Class: CWeapon

Client object binding for CWeapon inventory items.

Source

src/xrGame/WeaponScript.cpp, CWeapon binding.

Custom Constructor

CWeapon

Remarks

Weapon helpers on game_object require this family or a subclass. Addons, ammo, outfits, and consumables are not weapons even when they are inventory items.

Extends

• CInventoryItem

Extended by

• CWeaponMagazined
• CWeaponKnife

Constructors

Constructor

protected new CWeapon(): CWeapon;

Cast-only runtime wrapper.

Returns

CWeapon

Inherited from

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

CInventoryItem._construct

---

can_kill()

can_kill(): boolean;

Check whether the weapon can currently fire a lethal shot.

Returns

boolean

Whether the weapon can kill.

Remarks

Returns true when the weapon has suitable ammo available or does not use ammo. This is the same predicate used by actor and stalker weapon selection before considering an item lethal.

---

getEnabled()

getEnabled(): boolean;

Returns

boolean

Whether the object is enabled in the client object loop.

Inherited from

CInventoryItem.getEnabled

---

getVisible()

getVisible(): boolean;

Returns

boolean

Whether the object is visible.

Inherited from

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

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

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

CInventoryItem.net_Spawn

---

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

CInventoryItem.use

---

Visual()

Visual(): IXR_IRender_Visual;

Returns

IXR_IRender_Visual

Render visual assigned to the object.

Inherited from

CInventoryItem.Visual

Properties

__name

readonly __name: string;

LuaBind instance constructor name.

Inherited from

CInventoryItem.__name

---

__name

readonly static __name: string;

LuaBind class constructor name.

Inherited from

CInventoryItem.__name