Class: MockCTime

Mock of the X-Ray engine CTime object for jest/node.

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;

Replace time of day.

Parameters

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

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;

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.

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

---

toString()

toString(): string;

Returns a string representation of an object.

Returns

string

---

toTimestamp()

toTimestamp(): number;

Returns

number

---

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

Properties

__name

__name: string = "CTime";

LuaBind instance constructor name.

Implementation of

CTime.__name

---

d

d: number = 12;

---

diffSec

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

Get difference from another game time in seconds.

Param

time

Time to compare with.

Returns

Difference in seconds.

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;