Difference between revisions of "Function syntax"
imported>Qazaaq (starting this) |
imported>Cipscis (Italicised "reference" to match current function syntax and added information about how parameter values are displayed) |
||
| Line 2: | Line 2: | ||
==Syntax== | ==Syntax== | ||
(return value) reference.function arguments | (return value) ''[reference]''.function arguments | ||
===Return value=== | ===Return value=== | ||
| Line 18: | Line 18: | ||
===Arguments=== | ===Arguments=== | ||
Arguments are additional information for a function. Some are required, others are optional. All optional arguments are in italics. | Arguments are additional information for a function. Some are required, others are optional. All optional arguments are in italics. | ||
If an argument can only accept certain values, they will be displayed after the variable in curly brackets. If the argument has a default value, it may also be displayed in this way. | |||
===Names and types=== | ===Names and types=== | ||
Latest revision as of 15:45, 5 December 2010
| This article is incomplete. You can help by filling in any blank descriptions. Further information might be found in a section of the discussion page. Please remove this message when no longer necessary. |
Syntax[edit | edit source]
(return value) [reference].function arguments
Return value[edit | edit source]
The return value is a value returned by the function after it has finished with its operations. Return values can be stored in a variable for later use, see the example below.
float time set time to GetCurrentTime
Reference[edit | edit source]
A reference is an instance of an object in the game world. Certain functions can only be executed upon references. A period (.) is used to connect the function to the reference it is executed on.
Function[edit | edit source]
The actual function.
Arguments[edit | edit source]
Arguments are additional information for a function. Some are required, others are optional. All optional arguments are in italics.
If an argument can only accept certain values, they will be displayed after the variable in curly brackets. If the argument has a default value, it may also be displayed in this way.
Names and types[edit | edit source]
Return values, references and arguments can have name prefixed to their type, with a colon (:) separating them. See RemoveItem for an example.