Difference between revisions of "Osiris/API/CharacterIsIncapacitated"

From Divinity Engine Wiki
Jump to: navigation, search
m
m
 
Line 2: Line 2:
 
* query '''CharacterIsIncapacitated'''('''''[in]'''(CHARACTERGUID)'''''_Character''', '''''[out]'''(INTEGER)'''''_Incapacitated''')
 
* query '''CharacterIsIncapacitated'''('''''[in]'''(CHARACTERGUID)'''''_Character''', '''''[out]'''(INTEGER)'''''_Incapacitated''')
 
===== Description =====
 
===== Description =====
Returns whether '''_Character''' is currently incapacitated, such as frozen, petrified, stunned, knocked down, ...
+
Returns whether '''_Character''' is currently incapacitated, such as frozen, petrified, stunned, knocked down, or contrained, but also sitting, lying or climbing.
 
===== Return Values =====
 
===== Return Values =====
 
* '''Success/Failure''': Fails if '''_Character''' does not exist.
 
* '''Success/Failure''': Fails if '''_Character''' does not exist.

Latest revision as of 13:06, 26 September 2019

Full Definition(s)
  • query CharacterIsIncapacitated([in](CHARACTERGUID)_Character, [out](INTEGER)_Incapacitated)
Description

Returns whether _Character is currently incapacitated, such as frozen, petrified, stunned, knocked down, or contrained, but also sitting, lying or climbing.

Return Values
  • Success/Failure: Fails if _Character does not exist.
  • _Incapacitated: 1 if _Character is currently incapacitated, 0 if not.
Notes
  • /
See Also
  • /