Enum Remove

pub enum Remove<C>
where
    C: ?Sized,
{
    // some variants omitted
}

A TargetedEvent which removes component C from an entity when sent. The component is dropped and cannot be recovered.

Any handler which listens for Remove<C> will run before the component is removed. Remove<C> has no effect if the target entity does not exist or the event is consumed before it finishes broadcasting.

This type behaves like a unit struct. Use Remove::<C> to instantiate the type.

Examples

world.send_to(target, Remove::<C>);

Trait Implementations

impl<C> Clone for Remove<C>

where C: ?Sized,

fn clone(&self) -> Remove<C>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<C> Debug for Remove<C>

where C: ?Sized,

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

Formats the value using the given formatter.

impl<C> Default for Remove<C>

where C: ?Sized,

fn default() -> Remove<C>

Returns the “default value” for a type.

impl<C> Event for Remove<C>

where C: Component,

type This<'a> = Remove<C>

The type of Self, but with lifetimes modified to outlive 'a.

type EventIdx = TargetedEventIdx

Either GlobalEventIdx or TargetedEventIdx. This indicates if the event is global or targeted.

type Mutability = Mutable

Indicates if this event is Mutable or Immutable.

fn init(world: &mut World) -> EventKind

Gets the EventKind of this event and performs any necessary initialization work.

impl<C> Copy for Remove<C>

where C: ?Sized,