GetPlayerNametagColor: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
{{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 will allow you to get the current color of a player's tag. These are stored in RGB, a color mixture of 3 colors. The valid values for RGB are 0-255.
This will allow you to get the current color of a player's tag. These are stored in RGB, a color mixture of 3 colors. The valid values for RGB are 0-255.

Revision as of 11:30, 7 August 2007

This will allow you to get the current color of a player's tag. These are stored in RGB, a color mixture of 3 colors. The valid values for RGB are 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 existant target player was specified, values return false otherwise.

Example

This will tell the player what his tag color is. This color is made by an RGB color value mixture, which all range from 0-255.

function tagInfoCommand ( player, commandName )
	--This function is activated by the text 'retrievetagcolor' in the console.
	local r, g, b = getPlayerNametagColor ( player )
	--store the RGB data about the player who activated the command handler into the local varibles r, g, b. 
	outputChatBox ( "TAG COLOR = R:"..r.." G:"..g.." B:"..b )
	--Display the RGB color mixutre in the chatbox
end
addCommandHandler ( "retrievetagcolor", tagInfoCommand )

See Also