pub struct Archetype { /* private fields */ }
Expand description
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
sourceimpl Archetype
impl Archetype
sourcepub fn has_dynamic(&self, id: TypeId) -> bool
pub fn has_dynamic(&self, id: TypeId) -> bool
Whether this archetype contains components with the type identified by id
sourcepub fn get<T: Component>(&self) -> Option<ArchetypeColumn<'_, T>>
pub fn get<T: Component>(&self) -> Option<ArchetypeColumn<'_, T>>
Get the T
components of these entities, if present
Useful for efficient serialization.
sourcepub fn component_types(&self) -> impl ExactSizeIterator<Item = TypeId> + '_
pub fn component_types(&self) -> impl ExactSizeIterator<Item = TypeId> + '_
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
.
Trait Implementations
Auto Trait Implementations
impl RefUnwindSafe for Archetype
impl !Send for Archetype
impl !Sync for Archetype
impl Unpin for Archetype
impl UnwindSafe for Archetype
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more