C_ActionBar
namespaceavailable in: camelotStatus in wowlua
72 functions: 22 implemented, 11 recorded, 39 guessed. 15 events, 13 of them fired by the emulator on its own.
Functions
| function | what it does | status |
|---|---|---|
EnableActionRangeCheck | Used in conjunction with ACTION_RANGE_CHECK_UPDATE to inform the UI when an action goes in or out of range with its current target.(actionID: number, enable: boolean) | guessed |
FindAssistedCombatActionButtons | Returns the list of action bar slots that contain the Assisted Combat action spell.(setToSearch: ActionBarSet): number[]? | guessed |
FindFlyoutActionButtons | Returns the action slots that hold the flyout. · by wowlua(flyoutID: number, setToSearch: ActionBarSet): number[]? | guessed |
FindPetActionButtons | Returns the action slots that hold the pet action. · by wowlua(petActionID: number, setToSearch: ActionBarSet): number[]? | guessed |
FindSpellActionButtons | Returns the list of action bar slots that contain a specified spell.(spellID: SpellIdentifier, setToSearch: ActionBarSet): number[]? | implemented |
ForceUpdateAction | Force updates some internals for an action button slot.(slotID: number, suppressEvents: boolean) | guessed |
GetActionAutocast | Returns whether the action slot's pet action can autocast, and whether its autocast is on. · by wowlua(actionID: number): (boolean, boolean) | guessed |
GetActionBarPage | Returns the action bar page the main bar shows. · by wowlua(): number | implemented |
GetActionChargeDuration | Returns a duration object describing the active recharge time for an action.(actionID: number): LuaDurationObject | guessed |
GetActionCharges | Returns the charges of the action in the slot. · by wowlua(actionID: number): SpellChargeInfo | implemented |
GetActionCooldown | Returns the cooldown of the action in the slot. · by wowlua(actionID: number): SpellCooldownInfo | implemented |
GetActionCooldownDuration | Returns a duration object describing the active cooldown duration for an action.(actionID: number, ignoreGCD: boolean): LuaDurationObject | guessed |
GetActionDisplayCount | Depending on the action type, return a string that is either the use count or number of charges. If value is beyond the display count parameter, returns the replacementString (defaults to '*').(actionID: number, maxDisplayCount: number, replacementString: string): string | implemented |
GetActionLossOfControlCooldownDuration | Returns a duration object describing the active loss of control cooldown duration for an action.(actionID: number): LuaDurationObject | guessed |
GetActionLossOfControlCooldownInfo | Returns the loss-of-control lockout on the action in the slot. · by wowlua(actionID: number): SpellLossOfControlInfo | implemented |
GetActionText | Returns the text the action slot shows, such as a macro's name, or nil when it has none. · by wowlua(actionID: number): string? | implemented |
GetActionTexture | Returns the icon of the action in the slot. · by wowlua(actionID: number): number | implemented |
GetActionUseCount | Returns how many times the action in the slot can be used, such as an item's count. · by wowlua(actionID: number): number | guessed |
GetBonusBarIndex | Returns the action bar page of the bonus bar the player is on, such as a druid's form bar, or 0 without one. · by wowlua(): number | guessed |
GetBonusBarIndexForSlot | Returns the bonus bar page the action slot belongs to, or nil when it belongs to none. · by wowlua(slotID: number): number? | guessed |
GetBonusBarOffset | Returns the offset of the bonus bar the player is on, such as for a stance or form, or 0 without one. · by wowlua(): number | recorded |
GetExtraBarIndex | Returns the action bar page of the extra action bar. · by wowlua(): number | recorded |
GetItemActionOnEquipSpellID | Returns the spell the item in the action slot gives while equipped. · by wowlua(actionID: number): number? | guessed |
GetMultiCastBarIndex | Returns the action bar page of the multi-cast (totem) bar. · by wowlua(): number | recorded |
GetOverrideBarIndex | Returns the action bar page of the override bar. · by wowlua(): number | guessed |
GetOverrideBarSkin | Returns the skin of the override bar, or nil without one. · by wowlua(): number? | guessed |
GetPetActionPetBarIndices | Returns the pet bar slots that hold the pet action. · by wowlua(petActionID: number, setToSearch: ActionBarSet): number[]? | guessed |
GetProfessionQuality | Returns the crafting quality of the item in the action slot. · by wowlua(actionID: number): number? | guessed |
GetProfessionQualityInfo | Returns information about the crafting quality of the item in the action slot. · by wowlua(actionID: number): CraftingQualityInfo? | guessed |
GetSpell | Returns the ID of the spell in the action slot, or 0 when it holds none. · by wowlua(actionID: number): number | implemented |
GetTempShapeshiftBarIndex | Returns the action bar page of the temporary shapeshift bar. · by wowlua(): number | guessed |
GetVehicleBarIndex | Returns the action bar page of the vehicle bar. · by wowlua(): number | guessed |
HasAction | Returns true if an actionbar slot is populated with an action.(actionID: number): boolean | implemented |
HasAssistedCombatActionButtons | Whether an action slot holds the assisted combat action. · by wowlua(setToSearch: ActionBarSet): boolean | recorded |
HasBonusActionBar | Whether the player has a bonus action bar, such as for a stance or form. · by wowlua(): boolean | recorded |
HasExtraActionBar | Whether the extra action bar is shown. · by wowlua(): boolean | recorded |
HasFlyoutActionButtons | Whether an action slot holds the flyout. · by wowlua(flyoutID: number, setToSearch: ActionBarSet): boolean | guessed |
HasOverrideActionBar | Whether the player has an override action bar. · by wowlua(): boolean | recorded |
HasPetActionButtons | True if the pet action is currently on your action bars.(petActionID: number, setToSearch: ActionBarSet): boolean | guessed |
HasPetActionPetBarIndices | Whether a pet bar slot holds the pet action. · by wowlua(petActionID: number, setToSearch: ActionBarSet): boolean | guessed |
HasRangeRequirements | Whether the action in the slot has a range, such as a spell with one. · by wowlua(actionID: number): boolean | guessed |
HasSpellActionButtons | Whether an action slot holds the spell. · by wowlua(spellID: SpellIdentifier, setToSearch: ActionBarSet): boolean | guessed |
HasTempShapeshiftActionBar | Whether the player has a temporary shapeshift action bar. · by wowlua(): boolean | recorded |
HasVehicleActionBar | Whether the player has a vehicle action bar. · by wowlua(): boolean | recorded |
IsActionInRange | Whether the unit is in range of the action in the slot, or nil when the action has no range. · by wowlua(actionID: number, target: string?): boolean? | guessed |
IsAssistedCombatAction | Returns whether the given action button contains the Assisted Combat action spell.(slotID: number): boolean | implemented |
IsAttackAction | Whether the action slot holds Auto Attack. · by wowlua(actionID: number): boolean | implemented |
IsAutoCastPetAction | Whether the pet action in the slot can autocast. · by wowlua(slotID: number): boolean | implemented |
IsAutoRepeatAction | Whether the action in the slot is repeating, such as Auto Shot. · by wowlua(actionID: number): boolean | implemented |
IsConsumableAction | Whether the action slot holds a consumable item. · by wowlua(actionID: number): boolean | guessed |
IsCurrentAction | Whether the action in the slot is in use, such as a spell being cast or awaiting a target. · by wowlua(actionID: number): boolean | implemented |
IsEnabledAutoCastPetAction | Whether autocast is on for the pet action in the slot. · by wowlua(slotID: number): boolean | implemented |
IsEquippedAction | Whether the action slot holds an item the player has equipped. · by wowlua(actionID: number): boolean | implemented |
IsEquippedGearOutfitAction | Whether the action slot holds the equipment set the player has equipped. · by wowlua(slotID: number): boolean | implemented |
IsHarmfulAction | Returns true if the specified action is a harmful one.(actionID: number, useNeutral: boolean): boolean | guessed |
IsHelpfulAction | Returns true if the specified action is a helpful one.(actionID: number, useNeutral: boolean): boolean | guessed |
IsInterruptAction | Returns whether the given action button contains a spell that can interrupt spellcasting.(slotID: number): boolean | guessed |
IsItemAction | Whether the action slot holds an item. · by wowlua(actionID: number): boolean | implemented |
IsMacroActionWithShowTooltip | Returns whether the given action button contains a macro with an explicit #showtooltip directive.(actionID: number): boolean | guessed |
IsOnBarOrSpecialBar | Whether an action slot, the special bars included, holds the spell. · by wowlua(spellID: SpellIdentifier, setToSearch: ActionBarSet): boolean | guessed |
IsPossessBarVisible | Whether the possess bar is shown. · by wowlua(): boolean | recorded |
IsStackableAction | Whether the action slot holds an item that stacks. · by wowlua(actionID: number): boolean | guessed |
IsUsableAction | Returns whether the action in the slot is usable, and whether it lacks only power (such as mana) to be. · by wowlua(actionID: number): (boolean, boolean) | implemented |
PutActionInSlot | Places what the cursor holds in the action slot. · by wowlua(slotID: number) | guessed |
RegisterActionUIButton | Registers the button as showing the action slot, so the game updates it and its cooldown. · by wowlua(checkboxFrame: Checkbox, actionID: number, cooldownFrame: CooldownFrame) | guessed |
SetActionBarPage | Switches the main action bar to the page. · by wowlua(pageIndex: number) | implemented |
ShouldOverrideBarShowHealthBar | Whether the override bar shows a health bar. · by wowlua(): boolean | guessed |
ShouldOverrideBarShowManaBar | Whether the override bar shows a power bar. · by wowlua(): boolean | guessed |
ShouldShowKeyring | Whether the keyring button is shown. · by wowlua(): boolean | recorded |
ToggleAutoCastPetAction | Turns autocast on or off for the pet action in the slot. · by wowlua(slotID: number) | guessed |
UnregisterActionUIButton | Stops the game updating the button registered with RegisterActionUIButton. · by wowlua(checkboxFrame: Checkbox) | guessed |
UsesActionText | Whether the action slot shows text, such as a macro's name. · by wowlua(actionID: number): boolean | implemented |
"by wowlua": no one documents this function, so wowlua wrote the description from its name, signature and behaviour.
Events
| event | payload | fired by the emulator |
|---|---|---|
ACTIONBAR_HIDEGRID | no payload | implemented |
ACTIONBAR_PAGE_CHANGED | no payload | implemented |
ACTIONBAR_SHOWGRID | no payload | implemented |
ACTIONBAR_SHOW_BOTTOMLEFT | no payload | not implemented |
ACTIONBAR_SLOT_CHANGED | slot: number | implemented |
ACTIONBAR_UPDATE_COOLDOWN | no payload | implemented |
ACTIONBAR_UPDATE_STATE | no payload | implemented |
ACTIONBAR_UPDATE_USABLE | no payload | implemented |
ACTION_RANGE_CHECK_UPDATE | slot: number, isInRange: boolean, checksRange: boolean | implemented |
ACTION_USABLE_CHANGED | changes: ActionUsableState[] | implemented |
PET_BAR_UPDATE | no payload | implemented |
UPDATE_BONUS_ACTIONBAR | no payload | implemented |
UPDATE_EXTRA_ACTIONBAR | no payload | implemented |
UPDATE_MULTI_CAST_ACTIONBAR | no payload | not implemented |
UPDATE_OVERRIDE_ACTIONBAR | no payload | implemented |
An event the emulator doesn't fire on its own can still be fired from a test: mock.fireEvent("ACTIONBAR_SHOW_BOTTOMLEFT").
sources
Signatures, events and structures: Blizzard's API documentation (Blizzard_APIDocumentationGenerated) (ActionBar system, camelot 1.60.1). Descriptions: warcraft.wiki.gg's API pages, by its contributors, CC BY-SA 4.0 ↗; written by wowlua where no documentation describes the entry.