veloren_server/events/
inventory_manip.rs

1use hashbrown::HashSet;
2use rand::seq::IteratorRandom;
3use specs::{
4    DispatcherBuilder, Entities, Entity as EcsEntity, Read, ReadExpect, ReadStorage, SystemData,
5    Write, WriteStorage, join::Join, shred,
6};
7use tracing::{debug, error, warn};
8use vek::{Rgb, Vec3};
9
10use common::{
11    comp::{
12        self, InventoryUpdate, LootOwner, PickupItem,
13        group::members,
14        item::{self, MaterialStatManifest, flatten_counted_items, tool::AbilityMap},
15        loot_owner::LootOwnerKind,
16        slot::{self, Slot},
17    },
18    consts::MAX_PICKUP_RANGE,
19    event::{
20        BuffEvent, CreateItemDropEvent, CreateObjectEvent, DeleteEvent, EmitExt, HealthChangeEvent,
21        InventoryManipEvent, PoiseChangeEvent, TamePetEvent,
22    },
23    event_emitters,
24    mounting::VolumePos,
25    recipe::{self, RecipeBookManifest, default_component_recipe_book, default_repair_recipe_book},
26    resources::{ProgramTime, Time},
27    terrain::{Block, SpriteKind},
28    trade::Trades,
29    uid::{IdMaps, Uid},
30    util::find_dist::{self, FindDist},
31    vol::ReadVol,
32};
33use comp::LightEmitter;
34
35use crate::client::Client;
36use common::comp::{Alignment, CollectFailedReason, Group, InventoryUpdateEvent, pet::is_tameable};
37use common_net::msg::ServerGeneral;
38
39use super::{ServerEvent, entity_manipulation::emit_effect_events, event_dispatch};
40
41pub(super) fn register_event_systems(builder: &mut DispatcherBuilder) {
42    event_dispatch::<InventoryManipEvent>(builder, &[]);
43}
44
45pub fn swap_lantern(
46    storage: &mut WriteStorage<LightEmitter>,
47    entity: EcsEntity,
48    (lantern_color, lantern_strength): (Rgb<f32>, f32),
49) {
50    if let Some(mut light) = storage.get_mut(entity) {
51        light.strength = lantern_strength;
52        light.col = lantern_color;
53    }
54}
55
56pub fn snuff_lantern(storage: &mut WriteStorage<LightEmitter>, entity: EcsEntity) {
57    storage.remove(entity);
58}
59
60event_emitters! {
61    struct Events[Emitters] {
62        tame_pet: TamePetEvent,
63        delete: DeleteEvent,
64        create_item_drop: CreateItemDropEvent,
65        create_object: CreateObjectEvent,
66        health_change: HealthChangeEvent,
67        poise_change: PoiseChangeEvent,
68        buff: BuffEvent,
69    }
70}
71#[derive(SystemData)]
72pub struct InventoryManipData<'a> {
73    entities: Entities<'a>,
74    events: Events<'a>,
75    block_change: Write<'a, common_state::BlockChange>,
76    trades: Write<'a, Trades>,
77    #[cfg(feature = "worldgen")]
78    rtsim: specs::WriteExpect<'a, crate::rtsim::RtSim>,
79    terrain: ReadExpect<'a, common::terrain::TerrainGrid>,
80    id_maps: Read<'a, IdMaps>,
81    time: Read<'a, Time>,
82    #[cfg(feature = "worldgen")]
83    world: ReadExpect<'a, std::sync::Arc<world::World>>,
84    #[cfg(feature = "worldgen")]
85    index: ReadExpect<'a, world::IndexOwned>,
86    program_time: ReadExpect<'a, ProgramTime>,
87    ability_map: ReadExpect<'a, AbilityMap>,
88    msm: ReadExpect<'a, MaterialStatManifest>,
89    rbm: ReadExpect<'a, RecipeBookManifest>,
90    inventories: WriteStorage<'a, comp::Inventory>,
91    items: WriteStorage<'a, comp::PickupItem>,
92    inventory_updates: WriteStorage<'a, comp::InventoryUpdate>,
93    light_emitters: WriteStorage<'a, comp::LightEmitter>,
94    positions: ReadStorage<'a, comp::Pos>,
95    scales: ReadStorage<'a, comp::Scale>,
96    colliders: ReadStorage<'a, comp::Collider>,
97    character_states: ReadStorage<'a, comp::CharacterState>,
98    healths: ReadStorage<'a, comp::Health>,
99    uids: ReadStorage<'a, Uid>,
100    loot_owners: ReadStorage<'a, comp::LootOwner>,
101    alignments: ReadStorage<'a, comp::Alignment>,
102    bodies: ReadStorage<'a, comp::Body>,
103    players: ReadStorage<'a, comp::Player>,
104    groups: ReadStorage<'a, comp::Group>,
105    stats: ReadStorage<'a, comp::Stats>,
106    clients: ReadStorage<'a, Client>,
107    orientations: ReadStorage<'a, comp::Ori>,
108    agents: ReadStorage<'a, comp::Agent>,
109    pets: ReadStorage<'a, comp::Pet>,
110    masses: ReadStorage<'a, comp::Mass>,
111    #[cfg(feature = "worldgen")]
112    presences: ReadStorage<'a, comp::Presence>,
113    #[cfg(feature = "worldgen")]
114    rtsim_entities: ReadStorage<'a, common::rtsim::RtSimEntity>,
115}
116
117impl ServerEvent for InventoryManipEvent {
118    type SystemData<'a> = InventoryManipData<'a>;
119
120    fn handle(events: impl ExactSizeIterator<Item = Self>, mut data: Self::SystemData<'_>) {
121        let mut emitters = data.events.get_emitters();
122        let get_cylinder = |entity| {
123            data.positions.get(entity).map(|p| {
124                find_dist::Cylinder::from_components(
125                    p.0,
126                    data.scales.get(entity).copied(),
127                    data.colliders.get(entity),
128                    data.character_states.get(entity),
129                )
130            })
131        };
132        let mut rng = rand::thread_rng();
133
134        let mut dropped_items = Vec::new();
135
136        for InventoryManipEvent(entity, manip) in events {
137            let uid = if let Some(uid) = data.uids.get(entity) {
138                uid
139            } else {
140                warn!(
141                    "Couldn't get uid for entity {:?} at start of handle_inventory",
142                    entity
143                );
144                continue;
145            };
146            if data.trades.in_immutable_trade(uid) {
147                // manipulating the inventory can mutate the trade
148                continue;
149            }
150
151            if comp::is_downed_or_dead(data.healths.get(entity), data.character_states.get(entity))
152            {
153                // Can't manipulate the inventory while downed or dead.
154                continue;
155            }
156
157            let mut inventory = if let Some(inventory) = data.inventories.get_mut(entity) {
158                inventory
159            } else {
160                error!(
161                    ?entity,
162                    "Can't manipulate inventory, entity doesn't have one"
163                );
164                continue;
165            };
166            match manip {
167                comp::InventoryManip::Pickup(pickup_uid) => {
168                    let item_entity = if let Some(item_entity) = data.id_maps.uid_entity(pickup_uid)
169                    {
170                        item_entity
171                    } else {
172                        // Item entity could not be found - most likely because the entity
173                        // attempted to pick up the same item very quickly before its deletion
174                        // of the world from the first pickup
175                        // attempt was processed.
176                        debug!("Failed to get entity for item Uid: {}", pickup_uid);
177                        continue;
178                    };
179                    let entity_cylinder = get_cylinder(entity);
180
181                    // FIXME: Raycast so we can't pick up items through walls.
182                    if !within_pickup_range(entity_cylinder, || get_cylinder(item_entity)) {
183                        debug!(
184                            ?entity_cylinder,
185                            "Failed to pick up item as not within range, Uid: {}", pickup_uid
186                        );
187                        continue;
188                    }
189
190                    // If there's a loot owner for the item being picked up, then
191                    // determine whether the pickup should be rejected.
192                    let ownership_check_passed =
193                        data.loot_owners.get(item_entity).is_none_or(|loot_owner| {
194                            let can_pickup = loot_owner.can_pickup(
195                                *uid,
196                                data.groups.get(entity),
197                                data.alignments.get(entity),
198                                data.stats
199                                    .get(entity)
200                                    .map(|stats| &stats.original_body)
201                                    .or_else(|| data.bodies.get(entity)),
202                                data.players.get(entity),
203                            );
204                            if !can_pickup {
205                                let event = comp::InventoryUpdate::new(
206                                    InventoryUpdateEvent::EntityCollectFailed {
207                                        entity: pickup_uid,
208                                        reason: CollectFailedReason::LootOwned {
209                                            owner: loot_owner.owner(),
210                                            expiry_secs: loot_owner
211                                                .time_until_expiration()
212                                                .as_secs(),
213                                        },
214                                    },
215                                );
216                                data.inventory_updates.insert(entity, event).unwrap();
217                            }
218                            can_pickup
219                        });
220
221                    if !ownership_check_passed {
222                        continue;
223                    }
224
225                    // First, we remove the item, assuming picking it up will succeed (we do this to
226                    // avoid cloning the item, as we should not call Item::clone and it
227                    // may be removed!).
228                    let item = if let Some(item) = data.items.remove(item_entity) {
229                        item
230                    } else {
231                        // Item component could not be found - most likely because the entity
232                        // attempted to pick up the same item very quickly before its deletion of
233                        // the world from the first pickup attempt was
234                        // processed.
235                        debug!(
236                            "Failed to delete item component for entity, Uid: {}",
237                            pickup_uid
238                        );
239                        continue;
240                    };
241
242                    const ITEM_ENTITY_EXPECT_MESSAGE: &str = "We know item_entity still exist \
243                                                              since we just successfully removed \
244                                                              its PickupItem component.";
245
246                    let (item, reinsert_item) = item.pick_up();
247
248                    let mut item_msg = item.frontend_item(&data.ability_map, &data.msm);
249
250                    // Next, we try to equip the picked up item
251                    let event = match inventory.try_equip(item).or_else(|returned_item| {
252                        // If we couldn't equip it (no empty slot for it or unequippable) then
253                        // attempt to add the item to the entity's inventory
254                        inventory.pickup_item(returned_item)
255                    }) {
256                        Err((returned_item, inserted)) => {
257                            // If we had a `reinsert_item`, merge returned_item into it
258                            let returned_item = if let Some(mut reinsert_item) = reinsert_item {
259                                reinsert_item
260                                    .try_merge(PickupItem::new(returned_item, *data.program_time))
261                                    .expect(
262                                        "We know this item must be mergeable since it is a \
263                                         duplicate",
264                                    );
265                                reinsert_item
266                            } else {
267                                PickupItem::new(returned_item, *data.program_time)
268                            };
269
270                            // Inventory was full, so we need to put back the item (note that we
271                            // know there was no old item component for
272                            // this entity).
273                            data.items
274                                .insert(item_entity, returned_item)
275                                .expect(ITEM_ENTITY_EXPECT_MESSAGE);
276
277                            // If the item was partially picked up, send a loot annoucement.
278                            if let Some(inserted) = inserted {
279                                // Update the frontend item to the new amount
280                                item_msg
281                                    .set_amount(inserted.get())
282                                    .expect("Inserted must be > 0 and <= item.max_amount()");
283
284                                if let Some(group_id) = data.groups.get(entity) {
285                                    announce_loot_to_group(
286                                        group_id,
287                                        entity,
288                                        item_msg.duplicate(&data.ability_map, &data.msm),
289                                        &data.clients,
290                                        &data.uids,
291                                        &data.groups,
292                                        &data.alignments,
293                                        &data.entities,
294                                        &data.ability_map,
295                                        &data.msm,
296                                    );
297                                }
298                                comp::InventoryUpdate::new(InventoryUpdateEvent::Collected(
299                                    item_msg,
300                                ))
301                            } else {
302                                comp::InventoryUpdate::new(
303                                    InventoryUpdateEvent::EntityCollectFailed {
304                                        entity: pickup_uid,
305                                        reason: CollectFailedReason::InventoryFull,
306                                    },
307                                )
308                            }
309                        },
310                        Ok(_) => {
311                            // We succeeded in picking up the item, so we may now delete its old
312                            // entity entirely.
313                            if let Some(reinsert_item) = reinsert_item {
314                                data.items
315                                    .insert(item_entity, reinsert_item)
316                                    .expect(ITEM_ENTITY_EXPECT_MESSAGE);
317                            } else {
318                                emitters.emit(DeleteEvent(item_entity));
319                            }
320
321                            if let Some(group_id) = data.groups.get(entity) {
322                                announce_loot_to_group(
323                                    group_id,
324                                    entity,
325                                    item_msg.duplicate(&data.ability_map, &data.msm),
326                                    &data.clients,
327                                    &data.uids,
328                                    &data.groups,
329                                    &data.alignments,
330                                    &data.entities,
331                                    &data.ability_map,
332                                    &data.msm,
333                                );
334                            }
335                            comp::InventoryUpdate::new(InventoryUpdateEvent::Collected(item_msg))
336                        },
337                    };
338
339                    data.inventory_updates
340                        .insert(entity, event)
341                        .expect("We know entity exists since we got its inventory.");
342                },
343                comp::InventoryManip::Collect {
344                    sprite_pos,
345                    required_item,
346                } => {
347                    let block = data.terrain.get(sprite_pos).ok().copied();
348                    let mut drop_items = Vec::new();
349                    let inventory_update = data
350                        .inventory_updates
351                        .entry(entity)
352                        .expect("We know entity exists since we got its inventory.")
353                        .or_insert_with(InventoryUpdate::default);
354
355                    if let Some(block) = block {
356                        // If there are items to be reclaimed from the block, add it to the
357                        // inventory
358                        let sprite_cfg = data.terrain.sprite_cfg_at(sprite_pos);
359                        if block
360                            .get_sprite()
361                            .is_some_and(|s| s.is_collectible(sprite_cfg))
362                            && data.block_change.can_set_block(sprite_pos)
363                        {
364                            // Send event to rtsim if something was stolen.
365                            #[cfg(feature = "worldgen")]
366                            if block.is_owned()
367                                && let Some(actor) = super::entity_manipulation::entity_as_actor(
368                                    entity,
369                                    &data.rtsim_entities,
370                                    &data.presences,
371                                )
372                            {
373                                data.rtsim.hook_pickup_owned_sprite(
374                                    &data.world,
375                                    data.index.as_index_ref(),
376                                    block
377                                        .get_sprite()
378                                        .expect("If the block is owned, it is a sprite"),
379                                    sprite_pos,
380                                    actor,
381                                );
382                            }
383                            // If an item was required to collect the sprite, consume it now
384                            if let Some((inv_slot, true)) = required_item {
385                                inventory.take(inv_slot, &data.ability_map, &data.msm);
386                            }
387
388                            if let Some(items) =
389                                comp::Item::try_reclaim_from_block(block, sprite_cfg)
390                            {
391                                for item in
392                                    flatten_counted_items(&items, &data.ability_map, &data.msm)
393                                {
394                                    let mut item_msg =
395                                        item.frontend_item(&data.ability_map, &data.msm);
396                                    let do_announce = match inventory.push(item) {
397                                        Ok(_) => true,
398                                        Err((item, inserted)) => {
399                                            drop_items.push(item);
400                                            if let Some(inserted) = inserted {
401                                                // Update the amount of the frontend item
402                                                item_msg.set_amount(inserted.get()).expect(
403                                                    "Inserted must be > 0 and <= item.max_amount()",
404                                                );
405                                                true
406                                            } else {
407                                                false
408                                            }
409                                        },
410                                    };
411
412                                    if do_announce {
413                                        if let Some(group_id) = data.groups.get(entity) {
414                                            announce_loot_to_group(
415                                                group_id,
416                                                entity,
417                                                item_msg.duplicate(&data.ability_map, &data.msm),
418                                                &data.clients,
419                                                &data.uids,
420                                                &data.groups,
421                                                &data.alignments,
422                                                &data.entities,
423                                                &data.ability_map,
424                                                &data.msm,
425                                            );
426                                        }
427                                        inventory_update
428                                            .push(InventoryUpdateEvent::Collected(item_msg));
429                                    }
430                                }
431                            }
432
433                            // We made sure earlier the block was not already modified this tick
434                            data.block_change.set(sprite_pos, block.into_vacant());
435
436                            // If the block was a keyhole, remove nearby door blocks
437                            // TODO: Abstract this code into a generalised way to do block updates?
438                            if let Some(kind_to_destroy) = match block.get_sprite() {
439                                Some(SpriteKind::Keyhole) => Some(SpriteKind::KeyDoor),
440                                Some(SpriteKind::BoneKeyhole) => Some(SpriteKind::BoneKeyDoor),
441                                Some(SpriteKind::HaniwaKeyhole) => Some(SpriteKind::HaniwaKeyDoor),
442                                Some(SpriteKind::SahaginKeyhole) => {
443                                    Some(SpriteKind::SahaginKeyDoor)
444                                },
445                                Some(SpriteKind::GlassKeyhole) => Some(SpriteKind::GlassBarrier),
446                                Some(SpriteKind::KeyholeBars) => Some(SpriteKind::DoorBars),
447                                Some(SpriteKind::TerracottaKeyhole) => {
448                                    Some(SpriteKind::TerracottaKeyDoor)
449                                },
450                                Some(SpriteKind::VampireKeyhole) => {
451                                    Some(SpriteKind::VampireKeyDoor)
452                                },
453                                Some(SpriteKind::MyrmidonKeyhole | SpriteKind::MinotaurKeyhole) => {
454                                    Some(SpriteKind::MyrmidonKeyDoor)
455                                },
456                                _ => None,
457                            } {
458                                let dirs = [
459                                    Vec3::unit_x(),
460                                    -Vec3::unit_x(),
461                                    Vec3::unit_y(),
462                                    -Vec3::unit_y(),
463                                    Vec3::unit_z(),
464                                    -Vec3::unit_z(),
465                                ];
466                                let mut destroyed = HashSet::<Vec3<i32>>::default();
467                                let mut pending = dirs
468                                    .into_iter()
469                                    .map(|dir| sprite_pos + dir)
470                                    .collect::<HashSet<_>>();
471                                // TODO: Replace with `entry` eventually
472                                while destroyed.len() < 450 {
473                                    if let Some(pos) = pending.iter().next().copied() {
474                                        pending.remove(&pos);
475
476                                        if !destroyed.contains(&pos)
477                                            && data
478                                                .terrain
479                                                .get(pos)
480                                                .ok()
481                                                .and_then(|b| b.get_sprite())
482                                                == Some(kind_to_destroy)
483                                        {
484                                            data.block_change.try_set(pos, Block::empty());
485                                            destroyed.insert(pos);
486                                            pending.extend(dirs.into_iter().map(|dir| pos + dir));
487                                        }
488                                    } else {
489                                        break;
490                                    }
491                                }
492                            }
493                        } else {
494                            debug!(
495                                "Can't reclaim item from block at pos={}: block is not \
496                                 collectable or was already set this tick.",
497                                sprite_pos
498                            );
499                        }
500                    }
501                    if !drop_items.is_empty() {
502                        inventory_update.push(InventoryUpdateEvent::BlockCollectFailed {
503                            pos: sprite_pos,
504                            reason: CollectFailedReason::InventoryFull,
505                        })
506                    }
507
508                    for item in drop_items {
509                        emitters.emit(CreateItemDropEvent {
510                            pos: comp::Pos(
511                                Vec3::new(
512                                    sprite_pos.x as f32,
513                                    sprite_pos.y as f32,
514                                    sprite_pos.z as f32,
515                                ) + Vec3::one().with_z(0.0) * 0.5,
516                            ),
517                            vel: comp::Vel(Vec3::zero()),
518                            ori: data.orientations.get(entity).copied().unwrap_or_default(),
519                            item: PickupItem::new(item, *data.program_time),
520                            loot_owner: Some(LootOwner::new(LootOwnerKind::Player(*uid), false)),
521                        });
522                    }
523                },
524                comp::InventoryManip::Use(slot) => {
525                    let mut maybe_effect = None;
526
527                    let event = match slot {
528                        Slot::Inventory(slot) => {
529                            use item::ItemKind;
530
531                            let (is_equippable, lantern_info) =
532                                inventory.get(slot).map_or((false, None), |i| {
533                                    let kind = i.kind();
534                                    let is_equippable = kind.is_equippable();
535                                    let lantern_info = match &*kind {
536                                        ItemKind::Lantern(lantern) => {
537                                            Some((lantern.color(), lantern.strength()))
538                                        },
539                                        _ => None,
540                                    };
541                                    (is_equippable, lantern_info)
542                                });
543                            if is_equippable {
544                                if let Some(lantern_info) = lantern_info {
545                                    swap_lantern(&mut data.light_emitters, entity, lantern_info);
546                                }
547                                if let Some(pos) = data.positions.get(entity) {
548                                    dropped_items.extend(
549                                        inventory
550                                            .equip(slot, *data.time, &data.ability_map, &data.msm)
551                                            .into_iter()
552                                            .map(|item| {
553                                                (
554                                                    *pos,
555                                                    data.orientations
556                                                        .get(entity)
557                                                        .copied()
558                                                        .unwrap_or_default(),
559                                                    PickupItem::new(item, *data.program_time),
560                                                    *uid,
561                                                )
562                                            }),
563                                    );
564                                }
565                                Some(InventoryUpdateEvent::Used)
566                            } else if let Some(item) =
567                                inventory.take(slot, &data.ability_map, &data.msm)
568                            {
569                                match &*item.kind() {
570                                    ItemKind::Consumable { effects, .. } => {
571                                        maybe_effect = Some(effects.clone());
572                                        Some(InventoryUpdateEvent::Consumed((&item).into()))
573                                    },
574                                    ItemKind::Utility {
575                                        kind: item::Utility::Collar,
576                                        ..
577                                    } => {
578                                        const MAX_PETS: usize = 3;
579                                        let reinsert = if let Some(pos) = data.positions.get(entity)
580                                        {
581                                            if (&data.alignments, &data.agents, data.pets.mask())
582                                                .join()
583                                                .filter(|(alignment, _, _)| {
584                                                    alignment == &&comp::Alignment::Owned(*uid)
585                                                })
586                                                .count()
587                                                >= MAX_PETS
588                                            {
589                                                true
590                                            } else if let Some(tameable_entity) = {
591                                                (
592                                                    &data.entities,
593                                                    &data.bodies,
594                                                    &data.positions,
595                                                    &data.alignments,
596                                                )
597                                                    .join()
598                                                    .filter(|(_, _, wild_pos, _)| {
599                                                        wild_pos.0.distance_squared(pos.0)
600                                                            < 5.0f32.powi(2)
601                                                    })
602                                                    .filter(|(_, body, _, alignment)| {
603                                                        alignment == &&Alignment::Wild
604                                                            && is_tameable(body)
605                                                    })
606                                                    .min_by_key(|(_, _, wild_pos, _)| {
607                                                        (wild_pos.0.distance_squared(pos.0) * 100.0)
608                                                            as i32
609                                                    })
610                                                    .map(|(entity, _, _, _)| entity)
611                                            } {
612                                                emitters.emit(TamePetEvent {
613                                                    owner_entity: entity,
614                                                    pet_entity: tameable_entity,
615                                                });
616                                                false
617                                            } else {
618                                                true
619                                            }
620                                        } else {
621                                            true
622                                        };
623
624                                        if reinsert {
625                                            let _ = inventory.insert_or_stack_at(slot, item);
626                                        }
627
628                                        Some(InventoryUpdateEvent::Used)
629                                    },
630                                    ItemKind::RecipeGroup { .. } => {
631                                        match inventory.push_recipe_group(item) {
632                                            Ok(()) => {
633                                                if let Some(client) = data.clients.get(entity) {
634                                                    client.send_fallible(
635                                                        ServerGeneral::UpdateRecipes,
636                                                    );
637                                                }
638                                                Some(InventoryUpdateEvent::Used)
639                                            },
640                                            Err(item) => {
641                                                inventory.insert_or_stack_at(slot, item).expect(
642                                                    "slot was just vacated of item, so it \
643                                                     definitely fits there.",
644                                                );
645                                                None
646                                            },
647                                        }
648                                    },
649                                    _ => {
650                                        inventory.insert_or_stack_at(slot, item).expect(
651                                            "slot was just vacated of item, so it definitely fits \
652                                             there.",
653                                        );
654                                        None
655                                    },
656                                }
657                            } else {
658                                None
659                            }
660                        },
661                        Slot::Equip(slot) => {
662                            if slot == slot::EquipSlot::Lantern {
663                                snuff_lantern(&mut data.light_emitters, entity);
664                            }
665
666                            if let Some(pos) = data.positions.get(entity) {
667                                // Unequip the item, any items that no longer fit within the
668                                // inventory (due to unequipping a
669                                // bag for example) will be dropped on the floor
670                                if let Ok(Some(leftover_items)) =
671                                    inventory.unequip(slot, *data.time)
672                                {
673                                    dropped_items.extend(leftover_items.into_iter().map(|item| {
674                                        (
675                                            *pos,
676                                            data.orientations
677                                                .get(entity)
678                                                .copied()
679                                                .unwrap_or_default(),
680                                            PickupItem::new(item, *data.program_time),
681                                            *uid,
682                                        )
683                                    }));
684                                }
685                            }
686                            Some(InventoryUpdateEvent::Used)
687                        },
688                        // Items in overflow slots cannot be used
689                        Slot::Overflow(_) => None,
690                    };
691
692                    if let Some(effects) = maybe_effect {
693                        match effects {
694                            item::Effects::Any(effects) => {
695                                if let Some(effect) = effects.into_iter().choose(&mut rng) {
696                                    emit_effect_events(
697                                        &mut emitters,
698                                        *data.time,
699                                        entity,
700                                        effect,
701                                        None,
702                                        data.inventories.get(entity),
703                                        &data.msm,
704                                        data.character_states.get(entity),
705                                        data.stats.get(entity),
706                                        data.masses.get(entity),
707                                        None,
708                                    );
709                                }
710                            },
711                            item::Effects::All(effects) => {
712                                for effect in effects {
713                                    emit_effect_events(
714                                        &mut emitters,
715                                        *data.time,
716                                        entity,
717                                        effect,
718                                        None,
719                                        data.inventories.get(entity),
720                                        &data.msm,
721                                        data.character_states.get(entity),
722                                        data.stats.get(entity),
723                                        data.masses.get(entity),
724                                        None,
725                                    );
726                                }
727                            },
728                            item::Effects::One(effect) => {
729                                emit_effect_events(
730                                    &mut emitters,
731                                    *data.time,
732                                    entity,
733                                    effect,
734                                    None,
735                                    data.inventories.get(entity),
736                                    &data.msm,
737                                    data.character_states.get(entity),
738                                    data.stats.get(entity),
739                                    data.masses.get(entity),
740                                    None,
741                                );
742                            },
743                        }
744                    }
745                    if let Some(event) = event {
746                        data.inventory_updates
747                            .insert(entity, comp::InventoryUpdate::new(event))
748                            .expect("We know entity exists since we got its inventory.");
749                    }
750                },
751                comp::InventoryManip::Swap(a, b) => {
752                    use item::ItemKind;
753
754                    if let Some(lantern_info) = match (a, b) {
755                        // Only current possible lantern swap is between Slot::Inventory and
756                        // Slot::Equip add more cases if needed
757                        (Slot::Equip(slot::EquipSlot::Lantern), Slot::Inventory(slot))
758                        | (Slot::Inventory(slot), Slot::Equip(slot::EquipSlot::Lantern)) => {
759                            inventory.get(slot).and_then(|i| match &*i.kind() {
760                                ItemKind::Lantern(lantern) => {
761                                    Some((lantern.color(), lantern.strength()))
762                                },
763                                _ => None,
764                            })
765                        },
766                        _ => None,
767                    } {
768                        swap_lantern(&mut data.light_emitters, entity, lantern_info);
769                    }
770
771                    if let Some(pos) = data.positions.get(entity) {
772                        let mut merged_stacks = false;
773
774                        // If both slots have items and we're attempting to drag from one stack
775                        // into another, stack the items.
776                        if let (Slot::Inventory(slot_a), Slot::Inventory(slot_b)) = (a, b) {
777                            merged_stacks |= inventory.merge_stack_into(slot_a, slot_b);
778                        }
779
780                        // If the stacks weren't mergable carry out a swap.
781                        if !merged_stacks {
782                            dropped_items.extend(inventory.swap(a, b, *data.time).into_iter().map(
783                                |item| {
784                                    (
785                                        *pos,
786                                        data.orientations.get(entity).copied().unwrap_or_default(),
787                                        PickupItem::new(item, *data.program_time),
788                                        *uid,
789                                    )
790                                },
791                            ));
792                        }
793                    }
794
795                    data.inventory_updates
796                        .insert(
797                            entity,
798                            comp::InventoryUpdate::new(InventoryUpdateEvent::Swapped),
799                        )
800                        .expect("We know entity exists since we got its inventory.");
801                },
802                comp::InventoryManip::SplitSwap(slot, target) => {
803                    // If both slots have items and we're attempting to split from one stack
804                    // into another, ensure that they are the same type of item. If they are
805                    // the same type do nothing, as you don't want to overwrite the existing item.
806
807                    if let (
808                        Slot::Inventory(source_inv_slot_id),
809                        Slot::Inventory(target_inv_slot_id),
810                    ) = (slot, target)
811                    {
812                        if let Some(source_item) = inventory.get(source_inv_slot_id) {
813                            if let Some(target_item) = inventory.get(target_inv_slot_id) {
814                                if source_item != target_item {
815                                    continue;
816                                }
817                            }
818                        }
819                    }
820
821                    let item = match slot {
822                        Slot::Inventory(slot) => {
823                            inventory.take_half(slot, &data.ability_map, &data.msm)
824                        },
825                        Slot::Equip(_) => None,
826                        Slot::Overflow(_) => None,
827                    };
828
829                    if let Some(item) = item {
830                        if let Slot::Inventory(target) = target {
831                            inventory.insert_or_stack_at(target, item).ok();
832                        }
833                    }
834
835                    data.inventory_updates
836                        .insert(
837                            entity,
838                            comp::InventoryUpdate::new(InventoryUpdateEvent::Swapped),
839                        )
840                        .expect("We know entity exists since we got its inventory.");
841                },
842                comp::InventoryManip::Drop(slot) => {
843                    let item = match slot {
844                        Slot::Inventory(slot) => inventory.remove(slot),
845                        Slot::Equip(slot) => inventory.replace_loadout_item(slot, None, *data.time),
846                        Slot::Overflow(slot) => inventory.overflow_remove(slot),
847                    };
848
849                    // FIXME: We should really require the drop and write to be atomic!
850                    if let (Some(mut item), Some(pos)) = (item, data.positions.get(entity)) {
851                        item.put_in_world();
852                        dropped_items.push((
853                            *pos,
854                            data.orientations.get(entity).copied().unwrap_or_default(),
855                            PickupItem::new(item, *data.program_time),
856                            *uid,
857                        ));
858                    }
859                    data.inventory_updates
860                        .insert(
861                            entity,
862                            comp::InventoryUpdate::new(InventoryUpdateEvent::Dropped),
863                        )
864                        .expect("We know entity exists since we got its inventory.");
865                },
866                comp::InventoryManip::SplitDrop(slot) => {
867                    let item = match slot {
868                        Slot::Inventory(slot) => {
869                            inventory.take_half(slot, &data.ability_map, &data.msm)
870                        },
871                        Slot::Equip(_) => None,
872                        Slot::Overflow(o) => {
873                            inventory.overflow_take_half(o, &data.ability_map, &data.msm)
874                        },
875                    };
876
877                    // FIXME: We should really require the drop and write to be atomic!
878                    if let (Some(mut item), Some(pos)) = (item, data.positions.get(entity)) {
879                        item.put_in_world();
880                        dropped_items.push((
881                            *pos,
882                            data.orientations.get(entity).copied().unwrap_or_default(),
883                            PickupItem::new(item, *data.program_time),
884                            *uid,
885                        ));
886                    }
887                    data.inventory_updates
888                        .insert(
889                            entity,
890                            comp::InventoryUpdate::new(InventoryUpdateEvent::Dropped),
891                        )
892                        .expect("We know entity exists since we got its inventory.");
893                },
894                comp::InventoryManip::CraftRecipe {
895                    craft_event,
896                    craft_sprite,
897                } => {
898                    use comp::controller::CraftEvent;
899                    use recipe::ComponentKey;
900
901                    let get_craft_sprite = |sprite_pos: Option<VolumePos>| {
902                        sprite_pos
903                            .filter(|pos| {
904                                let entity_cylinder = get_cylinder(entity);
905                                let in_range = within_pickup_range(entity_cylinder, || {
906                                    pos.get_block_and_transform(
907                                        &data.terrain,
908                                        &data.id_maps,
909                                        |e| {
910                                            data.positions
911                                                .get(e)
912                                                .copied()
913                                                .zip(data.orientations.get(e).copied())
914                                        },
915                                        &data.colliders,
916                                    )
917                                    .map(|(mat, _)| mat.mul_point(Vec3::broadcast(0.5)))
918                                });
919                                if !in_range {
920                                    debug!(
921                                        ?entity_cylinder,
922                                        "Failed to craft recipe as not within range of required \
923                                         sprite, sprite pos: {:?}",
924                                        pos
925                                    );
926                                }
927                                in_range
928                            })
929                            .and_then(|pos| {
930                                pos.get_block(&data.terrain, &data.id_maps, &data.colliders)
931                            })
932                            .and_then(|block| block.get_sprite())
933                    };
934
935                    let crafted_items = match craft_event {
936                        CraftEvent::Simple {
937                            recipe,
938                            slots,
939                            amount,
940                        } => {
941                            let filtered_recipe = inventory
942                                .get_recipe(&recipe, &data.rbm)
943                                .cloned()
944                                .filter(|r| {
945                                    if let Some(needed_sprite) = r.craft_sprite {
946                                        let sprite = get_craft_sprite(craft_sprite);
947                                        Some(needed_sprite) == sprite
948                                    } else {
949                                        true
950                                    }
951                                });
952                            if let Some(recipe) = filtered_recipe {
953                                let items = (0..amount)
954                                    .filter_map(|_| {
955                                        recipe
956                                            .craft_simple(
957                                                &mut inventory,
958                                                slots.clone(),
959                                                &data.ability_map,
960                                                &data.msm,
961                                            )
962                                            .ok()
963                                    })
964                                    .flatten()
965                                    .collect::<Vec<_>>();
966
967                                if items.is_empty() { None } else { Some(items) }
968                            } else {
969                                None
970                            }
971                        },
972                        CraftEvent::Salvage(slot) => {
973                            let sprite = get_craft_sprite(craft_sprite);
974                            if matches!(sprite, Some(SpriteKind::DismantlingBench)) {
975                                recipe::try_salvage(
976                                    &mut inventory,
977                                    slot,
978                                    &data.ability_map,
979                                    &data.msm,
980                                )
981                                .ok()
982                            } else {
983                                None
984                            }
985                        },
986                        CraftEvent::ModularWeapon {
987                            primary_component,
988                            secondary_component,
989                        } => {
990                            let sprite = get_craft_sprite(craft_sprite);
991                            if matches!(sprite, Some(SpriteKind::CraftingBench)) {
992                                recipe::modular_weapon(
993                                    &mut inventory,
994                                    primary_component,
995                                    secondary_component,
996                                    &data.ability_map,
997                                    &data.msm,
998                                )
999                                .ok()
1000                                .map(|item| vec![item])
1001                            } else {
1002                                None
1003                            }
1004                        },
1005                        CraftEvent::ModularWeaponPrimaryComponent {
1006                            toolkind,
1007                            material,
1008                            modifier,
1009                            slots,
1010                        } => {
1011                            let component_recipes = default_component_recipe_book().read();
1012                            let item_id = |slot| {
1013                                inventory.get(slot).and_then(|item| {
1014                                    item.item_definition_id().itemdef_id().map(String::from)
1015                                })
1016                            };
1017                            if let Some(material_item_id) = item_id(material) {
1018                                component_recipes
1019                                    .get(&ComponentKey {
1020                                        toolkind,
1021                                        material: material_item_id,
1022                                        modifier: modifier.and_then(item_id),
1023                                    })
1024                                    .filter(|r| {
1025                                        let sprite = if let Some(needed_sprite) = r.craft_sprite {
1026                                            let sprite = get_craft_sprite(craft_sprite);
1027                                            Some(needed_sprite) == sprite
1028                                        } else {
1029                                            true
1030                                        };
1031                                        let known = inventory.recipe_is_known(&r.recipe_book_key);
1032                                        sprite && known
1033                                    })
1034                                    .and_then(|r| {
1035                                        r.craft_component(
1036                                            &mut inventory,
1037                                            material,
1038                                            modifier,
1039                                            slots,
1040                                            &data.ability_map,
1041                                            &data.msm,
1042                                        )
1043                                        .ok()
1044                                    })
1045                            } else {
1046                                None
1047                            }
1048                        },
1049                        CraftEvent::Repair { item, slots } => {
1050                            let repair_recipes = default_repair_recipe_book().read();
1051                            let sprite = get_craft_sprite(craft_sprite);
1052                            if matches!(sprite, Some(SpriteKind::RepairBench)) {
1053                                let _ = repair_recipes.repair_item(
1054                                    &mut inventory,
1055                                    item,
1056                                    slots,
1057                                    &data.ability_map,
1058                                    &data.msm,
1059                                );
1060                            }
1061                            None
1062                        },
1063                    };
1064
1065                    // Attempt to insert items into inventory, dropping them if there is not enough
1066                    // space
1067                    let items_were_crafted = if let Some(crafted_items) = crafted_items {
1068                        let mut dropped: Vec<PickupItem> = Vec::new();
1069                        for item in crafted_items {
1070                            if let Err((item, _inserted)) = inventory.push(item) {
1071                                let item = PickupItem::new(item, *data.program_time);
1072                                if let Some(can_merge) =
1073                                    dropped.iter_mut().find(|other| other.can_merge(&item))
1074                                {
1075                                    can_merge
1076                                        .try_merge(item)
1077                                        .expect("We know these items can be merged");
1078                                } else {
1079                                    dropped.push(item);
1080                                }
1081                            }
1082                        }
1083
1084                        if !dropped.is_empty()
1085                            && let Some(pos) = data.positions.get(entity)
1086                        {
1087                            for item in dropped {
1088                                dropped_items.push((
1089                                    *pos,
1090                                    data.orientations.get(entity).copied().unwrap_or_default(),
1091                                    item,
1092                                    *uid,
1093                                ));
1094                            }
1095                        }
1096
1097                        true
1098                    } else {
1099                        false
1100                    };
1101
1102                    // FIXME: We should really require the drop and write to be atomic!
1103                    if items_were_crafted {
1104                        let _ = data.inventory_updates.insert(
1105                            entity,
1106                            comp::InventoryUpdate::new(InventoryUpdateEvent::Craft),
1107                        );
1108                    }
1109                },
1110                comp::InventoryManip::Sort => {
1111                    inventory.sort();
1112                },
1113                comp::InventoryManip::SwapEquippedWeapons => {
1114                    inventory.swap_equipped_weapons(*data.time);
1115                },
1116            }
1117            if data.trades.in_mutable_trade(uid) {
1118                // manipulating the inventory mutated the trade, so reset the accept flags
1119                data.trades.implicit_mutation_occurred(uid);
1120            }
1121        }
1122
1123        // Drop items, Debug items should simply disappear when dropped
1124        for (pos, ori, mut item, owner) in dropped_items
1125            .into_iter()
1126            .filter(|(_, _, i, _)| !matches!(i.item().quality(), item::Quality::Debug))
1127        {
1128            item.remove_debug_items();
1129
1130            emitters.emit(CreateItemDropEvent {
1131                pos,
1132                vel: comp::Vel::default(),
1133                ori,
1134                item,
1135                loot_owner: Some(LootOwner::new(LootOwnerKind::Player(owner), true)),
1136            })
1137        }
1138    }
1139}
1140
1141fn within_pickup_range<S: FindDist<find_dist::Cylinder>>(
1142    entity_cylinder: Option<find_dist::Cylinder>,
1143    shape_fn: impl FnOnce() -> Option<S>,
1144) -> bool {
1145    entity_cylinder
1146        .and_then(|entity_cylinder| {
1147            shape_fn().map(|shape| shape.min_distance(entity_cylinder) < MAX_PICKUP_RANGE)
1148        })
1149        .unwrap_or(false)
1150}
1151
1152fn announce_loot_to_group(
1153    group_id: &Group,
1154    entity: EcsEntity,
1155    item: comp::FrontendItem,
1156    clients: &ReadStorage<Client>,
1157    uids: &ReadStorage<Uid>,
1158    groups: &ReadStorage<comp::Group>,
1159    alignments: &ReadStorage<comp::Alignment>,
1160    entities: &Entities,
1161    ability_map: &AbilityMap,
1162    msm: &MaterialStatManifest,
1163) {
1164    if let Some(uid) = uids.get(entity) {
1165        members(*group_id, groups, entities, alignments, uids)
1166            .filter(|(member_e, _)| member_e != &entity)
1167            .for_each(|(e, _)| {
1168                clients.get(e).map(|c| {
1169                    c.send_fallible(ServerGeneral::GroupInventoryUpdate(
1170                        item.duplicate(ability_map, msm),
1171                        *uid,
1172                    ));
1173                });
1174            });
1175    }
1176}
1177
1178#[cfg(test)]
1179mod tests {
1180    use vek::Vec3;
1181
1182    use common::comp::Pos;
1183    use find_dist::*;
1184
1185    use super::*;
1186
1187    // Helper function
1188    fn test_cylinder(pos: Pos) -> Option<Cylinder> {
1189        Some(Cylinder::from_components(pos.0, None, None, None))
1190    }
1191
1192    #[test]
1193    fn pickup_distance_within_range() {
1194        let position = Pos(Vec3::zero());
1195        let item_position = Pos(Vec3::one());
1196
1197        assert!(within_pickup_range(test_cylinder(position), || {
1198            test_cylinder(item_position)
1199        },),);
1200    }
1201
1202    #[test]
1203    fn pickup_distance_not_within_range() {
1204        let position = Pos(Vec3::zero());
1205        let item_position = Pos(Vec3::one() * 500.0);
1206
1207        assert!(!within_pickup_range(test_cylinder(position), || {
1208            test_cylinder(item_position)
1209        },),);
1210    }
1211}