Struct GameState 

pub struct GameState {
    pub playing: bool,
    pub transitional: bool,
    pub modal: bool,
    pub muted: bool,
}

What only the game knows, settled per frame.

Fields

playing: bool

The run is playing: not on a menu, not in a break, not paused. The host is told gameplay is running while this holds and nothing else does: see Suspend::host_gameplay.

transitional: bool

A transition is in flight: a run transition, or the game’s own break screen while it waits for an ad.

The clock runs on through it whichever way the rest of the gate falls, because a transition that cannot tick can never unblock itself; the transition is what ends it. Gameplay systems stay off.

modal: bool

A game-side modal owns the screen and nothing animates under it (a pause menu, a settings panel). A modal that animates is a transition instead.

muted: bool

The player muted the game in its own settings. Audio only: a mute is not a reason to stop the world.

Trait Implementations

impl Clone for GameState

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for GameState

impl Debug for GameState

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

Formats the value using the given formatter.

impl Default for GameState

fn default() -> Self

Returns the “default value” for a type.

impl Eq for GameState

impl PartialEq for GameState

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for GameState