openMap: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(removed ancient inaccurate note, format)
m (Text replacement - "// since Arma 3" to "// since {{arma3}}")
 
(65 intermediate revisions by 6 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| arma2 |= Game name
|game1= arma2
|version1= 1.03


|1.03|= Game version
|game2= arma2oa
____________________________________________________________________________________________
|version2= 1.50


| Shows in-game map. If forced, cannot be closed. |= Description
|game3= tkoh
____________________________________________________________________________________________
|version3= 1.00


| '''openMap''' show |= Syntax
|game4= arma3
|version4= 0.50


|p1= show: [[Boolean]] |= PARAMETER1
|eff= local


| [[Boolean]] |= RETURNVALUE
|gr1= Map
____________________________________________________________________________________________


|s2= '''openMap''' [show, forced] |=  
|gr2= Interaction


|p21= show: [[Boolean]] |=
|descr= Opens or closes in-game map.
{{Feature|warning|
If {{hl|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.
}}


|p22= forced: [[Boolean]] |=
|s1= [[openMap]] show


|r2= [[Boolean]] |=
|p1= show: [[Boolean]] - if [[true]] opens map, if [[false]] closes map, provided it is not ''forced''
____________________________________________________________________________________________


|x1= <code>[[openMap]] [[true]];</code> |= EXAMPLE1
|r1= [[Boolean]] - equivalent of [[visibleMap]]


|x2= <code>[[openMap]] <nowiki>[</nowiki>[[true]], [[true]]];</code> |= EXAMPLE2
|s2= [[openMap]] [show, forced]


____________________________________________________________________________________________
|p21= show: [[Boolean]] - if [[true]] opens map, if [[false]] closes map, provided it is not ''forced''.


| [[forceMap]], [[visibleMap]] |= SEEALSO
|p22= forced: [[Boolean]] - if [[true]] keeps map from closing when map is open. {{GVI|arma3|2.06|size= 0.75}} if [[false]], forces map to stay closed if ''show'' is [[false]] (see {{Link|#Example 1}})


|r2= [[Boolean]] - equivalent of [[visibleMap]]


|x1= <sqf>
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 {{arma3}} 2.06: prevents map from opening, closes open map and forces it to stay close (the user cannot open it on their own)
</sqf>


|seealso= [[forceMap]] [[forcedMap]] [[visibleMap]] [[showMap]] [[shownMap]]
}}


____________________________________________________________________________________________
{{Note
|user= Fraali
|timestamp= 20211208110058
|text= ('''As of Arma 3 ver.2.06.148470''') <br>
Trying to close a map using <sqf inline>openMap false</sqf> inside of a map event handler like
<sqf>addMissionEventHandler ["Map", { openMap false }];</sqf>
will cause the game to crash.<br>
To fix this, please use it inside of a spawned script.
<sqf>addMissionEventHandler ["Map", { 0 spawn { openMap false }; }];</sqf>
<br>
This should stop any issue of crashing when you close the map.
}}
}}
<h3 style='display:none'>Notes</h3>
<dl class='command_description'>
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style='display:none'>Bottom Section</h3>
[[Category:ArmA 2: New Scripting Commands List|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]

Latest revision as of 18:02, 18 November 2023

Logo A2.png1.03A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
LELocal
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.
Groups:
MapInteraction

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 logo black.png2.06 if false, forces map to stay closed if show is false (see Example 1)
Return Value:
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)

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
Fraali - c
Posted on Dec 08, 2021 - 11:00 (UTC)
(As of Arma 3 ver.2.06.148470)
Trying to close a map using openMap false inside of a map event handler like
addMissionEventHandler ["Map", { openMap false }];
will cause the game to crash.
To fix this, please use it inside of a spawned script.
addMissionEventHandler ["Map", { 0 spawn { openMap false }; }];

This should stop any issue of crashing when you close the map.
Retrieved from "https://community.bistudio.com/wiki?title=openMap&oldid=349654"