SetPlayerNametagColor: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
|||
Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Server 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 allows you to change the RGB color mixture in the name tags of players. | This allows you to change the RGB color mixture in the name tags of players. | ||
Line 26: | Line 27: | ||
<!-- 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"> | ||
-- The handler function for the console command | |||
function | function nametagColorChange ( thePlayer, commandName, r, g, b ) | ||
-- | -- Apply the new color mix of RGB to the command handler activator | ||
setPlayerNametagColor ( thePlayer, r, g, b ) | |||
setPlayerNametagColor ( | |||
end | 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 ) | |||
</syntaxhighlight> | </syntaxhighlight> | ||
Revision as of 21:36, 15 August 2007
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 )
Required Arguments
thePlayer, int r, int g, int b
- 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)
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
- getAlivePlayers
- getDeadPlayers
- getPlayerACInfo
- getPlayerAnnounceValue
- getPlayerCount
- getPlayerIdleTime
- getPlayerIP
- getPlayerScriptDebugLevel
- getPlayerVersion
- getRandomPlayer
- isPlayerMuted
- redirectPlayer
- resendPlayerACInfo
- resendPlayerModInfo
- setPlayerAnnounceValue
- setPlayerMuted
- setPlayerScriptDebugLevel
- setPlayerTeam
- setPlayerVoiceBroadcastTo
- setPlayerVoiceIgnoreFrom
- setPlayerWantedLevel
- spawnPlayer
- takePlayerScreenShot
Shared
- getPlayerTeam
- getPlayerBlurLevel
- setPlayerBlurLevel
- getPlayerSerial
- forcePlayerMap
- getPlayerFromName
- getPlayerMoney
- getPlayerName
- getPlayerNametagColor
- getPlayerNametagText
- getPlayerPing
- getPlayerWantedLevel
- givePlayerMoney
- isPlayerMapForced
- isPlayerNametagShowing
- setPlayerHudComponentVisible
- setPlayerMoney
- setPlayerNametagColor
- setPlayerNametagShowing
- setPlayerNametagText
- takePlayerMoney
- countPlayersInTeam
- getPlayersInTeam
- isVoiceEnabled
- setControlState
- getControlState