Struct bevy_ecs::schedule::State [−][src]
pub struct State<T: StateData> { /* fields omitted */ }
Expand description
Stack based state machine
This state machine has four operations: Push, Pop, Set and Replace.
- Push pushes a new state to the state stack, pausing the previous state
- Pop removes the current state, and unpauses the last paused state
- Set replaces the active state with a new one
- Replace unwinds the state stack, and replaces the entire stack with a single new state
Implementations
Creates a driver set for the State.
Important note: this set must be inserted before all other state-dependant sets to work properly!
Schedule a state change that replaces the active state with the given state.
This will fail if there is a scheduled operation, or if the given state
matches the
current state
Same as Self::set
, but if there is already a next state, it will be overwritten
instead of failing
Schedule a state change that replaces the full stack with the given state.
This will fail if there is a scheduled operation, or if the given state
matches the
current state
Same as Self::replace
, but if there is already a next state, it will be overwritten
instead of failing
Same as Self::set
, but does a push operation instead of a next operation
Same as Self::push
, but if there is already a next state, it will be overwritten
instead of failing
Same as Self::set
, but does a pop operation instead of a set operation
Same as Self::pop
, but if there is already a next state, it will be overwritten
instead of failing
Trait Implementations
Auto Trait Implementations
impl<T> RefUnwindSafe for State<T> where
T: RefUnwindSafe,
impl<T> UnwindSafe for State<T> where
T: UnwindSafe,
Blanket Implementations
Mutably borrows from an owned value. Read more
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
. Read more
Convert Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
. Read more
Convert &Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s. Read more
Convert &mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s. Read more
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more