API Docs (live)

Back to index...

Name	Type	Deprecated	Description
Command.Unit.Menu	function		Creates a standard context menu targeted at the unit of choice.
Event.Unit.Add			Signals the addition of units to unit specifiers. Always preceded by Event.Unit.Change.Remove. Tr...
Event.Unit.Availability.Full			Signals units entering Full availability.
Event.Unit.Availability.None			Signals units leaving availability entirely.
Event.Unit.Availability.Partial			Signals units entering Partial availability, possibly on the way to Full or None availability.
Event.Unit.Castbar			Signals a unit's castbar changing.
Event.Unit.Detail.Absorb			Signals a unit's damage absorption changing.
Event.Unit.Detail.Afk			Signals a unit's AFK flag changing. Will trigger only for partymembers.
Event.Unit.Detail.Aggro			Signals a unit's aggro flag changing. Will trigger only for groupmembers.
Event.Unit.Detail.Blocked			Signals a unit's LOS-blocked flag changing. Will trigger only for groupmembers.
Event.Unit.Detail.Charge			Signals a unit's charge changing. Will trigger only for the player's unit ID.
Event.Unit.Detail.ChargeMax			Signals a unit's charge maximum changing. Will trigger only for the player's unit ID.
Event.Unit.Detail.Combat			Signals a unit's combat status changing.
Event.Unit.Detail.Combo			Signals a unit's combo points changing. Will trigger only for the player's unit ID.
Event.Unit.Detail.Coord			Signals a change in the unit's location.
Event.Unit.Detail.Energy			Signals a unit's energy changing.
Event.Unit.Detail.EnergyMax			Signals a unit's energy maximum changing.
Event.Unit.Detail.Guild			Signals a unit's guild changing.
Event.Unit.Detail.Health			Signals a unit's health changing.
Event.Unit.Detail.HealthCap			Signals a unit's health cap changing.
Event.Unit.Detail.HealthMax			Signals a unit's health maximum changing.
Event.Unit.Detail.Level			Signals a unit's level changing.
Event.Unit.Detail.LocationName			Signals a unit's location name changing.
Event.Unit.Detail.Mana			Signals a unit's mana changing.
Event.Unit.Detail.ManaMax			Signals a unit's mana maximum changing.
Event.Unit.Detail.Mark			Signals a unit's mark changing.
Event.Unit.Detail.Mentoring			Signals a unit's mentoring status changing.
Event.Unit.Detail.Name			Signals a unit's name changing.
Event.Unit.Detail.Offline			Signals a unit's offline flag changing. Will trigger only for partymembers.
Event.Unit.Detail.Planar			Signals a unit's planar charges changing. Will trigger only for the player or groupmembers.
Event.Unit.Detail.PlanarMax			Signals a unit's maximum planar charges changing. Will trigger only for the player or groupmembers.
Event.Unit.Detail.Power			Signals a unit's power changing.
Event.Unit.Detail.PublicSize			Signals a unit's public group size or status changing.
Event.Unit.Detail.Pvp			Signals a unit's PvP flag changing.
Event.Unit.Detail.Radius			Signals a unit's radius changing.
Event.Unit.Detail.Ready			Signals a unit's readycheck status changing.
Event.Unit.Detail.Role			Signals a unit's role changing. Will trigger only for the player or partymembers.
Event.Unit.Detail.Tagged			Signals a unit's tagged status changing.
Event.Unit.Detail.TitlePrefixId			Signals a unit's title prefix ID changing.
Event.Unit.Detail.TitlePrefixName		deprecated	Signals a unit's localized title prefix changing.
Event.Unit.Detail.TitleSuffixId			Signals a unit's title suffix ID changing.
Event.Unit.Detail.TitleSuffixName		deprecated	Signals a unit's localized title suffix changing.
Event.Unit.Detail.Vitality			Signals a unit's vitality changing. Will trigger only for the player or groupmembers.
Event.Unit.Detail.Warfront			Signals a unit's warfront flag changing. Will trigger only for partymembers.
Event.Unit.Detail.Zone			Signals a change in the unit's zone.
Event.Unit.Remove			Signals the removal of units from unit specifiers. Always followed by Event.Unit.Change.Add. Trig...
Inspect.Unit.Castbar	function		Provides detailed information about a unit's castbar.
Inspect.Unit.Detail	function		Provides detailed information about a unit.
Inspect.Unit.List	function		Lists all the units that the client can see.
Inspect.Unit.Lookup	function		Converts unit IDs to unit specifiers and vice-versa.
Utility.Unit.Availability	function		Returns information on which detail members are available in which availability mode.

