GetPlayerTotalAmmo: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
 
No edit summary
Line 1: Line 1:
__NOTOC__
__NOTOC__
This function returns an integer that contains the total ammo in a specified [[player]]'s current weapon.
This function returns an integer that contains the total ammo in a specified [[player]]'s weapon. See [[weapon|Weapon Info]]


==Syntax==
==Syntax==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
int getPlayerTotalAmmo ( player thePlayer )
int getPlayerTotalAmmo ( player thePlayer, [ int weaponSlot = current ] )
</syntaxhighlight>
</syntaxhighlight>


===Required Arguments===
===Required Arguments===
*'''thePlayer''': The [[player]] whose ammo you want to check.
*'''thePlayer''': The [[player]] whose ammo you want to check.
===Optional Arguments===
*'''weaponSlot''': an integer representing the weapon slot (set to the players current slot if not given)


===Returns===
===Returns===

Revision as of 18:28, 13 December 2006

This function returns an integer that contains the total ammo in a specified player's weapon. See Weapon Info

Syntax

int getPlayerTotalAmmo ( player thePlayer, [ int weaponSlot = current ] )

Required Arguments

  • thePlayer: The player whose ammo you want to check.

Optional Arguments

  • weaponSlot: an integer representing the weapon slot (set to the players current slot if not given)


Returns

Returns an int containing the total amount of ammo for the specified player's weapon, or 0 if the player specified is invalid.

Example

This example outputs the total amount of ammo a player called Someguy has for his weapon. 

-- Find the player called 'Someguy'
myPlayer = findPlayer ( "Someguy" )
-- If a player called 'Someguy' was found then
if ( myPlayer ~= false )
	-- Retrieve the total amount of ammo for that player, and store it in a variable called 'ammo'
	ammo = getPlayerTotalAmmo ( myPlayer )
	-- Tell all the players how much ammo 'Someguy' has
	outputChatBox ( "Someguy's current total ammo: ", ammo, "." )
end

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/GetPlayerTotalAmmo?oldid=6753"