API Docs (pts)

Back to index...

Name	Type	Description
Command.Buff.Cancel	function	Cancels a buff on the player. Not all buffs are cancelable.
Command.Buff.Describe	function	Requests a detailed description for a given buff.
Event.Buff.Add		Signals new buffs on a unit.
Event.Buff.Change		Signals a change in existing buffs on a unit.
Event.Buff.Description		Signals a change in an existing buff's detailed description. Value of the key is "true" if detail...
Event.Buff.Remove		Signals removal of buffs from a unit.
Inspect.Buff.Detail	function	Provides detailed information about the buffs on a unit.
Inspect.Buff.List	function	List buffs on a unit.

Command.Buff.Cancel

Cancels a buff on the player. Not all buffs are cancelable.

Usage:

Throttled.

Parameter	Type	Datatype	Description
Command.Buff.Cancel(buff)
buff	parameter	buff	The ID of the buff to cancel.

Command.Buff.Describe

Requests a detailed description for a given buff.

Usage:

Throttled.

Parameter	Type	Datatype	Description
Command.Buff.Describe(unit, buff)
buff	parameter	buff	The ID of the buff to describe.
unit	parameter	unit	The ID of the unit that the buff is on.

Event.Buff.Add

Signals new buffs on a unit.

Usage:

Parameter	Type	Datatype	Description
Event.Buff.Add(unit, buffs)
buffs	parameter	<nope>	A table containing the buffs involved. The key is the buff ID, the value is the buff type ID or 'true' if the buff has no type.
unit	parameter	variant	The Unit ID of the unit involved.

Event.Buff.Change

Signals a change in existing buffs on a unit.

Usage:

Parameter	Type	Datatype	Description
Event.Buff.Change(unit, buffs)
buffs	parameter	<nope>	A table containing the buffs involved.
unit	parameter	variant	The Unit ID of the unit involved.

Event.Buff.Description

Signals a change in an existing buff's detailed description. Value of the key is "true" if detail is now available, "false" if it is no longer available.

Usage:

Parameter	Type	Datatype	Description
Event.Buff.Description(unit, buffs)
buffs	parameter	<nope>	A table containing the buffs involved.
unit	parameter	variant	The Unit ID of the unit involved.

Event.Buff.Remove

Signals removal of buffs from a unit.

Usage:

Parameter	Type	Datatype	Description
Event.Buff.Remove(unit, buffs)
buffs	parameter	<nope>	A table containing the buffs involved.
unit	parameter	variant	The Unit ID of the unit involved.

Inspect.Buff.Detail

Provides detailed information about the buffs on a unit.

Usage:

Parameter	Type	Datatype	Description
detail = Inspect.Buff.Detail(unit, buff)
details = Inspect.Buff.Detail(unit, buffs)
buff	parameter	buff	An identifier for the buff to retrieve detail for.
buffs	parameter	table	A table containing buff identifiers to retrieve details for.
unit	parameter	unit	The unit to inspect.
detail	result	table	Detail table for a single buff.
details	result	table	Detail tables for all requested buffs. The key is the buff ID, the value is the buff's detail table.

members

ability	The ID of the ability that created this buff. Not guaranteed to exist.
begin	The time the buff started, in the context of Inspect.Time.Frame.
caster	Unit ID of the buff's caster.
curse	Signals that the buff is a curse.
debuff	Signals that the buff is a debuff. If this is missing, then it's an actual buff.
description	Description for the buff. Numbers may not be accurate - see Command.Buff.Describe().
descriptionComplete	Signals that the buff description is complete.
disease	Signals that the buff is a disease.
duration	Duration of the buff in seconds.
expired	Number of seconds the buff is past its expiration time. Generally indicates lag.
icon	Resource filename of the buff's icon.
id	The ID of the requested element.
name	Name of the buff.
noncancelable	Signals that the buff cannot be voluntarily canceled. Does not show up for debuffs.
poison	Signals that the buff is a poison.
remaining	Time remaining on the buff, in seconds.
rune	If this buff is created by a rune, the ID of the rune causing it.
stack	Number of stacks on the buff.
type	The buff type ID.

Inspect.Buff.List

List buffs on a unit.

Usage:

Parameter	Type	Datatype	Description
buffs = Inspect.Buff.List(unit)
unit	parameter	unit	The unit to inspect.
buffs	result	table	A table of the IDs of the buffs on the unit.