[MOM] Farhand loots items (#82329)

* simple implementation of pickup_items eoc

* basic far hand proof of concept

* Pickup allows multiple arbitrary tiles

* Finish pickup spell effect + demo with farhand

* basic constraints implementation

* remove pickup_constraints struct, just use pick_info instead

* hook up pickup spell effect to pick_info fully

* Set up final spell definitions

* documentation

* hook up eoc to extra parameters

* astyle

* initialization order

* remove unused variable

* slowly fix the errors discovered by general build

* fix build

* clang

* IWYU

* astyle

* more clang

Author: b3brodie

data/mods/MindOverMatter/powers/telekinesis.json

@@ -4,7 +4,7 @@
     "//": "power ID exists for legacy reasons",
     "type": "SPELL",
     "name": "[Ψ]Far Hand",
-    "description": "Move a set of items towards or away from you.",
+    "description": "Pickup items at a distance or push them away from you.",
     "message": "",
     "teachable": false,
     "valid_targets": [ "self" ],
@@ -32,31 +32,41 @@
     "description": { "str": "The actual effect that causes the far hand.  It's a bug if you have it.", "//~": "NO_I18N" },
     "message": "",
     "teachable": false,
-    "valid_targets": [ "item", "ground" ],
+    "valid_targets": [ "item", "ground", "self", "ally", "hostile" ],
     "skill": "metaphysics",
     "flags": [ "PSIONIC", "RANDOM_DAMAGE", "NO_HANDS", "NO_LEGS", "NO_EXPLOSION_SFX" ],
     "difficulty": 1,
     "max_level": { "math": [ "int_to_level(1)" ] },
-    "effect": "directed_push",
+    "effect": "pickup",
     "shape": "blast",
     "min_damage": {
       "math": [
-        "min( (( (u_spell_level('telekinetic_pull') * 0.4) + 1) * (scaling_factor(u_val('intelligence') ) ) * u_nether_attunement_power_scaling * -1), 40)"
+        "max( 50 - ( ( u_spell_level('telekinetic_pull') * 3 ) * ( scaling_factor( u_val('intelligence') ) ) * u_nether_attunement_power_scaling ), 0 )"
       ]
     },
     "max_damage": {
       "math": [
-        "min( (( (u_spell_level('telekinetic_pull') * 0.9) + 4) * (scaling_factor(u_val('intelligence') ) ) * u_nether_attunement_power_scaling * -1), 40)"
+        "max( 100 - ( ( u_spell_level('telekinetic_pull') * 4 ) * ( scaling_factor( u_val('intelligence') ) ) * u_nether_attunement_power_scaling ), 0 )"
+      ]
+    },
+    "min_aoe": {
+      "math": [
+        "( u_spell_level('telekinetic_pull') * 0.2 ) * ( scaling_factor( u_val('intelligence') ) ) * u_nether_attunement_power_scaling"
+      ]
+    },
+    "max_aoe": {
+      "math": [
+        "( u_spell_level('telekinetic_pull') * 0.2 ) * ( scaling_factor( u_val('intelligence') ) ) * u_nether_attunement_power_scaling"
       ]
     },
     "min_range": {
       "math": [
-        "min( (( (u_spell_level('telekinetic_pull') * 0.9) + 2) * (scaling_factor(u_val('intelligence') ) ) * u_nether_attunement_power_scaling), 40)"
+        "min( ( ( ( u_spell_level('telekinetic_pull') * 0.9 ) + 2 ) * ( scaling_factor( u_val('intelligence') ) ) * u_nether_attunement_power_scaling ), 40 )"
       ]
     },
     "max_range": {
       "math": [
-        "min( (( (u_spell_level('telekinetic_pull') * 0.9) + 2) * (scaling_factor(u_val('intelligence') ) ) * u_nether_attunement_power_scaling), 40)"
+        "min( ( ( ( u_spell_level('telekinetic_pull') * 0.9 ) + 2 ) * ( scaling_factor( u_val('intelligence') ) ) * u_nether_attunement_power_scaling ), 40 )"
       ]
     }
   },

