Struct hecs::Archetype [−][src]
pub struct Archetype { /* fields omitted */ }
A collection of entities having the same component types
Accessing Archetype
s is only required in niche cases. Typical use should go through the
World
.
Implementations
impl Archetype
[src]
impl Archetype
[src]pub fn has_dynamic(&self, id: TypeId) -> bool
[src]
pub fn has_dynamic(&self, id: TypeId) -> bool
[src]Whether this archetype contains components with the type identified by id
pub fn get<T: Component>(&self) -> Option<ColumnRef<'_, T>>
[src]
pub fn get<T: Component>(&self) -> Option<ColumnRef<'_, T>>
[src]Get the T
components of these entities, if present
Useful for efficient serialization.
pub fn component_types(&self) -> impl ExactSizeIterator<Item = TypeId> + '_
[src]
pub fn component_types(&self) -> impl ExactSizeIterator<Item = TypeId> + '_
[src]Enumerate the types of the components of entities stored in this archetype.
Convenient for dispatching logic which needs to be performed on sets of type ids. For
example, suppose you’re building a scripting system, and you want to integrate the scripting
language with your ECS. This functionality allows you to iterate through all of the
archetypes of the world with World::archetypes()
and extract
all possible combinations of component types which are currently stored in the World
.
From there, you can then create a mapping of archetypes to wrapper objects for your
scripting language that provide functionality based off of the components of any given
Entity
, and bind them onto an Entity
when passed into your scripting language by
looking up the Entity
’s archetype using
EntityRef::component_types
.