getPlayerNametagColor | Multi Theft Auto: Wiki Skip to content
Multi Theft Auto: Wiki

getPlayerNametagColor

Client-side
Server-side
Shared

Pair: setPlayerNametagColor

Manual Review Required

Please finish this page using the corresponding Old Wiki article. Go to Contribution guidelines for more information.

This function gets the current color of a player's name tag as RGB values. These are in the range 0-255.

OOP Syntax Help! I don't understand this!

  • Method:player:getNametagColor(...)

Syntax 

int,​ int,​ int getPlayerNametagColor ( player thePlayer )
Required Arguments
  • thePlayer: The player whose name tag RGB color values you wish to retrieve.

Returns

  • int: value1
  • int: value2
  • int: value3

Returns red , green and blue values if an existent player was specified, false otherwise.

Code Examples

shared

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 )
  -- 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

Player Functions
Player Events
Reference