Difference between revisions of "Osiris/API/CharacterPurgeQueue"
From Divinity Engine Wiki
m |
m |
||
| Line 2: | Line 2: | ||
* call '''CharacterPurgeQueue'''(''(CHARACTERGUID)'''''_Character''') | * call '''CharacterPurgeQueue'''(''(CHARACTERGUID)'''''_Character''') | ||
===== Description ===== | ===== Description ===== | ||
| − | + | 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. | |
| − | + | See the description of [[Osiris/API/CharacterFlushQueue|CharacterFlushQueue]] for information about the Osiris queuing system. | |
| − | |||
===== Notes ===== | ===== Notes ===== | ||
* This will only purge actions queued from Osiris. It has no effect on actions started from behaviour scripts. | * 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 ' | + | * This call should virtually always be followed by a call to '[[Osiris/Shared/ProcClearMovingFacts|ProcClearMovingFacts]]. This will reset any state stored by the Shared mod's [[Osiris/Shared/ProcCharacterMoveTo|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 | + | * If you wish to immediately complete the queued actions instead of removing them, use [[Osiris/API/CharacterFlushQueue|CharacterFlushQueue]] instead |
===== See Also ===== | ===== See Also ===== | ||
* [[Osiris/API/CharacterFlushQueue|CharacterFlushQueue]] | * [[Osiris/API/CharacterFlushQueue|CharacterFlushQueue]] | ||
[[Category:Osiris Calls|CharacterPurgeQueue|CharacterPurgeQueue]] | [[Category:Osiris Calls|CharacterPurgeQueue|CharacterPurgeQueue]] | ||
Revision as of 21:43, 7 January 2018
Full Definition(s)
- call CharacterPurgeQueue((CHARACTERGUID)_Character)
Description
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.
See the description of CharacterFlushQueue for information about the Osiris queuing system.
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. 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
