API Docs (pts)

Back to index...

Name	Type	Deprecated	Description
Event.Ability.Add		deprecated	Signals the addition of a player ability.
Event.Ability.Cooldown.Begin		deprecated	Signals the start of an ability's cooldown.
Event.Ability.Cooldown.End		deprecated	Signals the end of an ability's cooldown. All the values in the "cooldown" parameter will be 0.
Event.Ability.New.Add			Signals the addition of a player ability.
Event.Ability.New.Cooldown.Begin			Signals the start of an ability's cooldown.
Event.Ability.New.Cooldown.End			Signals the end of an ability's cooldown. All the values in the "cooldown" parameter will be 0.
Event.Ability.New.Range.False			Signals a player ability exiting range from its current target.
Event.Ability.New.Range.True			Signals a player ability entering range from its current target.
Event.Ability.New.Remove			Signals the removal of a player ability.
Event.Ability.New.Target			Signals a player ability changing its current target.
Event.Ability.New.Usable.False			Signals a player ability becoming unusable.
Event.Ability.New.Usable.True			Signals a player ability becoming usable.
Event.Ability.Range.False		deprecated	Signals a player ability exiting range from its current target.
Event.Ability.Range.True		deprecated	Signals a player ability entering range from its current target.
Event.Ability.Remove		deprecated	Signals the removal of a player ability.
Event.Ability.Target		deprecated	Signals a player ability changing its current target.
Event.Ability.Usable.False		deprecated	Signals a player ability becoming unusable.
Event.Ability.Usable.True		deprecated	Signals a player ability becoming usable.
Inspect.Ability.Detail	function	deprecated	Provides detailed information about abilities.
Inspect.Ability.List	function	deprecated	List available abilities.
Inspect.Ability.New.Detail	function		Provides detailed information about abilities.
Inspect.Ability.New.List	function		List available abilities.

Event.Ability.Add

Signals the addition of a player ability.

Usage:

Parameter	Type	Datatype	Description
Event.Ability.Add(abilities)
abilities	parameter	variant	Lists the abilities that were added. Table from ability ID to "true".

deprecated: hard
disabled: true

Event.Ability.Cooldown.Begin

Signals the start of an ability's cooldown.

Usage:

Parameter	Type	Datatype	Description
Event.Ability.Cooldown.Begin(cooldowns)
cooldowns	parameter	variant	The abilities whose cooldown has been changed. The key is the ability ID, the value is the new cooldown. 0 indicates that the cooldown has finished.

deprecated: hard
disabled: true

Event.Ability.Cooldown.End

Signals the end of an ability's cooldown. All the values in the "cooldown" parameter will be 0.

Usage:

Parameter	Type	Datatype	Description
Event.Ability.Cooldown.End(cooldowns)
cooldowns	parameter	variant	The abilities whose cooldown has been changed. The key is the ability ID, the value is the new cooldown. 0 indicates that the cooldown has finished.

deprecated: hard
disabled: true

Event.Ability.New.Add

Signals the addition of a player ability.

Usage:

Parameter	Type	Datatype	Description
Event.Ability.New.Add(abilities)
abilities	parameter	variant	Lists the abilities that were added. Table from ability ID to "true".

Event.Ability.New.Cooldown.Begin

Signals the start of an ability's cooldown.

Usage:

Parameter	Type	Datatype	Description
Event.Ability.New.Cooldown.Begin(cooldowns)
cooldowns	parameter	variant	The abilities whose cooldown has been changed. The key is the ability ID, the value is the new cooldown. 0 indicates that the cooldown has finished.

Event.Ability.New.Cooldown.End

Signals the end of an ability's cooldown. All the values in the "cooldown" parameter will be 0.

Usage:

Parameter	Type	Datatype	Description
Event.Ability.New.Cooldown.End(cooldowns)
cooldowns	parameter	variant	The abilities whose cooldown has been changed. The key is the ability ID, the value is the new cooldown. 0 indicates that the cooldown has finished.

Event.Ability.New.Range.False

Signals a player ability exiting range from its current target.

Usage:

