Fix "Z-pos" value not having effect on some objects, remove duplicate "Layer" option

Removes hardcoded z-pos values some objects used when being drawn.

Some objects had both a "Z-pos" and "Layer" option listed, both doing the same, essentially being duplicates. In those cases, "Layer" was removed in favour of "Z-pos".

Some objects used to look for a "layer" property in their options and if it wasn't found, they overrode the "Z-pos" property set for `MovingSprite`s. In those cases, reading the "layer" option is now only left for backwards compatibility.

Author: provigz

src/object/block.cpp

@@ -37,7 +37,7 @@ static const float BOUNCY_BRICK_SPEED = 90;
 static const float BUMP_ROTATION_ANGLE = 10;
 
 Block::Block(const Vector& pos, const std::string& sprite_file) :
-  MovingSprite(pos, sprite_file),
+  MovingSprite(pos, sprite_file, LAYER_OBJECTS + 1),
   m_bouncing(false),
   m_breaking(false),
   m_bounce_dir(0),
@@ -51,7 +51,7 @@ Block::Block(const Vector& pos, const std::string& sprite_file) :
 }
 
 Block::Block(const ReaderMapping& mapping, const std::string& sprite_file) :
-  MovingSprite(mapping, sprite_file),
+  MovingSprite(mapping, sprite_file, LAYER_OBJECTS + 1),
   m_bouncing(false),
   m_breaking(false),
   m_bounce_dir(0),
@@ -149,12 +149,6 @@ Block::update(float dt_sec)
   }
 }
 
-void
-Block::draw(DrawingContext& context)
-{
-  m_sprite->draw(context.color(), get_pos(), LAYER_OBJECTS+1, m_flip);
-}
-
 void
 Block::start_bounce(GameObject* hitter)
 {

src/object/block.hpp

@@ -34,12 +34,9 @@ class Block : public MovingSprite
 
   virtual HitResponse collision(GameObject& other, const CollisionHit& hit) override;
   virtual void update(float dt_sec) override;
-  virtual void draw(DrawingContext& context) override;
 
   virtual void on_flip(float height) override;
 
-  virtual int get_layer() const override { return LAYER_OBJECTS + 1; }
-
   void start_bounce(GameObject* hitter);
 
 protected:

src/object/candle.cpp

@@ -39,7 +39,7 @@ Candle::Candle(const ReaderMapping& mapping) :
   mapping.get("flicker", flicker, true);
   std::vector<float> vColor;
   if (!mapping.get("color", vColor)) vColor = {1.0f, 1.0f, 1.0f};
-  mapping.get("layer", m_layer, 0);
+  mapping.get("layer", m_layer); // Backwards compatibility
 
   // Change the light color if defined.
   if (vColor.size() >= 3) {
@@ -75,9 +75,8 @@ Candle::get_settings()
   result.add_bool(_("Burning"), &burning, "burning", true);
   result.add_bool(_("Flicker"), &flicker, "flicker", true);
   result.add_color(_("Color"), &lightcolor, "color", Color::WHITE);
-  result.add_int(_("Layer"), &m_layer, "layer", 0);
 
-  result.reorder({"burning", "flicker", "name", "sprite", "color", "layer", "x", "y"});
+  result.reorder({"burning", "flicker", "name", "sprite", "color", "z-pos", "x", "y"});
 
   return result;
 }

src/object/conveyor_belt.cpp

@@ -26,8 +26,8 @@
 #include "math/util.hpp"
 #include "util/reader_mapping.hpp"
 
-ConveyorBelt::ConveyorBelt(const ReaderMapping &reader) :
-  MovingSprite(reader, "images/objects/conveyor_belt/conveyor.sprite"),
+ConveyorBelt::ConveyorBelt(const ReaderMapping& reader) :
+  MovingSprite(reader, "images/objects/conveyor_belt/conveyor.sprite", LAYER_TILES),
   m_running(true),
   m_dir(Direction::LEFT),
   m_length(1),
@@ -110,9 +110,7 @@ ConveyorBelt::draw(DrawingContext &context)
   for (int i = 0; i < m_length; i++)
   {
     m_sprite->set_frame(frame_index);
-    Vector pos = get_pos();
-    pos.x += static_cast<float>(i) * 32.0f;
-    m_sprite->draw(context.color(), pos, get_layer());
+    m_sprite->draw(context.color(), get_pos() + Vector(static_cast<float>(i) * 32.f, 0.f), m_layer);
   }
 }
 

