Made some sprites persist between map changes

The player party characters are now initialised at the start of the game and are no longer re-created after every map change. The script system takes care of moving the player into the correct position on the new map.

Deleted sprite IDs are now reused the next time a sprite is created, instead of throwing out everything between maps.

13 files changed, 111 insertions, 94 deletions

@@ -178,21 +178,15 @@ function ChangeMap(map, warp)
   local playerId = getPlayerSprite()
   local playerSprite = getSprite(playerId)
   local direction = playerSprite.dir
-  local oldState = playerSprite.characterState
 
   playerSprite.controllable = false
   FadeToBlack(150)
-  loadMap(map, warp, direction)
-
-  local newPlayerId = getPlayerSprite()
-  local newPlayerSprite = getSprite(newPlayerId)
-  if oldState == CharacterState.RUNNING then
-    character():startRunning(newPlayerId)
-  end
+  loadMap(map)
+  character():transplantParty(playerId, getWarpPoint(warp), direction)
 
   coroutine.yield()
   RemoveFadeout(150)
-  newPlayerSprite.controllable = true
+  playerSprite.controllable = true
 end
 
 function CreateAnimatedSpriteAtPosition(alias, character, x, y, animName, direction, layer)
@@ -45,10 +45,6 @@ void CameraSystem::destroySprite(int spriteId) {
   }
 }
 
