Difference between revisions of "Osiris/API/CharacterFollowCharacter"
From Divinity Engine Wiki
(Tinkerer moved page Osiris/API/CharacterFollowCharacter to Osiris/API/Follow: bg3 renames) |
m (Added a link to CharacterSetFollowCharacter) |
||
| (One intermediate revision by one other user not shown) | |||
| Line 1: | Line 1: | ||
| − | + | ===== Full Definition(s) ===== | |
| + | * call '''CharacterFollowCharacter'''(''(CHARACTERGUID)'''''_Character''', ''(CHARACTERGUID'')'''''_ToCharacter''') | ||
| + | |||
| + | ===== Description ===== | ||
| + | Makes '''_Character''' start following '''_ToCharacter'''. | ||
| + | |||
| + | ===== 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. | ||
| + | * 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. | ||
| + | * 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 ===== | ||
| + | * [[Osiris/API/CharacterAddToPlayerCharacter|CharacterAddToPlayerCharacter]] | ||
| + | * [[Osiris/API/CharacterStopFollow|CharacterStopFollow]] | ||
| + | * [[Osiris/API/CharacterSetFollowCharacter|CharacterSetFollowCharacter]] | ||
| + | * Helper [[Osiris/Shared/ProcCharacterFollowCharacter|ProcCharacterFollowCharacter]] | ||
| + | * Helper [[Osiris/Shared/ProcCharacterStopFollow|ProcCharacterStopFollow]] | ||
| + | |||
| + | [[Category:Osiris Calls|CharacterFollowCharacter]] | ||
Latest revision as of 20:21, 2 June 2022
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.
