Last modified 4 years ago Last modified on 08/25/08 08:41:13

These represent variables that are defined in the game which can be accessed in the scripts. It will only be possible to set the value that is held for some of the variables. Every variable can be get and set, if not noted otherwise.

; mapWidth

Width of the map. Cannot be set.

; mapHeight

Height of the map. Cannot be set.

; gameInitialised

Flag to specify whether all initialisation for the game has been performed. Use it in place of a bool i. e. can be considered to equal true or false. Cannot be set.

; selectedPlayer

Field to hold the currently selected player. Cannot be set

; gameTime

Holds the current time in the game (in 1/10 s). Cannot be set

; multiPlayerGameType

Holds the multiplayer game type. Cannot be set

; multiPlayerMaxPlayers

Maximum number of human players in this game. Cannot be set.

; multiPlayerBaseType

Campaign game base type (see multiplayer base configurations ?).

; multiPlayerAlliancesType

Get alliance type (see multiplayer alliance types ?).

; scrollX

Holds the starting x coordinate where the player can scroll.

; scrollY

Holds the starting y coordinate where the player can scroll.

; scrollWidth

Holds the width the player can scroll.

; scrollHeight

Holds the height the player can scroll.

; cursorType

Gets the current mode that the cursor is in (see cursor modes ?). Cannot be set.

; intMode

Get the current game mode (e.g. int_DESIGN when the design screen is active), see game modes ?. Cannot be set.

; targetedObjectType

Get the type of the object currently under the cursor (see values for targetedObjectType ?). Cannot be set.

; boolextraVictoryFlag

Use to mark additional victory conditions have been met; reset to FALSE at start of each level.

; boolextraFailFlag

Use to mark additional failure conditions have been met; reset to FALSE at start of each level.

; GameLevel

Single player difficulty.

{{Scripting manual}} Category:Scripting manual ?