ACE3/documentation/feature/spectator.md

layout	title	description	group	category	parent
wiki	Spectator	A flexible spectator system	feature	interaction	wiki

Please note:

This is not part of ACE3 yet. It will be released in a future version.

1. Overview

The ACE3 spectator system is designed to act as a flexible and easy to configure framework. Most scenarios can be set up as desired using only the settings provided, however public functions are available for finer control of these configurable aspects.

1.1 Spectator System

The current iteration of the ACE3 spectator system only officially supports scenarios using respawn type 3 (or "BASE"). However there's nothing to stop its use alongside anything else, just be aware that it might not function entirely as expected.

By default, the ACE3 spectator system does nothing - meaning existing missions will behave exactly as before. The setting ace_spectator_onDeath can be used to automatically put players into spectator mode each time they die.

For mission makers who seek a more advanced setup (such as multiple lives or wave respawning) the function ace_spectator_fnc_setSpectator is provided to transition players to/from spectator mode as desired:

 * Arguments:
 * 0: Unit to put into spectator state <OBJECT>
 * 1: New spectator state <BOOL> <OPTIONAL>
 *
 * Return Value:
 * None <NIL>
 *
 * Example:
 * [player, true] call ace_spectator_fnc_setSpectator

1.2 Spectatable Units

Spectatable units are stored in an automatically maintained list (ace_spectator_unitList) on each client. However, directly accessing this list is not encouraged. Instead mission makers have two tools at their disposal to tweak the list:

• Unit filter
• Unit whitelist/blacklist

The unit filter determines which units will automatically be used to populate the spectatable unit list. It's controlled by setting ace_spectator_filterUnits and there are three possible options:

• No units
• Player units (default)
• All units

In cases where more specific control is required function ace_spectator_fnc_updateUnits can be used to whitelist units from the filter or blacklist them from the list (on the local client):

 * Arguments:
 * 0: Units to add to the whitelist <ARRAY>
 * 1: Use blacklist <BOOL> <OPTIONAL>
 *
 * Return Value:
 * None <NIL>
 *
 * Example:
 * [allUnits,true] call ace_spectator_fnc_updateUnits
 *

1.3 Spectatable Sides

Spectatable sides can simply be considered an extra layer of filtering for the spectatable unit list. Again, there are two methods of controlling the spectatable sides:

• Side filter
• Side list

The side list is exactly what it sounds like, a list of sides spectatable by the local client. However, unlike spectatable units the side list remains static and can only be updated manually. This is because the side filter is applied on top of the side list whenever the unit list is automatically maintained - meaning the unit list will update if the player changes side or if the side relations change.

Note that the unit whitelist/blacklist also serves to override this side filtering mechanism.

The default side list is [west,east,resistance,civilian] and to update it (on the local client) function ace_spectator_fnc_updateSpectatableSides can be used:

 * Arguments:
 * 0: Sides to add <ARRAY>
 * 1: Sides to remove <ARRAY>
 *
 * Return Value:
 * Spectatable sides <ARRAY>
 *
 * Example:
 * [[west], [east,civilian]] call ace_spectator_fnc_updateSpectatableSides

The side filter determines which sides from the side list are valid each time the unit list is updated. It's controlled by setting ace_spectator_filterSides and there are four possible options:

• Player side (default)
• Friendly sides
• Hostile sides
• All sides

1.4 Camera Modes

There are 3 possible camera modes:

• Free
• Internal
• External

Mission makers can control the camera modes available to spectators via the setting ace_spectator_restrictModes. Function ace_spectator_fnc_updateCameraModes is also provided to alter the available modes (to the local player) as desired at any point in the mission:

 * Arguments:
 * 0: Camera modes to add <ARRAY>
 * 1: Camera modes to remove <ARRAY>
 *
 * Return Value:
 * Available camera modes <ARRAY>
 *
 * Example:
 * [[0], [1,2]] call ace_spectator_fnc_updateCameraModes

1.5 Vision Modes

Vision modes are only available in free camera mode. By default there are 4 available vision modes:

• Normal
• Night vision
• Thermal imaging (white hot)
• Thermal imaging (black hot)

