GetWeaponAmmo: Difference between revisions

Latest 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

Minimum server version	n/a
Minimum client version	1.3.0-9.04555

Note: Using this feature requires the resource to have the above minimum version declared in the meta.xml <min_mta_version> section. e.g. <min_mta_version client="1.3.0-9.04555" />

@@ Line 1: / Line 1: @@
 __NOTOC__
 {{Client function}}
-Get the amount of ammo a custom weapon has.
+This function gets the total ammo a [[Element/Weapon|custom weapon]] has.
 ==Syntax==
 <syntaxhighlight lang="lua">int getWeaponAmmo ( weapon theWeapon )</syntaxhighlight>
+{{OOP||[[Element/Weapon|weapon]]:getAmmo|ammo|setWeaponAmmo}}
-===Required Arguments===
+===Required arguments===
-* theWeapon: The weapon to get the ammo of.
+* '''theWeapon''': The weapon to get the ammo of.
 ===Returns===
-Returns an integer of the amount of ammo the weapon has, false otherwise.
+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|1.3.0-4555|1.3.0-4555|}}
+{{Requirements|n/a|1.3.0-9.04555|}}
-==See Also==
+==See also==
-{{Client weapon functions}}
+{{Client weapon creation functions}}