Osiris/API/CharacterIsPlayer: Difference between revisions
Jump to navigation
Jump to search
m (linked CharacterIsControlled) |
mNo edit summary |
||
| 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''. | ||
| Line 19: | Line 19: | ||
* [[Osiris/API/CharacterIsSummon|CharacterIsSummon]] | * [[Osiris/API/CharacterIsSummon|CharacterIsSummon]] | ||
[[Category:Osiris Queries]] | [[Category:Osiris Queries|CharacterIsPlayer]] | ||
Revision as of 14:28, 19 December 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.