Class: MockPhysicObject

Mock of the X-Ray engine CPhysicObject.

Extends

• MockCGameObject

Implements

• CPhysicObject

Constructors

Constructor

new MockPhysicObject(): MockPhysicObject;

Returns

MockPhysicObject

Inherited from

MockCGameObject.constructor

Methods

create()

static create(): MockPhysicObject;

Returns

MockPhysicObject

Overrides

MockCGameObject.create

---

mock()

static mock(): CPhysicObject;

Returns

CPhysicObject

Overrides

MockCGameObject.mock

Properties

__name

__name: string = "CGameObject";

LuaBind instance constructor name.

Implementation of

CPhysicObject.__name

Inherited from

MockCGameObject.__name

---

_construct

_construct: MockedFunction<() => DLL_Pure>;

Construct engine-side object state.

Remarks

Lifecycle hook used by the engine. Calling it from gameplay scripts can reinitialize native state unexpectedly.

Returns

Constructed base object.

Implementation of

CPhysicObject._construct

Inherited from

MockCGameObject._construct

---

anim_time_get

anim_time_get: Mock<() => number>;

Returns

Current animation time.

Implementation of

CPhysicObject.anim_time_get

---

anim_time_set

anim_time_set: Mock<(time: number) => void>;

Set current animation time.

Param

time

Animation time.

Implementation of

CPhysicObject.anim_time_set

---

animationTime

animationTime: number = 0;

---

getEnabled

getEnabled: MockedFunction<() => boolean>;

Returns

Whether the object is enabled in the client object loop.

Implementation of

CPhysicObject.getEnabled

Inherited from

MockCGameObject.getEnabled

---

getVisible

getVisible: MockedFunction<() => boolean>;

Returns

Whether the object is visible.

Implementation of

CPhysicObject.getVisible

Inherited from

MockCGameObject.getVisible

---

net_Export

net_Export: MockedFunction<(net_packet: net_packet) => void>;

Export network state to a packet.

Param

net_packet

Destination network packet.

Implementation of

CPhysicObject.net_Export

Inherited from

MockCGameObject.net_Export

---

net_Import

net_Import: MockedFunction<(net_packet: net_packet) => void>;

Import network state from a packet.

Param

net_packet

Source network packet.

Implementation of

CPhysicObject.net_Import

Inherited from

MockCGameObject.net_Import

---

net_Spawn

net_Spawn: MockedFunction<(cse_abstract: cse_abstract) => boolean>;

Spawn the client object from its server object.

Remarks

Lifecycle hook used during network spawn. Return false to reject spawn in custom subclasses.

Param

cse_abstract

Server object used for spawn data.

Returns

Whether spawn succeeded.

Implementation of

CPhysicObject.net_Spawn

Inherited from

MockCGameObject.net_Spawn

---

play_bones_sound

play_bones_sound: Mock<UnknownFunction>;

Start sounds attached to animated bones.

Implementation of

CPhysicObject.play_bones_sound

---

run_anim_back

run_anim_back: Mock<UnknownFunction>;

Run the object animation backward.

Implementation of

CPhysicObject.run_anim_back

---

run_anim_forward

run_anim_forward: Mock<UnknownFunction>;

Run the object animation forward.

Implementation of

CPhysicObject.run_anim_forward

---

set_door_ignore_dynamics

set_door_ignore_dynamics: Mock<UnknownFunction>;

Ignore dynamic objects while the door-like object is moving.

Implementation of

CPhysicObject.set_door_ignore_dynamics

---

stop_anim

stop_anim: Mock<() => boolean>;

Stop the current object animation.

Returns

Whether animation was stopped.

Implementation of

CPhysicObject.stop_anim

---

stop_bones_sound

stop_bones_sound: Mock<UnknownFunction>;

Stop sounds attached to animated bones.

Implementation of

CPhysicObject.stop_bones_sound

---

unset_door_ignore_dynamics

unset_door_ignore_dynamics: Mock<UnknownFunction>;

Restore normal dynamic-object collision handling.

Implementation of

CPhysicObject.unset_door_ignore_dynamics

---

use

use: MockedFunction<(object: CGameObject) => boolean>;

Use another object through the engine interaction path.

Param

object

Object being used.

Returns

Whether the use action was handled.

Implementation of

CPhysicObject.use

Inherited from

MockCGameObject.use

---

Visual

Visual: MockedFunction<() => IXR_IRender_Visual>;

Returns

Render visual assigned to the object.

Implementation of

CPhysicObject.Visual

Inherited from

MockCGameObject.Visual