openMap: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "_{10,} " to "")
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|Comments=
{{Command


| arma2 |Game name=
| arma2


|1.03|Game version=
|1.03


|eff= local|Multiplayer Effects=
|eff= local


|gr1= Map |GROUP1=
|gr1= Map


|gr2= Interaction |GROUP2=
|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.}} |DESCRIPTION=
{{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 |SYNTAX=
| [[openMap]] show


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


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


|s2= [[openMap]] [show, forced] |SYNTAX2=
|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]]|RETURNVALUE2=
|r2= [[Boolean]] - equivalent of [[visibleMap]]


|x1= <code>[[openMap]] [[true]];</code> |EXAMPLE1=
|x1= <code>[[openMap]] [[true]];</code>


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




| [[forceMap]], [[forcedMap]], [[visibleMap]], [[showMap]], [[shownMap]] |SEEALSO=
| [[forceMap]], [[forcedMap]], [[visibleMap]], [[showMap]], [[shownMap]]
}}
}}



Revision as of 01:26, 18 January 2021

Hover & click on the images for description

Description

Description:
Opens or closes in-game map.

If forced 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.
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

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

Additional Information

See also:
forceMapforcedMapvisibleMapshowMapshownMap

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

Notes

Bottom Section