BIS fnc EGSpectator: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category\:Function Group\: Spectator(\|\{\{[a-zA-Z0-9_:]+\}\})?\]\]" to "")
m (Text replacement - "_{10,} " to "")
Line 1: Line 1:
{{Function|Comments=
{{Function|Comments=
____________________________________________________________________________________________


| arma3 |Game name=
| arma3 |Game name=
Line 7: Line 6:


|gr1= Spectator |GROUP1=
|gr1= Spectator |GROUP1=
____________________________________________________________________________________________


|Spectator instance.|DESCRIPTION=
|Spectator instance.|DESCRIPTION=
____________________________________________________________________________________________


| [ mode,[specatator,whitelistedSides,allowAi,allowFreeCamera,allow3PPCamera,showFocusInfo,showCameraButtons,showControlsHelper,showHeader,showLists] ] call [[BIS_fnc_EGSpectator]];|SYNTAX=
| [ mode,[specatator,whitelistedSides,allowAi,allowFreeCamera,allow3PPCamera,showFocusInfo,showCameraButtons,showControlsHelper,showHeader,showLists] ] call [[BIS_fnc_EGSpectator]];|SYNTAX=
Line 39: Line 36:
|p11= showLists: [[Boolean]] - (Optional, default true) - Whether to show entities / locations lists |PARAMETER11=
|p11= showLists: [[Boolean]] - (Optional, default true) - Whether to show entities / locations lists |PARAMETER11=
|[[Boolean]] - Return value depends on mode. For Initialize and terminate it returns boolean depending on whether or not execution was successful|RETURNVALUE=
|[[Boolean]] - Return value depends on mode. For Initialize and terminate it returns boolean depending on whether or not execution was successful|RETURNVALUE=
____________________________________________________________________________________________


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


|[[Arma 3 End Game Spectator Mode]] |SEEALSO=
|[[Arma 3 End Game Spectator Mode]] |SEEALSO=

Revision as of 22:45, 16 January 2021

Hover & click on the images for description

Description

Description:
Spectator instance.
Execution:
call
Groups:
Spectator

Syntax

Syntax:
[ mode,[specatator,whitelistedSides,allowAi,allowFreeCamera,allow3PPCamera,showFocusInfo,showCameraButtons,showControlsHelper,showHeader,showLists] ] call BIS_fnc_EGSpectator;
Parameters:
mode: String - Mode, can be
  • "Initialize"
  • "Terminate"
There are more options available. See the ingame functions viewer for what they do. Following parameters are for "Initialize"
specatator: Object - Player
whitelistedSides: Array - (Optional, default []) - Sides player can spectate
allowAi: Boolean - (Optional, default true) - 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 3th Person Perspective 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 - Return value depends on mode. For Initialize and terminate it returns boolean depending on whether or not execution was successful

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

Notes

Bottom Section