Function syntax

From GECK

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

(return value) [reference].function arguments

Return value

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

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

The actual function.

Arguments

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

Return values, references and arguments can have name prefixed to their type, with a colon (:) separating them. See RemoveItem for an example.

See Also

Personal tools