Struct ticktime::TickTime

pub struct TickTime { /* fields omitted */ }

A TickTime helps to keep track of the current tick in the game. Following a TickTimeType, it will translate the current tick to a list of computed values, representing year, season, month…

Implementations

impl TickTime

pub fn init(
    current_tick: usize,
    options: TickTimeOptions
) -> Result<Self, &'static str>

Initialise a TickTime with a given tick (usefull to reload the state of a save) and a TickTimeType.

pub fn tick(&mut self) -> Option<TickTimeEvent>

Add a tick to the current_tick. Will also compute values

pub fn values(&self) -> (usize, usize, usize, usize, usize, usize, usize, usize)

Return a tuple of computed usizes for (year, season, month, day, hour, minute, second)

pub fn current_tick(&self) -> usize

Total tick count

pub fn year(&self) -> usize

Return the read only computed year

pub fn month(&self) -> usize

Return the read only computed month

pub fn season(&self) -> usize

Return the read only computed season

pub fn week(&self) -> usize

Return the read only computed week

pub fn day(&self) -> usize

Return the read only computed day

pub fn hour(&self) -> usize

Return the read only computed hour

pub fn minute(&self) -> usize

Return the read only computed minute

pub fn second(&self) -> usize

Return the read only computed second

Trait Implementations

impl Clone for TickTime

fn clone(&self) -> TickTime

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TickTime

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

Formats the value using the given formatter.

impl Display for TickTime

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

Formats the value using the given formatter.