Skip to content

Class: CZoneCampfire ​

Campfire anomaly object.

Source ​

src/xrGame/MosquitoBald_script.cpp, CZoneCampfire binding.

Custom Constructor ​

CZoneCampfire

Remarks ​

Campfire controls require this runtime object. The binding is registered next to mosquito-bald anomalies and exposes only on/off state controls; generic anomaly zones do not have these methods.

Extends ​

Constructors ​

Constructor ​

ts
new CZoneCampfire(): CZoneCampfire;

Create a campfire object wrapper.

Returns ​

CZoneCampfire

Overrides ​

CGameObject.constructor

Methods ​

_construct() ​

ts
_construct(): DLL_Pure;

Construct engine-side object state.

Returns ​

DLL_Pure

Constructed base object.

Remarks ​

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

Inherited from ​

CGameObject._construct


getEnabled() ​

ts
getEnabled(): boolean;

Returns ​

boolean

Whether the object is enabled in the client object loop.

Inherited from ​

CGameObject.getEnabled


getVisible() ​

ts
getVisible(): boolean;

Returns ​

boolean

Whether the object is visible.

Inherited from ​

CGameObject.getVisible


is_on() ​

ts
is_on(): boolean;

Returns ​

boolean

Whether the campfire is currently burning.


net_Export() ​

ts
net_Export(net_packet: net_packet): void;

Export network state to a packet.

Parameters ​

ParameterTypeDescription
net_packetnet_packetDestination network packet.

Returns ​

void

Inherited from ​

CGameObject.net_Export


net_Import() ​

ts
net_Import(net_packet: net_packet): void;

Import network state from a packet.

Parameters ​

ParameterTypeDescription
net_packetnet_packetSource network packet.

Returns ​

void

Inherited from ​

CGameObject.net_Import


net_Spawn() ​

ts
net_Spawn(cse_abstract: cse_abstract): boolean;

Spawn the client object from its server object.

Parameters ​

ParameterTypeDescription
cse_abstractcse_abstractServer object used for spawn data.

Returns ​

boolean

Whether spawn succeeded.

Remarks ​

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

Inherited from ​

CGameObject.net_Spawn


turn_off() ​

ts
turn_off(): void;

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

Returns ​

void


turn_on() ​

ts
turn_on(): void;

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

Returns ​

void


use() ​

ts
use(object: CGameObject): boolean;

Use another object through the engine interaction path.

Parameters ​

ParameterTypeDescription
objectCGameObjectObject being used.

Returns ​

boolean

Whether the use action was handled.

Inherited from ​

CGameObject.use


Visual() ​

ts
Visual(): IXR_IRender_Visual;

Returns ​

IXR_IRender_Visual

Render visual assigned to the object.

Inherited from ​

CGameObject.Visual

Properties ​

__name ​

ts
readonly __name: string;

LuaBind instance constructor name.

Inherited from ​

CGameObject.__name


__name ​

ts
readonly static __name: string;

LuaBind class constructor name.

Inherited from ​

CGameObject.__name