Run init-script only once after a sector has loaded (#3011)

* Run init-script only once after a sector has loaded

Fixes #698

* Allow saving init-script-run-once to level file

* Add toggle to editor sector menu

* Code improvement

* Per current guidelines

* Make run logic more clear

---------

Co-authored-by: swagtoy <[email protected]>

Author: tobbi

src/supertux/menu/editor_sector_menu.cpp

@@ -35,6 +35,7 @@ EditorSectorMenu::EditorSectorMenu() :
   add_hl();
   add_textfield(_("Name"), &sector->m_name);
   add_script(_("Initialization script"), &sector->m_init_script);
+  add_toggle(0, _("Run initialization script only once"), &sector->m_init_script_run_once);
   add_floatfield(_("Gravity"), &sector->m_gravity);
 
   add_hl();

src/supertux/sector.cpp

@@ -69,7 +69,9 @@ Sector::Sector(Level& parent) :
   m_foremost_opaque_layer(),
   m_gravity(10.0f),
   m_collision_system(new CollisionSystem(*this)),
-  m_text_object(add<TextObject>("Text"))
+  m_text_object(add<TextObject>("Text")),
+  m_init_script_run(),
+  m_init_script_run_once()
 {
   add<DisplayEffect>("Effect");
   add<TextArrayObject>("TextArray");
@@ -284,8 +286,10 @@ Sector::activate(const Vector& player_pos)
   }
 
   // Run init script
-  if (!m_init_script.empty() && !Editor::is_active()) {
+  if (!m_init_script.empty() && !Editor::is_active() && !m_init_script_run) {
     run_script(m_init_script, "init-script");
+    if (m_init_script_run_once)
+      m_init_script_run = true;
   }
 
   // Do not interpolate camera after it has been warped
@@ -775,6 +779,10 @@ Sector::save(Writer &writer)
     writer.write("init-script", m_init_script,false);
   }
 
+  if (m_init_script_run_once) {
+    writer.write("init-script-run-once", m_init_script_run_once);
+  }
+
   // saving objects;
   std::vector<GameObject*> objects(get_objects().size());
   std::transform(get_objects().begin(), get_objects().end(), objects.begin(), [] (auto& obj) {

src/supertux/sector.hpp

@@ -84,6 +84,8 @@ class Sector final : public Base::Sector
   inline Level& get_level() const { return m_level; }
   TileSet* get_tileset() const override;
   bool in_worldmap() const override;
+  inline void set_init_script_run_once(bool run_once) { m_init_script_run_once = run_once; }
+  inline bool get_init_script_run_once() const { return m_init_script_run_once; }
 
   /** activates this sector (change music, initialize player class, ...) */
   void activate(const std::string& spawnpoint);
@@ -266,6 +268,8 @@ class Sector final : public Base::Sector
   Vector m_last_translation; // For camera interpolation at high frame rates
   float m_last_scale;
   float m_last_dt;
+  bool m_init_script_run;
+  bool m_init_script_run_once;
 
  public: 
   // The default sector size.

src/supertux/sector_parser.cpp

@@ -150,6 +150,14 @@ SectorParser::parse(const ReaderMapping& reader)
       iter.get(value);
       m_sector.set_init_script(value);
     }
+    else if(iter.get_key() == "init-script-run-once")
+    {
+      auto sector = dynamic_cast<Sector*>(&m_sector);
+      if (!sector) continue;
+      bool value;
+      iter.get(value);
+      sector->set_init_script_run_once(value);
+    }
     else if (iter.get_key() == "ambient-light")
     {
       const auto& sx = iter.get_sexp();