GetPlayerNametagColor: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
mNo edit summary
 
(12 intermediate revisions by 7 users not shown)
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
{{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 fake function is for use with blah & blah and does blahblahblabhalbhl
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.
*'''argumentName:''' description
 
<!-- 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 -->
Returns ''red'', ''green'' and ''blue'' values if an existent player was specified, ''false'' otherwise.
Returns ''true'' if blah, ''false'' otherwise.


==Example==  
==Example==  
<!-- Explain what the example is in a single sentance -->
<section name="Server" class="server" show="true">
This example does...
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">
--This line does...
function tagInfoCommand ( thePlayer, commandName )
blabhalbalhb --abababa
-- store the RGB data about the player who activated the command handler into the local variables r, g, b.  
--This line does this...
local r, g, b = getPlayerNametagColor ( thePlayer )
mooo
-- Display the RGB values in the chatbox
outputChatBox ( "Your tag color is: R:" .. r .. " G:" .. g .. " B:" .. b, thePlayer )
end
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 -->
{{FunctionArea_functions}}
{{Player_functions}}
[[Category:Incomplete]] -- leave this unless you complete the function

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"