Difference between revisions of "Osiris/API/CharacterIsPlayer"
From Divinity Engine Wiki
(Fixed CharacterFollowCharacter/CharacterAddToPlayerCharacter mixup) |
m |
||
| 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 ===== | ||
| − | * Apart from avatars and recruited companions, ''player-controlled'' characters also include summons and [[Osiris/API/CharacterAddToCharacter|party | + | * Apart from avatars and recruited companions, ''player-controlled'' characters also include summons and [[Osiris/API/CharacterAddToCharacter|party followers]]. They do ''not'' inlcude [[Osiris/API/CharacterFollowCharacter|regular followers]]. |
===== See Also ===== | ===== See Also ===== | ||
* [[Osiris/API/CharacterAddToCharacter|CharacterAddToCharacter]] | * [[Osiris/API/CharacterAddToCharacter|CharacterAddToCharacter]] | ||
Revision as of 21:13, 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
- Apart from avatars and recruited companions, player-controlled characters also include summons and party followers. They do not inlcude regular followers.
