Achievement functions

Action functions

ActionBar functions

Addon-related functions

Archaeology profession functions

Arena functions

Auction functions

Bank functions

Barbershop functions

Battle.net functions

Battlefield functions

Blizzard internal functions

Buff functions

CVar functions

  • GetCVar - Returns the value of a configuration variable
  • GetCVarBool - Returns the value of a configuration variable in a format compatible with Lua conditional expressions
  • GetCVarDefault - Returns the default value of a configuration variable
  • GetCVarInfo - Returns information about a configuration variable
  • RegisterCVar - Registers a configuration variable to be saved
  • SetCVar - Sets the value of a configuration variable

Calendar functions

Camera functions

  • CameraOrSelectOrMoveStart - Begins camera movement or selection (equivalent to left-clicking in the 3-D world)
  • CameraOrSelectOrMoveStop - Ends action initiated by [[docs/api/CameraOrSelectOrMoveStart|`CameraOrSelectOrMoveStart`]]
  • CameraZoomIn - Zooms the camera in by a specified distance
  • CameraZoomOut - Zooms the camera out by a specified distance
  • FlipCameraYaw - Rotates the camera around the player
  • IsMouselooking - Returns whether mouselook mode is active
  • MouselookStart - Enables mouselook mode, in which cursor movement rotates the camera
  • MouselookStop - Disables mouselook mode
  • MoveViewDownStart - Begins orbiting the camera downward (to look upward)
  • MoveViewDownStop - Ends camera movement initiated by [[docs/api/MoveViewDownStart|`MoveViewDownStart`]]
  • MoveViewInStart - Begins zooming the camera inward (towards/through the player character)
  • MoveViewInStop - Ends camera movement initiated by [[docs/api/MoveViewInStart|`MoveViewInStart`]]
  • MoveViewLeftStart - Begins orbiting the camera around the player character to the left
  • MoveViewLeftStop - Ends camera movement initiated by [[docs/api/MoveViewLeftStart|`MoveViewLeftStart`]]
  • MoveViewOutStart - Begins zooming the camera outward (away from the player character)
  • MoveViewOutStop - Ends camera movement initiated by [[docs/api/MoveViewOutStart|`MoveViewOutStart`]]
  • MoveViewRightStart - Begins orbiting the camera around the player character to the right
  • MoveViewRightStop - Ends camera movement initiated by [[docs/api/MoveViewRightStart|`MoveViewRightStart`]]
  • MoveViewUpStart - Begins orbiting the camera upward (to look down)
  • MoveViewUpStop - Ends camera movement initiated by [[docs/api/MoveViewUpStart|`MoveViewUpStart`]]
  • NextView - Moves the camera to the next predefined setting
  • PrevView - Moves the camera to the previous predefined setting
  • ResetView - Resets a saved camera setting to default values
  • SaveView - Saves the current camera settings
  • SetView - Moves the camera to a saved camera setting

Channel functions

Chat functions

Class resource functions

  • DestroyTotem - Destroys a specific totem (or ghoul)
  • GetEclipseDirection - Returns the direction in which the players eclipse is moving.
  • GetRuneCooldown - Returns cooldown information about one of the player's rune resources
  • GetRuneCount - Returns the number of available rune resources in one of the player's rune slots
  • GetRuneType - Returns the type of one of the player's rune resources
  • GetTotemInfo - Returns information on a currently active totem (or ghoul)
  • GetTotemTimeLeft - Returns the time remaining before a totem (or ghoul) automatically disappears
  • TargetTotem - Targets one of the player's totems (or a Death Knight's ghoul)

Client control and information functions

  • CancelLogout - Cancels a pending logout or quit
  • DownloadSettings - Restores game settings from a backup stored on the server
  • ForceLogout - Forces the client to logout
  • ForceQuit - Immediately exits World of Warcraft
  • GetAccountExpansionLevel - Returns the most recent of WoW's retail expansion packs for which the player's account is authorized
  • GetBuildInfo - Returns the version information about the client
  • GetExistingLocales - Returns a list of installed localization packs for the WoW client
  • GetExpansionLevel - Returns the expansion level of the game
  • GetGameTime - Returns the current realm (server) time
  • GetLocale - Returns a code indicating the localization currently in use by the client
  • GetNetStats - Returns information about current network connection performance
  • IsLinuxClient - Returns whether the player is using the native Linux game client
  • IsMacClient - Returns whether the player is using the Mac OS X game client
  • IsWindowsClient - Returns whether the player is using the Windows game client
  • Logout - Attempts to log out and return to the character selection screen
  • NotWhileDeadError - Causes the default UI to display an error message indicating that actions are disallowed while the player is dead
  • Quit - Attempts to exit the World of Warcraft client
  • ReloadUI - Reloads the user interface
  • Screenshot - Saves an image of the current game display
  • SetEuropeanNumbers - Sets the decimal separator for displayed numbers
  • SetUIVisibility - Enables or disables display of UI elements in the 3-D world
  • UploadSettings - Stores a backup of game settings on the server

