Struct amethyst::prelude::GameData

pub struct GameData<'a, 'b> { /* fields omitted */ }

Default game data.

The lifetimes are for the systems inside and can be 'static unless a system has a borrowed field.

Implementations

impl<'a, 'b> GameData<'a, 'b>

pub fn new(dispatcher: Dispatcher<'a, 'b>) -> Self

Create new game data

pub fn update(&mut self, world: &World)

Update game data

pub fn dispose(&mut self, world: &mut World)

Dispose game data, dropping the dispatcher

Trait Implementations

impl DataDispose for GameData<'_, '_>

fn dispose(&mut self, world: &mut World)

Perform disposal

impl<'a, 'b> DataInit<GameData<'a, 'b>> for GameDataBuilder<'a, 'b>

fn build(self, world: &mut World) -> GameData<'a, 'b>

Build game data

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.