Struct bevy::ecs::archetype::Archetypes
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§
§impl Archetypes
impl Archetypes
pub fn generation(&self) -> ArchetypeGeneration
pub fn generation(&self) -> ArchetypeGeneration
Returns the current archetype generation. This is an ID indicating the current set of archetypes that are registered with the world.
pub 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()
pub 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.
pub fn iter(&self) -> impl Iterator<Item = &Archetype>
pub fn iter(&self) -> impl Iterator<Item = &Archetype>
Returns a read-only iterator over all archetypes.
pub 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§
§impl Index<ArchetypeId> for Archetypes
impl Index<ArchetypeId> for Archetypes
§fn index(
&self,
index: ArchetypeId
) -> &<Archetypes as Index<ArchetypeId>>::Output
fn index( &self, index: ArchetypeId ) -> &<Archetypes as Index<ArchetypeId>>::Output
Performs the indexing (
container[index]
) operation. Read more§impl IndexMut<ArchetypeId> for Archetypes
impl IndexMut<ArchetypeId> for Archetypes
§fn index_mut(
&mut self,
index: ArchetypeId
) -> &mut <Archetypes as Index<ArchetypeId>>::Output
fn index_mut( &mut self, index: ArchetypeId ) -> &mut <Archetypes as Index<ArchetypeId>>::Output
Performs the mutable indexing (
container[index]
) operation. Read more§impl<'a> SystemParam for &'a Archetypes
impl<'a> SystemParam for &'a Archetypes
§type Item<'w, 's> = &'w Archetypes
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. Read more§fn init_state(
_world: &mut World,
_system_meta: &mut SystemMeta
) -> <&'a Archetypes as SystemParam>::State
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>
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
. Read more§fn new_archetype(
_state: &mut Self::State,
_archetype: &Archetype,
_system_meta: &mut SystemMeta
)
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).§fn apply(state: &mut Self::State, system_meta: &SystemMeta, world: &mut World)
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
.impl<'a> ReadOnlySystemParam for &'a Archetypes
Auto Trait Implementations§
impl RefUnwindSafe for Archetypes
impl Send for Archetypes
impl Sync for Archetypes
impl Unpin for Archetypes
impl UnwindSafe for Archetypes
Blanket Implementations§
§impl<T, U> AsBindGroupShaderType<U> for Twhere
U: ShaderType,
&'a T: for<'a> Into<U>,
impl<T, U> AsBindGroupShaderType<U> for Twhere U: ShaderType, &'a T: for<'a> Into<U>,
§fn as_bind_group_shader_type(&self, _images: &RenderAssets<Image>) -> U
fn as_bind_group_shader_type(&self, _images: &RenderAssets<Image>) -> U
Return the
T
ShaderType
for self
. When used in AsBindGroup
derives, it is safe to assume that all images in self
exist.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
Mutably borrows from an owned value. Read more
§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere T: Any,
§fn into_any(self: Box<T, Global>) -> Box<dyn Any, Global>
fn into_any(self: Box<T, Global>) -> Box<dyn Any, Global>
Convert
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
.§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Convert
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
Convert
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Convert
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.