BIS fnc strategicMapOpen: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "</dd> </dl>" to "</dd> </dl>")
m (Text replacement - "True" to "true")
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{RV|type=function
{{RV|type=function


| arma3
|game1= arma3
 
|version1= 1.00
|1.00


|gr1= Strategic
|gr1= Strategic


| Creates a strategic map.
|descr= Creates a strategic map.
[[File:A3 strategicMap.jpg|center|600px]]
[[File:A3 strategicMap.jpg|center|600px]]


Line 44: Line 43:
*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]] 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]] 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)
Line 56: Line 55:
|p11= label: [[String]] - (Optional, default "Select a mission") Bottom bar action label text
|p11= label: [[String]] - (Optional, default "Select a mission") Bottom bar action label text


|p12= missionName: [[Boolean]] - (Optional, default [[true]]) [[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") 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  
Line 62: Line 61:
*%2 - Index from 1-9 (optional)
*%2 - Index from 1-9 (optional)


|r1=[[Display]] - RscDisplayStrategicMap
|r1= [[Display]] - RscDisplayStrategicMap


|x1= <code>[
|x1= <code>[
Line 132: Line 131:
<dd class="notedate">Posted on March 31, 2021 - 15:29 (UTC)</dd>
<dd class="notedate">Posted on March 31, 2021 - 15:29 (UTC)</dd>
<dt class="note">[[User:ansin11|ansin11]]</dt>
<dt class="note">[[User:ansin11|ansin11]]</dt>
<dd class="note">{{#if:
<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" {{cc|Does not work}}
(<nowiki>[</nowiki>[[str]] [[missionConfigFile]], 0, -15] [[call]] [[BIS_fnc_trimString]]) [[+]] "images\MyImage.jpg" {{cc|Works}}</code>
|
In order to use an image from the mission folder, the full path to the image has to be provided:
In order to use an image from the mission folder, the full path to the image has to be provided:
<code>"images\MyImage.jpg" {{cc|Does not work}}
<code>"images\MyImage.jpg" {{cc|Does not work}}
(<nowiki>[</nowiki>[[str]] [[missionConfigFile]], 0, -15] [[call]] [[BIS_fnc_trimString]]) [[+]] "images\MyImage.jpg" {{cc|Works}}</code>
(<nowiki>[</nowiki>[[str]] [[missionConfigFile]], 0, -15] [[call]] [[BIS_fnc_trimString]]) [[+]] "images\MyImage.jpg" {{cc|Works}}</code>
|-no text provided-}}</dd>
</dd>


</dl>
</dl>

Revision as of 20:23, 25 September 2021

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: 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: 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:
  • 0: String - Texture path
  • 1: Array - Colour in format [R,G,B,A]
  • 2: Position - Image position
  • 3: Number - Image width in meters
  • 4: Number - Image height in meters
  • 5: Number - Image angle in degrees
  • 6: String - Text displayed next to the image
  • 7: Boolean - true to show shadow
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


Posted on March 31, 2021 - 15:29 (UTC)
ansin11
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