setOxygenRemaining: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "<h3 style='display:none'>Notes</h3> <dl class='command_description'> <!-- Note Section BEGIN --> <!-- Note Section END --> </dl> <h3 style='display:none'>Bottom Section</h3>" to "")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|Game|[Gg]ame [Nn]ame( +[0-9])?|Game [Vv]ersion( +[0-9])?|Game Version \(number surrounded by NO SPACES\)|Arguments in MP|MP[Aa]rg|Multiplayer Arguments( \("local" or "global"\))?|Effects|Execution|Effects...)
Line 1: Line 1:
{{Command|Comments=
{{Command


| arma3 |Game name=
| arma3


|0.50|Game version=
|0.50


|gr1= Object Manipulation |GROUP1=
|gr1= Object Manipulation


| Sets oxygen remaining. It has no effect when soldier is not diving. Oxygen remaining is a number between 0 and 1. |DESCRIPTION=
| 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=
| unit '''setOxygenRemaining''' value


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


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


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




|x1= <code>[[player]] '''setOxygenRemaining''' 0; // Drowns player</code>|EXAMPLE1=
|x1= <code>[[player]] '''setOxygenRemaining''' 0; // Drowns player</code>




| [[getOxygenRemaining]] |SEEALSO=
| [[getOxygenRemaining]]


| |MPBEHAVIOUR=
|
}}
}}



Revision as of 11:09, 18 January 2021

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