BIS fnc strategicMapOpen: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "\|seealso= ([^ ]+)(\]\]|\}\}), *(\[\[|\{\{)" to "|seealso= $1$2 $3") |
Lou Montana (talk | contribs) m (Text replacement - "\[ +" to "[") |
||
(24 intermediate revisions by the same user not shown) | |||
Line 9: | Line 9: | ||
[[File:A3 strategicMap.jpg|center|600px]] | [[File:A3 strategicMap.jpg|center|600px]] | ||
|s1=[display,pos,missions,ORBATs,markers,images,weather,night,scale,simulation,label,missionName,missionIcon] call [[BIS_fnc_strategicMapOpen]] | |s1= [display, pos, missions, ORBATs, markers, images, weather, night, scale, simulation, label, missionName, missionIcon] call [[BIS_fnc_strategicMapOpen]] | ||
|p1= display: [[Display]] - | |p1= display: [[Display]] - parent display. When empty, mission display is used. | ||
|p2= pos: [[Position]] - | |p2= pos: [[Array]] format [[Position]] - default view position in format [x,y,y] or [x,y] | ||
|p3= missions: [[Array]] - | |p3= missions: [[Array]] - list of missions, each [[Array]] in format: | ||
*0: [[Position]] - 2D or 3D position of mission | * 0: [[Position]] - 2D or 3D position of mission | ||
*1: [[Code]] - Expression executed when user clicks on mission icon | * 1: [[Code]] - Expression executed when user clicks on mission icon | ||
*2: [[String]] - Mission name | * 2: [[String]] - Mission name | ||
*3: [[String]] - Short description | * 3: [[String]] - Short description | ||
*4: [[String]] - Name of mission's player | * 4: [[String]] - Name of mission's player | ||
*5: [[String]] - Path to overview image | * 5: [[String]] - Path to overview image | ||
*6: [[Number]] - | * 6: [[Number]] - size multiplier for overview image | ||
*7: [[Array]] - | * 7: [[Array]] - parameters for on-click action. Can be accessed in code with <sqf inline>_this # 9</sqf> | ||
|p4= ORBATs: [[Array]] - | |p4= ORBATs: [[Array]] - list of ORBAT, each [[Array]] in format: | ||
*0: [[Position]] - 2D or 3D position | * 0: [[Array]] format [[Position]] - 2D or 3D position | ||
*1: [[Config]] - | * 1: [[Config]] - preview CfgORBAT group | ||
*2: [[Config]] - | * 2: [[Config]] - topmost displayed CfgORBAT group | ||
*3: [[Array]] of [[String | * 3: [[Array]] of [[String]]s - list of allowed tags | ||
*4: [[String]] - | * 4: [[String]] - name of mission's player | ||
*5: [[Number]] - | * 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]] - | |p6= images: [[Array]] - list of custom images, each [[Array]] in format: | ||
*0: [[String]] - | * 0: [[String]] - texture path | ||
*1: [[Array]] | * 1: [[Array]] format [[Color|Color (RGBA)]] | ||
*2: [[Position]] - | * 2: [[Array]] format [[Position]] - image position | ||
*3: [[Number]] - | * 3: [[Number]] - image width in meters | ||
*4: [[Number]] - | * 4: [[Number]] - image height in meters | ||
*5: [[Number]] - | * 5: [[Number]] - image angle in degrees | ||
*6: [[String]] - | * 6: [[String]] - text displayed next to the image | ||
*7: [[Boolean]] - [[true]] to show shadow | * 7: [[Boolean]] - [[true]] to show shadow | ||
|p7= weather: [[Number]] - | |p7= weather: [[Number]] - overcast, from 0 - 1, where 1 means cloudy weather | ||
|p8= night: [[Boolean]] - [[true]] for night version of strategic map (darker with blue tone) | |p8= night: [[Boolean]] - [[true]] for night version of strategic map (darker with blue tone) | ||
|p9= scale: [[Number]] - | |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 | |p10= simulation: [[Boolean]]] - (Optional, default [[false]] [[true]] to enable simulation while the map is opened | ||
|p11= label: [[String]] - (Optional, default "Select a mission") | |p11= label: [[String]] - (Optional, default "Select a mission") bottom bar action label text | ||
|p12= missionName: [[Boolean]] - (Optional, default [[true]]) [[true]] to show icon label as a mission name | |p12= missionName: [[Boolean]] - (Optional, default [[true]]) [[true]] to show icon label as a mission name | ||
|p13= missionIcon: [[String]] - (Optional, default "\A3\Ui_f\data\Map\GroupIcons\badge_rotate_%1_gs.paa") | |p13= 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) | * %1 - Animation frame from 0-6 (optional) | ||
*%2 - Index from 1-9 (optional) | * %2 - Index from 1-9 (optional) | ||
|r1= [[Display]] - | |r1= [[Display]] - rscDisplayStrategicMap | ||
|x1= < | |x1= <sqf> | ||
[ | |||
findDisplay 46, | |||
[2000,2000,0], | [2000,2000,0], | ||
[ | [ | ||
[ | [ | ||
[2000,2000,0], | [2000,2000,0], | ||
{ | {systemChat format ["%1",name ((_this # 9) # 0)]}, | ||
"1st Mission", | "1st Mission", | ||
"This is mission one", | "This is mission one", | ||
Line 75: | 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] | |||
], | ], | ||
[ | [ | ||
[1000,1000,0], | [1000,1000,0], | ||
{ | {systemChat format ["%1",name ((_this # 9) # 0)]}, | ||
"2nd Mission", | "2nd Mission", | ||
"This is mission two", | "This is mission two", | ||
Line 85: | 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] | |||
] | ] | ||
], | ], | ||
Line 91: | Line 92: | ||
[ | [ | ||
[3000,3000,0], | [3000,3000,0], | ||
configFile >> "CfgORBAT" >> "BIS" >> "B_1_A_1_2", | |||
configFile >> "CfgORBAT" >> "BIS" >> "B_1", | |||
[], | [], | ||
10 | 10 | ||
Line 110: | Line 111: | ||
0, | 0, | ||
"Arma 3 Logo", | "Arma 3 Logo", | ||
true | |||
] | ] | ||
], | ], | ||
0, | 0, | ||
false, | |||
1, | 1, | ||
true, | |||
"Strategic Map Example", | "Strategic Map Example", | ||
false, | |||
"\A3\Ui_f\data\Logos\arma3_white_ca.paa" | "\A3\Ui_f\data\Logos\arma3_white_ca.paa" | ||
] | ] call BIS_fnc_strategicMapOpen; | ||
</sqf> | |||
|seealso= [[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]] | |seealso= [[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]] | ||
}} | }} | ||
{{Note | |||
|user= ansin11 | |||
|timestamp= 20210331152900 | |||
|text= In order to use an image from the mission folder, the full path to the image has to be provided: | |||
<sqf> | |||
"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 | |||
</sqf> | |||
}} | |||
</ | |||
Latest revision as of 18:16, 8 November 2023
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