Command.Unit.Menu

Creates a standard context menu targeted at the unit of choice.

Usage:

Parameter	Type	Datatype	Description
Command.Unit.Menu(target)
target	parameter	unit	The unit to generate a context menu for.

Signals the addition of units to unit specifiers. Always preceded by Event.Unit.Change.Remove. Triggers for unit IDs that have been removed from the specifier tree, but may not trigger for any children of those units. You may want to use LibUnitChange instead of this event.

Usage:

Parameter	Type	Datatype	Description
Event.Unit.Add(units)
units	parameter	variant	Table of the units changed. Key is the unit ID, value is the unit specifier, or "false" if the unit now has no specifier.

Event.Unit.Availability.Full

Signals units entering Full availability.

Usage:

Parameter	Type	Datatype	Description
Event.Unit.Availability.Full(units)
units	parameter	variant	Table of the units changed. Key is the unit ID, value is the unit specifier, or "false" if the unit now has no specifier.

Event.Unit.Availability.None

Signals units leaving availability entirely.

Usage:

Parameter	Type	Datatype	Description
Event.Unit.Availability.None(units)
units	parameter	variant	Table of the units changed. Key is the unit ID, value is the unit specifier, or "false" if the unit now has no specifier.

Event.Unit.Availability.Partial

Signals units entering Partial availability, possibly on the way to Full or None availability.

Usage:

Parameter	Type	Datatype	Description
Event.Unit.Availability.Partial(units)
units	parameter	variant	Table of the units changed. Key is the unit ID, value is the unit specifier, or "false" if the unit now has no specifier.

Event.Unit.Castbar

Signals a unit's castbar changing.

Usage:

Parameter	Type	Datatype	Description
Event.Unit.Castbar(units)
units	parameter	variant	Table of the units changed. Key is the unit ID, value is a castbar visibility flag.

Event.Unit.Detail.Absorb

Signals a unit's damage absorption changing.

Usage:

Parameter	Type	Datatype	Description
Event.Unit.Detail.Absorb(units)
units	parameter	variant	Table of the units changed. Key is the unit ID, value is the new value.

Event.Unit.Detail.Afk

Signals a unit's AFK flag changing. Will trigger only for partymembers.

Usage:

Parameter	Type	Datatype	Description
Event.Unit.Detail.Afk(units)
units	parameter	variant	Table of the units changed. Key is the unit ID, value is the new value.

Event.Unit.Detail.Aggro

Signals a unit's aggro flag changing. Will trigger only for groupmembers.

Usage:

Parameter	Type	Datatype	Description
Event.Unit.Detail.Aggro(units)
units	parameter	variant	Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.

Event.Unit.Detail.Blocked

Signals a unit's LOS-blocked flag changing. Will trigger only for groupmembers.

Usage:

Parameter	Type	Datatype	Description
Event.Unit.Detail.Blocked(units)
units	parameter	variant	Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.

Event.Unit.Detail.Charge

Signals a unit's charge changing. Will trigger only for the player's unit ID.

Usage:

Parameter	Type	Datatype	Description
Event.Unit.Detail.Charge(units)
units	parameter	variant	Table of the units changed. Key is the unit ID, value is the new value.

Event.Unit.Detail.ChargeMax

Signals a unit's charge maximum changing. Will trigger only for the player's unit ID.

Usage:

Parameter	Type	Datatype	Description
Event.Unit.Detail.ChargeMax(units)
units	parameter	variant	Table of the units changed. Key is the unit ID, value is the new value.

Event.Unit.Detail.Combat

Signals a unit's combat status changing.

Usage:

Parameter	Type	Datatype	Description
Event.Unit.Detail.Combat(units)
units	parameter	variant	Table of the units changed. Key is the unit ID, value is the new value.

Event.Unit.Detail.Combo

Signals a unit's combo points changing. Will trigger only for the player's unit ID.

Usage:

Parameter	Type	Datatype	Description
Event.Unit.Detail.Combo(units)
units	parameter	variant	Table of the units changed. Key is the unit ID, value is the new value.

Event.Unit.Detail.Coord

Signals a change in the unit's location.

Usage:

Parameter	Type	Datatype	Description
Event.Unit.Detail.Coord(x, y, z)
x	parameter	variant	The new X coordinate of the changed elements. Takes the form of a table. The key is the element ID.
y	parameter	<nope>	The new Y coordinate of the changed elements. Takes the form of a table. The key is the element ID.
z	parameter	<nope>	The new Z coordinate of the changed elements. Takes the form of a table. The key is the element ID.

