Creates a standard context menu targeted at the unit of choice.
Usage:
Command.Unit.Menu(target) |
Parameter | Type | Datatype | Description |
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:
Event.Unit.Add(units) |
Parameter | Type | Datatype | Description |
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. |
Signals units entering Full availability.
Usage:
Event.Unit.Availability.Full(units) |
Parameter | Type | Datatype | Description |
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. |
Signals units leaving availability entirely.
Usage:
Event.Unit.Availability.None(units) |
Parameter | Type | Datatype | Description |
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. |
Signals units entering Partial availability, possibly on the way to Full or None availability.
Usage:
Event.Unit.Availability.Partial(units) |
Parameter | Type | Datatype | Description |
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. |
Signals the availability of Inspect.Unit.Detail.
Usage:
Event.Unit.Available(units) |
Parameter | Type | Datatype | Description |
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. |
- deprecated
- hard
- disabled
- true
Signals a unit's castbar changing.
Usage:
Event.Unit.Castbar(units) |
Parameter | Type | Datatype | Description |
units | parameter | variant | Table of the units changed. Key is the unit ID, value is a castbar visibility flag. |
Signals a unit's damage absorption changing.
Usage:
Event.Unit.Detail.Absorb(units) |
Parameter | Type | Datatype | Description |
units | parameter | variant | Table of the units changed. Key is the unit ID, value is the new value. |
Signals a unit's AFK flag changing. Will trigger only for partymembers.
Usage:
Event.Unit.Detail.Afk(units) |
Parameter | Type | Datatype | Description |
units | parameter | variant | Table of the units changed. Key is the unit ID, value is the new value. |
Signals a unit's aggro flag changing. Will trigger only for groupmembers.
Usage:
Event.Unit.Detail.Aggro(units) |
Parameter | Type | Datatype | Description |
units | parameter | variant | Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil. |
Signals a unit's LOS-blocked flag changing. Will trigger only for groupmembers.
Usage:
Event.Unit.Detail.Blocked(units) |
Parameter | Type | Datatype | Description |
units | parameter | variant | Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil. |
Signals a unit's charge changing. Will trigger only for the player's unit ID.
Usage:
Event.Unit.Detail.Charge(units) |
Parameter | Type | Datatype | Description |
units | parameter | variant | Table of the units changed. Key is the unit ID, value is the new value. |
Signals a unit's charge maximum changing. Will trigger only for the player's unit ID.
Usage:
Event.Unit.Detail.ChargeMax(units) |
Parameter | Type | Datatype | Description |
units | parameter | variant | Table of the units changed. Key is the unit ID, value is the new value. |
Signals a unit's combat status changing.
Usage:
Event.Unit.Detail.Combat(units) |
Parameter | Type | Datatype | Description |
units | parameter | variant | Table of the units changed. Key is the unit ID, value is the new value. |
Signals a unit's combo points changing. Will trigger only for the player's unit ID.
Usage:
Event.Unit.Detail.Combo(units) |
Parameter | Type | Datatype | Description |
units | parameter | variant | Table of the units changed. Key is the unit ID, value is the new value. |
Signals a unit's combo point target changing. Will trigger only for the player's unit ID.
Usage:
Event.Unit.Detail.ComboUnit(units) |
Parameter | Type | Datatype | Description |
units | parameter | variant | Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil. |
Signals a change in the unit's location.
Usage:
Event.Unit.Detail.Coord(x, y, z) |
Parameter | Type | Datatype | Description |
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. |
Signals a unit's energy changing.
Usage:
Event.Unit.Detail.Energy(units) |
Parameter | Type | Datatype | Description |
units | parameter | variant | Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil. |
Signals a unit's energy maximum changing.
Usage:
Event.Unit.Detail.EnergyMax(units) |
Parameter | Type | Datatype | Description |
units | parameter | variant | Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil. |
Signals a unit's guild changing.
Usage:
Event.Unit.Detail.Guild(units) |
Parameter | Type | Datatype | Description |
units | parameter | variant | Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil. |
Signals a unit's health changing.
Usage:
Event.Unit.Detail.Health(units) |
Parameter | Type | Datatype | Description |
units | parameter | variant | Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil. |
Signals a unit's health cap changing.
Usage:
Event.Unit.Detail.HealthCap(units) |
Parameter | Type | Datatype | Description |
units | parameter | variant | Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil. |
Signals a unit's health maximum changing.
Usage:
Event.Unit.Detail.HealthMax(units) |
Parameter | Type | Datatype | Description |
units | parameter | variant | Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil. |
Signals a unit's level changing.
Usage:
Event.Unit.Detail.Level(units) |
Parameter | Type | Datatype | Description |
units | parameter | variant | Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil. |
Signals a unit's location name changing.
Usage:
Event.Unit.Detail.LocationName(units) |
Parameter | Type | Datatype | Description |
units | parameter | variant | Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil. |
Signals a unit's mana changing.
Usage:
Event.Unit.Detail.Mana(units) |
Parameter | Type | Datatype | Description |
units | parameter | variant | Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil. |
Signals a unit's mana maximum changing.
Usage:
Event.Unit.Detail.ManaMax(units) |
Parameter | Type | Datatype | Description |
units | parameter | variant | Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil. |
Signals a unit's mark changing.
Usage:
Event.Unit.Detail.Mark(units) |
Parameter | Type | Datatype | Description |
units | parameter | variant | Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil. |
Signals a unit's mentoring status changing.
Usage:
Event.Unit.Detail.Mentoring(units) |
Parameter | Type | Datatype | Description |
units | parameter | variant | Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil. |
Signals a unit's name changing.
Usage:
Event.Unit.Detail.Name(units) |
Parameter | Type | Datatype | Description |
units | parameter | variant | Table of the units changed. Key is the unit ID, value is the new value. |
Signals a unit's offline flag changing. Will trigger only for partymembers.
Usage:
Event.Unit.Detail.Offline(units) |
Parameter | Type | Datatype | Description |
units | parameter | variant | Table of the units changed. Key is the unit ID, value is the new value. |
Signals a unit's planar charges changing. Will trigger only for the player or groupmembers.
Usage:
Event.Unit.Detail.Planar(units) |
Parameter | Type | Datatype | Description |
units | parameter | variant | Table of the units changed. Key is the unit ID, value is the new value. |
Signals a unit's maximum planar charges changing. Will trigger only for the player or groupmembers.
Usage:
Event.Unit.Detail.PlanarMax(units) |
Parameter | Type | Datatype | Description |
units | parameter | variant | Table of the units changed. Key is the unit ID, value is the new value. |
Signals a unit's power changing.
Usage:
Event.Unit.Detail.Power(units) |
Parameter | Type | Datatype | Description |
units | parameter | variant | Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil. |
Signals a unit's public group size or status changing.
Usage:
Event.Unit.Detail.PublicSize(units) |
Parameter | Type | Datatype | Description |
units | parameter | variant | Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil. |
Signals a unit's PvP flag changing.
Usage:
Event.Unit.Detail.Pvp(units) |
Parameter | Type | Datatype | Description |
units | parameter | variant | Table of the units changed. Key is the unit ID, value is the new value. |
Signals a unit's radius changing.
Usage:
Event.Unit.Detail.Radius(units) |
Parameter | Type | Datatype | Description |
units | parameter | variant | Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil. |
Signals a unit's readycheck status changing.
Usage:
Event.Unit.Detail.Ready(units) |
Parameter | Type | Datatype | Description |
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. |
Signals a unit's role changing. Will trigger only for the player or partymembers.
Usage:
Event.Unit.Detail.Role(units) |
Parameter | Type | Datatype | Description |
units | parameter | variant | Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil. |
Signals a unit's tagged status changing.
Usage:
Event.Unit.Detail.Tagged(units) |
Parameter | Type | Datatype | Description |
units | parameter | variant | Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil. |
Signals a unit's localized title prefix changing. This event is deprecated and should not be used.
Usage:
Event.Unit.Detail.TitlePrefix(units) |
Parameter | Type | Datatype | Description |
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
- hard
- disabled
- true
Signals a unit's title prefix ID changing.
Usage:
Event.Unit.Detail.TitlePrefixId(units) |
Parameter | Type | Datatype | Description |
units | parameter | variant | Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil. |
Signals a unit's localized title prefix changing.
Usage:
Event.Unit.Detail.TitlePrefixName(units) |
Parameter | Type | Datatype | Description |
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
Signals a unit's localized title suffix changing. This event is deprecated and should not be used.
Usage:
Event.Unit.Detail.TitleSuffix(units) |
Parameter | Type | Datatype | Description |
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
- hard
- disabled
- true
Signals a unit's title suffix ID changing.
Usage:
Event.Unit.Detail.TitleSuffixId(units) |
Parameter | Type | Datatype | Description |
units | parameter | variant | Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil. |
Signals a unit's localized title suffix changing.
Usage:
Event.Unit.Detail.TitleSuffixName(units) |
Parameter | Type | Datatype | Description |
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
Signals a unit's vitality changing. Will trigger only for the player or groupmembers.
Usage:
Event.Unit.Detail.Vitality(units) |
Parameter | Type | Datatype | Description |
units | parameter | variant | Table of the units changed. Key is the unit ID, value is the new value. |
Signals a unit's warfront flag changing. Will trigger only for partymembers.
Usage:
Event.Unit.Detail.Warfront(units) |
Parameter | Type | Datatype | Description |
units | parameter | variant | Table of the units changed. Key is the unit ID, value is the new value. |
Signals a change in the unit's zone.
Usage:
Event.Unit.Detail.Zone(units) |
Parameter | Type | Datatype | Description |
units | parameter | variant | Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil. |
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:
Event.Unit.Remove(units) |
Parameter | Type | Datatype | Description |
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. |
Signals the unavailability of Inspect.Unit.Detail.
Usage:
Event.Unit.Unavailable(units) |
Parameter | Type | Datatype | Description |
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. |
- deprecated
- hard
- disabled
- true
Provides detailed information about a unit's castbar.
Usage:
detail = Inspect.Unit.Castbar(unit) |
details = Inspect.Unit.Castbar(units) |
Parameter | Type | Datatype | Description |
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.
|
Provides detailed information about a unit.
Usage:
detail = Inspect.Unit.Detail(unit) |
details = Inspect.Unit.Detail(units) |
Parameter | Type | Datatype | Description |
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", or "warrior".
|
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.
|
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.
|
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.
|
Lists all the units that the client can see.
Usage:
list = Inspect.Unit.List() |
Parameter | Type | Datatype | Description |
list | result | table | Map of unit ID to unit specifier. Units with multiple valid specifiers will have one chosen at random. |
Converts unit IDs to unit specifiers and vice-versa.
Usage:
unit = Inspect.Unit.Lookup(unit) |
units = Inspect.Unit.Lookup(units) |
Parameter | Type | Datatype | Description |
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. |
Returns information on which detail members are available in which availability mode.
Usage:
lookup = Utility.Unit.Availability() |
Parameter | Type | Datatype | Description |
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". |