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 - "(\|[pr][0-9]+ *= *[^- ]*) *- *P([a-gi-z ])" to "$1 - p$2")
 
(4 intermediate revisions by the same user not shown)
Line 10: Line 10:
|s1= [mode, [spectator, whitelistedSides, allowAi, allowFreeCamera, allow3PPCamera, showFocusInfo, showCameraButtons, showControlsHelper, showHeader, showLists]] call [[BIS_fnc_EGSpectator]]
|s1= [mode, [spectator, whitelistedSides, allowAi, allowFreeCamera, allow3PPCamera, showFocusInfo, showCameraButtons, showControlsHelper, showHeader, showLists]] call [[BIS_fnc_EGSpectator]]


|p1= mode: [[String]] - Function mode, can be:
|p1= mode: [[String]] - function mode, can be:
*"Initialize"
* "Initialize"
*"Terminate"
* "Terminate"
'''There are more options available. See the [[Arma 3: Functions Viewer|ingame Functions Viewer]] for more information. The following parameters are for "Initialize".'''
'''See the [[Arma 3: Functions Viewer|in-game Functions Viewer]] to see all the possible values. The following parameters are for "Initialize".'''


|p2= spectator: [[Object]] - Player
|p2= spectator: [[Object]] - player


|p3= whitelistedSides (Optional, default: []): [[Array]] - Sides that can be spectated
|p3= whitelistedSides: [[Array]] - (Optional, default: []) sides that can be spectated


|p4= allowAi (Optional, default: [[true]]): [[Boolean]] - Whether AI can be viewed by the spectator
|p4= allowAi: [[Boolean]] - (Optional, default: [[false]]) whether AI can be viewed by the spectator


|p5= allowFreeCamera (Optional, default: [[true]]): [[Boolean]] - Whether free camera mode is available
|p5= allowFreeCamera: [[Boolean]] - (Optional, default: [[true]]) whether free camera mode is available


|p6= allow3PPCamera (Optional, default: [[true]]): [[Boolean]] - Whether 3rd Person camera mode is available
|p6= allow3PPCamera: [[Boolean]] - (Optional, default: [[true]]) whether 3rd Person camera mode is available


|p7= showFocusInfo (Optional, default: [[true]]): [[Boolean]] - Whether to show Focus Info stats widget
|p7= showFocusInfo: [[Boolean]] - (Optional, default: [[true]]) whether to show Focus Info stats widget


|p8= showCameraButtons (Optional, default: [[true]]): [[Boolean]] - Whether or not to show camera buttons widget
|p8= showCameraButtons: [[Boolean]] - (Optional, default: [[true]]) whether or not to show camera buttons widget


|p9= showControlsHelper (Optional, default: [[true]]): [[Boolean]] - Whether to show controls helper widget
|p9= showControlsHelper: [[Boolean]] - (Optional, default: [[true]]) whether to show controls helper widget


|p10= showHeader (Optional, default: [[true]]): [[Boolean]] - Whether to show header widget
|p10= showHeader: [[Boolean]] - (Optional, default: [[true]]) whether to show header widget


|p11= showLists (Optional, default: [[true]]): [[Boolean]] - Whether to show entities / locations lists
|p11= showLists: [[Boolean]] - (Optional, default: [[true]]) whether to show entities / locations lists


|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= <sqf>["Initialize", [player]] call BIS_fnc_EGSpectator;</sqf>


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

Latest revision as of 16:45, 8 November 2023

Arma 3 logo black.png1.54
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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_EGSpectator&oldid=348958"