Difference between revisions of "Osiris/API/GetStatusTurns"
From Divinity Engine Wiki
m |
m |
||
Line 22: | Line 22: | ||
* [[Osiris/API/RemoveHarmfulStatuses|RemoveHarmfulStatuses]] | * [[Osiris/API/RemoveHarmfulStatuses|RemoveHarmfulStatuses]] | ||
− | [[Category:Osiris Queries]] | + | [[Category:Osiris Queries|GetStatusTurns]] |
Revision as of 15:30, 19 December 2017
Full Definition(s)
- query GetStatusTurns([in](GUIDSTRING)_Source, [in](STRING)'_StatusID, [out](INTEGER)_Turns)
Description
Returns the remaining lifetime of a status _StatusID on _Source, which can either be a character or an item.
Return Values
- Success/Failure: Fails if _Source is NULL or if _Source is not currently under the influence of _StatusIID.
- _Turns: The number of _Turns that _Source will still be under the influence of _StatusID, rounded up to the next integer (e.g. if there are 1.01 turns left, it will return 2). If the query failed, the result is guaranteed to be 0.
Notes
- This query is new in DOS2 Patch 5