Osiris/API/CharacterIsSummon: Difference between revisions

From Divinity Engine Wiki
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
Line 1: Line 1:
===== Full Definition(s) =====
===== Full Definition(s) =====
* query '''CharacterIsSummon'''('''''[in]'''(CHARACTERGUID)'''''_Character''', '''''[out]'''''(INTEGER)'''_Bool''')
* query '''CharacterIsSummon'''('''''[in]'''(CHARACTERGUID)'''''_Character''', '''''[out]'''(INTEGER)'''''_Bool''')
===== Description =====
===== Description =====
Returns whether '''_Character''' is a summon. Summons can be [[Osiris/API/CharacterIsPlayer|player-controlled]] or not.
Returns whether '''_Character''' is a summon. Summons can be [[Osiris/API/CharacterIsPlayer|player-controlled]] or not.
Line 12: Line 12:
* [[Osiris/API/CharacterIsPlayer|CharacterIsPlayer]]
* [[Osiris/API/CharacterIsPlayer|CharacterIsPlayer]]
   
   
[[Category:Osiris Queries]]
[[Category:Osiris Queries|CharacterIsSummon]]

Revision as of 14:29, 19 December 2017

Full Definition(s)
  • query CharacterIsSummon([in](CHARACTERGUID)_Character, [out](INTEGER)_Bool)
Description

Returns whether _Character is a summon. Summons 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.
See Also