Struct amethyst_test::FunctionState

pub struct FunctionState<F> where
    F: FnOnce(&mut World),  { /* fields omitted */ }

Runs a function in .update() then Pops itself.

The function is run before GameUpdate#update(world) is called.

Implementations

impl<F> FunctionState<F> where
    F: FnOnce(&mut World), 

pub fn new(function: F) -> Self

Returns a new FunctionState

Trait Implementations

impl<F: Debug> Debug for FunctionState<F> where
    F: FnOnce(&mut World), 

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

Formats the value using the given formatter.

impl<F, T, E> State<T, E> for FunctionState<F> where
    F: FnOnce(&mut World),
    T: GameUpdate,
    E: Send + Sync + 'static, 

fn update(&mut self, data: StateData<T>) -> Trans<T, E>

Executed on every frame immediately, as fast as the engine will allow (taking into account the frame rate limit), if this is the active state.

fn on_start(&mut self, _data: StateData<T>)

Executed when the game state begins.

fn on_stop(&mut self, _data: StateData<T>)

Executed when the game state exits.

fn on_pause(&mut self, _data: StateData<T>)

Executed when a different game state is pushed onto the stack.

fn on_resume(&mut self, _data: StateData<T>)

Executed when the application returns to this game state once again.

fn handle_event(&mut self, _data: StateData<T>, _event: E) -> Trans<T, E>

Executed on every frame before updating, for use in reacting to events.

fn fixed_update(&mut self, _data: StateData<T>) -> Trans<T, E>

Executed repeatedly at stable, predictable intervals (1/60th of a second by default), if this is the active state.

fn shadow_fixed_update(&mut self, _data: StateData<T>)

Executed repeatedly at stable, predictable intervals (1/60th of a second by default), even when this is not the active state, as long as this state is on the StateMachine's state-stack.

fn shadow_update(&mut self, _data: StateData<T>)

Executed on every frame immediately, as fast as the engine will allow (taking into account the frame rate limit), even when this is not the active state, as long as this state is on the StateMachine's state-stack.