Gettok: Difference between revisions

Revision as of 19:59, 18 November 2006

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

Syntax

returnType gettok ( string text, int tokennumber, int seperating character )

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: @@
-#REDIRECT [[split]]
+__NOTOC__
+<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->
+This fake function is for use with blah & blah and does blahblahblabhalbhl
+==Syntax==
+<!-- NOTE: don't use 'special' names for variable names, e.g. you shouldn't be writing things like 'player player, vehicle vehicle', instead write something like 'player thePlayer, vehicle vehicleToGetInto'. This is less confusing and prevents the syntax highlighting being odd -->
+<syntaxhighlight lang="lua">
+returnType gettok ( string text, int tokennumber, int seperating character )
+</syntaxhighlight>
+===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 -->
+*'''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 ''true'' if blah, ''false'' otherwise.
+==Example==
+<!-- Explain what the example is in a single sentance -->
+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">
+--This line does...
+blabhalbalhb --abababa
+--This line does this...
+mooo
+</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 -->
+{{FunctionArea_functions}}
+[[Category:Incomplete]]