Pair: getWeaponAmmo

Manual Review Required

Please finish this page using the corresponding Old Wiki article. Go to Contribution guidelines for more information.

---

Sets the ammo to a certain amount for a specified weapon (if they already have it), regardless of current ammo.

OOP Syntax Help! I don't understand this!

• Method:weapon:setAmmo(...)
• Variable: .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.

• ammoInClip (default: 0): 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

• bool: value

Returns a boolean value true or false that tells you if it was successful or not.

Code Examples

shared

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.

See Also

Weapon Functions

• getOriginalWeaponProperty
• getSlotFromWeapon
• getWeaponIDFromName
• getWeaponNameFromID
• getWeaponProperty
• giveWeapon
• isWeaponRenderEnabled
• setWeaponAmmo
• setWeaponProperty
• setWeaponRenderEnabled
• takeAllWeapons
• takeWeapon

Weapon Events

• onWeaponFire

Reference

• Scripting Functions