GetWeaponAmmo: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
(Added example) |
||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Client function}} | {{Client function}} | ||
This function gets the total ammo a [[Element/Weapon|custom weapon]] has. | This function gets the total ammo a [[Element/Weapon|custom weapon]] has. | ||
| Line 13: | Line 12: | ||
===Returns=== | ===Returns=== | ||
Returns an [[int|integer]] containing how many ammo left has the weapon. Returns ''false'' if an error occured. | Returns an [[int|integer]] containing how many ammo left has the weapon. Returns ''false'' if an error occured. | ||
==Example== | |||
This example gets the ammo of the custom weapon and outputs it to the chatbox. | |||
<syntaxhighlight lang="lua"> | |||
function createCustomWeapon() | |||
local position = Vector3(getElementPosition(localPlayer)) -- get the localPlayer position | |||
local weapon = createWeapon ("m4",position.x,position.y,position.z) -- Create the weapon | |||
if weapon then -- If the weapon exist then | |||
setWeaponAmmo(weapon,5000) | |||
local ammo = getWeaponAmmo(weapon) | |||
outputChatBox("Total ammo: "..ammo) -- output to the chatbox | |||
end | |||
end | |||
addCommandHandler("weapon",createCustomWeapon) | |||
</syntaxhighlight> | |||
==Requirements== | ==Requirements== | ||
Revision as of 14:05, 4 July 2016
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.
Example
This example gets the ammo of the custom weapon and outputs it to the chatbox.
function createCustomWeapon()
local position = Vector3(getElementPosition(localPlayer)) -- get the localPlayer position
local weapon = createWeapon ("m4",position.x,position.y,position.z) -- Create the weapon
if weapon then -- If the weapon exist then
setWeaponAmmo(weapon,5000)
local ammo = getWeaponAmmo(weapon)
outputChatBox("Total ammo: "..ammo) -- output to the chatbox
end
end
addCommandHandler("weapon",createCustomWeapon)
Requirements
This template will be deleted.
See also
- createWeapon
- fireWeapon
- getWeaponAmmo
- getWeaponClipAmmo
- getWeaponFiringRate
- getWeaponFlags
- getWeaponOwner
- getWeaponProperty
- getWeaponState
- getWeaponTarget
- resetWeaponFiringRate
- setWeaponAmmo
- setWeaponClipAmmo
- setWeaponFiringRate
- setWeaponFlags
- setWeaponProperty
- setWeaponState
- setWeaponTarget