GetPlayerNametagColor: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
mNo edit summary
 
Line 16: Line 16:


==Example==  
==Example==  
<section name="Server" class="server" show="true">
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 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.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
Line 26: Line 27:
addCommandHandler ( "retrievetagcolor", tagInfoCommand )
addCommandHandler ( "retrievetagcolor", tagInfoCommand )
</syntaxhighlight>
</syntaxhighlight>
</section>


==See Also==
==See Also==
<!-- Change FunctionArea to the area that this function is in on the main function list page, e.g. Server, Player, Vehicle etc -->
<!-- Change FunctionArea to the area that this function is in on the main function list page, e.g. Server, Player, Vehicle etc -->
{{Player_functions}}
{{Player_functions}}

Latest revision as of 00:59, 13 November 2015

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 )

OOP Syntax Help! I don't understand this!

Method: player:getNametagColor(...)
Counterpart: setPlayerNametagColor


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

Click to collapse [-]
Server

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