Struct bevy_ecs::component::Components
source · pub struct Components { /* private fields */ }
Implementations§
source§impl Components
impl Components
sourcepub fn init_component<T: Component>(
&mut self,
storages: &mut Storages
) -> ComponentId
pub fn init_component<T: Component>( &mut self, storages: &mut Storages ) -> ComponentId
Initializes a component of type T
with this instance.
If a component of this type has already been initialized, this will return
the ID of the pre-existing component.
§See also
sourcepub fn init_component_with_descriptor(
&mut self,
storages: &mut Storages,
descriptor: ComponentDescriptor
) -> ComponentId
pub fn init_component_with_descriptor( &mut self, storages: &mut Storages, descriptor: ComponentDescriptor ) -> ComponentId
sourcepub fn is_empty(&self) -> bool
pub fn is_empty(&self) -> bool
Returns true
if there are no components registered with this instance. Otherwise, this returns false
.
sourcepub fn get_info(&self, id: ComponentId) -> Option<&ComponentInfo>
pub fn get_info(&self, id: ComponentId) -> Option<&ComponentInfo>
Gets the metadata associated with the given component.
This will return an incorrect result if id
did not come from the same world as self
. It may return None
or a garbage value.
sourcepub fn get_name(&self, id: ComponentId) -> Option<&str>
pub fn get_name(&self, id: ComponentId) -> Option<&str>
Returns the name associated with the given component.
This will return an incorrect result if id
did not come from the same world as self
. It may return None
or a garbage value.
sourcepub unsafe fn get_info_unchecked(&self, id: ComponentId) -> &ComponentInfo
pub unsafe fn get_info_unchecked(&self, id: ComponentId) -> &ComponentInfo
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())
§See also
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())
§See also
sourcepub fn init_resource<T: Resource>(&mut self) -> ComponentId
pub fn init_resource<T: Resource>(&mut self) -> ComponentId
sourcepub fn init_non_send<T: Any>(&mut self) -> ComponentId
pub fn init_non_send<T: Any>(&mut self) -> ComponentId
Initializes a non-send resource of type T
with this instance.
If a resource of this type has already been initialized, this will return
the ID of the pre-existing resource.
sourcepub fn iter(&self) -> impl Iterator<Item = &ComponentInfo> + '_
pub fn iter(&self) -> impl Iterator<Item = &ComponentInfo> + '_
Gets an iterator over all components registered with this instance.
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
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
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 Components
Auto Trait Implementations§
impl Freeze for Components
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> 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.source§impl<T> DowncastSync for T
impl<T> DowncastSync for T
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
Self
using data from the given World
.