Difference between revisions of "Osiris/API/CharacterIsPartyFollower"
From Divinity Engine Wiki
(Fixed CharacterFollowCharacter/CharacterAddToPlayerCharacter mixup) |
m |
||
| (3 intermediate revisions by the same user not shown) | |||
| 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 party followers. | + | * [[Osiris/API/CharacterIsPlayer|CharacterIsPlayer]] will also return true for [[Osiris/API/CharacterAddToPlayerCharacter|party followers]]. |
* This query is unrelated to "regular followers" created via [[Osiris/API/CharacterFollowCharacter|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). | * This query is unrelated to "regular followers" created via [[Osiris/API/CharacterFollowCharacter|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). | ||
===== See Also ===== | ===== See Also ===== | ||
* [[Osiris/API/CharacterAddToPlayerCharacter|CharacterAddToPlayerCharacter]] | * [[Osiris/API/CharacterAddToPlayerCharacter|CharacterAddToPlayerCharacter]] | ||
| + | * [[Osiris/API/CharacterGetOwner|CharacterGetOwner]] | ||
* [[Osiris/API/CharacterIsPlayer|CharacterIsPlayer]] | * [[Osiris/API/CharacterIsPlayer|CharacterIsPlayer]] | ||
* [[Osiris/API/CharacterIsSummon|CharacterIsSummon]] | * [[Osiris/API/CharacterIsSummon|CharacterIsSummon]] | ||
| − | + | * [[Osiris/API/CharacterRemoveFromPlayerCharacter|CharacterRemoveFromPlayerCharacter]] | |
| − | [[Category:Osiris Queries]] | + | |
| + | [[Category:Osiris Queries|CharacterIsPartyFollower]] | ||
Latest revision as of 22:18, 28 February 2018
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).
