openMap: Difference between revisions
Jump to navigation
Jump to search
(Added BI F1 comment.) |
Lou Montana (talk | contribs) m (Text replacement - "// since Arma 3" to "// since {{arma3}}") |
||
(78 intermediate revisions by 12 users not shown) | |||
Line 1: | Line 1: | ||
{{ | {{RV|type=command | ||
| arma2 |= | |game1= arma2 | ||
|version1= 1.03 | |||
|1. | |game2= arma2oa | ||
|version2= 1.50 | |||
| | |game3= tkoh | ||
|version3= 1.00 | |||
| | |game4= arma3 | ||
|version4= 0.50 | |||
|= | |||
| | |eff= local | ||
| | |gr1= Map | ||
| | |gr2= Interaction | ||
| | |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. | |||
}} | |||
|s1= [[openMap]] show | |||
|p1= show: [[Boolean]] - if [[true]] opens map, if [[false]] closes map, provided it is not ''forced'' | |||
|r1= [[Boolean]] - equivalent of [[visibleMap]] | |||
| | |s2= [[openMap]] [show, forced] | ||
|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. {{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. | |||
}} |
Latest revision as of 18:02, 18 November 2023
Description
- Description:
- Opens or closes in-game map.
- 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. 2.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
- 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 likewill cause the game to crash.
To fix this, please use it inside of a spawned script.
This should stop any issue of crashing when you close the map.