Class: CTime

Mutable game calendar/time value.

Use game.get_game_time() for the current in-game time and time_global() for real elapsed milliseconds.

Source

C++ class CTime

Custom Constructor

game.CTime

Remarks

Methods such as add, sub, set, and setHMS mutate the current instance. The engine registers the class only in the game module, so new CTime() compiles to game.CTime().

Extends

• EngineBinding

Constructors

Constructor

new CTime(): CTime;

Create an empty time value.

Returns

CTime

Overrides

EngineBinding.constructor

Constructor

new CTime(time: CTime): CTime;

Copy another time value.

Parameters

Parameter	Type	Description
time	CTime	Time value to copy.

Returns

CTime

Overrides

EngineBinding.constructor

Methods

add()

add(time: CTime): void;

Add another time value to this one.

Parameters

Parameter	Type	Description
time	CTime	Time span to add.

Returns

void

---

dateToString()

dateToString(mode: number): string;

Format one date component as text.

Parameters

Parameter	Type	Description
mode	number	One of CTime.DateTo* formatting constants.

Returns

string

Requested date component.

---

diffSec()

diffSec(time: CTime): number;

Get difference from another game time in seconds.

Parameters

Parameter	Type	Description
time	CTime	Time to compare with.

Returns

number

Difference in seconds.

---

get()

get(
   y: number, 
   m: number, 
   d: number, 
   h: number, 
   min: number, 
   sec: number, 
ms: number): LuaMultiReturn<[number, number, number, number, number, number, number]>;

Read all date and time components.

The input values are placeholders for Lua out parameters.

Parameters

Parameter	Type
y	number
m	number
d	number
h	number
min	number
sec	number
ms	number

Returns

LuaMultiReturn<[number, number, number, number, number, number, number]>

Year, month, day, hour, minute, second, and millisecond.

---

set()

set(
   y: number, 
   m: number, 
   d: number, 
   h: number, 
   min: number, 
   sec: number, 
   ms: number): void;

Replace all date and time components.

Parameters

Parameter	Type	Description
y	number	Year.
m	number	Month.
d	number	Day.
h	number	Hour.
min	number	Minute.
sec	number	Second.
ms	number	Millisecond.

Returns

void

---

setHMS()

setHMS(
   h: number, 
   m: number, 
   s: number): void;

Replace time of day.

Parameters

Parameter	Type	Description
h	number	Hour.
m	number	Minute.
s	number	Second.

Returns

void

---

setHMSms()

setHMSms(
   h: number, 
   m: number, 
   s: number, 
   ms: number): void;

Replace time of day including milliseconds.

Parameters

Parameter	Type	Description
h	number	Hour.
m	number	Minute.
s	number	Second.
ms	number	Millisecond.

Returns

void

---

sub()

sub(time: CTime): void;

Subtract another time value from this one.

Parameters

Parameter	Type	Description
time	CTime	Time span to subtract.

Returns

void

Remarks

The result is clamped at zero when time is greater than the current value.

---

timeToString()

timeToString(mode: number): string;

Format one time component as text.

Parameters

Parameter	Type	Description
mode	number	One of CTime.TimeTo* formatting constants.

Returns

string

Requested time component.

Properties

__name

readonly __name: string;

LuaBind instance constructor name.

Inherited from

EngineBinding.__name

---

__name

readonly static __name: string;

LuaBind class constructor name.

Inherited from

EngineBinding.__name

---

DateToDay

readonly static DateToDay: 0;

Date formatting mode: day.

---

DateToMonth

readonly static DateToMonth: 1;

Date formatting mode: month.

---

DateToYear

readonly static DateToYear: 2;

Date formatting mode: year.

---

TimeToHours

readonly static TimeToHours: 0;

Time formatting mode: hours.

---

TimeToMilisecs

readonly static TimeToMilisecs: 3;

Time formatting mode: milliseconds.

---

TimeToMinutes

readonly static TimeToMinutes: 1;

Time formatting mode: minutes.

---

TimeToSeconds

readonly static TimeToSeconds: 2;

Time formatting mode: seconds.