World of Warcraft API

https://web.archive.org/web/20100726112636/http://wowprogramming.com/docs
Admin
The World of Warcraft API provides an interface for developers to interact with the game, offering...
Tokens:507,845
Snippets:4,293
Trust Score:9.9
Update:21 hours ago
Show doc for...
Tokens:
Raw
### StartAuction example: placing item and creating auctions

Source: https://web.archive.org/web/20100515165807/http://wowprogramming.com/docs/api/StartAuction

This example shows how to place an item in the auction slot and then call StartAuction to create 4 auctions of 5 items each with a 1g bid, 1g50s buyout, and 24-hour duration. The runTime argument is an index (2 for 24 hours) as of patch 3.3.3.

```lua
-- Place an item in the auction slot
PickupContainerItem(bag, slot)
ClickAuctionSellItemButton()
ClearCursor()

-- Create 4 auctions of 5 items each for 1g bid, 1g50s buyout, 
-- with a duration of 24 hours
StartAuction(10000, 15000, 2, 5, 4)
```

--------------------------------

### PickupContainerItem example: Pick up first item in backpack

Source: https://web.archive.org/web/20090711181353/http://wowprogramming.com/docs/api/PickupContainerItem

This example calls PickupContainerItem with container index 0 (backpack) and slot index 1 to pick up the first item. The function places the item on the cursor if the slot contains an item and the cursor is empty.

```lua
-- Pickup the first item in your backpack
PickupContainerItem(0, 1)
```

--------------------------------

### debugprofilestart()

Source: https://web.archive.org/web/20100105232029/http://wowprogramming.com/docs/api/debugprofilestart

Starts or resets the high resolution profiling timer. Subsequent calls to debugprofilestop() will return the current value of the timer.

```APIDOC
## debugprofilestart()

### Description
Starts/resets the high resolution profiling timer. Subsequent calls to debugprofilestop() will return the current value of the timer.

### Signature
`debugprofilestart()`

### Parameters
None.

### Returns
No return value.
```

--------------------------------

### GetItemQualityColor example

Source: https://web.archive.org/web/20111212154217/http://wowprogramming.com/docs/api/GetItemQualityColor

Example call to GetItemQualityColor(4) returning approximate color components and hex string.

```lua
GetItemQualityColor(4)
-- returns (approximately) 0.6392, 0.2078, 0,9333, "ffa335ee"
```

--------------------------------

### BankButtonIDToInvSlotID Example

Source: https://web.archive.org/web/20100105232007/http://wowprogramming.com/docs/api/BankButtonIDToInvSlotID

Example showing how to get the inventory slot ID for a bank item or bag slot when mousing over a button in the bank UI.

```lua
-- While mousing over a button in the bank
local button = GetMouseFocus()
print("Inventory Slot:", BankButtonIDToInvSlotID(button:GetID(), button.isBag))
```

--------------------------------

### RunBinding example: Take a screenshot

Source: https://web.archive.org/web/20111212165851/http://wowprogramming.com/docs/api/RunBinding

Calls RunBinding with the command "SCREENSHOT" to trigger the screenshot action. The comment indicates the purpose of the call.

```lua
-- Take a screenshot
RunBinding("SCREENSHOT")
```

--------------------------------

### ClickSendMailItemButton Example

Source: https://web.archive.org/web/20111212192149/http://wowprogramming.com/docs/api/ClickSendMailItemButton

Places the first item in the player's backpack into the mail attachment slot using PickupContainerItem and ClickSendMailItemButton.

```lua
-- Places the first item in your backpack in the auction house item slot
PickupContainerItem(0, 1)
ClickSendMailItemButton()
```

--------------------------------

### Measure function execution time with debugprofilestop

Source: https://web.archive.org/web/20100105212452/http://wowprogramming.com/docs/api/debugprofilestop

Use debugprofilestart() and debugprofilestop() to time a segment of code. The example prints the elapsed time in milliseconds with sub-millisecond precision using format().

```lua
-- can be used to test the efficiency of a segment of code:
function myFunction()
  debugprofilestart()

  -- function body goes here

  print(format("myFunction executed in %f ms", debugprofilestop()))
end
```

--------------------------------

### ClickAuctionSellItemButton Example: Place Backpack Item in Auction Slot

Source: https://web.archive.org/web/20111212192339/http://wowprogramming.com/docs/api/ClickAuctionSellItemButton

This example places the first item in the player's backpack into the auction house item slot using PickupContainerItem and ClickAuctionSellItemButton. It assumes the player is interacting with an auctioneer.

```lua
-- Places the first item in your backpack in the auction house item slot
PickupContainerItem(0, 1)
ClickAuctionSellItemButton()
```

--------------------------------

### Print item classes with GetAuctionItemClasses

Source: https://web.archive.org/web/20111212155255/http://wowprogramming.com/docs/api/GetAuctionItemClasses

Lua example that prints the list of item classes returned by GetAuctionItemClasses. The comment shows example values: Weapon, Armor, Container, Consumable, Glyph, Trade Goods, Projectile, Quiver, Recipe, Gem, Miscellaneous, Quest.

