Difference between revisions of "Osiris/API/CharacterIsPartyFollower"
From Divinity Engine Wiki
m |
m |
||
| Line 1: | Line 1: | ||
===== Full Definition(s) ===== | ===== Full Definition(s) ===== | ||
| − | * query '''CharacterIsPartyFollower'''('''''[in]'''(CHARACTERGUID)'''''_Character''', '''''[out] | + | * query '''CharacterIsPartyFollower'''('''''[in]'''(CHARACTERGUID)'''''_Character''', '''''[out]'''(INTEGER)'''''_Bool''') |
===== Description ===== | ===== Description ===== | ||
Returns whether '''_Character''' is a [[Osiris/API/CharacterAddToPlayerCharacter|party follower]]. | Returns whether '''_Character''' is a [[Osiris/API/CharacterAddToPlayerCharacter|party follower]]. | ||
===== Return Values ===== | ===== Return Values ===== | ||
| − | * '''Success/Failure''': Fails if '''_Character''' does not exist | + | * '''Success/Failure''': Fails if '''_Character''' does not exist. |
| − | * '''_Bool''': '''1''' if '''_Character''' is a party follower, '''0''' if not | + | * '''_Bool''': '''1''' if '''_Character''' is a party follower, '''0''' if not. |
===== Notes ===== | ===== Notes ===== | ||
* [[Osiris/API/CharacterIsPlayer|CharacterIsPlayer]] will also return true for [[Osiris/API/CharacterAddToPlayerCharacter|party followers]]. | * [[Osiris/API/CharacterIsPlayer|CharacterIsPlayer]] will also return true for [[Osiris/API/CharacterAddToPlayerCharacter|party followers]]. | ||
| Line 14: | Line 14: | ||
* [[Osiris/API/CharacterIsSummon|CharacterIsSummon]] | * [[Osiris/API/CharacterIsSummon|CharacterIsSummon]] | ||
| − | [[Category:Osiris Queries]] | + | [[Category:Osiris Queries|CharacterIsPartyFollower]] |
Revision as of 15:27, 19 December 2017
Full Definition(s)
- query CharacterIsPartyFollower([in](CHARACTERGUID)_Character, [out](INTEGER)_Bool)
Description
Returns whether _Character is a party follower.
Return Values
- Success/Failure: Fails if _Character does not exist.
- _Bool: 1 if _Character is a party follower, 0 if not.
Notes
- CharacterIsPlayer will also return true for party followers.
- This query is unrelated to "regular followers" created via CharacterFollowCharacter and will return false for such followers (unless they are also party followers, but there is no point in doing so since party followers will automatically follow their recruiter character).
