Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

setTutorialMode(bool)

Sets a number of restrictions appropriate for tutorial if set to true.

...

Excerpt

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

 

Syntax

Code Block
themeRDark
languagejavascript
linenumberstrue
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

...

...

..."

Examples

Code Block
themeRDark
languagejavascript
titleRemoving a reticule button
linenumberstrue
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
Div
classbox
Availability
Status
colourGreen
title3.1 b1+

Requires:

  • Warzone 3.1 Beta 1 or above
Div
classbox
Contents

Jump to:

Table of Contents
maxLevel5

Div
classbox

See also

Related articles: