Difference between revisions of "Osiris/API/CharacterIsPlayer"
From Divinity Engine Wiki
m |
|||
| Line 4: | Line 4: | ||
Returns whether '''_Character''' is ''player-controlled''. | Returns whether '''_Character''' is ''player-controlled''. | ||
===== Return Values ===== | ===== Return Values ===== | ||
| − | * '''Success/Failure''': Fails if '''_Character''' does not exist | + | * '''Success/Failure''': Fails if '''_Character''' does not exist. |
| − | * '''_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 followers. | * Apart from avatars and recruited companions, ''player-controlled'' characters also include summons and followers. | ||
Revision as of 13:08, 3 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 followers.