Event.Unit.Detail.Energy

Signals a unit's energy changing.

Usage:

Parameter	Type	Datatype	Description
Event.Unit.Detail.Energy(units)
units	parameter	variant	Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.

Event.Unit.Detail.EnergyMax

Signals a unit's energy maximum changing.

Usage:

Parameter	Type	Datatype	Description
Event.Unit.Detail.EnergyMax(units)
units	parameter	variant	Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.

Event.Unit.Detail.Guild

Signals a unit's guild changing.

Usage:

Parameter	Type	Datatype	Description
Event.Unit.Detail.Guild(units)
units	parameter	variant	Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.

Event.Unit.Detail.Health

Signals a unit's health changing.

Usage:

Parameter	Type	Datatype	Description
Event.Unit.Detail.Health(units)
units	parameter	variant	Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.

Event.Unit.Detail.HealthCap

Signals a unit's health cap changing.

Usage:

Parameter	Type	Datatype	Description
Event.Unit.Detail.HealthCap(units)
units	parameter	variant	Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.

Event.Unit.Detail.HealthMax

Signals a unit's health maximum changing.

Usage:

Parameter	Type	Datatype	Description
Event.Unit.Detail.HealthMax(units)
units	parameter	variant	Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.

Event.Unit.Detail.Level

Signals a unit's level changing.

Usage:

Parameter	Type	Datatype	Description
Event.Unit.Detail.Level(units)
units	parameter	variant	Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.

Event.Unit.Detail.LocationName

Signals a unit's location name changing.

Usage:

Parameter	Type	Datatype	Description
Event.Unit.Detail.LocationName(units)
units	parameter	variant	Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.

Event.Unit.Detail.Mana

Signals a unit's mana changing.

Usage:

Parameter	Type	Datatype	Description
Event.Unit.Detail.Mana(units)
units	parameter	variant	Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.

Event.Unit.Detail.ManaMax

Signals a unit's mana maximum changing.

Usage:

Parameter	Type	Datatype	Description
Event.Unit.Detail.ManaMax(units)
units	parameter	variant	Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.

Event.Unit.Detail.Mark

Signals a unit's mark changing.

Usage:

Parameter	Type	Datatype	Description
Event.Unit.Detail.Mark(units)
units	parameter	variant	Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.

Event.Unit.Detail.Mentoring

Signals a unit's mentoring status changing.

Usage:

Parameter	Type	Datatype	Description
Event.Unit.Detail.Mentoring(units)
units	parameter	variant	Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.

Event.Unit.Detail.Name

Signals a unit's name changing.

Usage:

Parameter	Type	Datatype	Description
Event.Unit.Detail.Name(units)
units	parameter	variant	Table of the units changed. Key is the unit ID, value is the new value.

Event.Unit.Detail.Offline

Signals a unit's offline flag changing. Will trigger only for partymembers.

Usage:

Parameter	Type	Datatype	Description
Event.Unit.Detail.Offline(units)
units	parameter	variant	Table of the units changed. Key is the unit ID, value is the new value.

Event.Unit.Detail.Planar

Signals a unit's planar charges changing. Will trigger only for the player or groupmembers.

Usage:

Parameter	Type	Datatype	Description
Event.Unit.Detail.Planar(units)
units	parameter	variant	Table of the units changed. Key is the unit ID, value is the new value.

Event.Unit.Detail.PlanarMax

Signals a unit's maximum planar charges changing. Will trigger only for the player or groupmembers.

Usage:

Parameter	Type	Datatype	Description
Event.Unit.Detail.PlanarMax(units)
units	parameter	variant	Table of the units changed. Key is the unit ID, value is the new value.

Event.Unit.Detail.Power

Signals a unit's power changing.

Usage:

Parameter	Type	Datatype	Description
Event.Unit.Detail.Power(units)
units	parameter	variant	Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.

Event.Unit.Detail.PublicSize

Signals a unit's public group size or status changing.

Usage:

Parameter	Type	Datatype	Description
Event.Unit.Detail.PublicSize(units)
units	parameter	variant	Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.

Event.Unit.Detail.Pvp

Signals a unit's PvP flag changing.

Usage:

Parameter	Type	Datatype	Description
Event.Unit.Detail.Pvp(units)
units	parameter	variant	Table of the units changed. Key is the unit ID, value is the new value.

Event.Unit.Detail.Radius

