Versions Compared

Old Version 4

changes.mady.by.user Aubergine

Saved on

compared with

New Version Current

changes.mady.by.user Aubergine

Saved on

Key

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

Display or hide the localhost human player's radar mini-map...

 

Syntax

Code Block
themeRDark
languagejavascript
linenumberstrue
setMiniMap(show);

Parameters

ParameterTypeMandatoryDescriptionGame version
showBoolean(error)

Should the minimap be shown?

  • true – yes, show the mini map
  • false – no, hide the mini map

Default: false

3.1 Beta 1

Return value

ValueTypeDescriptionGame version
undefinedUndefinedThe function always returns undefined3.1 Beta 1

Example

Code Block
themeRDark
languagejavascript
titleShow or hide minimap based on presence of HQ
linenumberstrue
// don't do this in AI scripts because the setMiniMap() function only applies to the human players minimap
 
function eventStructureBuilt(structure) {
  if (structure.stattype == HQ) setMiniMap(true);
}
function eventDestroyed(gameObj) {
  if (gameObj.type==STRUCTURE && gameObj.stattype==HQ) setMiniMap(false);
}
Div
classsuggest box

Standard game rules require that the mini map is only enabled while the player has a HQ.

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:

  • Mini Map and Design Mode – implementation of standard game rules
  • config – the Warzone config file contains some settings that affect what's displayed on the mini map
  • Images, Icons & Cursors – customising beacons, mission objectives and burning oil resources shown on the mini map
  • setDesign() – turn the design tool on or off
  • User Interface – quick reference of JS API features relating to user interface