[][src]Enum amethyst::StateEvent

pub enum StateEvent<T = String> where
    T: Clone + Send + Sync + 'static, 
{ 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: EmptyState> State<(), StateEvent<String>> for T[src]

fn on_start(&mut self, data: StateData<()>)[src]

Executed when the game state begins.

fn on_stop(&mut self, data: StateData<()>)[src]

Executed when the game state exits.

fn on_pause(&mut self, data: StateData<()>)[src]

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

fn on_resume(&mut self, data: StateData<()>)[src]

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

fn handle_event(&mut self, data: StateData<()>, event: StateEvent) -> EmptyTrans[src]

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

fn fixed_update(&mut self, data: StateData<()>) -> EmptyTrans[src]

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

fn update(&mut self, data: StateData<()>) -> EmptyTrans[src]

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<()>)[src]

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<()>)[src]

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<String>> for T[src]

fn on_start(&mut self, data: StateData<GameData>)[src]

Executed when the game state begins.

fn on_stop(&mut self, data: StateData<GameData>)[src]

Executed when the game state exits.

fn on_pause(&mut self, data: StateData<GameData>)[src]

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

fn on_resume(&mut self, data: StateData<GameData>)[src]

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

fn handle_event(
    &mut self,
    data: StateData<GameData>,
    event: StateEvent
) -> SimpleTrans
[src]

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

fn fixed_update(&mut self, data: StateData<GameData>) -> SimpleTrans[src]

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

fn update(&mut self, data: StateData<GameData>) -> SimpleTrans[src]

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>)[src]

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>)[src]

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: Clone> Clone for StateEvent<T> where
    T: Clone + Send + Sync + 'static, 
[src]

fn clone_from(&mut self, source: &Self)
1.0.0
[src]

Performs copy-assignment from source. Read more

Auto Trait Implementations

impl<T> Send for StateEvent<T>

impl<T> Sync for StateEvent<T>

Blanket Implementations

impl<T> From for T[src]

impl<T, U> Into for T where
    U: From<T>, 
[src]

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

impl<T, U> TryFrom for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T> Borrow for T where
    T: ?Sized
[src]

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> BorrowMut for T where
    T: ?Sized
[src]

impl<T, U> TryInto for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

impl<T> Same for T

type Output = T

Should always be Self

impl<SS, SP> SupersetOf for SP where
    SS: SubsetOf<SP>, 

impl<T> Resource for T where
    T: Any + Send + Sync

impl<T> Any for T where
    T: Any

impl<T> Event for T where
    T: Send + Sync + 'static, 

impl<T> Erased for T

impl<T> Erased for T

impl<T> SetParameter for T

fn set<T>(&mut self, value: T) -> <T as Parameter<Self>>::Result where
    T: Parameter<Self>, 

Sets value as a parameter of self.