Osiris/API/CharacterIsPlayer: Difference between revisions
Jump to navigation
Jump to search
m (Clearer layout of the definition of "player-controlled") |
mNo edit summary |
||
| Line 10: | Line 10: | ||
** Avatars: character chosen during character creation | ** Avatars: character chosen during character creation | ||
** 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]] | ** [[Osiris/API/CharacterIsSummon|Summons]] by other player-controlled characters | ||
** [[Osiris/API/CharacterAddToCharacter|Party followers]] | ** [[Osiris/API/CharacterAddToCharacter|Party followers]] | ||
* ''Player-controlled'' characters explicitly do ''not'' include [[Osiris/API/CharacterFollowCharacter|regular followers]]. | * ''Player-controlled'' characters explicitly do ''not'' include [[Osiris/API/CharacterFollowCharacter|regular followers]]. | ||
Revision as of 20:25, 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
- Player-controlled characters explicitly do not include regular followers.