GetPlayerNametagColor: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (Reverted edit of Ransom, changed back to last version by MrJax)
No edit summary
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
<!-- 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 fake function is for use with blah & blah and does blahblahblabhalbhl
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==  
==Syntax==  
Line 11: Line 11:
===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 -->
<!-- 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 -->
*'''argumentName:''' description
*'''thePlayer:''' The player whose name tag RGB color values you wish to retrieve.
 
<!-- Only include this section below if there are optional arguments -->
===Optional Arguments===
{{OptionalArg}}
*'''argumentName2:''' description
*'''argumentName3:''' description


===Returns===
===Returns===
<!-- Make this descriptive. Explain what cases will return false. If you're unsure, add a tag to it so we can check -->
<!-- Make this descriptive. Explain what cases will return false. If you're unsure, add a tag to it so we can check -->
Returns ''true'' if blah, ''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 -->
<!-- Explain what the example is in a single sentance -->
This example does...
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 -->
<!-- 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">
--This line does...
addCommandHandler ( "retrievetagcolor", "tagInfoCommand" )
blabhalbalhb --abababa
function tagInfoCommand ( player, commandName )
--This line does this...
--This function is activated by the text 'retrievetagcolor' in
mooo
--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
</syntaxhighlight>
</syntaxhighlight>


==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 -->
{{FunctionArea_functions}}
{{Player_functions}}
[[Category:Incomplete]] -- leave this unless you complete the function

Revision as of 09:12, 11 April 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. 

addCommandHandler ( "retrievetagcolor", "tagInfoCommand" )
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

See Also


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