SetWeaponAmmo: Difference between revisions
Jump to navigation
Jump to search
Enterprise (talk | contribs) No edit summary |
Fernando187 (talk | contribs) (Remove obsolete Requirements section) Tag: Manual revert |
||
| (13 intermediate revisions by 8 users not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Server function}} | {{Server client function}} | ||
<section name="setWeaponAmmo" class="server" show="true"> | |||
Sets the ammo to a certain amount for a specified weapon (if they already have it), regardless of current ammo. | Sets the ammo to a certain amount for a specified weapon (if they already have it), regardless of current ammo. | ||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua">bool setWeaponAmmo ( player thePlayer, int weapon, int totalAmmo, | <syntaxhighlight lang="lua">bool setWeaponAmmo ( player thePlayer, int weapon, int totalAmmo [, int ammoInClip = 0 ] )</syntaxhighlight> | ||
===Required Arguments=== | ===Required Arguments=== | ||
| Line 13: | Line 14: | ||
===Optional Arguments=== | ===Optional Arguments=== | ||
{{OptionalArg}} | {{OptionalArg}} | ||
*'''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. | *'''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. | ||
==Returns== | ==Returns== | ||
| Line 22: | Line 21: | ||
==Example== | ==Example== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
-- | local randPlayer = getRandomPlayer() -- Get a random player | ||
giveWeapon(randPlayer,35,100) -- Give them a rocket launcher with 100 rockets. | |||
setWeaponAmmo(randPlayer,35,50) -- Decide we're only going to give them 50 rockets. | |||
</syntaxhighlight> | </syntaxhighlight> | ||
</section> | |||
==See | <section name="setWeaponAmmo (custom weapons)" class="client" show="true"> | ||
Set the ammo of a custom weapon which was created through [[createWeapon]]. By default, a custom weapon has 9999 ammo (which means infinite ammo). | |||
==Syntax== | |||
<syntaxhighlight lang="lua">bool setWeaponAmmo ( weapon theWeapon, int ammo )</syntaxhighlight> | |||
{{OOP||[[Element/Weapon|weapon]]:setAmmo|ammo|getWeaponAmmo}} | |||
===Required arguments=== | |||
* '''theWeapon:''' The weapon to set the ammo of. | |||
* '''ammo:''' The total ammo amount for the given weapon (including ammo in clip). | |||
==Returns== | |||
Returns ''true'' on success, ''false'' otherwise. | |||
==Example== | |||
<syntaxhighlight lang="lua"> | |||
local weapon = createWeapon ("deagle",0, 0, 10) -- Create the weapon | |||
setWeaponAmmo(weapon,5000) | |||
</syntaxhighlight> | |||
</section> | |||
==See also== | |||
{{Weapon functions}} | {{Weapon functions}} | ||
{{Client weapon creation functions}} | |||
[[ru:setWeaponAmmo]] | [[ru:setWeaponAmmo]] | ||
Latest revision as of 15:32, 7 November 2024
Click to collapse [-]
setWeaponAmmoSets 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 ] )
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.
- 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.
Returns
Returns a boolean value true or false that tells you if it was successful or not.
Example
local randPlayer = getRandomPlayer() -- Get a random player giveWeapon(randPlayer,35,100) -- Give them a rocket launcher with 100 rockets. setWeaponAmmo(randPlayer,35,50) -- Decide we're only going to give them 50 rockets.
Click to collapse [-]
setWeaponAmmo (custom weapons)Set the ammo of a custom weapon which was created through createWeapon. By default, a custom weapon has 9999 ammo (which means infinite ammo).
Syntax
bool setWeaponAmmo ( weapon theWeapon, int ammo )
OOP Syntax Help! I don't understand this!
- Method: weapon:setAmmo(...)
- Variable: .ammo
- Counterpart: getWeaponAmmo
Required arguments
- theWeapon: The weapon to set the ammo of.
- ammo: The total ammo amount for the given weapon (including ammo in clip).
Returns
Returns true on success, false otherwise.
Example
local weapon = createWeapon ("deagle",0, 0, 10) -- Create the weapon
setWeaponAmmo(weapon,5000)
See also
- getWeaponProperty
- getPickupWeapon
- getOriginalWeaponProperty
- getSlotFromWeapon
- getWeaponIDFromName
- getWeaponNameFromID
- setWeaponAmmo
- setWeaponProperty