Struct legion::World

pub struct World { /* fields omitted */ }

Contains queryable collections of data associated with Entitys.

Methods

impl World

pub fn merge(&mut self, other: World)

Merges two worlds together.

This function moves all chunks from other into self. This operation is very fast, however the resulting memory layout may be inefficient if other contains a very small number of entities.

Merge is most effectively used to allow large numbers of entities to be loaded and initialized in the background, and then shunted into the "main" world all at once, once ready.

Safety

It is only safe to merge worlds which belong to the same Universe. This is currently not validated by the API.

pub fn is_alive(&self, entity: &Entity) -> bool

Determines if the given Entity is alive within this World.

pub fn insert_from<S, T>(&mut self, shared: S, components: T) -> &[Entity] where
    S: SharedDataSet,
    T: IntoIterator,
    T::Item: EntityDataSet,
    IterEntitySource<T::IntoIter, T::Item>: EntitySource, 

Inserts entities from an iterator of component tuples.

Examples

Inserting entity tuples:

let shared = (model, color);
let data = vec![
    (Position(0.0), Rotation(0.0)),
    (Position(1.0), Rotation(1.0)),
    (Position(2.0), Rotation(2.0)),
];
world.insert_from(shared, data);

pub fn insert<S, T>(&mut self, shared: S, components: T) -> &[Entity] where
    S: SharedDataSet,
    T: EntitySource, 

Inserts entities from an EntitySource.

pub fn delete(&mut self, entity: Entity) -> bool

Removes the given Entity from the World.

Returns true if the entity was deleted; else false.

pub fn entity_data<'a, T: EntityData>(
    &'a self,
    entity: Entity
) -> Option<Borrowed<'a, T>>

Borrows entity data for the given entity.

Returns Some(data) if the entity was found and contains the specified data. Otherwise None is returned.

Panics

This function borrows all components of type T in the world. It may panic if any other code is currently borrowing T mutably (such as in a query).

pub fn entity_data_mut<T: EntityData>(
    &mut self,
    entity: Entity
) -> Option<&mut T>

Mutably borrows entity data for the given entity.

Returns Some(data) if the entity was found and contains the specified data. Otherwise None is returned.

pub fn shared<T: SharedData>(&self, entity: Entity) -> Option<&T>

Borrows shared data for the given entity.

Returns Some(data) if the entity was found and contains the specified data. Otherwise None is returned.

Trait Implementations

impl Debug for World

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

Formats the value using the given formatter.