Osiris/Shared/ProcCharacterMoveTo - Revision history

Tinkerer at 13:42, 21 February 2018

2018-02-21T13:42:50Z

← Older revision		Revision as of 13:42, 21 February 2018
Line 10:		Line 10:
	===== Notes =====		===== Notes =====
	* If you wish to abort a move initiated this way, in addition to calling [[Osiris/API/CharacterPurgeQueue\|CharacterPurgeQueue]], you also have to call [[Osiris/Shared/ProcClearStoryMove\|ProcClearStoryMove]]. This will restore all of the suspended behaviours and prevent the resumption of the movement at a later moment.		* If you wish to abort a move initiated this way, in addition to calling [[Osiris/API/CharacterPurgeQueue\|CharacterPurgeQueue]], you also have to call [[Osiris/Shared/ProcClearStoryMove\|ProcClearStoryMove]]. This will restore all of the suspended behaviours and prevent the resumption of the movement at a later moment.
	* Preferably always use this routine or [[Osiris/Shared/ProcStateManagerCharacterMoveTo\|ProcStateManagerCharacterMoveTo]] instead of [[Osiris/API/CharacterMoveTo\|CharacterMoveTo]]		* Preferably always use this routine or [[Osiris/Shared/ProcStateManagerCharacterMoveTo\|ProcStateManagerCharacterMoveTo]] instead of [[Osiris/API/CharacterMoveTo\|CharacterMoveTo]].
	===== See Also =====		===== See Also =====
	* [[Osiris/API/CharacterMoveTo\|CharacterMoveTo]]		* [[Osiris/API/CharacterMoveTo\|CharacterMoveTo]]
	* Helper [[Osiris/Shared/ProcClearStoryMove\|ProcClearStoryMove]		* Helper [[Osiris/Shared/ProcClearStoryMove\|ProcClearStoryMove]]
	* Helper [[Osiris/Shared/ProcStateManagerCharacterMoveTo\|ProcStateManagerCharacterMoveTo]]		* Helper [[Osiris/Shared/ProcStateManagerCharacterMoveTo\|ProcStateManagerCharacterMoveTo]]

	[[Category:Osiris Shared Mod Helpers\|CharacterMoveTo]]		[[Category:Osiris Shared Mod Helpers\|CharacterMoveTo]]

Tinkerer: Must call ProcClearStoryMove instead of ProcClearMovingFacts

2018-02-21T13:42:33Z

Must call ProcClearStoryMove instead of ProcClearMovingFacts

← Older revision		Revision as of 13:42, 21 February 2018
Line 9:		Line 9:
	* /		* /
	===== Notes =====		===== Notes =====
	* If you wish to abort a move initiated this way, in addition to calling [[Osiris/API/CharacterPurgeQueue\|CharacterPurgeQueue]], you also have to call [[Osiris/Shared/~~ProcClearMovingFacts~~\|~~ProcClearMovingFacts~~]]. This will restore all of the suspended behaviours and prevent the resumption of the movement at a later moment.		* If you wish to abort a move initiated this way, in addition to calling [[Osiris/API/CharacterPurgeQueue\|CharacterPurgeQueue]], you also have to call [[Osiris/Shared/ProcClearStoryMove\|ProcClearStoryMove]]. This will restore all of the suspended behaviours and prevent the resumption of the movement at a later moment.
	* Preferably always use this routine or [[Osiris/Shared/ProcStateManagerCharacterMoveTo\|ProcStateManagerCharacterMoveTo]] instead of [[Osiris/API/CharacterMoveTo\|CharacterMoveTo]]		* Preferably always use this routine or [[Osiris/Shared/ProcStateManagerCharacterMoveTo\|ProcStateManagerCharacterMoveTo]] instead of [[Osiris/API/CharacterMoveTo\|CharacterMoveTo]]
	===== See Also =====		===== See Also =====
	* [[Osiris/API/CharacterMoveTo\|CharacterMoveTo]]		* [[Osiris/API/CharacterMoveTo\|CharacterMoveTo]]
			* Helper [[Osiris/Shared/ProcClearStoryMove\|ProcClearStoryMove]
	* Helper [[Osiris/Shared/ProcStateManagerCharacterMoveTo\|ProcStateManagerCharacterMoveTo]]		* Helper [[Osiris/Shared/ProcStateManagerCharacterMoveTo\|ProcStateManagerCharacterMoveTo]]

	[[Category:Osiris Shared Mod Helpers\|CharacterMoveTo]]		[[Category:Osiris Shared Mod Helpers\|CharacterMoveTo]]

Tinkerer at 19:44, 7 January 2018

2018-01-07T19:44:41Z

← Older revision		Revision as of 19:44, 7 January 2018
Line 2:		Line 2:
	* PROC '''ProcCharacterMoveTo'''(''(CHARACTERGUID)'''''_Char''', ''(GUIDSTRING)'''''_Point''', ''(INTEGER)'''''_Running''', ''(STRING)'''''_Event''')		* PROC '''ProcCharacterMoveTo'''(''(CHARACTERGUID)'''''_Char''', ''(GUIDSTRING)'''''_Point''', ''(INTEGER)'''''_Running''', ''(STRING)'''''_Event''')
	===== Description =====		===== Description =====
	This is a wrapper around the ~~'''~~CharacterMoveTo~~'''~~ API call that takes care of interactions with various other behaviours. A.o.,		This is a wrapper around the [[Osiris/API/CharacterMoveTo\|CharacterMoveTo]] API call that takes care of interactions with various other behaviours. A.o.,

	* It disables all dialogs while the character is moving.		* It disables all dialogs while the character is moving.
	* It disables all reactions to crimes while the character is moving.		* It disables all reactions to crimes while the character is moving.

Tinkerer at 15:01, 19 December 2017

2017-12-19T15:01:08Z

← Older revision		Revision as of 15:01, 19 December 2017
Line 1:		Line 1:
	===== Full Definition(s) =====		===== Full Definition(s) =====
	* PROC '''ProcCharacterMoveTo'''(''(CHARACTERGUID)'''''_Char''',''(GUIDSTRING)'''''_Point''',''(INTEGER)'''''_Running''',''(STRING)'''''_Event''')		* PROC '''ProcCharacterMoveTo'''(''(CHARACTERGUID)'''''_Char''', ''(GUIDSTRING)'''''_Point''', ''(INTEGER)'''''_Running''', ''(STRING)'''''_Event''')
	===== Description =====		===== Description =====
	This is a wrapper around the '''CharacterMoveTo''' API call that takes care of interactions with various other behaviours. A.o.,		This is a wrapper around the '''CharacterMoveTo''' API call that takes care of interactions with various other behaviours. A.o.,
Line 16:		Line 16:
	* Helper [[Osiris/Shared/ProcStateManagerCharacterMoveTo\|ProcStateManagerCharacterMoveTo]]		* Helper [[Osiris/Shared/ProcStateManagerCharacterMoveTo\|ProcStateManagerCharacterMoveTo]]

	[[Category:Osiris Shared Mod Helpers]]		[[Category:Osiris Shared Mod Helpers\|CharacterMoveTo]]

Tinkerer: Undo revision 3844 by Tinkerer (talk)

2017-10-12T19:43:46Z

Undo revision 3844 by Tinkerer (talk)

← Older revision		Revision as of 19:43, 12 October 2017
Line 1:		Line 1:
	===== Full Definition(s) =====		===== Full Definition(s) =====
	* ~~query~~ '''~~QueryOnlyOnce~~'''(''(STRING)'''''~~_OnlyOnceUUID~~''')		* PROC '''ProcCharacterMoveTo'''(''(CHARACTERGUID)'''''_Char''',''(GUIDSTRING)'''''_Point''',''(INTEGER)'''''_Running''',''(STRING)'''''_Event''')
	===== Description =====		===== Description =====
	~~Helper~~ to ~~ensure a rule gets executed only once~~.		This is a wrapper around the '''CharacterMoveTo''' API call that takes care of interactions with various other behaviours. A.o.,

			* It disables all dialogs while the character is moving.
			* It disables all reactions to crimes while the character is moving.
			* If the move is interrupted in one way or another, the character will resume moving after the interruption
	===== Return Values =====		===== Return Values =====
	* ~~'''Success~~/~~Failure''': Fails if '''QueryOnlyOnce''' was previously called with '''_OnlyOnceUUID''' as parameter, otherwise succeeds.~~		* /
	===== Notes =====		===== Notes =====
	* ~~This query defines '''DB_OnlyOnce(_OnlyOnceUUID)'''~~, so you ~~can test that afterwards~~ to ~~determine whether this query has been executed already~~.		* If you wish to abort a move initiated this way, in addition to calling [[Osiris/API/CharacterPurgeQueue\|CharacterPurgeQueue]], you also have to call [[Osiris/Shared/ProcClearMovingFacts\|ProcClearMovingFacts]]. This will restore all of the suspended behaviours and prevent the resumption of the movement at a later moment.
	~~===== Example =====~~		* Preferably always use this routine or [[Osiris/Shared/ProcStateManagerCharacterMoveTo\|ProcStateManagerCharacterMoveTo]] instead of [[Osiris/API/CharacterMoveTo\|CharacterMoveTo]]
	IF
	~~GameStarted("TUT_Tutorial_A",_)~~
	~~AND~~
	~~QueryOnlyOnce("FTJ_IfanStoryInit_TUT")~~
	~~THEN~~
	~~ItemToInventory(ITEMGUID_S_FTJ_IfanNoteFromDarkFaction_51899f0f-6ea2-4522-893b-69ccd87b97fb,CHARACTERGUID_S_Player_Ifan_ad9a3327-4456-42a7-9bf4-7ad60cc9e54f,-1,0);~~
	===== See Also =====		===== See Also =====
	/		* [[Osiris/API/CharacterMoveTo\|CharacterMoveTo]]
			* Helper [[Osiris/Shared/ProcStateManagerCharacterMoveTo\|ProcStateManagerCharacterMoveTo]]
	[[Category:Osiris ~~Queries~~]]
			[[Category:Osiris Shared Mod Helpers]]

Tinkerer: Document QueryOnlyOnce

2017-10-12T18:58:55Z

Document QueryOnlyOnce

← Older revision		Revision as of 18:58, 12 October 2017
Line 1:		Line 1:
	===== Full Definition(s) =====		===== Full Definition(s) =====
	* ~~PROC~~ '''~~ProcCharacterMoveTo~~'''(~~''(CHARACTERGUID)'''''_Char''',''(GUIDSTRING)'''''_Point''',''(INTEGER)'''''_Running''',~~''(STRING)'''''~~_Event~~''')		* query '''QueryOnlyOnce'''(''(STRING)'''''_OnlyOnceUUID''')
	===== Description =====		===== Description =====
	~~This is~~ a ~~wrapper around the '''CharacterMoveTo''' API call that takes care of interactions with various other behaviours. A.o.,~~		Helper to ensure a rule gets executed only once.

	* It disables all dialogs while the character is moving.
	* It disables all reactions to crimes while the character is moving.
	* If the move is interrupted in one way or another, the character will resume moving after the interruption
	===== Return Values =====		===== Return Values =====
	* /		* '''Success/Failure''': Fails if '''QueryOnlyOnce''' was previously called with '''_OnlyOnceUUID''' as parameter, otherwise succeeds.
	===== Notes =====		===== Notes =====
	* If you ~~wish~~ to ~~abort a move initiated~~ this ~~way~~, ~~in addition to calling [[Osiris/API/CharacterPurgeQueue\|CharacterPurgeQueue]]~~, ~~you also have to call [[Osiris/Shared/ProcClearMovingFacts\|ProcClearMovingFacts]]. This will restore all of the suspended behaviours and prevent the resumption of the movement at a later moment.~~		* This query defines '''DB_OnlyOnce(_OnlyOnceUUID)''', so you can test that afterwards to determine whether this query has been executed already.
	* Preferably always use this routine or [[Osiris/Shared/ProcStateManagerCharacterMoveTo\|ProcStateManagerCharacterMoveTo]] instead of [[Osiris/API/CharacterMoveTo\|CharacterMoveTo]]		===== Example =====
			IF
			GameStarted("TUT_Tutorial_A",_)
			AND
			QueryOnlyOnce("FTJ_IfanStoryInit_TUT")
			THEN
			ItemToInventory(ITEMGUID_S_FTJ_IfanNoteFromDarkFaction_51899f0f-6ea2-4522-893b-69ccd87b97fb,CHARACTERGUID_S_Player_Ifan_ad9a3327-4456-42a7-9bf4-7ad60cc9e54f,-1,0);
	===== See Also =====		===== See Also =====
	* [[Osiris/API/CharacterMoveTo\|CharacterMoveTo]]		/
	* Helper [[Osiris/Shared/~~ProcStateManagerCharacterMoveTo\|ProcStateManagerCharacterMoveTo]]~~
			[[Category:Osiris Queries]]
	[[Category:Osiris ~~Shared Mod Helpers~~]]

Tinkerer at 21:12, 25 August 2017

2017-08-25T21:12:44Z

← Older revision		Revision as of 21:12, 25 August 2017
Line 11:		Line 11:
	===== Notes =====		===== Notes =====
	* If you wish to abort a move initiated this way, in addition to calling [[Osiris/API/CharacterPurgeQueue\|CharacterPurgeQueue]], you also have to call [[Osiris/Shared/ProcClearMovingFacts\|ProcClearMovingFacts]]. This will restore all of the suspended behaviours and prevent the resumption of the movement at a later moment.		* If you wish to abort a move initiated this way, in addition to calling [[Osiris/API/CharacterPurgeQueue\|CharacterPurgeQueue]], you also have to call [[Osiris/Shared/ProcClearMovingFacts\|ProcClearMovingFacts]]. This will restore all of the suspended behaviours and prevent the resumption of the movement at a later moment.
	* Preferably always use this routine or [[Osiris/Shared/~~ProcCharacterMoveTo~~\|~~ProcCharacterMoveTo~~]] instead of [[Osiris/API/CharacterMoveTo\|CharacterMoveTo]]		* Preferably always use this routine or [[Osiris/Shared/ProcStateManagerCharacterMoveTo\|ProcStateManagerCharacterMoveTo]] instead of [[Osiris/API/CharacterMoveTo\|CharacterMoveTo]]
	===== See Also =====		===== See Also =====
	* [[Osiris/API/CharacterMoveTo\|CharacterMoveTo]]		* [[Osiris/API/CharacterMoveTo\|CharacterMoveTo]]
	* Helper [[Osiris/Shared/~~ProcCharacterMoveTo~~\|~~ProcCharacterMoveTo~~]]		* Helper [[Osiris/Shared/ProcStateManagerCharacterMoveTo\|ProcStateManagerCharacterMoveTo]]

	[[Category:Osiris Shared Mod Helpers]]		[[Category:Osiris Shared Mod Helpers]]

Tinkerer at 21:10, 25 August 2017

2017-08-25T21:10:06Z

← Older revision		Revision as of 21:10, 25 August 2017
Line 10:		Line 10:
	* /		* /
	===== Notes =====		===== Notes =====
	* If you wish to abort a move initiated this way, in addition to calling ~~'''~~CharacterPurgeQueue~~'''(_'''Character''')~~, you also have to call ~~'''~~ProcClearMovingFacts~~'''('''_Character''')~~. This will restore all of the suspended behaviours and prevent the resumption of the movement at a later moment.		* If you wish to abort a move initiated this way, in addition to calling [[Osiris/API/CharacterPurgeQueue\|CharacterPurgeQueue]], you also have to call [[Osiris/Shared/ProcClearMovingFacts\|ProcClearMovingFacts]]. This will restore all of the suspended behaviours and prevent the resumption of the movement at a later moment.
	* Preferably always use this routine or ~~'''ProcStateManagerCharacterMoveTo'''~~ instead of ~~'''~~CharacterMoveTo~~'''~~		* Preferably always use this routine or [[Osiris/Shared/ProcCharacterMoveTo\|ProcCharacterMoveTo]] instead of [[Osiris/API/CharacterMoveTo\|CharacterMoveTo]]
	===== See Also =====		===== See Also =====
	* [[Osiris/API/CharacterMoveTo]]		* [[Osiris/API/CharacterMoveTo\|CharacterMoveTo]]
	* Helper [[Osiris/Shared/ProcCharacterMoveTo]]		* Helper [[Osiris/Shared/ProcCharacterMoveTo\|ProcCharacterMoveTo]]

	[[Category:Osiris Shared Mod Helpers]]		[[Category:Osiris Shared Mod Helpers]]

Tinkerer: Osiris Helper Mod APIs

2017-08-08T13:56:33Z

Osiris Helper Mod APIs

New page

===== Full Definition(s) =====
* PROC '''ProcCharacterMoveTo'''(''(CHARACTERGUID)'''''_Char''',''(GUIDSTRING)'''''_Point''',''(INTEGER)'''''_Running''',''(STRING)'''''_Event''')
===== Description =====
This is a wrapper around the '''CharacterMoveTo''' API call that takes care of interactions with various other behaviours. A.o.,

* It disables all dialogs while the character is moving.
* It disables all reactions to crimes while the character is moving.
* If the move is interrupted in one way or another, the character will resume moving after the interruption
===== Return Values =====
* /
===== Notes =====
* If you wish to abort a move initiated this way, in addition to calling '''CharacterPurgeQueue'''(_'''Character'''), you also have to call '''ProcClearMovingFacts'''('''_Character'''). This will restore all of the suspended behaviours and prevent the resumption of the movement at a later moment.
* Preferably always use this routine or '''ProcStateManagerCharacterMoveTo''' instead of '''CharacterMoveTo'''
===== See Also =====
* [[Osiris/API/CharacterMoveTo]]
* Helper [[Osiris/Shared/ProcCharacterMoveTo]]

[[Category:Osiris Shared Mod Helpers]]

← Older revision		Revision as of 13:42, 21 February 2018
Line 10:		Line 10:
	===== Notes =====		===== Notes =====
	* If you wish to abort a move initiated this way, in addition to calling [[Osiris/API/CharacterPurgeQueue\|CharacterPurgeQueue]], you also have to call [[Osiris/Shared/ProcClearStoryMove\|ProcClearStoryMove]]. This will restore all of the suspended behaviours and prevent the resumption of the movement at a later moment.		* If you wish to abort a move initiated this way, in addition to calling [[Osiris/API/CharacterPurgeQueue\|CharacterPurgeQueue]], you also have to call [[Osiris/Shared/ProcClearStoryMove\|ProcClearStoryMove]]. This will restore all of the suspended behaviours and prevent the resumption of the movement at a later moment.
	* Preferably always use this routine or [[Osiris/Shared/ProcStateManagerCharacterMoveTo\|ProcStateManagerCharacterMoveTo]] instead of [[Osiris/API/CharacterMoveTo\|CharacterMoveTo]]		* Preferably always use this routine or [[Osiris/Shared/ProcStateManagerCharacterMoveTo\|ProcStateManagerCharacterMoveTo]] instead of [[Osiris/API/CharacterMoveTo\|CharacterMoveTo]].
	===== See Also =====		===== See Also =====
	* [[Osiris/API/CharacterMoveTo\|CharacterMoveTo]]		* [[Osiris/API/CharacterMoveTo\|CharacterMoveTo]]
	* Helper [[Osiris/Shared/ProcClearStoryMove\|ProcClearStoryMove]		* Helper [[Osiris/Shared/ProcClearStoryMove\|ProcClearStoryMove]]
	* Helper [[Osiris/Shared/ProcStateManagerCharacterMoveTo\|ProcStateManagerCharacterMoveTo]]		* Helper [[Osiris/Shared/ProcStateManagerCharacterMoveTo\|ProcStateManagerCharacterMoveTo]]

	[[Category:Osiris Shared Mod Helpers\|CharacterMoveTo]]		[[Category:Osiris Shared Mod Helpers\|CharacterMoveTo]]

← Older revision		Revision as of 13:42, 21 February 2018
Line 9:		Line 9:
	* /		* /
	===== Notes =====		===== Notes =====
	* If you wish to abort a move initiated this way, in addition to calling [[Osiris/API/CharacterPurgeQueue\|CharacterPurgeQueue]], you also have to call [[Osiris/Shared/~~ProcClearMovingFacts~~\|~~ProcClearMovingFacts~~]]. This will restore all of the suspended behaviours and prevent the resumption of the movement at a later moment.		* If you wish to abort a move initiated this way, in addition to calling [[Osiris/API/CharacterPurgeQueue\|CharacterPurgeQueue]], you also have to call [[Osiris/Shared/ProcClearStoryMove\|ProcClearStoryMove]]. This will restore all of the suspended behaviours and prevent the resumption of the movement at a later moment.
	* Preferably always use this routine or [[Osiris/Shared/ProcStateManagerCharacterMoveTo\|ProcStateManagerCharacterMoveTo]] instead of [[Osiris/API/CharacterMoveTo\|CharacterMoveTo]]		* Preferably always use this routine or [[Osiris/Shared/ProcStateManagerCharacterMoveTo\|ProcStateManagerCharacterMoveTo]] instead of [[Osiris/API/CharacterMoveTo\|CharacterMoveTo]]
	===== See Also =====		===== See Also =====
	* [[Osiris/API/CharacterMoveTo\|CharacterMoveTo]]		* [[Osiris/API/CharacterMoveTo\|CharacterMoveTo]]
			* Helper [[Osiris/Shared/ProcClearStoryMove\|ProcClearStoryMove]
	* Helper [[Osiris/Shared/ProcStateManagerCharacterMoveTo\|ProcStateManagerCharacterMoveTo]]		* Helper [[Osiris/Shared/ProcStateManagerCharacterMoveTo\|ProcStateManagerCharacterMoveTo]]

	[[Category:Osiris Shared Mod Helpers\|CharacterMoveTo]]		[[Category:Osiris Shared Mod Helpers\|CharacterMoveTo]]