-void CameraSystem::clearSpriteCache() {
-  followingSprite_ = -1;
-}
-
 vec2i CameraSystem::calculatePosWithCenter(vec2i center) const {
   const Map& map = game_.getMap();
   vec2i mapBounds = map.getMapSize() * map.getTileSize();
@@ -35,8 +35,6 @@ public:
 
   void destroySprite(int spriteId) override;
 
-  void clearSpriteCache() override;
-
 private:
 
   vec2i calculatePosWithCenter(vec2i center) const;
@@ -39,6 +39,32 @@ void CharacterSystem::addSpriteToParty(int leaderId, int followerId) {
   game_.getSystem<AnimationSystem>().setSpriteAnimation(followerId, "still");
 }
 
+void CharacterSystem::transplantParty(int leaderId, vec2i pos, Direction dir) {
+  Sprite& leader = game_.getSprite(leaderId);
+  CharacterState oldState = leader.characterState;
+
+  std::vector<int> followers = leader.followers;
+  leader.followers.clear();
+
+  game_.getSystem<TransformSystem>().moveSprite(leaderId, pos);
+  game_.getSystem<AnimationSystem>().setSpriteDirection(leaderId, dir);
+
+  for (int followerId : followers) {
+    Sprite& follower = game_.getSprite(followerId);
+    follower.trail.clear();
+
+    game_.getSystem<TransformSystem>().moveSprite(followerId, pos);
+    game_.getSystem<AnimationSystem>().setSpriteDirection(followerId, dir);
+    addSpriteToParty(leaderId, followerId);
+  }
+
+  if (oldState == CharacterState::Running) {
+    startRunning(leaderId);
+  } else {
+    setPartyState(leaderId, oldState);
+  }
+}
+
 void CharacterSystem::moveInDirection(int spriteId, Direction dir) {
   Sprite& sprite = game_.getSprite(spriteId);
 
@@ -266,11 +292,3 @@ void CharacterSystem::destroySprite(int spriteId) {
     stopRunningSound(sprite);
   }
 }
-
-void CharacterSystem::clearSpriteCache() {
-  for (Sprite& sprite : game_.getSprites() | game_.spriteView()) {
-    if (sprite.runningSfxChannel != -1) {
-      stopRunningSound(sprite);
-    }
-  }
-}
@@ -23,6 +23,8 @@ public:
 
   void addSpriteToParty(int leaderId, int followerId);
 
+  void transplantParty(int leaderId, vec2i pos, Direction dir);
+
   void moveInDirection(int spriteId, Direction dir);
 
   void stopDirecting(int spriteId);
@@ -37,8 +39,6 @@ public:
 
   void destroySprite(int spriteId) override;
 
-  void clearSpriteCache() override;
-
 private:
 
   void stopRunning(int spriteId);
@@ -5,9 +5,19 @@
 #include "camera_system.h"
 
 int Game::emplaceSprite(std::string alias) {
-  int id = sprites_.size();
-  sprites_.emplace_back();
-  sprites_.back().alias = alias;
+  int id;
+
+  if (idsToReuse_.empty()) {
+    id = sprites_.size();
+    sprites_.emplace_back();
+    sprites_.back().alias = alias;
+  } else {
+    id = idsToReuse_.front();
+    idsToReuse_.pop_front();
+    sprites_[id] = Sprite();
+    sprites_[id].alias = alias;
+  }
+
   spriteIds_.insert(id);
   spritesByAlias_[alias] = id;
   return id;
@@ -19,56 +29,28 @@ void Game::destroySprite(int id) {
   }
 
   spriteIds_.erase(id);
+  idsToReuse_.push_back(id);
   spritesByAlias_.erase(sprites_.at(id).alias);
 }
 
-void Game::clearSprites() {
-  for (std::unique_ptr<System>& system : systems_) {
-    system->clearSpriteCache();
-  }
+void Game::loadMap(std::string filename) {
+  // Clear out non-persistent sprites.
+  std::list<int> spritesToDelete;
+  for (int spriteId : spriteIds_) {
+    Sprite& sprite = sprites_.at(spriteId);
 
-  sprites_.clear();
-  spriteIds_.clear();
-  spritesByAlias_.clear();
-}
+    if (!sprite.persistent) {
+      spritesToDelete.push_back(spriteId);
+    }
+  }
 
-void Game::loadMap(std::string filename, std::string warpPoint, Direction dir) {
-  clearSprites();
+  for (int spriteId : spritesToDelete) {
+    destroySprite(spriteId);
+  }
 
+  // Load the new map.
   map_ = std::make_unique<Map>(filename);
 
-  vec2i warpLoc = map_->getWarpPoint(warpPoint);
-
-  int lucasSprite = emplaceSprite("lucas");
-  getSystem<TransformSystem>().initSprite(lucasSprite, warpLoc);
-  getSystem<TransformSystem>().setUpCollision(lucasSprite, {-8, -8}, {12, 8}, true);
-  getSystem<AnimationSystem>().initSprite(lucasSprite, "../res/sprites/lucas_anim.txt");
-  getSystem<AnimationSystem>().setSpriteDirection(lucasSprite, dir);
-  getSprite(lucasSprite).hasShadow = true;
-  getSprite(lucasSprite).player = true;
-  getSystem<CharacterSystem>().initSprite(lucasSprite);
-
-  int kumaSprite = emplaceSprite("kuma");
-  getSystem<TransformSystem>().initSprite(kumaSprite, warpLoc);
-  getSystem<AnimationSystem>().initSprite(kumaSprite, "../res/sprites/kuma_anim.txt");
-  getSystem<AnimationSystem>().setSpriteDirection(kumaSprite, dir);
-  getSprite(kumaSprite).hasShadow = true;
-  getSystem<CharacterSystem>().addSpriteToParty(lucasSprite, kumaSprite);
-
-  int dusterSprite = emplaceSprite("duster");
-  getSystem<TransformSystem>().initSprite(dusterSprite, warpLoc);
-  getSystem<AnimationSystem>().initSprite(dusterSprite, "../res/sprites/duster_anim.txt");
-  getSystem<AnimationSystem>().setSpriteDirection(dusterSprite, dir);
-  getSprite(dusterSprite).hasShadow = true;
-  getSystem<CharacterSystem>().addSpriteToParty(lucasSprite, dusterSprite);
-
-  int boneySprite = emplaceSprite("boney");
-  getSystem<TransformSystem>().initSprite(boneySprite, warpLoc);
-  getSystem<AnimationSystem>().initSprite(boneySprite, "../res/sprites/boney_anim.txt");
-  getSystem<AnimationSystem>().setSpriteDirection(boneySprite, dir);
-  getSprite(boneySprite).hasShadow = true;
-  getSystem<CharacterSystem>().addSpriteToParty(lucasSprite, boneySprite);
-
   for (const Prototype& p : map_->getPrototypes()) {
     int spriteId = emplaceSprite(p.name);
     getSystem<TransformSystem>().initSprite(spriteId, p.pos);
@@ -86,7 +68,4 @@ void Game::loadMap(std::string filename, std::string warpPoint, Direction dir) {
     getSystem<TransformSystem>().setUpCollision(spriteId, {0, 0}, t.size, false);
     getSprite(spriteId).walkthroughScript = t.script;
   }
-
-  getSystem<CameraSystem>().setFollowingSprite(lucasSprite);
-  getSystem<CameraSystem>().unlockCamera();
 }
@@ -1,6 +1,7 @@
 #ifndef GAME_H_E6F1396E
 #define GAME_H_E6F1396E
 
+#include <deque>
 #include <list>
 #include <range/v3/all.hpp>
 #include <vector>
@@ -76,7 +77,7 @@ public:
     });
   }
 
-  void loadMap(std::string filename, std::string warpPoint, Direction dir);
+  void loadMap(std::string filename);
 
   const Map& getMap() const { return *map_; }
 
@@ -84,8 +85,6 @@ public:
 
 private:
 
-  void clearSprites();
-
   Mixer mixer_;
   bool shouldQuit_ = false;
 
@@ -93,6 +92,7 @@ private:
   std::map<SystemKey, System*> systemByKey_;
 
   std::set<int> spriteIds_;
+  std::deque<int> idsToReuse_;
   std::vector<Sprite> sprites_;
   std::map<std::string, int> spritesByAlias_;
   std::unique_ptr<Map> map_;
