BIS fnc diagAAR: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (1 revision)
m (Text replacement - "Script handle" to "Script Handle")
 
(31 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{RV|type=function


{{Function|= Comments
|game1= arma3
____________________________________________________________________________________________
|version1= 1.00


| arma3 |= Game name
|gr1= Diagnostic


|1.00|= Game version
|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.}}


| <pre>#define AAR_VERSION 1.02
|s1= [mode, arguments] call [[BIS_fnc_diagAAR]]
#define GUI_MAP (_display displayctrl 2201)
#define GUI_BACKGROUND (_display displayctrl 1000)
#define GUI_TIMELINE (_display displayctrl 1900)
#define GUI_TOP (_display displayctrl 1100)
#define GUI_LIST_MISSIONS (_display displayctrl 2100)
#define GUI_LIST_SESSIONS (_display displayctrl 2101)
#define GUI_IDC (_display displayctrl _idc)
#define PROFILE_AAR_VARNAME "BIS_fnc_diagAAR_data"
#define PROFILE_AAR (profilenamespace getvariable [PROFILE_AAR_VARNAME,[]])


#define ID_META_VERSION 0
|p1= mode: [[String]] - can be one of:
#define ID_META_SEED 1
* "Init" - Fill display with AAR data
#define ID_META_PLAYER 2
* "Init_List" - ''internal function usage''
#define ID_META_PLAYERNAME 3
* "Display_keydown" - ''internal function usage''
#define ID_META_UNITS 4
* "Timeline_sliderposchanged" - ''internal function usage''
#define ID_META_DELAY 5
* "ListMissions_lbselchanged" - ''internal function usage''
* "ListSessions_lbselchanged" - ''internal function usage''
* "draw" - ''internal function usage''


#define ID_VAR_UNIT 0
|p2= arguments:
#define ID_TYPEOF 1
* "Init" arguments: [display]: [[Display]]
#define ID_SIDE 2
* "Init_List" arguments: [display]: [[Display]]
#define ID_DAMAGE 3
* "Display_keydown" arguments: see [[User_Interface_Event_Handlers#onKeyDown|onKeyDown]] event
#define ID_POSITION 4
* "Timeline_sliderposchanged" arguments: see [[User_Interface_Event_Handlers#onSliderPosChanged|onSliderPosChanged]] event
#define ID_DIRECTION 5
* "ListMissions_lbselchanged" arguments: see [[User_Interface_Event_Handlers#onLbSelChanged|onLBSelChanged]] event
#define ID_COMMANDER 6
* "ListSessions_lbselchanged" arguments: see [[User_Interface_Event_Handlers#onLbSelChanged|onLBSelChanged]] event
* "draw" arguments: see [[User_Interface_Event_Handlers#onDraw|onDraw]] event


#define RGB_SELECTED 1,0,0
|r1= [[Script Handle]]
#define RGB_DISABLED 0,0,0
#define COLOR_SELECTED [RGB_SELECTED,1]
#define COLOR_SELECTED_FADED [RGB_SELECTED,0.1]
#define COLOR_DISABLED [RGB_DISABLED,0.4]
#define COLOR_DISABLED_FADED [RGB_DISABLED,0.05]
#define COLOR_DEATH [0,0,0,1]
#define ICON_SIZE 32


//--- Function called before display - create display and terminate
|x1= <sqf>["Init", [_anAARDisplay]] call BIS_fnc_diagAAR;</sqf>
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
____________________________________________________________________________________________
 
| <!-- [] call [[BIS_fnc_diagAAR]]; --> |= Syntax
 
|p1= |= Parameter 1
 
| |= Return value
____________________________________________________________________________________________
 
|x1= <code></code> |=
____________________________________________________________________________________________
 
| |= 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

Arma 3 logo black.png1.00
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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_diagAAR&oldid=329963"