Variables

difficulty:Float

[HostOnly] The difficulty of the game. 0 is Easy, then each difficulty level increment by 1. Can vary with decimals. Use getSelectedDifficulty() to get the difficulty chosen by the player.

read onlyevents:Events

The events manager.

See also:

  • Events

read onlyobjectives:ScriptObjectives

[Deprecated] Interface to setup objectives visible in the UI.

read onlyplayers:NetArray<Player>

The list of players participating in the game. Include the current player. Defeated players get removed from it.

scriptDesc:String

Custom description to be displayed in the Mod Window from the Victory Condition screen. Allow the use of some Html markups : : Change the current font. Support the following parameter :

	- face : use a different font. override bold or italic. See FontKind for the list of fonts.
	- color : change the text color, use Html hexadecimal. (e.g. #FF0000 for red)
	- opacity : change the font opacity, from 0. (transparent) to 1. (opaque)
or : set a font for bold text. or : set a font for italic text.
: new line

: define a paragraph. Support the following parameters : - align : text alignment, options are "left", "center", "right", "multiline-center", "multiline-right";

scriptProps:Dynamic

[HostOnly] Use this to save data

read onlystartPlayers:NetArray<Player>

The list of players participating from the start of the game. Doesn't change even on a player's defeat.

time:Float

[HostOnly] The current time of the game in seconds, represented in the calendar. An ingame month is 60 seconds, a whole year is 720 seconds. Time 0 is the beginning of March, just after winter.

read onlyzones:NetArray<Zone>

The list of all the zones composing the map, including high sea zones

Methods

addVictory(kind:VictoryKind):Void

[HostOnly] Allow a VictoryKind.

Parameters:

null

kind

isVictoryAllowed(kind:VictoryKind):Bool

Check if we allowed a victory kind

Parameters:

kind

Returns:

Bool

removeVictory(kind:VictoryKind):Void

[HostOnly] Forbid a VictoryKind.

Parameters:

null

kind