SetPlayerMoney: Difference between revisions
Tag: Undo |
|||
(39 intermediate revisions by 25 users not shown) | |||
Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
Sets a player's money to a certain value | {{Server client function}} | ||
Sets a player's money to a certain value, regardless of current player money. It should be noted that setting negative values does not work and in fact gives the player large amounts of money. | |||
{{Note|Using this function client side (not recommended) will not change a players money server side.}} | |||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua">setPlayerMoney ( player, | <section name="Server" class="server" show="true"> | ||
<syntaxhighlight lang="lua"> | |||
bool setPlayerMoney ( player thePlayer, int amount [, bool instant = false ] ) </syntaxhighlight> | |||
{{OOP||[[player]]:setMoney|money|getPlayerMoney}} | |||
===Required Arguments=== | |||
*'''thePlayer:''' Which player to set the money of. | |||
*'''amount:''' A whole integer specifying the new amount of money the player will have. | |||
===Optional Arguments=== | |||
{{OptionalArg}} | |||
{{New items|3.0140|1.4| | |||
*'''instant:''' If set to ''true'' money will be set instantly without counting up/down like in singleplayer.}} | |||
</section> | |||
<section name="Client" class="client" show="true"> | |||
<syntaxhighlight lang="lua"> | |||
bool setPlayerMoney ( int amount [, bool instant = false ] ) </syntaxhighlight> | |||
{{OOP||[[Player]].setMoney||getPlayerMoney}} | |||
===Required Arguments=== | ===Required Arguments=== | ||
*''' | *'''amount:''' A whole integer specifying the new amount of money the local player will have. | ||
*''' | |||
===Optional Arguments=== | |||
{{OptionalArg}} | |||
{{New items|3.0140|1.4| | |||
*'''instant:''' If set to ''true'' money will be set instantly without counting up/down like in singleplayer.}} | |||
</section> | |||
===Returns=== | |||
Returns ''true'' if the money was added, or ''false'' if invalid parameters were passed. | |||
==Example== | ==Example== | ||
'''Example 1:''' This example sets the player's money to the desired amount when he types "setcash" in console. | |||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
function | function setCash(thePlayer, command, amount) -- when the setcash function is called | ||
setPlayerMoney(thePlayer, tonumber(amount)) -- change player's money to the desired amount | |||
end | |||
addCommandHandler("setcash", setCash) -- add a command handler for setcash | |||
</syntaxhighlight> | |||
'''Example 2:''' This sets all players the amount of 1337 money when "leet" is typed in console. | |||
<syntaxhighlight lang="lua"> | |||
function leetmoney() | |||
setPlayerMoney(root, 1337) | |||
end | |||
addCommandHandler("leet", leetmoney) | |||
</syntaxhighlight> | |||
==See Also== | |||
{{Player functions}} | |||
[[pt-br:SetPlayerMoney]] | |||
[[ru:setPlayerMoney]] |
Latest revision as of 10:26, 29 June 2022
Sets a player's money to a certain value, regardless of current player money. It should be noted that setting negative values does not work and in fact gives the player large amounts of money.
Note: Using this function client side (not recommended) will not change a players money server side. |
Syntax
bool setPlayerMoney ( player thePlayer, int amount [, bool instant = false ] )
OOP Syntax Help! I don't understand this!
- Method: player:setMoney(...)
- Variable: .money
- Counterpart: getPlayerMoney
Required Arguments
- thePlayer: Which player to set the money of.
- amount: A whole integer specifying the new amount of money the player will have.
Optional Arguments
NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use. For more information on optional arguments, see optional arguments.
- instant: If set to true money will be set instantly without counting up/down like in singleplayer.
bool setPlayerMoney ( int amount [, bool instant = false ] )
OOP Syntax Help! I don't understand this!
- Method: Player.setMoney(...)
- Counterpart: getPlayerMoney
Required Arguments
- amount: A whole integer specifying the new amount of money the local player will have.
Optional Arguments
NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use. For more information on optional arguments, see optional arguments.
- instant: If set to true money will be set instantly without counting up/down like in singleplayer.
Returns
Returns true if the money was added, or false if invalid parameters were passed.
Example
Example 1: This example sets the player's money to the desired amount when he types "setcash" in console.
function setCash(thePlayer, command, amount) -- when the setcash function is called setPlayerMoney(thePlayer, tonumber(amount)) -- change player's money to the desired amount end addCommandHandler("setcash", setCash) -- add a command handler for setcash
Example 2: This sets all players the amount of 1337 money when "leet" is typed in console.
function leetmoney() setPlayerMoney(root, 1337) end addCommandHandler("leet", leetmoney)
See Also
- getAlivePlayers
- getDeadPlayers
- getPlayerACInfo
- getPlayerAnnounceValue
- getPlayerCount
- getPlayerIdleTime
- getPlayerIP
- getPlayerScriptDebugLevel
- getPlayerVersion
- getRandomPlayer
- isPlayerMuted
- redirectPlayer
- resendPlayerACInfo
- resendPlayerModInfo
- setPlayerAnnounceValue
- setPlayerMuted
- setPlayerScriptDebugLevel
- setPlayerTeam
- setPlayerVoiceBroadcastTo
- setPlayerVoiceIgnoreFrom
- setPlayerWantedLevel
- spawnPlayer
- takePlayerScreenShot
Shared
- getPlayerTeam
- getPlayerBlurLevel
- setPlayerBlurLevel
- getPlayerSerial
- forcePlayerMap
- getPlayerFromName
- getPlayerMoney
- getPlayerName
- getPlayerNametagColor
- getPlayerNametagText
- getPlayerPing
- getPlayerWantedLevel
- givePlayerMoney
- isPlayerMapForced
- isPlayerNametagShowing
- setPlayerHudComponentVisible
- setPlayerMoney
- setPlayerNametagColor
- setPlayerNametagShowing
- setPlayerNametagText
- takePlayerMoney
- countPlayersInTeam
- getPlayersInTeam
- isVoiceEnabled
- setControlState
- getControlState