Parameter	Type	Datatype	Description
Event.Ability.New.Range.False(abilities)
abilities	parameter	variant	The abilities that have entered or exited range. The key is the ability ID, the value is whether they are currently in range.

Event.Ability.New.Range.True

Signals a player ability entering range from its current target.

Usage:

Parameter	Type	Datatype	Description
Event.Ability.New.Range.True(abilities)
abilities	parameter	variant	The abilities that have entered or exited range. The key is the ability ID, the value is whether they are currently in range.

Event.Ability.New.Remove

Signals the removal of a player ability.

Usage:

Parameter	Type	Datatype	Description
Event.Ability.New.Remove(abilities)
abilities	parameter	variant	Lists the abilities that were removed. Table from ability ID to "false".

Event.Ability.New.Target

Signals a player ability changing its current target.

Usage:

Parameter	Type	Datatype	Description
Event.Ability.New.Target(abilities)
abilities	parameter	variant	The abilities whose target has changed. The key is the ability ID, the value is the new target.

Event.Ability.New.Usable.False

Signals a player ability becoming unusable.

Usage:

Parameter	Type	Datatype	Description
Event.Ability.New.Usable.False(abilities)
abilities	parameter	variant	The abilities whose usability has changed. The key is the ability ID, the value is the new usability.

Event.Ability.New.Usable.True

Signals a player ability becoming usable.

Usage:

Parameter	Type	Datatype	Description
Event.Ability.New.Usable.True(abilities)
abilities	parameter	variant	The abilities whose usability has changed. The key is the ability ID, the value is the new usability.

Event.Ability.Range.False

Signals a player ability exiting range from its current target.

Usage:

Parameter	Type	Datatype	Description
Event.Ability.Range.False(abilities)
abilities	parameter	variant	The abilities that have entered or exited range. The key is the ability ID, the value is whether they are currently in range.

deprecated: hard
disabled: true

Event.Ability.Range.True

Signals a player ability entering range from its current target.

Usage:

Parameter	Type	Datatype	Description
Event.Ability.Range.True(abilities)
abilities	parameter	variant	The abilities that have entered or exited range. The key is the ability ID, the value is whether they are currently in range.

deprecated: hard
disabled: true

Event.Ability.Remove

Signals the removal of a player ability.

Usage:

Parameter	Type	Datatype	Description
Event.Ability.Remove(abilities)
abilities	parameter	variant	Lists the abilities that were removed. Table from ability ID to "false".

deprecated: hard
disabled: true

Event.Ability.Target

Signals a player ability changing its current target.

Usage:

Parameter	Type	Datatype	Description
Event.Ability.Target(abilities)
abilities	parameter	variant	The abilities whose target has changed. The key is the ability ID, the value is the new target.

deprecated: hard
disabled: true

Event.Ability.Usable.False

Signals a player ability becoming unusable.

Usage:

Parameter	Type	Datatype	Description
Event.Ability.Usable.False(abilities)
abilities	parameter	variant	The abilities whose usability has changed. The key is the ability ID, the value is the new usability.

deprecated: hard
disabled: true

Event.Ability.Usable.True

Signals a player ability becoming usable.

Usage:

Parameter	Type	Datatype	Description
Event.Ability.Usable.True(abilities)
abilities	parameter	variant	The abilities whose usability has changed. The key is the ability ID, the value is the new usability.

deprecated: hard
disabled: true

Inspect.Ability.Detail

Provides detailed information about abilities.

Usage:

Parameter	Type	Datatype	Description
detail = Inspect.Ability.Detail(ability)
details = Inspect.Ability.Detail(abilities)
abilities	parameter	table	A table of identifiers of abilities to retrieve detail for.
ability	parameter	ability	The identifier of the ability to retrieve detail for.
detail	result	table	Detail table for a single ability.
details	result	table	Detail tables for all requested abilities. The key is the ability ID, the value is the ability's detail table.

disabled

true

deprecated

hard

members

