Difference between revisions of "Osiris/API/CharacterIsSummon"
From Divinity Engine Wiki
(Osiris Core APIs) |
m (→See Also) |
||
| (3 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
===== Full Definition(s) ===== | ===== Full Definition(s) ===== | ||
| − | * query '''CharacterIsSummon'''('''''[in]'''(CHARACTERGUID)'''''_Character''', '''''[out] | + | * query '''CharacterIsSummon'''('''''[in]'''(CHARACTERGUID)'''''_Character''', '''''[out]'''(INTEGER)'''''_Bool''') |
===== Description ===== | ===== Description ===== | ||
| − | Returns whether '''_Character''' is a summon. | + | Returns whether '''_Character''' is a summon. Summons can be [[Osiris/API/CharacterIsPlayer|player-controlled]] or not. |
===== 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 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/CharacterGetOwner|CharacterGetOwner]] |
| + | * [[Osiris/API/CharacterIsPlayer|CharacterIsPlayer]] | ||
| − | [[Category:Osiris Queries]] | + | [[Category:Osiris Queries|CharacterIsSummon]] |
Latest revision as of 14:53, 24 June 2020
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.