src/object/conveyor_belt.hpp

@@ -51,8 +51,6 @@ class ConveyorBelt final : public MovingSprite
   virtual void update(float dt_sec) override;
   virtual void draw(DrawingContext& context) override;
 
-  virtual int get_layer() const override { return LAYER_TILES; }
-
   virtual void after_editor_set() override;
 
   /** @name Scriptable Methods */

src/object/lit_object.cpp

@@ -25,7 +25,7 @@
 #include "util/reader_mapping.hpp"
 
 LitObject::LitObject(const ReaderMapping& reader) :
-  MovingSprite(reader, "images/objects/lightflower/lightflower1.sprite"),
+  MovingSprite(reader, "images/objects/lightflower/lightflower1.sprite", LAYER_TILES),
   m_light_offset(-6.f, -17.f),
   m_light_sprite_name("images/objects/lightflower/light/glow_light.sprite"),
   m_sprite_action("default"),
@@ -36,7 +36,7 @@ LitObject::LitObject(const ReaderMapping& reader) :
   reader.get("light-offset-y", m_light_offset.y);
 
   reader.get("light-sprite", m_light_sprite_name);
-  reader.get("layer", m_layer, 0);
+  reader.get("layer", m_layer); // Backwards compatibility
 
   reader.get("action", m_sprite_action);
   reader.get("light-action", m_light_sprite_action);
@@ -68,7 +68,6 @@ LitObject::get_settings()
   ObjectSettings result = MovingSprite::get_settings();
 
   result.add_sprite(_("Light sprite"), &m_light_sprite_name, "light-sprite", "images/objects/lightflower/light/glow_light.sprite");
-  result.add_int(_("Layer"), &m_layer, "layer", 0);
 
   result.add_text(_("Sprite starting action"), &m_sprite_action, "action", "default");
   result.add_text(_("Light sprite starting action"), &m_light_sprite_action, "light-action", "default");

src/object/lit_object.hpp

@@ -50,8 +50,6 @@ class LitObject final : public MovingSprite
   virtual ObjectSettings get_settings() override;
   virtual void after_editor_set() override;
 
-  virtual int get_layer() const override { return m_layer; }
-
   virtual void on_flip(float height) override;
 
   /**

src/object/moving_sprite.hpp

@@ -63,7 +63,7 @@ class MovingSprite : public MovingObject
   virtual void after_editor_set() override;
   virtual void on_type_change(int old_type) override;
 
-  virtual int get_layer() const override { return m_layer; }
+  int get_layer() const override { return m_layer; }
 
   bool has_found_sprite() const { return m_sprite_found; }
   const std::string& get_sprite_name() const { return m_sprite_name; }

src/object/particlesystem_interactive.cpp

@@ -17,7 +17,6 @@
 #include "object/particlesystem_interactive.hpp"
 
 #include "collision/collision.hpp"
-#include "editor/editor.hpp"
 #include "math/aatriangle.hpp"
 #include "object/tilemap.hpp"
 #include "supertux/globals.hpp"
@@ -36,19 +35,13 @@ ParticleSystem_Interactive::ParticleSystem_Interactive() :
 {
   virtual_width = static_cast<float>(SCREEN_WIDTH);
   virtual_height = static_cast<float>(SCREEN_HEIGHT);
-  if (!Editor::is_active()) {
-    z_pos = 0;
-  }
 }
 
 ParticleSystem_Interactive::ParticleSystem_Interactive(const ReaderMapping& mapping) :
   ParticleSystem(mapping)
 {
   virtual_width = static_cast<float>(SCREEN_WIDTH);
   virtual_height = static_cast<float>(SCREEN_HEIGHT);
-  if (!Editor::is_active()) {
-    z_pos = 0;
-  }
 }
 
 ParticleSystem_Interactive::~ParticleSystem_Interactive()

src/object/rain_particle_system.cpp

@@ -302,7 +302,7 @@ void RainParticleSystem::draw(DrawingContext& context)
   context.set_translation(Vector(0, 0));
   context.color().draw_filled_rect(context.get_rect(),
                                    Color(0.3f, 0.38f, 0.4f, opacity),
-                                   199); // TODO: Change the hardcoded layer value with the rain's layer
+                                   z_pos);
   context.pop_transform();
 }