underwater: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
m (Text replacement - "{{HashLink" to "{{Link")
 
(42 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| arma3 |= Game name
|game1= arma3
|version1= 0.50


|0.50|= Game version
|gr1= Object Manipulation
____________________________________________________________________________________________


| Return whether object is fully underwater. Works as intended only on objects, not units. For units it returns "isSwimming" and not "underwater"  |= Description
|descr= Returns whether the object is fully underwater.
____________________________________________________________________________________________
{{Feature|informative|This command works well with Arma 3 mini-submarines, which was most likely the primary design goal.}}


| '''underwater''' object |= Syntax
|s1= [[underwater]] object


|p1= object: [[Object]] |= PARAMETER1
|p1= object: [[Object]] - mini-submarine


| [[Boolean]] |= RETURNVALUE
|r1= [[Boolean]] - [[true]] if submerged


|x1= <sqf>private _isUnderwater = underwater vehicle player;</sqf>


|x1= <code>_isSwimming = [[underwater]] [[player]];</code>|= EXAMPLE1
|x2= <sqf>private _isHeadUnderwater = eyePos player select 2 < 0;</sqf>


|x2= <code>_isUnderwater = [[eyePos]] [[player]] [[select]] 2 < 0;</code>|= EXAMPLE2
|seealso= [[isTouchingGround]] [[isAbleToBreathe]]
____________________________________________________________________________________________
}}
 
| [[isTouchingGround]], [[isAbleToBreathe]] |= SEEALSO


| |= MPBEHAVIOUR
{{Note
____________________________________________________________________________________________
|user= Killzone_Kid
|timestamp= 20170202180800
|text= This command is quite buggy with objects other than mini-subs. Code in {{Link|#Example 2}} is a good alternative.
}}
}}
<h3 style='display:none'>Notes</h3>
<dl class='command_description'>
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style='display:none'>Bottom Section</h3>
[[Category:Arma_3:_New_Scripting_Commands_List|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
<!-- CONTINUE Notes -->
<dl class="command_description">
<dd class="notedate">Posted on September 21, 2014 - 20:49 (UTC)</dd>
<dt class="note">[[User:Killzone Kid|Killzone Kid]]</dt>
<dd class="note">
This command name is MISLEADING. It returns true when player is in swimming position and false otherwise. Player can be standing fully underwater and this command would return false or swimming with head above water and this command would return true.<br><br>
</dd>
</dl>
<!-- DISCONTINUE Notes -->
<!-- CONTINUE Notes -->
<dl class="command_description">
<dd class="notedate">Posted on December 17, 2016 - 11:08 (UTC)</dd>
<dt class="note">[[User:Fusselwurm|Fusselwurm]]</dt>
<dd class="note">
Seems to be fixed for players now (as of 1.66) : returns <code>true</code> if submerged, <code>false</code> is swimming on surface
</dd>
</dl>
<!-- DISCONTINUE Notes -->

Latest revision as of 18:44, 4 January 2023

Arma 3 logo black.png0.50
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 most likely the primary design goal.
Groups:
Object Manipulation

Syntax

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

Examples

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

Additional Information

See also:
isTouchingGround isAbleToBreathe

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
Killzone_Kid - c
Posted on Feb 02, 2017 - 18:08 (UTC)
This command is quite buggy with objects other than mini-subs. Code in Example 2 is a good alternative.
Retrieved from "https://community.bistudio.com/wiki?title=underwater&oldid=336959"