GetPlayerNametagColor: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
mNo edit summary |
||
(8 intermediate revisions by 6 users not shown) | |||
Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Server client function}} | |||
<!-- Describe in plain english what this function does. Don't go into details, just give an overview --> | <!-- Describe in plain english what this function does. Don't go into details, just give an overview --> | ||
This | This function gets the current color of a player's name tag as RGB values. These are in the range 0-255. | ||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
int int int getPlayerNametagColor ( player thePlayer ) | int, int, int getPlayerNametagColor ( player thePlayer ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
{{OOP||[[player]]:getNametagColor||setPlayerNametagColor}} | |||
===Required Arguments=== | ===Required Arguments=== | ||
*'''thePlayer:''' The player whose name tag RGB color values you wish to retrieve. | *'''thePlayer:''' The player whose name tag RGB color values you wish to retrieve. | ||
===Returns=== | ===Returns=== | ||
Returns ''red'', ''green'' and ''blue'' values if an existent player was specified, ''false'' otherwise. | |||
Returns ''red'', ''green'' and ''blue'' values if an | |||
==Example== | ==Example== | ||
< | <section name="Server" class="server" show="true"> | ||
This will tell the player what his tag color is. | This console command will tell the player what his tag color is. The color is composed of a red, a green and a blue component, each ranging from 0-255. | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
function tagInfoCommand ( thePlayer, commandName ) | |||
function tagInfoCommand ( | -- store the RGB data about the player who activated the command handler into the local variables r, g, b. | ||
-- | local r, g, b = getPlayerNametagColor ( thePlayer ) | ||
-- Display the RGB values in the chatbox | |||
local r, g, b = getPlayerNametagColor ( | outputChatBox ( "Your tag color is: R:" .. r .. " G:" .. g .. " B:" .. b, thePlayer ) | ||
-- | |||
outputChatBox ( " | |||
end | end | ||
addCommandHandler ( "retrievetagcolor", tagInfoCommand ) | |||
</syntaxhighlight> | </syntaxhighlight> | ||
</section> | |||
==See Also== | ==See Also== | ||
<!-- Change FunctionArea to the area that this function is in on the main function list page, e.g. Server, Player, Vehicle etc --> | <!-- Change FunctionArea to the area that this function is in on the main function list page, e.g. Server, Player, Vehicle etc --> | ||
{{Player_functions}} | {{Player_functions}} |
Latest revision as of 00:59, 13 November 2015
This function gets the current color of a player's name tag as RGB values. These are in the range 0-255.
Syntax
int, int, int getPlayerNametagColor ( player thePlayer )
OOP Syntax Help! I don't understand this!
- Method: player:getNametagColor(...)
- Counterpart: setPlayerNametagColor
Required Arguments
- thePlayer: The player whose name tag RGB color values you wish to retrieve.
Returns
Returns red, green and blue values if an existent player was specified, false otherwise.
Example
Click to collapse [-]
ServerThis console command will tell the player what his tag color is. The color is composed of a red, a green and a blue component, each ranging from 0-255.
function tagInfoCommand ( thePlayer, commandName ) -- store the RGB data about the player who activated the command handler into the local variables r, g, b. local r, g, b = getPlayerNametagColor ( thePlayer ) -- Display the RGB values in the chatbox outputChatBox ( "Your tag color is: R:" .. r .. " G:" .. g .. " B:" .. b, thePlayer ) end addCommandHandler ( "retrievetagcolor", tagInfoCommand )
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