Difference between revisions of "Osiris/API/Follow"
From Divinity Engine Wiki
m |
m (links) |
||
| Line 4: | Line 4: | ||
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 | + | * As long as '''_Character''' is following '''_ToCharacter''', the [[Osiris/API/CharacterIsPlayer|CharacterIsPlayer]] query will return '''1''' for '''_Character'''. |
| − | * Preferably use | + | * 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 | + | * 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 ===== | ===== See Also ===== | ||
* [[Osiris/API/CharacterStopFollow|CharacterStopFollow]] | * [[Osiris/API/CharacterStopFollow|CharacterStopFollow]] | ||
Revision as of 14:27, 25 November 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 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.
