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
new CZoneCampfire(): CZoneCampfire;Create a campfire object wrapper.
Returns
CZoneCampfire
Overrides
Methods
_construct()
_construct(): DLL_Pure;Construct engine-side object state.
Returns
Constructed base object.
Remarks
Lifecycle hook used by the engine. Calling it from gameplay scripts can reinitialize native state unexpectedly.
Inherited from
getEnabled()
getEnabled(): boolean;Returns
boolean
Whether the object is enabled in the client object loop.
Inherited from
getVisible()
getVisible(): boolean;Returns
boolean
Whether the object is visible.
Inherited from
is_on()
is_on(): boolean;Returns
boolean
Whether the campfire is currently burning.
net_Export()
net_Export(net_packet: net_packet): void;Export network state to a packet.
Parameters
| Parameter | Type | Description |
|---|---|---|
net_packet | net_packet | Destination network packet. |
Returns
void
Inherited from
net_Import()
net_Import(net_packet: net_packet): void;Import network state from a packet.
Parameters
| Parameter | Type | Description |
|---|---|---|
net_packet | net_packet | Source network packet. |
Returns
void
Inherited from
net_Spawn()
net_Spawn(cse_abstract: cse_abstract): boolean;Spawn the client object from its server object.
Parameters
| Parameter | Type | Description |
|---|---|---|
cse_abstract | cse_abstract | Server 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
turn_off()
turn_off(): void;Switch the campfire into its disabled state and stop native idle effects.
Returns
void
turn_on()
turn_on(): void;Switch the campfire into its enabled state and start native idle effects.
Returns
void
use()
use(object: CGameObject): boolean;Use another object through the engine interaction path.
Parameters
| Parameter | Type | Description |
|---|---|---|
object | CGameObject | Object being used. |
Returns
boolean
Whether the use action was handled.
Inherited from
Visual()
Visual(): IXR_IRender_Visual;Returns
Render visual assigned to the object.
Inherited from
Properties
__name
readonly __name: string;LuaBind instance constructor name.
Inherited from
__name
readonly static __name: string;LuaBind class constructor name.