XRF X-Ray 16 SDK

Appearance

Class: MockHangingLamp ​

Mock of the X-Ray engine hanging lamp object.

Extends ​

  • MockCGameObject

Implements ​

  • hanging_lamp

Constructors ​

Constructor ​

ts
new MockHangingLamp(): MockHangingLamp;

Returns ​

MockHangingLamp

Inherited from ​

ts
MockCGameObject.constructor

Methods ​

create() ​

ts
static create(): MockHangingLamp;

Returns ​

MockHangingLamp

Overrides ​

ts
MockCGameObject.create

mock() ​

ts
static mock(): hanging_lamp;

Returns ​

hanging_lamp

Overrides ​

ts
MockCGameObject.mock

Properties ​

__name ​

ts
__name: string = "CGameObject";

LuaBind instance constructor name.

Implementation of ​

ts
hanging_lamp.__name

Inherited from ​

ts
MockCGameObject.__name

_construct ​

ts
_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 ​

ts
hanging_lamp._construct

Inherited from ​

ts
MockCGameObject._construct

getEnabled ​

ts
getEnabled: MockedFunction<() => boolean>;

Returns ​

Whether the object is enabled in the client object loop.

Implementation of ​

ts
hanging_lamp.getEnabled

Inherited from ​

ts
MockCGameObject.getEnabled

getVisible ​

ts
getVisible: MockedFunction<() => boolean>;

Returns ​

Whether the object is visible.

Implementation of ​

ts
hanging_lamp.getVisible

Inherited from ​

ts
MockCGameObject.getVisible

net_Export ​

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

Export network state to a packet.

Param ​

net_packet

Destination network packet.

Implementation of ​

ts
hanging_lamp.net_Export

Inherited from ​

ts
MockCGameObject.net_Export

net_Import ​

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

Import network state from a packet.

Param ​

net_packet

Source network packet.

Implementation of ​

ts
hanging_lamp.net_Import

Inherited from ​

ts
MockCGameObject.net_Import

net_Spawn ​

ts
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 ​

ts
hanging_lamp.net_Spawn

Inherited from ​

ts
MockCGameObject.net_Spawn

turn_off ​

ts
turn_off: Mock<UnknownFunction>;

Turn the lamp off.

Implementation of ​

ts
hanging_lamp.turn_off

turn_on ​

ts
turn_on: Mock<UnknownFunction>;

Turn the lamp on.

Implementation of ​

ts
hanging_lamp.turn_on

use ​

ts
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 ​

ts
hanging_lamp.use

Inherited from ​

ts
MockCGameObject.use

Visual ​

ts
Visual: MockedFunction<() => IXR_IRender_Visual>;

Returns ​

Render visual assigned to the object.

Implementation of ​

ts
hanging_lamp.Visual

Inherited from ​

ts
MockCGameObject.Visual