Difference between revisions of "Osiris/API/ObjectEnteredCombat"
From Divinity Engine Wiki
(Osiris Core APIs) |
m |
||
| (3 intermediate revisions by the same user not shown) | |||
| Line 8: | Line 8: | ||
===== Notes ===== | ===== Notes ===== | ||
* This can be a combat that is still being set up, or an existing combat joined by a character that wandered too close. | * This can be a combat that is still being set up, or an existing combat joined by a character that wandered too close. | ||
| − | * | + | * When this event gets thrown, this object's combat setup has not yet fully finished. This means you cannot yet use APIs such as [[Osiris/API/JumpToTurn|JumpToTurn]] on them. You can only use it to react in general to the object getting involved in a combat (e.g. to change alignments so that others join the combat as well). |
| + | * See [[Osiris/API/ObjectReadyInCombat|ObjectReadyInCombat]] for an explanation about when you can use [[Osiris/API/JumpToTurn|JumpToTurn]]. | ||
===== See Also ===== | ===== See Also ===== | ||
| − | * [[Osiris/API/CombatStarted]] | + | * [[Osiris/API/CombatStarted|CombatStarted]] |
| − | * [[Osiris/API/ObjectLeftCombat]] | + | * [[Osiris/API/ObjectLeftCombat|ObjectLeftCombat]] |
| − | + | * [[Osiris/API/ObjectReadyInCombat|ObjectReadyInCombat]] | |
| − | [[Category:Osiris Events]] | + | * Helper [[Osiris/Shared/DB_CombatCharacters|DB_CombatCharacters]] |
| + | * Helper [[Osiris/Shared/DB_WasInCombat|DB_WasInCombat]] | ||
| + | |||
| + | [[Category:Osiris Events|ObjectEnteredCombat]] | ||
Latest revision as of 16:14, 19 December 2017
Full Definition(s)
- event ObjectEnteredCombat((GUIDSTRING)_Object, (INTEGER)_CombatID)
Description
Thrown when an object (character or item) enters a combat.
Parameters
- _Object: The object that has entered the combat
- _CombatID: A handle that identifies the combat. Should always be > 0.
Notes
- This can be a combat that is still being set up, or an existing combat joined by a character that wandered too close.
- When this event gets thrown, this object's combat setup has not yet fully finished. This means you cannot yet use APIs such as JumpToTurn on them. You can only use it to react in general to the object getting involved in a combat (e.g. to change alignments so that others join the combat as well).
- See ObjectReadyInCombat for an explanation about when you can use JumpToTurn.
