veloren_common_systems/
controller.rs

1use common::{
2    comp::{
3        Body, BuffChange, Collider, ControlEvent, Controller, Health, Pos, Scale,
4        UnresolvedChatMsg,
5        ability::Stance,
6        agent::{Sound, SoundKind},
7    },
8    event::{self, ChatEvent, EmitExt},
9    event_emitters,
10    interaction::Interaction,
11    terrain::TerrainGrid,
12    uid::{IdMaps, Uid},
13};
14use common_ecs::{Job, Origin, Phase, System};
15use specs::{Entities, LendJoin, Read, ReadExpect, ReadStorage, SystemData, WriteStorage, shred};
16use tracing::warn;
17use vek::*;
18
19event_emitters! {
20    struct Events[EventEmitters] {
21        mount: event::MountEvent,
22        set_pet_stay: event::SetPetStayEvent,
23        lantern: event::SetLanternEvent,
24        npc_interact: event::NpcInteractEvent,
25        dialogue: event::DialogueEvent,
26        initiate_invite: event::InitiateInviteEvent,
27        invite_response: event::InviteResponseEvent,
28        process_trade_action: event::ProcessTradeActionEvent,
29        inventory_manip: event::InventoryManipEvent,
30        group_manip: event::GroupManipEvent,
31        respawn: event::RespawnEvent,
32        sound: event::SoundEvent,
33        change_ability: event::ChangeAbilityEvent,
34        change_stance: event::ChangeStanceEvent,
35        start_teleporting: event::StartTeleportingEvent,
36        buff: event::BuffEvent,
37        start_interaction: event::StartInteractionEvent,
38        kill: event::KillEvent,
39        chat: event::ChatEvent,
40    }
41}
42
43#[derive(SystemData)]
44pub struct ReadData<'a> {
45    entities: Entities<'a>,
46    id_maps: Read<'a, IdMaps>,
47    events: Events<'a>,
48    terrain_grid: ReadExpect<'a, TerrainGrid>,
49    positions: ReadStorage<'a, Pos>,
50    bodies: ReadStorage<'a, Body>,
51    scales: ReadStorage<'a, Scale>,
52    colliders: ReadStorage<'a, Collider>,
53    uids: ReadStorage<'a, Uid>,
54    healths: ReadStorage<'a, Health>,
55}
56
57#[derive(Default)]
58pub struct Sys;
59
60impl<'a> System<'a> for Sys {
61    type SystemData = (ReadData<'a>, WriteStorage<'a, Controller>);
62
63    const NAME: &'static str = "controller";
64    const ORIGIN: Origin = Origin::Common;
65    const PHASE: Phase = Phase::Create;
66
67    fn run(_job: &mut Job<Self>, (read_data, mut controllers): Self::SystemData) {
68        let mut emitters = read_data.events.get_emitters();
69
70        (&read_data.entities, &read_data.uids, &mut controllers)
71            .lend_join()
72            .for_each(|(entity, uid, controller)| {
73                // Sanitize inputs to avoid clients sending bad data
74                controller.inputs.sanitize();
75
76                // Process other controller events
77                for event in controller.events.drain(..) {
78                    match event {
79                        ControlEvent::Mount(mountee_uid) => {
80                            if let Some(mountee_entity) = read_data.id_maps.uid_entity(mountee_uid)
81                            {
82                                emitters
83                                    .emit(event::MountEvent::MountEntity(entity, mountee_entity));
84                            }
85                        },
86                        ControlEvent::MountVolume(volume) => {
87                            if let Some(block) = volume.get_block(
88                                &read_data.terrain_grid,
89                                &read_data.id_maps,
90                                &read_data.colliders,
91                            ) && block.is_mountable()
92                            {
93                                emitters.emit(event::MountEvent::MountVolume(entity, volume));
94                            }
95                        },
96                        ControlEvent::SetPetStay(pet_uid, stay) => {
97                            if let Some(pet_entity) = read_data.id_maps.uid_entity(pet_uid) {
98                                emitters.emit(event::SetPetStayEvent(entity, pet_entity, stay));
99                            }
100                        },
101                        ControlEvent::RemoveBuff(buff_id) => {
102                            emitters.emit(event::BuffEvent {
103                                entity,
104                                buff_change: BuffChange::RemoveFromController(buff_id),
105                            });
106                        },
107                        ControlEvent::Unmount => emitters.emit(event::MountEvent::Unmount(entity)),
108                        ControlEvent::EnableLantern => {
109                            emitters.emit(event::SetLanternEvent(entity, true))
110                        },
111                        ControlEvent::DisableLantern => {
112                            emitters.emit(event::SetLanternEvent(entity, false))
113                        },
114                        ControlEvent::Interact(npc_uid) => {
115                            if let Some(npc_entity) = read_data.id_maps.uid_entity(npc_uid) {
116                                emitters.emit(event::NpcInteractEvent(entity, npc_entity));
117                            }
118                        },
119                        ControlEvent::InitiateInvite(inviter_uid, kind) => {
120                            emitters.emit(event::InitiateInviteEvent(entity, inviter_uid, kind));
121                        },
122                        ControlEvent::InviteResponse(response) => {
123                            emitters.emit(event::InviteResponseEvent(entity, response));
124                        },
125                        ControlEvent::PerformTradeAction(trade_id, action) => {
126                            emitters.emit(event::ProcessTradeActionEvent(entity, trade_id, action));
127                        },
128                        ControlEvent::InventoryEvent(event) => {
129                            emitters.emit(event::InventoryManipEvent(entity, event.into()));
130                        },
131                        ControlEvent::GroupManip(manip) => {
132                            emitters.emit(event::GroupManipEvent(entity, manip))
133                        },
134                        ControlEvent::GiveUp => {
135                            if read_data
136                                .healths
137                                .get(entity)
138                                .is_some_and(|h| h.has_consumed_death_protection())
139                            {
140                                emitters.emit(event::KillEvent { entity });
141                            }
142                        },
143                        ControlEvent::Respawn => {
144                            if read_data.healths.get(entity).is_some_and(|h| h.is_dead) {
145                                emitters.emit(event::RespawnEvent(entity));
146                            }
147                        },
148                        ControlEvent::Utterance(kind) => {
149                            if let (Some(pos), Some(body), scale) = (
150                                read_data.positions.get(entity),
151                                read_data.bodies.get(entity),
152                                read_data.scales.get(entity),
153                            ) {
154                                let sound = Sound::new(
155                                    SoundKind::Utterance(kind, *body),
156                                    pos.0
157                                        + Vec3::unit_z()
158                                            * body.eye_height(scale.map_or(1.0, |s| s.0)),
159                                    8.0, // TODO: Come up with a better way of determining this
160                                    1.0,
161                                );
162                                emitters.emit(event::SoundEvent { sound });
163                            }
164                        },
165                        ControlEvent::ChangeAbility {
166                            slot,
167                            auxiliary_key,
168                            new_ability,
169                        } => {
170                            emitters.emit(event::ChangeAbilityEvent {
171                                entity,
172                                slot,
173                                auxiliary_key,
174                                new_ability,
175                            });
176                        },
177                        ControlEvent::LeaveStance => {
178                            emitters.emit(event::ChangeStanceEvent {
179                                entity,
180                                stance: Stance::None,
181                            });
182                        },
183                        ControlEvent::ActivatePortal(portal_uid) => {
184                            if let Some(portal) = read_data.id_maps.uid_entity(portal_uid) {
185                                emitters.emit(event::StartTeleportingEvent { entity, portal });
186                            }
187                        },
188                        ControlEvent::InteractWith { target, kind } => {
189                            if let Some(uid) = read_data.uids.get(entity) {
190                                emitters.emit(event::StartInteractionEvent(Interaction {
191                                    interactor: *uid,
192                                    target,
193                                    kind,
194                                }));
195                            }
196                        },
197                        ControlEvent::Dialogue(target, dialogue) => {
198                            if let Some(msg) = dialogue.message().cloned() {
199                                emitters.emit(ChatEvent {
200                                    msg: UnresolvedChatMsg::npc(*uid, msg),
201                                    from_client: false,
202                                });
203                            }
204                            if let Some(target) = read_data.id_maps.uid_entity(target) {
205                                emitters.emit(event::DialogueEvent(
206                                    entity,
207                                    target,
208                                    dialogue.clone(),
209                                ));
210                            } else {
211                                warn!("Control event Dialogue sent to non-existent target entity");
212                            }
213                        },
214                    }
215                }
216            });
217    }
218}
veloren_common_systems/controller.rs

veloren_common_systems/
controller.rs
