underwater: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\{\{GameCategory\|(arma[0123])\|[ _]?New[ _]Scripting[ _]Commands[ _]List\}\}" to "{{GameCategory|$1|New Scripting Commands}}")
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 whether the object is fully underwater<br><br>
| Returns whether the object is fully underwater<br><br>
{{Informative | This command works well with Arma 3 mini-submarines, which was the primary design goal most likely}} |DESCRIPTION=
{{Informative | This command works well with Arma 3 mini-submarines, which was the primary design goal most likely}} |DESCRIPTION=
____________________________________________________________________________________________


| '''underwater''' object |SYNTAX=
| '''underwater''' object |SYNTAX=
Line 23: Line 20:


|x2= <code>_isUnderwater = [[eyePos]] [[player]] [[select]] 2 < 0;</code>|EXAMPLE2=  
|x2= <code>_isUnderwater = [[eyePos]] [[player]] [[select]] 2 < 0;</code>|EXAMPLE2=  
____________________________________________________________________________________________


| [[isTouchingGround]], [[isAbleToBreathe]] |SEEALSO=  
| [[isTouchingGround]], [[isAbleToBreathe]] |SEEALSO=  


|  |MPBEHAVIOUR=  
|  |MPBEHAVIOUR=  
____________________________________________________________________________________________
}}
}}



Revision as of 04:17, 17 January 2021

Hover & click on the images for description

Description

Description:
Returns whether the object is fully underwater

This command works well with Arma 3 mini-submarines, which was the primary design goal most likely
Groups:
Object Manipulation

Syntax

Syntax:
underwater object
Parameters:
object: Object - mini-submarine
Return Value:
Boolean - true if submerged

Examples

Example 1:
_isUnderwater = underwater vehicle player;
Example 2:
_isUnderwater = eyePos player select 2 < 0;

Additional Information

See also:
isTouchingGroundisAbleToBreathe

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

Posted on February 2, 2017 - 18:08 (UTC)
Killzone Kid
This command is quite buggy with objects other than mini-subs. Code in Example 2 is a good alternative.