Allow for control of Tux's fancy idle animations via scripting (#3112)

fixes #3112
* Allow for control of Tux's fancy idle animations via scripting

* Mark one liners as `inline`

* PART ONE

* part 2

* Format namespace

* Simplify & Fix

* Address feedback

Author: bruhmoent

src/object/player.cpp

@@ -53,8 +53,8 @@
 
 const float TUX_INVINCIBLE_TIME_WARNING = 2.0f;
 
-namespace {
-
+namespace 
+{
 /* Times: */
 const float TUX_SAFE_TIME = 1.8f;
 const float TUX_INVINCIBLE_TIME = 14.0f;
@@ -232,6 +232,8 @@ Player::Player(PlayerStatus& player_status, const std::string& name_, int player
   m_water_jump(false),
   m_airarrow(Surface::from_file("images/engine/hud/airarrow.png")),
   m_bubbles_sprite(SpriteManager::current()->create("images/particles/air_bubble.sprite")),
+  m_should_fancy_idle(true),
+  m_fancy_idle_active(true),
   m_floor_normal(0.0f, 0.0f),
   m_ghost_mode(false),
   m_unduck_hurt_timer(),
@@ -2189,42 +2191,60 @@ Player::draw(DrawingContext& context)
   }
   else
   {
-    if (fabsf(m_physic.get_velocity_x()) < 1.0f) {
-      if (std::all_of(IDLE_STAGES.begin(), IDLE_STAGES.end(),
-            [this](const std::string& stage) { return m_sprite->get_action().find("-" + stage + "-") == std::string::npos; }))
+    if (fabsf(m_physic.get_velocity_x()) < 1.0f)
+    {
+      const bool is_not_idle = std::all_of(IDLE_STAGES.begin(), IDLE_STAGES.end(),
+        [this](const std::string& stage) { return m_sprite->get_action().find("-" + stage + "-") == std::string::npos; });
+
+      if (is_not_idle || (m_should_fancy_idle && !m_fancy_idle_active))
       {
         m_idle_stage = 0;
         m_idle_timer.start(static_cast<float>(TIME_UNTIL_IDLE) / 1000.0f);
+        m_sprite->set_action(sa_prefix + ("-" + IDLE_STAGES[m_idle_stage]) + sa_postfix, Sprite::LOOPS_CONTINUED);
 
-        m_sprite->set_action(sa_prefix+("-" + IDLE_STAGES[m_idle_stage])+sa_postfix, Sprite::LOOPS_CONTINUED);
-      }
-      else if (m_idle_timer.check() || m_sprite->animation_done()) {
-        m_idle_stage++;
-        if (m_idle_stage >= static_cast<unsigned int>(IDLE_STAGES.size()))
+        if (!m_should_fancy_idle)
         {
-          m_idle_stage = static_cast<int>(IDLE_STAGES.size()) - 1;
-          m_sprite->set_action(sa_prefix+("-" + IDLE_STAGES[m_idle_stage])+sa_postfix);
           m_sprite->set_animation_loops(-1);
+          m_fancy_idle_active = false;
         }
         else
+          m_fancy_idle_active = true;
+      }
+      else if (m_should_fancy_idle)
+      {
+        if (m_idle_timer.check() || m_sprite->animation_done())
         {
-          m_sprite->set_action(sa_prefix+("-" + IDLE_STAGES[m_idle_stage])+sa_postfix, 1);
+          m_idle_stage++;
+
+          if (m_idle_stage >= static_cast<unsigned int>(IDLE_STAGES.size()))
+          {
+            m_idle_stage = static_cast<int>(IDLE_STAGES.size()) - 1;
+            m_sprite->set_action(sa_prefix + ("-" + IDLE_STAGES[m_idle_stage]) + sa_postfix);
+            m_sprite->set_animation_loops(-1);
+          }
+          else
+            m_sprite->set_action(sa_prefix + ("-" + IDLE_STAGES[m_idle_stage]) + sa_postfix, 1);
         }
       }
-      else {
-        m_sprite->set_action(sa_prefix+("-" + IDLE_STAGES[m_idle_stage])+sa_postfix, Sprite::LOOPS_CONTINUED);
+      else
+      {
+        if (m_idle_stage != 0 || m_sprite->get_action() != sa_prefix + ("-" + IDLE_STAGES[0]) + sa_postfix)
+        {
+          m_idle_stage = 0;
+          m_sprite->set_action(sa_prefix + ("-" + IDLE_STAGES[0]) + sa_postfix);
+          m_sprite->set_animation_loops(-1);
+        }
+        m_fancy_idle_active = false;
       }
     }
     else
     {
-      if (std::abs(m_physic.get_velocity_x()) >= MAX_RUN_XM-3)
-      {
-        m_sprite->set_action(sa_prefix+"-run"+sa_postfix);
-      }
+      if (std::abs(m_physic.get_velocity_x()) >= MAX_RUN_XM - 3)
+        m_sprite->set_action(sa_prefix + "-run" + sa_postfix);
       else
-      {
-        m_sprite->set_action(sa_prefix+"-walk"+sa_postfix);
-      }
+        m_sprite->set_action(sa_prefix + "-walk" + sa_postfix);
+
+      m_fancy_idle_active = false;
     }
   }
 
@@ -3082,6 +3102,8 @@ Player::register_class(ssq::VM& vm)
   cls.addFunc("make_invincible", &Player::make_invincible);
   cls.addFunc("deactivate", &Player::deactivate);
   cls.addFunc("activate", &Player::activate);
+  cls.addFunc("enable_fancy_idling", &Player::enable_fancy_idling);
+  cls.addFunc("disable_fancy_idling", &Player::disable_fancy_idling);
   cls.addFunc("walk", &Player::walk);
   cls.addFunc("set_dir", &Player::set_dir);
   cls.addFunc("set_visible", &Player::set_visible);

src/object/player.hpp

@@ -390,6 +390,17 @@ class Player final : public MovingObject
    */
   void deactivate();
 
+  /**
+   * @scripting
+   * @description Enables Tux's fancy idle animations.
+   */ 
+  inline void enable_fancy_idling() { m_should_fancy_idle = true; }
+  /**
+   * @scripting
+   * @description Disables Tux's fancy idle animations.
+   */
+  inline void disable_fancy_idling() { m_should_fancy_idle = false; }
+
   /**
    * @scripting
    * @description Gets whether the current input on the keyboard/controller/touchpad has been pressed.
@@ -612,6 +623,9 @@ class Player final : public MovingObject
   Timer m_bubble_timer; /**< timer for spawning bubble particles */
   std::list<std::pair<SpritePtr, Vector>> m_active_bubbles; /**< active bubble particles */
 
+  bool m_should_fancy_idle;
+  bool m_fancy_idle_active;
+
   Vector m_floor_normal;
 
   bool m_ghost_mode; /**< indicates if Tux should float around and through solid objects */