Struct Suspend 

pub struct Suspend { /* private fields */ }

One frame’s answer to “does gameplay run, does the world tick, does sound play”.

Implementations

impl Suspend

pub fn resolve(game: GameState, portal: PortalView) -> Self

Settle one frame from both halves of the gate.

pub fn suspended(&self) -> bool

The clock is stopped this frame, so the sim must not tick. This is the blocked argument of repame-fx’s SimDriver::frame.

pub fn live(&self) -> bool

Gameplay systems run this frame (the games’ live flag). The world may still tick under a modal or a transition, so this is not the negation of Suspend::suspended.

pub fn silenced(&self) -> bool

Audio must be silent this frame.

pub fn host_gameplay(&self) -> bool

Whether the host should count gameplay as running this frame.

pub fn cause(&self) -> Option<Cause>

The outermost reason the clock is stopped, None when it runs.

pub fn time_scale(&self) -> f32

The clock this decision means: 0.0 while suspended, 1.0 otherwise.

A stopped clock is not a banked one: Sim::step drops the wall time it would have accumulated, so resuming after a long ad does not run a burst of catch-up ticks.

pub fn apply(&self, sim: &mut Sim)

Write the decision to the sim clock.

Trait Implementations

impl Clone for Suspend

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 Suspend

impl Debug for Suspend

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

Formats the value using the given formatter.

impl Eq for Suspend

impl PartialEq for Suspend

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Suspend