SetClientName: Difference between revisions

Revision as of 17:55, 19 November 2006

This function sets the name of the specified client.

bool setClientName ( client theClient , string name )

Returns true if the client's name was changed succesfully, false if invalid arguments are specified.

This example does...

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

@@ Line 2: / Line 2: @@
 __NOTOC__
-This fake function is for use with blah & blah and does blahblahblabhalbhl
+This function sets the name of the specified client.
 ==Syntax==
 <syntaxhighlight lang="lua">
-Insert syntax here
+bool setClientName ( client theClient , string name )
 </syntaxhighlight>
 ===Required Arguments===
-*'''argumentName:''' description
+*'''theClient:''' The client that will have it's name set
+*'''name:''' The name to set for the client
-===Optional Arguments===
-{{OptionalArg}}
-*'''argumentName2:''' descriptiona
-*'''argumentName3:''' description
 ===Returns===
-Returns ''true'' if blah, ''false'' otherwise.
+Returns ''true'' if the client's name was changed succesfully, ''false'' if invalid arguments are specified.
 ==Example==