Difference between revisions of "Osiris/API/Follow"

From Divinity Engine Wiki
Jump to: navigation, search
m
m (Removed the _Running parameter since it doesn't exist within the call.)
Line 1: Line 1:
 
===== Full Definition(s) =====
 
===== Full Definition(s) =====
* call  '''CharacterFollowCharacter'''(''(CHARACTERGUID)'''''_Character''', ''(CHARACTERGUID'')'''''_ToCharacter''', ''(INTEGER)'''''_Running''')
+
* call  '''CharacterFollowCharacter'''(''(CHARACTERGUID)'''''_Character''', ''(CHARACTERGUID'')'''''_ToCharacter''')
 +
 
 
===== Description =====
 
===== Description =====
Makes '''_Character''' start following '''_ToCharacter'''. '''_Running''' indicates whether '''_Character''' should walk or run.
+
Makes '''_Character''' start following '''_ToCharacter'''.
 +
 
 
===== Notes =====
 
===== Notes =====
 
* 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.
 
* 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.
Line 8: Line 10:
 
* 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.
 
* 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.
 
* Note that this call does ''not'' turn '''_Character''' in a so-called "party follower" or minion, which is done via [[Osiris/API/CharacterAddToPlayerCharacter|CharacterAddToPlayerCharacter]]. The difference between "regular followers" (as created by this routine) and party followers/minions is that regular followers simply follow any other character around (you can have one NPC follow another one, if you want), while party followers/minions always follow a player-controlled character and can be partially controlled by the [[Osiris/API/CharacterGetReservedUserID|user]] that controls this player character.
 
* Note that this call does ''not'' turn '''_Character''' in a so-called "party follower" or minion, which is done via [[Osiris/API/CharacterAddToPlayerCharacter|CharacterAddToPlayerCharacter]]. The difference between "regular followers" (as created by this routine) and party followers/minions is that regular followers simply follow any other character around (you can have one NPC follow another one, if you want), while party followers/minions always follow a player-controlled character and can be partially controlled by the [[Osiris/API/CharacterGetReservedUserID|user]] that controls this player character.
 +
 
===== See Also =====
 
===== See Also =====
 
* [[Osiris/API/CharacterAddToPlayerCharacter|CharacterAddToPlayerCharacter]]
 
* [[Osiris/API/CharacterAddToPlayerCharacter|CharacterAddToPlayerCharacter]]

Revision as of 00:11, 16 May 2018

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

Makes _Character start following _ToCharacter.

Notes
  • Preferably use ProcCharacterFollowCharacter from the Shared mod. This will ensure that _Character's following behaviour gets suspended when it enters combat, and resumed afterwards.
  • Use CharacterStopFollow to stop the following behaviour (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.
  • Note that this call does not turn _Character in a so-called "party follower" or minion, which is done via CharacterAddToPlayerCharacter. The difference between "regular followers" (as created by this routine) and party followers/minions is that regular followers simply follow any other character around (you can have one NPC follow another one, if you want), while party followers/minions always follow a player-controlled character and can be partially controlled by the user that controls this player character.
See Also