Added lightning sprite to mailbox event

Sprites can be destroyed now, which really just means that their index is removed from the list of active sprites. The actual memory is not freed until all sprites are deleted on map change.

Sprite layers are introduced. All sprites by default are on layer 0 (Normal) which renders them in between the lower and upper map layers. There is also a layer 1 (Above) that renders above the upper map layer, and the sprite for the lightning strike uses this layer in order to not be hidden by the trees.

Fixed a bug where waiting for the end of a non-looping animation would trip the flag immediately upon the final frame activating, instead of waiting the length of the last frame.

23 files changed, 190 insertions, 36 deletions

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<map version="1.4" tiledversion="1.4.3" orientation="orthogonal" renderorder="right-down" width="64" height="64" tilewidth="16" tileheight="16" infinite="0" nextlayerid="3" nextobjectid="6">
+<map version="1.4" tiledversion="1.4.3" orientation="orthogonal" renderorder="right-down" width="64" height="64" tilewidth="16" tileheight="16" infinite="0" nextlayerid="3" nextobjectid="7">
  <tileset firstgid="1" name="fromRom" tilewidth="16" tileheight="16" tilecount="180" columns="10">
   <image source="map2_tiles.png" width="160" height="288"/>
   <tile id="61">
@@ -657,6 +657,9 @@
    </properties>
    <point/>
   </object>
+  <object id="6" name="debugWarp_mailboxes" type="warp" x="598.667" y="420.667">
+   <point/>
+  </object>
  </objectgroup>
  <layer id="1" name="Layer 0" width="64" height="64">
   <data encoding="csv">
@@ -25,6 +25,11 @@ CharacterState = {
   RUNNING = 3
 }
 
+SpriteLayer = {
+  NORMAL = 0,
+  ABOVE = 1
+}
+
 function StartCutscene()
   local playerId = getPlayerSprite()
   local playerSprite = getSprite(playerId)
@@ -59,6 +64,12 @@ function HideCutsceneBars()
   playerSprite.controllable = true
 end
 
+function GetPosition(spriteName)
+  local spriteId = getSpriteByAlias(spriteName)
+  local sprite = getSprite(spriteId)
+  return sprite.loc
+end
+
 function SetDirection(spriteName, dir)
   local spriteId = getSpriteByAlias(spriteName)
   animation():setSpriteDirection(spriteId, dir)
@@ -137,3 +148,16 @@ function ChangeMap(map, warp)
   RemoveFadeout(150)
   newPlayerSprite.controllable = true
 end
+
+function CreateAnimatedSpriteAtPosition(alias, character, x, y, animName, direction, layer)
+  local spriteId = emplaceSprite(alias)
+  transform():initSprite(spriteId, x, y, layer)
+  animation():initSprite(spriteId, "../res/sprites/" .. character .. "_anim.txt")
+  animation():setSpriteDirection(spriteId, direction)
+  animation():setSpriteAnimation(spriteId, animName)
+end
+
+function DestroyNamedSprite(alias)
+  local spriteId = getSpriteByAlias(alias)
+  destroySprite(spriteId)
+end
@@ -29,8 +29,15 @@ function map2.mailbox_lightning()
   DisplayMessage("* ...?", "", SpeakerType.NONE)
   WaitForEndOfMessage()
 
+  local lucasPos = GetPosition("lucas")
+  CreateAnimatedSpriteAtPosition("lightning_from_mailbox", "lightning", lucasPos:x() + 56, lucasPos:y() - 72, "strike", Direction.DOWN_LEFT, SpriteLayer.ABOVE)
+
   SetDirection("lucas", Direction.DOWN)
-  SetAnimation("lucas", "electrocute!")
+  SetAnimation("lucas", "lightning_electrocute!")
+  WaitForAnimation("lucas")
+
+  DestroyNamedSprite("lightning_from_mailbox")
+  SetAnimation("lucas", "lightning_collapse!")
   WaitForAnimation("lucas")
 
   DisplayMessage("* It was lightning.\n\fAh.", "", SpeakerType.NONE)
