Osiris/API/ObjectEnteredCombat

From Divinity Engine Wiki
Revision as of 16:14, 19 December 2017 by Tinkerer (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search
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.
See Also