setMiniMap(bool)
Turns visible minimap on or off in the GUI.
...
Overview
| Excerpt |
|---|
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
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
setMiniMap(show); |
Parameters
| Parameter | Type | Mandatory | Description | Game version |
|---|---|---|---|---|
| show | Boolean |  | Should the minimap be shown?
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
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
// 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);
} |
See also
- setDesign() – turn the design tool on or off
- User Interface – quick reference of JS API features relating to user interface