BIS fnc EGSpectator: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Arma 3 ([^ACHJKLMTZ|])([^|]+)\]\]" to "Arma 3: $1$2")
m (Formatting)
Line 1: Line 1:
{{RV|type=function
{{RV|type=function


| arma3
|game1= arma3
 
|version1= 1.54
|1.54


|gr1= Spectator
|gr1= Spectator


|Spectator instance.
|descr= Spectator instance.


| [ mode,[specatator,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]] - Mode, can be <br>
|p1= mode: [[String]] - Function mode, can be:
*"Initialize"
*"Initialize"
*"Terminate"
*"Terminate"
'''There are more options available. See the ingame functions viewer for what they do. Following parameters are for "Initialize"'''
'''There are more options available. See the [[Arma 3: Functions Viewer|ingame Functions Viewer]] for more information. The following parameters are for "Initialize".'''
 
|p2= spectator: [[Object]] - Player


|p2= specatator: [[Object]] - Player
|p3= whitelistedSides (Optional, default: []): [[Array]] - Sides that can be spectated


|p3= whitelistedSides: [[Array]] - (Optional, default []) - Sides player can spectate
|p4= allowAi (Optional, default: [[true]]): [[Boolean]] - Whether AI can be viewed by the spectator


|p4= allowAi: [[Boolean]] - (Optional, default true) - 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 3th Person Perspective 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.
|[[Boolean]] - Return value depends on mode. For Initialize and terminate it returns boolean depending on whether or not execution was successful


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


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

Revision as of 21:12, 18 May 2021

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"
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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_EGSpectator&oldid=257648"