Difference between revisions of "Osiris/API/CharacterIsPlayer"
From Divinity Engine Wiki
m |
m (Clearer layout of the definition of "player-controlled") |
||
| Line 7: | Line 7: | ||
* '''_Bool''': '''1''' if '''_Character''' is ''player-controlled'', '''0''' if not. | * '''_Bool''': '''1''' if '''_Character''' is ''player-controlled'', '''0''' if not. | ||
===== Notes ===== | ===== Notes ===== | ||
| − | * | + | * ''Player-controlled'' characters include: |
| + | ** Avatars: character chosen during character creation | ||
| + | ** Recruited companions: NPCs turned into players afterwards through [[Osiris/API/CharacterMakePlayer|CharacterMakePlayer]] | ||
| + | ** [[Osiris/API/CharacterIsSummon|Summons]] | ||
| + | ** [[Osiris/API/CharacterAddToCharacter|Party followers]] | ||
| + | * ''Player-controlled'' characters explicitly do ''not'' include [[Osiris/API/CharacterFollowCharacter|regular followers]]. | ||
===== See Also ===== | ===== See Also ===== | ||
* [[Osiris/API/CharacterAddToCharacter|CharacterAddToCharacter]] | * [[Osiris/API/CharacterAddToCharacter|CharacterAddToCharacter]] | ||
Revision as of 22:23, 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
- Party followers
- Player-controlled characters explicitly do not include regular followers.
