BIS fnc diagAAR: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(Page filling - missing see also (WIP?))
m (Text replacement - "Script handle" to "Script Handle")
 
(30 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Function|= Comments
{{RV|type=function
____________________________________________________________________________________________


| arma3 |= Game name
|game1= arma3
|version1= 1.00


|1.00|= Game version
|gr1= Diagnostic
____________________________________________________________________________________________


| Show '''AAR''' display (end mission display) and fill it with '''BIS_fnc_diagAAR_data''' content. Engine use, as it ends the mission. |= Description
|descr= Fill an '''AAR''' (After Action Review) display with data and Event Handlers.<br>
____________________________________________________________________________________________
{{Feature|important|
[[BIS_fnc_diagAARrecord]] '''must''' have been previously executed to have data to display.}}


| [mode, arguments] call [[BIS_fnc_diagAAR]] |= Syntax
|s1= [mode, arguments] call [[BIS_fnc_diagAAR]]


|p1= mode: [[String]] - can be one of:
|p1= mode: [[String]] - can be one of:
* "Init" - Starts '''AAR'''
* "Init" - Fill display with AAR data
* "Init_List" - ''internal function usage''
* "Init_List" - ''internal function usage''
* "Display_keydown" - ''internal function usage''
* "Display_keydown" - ''internal function usage''
Line 19: Line 19:
* "ListMissions_lbselchanged" - ''internal function usage''
* "ListMissions_lbselchanged" - ''internal function usage''
* "ListSessions_lbselchanged" - ''internal function usage''
* "ListSessions_lbselchanged" - ''internal function usage''
* "draw" - ''internal function usage'' |= Parameter 1
* "draw" - ''internal function usage''


|p2= arguments: [[Anything]] - (Optional, default [])
|p2= arguments:
* "Init" arguments: display: [[Display]]
* "Init" arguments: [display]: [[Display]]
* "Init_List" arguments: display: [[Display]]
* "Init_List" arguments: [display]: [[Display]]
* "Display_keydown" arguments: see [[User_Interface_Event_Handlers#onKeyDown|onKeyDown]] event
* "Display_keydown" arguments: see [[User_Interface_Event_Handlers#onKeyDown|onKeyDown]] event
* "Timeline_sliderposchanged" arguments: see [[User_Interface_Event_Handlers#onSliderPosChanged|onSliderPosChanged]] event
* "Timeline_sliderposchanged" arguments: see [[User_Interface_Event_Handlers#onSliderPosChanged|onSliderPosChanged]] event
* "ListMissions_lbselchanged" arguments: see [[User_Interface_Event_Handlers#onLbSelChanged|onLbSelChanged]] event
* "ListMissions_lbselchanged" arguments: see [[User_Interface_Event_Handlers#onLbSelChanged|onLBSelChanged]] event
* "ListSessions_lbselchanged" arguments: see [[User_Interface_Event_Handlers#onLbSelChanged|onLbSelChanged]] event
* "ListSessions_lbselchanged" arguments: see [[User_Interface_Event_Handlers#onLbSelChanged|onLBSelChanged]] event
* "draw" arguments: see [[User_Interface_Event_Handlers#onDraw|onDraw]] event |= Parameter 2
* "draw" arguments: see [[User_Interface_Event_Handlers#onDraw|onDraw]] event


| [[Script_(handle)|Script handle]] |= Return value
|r1= [[Script Handle]]
____________________________________________________________________________________________


|x1= <code>["Init", <nowiki>[</nowiki>[[call]] [[BIS_fnc_displayMission]]]] [[call]] [[BIS_fnc_diagAAR]];</code> |= Example 1
|x1= <sqf>["Init", [_anAARDisplay]] call BIS_fnc_diagAAR;</sqf>
____________________________________________________________________________________________


| |= See also
|seealso= [[BIS_fnc_diagAARrecord]]
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Function Group: Diagnostic|{{uc:diagAAR}}]]
[[Category:Functions|{{uc:diagAAR}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:diagAAR}}]]

Latest revision as of 19:17, 9 August 2022

Hover & click on the images for description

Description

Description:
Fill an AAR (After Action Review) display with data and Event Handlers.
BIS_fnc_diagAARrecord must have been previously executed to have data to display.
Execution:
call
Groups:
Diagnostic

Syntax

Syntax:
[mode, arguments] call BIS_fnc_diagAAR
Parameters:
mode: String - can be one of:
  • "Init" - Fill display with AAR data
  • "Init_List" - internal function usage
  • "Display_keydown" - internal function usage
  • "Timeline_sliderposchanged" - internal function usage
  • "ListMissions_lbselchanged" - internal function usage
  • "ListSessions_lbselchanged" - internal function usage
  • "draw" - internal function usage
arguments:
Return Value:
Script Handle

Examples

Example 1:
["Init", [_anAARDisplay]] call BIS_fnc_diagAAR;

Additional Information

See also:
BIS_fnc_diagAARrecord

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