lifeState: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category:ArmA 2: New Scripting Commands List\|{{uc:{{PAGENAME}}}}\]\]\s*" to "")
m (Some wiki formatting)
 
(35 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


| arma2 |Game name=
|game1= arma2
|version1= 1.00


|1.00|Game version=
|game2= arma2oa
|version2= 1.50


|arg= global |Multiplayer Arguments=
|game3= tkoh
____________________________________________________________________________________________
|version3= 1.00


| Returns the life state of the given unit. Can be one of:<br>
|game4= arma3
<br>
|version4= 0.50
'''(Pre-Arma 3)'''
*"ALIVE"
*"DEAD"
*"DEAD-RESPAWN"
*"DEAD-SWITCHING"
*"ASLEEP"
*"UNCONSCIOUS"
<br>
'''(Arma 3)'''
*"HEALTHY"
*"DEAD"
*"DEAD-RESPAWN"
*"DEAD-SWITCHING"
*"INCAPACITATED"
*"INJURED"
<br>
In Arma 3 [[lifeState]] seems to change to "INJURED" when [[damage]] aliveUnit <nowiki>>=</nowiki> 0.1 (0.1 seems to be the value defined in config under "InjuredTreshold"). |DESCRIPTION=


____________________________________________________________________________________________
|arg= global


| '''lifeState''' unit |SYNTAX=
|gr1= Object Manipulation


|p1= unit: [[Object]] |PARAMETER1=  
|descr= Returns the life state of the given unit.
{{{!}} class="wikitable"
! {{arma2}}
! {{arma3}}
{{!}}-
{{!}}
* "ALIVE"
* "DEAD"
* "DEAD-RESPAWN"
* "DEAD-SWITCHING"
* "ASLEEP"
* "UNCONSCIOUS"
{{!}}
* "HEALTHY"
* "DEAD"
* "DEAD-RESPAWN"
* "DEAD-SWITCHING"
* "INCAPACITATED"
* "INJURED"
{{!}}}


|p2= |PARAMETER2=
{{Feature | arma3 | In {{arma3}}, [[lifeState]] seems to change to "INJURED" when <sqf inline>damage aliveUnit >= 0.1</sqf> (0.1 seeming to be the value defined in config under {{sic|"InjuredTreshold"|Threshold}}). When the state is "INCAPACITATED", a sub-state is available via [[incapacitatedState]] command.}}


|p3= |PARAMETER3=  
|s1= [[lifeState]] unit


| [[String]] |RETURNVALUE=
|p1= unit: [[Object]]


|r1= [[String]]


|x1= <code>_ls = [[lifeState]] loon;</code> |EXAMPLE1=
|x1= <sqf>private _lifeState = lifeState player;</sqf>


____________________________________________________________________________________________
|seealso= [[setUnconscious]] [[incapacitatedState]]
 
| [[setUnconscious]] |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:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]

Latest revision as of 13:23, 27 July 2022

Hover & click on the images for description

Description

Description:
Returns the life state of the given unit.
Arma 2 Arma 3
  • "ALIVE"
  • "DEAD"
  • "DEAD-RESPAWN"
  • "DEAD-SWITCHING"
  • "ASLEEP"
  • "UNCONSCIOUS"
  • "HEALTHY"
  • "DEAD"
  • "DEAD-RESPAWN"
  • "DEAD-SWITCHING"
  • "INCAPACITATED"
  • "INJURED"
Arma 3
In Arma 3, lifeState seems to change to "INJURED" when damage aliveUnit >= 0.1 (0.1 seeming to be the value defined in config under "InjuredTreshold"sic). When the state is "INCAPACITATED", a sub-state is available via incapacitatedState command.
Groups:
Object Manipulation

Syntax

Syntax:
lifeState unit
Parameters:
unit: Object
Return Value:
String

Examples

Example 1:
private _lifeState = lifeState player;

Additional Information

See also:
setUnconscious incapacitatedState

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