@@ -24,8 +24,46 @@ void loop(Renderer& renderer) {
   game.emplaceSystem<MessageSystem>();
   game.emplaceSystem<EffectSystem>();
 
-  game.loadMap("map2", "debugWarp_mailboxes", Direction::down);
-  game.getSprite(game.getSpriteByAlias("lucas")).controllable = true;
+  game.loadMap("map2");
+
+  vec2i warpLoc = game.getMap().getWarpPoint("debugWarp_mailboxes");
+
+  int lucasSprite = game.emplaceSprite("lucas");
+  game.getSystem<TransformSystem>().initSprite(lucasSprite, warpLoc);
+  game.getSystem<TransformSystem>().setUpCollision(lucasSprite, {-8, -8}, {12, 8}, true);
+  game.getSystem<AnimationSystem>().initSprite(lucasSprite, "../res/sprites/lucas_anim.txt");
+  game.getSystem<AnimationSystem>().setSpriteDirection(lucasSprite, Direction::down);
+  game.getSprite(lucasSprite).hasShadow = true;
+  game.getSprite(lucasSprite).player = true;
+  game.getSprite(lucasSprite).controllable = true;
+  game.getSprite(lucasSprite).persistent = true;
+  game.getSystem<CharacterSystem>().initSprite(lucasSprite);
+  game.getSystem<CameraSystem>().setFollowingSprite(lucasSprite);
+  game.getSystem<CameraSystem>().unlockCamera();
+
+  int kumaSprite = game.emplaceSprite("kuma");
+  game.getSystem<TransformSystem>().initSprite(kumaSprite, warpLoc);
+  game.getSystem<AnimationSystem>().initSprite(kumaSprite, "../res/sprites/kuma_anim.txt");
+  game.getSystem<AnimationSystem>().setSpriteDirection(kumaSprite, Direction::down);
+  game.getSprite(kumaSprite).hasShadow = true;
+  game.getSprite(kumaSprite).persistent = true;
+  game.getSystem<CharacterSystem>().addSpriteToParty(lucasSprite, kumaSprite);
+
+  int dusterSprite = game.emplaceSprite("duster");
+  game.getSystem<TransformSystem>().initSprite(dusterSprite, warpLoc);
+  game.getSystem<AnimationSystem>().initSprite(dusterSprite, "../res/sprites/duster_anim.txt");
+  game.getSystem<AnimationSystem>().setSpriteDirection(dusterSprite, Direction::down);
+  game.getSprite(dusterSprite).hasShadow = true;
+  game.getSprite(dusterSprite).persistent = true;
+  game.getSystem<CharacterSystem>().addSpriteToParty(lucasSprite, dusterSprite);
+
+  int boneySprite = game.emplaceSprite("boney");
+  game.getSystem<TransformSystem>().initSprite(boneySprite, warpLoc);
+  game.getSystem<AnimationSystem>().initSprite(boneySprite, "../res/sprites/boney_anim.txt");
+  game.getSystem<AnimationSystem>().setSpriteDirection(boneySprite, Direction::down);
+  game.getSprite(boneySprite).hasShadow = true;
+  game.getSprite(boneySprite).persistent = true;
+  game.getSystem<CharacterSystem>().addSpriteToParty(lucasSprite, boneySprite);
 
   renderer.render(game);
 
@@ -54,6 +54,7 @@ ScriptSystem::ScriptSystem(Game& game) : game_(game) {
 
   engine_.new_usertype<CharacterSystem>(
     "character",
+    "transplantParty", &CharacterSystem::transplantParty,
     "startRunning", &CharacterSystem::startRunning,
     "halt", &CharacterSystem::halt);
 
@@ -165,8 +166,14 @@ ScriptSystem::ScriptSystem(Game& game) : game_(game) {
 
   engine_.set_function(
     "loadMap",
-    [&] (std::string filename, std::string warpPoint, Direction dir) {
-      game_.loadMap(filename, warpPoint, dir);
+    [&] (std::string filename) {
+      game_.loadMap(filename);
+    });
+
+  engine_.set_function(
+    "getWarpPoint",
+    [&] (std::string warp) {
+      return game_.getMap().getWarpPoint(warp);
     });
 
   engine_.script_file("../res/scripts/common.lua");
@@ -42,6 +42,7 @@ class Sprite {
 public:
 
   std::string alias;
+  bool persistent = false;
 
   // Transform
   vec2i loc { 0, 0 };
@@ -18,8 +18,6 @@ public:
   virtual void tick(double dt) {}
 
   virtual void destroySprite(int spriteId) {}
-
-  virtual void clearSpriteCache() {}
 };
 
 #endif /* end of include guard: SYSTEM_H_6B40E1B9 */
@@ -225,13 +225,3 @@ void TransformSystem::destroySprite(int spriteId) {
     removeCollidable(spriteId);
   }
 }
-
-void TransformSystem::clearSpriteCache() {
-  for (auto& layer : spritesByY_) {
-    layer.clear();
-  }
-  leftCollidables_.clear();
-  rightCollidables_.clear();
-  upCollidables_.clear();
-  downCollidables_.clear();
-}
@@ -47,8 +47,6 @@ public:
 
   void destroySprite(int spriteId) override;
 
-  void clearSpriteCache() override;
-
 private:
 
   Game& game_;