Mission makers can control which of these vision modes are available to spectators via the setting ace_spectator_restrictVisions. However, there are actually a total of 10 possible vision modes and function ace_spectator_fnc_updateVisionModes can be used to alter which of them are available (to the local player) at any point in the mission:

 * Possible vision modes are:
 *   - -2: Normal
 *   - -1: Night vision
 *   -  0: White hot
 *   -  1: Black hot
 *   -  2: Light Green Hot / Darker Green cold
 *   -  3: Black Hot / Darker Green cold
 *   -  4: Light Red Hot / Darker Red Cold
 *   -  5: Black Hot / Darker Red Cold
 *   -  6: White Hot / Darker Red Cold
 *   -  7: Thermal (Shade of Red and Green, Bodies are white)
 *
 * Arguments:
 * 0: Vision modes to add <ARRAY>
 * 1: Vision modes to remove <ARRAY>
 *
 * Return Value:
 * Available vision modes <ARRAY>
 *
 * Example:
 * [[0], [1,2]] call ace_spectator_fnc_updateVisionModes

1.6 Camera Attributes

The spectator camera has 8 manipulatable attributes:

• Camera mode: The camera view
• Camera unit: The unit used for internal and external view
• Camera vision: The vision mode used by the free camera
• Camera position: The position of the free camera
• Camera pan: The pan (direction/heading) of the free camera
• Camera tilt: The tilt (pitch) of the free camera
• Camera zoom: The zoom level of the free camera
• Camera speed: The movement speed of the free camera

Function ace_spectator_fnc_setCameraAttributes can be used to change any of these attributes at ay point (including before spectator has ever opened):

 * Arguments:
 * 0: Camera mode <NUMBER> <OPTIONAL>
 *   - 0: Free
 *   - 1: Internal
 *   - 2: External
 * 1: Camera unit (objNull for random) <OBJECT> <OPTIONAL>
 * 2: Camera vision <NUMBER> <OPTIONAL>
 *   - -2: Normal
 *   - -1: Night vision
 *   -  0: Thermal white hot
 *   -  1: Thermal black hot
 * 3: Camera position (ATL) <ARRAY> <OPTIONAL>
 * 4: Camera pan (0 - 360) <NUMBER> <OPTIONAL>
 * 5: Camera tilt (-90 - 90) <NUMBER> <OPTIONAL>
 * 6: Camera zoom (0.01 - 2) <NUMBER> <OPTIONAL>
 * 7: Camera speed in m/s (0.05 - 10) <NUMBER> <OPTIONAL>
 *
 * Return Value:
 * None <NIL>
 *
 * Example:
 * [1, objNull] call ace_spectator_fnc_setCameraAttributes

2. Usage

2.1 Spectator Shortcuts

Shortcuts are currently hardcoded in the ACE3 spectator system. Future versions are likely to change that.

2.1.1 Interface Shortcuts

Shortcut	Action
H	Toggle help
M	Toggle map
1	Toggle unit list
2	Toggle toolbar
3	Toggle compass
4	Toggle unit icons
Backspace	Toggle interface

2.1.2 Free Camera Shortcuts

Shortcut	Action
W	Camera forward
S	Camera backward
A	Camera left
D	Camera right
Q	Camera up
Z	Camera down
LMB	Camera dolly
RMB	Camera pan and tilt
Scrollwheel	Zoom +/-
Ctrl+Scrollwheel	Speed +/-
N	Next vision mode
Ctrl+N	Previous vision mode

2.1.3 Unit Camera Shortcuts

Shortcut	Action
Right arrow	Next unit
Left arrow	Previous unit
RMB	Toggle gun camera

2.1.4 General shortcuts

Shortcut	Action
Up arrow	Next camera
Down arrow	Previous camera

2.2 The Interface

2.2.1 Unit list

The unit list on the left lists all of the units currently available to spectate. Double click on any unit name in the list to switch to the unit. Double click on the current unit to switch between internal and external view.

2.2.2 Toolbar

The toolbar along the bottom of the screen displays various useful values. From left to right these are:

• Unit name
• Camera mode
• Camera zoom/Unit side
• 24-hour Clock
• Vision mode/Unit depth
• Camera/Unit speed

2.2.3 Map

The map overlay will show the current position of the free camera and all spectatable units. The unit icons are tied into the unit icon toggle shortcut. When spectating a unit the map will also show the icons of units it knows about. In free camera you can double click on the map to teleport the camera to the position of the mouse.

3. Dependencies

ace_common