SetWeaponAmmo: Difference between revisions
Jump to navigation
Jump to search
m (Needs example) |
Cazomino05 (talk | contribs) m (added reload param) |
||
| Line 4: | Line 4: | ||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua">bool setWeaponAmmo ( player thePlayer, int weapon, int totalAmmo, [int ammoInClip = | <syntaxhighlight lang="lua">bool setWeaponAmmo ( player thePlayer, int weapon, int totalAmmo, [int ammoInClip = 0 , bool reload = false] )</syntaxhighlight> | ||
===Required Arguments=== | ===Required Arguments=== | ||
| Line 14: | Line 14: | ||
{{OptionalArg}} | {{OptionalArg}} | ||
{{New feature|10|1.0| | {{New feature|10|1.0| | ||
*'''ammoInClip:''' The amount of ammo to set in the player's clip. This will be taken from the main ammo. If left unspecified, the current clip will remain. | *'''ammoInClip:''' The amount of ammo to set in the player's clip. This will be taken from the main ammo. If left unspecified or set to 0, the current clip will remain. | ||
*'''reload:''' Set this to true to reload the weapon (This plays the weapon reload animation and sets the ammo to full) | |||
}} | }} | ||
Revision as of 08:57, 3 July 2009
Sets the ammo to a certain amount for a specified weapon (if they already have it), regardless of current ammo.
Syntax
bool setWeaponAmmo ( player thePlayer, int weapon, int totalAmmo, [int ammoInClip = 0 , bool reload = false] )
Required Arguments
- thePlayer: A player object referencing the specified player
- weapon: A whole number integer that refers to a weapon ID.
- totalAmmo: A whole number integer serving as the total ammo amount for the given weapon (including ammo in clip).
Optional Arguments
NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use. For more information on optional arguments, see optional arguments.
Returns
Returns a boolean value true or false that tells you if it was successful or not.
Example
-- TODO