Osiris/Shared/ProcCharacterMoveTo

From Divinity Engine Wiki
Revision as of 15:56, 8 August 2017 by Tinkerer (talk | contribs) (Osiris Helper Mod APIs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search
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