Struct game_time::clock::GameClockBuilder

pub struct GameClockBuilder { /* fields omitted */ }

A GameClock builder, allowing for customization of the initial time and parameters.

GameClockBuilder offers fine control over the initial state of a GameClock. For most cases, using GameClock::new() is good enough. However, it can be useful to have more control in some situations, especially testing.

Methods

impl GameClockBuilder

pub fn new() -> GameClockBuilder

Construct a new GameClockBuilder with default values.

Calling build on the returned object returns immediately gives the same result as GameClock::new().

pub fn start_game_time(&mut self, time: Duration) -> &mut GameClockBuilder

Set the initial game time when the game is started.

Defaults to zero.

pub fn start_wall_time(     &mut self,     time: DateTime<Local> ) -> &mut GameClockBuilder

Set the initial wall time when the game is started.

Defaults to chrono::Local::now().

pub fn start_frame(&mut self, frame_num: u64) -> &mut GameClockBuilder

Set the initial frame number.

Defaults to 0.

pub fn clock_multiplier(&mut self, multiplier: f64) -> &mut GameClockBuilder

Set the initial clock multiplier.

Defaults to 1.0.

pub fn build(&self) -> GameClock

Construct a GameClock object with the set parameters.

Trait Implementations

impl Default for GameClockBuilder

fn default() -> GameClockBuilder

Returns the "default value" for a type.

impl Clone for GameClockBuilder

fn clone(&self) -> GameClockBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GameClockBuilder

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

Formats the value using the given formatter.