Struct valence::ecs::removal_detection::RemovedComponents

pub struct RemovedComponents<'w, 's, T>
where
    T: Component,
{ /* private fields */ }

A SystemParam that yields entities that had their T Component removed or have been despawned with it.

This acts effectively the same as an EventReader.

Note that this does not allow you to see which data existed before removal. If you need this, you will need to track the component data value on your own, using a regularly scheduled system that requests Query<(Entity, &T), Changed<T>> and stores the data somewhere safe to later cross-reference.

If you are using bevy_ecs as a standalone crate, note that the RemovedComponents list will not be automatically cleared for you, and will need to be manually flushed using World::clear_trackers.

For users of bevy and bevy_app, World::clear_trackers is automatically called by bevy_app::App::update and bevy_app::SubApp::update. For the main world, this is delayed until after all SubApps have run.

Examples

Basic usage:

fn react_on_removal(mut removed: RemovedComponents<MyComponent>) {
    removed.read().for_each(|removed_entity| println!("{:?}", removed_entity));
}

Implementations

impl<'w, 's, T> RemovedComponents<'w, 's, T>

where T: Component,

pub fn reader(&self) -> &ManualEventReader<RemovedComponentEntity>

Fetch underlying ManualEventReader.

pub fn reader_mut(&mut self) -> &mut ManualEventReader<RemovedComponentEntity>

Fetch underlying ManualEventReader mutably.

pub fn events(&self) -> Option<&Events<RemovedComponentEntity>>

Fetch underlying Events.

pub fn reader_mut_with_events( &mut self, ) -> Option<(&mut RemovedComponentReader<T>, &Events<RemovedComponentEntity>)>

Destructures to get a mutable reference to the ManualEventReader and a reference to Events.

This is necessary since Rust can’t detect destructuring through methods and most usecases of the reader uses the Events as well.

pub fn read( &mut self, ) -> Map<Flatten<IntoIter<Cloned<EventIterator<'_, RemovedComponentEntity>>>>, fn(_: RemovedComponentEntity) -> Entity>

Iterates over the events this RemovedComponents has not seen yet. This updates the RemovedComponents’s event counter, which means subsequent event reads will not include events that happened before now.

pub fn read_with_id( &mut self, ) -> Map<Flatten<IntoIter<EventIteratorWithId<'_, RemovedComponentEntity>>>, fn(_: (&RemovedComponentEntity, EventId<RemovedComponentEntity>)) -> (Entity, EventId<RemovedComponentEntity>)>

Like read, except also returning the EventId of the events.

pub fn len(&self) -> usize

Determines the number of removal events available to be read from this RemovedComponents without consuming any.

pub fn is_empty(&self) -> bool

Returns true if there are no events available to read.

pub fn clear(&mut self)

Consumes all available events.

This means these events will not appear in calls to RemovedComponents::read() or RemovedComponents::read_with_id() and RemovedComponents::is_empty() will return true.

Trait Implementations

impl<T> SystemParam for RemovedComponents<'_, '_, T>

where T: Component,

type State = FetchState<T>

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

type Item<'w, 's> = RemovedComponents<'w, 's, T>

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, ) -> <RemovedComponents<'_, '_, T> as SystemParam>::State

Registers any World access used by this SystemParam and creates a new instance of this param’s State.

unsafe fn new_archetype( state: &mut <RemovedComponents<'_, '_, T> as SystemParam>::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 <RemovedComponents<'_, '_, T> as SystemParam>::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 <RemovedComponents<'_, '_, T> as SystemParam>::State, system_meta: &SystemMeta, world: DeferredWorld<'_>, )

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

unsafe fn get_param<'w, 's>( state: &'s mut <RemovedComponents<'_, '_, T> as SystemParam>::State, system_meta: &SystemMeta, world: UnsafeWorldCell<'w>, change_tick: Tick, ) -> <RemovedComponents<'_, '_, T> as SystemParam>::Item<'w, 's>

Creates a parameter to be passed into a SystemParamFunction.

impl<'w, 's, T> ReadOnlySystemParam for RemovedComponents<'w, 's, T>

where T: Component, ComponentIdFor<'s, T>: ReadOnlySystemParam, Local<'s, RemovedComponentReader<T>>: ReadOnlySystemParam, &'w RemovedComponentEvents: ReadOnlySystemParam,