Functions Global

From WoWDev

Contents 1 Global Function Groups 1.1 Action Functions 1.2 Activity Functions 1.3 AddOn Functions 1.4 Auction Functions 1.5 Bank Functions 1.6 Battlefield Functions 1.7 Buff/Debuff Functions 1.8 Camera Functions 1.9 Channel Functions 1.10 Character Functions 1.11 Chat Functions 1.12 Communication Functions 1.13 Container/Bag Functions 1.14 Crafting Functions 1.15 Cursor Functions 1.16 Debugging Functions 1.17 Disabled Functions 1.18 Dressing Room Functions 1.19 Enchanting Functions 1.20 Faction Functions 1.21 Friend Functions 1.22 GM Functions 1.23 Gossip Functions 1.24 Group Functions 1.25 Guild Functions 1.26 Honor Functions 1.27 Ignore Functions 1.28 Inspection Functions 1.29 Instance Functions 1.30 Inventory Functions 1.31 Item Functions 1.32 Item Text Functions 1.33 Key Binding Functions 1.34 LUA Functions 1.35 Location Functions 1.36 Loot Functions 1.37 Macro Functions 1.38 Mail Functions 1.39 Mapping Functions 1.40 Math Functions 1.41 Meeting Stone Functions 1.42 Merchant Functions 1.43 Movement Functions 1.44 Pet Functions 1.45 Petition Functions 1.46 Quest Functions 1.47 Raid Functions 1.48 Settings Functions 1.49 Skill Functions 1.50 Spell Functions 1.51 String Functions 1.52 System Functions 1.53 Table Functions 1.54 Talent Functions 1.55 Targetting Functions 1.56 Taxi Functions 1.57 Toggle Functions 1.58 TradeSkill Functions 1.59 Trading Functions 1.60 Training Functions 1.61 Unit Functions 1.62 Who Functions 1.63 UI Provided Functions 1.64 Removed Functions 1.65 Unknown Functions 2 Widget Specific Functions 3 User Defined Functions

Global Function Groups

Here is a complete list of all global functions: Global Function List. If a function on that list is missing from this page, it's because no-one has added it yet. If you add a new entry, please base it on the Empty Template.

Action Functions

These functions are those which operate with the action buttons (General player actions are likely in the Activity Functions section below).

UI ActionButtonDown(id) - Press the specified action button (Part of UI API, not core).

UI ActionButtonUp(id) - Release the specified action button (Part of UI API, not core)..

UI BonusActionButtonDown - Trigger the specified bonus(pet or minion) action button. (Part of UI API, not core).

UI BonusActionButtonUp - Release the specified bonus(pet or minion) action button. (Part of UI API, not core).

CameraOrSelectOrMoveStart() - Begin "Left click" in the 3D world.

CameraOrSelectOrMoveStop([stickyFlag]) - End "Left click" in the 3D world.

ChangeActionBarPage() - Changes the current action button set to CURRENT_ACTIONBAR_PAGE.

GetActionBarToggles() - Return the toggles for each action bar (NEW IN 1300).

GetActionCooldown(slot) - This returns the cooldown values of the specified action..

GetActionCount(slot) - Get the count (bandage/potion/etc) for an action, returns 0 if none or not applicable.

GetActionText(slot) - Get the text label (macros, etc) for an action, returns nil if none.

GetActionTexture(slot) - Gets the texture path for the specified action.

GetBonusBarOffset() - Determine which page of bonus actions to show.

HasAction(slot) - Returns 1 if the player has an action in the specified slot, nil otherwise.

IsActionInRange(slot) - Test if an action is in range (1=yes, 0=no, nil=not applicable).

IsAttackAction(slot) - Return 1 if an action is an 'attack' action (flashes during combat), nil otherwise.

IsAutoRepeatAction(slot) - Return 1 if an action is auto-repeating, nil otherwise.

IsCurrentAction(slot) - Return 1 if an action is the one currently underway, nil otherwise.

IsUsableAction(slot) - Return 1 if an action can be used at present, nil otherwise.

IsConsumableAction(slot) - Return 1 if an action is consumable (i.e. has a count), nil otherwise.

IsEquippedAction(slot) - Return 1 if an action is equipped (i.e. connected to an item that must be equipped), nil otherwise.

PetHasActionBar() - Determine if player has a pet with an action bar.

PickupAction(slot) - Drags an action out of the specified quickbar slot and holds it on the cursor.

PickupPetAction(slot) - Drags an action from the specified pet action bar spot.

PlaceAction(slot) - Drops an action from the cursor into the specified quickbar slot.

SetActionBarToggles(show1,show2,show3,show4) - Set show toggle for each action bar (NEW IN 1300)

TurnOrActionStart() - Begin "Right Click" in the 3D world.

TurnOrActionStop() - End "Right Click" in the 3D world.

