openMap: Difference between revisions

Revision as of 17:15, 2 August 2021

1.03

Hover & click on the images for description

Description

Description:

Opens or closes in-game map.

⚠

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

Since Arma 3 v2.06.147984 the alternative syntax has the following functionality:

openMap [true, false] - opens map normally
openMap [false, false] - closes opened map normally
openMap [true, true]- force opens map and keeps open (the user cannot close it on their own)

New

openMap [false, true] - prevents map from opening, closes open map and forces it to stay close.

Groups:

Map Interaction

Syntax

Syntax:: openMap show
Parameters:: show: Boolean - if true opens map, if false closes map, provided it is not forced
Return Value:: Boolean - equivalent of visibleMap

Alternative Syntax

Syntax:: 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.147984, if false, forces map to stay closed if 'show' is false (see description)
Return Value:: Boolean - equivalent of visibleMap

Examples

Example 1:: openMap true;
Example 2:: openMap [true, true];

Additional Information

See also:: forceMap forcedMap visibleMap showMap shownMap

Notes

: Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note

@@ Line 19: / Line 19: @@
 |gr2= Interaction
-|descr= Opens or closes in-game map.{{Feature | Warning | If <tt>forced</tt> 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 }}
+|descr= Opens or closes in-game map.{{Feature | Warning | If <tt>forced</tt> 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
+<br>
+Since Arma 3 v2.06.147984 the alternative syntax has the following functionality:
+* [[openMap]] <nowiki>[</nowiki>[[true]], [[false]]] - opens map normally
+* [[openMap]] <nowiki>[</nowiki>[[false]], [[false]]] - closes opened map normally
+* [[openMap]] <nowiki>[</nowiki>[[true]], [[true]]]- force opens map and keeps open (the user cannot close it on their own)
+''New''
+* [[openMap]] <nowiki>[</nowiki>[[false]], [[true]]] - prevents map from opening, closes open map and forces it to stay close.}}
 |s1= [[openMap]] show
@@ Line 31: / Line 38: @@
 |p21= show: [[Boolean]] - if [[true]] opens map, if [[false]] closes map, provided it is not ''forced''.
-|p22= forced: [[Boolean]] - if [[true]] keeps map from closing when map is open.
+|p22= forced: [[Boolean]] - if [[true]] keeps map from closing when map is open. Arma 3 v2.06.147984, if [[false]], forces map to stay closed if 'show' is [[false]] (see description)
 |r2= [[Boolean]] - equivalent of [[visibleMap]]