Display or hide the localhost human player's radar mini-map...
Syntax
setMiniMap(show);
Parameters
Parameter
Type
Mandatory
Description
Game version
show
Boolean
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
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);
}
Standard game rules require that the mini map is only enabled while the player has a HQ.