Difference between revisions of "Osiris/API/CharacterIsAlly"
From Divinity Engine Wiki
(Osiris Core APIs) |
m |
||
| (3 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
===== Full Definition(s) ===== | ===== Full Definition(s) ===== | ||
| − | * query '''CharacterIsAlly'''('''''[in]'''(CHARACTERGUID)'''''_Character''', ''''[in] | + | * query '''CharacterIsAlly'''('''''[in]'''(CHARACTERGUID)'''''_Character''', '''''[in]'''(CHARACTERGUID)'''''_OtherCharacter''', '''''[out]'''(INTEGER)'''''_Bool''') |
===== Description ===== | ===== Description ===== | ||
Returns whether '''_Character''' is an ally of '''_OtherCharacter'''. | Returns whether '''_Character''' is an ally of '''_OtherCharacter'''. | ||
===== Return Values ===== | ===== Return Values ===== | ||
* '''Success/Failure''': Default return value. | * '''Success/Failure''': Default return value. | ||
| − | * '''_Bool''': '''1''' if '''_Character''' and '''_OtherCharacter '''are allies, '''0''' if not | + | * '''_Bool''': '''1''' if '''_Character''' and '''_OtherCharacter''' are allies, '''0''' if not. |
===== Notes ===== | ===== Notes ===== | ||
* Also works outside combat. | * Also works outside combat. | ||
* If '''_Character''' or '''_OtherCharacter''' is dead or dying, the result solely depends on the characters' alignments (factions). If they are alive, it is also influenced by temporary hostile relations, e.g. induced by attacking a neutral character. | * If '''_Character''' or '''_OtherCharacter''' is dead or dying, the result solely depends on the characters' alignments (factions). If they are alive, it is also influenced by temporary hostile relations, e.g. induced by attacking a neutral character. | ||
===== See Also ===== | ===== See Also ===== | ||
| − | * [[Osiris/API/CharacterIsNeutral]] | + | * [[Osiris/API/CharacterIsNeutral|CharacterIsNeutral]] |
| − | * [[Osiris/API/CharacterIsEnemy]] | + | * [[Osiris/API/CharacterIsEnemy|CharacterIsEnemy]] |
| − | [[Category:Osiris Queries]] | + | [[Category:Osiris Queries|CharacterIsAlly]] |
Latest revision as of 13:10, 20 December 2017
Full Definition(s)
- query CharacterIsAlly([in](CHARACTERGUID)_Character, [in](CHARACTERGUID)_OtherCharacter, [out](INTEGER)_Bool)
Description
Returns whether _Character is an ally of _OtherCharacter.
Return Values
- Success/Failure: Default return value.
- _Bool: 1 if _Character and _OtherCharacter are allies, 0 if not.
Notes
- Also works outside combat.
- If _Character or _OtherCharacter is dead or dying, the result solely depends on the characters' alignments (factions). If they are alive, it is also influenced by temporary hostile relations, e.g. induced by attacking a neutral character.
