SetPlayerNametagColor: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
Line 6: Line 6:
==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 -->
<!-- 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 -->
{{Deprecated feature|2|DP2|
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool setPlayerNametagColor ( player thePlayer, int r, int g, int b )
bool setPlayerNametagColor ( player thePlayer, int r, int g, int b )
</syntaxhighlight>  
</syntaxhighlight>  
}}


{{New feature|2|DP2|
{{New feature|2|DP2|

Revision as of 04:10, 5 January 2008

This allows you to change the RGB color mixture in the name tags of players.

Syntax

bool setPlayerNametagColor ( player thePlayer, int r, int g, int b )

bool setPlayerNametagColor ( player thePlayer, false )

Required Arguments

  • thePlayer: The player whose name tag text you wish to change the color of
  • r: The amount of red you want in the mixture of RGB (0-255 is valid)
  • g: The amount of green you want in the mixture of RGB (0-255 is valid)
  • b: The amount of blue you want in the mixture of RGB (0-255 is valid)
  • false: If false is specified instead of the colors, the nametag color will reset to defaulting to your team color.

Returns

Returns true if the function was successful, false otherwise.

Example

This will allow a player to change the RGB color mixture of their nickname. Valid RGB is between 0-255. 

-- The handler function for the console command
function nametagColorChange ( thePlayer, commandName, r, g, b )
    -- Apply the new color mix of RGB to the command handler activator
    setPlayerNametagColor ( thePlayer, r, g, b )
end
-- This is a command handler that activates on text "nametagcolor" in the console. It also asks 
-- the player to provide values for the extra parameters r, g, b after the command name. These will 
-- be the new color mix of RGB to apply to the player's name tag.
addCommandHandler ( "nametagcolor", nametagColorChange )

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/SetPlayerNametagColor?oldid=14500"