Osiris/API/Follow: Difference between revisions

From Divinity Engine Wiki
Jump to navigation Jump to search
m (Tinkerer moved page Osiris/API/CharacterFollowCharacter to Osiris/API/Follow: bg3 renames)
(Updated for bg3)
Line 1: Line 1:
===== Full Definition(s) =====
===== Full Definition(s) =====
* call  '''CharacterFollowCharacter'''(''(CHARACTERGUID)'''''_Character''', ''(CHARACTERGUID'')'''''_ToCharacter''')
* call  '''Follow'''(''(CHARACTER)'''''_Follower''', ''(CHARACTER)'''''_Leader''')


===== Description =====
===== Description =====
Makes '''_Character''' start following '''_ToCharacter'''.
Makes '''_Follower''' start following '''_Leader'''.


===== 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/PROC_Follow|PROC_Follow]] from the Shared mod. This will ensure that '''_Follower''''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]]).
* Use [[Osiris/API/StopFollow|StopFollow]] to stop the following behaviour (or [[Osiris/Shared/PROC_StopFollow|PROC_StopFollow]] if you used [[Osiris/Shared/PROC_Follow|PROC_Follow]]).
* 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/PROC_Follow|PROC_Follow]] 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_Followers|party follower]] or minion, which is done via [[Osiris/API/AddPartyFollower|AddPartyFollower]]. 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/GetReservedUserID|user]] that controls this player character.


===== See Also =====
===== See Also =====
* [[Osiris/API/CharacterAddToPlayerCharacter|CharacterAddToPlayerCharacter]]
* [[Osiris/API/AddPartyFollower|AddPartyFollower]]
* [[Osiris/API/CharacterStopFollow|CharacterStopFollow]]
* [[Osiris/API/StopFollow|StopFollow]]
* Helper [[Osiris/Shared/ProcCharacterFollowCharacter|ProcCharacterFollowCharacter]]
* Helper [[Osiris/Shared/PROC_Follow|PROC_Follow]]
* Helper [[Osiris/Shared/ProcCharacterStopFollow|ProcCharacterStopFollow]]
* Helper [[Osiris/Shared/PROC_StopFollow|PROC_StopFollow]]
   
   
[[Category:Osiris Calls|CharacterFollowCharacter]]
[[Category:Osiris Calls|Follow]]

Revision as of 12:17, 19 March 2021

Full Definition(s)
  • call Follow((CHARACTER)_Follower, (CHARACTER)_Leader)
Description

Makes _Follower start following _Leader.

Notes
  • Preferably use PROC_Follow from the Shared mod. This will ensure that _Follower's following behaviour gets suspended when it enters combat, and resumed afterwards.
  • Use StopFollow to stop the following behaviour (or PROC_StopFollow if you used PROC_Follow).
  • Make sure to stop following a previous character before starting to follow a new one. PROC_Follow 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 AddPartyFollower. 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
Retrieved from "https://docs.larian.game/index.php?title=Osiris/API/Follow&oldid=6705"