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