ecs-lib-rs 0.1.1

An Entity Component System (ECS) Framework for learning.
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
106

mod custom_errors;
mod entities;
mod resources;

use crate::entities::query::Query;
use crate::entities::Entities;
use crate::resources::Resources;
use eyre::Result;
use std::any::Any;

#[derive(Default)]
pub struct World {
    resources: Resources,
    entities: Entities,
}

impl World {
    pub fn new() -> Self {
        Self::default()
    }

    /// Add a resource.
    /// ```
    /// use ecs_lib_rs::World;
    /// let mut world = World::new();
    /// world.add_resource(1_u32);
    /// assert_eq!(world.get_resource::<u32>(), Some(&1));
    /// ```
    pub fn add_resource(&mut self, resource: impl Any) {
        self.resources.add(resource)
    }

    /// Query for a resource and get a reference to it. The type of the resource must be added in so that it can find it.
    /// ```
    /// use ecs_lib_rs::World;
    /// let mut world = World::new();
    /// assert_eq!(world.get_resource::<u32>(), None);
    /// world.add_resource(1_u32);
    /// assert_eq!(world.get_resource::<u32>(), Some(&1));
    /// ```
    pub fn get_resource<T: Any>(&self) -> Option<&T> {
        self.resources.get_ref::<T>()
    }

    /// Query for a resource and get a mutable reference to it. The type of the resource must be added in so that it can find it.
    /// ```
    /// use ecs_lib_rs::World;
    /// let mut world = World::new();
    /// assert_eq!(world.get_resource_mut::<u32>(), None);
    /// world.add_resource(1_u32);
    /// {
    ///     let x = world.get_resource_mut::<u32>();
    ///     assert_eq!(x, Some(&mut 1_u32));
    ///     let x = x.unwrap();
    ///     *x += 1;
    /// }
    /// assert_eq!(world.get_resource::<u32>(), Some(&2));
    /// ```
    pub fn get_resource_mut<T: Any>(&mut self) -> Option<&mut T> {
        self.resources.get_mut::<T>()
    }

    /// Removes the resource from the world. Returns `None` if the resource wasn't present and hence was not deleted.
    /// Otherwise, it returns `Some(data)`
    /// ```   
    /// use ecs_lib_rs::World;
    /// let mut world = World::new();
    /// world.add_resource(1_u32);
    /// world.remove_resource::<u32>();
    /// assert_eq!(world.get_resource::<u32>(), None);
    /// ```
    pub fn remove_resource<T: Any>(&mut self) -> Option<Box<dyn Any>> {
        self.resources.remove::<T>()
    }

    /// Register a component. The type of the resource must be added in so that it can find it.
    /// ```
    /// use ecs_lib_rs::World;
    /// let mut world = World::new();
    /// world.register_component::<u32>();
    ///
    /// ```
    pub fn register_component<T: Any>(&mut self) {
        self.entities.register_component::<T>()
    }

    pub fn create_entity(&mut self) -> &mut Entities {
        self.entities.create_entity()
    }

    pub fn query(&self) -> Query {
        Query::new(&self.entities)
    }

    pub fn delete_component_by_entity_id<T: Any>(&mut self, id: usize) -> Result<()> {
        self.entities.delete_component_by_entity_id::<T>(id)
    }

    pub fn add_component_to_entity_by_id(&mut self, id: usize, component: impl Any) -> Result<()> {
        self.entities.add_component_by_entity_id(id, component)
    }

    pub fn delete_entity_by_id(&mut self, id: usize) -> Result<()> {
        self.entities.delete_by_id(id)
    }
}