Difference between revisions of "Osiris/API/Follow"

From Divinity Engine Wiki
Jump to: navigation, search
(Osiris Core APIs)
 
m
Line 2: Line 2:
 
* call  '''CharacterFollowCharacter'''(''(CHARACTERGUID)'''''_Character''', ''(CHARACTERGUID'')'''''_ToCharacter''', ''(INTEGER)'''''_Running''')
 
* call  '''CharacterFollowCharacter'''(''(CHARACTERGUID)'''''_Character''', ''(CHARACTERGUID'')'''''_ToCharacter''', ''(INTEGER)'''''_Running''')
 
===== Description =====
 
===== Description =====
  Makes '''_Character''' start following '''_ToCharacter'''. '''_Running''' indicates whether '''_Character''' should walk or run.
+
Makes '''_Character''' start following '''_ToCharacter'''. '''_Running''' indicates whether '''_Character''' should walk or run.
 
===== Notes =====
 
===== Notes =====
 
* As long as '''_Character''' is following '''_ToCharacter''', the '''CharacterIsPlayer''' query will return '''1''' for '''_Character'''.
 
* As long as '''_Character''' is following '''_ToCharacter''', the '''CharacterIsPlayer''' query will return '''1''' for '''_Character'''.
Line 8: Line 8:
 
* Use '''CharacterStopFollow''' to stop the following behaivour (or '''ProcCharacterStopFollow''' if you used '''ProcCharacterFollowCharacter'''). Make sure to stop following a previous character before starting to follow a new one. '''ProcCharacterFollowCharacter''' will automatically take care of this.
 
* Use '''CharacterStopFollow''' to stop the following behaivour (or '''ProcCharacterStopFollow''' if you used '''ProcCharacterFollowCharacter'''). Make sure to stop following a previous character before starting to follow a new one. '''ProcCharacterFollowCharacter''' will automatically take care of this.
 
===== See Also =====
 
===== See Also =====
* [[Osiris/API/CharacterStopFollow]]
+
* [[Osiris/API/CharacterStopFollow|CharacterStopFollow]]
* Helper [[Osiris/Shared/ProcCharacterFollowCharacter]]
+
* Helper [[Osiris/Shared/ProcCharacterFollowCharacter|ProcCharacterFollowCharacter]]
* Helper [[Osiris/Shared/ProcCharacterStopFollow]]
+
* Helper [[Osiris/Shared/ProcCharacterStopFollow|ProcCharacterStopFollow]]
 
   
 
   
 
[[Category:Osiris Calls]]
 
[[Category:Osiris Calls]]

Revision as of 21:34, 16 August 2017

Full Definition(s)
  • call CharacterFollowCharacter((CHARACTERGUID)_Character, (CHARACTERGUID)_ToCharacter, (INTEGER)_Running)
Description

Makes _Character start following _ToCharacter. _Running indicates whether _Character should walk or run.

Notes
  • As long as _Character is following _ToCharacter, the CharacterIsPlayer query will return 1 for _Character.
  • Preferably use ProcCharacterFollowCharacter from the Shared mod. This will ensure that _Character's gets suspended when it enters combat, and resumed afterwards.
  • Use CharacterStopFollow to stop the following behaivour (or ProcCharacterStopFollow if you used ProcCharacterFollowCharacter). Make sure to stop following a previous character before starting to follow a new one. ProcCharacterFollowCharacter will automatically take care of this.
See Also