Difference between revisions of "Osiris/API/CharacterPurgeQueue"
From Divinity Engine Wiki
m |
m |
||
| Line 13: | Line 13: | ||
* [[Osiris/API/CharacterFlushQueue|CharacterFlushQueue]] | * [[Osiris/API/CharacterFlushQueue|CharacterFlushQueue]] | ||
| − | [[Category:Osiris Calls]] | + | [[Category:Osiris Calls|CharacterPurgeQueue]] |
Revision as of 16:17, 19 December 2017
Full Definition(s)
- call CharacterPurgeQueue((CHARACTERGUID)_Character)
Description
See the description of CharacterFlushQueue for information about the Osiris queuing system.
This call will remove the currently executing action and all queued actions for _Character instantaneously as if they were never queued in the first place.
Notes
- This will only purge actions queued from Osiris. It has no effect on actions started from behaviour scripts.
- This call should virtually always be followed by a call to ProcClearMovingFacts(_Character), which is defined in the Shared mod. This will reset any state stored by the Shared mod's ProcCharacterMoveTo(), and thereby prevent the character from resuming such movements afterwards (since this state is not part of Osiris itself and hence is not deleted by this call).
- If you wish to immediately complete the queued actions instead of removing them, use CharacterFlushQueue instead
