Struct game_engine_core::StateMachine

pub struct StateMachine<S> { /* fields omitted */ }

A state machine that holds the stack of states and performs transitions between states. It can be created using

StateMachine::<()>::default()

Generics

• S: State data, the data that is sent to states for them to do their operations.

Implementations

impl<S> StateMachine<S>

pub fn is_running(&self) -> bool

Returns if the state machine still has states in its stack.

pub fn update(&mut self, state_data: &mut S)

Updates the state at the top of the stack with the provided data. If the states returns a transition, perform it.

pub fn push(
    &mut self,
    state: Box<dyn State<S> + 'static, Global>,
    state_data: &mut S
)

Push a state on the stack and start it. Pauses any previously active state.

pub fn stop(&mut self, state_data: &mut S)

Removes all currently running states from the stack.

Trait Implementations

impl<S> Default for StateMachine<S>

pub fn default() -> StateMachine<S>

Returns the “default value” for a type.