Struct bevy_internal::ecs::prelude::State

pub struct State<T>where
    T: StateData,{ /* private fields */ }

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

impl<T> State<T>where
    T: StateData,

pub fn on_update(pred: T) -> RunCriteriaDescriptor

pub fn on_inactive_update(pred: T) -> RunCriteriaDescriptor

pub fn on_in_stack_update(pred: T) -> RunCriteriaDescriptor

pub fn on_enter(pred: T) -> RunCriteriaDescriptor

pub fn on_exit(pred: T) -> RunCriteriaDescriptor

pub fn on_pause(pred: T) -> RunCriteriaDescriptor

pub fn on_resume(pred: T) -> RunCriteriaDescriptor

pub fn on_update_set(s: T) -> SystemSet

pub fn on_inactive_update_set(s: T) -> SystemSet

pub fn on_enter_set(s: T) -> SystemSet

pub fn on_exit_set(s: T) -> SystemSet

pub fn on_pause_set(s: T) -> SystemSet

pub fn on_resume_set(s: T) -> SystemSet

pub fn get_driver() -> SystemSet

Creates a driver set for the State.

Important note: this set must be inserted before all other state-dependant sets to work properly!

pub fn new(initial: T) -> State<T>

pub fn set(&mut self, state: T) -> Result<(), StateError>

Schedule a state change that replaces the active state with the given state. This will fail if there is a scheduled operation, pending transition, or if the given state matches the current state

pub fn overwrite_set(&mut self, state: T) -> Result<(), StateError>

Same as Self::set, but if there is already a next state, it will be overwritten instead of failing

pub fn replace(&mut self, state: T) -> Result<(), StateError>

Schedule a state change that replaces the full stack with the given state. This will fail if there is a scheduled operation, pending transition, or if the given state matches the current state

pub fn overwrite_replace(&mut self, state: T) -> Result<(), StateError>

Same as Self::replace, but if there is already a next state, it will be overwritten instead of failing

pub fn push(&mut self, state: T) -> Result<(), StateError>

Same as Self::set, but does a push operation instead of a next operation

pub fn overwrite_push(&mut self, state: T) -> Result<(), StateError>

Same as Self::push, but if there is already a next state, it will be overwritten instead of failing

pub fn pop(&mut self) -> Result<(), StateError>

Same as Self::set, but does a pop operation instead of a set operation

pub fn overwrite_pop(&mut self) -> Result<(), StateError>

Same as Self::pop, but if there is already a next state, it will be overwritten instead of failing

pub fn restart(&mut self) -> Result<(), StateError>

Schedule a state change that restarts the active state. This will fail if there is a scheduled operation or a pending transition

pub fn overwrite_restart(&mut self)

Same as Self::restart, but if there is already a scheduled state operation, it will be overwritten instead of failing

pub fn current(&self) -> &T

pub fn inactives(&self) -> &[T]

pub fn clear_schedule(&mut self)

Clears the scheduled state operation.

Trait Implementations

impl<T> Debug for State<T>where
    T: Debug + StateData,

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

Formats the value using the given formatter.

impl<T> Resource for State<T>where
    T: StateData,
    State<T>: 'static + Send + Sync,