Difference between revisions of "Osiris/API/CharacterIsPlayer"

From Divinity Engine Wiki
Jump to: navigation, search
m
m
Line 15: Line 15:
 
===== See Also =====
 
===== See Also =====
 
* [[Osiris/API/CharacterAddToPlayerCharacter|CharacterAddToPlayerCharacter]]
 
* [[Osiris/API/CharacterAddToPlayerCharacter|CharacterAddToPlayerCharacter]]
 +
* [[Osiris/API/CharacterGetOwner|CharacterGetOwner]]
 
* [[Osiris/API/CharacterIsControlled|CharacterIsControlled]]
 
* [[Osiris/API/CharacterIsControlled|CharacterIsControlled]]
 
* [[Osiris/API/CharacterIsPartyFollower|CharacterIsPartyFollower]]
 
* [[Osiris/API/CharacterIsPartyFollower|CharacterIsPartyFollower]]

Revision as of 21:18, 28 February 2018

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.
See Also