Osiris/API/GetStatusTurns - Revision history

Tinkerer at 12:26, 26 February 2018

2018-02-26T12:26:42Z

← Older revision		Revision as of 12:26, 26 February 2018
Line 9:		Line 9:
	* This query is new in DOS2 Patch 5.		* This query is new in DOS2 Patch 5.
	* As of DOS 2 Patch 6, this query returns '''-1''' for statuses with an infinite duration. Before, it returned '''0''' in that case.		* As of DOS 2 Patch 6, this query returns '''-1''' for statuses with an infinite duration. Before, it returned '''0''' in that case.
			* See the notes of [[Osiris/API/CharacterStatusAttempt\|CharacterStatusAttempt]] for a usage constraint.
	===== See Also =====		===== See Also =====
	* [[Osiris/API/ApplyStatus\|ApplyStatus]]		* [[Osiris/API/ApplyStatus\|ApplyStatus]]

Tinkerer: Updated for DOS2 Patch 6 change

2018-02-22T21:25:18Z

Updated for DOS2 Patch 6 change

← Older revision		Revision as of 21:25, 22 February 2018
Line 7:		Line 7:
	* '''_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'''.		* '''_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 =====		===== Notes =====
	* This query is new in DOS2 Patch 5		* This query is new in DOS2 Patch 5.
			* As of DOS 2 Patch 6, this query returns '''-1''' for statuses with an infinite duration. Before, it returned '''0''' in that case.
	===== See Also =====		===== See Also =====
	* [[Osiris/API/ApplyStatus\|ApplyStatus]]		* [[Osiris/API/ApplyStatus\|ApplyStatus]]

Tinkerer at 14:30, 19 December 2017

2017-12-19T14:30:29Z

← Older revision		Revision as of 14:30, 19 December 2017
Line 22:		Line 22:
	* [[Osiris/API/RemoveHarmfulStatuses\|RemoveHarmfulStatuses]]		* [[Osiris/API/RemoveHarmfulStatuses\|RemoveHarmfulStatuses]]

	[[Category:Osiris Queries]]		[[Category:Osiris Queries\|GetStatusTurns]]

Tinkerer at 15:37, 6 December 2017

2017-12-06T15:37:58Z

← Older revision		Revision as of 15:37, 6 December 2017
Line 7:		Line 7:
	* '''_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'''.		* '''_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 =====		===== Notes =====
	* /		* This query is new in DOS2 Patch 5
	===== See Also =====		===== See Also =====
	* [[Osiris/API/ApplyStatus\|ApplyStatus]]		* [[Osiris/API/ApplyStatus\|ApplyStatus]]

Tinkerer at 15:08, 6 December 2017

2017-12-06T15:08:18Z

← Older revision		Revision as of 15:08, 6 December 2017
Line 1:		Line 1:
	===== Full Definition(s) =====		===== Full Definition(s) =====
	* query '''GetStatusTurns'''('''''[in]'''(GUIDSTRING)'''''_Source''', ''''[in]''''(STRING)''''_StatusID''''', [out]'''''(INTEGER)'''_Turns''')		* 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.

Tinkerer: Documented GetStatusTurns

2017-12-06T15:07:33Z

Documented GetStatusTurns

New page

===== 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 =====
* /
===== See Also =====
* [[Osiris/API/ApplyStatus|ApplyStatus]]
* [[Osiris/API/CharacterStatusAttempt|CharacterStatusAttempt]]
* [[Osiris/API/CharacterStatusApplied|CharacterStatusApplied]]
* [[Osiris/API/CharacterStatusRemoved|CharacterStatusRemoved]]
* [[Osiris/API/GetStatusType|GetStatusType]]
* [[Osiris/API/HasActiveStatus|HasActiveStatus]]
* [[Osiris/API/HasAppliedStatus|HasAppliedStatus]]
* [[Osiris/API/ItemStatusAttempt|ItemStatusAttempt]]
* [[Osiris/API/ItemStatusChange|ItemStatusChange]]
* [[Osiris/API/ItemStatusRemoved|ItemStatusRemoved]]
* [[Osiris/API/RemoveStatus|RemoveStatus]]
* [[Osiris/API/RemoveHarmfulStatuses|RemoveHarmfulStatuses]]

[[Category:Osiris Queries]]