getDiverState: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (updated version to 1.96)
m (arma3dev → arma3)
Line 2: Line 2:
____________________________________________________________________________________________
____________________________________________________________________________________________


| arma3dev |Game name=
| arma3 |Game name=
 
|1.96|Game version=
|1.96|Game version=
____________________________________________________________________________________________
____________________________________________________________________________________________


Line 11: Line 11:
____________________________________________________________________________________________
____________________________________________________________________________________________


|'''getDiverState''' unit|SYNTAX=
| [[getDiverState]] unit |SYNTAX=
|p1 = unit: [[Object]]
 
|p1= unit: [[Object]]
 
| [[Boolean]] - [[true]] when diving [[goggles]] are visible |RETURNVALUE=
| [[Boolean]] - [[true]] when diving [[goggles]] are visible |RETURNVALUE=
____________________________________________________________________________________________
____________________________________________________________________________________________
|x1 = <code>_gogglesOn = [[getDiverState]] [[player]];</code> |EXAMPLE1=


|x1= <code>[[private]] _gogglesOn = [[getDiverState]] [[player]];</code> |EXAMPLE1=


| [[goggles]], [[removeGoggles]], [[addGoggles]] |SEEALSO=
| [[goggles]], [[removeGoggles]], [[addGoggles]] |SEEALSO=
}}
}}



Revision as of 21:10, 29 October 2019

Hover & click on the images for description

Description

Description:
Returns true when object is in diver state i.e. when unit would put diving goggles on.

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.
Groups:
Uncategorised

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

Notes

Bottom Section