setOxygenRemaining: 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)
 
(15 intermediate revisions by 2 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


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


| Sets oxygen remaining. It has no effect when soldier is not diving. Oxygen remaining is a number between 0 and 1.  |DESCRIPTION=
|s1= unit [[setOxygenRemaining]] value
____________________________________________________________________________________________


| unit '''setOxygenRemaining''' value |SYNTAX=
|p1= unit: [[Object]]


|p1= unit: [[Object]] |PARAMETER1=
|p2= value: [[Number]]


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


| [[Nothing]] |RETURNVALUE=  
|x1= <sqf>player setOxygenRemaining 0; // drowns player</sqf>


 
|seealso= [[getOxygenRemaining]]
|x1= <code>[[player]] '''setOxygenRemaining''' 0; // Drowns player</code>|EXAMPLE1=
 
____________________________________________________________________________________________
 
| [[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>
{{GameCategory|arma3|New_Scripting_Commands_List}}
{{GameCategory|arma3|Scripting Commands}}
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]

Latest revision as of 16:28, 13 May 2022

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