Struct bevy_ecs::component::Components

pub struct Components { /* private fields */ }

Implementations

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>

pub unsafe fn get_info_unchecked(&self, id: ComponentId) -> &ComponentInfo

Safety

id must be a valid ComponentId

pub fn get_id(&self, type_id: TypeId) -> Option<ComponentId>

Type-erased equivalent of Components::component_id.

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())

pub fn get_resource_id(&self, type_id: TypeId) -> Option<ComponentId>

Type-erased equivalent of Components::resource_id.

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

impl Debug for Components

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Components

fn default() -> Components

Returns the “default value” for a type.

impl<'a> SystemParam for &'a Components

type State = ()

Used to store data which persists across invocations of a system.

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.

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.

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

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)

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