GetPlayerNametagColor: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 15: Line 15:
===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 ''red'', ''green'' and ''blue'' values if an existant target player was specified, values return ''false'' otherwise.
Returns ''red'', ''green'' and ''blue'' values of the target player


==Example==  
==Example==  

Revision as of 09:10, 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 of the target player

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=7818"