BIS fnc EGSpectator: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (formatting, needs still some polishing)
m (Text replacement - "(\|[pr][0-9]+ *= *[^- ]*) *- *P([a-gi-z ])" to "$1 - p$2")
 
(39 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{RV|type=function


{{Function|= Comments
|game1= arma3
____________________________________________________________________________________________
|version1= 1.54


| arma3 |= Game name
|gr1= Spectator


|1.54|= Game version
|descr= Spectator instance.
____________________________________________________________________________________________


|Spectator instance.|DESCRIPTION=
|s1= [mode, [spectator, whitelistedSides, allowAi, allowFreeCamera, allow3PPCamera, showFocusInfo, showCameraButtons, showControlsHelper, showHeader, showLists]] call [[BIS_fnc_EGSpectator]]
____________________________________________________________________________________________


| [ mode,[specatator,whitelistedSides,allowAi,allowFreeCamera,allow3PPCamera,showFocusInfo,showCameraButtons,showControlsHelper,showHeader,showLists] ] call [[BIS_fnc_EGSpectator]];|SYNTAX=
|p1= mode: [[String]] - function mode, can be:
* "Initialize"
* "Terminate"
'''See the [[Arma 3: Functions Viewer|in-game Functions Viewer]] to see all the possible values. The following parameters are for "Initialize".'''


|p1= mode: [[String]] - Mode, can be <br>
|p2= spectator: [[Object]] - player
*"Initialize"
*"Terminate"
'''There are more options available. See the ingame functions viewer for what they do. Following parameters are for "Initialize"'''|=
|p2= specatator: [[Object]] - Player |=
|p3= whitelistedSides: [[Array]] - (Optional, default []) - Sides player can spectate |=
|p4= allowAi: [[Boolean]] - (Optional, default true) - Whether AI can be viewed by the spectator |=
|p5= allowFreeCamera: [[Boolean]] - (Optional, default true) - Whether Free camera mode is available |=
|p6= allow3PPCamera: [[Boolean]] - (Optional, default true) - Whether 3th Person Perspective camera mode is available |=
|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 |=
|[[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", [ [[player]] ] ] [[call]] [[BIS_fnc_EGSpectator]];</code> |=
|p3= whitelistedSides: [[Array]] - (Optional, default: []) sides that can be spectated
____________________________________________________________________________________________


|[[Arma 3 End Game Spectator Mode]] |SEEALSO=
|p4= allowAi: [[Boolean]] - (Optional, default: [[false]]) whether AI can be viewed by the spectator


}}
|p5= allowFreeCamera: [[Boolean]] - (Optional, default: [[true]]) whether free camera mode is available
 
|p6= allow3PPCamera: [[Boolean]] - (Optional, default: [[true]]) whether 3rd Person camera mode is available
 
|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}}]]

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"