1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
|
use crate::component::{Parts as ComponentParts, Sequence as ComponentSequence};
use crate::event::component::Removed;
use crate::pair::Pair;
use crate::system::{Metadata as SystemMetadata, Param as SystemParam};
use crate::uid::{Kind as UidKind, Uid, WithUidTuple};
use crate::{ActionQueue, World};
/// Used to to queue up actions for a [`World`] to perform.
#[derive(Debug)]
pub struct Actions<'world>
{
action_queue: &'world ActionQueue,
world: Option<&'world World>,
}
impl Actions<'_>
{
/// Queues up a entity to spawn at the end of the current tick, returning the [`Uid`]
/// that the entity will have.
pub fn spawn<Comps: ComponentSequence>(&mut self, components: Comps) -> Uid
{
let new_entity_uid = Uid::new_unique(UidKind::Entity);
self.action_queue.push(Action::Spawn(
new_entity_uid,
components.into_parts_array().into(),
));
new_entity_uid
}
/// Queues up despawning a entity at the end of the current tick.
pub fn despawn(&mut self, entity_uid: Uid)
{
debug_assert_eq!(entity_uid.kind(), UidKind::Entity);
let Some(world) = self.world else {
self.action_queue.push(Action::Despawn(entity_uid));
return;
};
let Some(ent) = world.get_entity(entity_uid) else {
tracing::warn!("Cannot entity that doesn't exist");
return;
};
// TODO: Submit all events with a single function call to reduce overhead
for comp_id in ent.component_ids() {
if comp_id.kind() == UidKind::Pair {
continue;
}
world.event_submitter().submit_event(
&Pair::builder()
.relation::<Removed>()
.target_id(comp_id)
.build(),
entity_uid,
);
}
self.action_queue.push(Action::Despawn(entity_uid));
}
/// Queues up adding component(s) to a entity at the end of the current tick.
pub fn add_components<Comps>(&mut self, entity_uid: Uid, components: Comps)
where
Comps: ComponentSequence,
{
debug_assert_eq!(entity_uid.kind(), UidKind::Entity);
if Comps::COUNT == 0 {
return;
}
self.action_queue.push(Action::AddComponents(
entity_uid,
components.into_parts_array().into(),
));
}
/// Queues up removing component(s) from a entity at the end of the current tick.
#[tracing::instrument(skip(self, component_ids))]
pub fn remove_components(
&mut self,
entity_uid: Uid,
component_ids: impl IntoIterator<Item = Uid>,
)
{
debug_assert_eq!(entity_uid.kind(), UidKind::Entity);
let mut component_ids = component_ids.into_iter().peekable();
if component_ids.peek().is_none() {
return;
}
let Some(world) = self.world else {
self.action_queue.push(Action::RemoveComponents(
entity_uid,
component_ids.collect(),
));
return;
};
let Some(ent) = world.get_entity(entity_uid) else {
tracing::warn!("Cannot remove components from entity that doesn't exist");
return;
};
let component_ids = component_ids
.filter(|comp_id| ent.has_component(*comp_id))
.collect::<Vec<_>>();
if component_ids.is_empty() {
return;
}
// TODO: Submit all events with a single function call to reduce overhead
for comp_id in &component_ids {
if comp_id.kind() == UidKind::Pair {
continue;
}
world.event_submitter().submit_event(
&Pair::builder()
.relation::<Removed>()
.target_id(*comp_id)
.build(),
entity_uid,
);
}
self.action_queue
.push(Action::RemoveComponents(entity_uid, component_ids));
}
/// Queues up removing component(s) from a entity at the end of the current tick.
pub fn remove_comps<Ids: WithUidTuple>(&mut self, entity_uid: Uid)
{
self.remove_components(entity_uid, Ids::uids());
}
/// Stops the [`World`]. The world will finish the current tick and that tick will be
/// the last.
pub fn stop(&mut self)
{
self.action_queue.push(Action::Stop);
}
}
impl<'world> SystemParam<'world> for Actions<'world>
{
type Input = ();
fn new(world: &'world World, _system_metadata: &SystemMetadata) -> Self
{
Self {
action_queue: &world.data.action_queue,
world: Some(world),
}
}
}
/// A action for a [`System`] to perform.
#[derive(Debug)]
pub(crate) enum Action
{
Spawn(Uid, Vec<ComponentParts>),
Despawn(Uid),
AddComponents(Uid, Vec<ComponentParts>),
RemoveComponents(Uid, Vec<Uid>),
Stop,
}
|
