Difference between revisions of "Osiris/Shared/ProcStateManagerCharacterMoveTo"

From Divinity Engine Wiki
Jump to: navigation, search
m
m
Line 7: Line 7:
 
===== Notes =====
 
===== Notes =====
 
* This routine requires that the ''State_Manager_GoTo'' character script has been assigned to '''_Char'''
 
* This routine requires that the ''State_Manager_GoTo'' character script has been assigned to '''_Char'''
* This routine can be used instead of the regular '''ProcCharacterMoveTo()''' if you want a character to join combats it encounters on its way.
+
* This routine can be used instead of the regular [[Osiris/Shared/ProcCharacterMoveTo|ProcCharacterMoveTo]] if you want a character to join combats it encounters on its way.
* Preferably always use this routine or '''ProcCharacterMoveTo''' 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]]

Revision as of 22:12, 25 August 2017

Full Definition(s)
  • PROC ProcStateManagerCharacterMoveTo'((CHARACTERGUID)_Char,'(GUIDSTRING)_Destination,(INTEGER)_Running,(REAL)_MaxDist,(STRING)_Event,(STRING)_AfterArrivalState)
Description

Uses a behaviour script's CharacterMoveTo to move _Char to _Destination (can be a character, item or trigger). _Running can be 0 or 1 to indicate walking resp. running. _MaxDist indicates the maximum distance between _Char and _Destination before the routine can assume that _Char has arrived. If _Event is a non-empty string, a Character Event will be raised for _Char once it arrives. _AfterArrivalState specifies the state to which the character should go when it arrives (can be an empty string to disable the state manager afterwards).

Return Values
  • /
Notes
  • This routine requires that the State_Manager_GoTo character script has been assigned to _Char
  • This routine can be used instead of the regular ProcCharacterMoveTo if you want a character to join combats it encounters on its way.
  • Preferably always use this routine or ProcCharacterMoveTo instead of CharacterMoveTo
See Also