GetWeaponClipAmmo: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
Line 1: Line 1:
{{Needs_Example}}
__NOTOC__
__NOTOC__
{{Client function}}
{{Client function}}
Line 8: Line 7:


===Required Arguments===
===Required Arguments===
* '''theWeapon:''' The weapon to get the clip ammo of.
* '''theWeapon:''' the [[weapon]] to get the clip ammo of.


===Returns===
===Returns===
Line 14: Line 13:


===Example===
===Example===
<section name="Example 1" class="client" show="true">This example gets your ammo and output it!
This example gets your ammo and output it!
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
[lua]
[lua]
Line 23: Line 22:
end -- End the function
end -- End the function
</syntaxhighlight>
</syntaxhighlight>
</section>


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

Revision as of 15:14, 14 October 2014

This function gets the amount of ammo in a custom weapons magazine/clip.

Syntax

int getWeaponClipAmmo ( weapon theWeapon )

Required Arguments

  • theWeapon: the weapon to get the clip ammo of.

Returns

Returns the amount of ammo in the custom weapons clip, false otherwise.

Example

This example gets your ammo and output it!

[lua]
function getMyAmmo(player) -- Create a function named getMyAmmo and add player as the first parameter of addCommandHandler!
   local weapon = getPedWeapon(player) -- Create a local variable with the value of getPedWeapon ( the weapon of the player )!
   local clipAmmo = getWeaponClipAmmo(weapon) -- Now use the local variable and get the weapon's clip ammo!
   outputChatBox(tostring(clipAmmo), player) -- Output the clipAmmo to the player, Please use tostring for it or it will give you a error that it should be a string!
end -- End the function

See Also