isAbleToBreathe: Difference between revisions

From Bohemia Interactive Community
(clarification)
m (Some wiki formatting)
 
(32 intermediate revisions by 4 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
____________________________________________________________________________________________


| If unit is diving and doesn't have a re-breather, it returns [[false]]. Diving means the unit's head is underwater. If unit is underwater and has a re-breather, the command returns [[true]]. |= Description
|descr= If unit is diving and doesn't have a rebreather, it returns [[false]].
____________________________________________________________________________________________
Diving means the unit's head is underwater. If unit is underwater and has a rebreather, the command returns [[true]].


| '''isAbleToBreathe''' unit |= Syntax
|s1= [[isAbleToBreathe]] unit


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


| [[Boolean]] |= RETURNVALUE
|r1= [[Boolean]]


|x1= <sqf>_canBreath = isAbleToBreathe player;</sqf>


|x1= <code>
|seealso= [[underwater]]
</code>|= EXAMPLE1
}}
 
____________________________________________________________________________________________
 
|[[underwater]] |= SEEALSO


| |= MPBEHAVIOUR
{{Note
____________________________________________________________________________________________
|user= Vabene1111
|timestamp= 20190506194300
|text= Might return false if player enters a vehicle while underwater.
}}
}}
<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}}}}]]

Latest revision as of 22:53, 2 February 2026

Hover & click on the images for description

Description

Description:
If unit is diving and doesn't have a rebreather, it returns false. Diving means the unit's head is underwater. If unit is underwater and has a rebreather, the command returns true.
Groups:
Object Manipulation

Syntax

Syntax:
isAbleToBreathe unit
Parameters:
unit: Object
Return Value:
Boolean

Examples

Example 1:
_canBreath = isAbleToBreathe player;

Additional Information

See also:
underwater

Notes

Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord.
Only post proven facts here! Add Note
Vabene1111 - c
Posted on May 06, 2019 - 19:43 (UTC)
Might return false if player enters a vehicle while underwater.