forceMap: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
m (Text replacement - "[[Category:Scripting Commands ArmA|" to "[[Category:Scripting Commands Armed Assault|")
(27 intermediate revisions by 13 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{Command|Comments=
____________________________________________________________________________________________
____________________________________________________________________________________________


| ofp |= Game name
| ofp |Game name=


|1.27|= Game version
|1.27|Game version=


|eff= local |= Effects in MP
|eff= local |Multiplayer Effects=
____________________________________________________________________________________________
____________________________________________________________________________________________


| Displays the map on the screen during a mission. |= Description
| Opens non-interactive main map in background that overrides user screen. <br><br>
{{Warning | When map is forced with this command, the user is able to fire but cannot see the world, just the map. The map 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.}}<br>
To force open interactive map use [[openMap]] command. |DESCRIPTION=
____________________________________________________________________________________________
____________________________________________________________________________________________


| '''forceMap''' state |= Syntax
| '''forceMap''' show |SYNTAX=


| [[Nothing]] |= Return value
|p1= show: [[Boolean]] |PARAMETER1=
 
| [[Nothing]] |RETURNVALUE=
____________________________________________________________________________________________
____________________________________________________________________________________________
   
   
|x1= <pre>forceMap true</pre> |= Example 1
|x1= <code>[[forceMap]] [[true]]</code> |EXAMPLE1=
____________________________________________________________________________________________
____________________________________________________________________________________________


| [[showMap]], [[shownMap]] |= See also
| [[forcedMap]], [[showMap]], [[shownMap]], [[openMap]], [[visibleMap]]  |SEEALSO=


}}
}}
Line 27: Line 31:
<dl class="command_description">
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section BEGIN -->
<dt class="note">[[User:Ceeeb|Ceeeb]]
<dd class="note">
In '''OFP v1.96''', the mapAnim series of commands, together with [[forceMap]] can only be used in the intro and mission, as it is not possible to access the map from the outro. ''(not checked, sourced from an old copy of the OFPEC comref)''
<dt class="note">[[User:Manny|Manny]]
<dd class="note">
Manually opening the map afterwards won't close the map. Actually it will open the "real" map on top of the forced map, and closing the (top) map with the ''m''-key again will still show the forcefully opened map. (ArmA 1.05)


<!-- Note Section END -->
<!-- Note Section END -->
Line 33: Line 44:
<h3 style="display:none">Bottom Section</h3>
<h3 style="display:none">Bottom Section</h3>
[[Category:Scripting Commands|FORCEMAP]]
[[Category:Scripting Commands|FORCEMAP]]
[[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands OFP 1.96|FORCEMAP]]
[[Category:Scripting Commands OFP 1.96|FORCEMAP]]
[[Category:Scripting Commands OFP 1.46|FORCEMAP]]
[[Category:Scripting Commands OFP 1.46|FORCEMAP]]
[[Category:Scripting Commands ArmA|FORCEMAP]]
[[Category:Scripting Commands Armed Assault|FORCEMAP]]
[[Category:Command_Group:_GUI_Control|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]]

Revision as of 20:01, 3 June 2020

Hover & click on the images for description

Description

Description:
Opens non-interactive main map in background that overrides user screen.

When map is forced with this command, the user is able to fire but cannot see the world, just the map. The map 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.

To force open interactive map use openMap command.
Groups:
Uncategorised

Syntax

Syntax:
forceMap show
Parameters:
show: Boolean
Return Value:
Nothing

Examples

Example 1:
forceMap true

Additional Information

See also:
forcedMapshowMapshownMapopenMapvisibleMap

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

Ceeeb
In OFP v1.96, the mapAnim series of commands, together with forceMap can only be used in the intro and mission, as it is not possible to access the map from the outro. (not checked, sourced from an old copy of the OFPEC comref)
Manny
Manually opening the map afterwards won't close the map. Actually it will open the "real" map on top of the forced map, and closing the (top) map with the m-key again will still show the forcefully opened map. (ArmA 1.05)

Bottom Section