getDiverState: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]Arma[ _]3(\|.*)]]" to "{{GameCategory|arma3|Scripting Commands}}")
m (Some wiki formatting)
 
(19 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


| arma3 |Game name=
|game1= arma3
|version1= 1.96


|1.96|Game version=
|gr1= Object Manipulation


|gr1= Object Manipulation |GROUP1=
|descr= Returns [[true]] when object is in diver state - e.g when the unit would put diving [[goggles]] on.
____________________________________________________________________________________________
{{Feature|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.
}}


| Returns [[true]] when object is in diver state i.e. when unit would put diving [[goggles]] on. <br><br>
|s1= [[getDiverState]] unit
{{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=


|p1= unit: [[Object]]
|p1= unit: [[Object]]


| [[Boolean]] - [[true]] when diving [[goggles]] are visible |RETURNVALUE=
|r1= [[Boolean]] - [[true]] when diving [[goggles]] are visible
____________________________________________________________________________________________


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


| [[goggles]], [[removeGoggles]], [[addGoggles]] |SEEALSO=
|seealso= [[goggles]] [[removeGoggles]] [[addGoggles]]
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
</dl>
<h3 style="display:none">Bottom Section</h3>
{{GameCategory|arma3|New_Scripting_Commands_List}}
{{GameCategory|arma3|Scripting Commands}}
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]

Latest revision as of 15:10, 3 May 2022

Arma 3 logo black.png1.96
Hover & click on the images for description

Description

Description:
Returns true when object is in diver state - e.g when the 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:
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:
goggles removeGoggles addGoggles

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
Retrieved from "https://community.bistudio.com/wiki?title=getDiverState&oldid=309148"