GetPlayerNametagColor: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
mNo edit summary
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
{{Server function}}
{{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 function gets the current color of a player's name tag as RGB values. These are in the range 0-255.
This function gets the current color of a player's name tag as RGB values. These are in the range 0-255.

Revision as of 00:37, 24 July 2009

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