Struct StateTransitionEvent

pub struct StateTransitionEvent<S: States> {
    pub exited: Option<S>,
    pub entered: Option<S>,
}

Event sent when any state transition of S happens. This includes identity transitions, where exited and entered have the same value.

If you know exactly what state you want to respond to ahead of time, consider OnEnter, OnTransition, or OnExit

Fields

exited: Option<S>

The state being exited.

entered: Option<S>

The state being entered.

Trait Implementations

impl<S: Clone + States> Clone for StateTransitionEvent<S>

fn clone(&self) -> StateTransitionEvent<S>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S: Debug + States> Debug for StateTransitionEvent<S>

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

Formats the value using the given formatter.

impl<S: States> Event for StateTransitionEvent<S>

where Self: Send + Sync + 'static,

const AUTO_PROPAGATE: bool = false

When true, this event will always attempt to propagate when triggered, without requiring a call to Trigger::propagate.

type Traversal = ()

The component that describes which Entity to propagate this event to next, when propagation is enabled.

fn register_component_id(world: &mut World) -> ComponentId

Generates the ComponentId for this event type.

fn component_id(world: &World) -> Option<ComponentId>

Fetches the ComponentId for this event type, if it has already been generated.

impl<S: PartialEq + States> PartialEq for StateTransitionEvent<S>

fn eq(&self, other: &StateTransitionEvent<S>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<S: Copy + States> Copy for StateTransitionEvent<S>

impl<S: Eq + States> Eq for StateTransitionEvent<S>

impl<S: States> StructuralPartialEq for StateTransitionEvent<S>