Class: MockCTime

Mock of the X-Ray engine CTime object for jest/node. Keeps time as the engine xrTime does, milliseconds since the start of year 1, and splits it into date fields.

Implements

• CTime

Constructors

Constructor

new MockCTime(): MockCTime;

Returns

MockCTime

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

Implementation of

CTime.add

---

copy()

copy(): MockCTime;

Returns

MockCTime

---

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.

Implementation of

CTime.dateToString

---

isEqual()

isEqual(time: CTime | MockCTime): boolean;

Parameters

Parameter	Type
time	CTime | MockCTime

Returns

boolean

---

setHMS()

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

As the engine: time of day from the start of year 1, as used for durations to add or sub.

Parameters

Parameter	Type
h	number
m	number
s	number

Returns

void

Implementation of

CTime.setHMS

---

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

Implementation of

CTime.setHMSms

---

sub()

sub(time: CTime): void;

As the engine: subtracting a later time leaves the start of year 1.

Parameters

Parameter	Type
time	CTime

Returns

void

Implementation of

CTime.sub

---

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.

Implementation of

CTime.timeToString

---

toAbsolute()

toAbsolute(): number;

Returns

number

Milliseconds since the start of year 1, as the engine xrTime stores time.

---

toString()

toString(): string;

Returns a string representation of an object.

Returns

string

---

toTimestamp()

toTimestamp(): number;

Returns

number

Milliseconds since the start of 1970.

---

areEqual()

static areEqual(first: CTime | MockCTime, second: CTime | MockCTime): boolean;

Parameters

Parameter	Type
first	CTime | MockCTime
second	CTime | MockCTime

Returns

boolean

---

create()

static create(
   y: number, 
   m: number, 
   d: number, 
   h: number, 
   min: number, 
   sec: number, 
   ms: number): MockCTime;

Parameters

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

Returns

MockCTime

---

mock()

static mock(
   y: number, 
   m: number, 
   d: number, 
   h: number, 
   min: number, 
   sec: number, 
   ms: number): CTime;

Create a mock typed as the engine CTime, for use where a real CTime is expected.

Parameters

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

Returns

CTime

---

now()

static now(): MockCTime;

Returns

MockCTime

---

toMilliseconds()

static toMilliseconds(
   y: number, 
   m: number, 
   d: number, 
   h: number, 
   min: number, 
   sec: number, 
   ms: number): number;

Port of the engine generate_time: fields past their range carry over, as set(y, m, d, h, min, sec + 90, ms).

Parameters

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

Returns

number

Milliseconds since the start of year 1.

Properties

__name

__name: string = "CTime";

LuaBind instance constructor name.

Implementation of

CTime.__name

---

d

d: number = 12;

---

diffSec

diffSec: Mock<(target: CTime) => number>;

As the engine: seconds from target to this time, negative when this time is earlier.

Implementation of

CTime.diffSec

---

get

get: Mock<(_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.

Returns

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

Implementation of

CTime.get

---

h

h: number = 9;

---

m

m: number = 6;

---

min

min: number = 30;

---

ms

ms: number = 0;

---

sec

sec: number = 0;

---

set

set: Mock<(y: number, m: number, d: number, h: number, min: number, sec: number, ms: number) => void>;

Replace all date and time components.

Param

y

Year.

Param

m

Month.

Param

d

Day.

Param

h

Hour.

Param

min

Minute.

Param

sec

Second.

Param

ms

Millisecond.

Implementation of

CTime.set

---

y

y: number = 2012;

---

nowTime

static nowTime: MockCTime;