shipyard 0.11.2

Entity Component System
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
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

use crate::component::Component;
use crate::entity_id::EntityId;
use crate::ViewMut;

/// Adds components to an existing entity.
pub trait AddComponent<T> {
    /// Adds `component` to `entity`, multiple components can be added at the same time using a tuple.  
    /// This function does not check `entity` is alive. It's possible to add components to removed entities.  
    /// Use [`Entities::add_component`] if you're unsure.
    ///
    /// ### Example
    /// ```
    /// use shipyard::{AddComponent, Component, EntitiesViewMut, ViewMut, World};
    ///
    /// #[derive(Component)]
    /// struct U32(u32);
    ///
    /// let world = World::new();
    ///
    /// let (mut entities, mut u32s) = world.borrow::<(EntitiesViewMut, ViewMut<U32>)>().unwrap();
    /// let entity = entities.add_entity((), ());
    ///
    /// u32s.add_component_unchecked(entity, U32(0));
    /// ```
    ///
    /// [`Entities::add_component`]: crate::entities::Entities::add_component()
    fn add_component_unchecked(&mut self, entity: EntityId, component: T)
    where
        Self: Sized;
}

impl AddComponent<()> for () {
    #[inline]
    fn add_component_unchecked(&mut self, _: EntityId, _: ()) {}
}

impl<T: Component, TRACK> AddComponent<T> for ViewMut<'_, T, TRACK> {
    #[inline]
    #[track_caller]
    fn add_component_unchecked(&mut self, entity: EntityId, component: T) {
        let _ = self.sparse_set.insert(entity, component, self.current);
    }
}

impl<T: Component, TRACK> AddComponent<T> for &mut ViewMut<'_, T, TRACK> {
    #[inline]
    #[track_caller]
    fn add_component_unchecked(&mut self, entity: EntityId, component: T) {
        let _ = self.sparse_set.insert(entity, component, self.current);
    }
}

impl<T: Component, TRACK> AddComponent<Option<T>> for ViewMut<'_, T, TRACK> {
    #[inline]
    #[track_caller]
    fn add_component_unchecked(&mut self, entity: EntityId, component: Option<T>) {
        if let Some(component) = component {
            let _ = self.sparse_set.insert(entity, component, self.current);
        }
    }
}

impl<T: Component, TRACK> AddComponent<Option<T>> for &mut ViewMut<'_, T, TRACK> {
    #[inline]
    #[track_caller]
    fn add_component_unchecked(&mut self, entity: EntityId, component: Option<T>) {
        if let Some(component) = component {
            let _ = self.sparse_set.insert(entity, component, self.current);
        }
    }
}

macro_rules! impl_add_component {
    ($(($storage: ident, $component: ident, $index: tt))+) => {
        impl<$($component: Component,)+ $($storage: AddComponent<$component>,)+> AddComponent<($($component,)+)> for ($($storage,)+) {
            #[inline]
            #[track_caller]
            fn add_component_unchecked(&mut self, entity: EntityId, component: ($($component,)+)) {
                $(
                    let _ = self.$index.add_component_unchecked(entity, component.$index);
                )+
            }
        }
    }
}

macro_rules! add_component {
    ($(($storage: ident, $component: ident, $index: tt))+; ($storage1: ident, $component1: ident, $index1: tt) $(($queue_storage: ident, $queue_component: ident, $queue_index: tt))*) => {
        impl_add_component![$(($storage, $component, $index))*];
        add_component![$(($storage, $component, $index))* ($storage1, $component1, $index1); $(($queue_storage, $queue_component, $queue_index))*];
    };
    ($(($storage: ident, $component: ident, $index: tt))+;) => {
        impl_add_component![$(($storage, $component, $index))*];
    }
}

#[cfg(not(feature = "extended_tuple"))]
add_component![(ViewA, A, 0); (ViewB, B, 1) (ViewC, C, 2) (ViewD, D, 3) (ViewE, E, 4) (ViewF, F, 5) (ViewG, G, 6) (ViewH, H, 7) (ViewI, I, 8) (ViewJ, J, 9)];
#[cfg(feature = "extended_tuple")]
add_component![
    (ViewA, A, 0); (ViewB, B, 1) (ViewC, C, 2) (ViewD, D, 3) (ViewE, E, 4) (ViewF, F, 5) (ViewG, G, 6) (ViewH, H, 7) (ViewI, I, 8) (ViewJ, J, 9)
    (ViewK, K, 10) (ViewL, L, 11) (ViewM, M, 12) (ViewN, N, 13) (ViewO, O, 14) (ViewP, P, 15) (ViewQ, Q, 16) (ViewR, R, 17) (ViewS, S, 18) (ViewT, T, 19)
    (ViewU, U, 20) (ViewV, V, 21) (ViewW, W, 22) (ViewX, X, 23) (ViewY, Y, 24) (ViewZ, Z, 25) (ViewAA, AA, 26) (ViewBB, BB, 27) (ViewCC, CC, 28) (ViewDD, DD, 29)
    (ViewEE, EE, 30) (ViewFF, FF, 31)
];