setMiniMap()

Overview

Allows you to turn the human player's minimap (radar) display on or off.

Note that this is automatically handled by rules.js in challenges and multiplayer/skirmish games.

Availability

Warzone 3.1 Beta 1 and above.

Syntax

setMiniMap(show);

Parameters

Parameter Type Mandatory Description Game version

show

Boolean

Should the minimap be shown?

true – yes
false – no

Defaults to false if not specified.

3.1 Beta 1

Return value

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

Example

Show or hide minimap based on presence of HQ

// 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);
}