Struct RemovedComponentEvents

pub struct RemovedComponentEvents { /* private fields */ }

Stores the RemovedComponents event buffers for all types of component in a given World.

Implementations

impl RemovedComponentEvents

pub fn new() -> Self

Creates an empty storage buffer for component removal events.

pub fn update(&mut self)

For each type of component, swaps the event buffers and clears the oldest event buffer. In general, this should be called once per frame/update.

pub fn iter( &self, ) -> impl Iterator<Item = (&ComponentId, &Events<RemovedComponentEntity>)>

Returns an iterator over components and their entity events.

pub fn get( &self, component_id: impl Into<ComponentId>, ) -> Option<&Events<RemovedComponentEntity>>

Gets the event storage for a given component.

pub fn send(&mut self, component_id: impl Into<ComponentId>, entity: Entity)

Sends a removal event for the specified component.

Trait Implementations

impl Debug for RemovedComponentEvents

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

Formats the value using the given formatter.

impl Default for RemovedComponentEvents

fn default() -> RemovedComponentEvents

Returns the “default value” for a type.

impl<'a> SystemParam for &'a RemovedComponentEvents

type State = ()

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

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

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 RemovedComponentEvents