Combat functions

CombatLog functions

Commentator functions

Companion functions

Complaint functions

Container functions

Currency functions

Cursor functions

Debugging and Profiling functions

Deprecated functions

Duel functions

  • AcceptDuel - Accepts a proposed duel
  • CancelDuel - Cancels an ongoing duel, or declines an offered duel
  • StartDuel - Challenges another player to a duel

Equipment Manager functions

Experience (XP) functions

  • GetRewardXP - Returns the experience awarded when completing a quest
  • GetXPExhaustion - Returns the amount of rested bonus experience available
  • IsXPUserDisabled - Returns whether experience gain has been disabled for the player
  • UnitXP - Returns the player's current amount of experience points
  • UnitXPMax - Return the total amount of experience points required for the player to gain a level

Faction functions

Flyout button functions

GM Survey functions

GM Ticket functions

Glyph functions

Guild bank functions

Guild functions

Hyperlink functions

In-game movie playback functions

Inspect functions

Instance functions

Inventory functions

Item Text functions

Item Upgrade functions

Item functions

Keybind functions

Keyboard functions

Knowledge-base functions

Limited play time functions

  • GetBillingTimeRested - Returns the amount of time for which the player must be offline in order to lift play time restrictions
  • NoPlayTime - Returns whether the player has exceeded the allowed play time limit
  • PartialPlayTime - Returns whether the player is near the allowed play time limit

Locale-specific functions

Looking for group functions

Loot functions

Lua library functions

  • acos - Alternative to math.acos, using degrees instead of radians
  • acos - Alternative to math.acos, using degrees instead of radians
  • asin - Alternative to math.asin, using degrees instead of radians
  • asin - Alternative to math.asin, using degrees instead of radians
  • assert - Causes a Lua error if a condition is failed
  • atan - Alternative to math.atan, using degrees instead of radians
  • atan - Alternative to math.atan, using degrees instead of radians
  • ceil - Returns the smallest integer larger than or equal to a number
  • collectgarbage - Interface to the Lua garbage collector
  • cos - Alternative to math.cos, using degrees instead of radians
  • date - Returns a formatted date/time string for a date (or the current date)
  • difftime - Returns the number of seconds between two time values
  • error - Causes a Lua error message
  • floor - Returns the largest integer smaller than or equal to a number
  • foreach - This function is deprecated and should no longer be used
  • foreachi - This function is deprecated and should no longer be used
  • format - Returns a formatted string containing specified values
  • frexp - Returns the normalized fraction and base-2 exponent for a number
  • gcinfo - Returns the total Lua memory usage
  • getfenv - Returns the environment for a function (or the global environment)
  • getmetatable - Returns an object's metatable
  • getn - This function is deprecated and should no longer be used
  • gmatch - Returns an iterator function for finding pattern matches in a string
  • gsub - Returns a string in which occurrences of a pattern are replaced
  • ipairs - Returns an iterator function for integer keys in a table
  • ldexp - Returns the number generated by a normalized fraction and base-2 exponent
  • loadstring - Loads and compiles Lua source code
  • next - Returns the next key/value pair in a table
  • pairs - Returns an iterator function for a table
  • pcall - Executes a function in protected mode
  • random - Generates a pseudo-random number
  • rawequal - Returns whether two values are equal without invoking any metamethods
  • rawget - Returns the real value associated with a key in a table without invoking any metamethods
  • rawset - Sets the value associated with a key in a table without invoking any metamethods
  • select - Returns one or more values from a list (`...`), or the number of values in a list
  • setfenv - Sets the environment to be used by a function
  • setmetatable - Sets the metatable for a table
  • sin - Alternative to math.sin, using degrees instead of radians
  • sort - Sorts a table
  • sqrt - Returns the square root of a number
  • tan - Alternative to math.tan, using degrees instead of radians
  • time - Returns the numeric time value for a described date/time (or the current time)
  • tonumber - Returns the numeric value of a string
  • tostring - Returns a string representation of a value
  • type - Returns a string describing the data type of a value
  • unpack - Returns the list of elements in a table
  • xpcall - Executes a function in protected mode with a custom error handler

Mac client functions

Macro functions

Mail functions

Map functions

Merchant functions

Modified click functions

Money functions

Movement functions

Multi-cast actions

NPC "Gossip" Dialog functions

Objectives tracking functions

Party functions

Pet Stable functions

Pet functions

Petition functions

Player information functions

  • AcceptResurrect - Accepts an offered resurrection spell
  • AcceptXPLoss - Resurrects the player at a spirit healer, accepting possible consequences
  • CanHearthAndResurrectFromArea - Returns whether the player is in a world PvP zone offering an exit option
  • CheckBinderDist - Returns whether the player is in range of an NPC that can set the Hearthstone location
  • CheckSpiritHealerDist - Returns whether the player is in range of a spirit healer
  • ConfirmBinder - Sets the player's Hearthstone to the current location
  • DeclineResurrect - Declines an offered resurrection spell
  • Dismount - Dismounts from the player's summoned mount
  • GetAverageItemLevel - Returns the players average item level as displayed in the character pane.
  • GetBindLocation - Returns the name of the player's Hearthstone location
  • GetComboPoints - Returns the player's number of combo points on the target.
  • GetCorpseRecoveryDelay - Returns the amount of time left until the player can recover their corpse
  • GetCurrentTitle - Returns the currently selected player title
  • GetMaxPlayerLevel - Returns the maximum level attainable by a player
  • GetNumTitles - Returns the number of available player titles
  • GetOverrideSpellPowerByAP - Returns how much spell power is returned by attack power (Shaman)
  • GetPlayerFacing - Returns the player's orientation (heading)
  • GetQuestLogRewardTitle - Returns the title reward for the selected quest in the quest log
  • GetReleaseTimeRemaining - Returns the amount of time remaining until the player's spirit is automatically released when dead
  • GetResSicknessDuration - Returns the duration of resurrection sickness at the player's current level
  • GetRestState - Returns the player's current rest state
  • GetRuneCooldown - Returns cooldown information about one of the player's rune resources
  • GetRuneCount - Returns the number of available rune resources in one of the player's rune slots
  • GetRuneType - Returns the type of one of the player's rune resources
  • GetTimeToWellRested - This function is deprecated and should no longer be used
  • GetTitleName - Returns the text of an available player title
  • GetUnitPitch - Returns the player's current pitch (slope or angle of movement)
  • GetUnitSpeed - Returns a unit's current speed
  • GetXPExhaustion - Returns the amount of rested bonus experience available
  • HasFullControl - Returns whether the player character can be controlled
  • HasKey - Returns whether the player has any keys stored in the Keyring container
  • HasSoulstone - Returns whether the player can instantly resurrect in place
  • HasWandEquipped - Returns whether the player has a wand equipped
  • IsChatAFK - Returns whether the player's status is Away
  • IsChatDND - Returns whether the player's status is Busy
  • IsFalling - Returns whether the player is currently falling
  • IsFlyableArea - Returns whether flight is allowed on the continent where the player is currently located
  • IsFlying - Returns whether the player is currently flying
  • IsInInstance - Returns whether the player is in an instance (and its type if applicable)
  • IsIndoors - Returns whether the player is currently indoors
  • IsMounted - Returns whether the player is mounted
  • IsOutOfBounds - Returns whether the player is currently outside the bounds of the world
  • IsOutdoors - Returns whether the player is currently outdoors
  • IsResting - Returns whether the player is currently resting
  • IsStealthed - Returns whether the player is currently stealthed
  • IsSwimming - Returns whether the player is currently swimming
  • IsTitleKnown - Returns whether the player has earned the ability to display a title
  • IsXPUserDisabled - Returns whether experience gain has been disabled for the player
  • OffhandHasWeapon - Returns whether the player has an equipped weapon in the off hand slot
  • OpeningCinematic - Displays the introductory cinematic for the player's race
  • PlayerHasHearthstone - Returns whether the player has a hearthstone in their bag
  • RepopMe - Releases the player's spirit to the nearest graveyard
  • ResurrectGetOfferer - Returns the name of a unit offering to resurrect the player
  • ResurrectHasSickness - Returns whether accepting an offered resurrection spell will cause the player to suffer Resurrection Sickness
  • ResurrectHasTimer - Returns whether the player must wait before resurrecting
  • RetrieveCorpse - Confirms resurrection by returning to the player's corpse
  • SetCurrentTitle - Changes a player's displayed title
  • ShowCloak - Enables or disables display of the player's cloak
  • ShowHelm - Enables or disables display of the player's headgear
  • ShowingCloak - Returns whether the player's cloak is displayed
  • ShowingHelm - Returns whether the player's headgear is displayed
  • ToggleSheath - Sheaths or unsheaths the player character's hand-held items
  • UnitXP - Returns the player's current amount of experience points
  • UnitXPMax - Return the total amount of experience points required for the player to gain a level
  • UseHearthstone - Attempts to use the player's Hearthstone
  • UseSoulstone - Instantly resurrects the player in place, if possible

PvP functions

Quest functions

Raid functions

Realm functions

Recruit-a-friend functions

  • AcceptLevelGrant - Accepts a level offered by the player's Recruit-a-Friend partner
  • CanGrantLevel - Returns whether the player can give levels to a Recruit-a-Friend partner
  • CanSummonFriend - Returns whether a unit can be summoned via Recruit-a-Friend
  • DeclineLevelGrant - Refuses a level offered by the player's Recruit-a-Friend partner
  • GetSummonFriendCooldown - Returns cooldown information about the player's Summon Friend ability
  • GrantLevel - Grants a level to the player's Recruit-a-Friend partner
  • IsReferAFriendLinked - Returns whether a unit's account is linked to the player's via the Recruit-a-Friend program
  • SummonFriend - Summons a unit whose account is linked to the player's via the Recruit-a-Friend program

Secure execution utility functions

  • InCombatLockdown - Returns whether the user interface is protected due to combat
  • forceinsecure - Causes the current execution path to continue outside the secure environment
  • hooksecurefunc - Add a function to be called after execution of a secure function
  • issecure - Returns whether the current execution path is secure
  • issecurevariable - Returns whether a variable is secure (and if not, which addon tainted it)
  • newproxy - Creates a zero-length userdata with an optional metatable.
  • securecall - Calls a function without tainting the execution path

Skill functions

Social functions

  • AddFriend - Adds a character to the friends list
  • AddIgnore - Adds a character to the ignore list
  • AddOrDelIgnore - Adds the named character to the ignore list, or removes the character if already in the ignore list
  • AddOrRemoveFriend - Adds the named character to the friends list, or removes the character if already in the friends list
  • BNGetFriendIndex - Returns friendlist index of a BN friend
  • DelIgnore - Removes a player from the ignore list
  • GetFriendInfo - Returns information about a character on the player's friends list
  • GetIgnoreName - Returns the name of a character on the ignore list
  • GetNumFriends - Returns the number of characters and online characters on the player's friends list
  • GetNumIgnores - Returns the number of characters on the player's ignore list
  • GetNumWhoResults - Returns the number of results from a Who system query
  • GetSelectedFriend - Returns the index of the selected character in the player's friends list
  • GetSelectedIgnore - Returns the index of the selected character in the player's ignore list
  • GetWhoInfo - Returns information about a character in the Who system query results
  • IsIgnored - Returns whether a unit is on the player's ignore list
  • RemoveFriend - Removes a character from the friends list
  • SendWho - Requests a list of characters meeting given search criteria from the server
  • SetFriendNotes - Sets note text associated with a friends list entry
  • SetSelectedFriend - Selects a character in the player's friends list
  • SetSelectedIgnore - Selects a character in the player's ignore list
  • SetWhoToUI - Changes the delivery method for results from [[docs/api/SendWho|`SendWho()`]] queries
  • ShowFriends - Requests friends/ignore list information from the server
  • SortWho - Sorts the Who system query results list

Socketing functions

Sound functions

Spell functions

Stance/Shapeshift functions

Stat information functions

Stopwatch functions

Summoning functions

Talent functions

Targeting functions

