GetPlayerNametagColor: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 2: Line 2:
{{Server function}}
{{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 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 )
Line 11: Line 10:


===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 -->
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 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.
<!-- 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.
-- This function is activated by the text 'retrievetagcolor' in the console.
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.  
-- 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 )
outputChatBox ( "Your tag color is: R:" .. r .. " G:" .. g .. " B:" .. b, thePlayer )
--Display the RGB color mixutre in the chatbox
-- 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 )
	-- This function is activated by the text 'retrievetagcolor' in the console.
	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. 
	outputChatBox ( "Your tag color is: R:" .. r .. " G:" .. g .. " B:" .. b, thePlayer )
	-- Display the RGB color mixutre in the chatbox
end
addCommandHandler ( "retrievetagcolor", tagInfoCommand )

See Also


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