veloren_server/events/
interaction.rs

1use std::{f32::consts::PI, ops::Mul};
2
3use common::{comp::loot_owner::ONWERSHIP_TIMEOUT_FAST, rtsim::DialogueKind};
4use common_state::{BlockChange, ScheduledBlockChange};
5use specs::{DispatcherBuilder, Join, ReadExpect, ReadStorage, WriteExpect, WriteStorage};
6use tracing::error;
7use vek::*;
8
9use common::{
10    assets::{AssetCombined, AssetHandle, Ron},
11    comp::{
12        self, InventoryUpdateEvent,
13        agent::{AgentEvent, Sound, SoundKind},
14        inventory::slot::EquipSlot,
15        item::{MaterialStatManifest, flatten_counted_items},
16        loot_owner::LootOwnerKind,
17        tool::AbilityMap,
18    },
19    consts::{MAX_INTERACT_RANGE, MAX_NPCINTERACT_RANGE, SOUND_TRAVEL_DIST_PER_VOLUME},
20    event::{
21        CreateItemDropEvent, CreateSpriteEvent, DialogueEvent, EventBus, MineBlockEvent,
22        NpcInteractEvent, SetLanternEvent, SetPetStayEvent, SoundEvent, TamePetEvent,
23        ToggleSpriteLightEvent,
24    },
25    link::Is,
26    mounting::Mount,
27    outcome::Outcome,
28    resources::ProgramTime,
29    terrain::{self, Block, SpriteKind, TerrainGrid},
30    uid::Uid,
31    util::Dir,
32    vol::ReadVol,
33};
34
35use crate::{Server, ServerGeneral, Time, client::Client};
36
37use crate::pet::tame_pet;
38use hashbrown::{HashMap, HashSet};
39use lazy_static::lazy_static;
40
41use super::{ServerEvent, event_dispatch, mounting::within_mounting_range};
42
43pub(super) fn register_event_systems(builder: &mut DispatcherBuilder) {
44    event_dispatch::<SetLanternEvent>(builder, &[]);
45    event_dispatch::<NpcInteractEvent>(builder, &[]);
46    event_dispatch::<DialogueEvent>(builder, &[]);
47    event_dispatch::<SetPetStayEvent>(builder, &[]);
48    event_dispatch::<MineBlockEvent>(builder, &[]);
49    event_dispatch::<SoundEvent>(builder, &[]);
50    event_dispatch::<CreateSpriteEvent>(builder, &[]);
51    event_dispatch::<ToggleSpriteLightEvent>(builder, &[]);
52}
53
54impl ServerEvent for SetLanternEvent {
55    type SystemData<'a> = (
56        WriteStorage<'a, comp::LightEmitter>,
57        ReadStorage<'a, comp::Inventory>,
58        ReadStorage<'a, comp::Health>,
59    );
60
61    fn handle(
62        events: impl ExactSizeIterator<Item = Self>,
63        (mut light_emitters, inventories, healths): Self::SystemData<'_>,
64    ) {
65        for SetLanternEvent(entity, enable) in events {
66            let lantern_exists = light_emitters
67                .get(entity)
68                .is_some_and(|light| light.strength > 0.0);
69
70            if lantern_exists != enable {
71                if !enable {
72                    light_emitters.remove(entity);
73                }
74                // Only enable lantern if entity is alive
75                else if healths.get(entity).is_none_or(|h| !h.is_dead) {
76                    inventories
77                        .get(entity)
78                        .and_then(|inventory| inventory.equipped(EquipSlot::Lantern))
79                        .map(|item| {
80                            if let comp::item::ItemKind::Lantern(l) = &*item.kind() {
81                                let _ = light_emitters.insert(entity, comp::LightEmitter {
82                                    col: l.color(),
83                                    strength: l.strength(),
84                                    flicker: l.flicker(),
85                                    animated: true,
86                                    dir: l.dir,
87                                });
88                            }
89                        });
90                }
91            }
92        }
93    }
94}
95
96impl ServerEvent for NpcInteractEvent {
97    type SystemData<'a> = (
98        WriteStorage<'a, comp::Agent>,
99        ReadStorage<'a, comp::Pos>,
100        ReadStorage<'a, Uid>,
101    );
102
103    fn handle(
104        events: impl ExactSizeIterator<Item = Self>,
105        (mut agents, positions, uids): Self::SystemData<'_>,
106    ) {
107        for NpcInteractEvent(interactor, npc_entity) in events {
108            let within_range = {
109                positions
110                    .get(interactor)
111                    .zip(positions.get(npc_entity))
112                    .is_some_and(|(interactor_pos, npc_pos)| {
113                        interactor_pos.0.distance_squared(npc_pos.0)
114                            <= MAX_NPCINTERACT_RANGE.powi(2)
115                    })
116            };
117
118            if within_range
119                && let Some(agent) = agents.get_mut(npc_entity)
120                && agent.target.is_none()
121                && let Some(interactor_uid) = uids.get(interactor)
122            {
123                agent.inbox.push_back(AgentEvent::Talk(*interactor_uid));
124            }
125        }
126    }
127}
128
129impl ServerEvent for DialogueEvent {
130    type SystemData<'a> = (
131        ReadStorage<'a, Uid>,
132        ReadStorage<'a, comp::Pos>,
133        ReadStorage<'a, Client>,
134        WriteStorage<'a, comp::Agent>,
135        WriteStorage<'a, comp::Inventory>,
136        ReadExpect<'a, AbilityMap>,
137        ReadExpect<'a, MaterialStatManifest>,
138        WriteStorage<'a, comp::InventoryUpdateBuffer>,
139    );
140
141    fn handle(
142        events: impl ExactSizeIterator<Item = Self>,
143        (
144            uids,
145            positions,
146            clients,
147            mut agents,
148            mut inventories,
149            ability_map,
150            msm,
151            mut inventory_update_buffers,
152        ): Self::SystemData<'_>,
153    ) {
154        for DialogueEvent(sender, target, dialogue) in events {
155            let within_range = positions
156                .get(sender)
157                .zip(positions.get(target))
158                .is_some_and(|(sender_pos, target_pos)| {
159                    sender_pos.0.distance_squared(target_pos.0) <= MAX_NPCINTERACT_RANGE.powi(2)
160                });
161
162            if within_range && let Some(sender_uid) = uids.get(sender) {
163                // Perform item transfer, if required
164                let given_item = match &dialogue.kind {
165                    DialogueKind::Start
166                    | DialogueKind::End
167                    | DialogueKind::Question { .. }
168                    | DialogueKind::Marker { .. }
169                    | DialogueKind::Ack { .. } => None,
170                    DialogueKind::Statement { given_item, .. } => given_item.as_ref(),
171                    DialogueKind::Response { response, .. } => response.given_item.as_ref(),
172                };
173                // If the response requires an item to be given, perform exchange (or exit)
174                if let Some((item_def, amount)) = given_item {
175                    // Check that the target's inventory has enough space for the item
176                    if let Some(target_inv) = inventories.get(target)
177                        && target_inv.has_space_for(item_def, *amount)
178                        // Check that the sender has enough of the item
179                        && let Some(mut sender_inv) = inventories.get_mut(sender)
180                        && sender_inv.item_count(item_def) >= *amount as u64
181                        // First, remove the item from the sender's inventory
182                        && let Some(items) = sender_inv.remove_item_amount(item_def, *amount, &ability_map, &msm)
183                        && let Some(mut target_inv) = inventories.get_mut(target)
184                    {
185                        for item in items {
186                            let item_event = InventoryUpdateEvent::Collected(
187                                item.frontend_item(&ability_map, &msm),
188                            );
189                            // Push the items to the target's inventory
190                            if target_inv.push(item).is_err() {
191                                error!(
192                                    "Failed to insert dialogue given item despite target \
193                                     inventory claiming to have space, dropping remaining items..."
194                                );
195                                break;
196                            } else if let Some(buf) = inventory_update_buffers.get_mut(target) {
197                                buf.push(item_event);
198                            }
199                        }
200                    } else {
201                        // TODO: Respond with error message on failure?
202                        continue;
203                    }
204                }
205
206                let dialogue = dialogue.into_validated_unchecked();
207
208                if let Some(agent) = agents.get_mut(target) {
209                    agent
210                        .inbox
211                        .push_back(AgentEvent::Dialogue(*sender_uid, dialogue.clone()));
212                }
213
214                if let Some(client) = clients.get(target) {
215                    client.send_fallible(ServerGeneral::Dialogue(*sender_uid, dialogue));
216                }
217            }
218        }
219    }
220}
221
222impl ServerEvent for SetPetStayEvent {
223    type SystemData<'a> = (
224        WriteStorage<'a, comp::Agent>,
225        WriteStorage<'a, comp::CharacterActivity>,
226        ReadStorage<'a, comp::Pos>,
227        ReadStorage<'a, comp::Alignment>,
228        ReadStorage<'a, Is<Mount>>,
229        ReadStorage<'a, Uid>,
230    );
231
232    fn handle(
233        events: impl ExactSizeIterator<Item = Self>,
234        (mut agents, mut character_activities, positions, alignments, is_mounts, uids): Self::SystemData<'_>,
235    ) {
236        for SetPetStayEvent(command_giver, pet, stay) in events {
237            let is_owner = uids.get(command_giver).is_some_and(|owner_uid| {
238                matches!(
239                    alignments.get(pet),
240                    Some(comp::Alignment::Owned(pet_owner)) if *pet_owner == *owner_uid,
241                )
242            });
243
244            let current_pet_position = positions.get(pet).copied();
245            let stay = stay && current_pet_position.is_some();
246            if is_owner
247                && within_mounting_range(positions.get(command_giver), positions.get(pet))
248                && is_mounts.get(pet).is_none()
249            {
250                character_activities
251                    .get_mut(pet)
252                    .map(|mut activity| activity.is_pet_staying = stay);
253                agents
254                    .get_mut(pet)
255                    .map(|s| s.stay_pos = current_pet_position.filter(|_| stay));
256            }
257        }
258    }
259}
260
261lazy_static! {
262    static ref RESOURCE_EXPERIENCE_MANIFEST: AssetHandle<Ron<HashMap<String, u32>>> =
263        Ron::load_expect_combined_static("server.manifests.resource_experience_manifest");
264}
265
266impl ServerEvent for MineBlockEvent {
267    type SystemData<'a> = (
268        WriteExpect<'a, BlockChange>,
269        ReadExpect<'a, TerrainGrid>,
270        ReadExpect<'a, MaterialStatManifest>,
271        ReadExpect<'a, AbilityMap>,
272        ReadExpect<'a, EventBus<CreateItemDropEvent>>,
273        ReadExpect<'a, EventBus<SoundEvent>>,
274        ReadExpect<'a, EventBus<Outcome>>,
275        ReadExpect<'a, ProgramTime>,
276        ReadExpect<'a, Time>,
277        WriteStorage<'a, comp::SkillSet>,
278        ReadStorage<'a, Uid>,
279    );
280
281    fn handle(
282        events: impl ExactSizeIterator<Item = Self>,
283        (
284            mut block_change,
285            terrain,
286            msm,
287            ability_map,
288            create_item_drop_events,
289            sound_events,
290            outcomes,
291            program_time,
292            time,
293            mut skill_sets,
294            uids,
295        ): Self::SystemData<'_>,
296    ) {
297        use rand::RngExt;
298        let mut rng = rand::rng();
299        let mut create_item_drop_emitter = create_item_drop_events.emitter();
300        let mut sound_event_emitter = sound_events.emitter();
301        let mut outcome_emitter = outcomes.emitter();
302        for ev in events {
303            if block_change.can_set_block(ev.pos) {
304                let block = terrain.get(ev.pos).ok().copied();
305                if let Some(mut block) =
306                    block.filter(|b| b.mine_tool().is_some_and(|t| Some(t) == ev.tool))
307                {
308                    // Attempt to increase the resource's damage
309                    let damage = if let Ok(damage) = block.get_attr::<terrain::sprite::Damage>() {
310                        let updated_damage = damage.0.saturating_add(1);
311                        block
312                            .set_attr(terrain::sprite::Damage(updated_damage))
313                            .expect(
314                                "We just read the Damage attribute from the block, writing should \
315                                 be possible too",
316                            );
317
318                        Some(updated_damage)
319                    } else {
320                        None
321                    };
322
323                    let sprite = block.get_sprite();
324
325                    // Maximum damage has reached, destroy the block
326                    let is_broken = damage
327                        .and_then(|damage| Some((sprite?.required_mine_damage(), damage)))
328                        .is_some_and(|(required_damage, damage)| {
329                            required_damage.is_none_or(|required| damage >= required)
330                        });
331
332                    // Stage changes happen in damage interval of `mine_drop_intevral`
333                    let stage_changed = damage
334                        .and_then(|damage| Some((sprite?.mine_drop_interval(), damage)))
335                        .is_some_and(|(interval, damage)| damage % interval == 0);
336
337                    let sprite_cfg = terrain.sprite_cfg_at(ev.pos);
338                    if (stage_changed || is_broken)
339                        && let Some(items) = comp::Item::try_reclaim_from_block(block, sprite_cfg)
340                    {
341                        let mut items: Vec<_> =
342                            flatten_counted_items(&items, &ability_map, &msm).collect();
343                        let maybe_uid = uids.get(ev.entity).copied();
344
345                        if let Some(mut skillset) = skill_sets.get_mut(ev.entity) {
346                            use common::comp::skills::{MiningSkill, SKILL_MODIFIERS, Skill};
347
348                            if is_broken
349                                && let (Some(tool), Some(uid), exp_reward @ 1..) = (
350                                    ev.tool,
351                                    maybe_uid,
352                                    items
353                                        .iter()
354                                        .filter_map(|item| {
355                                            item.item_definition_id().itemdef_id().and_then(|id| {
356                                                RESOURCE_EXPERIENCE_MANIFEST
357                                                    .read()
358                                                    .0
359                                                    .get(id)
360                                                    .copied()
361                                            })
362                                        })
363                                        .sum(),
364                                )
365                            {
366                                let skill_group = comp::SkillGroupKind::Weapon(tool);
367                                if let Some(level_outcome) =
368                                    skillset.add_experience(skill_group, exp_reward)
369                                {
370                                    outcome_emitter.emit(Outcome::SkillPointGain {
371                                        uid,
372                                        skill_tree: skill_group,
373                                        total_points: level_outcome,
374                                    });
375                                }
376                                outcome_emitter.emit(Outcome::ExpChange {
377                                    uid,
378                                    exp: exp_reward,
379                                    xp_pools: HashSet::from([skill_group]),
380                                });
381                            }
382
383                            let stage_ore_chance = || {
384                                let chance_mod = f64::from(SKILL_MODIFIERS.mining_tree.ore_gain);
385                                let skill_level = skillset
386                                    .skill_level(Skill::Pick(MiningSkill::OreGain))
387                                    .unwrap_or(0);
388
389                                chance_mod * f64::from(skill_level)
390                            };
391                            let stage_gem_chance = || {
392                                let chance_mod = f64::from(SKILL_MODIFIERS.mining_tree.gem_gain);
393                                let skill_level = skillset
394                                    .skill_level(Skill::Pick(MiningSkill::GemGain))
395                                    .unwrap_or(0);
396
397                                chance_mod * f64::from(skill_level)
398                            };
399
400                            // If the resource hasn't been fully broken, only drop certain resources
401                            // with a chance
402                            if !is_broken {
403                                items.retain(|item| {
404                                    rng.random_bool(
405                                        0.5 + item
406                                            .item_definition_id()
407                                            .itemdef_id()
408                                            .map(|id| {
409                                                if id.contains("mineral.ore.") {
410                                                    stage_ore_chance()
411                                                } else if id.contains("mineral.gem.") {
412                                                    stage_gem_chance()
413                                                } else {
414                                                    0.0
415                                                }
416                                            })
417                                            .unwrap_or(0.0),
418                                    )
419                                });
420                            }
421                        }
422                        for item in items {
423                            let loot_owner = maybe_uid.map(LootOwnerKind::Player).map(|owner| {
424                                comp::LootOwner::new(owner, false, ONWERSHIP_TIMEOUT_FAST)
425                            });
426                            create_item_drop_emitter.emit(CreateItemDropEvent {
427                                pos: comp::Pos(ev.pos.map(|e| e as f32) + Vec3::broadcast(0.5)),
428                                vel: comp::Vel(
429                                    Vec2::unit_x()
430                                        .rotated_z(rng.random::<f32>() * PI * 2.0)
431                                        .mul(4.0)
432                                        .with_z(rng.random_range(5.0..10.0)),
433                                ),
434                                ori: comp::Ori::from(Dir::random_2d(&mut rng)),
435                                item: comp::PickupItem::new(item, *program_time, false),
436                                loot_owner,
437                            });
438                        }
439                    }
440
441                    if damage.is_some() && !is_broken {
442                        block_change.set(ev.pos, block);
443                    } else {
444                        block_change.set(ev.pos, block.into_vacant());
445                    }
446                    outcome_emitter.emit(if is_broken {
447                        Outcome::BreakBlock {
448                            pos: ev.pos,
449                            tool: ev.tool,
450                            color: block.get_color(),
451                        }
452                    } else {
453                        Outcome::DamagedBlock {
454                            pos: ev.pos,
455                            stage_changed,
456                            tool: ev.tool,
457                        }
458                    });
459
460                    // Emit mining sound
461                    sound_event_emitter.emit(SoundEvent {
462                        sound: Sound::new(SoundKind::Mine, ev.pos.as_(), 20.0, time.0),
463                    });
464                }
465            }
466        }
467    }
468}
469
470impl ServerEvent for SoundEvent {
471    type SystemData<'a> = (
472        ReadExpect<'a, EventBus<Outcome>>,
473        WriteStorage<'a, comp::Agent>,
474        ReadStorage<'a, comp::Pos>,
475    );
476
477    fn handle(
478        events: impl ExactSizeIterator<Item = Self>,
479        (outcomes, mut agents, positions): Self::SystemData<'_>,
480    ) {
481        let mut outcome_emitter = outcomes.emitter();
482        for SoundEvent { sound } in events {
483            // TODO: Reduce the complexity of this problem by using spatial partitioning
484            // system
485            for (agent, agent_pos) in (&mut agents, &positions).join() {
486                // TODO: Use pathfinding for more dropoff around obstacles
487                let agent_dist_sqrd = agent_pos.0.distance_squared(sound.pos);
488                let sound_travel_dist_sqrd = (sound.vol * SOUND_TRAVEL_DIST_PER_VOLUME).powi(2);
489
490                let vol_dropoff = agent_dist_sqrd / sound_travel_dist_sqrd * sound.vol;
491                let propagated_sound = sound.with_new_vol(sound.vol - vol_dropoff);
492
493                let can_hear_sound = propagated_sound.vol > 0.00;
494                let should_hear_sound = agent_dist_sqrd < agent.psyche.listen_dist.powi(2);
495
496                if can_hear_sound && should_hear_sound {
497                    agent
498                        .inbox
499                        .push_back(AgentEvent::ServerSound(propagated_sound));
500                }
501            }
502
503            // Attempt to turn this sound into an outcome to be received by frontends.
504            if let Some(outcome) = match sound.kind {
505                SoundKind::Utterance(kind, body) => Some(Outcome::Utterance {
506                    kind,
507                    pos: sound.pos,
508                    body,
509                }),
510                _ => None,
511            } {
512                outcome_emitter.emit(outcome);
513            }
514        }
515    }
516}
517
518impl ServerEvent for CreateSpriteEvent {
519    type SystemData<'a> = (
520        WriteExpect<'a, BlockChange>,
521        WriteExpect<'a, ScheduledBlockChange>,
522        ReadExpect<'a, TerrainGrid>,
523        ReadExpect<'a, Time>,
524    );
525
526    fn handle(
527        events: impl ExactSizeIterator<Item = Self>,
528        (mut block_change, mut scheduled_block_change, terrain, time): Self::SystemData<'_>,
529    ) {
530        for ev in events {
531            if block_change.can_set_block(ev.pos) {
532                let block = terrain.get(ev.pos).ok().copied();
533                if block.is_some_and(|b| (*b).is_fluid()) {
534                    let old_block = block.unwrap_or_else(|| Block::air(SpriteKind::Empty));
535                    let new_block = old_block.with_sprite(ev.sprite);
536                    block_change.set(ev.pos, new_block);
537                    // Remove sprite after del_timeout and offset if specified
538                    if let Some((timeout, del_offset)) = ev.del_timeout {
539                        use rand::RngExt;
540                        let mut rng = rand::rng();
541                        let offset = rng.random_range(0.0..del_offset);
542                        let current_time: f64 = time.0;
543                        let replace_time = current_time + (timeout + offset) as f64;
544                        if old_block != new_block {
545                            scheduled_block_change.set(ev.pos, old_block, replace_time);
546                            scheduled_block_change.outcome_set(ev.pos, new_block, replace_time);
547                        }
548                    }
549                }
550            }
551        }
552    }
553}
554
555impl ServerEvent for ToggleSpriteLightEvent {
556    type SystemData<'a> = (
557        WriteExpect<'a, BlockChange>,
558        ReadExpect<'a, TerrainGrid>,
559        ReadStorage<'a, comp::Pos>,
560    );
561
562    fn handle(
563        events: impl ExactSizeIterator<Item = Self>,
564        (mut block_change, terrain, positions): Self::SystemData<'_>,
565    ) {
566        for ev in events.into_iter() {
567            if let Some(entity_pos) = positions.get(ev.entity)
568                && entity_pos.0.distance_squared(ev.pos.as_()) < MAX_INTERACT_RANGE.powi(2)
569                && block_change.can_set_block(ev.pos)
570                && let Some(new_block) = terrain
571                    .get(ev.pos)
572                    .ok()
573                    .and_then(|block| block.with_toggle_light(ev.enable))
574            {
575                block_change.set(ev.pos, new_block);
576                // TODO: Emit outcome
577            }
578        }
579    }
580}
581
582pub fn handle_tame_pet(server: &mut Server, ev: TamePetEvent) {
583    // TODO: Raise outcome to send to clients to play sound/render an indicator
584    // showing taming success?
585    tame_pet(server.state.ecs(), ev.pet_entity, ev.owner_entity);
586}
veloren_server/events/interaction.rs

veloren_server/events/
interaction.rs
