Difference between revisions of "Osiris/API/CharacterFlushQueue"
From Divinity Engine Wiki
(Osiris Core APIs) |
m |
||
| 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]] | ||
Revision as of 13:55, 25 August 2017
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
