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

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, this is automatically done in bevy_app::App::update. For the main world, World::clear_trackers is run after the main schedule is run and after SubApp’s have run.

Examples

Basic usage:

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

Implementations§

source§

impl<'w, 's, T> RemovedComponents<'w, 's, T>
where T: Component,

source

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

Fetch underlying ManualEventReader.

source

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

Fetch underlying ManualEventReader mutably.

source

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

Fetch underlying Events.

source

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.

source

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.

source

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.

source

pub fn len(&self) -> usize

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

source

pub fn is_empty(&self) -> bool

Returns true if there are no events available to read.

source

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§

source§

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. Read more
source§

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.
source§

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).
source§

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.
source§

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. Read more
source§

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

Auto Trait Implementations§

§

impl<'w, 's, T> RefUnwindSafe for RemovedComponents<'w, 's, T>
where T: RefUnwindSafe,

§

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

§

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

§

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

§

impl<'w, 's, T> !UnwindSafe for RemovedComponents<'w, 's, T>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T, U> AsBindGroupShaderType<U> for T
where U: ShaderType, &'a T: for<'a> Into<U>,

source§

fn as_bind_group_shader_type(&self, _images: &RenderAssets<Image>) -> U

Return the T ShaderType for self. When used in AsBindGroup derives, it is safe to assume that all images in self exist.
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> Downcast<T> for T

source§

fn downcast(&self) -> &T

source§

impl<T> Downcast for T
where T: Any,

source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<S> FromSample<S> for S

source§

fn from_sample_(s: S) -> S

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> ToSample<U> for T
where U: FromSample<T>,

source§

fn to_sample_(self) -> U

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> Upcast<T> for T

source§

fn upcast(&self) -> Option<&T>

source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

impl<S, T> Duplex<S> for T
where T: FromSample<S> + ToSample<S>,

source§

impl<T> Settings for T
where T: 'static + Send + Sync,

source§

impl<T> WasmNotSend for T
where T: Send,

source§

impl<T> WasmNotSendSync for T

source§

impl<T> WasmNotSync for T
where T: Sync,