Class: MockCZoneCampfire

Mock of the X-Ray engine campfire object.

Extends

• MockCGameObject

Implements

• CZoneCampfire

Constructors

Constructor

new MockCZoneCampfire(state?: boolean): MockCZoneCampfire;

Parameters

Parameter	Type	Default value
state	boolean	false

Returns

MockCZoneCampfire

Overrides

MockCGameObject.constructor

Methods

create()

static create(state?: boolean): MockCZoneCampfire;

Parameters

Parameter	Type	Default value
state	boolean	false

Returns

MockCZoneCampfire

Overrides

MockCGameObject.create

---

mock()

static mock(state?: boolean): CZoneCampfire;

Parameters

Parameter	Type	Default value
state	boolean	false

Returns

CZoneCampfire

Overrides

MockCGameObject.mock

Properties

__name

__name: string = "CGameObject";

LuaBind instance constructor name.

Implementation of

CZoneCampfire.__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

CZoneCampfire._construct

Inherited from

MockCGameObject._construct

---

getEnabled

getEnabled: MockedFunction<() => boolean>;

Returns

Whether the object is enabled in the client object loop.

Implementation of

CZoneCampfire.getEnabled

Inherited from

MockCGameObject.getEnabled

---

getVisible

getVisible: MockedFunction<() => boolean>;

Returns

Whether the object is visible.

Implementation of

CZoneCampfire.getVisible

Inherited from

MockCGameObject.getVisible

---

is_on

is_on: Mock<() => boolean>;

Returns

Whether the campfire is currently burning.

Implementation of

CZoneCampfire.is_on

---

net_Export

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

Export network state to a packet.

Param

net_packet

Destination network packet.

Implementation of

CZoneCampfire.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

CZoneCampfire.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

CZoneCampfire.net_Spawn

Inherited from

MockCGameObject.net_Spawn

---

state

state: boolean;

---

turn_off

turn_off: Mock<() => void>;

Switch the campfire into its disabled state and stop native idle effects.

Implementation of

CZoneCampfire.turn_off

---

turn_on

turn_on: Mock<() => void>;

Switch the campfire into its enabled state and start native idle effects.

Implementation of

CZoneCampfire.turn_on

---

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

CZoneCampfire.use

Inherited from

MockCGameObject.use

---

Visual

Visual: MockedFunction<() => IXR_IRender_Visual>;

Returns

Render visual assigned to the object.

Implementation of

CZoneCampfire.Visual

Inherited from

MockCGameObject.Visual