Struct RequiredComponents

pub struct RequiredComponents(/* private fields */);

The collection of metadata for components that are required for a given component.

For more information, see the “Required Components” section of Component.

Implementations

impl RequiredComponents

pub unsafe fn register_dynamic( &mut self, component_id: ComponentId, constructor: RequiredComponentConstructor, inheritance_depth: u16, )

Registers a required component.

If the component is already registered, it will be overwritten if the given inheritance depth is smaller than the depth of the existing registration. Otherwise, the new registration will be ignored.

Safety

component_id must match the type initialized by constructor. constructor must initialize a component for component_id in such a way that matches the storage type of the component. It must only use the given table_row or Entity to initialize the storage for component_id corresponding to the given entity.

pub fn register<C: Component>( &mut self, components: &mut Components, storages: &mut Storages, constructor: fn() -> C, inheritance_depth: u16, )

Registers a required component.

If the component is already registered, it will be overwritten if the given inheritance depth is smaller than the depth of the existing registration. Otherwise, the new registration will be ignored.

pub fn register_by_id<C: Component>( &mut self, component_id: ComponentId, constructor: fn() -> C, inheritance_depth: u16, )

Registers the Component with the given ID as required if it exists.

If the component is already registered, it will be overwritten if the given inheritance depth is smaller than the depth of the existing registration. Otherwise, the new registration will be ignored.

pub fn iter_ids(&self) -> impl Iterator<Item = ComponentId> + '_

Iterates the ids of all required components. This includes recursive required components.

Trait Implementations

impl Clone for RequiredComponents

fn clone(&self) -> RequiredComponents

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RequiredComponents

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

Formats the value using the given formatter.

impl Default for RequiredComponents

fn default() -> RequiredComponents

Returns the “default value” for a type.