Struct bevy_hecs::Archetype

pub struct Archetype { /* fields omitted */ }

A collection of entities having the same component types

Accessing Archetypes is only required for complex dynamic scheduling. To manipulate entities, go through the World.

Implementations

impl Archetype

pub fn new(types: Vec<TypeInfo>) -> Self

pub fn with_grow(types: Vec<TypeInfo>, grow_size: usize) -> Self

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

pub fn has_type(&self, ty: TypeId) -> bool

pub fn get<T: Component>(&self) -> Option<NonNull<T>>

pub fn get_with_type_state<T: Component>(
    &self
) -> Option<(NonNull<T>, &TypeState)>

pub fn get_type_state(&self, ty: TypeId) -> Option<&TypeState>

pub fn get_type_state_mut(&mut self, ty: TypeId) -> Option<&mut TypeState>

pub fn borrow<T: Component>(&self)

pub fn borrow_mut<T: Component>(&self)

pub fn release<T: Component>(&self)

pub fn release_mut<T: Component>(&self)

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn iter_entities(&self) -> impl Iterator<Item = &Entity>

pub fn types(&self) -> &[TypeInfo]

pub unsafe fn allocate(&mut self, id: Entity) -> usize

Safety

Every type must be written immediately after this call

pub fn clear_trackers(&mut self)

pub unsafe fn put_dynamic(
    &mut self,
    component: *mut u8,
    ty: TypeId,
    size: usize,
    index: usize,
    added: bool
)

Safety

• component must point to valid memory
• the component type must be registered
• index must be in-bound
• size must be the size of the component
• the storage array must be big enough

Trait Implementations

impl Debug for Archetype

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

Formats the value using the given formatter.

impl Drop for Archetype

fn drop(&mut self)

Executes the destructor for this type.