BIS fnc EGSpectator: Difference between revisions

Latest revision as of 16:45, 8 November 2023

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

@@ Line 1: / Line 1: @@
+{{RV|type=function
-{{Function|= Comments
+|game1= arma3
-____________________________________________________________________________________________
+|version1= 1.54
-| arma3 |= Game name
+|gr1= Spectator
-|1.00|= Game version
+|descr= Spectator instance.
-____________________________________________________________________________________________
-| <pre>/*
+|s1= [mode, [spectator, whitelistedSides, allowAi, allowFreeCamera, allow3PPCamera, showFocusInfo, showCameraButtons, showControlsHelper, showHeader, showLists]] call [[BIS_fnc_EGSpectator]]
-	Author:
-	Nelson Duarte
-	Description:
+|p1= mode: [[String]] - function mode, can be:
-	Spectator instance
+* "Initialize"
+* "Terminate"
+'''See the [[Arma 3: Functions Viewer|in-game Functions Viewer]] to see all the possible values. The following parameters are for "Initialize".'''
-	Returns:
+|p2= spectator: [[Object]] - player
-	Multiple values / none
-	Examples:
+|p3= whitelistedSides: [[Array]] - (Optional, default: []) sides that can be spectated
-	["Initialize", [player]] call BIS_fnc_EGSpectator; 	// Initializes spectator for given player
-	["Terminate"] call BIS_fnc_EGSpectator; 			// Terminates spectator for given player
-*/
-// Do not execute from within 3DEN
-</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |DESCRIPTION=
-____________________________________________________________________________________________
-| <!-- [] call [[BIS_fnc_EGSpectator]]; --> |SYNTAX=
+|p4= allowAi: [[Boolean]] - (Optional, default: [[false]]) whether AI can be viewed by the spectator
-|p1= |PARAMETER1=
-| |RETURNVALUE=
+|p5= allowFreeCamera: [[Boolean]] - (Optional, default: [[true]]) whether free camera mode is available
-____________________________________________________________________________________________
-|x1= <code></code> |=
+|p6= allow3PPCamera: [[Boolean]] - (Optional, default: [[true]]) whether 3rd Person camera mode is available
-____________________________________________________________________________________________
-| |SEEALSO=
+|p7= showFocusInfo: [[Boolean]] - (Optional, default: [[true]]) whether to show Focus Info stats widget
-}}
+|p8= showCameraButtons: [[Boolean]] - (Optional, default: [[true]]) whether or not to show camera buttons widget
+|p9= showControlsHelper: [[Boolean]] - (Optional, default: [[true]]) whether to show controls helper widget
+|p10= showHeader: [[Boolean]] - (Optional, default: [[true]]) whether to show header widget
+|p11= showLists: [[Boolean]] - (Optional, default: [[true]]) whether to show entities / locations lists
-<h3 style="display:none">Notes</h3>
+|r1= [[Boolean]] - the return value depends on the mode. For "Initialize" and "Terminate" a [[Boolean]] indicating successful execution is returned.
-<dl class="command_description">
-<!-- Note Section BEGIN -->
-<!-- Note Section END -->
+|x1= <sqf>["Initialize", [player]] call BIS_fnc_EGSpectator;</sqf>
-</dl>
-<h3 style="display:none">Bottom Section</h3>
+|seealso= [[Arma 3: End Game Spectator Mode]]
-[[Category:Function Group: Spectator|{{uc:EGSpectator}}]]
+}}
-[[Category:Functions|{{uc:EGSpectator}}]]
-[[Category:{{Name|arma3}}: Functions|{{uc:EGSpectator}}]]