setOxygenRemaining: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(Added see also and comment on example's effect)
m (Some wiki formatting)
 
(24 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
____________________________________________________________________________________________


| Sets oxygen remaining. It has no effect when soldier is not diving. |= Description
|descr= Sets oxygen remaining. It has no effect when soldier is not diving. Oxygen remaining is a number between 0 and 1.
____________________________________________________________________________________________


| unit '''setOxygenRemaining''' value |= Syntax
|s1= unit [[setOxygenRemaining]] value


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


|p2= value: [[Number]] |= PARAMETER2
|p2= value: [[Number]]


| [[Nothing]] |= RETURNVALUE
|r1= [[Nothing]]


|x1= <sqf>player setOxygenRemaining 0; // drowns player</sqf>


|x1= <code>[[player]] '''setOxygenRemaining''' 0; // Drowns player</code>|= EXAMPLE1
|seealso= [[getOxygenRemaining]]
 
____________________________________________________________________________________________
 
| [[getOxygenRemaining]] |= SEEALSO
 
|  |= MPBEHAVIOUR
____________________________________________________________________________________________
}}
}}
<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 17:28, 13 May 2022

Arma 3 logo black.png0.50
Hover & click on the images for description

Description

Description:
Sets oxygen remaining. It has no effect when soldier is not diving. Oxygen remaining is a number between 0 and 1.
Groups:
Object Manipulation

Syntax

Syntax:
unit setOxygenRemaining value
Parameters:
unit: Object
value: Number
Return Value:
Nothing

Examples

Example 1:
player setOxygenRemaining 0; // drowns player

Additional Information

See also:
getOxygenRemaining

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=setOxygenRemaining&oldid=321204"