Osiris/API/Follow - Revision history

Tinkerer: Blanked the page

2021-03-19T12:29:33Z

Blanked the page

← Older revision		Revision as of 12:29, 19 March 2021
Line 1:		Line 1:
	~~===== Full Definition(s) =====~~
	* call '''Follow'''(''(CHARACTER)'''''_Follower''', ''(CHARACTER)'''''_Leader''')

	~~===== Description =====~~
	~~Makes '''_Follower''' start following '''_Leader'''.~~

	~~===== Notes =====~~
	* 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/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/PROC_Follow\|PROC_Follow]] will automatically take care of this.
	* 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 =====~~
	* [[Osiris/API/AddPartyFollower\|AddPartyFollower]]
	* [[Osiris/API/StopFollow\|StopFollow]]
	* Helper [[Osiris/Shared/PROC_Follow\|PROC_Follow]]
	* Helper [[Osiris/Shared/PROC_StopFollow\|PROC_StopFollow]]

	~~[[Category:Osiris Calls\|Follow]]~~

Tinkerer: Updated for bg3

2021-03-19T12:17:10Z

Updated for bg3

← Older revision		Revision as of 12:17, 19 March 2021
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]]

Tinkerer: Tinkerer moved page Osiris/API/CharacterFollowCharacter to Osiris/API/Follow: bg3 renames

2021-03-19T12:13:33Z

Tinkerer moved page Osiris/API/CharacterFollowCharacter to Osiris/API/Follow: bg3 renames

← Older revision	Revision as of 12:13, 19 March 2021
(No difference)

LaughingLeader: Removed the _Running parameter since it doesn't exist within the call.

2018-05-15T23:11:42Z

Removed the _Running parameter since it doesn't exist within the call.

← Older revision		Revision as of 23:11, 15 May 2018
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]]

Tinkerer at 15:15, 19 December 2017

2017-12-19T15:15:43Z

← Older revision		Revision as of 15:15, 19 December 2017
Line 14:		Line 14:
	* Helper [[Osiris/Shared/ProcCharacterStopFollow\|ProcCharacterStopFollow]]		* Helper [[Osiris/Shared/ProcCharacterStopFollow\|ProcCharacterStopFollow]]

	[[Category:Osiris Calls]]		[[Category:Osiris Calls\|CharacterFollowCharacter]]

Tinkerer at 20:13, 28 November 2017

2017-11-28T20:13:36Z

← Older revision		Revision as of 20:13, 28 November 2017
Line 7:		Line 7:
	* 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/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.		* 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]]

Tinkerer: CharacterFollowCharacter does NOT result in CharacterIsPlayer returning 1 for the follower character; there's a difference between these "regular followers" and "party followers" :|

2017-11-28T20:10:09Z

CharacterFollowCharacter does NOT result in CharacterIsPlayer returning 1 for the follower character; there's a difference between these "regular followers" and "party followers" :|

← Older revision		Revision as of 20:10, 28 November 2017
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 [[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.		* 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]]).		* 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.		* 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 =====		===== See Also =====
			* [[Osiris/API/CharacterAddToPlayerCharacter\|CharacterAddToPlayerCharacter]]
	* [[Osiris/API/CharacterStopFollow\|CharacterStopFollow]]		* [[Osiris/API/CharacterStopFollow\|CharacterStopFollow]]
	* Helper [[Osiris/Shared/ProcCharacterFollowCharacter\|ProcCharacterFollowCharacter]]		* Helper [[Osiris/Shared/ProcCharacterFollowCharacter\|ProcCharacterFollowCharacter]]

Tinkerer: links

2017-11-25T12:27:48Z

links

← Older revision		Revision as of 12:27, 25 November 2017
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 ~~'''~~CharacterIsPlayer~~'''~~ query will return '''1''' for '''_Character'''.		* As long as '''_Character''' is following '''_ToCharacter''', the [[Osiris/API/CharacterIsPlayer\|CharacterIsPlayer]] query will return '''1''' for '''_Character'''.
	* Preferably use ~~'''~~ProcCharacterFollowCharacter~~'''~~ from the Shared mod. This will ensure that '''_Character''''s 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.
	* Use ~~'''~~CharacterStopFollow~~'''~~ to stop the following ~~behaivour~~ (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.		* 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]]

Tinkerer at 20:34, 16 August 2017

2017-08-16T20:34:06Z

← Older revision		Revision as of 20:34, 16 August 2017
Line 2:		Line 2:
	* call '''CharacterFollowCharacter'''(''(CHARACTERGUID)'''''_Character''', ''(CHARACTERGUID'')'''''_ToCharacter''', ''(INTEGER)'''''_Running''')		* call '''CharacterFollowCharacter'''(''(CHARACTERGUID)'''''_Character''', ''(CHARACTERGUID'')'''''_ToCharacter''', ''(INTEGER)'''''_Running''')
	===== Description =====		===== Description =====
	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 '''CharacterIsPlayer''' query will return '''1''' for '''_Character'''.		* As long as '''_Character''' is following '''_ToCharacter''', the '''CharacterIsPlayer''' query will return '''1''' for '''_Character'''.
Line 8:		Line 8:
	* Use '''CharacterStopFollow''' to stop the following behaivour (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.		* Use '''CharacterStopFollow''' to stop the following behaivour (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.
	===== See Also =====		===== See Also =====
	* [[Osiris/API/CharacterStopFollow]]		* [[Osiris/API/CharacterStopFollow\|CharacterStopFollow]]
	* Helper [[Osiris/Shared/ProcCharacterFollowCharacter]]		* Helper [[Osiris/Shared/ProcCharacterFollowCharacter\|ProcCharacterFollowCharacter]]
	* Helper [[Osiris/Shared/ProcCharacterStopFollow]]		* Helper [[Osiris/Shared/ProcCharacterStopFollow\|ProcCharacterStopFollow]]

	[[Category:Osiris Calls]]		[[Category:Osiris Calls]]

Tinkerer: Osiris Core APIs

2017-08-08T13:52:35Z

Osiris Core APIs

New page

===== 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 gets suspended when it enters combat, and resumed afterwards.
* Use '''CharacterStopFollow''' to stop the following behaivour (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.
===== See Also =====
* [[Osiris/API/CharacterStopFollow]]
* Helper [[Osiris/Shared/ProcCharacterFollowCharacter]]
* Helper [[Osiris/Shared/ProcCharacterStopFollow]]

[[Category:Osiris Calls]]

← Older revision		Revision as of 12:17, 19 March 2021
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]]

← Older revision		Revision as of 20:13, 28 November 2017
Line 7:		Line 7:
	* 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/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.		* 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]]

← Older revision		Revision as of 20:10, 28 November 2017
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 [[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.		* 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]]).		* 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.		* 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 =====		===== See Also =====
			* [[Osiris/API/CharacterAddToPlayerCharacter\|CharacterAddToPlayerCharacter]]
	* [[Osiris/API/CharacterStopFollow\|CharacterStopFollow]]		* [[Osiris/API/CharacterStopFollow\|CharacterStopFollow]]
	* Helper [[Osiris/Shared/ProcCharacterFollowCharacter\|ProcCharacterFollowCharacter]]		* Helper [[Osiris/Shared/ProcCharacterFollowCharacter\|ProcCharacterFollowCharacter]]