Struct xecs::World

pub struct World { /* private fields */ }

World is the core of XECS.It manages all components and entities

Implementations

impl World

pub fn new() -> World

Create a empty world.

pub fn register_resource<R: Resource>(&mut self, resource: R)

Register resource in world

pub fn resource_read<R: Resource>(&self) -> Option<ResourceRead<'_, R>>

Get a read guard of resource

pub fn resource_write<R: Resource>(&self) -> Option<ResourceWrite<'_, R>>

Get a write guard of resource

pub fn register<T: Component>(&mut self) -> &mut Self

Register a component.

Panics

Panic if component is registered.

pub fn has_registered<T: Component>(&self) -> bool

Check if component is registered.

pub fn create_entity(&self) -> Entity<'_>

Create an entity without any component in World, return an Entity.

pub fn create_entities(&self, count: usize) -> Entities<'_>

Create count of entities

Details

This funtionn ensures tbe entity id is continuous.

pub fn remove_entity(&self, entity_id: EntityId)

Remove entity and its components.

pub fn attach_component<T: Component>(&self, entity_id: EntityId, component: T)

Attach a component to an entity.

Panics

• Panic if T is not registered.
• Panic if entity_id not exist.

pub fn detach_component<T: Component>(&self, entity_id: EntityId) -> Option<T>

Detach a component from an entity.

Details

Return None if entity doesn’t have this component,
otherwise return Some(component)

Panics

• Panic if T is not registered.
• Panic if entity_id not exist.

pub fn exist(&self, entity_id: EntityId) -> bool

Check if entity_id exists in World.

pub fn components_read<T: Component>(&self) -> Option<StorageRead<'_, T>>

Get the component storage’s read guard

pub fn components_write<T: Component>(&self) -> Option<StorageWrite<'_, T>>

Get the component storage’s write guard

pub fn entity_component_read<T: Component>(
    &self,
    id: EntityId
) -> Option<ComponentRead<'_, T>>

Get the read guard of component of an entity

pub fn entity_component_write<T: Component>(
    &self,
    id: EntityId
) -> Option<ComponentWrite<'_, T>>

Get the write guard of component of an entity

pub fn entity(&self, id: EntityId) -> Option<Entity<'_>>

Get an Entity from an entity id

pub fn make_group<G: Into<Group> + 'static + Copy>(&mut self, group: G)

Make a group to accelerate the iteration.

Panics

• Panic if group is the same as another group in World.
• Panic if component is owned by another group.

pub fn query<'a, T: Queryable<'a>>(
    &'a self
) -> Box<dyn QueryIterator<Item = <T as Queryable<'_>>::Item> + 'a>

Query entities with conditions

Trait Implementations

impl Debug for World

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.