Difference between revisions of "Osiris/API/CombatStarted"
From Divinity Engine Wiki
(Osiris Core APIs) |
m |
||
| Line 8: | Line 8: | ||
* This event can also be thrown for an ongoing combat after one or more participants left. In this case, first a new '''ObjectEnteredCombat''' event will be thrown for every participant still in the combat, followed by a new '''CombatStartedEvent''' with the same _'''CombatID''' as before. During these new '''ObjectEventeredCombat''' events and '''CombatStarted''' event, the combat must again be considered to be not completely initialised yet. | * This event can also be thrown for an ongoing combat after one or more participants left. In this case, first a new '''ObjectEnteredCombat''' event will be thrown for every participant still in the combat, followed by a new '''CombatStartedEvent''' with the same _'''CombatID''' as before. During these new '''ObjectEventeredCombat''' events and '''CombatStarted''' event, the combat must again be considered to be not completely initialised yet. | ||
* This event will also be thrown when two combats are merged. | * This event will also be thrown when two combats are merged. | ||
| + | * This event will '''not''' be thrown when an object joins an ongoing combat. | ||
===== See Also ===== | ===== See Also ===== | ||
* [[Osiris/API/ObjectEnteredCombat]] | * [[Osiris/API/ObjectEnteredCombat]] | ||
Revision as of 13:57, 25 August 2017
Full Definition(s)
- event CombatStarted((INTEGER)_CombatID)
Description
Thrown once a new combat has started and has been completely initialised. I.e., all initial participants have been added, and combat is ready to start.
Parameters
- _CombatID: A handle that identifies the combat. Should always be > 0.
Notes
- This event can also be thrown for an ongoing combat after one or more participants left. In this case, first a new ObjectEnteredCombat event will be thrown for every participant still in the combat, followed by a new CombatStartedEvent with the same _CombatID as before. During these new ObjectEventeredCombat events and CombatStarted event, the combat must again be considered to be not completely initialised yet.
- This event will also be thrown when two combats are merged.
- This event will not be thrown when an object joins an ongoing combat.
