BIS fnc missionSelector: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category\:Function Group\: Systems(\|\{\{[a-zA-Z0-9_:]+\}\})?\]\]" to "")
m (Text replacement - "(Optional, default {{hl|[]}})" to "(Optional, default <sqf inline>[]</sqf>)")
 
(18 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Function|Comments=
{{RV|type=function


| arma3 |Game name=
|game1= arma3
|version1= 1.78


|1.78|Game version=
|gr1= Systems


<!---|arg= local |Multiplayer Arguments=--->
|eff= local


|eff= local |Multiplayer Effects=
|descr= Function that draws clickable, hoverable and animated icons on the map that execute a user-defined code when pressed.


| Function that draws clickable, hoverable and animated icons on the map that execute a user-defined code when pressed. |Description=
|s1= [area, mapCenter, missionsArray] call [[BIS_fnc_missionSelector]]


| [area, mapCenter, missionsArray] call [[BIS_fnc_missionSelector]] |Syntax=
|p1= area: [[Array]] of [[Number]] - (Optional, default [100,100]) used to determine map's zoom, format [width, height]


|p1= area: [[Array]] of [[Number]] - (Optional, default [100,100]) used to determine map's zoom, format [width, height] |Parameter 1=
|p2= mapCenter: [[Position#Introduction|Position2D]] - (Optional, default [0,0]) center position where the map camera will be positioned


|p2= mapCenter: [[Position2D]] - (Optional, default [0,0]) center position where the map camera will be positioned |Parameter 2=
|p3= missionsArray: [[Array]] - (Optional, default <sqf inline>[]</sqf>) list of selectable missions and their parameters, to format [pos, text, tooltip, picture, code]:
 
|p3= missionsArray: [[Array]] - (Optional, default []) list of selectable missions and their parameters, to format [pos, text, tooltip, picture, code]:
* pos: [[Array]] - where the clickable marker will be placed
* pos: [[Array]] - where the clickable marker will be placed
* text: [[String]] - text that should be displayed next to the icon
* text: [[String]] - text that should be displayed next to the icon
Line 23: Line 22:
* picture: [[String]] - location of the picture to be displayed in the tooltip
* picture: [[String]] - location of the picture to be displayed in the tooltip
* code: [[Code]] - code spawned when the icon is clicked
* code: [[Code]] - code spawned when the icon is clicked
|Parameter 3=


| [[Number]] - index of the chosen mission |Return value=
|r1= [[Number]] - index of the chosen mission


|x1= <code>[[private]] _area = [750, 400];
|x1= <sqf>
[[private]] _missionsList =
private _area = [750, 400];
private _missionsList =
[
[
[
[
[[getMarkerPos]] "BIS_briefMarkerINFANTRY",
getMarkerPos "BIS_briefMarkerINFANTRY",
"Infantry",
"Infantry",
"Your mission is to do stuff",
"Your mission is to do stuff",
"AnimBriefing\intro_stage1a_CA.paa",
"AnimBriefing\intro_stage1a_CA.paa",
{ [[hint]] "infantry mission selected" }
{ hint "infantry mission selected" }
],
],
[
[
[[getMarkerPos]] "BIS_briefMarkerSPECIALFORCES",
getMarkerPos "BIS_briefMarkerSPECIALFORCES",
"Special Forces",
"Special Forces",
"Your mission is to do stuff but in a more special way",
"Your mission is to do stuff but in a more special way",
"AnimBriefing\intro_stage1a_CA.paa",
"AnimBriefing\intro_stage1a_CA.paa",
{ [[hint]] "special forces mission selected" }
{ hint "special forces mission selected" }
]
]
];
];


[[private]] _index = [_area, [[getMarkerPos]] "BIS_cameraCenter", _missionsList] [[call]] [[BIS_fnc_missionSelector]];
private _index = [_area, getMarkerPos "BIS_cameraCenter", _missionsList] call BIS_fnc_missionSelector;
[[private]] _missionDetails = _missionsList [[select]] _index;</code> |Example 1=
private _missionDetails = _missionsList select _index;
</sqf>


|exec= call |Execution=
|seealso= [[playMission]]
 
| [[playMission]] |See also=
}}
}}
<h3 style="display:none">Notes</h3>
<h3 style="display:none">Bottom Section</h3>

Latest revision as of 18:09, 8 November 2023

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

Description

Description:
Function that draws clickable, hoverable and animated icons on the map that execute a user-defined code when pressed.
Execution:
call
Groups:
Systems

Syntax

Syntax:
[area, mapCenter, missionsArray] call BIS_fnc_missionSelector
Parameters:
area: Array of Number - (Optional, default [100,100]) used to determine map's zoom, format [width, height]
mapCenter: Position2D - (Optional, default [0,0]) center position where the map camera will be positioned
missionsArray: Array - (Optional, default []) list of selectable missions and their parameters, to format [pos, text, tooltip, picture, code]:
  • pos: Array - where the clickable marker will be placed
  • text: String - text that should be displayed next to the icon
  • tooltip: String - text to be displayed in the tooltip (on mouse over)
  • picture: String - location of the picture to be displayed in the tooltip
  • code: Code - code spawned when the icon is clicked
Return Value:
Number - index of the chosen mission

Examples

Example 1:
private _area = [750, 400]; private _missionsList = [ [ getMarkerPos "BIS_briefMarkerINFANTRY", "Infantry", "Your mission is to do stuff", "AnimBriefing\intro_stage1a_CA.paa", { hint "infantry mission selected" } ], [ getMarkerPos "BIS_briefMarkerSPECIALFORCES", "Special Forces", "Your mission is to do stuff but in a more special way", "AnimBriefing\intro_stage1a_CA.paa", { hint "special forces mission selected" } ] ]; private _index = [_area, getMarkerPos "BIS_cameraCenter", _missionsList] call BIS_fnc_missionSelector; private _missionDetails = _missionsList select _index;

Additional Information

See also:
playMission

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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_missionSelector&oldid=349497"