```lua
-- Prints the list of item classes
print(GetAuctionItemClasses())

-- Example values returned are:
--   Weapon, Armor, Container, Consumable, Glyph, Trade Goods, Projectile, Quiver, Recipe, Gem, Miscellaneous, Quest
```

--------------------------------

### GetMacroItem usage example

Source: https://web.archive.org/web/20111212160628/http://wowprogramming.com/docs/api/GetMacroItem

Shows how to create a macro with conditional item usage and then call GetMacroItem to retrieve the item that would be used in the current context (combat vs non-combat). The example includes the macro creation and two calls to GetMacroItem with comments indicating the expected return values.

```lua
CreateMacro("health",1,"/use [combat] Runic Healing Potion ; [nocombat] Salted Venison")

-- when in combat:
GetMacroItem("health")
-- returns "Runic Healing Potion" (and hyperlink)

-- when not in combat:
GetMacroItem("health")
-- returns "Salted Venison" (and hyperlink)
```

--------------------------------

### Example combat log file contents

Source: https://web.archive.org/web/20100105232258/http://wowprogramming.com/docs/api/LoggingCombat

Shows the format of the WoWCombatLog.txt file entries, including event types like SPELL_CAST_SUCCESS and SWING_DAMAGE, with timestamps and unit details.

```plaintext
-- example log file contents
6/7 17:08:46.784  SPELL_CAST_SUCCESS,0x060000000279E425,"Gundark",0x511,0xF13000482C5462D1,"Timber Worg",0x10a48,49576,"Death Grip",0x1
6/7 17:08:47.089  SPELL_AURA_APPLIED,0x060000000279E425,"Gundark",0x511,0xF13000482C5462D1,"Timber Worg",0x10a48,49560,"Death Grip",0x1,DEBUFF
6/7 17:08:47.886  SWING_DAMAGE,0x060000000279E425,"Gundark",0x511,0xF13000482C5462D1,"Timber Worg",0x10a48,374,0,1,0,0,0,nil,nil,nil
6/7 17:08:47.887  SPELL_DAMAGE,0x060000000279E425,"Gundark",0x511,0xF13000482C5462D1,"Timber Worg",0x10a48,50401,"Razor Frost",0x10,5,0,16,0,0,0,nil,nil,nil
6/7 17:08:47.887  SPELL_AURA_APPLIED,0x060000000279E425,"Gundark",0x511,0xF13000482C5462D1,"Timber Worg",0x10a48,51714,"Frost Vulnerability",0x10,DEBUFF
6/7 17:08:48.207  SPELL_CAST_SUCCESS,0x060000000279E425,"Gundark",0x511,0xF13000482C5462D1,"Timber Worg",0x10a48,49896,"Icy Touch",0x10
6/7 17:08:48.327  SWING_MISSED,0xF13000482C5462D1,"Timber Worg",0x10a48,0x060000000279E425,"Gundark",0x511,DODGE
6/7 17:08:48.328  SPELL_PERIODIC_HEAL,0x060000000279E425,"Gundark",0x511,0x060000000279E425,"Gundark",0x511,50475,"Blood Presence",0x1,15,15,nil
```

--------------------------------

### Print localized facial hair customization names

Source: https://web.archive.org/web/20111212191300/http://wowprogramming.com/docs/api/GetFacialHairCustomization

Lua example that calls GetFacialHairCustomization() to obtain a token and then prints the localized string from the global table using the token. The output includes examples like "Facial Hair", "Earrings", and "Tusks".

```lua
-- prints localized names for customization options
-- e.g. "Facial Hair", "Earrings", "Tusks"
local token = GetFacialHairCustomization();
print(_G["FACIAL_HAIR_"..token]);
```

--------------------------------

### MoveViewDownStart()

Source: https://web.archive.org/web/20111212153747/http://wowprogramming.com/docs/api/MoveViewDownStart

Begins orbiting the camera downward (to look upward). This function is part of the camera functions and is called to start the downward camera movement.

```APIDOC
## MoveViewDownStart()

### Description
Begins orbiting the camera downward (to look upward).

### Signature
`MoveViewDownStart()`

### Parameters
None.

### Returns
None.

### Remarks
See also [Camera functions](http://wowprogramming.com/docs/api_categories#camera).
```

--------------------------------

### GetItemStats usage example with table reuse and wipe

Source: https://web.archive.org/web/20101210144624/http://wowprogramming.com/docs/api/GetItemStats

Shows how to call GetItemStats with an item link, iterate over the returned stats table, and reuse the table for another item. The example warns that reusing the table without wiping it first leaves stale stats from the previous item, and demonstrates using wipe() to clear it.

