openMap: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\| *arma2 * * *\| *([0-1]\.[0-9]{2}) * \|game2" to "|game1= arma2 |version1= $1 |game2")
m (Text replacement - " \{\{GameCategory\|[a-z]+[0-9]?\|Scripting Commands\}\}" to "")
Line 41: Line 41:
|seealso= [[forceMap]], [[forcedMap]], [[visibleMap]], [[showMap]], [[shownMap]]
|seealso= [[forceMap]], [[forcedMap]], [[visibleMap]], [[showMap]], [[shownMap]]
}}
}}
{{GameCategory|arma3|Scripting Commands}}
{{GameCategory|tkoh|Scripting Commands}}

Revision as of 23:40, 16 June 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