Difference between revisions of "Osiris/Shared/DB CombatCharacters"
From Divinity Engine Wiki
(Documented DB_CombatCharacters and DB_WasInCombat) |
(→Notes) |
||
| (5 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
===== Full Definition(s) ===== | ===== Full Definition(s) ===== | ||
| − | * '''DB_CombatCharacters | + | * '''DB_CombatCharacters'''(''(CHARACTERGUID)'''''_Char, ''(INTEGER)'''''_ID''') |
| − | * '''DB_WasInCombat | + | * '''DB_WasInCombat'''(''(CHARACTERGUID)'''''_Char, ''(INTEGER)'''''_ID''') |
| − | ===== Description ==== | + | ===== Description ===== |
Whenever a character [[Osiris/API/ObjectEnteredCombat|enters]] a combat, the a corresponding '''DB_CombatCharacters''' entry is defined that contains the character '''_Char''' and the '''_ID''' of the combat. Entering a combat will also clear any previous '''DB_CombatCharacters''' and '''DB_WasInCombat''' entries for this character. | Whenever a character [[Osiris/API/ObjectEnteredCombat|enters]] a combat, the a corresponding '''DB_CombatCharacters''' entry is defined that contains the character '''_Char''' and the '''_ID''' of the combat. Entering a combat will also clear any previous '''DB_CombatCharacters''' and '''DB_WasInCombat''' entries for this character. | ||
Whenever a combat [[Osiris/API/ObjectLeftCombat|leaves]] a combat, a '''DB_WasInCombat''' entry is defined that contains the character '''_Char''' and the '''_ID''' of the combat | Whenever a combat [[Osiris/API/ObjectLeftCombat|leaves]] a combat, a '''DB_WasInCombat''' entry is defined that contains the character '''_Char''' and the '''_ID''' of the combat | ||
===== Notes ===== | ===== Notes ===== | ||
| − | * | + | * Combat IDs are reused by code once combats end, so '''DB_WasInCombat()''' is quite unreliable and should not be used. |
| + | |||
===== See Also ===== | ===== See Also ===== | ||
* [[Osiris/API/ObjectEnteredCombat|ObjectEnteredCombat]] | * [[Osiris/API/ObjectEnteredCombat|ObjectEnteredCombat]] | ||
* [[Osiris/API/ObjectLeftCombat|ObjectLeftCombat]] | * [[Osiris/API/ObjectLeftCombat|ObjectLeftCombat]] | ||
| − | [[Category:Osiris Shared Mod Helpers]] | + | [[Category:Osiris Shared Mod Helpers|CombatCharacters|CombatCharacters]] |
Latest revision as of 08:36, 6 July 2018
Full Definition(s)
- DB_CombatCharacters((CHARACTERGUID)_Char, (INTEGER)_ID)
- DB_WasInCombat((CHARACTERGUID)_Char, (INTEGER)_ID)
Description
Whenever a character enters a combat, the a corresponding DB_CombatCharacters entry is defined that contains the character _Char and the _ID of the combat. Entering a combat will also clear any previous DB_CombatCharacters and DB_WasInCombat entries for this character.
Whenever a combat leaves a combat, a DB_WasInCombat entry is defined that contains the character _Char and the _ID of the combat
Notes
- Combat IDs are reused by code once combats end, so DB_WasInCombat() is quite unreliable and should not be used.
