Struct bevy_ecs::archetype::Archetypes
source · 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
§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
.impl<'a> ReadOnlySystemParam for &'a Archetypes
Auto Trait Implementations§
impl Freeze for Archetypes
impl RefUnwindSafe for Archetypes
impl Send for Archetypes
impl Sync for Archetypes
impl Unpin for Archetypes
impl UnwindSafe for Archetypes
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
.source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.