doc/JSON/MAGIC.md

@@ -206,6 +206,7 @@ Effect                 | Description
 `noise`                | Causes damage() amount of noise at the target.  Note: the noise can be described further with `sound_type`, `sound_description`, `sound_ambient`, `sound_id` and `sound_variant`.
 `pain_split`           | Evens out all of your limbs' damage.
 `pull_target`          | Attempts to pull the target towards the caster in a straight line.  If the path is blocked by impassable furniture or terrain, the effect fails.
+`pickup`               | Opens up the pickup menu at the target(s), allowing characters to pick up items at the area.  For every 1 damage in the spell's definition, each item takes 1 extra move to pick up.
 `recharge_vehicle`     | Increases or decreases the battery charge of a vehicle or battery-connected power grid. Damage is equal to the charge (negative decreases).
 `recover_energy`       | Recovers an energy source equal to damage of the spell and may be one of `BIONIC`, `SLEEPINESS`, `PAIN`, `MANA` or `STAMINA`. Alternative notation can be used for spell consuming vitamins, see example below
 `remove_effect`        | Removes `effect_str` effects from all creatures in the aoe.

src/activity_actor_definitions.h

@@ -555,6 +555,14 @@ class pickup_activity_actor : public activity_actor
                                const std::optional<tripoint_bub_ms> &starting_pos,
                                bool autopickup ) : target_items( target_items ),
             quantities( quantities ), starting_pos( starting_pos ), stash_successful( true ),
+            autopickup( autopickup ) {
+            info = Pickup::pick_info();
+        }
+        pickup_activity_actor( const std::vector<item_location> &target_items,
+                               const std::vector<int> &quantities,
+                               const std::optional<tripoint_bub_ms> &starting_pos,
+                               bool autopickup, Pickup::pick_info &info ) : target_items( target_items ),
+            quantities( quantities ), info( info ), starting_pos( starting_pos ), stash_successful( true ),
             autopickup( autopickup ) {}
 
         /**

src/character.h

@@ -91,6 +91,11 @@ namespace catacurses
 {
 class window;
 }  // namespace catacurses
+namespace Pickup
+{
+struct pick_info;
+} // namespace Pickup
+
 enum action_id : int;
 enum class proficiency_bonus_type : int;
 enum class recipe_filter_flags : int;
@@ -2455,6 +2460,7 @@ class Character : public Creature, public visitable
          *  Requires sufficient storage; items cannot be wielded or worn from this activity.
          */
         void pick_up( const drop_locations &what );
+        void pick_up( const drop_locations &what, Pickup::pick_info &info );
 
         bool is_wielding( const item &target ) const;
 

src/character_inventory.cpp

@@ -34,6 +34,7 @@
 #include "map.h"
 #include "map_selector.h"
 #include "options.h"
+#include "pickup.h"
 #include "pimpl.h"
 #include "pocket_type.h"
 #include "ret_val.h"
@@ -623,6 +624,12 @@ void Character::drop( const drop_locations &what, const tripoint_bub_ms &target,
 }
 
 void Character::pick_up( const drop_locations &what )
+{
+    Pickup::pick_info pick_info = Pickup::pick_info();
+    pick_up( what, pick_info );
+}
+
+void Character::pick_up( const drop_locations &what, Pickup::pick_info &info )
 {
     if( what.empty() ) {
         return;
@@ -639,7 +646,7 @@ void Character::pick_up( const drop_locations &what )
     }
 
     last_item = item( *items.back() ).typeId();
-    assign_activity( pickup_activity_actor( items, quantities, pos_bub(), false ) );
+    assign_activity( pickup_activity_actor( items, quantities, pos_bub(), false, info ) );
 }
 
 invlets_bitset Character::allocated_invlets() const

src/game.cpp