```lua
-- links to some early death knight gear for illustrating the example...
local _, swordLink = GetItemInfo("Greatsword of the Ebon Blade")
local _, ring1Link = GetItemInfo("Valanar's Signet Ring")

local stats = GetItemStats(swordLink)
for stat, value in pairs(stats) do print(value, _G[stat]) end
-- prints (approximately, on enUS client):
--   60.5 Damage Per Second
--   30 Strength
--   12 Hit Rating
--   24 Stamina

-- reusing the table...
GetItemStats(ring1Link, stats)
for stat, value in pairs(stats) do print(value, _G[stat]) end
--   60.5 Damage Per Second
--   12 Strength
--   12 Hit Rating
--   12 Critical Strike Rating
--   18 Stamina
-- oops, it overwrote the table from before, keeping some of the sword's stats...

-- let's try again and make sure it shows just the ring stats
wipe(stats)
GetItemStats(ring1Link, stats)
for stat, value in pairs(stats) do print(value, _G[stat]) end
--   12 Strength
--   12 Critical Strike Rating
--   18 Stamina
```

--------------------------------

### ClickSocketButton Example: Socket gem from backpack

Source: https://web.archive.org/web/20100105212701/http://wowprogramming.com/docs/api/ClickSocketButton

Picks up an item from the backpack and places it into the first gem socket using ClickSocketButton(1). The function only works while the Item Socketing UI is open.

```lua
-- Put the item in the top left slot of the backpack into the first gem socket
PickupContainerItem(0,1)
ClickSocketButton(1)
    
```

--------------------------------

### KBSetup_IsLoaded()

Source: https://web.archive.org/web/20111212160057/http://wowprogramming.com/docs/api/KBSetup_IsLoaded

Returns whether the knowledge base default query has completed successfully. This function presents an alternative to the KNOWLEDGE_BASE_SETUP_LOAD_SUCCESS event that can be used across UI reloads or login/logout.

```APIDOC
## KBSetup_IsLoaded()

### Description
Returns whether the knowledge base default query has completed successfully. The `KNOWLEDGE_BASE_SETUP_LOAD_SUCCESS` also indicates that the knowledge base setup is complete; this function presents an alternative that can be used across UI reloads or login/logout.

### Signature
`isLoaded` = `KBSetup_IsLoaded()`

### Returns
- **isLoaded** (boolean) - True if results for the knowledge base's default "Top Issues" query are available; false if a query is in progress or has failed.
```

--------------------------------

### debugstack example with output

Source: https://web.archive.org/web/20111212162925/http://wowprogramming.com/docs/api/debugstack

Calls debugstack() with no arguments to print the current call stack. The output shows the stack trace starting from the main chunk, including the RunScript function and various ChatFrame.lua functions.

```lua
print(debugstack())
-- output:
[string "print(debugstack())"]:1: in main chunk
  [C]: in function `RunScript'
  Interface\FrameXML\ChatFrame.lua:1826: in function `?'
  Interface\FrameXML\ChatFrame.lua:3332: in function `ChatEdit_ParseText'
  Interface\FrameXML\ChatFrame.lua:3052: in function `ChatEdit_SendText'
  Interface\FrameXML\ChatFrame.lua:3073: in function 
  [C]: in function `ChatEdit_OnEnterPressed'
  [string "*:OnEnterPressed"]:1: in function <[string "*:OnEnterPressed"]:1>
```

--------------------------------

### SetMouselookOverrideBinding example: rebind mouse buttons for mouselook

Source: https://web.archive.org/web/20100106000908/http://wowprogramming.com/docs/api/SetMouselookOverrideBinding

This example overrides the default mouselook bindings so that the 'z' key activates mouselook, and the left and right mouse buttons move the character forward and backward instead. It uses SetOverrideBindingClick to bind the 'z' key to a button that starts and stops mouselook, and SetMouselookOverrideBinding to assign MOVEFORWARD and MOVEBACKWARD to BUTTON1 and BUTTON2. Credits to slouken for this code.

```lua
-- Uses the 'z' button to activate mouselook instead of the mouse buttons,
-- and the mouse buttons to move forward and backward instead of mouselooking.
-- Credits to slouken for this code.
CreateFrame("Button", "MouselookButton")
MouselookButton:RegisterForClicks("AnyUp", "AnyDown")
MouselookButton:SetScript("OnClick", function (self, button, down)
  if ( down ) then
MouselookStart()
  else
MouselookStop()
  end
end)
SetOverrideBindingClick(MouselookButton, nil, "Z", "MouselookButton")
SetMouselookOverrideBinding("BUTTON1", "MOVEFORWARD")
SetMouselookOverrideBinding("BUTTON2", "MOVEBACKWARD")
```

--------------------------------

### StartAuction(minBid, buyoutPrice, runTime, stackSize, numStacks)

Source: https://web.archive.org/web/20100515165807/http://wowprogramming.com/docs/api/StartAuction

Creates an auction for the item currently in the 'auction item' slot. Requires an item to be placed in the Create Auction UI's 'auction item' slot first. With patch 3.3.3, runTime is an index and stackSize/numStacks were added for batch posting.

```APIDOC
## StartAuction(minBid, buyoutPrice, runTime, stackSize, numStacks)

### Description
Creates an auction for the item currently in the "auction item" slot. Has no effect unless an item has been placed in the Create Auction UI's "auction item" slot (see ClickAuctionSellItemButton()). With patch 3.3.3 the runTime arg was changed from minutes to an index and the stackSize/numStacks args were added for batch posting.

