summaryrefslogtreecommitdiff
path: root/ecs/src/actions.rs
blob: 08780677054a1cc9b906702861d3983aa16b2925 (plain)
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
use std::marker::PhantomData;
use std::sync::{Arc, Weak};

use crate::component::{
    Component,
    Metadata as ComponentMetadata,
    Sequence as ComponentSequence,
};
use crate::system::{NoInitParamFlag, Param as SystemParam, System};
use crate::uid::{Kind as UidKind, Uid};
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,
    action_queue_weak: Weak<ActionQueue>,
}

impl<'world> Actions<'world>
{
    /// Queues up a entity to spawn at the end of the current tick.
    pub fn spawn<Comps: ComponentSequence>(&mut self, components: Comps)
    {
        self.action_queue.push(Action::Spawn(
            components.into_vec(),
            EventIds { ids: Comps::added_event_ids() },
        ));
    }

    /// 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);

        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);

        self.action_queue.push(Action::AddComponents(
            entity_uid,
            components.into_vec(),
            EventIds { ids: Comps::added_event_ids() },
        ));
    }

    /// Queues up removing component(s) from a entity at the end of the current tick.
    pub fn remove_components<Comps>(&mut self, entity_uid: Uid)
    where
        Comps: ComponentSequence,
    {
        debug_assert_eq!(entity_uid.kind(), UidKind::Entity);

        self.action_queue.push(Action::RemoveComponents(
            entity_uid,
            Comps::metadata(),
            EventIds { ids: Comps::removed_event_ids() },
        ));
    }

    /// 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);
    }

    /// Returns a struct which holds a weak reference to the [`World`] that `Actions`
    /// references and that can be used to aquire a new `Actions` instance if the
    /// referenced [`World`] is still alive.
    #[must_use]
    pub fn to_weak_ref(&self) -> WeakRef
    {
        WeakRef {
            action_queue: self.action_queue_weak.clone(),
        }
    }

    fn new(action_queue: &'world Arc<ActionQueue>) -> Self
    {
        Self {
            action_queue,
            action_queue_weak: Arc::downgrade(action_queue),
        }
    }
}

unsafe impl<'world> SystemParam<'world> for Actions<'world>
{
    type Flags = NoInitParamFlag;
    type Input = ();

    fn initialize<SystemImpl>(
        _system: &mut impl System<'world, SystemImpl>,
        _input: Self::Input,
    )
    {
    }

    fn new<SystemImpl>(
        _system: &'world impl System<'world, SystemImpl>,
        world: &'world World,
    ) -> Self
    {
        Self::new(&world.data.action_queue)
    }
}

#[derive(Debug, Clone)]
pub struct WeakRef
{
    action_queue: Weak<ActionQueue>,
}

impl WeakRef
{
    /// Returns a struct which can be used to retrieve a [`Actions`].
    ///
    /// Returns [`None`] if the referenced [`World`] has been dropped.
    #[must_use]
    pub fn access(&self) -> Option<Ref<'_>>
    {
        Some(Ref {
            action_queue: self.action_queue.upgrade()?,
            _pd: PhantomData,
        })
    }
}

/// Intermediate between [`Actions`] and [`WeakRef`]. Contains a strong reference to
/// a world which is not allowed direct access to.
#[derive(Debug, Clone)]
pub struct Ref<'weak_ref>
{
    action_queue: Arc<ActionQueue>,
    _pd: PhantomData<&'weak_ref ()>,
}

impl<'weak_ref> Ref<'weak_ref>
{
    #[must_use]
    pub fn to_actions(&self) -> Actions<'_>
    {
        Actions::new(&self.action_queue)
    }
}

#[derive(Debug)]
pub(crate) struct EventIds
{
    pub(crate) ids: Vec<Uid>,
}

/// A action for a [`System`] to perform.
#[derive(Debug)]
pub(crate) enum Action
{
    Spawn(Vec<Box<dyn Component>>, EventIds),
    Despawn(Uid),
    AddComponents(Uid, Vec<Box<dyn Component>>, EventIds),
    RemoveComponents(Uid, Vec<ComponentMetadata>, EventIds),
    Stop,
}