Other great resources: Official JS API docs, Scripting Forum
setTutorialMode()
- Aubergine
Owned by Aubergine
Toggles "tutorial mode" in a single-player game...
Â
Syntax
setTutorialMode(active);
Parameters
Parameter | Type | Mandatory | Notes | Game version |
---|---|---|---|---|
active | Boolean | Make tutorial mode active?
| 3.1 Beta 1 |
Return value
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
Availability 3.1 B1+
Requires:
- Warzone 3.1 Beta 1 or above
Contents
Jump to:
See also
Related articles:
- addReticuleButton() – add a reticule button
- removeReticuleButton() – remove a reticule button
- User Interface – quick reference of all JS API features relating to the user interface
Â