### Signature
`StartAuction(minBid, buyoutPrice, runTime, stackSize, numStacks)`

### Arguments
- `minBid` (number) - Minimum bid for the auction (in copper)
- `buyoutPrice` (number) - Buyout price for the auction (in copper)
- `runTime` (number) - Run time until the auction expires (an index indicating number of hours)
  - `1` - 12 hours
  - `2` - 24 hours
  - `3` - 48 hours
- `stackSize` (number) - Number of items to post in each auction
- `numStacks` (number) - Number of auctions (stacks) to post

### Examples
```
-- Place an item in the auction slot
PickupContainerItem(bag, slot)
ClickAuctionSellItemButton()
ClearCursor()

-- Create 4 auctions of 5 items each for 1g bid, 1g50s buyout, 
-- with a duration of 24 hours
StartAuction(10000, 15000, 2, 5, 4)
```
```

--------------------------------

### SetupFullscreenScale

Source: https://web.archive.org/web/20100726112636/http://wowprogramming.com/docs/api_categories

Sizes a frame to take up the entire screen regardless of screen resolution.

```APIDOC
## SetupFullscreenScale

### Description
Sizes a frame to take up the entire screen regardless of screen resolution.

### Method
Function

### Endpoint
SetupFullscreenScale(frame)

### Parameters
- **frame** (Frame) - Required - The frame to size.

### Returns
None
```

--------------------------------

### Print rank flags for the first rank in the guild

Source: https://web.archive.org/web/20111212153255/http://wowprogramming.com/docs/api/GuildControlGetRankFlags

This example defines a PrintFlags function that iterates over the returned flags, using the global variable GUILDCONTROL_OPTION..index to get the privilege name, and prints each flag. It then calls GuildControlSetRank(1) and PrintFlags(GuildControlGetRankFlags()) to display the flags for the first rank.

```lua
-- Print rank flags for the first rank in the guild
function PrintFlags(...)
  local output = ""
  for i = 1, select("#", ...) do
    output = output .. _G["GUILDCONTROL_OPTION"..i] .. ": " .. tostring(select(i, ...)) .. "; "
  end
  print(output)
end
GuildControlSetRank(1)
PrintFlags(GuildControlGetRankFlags())
```

--------------------------------

### ResetTutorials

Source: https://web.archive.org/web/20100726112636/http://wowprogramming.com/docs/api_categories

Enables contextual tutorial display and clears the list of already displayed tutorials.

```APIDOC
## ResetTutorials

### Description
Enables contextual tutorial display and clears the list of already displayed tutorials.

### Method
Function

### Endpoint
ResetTutorials()

### Parameters
None

### Returns
None
```

--------------------------------

### GetContainerFreeSlots usage example

Source: https://web.archive.org/web/20111212163217/http://wowprogramming.com/docs/api/GetContainerFreeSlots

Example showing how to call GetContainerFreeSlots with and without the returnTable argument, including the use of wipe() to clear the table before reuse.

```lua
-- assuming the first two rows of slots in your backpack are full...
local bagSpaces = GetContainerFreeSlots(0)
print(unpack(bagSpaces))
-- Chat window shows "9 10 11 12 13 14 15 16"

-- assuming all slots but the first in the bag immediately left of your backpack are full...
GetContainerFreeSlots(1, bagSpaces)
print(unpack(bagSpaces))
-- Chat window shows "1 10 11 12 13 14 15 16"
-- oops, it overwrote the table from before... let's try again
wipe(bagSpaces)
GetContainerFreeSlots(1, bagSpaces)
print(unpack(bagSpaces))
-- Chat window shows "1"
```

--------------------------------

### GetItemCount usage examples in Lua

Source: https://web.archive.org/web/20111212183956/http://wowprogramming.com/docs/api/GetItemCount

Three examples showing how to call GetItemCount: using an item link from GetItemInfo, counting bank items by subtracting counts, and counting charges with includeCharges set to true. The examples illustrate the function's behavior with different argument types and options.

```lua
_, link = GetItemInfo("Hearthstone")
GetItemCount(link)
-- nearly always returns 1 for most players
```

```lua
GetItemCount(34722, true) - GetItemCount(34722)
-- returns number of Heavy Frostweave Bandages in the player's bank (not counting those on hand)
```

```lua
GetItemCount("Drums of Speed", nil, true)
-- return of 99 could indicate player has two drums in inventory, one of which has been used only once
```

--------------------------------

### SetOverrideBindingSpell example with ClearOverrideBindings

Source: https://web.archive.org/web/20111212191043/http://wowprogramming.com/docs/api/SetOverrideBindingSpell

Sets an override binding for Shift-2 to cast Prayer of Mending, owned by PlayerFrame, then clears all override bindings for PlayerFrame. The example shows the usage of both functions together.

```lua
-- Set up Shift-2 to cast Prayer of Mending as an override binding
-- owned by PlayerFrame
SetOverrideBindingSpell(PlayerFrame, 1, "SHIFT-2", "Prayer of Mending")

