Difference between revisions of "Osiris/API/HasAppliedStatus"
From Divinity Engine Wiki
(Osiris Core APIs) |
m |
||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
===== Full Definition(s) ===== | ===== Full Definition(s) ===== | ||
| − | * query '''HasAppliedStatus'''('''''[in]'''(GUIDSTRING)'''''_Target''', '''''[in]'''(STRING)'''''_Status''',''''' [out]'''(INTEGER)'''''_Bool''') | + | * query '''HasAppliedStatus'''('''''[in]'''(GUIDSTRING)'''''_Target''', '''''[in]'''(STRING)'''''_Status''', '''''[out]'''(INTEGER)'''''_Bool''') |
===== Description ===== | ===== Description ===== | ||
Returns whether '''_Status''' has been applied to '''_Target'''. '''_Target''' may or may not yet actually be under its influence. | Returns whether '''_Status''' has been applied to '''_Target'''. '''_Target''' may or may not yet actually be under its influence. | ||
===== Return Values ===== | ===== Return Values ===== | ||
* Success/Failure''': '''Default return value. | * Success/Failure''': '''Default return value. | ||
| − | * '''_Bool''': 0 if ''' | + | * '''_Bool''': '''0''' if '''_Target''' is currently not under the influence of '''_Status''', '''1''' if it is. |
===== Notes ===== | ===== Notes ===== | ||
| − | * In virtually all cases, use | + | * In virtually all cases, use [[Osiris/API/HasActiveStatus|HasActiveStatus]] instead. The main purpose of this query is for crime reactions, and is only needed due to frame delays between code and Osiris. |
===== See Also ===== | ===== See Also ===== | ||
| − | * [[Osiris/API/HasActiveStatus]] | + | * [[Osiris/API/HasActiveStatus|HasActiveStatus]] |
| − | [[Category:Osiris Queries]] | + | [[Category:Osiris Queries|HasAppliedStatus]] |
Latest revision as of 15:34, 19 December 2017
Full Definition(s)
- query HasAppliedStatus([in](GUIDSTRING)_Target, [in](STRING)_Status, [out](INTEGER)_Bool)
Description
Returns whether _Status has been applied to _Target. _Target may or may not yet actually be under its influence.
Return Values
- Success/Failure: Default return value.
- _Bool: 0 if _Target is currently not under the influence of _Status, 1 if it is.
Notes
- In virtually all cases, use HasActiveStatus instead. The main purpose of this query is for crime reactions, and is only needed due to frame delays between code and Osiris.
