Osiris/API/CharacterPurgeQueue - Revision history

Tinkerer at 09:11, 6 October 2019

2019-10-06T09:11:35Z

← Older revision		Revision as of 09:11, 6 October 2019
Line 1:		Line 1:
	===== Full Definition(s) =====		===== Full Definition(s) =====
	* 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.		This call will remove the currently executing '''Osiris''' task and all queued '''Osiris''' tasks 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.		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 tasks queued from Osiris. It has no effect on tasks started from behaviour scripts.
	* 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).		* 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 [[Osiris/API/CharacterFlushQueue\|CharacterFlushQueue]] instead		* 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]]

Tinkerer at 19:44, 7 January 2018

2018-01-07T19:44:13Z

← Older revision		Revision as of 19:44, 7 January 2018
Line 7:		Line 7:
	===== 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 '[[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).		* 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 [[Osiris/API/CharacterFlushQueue\|CharacterFlushQueue]] instead		* If you wish to immediately complete the queued actions instead of removing them, use [[Osiris/API/CharacterFlushQueue\|CharacterFlushQueue]] instead
	===== See Also =====		===== See Also =====

Tinkerer at 19:43, 7 January 2018

2018-01-07T19:43:53Z

← Older revision		Revision as of 19:43, 7 January 2018
Line 2:		Line 2:
	* call '''CharacterPurgeQueue'''(''(CHARACTERGUID)'''''_Character''')		* call '''CharacterPurgeQueue'''(''(CHARACTERGUID)'''''_Character''')
	===== Description =====		===== 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.

	~~This~~		See the description of [[Osiris/API/CharacterFlushQueue\|CharacterFlushQueue]] for information about the Osiris queuing system.
	~~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 =====		===== 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 '''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).		* 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 ~~'''~~CharacterFlushQueue~~'''~~ instead		* 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]]

Tinkerer at 15:18, 19 December 2017

2017-12-19T15:18:54Z

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

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

Tinkerer at 15:17, 19 December 2017

2017-12-19T15:17:05Z

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

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

Tinkerer at 12:55, 25 August 2017

2017-08-25T12:55:47Z

← Older revision		Revision as of 12:55, 25 August 2017
Line 11:		Line 11:
	* If you wish to immediately complete the queued actions instead of removing them, use '''CharacterFlushQueue''' instead		* If you wish to immediately complete the queued actions instead of removing them, use '''CharacterFlushQueue''' instead
	===== See Also =====		===== See Also =====
	* [[Osiris/API/CharacterFlushQueue]]		* [[Osiris/API/CharacterFlushQueue\|CharacterFlushQueue]]

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

Tinkerer: Osiris Core APIs

2017-08-08T13:52:35Z

Osiris Core APIs

New page

===== 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
===== See Also =====
* [[Osiris/API/CharacterFlushQueue]]

[[Category:Osiris Calls]]