Struct orbtk::prelude::World

pub struct World<E, C, Ctx> where
    C: ComponentStore,
    E: EntityStore,  { /* fields omitted */ }

The World struct represents the main interface of the library. It used as storage of entities, components and systems.

Implementations

impl<E, C, Ctx> World<E, C, Ctx> where
    C: ComponentStore,
    E: EntityStore, 

pub fn from_stores(entity_store: E, component_store: C) -> World<E, C, Ctx>

Creates a new world from the given container.

pub fn create_entity(&mut self) -> EntityBuilder<'_, E, C>

Creates a new entity and returns a returns an TypeEntityBuilder.

pub fn remove_entity(&mut self, entity: impl Into<Entity>)

Deletes the given entity.

pub fn register_init_system(&mut self, init_system: impl System<E, C, Ctx>)

Registers the init system.

pub fn register_cleanup_system(
    &mut self,
    cleanup_system: impl System<E, C, Ctx>
)

Registers the cleanup system.

pub fn create_system(
    &mut self,
    system: impl System<E, C, Ctx>
) -> SystemStoreBuilder<'_, E, C, Ctx>

Creates a new entity system and returns a returns an SystemStoreBuilder.

pub fn remove_system(&mut self, system_id: u32)

Removes the given entity.

pub fn entity_component_manager(&mut self) -> &mut EntityComponentManager<E, C>

Borrows mutable the entity component manager.

pub fn print_entity(&self, entity: impl Into<Entity>)

Print infos about the given entity.

pub fn run(&mut self)

Run all systems of the world.

pub fn run_with_context(&mut self, ctx: &mut Ctx)

Run all systems of the world and calls run_with_context of the systems with the given context.

Trait Implementations

impl<E, C, Ctx> Drop for World<E, C, Ctx> where
    C: ComponentStore,
    E: EntityStore, 

fn drop(&mut self)

Executes the destructor for this type.

impl<E, C, Ctx> Send for World<E, C, Ctx> where
    C: ComponentStore,
    E: EntityStore,