Signals a unit's radius changing.

Usage:

Parameter	Type	Datatype	Description
Event.Unit.Detail.Radius(units)
units	parameter	variant	Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.

Event.Unit.Detail.Ready

Signals a unit's readycheck status changing.

Usage:

Parameter	Type	Datatype	Description
Event.Unit.Detail.Ready(units)
units	parameter	variant	Table of the units changed. Key is the unit ID, value is the new value, or the string "nil" in place of nil.

Event.Unit.Detail.Role

Signals a unit's role changing. Will trigger only for the player or partymembers.

Usage:

Parameter	Type	Datatype	Description
Event.Unit.Detail.Role(units)
units	parameter	variant	Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.

Event.Unit.Detail.Tagged

Signals a unit's tagged status changing.

Usage:

Parameter	Type	Datatype	Description
Event.Unit.Detail.Tagged(units)
units	parameter	variant	Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.

Event.Unit.Detail.TitlePrefixId

Signals a unit's title prefix ID changing.

Usage:

Parameter	Type	Datatype	Description
Event.Unit.Detail.TitlePrefixId(units)
units	parameter	variant	Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.

Event.Unit.Detail.TitlePrefixName

Signals a unit's localized title prefix changing.

Usage:

Parameter	Type	Datatype	Description
Event.Unit.Detail.TitlePrefixName(units)
units	parameter	variant	Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.

deprecated: standard

Event.Unit.Detail.TitleSuffixId

Signals a unit's title suffix ID changing.

Usage:

Parameter	Type	Datatype	Description
Event.Unit.Detail.TitleSuffixId(units)
units	parameter	variant	Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.

Event.Unit.Detail.TitleSuffixName

Signals a unit's localized title suffix changing.

Usage:

Parameter	Type	Datatype	Description
Event.Unit.Detail.TitleSuffixName(units)
units	parameter	variant	Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.

deprecated: standard

Event.Unit.Detail.Vitality

Signals a unit's vitality changing. Will trigger only for the player or groupmembers.

Usage:

Parameter	Type	Datatype	Description
Event.Unit.Detail.Vitality(units)
units	parameter	variant	Table of the units changed. Key is the unit ID, value is the new value.

Event.Unit.Detail.Warfront

Signals a unit's warfront flag changing. Will trigger only for partymembers.

Usage:

Parameter	Type	Datatype	Description
Event.Unit.Detail.Warfront(units)
units	parameter	variant	Table of the units changed. Key is the unit ID, value is the new value.

Event.Unit.Detail.Zone

Signals a change in the unit's zone.

Usage:

Parameter	Type	Datatype	Description
Event.Unit.Detail.Zone(units)
units	parameter	variant	Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.

Event.Unit.Remove

Signals the removal of units from unit specifiers. Always followed by Event.Unit.Change.Add. Triggers for unit IDs that have been removed from the specifier tree, but may not trigger for any children of those units. You may want to use LibUnitChange instead of this event.

Usage:

Parameter	Type	Datatype	Description
Event.Unit.Remove(units)
units	parameter	variant	Table of the units changed. Key is the unit ID, value is the unit specifier, or "false" if the unit now has no specifier.

Inspect.Unit.Castbar

Provides detailed information about a unit's castbar.

Usage:

Parameter	Type	Datatype	Description
detail = Inspect.Unit.Castbar(unit)
details = Inspect.Unit.Castbar(units)
unit	parameter	unit	A unit, in either unit ID or unit specifier format.
units	parameter	table	A table containing units to inspect.
detail	result	table	Detail table for a single castbar.
details	result	table	Detail tables for all requested castbars. The key is the unit ID or unit specifier, the value is the castbar's detail table.

members

ability	ID of the ability being cast, if available.
abilityName	Name of the ability being cast.
begin	The time the cast started, in the context of Inspect.Time.Frame.
channeled	True if this ability is channeled.
duration	Duration of the cast in seconds.
expired	Number of the seconds the cast is past its completion time. Generally indicates lag.
remaining	Time remaining on the cast, in seconds.
uninterruptible	Signals that the cast is not interruptible.

Inspect.Unit.Detail

Provides detailed information about a unit.

Usage:

Parameter	Type	Datatype	Description
detail = Inspect.Unit.Detail(unit)
details = Inspect.Unit.Detail(units)
unit	parameter	unit	A unit, in either unit ID or unit specifier format.
units	parameter	table	A table containing units to inspect.
detail	result	table	Detail table for a single unit.
details	result	table	Detail tables for all requested units. The key is the unit ID or unit specifier, the value is the unit's detail table.

