BIS fnc EGSpectator: Difference between revisions
Jump to navigation
Jump to search
m (template:command argument fix) |
m (formatting, needs still some polishing) |
||
| Line 5: | Line 5: | ||
| arma3 |= Game name | | arma3 |= Game name | ||
|1. | |1.54|= Game version | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| | |Spectator instance.|DESCRIPTION= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| | | [ mode,[specatator,whitelistedSides,allowAi,allowFreeCamera,allow3PPCamera,showFocusInfo,showCameraButtons,showControlsHelper,showHeader,showLists] ] call [[BIS_fnc_EGSpectator]];|SYNTAX= | ||
| |RETURNVALUE= | |p1= mode: [[String]] - Mode, can be <br> | ||
*"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></code> |= | |x1= <code>[ "Initialize", [ [[player]] ] ] [[call]] [[BIS_fnc_EGSpectator]];</code> |= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| |SEEALSO= | |[[Arma 3 End Game Spectator Mode]] |SEEALSO= | ||
}} | }} | ||
Revision as of 18:46, 29 May 2019
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"
- 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