Class: MockObject

Mock of the X-Ray engine object action/state enumeration.

Implements

• XR_object

Constructors

Constructor

new MockObject(...args: unknown[]): MockObject;

Parameters

Parameter	Type
...args	unknown[]

Returns

MockObject

Methods

action()

action(action: TXR_object_action): void;

Set the object action mode.

Parameters

Parameter	Type	Description
action	TXR_object_action	Object action id.

Returns

void

Implementation of

XR_object.action

---

completed()

completed(): boolean;

Check whether the object action is complete.

Returns

boolean

Whether the action is complete.

Implementation of

XR_object.completed

---

object()

object(object: string | game_object): void;

Set target object by name.

Parameters

Parameter	Type
object	string | game_object

Returns

void

Implementation of

XR_object.object

---

create()

static create(...args: unknown[]): MockObject;

Parameters

Parameter	Type
...args	unknown[]

Returns

MockObject

---

mock()

static mock(...args: unknown[]): XR_object;

Parameters

Parameter	Type
...args	unknown[]

Returns

XR_object

Properties

__name

__name: string = "object";

LuaBind instance constructor name.

Implementation of

XR_object.__name

---

args

args: unknown[];

---

isCompleted

isCompleted: boolean = false;

---

objectAction

objectAction: TXR_object_action | null = null;

---

targetObject

targetObject: string | game_object | null = null;

---

activate

readonly static activate: 16;

Engine enum value for XR_object.activate.

---

aim1

readonly static aim1: 4;

Engine enum value for XR_object.aim1.

---

aim2

readonly static aim2: 5;

Engine enum value for XR_object.aim2.

---

deactivate

readonly static deactivate: 17;

Engine enum value for XR_object.deactivate.

---

drop

readonly static drop: 11;

Engine enum value for XR_object.drop.

---

dummy

readonly static dummy: -1;

Engine enum value for XR_object.dummy.

---

fire1

readonly static fire1: 6;

Engine enum value for XR_object.fire1.

---

fire2

readonly static fire2: 8;

Engine enum value for XR_object.fire2.

---

hide

readonly static hide: 22;

Engine enum value for XR_object.hide.

---

idle

readonly static idle: 9;

Engine enum value for XR_object.idle.

---

reload

readonly static reload: 2;

Engine enum value for XR_object.reload.

---

reload1

readonly static reload1: 2;

Engine enum value for XR_object.reload1.

---

reload2

readonly static reload2: 3;

Engine enum value for XR_object.reload2.

---

show

readonly static show: 21;

Engine enum value for XR_object.show.

---

strap

readonly static strap: 10;

Engine enum value for XR_object.strap.

---

switch1

readonly static switch1: 0;

Engine enum value for XR_object.switch1.

---

switch2

readonly static switch2: 1;

Engine enum value for XR_object.switch2.

---

take

readonly static take: 23;

Engine enum value for XR_object.take.

---

turn_off

readonly static turn_off: 20;

Engine enum value for XR_object.turn_off.

---

turn_on

readonly static turn_on: 19;

Engine enum value for XR_object.turn_on.

---

use

readonly static use: 18;

Engine enum value for XR_object.use.