Osiris/API/CharacterIsPlayer

From Divinity Engine Wiki
Revision as of 15:26, 28 January 2019 by Tinkerer (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search
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
Retrieved from "https://docs.larian.game/index.php?title=Osiris/API/CharacterIsPlayer&oldid=6505"