(info) Other great resources: Official JS API docs, Scripting Forum

setTutorialMode()

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

 

Syntax

setTutorialMode(active);

Parameters

ParameterTypeMandatoryNotesGame version
activeBoolean(tick)

Make tutorial mode active?

  • true – yes, tutorial mode is active
  • false – no, the game is in normal mode
3.1 Beta 1

Return value

ValueTypeDescriptionGame version
undefinedUndefinedThe function always returns undefined3.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:

Â