BIS fnc missionSelector: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (infobox to template)
(Page filling)
Line 7: Line 7:
<!---|arg= local |Multiplayer Arguments=--->
<!---|arg= local |Multiplayer Arguments=--->


<!---|eff= local |Multiplayer Effects=--->
|eff= local |Multiplayer Effects=


| <pre>/*
| Function that draws clickable, hoverable and animated icons on the map that execute a user-defined code when pressed. |Description=
Author: Riccardo Argiolas


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


Parameters:
|p1= area: [[Array]] of [[Number]] - (Optional, default [100,100]) used to determine map's zoom, format [width, height] |Parameter 1=
Select 0 - ARRAY: center position of where the camera will be positioned.
Select 1 - ARRAY: list of selectable missions and their parameters.
Select X - Array element
Select 0 - ARRAY: where the clickable marker will be placed.
Select 1 - STRING: text that should be displayed next to the icon.
Select 2 - STRING: text to be displayed in the tooltip (on mouse over).
Select 3 - STRING: directory of the picture to be displayed in the tooltip.
Select 4 - CODE: code spawned when the icon is clicked.


|p2= mapCenter: [[Position2D]] - (Optional, default [0,0]) center position where the map camera will be positioned |Parameter 2=


Returns:
|p3= missionsArray: [[Array]] - (Optional, default []) list of selectable missions and their parameters, to format [pos, text, tooltip, picture, code]:
NUMBER: chosen mission (index of the list of selectable missions)
* 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
|Parameter 3=


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


_listOfMissions =  
|x1= <code>[[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"}
]
]
];
];
_selectedMissionIndex = [getMarkerPos "BIS_cameraCenter", _listOfMissions] call BIS_fnc_missionSelector;
*/</pre>{{placeholder}}<!-- Remove this after fill-in --> |Description=


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


|p1= parameter: Datatype - (Optional, default defValue) description |Parameter 1=
|exec= call |Execution=


|Datatype - description|Return value=
| [[playMission]] |See also=
}}


|x1= <code></code>|Example 1=


|exec= call |Execution=
<h3 style="display:none">Notes</h3>


| |See also=
}}


<h3 style="display:none">Bottom Section</h3>
[[Category:Function Group: Systems|{{uc:missionSelector}}]]
[[Category:Function Group: Systems|{{uc:missionSelector}}]]
[[Category:Functions|{{uc:missionSelector}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:missionSelector}}]]

Revision as of 00:29, 9 April 2020

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:
Uncategorised

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


Notes


Bottom Section

Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_missionSelector&oldid=151552"