SetPlayerNametagColor: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
<!-- 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 | This allows you to change the RGB color mixture in the name tags of players. | ||
==Syntax== | ==Syntax== | ||
| Line 11: | Line 11: | ||
===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 --> | <!-- 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, 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=== | ||
<!-- 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 ''true'' if | Returns ''true'' if the function was successful, ''false'' otherwise. | ||
==Example== | ==Example== | ||
<!-- Explain what the example is in a single sentance --> | <!-- Explain what the example is in a single sentance --> | ||
This | This will allow a player to change the RGB color mixture of their nickname. Valid RGB is between 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 --> | <!-- 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 | addCommandHandler ( "nametagcolor", "nametagcolorchange" ) | ||
function nametagcolorchange ( player, commandName, r, g, b ) | |||
-- | --This is a command handler that activates on text "nametagcolor". It also asks that the player | ||
--provide the r, g, b values after the command name. These will be the new color mix of RGB to | |||
--apply to the player's name tag. | |||
setPlayerNametagColor ( player, r, g, b ) | |||
--Apply the new color mix of RGB to the command handler activator | |||
end | |||
</syntaxhighlight> | </syntaxhighlight> | ||
==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 --> | ||
{{ | {{Player_functions}} | ||
[[Category:Incomplete]] -- leave this unless you complete the function | [[Category:Incomplete]] -- leave this unless you complete the function | ||
Revision as of 07:34, 11 April 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.
addCommandHandler ( "nametagcolor", "nametagcolorchange" ) function nametagcolorchange ( player, commandName, r, g, b ) --This is a command handler that activates on text "nametagcolor". It also asks that the player --provide the r, g, b values after the command name. These will be the new color mix of RGB to --apply to the player's name tag. setPlayerNametagColor ( player, r, g, b ) --Apply the new color mix of RGB to the command handler activator end
See Also
- forcePlayerMap
- getAlivePlayers
- getDeadPlayers
- getPlayerACInfo
- getPlayerAnnounceValue
- getPlayerBlurLevel
- getPlayerCount
- getPlayerFromName
- getPlayerIdleTime
- getPlayerIP
- getPlayerMoney
- getPlayerName
- getPlayerNametagColor
- getPlayerNametagText
- getPlayerPing
- getPlayerScriptDebugLevel
- getPlayerSerial
- getPlayerTeam
- getPlayerVersion
- getPlayerWantedLevel
- getRandomPlayer
- givePlayerMoney
- isPlayerMapForced
- isPlayerMuted
- isPlayerNametagShowing
- isVoiceEnabled
- redirectPlayer
- resendPlayerACInfo
- resendPlayerModInfo
- setPlayerAnnounceValue
- setPlayerBlurLevel
- setPlayerHudComponentVisible
- setPlayerMoney
- setPlayerMuted
- setPlayerName
- setPlayerNametagColor
- setPlayerNametagShowing
- setPlayerNametagText
- setPlayerScriptDebugLevel
- setPlayerTeam
- setPlayerVoiceBroadcastTo
- setPlayerVoiceIgnoreFrom
- setPlayerWantedLevel
- spawnPlayer
- takePlayerMoney
- takePlayerScreenShot
-- leave this unless you complete the function