Difference between revisions of "Osiris/API/CharacterIsPlayer"
From Divinity Engine Wiki
(Osiris Core APIs) |
m |
||
| (11 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
===== Full Definition(s) ===== | ===== Full Definition(s) ===== | ||
| − | * query '''CharacterIsPlayer'''('''''[in]'''(CHARACTERGUID)'''''_Character''', '''''[out] | + | * query '''CharacterIsPlayer'''('''''[in]'''(CHARACTERGUID)'''''_Character''', '''''[out]'''(INTEGER)'''''_Bool''') |
===== Description ===== | ===== Description ===== | ||
Returns whether '''_Character''' is ''player-controlled''. | Returns whether '''_Character''' is ''player-controlled''. | ||
===== 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 ''player-controlled'', '''0''' if not | + | * '''_Bool''': '''1''' if '''_Character''' is ''player-controlled'', '''0''' if not. |
===== Notes ===== | ===== Notes ===== | ||
| − | * | + | * ''Player-controlled'' characters include: |
| + | ** Avatars: character chosen during character creation | ||
| + | ** Recruited companions: NPCs turned into players afterwards through [[Osiris/API/CharacterMakePlayer|CharacterMakePlayer]] | ||
| + | ** [[Osiris/API/CharacterIsSummon|Summons]] by other player-controlled characters | ||
| + | ** [[Osiris/API/CharacterAddToPlayerCharacter|Party followers]] of player-controlled characters | ||
| + | * ''Player-controlled'' characters explicitly do ''not'' include [[Osiris/API/CharacterFollowCharacter|regular followers]]. | ||
===== See Also ===== | ===== See Also ===== | ||
| − | * [[Osiris/API/CharacterIsPartyFollower]] | + | * [[Osiris/API/CharacterAddToPlayerCharacter|CharacterAddToPlayerCharacter]] |
| − | * [[Osiris/API/ | + | * [[Osiris/API/CharacterGetOwner|CharacterGetOwner]] |
| − | * [[Osiris/API/ | + | * [[Osiris/API/CharacterIsControlled|CharacterIsControlled]] |
| + | * [[Osiris/API/CharacterIsPartyFollower|CharacterIsPartyFollower]] | ||
| + | * [[Osiris/API/CharacterIsPartyMember|CharacterIsPartyMember]] | ||
| + | * [[Osiris/API/CharacterIsSummon|CharacterIsSummon]] | ||
| − | [[Category:Osiris Queries]] | + | [[Category:Osiris Queries|CharacterIsPlayer]] |
Latest revision as of 14:26, 28 January 2019
Full Definition(s)
- query CharacterIsPlayer([in](CHARACTERGUID)_Character, [out](INTEGER)_Bool)
Description
Returns whether _Character is player-controlled.
Return Values
- Success/Failure: Fails if _Character does not exist.
- _Bool: 1 if _Character is player-controlled, 0 if not.
Notes
- Player-controlled characters include:
- Avatars: character chosen during character creation
- Recruited companions: NPCs turned into players afterwards through CharacterMakePlayer
- Summons by other player-controlled characters
- Party followers of player-controlled characters
- Player-controlled characters explicitly do not include regular followers.
