BIS fnc EGSpectator: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - " <h3 style="display:none">Notes</h3> <dl class="command_description"> <!-- Note Section BEGIN --> <!-- Note Section END --> </dl>" to "") |
Lou Montana (talk | contribs) m (Text replacement - " *\| *([Cc]omments|COMMENTS|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments \("local" or "global"\)|Multiplayer Effects \("local" or "global"\)|Multiplayer Execution \("server" o...) |
||
| Line 1: | Line 1: | ||
{{Function | {{Function | ||
| arma3 | | arma3 | ||
|1.54 | |1.54 | ||
|gr1= Spectator | |gr1= Spectator | ||
|Spectator instance. | |Spectator instance. | ||
| [ mode,[specatator,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]]; | ||
|p1= mode: [[String]] - Mode, can be <br> | |p1= mode: [[String]] - Mode, can be <br> | ||
*"Initialize" | *"Initialize" | ||
*"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 | ||
|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 | ||
|p5= allowFreeCamera: [[Boolean]] - (Optional, default true) - Whether Free camera mode is available | |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 | |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 | |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 | |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 | |p9= showControlsHelper: [[Boolean]] - (Optional, default true) - Whether to show controls helper widget | ||
|p10= showHeader: [[Boolean]] - (Optional, default true) - Whether to show header widget |PARAMETER10= | |p10= showHeader: [[Boolean]] - (Optional, default true) - Whether to show header widget |PARAMETER10= | ||
|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 | |[[Boolean]] - Return value depends on mode. For Initialize and terminate it returns boolean depending on whether or not execution was successful | ||
|x1= <code>[ "Initialize", [<nowiki/>[[player]] ] ] [[call]] [[BIS_fnc_EGSpectator]];</code> | |x1= <code>[ "Initialize", [<nowiki/>[[player]] ] ] [[call]] [[BIS_fnc_EGSpectator]];</code> | ||
|[[Arma 3 End Game Spectator Mode]] | |[[Arma 3 End Game Spectator Mode]] | ||
}} | }} | ||
Revision as of 22:06, 17 January 2021
Description
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