getDiverState: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "\{\{GameCategory\|(arma[0123])\|New[ _]Scripting[ _]Commands[ _]List\}\}" to "{{GameCategory|$1|New Scripting Commands}}") |
Lou Montana (talk | contribs) m (Text replacement - "_{10,} " to "") |
||
Line 1: | Line 1: | ||
{{Command|Comments= | {{Command|Comments= | ||
| arma3 |Game name= | | arma3 |Game name= | ||
Line 7: | Line 6: | ||
|gr1= Object Manipulation |GROUP1= | |gr1= Object Manipulation |GROUP1= | ||
| Returns [[true]] when object is in diver state i.e. when unit would put diving [[goggles]] on. <br><br> | | Returns [[true]] when object is in diver state i.e. when unit would put diving [[goggles]] on. <br><br> | ||
{{Informative| Diving [[goggles]] remove blurriness underwater, however when assigned, they do not appear on the face of the unit until the unit steps into the water. This command allows to detect the moment when the goggles are visible. If the unit doesn't have diving goggles assigned, this command would still return [[true]] at appropriate time if the unit steps into the water.}} |DESCRIPTION= | {{Informative| Diving [[goggles]] remove blurriness underwater, however when assigned, they do not appear on the face of the unit until the unit steps into the water. This command allows to detect the moment when the goggles are visible. If the unit doesn't have diving goggles assigned, this command would still return [[true]] at appropriate time if the unit steps into the water.}} |DESCRIPTION= | ||
| [[getDiverState]] unit |SYNTAX= | | [[getDiverState]] unit |SYNTAX= | ||
Line 18: | Line 15: | ||
| [[Boolean]] - [[true]] when diving [[goggles]] are visible |RETURNVALUE= | | [[Boolean]] - [[true]] when diving [[goggles]] are visible |RETURNVALUE= | ||
|x1= <code>[[private]] _gogglesOn = [[getDiverState]] [[player]];</code> |EXAMPLE1= | |x1= <code>[[private]] _gogglesOn = [[getDiverState]] [[player]];</code> |EXAMPLE1= |
Revision as of 01:17, 17 January 2021
Description
- Description:
- Returns true when object is in diver state i.e. when unit would put diving goggles on.
- Groups:
- Object Manipulation
Syntax
- Syntax:
- getDiverState unit
- Parameters:
- unit: Object
- Return Value:
- Boolean - true when diving goggles are visible
Examples
- Example 1:
private _gogglesOn = getDiverState player;
Additional Information
- See also:
- gogglesremoveGogglesaddGoggles
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