Enum amethyst::StateEvent

pub enum StateEvent<T = StringBindings> where
    T: BindingTypes,  {
    Window(Event),
    Ui(UiEvent),
    Input(InputEvent<T>),
}

The enum holding the different types of event that can be received in a State in the handle_event method.

Variants

Window(Event)

Events sent by the winit window.

Ui(UiEvent)

Events sent by the ui system.

Input(InputEvent<T>)

Events sent by the input system.

Trait Implementations

impl<T> Clone for StateEvent<T> where
    T: BindingTypes, 

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for StateEvent<T> where
    T: BindingTypes, 

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

Formats the value using the given formatter.

impl<T: EmptyState> State<(), StateEvent<StringBindings>> for T

fn on_start(&mut self, data: StateData<'_, ()>)

Executed when the game state begins.

fn on_stop(&mut self, data: StateData<'_, ()>)

Executed when the game state exits.

fn on_pause(&mut self, data: StateData<'_, ()>)

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

fn on_resume(&mut self, data: StateData<'_, ()>)

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

fn handle_event(
    &mut self,
    data: StateData<'_, ()>,
    event: StateEvent
) -> EmptyTrans

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

fn fixed_update(&mut self, data: StateData<'_, ()>) -> EmptyTrans

Executed repeatedly at stable, predictable intervals (1/60th of a second by default).

fn update(&mut self, data: StateData<'_, ()>) -> EmptyTrans

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

fn shadow_fixed_update(&mut self, data: StateData<'_, ()>)

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<'_, ()>)

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.

impl<T: SimpleState> State<GameData<'static, 'static>, StateEvent<StringBindings>> for T

fn on_start(&mut self, data: StateData<'_, GameData<'_, '_>>)

Executed when the game state begins.

fn on_stop(&mut self, data: StateData<'_, GameData<'_, '_>>)

Executed when the game state exits.

fn on_pause(&mut self, data: StateData<'_, GameData<'_, '_>>)

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

fn on_resume(&mut self, data: StateData<'_, GameData<'_, '_>>)

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

fn handle_event(
    &mut self,
    data: StateData<'_, GameData<'_, '_>>,
    event: StateEvent
) -> SimpleTrans

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

fn fixed_update(&mut self, data: StateData<'_, GameData<'_, '_>>) -> SimpleTrans

Executed repeatedly at stable, predictable intervals (1/60th of a second by default).

fn update(&mut self, data: StateData<'_, GameData<'_, '_>>) -> SimpleTrans

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

fn shadow_fixed_update(&mut self, data: StateData<'_, GameData<'_, '_>>)

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<'_, GameData<'_, '_>>)

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.