openMap

Description

Opens or closes in-game map.

Warning

If forced param is set to true and map is set to open, when the map is opened it cannot be closed manually and the user can get stuck requiring the game restart.

Make sure you provide scripted mechanics to resolve this, should you need to force the map.

Useful when you wish to keep user for example on respawn screen, where they could still interact with the map but cannot enter the game until the time is up.

Syntax

Syntax 1

openMap show

Parameters:

• show: Boolean - if true opens map, if false closes map, provided it is not forced

Returns: Boolean - equivalent of visibleMap

Syntax 2

openMap [show, forced]

Parameters:

• show: Boolean - if true opens map, if false closes map, provided it is not forced.
• forced: Boolean - if true keeps map from closing when map is open. Arma 3 v2.06 if false, forces map to stay closed if show is false (see Example 1)

Returns: Boolean - equivalent of visibleMap

Examples

Example 1

openMap [true, false];    // opens map normally
openMap [false, false];    // closes an opened map normally
openMap [true, true];    // force opens map and keeps it open (the user cannot close it on their own)
openMap [false, true];    // since Arma 3 2.06: prevents map from opening, closes open map and forces it to stay close (the user cannot open it on their own)

See also

forceMap · forcedMap · visibleMap · showMap · shownMap

addMissionEventHandler ["Map", { openMap false }];

addMissionEventHandler ["Map", { 0 spawn { openMap false }; }];