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

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 Fetch = ComponentsState