BIS_fnc_EGSpectator

From Bohemia Interactive Community
Revision as of 15:45, 8 November 2023 by Lou Montana (talk | contribs) (Text replacement - "(\|[pr][0-9]+ *= *[^- ]*) *- *P([a-gi-z ])" to "$1 - p$2")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search
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"
See the in-game Functions Viewer to see all the possible values. The following parameters are for "Initialize".
spectator: Object - player
whitelistedSides: Array - (Optional, default: []) sides that can be spectated
allowAi: Boolean - (Optional, default: false) whether AI can be viewed by the spectator
allowFreeCamera: Boolean - (Optional, default: true) whether free camera mode is available
allow3PPCamera: Boolean - (Optional, default: true) whether 3rd Person camera mode is available
showFocusInfo: Boolean - (Optional, default: true) whether to show Focus Info stats widget
showCameraButtons: Boolean - (Optional, default: true) whether or not to show camera buttons widget
showControlsHelper: Boolean - (Optional, default: true) whether to show controls helper widget
showHeader: Boolean - (Optional, default: true) whether to show header widget
showLists: Boolean - (Optional, default: true) 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