Back to index...

NameTypeDeprecatedSecureDescription
Command.TooltipfunctionChanges the displayed tooltip.
Event.TooltipSignals that the tooltip has changed.
Inspect.TooltipfunctionReturns the current contents of the tooltip.

Command.Tooltip

Changes the displayed tooltip.

Usage:

Command.Tooltip(target)
Command.Tooltip(target, nil)
Command.Tooltip(owner, buff)
ParameterTypeDatatypeDescription
buffparameterbuffThe ID of a buff for the new tooltip.
nilparameternilOptional placeholder nil.
ownerparameterunitThe ID of the owner of the buff.
targetparametervariantThe new tooltip. Currently accepts ability, item, itemtype, or unit IDs. Pass nil to clear the tooltip.

Event.Tooltip

Signals that the tooltip has changed.

Usage:

Event.Tooltip(type, shown, buff)
ParameterTypeDatatypeDescription
buffparameter<nope>The ID of the tooltip's new buff. "shown" will be a unit in this case.
shownparameter<nope>The blob describing the new element shown. Generally, some kind of identifier used in another part of the addon system.
typeparametervariantThe current tooltip type. Valid values include "ability", "buff", "item", "itemtype", and "unit".

Inspect.Tooltip

Returns the current contents of the tooltip.

Usage:

type, shown = Inspect.Tooltip()
type, unit, buff = Inspect.Tooltip()
ParameterTypeDatatypeDescription
buffresultbuffThe ID of the tooltip's buff.
shownresultvariant, nilThe blob describing what is currently shown. Generally, some kind of identifier used in another part of the addon system.
typeresultstring, nilThe current tooltip type. Valid values include "ability", "buff", "item", "itemtype", and "unit".
unitresultunitThe unit that the buff is attached to.

Back to index...