Item Pocket (#3070)

Original description by MatusGuy:
The Item Pocket allows you to save a powerup for later use. If you collect a flower while having a bonus greater than GROWUP_BONUS, that flower gets equipped and the old flower gets stored in the top left corner of the screen. Now, the player can press the new ITEM control (usually Select/Back or Left Shift) to use the stored flower by throwing it up and catching it.

This pull request replaces the powerup stacking feature because this new solution is much more balanced. It also limits the amount of concurrent players to 4.

* aeiou

* add item pocket input

* item pocket workie

* item pocket hud

* lifesaver texture

Co-authored-by: RustyBox@users.noreply.github.com

* item pocket bare minimum

* god fujjgking damngit

* THINGS

* pepsi pocket

Co-authored-by: RustyBox <RustyBox@users.noreply.github.com>

* this is for the good of the item economy

* more bugs fickesed

* powerup stacking is gone

* editor

* fix ci

* setting wip

* item pocket setting complete

* agjhag

* tdjyfjgfjgf

* bitch

* the anticheat mechanism

* omfg

* wip [ci skip]

* wip again [ci skip]

* script

* augh squirrel thing

* Apply suggestions from code review

Co-authored-by: Vankata453 <78196474+Vankata453@users.noreply.github.com>

* Fix being unable to spawn player [ci skip]

* Remove code duplication in `MultiplayerPlayerMenu`, do not remove players from status

[ci skip]

* Fix scripting documentation consistency with function

* wip script item pocket

* chagne docs

* fix duo player bug weird strange weird

* Scripting docs: Full stops

[ci skip]

* Fix `BonusType` enum descriptions for scripting documentation
[ci skip]

---------

Co-authored-by: MatusGuy <MatusGuy@users.noreply.github.com>
Co-authored-by: RustyBox <RustyBox@users.noreply.github.com>
Co-authored-by: Vankata453 <78196474+Vankata453@users.noreply.github.com>

src/badguy/badguy.cpp

@@ -617,7 +617,7 @@ HitResponse
 BadGuy::collision_bullet(Bullet& bullet, const CollisionHit& hit)
 {
   if (is_frozen()) {
-    if (bullet.get_type() == FIRE_BONUS) {
+    if (bullet.get_type() == BONUS_FIRE) {
       // Fire bullet thaws frozen badguys.
       unfreeze();
       bullet.remove_me();
@@ -629,7 +629,7 @@ BadGuy::collision_bullet(Bullet& bullet, const CollisionHit& hit)
     }
   }
   else if (is_ignited()) {
-    if (bullet.get_type() == ICE_BONUS) {
+    if (bullet.get_type() == BONUS_ICE) {
       // Ice bullets extinguish ignited badguys.
       extinguish();
       bullet.remove_me();
@@ -640,13 +640,13 @@ BadGuy::collision_bullet(Bullet& bullet, const CollisionHit& hit)
       return FORCE_MOVE;
     }
   }
-  else if (bullet.get_type() == FIRE_BONUS && is_flammable()) {
+  else if (bullet.get_type() == BONUS_FIRE && is_flammable()) {
     // Fire bullets ignite flammable badguys.
     ignite();
     bullet.remove_me();
     return ABORT_MOVE;
   }
-  else if (bullet.get_type() == ICE_BONUS && is_freezable()) {
+  else if (bullet.get_type() == BONUS_ICE && is_freezable()) {
     // Ice bullets freeze freezable badguys.
     freeze();
     bullet.remove_me();

src/badguy/boss.cpp

@@ -31,16 +31,19 @@ namespace
 Boss::Boss(const ReaderMapping& reader, const std::string& sprite_name, int layer) :
   BadGuy(reader, sprite_name, layer),
   m_lives(),
+  m_max_lives(),
   m_pinch_lives(),
   m_hud_head(),
   m_hud_icon(),
   m_pinch_mode(),
   m_pinch_activation_script()
 {
   reader.get("lives", m_lives, DEFAULT_LIVES);
-  reader.get("pinch-lives", m_pinch_lives, DEFAULT_PINCH_LIVES);
+  m_max_lives = m_lives;
+
   m_countMe = true;
 
+  reader.get("pinch-lives", m_pinch_lives, DEFAULT_PINCH_LIVES);
   reader.get("pinch-activation-script", m_pinch_activation_script, "");
 }
 
@@ -70,9 +73,13 @@ Boss::draw_hit_points(DrawingContext& context)
     context.set_translation(Vector(0, 0));
     context.transform().scale = 1.f;
 
+    float startpos = (context.get_width() - static_cast<float>((m_hud_head->get_width() * m_max_lives))) / 2;
     for (int i = 0; i < m_lives; ++i)
     {
-      context.color().draw_surface(m_hud_head, Vector(BORDER_X + (static_cast<float>(i * m_hud_head->get_width())), BORDER_Y + 1), LAYER_HUD);
+      context.color().draw_surface(m_hud_head,
+                                   Vector(BORDER_X + (startpos + static_cast<float>(i * m_hud_head->get_width())),
+                                          BORDER_Y + 1),
+                                   LAYER_HUD);
     }
 
     context.pop_transform();
@@ -86,15 +93,15 @@ Boss::get_settings()
 
   result.add_text("hud-icon", &m_hud_icon, "hud-icon", "images/creatures/yeti/hudlife.png", OPTION_HIDDEN);
   result.add_int(_("Lives"), &m_lives, "lives", DEFAULT_LIVES);
-  
-  /* l10n: Pinch Mode refers to a particular boss mode that gets 
-     activated once the boss has lost the specified amounts of lives. 
+
+  /* l10n: Pinch Mode refers to a particular boss mode that gets
+     activated once the boss has lost the specified amounts of lives.
      This setting specifies how many lives need to be spent until pinch
      mode is activated. */
   result.add_int(_("Lives to Pinch Mode"), &m_pinch_lives, "pinch-lives", DEFAULT_PINCH_LIVES);
 
-  /* l10n: Pinch Mode refers to a particular boss mode that gets 
-    activated once the boss has lost the specified amounts of lives. 
+  /* l10n: Pinch Mode refers to a particular boss mode that gets
+    activated once the boss has lost the specified amounts of lives.
     This setting specifies the squirrel script that gets run to activate boss mode.  */
   result.add_script(_("Pinch Mode Activation Script"), &m_pinch_activation_script, "pinch-activation-script");
 

src/badguy/boss.hpp

@@ -37,6 +37,7 @@ class Boss : public BadGuy
 
 protected:
   int m_lives;
+  int m_max_lives;
   int m_pinch_lives;
   SurfacePtr m_hud_head;
   std::string m_hud_icon;

src/badguy/snowman.cpp

@@ -54,7 +54,7 @@ Snowman::loose_head()
 HitResponse
 Snowman::collision_bullet(Bullet& bullet, const CollisionHit& hit)
 {
-  if (bullet.get_type() == FIRE_BONUS) {
+  if (bullet.get_type() == BONUS_FIRE) {
     // Fire bullets destroy snowman's body.
     Vector snowball_pos = get_pos();
     // Hard-coded values from sprites.

src/badguy/stalactite.cpp

@@ -147,7 +147,7 @@ Stalactite::collision_bullet(Bullet& bullet, const CollisionHit& hit)
     timer.start(SHAKE_TIME);
     state = STALACTITE_SHAKING;
     bullet.remove_me();
-    if (bullet.get_type() == FIRE_BONUS)
+    if (bullet.get_type() == BONUS_FIRE)
       SoundManager::current()->play("sounds/sizzle.ogg", get_pos());
     SoundManager::current()->play("sounds/cracking.wav", get_pos());
   }

src/control/controller.cpp

@@ -27,6 +27,7 @@ const char* g_control_names[] = {
   "down",
   "jump",
   "action",
+  "item",
   "start",
   "escape",
   "menu-select",

src/control/controller.hpp

@@ -29,6 +29,7 @@ enum class Control {
 
   JUMP,
   ACTION,
+  ITEM,
 
   START,
   ESCAPE,

src/control/game_controller_manager.cpp

@@ -24,7 +24,6 @@
 #include "supertux/globals.hpp"
 #include "supertux/game_session.hpp"
 #include "supertux/savegame.hpp"
-#include "supertux/sector.hpp"
 #include "util/log.hpp"
 
 GameControllerManager::GameControllerManager(InputManager* parent) :
@@ -84,7 +83,7 @@ GameControllerManager::process_button_event(const SDL_ControllerButtonEvent& ev)
       break;
 
     case SDL_CONTROLLER_BUTTON_BACK:
-      set_control(Control::CONSOLE, ev.state);
+      set_control(Control::ITEM, ev.state);
       break;
 
     case SDL_CONTROLLER_BUTTON_GUIDE:
@@ -205,6 +204,9 @@ GameControllerManager::process_axis_event(const SDL_ControllerAxisEvent& ev)
 void
 GameControllerManager::on_controller_added(int joystick_index)
 {
+  if (!m_parent->can_add_user())
+    return;
+
   if (!SDL_IsGameController(joystick_index))
   {
     log_warning << "joystick is not a game controller, ignoring: " << joystick_index << std::endl;
@@ -240,16 +242,7 @@ GameControllerManager::on_controller_added(int joystick_index)
 
         if (GameSession::current() && !GameSession::current()->get_savegame().is_title_screen() && id != 0)
         {
-          auto& sector = GameSession::current()->get_current_sector();
-          auto& player_status = GameSession::current()->get_savegame().get_player_status();
-
-          if (player_status.m_num_players <= id)
-            player_status.add_player();
-
-          // ID = 0 is impossible, so no need to write `(id == 0) ? "" : ...`
-          auto& player = sector.add<Player>(player_status, "Tux" + std::to_string(id + 1), id);
-
-          player.multiplayer_prepare_spawn();
+          GameSession::current()->on_player_added(id);
         }
       }
     }
@@ -272,22 +265,10 @@ GameControllerManager::on_controller_removed(int instance_id)
     m_game_controllers.erase(it);
 
     if (m_parent->m_use_game_controller && g_config->multiplayer_auto_manage_players
-        && deleted_player_id != 0 && !m_parent->m_uses_keyboard[deleted_player_id])
+        && deleted_player_id != 0 && !m_parent->m_uses_keyboard[deleted_player_id] &&
+        GameSession::current())
     {
-      // Sectors in worldmaps have no Player's of that class.
-      if (Sector::current() && Sector::current()->get_object_count<Player>() > 0)
-      {
-        auto players = Sector::current()->get_objects_by_type<Player>();
-        auto it_players = players.begin();
-
-        while (it_players != players.end())
-        {
-          if (it_players->get_id() == deleted_player_id)
-            it_players->remove_me();
-
-          it_players++;
-        }
-      }
+      GameSession::current()->on_player_removed(deleted_player_id);
     }
   }
   else

src/control/input_manager.cpp

@@ -23,6 +23,8 @@
 #include "control/keyboard_manager.hpp"
 #include "util/log.hpp"
 
+static constexpr int MAX_PLAYERS = 4;
+
 InputManager::InputManager(KeyboardConfig& keyboard_config,
                            JoystickConfig& joystick_config) :
   m_controllers(),
@@ -51,6 +53,12 @@ InputManager::get_controller(int player_id)
   return *m_controllers[player_id];
 }
 
+bool
+InputManager::can_add_user() const
+{
+  return get_num_users() < MAX_PLAYERS;
+}
+
 void
 InputManager::use_game_controller(bool v)
 {
@@ -139,6 +147,9 @@ InputManager::process_event(const SDL_Event& event)
 void
 InputManager::push_user()
 {
+  if (!can_add_user())
+    return;
+
   m_controllers.push_back(std::make_unique<Controller>());
 }
 

src/control/input_manager.hpp

@@ -59,7 +59,7 @@ class InputManager final : public Currenton<InputManager>
   Controller& get_controller(int player_id = 0);
 
   int get_num_users() const { return static_cast<int>(m_controllers.size()); }
-
+  bool can_add_user() const;
   void push_user();
   void pop_user();
 

src/control/joystick_config.cpp

@@ -38,6 +38,7 @@ JoystickConfig::JoystickConfig() :
   bind_joybutton(0, 4, Control::PEEK_LEFT);
   bind_joybutton(0, 5, Control::PEEK_RIGHT);
   bind_joybutton(0, 6, Control::START);
+  bind_joybutton(0, 7, Control::ITEM);
 
   // Default joystick axis configuration
   bind_joyaxis(0, -1, Control::LEFT);

src/control/joystick_manager.cpp

@@ -26,7 +26,6 @@
 #include "supertux/globals.hpp"
 #include "supertux/game_session.hpp"
 #include "supertux/savegame.hpp"
-#include "supertux/sector.hpp"
 #include "util/log.hpp"
 
 JoystickManager::JoystickManager(InputManager* parent_,
@@ -55,6 +54,10 @@ void
 JoystickManager::on_joystick_added(int joystick_index)
 {
   log_debug << "on_joystick_added(): " << joystick_index << std::endl;
+
+  if (!parent->can_add_user())
+    return;
+
   SDL_Joystick* joystick = SDL_JoystickOpen(joystick_index);
   if (!joystick)
   {
@@ -96,16 +99,7 @@ JoystickManager::on_joystick_added(int joystick_index)
 
       if (GameSession::current() && !GameSession::current()->get_savegame().is_title_screen() && id != 0)
       {
-        auto& sector = GameSession::current()->get_current_sector();
-        auto& player_status = GameSession::current()->get_savegame().get_player_status();
-
-        if (player_status.m_num_players <= id)
-          player_status.add_player();
-
-        // ID = 0 is impossible, so no need to write `(id == 0) ? "" : ...`
-        auto& player = sector.add<Player>(player_status, "Tux" + std::to_string(id + 1), id);
-
-        player.multiplayer_prepare_spawn();
+        GameSession::current()->on_player_added(id);
       }
     }
   }
@@ -129,22 +123,10 @@ JoystickManager::on_joystick_removed(int instance_id)
     joysticks.erase(it);
 
     if (!parent->m_use_game_controller && g_config->multiplayer_auto_manage_players
-        && deleted_player_id != 0 && !parent->m_uses_keyboard[deleted_player_id])
+        && deleted_player_id != 0 && !parent->m_uses_keyboard[deleted_player_id] &&
+        GameSession::current())
     {
-      // Sectors in worldmaps have no Player's of that class
-      if (Sector::current() && Sector::current()->get_object_count<Player>() > 0)
-      {
-        auto players = Sector::current()->get_objects_by_type<Player>();
-        auto it_players = players.begin();
-
-        while (it_players != players.end())
-        {
-          if (it_players->get_id() == deleted_player_id)
-            it_players->remove_me();
-
-          it_players++;
-        }
-      }
+      GameSession::current()->on_player_removed(deleted_player_id);
     }
   }
   else

src/control/keyboard_config.cpp

@@ -34,6 +34,7 @@ KeyboardConfig::KeyboardConfig() :
     Control::RIGHT,
     Control::JUMP,
     Control::ACTION,
+    Control::ITEM,
     Control::PEEK_LEFT,
     Control::PEEK_RIGHT,
     Control::PEEK_UP,
@@ -51,6 +52,7 @@ KeyboardConfig::KeyboardConfig() :
   m_keymap[SDLK_DOWN]      = {0, Control::DOWN};
   m_keymap[SDLK_SPACE]     = {0, Control::JUMP};
   m_keymap[SDLK_LCTRL]     = {0, Control::ACTION};
+  m_keymap[SDLK_LSHIFT]    = {0, Control::ITEM};
   m_keymap[SDLK_ESCAPE]    = {0, Control::ESCAPE};
   m_keymap[SDLK_p]         = {0, Control::START};
   m_keymap[SDLK_PAUSE]     = {0, Control::START};
@@ -64,20 +66,6 @@ KeyboardConfig::KeyboardConfig() :
   m_keymap[SDLK_F1]        = {0, Control::CHEAT_MENU};
   m_keymap[SDLK_F2]        = {0, Control::DEBUG_MENU};
   m_keymap[SDLK_BACKSPACE] = {0, Control::REMOVE};
-
-  m_keymap[SDLK_a]         = {1, Control::LEFT};
-  m_keymap[SDLK_d]         = {1, Control::RIGHT};
-  m_keymap[SDLK_w]         = {1, Control::UP};
-  m_keymap[SDLK_s]         = {1, Control::DOWN};
-  m_keymap[SDLK_e]         = {1, Control::JUMP};
-  m_keymap[SDLK_q]         = {1, Control::ACTION};
-
-  m_keymap[SDLK_j]         = {2, Control::LEFT};
-  m_keymap[SDLK_l]         = {2, Control::RIGHT};
-  m_keymap[SDLK_i]         = {2, Control::UP};
-  m_keymap[SDLK_k]         = {2, Control::DOWN};
-  m_keymap[SDLK_o]         = {2, Control::JUMP};
-  m_keymap[SDLK_u]         = {2, Control::ACTION};
 }
 
 void