@@ -6485,7 +6485,7 @@ void game::pickup()
         return;
     }
     // Pick up items only from the selected tile
-    u.pick_up( game_menus::inv::pickup( where_ ) );
+    u.pick_up( game_menus::inv::pickup( {where_.value()} ) );
 }
 
 void game::pickup_all()
@@ -6505,7 +6505,7 @@ void game::pickup( const tripoint_bub_ms &p )
     add_draw_callback( hilite_cb );
 
     // Pick up items only from the selected tile
-    u.pick_up( game_menus::inv::pickup( p ) );
+    u.pick_up( game_menus::inv::pickup( {p} ) );
 }
 
 //Shift player by one tile, look_around(), then restore previous position.

src/game_inventory.cpp

@@ -48,6 +48,7 @@
 #include "npctrade.h"
 #include "options.h"
 #include "output.h"
+#include "pickup.h"
 #include "pimpl.h"
 #include "player_activity.h"
 #include "pocket_type.h"
@@ -2426,26 +2427,41 @@ drop_locations game_menus::inv::multidrop( Character &you )
     return inv_s.execute();
 }
 
-drop_locations game_menus::inv::pickup( const std::optional<tripoint_bub_ms> &target,
+drop_locations game_menus::inv::pickup( const std::set<tripoint_bub_ms> &targets )
+{
+    return pickup( targets, {} );
+}
+
+drop_locations game_menus::inv::pickup( const std::set<tripoint_bub_ms> &targets,
                                         const std::vector<drop_location> &selection )
+{
+    Pickup::pick_info pickup_info = Pickup::pick_info();
+    return pickup( targets, selection, pickup_info );
+}
+
+drop_locations game_menus::inv::pickup( const std::set<tripoint_bub_ms> &targets,
+                                        const std::vector<drop_location> &selection,
+                                        Pickup::pick_info &info )
 {
     avatar &you = get_avatar();
     pickup_inventory_preset preset( you, /*skip_wield_check=*/true, /*ignore_liquidcont=*/true );
     preset.save_state = &pickup_ui_default_state;
 
-    pickup_selector pick_s( you, preset, _( "ITEMS TO PICK UP" ), target );
+    pickup_selector pick_s( you, preset, _( "ITEMS TO PICK UP" ), targets );
 
     // Add items from the selected tile, or from current and all surrounding tiles
-    if( target ) {
-        pick_s.add_vehicle_items( *target );
-        pick_s.add_map_items( *target );
+    if( !targets.empty() ) {
+        for( tripoint_bub_ms target : targets ) {
+            pick_s.add_vehicle_items( target );
+            pick_s.add_map_items( target );
+        }
     } else {
         pick_s.add_nearby_items();
     }
     pick_s.set_title( _( "Pickup" ) );
 
     if( pick_s.empty() ) {
-        if( target ) {
+        if( !targets.empty() ) {
             add_msg( _( "There is nothing to pick up." ) );
         } else {
             add_msg( _( "There is nothing to pick up nearby." ) );
@@ -2457,6 +2473,12 @@ drop_locations game_menus::inv::pickup( const std::optional<tripoint_bub_ms> &ta
         pick_s.apply_selection( selection );
     }
 
+    if( info.max_volume != -1_ml ) {
+        pick_s.overriden_volume = info.max_volume;
+    }
+    if( info.max_mass != -1_gram ) {
+        pick_s.overriden_mass = info.max_mass;
+    }
     return pick_s.execute();
 }
 

src/game_inventory.h

@@ -27,6 +27,11 @@ enum efile_action : int;
 using item_filter = std::function<bool( const item & )>;
 using item_location_filter = std::function<bool ( const item_location & )>;
 
+namespace Pickup
+{
+struct pick_info;
+} // namespace Pickup
+
 /**
 * A boiled-down shortcut for inventory_selector_preset.
 * @param filter - function solely determines what is shown in the item list.
@@ -113,8 +118,12 @@ drop_locations multidrop( Character &you );
  * Otherwise, pick up items from the avatar's current location and all adjacent tiles.
  * @return A list of pairs of item_location, quantity.
  */
-drop_locations pickup( const std::optional<tripoint_bub_ms> &target = std::nullopt,
-                       const std::vector<drop_location> &selection = {} );
+drop_locations pickup( const std::set<tripoint_bub_ms> &targets = {} );
+drop_locations pickup( const std::set<tripoint_bub_ms> &targets,
+                       const std::vector<drop_location> &selection );
+drop_locations pickup( const std::set<tripoint_bub_ms> &targets,
+                       const std::vector<drop_location> &selection,
+                       Pickup::pick_info &info );
 
 drop_locations smoke_food( Character &you, units::volume total_capacity,
                            units::volume used_capacity );

src/inventory_ui.cpp

@@ -4239,7 +4239,7 @@ inventory_selector::stats inventory_insert_selector::get_raw_stats() const
 }
 
 pickup_selector::pickup_selector( Character &p, const inventory_selector_preset &preset,
-                                  const std::string &selection_column_title, const std::optional<tripoint_bub_ms> &where ) :
+                                  const std::string &selection_column_title, const std::set<tripoint_bub_ms> &where ) :
     inventory_multiselector( p, preset, selection_column_title ), where( where )
 {
     ctxt.register_action( "WEAR" );
@@ -4362,11 +4362,7 @@ void pickup_selector::reopen_menu()
 {
     // copy the member variables to still be valid on call
     uistate.open_menu = [where = where, to_use = to_use]() {
-        std::optional<tripoint_bub_ms> temp;
-        if( where.has_value() ) {
-            temp = tripoint_bub_ms( where.value() );
-        }
-        get_player_character().pick_up( game_menus::inv::pickup( temp, to_use ) );
+        get_player_character().pick_up( game_menus::inv::pickup( where, to_use ) );
     };
 }
 
@@ -4409,9 +4405,9 @@ inventory_selector::stats pickup_selector::get_raw_stats() const
 
     return get_weight_and_volume_and_holster_stats(
                u.weight_carried() + weight,
-               u.weight_capacity(),
+               overriden_mass.has_value() ? overriden_mass.value() : u.weight_capacity(),
                u.volume_carried() + volume,
-               u.volume_capacity(),
+               overriden_volume.has_value() ? overriden_volume.value() : u.volume_capacity(),
                u.max_single_item_length(),
                u.max_single_item_volume(),
                u.free_holster_volume(),

src/inventory_ui.h

@@ -11,6 +11,7 @@
 #include <list>
 #include <memory>
 #include <optional>
+#include <set>
 #include <string>
 #include <string_view>
 #include <utility>
@@ -28,7 +29,7 @@
 #include "pocket_type.h"
 #include "point.h"
 #include "translations.h"
-#include "units_fwd.h"
+#include "units.h"
 
 class Character;
 class JsonObject;
@@ -1086,9 +1087,12 @@ class pickup_selector : public inventory_multiselector
     public:
         explicit pickup_selector( Character &p, const inventory_selector_preset &preset = default_preset,
                                   const std::string &selection_column_title = _( "ITEMS TO PICK UP" ),
-                                  const std::optional<tripoint_bub_ms> &where = std::nullopt );
+                                  const std::set<tripoint_bub_ms> &where = {} );
         drop_locations execute();
         void apply_selection( std::vector<drop_location> selection );
+
+        std::optional<units::volume> overriden_volume;
+        std::optional<units::mass> overriden_mass;
     protected:
         stats get_raw_stats() const override;
         void reassign_custom_invlets() override;
@@ -1097,7 +1101,7 @@ class pickup_selector : public inventory_multiselector
         bool wear();
         void remove_from_to_use( item_location &it );
         void reopen_menu();
-        const std::optional<tripoint_bub_ms> where;
+        const std::set<tripoint_bub_ms> where;
 };
 
 class unload_selector : public inventory_pick_selector