-- Clear PlayerFrame's override bindings
ClearOverrideBindings(PlayerFrame)
```

--------------------------------

### FlagTutorial

Source: https://web.archive.org/web/20100726112636/http://wowprogramming.com/docs/api_categories

Marks a contextual tutorial as displayed so it doesn't appear again.

```APIDOC
## FlagTutorial

### Description
Marks a contextual tutorial as displayed so it doesn't appear again.

### Method
Function

### Endpoint
FlagTutorial(tutorialIndex)

### Parameters
- **tutorialIndex** (number) - Required - The index of the tutorial to flag.

### Returns
None
```

--------------------------------

### UnitGUID("unit")

Source: https://web.archive.org/web/20100819132501/http://wowprogramming.com/docs/api/UnitGUID

Returns the globally unique identifier (GUID) of the specified unit. The unit argument is a string representing a unit ID, and the function returns a string containing the GUID.

```APIDOC
## UnitGUID("unit")

### Description
Returns a unit's globally unique identifier.

### Signature
`guid` = `UnitGUID("unit")`

### Arguments
- `unit` (string, unitID) - A unit to query.

### Returns
- `guid` (string, guid) - The unit's GUID.
```

--------------------------------

### KBSetup_BeginLoading(numArticles, currentPage)

Source: https://web.archive.org/web/20100105214956/http://wowprogramming.com/docs/api/KBSetup_BeginLoading

Loads a maximum number of 'Top Issues' from a given page. The function takes the number of articles per page and the page number to display.

```APIDOC
## KBSetup_BeginLoading(numArticles, currentPage)

### Description
Loads a maximum number of "Top Issues" from a given page.

### Signature
`KBSetup_BeginLoading(numArticles, currentPage)`

### Arguments
- `numArticles` (number) - The number of articles displayed per page. This is typically the constant `KBASE_NUM_ARTICLES_PER_PAGE`.
- `currentPage` (number) - The page to display.

```

--------------------------------

### SetChannelOwner Example

Source: https://web.archive.org/web/20111212160054/http://wowprogramming.com/docs/api/SetChannelOwner

Gives channel ownership to another character. Has no effect unless the player is the owner of the given channel. The example transfers ownership of the channel "monkeys" to the character "Cladhaire".

```lua
-- Give "Cladhaire" ownership in the channel "monkeys"
SetChannelOwner("monkeys", "Cladhaire")
```

--------------------------------

### Lua example: Print subclasses for each item class

Source: https://web.archive.org/web/20100105230415/http://wowprogramming.com/docs/api/GetAuctionItemSubClasses

This example defines a function printSubClasses that iterates over item classes and prints each class name followed by its subclasses, using GetAuctionItemSubClasses. It is called with GetAuctionItemClasses() to list all classes.

```lua
-- prints a list of the subclasses for each item class
function printSubClasses(...)
  for class = 1, select("#", ...) do
    print(select(class, ...).. ":", strjoin(", ", GetAuctionItemSubClasses(class)))
  end
end
printSubClasses(GetAuctionItemClasses())
```

--------------------------------

### DownloadSettings

Source: https://web.archive.org/web/20100726112636/http://wowprogramming.com/docs/api_categories

Restores game settings from a backup stored on the server.

```APIDOC
## DownloadSettings

### Description
Restores game settings from a backup stored on the server.

```

--------------------------------

### debugstack(start, countTop, countBot)

Source: https://web.archive.org/web/20111212162925/http://wowprogramming.com/docs/api/debugstack

Returns a multi-line string describing the current function call stack. The start argument specifies the stack level to begin listing, and countTop/countBot limit the number of functions shown at the top and bottom of the trace.

```APIDOC
## debugstack(start, countTop, countBot)

### Description
Returns information about the current function call stack as a multi-line string.

### Signature
`debugstring` = `debugstack(start, countTop, countBot)`

### Arguments
- **start** (number) - Optional - Stack level at which to begin listing functions; 0 is the `debugstack()` function itself, 1 is the function that called `debugstack()`, 2 is the function that called function 1, etc. Defaults to 1 if omitted.
- **countTop** (number) - Optional - Maximum number of functions to output at the top of the stack trace.
- **countBot** (number) - Optional - Maximum number of functions to output at the bottom of the stack trace.

### Returns
- **debugstring** (string) - A multi-line string describing the current function call stack.

### Example
```lua
print(debugstack())
-- output:
[string "print(debugstack())"]:1: in main chunk
  [C]: in function `RunScript'
  Interface\FrameXML\ChatFrame.lua:1826: in function `?'
  Interface\FrameXML\ChatFrame.lua:3332: in function `ChatEdit_ParseText'
  Interface\FrameXML\ChatFrame.lua:3052: in function `ChatEdit_SendText'
  Interface\FrameXML\ChatFrame.lua:3073: in function 
  [C]: in function `ChatEdit_OnEnterPressed'
  [string "*:OnEnterPressed"]:1: in function <[string "*:OnEnterPressed"]:1>
```
```

--------------------------------

### MoveViewUpStart()

Source: https://web.archive.org/web/20111212170501/http://wowprogramming.com/docs/api/MoveViewUpStart

Begins orbiting the camera upward (to look down). This function is part of the World of Warcraft API and is used to control camera movement.

```APIDOC
## MoveViewUpStart()

### Description
Begins orbiting the camera upward (to look down).

### Signature
`MoveViewUpStart()`

### Parameters
None.

### Returns
None.

### Related Functions
See also [Camera functions](http://wowprogramming.com/docs/api_categories#camera).
```

--------------------------------

### Print buyback item links for first 12 slots

Source: https://web.archive.org/web/20111212164756/http://wowprogramming.com/docs/api/GetBuybackItemLink

Loops through indices 1 to 12, calls GetBuybackItemLink(i), and prints the link if the item exists. The index must be between 1 and GetNumBuybackItems().

```lua
-- Print item links for every item in the buyback tab
for i=1,12 do
  local link = GetBuybackItemLink(i)
  if link then
    print(link .. " is available for buyback")
  end
end
    
```

--------------------------------

### GetGlyphLink

Source: https://web.archive.org/web/20100726112636/http://wowprogramming.com/docs/api_categories

Gets a hyperlink for the contents of a glyph socket.

```APIDOC
## GetGlyphLink

### Description
Gets a hyperlink for the contents of a glyph socket.

### Method
Function

### Endpoint
GetGlyphLink()
```

--------------------------------

### StartAuction

Source: https://web.archive.org/web/20100726112636/http://wowprogramming.com/docs/api_categories

Creates an auction for the item currently in the "auction item" slot.

```APIDOC
## StartAuction

### Description
Creates an auction for the item currently in the "auction item" slot.

### Function
StartAuction()
```

--------------------------------

### GetItemStatDelta Example in Lua

Source: https://web.archive.org/web/20100105212227/http://wowprogramming.com/docs/api/GetItemStatDelta

Retrieves the stat delta between two items using GetItemStatDelta and prints each stat change. The example uses Valanar's Signet Ring and Keleseth's Signet Ring, and the output shows approximate values on enUS client.

```lua
-- links to some early death knight gear for illustrating the example...
local _, ring1Link = GetItemInfo("Valanar's Signet Ring")
local _, ring2Link = GetItemInfo("Keleseth's Signet Ring")

local statDelta = GetItemStatDelta(ring1Link, ring2Link)
for stat, value in pairs(statDelta) do print(value, _G[stat]) end
-- prints (approximately, on enUS client):
--   12 Critical Strike Rating
--   -6 Strength
--   -6 Hit Rating
--   3 Stamina
```

--------------------------------

### GetBuildInfo()

Source: https://web.archive.org/web/20100105224844/http://wowprogramming.com/docs/api/GetBuildInfo

Returns the version information about the client, including display version, internal version, build date, and UI version.

```APIDOC
## GetBuildInfo()

### Description
Returns the version information about the client.

### Signature
`version, internalVersion, date, uiVersion = GetBuildInfo()`

### Returns
- **version** (string) - Display version number of the client (e.g. `"3.1.1"`)
- **internalVersion** (string) - Internal version number of the client (e.g. `"9835"`)
- **date** (string) - Date on which the client executable was built (e.g. `"Apr 24 2009"`); not necessarily the date it was released to the public
- **uiVersion** (number) - Version compatibility number for UI purposes (e.g. `30100`); generally, installed addons should have this number in the `Interface` header of their TOC files to avoid being marked as Out of Date and possibly not loaded
```

--------------------------------

### VoiceChat_StartCapture

Source: https://web.archive.org/web/20100726112636/http://wowprogramming.com/docs/api_categories

Deprecated function that was used to start voice capture.

```APIDOC
## VoiceChat_StartCapture

### Description
This function is deprecated and should no longer be used.

### Method
Function

### Endpoint
VoiceChat_StartCapture()

### Parameters
None

### Response
No return value.
```

--------------------------------

### MoveViewOutStart()

Source: https://web.archive.org/web/20111212185205/http://wowprogramming.com/docs/api/MoveViewOutStart

Begins zooming the camera outward (away from the player character). This function is part of the World of Warcraft API.

```APIDOC
## MoveViewOutStart()

### Description
Begins zooming the camera outward (away from the player character).

### Signature
`MoveViewOutStart()`

### Parameters
None.

### Returns
None.

### See Also
[Camera functions](http://wowprogramming.com/docs/api_categories#camera)
```

--------------------------------

### MoveForwardStart

Source: https://web.archive.org/web/20100726112636/http://wowprogramming.com/docs/api_categories

Begins moving the player character forward. This function is protected.

```APIDOC
## MoveForwardStart

### Description
Begins moving the player character forward.

### Protection
Protected

```

--------------------------------

### ConfirmAcceptQuest

Source: https://web.archive.org/web/20100726112636/http://wowprogramming.com/docs/api_categories

Accepts a quest started by another group member.

