GetPlayerMoney: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Undo revision 59047 by Lizzalka (talk))
m (The return value in the server block was inconsistent with almost any other page on the wiki (and even the client block on the same page))
Line 7: Line 7:
==Syntax==  
==Syntax==  
<section show="true" name="Server" class="server">
<section show="true" name="Server" class="server">
<syntaxhighlight lang="lua">int/bool getPlayerMoney ( player thePlayer )</syntaxhighlight>  
<syntaxhighlight lang="lua">int getPlayerMoney ( player thePlayer )</syntaxhighlight>  
{{OOP||[[player]]:getMoney|money|setPlayerMoney}}
{{OOP||[[player]]:getMoney|money|setPlayerMoney}}
===Required Arguments===  
===Required Arguments===  

Revision as of 09:00, 8 March 2019

Returns the amount of money a player currently has.

Note: The amount may vary between the server and client, you shouldn't trust the client side value to always be accurate.

Syntax

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

OOP Syntax Help! I don't understand this!

Method: player:getMoney(...)
Variable: .money
Counterpart: setPlayerMoney


Required Arguments

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

Returns

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

Click to collapse [-]
Client
int getPlayerMoney ( )

OOP Syntax Help! I don't understand this!

Method: Player.getMoney(...)
Counterpart: setPlayerMoney


Returns

Returns an integer with the amount of money the local player has.

Example

Click to collapse [-]
Server

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

function checkMoney(thePlayer, command)
	local money = getPlayerMoney(thePlayer)                                -- 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), thePlayer)  -- output this message together with the money
 	else
		outputChatBox("Poor guy...", thePlayer)                        -- and else, output this message
	end
end
addCommandHandler("checkMoney", checkMoney)                                    -- add the console command

See Also