Difference between revisions of "Osiris/API/CharacterIsPlayer"

From Divinity Engine Wiki
Jump to: navigation, search
m
m
Line 11: Line 11:
 
** Recruited companions: NPCs turned into players afterwards through [[Osiris/API/CharacterMakePlayer|CharacterMakePlayer]]
 
** Recruited companions: NPCs turned into players afterwards through [[Osiris/API/CharacterMakePlayer|CharacterMakePlayer]]
 
** [[Osiris/API/CharacterIsSummon|Summons]] by other player-controlled characters
 
** [[Osiris/API/CharacterIsSummon|Summons]] by other player-controlled characters
** [[Osiris/API/CharacterAddToCharacter|Party followers]] of player-controlled characters
+
** [[Osiris/API/CharacterAddToPlayerCharacter|Party followers]] of player-controlled characters
 
* ''Player-controlled'' characters explicitly do ''not'' include [[Osiris/API/CharacterFollowCharacter|regular followers]].
 
* ''Player-controlled'' characters explicitly do ''not'' include [[Osiris/API/CharacterFollowCharacter|regular followers]].
 
===== See Also =====
 
===== See Also =====
* [[Osiris/API/CharacterAddToCharacter|CharacterAddToCharacter]]
+
* [[Osiris/API/CharacterAddToPlayerCharacter|CharacterAddToPlayerCharacter]]
 
* [[Osiris/API/CharacterIsPartyFollower|CharacterIsPartyFollower]]
 
* [[Osiris/API/CharacterIsPartyFollower|CharacterIsPartyFollower]]
 
* [[Osiris/API/CharacterIsSummon|CharacterIsSummon]]
 
* [[Osiris/API/CharacterIsSummon|CharacterIsSummon]]
 
   
 
   
 
[[Category:Osiris Queries]]
 
[[Category:Osiris Queries]]

Revision as of 21:53, 28 November 2017

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