GetWeaponAmmo: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
(Remove obsolete Requirements section)
 
(7 intermediate revisions by 4 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{Client function}}
{{Client function}}
Get the amount of ammo a custom weapon has.
This function gets the total ammo a [[Element/Weapon|custom weapon]] has.


==Syntax==
==Syntax==
<syntaxhighlight lang="lua">int getWeaponAmmo ( weapon theWeapon )</syntaxhighlight>
<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===
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.


==Requirements==
==Example==
{{Requirements|1.3.0-4555|1.3.0-4555|}}
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>


==See Also==
==See also==
{{Client weapon creation functions}}
{{Client weapon creation functions}}

Latest revision as of 17:05, 7 November 2024

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)

See also


Retrieved from "https://wiki.multitheftauto.com/wiki/GetWeaponAmmo?oldid=81127"