Difference between revisions of "Osiris/API/CharacterIsSummon"
From Divinity Engine Wiki
(Osiris Core APIs) |
|||
| Line 7: | Line 7: | ||
* '''_Bool''': '''1''' if '''_Character''' is a summon, '''0''' if not'''.''' | * '''_Bool''': '''1''' if '''_Character''' is a summon, '''0''' if not'''.''' | ||
===== Notes ===== | ===== Notes ===== | ||
| − | |||
* Summons can also be distinguished by the fact that hey have the '''SUMMON''' tag. | * Summons can also be distinguished by the fact that hey have the '''SUMMON''' tag. | ||
| − | * If you wish to know whether a summon is ''player-controlled'', also check | + | * If you wish to know whether a summon is ''player-controlled'', also check [[Osiris/API/CharacterIsPlayer|CharacterIsPlayer]]. |
===== See Also ===== | ===== See Also ===== | ||
| − | * [[Osiris/API/CharacterIsPlayer]] | + | * [[Osiris/API/CharacterIsPlayer|CharacterIsPlayer]] |
[[Category:Osiris Queries]] | [[Category:Osiris Queries]] | ||
Revision as of 22:45, 25 August 2017
Full Definition(s)
- query CharacterIsSummon([in](CHARACTERGUID)_Character, [out](INTEGER)_Bool)
Description
Returns whether _Character is a summon. Summon can be player-controlled or not.
Return Values
- Success/Failure: Fails if _Character does not exist.
- _Bool: 1 if _Character is a summon, 0 if not.
Notes
- Summons can also be distinguished by the fact that hey have the SUMMON tag.
- If you wish to know whether a summon is player-controlled, also check CharacterIsPlayer.
