Struct GameDay

#[repr(transparent)]
pub struct GameDay(pub f32);

Represents a day in a 0-based game.

This usually takes the range 0.0..=30.0 range.

Tuple Fields

0: f32

Implementations

impl GameDay

pub const DEFAULT: Self

The default GameDay value (0.0) at compile time.

pub const fn new(value: f32) -> Self

Creates a new GameDay instance with the specified value.

Example

let game_day = GameDay::new(5.0);
assert_eq!(game_day.0, 5.0);

pub const fn day_of_week(&self) -> u32

Returns the day of the week (0-6), 0 based value.

Example

let game_day = GameDay::new(3.0);
assert_eq!(game_day.day_of_week(), 3);

pub const fn to_clamp_day(self, month: u32) -> u32

Clamps the day value based on the month’s maximum days.

When month is in the range of 1 to 12, a valid value is returned.

Example

use commonlibsse_ng::re::Calendar::GameDay;
let game_day = GameDay::new(32.0);
assert_eq!(game_day.to_clamp_day(2), 28); // Sun's Dawn (28 days)

assert_eq!(game_day.to_clamp_day(0), 31); // Underflow (Fallback to 31 days)
assert_eq!(game_day.to_clamp_day(12), 31); // Overflow (Fallback to 31 days)
assert_eq!(game_day.to_clamp_day(300), 31); // Overflow (Fallback to 31 days)

pub const fn ordinal_suffix(&self) -> &'static str

Returns the ordinal suffix for the day (e.g., st, nd, rd, th).

Example

use commonlibsse_ng::re::Calendar::GameDay;
let game_day = GameDay::new(21.0);
assert_eq!(game_day.ordinal_suffix(), "st");

pub const fn to_week(self) -> Option<Week>

Converts GameDay into a Week enum.

Returns None if the GameDay value is out of range (greater than 7.0).

Example

use commonlibsse_ng::re::Calendar::{GameDay, Week};
let game_day = GameDay::new(1.0);
assert_eq!(game_day.to_week(), Some(Week::Morndas));

Trait Implementations

impl Clone for GameDay

fn clone(&self) -> GameDay

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GameDay

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

Formats the value using the given formatter.

impl Default for GameDay

fn default() -> GameDay

Returns the “default value” for a type.

impl PartialEq for GameDay

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for GameDay

impl StructuralPartialEq for GameDay