BIS fnc EGSpectator: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "|= Comments" to "|Comments=")
m (Text replacement - "|= |p3=" to "|Parameter2= |p3=")
Line 17: Line 17:
*"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 ingame functions viewer for what they do. Following parameters are for "Initialize"'''|=  
|p2= specatator: [[Object]] - Player |=  
|p2= specatator: [[Object]] - Player |Parameter2=
 
|p3= whitelistedSides: [[Array]] - (Optional, default []) - Sides player can spectate |=
|p3= whitelistedSides: [[Array]] - (Optional, default []) - Sides player can spectate |=
|p4= allowAi: [[Boolean]] - (Optional, default true) - Whether AI can be viewed by the spectator |=
|p4= allowAi: [[Boolean]] - (Optional, default true) - Whether AI can be viewed by the spectator |=

Revision as of 02:23, 3 September 2019


Hover & click on the images for description

Description

Description:
Spectator instance.
Execution:
call
Groups:
Uncategorised

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