members

absorb	The unit's damage absorption.
afk	Signals that the unit is AFK. Provided only for the player and the player's groupmembers.
aggro	Signals that this unit is being attacked. Provided only for groupmembers.
alliance	The unit's alliance. "defiant", "guardian", or nil.
availability	The unit's current availability. See Utility.Unit.Availability() for details.
blocked	Signals that this unit is not in line of sight. Provided only for groupmembers.
calling	The unit's calling. May be "mage", "rogue", "cleric", "warrior", or "primalist".
charge	The unit's charge. Provided only for the player.
chargeMax	The unit's maximum charge. Provided only for the player.
combat	The unit's combat status.
combo	The unit's combo points. Provided only for the player.
coordX	The unit's current X coordinate.
coordY	The unit's current Y coordinate.
coordZ	The unit's current Z coordinate.
energy	The unit's energy.
energyMax	The unit's maximum energy.
factionId	The unit's faction ID.
focus	The unit's focus.
guaranteedLoot	Signals that this unit guarantees loot on death. Shown in the user interface as a diamond above the portrait.
guild	The unit's guild.
health	The unit's health.
healthCap	The unit's capped maximum health.
healthMax	The unit's maximum health.
id	The ID of the requested element.
level	The unit's level. May be "??" if the unit is hostile and very high-level.
locationName	The name of the unit's location. Provided only for friendly players.
loot	The Unit ID that has looting rights to this corpse.
mana	The unit's mana.
manaMax	The unit's maximum mana.
mark	The mark on this unit.
mentoring	The unit's mentoring status.
name	The unit's name.
nameSecondary	The unit's secondary name.
offline	Signals that the unit is offline. Provided only for the player's groupmembers.
planar	The unit's available planar charges. Provided only for the player or groupmembers.
planarMax	The unit's maximum planar charges. Provided only for the player or groupmembers.
player	Signals that the unit is a player, not an NPC.
power	The unit's power.
publicSize	The unit's current public group size. nil if the group is not public. Provided only for friendly players.
pvp	The unit's PvP flag.
race	The unit's race. Provided only for players.
raceName	The unit's race, localized. Provided only for players.
radius	The unit's radius.
ready	The unit's readycheck status.
relation	The unit's relation to you. May be "hostile" or "friendly". Neutral targets will not have this member.
role	The unit's role. May be "tank", "heal", "dps", "support", or nil. Provided only for the player and the player's groupmembers.
spirit	The unit's spirit.
tag	The unit's tags, space-separated.
tagName	The unit's tags, localized.
tagged	The unit's tagged status. true if the unit has been tagged by you, "other" if the unit has been tagged by someone else.
tier	The unit's difficulty tier. nil, "group", or "raid".
titlePrefixId	The unit's title prefix ID.
titlePrefixName	The unit's localized title prefix.
titleSuffixId	The unit's title suffix ID.
titleSuffixName	The unit's localized title suffix.
type	The unit type ID.
vitality	The unit's vitality. Provided only for the player or groupmembers.
warfront	Signals that the unit has temporarily left the group to join a warfront. Provided only for groupmembers.
zone	The ID of the unit's current zone.

Inspect.Unit.List

Lists all the units that the client can see.

Usage:

Parameter	Type	Datatype	Description
list = Inspect.Unit.List()
list	result	table	Map of unit ID to unit specifier. Units with multiple valid specifiers will have one chosen at random.

Inspect.Unit.Lookup

Converts unit IDs to unit specifiers and vice-versa.

Usage:

Parameter	Type	Datatype	Description
unit = Inspect.Unit.Lookup(unit)
units = Inspect.Unit.Lookup(units)
unit	parameter	unit	A unit ID or unit specifier, whichever is the opposite of the parameter given. May be nil.
units	parameter	table	A table of unit IDs and unit specifiers. The key is the input, the value is the result. Invalid inputs will not result in output entries.
unit	result	unit	A unit ID or unit specifier, whichever is the opposite of the parameter given. May be nil.
units	result	table	A table of unit IDs and unit specifiers. The key is the input, the value is the result. Invalid inputs will not result in output entries.

Utility.Unit.Availability

Returns information on which detail members are available in which availability mode.

Usage:

Parameter	Type	Datatype	Description
lookup = Utility.Unit.Availability()
lookup	result	table	Lookup table for which members are available in which availability mode. To check if "full" availability contains "level", check "lookup.full.level".