setTutorialMode()

Toggles "tutorial mode" in a single-player game...

Syntax

setTutorialMode(active);

Parameters

Parameter	Type	Mandatory	Notes	Game version

Parameter

Type

Mandatory

Notes

Game version

active

Boolean

Make tutorial mode active?

true – yes, tutorial mode is active
false – no, the game is in normal mode

3.1 Beta 1

Return value

Value	Type	Description	Game version

Value	Type	Description	Game version
`undefined`	Undefined	The function always returns `undefined`	3.1 Beta 1

Notes

Tutorial mode is mainly designed for use in the Tutorial map, or as cybersphinx describes it: "It makes the game annoying. Disables saving, enables toggling the reticule buttons..."

Examples

Removing a reticule button

setTutorialMode(false); // turn off tutorial mode
removeReticuleButton(DESIGN); // has no effect because tutorial mode is switched off
 
setTutorialMode(true); // activate tutorial mode
removeReticuleButton(DESIGN); // Design reticule button is removed successfully