BIS fnc strategicMapOpen: Difference between revisions
Lou Montana (talk | contribs) m (Text replacement - "(\|p[0-9]+ *= *[^(]+\(Optional(, default[^)]*)\) )P([a-z])" to "$1p$3")  | 
				Lou Montana (talk | contribs)  m (Some wiki formatting)  | 
				||
| (6 intermediate revisions by 2 users not shown) | |||
| Line 33: | Line 33: | ||
* 5: [[Number]] - maximum number of displayed tiers  | * 5: [[Number]] - maximum number of displayed tiers  | ||
|p5= markers: [[Array]] of [[String  | |p5= markers: [[Array]] of [[String]]s - 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 61: | Line 61: | ||
* %2 - Index from 1-9 (optional)  | * %2 - Index from 1-9 (optional)  | ||
|r1= [[Display]] -   | |r1= [[Display]] - rscDisplayStrategicMap  | ||
|x1= <sqf>  | |x1= <sqf>  | ||
| Line 76: | Line 76: | ||
			"\A3\Data_F_Exp\Logos\arma3_exp_icon_ca.paa",  | 			"\A3\Data_F_Exp\Logos\arma3_exp_icon_ca.paa",  | ||
			1.5,  | 			1.5,  | ||
			[ player ]  | 			[player]  | ||
		],  | 		],  | ||
		[  | 		[  | ||
| Line 86: | Line 86: | ||
			"\A3\Data_F_Argo\Logos\arma3_argo_logoTitle_ca.paa",  | 			"\A3\Data_F_Argo\Logos\arma3_argo_logoTitle_ca.paa",  | ||
			1.5,  | 			1.5,  | ||
			[ player ]  | 			[player]  | ||
		]  | 		]  | ||
	],  | 	],  | ||
| Line 137: | Line 137: | ||
// edit: since Arma 3 v1.96 getMissionPath is available  | // edit: since Arma 3 v1.96 getMissionPath is available  | ||
getMissionPath "images\MyImage.jpg" // works  | getMissionPath "images\MyImage.jpg" // works  | ||
</sqf>  | |||
}}  | |||
{{Note  | |||
|user= Hamster2k  | |||
|timestamp= 20250911143457  | |||
|text= If you want to show the strategic map at the start of the mission by attaching it to the mission display (findDisplay 46;), the mission display needs to be initialized first. You can wait for initialization like this:  | |||
<sqf>waitUntil { !isNull findDisplay 46 };</sqf>  | |||
}}  | |||
{{Note  | |||
|user= Hamster2k  | |||
|timestamp= 20250912191307  | |||
|text= If you are using 3D positions for the positions in your _missions array, be aware that the clickable size of the mission on the map gets reduced the further away from 0 your z coordinate is, becoming unclickable at some point. Use a 2D position like this to avoid that issue:  | |||
<sqf>  | |||
private _position = getPosWorld mission1;  | |||
_position2d = [_position select 0, _position select 1];  | |||
_missions pushBack [  | |||
	_position2d,  | |||
	{ /*mission code*/ },  | |||
	"My mission",  | |||
	"My mission description"  | |||
];  | |||
</sqf>  | </sqf>  | ||
}}  | }}  | ||
Latest revision as of 13:29, 14 September 2025
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: Array format 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 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
 
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 
- Posted on Mar 31, 2021 - 15:29 (UTC)
 - 
In order to use an image from the mission folder, the full path to the image has to be provided:
"images\MyImage.jpg" // Does not work ([str missionConfigFile, 0, -15] call BIS_fnc_trimString) + "images\MyImage.jpg" // works // edit: since Arma 3 v1.96 getMissionPath is available getMissionPath "images\MyImage.jpg" // works
 
- Posted on Sep 11, 2025 - 14:34 (UTC)
 - 
If you want to show the strategic map at the start of the mission by attaching it to the mission display (findDisplay 46;), the mission display needs to be initialized first. You can wait for initialization like this:
 
- Posted on Sep 12, 2025 - 19:13 (UTC)
 - If you are using 3D positions for the positions in your _missions array, be aware that the clickable size of the mission on the map gets reduced the further away from 0 your z coordinate is, becoming unclickable at some point. Use a 2D position like this to avoid that issue: