Action functions

ActionBar functions

Addon-related functions

  • DisableAddOn - Disables an addon by name or index
    • DisableAllAddOns - Flags all addons as disabled for the current character
    • EnableAddOn - Enables an addon for the current character
      • EnableAllAddOns - Enables all addons for the current character (takes effect at the next UI load)
        • GetAddOnDependencies - Get all dependencies of the queried addon. Returns nil if no dependencies are listed.
          • GetAddOnInfo - Returns information about an addon in the client's addon list
            • GetAddOnMetadata - Returns the value of certain fields in an addon's TOC file
              • GetNumAddOns - Returns the number of addons in the addon listing
                • IsAddOnLoadOnDemand - Returns whether or not a given addon can be loaded on demand
                  • IsAddOnLoaded - Query if an addon is loaded (running)
                    • LoadAddOn - Loads an AddOn manually if it is Load on Demand. Will also load the dependencies of an AdddOn.
                      • ResetDisabledAddOns - Resets the enabled status of addons before the change is committed via a reload
                        • SendAddonMessage - Sends a chat-like message to players that will not show up in their chat windows by default

                        Arena functions

                        Auction functions

                        Bank functions

                        Battlefield functions

                        Blizzard internal functions

                        Buff functions

                        CVar functions

                        • GetCVar - Returns the value of a stored configuration variable
                          • GetCVarAbsoluteMax - Returns the absolute maximum value allowed for a given CVar
                            • GetCVarAbsoluteMin - Returns the absolute minimum value allowed for a given CVar
                              • GetCVarBool - Returns the value of the CVar as 1 or nil instead of requiring you to compare the cvar value with "0" or "1"
                                • GetCVarDefault - Query the default value for a given CVar. Will error if CVar does not exist.
                                  • GetCVarInfo - Returns information about the named CVar
                                    • GetCVarMax - Returns the maximum value allowed for a given CVar
                                      • GetCVarMin - Returns the minimum value allowed for a given CVar
                                        • RegisterCVar - Registers a configuration variable to be saved
                                          • SetCVar - Sets the value of a configuration variable in config.wtf

                                            Camera functions

                                            Channel functions

                                            Chat functions

                                            • AddChatWindowChannel - Maps a channel in a specific chat frame to a numeric index.
                                              • AddChatWindowMessages - Sets a chat frame to receive and show messages of the given message group.
                                                • CanComplainChat - Returns whether or not a given chat line can be reported
                                                  • ChangeChatColor - Changes the color of a message type in the chat windows
                                                    • ComplainChat - Files a complaint about a given chat message
                                                      • GetChatTypeIndex - Converts a chat type string to a numeric chat type index.
                                                        • GetChatWindowChannels - Returns a list of all channels that a given chat window is interested in
                                                          • GetChatWindowInfo - Retrieves information about a specific Chat window
                                                            • GetChatWindowMessages - Returns a list of message events (leaving the CHAT_MSG_ part out) a given chatframe is registered for.
                                                              • GetLanguageByIndex - Returns the localized name of the language identified by the index being queried
                                                                • GetNumLaguages - Returns the number of languages the player is capable of speaking
                                                                  • GetNumLanguages - Returns the number of languages the player's character can speak
                                                                    • IsIgnored - Returns whether or not you are ignoring a specific unit.
                                                                      • LoggingChat - Toggle logging of chat to Logs/WowChatLog.txt. Toggle = true to turn on logging, Toggle = false to turn off logging, nil to query logging status.
                                                                        • LoggingCombat - Toggle combat logging to Logs/WoWCombatLog.txt. Toggle = true to turn on logging, Toggle = false to turn off logging, nil to query logging status.
                                                                          • RemoveChatWindowChannel - Removes a chat chanel from the given
                                                                            • RemoveChatWindowMessages - Hides a group of messages from a chat frame
                                                                              • ResetChatColors - Resets the colors of the chat channels back to default.
                                                                                • ResetChatWindows - Resets the chat windows to hardcoded defaults
                                                                                  • SendChatMessage - Sends a chat message
                                                                                    • SetChatWindowAlpha - Sets the value of the chat window alpha in chat-cache.txt
                                                                                      • SetChatWindowColor - Sets the value of the chat window color in chat-cache.txt
                                                                                        • SetChatWindowDocked - Sets the value of the docked setting for the given chat window in chat-cache.txt
                                                                                          • SetChatWindowLocked - Locks a chat window, so it can't be dragged or resized.
                                                                                            • SetChatWindowName - Set the name for a chat window in chat-cache.txt
                                                                                              • SetChatWindowShown - Sets if a chat window is shown in chat-cache.txt
                                                                                                • SetChatWindowSize - Sets the value of the chat window's font size in chat-cache.txt

                                                                                                  Chinese client functions

                                                                                                  Client information functions

                                                                                                  • CancelLogout - Cancels a pending logout
                                                                                                    • ForceLogout - Forces the client to logout
                                                                                                      • ForceQuit - Immediately exits World of Warcraft
                                                                                                        • GetAccountExpansionLevel - Returns the expansion level of the player's account
                                                                                                          • GetBuildInfo - Returns the version information about the client
                                                                                                            • GetExistingLocales - Returns the locale packs currently available to the client
                                                                                                              • GetLocale - Returns the four character locale code indicating what language the client uses
                                                                                                                • IsLinuxClient - Returns whether or not the game client is running on Linux
                                                                                                                  • IsMacClient - Returns whether or not the running client is a Mac
                                                                                                                    • IsWindowsClient - Checks if the client's OS is Windows
                                                                                                                      • Logout - Logs out of the current character, taking your back to the character selection screen
                                                                                                                        • Quit - Quits the game normally.
                                                                                                                          • SetEuropeanNumbers - Enables using comma as the decimal separator

                                                                                                                            Combat functions

                                                                                                                            • AttackTarget - Enables melee auto-attacking against the currently selected target
                                                                                                                            • LoggingCombat - Toggle combat logging to Logs/WoWCombatLog.txt. Toggle = true to turn on logging, Toggle = false to turn off logging, nil to query logging status.
                                                                                                                              • StartAttack - This function is used by Blizzard code to start an attack on a specific unit.
                                                                                                                              • StopAttack - Stops auto-attack if active
                                                                                                                              • UnitAffectingCombat - Returns whether or not a unit is currently in combat

                                                                                                                                Commentator functions

                                                                                                                                Complaint functions

                                                                                                                                • CanComplainChat - Returns whether or not a given chat line can be reported
                                                                                                                                  • CanComplainInboxItem - Query an inbox mail item for complain status. This determines if you can report this mail as Spam. Returns 1 if you can, nil otherwise. This function only works at the mailbox, and will return nil for anyone on your friends list
                                                                                                                                    • ComplainChat - Files a complaint about a given chat message
                                                                                                                                      • ComplainInboxItem - Reports an inbox item as spam
                                                                                                                                        • ReportPlayerIsPVPAFK - Reports a player or unit as AFK in a PVP battleground

                                                                                                                                          Container functions

                                                                                                                                          Crafting functions

                                                                                                                                          • BindEnchant - Confirms enchanting an item, when it would cause the item to become soulbound
                                                                                                                                            • CloseCraft - Closes the Craft Frame
                                                                                                                                              • CollapseCraftSkillLine - Collapses a skill line in the craft frame
                                                                                                                                                • CraftIsEnchanting - Returns whether or not the current craft window is the enchanting window.
                                                                                                                                                  • CraftIsPetTraining - Returns whether or not the open craft window is the pet traning window
                                                                                                                                                    • CraftOnlyShowMakeable - Enables or disables the "Have Materials" filter in the craft UI.
                                                                                                                                                      • DoCraft - Performs the selected craft skill
                                                                                                                                                        • ExpandCraftSkillLine - Expands a craft skill line header
                                                                                                                                                          • GetCraftButtonToken - Returns the global string token for the craft button in the craft UI
                                                                                                                                                            • GetCraftCooldown - Returns the amount of time left on a craft skill cooldown
                                                                                                                                                              • GetCraftDescription - Returns a short description of what a specified craft does
                                                                                                                                                                • GetCraftDisplaySkillLine - Returns information about the currently open craft (Enchanting or Beast Training)
                                                                                                                                                                  • GetCraftFilter - Returns whether or not a given craft filter is enabled
                                                                                                                                                                    • GetCraftIcon - Returns the texture of a selected craft to be shown in the craft UI.
                                                                                                                                                                      • GetCraftInfo - Returns information about a given craft recipe or skill (Enchanting, or Pet Training)
                                                                                                                                                                        • GetCraftItemLink - Returns an item link for a craft skill item
                                                                                                                                                                          • GetCraftItemNameFilter - Returns the value of the craft UI item name filter
                                                                                                                                                                            • GetCraftName - Returns the name of the current craft that the player has open. Will return the first profession found in the spellbook (even professions that use the TradeSkill API instead of the Craft API) if no craft is open.
                                                                                                                                                                              • GetCraftNumMade - Returns the number of items crafted for a given recipe
                                                                                                                                                                                • GetCraftNumReagents - Returns the number of reagents that are required for the given recipe
                                                                                                                                                                                  • GetCraftReagentInfo - Returns information about a craft skill reagent
                                                                                                                                                                                    • GetCraftReagentItemLink - Returns an item link for a specific craft skill reagent
                                                                                                                                                                                      • GetCraftRecipeLink - Retrieves the recipe link for a given craft skill. The tooltip for this item link shows required reagents and description.
                                                                                                                                                                                        • GetCraftSelectionIndex - Returns the index of the currently selected craft item
                                                                                                                                                                                          • GetCraftSkillLine - Returns the name of the currently (or last) open craft skill window
                                                                                                                                                                                            • GetCraftSlots - Returns a list of item slot types for which crafted items can be made
                                                                                                                                                                                              • GetCraftSpellFocus - Returns a list of required items for a craft skill (e.g. Enchanting rods)
                                                                                                                                                                                                • GetNumCrafts - Returns the number of items in the crafting window
                                                                                                                                                                                                  • ReplaceEnchant - Confirms replacing an existing enchant
                                                                                                                                                                                                    • SelectCraft - Selects a given item for the active craft (used by Enchanting and Pet Training)
                                                                                                                                                                                                      • SetCraftFilter - Sets a specific craft filter as active
                                                                                                                                                                                                        • SetCraftItemNameFilter - Sets the craft ui item name filter search string

                                                                                                                                                                                                          Cursor functions

                                                                                                                                                                                                          Debug client functions

                                                                                                                                                                                                          • FrameXML_Debug - Enables or disables verbose XML logging
                                                                                                                                                                                                            • debugprofilestart - Starts and resets the high resolution debug timer
                                                                                                                                                                                                              • debugprofilestop - Returns the value of the running debug profile timer
                                                                                                                                                                                                                • debugstack - Returns information about the current function call stack
                                                                                                                                                                                                                  • geterrorhandler - Returns a reference to the current error handler.
                                                                                                                                                                                                                    • issecurevariable - Returns whether or not a variable is secure and if not, what addon tainted the variable
                                                                                                                                                                                                                      • seterrorhandler - Sets the default error handler to a specific function

                                                                                                                                                                                                                        Deprecated functions

                                                                                                                                                                                                                        Faction functions

                                                                                                                                                                                                                        GM Survey functions

                                                                                                                                                                                                                        GM ticket functions

                                                                                                                                                                                                                        Guild bank functions

                                                                                                                                                                                                                        Guild functions

                                                                                                                                                                                                                        Inspect functions

                                                                                                                                                                                                                        Instance functions

                                                                                                                                                                                                                        Inventory functions

                                                                                                                                                                                                                        Item functions

                                                                                                                                                                                                                        Item text functions

                                                                                                                                                                                                                        • CloseItemText - Closes the item text display frame.
                                                                                                                                                                                                                          • ItemTextGetCreator - Gets the creator of the text currently being viewed. Used for books, parchments and the like.
                                                                                                                                                                                                                            • ItemTextGetItem - Returns the name of the currently viewed ItemText item
                                                                                                                                                                                                                              • ItemTextGetMaterial - Returns the texture for the current book/parchement being displayed in the ItemTextFrame. A return value of 'nil' means 'Parchment' is being used.
                                                                                                                                                                                                                                • ItemTextGetPage - Returns the page number of the currently item text
                                                                                                                                                                                                                                  • ItemTextGetText - Returns the test associated with the open item.
                                                                                                                                                                                                                                    • ItemTextHasNextPage - Determines if the currently open book has another page following the current one.
                                                                                                                                                                                                                                      • ItemTextNextPage - Asks the game to move the currently open book, or other readable object to the next page of text.
                                                                                                                                                                                                                                        • ItemTextPrevPage - Asks the game to move the currently open book, or other readable object to the previous page of text.

                                                                                                                                                                                                                                          Itemlink functions

                                                                                                                                                                                                                                          Keybind functions

                                                                                                                                                                                                                                          Keyboard functions