Struct planck_ecs::World

pub struct World { /* fields omitted */ }

Contains data indexed by type. World allows to dynamically enforce the rust rules of borrowing and ownership at runtime:

• The same type cannot be borrowed immutably and mutably at the same time.
• The same type cannot be borrowed mutably more than once at the same time.

Implementations

impl World

pub fn initialize<T>(&mut self) where
    T: 'static + Default + Send + Sync, 

Initializes a resource to its default value. This is the only way to “insert” a resource.

It is suggested to use a macro to collect all the resources and initialize all of them.

pub fn get<T>(&self) -> Result<AtomicRef<'_, T>, EcsError> where
    T: 'static + Send + Sync, 

Get an immutable reference to a resource by type. Will return an error if the type is:

• Non initialized
• Already borrowed mutably

pub fn get_mut<T>(&self) -> Result<AtomicRefMut<'_, T>, EcsError> where
    T: 'static + Send + Sync, 

Get a mutable reference to a resource by type. Will return an error if the type is:

• Non initialized
• Already borrowed immutably
• Already borrowed mutably

pub fn get_mut_or_default<T>(&mut self) -> AtomicRefMut<'_, T> where
    T: 'static + Default + Send + Sync, 

Get a mutable reference to a resource by type, default-initializing it if not already initialized.

Trait Implementations

impl Default for World

pub fn default() -> World

Returns the “default value” for a type.

impl WorldExt for World

fn maintain(&mut self)

Removes dead entities from all the registered storages.