BIS fnc strategicMapOpen: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "<code>([^<]*)<nowiki>\[<\/nowiki>\[\[([a-zA-Z0-9_]+)\]\](.*)<\/code>" to "<code>$1$2$3</code>")
m (Some wiki formatting)
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]] - 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: [[Array]] format [[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:
*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]] - 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 {{ic|_this # 9}}
* 7: [[Array]] - parameters for on-click action. Can be accessed in code with {{ic|_this # 9}}


|p4= ORBATs: [[Array]] - List of ORBAT, each [[Array]] in format:
|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]] - Preview CfgORBAT group
* 1: [[Config]] - preview CfgORBAT group
*2: [[Config]] - Topmost displayed CfgORBAT group
* 2: [[Config]] - topmost displayed CfgORBAT group
*3: [[Array]] of [[String|strings]] - List of allowed tags
* 3: [[Array]] of [[String]]s - 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:
*0: [[String]] - Texture path
* 0: [[String]] - texture path
*1: [[Array]] - Colour in format [R,G,B,A]
* 1: [[Array]] format [[Color|Color (RGBA)]]
*2: [[Position]] - Image position
* 2: [[Array]] format [[Position]] - image position
*3: [[Number]] - Image width in meters
* 3: [[Number]] - image width in meters
*4: [[Number]] - Image height in meters
* 4: [[Number]] - image height in meters
*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]] to show shadow
* 7: [[Boolean]] - [[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
Line 58: Line 58:


|p13= missionIcon: [[String]] - (Optional, default "\A3\Ui_f\data\Map\GroupIcons\badge_rotate_%1_gs.paa") Path to mission icon texture  
|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]] - RscDisplayStrategicMap
|r1= [[Display]] - RscDisplayStrategicMap


|x1= <code>[
|x1= <sqf>
[
findDisplay 46,
findDisplay 46,
[2000,2000,0],
[2000,2000,0],
Line 120: Line 121:
false,
false,
"\A3\Ui_f\data\Logos\arma3_white_ca.paa"
"\A3\Ui_f\data\Logos\arma3_white_ca.paa"
] call BIS_fnc_strategicMapOpen;</code>
] 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]] [[BIS_fnc_strategicMapAnimate]]
|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


<dl class="command_description">
// edit: since Arma 3 v1.96 getMissionPath is available
 
getMissionPath "images\MyImage.jpg" // works
<dt></dt>
</sqf>
<dd class="notedate">Posted on March 31, 2021 - 15:29 (UTC)</dd>
}}
<dt class="note">[[User:ansin11|ansin11]]</dt>
<dd class="note">
In order to use an image from the mission folder, the full path to the image has to be provided:
<code>"images\MyImage.jpg" // Does not work
(str [[missionConfigFile]], 0, -15] [[call]] [[BIS_fnc_trimString]]) [[+]] "images\MyImage.jpg" // Works</code>
</dd>
 
</dl>

Revision as of 14:49, 13 July 2022

Arma 3 logo black.png1.00
Hover & click on the images for description

Description

Description:
Creates a strategic map.
A3 strategicMap.jpg
Execution:
call
Groups:
Strategic

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:
  • 0: Array format Position - 2D or 3D position
  • 1: Config - preview CfgORBAT group
  • 2: Config - topmost displayed CfgORBAT group
  • 3: Array of Strings - list of allowed tags
  • 4: String - name of mission's player
  • 5: Number - maximum number of displayed tiers
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
ansin11 - c
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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_strategicMapOpen&oldid=327944"