Class: CBastArtefact

Client object binding for CBastArtefact artefacts.

Source

src/xrGame/artefact_script.cpp, CBastArtefact binding.

Custom Constructor

CBastArtefact

Extends

• CArtefact

Constructors

Constructor

new CBastArtefact(): CBastArtefact;

Create an artefact object wrapper.

Returns

CBastArtefact

Inherited from

CArtefact.constructor

Methods

_construct()

_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

CArtefact._construct

---

FollowByPath()

FollowByPath(
   path_name: string, 
   point_index: number, 
   position: vector): void;

Move the artefact detector helper along a patrol path.

Parameters

Parameter	Type	Description
path_name	string	Patrol path name.
point_index	number	Starting path point index.
position	vector	Movement force used by detector support.

Returns

void

Remarks

Native code delegates to detector support when it exists. Missing detector support makes this a no-op. The vector parameter is stored as movement force, not as an initial world position.

Inherited from

CArtefact.FollowByPath

---

GetAfRank()

GetAfRank(): number;

Returns

number

Artefact rank used by detectors and inventory UI.

Inherited from

CArtefact.GetAfRank

---

getEnabled()

getEnabled(): boolean;

Returns

boolean

Whether the object is enabled in the client object loop.

Inherited from

CArtefact.getEnabled

---

getVisible()

getVisible(): boolean;

Returns

boolean

Whether the object is visible.

Inherited from

CArtefact.getVisible

---

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

CArtefact.net_Export

---

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

CArtefact.net_Import

---

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

CArtefact.net_Spawn

---

SwitchVisibility()

SwitchVisibility(is_visible: boolean): void;

Show or hide the artefact detector helper.

Parameters

Parameter	Type	Description
is_visible	boolean	New visibility state.

Returns

void

Remarks

Native code delegates to detector support when it exists. Missing detector support makes this a no-op; it does not spawn or destroy the artefact object.

Inherited from

CArtefact.SwitchVisibility

---

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

CArtefact.use

---

Visual()

Visual(): IXR_IRender_Visual;

Returns

IXR_IRender_Visual

Render visual assigned to the object.

Inherited from

CArtefact.Visual

Properties

__name

readonly __name: string;

LuaBind instance constructor name.

Inherited from

CArtefact.__name

---

__name

readonly static __name: string;

LuaBind class constructor name.

Inherited from

CArtefact.__name