Osiris/API/CharacterFlushQueue - Revision history

Tinkerer at 10:17, 20 December 2017

2017-12-20T10:17:41Z

← Older revision		Revision as of 10:17, 20 December 2017
Line 12:		Line 12:
	* [[Osiris/API/CharacterPurgeQueue\|CharacterPurgeQueue]]		* [[Osiris/API/CharacterPurgeQueue\|CharacterPurgeQueue]]

	[[Category:~~Osiris Calls\|~~Osiris Calls\|CharacterFlushQueue]]		[[Category:Osiris Calls\|CharacterFlushQueue]]

Tinkerer at 10:16, 20 December 2017

2017-12-20T10:16:17Z

← Older revision		Revision as of 10:16, 20 December 2017
Line 12:		Line 12:
	* [[Osiris/API/CharacterPurgeQueue\|CharacterPurgeQueue]]		* [[Osiris/API/CharacterPurgeQueue\|CharacterPurgeQueue]]

	[[Category:Osiris Calls\|Osiris Calls]]		[[Category:Osiris Calls\|Osiris Calls\|CharacterFlushQueue]]

Tinkerer at 15:15, 19 December 2017

2017-12-19T15:15:37Z

← Older revision		Revision as of 15:15, 19 December 2017
Line 12:		Line 12:
	* [[Osiris/API/CharacterPurgeQueue\|CharacterPurgeQueue]]		* [[Osiris/API/CharacterPurgeQueue\|CharacterPurgeQueue]]

	[[Category:Osiris Calls]]		[[Category:Osiris Calls\|Osiris Calls]]

Tinkerer: Document how to stop an ongoing animation

2017-09-13T08:56:54Z

Document how to stop an ongoing animation

← Older revision		Revision as of 08:56, 13 September 2017
Line 8:		Line 8:
	* This will only flush actions queued from Osiris. It has no effect on actions started from behaviour scripts.		* This will only flush actions queued from Osiris. It has no effect on actions started from behaviour scripts.
	* If you wish to discard the queued actions instead of make their effects happen immediately, use [[Osiris/API/CharacterPurgeQueue\|CharacterPurgeQueue]] instead.		* If you wish to discard the queued actions instead of make their effects happen immediately, use [[Osiris/API/CharacterPurgeQueue\|CharacterPurgeQueue]] instead.
	* A notable exception of APIs not affected by this API [[Osiris/API/PlayAnimation\|PlayAnimation]]. ~~See that page for information~~ on ~~how to abort an~~ ongoing animation.		* A notable exception of APIs not affected by this API [[Osiris/API/PlayAnimation\|PlayAnimation]]. An ongoing animation can be aborted by playing a new animation on the same object. If you specify a non-existent animation (such as the empty string), it will stop the ongoing animation without starting a new one (there is no clean way to achieve the same result).
	===== See Also =====		===== See Also =====
	* [[Osiris/API/CharacterPurgeQueue\|CharacterPurgeQueue]]		* [[Osiris/API/CharacterPurgeQueue\|CharacterPurgeQueue]]

	[[Category:Osiris Calls]]		[[Category:Osiris Calls]]

Tinkerer: Replaced some keywords by links, corrected misinformation about this call also flushing PlayAnimation calls

2017-09-13T08:51:40Z

Replaced some keywords by links, corrected misinformation about this call also flushing PlayAnimation calls

← Older revision		Revision as of 08:51, 13 September 2017
Line 2:		Line 2:
	* call '''CharacterFlushQueue'''(''(CHARACTERGUID)'''''_Character''')		* call '''CharacterFlushQueue'''(''(CHARACTERGUID)'''''_Character''')
	===== Description =====		===== Description =====
	If you start an Osiris action for a character while another is still busy, or multiple actions at the same time, then these actions are all queued. For example, you can queue multiple ~~'''~~CharacterMoveTo~~'''~~ events to prevent a hick-up between catching the event from arriving and dispatching the next move~~. Another example of an action that can take quite a while to complete is '''PlayAnimation'''~~.		If you start an Osiris action for a character while another is still busy, or multiple actions at the same time, then these actions are all queued. For example, you can queue multiple [[Osiris/API/CharacterMoveTo\|CharacterMoveTo]] events to prevent a hick-up between catching the event from arriving and dispatching the next move.

	This call will complete the currently executing action and all queued actions for '''_Character''' instantaneously while preserving their side-effects. This means that move events are turned into teleports, while animations are skipped (but their completion events will still be triggered, in order).		This call will complete the currently executing action and all queued actions for '''_Character''' instantaneously while preserving their side-effects. This means that move events are turned into teleports, while animations are skipped (but their completion events will still be triggered, in order).
	===== Notes =====		===== Notes =====
	* This will only flush actions queued from Osiris. It has no effect on actions started from behaviour scripts.		* This will only flush actions queued from Osiris. It has no effect on actions started from behaviour scripts.
	* If you wish to discard the queued actions instead of make their effects happen immediately, use ~~'''~~CharacterPurgeQueue~~'''~~ instead		* If you wish to discard the queued actions instead of make their effects happen immediately, use [[Osiris/API/CharacterPurgeQueue\|CharacterPurgeQueue]] instead.
			* A notable exception of APIs not affected by this API [[Osiris/API/PlayAnimation\|PlayAnimation]]. See that page for information on how to abort an ongoing animation.
	===== See Also =====		===== See Also =====
	* [[Osiris/API/CharacterPurgeQueue\|CharacterPurgeQueue]]		* [[Osiris/API/CharacterPurgeQueue\|CharacterPurgeQueue]]

	[[Category:Osiris Calls]]		[[Category:Osiris Calls]]

Tinkerer at 12:55, 25 August 2017

2017-08-25T12:55:37Z

← Older revision		Revision as of 12:55, 25 August 2017
Line 9:		Line 9:
	* If you wish to discard the queued actions instead of make their effects happen immediately, use '''CharacterPurgeQueue''' instead		* If you wish to discard the queued actions instead of make their effects happen immediately, use '''CharacterPurgeQueue''' instead
	===== See Also =====		===== See Also =====
	* [[Osiris/API/CharacterPurgeQueue]]		* [[Osiris/API/CharacterPurgeQueue\|CharacterPurgeQueue]]

	[[Category:Osiris Calls]]		[[Category:Osiris Calls]]

Tinkerer: Osiris Core APIs

2017-08-08T13:52:35Z

Osiris Core APIs

New page

===== Full Definition(s) =====
* call '''CharacterFlushQueue'''(''(CHARACTERGUID)'''''_Character''')
===== Description =====
If you start an Osiris action for a character while another is still busy, or multiple actions at the same time, then these actions are all queued. For example, you can queue multiple '''CharacterMoveTo''' events to prevent a hick-up between catching the event from arriving and dispatching the next move. Another example of an action that can take quite a while to complete is '''PlayAnimation'''.

This call will complete the currently executing action and all queued actions for '''_Character''' instantaneously while preserving their side-effects. This means that move events are turned into teleports, while animations are skipped (but their completion events will still be triggered, in order).
===== Notes =====
* This will only flush actions queued from Osiris. It has no effect on actions started from behaviour scripts.
* If you wish to discard the queued actions instead of make their effects happen immediately, use '''CharacterPurgeQueue''' instead
===== See Also =====
* [[Osiris/API/CharacterPurgeQueue]]

[[Category:Osiris Calls]]