GetPlayerNametagColor: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
mNo edit summary
 
(6 intermediate revisions by 5 users not shown)
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 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 function gets the current color of a player's name tag as RGB values. These are in the range 0-255.


==Syntax==  
==Syntax==  
<!-- NOTE: don't use 'special' names for variable names, e.g. you shouldn't be writing things like 'player player, vehicle vehicle', instead write something like 'player thePlayer, vehicle vehicleToGetInto'. This is less confusing and prevents the syntax highlighting being odd -->
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
int int int getPlayerNametagColor ( player thePlayer )
int, int, int getPlayerNametagColor ( player thePlayer )
</syntaxhighlight>  
</syntaxhighlight>  
 
{{OOP||[[player]]:getNametagColor||setPlayerNametagColor}}
===Required Arguments===  
===Required Arguments===  
<!-- List each argument one per line. This should be the argument's name as in the argument list above, NOT the argument's data type -->
*'''thePlayer:''' The player whose name tag RGB color values you wish to retrieve.
*'''thePlayer:''' The player whose name tag RGB color values you wish to retrieve.


===Returns===
===Returns===
<!-- Make this descriptive. Explain what cases will return false. If you're unsure, add a tag to it so we can check -->
Returns ''red'', ''green'' and ''blue'' values if an existent player was specified, ''false'' otherwise.
Returns ''red'', ''green'' and ''blue'' values if an existant target player was specified, values return ''false'' otherwise.


==Example==  
==Example==  
<!-- Explain what the example is in a single sentance -->
<section name="Server" class="server" show="true">
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.
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.
<!-- Add the code below, an emphasis should be on making it clear, not optimized. You could provide two versions if you wish, one clear and well commented, the other optimized -->
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
function tagInfoCommand ( player, 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 ( player )
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 ( "TAG COLOR = R:"..r.." G:"..g.." B:"..b )
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 )
</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


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