pkecs 9.0.0

Another ECS implementation.
Documentation 
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

//! Types for containing ECS state.

use crate::cell::UncheckedCell;
use super::{component::Components, event::EventQueues};

/// The primary data store for the ECS.
#[derive(Default)]
pub struct World {
    components: Components,
    events: EventQueues,
}

impl World {
    /// Returns an immutable reference to [`Components`].
    pub const fn components(&self) -> &Components {
        &self.components
    }

    /// Returns a mutable reference to [`Components`].
    pub const fn components_mut(&mut self) -> &mut Components {
        &mut self.components
    }

    /// Returns an immutable reference to [`EventQueues`].
    pub const fn events(&self) -> &EventQueues {
        &self.events
    }

    /// Returns a mutable reference to [`EventQueues`].
    pub const fn events_mut(&mut self) -> &mut EventQueues {
        &mut self.events
    }
}

/// A [`World`] wrapped in a [`UncheckedCell`].
///
/// This facilitates most of the functionality provided by pkecs.
///
/// SAFETY:
/// Note that this is 'unsafe' for a reason, you must uphold safety guarantees.
pub type UnsafeWorldCell = UncheckedCell<World>;