Difference between revisions of "Osiris/API/GetStatusTurns"
From Divinity Engine Wiki
(Documented GetStatusTurns) |
m |
||
| Line 1: | Line 1: | ||
===== Full Definition(s) ===== | ===== Full Definition(s) ===== | ||
| − | * query '''GetStatusTurns'''('''''[in]'''(GUIDSTRING)'''''_Source''', ''''[in] | + | * query '''GetStatusTurns'''('''''[in]'''(GUIDSTRING)'''''_Source''', '''''[in]'''(STRING)''''_StatusID''''', '''''[out]'''(INTEGER)'''_Turns''') |
===== Description ===== | ===== Description ===== | ||
Returns the remaining lifetime of a status '''_StatusID''' on '''_Source''', which can either be a character or an item. | Returns the remaining lifetime of a status '''_StatusID''' on '''_Source''', which can either be a character or an item. | ||
Revision as of 17:08, 6 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
- /
