forceMap: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]Arma[ _]3(\|.*)]]" to "{{GameCategory|arma3|Scripting Commands}}")
m (Text replacement - "</dd> </dl>" to "</dd> </dl>")
(18 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


| ofp |Game name=
|game1= ofp
|version1= 1.27


|1.27|Game version=
|game2= ofpe
|version2= 1.00


|eff= local |Multiplayer Effects=
|game3= arma1
|version3= 1.00


|gr1= Map |GROUP1=
|game4= arma2
|version4= 1.00


|gr2= Interaction |GROUP2=
|game5= arma2oa
____________________________________________________________________________________________
|version5= 1.50


| Opens non-interactive main map in background that overrides user screen. <br><br>
|game6= tkoh
{{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>
|version6= 1.00
To force open interactive map use [[openMap]] command. |DESCRIPTION=
____________________________________________________________________________________________


| '''forceMap''' show |SYNTAX=
|game7= arma3
|version7= 0.50


|p1= show: [[Boolean]] |PARAMETER1=
|eff= local


| [[Nothing]] |RETURNVALUE=
|gr1= Map
____________________________________________________________________________________________
 
|x1= <code>[[forceMap]] [[true]]</code> |EXAMPLE1=
____________________________________________________________________________________________


| [[forcedMap]], [[showMap]], [[shownMap]], [[openMap]], [[visibleMap]]  |SEEALSO=
|gr2= Interaction


|descr= Opens non-interactive main map in background that overrides user screen. To force open interactive map use [[openMap]] command.
{{Feature | Warning | When the map is forced open with this command, the user is still able to fire but cannot see the world, just the map.
The map cannot be closed manually and the user can get stuck requiring a game restart. Make sure you provide scripted mechanics to de-force the map at a later stage.}}
|s1= [[forceMap]] show
|p1= show: [[Boolean]] - [[true]] to force, [[false]] to go back to normal map behaviour
|r1= [[Nothing]]
|x1= <code>[[forceMap]] [[true]]</code>
|seealso= [[forcedMap]], [[showMap]], [[shownMap]], [[openMap]], [[visibleMap]]
}}
}}


<h3 style="display:none">Notes</h3>
<dl class="command_description">
<dl class="command_description">
<!-- Note Section BEGIN -->
<dt class="note">[[User:Ceeeb|Ceeeb]]</dt>
<dt class="note">[[User:Ceeeb|Ceeeb]]
<dd class="note">
<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)''
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)''
</dd>


<dt class="note">[[User:Manny|Manny]]
<dt class="note">[[User:Manny|Manny]]</dt>
<dd class="note">
<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)
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)
</dd>


<!-- Note Section END -->
</dl>
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Scripting Commands|FORCEMAP]]
[[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands OFP 1.96|FORCEMAP]]
[[Category:Scripting Commands OFP 1.46|FORCEMAP]]
{{GameCategory|arma1|Scripting Commands}}
[[Category:Scripting Commands Arma 2|{{uc:{{PAGENAME}}}}]]
{{GameCategory|arma3|Scripting Commands}}
[[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]]

Revision as of 17:09, 13 June 2021

Logo A0.png1.27ofpe logo.png1.00Logo A1 black.png1.00Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
LELocal
Hover & click on the images for description

Description

Description:
Opens non-interactive main map in background that overrides user screen. To force open interactive map use openMap command.
⚠
When the map is forced open with this command, the user is still able to fire but cannot see the world, just the map. The map cannot be closed manually and the user can get stuck requiring a game restart. Make sure you provide scripted mechanics to de-force the map at a later stage.
Groups:
MapInteraction

Syntax

Syntax:
forceMap show
Parameters:
show: Boolean - true to force, false to go back to normal map behaviour
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
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)
Retrieved from "https://community.bistudio.com/wiki?title=forceMap&oldid=276082"