Struct kudo::World

pub struct World { /* fields omitted */ }

The world holds all components and associated entities.

Implementations

impl World

pub fn new() -> Self

Create the world.

pub fn spawn(&mut self, b: impl ComponentBundle) -> Entity

Spawn an entity with components passed in through a tuple. Multiple components can be passed in through the tuple.

Example

let mut world = World::new();
let entity = world.spawn((456, true));

pub fn despawn(&mut self, entity: Entity) -> Result<(), NoSuchEntity>

Remove an entity and all its components from the world. An error is returned if the entity does not exist.

pub fn get_component_mut<T: 'static>(
    &mut self,
    entity: Entity
) -> Result<&mut T, ComponentError>

Gets mutable access to a single component on an Entity.

pub fn remove_component<T: 'static>(
    &mut self,
    entity: Entity
) -> Result<T, ComponentError>

Remove a single component from an entity. If successful the component is returned.

Example

let mut world = World::new();
let entity = world.spawn((456, true));
let b = world.remove_component::<bool>(entity).unwrap();

pub fn add_component<T: 'static + Send + Sync>(
    &mut self,
    entity: Entity,
    t: T
) -> Result<(), NoSuchEntity>

Adds a component to an entity. If the component already exists its data will be replaced.

pub fn query<'world_borrow, T: QueryParams>(
    &'world_borrow self
) -> Result<Query<'_, T>, ComponentAlreadyBorrowed>

Get a query from the world.

Example

let query = world.query<(&bool, &String)>();