Struct chunked::universe::Universe

pub struct Universe { /* fields omitted */ }

A universe contains all of the globals which can be shared between worlds.

This includes things like chunk allocation zones and the archetype list.

Implementations

impl Universe

pub fn new() -> Arc<Universe>

Create a new universe with the default settings.

pub fn with_chunk_size(chunk_size: usize) -> Arc<Universe>

Create a new universe with a specified maximum number of entities per chunk.

pub fn chunk_size(&self) -> usize

Get the chunk size in number of entities per chunk.

pub fn archetype_by_id(&self, id: usize) -> Option<Arc<Archetype>>

Fetch an archetype by its ID.

pub fn archetype<'a, T: ComponentSet>(
    &self,
    component_types: T
) -> Option<Arc<Archetype>>

Get a archetype with the given component types, providing it already exists in the world.

Generally, one should prefer ensure_archetype unless you have a particular reason to not want the archetype to be created, as it handles the fast case of the archetype already existing.

pub fn ensure_archetype<'a>(
    self: &Arc<Universe>,
    component_types: impl ComponentSet
) -> Arc<Archetype>

Get the archetype which contains exactly the requested component types.

The archetype might not contain the given types in the order requested, they will be sorted by their unique ID.

pub fn allocate_entity(&self) -> EntityID

Generate a new entity ID which is unique for this world.

pub fn flush(&self)

Flush all cached memory.