Struct bevy::prelude::StateTransitionEvent

pub struct StateTransitionEvent<S>
where
    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 for StateTransitionEvent<S>

where S: Clone + States,

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S> Component for StateTransitionEvent<S>

where S: States, StateTransitionEvent<S>: Send + Sync + 'static,

const STORAGE_TYPE: StorageType = bevy_ecs::component::StorageType::SparseSet

A constant indicating the storage type used for this component.

fn register_component_hooks(_hooks: &mut ComponentHooks)

Called when registering this component, allowing mutable access to its ComponentHooks.

impl<S> Debug for StateTransitionEvent<S>

where S: Debug + States,

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

Formats the value using the given formatter.

impl<S> PartialEq for StateTransitionEvent<S>

where S: PartialEq + States,

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<S> Copy for StateTransitionEvent<S>

where S: Copy + States,

impl<S> Eq for StateTransitionEvent<S>

where S: Eq + States,

impl<S> Event for StateTransitionEvent<S>

where S: States, StateTransitionEvent<S>: Send + Sync + 'static,

impl<S> StructuralPartialEq for StateTransitionEvent<S>

where S: States,