GetWeaponAmmo: Difference between revisions
Jump to navigation
Jump to search
(→Syntax) |
(Added OOP syntax) |
||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Needs example}} | |||
{{Client function}} | {{Client function}} | ||
This function gets the total ammo a [[Element/Weapon|custom weapon]] has. | |||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua">int getWeaponAmmo ( weapon theWeapon )</syntaxhighlight> | <syntaxhighlight lang="lua">int getWeaponAmmo ( weapon theWeapon )</syntaxhighlight> | ||
===Required | {{OOP||[[Element/Weapon|weapon]]:getAmmo|ammo|setWeaponAmmo}} | ||
* theWeapon: The weapon to get the ammo of. | |||
===Required arguments=== | |||
* '''theWeapon''': The weapon to get the ammo of. | |||
===Returns=== | ===Returns=== | ||
Returns an integer | Returns an [[int|integer]] containing how many ammo left has the weapon. Returns ''false'' if an error occured. | ||
==Requirements== | ==Requirements== | ||
{{Requirements|n/a|1.3.0-9.04555|}} | {{Requirements|n/a|1.3.0-9.04555|}} | ||
==See | ==See also== | ||
{{Client weapon creation functions}} | {{Client weapon creation functions}} | ||
Revision as of 16:39, 23 December 2014
Template:Needs example This function gets the total ammo a custom weapon has.
Syntax
int getWeaponAmmo ( weapon theWeapon )
OOP Syntax Help! I don't understand this!
- Method: weapon:getAmmo(...)
- Variable: .ammo
- Counterpart: setWeaponAmmo
Required arguments
- theWeapon: The weapon to get the ammo of.
Returns
Returns an integer containing how many ammo left has the weapon. Returns false if an error occured.
Requirements
This template will be deleted.
See also
- createWeapon
- fireWeapon
- getWeaponFiringRate
- getWeaponClipAmmo
- getWeaponAmmo
- getWeaponFlags
- getWeaponState
- getWeaponTarget
- resetWeaponFiringRate
- setWeaponClipAmmo
- setWeaponFiringRate
- setWeaponFlags
- setWeaponState
- setWeaponTarget