BIS fnc strategicMapOpen: Difference between revisions
Lou Montana (talk | contribs) m (Text replacement - " *\|= " to " ")  | 
				Lou Montana (talk | contribs)  m (Text replacement - " *\| *([Cc]omments|COMMENTS|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments \("local" or "global"\)|Multiplayer Effects \("local" or "global"\)|Multiplayer Execution \("server" o...)  | 
				||
| Line 1: | Line 1: | ||
{{Function  | {{Function  | ||
| arma3   | | arma3  | ||
|1.00  | |1.00  | ||
|gr1 = Strategic   | |gr1 = Strategic  | ||
| Creates a strategic map.  | | Creates a strategic map.  | ||
[[File:A3 strategicMap.jpg|center|600px]]   | [[File:A3 strategicMap.jpg|center|600px]]  | ||
| [display,pos,missions,ORBATs,markers,images,weather,night,scale,simulation,label,missionName,missionIcon] call [[BIS_fnc_StrategicMapOpen]]   | | [display,pos,missions,ORBATs,markers,images,weather,night,scale,simulation,label,missionName,missionIcon] call [[BIS_fnc_StrategicMapOpen]]  | ||
|p1= display: [[Display]] - Parent display. When empty, mission display is used.  | |p1= display: [[Display]] - Parent display. When empty, mission display is used.  | ||
|p2= pos: [[Position]] - Default view position in format [x,y,y] or [x,y]  | |p2= pos: [[Position]] - Default view position in format [x,y,y] or [x,y]  | ||
|p3= missions: [[Array]] - List of missions, each [[Array]] in format:  | |p3= missions: [[Array]] - List of missions, each [[Array]] in format:  | ||
| Line 24: | Line 24: | ||
*5: [[String]] - Path to overview image  | *5: [[String]] - Path to overview image  | ||
*6: [[Number]] - Size multiplier for overview image  | *6: [[Number]] - Size multiplier for overview image  | ||
*7: [[Array]] - Parameters for on-click action. Can be accessed in code with {{Inline code|_this # 9}}  | *7: [[Array]] - Parameters for on-click action. Can be accessed in code with {{Inline code|_this # 9}}  | ||
|p4= ORBATs: [[Array]] - List of ORBAT, each [[Array]] in format:  | |p4= ORBATs: [[Array]] - List of ORBAT, each [[Array]] in format:  | ||
| Line 32: | Line 32: | ||
*3: [[Array]] of [[String|strings]] - List of allowed tags  | *3: [[Array]] of [[String|strings]] - List of allowed tags  | ||
*4: [[String]] - Name of mission's player  | *4: [[String]] - Name of mission's player  | ||
*5: [[Number]] - Maximum number of displayed tiers  | *5: [[Number]] - Maximum number of displayed tiers  | ||
|p5= markers: [[Array]] of [[String|strings]] - List of markers revealed in strategic map (will be hidden when map is closed)  | |p5= markers: [[Array]] of [[String|strings]] - List of markers revealed in strategic map (will be hidden when map is closed)  | ||
|p6= images: [[Array]] - List of custom images, each [[Array]] in format:  | |p6= images: [[Array]] - List of custom images, each [[Array]] in format:  | ||
| Line 44: | Line 44: | ||
*5: [[Number]] - Image angle in degrees  | *5: [[Number]] - Image angle in degrees  | ||
*6: [[String]] - Text displayed next to the image  | *6: [[String]] - Text displayed next to the image  | ||
*7: [[Boolean]] - [[true|True]] to show shadow  | *7: [[Boolean]] - [[true|True]] to show shadow  | ||
|p7= weather: [[Number]] - Overcast, from 0 - 1, where 1 means cloudy weather  | |p7= weather: [[Number]] - Overcast, from 0 - 1, where 1 means cloudy weather  | ||
|p8= night: [[Boolean]] - [[true|True]] for night version of strategic map (darker with blue tone)  | |p8= night: [[Boolean]] - [[true|True]] for night version of strategic map (darker with blue tone)  | ||
|p9= scale: [[Number]] - Default map scale coeficient (1 is automatic scale)  | |p9= scale: [[Number]] - Default map scale coeficient (1 is automatic scale)  | ||
|p10= simulation: [[Boolean]]] - (Optional, default [[false]] [[true]] to enable simulation while the map is opened|PARAMETER10=  | |p10= simulation: [[Boolean]]] - (Optional, default [[false]] [[true]] to enable simulation while the map is opened|PARAMETER10=  | ||
| Line 63: | Line 63: | ||
*%2 - Index from 1-9 (optional)|PARAMETER13=  | *%2 - Index from 1-9 (optional)|PARAMETER13=  | ||
| [[Display]] - RscDisplayStrategicMap   | | [[Display]] - RscDisplayStrategicMap  | ||
|x1= <code>[  | |x1= <code>[  | ||
| Line 124: | Line 124: | ||
] [[call]] [[BIS_fnc_StrategicMapOpen]];</code>  | ] [[call]] [[BIS_fnc_StrategicMapOpen]];</code>  | ||
| [[ORBAT Viewer]], [[BIS_fnc_ORBATAddGroupOverlay]], [[BIS_fnc_ORBATAnimate]], [[BIS_fnc_ORBATConfigPreview]], [[BIS_fnc_ORBATGetGroupParams]], [[BIS_fnc_ORBATOpen]], [[BIS_fnc_ORBATRemoveGroupOverlay]], [[BIS_fnc_ORBATSetGroupFade]], [[BIS_fnc_ORBATSetGroupParams]], [[BIS_fnc_ORBATTooltip]], [[BIS_fnc_StrategicMapMouseButtonClick]], [[BIS_fnc_StrategicMapAnimate]]   | | [[ORBAT Viewer]], [[BIS_fnc_ORBATAddGroupOverlay]], [[BIS_fnc_ORBATAnimate]], [[BIS_fnc_ORBATConfigPreview]], [[BIS_fnc_ORBATGetGroupParams]], [[BIS_fnc_ORBATOpen]], [[BIS_fnc_ORBATRemoveGroupOverlay]], [[BIS_fnc_ORBATSetGroupFade]], [[BIS_fnc_ORBATSetGroupParams]], [[BIS_fnc_ORBATTooltip]], [[BIS_fnc_StrategicMapMouseButtonClick]], [[BIS_fnc_StrategicMapAnimate]]  | ||
}}  | }}  | ||
Revision as of 22:22, 17 January 2021
Description
Syntax
- Syntax:
 - [display,pos,missions,ORBATs,markers,images,weather,night,scale,simulation,label,missionName,missionIcon] call BIS_fnc_StrategicMapOpen
 - Parameters:
 - display: Display - Parent display. When empty, mission display is used.
 - pos: Position - Default view position in format [x,y,y] or [x,y]
 - missions: Array - List of missions, each Array in format:
- 0: Position - 2D or 3D position of mission
 - 1: Code - Expression executed when user clicks on mission icon
 - 2: String - Mission name
 - 3: String - Short description
 - 4: String - Name of mission's player
 - 5: String - Path to overview image
 - 6: Number - Size multiplier for overview image
 - 7: Array - Parameters for on-click action. Can be accessed in code with 
_this # 9 
 - ORBATs: Array - List of ORBAT, each Array in format:
 - markers: Array of strings - List of markers revealed in strategic map (will be hidden when map is closed)
 - images: Array - List of custom images, each Array in format:
 - weather: Number - Overcast, from 0 - 1, where 1 means cloudy weather
 - night: Boolean - True for night version of strategic map (darker with blue tone)
 - scale: Number - Default map scale coeficient (1 is automatic scale)
 - simulation: Boolean] - (Optional, default false true to enable simulation while the map is opened
 - label: String - (Optional, default "Select a mission") Bottom bar action label text
 - missionName: Boolean - (Optional, default true) True to show icon label as a mission name
 - missionIcon: String - (Optional, default "\A3\Ui_f\data\Map\GroupIcons\badge_rotate_%1_gs.paa") Path to mission icon texture 
- %1 - Animation frame from 0-6 (optional)
 - %2 - Index from 1-9 (optional)
 
 - Return Value:
 - Display - RscDisplayStrategicMap
 
Examples
- Example 1:
 [ findDisplay 46, [2000,2000,0], [ [ [2000,2000,0], {systemChat format ["%1",name ((_this # 9) # 0)]}, "1st Mission", "This is mission one", "Name of mission's player", "\A3\Data_F_Exp\Logos\arma3_exp_icon_ca.paa", 1.5, [ player ] ], [ [1000,1000,0], {systemChat format ["%1",name ((_this # 9) # 0)]}, "2nd Mission", "This is mission two", "Name of mission's player", "\A3\Data_F_Argo\Logos\arma3_argo_logoTitle_ca.paa", 1.5, [ player ] ] ], [ [ [3000,3000,0], configFile >> "CfgORBAT" >> "BIS" >> "B_1_A_1_2", configFile >> "CfgORBAT" >> "BIS" >> "B_1", [], 10 ] ], [ "marker_1", "marker_2" ], [ [ "\A3\Ui_f\data\Logos\arma3_white_ca.paa", [0,0,0,1], [4000,4000,0], 8, 8, 0, "Arma 3 Logo", true ] ], 0, false, 1, true, "Strategic Map Example", false, "\A3\Ui_f\data\Logos\arma3_white_ca.paa" ] call BIS_fnc_StrategicMapOpen;
Additional Information
- See also:
 - ORBAT ViewerBIS_fnc_ORBATAddGroupOverlayBIS_fnc_ORBATAnimateBIS_fnc_ORBATConfigPreviewBIS_fnc_ORBATGetGroupParamsBIS_fnc_ORBATOpenBIS_fnc_ORBATRemoveGroupOverlayBIS_fnc_ORBATSetGroupFadeBIS_fnc_ORBATSetGroupParamsBIS_fnc_ORBATTooltipBIS_fnc_StrategicMapMouseButtonClickBIS_fnc_StrategicMapAnimate
 
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