Difference between revisions of "Osiris/API/ApplyDamage"
From Divinity Engine Wiki
m |
m |
||
| Line 5: | Line 5: | ||
Applies '''_Damage''' points of '''_DamageType''' damage to '''_Object'''. | Applies '''_Damage''' points of '''_DamageType''' damage to '''_Object'''. | ||
| − | (New parameter in DOS2 Patch 5)If '''_Source''' is not '''''NULL''''', it will be considered as the source of the damage and will be reported as such to [[Osiris/API/CharacterReceivedDamage|CharacterReceivedDamage]] and, if the character dies as a consequence of this damage application, to [[Osiris/API/CharacterKilledBy|CharacterKilledBy]] and [[Osiris/API/CharacterTemplateKilledByCharacter|CharacterTemplateKilledByCharacter]]. | + | ''(New parameter in DOS2 Patch 5)'' If '''_Source''' is not '''''NULL''''', it will be considered as the source of the damage and will be reported as such to [[Osiris/API/CharacterReceivedDamage|CharacterReceivedDamage]] and, if the character dies as a consequence of this damage application, to [[Osiris/API/CharacterKilledBy|CharacterKilledBy]] and [[Osiris/API/CharacterTemplateKilledByCharacter|CharacterTemplateKilledByCharacter]]. |
===== Notes ===== | ===== Notes ===== | ||
* The overload in the Shared mod uses the default '''_Source''' = '''NULL_00000000-0000-0000-0000-000000000000'''. | * The overload in the Shared mod uses the default '''_Source''' = '''NULL_00000000-0000-0000-0000-000000000000'''. | ||
Revision as of 00:52, 25 February 2018
Full Definition(s)
- (Shared mod) call ApplyDamage((GUIDSTRING)_Object, (INTEGER)_Damage, (STRING)_DamageType)
- call ApplyDamage((GUIDSTRING)_Object, (INTEGER)_Damage, (STRING)_DamageType, (GUIDSTRING)_Source)
Description
Applies _Damage points of _DamageType damage to _Object.
(New parameter in DOS2 Patch 5) If _Source is not NULL, it will be considered as the source of the damage and will be reported as such to CharacterReceivedDamage and, if the character dies as a consequence of this damage application, to CharacterKilledBy and CharacterTemplateKilledByCharacter.
Notes
- The overload in the Shared mod uses the default _Source = NULL_00000000-0000-0000-0000-000000000000.