```APIDOC
## ConfirmAcceptQuest

### Description
Accepts a quest started by another group member.

### Function
ConfirmAcceptQuest()
```

--------------------------------

### MoveViewUpStart

Source: https://web.archive.org/web/20100726112636/http://wowprogramming.com/docs/api_categories

Begins orbiting the camera upward (to look down).

```APIDOC
## MoveViewUpStart

### Description
Begins orbiting the camera upward (to look down).

### Method
Function Call

### Endpoint
MoveViewUpStart()

### Parameters
None documented.

### Response
No return value documented.
```

--------------------------------

### Lua example: Check if an item can go in a bag using GetItemFamily

Source: https://web.archive.org/web/20100816051611/http://wowprogramming.com/docs/api/GetItemFamily

This example defines a function CanGoInBag that uses GetItemFamily to determine if an item can be placed in a given bag. It handles containers by setting itemFamily to 0, and uses bit.band to compare item and bag families.

```lua
function CanGoInBag(item, bag)
   -- Get the item's family
   local itemFamily = GetItemFamily(item)
   
   -- If the item is a container, then the itemFamily should be 0
   local equipSlot = select(9, GetItemInfo(item))
   if equipSlot == "INVTYPE_BAG" then
      itemFamily = 0
   end

   -- Get the bag's family
   local bagFamily = select(2, GetContainerNumFreeSlots(bag))

   return bagFamily == 0 or bit.band(itemFamily, bagFamily) > 0
end
```

--------------------------------

### VehicleAimUpStart

Source: https://web.archive.org/web/20100726112636/http://wowprogramming.com/docs/api_categories

Starts adjusting vehicle aim upward. This function is protected.

```APIDOC
## VehicleAimUpStart

### Description
Starts adjusting vehicle aim upward. This function is protected.

### Method
Function call

### Endpoint
VehicleAimUpStart()

### Parameters
None documented.

### Response
No return value documented.
```

--------------------------------

### MoveViewLeftStart

Source: https://web.archive.org/web/20100726112636/http://wowprogramming.com/docs/api_categories

Begins orbiting the camera around the player character to the left.

```APIDOC
## MoveViewLeftStart

### Description
Begins orbiting the camera around the player character to the left.

### Method
Function Call

### Endpoint
MoveViewLeftStart()

### Parameters
None documented.

### Response
No return value documented.
```

--------------------------------

### KBQuery_BeginLoading

Source: https://web.archive.org/web/20111212162052/http://wowprogramming.com/docs/api/KBQuery_BeginLoading

Queries the knowledge base server for articles. The function takes a search string, category and subcategory indices, the number of articles per page, and the page number. Results are not immediately available.

```APIDOC
## KBQuery_BeginLoading

### Description
Queries the knowledge base server for articles. The function takes a search string, category and subcategory indices, the number of articles per page, and the page number. Results are not immediately available.

### Signature
`KBQuery_BeginLoading("searchText", categoryIndex, subcategoryIndex, numArticles, page)`

### Arguments
- `searchText` (string) - The search string to use. The empty string will search for all articles in the given category.
- `categoryIndex` (number) - The category index.
- `subcategoryIndex` (number) - The subcategory index.
- `numArticles` (number) - The number of articles to be returned for each page.
- `page` (number) - The page of the total results that should be displayed.

### Notes
This function must query the remote server, and any results will not be immediately available to the game client. Please see the function's documentation for more information about how to retrieve any results.
```

--------------------------------

### VehicleAimDownStart

Source: https://web.archive.org/web/20100726112636/http://wowprogramming.com/docs/api_categories

Starts adjusting vehicle aim downward. This function is protected.

```APIDOC
## VehicleAimDownStart

### Description
Starts adjusting vehicle aim downward. This function is protected.

### Flags
- protected
```

--------------------------------

### ToggleAutoRun

Source: https://web.archive.org/web/20100726112636/http://wowprogramming.com/docs/api_categories

Starts or stops the player character automatically moving forward.

```APIDOC
## ToggleAutoRun

### Description
Starts or stops the player character automatically moving forward.

### Method
Function

### Endpoint
ToggleAutoRun()

### Parameters
None

### Response
None
```

--------------------------------

### GetAchievementInfoFromCriteria

Source: https://web.archive.org/web/20100726112636/http://wowprogramming.com/docs/api_categories

Gets information about an achievement or statistic given a criterion ID.

```APIDOC
## GetAchievementInfoFromCriteria

### Description
Gets information about an achievement or statistic given a criterion ID.

### Function
GetAchievementInfoFromCriteria()

```

--------------------------------

### MoveViewOutStart

Source: https://web.archive.org/web/20100726112636/http://wowprogramming.com/docs/api_categories

Begins zooming the camera outward (away from the player character).

```APIDOC
## MoveViewOutStart

### Description
Begins zooming the camera outward (away from the player character).

### Method
Function Call

### Endpoint
MoveViewOutStart()

### Parameters
None documented.

### Response
No return value documented.
```

--------------------------------

### GetExistingLocales

