openMap: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "_{10,} " to "") |
Lou Montana (talk | contribs) m (Text replacement - " *\| *([Cc]omments|COMMENTS|Game|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments( \("local" or "global"\))?|Effects|Multiplayer Effects( \("local" or "global"\))?|Multiplayer Exe...) |
||
| Line 1: | Line 1: | ||
{{Command | {{Command | ||
| arma2 | | arma2 | ||
|1.03 | |1.03 | ||
|eff= local | |eff= local | ||
|gr1= Map | |gr1= Map | ||
|gr2= Interaction | |gr2= Interaction | ||
| Opens or closes in-game map.<br><br> | | Opens or closes in-game map.<br><br> | ||
{{Warning | If <tt>forced</tt> param is set to [[true]], when 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.}} | {{Warning | If <tt>forced</tt> param is set to [[true]], when 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.}} | ||
| [[openMap]] show | | [[openMap]] show | ||
|p1= show: [[Boolean]] - if [[true]] opens map, if [[false]] closes map, provided it is not ''forced'' | |p1= show: [[Boolean]] - if [[true]] opens map, if [[false]] closes map, provided it is not ''forced'' | ||
| [[Boolean]] - equivalent of [[visibleMap]] | | [[Boolean]] - equivalent of [[visibleMap]] | ||
|s2= [[openMap]] [show, forced] | |s2= [[openMap]] [show, forced] | ||
|p21= show: [[Boolean]] - if [[true]] opens map, if [[false]] closes map, provided it is not ''forced''. |PARAMETER21= | |p21= show: [[Boolean]] - if [[true]] opens map, if [[false]] closes map, provided it is not ''forced''. |PARAMETER21= | ||
| Line 26: | Line 26: | ||
|p22= forced: [[Boolean]] - if [[true]] keeps map from closing when map is open. |Parameter22= | |p22= forced: [[Boolean]] - if [[true]] keeps map from closing when map is open. |Parameter22= | ||
|r2= [[Boolean]] - equivalent of [[visibleMap]] | |r2= [[Boolean]] - equivalent of [[visibleMap]] | ||
|x1= <code>[[openMap]] [[true]];</code> | |x1= <code>[[openMap]] [[true]];</code> | ||
|x2= <code>[[openMap]] [<nowiki/>[[true]], [[true]]];</code> | |x2= <code>[[openMap]] [<nowiki/>[[true]], [[true]]];</code> | ||
| [[forceMap]], [[forcedMap]], [[visibleMap]], [[showMap]], [[shownMap]] | | [[forceMap]], [[forcedMap]], [[visibleMap]], [[showMap]], [[shownMap]] | ||
}} | }} | ||
Revision as of 02:26, 18 January 2021
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.
- Return Value:
- Boolean - equivalent of visibleMap
Examples
Additional Information
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