Struct Bundles

pub struct Bundles { /* private fields */ }

Metadata for bundles. Stores a BundleInfo for each type of Bundle in a given world.

Implementations

impl Bundles

pub fn get(&self, bundle_id: BundleId) -> Option<&BundleInfo>

Gets the metadata associated with a specific type of bundle. Returns None if the bundle is not registered with the world.

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

Gets the value identifying a specific type of bundle. Returns None if the bundle does not exist in the world, or if type_id does not correspond to a type of bundle.

Trait Implementations

impl Default for Bundles

fn default() -> Bundles

Returns the “default value” for a type.

impl<'a> SystemParam for &'a Bundles

type State = ()

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

type Item<'w, 's> = &'w Bundles

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: UnsafeWorldCell<'w>, _change_tick: Tick, ) -> Self::Item<'w, 's>

Creates a parameter to be passed into a SystemParamFunction.

unsafe 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).a

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

fn queue( state: &mut Self::State, system_meta: &SystemMeta, world: DeferredWorld<'_>, )

Queues any deferred mutations to be applied at the next apply_deferred.

unsafe fn validate_param( _state: &Self::State, _system_meta: &SystemMeta, _world: UnsafeWorldCell<'_>, ) -> bool

Validates that the param can be acquired by the get_param. Built-in executors use this to prevent systems with invalid params from running. For nested SystemParams validation will fail if any delegated validation fails.

impl<'a> ReadOnlySystemParam for &'a Bundles