Struct GameDateTime

pub struct GameDateTime(pub NaiveDateTime);

NewType wrapper for NaiveDateTime, representing in-game date and time.

Example

use commonlibsse_ng::re::Calendar::{GameDateTime, Year, MonthIndex, GameDay, Hour};

let year = Year::new(2025.0);
let month = MonthIndex::new(2.0);   // March (0-based)
let day = GameDay::new(28.0);
let hour = Hour::new(15.5);         // 15:30

let date_time = GameDateTime::new(year, month, day, hour).unwrap();
assert_eq!(date_time.to_string(), "2025-03-28 15:30:00");

Tuple Fields

0: NaiveDateTime

Implementations

impl GameDateTime

pub const DEFAULT: Self

The default in-game date: 77-01-01 00:00:00.

Example

use commonlibsse_ng::re::Calendar::GameDateTime;
assert_eq!(GameDateTime::default().to_string(), "0077-01-01 00:00:00");

pub fn new( year: Year, month: MonthIndex, day: GameDay, hour: Hour, ) -> Option<Self>

Creates a new GameDateTime from year, month, day, and hour components.

• The month uses 0-based indexing internally (0 = January, 11 = December).
• The day and hour values are clamped to their valid ranges.

Returns None if the date or time is invalid.

Example

use commonlibsse_ng::re::Calendar::{GameDateTime, Year, MonthIndex, GameDay, Hour};

let year = Year::new(2025.0);
let month = MonthIndex::new(2.0);   // March
let day = GameDay::new(15.0);
let hour = Hour::new(9.75);         // 9:45

let date_time = GameDateTime::new(year, month, day, hour).unwrap();
assert_eq!(date_time.to_string(), "2025-03-15 09:45:00");

// Invalid date returns `None`
let invalid = GameDateTime::new(year, MonthIndex::new(12.0), day, hour);
assert!(invalid.is_none());

pub const fn from_ymd(year: i32, month: u32, day: u32) -> Self

Creates a NaiveDateTime from year, month, and day components.

This is a helper function to avoid using deprecated from_ymd directly.

Panics

• Panics if the provided date or time is invalid or out of range.

Example

use commonlibsse_ng::re::Calendar::GameDateTime;

let date = GameDateTime::from_ymd(2025, 3, 27);

// Panics: invalid date
// let invalid = from_ymd(2025, 13, 32);

Trait Implementations

impl Clone for GameDateTime

fn clone(&self) -> GameDateTime

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GameDateTime

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

Formats the value using the given formatter.

impl Default for GameDateTime

fn default() -> Self

Returns the “default value” for a type.

impl Display for GameDateTime

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

Formats the value using the given formatter.

impl Hash for GameDateTime

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for GameDateTime

fn cmp(&self, other: &GameDateTime) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for GameDateTime

fn eq(&self, other: &GameDateTime) -> 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 PartialOrd for GameDateTime

fn partial_cmp(&self, other: &GameDateTime) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for GameDateTime

impl Eq for GameDateTime

impl StructuralPartialEq for GameDateTime