SetPlayerNametagColor

From Multi Theft Auto: Wiki
Revision as of 01:42, 3 September 2012 by Ransom (talk | contribs) (Note about hexcodes in player tags overriding this function)

This template is no longer in use as it results in poor readability.


Dialog-information.png This article needs checking.

Reason(s): See the note. There should probably be a useful function to do this instead of everyone trying to re-invent the wheel when they need to force nick colors ie TDM/gangwars. If someone makes a useful function, link it in the note.

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 )

OR

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

BETA: FROM VERSION 1.5.7 r19626 ONWARDS
BETA: FROM VERSION 1.5.7 r19626 ONWARDS