GetPlayerTotalAmmo: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 5: Line 5:


==Syntax==
==Syntax==
<section name="Server" class="server">
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
int getPlayerTotalAmmo ( player thePlayer )
int getPlayerTotalAmmo ( player thePlayer )
Line 16: Line 16:
Returns an [[int]] containing the total amount of ammo for the player's current weapon.
Returns an [[int]] containing the total amount of ammo for the player's current weapon.
</section>
</section>
<section name="Client" class="client">
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
int getPlayerTotalAmmo ( player thePlayer, [ int weaponSlot = current ] )
int getPlayerTotalAmmo ( player thePlayer [, int weaponSlot = current ] )
</syntaxhighlight>
</syntaxhighlight>


Line 28: Line 28:


===Returns===
===Returns===
Returns an [[int]] containing the total amount of ammo for the specified player's weapon, or 0 if the player specified is invalid.</section>
Returns an [[int]] containing the total amount of ammo for the specified player's weapon, or 0 if the player specified is invalid.
</section>


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

Revision as of 14:11, 19 August 2007

Dialog-information.png This article needs checking.
Reason(s): Should return false instead of 0 if player's invalid, for consistency

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

Syntax

Click to collapse [-]
Server
int getPlayerTotalAmmo ( player thePlayer )

Required Arguments

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

Returns

Returns an int containing the total amount of ammo for the player's current weapon.

Click to collapse [-]
Client
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 = getPlayerFromNick ( "Someguy" )
-- If a player called 'Someguy' was found then
if ( myPlayer ) then
	-- 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=10689"