Struct bevy_ecs::component::Components
source · pub struct Components { /* private fields */ }
Implementations§
source§impl Components
impl Components
pub fn init_component<T: Component>( &mut self, storages: &mut Storages ) -> ComponentId
pub fn init_component_with_descriptor( &mut self, storages: &mut Storages, descriptor: ComponentDescriptor ) -> ComponentId
pub fn len(&self) -> usize
pub fn is_empty(&self) -> bool
pub fn get_info(&self, id: ComponentId) -> Option<&ComponentInfo>
pub fn get_name(&self, id: ComponentId) -> Option<&str>
sourcepub unsafe fn get_info_unchecked(&self, id: ComponentId) -> &ComponentInfo
pub unsafe fn get_info_unchecked(&self, id: ComponentId) -> &ComponentInfo
Safety
id
must be a valid ComponentId
sourcepub fn get_id(&self, type_id: TypeId) -> Option<ComponentId>
pub fn get_id(&self, type_id: TypeId) -> Option<ComponentId>
Type-erased equivalent of Components::component_id
.
sourcepub fn component_id<T: Component>(&self) -> Option<ComponentId>
pub fn component_id<T: Component>(&self) -> Option<ComponentId>
Returns the ComponentId
of the given Component
type T
.
The returned ComponentId
is specific to the Components
instance
it was retrieved from and should not be used with another Components
instance.
Returns None
if the Component
type has not
yet been initialized using Components::init_component
.
use bevy_ecs::prelude::*;
let mut world = World::new();
#[derive(Component)]
struct ComponentA;
let component_a_id = world.init_component::<ComponentA>();
assert_eq!(component_a_id, world.components().component_id::<ComponentA>().unwrap())
sourcepub fn get_resource_id(&self, type_id: TypeId) -> Option<ComponentId>
pub fn get_resource_id(&self, type_id: TypeId) -> Option<ComponentId>
Type-erased equivalent of Components::resource_id
.
sourcepub fn resource_id<T: Resource>(&self) -> Option<ComponentId>
pub fn resource_id<T: Resource>(&self) -> Option<ComponentId>
Returns the ComponentId
of the given Resource
type T
.
The returned ComponentId
is specific to the Components
instance
it was retrieved from and should not be used with another Components
instance.
Returns None
if the Resource
type has not
yet been initialized using Components::init_resource
.
use bevy_ecs::prelude::*;
let mut world = World::new();
#[derive(Resource, Default)]
struct ResourceA;
let resource_a_id = world.init_resource::<ResourceA>();
assert_eq!(resource_a_id, world.components().resource_id::<ResourceA>().unwrap())
pub fn init_resource<T: Resource>(&mut self) -> ComponentId
pub fn init_non_send<T: Any>(&mut self) -> ComponentId
pub fn iter(&self) -> impl Iterator<Item = &ComponentInfo> + '_
Trait Implementations§
source§impl Debug for Components
impl Debug for Components
source§impl Default for Components
impl Default for Components
source§fn default() -> Components
fn default() -> Components
Returns the “default value” for a type. Read more
source§impl<'a> SystemParam for &'a Components
impl<'a> SystemParam for &'a Components
§type Item<'w, 's> = &'w Components
type Item<'w, 's> = &'w Components
The item type returned when constructing this system param.
The value of this associated type should be
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
Registers any
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: &'w World,
_change_tick: u32
) -> Self::Item<'w, 's>
unsafe fn get_param<'w, 's>( _state: &'s mut Self::State, _system_meta: &SystemMeta, world: &'w World, _change_tick: u32 ) -> Self::Item<'w, 's>
Safety Read more
source§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).source§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_system_buffers
.impl<'a> ReadOnlySystemParam for &'a Components
Auto Trait Implementations§
impl RefUnwindSafe for Components
impl Send for Components
impl Sync for Components
impl Unpin for Components
impl UnwindSafe for Components
Blanket Implementations§
source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere T: Any,
source§fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, 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
.source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
Convert
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)
Convert
&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)
Convert
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.source§impl<T> FromWorld for Twhere
T: Default,
impl<T> FromWorld for Twhere T: Default,
source§fn from_world(_world: &mut World) -> T
fn from_world(_world: &mut World) -> T
Creates
Self
using data from the given World