pub struct Archetypes { /* private fields */ }
Expand description
The backing store of all Archetype
s within a World
.
For more information, see the module level documentation.
Implementations§
Source§impl Archetypes
impl Archetypes
Sourcepub fn generation(&self) -> ArchetypeGeneration
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 Archetype
s since the last time this
function was called.
Sourcepub fn empty(&self) -> &Archetype
pub fn empty(&self) -> &Archetype
Fetches an immutable reference to the archetype without any components.
Shorthand for archetypes.get(ArchetypeId::EMPTY).unwrap()
Sourcepub fn get(&self, id: ArchetypeId) -> Option<&Archetype>
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.
Sourcepub fn iter(&self) -> impl Iterator<Item = &Archetype>
pub fn iter(&self) -> impl Iterator<Item = &Archetype>
Returns a read-only iterator over all archetypes.
Sourcepub fn archetype_components_len(&self) -> usize
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§
Source§impl Index<ArchetypeId> for Archetypes
impl Index<ArchetypeId> for Archetypes
Source§impl Index<RangeFrom<ArchetypeGeneration>> for Archetypes
impl Index<RangeFrom<ArchetypeGeneration>> for Archetypes
Source§impl IndexMut<ArchetypeId> for Archetypes
impl IndexMut<ArchetypeId> for Archetypes
Source§impl<'a> SystemParam for &'a Archetypes
impl<'a> SystemParam for &'a Archetypes
Source§type Item<'w, 's> = &'w Archetypes
type Item<'w, 's> = &'w Archetypes
Self
, instantiated with new lifetimes. Read moreSource§fn init_state(_world: &mut World, _system_meta: &mut SystemMeta) -> Self::State
fn init_state(_world: &mut World, _system_meta: &mut SystemMeta) -> Self::State
World
access used by this SystemParam
and creates a new instance of this param’s State
.Source§unsafe fn get_param<'w, 's>(
_state: &'s mut Self::State,
_system_meta: &SystemMeta,
world: UnsafeWorldCell<'w>,
_change_tick: Tick,
) -> Self::Item<'w, 's>
unsafe fn get_param<'w, 's>( _state: &'s mut Self::State, _system_meta: &SystemMeta, world: UnsafeWorldCell<'w>, _change_tick: Tick, ) -> Self::Item<'w, 's>
SystemParamFunction
. Read moreSource§unsafe fn new_archetype(
state: &mut Self::State,
archetype: &Archetype,
system_meta: &mut SystemMeta,
)
unsafe fn new_archetype( state: &mut Self::State, archetype: &Archetype, system_meta: &mut SystemMeta, )
Archetype
, registers the components accessed by this SystemParam
(if applicable).a Read moreSource§fn apply(state: &mut Self::State, system_meta: &SystemMeta, world: &mut World)
fn apply(state: &mut Self::State, system_meta: &SystemMeta, world: &mut World)
SystemParam
’s state.
This is used to apply Commands
during apply_deferred
.Source§fn queue(
state: &mut Self::State,
system_meta: &SystemMeta,
world: DeferredWorld<'_>,
)
fn queue( state: &mut Self::State, system_meta: &SystemMeta, world: DeferredWorld<'_>, )
apply_deferred
.