BIS fnc EGSpectator: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "= <code>([^<]*)\[\[([a-zA-Z][a-zA-Z0-_]+)\]\]([^<]*)<\/code>" to "= <code>$1$2$3</code>")
m (Text replacement - "= <code>([^<]*)\[\[([a-zA-Z][a-zA-Z0-_]+)\]\]([^<]*)<\/code>" to "= <code>$1$2$3</code>")
Line 37: Line 37:
|r1= [[Boolean]] - The return value depends on the mode. For "Initialize" and "Terminate" a [[Boolean]] indicating successful execution is returned.
|r1= [[Boolean]] - The return value depends on the mode. For "Initialize" and "Terminate" a [[Boolean]] indicating successful execution is returned.


|x1= <code>["Initialize", [player]] call [[BIS_fnc_EGSpectator]];</code>
|x1= <code>["Initialize", [player]] call BIS_fnc_EGSpectator;</code>


|seealso= [[Arma 3: End Game Spectator Mode]]
|seealso= [[Arma 3: End Game Spectator Mode]]
}}
}}

Revision as of 16:56, 13 July 2022

Hover & click on the images for description

Description

Description:
Spectator instance.
Execution:
call
Groups:
Spectator

Syntax

Syntax:
[mode, [spectator, whitelistedSides, allowAi, allowFreeCamera, allow3PPCamera, showFocusInfo, showCameraButtons, showControlsHelper, showHeader, showLists]] call BIS_fnc_EGSpectator
Parameters:
mode: String - Function mode, can be:
  • "Initialize"
  • "Terminate"
There are more options available. See the ingame Functions Viewer for more information. The following parameters are for "Initialize".
spectator: Object - Player
whitelistedSides (Optional, default: []): Array - Sides that can be spectated
allowAi (Optional, default: true): Boolean - Whether AI can be viewed by the spectator
allowFreeCamera (Optional, default: true): Boolean - Whether free camera mode is available
allow3PPCamera (Optional, default: true): Boolean - Whether 3rd Person camera mode is available
showFocusInfo (Optional, default: true): Boolean - Whether to show Focus Info stats widget
showCameraButtons (Optional, default: true): Boolean - Whether or not to show camera buttons widget
showControlsHelper (Optional, default: true): Boolean - Whether to show controls helper widget
showHeader (Optional, default: true): Boolean - Whether to show header widget
showLists (Optional, default: true): Boolean - Whether to show entities / locations lists
Return Value:
Boolean - The return value depends on the mode. For "Initialize" and "Terminate" a Boolean indicating successful execution is returned.

Examples

Example 1:
["Initialize", [player]] call BIS_fnc_EGSpectator;

Additional Information

See also:
Arma 3: End Game Spectator Mode

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