incapacitatedState: 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 (Text replacement - ">Posted on December ([0-9]{2})[ a-zA-Z]*, ([0-9]{4})" to ">Posted on $2-12-$1")
 
(31 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


| arma3 |Game name=
|game1= arma3
|version1= 1.00


|1.00|Game version=
|gr1= Object Manipulation


|gr1= Object Manipulation |GROUP1=
|descr= Returns the incapacitated sub-state of the given unit, when the [[lifeState]] of the unit is "INCAPACITATED". Could be one of:
____________________________________________________________________________________________
* "UNCONSCIOUS"
* "MOVING"
* "SHOOTING"


| Returns the incapacitated state of the given unit. |DESCRIPTION=
|s1= [[incapacitatedState]] person
____________________________________________________________________________________________


| '''incapacitatedState''' person |SYNTAX=
|p1= person: [[Object]]


|p1= person: [[Object]] |PARAMETER1=
|r1= [[String]] - incapacitated sub-state (see description) or empty string ""


| [[String]] |RETURNVALUE=  
|x1= <sqf>_result = incapacitatedState player;</sqf>


 
|seealso= [[setUnconscious]] [[lifeState]]
|x1= <code>_result = [[incapacitatedState]] [[player]];</code> |EXAMPLE1=
 
____________________________________________________________________________________________
 
| [[setUnconscious]] [[lifeState]] |SEEALSO=
 
|  |MPBEHAVIOUR=
____________________________________________________________________________________________
}}
}}


<h3 style='display:none'>Notes</h3>
<dl class="command_description">
<dl class='command_description'>
<!-- Note Section BEGIN -->
 
<!-- Note Section END -->
</dl>


<h3 style='display:none'>Bottom Section</h3>
<dt></dt>
{{GameCategory|arma3|New_Scripting_Commands_List}}
<dd class="notedate">Posted on 2018-07-18 - 02:53 (UTC)</dd>
{{GameCategory|arma3|Scripting Commands}}
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
 
<!-- CONTINUE Notes -->
<dl class="command_description">
<dd class="notedate">Posted on July 18, 2018 - 02:53 (UTC)</dd>
<dt class="note">[[User:HazJ|HazJ]]</dt>
<dt class="note">[[User:HazJ|HazJ]]</dt>
<dd class="note">
<dd class="note">
This command returns "SHOOTING" (intentional behaviour?) when checking a unit's state while they are unconscious. Tested with BIS revive. I recommend just using the lifeState command instead.
This command returns "SHOOTING" (intentional behaviour?) when checking a unit's state while they are unconscious. Tested with BIS revive. I recommend just using the lifeState command instead.
</dd>
</dd>
</dl>
<!-- DISCONTINUE Notes -->


<!-- CONTINUE Notes -->
<dt><dt>
<dl class="command_description">
<dd class="notedate">Posted on 2019-12-29 - 21:13 (UTC)</dd>
<dd class="notedate">Posted on December 29, 2019 - 21:13 (UTC)</dd>
<dt class="note">[[User:Tankbuster|Tankbuster]]</dt>
<dt class="note">[[User:Tankbuster|Tankbuster]]</dt>
<dd class="note">
<dd class="note">
Returns  
Returns  
"UNCONSCIOUS" when awaiting revive.
"UNCONSCIOUS" when awaiting revive.
"" when alive or when awaiting respawn. This means that when a unit dies instantly, ie through drowning, this command will return empty string throughout. As Haz says above, it sometimes show "SHOOTING" when the player is unconscious for reasons that aren't clear.
"" when alive or when awaiting respawn. This means that when a unit dies instantly, ie through drowning, this command will return empty string throughout. As Haz says above, it sometimes show "SHOOTING" when the player is unconscious for reasons that are not clear.


</dd>
</dd>
</dl>
</dl>
<!-- DISCONTINUE Notes -->

Latest revision as of 23:13, 13 May 2023

Arma 3 logo black.png1.00
Hover & click on the images for description

Description

Description:
Returns the incapacitated sub-state of the given unit, when the lifeState of the unit is "INCAPACITATED". Could be one of:
  • "UNCONSCIOUS"
  • "MOVING"
  • "SHOOTING"
Groups:
Object Manipulation

Syntax

Syntax:
incapacitatedState person
Parameters:
person: Object
Return Value:
String - incapacitated sub-state (see description) or empty string ""

Examples

Example 1:
_result = incapacitatedState player;

Additional Information

See also:
setUnconscious lifeState

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
Posted on 2018-07-18 - 02:53 (UTC)
HazJ
This command returns "SHOOTING" (intentional behaviour?) when checking a unit's state while they are unconscious. Tested with BIS revive. I recommend just using the lifeState command instead.
Posted on 2019-12-29 - 21:13 (UTC)
Tankbuster
Returns "UNCONSCIOUS" when awaiting revive. "" when alive or when awaiting respawn. This means that when a unit dies instantly, ie through drowning, this command will return empty string throughout. As Haz says above, it sometimes show "SHOOTING" when the player is unconscious for reasons that are not clear.
Retrieved from "https://community.bistudio.com/wiki?title=incapacitatedState&oldid=341186"