ACE3/addons/spectator/XEH_preInit.sqf

#include "script_component.hpp"

ADDON = false;

PREP(cacheUnitInfo);
PREP(cycleCamera);
PREP(handleCamera);
PREP(handleCompass);
PREP(handleIcons);
PREP(handleInterface);
PREP(handleMap);
PREP(handleMouse);
PREP(handleToolbar);
PREP(handleUnits);
PREP(interrupt);
PREP(moduleSpectatorSettings);
PREP(respawnTemplate);
PREP(setCameraAttributes);
PREP(setSpectator);
PREP(stageSpectator);
PREP(transitionCamera);
PREP(toggleInterface);
PREP(updateCameraModes);
PREP(updateSpectatableSides);
PREP(updateUnits);
PREP(updateVisionModes);

// Permanent variables
GVAR(availableModes) = [0,1,2];
GVAR(availableSides) = [west,east,resistance,civilian];
GVAR(availableVisions) = [-2,-1,0,1];

GVAR(camAgent) = objNull;
GVAR(camDistance) = 10;
GVAR(camMode) = 0;
GVAR(camPan) = 0;
GVAR(camPos) = ATLtoASL [worldSize * 0.5, worldSize * 0.5, 20];
GVAR(camSpeed) = 2.5;
GVAR(camTilt) = -10;
GVAR(camUnit) = objNull;
GVAR(camVision) = -2;
GVAR(camZoom) = 1.25;

GVAR(interrupts) = [];
GVAR(isSet) = false;

GVAR(showComp) = true;
GVAR(showHelp) = true;
GVAR(showIcons) = true;
GVAR(showInterface) = true;
GVAR(showMap) = false;
GVAR(showTool) = true;
GVAR(showUnit) = true;

GVAR(unitList) = [];
GVAR(unitBlacklist) = [];
GVAR(unitWhitelist) = [];
GVAR(groupList) = [];

ADDON = true;
Add Spectator. 2015-06-29 02:34:21 +00:00			`#include "script_component.hpp"`

			`ADDON = false;`

Cache unit information 2015-07-24 16:13:03 +00:00			`PREP(cacheUnitInfo);`
Add camera cycling function 2015-07-21 12:31:13 +00:00			`PREP(cycleCamera);`
Handle free cam movement 2015-07-15 11:11:19 +00:00			`PREP(handleCamera);`
Enable compass, auto-refresh units, pass display to PFHs 2015-07-19 01:25:52 +00:00			`PREP(handleCompass);`
Handle unit icons and provide setting 2015-07-25 11:28:03 +00:00			`PREP(handleIcons);`
Initalize interface 2015-07-15 11:03:54 +00:00			`PREP(handleInterface);`
Overhaul spectator icon handling and rendering - Optimize and improve 3D icon drawing - Combine 2D and 3D PFHs into 1 - Render group icons outside of 200m, unit icons within - Store list of groups on units update to cut down on what needs to be done each frame - Change map control type to 100 to remove all default unit icons - Improve colour caching, group colours don't change, unit colours do - Remove icon setting, toggling should be at users discretion 2015-08-06 12:42:31 +00:00			`PREP(handleMap);`
Handle free cam movement 2015-07-15 11:11:19 +00:00			`PREP(handleMouse);`
Handle toolbar values 2015-07-19 15:35:53 +00:00			`PREP(handleToolbar);`
Naming consistency 2015-07-18 15:20:19 +00:00			`PREP(handleUnits);`
Add spectator UI interrupt system A public API system to allow external systems to interrupt and resume the spectator interface. Also made use of it for the escape menu and zeus support. 2015-08-21 23:26:01 +00:00			`PREP(interrupt);`
Updating ace settings 2015-07-17 15:02:38 +00:00			`PREP(moduleSpectatorSettings);`
Replace spectator respawn changes with a template Hacking the BI respawn framework to support a spectator setting was intrusive and limiting. Instead of using a setting, I've opted to introduce a new respawn template that can be used within BI's respawn framework. The benefits of this approach are: - Compatibility isn't a concern, that responsibility is shifted onto mission designers. - Mission designers can use the functionality of the BI framework alongside the spectator system (combining templates, using different templates for different sides, etc.). - If a custom respawn framework is used, then this doesn't change anything. Custom frameworks are still fully supported via the public functions provided. - Remains simple to set up, just requires a description.ext edit 2015-08-04 21:11:34 +00:00			`PREP(respawnTemplate);`
Set camera attributes 2015-07-20 21:45:28 +00:00			`PREP(setCameraAttributes);`
Initial enter/exit function implementation 2015-07-02 23:53:26 +00:00			`PREP(setSpectator);`
Separate spectator physical and virtual states With the changes planned to allow spectator in the true death state, physical changes aren't applicable in all of the possible usage cases. This separates the physical process into new function ace_spectator_fnc_stageSpectator 2015-08-01 17:10:11 +00:00			`PREP(stageSpectator);`
Altered naming conventions 2015-07-20 21:45:11 +00:00			`PREP(transitionCamera);`
			`PREP(toggleInterface);`
