GetPlayerNametagColor: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 19: Line 19:
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
function tagInfoCommand ( thePlayer, commandName )
function tagInfoCommand ( thePlayer, commandName )
-- This function is activated by the text 'retrievetagcolor' in the console.
-- 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 )
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.
-- Display the RGB values in the chatbox
outputChatBox ( "Your tag color is: R:" .. r .. " G:" .. g .. " B:" .. b, thePlayer )
outputChatBox ( "Your tag color is: R:" .. r .. " G:" .. g .. " B:" .. b, thePlayer )
-- 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 )
	-- 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


Retrieved from "https://wiki.multitheftauto.com/wiki/GetPlayerNametagColor?oldid=10696"