BIS fnc EGSpectator: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "= <code>([^<{]+)<\/code>" to "= <sqf>$1</sqf>") |
Lou Montana (talk | contribs) m (Fix allowAi true → false) |
||
Line 11: | Line 11: | ||
|p1= mode: [[String]] - Function mode, can be: | |p1= mode: [[String]] - Function mode, can be: | ||
*"Initialize" | * "Initialize" | ||
*"Terminate" | * "Terminate" | ||
''' | '''See the [[Arma 3: Functions Viewer|in-game Functions Viewer]] to see all the possible values. The following parameters are for "Initialize".''' | ||
|p2= spectator: [[Object]] - Player | |p2= spectator: [[Object]] - Player | ||
|p3= whitelistedSides (Optional, default: []) | |p3= whitelistedSides: [[Array]] - (Optional, default: []) sides that can be spectated | ||
|p4= allowAi (Optional, default: [[ | |p4= allowAi: [[Boolean]] - (Optional, default: [[false]]) whether AI can be viewed by the spectator | ||
|p5= allowFreeCamera (Optional, default: [[true]]) | |p5= allowFreeCamera: [[Boolean]] - (Optional, default: [[true]]) whether free camera mode is available | ||
|p6= allow3PPCamera (Optional, default: [[true]]) | |p6= allow3PPCamera: [[Boolean]] - (Optional, default: [[true]]) whether 3rd Person camera mode is available | ||
|p7= showFocusInfo (Optional, default: [[true]]) | |p7= showFocusInfo: [[Boolean]] - (Optional, default: [[true]]) whether to show Focus Info stats widget | ||
|p8= showCameraButtons (Optional, default: [[true]]) | |p8= showCameraButtons: [[Boolean]] - (Optional, default: [[true]]) whether or not to show camera buttons widget | ||
|p9= showControlsHelper (Optional, default: [[true]]) | |p9= showControlsHelper: [[Boolean]] - (Optional, default: [[true]]) whether to show controls helper widget | ||
|p10= showHeader (Optional, default: [[true]]) | |p10= showHeader: [[Boolean]] - (Optional, default: [[true]]) whether to show header widget | ||
|p11= showLists (Optional, default: [[true]]) | |p11= showLists: [[Boolean]] - (Optional, default: [[true]]) whether to show entities / locations lists | ||
|r1= [[Boolean]] - | |r1= [[Boolean]] - the return value depends on the mode. For "Initialize" and "Terminate" a [[Boolean]] indicating successful execution is returned. | ||
|x1= <sqf>["Initialize", [player]] call BIS_fnc_EGSpectator;</sqf> | |x1= <sqf>["Initialize", [player]] call BIS_fnc_EGSpectator;</sqf> |
Revision as of 13:25, 14 July 2022
Description
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"
- 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:
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