Public functions to tweak available vision/camera modes 2015-07-21 19:19:54 +00:00			`PREP(updateCameraModes);`
New function to precisely control spectatable sides 2015-07-25 10:32:42 +00:00			`PREP(updateSpectatableSides);`
Handling the spectatable unit list 2015-07-15 13:58:38 +00:00			`PREP(updateUnits);`
Public functions to tweak available vision/camera modes 2015-07-21 19:19:54 +00:00			`PREP(updateVisionModes);`
Variable handling and consistency 2015-07-18 14:52:44 +00:00
			`// Permanent variables`
Add camera cycling function 2015-07-21 12:31:13 +00:00			`GVAR(availableModes) = [0,1,2];`
New function to precisely control spectatable sides 2015-07-25 10:32:42 +00:00			`GVAR(availableSides) = [west,east,resistance,civilian];`
Add camera cycling function 2015-07-21 12:31:13 +00:00			`GVAR(availableVisions) = [-2,-1,0,1];`

Replace spectator respawn changes with a template Hacking the BI respawn framework to support a spectator setting was intrusive and limiting. Instead of using a setting, I've opted to introduce a new respawn template that can be used within BI's respawn framework. The benefits of this approach are: - Compatibility isn't a concern, that responsibility is shifted onto mission designers. - Mission designers can use the functionality of the BI framework alongside the spectator system (combining templates, using different templates for different sides, etc.). - If a custom respawn framework is used, then this doesn't change anything. Custom frameworks are still fully supported via the public functions provided. - Remains simple to set up, just requires a description.ext edit 2015-08-04 21:11:34 +00:00			`GVAR(camAgent) = objNull;`
Change spectator external camera behaviour Using the "external" view is limited by the server difficulty setting. Instead the spectator external camera has been replaced with an oribtal camera as was originally planned to be added alongside the default views. 2015-09-09 22:21:49 +00:00			`GVAR(camDistance) = 10;`
Variable handling and consistency 2015-07-18 14:52:44 +00:00			`GVAR(camMode) = 0;`
			`GVAR(camPan) = 0;`
setCameraAttributes should use ATL 2015-07-21 17:07:55 +00:00			`GVAR(camPos) = ATLtoASL [worldSize * 0.5, worldSize * 0.5, 20];`
Add keys to adjust spectator camera speed and zoom Allows for finer control of the speed and zoom, as well as a quick way to reset either. 2015-08-08 17:31:37 +00:00			`GVAR(camSpeed) = 2.5;`
camTilt should persist 2015-07-20 22:20:05 +00:00			`GVAR(camTilt) = -10;`
Variable handling and consistency 2015-07-18 14:52:44 +00:00			`GVAR(camUnit) = objNull;`
Camera vision modes 2015-07-21 10:59:20 +00:00			`GVAR(camVision) = -2;`
Default value update 2015-07-21 21:56:47 +00:00			`GVAR(camZoom) = 1.25;`
Add Spectator. 2015-06-29 02:34:21 +00:00
Add spectator UI interrupt system A public API system to allow external systems to interrupt and resume the spectator interface. Also made use of it for the escape menu and zeus support. 2015-08-21 23:26:01 +00:00			`GVAR(interrupts) = [];`
Enable ace_spectator respawn framework integration Seamlessly integrates the spectator system with the vanilla respawn framework when the onDeath setting is enabled. This commit makes a lot of changes: - Edit BI functions used by the vanilla respawn framework to enable support for ace_spectator. - Set spectator state is now tracked using a GVAR for the local player since using a unit won't be reliable all of the time. However unit is still marked for any filtering purposes. - Instead of NV being used based on the sun to moon transition state by default, that functionality only takes place in the integrated system so that custom frameworks can do what they want. - Seagull units are hidden when using framework integration since they're spawned by the engine with respawn type 1 and they just hang around undesirably 2015-08-03 20:38:44 +00:00			`GVAR(isSet) = false;`
Clear spectator display variable at preInit uiNamespace persists between missions and should be reset on mission start 2015-08-02 11:34:35 +00:00
Interface toggles 2015-07-18 14:42:07 +00:00			`GVAR(showComp) = true;`
			`GVAR(showHelp) = true;`
Adding icon toggle 2015-07-24 16:23:25 +00:00			`GVAR(showIcons) = true;`
Interface toggles 2015-07-18 14:42:07 +00:00			`GVAR(showInterface) = true;`
			`GVAR(showMap) = false;`
			`GVAR(showTool) = true;`
			`GVAR(showUnit) = true;`

Improving unit list handling 2015-07-16 10:15:33 +00:00			`GVAR(unitList) = [];`
			`GVAR(unitBlacklist) = [];`
			`GVAR(unitWhitelist) = [];`
Overhaul spectator icon handling and rendering - Optimize and improve 3D icon drawing - Combine 2D and 3D PFHs into 1 - Render group icons outside of 200m, unit icons within - Store list of groups on units update to cut down on what needs to be done each frame - Change map control type to 100 to remove all default unit icons - Improve colour caching, group colours don't change, unit colours do - Remove icon setting, toggling should be at users discretion 2015-08-06 12:42:31 +00:00			`GVAR(groupList) = [];`
Improving unit list handling 2015-07-16 10:15:33 +00:00
Blank space cleanup 2015-07-04 23:10:01 +00:00			`ADDON = true;`