Osiris/API/Follow: Difference between revisions

From Divinity Engine Wiki
Jump to navigation Jump to search
m (links)
(Blanked the page)
 
(6 intermediate revisions by 2 users not shown)
Line 1: Line 1:
===== 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 [[Osiris/API/CharacterIsPlayer|CharacterIsPlayer]] query will return '''1''' for '''_Character'''.
* Preferably use [[Osiris/Shared/ProcCharacterFollowCharacter|ProcCharacterFollowCharacter]] from the Shared mod. This will ensure that '''_Character''''s following behaviour gets suspended when it enters combat, and resumed afterwards.
* Use [[Osiris/API/CharacterStopFollow|CharacterStopFollow]] to stop the following behaviour (or [[Osiris/Shared/ProcCharacterStopFollow|ProcCharacterStopFollow]] if you used [[Osiris/Shared/ProcCharacterFollowCharacter|ProcCharacterFollowCharacter]]).
* Make sure to stop following a previous character before starting to follow a new one. [[Osiris/Shared/ProcCharacterFollowCharacter|ProcCharacterFollowCharacter]] will automatically take care of this.
===== See Also =====
* [[Osiris/API/CharacterStopFollow|CharacterStopFollow]]
* Helper [[Osiris/Shared/ProcCharacterFollowCharacter|ProcCharacterFollowCharacter]]
* Helper [[Osiris/Shared/ProcCharacterStopFollow|ProcCharacterStopFollow]]
[[Category:Osiris Calls]]

Latest revision as of 12:29, 19 March 2021