API Docs (pts)

Back to index...

Name	Type	Deprecated	Secure	Description
Event.Combat.Damage				Signals damage done to a unit. All units referenced by this event will be accessible within this ...
Event.Combat.Death				Signals the death of a unit. All units referenced by this event will be accessible within this ev...
Event.Combat.Dodge				Signals a unit dodging an ability. All units referenced by this event will be accessible within t...
Event.Combat.Heal				Signals healing done to a unit. All units referenced by this event will be accessible within this...
Event.Combat.Immune				Signals a unit resisting an ability through immunity. All units referenced by this event will be ...
Event.Combat.Miss				Signals an ability's effect missing a unit. All units referenced by this event will be accessible...
Event.Combat.Parry				Signals a unit parrying an ability. All units referenced by this event will be accessible within ...
Event.Combat.Resist				Signals a unit resisting an ability. All units referenced by this event will be accessible within...

Event.Combat.Damage

Signals damage done to a unit. All units referenced by this event will be accessible within this event's handlers.

Usage:

Parameter	Type	Datatype	Description
Event.Combat.Damage(info)
info	parameter	variant	Detailed information table about this event, containing several named parameters.

members

ability	The ability ID for the ability used, if available.
abilityName	The name of the ability used.
caster	The unit ID for this event's initiator, if one exists.
casterName	The name of this event's initiator, if available.
crit	Whether this was the result of a critical hit.
damage	The amount of damage actually done.
damageAbsorbed	The amount of damage absorbed.
damageBlocked	The amount of damage blocked.
damageDeflected	The amount of damage deflected.
damageIntercepted	The amount of damage intercepted.
damageModified	The amount of damage modified.
overkill	The amount of overkill done.
target	The unit ID for the target.
targetName	The name of the target, if available.
type	The damage type. Values include "life", "death", "air", "earth", "fire", "water".

Event.Combat.Death

Signals the death of a unit. All units referenced by this event will be accessible within this event's handlers.

Usage:

Parameter	Type	Datatype	Description
Event.Combat.Death(info)
info	parameter	variant	Detailed information table about this event, containing several named parameters.

members

caster	The unit ID for this event's initiator, if one exists.
casterName	The name of this event's initiator, if available.
target	The unit ID for the target.
targetName	The name of the target, if available.

Event.Combat.Dodge

Signals a unit dodging an ability. All units referenced by this event will be accessible within this event's handlers.

Usage:

Parameter	Type	Datatype	Description
Event.Combat.Dodge(info)
info	parameter	variant	Detailed information table about this event, containing several named parameters.

members

ability	The ability ID for the ability used, if available.
abilityName	The name of the ability used.
caster	The unit ID for this event's initiator, if one exists.
casterName	The name of this event's initiator, if available.
target	The unit ID for the target.
targetName	The name of the target, if available.

Event.Combat.Heal

Signals healing done to a unit. All units referenced by this event will be accessible within this event's handlers.

Usage:

Parameter	Type	Datatype	Description
Event.Combat.Heal(info)
info	parameter	variant	Detailed information table about this event, containing several named parameters.

members

ability	The ability ID for the ability used, if available.
abilityName	The name of the ability used.
caster	The unit ID for this event's initiator, if one exists.
casterName	The name of this event's initiator, if available.
crit	Whether this was the result of a critical hit.
heal	The amount healed.
overheal	The amount of healing past maximum health wasted.
target	The unit ID for the target.
targetName	The name of the target, if available.

Event.Combat.Immune

Signals a unit resisting an ability through immunity. All units referenced by this event will be accessible within this event's handlers.

Usage:

Parameter	Type	Datatype	Description
Event.Combat.Immune(info)
info	parameter	variant	Detailed information table about this event, containing several named parameters.

members

ability	The ability ID for the ability used, if available.
abilityName	The name of the ability used.
caster	The unit ID for this event's initiator, if one exists.
casterName	The name of this event's initiator, if available.
target	The unit ID for the target.
targetName	The name of the target, if available.

Event.Combat.Miss

Signals an ability's effect missing a unit. All units referenced by this event will be accessible within this event's handlers.

Usage:

Parameter	Type	Datatype	Description
Event.Combat.Miss(info)
info	parameter	variant	Detailed information table about this event, containing several named parameters.

members

ability	The ability ID for the ability used, if available.
abilityName	The name of the ability used.
caster	The unit ID for this event's initiator, if one exists.
casterName	The name of this event's initiator, if available.
target	The unit ID for the target.
targetName	The name of the target, if available.

Event.Combat.Parry

Signals a unit parrying an ability. All units referenced by this event will be accessible within this event's handlers.

Usage:

Parameter	Type	Datatype	Description
Event.Combat.Parry(info)
info	parameter	variant	Detailed information table about this event, containing several named parameters.

members

ability	The ability ID for the ability used, if available.
abilityName	The name of the ability used.
caster	The unit ID for this event's initiator, if one exists.
casterName	The name of this event's initiator, if available.
target	The unit ID for the target.
targetName	The name of the target, if available.

Event.Combat.Resist

Signals a unit resisting an ability. All units referenced by this event will be accessible within this event's handlers.

Usage:

Parameter	Type	Datatype	Description
Event.Combat.Resist(info)
info	parameter	variant	Detailed information table about this event, containing several named parameters.

members

ability	The ability ID for the ability used, if available.
abilityName	The name of the ability used.
caster	The unit ID for this event's initiator, if one exists.
casterName	The name of this event's initiator, if available.
target	The unit ID for the target.
targetName	The name of the target, if available.