GetPlayerMoney: 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__  
Returns the money level of a player
Returns the amount of money a player currently has.


==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">getPlayerMoney ( player )</syntaxhighlight>  
<syntaxhighlight lang="lua">int getPlayerMoney ( player thePlayer )</syntaxhighlight>  


===Required Arguments===  
===Required Arguments===  
*'''Player:''' Tells the function to give money to a player
*'''thePlayer:''' The player you wish the retrieve the amount of money from.


==Example==
===Returns===
<syntaxhighlight lang="lua">addEventHandler ( "onPlayerConsole", root, "onConsole" )
Returns an integer with the amount of money the player has, ''false'' if the player is invalid.
function onConsole ( message )
 
if gettok(message, 1, 32) == "!checkcash" then --when the player types !checkcash in the console
==Example==
local playermoney = getPlayerMoney ( source ) --set playermoney varible to player's current cash
When a player types '/checkMoney' this example retrieves the players money and outputs a message according to the value.
outputChatBox ( "Your cash: ".. playermoney ) --display their current cash in the chatbox
<syntaxhighlight lang="lua">
function checkMoney(player,command)
local money = getPlayerMoney(player) -- get the amount of money from the player who entered the command
if (money > 1000) then -- if money is more than 1000
outputChatBox("You are rich: "..tostring(money)) -- output this message together with the money
else
outputChatBox("Poor guy..") -- and else, output this message
end
end
end</syntaxhighlight>
end
addCommandHandler("checkMoney",checkMoney) -- adds the command
</syntaxhighlight>


==See Also==
==See Also==
{{Player functions}}
{{Player functions}}

Revision as of 12:13, 27 July 2007

Returns the amount of money a player currently has.

Syntax

int getPlayerMoney ( player thePlayer )

Required Arguments

  • thePlayer: The player you wish the retrieve the amount of money from.

Returns

Returns an integer with the amount of money the player has, false if the player is invalid.

Example

When a player types '/checkMoney' this example retrieves the players money and outputs a message according to the value.

function checkMoney(player,command)
	local money = getPlayerMoney(player) -- get the amount of money from the player who entered the command
	if (money > 1000) then -- if money is more than 1000
		outputChatBox("You are rich: "..tostring(money)) -- output this message together with the money
 	else
		outputChatBox("Poor guy..") -- and else, output this message
	end
end
addCommandHandler("checkMoney",checkMoney) -- adds the command

See Also