autoattack	Autoattack mode of the ability.
castingTime	Casting time of the ability, in seconds.
channeled	Signals that the ability is channeled.
continuous	Signals that the ability is continuous.
cooldown	Cooldown of the ability, in seconds.
costCharge	The amount of charge this ability consumes on use.
costEnergy	The amount of energy this ability consumes on use.
costMana	The amount of mana this ability consumes on use.
costPlanarCharge	The amount of planar charges this ability consumes on use.
costPower	The amount of power this ability consumes on use.
currentCooldownBegin	The time the current cooldown started, in the context of Inspect.Time.Frame.
currentCooldownDuration	Duration of the current cooldown the ability is influenced by, in seconds.
currentCooldownExpired	Number of seconds the current cooldown is past its expiration time. Generally indicates lag.
currentCooldownPaused	Indicates that this ability's cooldown is paused.
currentCooldownRemaining	Time remaining in the ability's current cooldown, in seconds.
description	Description for the ability.
gainCharge	Amount of charge gained by using the ability.
icon	Resource filename of the ability's icon.
id	The ID of the requested element.
idNew	The new ability ID.
name	Name of the ability.
outOfRange	Signals that the ability is out of range.
passive	Signals that the ability is passive.
positioned	Signals that the ability's effect is manually positioned by the user.
racial	Signals that the ability is a racial ability.
rangeMax	The maximum range of the ability.
rangeMin	The minimum range of the ability.
stealthRequired	Signals that the ability requires the user to be in stealth.
target	The Unit ID of the unit that this ability will be used on if triggered at this moment.
unusable	Signals that this ability is unusable.
weapon	The required equipped weapon for this ability. May be "any", "melee", or "ranged".

Inspect.Ability.List

List available abilities.

Usage:

Parameter	Type	Datatype	Description
abilities = Inspect.Ability.List()
abilities	result	table	A table of IDs of the available abilities.

deprecated: hard
disabled: true

Inspect.Ability.New.Detail

Provides detailed information about abilities.

Usage:

Parameter	Type	Datatype	Description
detail = Inspect.Ability.New.Detail(ability)
details = Inspect.Ability.New.Detail(abilities)
abilities	parameter	table	A table of identifiers of abilities to retrieve detail for.
ability	parameter	ability	The identifier of the ability to retrieve detail for.
detail	result	table	Detail table for a single ability.
details	result	table	Detail tables for all requested abilities. The key is the ability ID, the value is the ability's detail table.

members

autoattack	Autoattack mode of the ability.
castingTime	Casting time of the ability, in seconds.
channeled	Signals that the ability is channeled.
continuous	Signals that the ability is continuous.
cooldown	Cooldown of the ability, in seconds.
costCharge	The amount of charge this ability consumes on use.
costEnergy	The amount of energy this ability consumes on use.
costMana	The amount of mana this ability consumes on use.
costPlanarCharge	The amount of planar charges this ability consumes on use.
costPower	The amount of power this ability consumes on use.
currentCooldownBegin	The time the current cooldown started, in the context of Inspect.Time.Frame.
currentCooldownDuration	Duration of the current cooldown the ability is influenced by, in seconds.
currentCooldownExpired	Number of seconds the current cooldown is past its expiration time. Generally indicates lag.
currentCooldownPaused	Indicates that this ability's cooldown is paused.
currentCooldownRemaining	Time remaining in the ability's current cooldown, in seconds.
description	Description for the ability.
gainCharge	Amount of charge gained by using the ability.
icon	Resource filename of the ability's icon.
id	The ID of the requested element.
idNew	The new ability ID.
name	Name of the ability.
outOfRange	Signals that the ability is out of range.
passive	Signals that the ability is passive.
positioned	Signals that the ability's effect is manually positioned by the user.
racial	Signals that the ability is a racial ability.
rangeMax	The maximum range of the ability.
rangeMin	The minimum range of the ability.
stealthRequired	Signals that the ability requires the user to be in stealth.
target	The Unit ID of the unit that this ability will be used on if triggered at this moment.
unusable	Signals that this ability is unusable.
weapon	The required equipped weapon for this ability. May be "any", "melee", or "ranged".

Inspect.Ability.New.List

List available abilities.

Usage:

Parameter	Type	Datatype	Description
abilities = Inspect.Ability.New.List()
abilities	result	table	A table of IDs of the available abilities.