GetPlayerMoney: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(39 intermediate revisions by 16 users not shown)
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
{{Server function}}
{{Server client function}}
Returns the amount of money a player currently has.
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==  
==Syntax==  
<section show="true" name="Server" class="server">
<syntaxhighlight lang="lua">int getPlayerMoney ( player thePlayer )</syntaxhighlight>  
<syntaxhighlight lang="lua">int getPlayerMoney ( player thePlayer )</syntaxhighlight>  
 
{{OOP||[[player]]:getMoney|money|setPlayerMoney}}
===Required Arguments===  
===Required Arguments===  
*'''thePlayer:''' The player you wish the retrieve the amount of money from.
*'''thePlayer:''' The player you wish the retrieve the amount of money from.


===Returns===
===Returns===
Returns an integer with the amount of money the player has, ''false'' if the player is invalid.
Returns an integer with the amount of money the specified player has, ''false'' if the player is invalid.
</section>
 
<section show="true" name="Client" class="client">
<syntaxhighlight lang="lua">int getPlayerMoney ( )</syntaxhighlight>
{{OOP||[[Player]].getMoney||setPlayerMoney}}
===Returns===
Returns an integer with the amount of money the local player has.
</section>


==Example==
==Example==
When a player types '/checkMoney' this example retrieves the players money and outputs a message according to the value.
<section show="true" name="Server" class="server">
When a player types '/checkMoney' this example retrieves the player's money and outputs a message according to the value.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
function checkMoney(player,command)
function checkMoney(thePlayer, command)
local money = getPlayerMoney(player) -- get the amount of money from the player who entered the 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
if (money > 1000) then                                                 -- if money is more than 1000
outputChatBox("You are rich: "..tostring(money)) -- output this message together with the money
outputChatBox("You are rich: " .. tostring(money), thePlayer) -- output this message together with the money
  else
  else
outputChatBox("Poor guy..") -- and else, output this message
outputChatBox("Poor guy...", thePlayer)                       -- and else, output this message
end
end
end
end
addCommandHandler("checkMoney",checkMoney) -- adds the command
addCommandHandler("checkMoney", checkMoney)                                   -- add the console command
</syntaxhighlight>
</syntaxhighlight>
</section>


==See Also==
==See Also==
{{Player functions}}
{{Player functions}}
[[pt-br:getPlayerMoney]]
[[ru:getPlayerMoney]]
[[tr:getPlayerMoney]]

Latest revision as of 03:55, 11 August 2019

Returns the amount of money a player currently has.

[[{{{image}}}|link=|]] 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

Retrieved from "https://wiki.multitheftauto.com/wiki/GetPlayerMoney?oldid=63662"