Difference between revisions of "Osiris/Shared/ProcCharacterMoveTo"

From Divinity Engine Wiki
Jump to: navigation, search
(Must call ProcClearStoryMove instead of ProcClearMovingFacts)
m
 
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]]

Latest revision as of 14:42, 21 February 2018

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
See Also