@@ -0,0 +1,3 @@
+../res/sprites/lightning.png
+../res/sprites/lightning_frames.txt
+strike[down_left]: 0,1,3,2
\ No newline at end of file
@@ -0,0 +1,14 @@
+160,128 cell size
+10 frames per row
+10 frames
+
+112,128,60,56
+128,128,72,64
+116,128,64,64
+116,128,64,64
+88,96,40,96
+88,96,40,96
+80,96,40,96
+160,32,123,83
+160,32,123,91
+160,32,123,91
@@ -32,4 +32,5 @@ run[up]: 71,79,87,95
 run[up_right]: 72,80,88,96
 run[right]: 73,81,89,97
 run[down_right]: 74,82,90,98
-electrocute![down]: 116,117,118,116,117,118,116,117,118,119,120,121,122
\ No newline at end of file
+lightning_electrocute![down]: 116,117,118,116,117,118,116,117,118,116
+lightning_collapse![down]: 119,120,121,122
\ No newline at end of file
@@ -65,7 +65,7 @@ void AnimationSystem::initSprite(int spriteId, std::string_view filename) {
   std::string animLine;
   std::getline(datafile, animLine); // blank
   while (std::getline(datafile, animLine)) {
-    std::regex re(R"(([a-z!]+)\[([a-z_]+)\]: ([0-9,]+))");
+    std::regex re(R"(([a-z!_]+)\[([a-z_]+)\]: ([0-9,]+))");
     std::smatch m;
     std::regex_match(animLine, m, re);
 
@@ -96,14 +96,13 @@ void AnimationSystem::tick(double dt) {
     for (Sprite& sprite : game_.getSprites() | game_.spriteView()) {
       if (sprite.isAnimated && !sprite.animFinished) {
         sprite.animationFrame++;
-        if (sprite.animations[sprite.animationId].looping) {
-          if (sprite.animationFrame >= sprite.animations[sprite.animationId].frameIndices.size()) {
+
+        if (sprite.animationFrame >= sprite.animations[sprite.animationId].frameIndices.size()) {
+          if (sprite.animations[sprite.animationId].looping) {
             sprite.animationFrame = 0;
-          }
-        } else {
-          if (sprite.animationFrame >= sprite.animations[sprite.animationId].frameIndices.size() - 1) {
-            sprite.animationFrame = sprite.animations[sprite.animationId].frameIndices.size() - 1;
+          } else {
             sprite.animFinished = true;
+            sprite.animationFrame = sprite.animations[sprite.animationId].frameIndices.size() - 1;
           }
         }
       }
@@ -26,6 +26,12 @@ void CameraSystem::tick(double dt) {
   }
 }
 
+void CameraSystem::destroySprite(int spriteId) {
+  if (followingSprite_ == spriteId) {
+    followingSprite_ = -1;
+  }
+}
+
 void CameraSystem::clearSpriteCache() {
   followingSprite_ = -1;
 }
@@ -26,6 +26,8 @@ public:
 
   void tick(double dt) override;
 
+  void destroySprite(int spriteId) override;
+
   void clearSpriteCache() override;
 
 private:
@@ -260,6 +260,13 @@ void CharacterSystem::halt(int spriteId) {
   }
 }
 
+void CharacterSystem::destroySprite(int spriteId) {
+  Sprite& sprite = game_.getSprite(spriteId);
+  if (sprite.runningSfxChannel != -1) {
+    stopRunningSound(sprite);
+  }
+}
+
 void CharacterSystem::clearSpriteCache() {
   for (Sprite& sprite : game_.getSprites() | game_.spriteView()) {
     if (sprite.runningSfxChannel != -1) {
@@ -35,6 +35,8 @@ public:
 
   void halt(int spriteId);
 
+  void destroySprite(int spriteId) override;
+
   void clearSpriteCache() override;
 
 private:
@@ -12,4 +12,6 @@ const int PARTY_FRAME_DELAY = 10;// / MOVEMENT_SPEED;
 
 const int MESSAGE_TEXT_WIDTH = 196;
 
+const int NUM_SPRITE_LAYERS = 2;
+
 #endif /* end of include guard: CONSTS_H_9561E49C */
@@ -7,11 +7,21 @@
 int Game::emplaceSprite(std::string alias) {
   int id = sprites_.size();
   sprites_.emplace_back();
-  spriteIds_.push_back(id);
+  sprites_.back().alias = alias;
+  spriteIds_.insert(id);
   spritesByAlias_[alias] = id;
   return id;
 }
 
+void Game::destroySprite(int id) {
+  for (std::unique_ptr<System>& system : systems_) {
+    system->destroySprite(id);
+  }
+
+  spriteIds_.erase(id);
+  spritesByAlias_.erase(sprites_.at(id).alias);
+}
+
 void Game::clearSprites() {
   for (std::unique_ptr<System>& system : systems_) {
     system->clearSpriteCache();
@@ -6,6 +6,7 @@
 #include <vector>
 #include <memory>
 #include <map>
+#include <set>
 #include "sprite.h"
 #include "map.h"
 #include "consts.h"
@@ -45,6 +46,8 @@ public:
 
   int emplaceSprite(std::string alias);
 
+  void destroySprite(int id);
+
   const Sprite& getSprite(int id) const {
     return sprites_.at(id);
   }
@@ -53,7 +56,7 @@ public:
     return sprites_.at(id);
   }
 
-  const std::vector<int>& getSprites() {
+  const std::set<int>& getSprites() {
     return spriteIds_;
   }
 
@@ -93,7 +96,7 @@ private:
   std::list<std::unique_ptr<System>> systems_;
   std::map<SystemKey, System*> systemByKey_;
 
-  std::vector<int> spriteIds_;
+  std::set<int> spriteIds_;
   std::vector<Sprite> sprites_;
   std::map<std::string, int> spritesByAlias_;
   std::unique_ptr<Map> map_;
@@ -22,7 +22,7 @@ void loop(Renderer& renderer) {
   game.emplaceSystem<CameraSystem>();
   game.emplaceSystem<MessageSystem>();
 
-  game.loadMap("map1", "spawn", Direction::down);
+  game.loadMap("map2", "debugWarp_mailboxes", Direction::down);
   game.getSprite(game.getSpriteByAlias("lucas")).controllable = true;
 
   renderer.render(game);
@@ -94,6 +94,21 @@ texture_ptr Renderer::renderMapLayer(const Map& map, int layer) {
   return canvas;
 }
 
+void Renderer::renderSprite(const Sprite& sprite) {
+  if (sprite.isAnimated) {
+    if (sprite.hasShadow) {
+      int shadowTexId = loadImageFromFile("../res/shadow.png");
+      const SDL_Rect shadowDest { sprite.loc.x() - 8, sprite.loc.y() - 8, 16, 8 };
+      SDL_RenderCopy(ren_.get(), textures_.at(shadowTexId).get(), nullptr, &shadowDest);
+    }
+
+    const SpriteFrame& frame = sprite.frames.at(sprite.animations.at(sprite.animationId).frameIndices.at(sprite.animationFrame));
+    const SDL_Rect& src = frame.srcRect;
+    SDL_Rect dest { sprite.loc.x() - frame.center.x(), sprite.loc.y() - frame.center.y(), frame.size.w(), frame.size.h() };
+    SDL_RenderCopy(ren_.get(), textures_.at(loadImageFromFile(sprite.spritesheet)).get(), &src, &dest);
+  }
+}
+
 void Renderer::render(Game& game) {
   if (cachedMapName_ != game.getMap().getName()) {
     cachedMapName_ = game.getMap().getName();
@@ -122,23 +137,16 @@ void Renderer::render(Game& game) {
 
   SDL_RenderCopy(ren_.get(), renLay1_.get(), nullptr, nullptr);
 
-  int shadowTexId = loadImageFromFile("../res/shadow.png");
-  for (const Sprite& sprite : game.getSystem<TransformSystem>().getSpritesByY() | game.spriteView()) {
-    if (sprite.isAnimated) {
-      if (sprite.hasShadow) {
-        const SDL_Rect shadowDest { sprite.loc.x() - 8, sprite.loc.y() - 8, 16, 8 };
-        SDL_RenderCopy(ren_.get(), textures_.at(shadowTexId).get(), nullptr, &shadowDest);
-      }
-
-      const SpriteFrame& frame = sprite.frames.at(sprite.animations.at(sprite.animationId).frameIndices.at(sprite.animationFrame));
-      const SDL_Rect& src = frame.srcRect;
-      SDL_Rect dest { sprite.loc.x() - frame.center.x(), sprite.loc.y() - frame.center.y(), frame.size.w(), frame.size.h() };
-      SDL_RenderCopy(ren_.get(), textures_.at(loadImageFromFile(sprite.spritesheet)).get(), &src, &dest);
-    }
+  for (const Sprite& sprite : game.getSystem<TransformSystem>().getSpritesByY(SpriteLayer::Normal) | game.spriteView()) {
+    renderSprite(sprite);
   }
 
   SDL_RenderCopy(ren_.get(), renLay0_.get(), nullptr, nullptr);
 
+  for (const Sprite& sprite : game.getSystem<TransformSystem>().getSpritesByY(SpriteLayer::Above) | game.spriteView()) {
+    renderSprite(sprite);
+  }
+
   SDL_Rect cameraField {
     game.getSystem<CameraSystem>().getCameraPosition().x(),
     game.getSystem<CameraSystem>().getCameraPosition().y(),
@@ -11,6 +11,7 @@
 
 class Game;
 class Map;
+class Sprite;
 
 class sdl_error : public std::logic_error {
 public:
@@ -133,6 +134,9 @@ private:
   std::vector<texture_ptr> textures_;
   std::map<std::string, int> filenameToTexId_;
 
+  // Sprite rendering
+  void renderSprite(const Sprite& sprite);
+
   // Map rendering
   texture_ptr renderMapLayer(const Map& map, int layer);
 
@@ -4,6 +4,8 @@
 #include "message_system.h"
 #include "animation_system.h"
 #include "character_system.h"
+#include "transform_system.h"
+#include "vector.h"
 
 ScriptSystem::ScriptSystem(Game& game) : game_(game) {
   engine_.open_libraries(
@@ -11,8 +13,14 @@ ScriptSystem::ScriptSystem(Game& game) : game_(game) {
     sol::lib::coroutine,
     sol::lib::math);
 
+  engine_.new_usertype<vec2i>(
+    "vec2i",
+    "x", [] (const vec2i& v) { return v.x(); },
+    "y", [] (const vec2i& v) { return v.y(); });
+
   engine_.new_usertype<Sprite>(
     "sprite",
+    "loc", &Sprite::loc,
     "dir", &Sprite::dir,
     "followers", &Sprite::followers,
     "characterState", &Sprite::characterState,
@@ -29,6 +37,7 @@ ScriptSystem::ScriptSystem(Game& game) : game_(game) {
 
   engine_.new_usertype<AnimationSystem>(
     "animation",
+    "initSprite", &AnimationSystem::initSprite,
     "setSpriteAnimation", &AnimationSystem::setSpriteAnimation,
     "setSpriteDirection", &AnimationSystem::setSpriteDirection);
 
@@ -37,6 +46,12 @@ ScriptSystem::ScriptSystem(Game& game) : game_(game) {
     "startRunning", &CharacterSystem::startRunning,
     "halt", &CharacterSystem::halt);
 
+  engine_.new_usertype<TransformSystem>(
+    "transform",
+    "initSprite", [] (TransformSystem& transform, int spriteId, int x, int y, SpriteLayer layer) {
+      transform.initSprite(spriteId, vec2i{x, y}, layer);
+    });
+
   engine_.new_usertype<Mixer>(
     "mixer",
     "playSound", &Mixer::playSound,
@@ -62,12 +77,30 @@ ScriptSystem::ScriptSystem(Game& game) : game_(game) {
     });
 
   engine_.set_function(
+    "transform",
+    [&] () -> TransformSystem& {
+      return game_.getSystem<TransformSystem>();
+    });
+
+  engine_.set_function(
     "mixer",
     [&] () -> Mixer& {
       return game_.getMixer();
     });
 
   engine_.set_function(
+    "emplaceSprite",
+    [&] (std::string alias) -> int {
+      return game_.emplaceSprite(alias);
+    });
+
+  engine_.set_function(
+    "destroySprite",
+    [&] (int spriteId) {
+      game_.destroySprite(spriteId);
+    });
+
+  engine_.set_function(
     "getSpriteByAlias",
     [&] (std::string alias) -> int {
       return game_.getSpriteByAlias(alias);
@@ -10,6 +10,11 @@
 #include "vector.h"
 #include "step_type.h"
 
+enum class SpriteLayer {
+  Normal,
+  Above
+};
+
 struct SpriteFrame {
   SDL_Rect srcRect;
   vec2i center;
@@ -36,8 +41,11 @@ struct Movement {
 class Sprite {
 public:
 
+  std::string alias;
+
   // Transform
   vec2i loc { 0, 0 };
+  SpriteLayer layer = SpriteLayer::Normal;
   bool collidable = false;
   bool solid = false;
   vec2i collisionOffset;
@@ -16,6 +16,8 @@ public:
 
   virtual void tick(double dt) {}
 
+  virtual void destroySprite(int spriteId) {}
+
   virtual void clearSpriteCache() {}
 };
 
@@ -2,10 +2,11 @@
 #include "game.h"
 #include "map.h"
 
-void TransformSystem::initSprite(int spriteId, vec2i loc) {
+void TransformSystem::initSprite(int spriteId, vec2i loc, SpriteLayer layer) {
   Sprite& sprite = game_.getSprite(spriteId);
   sprite.loc = loc;
-  spritesByY_.emplace(loc.y(), spriteId);
+  sprite.layer = layer;
+  spritesByY_[static_cast<size_t>(layer)].emplace(loc.y(), spriteId);
 }
 
 void TransformSystem::setUpCollision(int spriteId, vec2i offset, vec2i size, bool solid) {
@@ -26,11 +27,11 @@ void TransformSystem::moveSprite(int spriteId, vec2i newLoc) {
 
   bool changedY = (sprite.loc.y() != newLoc.y());
   if (changedY) {
-    spritesByY_.erase(std::make_tuple(sprite.loc.y(), spriteId));
+    spritesByY_[static_cast<size_t>(sprite.layer)].erase(std::make_tuple(sprite.loc.y(), spriteId));
   }
   sprite.loc = newLoc;
   if (changedY) {
-    spritesByY_.emplace(newLoc.y(), spriteId);
+    spritesByY_[static_cast<size_t>(sprite.layer)].emplace(newLoc.y(), spriteId);
   }
   if (sprite.collidable) {
     addCollidable(spriteId);
@@ -216,8 +217,19 @@ void TransformSystem::removeCollidable(int spriteId) {
   downCollidables_.erase({ colUL.y(), spriteId });
 }
 
+void TransformSystem::destroySprite(int spriteId) {
+  Sprite& sprite = game_.getSprite(spriteId);
+  spritesByY_[static_cast<size_t>(sprite.layer)].erase(std::make_tuple(sprite.loc.y(), spriteId));
+
+  if (sprite.collidable) {
+    removeCollidable(spriteId);
+  }
+}
+
 void TransformSystem::clearSpriteCache() {
-  spritesByY_.clear();
+  for (auto& layer : spritesByY_) {
+    layer.clear();
+  }
   leftCollidables_.clear();
   rightCollidables_.clear();
   upCollidables_.clear();
@@ -8,6 +8,8 @@
 #include "direction.h"
 #include "system.h"
 #include "vector.h"
+#include "sprite.h"
+#include "consts.h"
 
 class Game;
 
@@ -29,26 +31,28 @@ public:
 
   TransformSystem(Game& game) : game_(game) {}
 
-  void initSprite(int spriteId, vec2i loc);
+  void initSprite(int spriteId, vec2i loc, SpriteLayer layer = SpriteLayer::Normal);
 
   void setUpCollision(int spriteId, vec2i offset, vec2i size, bool solid);
 
   void moveSprite(int spriteId, vec2i newLoc);
 
-  auto getSpritesByY() const {
-    return spritesByY_ | ranges::views::transform([] (const std::tuple<int, int>& val) {
+  auto getSpritesByY(SpriteLayer layer) const {
+    return spritesByY_[static_cast<size_t>(layer)] | ranges::views::transform([] (const std::tuple<int, int>& val) {
       return std::get<1>(val);
     });
   }
 
   CollisionResult checkCollision(int spriteId, vec2i newLoc, Direction dir);
 
+  void destroySprite(int spriteId) override;
+
   void clearSpriteCache() override;
 
 private:
 
   Game& game_;
-  std::set<std::tuple<int, int>> spritesByY_;
+  std::set<std::tuple<int, int>> spritesByY_[NUM_SPRITE_LAYERS];
 
   struct Collidable {
     int lower;