Osiris/API/CharacterReceivedDamage

From Divinity Engine Wiki
Revision as of 06:28, 23 October 2018 by Tinkerer (talk | contribs)
Jump to: navigation, search
Full Definition(s)
  • event CharacterReceivedDamage((CHARACTERGUID)_Character, (INTEGER)_Percentage, (GUIDSTRING)_Source)
Description

Thrown when a character receives damage from an attack or an environmental effect such as a surface.

Parameters
  • _Character: The character that was damaged.
  • (new in DOS2 Patch 5) _Percentage: The percentage of vitality/hit points that was removed by this damage event.
  • (new in DOS2 Patch 5) _Source: The GUID of the character or item that caused the damage. In case the damage is caused by a surface, this will be the creator of said surface (can be NULL if the game cannot determine the party responsible, e.g. if you are damaged by a static fire surface that was painted in the editor).
Notes
  • This event is thrown even when _Percentage is 0.0, i.e., all damage was blocked by armor or _Character was immune to the damage type.
  • This event is not thrown if the "damage" healed _Character (e.g. poison damage to a zombie); in that case, a corresponding HEAL status will be applied to _Character instead.
See Also
Retrieved from "https://docs.larian.game/index.php?title=Osiris/API/CharacterReceivedDamage&oldid=6437"