UseAction(slot, {checkCursor {,onSelf} } - This instructs the interface to use the action associated with the specified ID, optionally on the player (regardless of target).

Activity Functions

This section is for functions which make the player do something (and which aren't covered elsewhere, and which aren't simply confirmation steps)

AcceptDuel() - The player accepts the challenge to duel.

AttackTarget() - Attacks the targetted unit.

CancelDuel() - Refuse the invitation to fight a duel.

CancelLogout()

CancelMeetingStoneRequest()

ClearTutorials()

ConfirmSummon()

REMOVED Duel() - Duels a specified user by name. (No longer valid -- 14:38, 1 Jan 2005 (EST))

REMOVED EnablePVP() - Enable PVP Status (Removed in 1.4.0 patch -- 23:12, 19 Apr 2005 (EDT))

FlagTutorial("tutotial")

ForceLogout()

ForceQuit()

GetSummonConfirmAreaName()

GetSummonConfirmSummoner()

GetSummonConfirmTimeLeft()

Logout - Logs the user out of the game.

Quit - Quits the application, NOT the LUA script.

RandomRoll(low, high) - Does a random roll between the two values.

SitOrStand() - The player sits or stands.

StartDuel("name") - Challenge someone to a duel (by name)

StartDuelUnit("unit") - Challenge a unit to a duel.

TogglePVP() - Toggles PVP Status

ToggleSheath() - Toggles sheathed or unsheathed weapons.

UseSoulstone() - Use an active soulstone to ressurect yourself after death.

AddOn Functions

DisableAddOn(index or "AddonName") - Disable the specified AddOn for subsequent sessions.

DisableAllAddOns() - Disable all AddOns for subsequent sessions.

EnableAddOn(index or "AddonName") - Enable the specified AddOn for subsequent sessions.

EnableAllAddOns() - Enable all AddOns for subsequent sessions.

GetAddOnDependencies(index or "AddonName") - Get dependency list for an AddOn.

GetAddOnInfo(index or "AddonName") - Get information about an AddOn.

GetNumAddOns() - Get the number of user supplied AddOns.

IsAddOnLoaded(index or "AddonName") - Test whether an AddOn was loaded.

IsAddOnLoadOnDemand(index or "AddonName") - Test whether an AddOn is load-on-demand.

LoadAddOn(index or "AddonName") - Request loading of an On-Demand AddOn.

ResetDisabledAddOns() -

Auction Functions

CalculateAuctionDeposit(runTime) - Returns the required deposit for the current selling item given the specified duration (minutes).

CanSendAuctionQuery() - Return 1 if auction search button would be active, nil otherwise.

CancelAuction(index) - Cancel the specified auction (on the "owner" list).

ClickAuctionSellItemButton() - Puts the currently 'picked up' item into the 'create auction' slot.

CloseAuctionHouse() - Will close the AuctionFrame if opened.

GetAuctionHouseDepositRate() - Returns the deposit rate (percentage) for the currently open auction house (Possibly out-dated by CalculateAuctionDeposit).

GetAuctionInvTypes(classIndex, subclassIndex) - Returns types of subcategories items.

GetAuctionItemClasses() - Returns major auction item categories.

GetAuctionItemInfo("type", index) - Returns details about the specified auction item.

GetAuctionItemLink("type", index) - Returns a link string for the specified auction item.

GetAuctionItemSubClasses(classIndex) - Returns subcategories in the nth auction category.

GetAuctionItemTimeLeft("type", index) - Returns the time left status of the specified auction item.

GetAuctionSellItemInfo() - Returns information about the current selling item (or nil if none selected).

GetBidderAuctionItems({page}) - ?.

GetNumAuctionItems("type") - Returns the size of the specified auction item list.

GetOwnerAuctionItems({page}) - ?.

GetSelectedAuctionItem("type") - Returns the index (1-50) of the selected auction item or 0 if none is selected.

IsAuctionSortReversed("type", "sort") - Returns 1 if the specified auction list and sort is reversed, nil otherwise.

PlaceAuctionBid("type", index, bid) - Place a bid on the selected auction item.

QueryAuctionItems("name", minLevel, maxLevel, invTypeIndex, classIndex, subclassIndex, page, isUsable, qualityIndex) - ?.

SetSelectedAuctionItem("type", index) - ?.

SortAuctionItems("type", "sort") - Request that the specified auction list be sorted by a specific column.

StartAuction(minBid, buyoutPrice, runTime) - Starts the auction you have created in the Create Auction panel.

AuctionFrameAuctions.duration - Set the amount of time the auction will run for in minutes.

Bank Functions

BankButtonIDToInvSlotID - Returns the ID number of a bank button in terms of inventory slot ID.

CloseBankFrame() - Close the bank frame if it's open. --Ramble

GetBankSlotCost(numSlots) - Returns the cost of the next bank slot. --Ramble

GetNumBankSlots() - Returns total purchased bank bag slots, and a flag indicating if it's full. --Ramble

PurchaseSlot()

Battlefield Functions

AcceptAreaSpiritHeal() - Accept a spirit heal.

CancelAreaSpiritHeal() - Cancel a spirit heal.

CanJoinBattlefieldAsGroup() - returns nil if the player can not do a group join for a battlefield.

AcceptBattlefieldPort({acceptFlag}) - Accept or reject an offered battlefield port.

CheckSpiritHealerDist()

CloseBattlefield() - ?.

GetAreaSpiritHealerTime() - Returns the time left until the next resurrection by the Sprit Guide.

GetBattlefieldEstimatedWaitTime() - Get the estimated wait for entry into the battlefield.

GetBattlefieldFlagPosition(index) - ?.

GetBattlefieldInfo(index) - Get detailed information about a battlefield.

GetBattlefieldInstanceExpiration() - Get shutdown timer for the battlefield instance.

GetBattlefieldInstanceInfo(index) - Get the instance ID for a battlefield.

GetBattlefieldInstanceRunTime - ?.

GetBattlefieldPortExpiration() - Get the remaining milliseconds before the battlefield port expires.

GetBattlefieldPosition(index) - Get the map position and name of a player in the battleground not in your raid.

GetBattlefieldScore(index) - Get information about a player

GetBattlefieldStatData() -

GetBattlefieldStatInfo() -

GetBattlefieldStatus() - Get the battlefield's current status.

GetBattlefieldTimeWaited() - Get time waited in queue in milliseconds.

GetBattlefieldWinner() -

GetBattlefieldWorldStateUIInfo(i) - Get score and flag status within a battlefield.

GetNumBattlefieldFlagPositions - ?.

GetNumBattlefieldPositions() - Get the number of positions available from GetBattlefieldPosition().

GetNumBattlefieldScores() - ?.

GetNumBattlefieldStats() - ?

GetNumBattlefieldStateUI() - ?

GetNumBattlefields() - ?.

GetNumWorldStateUI() - ?

GetSelectedBattlefield() - ?.

GetWorldStateUIInfo(i) - Get score and flag status within a battlefield.

JoinBattlefield(index) - ?.

LeaveBattlefield() - ?.

RequestBattlefieldPositions() - ?.

RequestBattlefieldScoreData() - ?.

SetBattlefieldScoreFaction() - ?.

SetSelectedBattlefield(index) - ?.

ShowBattlefieldList() - Request list of available battlefields.

ToggleBattlefieldMinimap() - Toggles the Battlefield Minimap.

Buff/Debuff Functions

CancelPlayerBuff(buffIndex) - Removes a specific buff from the player.

CancelTrackingBuff() - Cancels your current tracking buff (Find Minerals etc.)

GetPlayerBuff - Retrieves info about a certain effect (beneficial, harmful or passive)

GetPlayerBuffTexture - Retrieves the texture identifier for a certain buff

GetPlayerBuffTimeLeft - Retrieves how long a buff will last before expiring

GetWeaponEnchantInfo() - Return information about main and offhand weapon enchantments.

UnitBuff("unit", index) - Retrieves info about a buff of a certain unit.

UnitDebuff("unit", index) - Retrieves info about a debuff of a certain unit.

GetPlayerBuffApplications(index) - Retrieves the number of applications of a debuff.

Camera Functions

CameraOrSelectOrMoveStart - ?.

CameraOrSelectOrMoveStop - ?.

CameraZoomIn - ?.

CameraZoomOut - ?.

FlipCameraYaw - ?.

MoveViewDownStart - ?.

MoveViewDownStop - ?.

MoveViewInStart - ?.

MoveViewInStop - ?.

MoveViewLeftStart - ?.

MoveViewLeftStop - ?.

MoveViewOutStart - ?.

MoveViewOutStop - ?.

MoveViewRightStart - ?.

MoveViewRightStop - ?.

MoveViewUpStart - ?.

MoveViewUpStop - ?.

NextView - ?.

PitchDownStart - ?.

PitchDownStop - ?.

PitchUpStart - ?.

PitchUpStop - ?.

PrevView - ?.

ResetView - ?.

SaveView - ?.

SetView - ?.

Channel Functions

These are chat functions which are specific to channels. Also see the Chat Functions and Communication Functions sections.

AddChatWindowChannel(chatFrameIndex, "channel") - Make a chat channel visible in a specific ChatFrame.

ChannelBan("channel", "name") - Bans a player from the specified channel.

ChannelInvite("channel", "name") - Invites the specified user to the channel.

ChannelKick("channel", "name") - Kicks the specified user from the channel.

ChannelModerate("channel") - ?.

ChannelModerator("channel", "name") - Sets the specified player as the channel moderator.

ChannelMute("channel", "name") - Turns off the specified player's ability to speak in a channel.

ChannelToggleAnnouncements("channel") - Toggles the channel to display announcements either on or off.

ChannelUnban("channel", "name") - Unbans a player from a channel.

ChannelUnmoderator("channel", "name") - Takes the specified user away from the moderator status.

ChannelUnmute("channel", "name") - Unmutes the specified user from the channel.

DisplayChannelOwner("channel") - Displays the owner of the specified channel in the default chat.

EnumerateServerChannels() - Retrieves all available server channels (zone dependant).

GetChannelList() - Retrieves joined channels.

GetChannelName("channel" or index) - Retrieves the name from a specific channel.

GetChatWindowChannels(index) - Get the chat channels received by a chat window.

JoinChannelByName("channel"{,"password"{,frameId}}) - Join the specified chat channel (with optional password, and register for specified frame) (updated in 1.9)

LeaveChannelByName("channel") - Leaves the channel with the specified name.

ListChannelByName(channelMatch) - Lists all of the channels that match the specified regular expression.

ListChannels() - Lists all of the channels into the chat window.

RemoveChatWindowChannel(chatFrameIndex, "channel") - Make a chat channel invisible (hidden) in a specific ChatFrame.

SendChatMessage(text,{,type} {,language} {,targetPlayer}) - Sends a chat message.

SetChannelOwner("channel", "name") - Sets the channel owner.

SetChannelPassword("channel", "password") - Changes the password of the current channel.

Character Functions

AbandonSkill - The player abandons a skill.

AcceptResurrect - The player accepts the request from another player to resurrect him/herself.

AcceptSkillUps()

AcceptXPLoss - Accept the XP loss to be reborn where you stand (The name is somewhat of a misnomer, since it's now durability rather than XP that is lost).

AddSkillUp(index)

BuySkillTier(index)

CancelSkillUps()

CheckBinderDist() - Check wether the player is close enough to interact with the Hearthstone binder.

ConfirmBinder() - Confirm the request to set the binding of the player's Hearthstone.

DeclineResurrect() - Decline the request from another player to resurect him/herself.

GetBindLocation() - Get the name of the location for your Hearthstone.

GetBlockChance() - Returns the player's percentage block chance.

GetComboPoints() - Get the current number of combo points.

GetCorpseRecoveryDelay()

GetDamageBonusStat() - returns index of which stat a player receives a damage bonus from increasing

GetDodgeChance() - Returns the player's percentage dodge chance.

GetMoney()

GetParryChance() - Returns the player's percentage parry chance.

GetReleaseTimeRemaining() - Returns the amount of time left before your ghost is pulled from your body.

GetResSicknessDuration()

GetRestState()

GetTimeToWellRested()

GetXPExhaustion()

HasFullControl()

HasSoulstone()

IsResting()

NotWhileDeadError - Generates an error message saying you cannot do that while dead.

RemoveSkillUp(index)

ResurrectHasSickness()

RessurectHasTimes() - ? (NEW IN 1300)

RetrieveCorpse() - Resurrects when near corpse. e.g., The "Accept" button one sees after running back to your body. -- Taedirk

SetSelectedSkill(index)

Chat Functions

These are functions which are specific to chat window management. Also see the Channel Functions and Communication Functions sections.

AddChatWindowChannel(chatFrameIndex, "channel") - Make a chat channel visible in a specific ChatFrame.

AddChatWindowMessages - Adds a messaging group to the specified chat window.

ChangeChatColor(chatType,r,g,b) - Update the color for a type of chat message.

ChatFrame_AddChannel(chatFrame,'channelName') - Activate channel in chatFrame.

ChatFrameLog() - Obsolete (1.7) -Alco

ChatFrame_OnHyperlinkShow(reference, link, button) - called when the user clicks on a chatlink.

GetChatTypeIndex(type) - Get the numeric ID of a type of chat message.

GetChatWindowChannels(index) - Get the chat channels received by a chat window.

GetChatWindowInfo(index) - Get setup information about a chat window.

GetChatWindowMessages(index) - Get the chat message types received by a chat window.

JoinChannelByName("channel"{,"password"{,frameId}}) - Join the specified chat channel (with optional password, and register for specified frame)

LoggingChat(newState) - Gets or sets whether logging chat to Logs\WoWChatLog.txt is enabled.

LoggingCombat(newState) - Gets or sets whether logging combat to Logs\WoWCombatLog.txt is enabled.

RemoveChatWindowChannel(chatFrameIndex, "channel") - Make a chat channel invisible (hidden) in a specific ChatFrame.

RemoveChatWindowMessages(chatFrameIndex,"messageGroup") - Remove a set of chat messages from this window.

SetChatWindowAlpha(index,alpha) - Sets the Alpha value(transparency) of ChatFrame<index>

SetChatWindowColor(index,r,g,b) - Sets the background color of a a chat window.

SetChatWindowDocked(index,docked) - Set whether a chat window is docked.

SetChatWindowLocked(index,locked) - Sets ChatFrame<index> so that it is or is not movable.

SetChatWindowName(index,"name") - Sets the name of ChatFrame<index> to <"name">.

SetChatWindowShown(index,shown) - Shows or Hides ChatFrame<index> depending on value of <shown>

SetChatWindowSize(index,size) - Sets the font size of a chat window.

Communication Functions

These are the functions which communicate with other players. Also see the Channel Functions and Chat Functions sections.

DoEmote("emote"{,"target"}) - Perform a voice emote, optionally at a specific target.

GetDefaultLanguage("unit") - Returns the default language that the unit is speaking after logon.

GetLanguageByIndex(index) - Returns the language specified by the index.

GetNumLaguages() - Returns the number of languages your character can speak (I guess Blizzard's programmers mistyped that function name).

REMOVED PlayVocalCategory("category") - REMOVED IN 1300 -- 16:43, 22 Mar 2005 (EST)

RandomRoll(low, high) - Does a random roll between the two values.

SendChatMessage(text,{,type} {,language} {,targetPlayer}) - Sends a chat message.

Container/Bag Functions

These functions manage containers (bags, backpack). See also Inventory Functions and Bank Functions.

ContainerIDToInventoryID(containedID)

GetBagName(index) - Get the name of one of the player's bags.

GetContainerItemCooldown(index,slot)

GetContainerItemInfo(index,slot) - Get the info for an item in one of the player's bags.

GetContainerItemLink(index,slot)

GetContainerNumSlots(index) - Gives you the number of slots available in the bag specified by the index.

PickupBagFromSlot(slot)

PickupContainerItem(index,slot)

PutItemInBackpack()

PutItemInBag(inventoryId)

SetBagPortaitTexture(texture,slot)

SplitContainerItem(index,slot,amount)

UI ToggleBackpack - Toggles your backpack open/closed.

UI ToggleBag - Opens or closes the specified bag.

UseContainerItem(bag,slot) - Uses an item located in bag# and slot#. (Warning: If a vendor window is open, using items in your pack may sell them!)

Crafting Functions

These superseded the older crafting functions for all skills, but enchanting and the hunters train-pet-window (for the other skills see TradeSkill Functions). Most functions only work if the window for enchants is opened in the GUI. You can check whether the window is opened by using GetCraftSkillLine().

CloseCraft()

CollapseCraftSkillLine(index)

DoCraft(index)

ExpandCraftSkillLine(index)

GetCraftButtonToken()

GetCraftDescription(index)

GetCraftDisplaySkillLine()

GetCraftIcon(index)

GetCraftInfo(index)

GetCraftItemLink(index)

GetCraftName()

GetCraftNumReagents(index)

GetCraftReagentInfo(index,reagentIndex)

GetCraftReagentItemLink(index,reagentIndex)

GetCraftSelectionIndex()

GetCraftSkillLine()

GetCraftSpellFocus - ?.

GetNumCrafts()

SelectCraft(index)

Cursor Functions

AutoEquipCursorItem() - Causes the equipment on the cursor to be equipped.

CursorCanGoInSlot(slot) - Return true if cursor item can go into inventory slot

CursorHasItem() - Returns true if the cursor currently holds an item

CursorHasMoney() - true/false

CursorHasSpell() - true/false

DeleteCursorItem()

DropCursorMoney - Drops the amount of money held by the cursor.

DropItemOnUnit("unit") - Drops an item from the cursor onto a unit.

EquipCursorItem(x)

GetCursorMoney - Returns the amount of money held by the cursor.

GetCursorPosition() - Get the cursor location on the screen

HideRepairCursor()

InRepairMode()

PickupAction(slot) - Drags an action out of the specified quickbar slot and holds it on the cursor.

PickupBagFromSlot(slot)

PickupContainerItem(index,slot)

PickupInventoryItem(index)

PickupMacro(index) - Pickup a macro button icon.

PickupMerchantItem(index) - Places the item on the cursor.

PickupPetAction(index) - ?.

PickupPlayerMoney - Picks up an amount of money from the player.

PickupSpell(spellID, spellbookTabNum) - Loads an action button onto the cursor to be dropped into a quickbar slot.

PickupStablePet(index) - ?.

PickupTradeMoney(amount)

PlaceAction(slot) - Drops an action from the cursor into the specified quickbar slot.

PutItemInBackpack()

PutItemInBag(inventoryId)

ResetCursor()

SetCursor("cursor")

ShowContainerSellCursor(index,slot)

ShowInspectCursor() - Change the cursor to the magnifying glass inventory inspection cursor

ShowInventorySellCursor() - ?.

ShowMerchantSellCursor(index) - Changes the cursor to the merchant sell cursor.

ShowRepairCursor()

Debugging Functions

debugprofilestart() - starts a timer for profiling during debugging.

debugprofilestop() - return the time in milliseconds since the last call to debugprofilestart()

FrameXML_Debug(flag) - Sets FrameXML logging state which is output to /WoW Folder/Logs/FrameXML.log

GetDebugStats()

Disabled Functions

These functions are present but have been disabled entirely.

AppendToFile - ?.

DeleteFile() - ?

ReadFile() - ?.

Dressing Room Functions

Functions Controling the Dressing Room interface. NEW in 1700.

Hope noone minds me adding this -- Judeas

Hope noone minds me adding two interpretations -- Untitleder

DressUpItem("item") - - Given an Item will show the DressingRoom UI with the item equiped.

DressUpItemLink("itemlink") - Given an ItemLink will show the DressingRoom UI with the item equiped.

SetDressUpBackground(isAuctionFrame) - Given an Item shown in the Auction House will show the DressingRoom UI with the item equiped.

Enchanting Functions

GetWeaponEnchantInfo() - Return information about main and offhand weapon enchantments.

ReplaceEnchant()

ReplaceTradeEnchant() - Confirm the replacement of an enchantment via trade.

BindEnchant() - Confirm the binding of the item when enchanting.

Faction Functions

CollapseFactionHeader(index) - Collapse a faction header row.

ExpandFactionHeader(index) - Expand a faction header row.

FactionToggleAtWar(index) - Toggle the At War flag for a faction.

GetFactionInfo(index) - Gets details for a specific faction/faction header.

GetNumFactions() - Returns the number of lines in the faction display.

UnitFactionGroup("unit") - Returns the faction group id and name of the specified unit. (eg. "Alliance") - string returned is localization-independent (used in filepath) -~~

Friend Functions

AddFriend("playerName") - Add a friend to your friend list.

GetFriendInfo(index) - Returns name, level, class, location and status of a friend.

GetNumFriends() - Returns how many friends are on your friend list.

GetSelectedFriend() - Returns the index of the current selected friend.

RemoveFriend("name" or index) - Removes a friend from your friend list

SetSelectedFriend(index) - Update the current selected friend.

ShowFriends() - Request updated friends information from server.

UI ToggleFriendsFrame({tabNumber} - Opens/closes the friends pane (possibly on a specific tab).

GM Functions

DeleteGMTicket()

GMRequestPlayerInfo() - access denied (darn)

GetGMStatus()

GetGMTicket()

GetGMTicketCategories()

NewGMTicket(type,"text")

REMOVED ReportBug("text") - REMOVED IN 1300 --

REMOVED ReportNote("text") - REMOVED IN 1300 --

REMOVED ReportSuggestion("text","category") - REMOVED IN 1300 --

SECURE Stuck - Informs the game engine that the player is Stuck.

UpdateGMTicket(type,"text")

Gossip Functions

CloseGossip() - Dismiss the gossip window.

GetGossipActiveQuests() - Retrieves a list of the active (?) quests on the NPC you are talking to.

GetGossipAvailableQuests() - Retrieves a list of the available (!) quests on the NPC you are talking to.

GetGossipOptions() - Retrieves a list of the available gossip items on the NPC you are talking to.

GetGossipText() - Retrieves the gossip text.

SelectGossipActiveQuest(index) - Selects an active quest.

SelectGossipAvailableQuest(index) - Selects on an available quest.

SelectGossipOption(index) - Selects on a gossip item.

Group Functions

AcceptGroup() - Accept the invitation to party.

ConvertToRaid() - Converts party to raid.

DeclineGroup() - Decline the invitation to a party.

GetLookingForGroup()

GetLootMethod() - Return the currently active loot method

GetLootThreshold() - Return the current loot threshold (for group loot)

GetMasterLootCandidate() - Return the player who receives loot in master mode

GetNumPartyMembers() - Returns the number of party members

GetPartyLeaderIndex()

GetPartyMember(id) - Returns the index of the party member at the given index if that party slot is filled, otherwise nil.

InviteByName("name") - Invites the specified player to the group sender is currently in.

InviteToParty("unit") - Invite a unit to a party.

IsPartyLeader() - Returns true if the player is the party leader.

LeaveParty() - Quit the party.

PromoteByName("name") - Promotes by name the target.

PromoteToPartyLeader("unit") - Promote a unit to party leader.

SetLookingForGroup(flag)

SetLootMethod("method"{,"masterPlayer" or ,threshold}) - Set the current loot method

SetLootThreshold(threshold) - Set the threshold for group loot

UninviteByName("name") - Uninvites (kicks) the target from the current group if player is group leader.

UninviteFromParty("unit") - Kick a unit from the party if player is group leader.

UnitInParty("unit") - Returns true if the unit is a member of your party.

UnitIsPartyLeader("unit") - Returns true if the unit is the leader of its party.

Guild Functions

AcceptGuild() - The player accepts the invitation to join a guild.

BuyGuildCharter("guildName") - Purchases a guild charter for guildName.

CanEditMOTD() - Returns true if you are allowed to edit the guild motd.

CanEditOfficerNote() - Returns true if you are allowed to edit a guild member's officer note.

CanEditPublicNote() - Returns true if you are allowed to edit a guild member's public note.

CanGuildDemote() - Returns true if you are allowed to demote a guild member.

CanGuildInvite() - Returns true if you are allowed to invite a new member to the guild.

CanGuildPromote() - ?.

CanGuildRemove() - ?.

CanViewOfficerNote() - ?.

CloseGuildRegistrar() - ?.

CloseGuildRoster() - ?.

CloseTabardCreation()

DeclineGuild() - ?.

GetGuildCharterCost() - Returns the cost of purchasing a guild charter.

GetGuildInfo("unit") - This function returns the name of the guild unit belongs to.

GetGuildInfoText() - Returns the persistant Guild Information data. (new in 1.9)

GetGuildRosterInfo(index) - This function is used to get info on members in the guild.

GetGuildRosterLastOnline(index) - Returns time since last online for indexth member in current sort order.

GetGuildRosterMOTD() - Returs guild's MOTD.

GetGuildRosterSelection() - Returns the index of the current selected guild member.

GetGuildRosterShowOffline() - Returns true if showing offline members of the guild.

GetNumGuildMembers(offline) - Returns the number of guild members total.

GetTabardCreationCost() - Returns cost in coppers.

GetTabardInfo() -?.

GuildControlAddRank("name") - Add another rank called "name". Only Guildmaster?

GuildControlDelRank - Delete rank? Only Guildmaster?

GuildControlGetNumRanks() - Returns number of ranks after guild frame open. Any guild member can use this.

GuildControlGetRankFlags() - Returns list of values for each permission for your rank.

GuildControlGetRankName(index) - Returns name of the rank. Any guild member can use this.

GuildControlSaveRank("name") - Only Guildmaster?

GuildControlSetRank(rank) - ?.

GuildControlSetRankFlag(index, enabled) - Enable/disable permission for some action.

GuildDemoteByName("name") - ?.

GuildDisband() - ?.

GuildInfo() - Displays information about the guild you are a member of.

GuildInviteByName("name") - ?.

GuildLeave() - Removes you from your current guild.

GuildPromoteByName("name") - ?.

GuildRoster() - Fetches the guild list and fires a GUILD_ROSTER_UPDATE event.

GuildRosterSetOfficerNote(index, "note") - ?.

GuildRosterSetPublicNote(index, "note") - ?.

GuildSetLeaderByName("name") - ?.

GuildSetMOTD("note") - ?.

GuildUninviteByName("name") - ?.

IsGuildLeader() - ?.

IsInGuild() - Lets you know whether you are in a guild.

SetGuildInfoText() - Sets the persistant Guild Information data. (new in 1.9)

SetGuildRosterSelection(index) - Selects/deselects a guild member according current sorting order.

SetGuildRosterShowOffline(enabled) - Sets/Resets the show offline members flag.

SortGuildRoster("sort") - Sorts guildroster according "sort". Any unknown values sort on "name".

TurnInGuildCharter() - ?.

Honor Functions

GetInspectHonorData() - Return honor info for the inspected unit (if available).

GetInspectPVPRankProgress - Return rank progress for the inspected unit (if available). Ranges from 0 to 1.

GetPVPLastWeekStats() - Get your PvP/Honor statistics for last week.

GetPVPLifetimeStats() - Get your PvP/Honor statistics for your lifetime.

GetPVPRankInfo(rank{,unit}) - Get information about a specific PvP rank.

GetPVPRankProgress() - Get information about the PvP rank progress.

GetPVPSessionStats() - Get your PvP/Honor statistics for this session.

GetPVPThisWeekStats() - Get your PvP/Honor statistics for this week.

GetPVPYesterdayStats() - Get your PvP/Honor statistics for yesterday.

HasInspectHonorData() - Determine if the inspected unit's honor data is available.

RequestInspectHonorData() - Request honor data for inspected unit.

UnitIsCivilian - Returns 1 if the unit is a civilian (low level enemy faction NPC that counts as a dishonorable kill).

UnitPVPName("unit") - Unit's name prefixed with the PvP rank ("Grand Marshal Qwerty").

UnitPVPRank("unit") - Get PvP rank information for requested unit.

Ignore Functions

AddIgnore("name") - Add a player to your ignore list.

AddOrDelIgnore("name") - Toggles the ignore state of the specified name.

DelIgnore("name") - Delete a player from your ignore list.

GetIgnoreName(index) - Get the name of the player on your ignore list at index.

GetNumIgnores() - Get the number of players on your ignore list.

GetSelectedIgnore()

SetSelectedIgnore(index)

Inspection Functions

CheckInteractDistance("unit",distIndex)

ClearInspectPlayer() - Reset inspect data once finished with it (Called on inspect window hide)

GetInspectHonorData() - Return honor info for the inspected unit (if available).

GetInspectPVPRankProgress - Get the PvP rank progress information from the inspected unit.

HasInspectHonorData() - Determine if the inspected unit's honor data is available.

InspectUnit("unit") - Inspects the specified / selected "unit".

NotifyInspect("unit")

RequestInspectHonorData() - Request honor data for inspected unit.

Instance Functions

GetBattlefieldInstanceExpiration() - Get shutdown timer for the battlefield instance.

GetBattlefieldInstanceInfo(index) - Get the instance ID for a battlefield

GetBattlefieldInstanceRunTime - ?.

GetInstanceBootTimeRemaining() - ?.

Inventory Functions

These functions manage your inventory, that is those items you have equipped. See also Container/Bag Functions and Bank Functions.

AutoEquipCursorItem() - Causes the equipment on the cursor to be equipped.

BankButtonIDToInvSlotID - Returns the ID number of a bank button in terms of inventory slot ID.

CancelPendingEquip(index)

ConfirmBindOnUse()

ContainerIDToInventoryID(containedID)

[[API CursorCanGoInSlot|CursorCanGoInSlot(slot)]]

EquipCursorItem(x)

[[API EquipPendingItem|EquipPendingItem(slot)]]

GetInventoryAlertStatus(index)

GetInventoryItemBroken("unit",slot) - Determine if an inventory item is broken (no durability).

GetInventoryItemCooldown("unit",slot) - Get cooldown information for an inventory item.

GetInventoryItemCount("unit",slot) - Determine the quantity of an item in an inventory slot.

GetInventoryItemLink("unit",slot) - Get a link string for an inventory item.

GetInventoryItemQuality("unit",slot) - Return the quality of an inventory item.

GetInventoryItemTexture("unit",slot) - Return the texture for an inventory item.

GetInventorySlotInfo(slot) - Get the info for a named inventory slot (slot ID and texture)

GetWeaponEnchantInfo() - Return information about main and offhand weapon enchantments.

HasWandEquipped() - Returns 1 if a wand is equipped, false otherwise.

IsInventoryItemLocked(id)

PickupBagFromSlot(slot)

PickupInventoryItem(index)

SetInventoryPortaitTexture - ?.

REMOVED SetInventoryPortraitTexture()

UpdateInventoryAlertStatus()

[[API UseInventoryItem|UseInventoryItem(slot)]] - Use an item in a specific inventory slot.

Item Functions

These functions are those which operate on item links or item information directly. See also Container/Bag Functions and Inventory Functions.

GetAuctionItemLink("type", index) - Returns a link string for the specified auction item.

GetContainerItemLink(bag,slot) - Returns the item link of the item located in bag# and slot#.

GetCraftItemLink(index)

GetCraftReagentItemLink(index,reagentIndex)

GetInventoryItemLink("unit",slot) - Get a link string for an inventory item.

GetItemInfo(itemID | "itemString") - Returns information about an item.

GetItemQualityColor(quality) - Returns the RGB color codes for a quality.

GetMerchantItemLink(index) - Returns a link to an item.

GetQuestItemLink - Returns a link to a quest reward item.

GetQuestLogItemLink - ?.

GetTradePlayerItemLink(id) - Returns link to a trade item.

GetTradeSkillItemLink(index) - Gets the link string for a trade skill item.

GetTradeSkillReagentItemLink(index, reagentId) - Gets the link string for a trade skill reagent.

GetTradeTargetItemLink(id) - Returns link to a trade item.

OffhandHasWeapon() - Determine if your offhand carries a weapon.

SetItemRef(itemLink) - Displays an item link box.

Item Text Functions

These functions relate to item text (books, etc)

CloseItemText() - Close an open item text (book, plaque, etc).

ItemTextGetCreator() - Get the creator of the current text (if player-created).

ItemTextGetItem() - Get the name of the text.

ItemTextGetMaterial() - Get the material on which the text is printed.

ItemTextGetPage() - Get the page number of the currently viewed page.

ItemTextGetText() - Get the page contents of the currently viewed page.

ItemTextHasNextPage() - Determine if there is another page after the current one.

ItemTextNextPage() - Request the next page of the text.

ItemTextPrevPage() - Request the previous page of the text.

Key Binding Functions

REMOVED DefaultBindings() - Loads default WoW key bindings into memory.

GetBinding(index) - Get action and key bindings for that index.

GetBindingAction("key") - Get the action bound to that key.

GetBindingKey("command") - Get the key(s) bound to that action.

GetBindingText("key", "prefix") - Gets the string value for the key.

GetCurrentBindingSet() - Queries if current set of key bindings is character or account specific

GetNumBindings() - Get total number key bindings and headers.

REMOVED ResetBindings() - Loads key bindings into memory from disk.

LoadBindings(which) - Loads default, account or character specific key binding set into memory from disk.

RunBinding("command") - ?

SaveBindings(which) - Saves account or character specific key bindings from memory to disk.

SetBinding("key"{,"command"}) - Sets or unsets key bindings.

SetConsoleKey - ?

LUA Functions

These functions are part of the LUA programming language, described here.

assert(value) - asserts a value is non-nil, otherwise shows dialog and outputs debug diagnostic information if you have a debugger attached to wow.exe

date(format, time) - Returns the current date according to the user's machine.

error("error message",level) - Throws an error with the given error message. Use