ACE3/addons/spectator/functions/fnc_ui.sqf
SilentSpike d3ce75daef Spectator overhaul (#5171)
- Overhauls the spectator module entirely to share a similar UX to BI's "End Game Spectator" while maintaining some of the extended flexibility of ACE Spectator.
- Simplifies spectator setup by reducing the number of settings. More advanced setup is still possible via the API functions provided.
2017-08-12 14:25:48 +01:00

147 lines
3.9 KiB
Plaintext

/*
* Author: SilentSpike
* Handles UI initialisation and destruction
*
* Arguments:
* 0: Init/Terminate <BOOL>
*
* Return Value:
* None
*
* Example:
* [false] call ace_spectator_fnc_ui
*
* Public: No
*/
#include "script_component.hpp"
params ["_init"];
// No change
if (_init isEqualTo !isNull SPEC_DISPLAY) exitWith {};
// Close map
openMap [false,false];
// Close any open dialogs
while {dialog} do {
closeDialog 0;
};
// Note that init and destroy intentionally happen in reverse order
// Init: Vars > Display > UI Stuff
// Destroy: UI Stuff > Display > Vars
if (_init) then {
// UI visibility tracking
GVAR(uiVisible) = true;
GVAR(uiHelpVisible) = true;
GVAR(uiMapVisible) = true;
GVAR(uiWidgetVisible) = true;
// Drawing related
GVAR(drawProjectiles) = false;
GVAR(drawUnits) = true;
GVAR(entitiesToDraw) = [];
GVAR(grenadesToDraw) = [];
GVAR(iconsToDraw) = [];
GVAR(locationsToDraw) = [];
GVAR(projectilesToDraw) = [];
// RMB tracking is used for follow camera mode
GVAR(holdingRMB) = false;
// List type is used for list updates and interaction
GVAR(uiListType) = LIST_ENTITIES;
// Highlighted map object is used for click and drawing events
GVAR(uiMapHighlighted) = objNull;
// Holds the current list data
GVAR(curList) = [];
// Cache view distance and set spectator default
GVAR(oldViewDistance) = viewDistance;
setViewDistance DEFAULT_VIEW_DISTANCE;
// If counter already exists handle it, otherwise display XEH will handle it
[GETUVAR(RscRespawnCounter,displayNull)] call FUNC(compat_counter);
// Create the display
MAIN_DISPLAY createDisplay QGVAR(display);
// Store default H value for scaling purposes
GVAR(uiHelpH) = (ctrlPosition CTRL_HELP) select 3;
// Initially hide map
[] call FUNC(ui_toggleMap);
// Initially fade the list
[true] call FUNC(ui_fadeList);
// Initalise the help, widget and list information
[] call FUNC(ui_updateCamButtons);
[] call FUNC(ui_updateListEntities);
[] call FUNC(ui_updateListFocus);
[] call FUNC(ui_updateWidget);
[] call FUNC(ui_updateHelp);
// Start updating things to draw
GVAR(collectPFH) = [LINKFUNC(ui_updateIconsToDraw), 0.2] call CBA_fnc_addPerFrameHandler;
// Draw icons and update the cursor object
GVAR(uiDraw3D) = addMissionEventHandler ["Draw3D", {call FUNC(ui_draw3D)}];
// Periodically update list and focus widget
GVAR(uiPFH) = [{
if (GVAR(uiListType) == LIST_ENTITIES) then {
[] call FUNC(ui_updateListEntities);
} else {
[] call FUNC(ui_updateListLocations);
};
[] call FUNC(ui_updateWidget);
}, 5] call CBA_fnc_addPerFrameHandler;
} else {
// Stop updating the list and focus widget
[GVAR(uiPFH)] call CBA_fnc_removePerFrameHandler;
// Stop drawing icons and tracking cursor object
removeMissionEventHandler ["Draw3D", GVAR(uiDraw3D)];
GVAR(uiDraw3D) = nil;
// Stop updating things to draw
[GVAR(collectPFH)] call CBA_fnc_removePerFrameHandler;
GVAR(collectPFH) = nil;
// Destroy the display
SPEC_DISPLAY closeDisplay 1;
// Stop tracking everything
GVAR(uiVisible) = nil;
GVAR(uiHelpVisible) = nil;
GVAR(uiMapVisible) = nil;
GVAR(uiWidgetVisible) = nil;
GVAR(holdingRMB) = nil;
GVAR(uiListType) = nil;
GVAR(uiMapHighlighted) = nil;
GVAR(curList) = nil;
GVAR(uiHelpH) = nil;
// Stop drawing
GVAR(drawProjectiles) = nil;
GVAR(drawUnits) = nil;
GVAR(entitiesToDraw) = nil;
GVAR(grenadesToDraw) = nil;
GVAR(iconsToDraw) = nil;
GVAR(locationsToDraw) = nil;
GVAR(projectilesToDraw) = nil;
// Reset view distance
setViewDistance GVAR(oldViewDistance);
GVAR(oldViewDistance) = nil;
// Ensure chat is shown again
showChat true;
};