Developer API

Developer Reference

Approved API entries grouped for fast lookup while keeping signatures and examples close at hand.

Entries50

Core HelperClass ColorReturns the active ColorMixin-style color table for a class token, honoring CUSTOM_CLASS_COLORS when present.E · Core · stableCore HelperInverse Class ColorBuilds a readable inverse color from the current class color.E · Core · stableUI UtilityRegister ClicksRegisters secure click behavior with the right AnyDown/AnyUp pattern for the active WoW client.E · Core · stableGame Version WrapperGet Spell InfoWrapper around C_Spell.GetSpellInfo that returns the legacy tuple shape many addon integrations still expect.E · Core · wrapperGame Version WrapperGet Aura DataReads aura data by index and unpacks it into the tuple format used by ElvUI unit frame helpers.E · Core · wrapperGame Version WrapperGet Aura By IDFinds the first aura on a unit that matches a spell id.E · Core · wrapperCore HelperGet Threat Status ColorReturns ElvUI threat color channels for a Blizzard threat status.E · Core · stableCore HelperGet Player RoleReturns ElvUI’s best-known player group role with spec fallback.E · Core · stableCore HelperIs Dispellable By MeChecks whether the active character can dispel a debuff type according to ElvUI’s dispel map.E · Core · stableAddon HookCustom Class Color RegisterRegisters a callback fired when custom class colors are refreshed.E · Core · stableDebug UtilityDumpOpens Blizzard debug tooling for inspecting tables or printing simple values during development.E · Core · internalCompatibilityCompatible TooltipAdds GetTooltipData compatibility to older tooltip objects that do not provide native support.E · Core · wrapperUI UtilityGet Class CoordsReturns class icon atlas coordinates with optional cropping.E · Core · stableUI UtilityCrop RatioComputes texture coordinates that preserve a crop ratio for rectangular textures.E · Core · stableTag APIAdd Tag InfoRegisters metadata for an ElvUI tag so it appears in tag documentation and selectors.E · Tags · stableTag APIAdd TagRegisters a new ElvUI unit frame tag backed by events or an update throttle.E · Tags · stableTag APICall TagInvokes a registered ElvUI tag method directly.E · Tags · stableDataText APIRegister DataTextRegisters a DataText addon entry with event, update, click, and tooltip handlers.DT · DataTexts · stableCore HelperUnit Selection TypeReturns ElvUI’s normalized unit selection type, with optional hostile-threat handling.E · Core · stableCore HelperGet Currency ID From LinkExtracts the currency id from a WoW currency hyperlink.E · Core · stableGame Version WrapperGet Date TimeReturns a realm-aware date table or unix timestamp using ElvUI’s server-time handling.E · Core · stableCore HelperGet Item Quality ColorReturns item-quality RGB channels with ElvUI fallback border color handling.E · Core · stableCore HelperGet Class InfoLooks up cached class metadata by class file token or class id.E · Core · stableLocalization HelperUnlocalized Class NameConverts a localized class name back to the English class token used by ElvUI.E · Core · stableLocalization HelperLocalized Class NameReturns a localized male or female class name for a class token.E · Core · stableCore HelperGet Unit Spec InfoScans a player tooltip and returns ElvUI’s cached specialization metadata for that unit.E · Core · stableGame Version WrapperGet Spell ChargesWrapper around C_Spell.GetSpellCharges that returns the older tuple shape.E · Core · wrapperGame Version WrapperGet Spell CooldownReturns spell cooldown data from either legacy GetSpellCooldown or C_Spell.GetSpellCooldown.E · Core · wrapperGame Version WrapperGet Aura By NameFinds the first aura on a unit that matches an aura name and returns ElvUI’s unpacked aura tuple.E · Core · wrapperAddon HookCustom Class Color UnregisterUnregisters a callback previously registered with E:CustomClassColorRegister.E · Core · stableAddon HookUpdate Custom Class ColorUpdates a custom class color, refreshes colorStr, stores the profile value, and notifies callbacks.E · Core · stableCompatibilityRegister Pet Battle Hide FramesRegisters an addon frame for ElvUI pet-battle parent/strata management.E · Core · stableCompatibilityUnregister Pet Battle Hide FramesRemoves an addon frame from ElvUI pet-battle frame management and restores its parent/strata.E · Core · stableCompatibilityRegister Object For Vehicle LockRegisters an unprotected addon frame to be hidden while the player is in a vehicle UI.E · Core · stableCompatibilityUnregister Object For Vehicle LockRemoves a frame from ElvUI vehicle-lock management and restores its parent.E · Core · stableGame Version WrapperGet Watched Faction InfoReturns watched faction data using the correct Blizzard API for the active client.E · Core · wrapperUI UtilityAlert CombatChecks combat lockdown and shows ElvUI’s standard not-in-combat error when blocked.E · Core · stableGame Version WrapperGet Mouse FocusCompatibility wrapper for GetMouseFocus and GetMouseFoci client differences.E · Core · wrapperGame Version WrapperScan Tooltip Unit InfoReturns tooltip data for a unit using C_TooltipInfo when available or ElvUI’s scan tooltip fallback.E · Core · wrapperGame Version WrapperScan Tooltip Inventory InfoReturns tooltip data for an inventory slot using the active client tooltip API.E · Core · wrapperGame Version WrapperScan Tooltip Hyperlink InfoReturns tooltip data for a hyperlink using C_TooltipInfo when available or scan-tooltip fallback.E · Core · wrapperTag APITag Update RateChanges the shared ElvUI tag event update timer.E · Tags · stableDataText APIRegister DataText PanelRegisters a custom panel that can host one or more ElvUI DataText slots.DT · DataTexts · stableDataText APIForce Update DataTextForces assigned instances of a DataText to refresh settings and event output.DT · DataTexts · stableDataText APIRegister Custom Currency DataTextCreates a DataText entry for a currency id and stores default display settings.DT · DataTexts · stableDataText APIRemove Custom CurrencyRemoves a custom currency DataText registration and reloads DataTexts.DT · DataTexts · stableAddon HookAdd Chat SmileyRegisters a custom chat smiley replacement texture.CH · Chat · stableAddon HookRemove Chat SmileyRemoves a custom chat smiley replacement by token.CH · Chat · stableAddon HookAdd Plugin IconsRegisters a callback that can return a chat icon for a guid or sender.CH · Chat · stableAddon HookAdd Plugin Message FilterRegisters a chat message filter callback in ElvUI’s plugin filter chain.CH · Chat · stable