Struct valence::ecs::archetype::Archetypes

pub struct Archetypes { /* private fields */ }

The backing store of all Archetypes within a World.

For more information, see the module level documentation.

Implementations

impl Archetypes

pub fn generation(&self) -> ArchetypeGeneration

Returns the “generation”, a handle to the current highest archetype ID.

This can be used with the Index Archetypes implementation to iterate over newly introduced Archetypes since the last time this function was called.

pub fn len(&self) -> usize

Fetches the total number of Archetypes within the world.

pub fn empty(&self) -> &Archetype

Fetches an immutable reference to the archetype without any components.

Shorthand for archetypes.get(ArchetypeId::EMPTY).unwrap()

pub fn get(&self, id: ArchetypeId) -> Option<&Archetype>

Fetches an immutable reference to an Archetype using its ID. Returns None if no corresponding archetype exists.

pub fn iter(&self) -> impl Iterator<Item = &Archetype>

Returns a read-only iterator over all archetypes.

pub fn archetype_components_len(&self) -> usize

Returns the number of components that are stored in archetypes. Note that if some component T is stored in more than one archetype, it will be counted once for each archetype it’s present in.

Trait Implementations

impl Index<ArchetypeId> for Archetypes

type Output = Archetype

The returned type after indexing.

fn index( &self, index: ArchetypeId, ) -> &<Archetypes as Index<ArchetypeId>>::Output

Performs the indexing (container[index]) operation.

impl Index<RangeFrom<ArchetypeGeneration>> for Archetypes

type Output = [Archetype]

The returned type after indexing.

fn index( &self, index: RangeFrom<ArchetypeGeneration>, ) -> &<Archetypes as Index<RangeFrom<ArchetypeGeneration>>>::Output

Performs the indexing (container[index]) operation.

impl IndexMut<ArchetypeId> for Archetypes

fn index_mut( &mut self, index: ArchetypeId, ) -> &mut <Archetypes as Index<ArchetypeId>>::Output

Performs the mutable indexing (container[index]) operation.

impl<'a> SystemParam for &'a Archetypes

type State = ()

Used to store data which persists across invocations of a system.

type Item<'w, 's> = &'w Archetypes

The item type returned when constructing this system param. The value of this associated type should be Self, instantiated with new lifetimes.

fn init_state( _world: &mut World, _system_meta: &mut SystemMeta, ) -> <&'a Archetypes as SystemParam>::State

Registers any World access used by this SystemParam and creates a new instance of this param’s State.

unsafe fn get_param<'w, 's>( _state: &'s mut <&'a Archetypes as SystemParam>::State, _system_meta: &SystemMeta, world: UnsafeWorldCell<'w>, _change_tick: Tick, ) -> <&'a Archetypes as SystemParam>::Item<'w, 's>

Creates a parameter to be passed into a SystemParamFunction.

unsafe fn new_archetype( state: &mut Self::State, archetype: &Archetype, system_meta: &mut SystemMeta, )

For the specified Archetype, registers the components accessed by this SystemParam (if applicable).a

fn apply(state: &mut Self::State, system_meta: &SystemMeta, world: &mut World)

Applies any deferred mutations stored in this SystemParam’s state. This is used to apply Commands during apply_deferred.

fn queue( state: &mut Self::State, system_meta: &SystemMeta, world: DeferredWorld<'_>, )

Queues any deferred mutations to be applied at the next apply_deferred.

impl<'a> ReadOnlySystemParam for &'a Archetypes