GetPlayerNametagColor: Difference between revisions

Revision as of 09:11, 11 April 2007

This fake function is for use with blah & blah and does blahblahblabhalbhl

Syntax

int int int getPlayerNametagColor ( player thePlayer )

Required Arguments

argumentName: description

Optional Arguments

NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use. For more information on optional arguments, see optional arguments.

argumentName2: description
argumentName3: description

Returns

Returns true if blah, false otherwise.

Example

This example does...

--This line does...
blabhalbalhb --abababa
--This line does this...
mooo

@@ Line 1: / Line 1: @@
 __NOTOC__
 <!-- Describe in plain english what this function does. Don't go into details, just give an overview -->
-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.
+This fake function is for use with blah & blah and does blahblahblabhalbhl
 ==Syntax==
@@ Line 11: / Line 11: @@
 ===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 -->
-*'''thePlayer:''' The player whose name tag RGB color values you wish to retrieve.
+*'''argumentName:''' description
+<!-- Only include this section below if there are optional arguments -->
+===Optional Arguments===
+{{OptionalArg}}
+*'''argumentName2:''' description
+*'''argumentName3:''' description
 ===Returns===
 <!-- 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 of the target player
+Returns ''true'' if blah, ''false'' otherwise.
 ==Example==
 <!-- Explain what the example is in a single sentance -->
-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.
+This example does...
 <!-- 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">
-addCommandHandler ( "retrievetagcolor", "tagInfoCommand" )
+--This line does...
-function tagInfoCommand ( player, commandName )
+blabhalbalhb --abababa
---This function is activated by the text 'retrievetagcolor' in
+--This line does this...
---the console.
+mooo
-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
 </syntaxhighlight>
 ==See Also==
 <!-- Change FunctionArea to the area that this function is in on the main function list page, e.g. Server, Player, Vehicle etc -->
-{{Player_functions}}
+{{FunctionArea_functions}}
+[[Category:Incomplete]] -- leave this unless you complete the function