weaponAPI_t Struct Reference

About this class

Weapon library.

Public Member Functions
bool	IsValid (entity weaponRef=__NULL__)
	Returns whether this entity reference to a weapon is still valid.
string	GetTitle (entity weaponRef=__NULL__)
	Returns the title of the weapon specified.
int	GetSlot (entity weaponRef=__NULL__)
	Returns the slot number of the weapon specified.
int	GetSlotPos (entity weaponRef=__NULL__)
	Returns if the slot position of the weapon specified.
string	GetIcon (entity weaponRef=__NULL__)
	Returns the inventory icons of the weapon specified.
string	GetSelectedIcon (entity weaponRef=__NULL__)
	Returns the selected variant inventory icons of the weapon specified.
int	GetAmmo1 (entity weaponRef=__NULL__)
	Returns if the current/active weapons present reserve ammo.
int	GetAmmo2 (entity weaponRef=__NULL__)
	Returns if the current/active weapons present reserve ammo, but for the second ammo type.
int	GetClip (entity weaponRef=__NULL__)
	Returns if the current/active weapons present clip/magazine size.
int	GetClipSize (entity weaponRef=__NULL__)
	Returns if the current/active weapons maximum clip/magazine size.
int	MaxAmmo (entity weaponRef=__NULL__)
	Returns if the maximum reserve ammo.
bool	UsesSecondaryAmmo (entity weaponRef=__NULL__)
	Returns if the current/active weapon item in the player's inventory makes use of a secondary ammo type.
bool	AmmoRequired (entity weaponRef=__NULL__)
	Returns if the current/active weapon item in the player's inventory requires ammo.
entity	GetActiveWeapon (void)
	Returns the current/active weapon item in the player's inventory.
entity	GetFirstWeaponInInventory (void)
	Returns the first weapon item in the player's inventory.
entity	GetLastWeaponInInventory (void)
	Returns the last weapon item in the player's inventory.
entity	GetNextWeaponRelativeTo (entity)
	Returns the weapon that comes after (in the player's inventory) the input weapon.
entity	GetPreviousWeaponRelativeTo (entity playerWeapon)
	Returns the weapon that comes before (in the player's inventory) the input weapon.
void	SelectWeapon (entity)
	Attempts to make the player switch to the specified weapon reference.

Member Function Documentation

AmmoRequired()

bool weaponAPI_t::AmmoRequired

(

entity

weaponRef = __NULL__

)

Returns if the current/active weapon item in the player's inventory requires ammo.

Returns

true when it requires ammo.

GetActiveWeapon()

entity weaponAPI_t::GetActiveWeapon

(

void

)

Returns the current/active weapon item in the player's inventory.

Returns

the active weapon in the player's inventory. NULL if invalid.

GetAmmo1()

int weaponAPI_t::GetAmmo1

(

entity

weaponRef = __NULL__

)

Returns if the current/active weapons present reserve ammo.

Returns

integer value of the present reserve ammo.

GetAmmo2()

int weaponAPI_t::GetAmmo2

(

entity

weaponRef = __NULL__

)

Returns if the current/active weapons present reserve ammo, but for the second ammo type.

Returns

integer value of the present reserve ammo.

GetClip()

int weaponAPI_t::GetClip

(

entity

weaponRef = __NULL__

)

Returns if the current/active weapons present clip/magazine size.

Returns

integer value of the present clip/magazine size.

GetClipSize()

int weaponAPI_t::GetClipSize

(

entity

weaponRef = __NULL__

)

Returns if the current/active weapons maximum clip/magazine size.

Returns

integer value of the maximum clip/magazine size.

GetFirstWeaponInInventory()

entity weaponAPI_t::GetFirstWeaponInInventory

(

void

)

Returns the first weapon item in the player's inventory.

Returns

the first weapon in the player's inventory. NULL if invalid.

GetIcon()

string weaponAPI_t::GetIcon

(

entity

weaponRef = __NULL__

)

Returns the inventory icons of the weapon specified.

Parameters

weaponRef

is the weapon entity to reference

Returns

string value containing the material/image of the weapon inventory icon.

GetLastWeaponInInventory()

entity weaponAPI_t::GetLastWeaponInInventory

(

void

)

Returns the last weapon item in the player's inventory.

Returns

the last weapon in the player's inventory. NULL if invalid.

GetNextWeaponRelativeTo()

entity weaponAPI_t::GetNextWeaponRelativeTo

(

entity

)

Returns the weapon that comes after (in the player's inventory) the input weapon.

Parameters

playerWeapon

the weapon entity of the player.

Returns

the weapon after playerWeapon in the player's inventory. NULL if invalid.

GetPreviousWeaponRelativeTo()

entity weaponAPI_t::GetPreviousWeaponRelativeTo

(

entity

playerWeapon

)

Returns the weapon that comes before (in the player's inventory) the input weapon.

Parameters

playerWeapon

the weapon entity of the player.

Returns

the weapon before playerWeapon in the player's inventory. NULL if invalid.

GetSelectedIcon()

string weaponAPI_t::GetSelectedIcon

(

entity

weaponRef = __NULL__

)

Returns the selected variant inventory icons of the weapon specified.

Parameters

weaponRef

is the weapon entity to reference

Returns

string value containing the material/image of the selected weapon inventory icon.

GetSlot()

int weaponAPI_t::GetSlot

(

entity

weaponRef = __NULL__

)

Returns the slot number of the weapon specified.

Parameters

weaponRef

is the weapon entity to reference

Returns

integer value containing the inventory slot the weapon is in.

GetSlotPos()

int weaponAPI_t::GetSlotPos

(

entity

weaponRef = __NULL__

)

Returns if the slot position of the weapon specified.

Parameters

weaponRef

is the weapon entity to reference

Returns

integer value containing the position within an inventory slot that the weapon is in.

GetTitle()

string weaponAPI_t::GetTitle

(

entity

weaponRef = __NULL__

)

Returns the title of the weapon specified.

Parameters

weaponRef

is the weapon entity to reference

Returns

string value containing a localized weapon name.

IsValid()

bool weaponAPI_t::IsValid

(

entity

weaponRef = __NULL__

)

Returns whether this entity reference to a weapon is still valid.

Parameters

weaponRef

is the weapon entity to reference

Returns

whether the weapon entity reference is valid to the current player.

MaxAmmo()

int weaponAPI_t::MaxAmmo

(

entity

weaponRef = __NULL__

)

Returns if the maximum reserve ammo.

Returns

integer value of the maximum ammo size.

SelectWeapon()

void weaponAPI_t::SelectWeapon

(

entity

)

Attempts to make the player switch to the specified weapon reference.

Parameters

weaponRef

is the weapon entity to switch to.

UsesSecondaryAmmo()

bool weaponAPI_t::UsesSecondaryAmmo

(

entity

weaponRef = __NULL__

)

Returns if the current/active weapon item in the player's inventory makes use of a secondary ammo type.

Returns

true when it supports a second ammo type.

---

The documentation for this struct was generated from the following file:

• src/client/api_func.h