Taxi/Flight functions

  • CloseTaxiMap - Ends interaction with the Taxi (flight master) UI
  • GetNumRoutes - Returns the number of hops from the current location to another taxi node
  • GetTaxiBenchmarkMode - Returns whether flight path benchmark mode is enabled
  • NumTaxiNodes - Returns the number of flight points on the taxi map
  • SetTaxiBenchmarkMode - Enables or disables flight path benchmark mode
  • SetTaxiMap - Sets a Texture object to show the appropriate flight map texture
  • TakeTaxiNode - Embarks on a taxi flight to a given destination
  • TaxiGetDestX - Returns the horizontal coordinate of a taxi flight's destination node
  • TaxiGetDestY - Returns the vertical coordinate of a taxi flight's destination node
  • TaxiGetSrcX - Returns the horizontal coordinate of a taxi flight's source node
  • TaxiGetSrcY - Returns the vertical coordinate of a taxi flight's source node
  • TaxiNodeCost - Returns the cost to fly to a given taxi node
  • TaxiNodeGetType - Returns the type of a flight pont
  • TaxiNodeName - Returns the name of a flight point
  • TaxiNodePosition - Returns the position of a flight point on the taxi map
  • TaxiNodeSetCurrent - Sets the "current" flight path node
  • UnitOnTaxi - Returns whether a unit is currently riding a flight path (taxi)

Threat functions

Tracking functions

  • GetNumTrackingTypes - Returns the number of available minimap object/unit tracking abilities
  • GetTrackingInfo - Returns information about a given tracking option
  • SetTracking - Enables a given minimap object/unit tracking ability

Trade functions

Tradeskill functions

Trainer functions

Transmogrification functions

Tutorial functions

  • ClearTutorials - Disables contextual tutorial display
  • FlagTutorial - Marks a contextual tutorial as displayed so it doesn't appear again
  • ResetTutorials - Enables contextual tutorial display and clears the list of already displayed tutorials

UI/Visual functions

Unit functions

Utility functions

  • CreateFont - Creates a new Font object
  • CreateFrame - Creates a new Frame object
  • EnumerateFrames - Returns the next frame following the frame passed, or nil if no more frames exist
  • GetAutoCompleteResults - Returns a list of character names which complete a given partial name prefix
  • GetClickFrame - Returns the Frame object associated with the given name
  • GetCurrentKeyBoardFocus - Returns the frame currently handling keyboard input
  • GetFramesRegisteredForEvent - Returns all frames registered for a given event
  • GetMirrorTimerInfo - Returns information about special countdown timers
  • GetMirrorTimerProgress - Returns a high-resolution value for a special countdown timer
  • GetMouseButtonClicked - Returns which mouse button triggered the current script
  • GetMouseButtonName - Returns the name for a mouse button specified by number
  • GetMouseFocus - Returns the frame that is currently under the mouse, and has mouse input enabled.
  • GetMuteName - Returns the name of a character on the mute list
  • GetNumFrames - Returns the number of existing Frame objects (and derivatives)
  • GetText - Returns a localized string according to given parameters
  • GetTime - Returns a number representing the current time (with millisecond precision)
  • IsLoggedIn - Returns whether the login process has completed
  • IsMouseButtonDown - Returns whether a given mouse button is held down
  • RequestTimePlayed - Requests information from the server about the player character's total time spent online
  • RunScript - Runs a string as a Lua script
  • SecondsToTime - Returns a description of an amount of time in appropriate units
  • SetPortraitToTexture - Sets a Texture object to display an arbitrary texture, altering it to fit a circular frame
  • debuglocals - Returns information about the local variables at a given stack depth
  • getglobal - Returns the value of a global variable
  • scrub - Replaces non-simple values in a list with nil
  • setglobal - Sets a global variable to a specified value
  • strconcat - Joins a list of strings (with no separator)
  • strjoin - Joins a list of strings together with a given separator
  • strsplit - Splits a string based on another seperator string
  • strtrim - Trims leading and trailing characters (whitespace by default) from a string
  • wipe - Removes all entries from a table

Vehicle functions

Video functions

Voice functions

Void storage functions

Wargame functions

Zone information functions

  • GetMinimapZoneText - Returns the name of the current area (as displayed in the Minimap)
  • GetRealZoneText - Returns the "official" name of the zone or instance in which the player is located
  • GetSubZoneText - Returns the name of the minor area in which the player is located
  • GetZonePVPInfo - Returns PVP information about the current area
  • GetZoneText - Returns the name of the zone in which the player is located
  • IsSubZonePVPPOI - Returns whether the current area has PvP (or other) objectives to be displayed

_(API_CAT_BATTLEPETS)

  • GetAuctionItemBattlePetInfo - Retrieves info about one Battle Pet in the current retrieved list of Battle Pets from the Auction House.

Uncategorized functions