Source: https://web.archive.org/web/20100726112636/http://wowprogramming.com/docs/api_categories

Returns a list of installed localization packs for the WoW client.

```APIDOC
## GetExistingLocales

### Description
Returns a list of installed localization packs for the WoW client.

```

--------------------------------

### KBSetup_GetCategoryData(index)

Source: https://web.archive.org/web/20100106002007/http://wowprogramming.com/docs/api/KBSetup_GetCategoryData

Returns information about a knowledge base category. The function takes an index and returns the category ID and name.

```APIDOC
## KBSetup_GetCategoryData(index)

### Description
Returns information about a knowledge base category.

### Signature
`categoryId, name = KBSetup_GetCategoryData(index)`

### Arguments
- `index` (number) - The index of the category.

### Returns
- `categoryId` (number) - The unique identifier for the given category.
- `name` (string) - The name of the category.
```

--------------------------------

### UploadSettings

Source: https://web.archive.org/web/20100726112636/http://wowprogramming.com/docs/api_categories

Stores a backup of game settings on the server.

```APIDOC
## UploadSettings

### Description
Stores a backup of game settings on the server.

```

--------------------------------

### OpeningCinematic()

Source: https://web.archive.org/web/20100106002526/http://wowprogramming.com/docs/api/OpeningCinematic

Displays the introductory cinematic for the player's race. Only has effect if the player has never gained any experience.

```APIDOC
## OpeningCinematic()

### Description
Displays the introductory cinematic for the player's race. Only has effect if the player has never gained any experience.

### Signature
`OpeningCinematic()`

```

--------------------------------

### CombatLogSetCurrentEntry(index [, ignoreFilter])

Source: https://web.archive.org/web/20100105215418/http://wowprogramming.com/docs/api/CombatLogSetCurrentEntry

Sets the cursor position used by other CombatLog functions. The index can be positive (starting from the oldest event) or negative (starting from the newest event). The ignoreFilter argument controls whether to use the entire saved combat log history or only events matching the current filter.

```APIDOC
## CombatLogSetCurrentEntry(index [, ignoreFilter])

### Description
Sets the "cursor" position used by other CombatLog functions. Information about the entry at the "cursor" position can be retrieved with CombatLogGetCurrentEntry(). That function then advances the cursor to the next entry, so calling it repeatedly returns all information in the combat log -- this function can be used to "rewind" the combat log to retrieve information about earlier events.

### Signature
`CombatLogSetCurrentEntry(index [, ignoreFilter])`

### Arguments
- **index** (number) - Index of a combat log event (between 1 and CombatLogGetNumEntries(ignoreFilter), or between -1 and -CombatLogGetNumEntries(ignoreFilter)). Positive indices start at the beginning of the combat log (oldest events) and count up to the end (newest events); negative indices start at -1 for the newest event and count backwards to -CombatLogGetNumEntries(ignoreFilter) for the oldest.
- **ignoreFilter** (boolean) - True to use the entire saved combat log history; false or omitted to use only events matching the current filter.
```

--------------------------------

### KBSystem_GetServerNotice()

Source: https://web.archive.org/web/20111212164528/http://wowprogramming.com/docs/api/KBSystem_GetServerNotice

Returns the text of the knowledge base server system notice. This function takes no arguments and returns a string.

```APIDOC
## KBSystem_GetServerNotice()

### Description
Returns the text of the knowledge base server system notice.

### Signature
`text` = `KBSystem_GetServerNotice()`

### Parameters
None.

### Returns
- `text` (string) - The text of the knowledgebase system server notice.

```

--------------------------------

### MoveViewInStart

Source: https://web.archive.org/web/20100726112636/http://wowprogramming.com/docs/api_categories

Begins zooming the camera inward (towards/through the player character).

```APIDOC
## MoveViewInStart

### Description
Begins zooming the camera inward (towards/through the player character).

### Method
Function Call

### Endpoint
MoveViewInStart()

### Parameters
None documented.

### Response
No return value documented.
```

--------------------------------

### VoicePushToTalkStart

Source: https://web.archive.org/web/20100726112636/http://wowprogramming.com/docs/api_categories

Deprecated function used internally to start talking when push-to-talk is active.

```APIDOC
## VoicePushToTalkStart

### Description
Used internally to start talking, when push-to-talk is active in voice chat. This function is deprecated and should no longer be used.

### Method
Function

### Endpoint
VoicePushToTalkStart()

### Parameters
None

### Response
No return value.
```

--------------------------------

### SetLFGRoles example with GetLFGRoles output

Source: https://web.archive.org/web/20100701210115/http://wowprogramming.com/docs/api/SetLFGRoles

Shows how to call SetLFGRoles with all roles true, then GetLFGRoles to verify. On a priest, healing is supported but tanking is not, so the result is true,false,true,true. On a warrior, tanking is supported but healing is not, so the result is true,true,false,true.

```lua
SetLFGRoles(true,true,true,true)
GetLFGRoles()
-- on a priest: returns true,false,true,true
-- on a warrior: returns true,true,false,true
```
Tokens:
Raw