GetPlayerNametagColor: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
Line 2: | Line 2: | ||
{{Server function}} | {{Server 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 ) | ||
Line 11: | Line 10: | ||
===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== | ||
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. | |||
This will tell the player what his tag color is. | |||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
function tagInfoCommand ( | function tagInfoCommand ( thePlayer, commandName ) | ||
--This function is activated by the text 'retrievetagcolor' in the console. | -- This function is activated by the text 'retrievetagcolor' in the console. | ||
local r, g, b = getPlayerNametagColor ( | local r, g, b = getPlayerNametagColor ( thePlayer ) | ||
--store the RGB data about the player who activated the command handler into the local varibles r, g, b. | -- store the RGB data about the player who activated the command handler into the local varibles r, g, b. | ||
outputChatBox ( " | outputChatBox ( "Your tag color is: R:" .. r .. " G:" .. g .. " B:" .. b, thePlayer ) | ||
--Display the RGB color mixutre in the chatbox | -- Display the RGB color mixutre in the chatbox | ||
end | end | ||
addCommandHandler ( "retrievetagcolor", tagInfoCommand ) | addCommandHandler ( "retrievetagcolor", tagInfoCommand ) |
Revision as of 14:33, 19 August 2007
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 )
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
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.
function tagInfoCommand ( thePlayer, commandName ) -- This function is activated by the text 'retrievetagcolor' in the console. local r, g, b = getPlayerNametagColor ( thePlayer ) -- store the RGB data about the player who activated the command handler into the local varibles r, g, b. outputChatBox ( "Your tag color is: R:" .. r .. " G:" .. g .. " B:" .. b, thePlayer ) -- Display the RGB color mixutre in the chatbox 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