World of Warcraft API

The World of Warcraft API doc is currently at http://www.cosmosui.org/texts/BlizzardCommands.xml (outdated). It should hopefully be ported here soon.

Global Function Groups

Template:Dynamic list

Here is a list of all potential global functions: Global Function List.

Action Functions

AcceptDuel - The player accepts the challenge to duel.

ActionButtonDown - Press the specified action button.

ActionButtonUp - Release the specified action button.

AddTradeMoney - Adds the money dropped into the player's trade frame.

AssistByName - Assists the player whose name is entered.

AssistUnit - Instructs your character to assist the target player.

AttackTarget - Attacks the targetted unit.

BeginTrade - Begins the trade with the target.

BonusActionButtonDown - Trigger the specified bonus(pet or minion) action button.

BonusActionButtonUp - Release the specified bonus(pet or minion) action button.

CancelDuel - Refuse the invitation to fight a duel.

ChangeActionBarPage - ?.

Duel - Duels a specified user by name.

GetActionCooldown - ?.

GetActionCount - ?.

GetActionText - ?.

GetActionTexture - ?.

GetBindingAction - ?.

HasAction - ?.

IsActionInRange - ?.

IsAttackAction - ?.

IsAutoRepeatAction - ?.

IsCurrentAction - ?.

IsUsableAction - ?.

Jump - The player jumps.

PickupAction - ?.

PlaceAction - ?.

SitOrStand - The player sits or stands.

StartDuelUnit - Challenge a unit to a duel.

ToggleSheath - Toggles sheathed or unsheathed weapons.

TurnOrActionStart - ?.

TurnOrActionStop - ?.

UseAction - ?.

Auction Functions

CalculateAuctionDeposit - ?.

CancelAuction - ?.

CanSendAuctionQuery - ?.

ClickAuctionSellItemButton - ?.

CloseAuctionHouse - ?.

GetAuctionInvTypes - ?.

GetAuctionItemClasses - ?.

GetAuctionItemInfo - ?.

GetAuctionItemLink - ?.

GetAuctionItemSubClasses - ?.

GetAuctionItemTimeLeft - ?.

GetAuctionSellItemInfo - ?.

GetBidderAuctionItems - ?.

GetNumAuctionItems - ?.

GetOwnerAuctionItems - ?.

GetSelectedAuctionItem - ?.

IsAuctionSortReversed - ?.

PlaceAuctionBid - ?.

QueryAuctionItems - ?.

SetSelectedAuctionItem - ?.

SortAuctionItems - ?.

StartAuction - ?.

Battlefield Functions

CloseBattlefield - ?.

GetBattlefieldInfo - ?.

GetNumBattlefields - ?.

GetSelectedBattlefield - ?.

JoinBattlefield - ?.

SetSelectedBattlefield - ?.

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

ChannelBan - Bans a player from the specified channel.

ChannelInvite - Invites the specified user to the channel.

ChannelKick - Kicks the specified user from the channel.

ChannelModerate - ?.

ChannelModerator - Sets the specified player as the channel moderator.

ChannelMute - Turns off the specified player's ability to speak in a channel.

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

ChannelUnban - Unbans a player from a channel.

ChannelUnmoderator - Takes the specified user away from the moderator status.

ChannelUnmute - Unmutes the specified user from the channel.

DisplayChannelOwner - ?.

EnumerateServerChannels - ?.

GetChannelList - ?.

GetChannelName - ?.

GetChatWindowChannels - ?.

JoinChannelByName - ?.

LeaveChannelByName - Leaves the channel with the specified name.

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

ListChannels - Lists all of the channels.

RemoveChatWindowChannel - ?.

SetChannelOwner - ?.

SetChannelPassword - 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.

AcceptXPLoss - Accept the XP loss to be reborn where you stand.

AddFriend - Add a friend to your friend list.

AddIgnore - Add a player to your ignore list.

AddOrDelIgnore - Toggles the ignore state of the specified user.

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

Group Functions

AcceptGroup - Accept the invitation to party.

DeclineGroup - Decline the invitation to a party.

GetPartyMember - Returns the name of the party member at the specified index.

InviteByName - Invites the specified player to the group sender is currently in.

InviteToParty - Invite a unit to a party.

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

LeaveParty - Quit the party.

PromoteByName - Promotes by name the target.

PromoteToPartyLeader - Promote a unit to party leader.

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

UnitIsPartyLeader - Returns true if the unit is its partyleader.

UninviteByName - Uninvites (kicks) the target from the current group if group leader.

UninviteFromParty - Kick a unit from the party.

Guild Functions

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

BuyGuildCharter - ?.

CanEditMOTD - ?.

CanEditOfficerNote - ?.

CanEditPublicNote - ?.

CanGuildDemote - ?.

CanGuildInvite - ?.

CanGuildPromote - ?.

CanGuildRemove - ?.

CanViewOfficerNote - ?.

CloseGuildRegistrar - ?.

DeclineGuild - ?.

GetGuildCharterCost - ?.

GetGuildInfo - ?.

GetGuildRosterInfo - ?.

GetGuildRosterLastOnline - ?.

GetGuildRosterMOTD - ?.

GetGuildRosterSelection - ?.

GetGuildRosterShowOffline - ?.

GetNumGuildMembers - ?.

GuildControlAddRank - ?.

GuildControlDelRank - ?.

GuildControlGetNumRanks - ?.

GuildControlGetRankFlags - ?.

GuildControlGetRankName - ?.

GuildControlSaveRank - ?.

GuildControlSetRankFlag - ?.

GuildControlSetRank - ?.

GuildDemoteByName - ?.

GuildDisband - ?.

GuildInfo - ?.

GuildInviteByName - ?.

GuildLeave - ?.

GuildPromoteByName - ?.

GuildRosterSetOfficerNote - ?.

GuildRosterSetPublicNote - ?.

GuildRoster - ?.

GuildSetLeaderByName - ?.

GuildSetMOTD - ?.

GuildUninviteByName - ?.

IsGuildLeader - ?.

IsInGuild - ?.

SetGuildRosterSelection - ?.

SetGuildRosterShowOffline - ?.

SortGuildRoster - ?.

TurnInGuildCharter - ?.

Item Functions

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

Inventory Functions

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

Macro Functions

CreateMacro - ?.

DeleteMacro - ?.

EditMacro - ?.

GetMacroIconInfo - ?.

GetMacroIndexByName - ?.

GetMacroInfo - ?.

GetNumMacroIcons - ?.

GetNumMacros - ?.

PickupMacro - ?.

RunMacro - ?.

SaveMacros - ?.

Mail Functions

AddSendMailCOD - ?.

AddSendMailMoney - ?.

CheckInbox - ?.

ClickSendMailItemButton - ?.

CloseMail - ?.

DeleteInboxItem - ?.

GetInboxHeaderInfo - ?.

GetInboxItem - ?.

GetInboxNumItems - ?.

GetInboxText - ?.

GetSendMailCOD - ?.

GetSendMailItem - ?.

GetSendMailMoney - ?.

GetSendMailPrice - ?.

HasNewMail - ?.

InboxItemCanDelete - ?.

PickupSendMailCOD - ?.

PickupSendMailMoney - ?.

ReturnInboxItem - ?.

SendMail - ?.

SetSendMailCOD - ?.

SetSendMailMoney - ?.

TakeInboxItem - ?.

TakeInboxMoney - ?.

TakeInboxTextItem - ?.

Mapping Functions

GetCorpseMapPosition - Returns the postion off the corpse on the current map.

GetCurrentMapContinent - Returns the number of the continent the world map is currently showing.

GetCurrentMapZone - Returns the number of the zone the world map is currently showing.

GetMapContinents - Returns the continent names.

GetMapInfo - ?.

GetMapLandmarkInfo - ?.

GetMapOverlayInfo - ?.

GetMapZones - Returns the zone names of one continent.

GetMinimapZoneText - Returns the zone text, that is displayed over the minimap.

GetNumMapLandmarks - ?.

GetNumMapOverlays - ?.

GetPlayerMapPosition - Returns the postion of a unit on the current map.

GetRealZoneText - ?.

GetSubZoneText - Returns the subzone text.

GetZonePVPInfo - Returns PVP info for the current zone.

GetZoneText - Returns the zone text.

ProcessMapClick - Passes a click to the client, which then calculates if the zone has to be changed.

SetMapToCurrentZone - Sets the zoom to the zone the player is currently in.

SetMapZoom - Sets the zoom to a specific zone.

SetupWorldMapScale - ?.

UpdateMapHighlight - ?.

Math Functions

abs - Returns the absolute value of the number.

acos - Returns the value of the arc cosine of the value in degrees.

asin - Returns the value of the arc sine of the value in degrees.

atan - Returns the value of the arc tan of the value in degrees.

atan2 - Returns the value of the arc tangent of X/Y in degrees.

Merchant Functions

BuyMerchantItem - ?.

CanMerchantRepair - ?.

CloseMerchant - ?.

GetMerchantItemInfo - ?.

GetMerchantItemLink - ?.

GetMerchantItemMaxStack - ?.

GetMerchantNumItems - ?.

PickupMerchantItem - ?.

ShowMerchantSellCursor - ?.

Miscellaneous Functions

AddChatWindowChannel - Adds a chat channel to a chat window.

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

GetGameTime - Returns the time in-game.

GetScreenHeight - Returns the height of the window in pixels.

GetTime - Returns a number that represents the current time.

IsAltKeyDown - Returns true if the alt key is currently depressed.

IsControlKeyDown - Returns true if the control key is currently depressed.

IsShiftKeyDown - Returns true if the shift key is currently depressed.

Logout - Logs the user out of the game.

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

PlaySound - Plays the specified sound filename.

Quit - Quits the application, NOT the LUA script.

RandomRoll - Does a random roll between the two values.

Screenshot - Takes a screenshot.

SendChatMessage - Sends a chat message.

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

TakeScreenshot - Takes a screenshot.

Movement Functions

MoveBackwardStart - The player begins moving backward at the specified time.

MoveBackwardStop - The player stops moving backward at the specified time.

MoveForwardStart - The player begins moving forward at the specified time.

MoveForwardStop - The player stops moving forward at the specified time.

StrafeLeftStart - The player begins strafing left at the specified time.

StrafeLeftStop - The player stops strafing left at the specified time.

StrafeRightStart - The player begins strafing right at the specified time.

StrafeRightStop - The player stops strafing right at the specified time.

ToggleAutoRun - Turns auto-run on or off

ToggleRun - Toggle between running and walking.

TurnLeftStart - The player starts turning left at the specified time.

TurnLeftStop - The player starts turning left at the specified time.

TurnRightStart - The player starts turning right at the specified time.

TurnRightStop - The player stops turning right at the specified time.

Pet Functions

CastPetAction - ?.

ClickStablePet - ?.

ClosePetStables - ?.

DropItemOnUnit - Drops an item from the cursor onto your target.

GetNumStablePets - ?.

GetPetActionCooldown - Returns cooldown information for the pet action at the specificed pet action bar slot.

GetPetActionInfo - Returns information on the pet action at the specified pet action bar slot.

GetPetActionsUsable - ?.

GetPetExperience - ?.

GetPetFoodTypes - ?.

GetPetHappiness - ?.

GetPetIcon - ?.

GetPetLoyalty - ?.

GetPetTimeRemaining - ?.

GetPetTrainingPoints - ?.

GetSelectedStablePet - ?.

GetStablePetFoodTypes - ?.

GetStablePetInfo - ?.

HasPetSpells - Returns true if the player has pet spells.

HasPetUI - Returns true if the player has a pet User Interface.

PetAbandon - Permanently abandon's your pet.

PetAggressiveMode - Set your pet in aggressive mode.

PetAttack - Instruct your pet to attack your target.

PetCanBeAbandoned - Retuns true if the pet is abandonable.

PetCanBeRenamed - Retuns true if the pet can be renamed.

PetDefensiveMode - Set your pet in defensive mode.

PetDismiss - Dismiss your pet.

PetFollow - Instruct your pet to follow you.

PetHasActionBar - ?.

PetPassiveMode - Set your pet into passive mode.

PetRename - ?.

PetWait - Instruct your pet to remain still.

PickupPetAction - ?.

PickupStablePet - ?.

SetPetStablePaperdoll - ?.

TargetUnitsPet - ?.

TogglePetAutocast - ?.

Petition Functions

CanSignPetition - ?.

ClosePetition - ?.

GetNumPetitionNames - ?.

GetPetitionInfo - ?.

GetPetitionNameInfo - ?.

OfferPetition - ?.

SignPetition - ?.

Quest Functions

AbandonQuest - Abandon the specified quest.

AcceptQuest - Accept the specified quest.

CloseQuest - ?.

CollapseQuestHeader - Collapses a quest header.

CompleteQuest - Complete the specified quest.

ConfirmAcceptQuest - Accept the quest. Yes. Really accept it.

DeclineQuest - Declines the currently offered quest.

ExpandQuestHeader - Expands a quest header.

GetAbandonQuestName - ?.

GetGossipActiveQuests - ?.

GetGossipAvailableQuests - ?.

GetNumActiveQuests - ?.

GetNumAvailableQuests - ?.

GetNumQuestChoices - ?.

GetNumQuestItems - Returns the number of items nessecary to complete a particular quest.

GetNumQuestLeaderBoards - ?.

GetNumQuestLogChoices - Returns the number of options someone has when getting a quest item.

GetNumQuestLogEntries - Returns the number of entries in the quest log.

GetNumQuestLogRewards - Returns the count of the rewards for a particular quest.

GetNumQuestRewards - ?.

GetQuestBackgroundMaterial - Returns the material string associated with the particular quest.

GetQuestGreenRange - ?.

GetQuestIndexForTimer - ?.

GetQuestItemInfo - Returns basic information about the quest items.

GetQuestItemLink - ?.

GetQuestLogChoiceInfo - Returns a bunch of data about a quest reward choice from the quest log.

GetQuestLogItemLink - ?.

GetQuestLogLeaderBoard - ?.

GetQuestLogPushable - ?.

GetQuestLogQuestText - Returns the description and objectives required for the specified quest.

GetQuestLogRequiredMoney - ?.

GetQuestLogRewardInfo - Returns a pile of reward item info.

GetQuestLogRewardMoney - Returns a number representing the amount of copper returned by a particular quest.

GetQuestLogRewardSpell - ?.

GetQuestLogSelection - Returns a number associated with the QuestLogSelection index.

GetQuestLogTimeLeft - ?.

GetQuestLogTitle - Returns the string which is associated with the specific QuestLog Title in the game.

GetQuestMoneyToGet - ?.

GetQuestReward - Gets the quest reward specified.

GetQuestText - ?.

GetQuestTimers - Returns all of the quest timers currently in progress.

GetRewardMoney - ?.

GetRewardSpell - ?.

GetRewardText - ?.

IsCurrentQuestFailed - ?.

IsQuestCompletable - Returns true if a quest is possible to complete.

QuestChooseRewardError - Throws an error when the quest choose reward method doesn't work.

QuestLogPushQuest - ?.

SelectActiveQuest - ?.

SelectAvailableQuest - ?.

SelectGossipActiveQuest - ?.

SelectGossipAvailableQuest - ?.

SelectQuestLogEntry - ?.

SetAbandonQuest - Called before AbandonQuest.

Raid Functions

ConvertToRaid - ?.

GetNumRaidMembers - ?.

GetRaidRosterInfo - ?.

GetRaidRosterSelection - ?.

IsRaidLeader - ?.

IsRaidOfficer - ?.

SetRaidRosterSelection - ?.

SetRaidSubgroup - ?.

SwapRaidSubgroup - ?.

UninviteFromRaid - ?.

Spell Functions

CastSpell - ?.

CastSpellByName - ?.

GetCraftSpellFocus - ?.

GetNumSpellTabs - ?.

GetSpellCooldown - ?.

GetSpellName - ?.

GetSpellTabInfo - ?.

GetSpellTexture - ?.

IsSpellPassive - ?.

PickupSpell - ?.

PlayerHasSpells - ?.

SpellCanTargetUnit - ?.

SpellIsTargeting - Returns true if a spell has been cast and is awaiting target selection.

SpellStopCasting - ?.

SpellStopTargeting - ?.

SpellTargetUnit - ?.

UpdateSpells - ?.

Targetting Functions

ClearTarget - Clears the selected target.

TargetLastEnemy - Selects the last targetted enemy as the current target.

TargetNearestEnemy - Selects the nearest enemy as the current target.

TargetUnit - Selects the specified id as the current target.

Taxi Functions

CloseTaxiMap - ?.

NumTaxiNodes - ?.

SetTaxiMap - ?.

TakeTaxiNode - ?.

TaxiNodeCost - ?.

TaxiNodeGetType - ?.

TaxiNodeName - ?.

TaxiNodePosition - ?.

UnitOnTaxi - ?.

Toggle Functions

ToggleBackpack - Toggles your backpage open/closed.

ToggleBag - Opens or closes the specified bag.

ToggleCharacter - Toggles the character pane to the specified frame.

ToggleCombatLog - Opens/closes the combat log.

ToggleFriendsFrame - Opens/closes the friends pane.

ToggleGameMenu - Opens/closes the game menu.

ToggleMinimap - Turns the minimap display on/off.

ToggleQuestLog - Opens/closes the quest log.

ToggleWorldMap - Turns the world map on/off.

Trading Functions

AddTradeMoney - Adds the money dropped into the players trade frame.

BeginTrade - Begins the trade with the target.

CancelTrade - Declines the offer to trade with the other player.

CancelTradeAccept - Cancels the trade attempt which required an accept.

CloseTrade - Closes the trade.

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

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

GetPlayerTradeMoney - Returns the amount of money the player has in the trade window.

GetTargetTradeMoney - Returns the amount of money in the trade frame of the target player.

GetTradeTargetItemInfo - Returns information about a trade item.

InitiateTrade - Asks the specified unit to trade.

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

ReplaceTradeEnchant - Confirm the replacement of an enchantment via trade.

TradeSkill Functions

CloseTradeSkill - ?.

CollapseTradeSkillSubClass - ?.

DoTradeSkill - ?.

ExpandTradeSkillSubClass - ?.

GetFirstTradeSkill - ?.

GetNumTradeSkills - ?.

GetTradeSkillCooldown - ?.

GetTradeSkillIcon - ?.

GetTradeSkillInfo - ?.

GetTradeSkillInvSlotFilter - ?.

GetTradeSkillInvSlots - ?.

GetTradeSkillItemLink - ?.

GetTradeSkillLine - ?.

GetTradeSkillNumMade - ?.

GetTradeSkillNumReagents - ?.

GetTradeSkillReagentInfo - ?.

GetTradeSkillReagentItemLink - ?.

GetTradeSkillSelectionIndex - ?.

GetTradeSkillSubClassFilter - ?.

GetTradeSkillSubClasses - ?.

GetTradeSkillTools - ?.

GetTradeskillRepeatCount - ?.

SelectTradeSkill - ?.

SetTradeSkillInvSlotFilter - ?.

SetTradeSkillSubClassFilter - ?.

Training Functions

AddSendMailCOD - ?.

BuyTrainerService - ?.

CloseTrainer - ?.

CollapseTrainerSkillLine - ?.

ExpandTrainerSkillLine - ?.

GetNumTrainerServices - ?.

GetTrainerGreetingText - ?.

GetTrainerSelectionIndex - ?.

GetTrainerServiceAbilityReq - ?.

GetTrainerServiceCost - ?.

GetTrainerServiceDescription - ?.

GetTrainerServiceIcon - ?.

GetTrainerServiceInfo - ?.

GetTrainerServiceLevelReq - ?.

GetTrainerServiceNumAbilityReq - ?.

GetTrainerServiceSkillLine - ?.

GetTrainerServiceSkillReq - ?.

GetTrainerServiceStepReq - ?.

GetTrainerServiceTypeFilter - ?.

IsTalentTrainer - ?.

IsTradeskillTrainer - ?.

IsTrainerServiceLearnSpell - ?.

SelectTrainerService - ?.

SetTrainerServiceTypeFilter - ?.

Unit Functions

UnitArmor - Returns the armor statistics relevant to the specified unit.

UnitAttackBothHands - ?.

UnitAttackPower - ?.

UnitAttackSpeed - ?.

UnitBuff - Retrieves info about a buff of a certain unit.

UnitCanAttack - Returns true if the first unit can attack the second, false otherwise.

UnitCanCooperate - Returns true if the first unit can cooperate with the second, false otherwise.

UnitCharacterPoints - ?.

UnitClass - Returns the class name of the specified unit (e.g., "Warrior" or "Shaman").

UnitClassification - Returns the classification of the specified unit (e.g., "elite" or "worldboss").

UnitCreatureFamily - ?.

UnitDamage - Returns the damage statistics relevant to the specified unit.

UnitDebuff - Retrieves info about a debuff of a certain unit.

UnitDefense - ?.

UnitExists - Returns true if the specified unit exists, false otherwise.

UnitFactionGroup - Returns the faction group id and name of the specified unit.

UnitHealth - Returns the current health, in points, of the specified unit.

UnitHealthMax - Returns the maximum health, in points, of the specified unit.

UnitInParty - Returns true if the specified unit is in the same party as the player, false otherwise.

UnitIsConnected - Returns true if the specified unit is connected, false otherwise.

UnitIsCorpse - Returns true if the specified unit is a corpse, false otherwise.

UnitIsDead - Returns true if the specified unit is dead, false otherwise.

UnitIsDeadOrGhost - Returns true if the specified unit is dead or a ghost, false otherwise.

UnitIsEnemy - Returns true if the specified units are enemies, false otherwise.

UnitIsFriend - Returns true if the specified units are friends, false otherwise.

UnitIsGhost - Returns true if the specified unit is a ghost, false otherwise.

UnitIsPVP - Returns true if the specified unit is flagged for PVP, false otherwise.

UnitIsPVPFreeForAll - Returns true if the specified unit is flagged for free-for-all PVP, false otherwise.

UnitIsPartyLeader - Returns true if the specified unit is the leader of the player's party, false otherwise.

UnitIsPlayer - Returns true if the specified unit is a player character, false otherwise.

UnitIsPlusMob - Returns true if the specified unit is a mob, more powerful than it's nominal level, false otherwise (e.g., "elite" mobs).

UnitIsTapped - Returns true if the specified unit is tapped, false otherwise.

UnitIsTappedByPlayer - Returns true if the specified unit is tapped by a player, false otherwise.

UnitIsUnit - Returns true if the two specified units refer to the same unit (e.g., "player" and "target" can refer to the same unit), false otherwise.

UnitLevel - Returns the level of the unit referred to by the local naming schema.

UnitMana - Returns the current mana, in points, of the specified unit.

UnitManaMax - Returns the maximum mana, in points, of the specified unit.

UnitName - Returns the name of the unit referred to by the local naming schema.

UnitPVPName - ?.

UnitPlayerControlled - Returns true if the specified unit is controlled by a player, false otherwise.

UnitPowerType - Returns a number corresponding to the power type (e.g., mana, rage or energy) of the specified unit.

UnitRace - Returns the race name of the specified unit (e.g., "Human" or "Troll").

UnitRangedAttack - ?.

UnitRangedAttackPower - ?.

UnitRangedDamage - ?.

UnitReaction - Returns a number corresponding to the reaction (aggressive, neutral or friendly) of the first unit towards the second unit.

UnitResistance - Returns the resistance statistics relevant to the specified unit and resistance type.

UnitSex - Returns non-zero if the specified unit is female, zero otherwise.

UnitStat - Returns the statistics relevant to the specified unit and basic attribute (e.g., strength or intellect).

UnitXP - Returns the number of experience points the specified unit has in their current level.

UnitXPMax - Returns the number of experience points the specified unit needs to reach their next level.

---

New Functions

add functions whose group is not clear here

Example Function

Widget Specific Functions

Here is an incomplete list of potential widget specific functions: Widget Function List.

FrameLayout

An abstract object which can't actually be created in an XML file. It defines some methods common to a lot of objects.

ClearAllPoints

GetAlpha

GetHeight

GetName

GetWidth

Hide

IsVisible

SetAlpha

SetHeight

SetPoint - Position the object relative to another object.

SetWidth

Show

FontString

All those functions in FrameLayout (except GetAlpha), plus the following.

GetStringWidth

GetText

SetAlphaGradient - Usage: SetAlphaGradient(start, length)

SetJustifyH

SetJustifyV

SetText

SetTextColor

SetTextHeight - Usage: SetTextHeight(pixelHeight)

SetVertexColor

Texture

All those functions in FrameLayout, plus the following.

SetDesaturated

SetGradient

SetGradientAlpha - Usage: SetGradientAlpha("orientation", minR, minG, minB, minA, maxR, maxG, maxB, maxA)

SetTexCoord - Note, this is not a typo

SetTexture

SetVertexColor

Frame

All those methods in FrameLayout, plus the following.

DisableDrawLayer

EnableDrawLayer

EnableKeyboard

EnableMouse

GetBottom

GetCenter

GetFrameLevel

GetID

GetLeft

GetParent

GetRight

GetScale

GetTop

IsShown

IsUserPlaced

Lower

Raise

RegisterEvent - Usage: RegisterEvent("event")

RegisterForDrag

SetAllPoints - Usage: SetAllPoints("frame")

SetBackdropBorderColor

SetBackdropColor

SetFrameLevel - Usage: SetFrameLevel(level)

SetID - Usage: SetID(ID)

SetMaxResize - Usage: SetMaxResize(maxWidth, maxHeight)

SetMinResize - Usage: SetMinResize(minWidth, minHeight)

SetScale - Usage: SetScale(scale)

StartMoving

StartSizing

StopMovingOrSizing

UnregisterEvent - Usage: UnregisterEvent("event")

Button

All those methods in FrameLayout and Frame, plus the following.

Click

Disable

Enable

GetButtonState

GetInventorySlot

GetText

GetTextHeight

GetTextWidth

IsEnabled

LockHighlight

RegisterForClicks

SetButtonState - Usage: SetButtonState("state", lock)

SetDisabledTextColor

SetDisabledTexture

SetHighlightTextColor

SetHighlightTexture

SetNormalTexture

SetPushedTexture

SetText

SetTextColor

UnlockHighlight

CheckButton

All those methods in FrameLayout, Frame and Button, plus the following.

GetChecked

SetChecked - Usage: SetChecked(nil) or SetChecked(true)

SetCheckedTexture - Usage: SetCheckedTexture("texture")

SetDisabledCheckedTexture - Usage: SetDisabledCheckedTexture("texture")

EditBox

All those methods in FrameLayout and Frame, plus the following.

AddHistoryLine - Usage: AddHistoryLine("text")

ClearFocus

GetInputLanguage

GetNumLetters

GetNumber

GetText

HighlightText

Insert

SetFocus

SetMaxBytes - Usage: SetMaxBytes(max)

SetMaxLetters - Usage: SetMaxLetters(max)

SetNumber - Usage: SetNumber(number)

SetText

SetTextColor

SetTextInsets - Usage: SetTextInsets(l, r, t, b)

ToggleInputLanguage

MessageFrame

All those methods in FrameLayout and Frame, plus the following.

AddMessage

ScrollingMessageFrame

All those methods in FrameLayout, Frame and MessageFrame, plus the following.

AtBottom

GetCurrentLine

GetCurrentScroll

GetFontHeight

GetNumLinesDisplayed

GetNumMessages

PageDown

PageUp

ScrollDown

ScrollToBottom

ScrollToTop

ScrollUp

SetFontHeight - Usage: SetFontHeight(pixelHeight)

SetScrollFromBottom

UpdateColorByID

ScrollFrame

All those methods in FrameLayout and Frame, plus the following.

GetHorizontalScroll

GetHorizontalScrollRange

GetVerticalScroll

GetVerticalScrollRange

SetHorizontalScroll - Usage: SetHorizontalScroll(offset)

SetVerticalScroll - Usage: SetVerticalScroll(offset)

UpdateScrollChildRect

Slider

All those methods in FrameLayout and Frame, plus the following.

GetMinMaxValues

GetValue

GetValueStep

SetMinMaxValues- Usage: SetMinMaxValues(min, max)

SetValue

SetValueStep - Usage: SetValueStep(value)

SimpleHTML

All those methods in FrameLayout and Frame, plus the following.

SetText

SetTextColor

StatusBar

All those methods in FrameLayout and Frame, plus the following.

GetMinMaxValues

GetValue

SetMinMaxValues - Usage: SetMinMaxValues(min, max)

SetStatusBarColor

SetValue

ColorSelect

All those methods in FrameLayout and Frame, plus the following.

GetColorHSV

GetColorRGB

SetColorHSV

SetColorRGB

MovieFrame

All those methods in FrameLayout and Frame, plus the following.

EnableSubtitles

StartMovie - Usage: StartMovie("filename")

StopMovie

Model

All those methods in FrameLayout and Frame, plus the following.

AdvanceTime

ClearFog

ClearModel

GetFacing

GetPosition

ReplaceIconTexture - Usage: ReplaceIconTexture("texture")

SetCamera - Usage: SetCamera(index)

SetFacing - Usage: SetFacing(facing)

SetFogColor

SetFogFar - Usage: SetFogFar(value)

SetFogNear - Usage: SetFogNear(value)

SetLight -Usage: SetLight(enabled[, omni, dirX, dirY, dirZ, ambIntensity[, ambR, ambG, ambB], dirIntensity[, dirR, dirG, dirB]])

SetModel - Usage: SetModel("file")

SetPosition

SetSequence

SetSequenceTime -Usage: SetSequenceTime(sequence, time)

GameTooltip

Undocumented in UI.xsd. Methods not verified in-game yet.

AddDoubleLine

AddLine

AppendText - Usage: AppendText("text")

ClearLines

FadeOut

IsOwned

NumLines

SetAction - Usage: SetAction(slot)

SetAuctionCompareItem - Usage: SetAuctionCompareItem("type", index [, offset])

SetAuctionItem - Usage: SetAuctionItem("type", index)

SetAuctionSellItem

SetBagItem

SetBuybackItem

SetCraftItem

SetCraftSpell

SetHyperlink - Usage: SetHyperlink(link)

SetInboxItem - Usage: SetInboxItem(index)

SetInventoryItem - Usage: SetInventoryItem(unit, slot [, nameOnly])

SetLootItem

SetLootRollItem - Usage: SetLootRollItem(id)

SetMerchantCompareItem - Usage: SetMerchantCompareItem("slot" [, offset])

SetMerchantItem

SetMoneyWidth - Usage: SetMoneyWidth(width)

SetOwner

SetPadding

SetPetAction - Usage: SetPetAction(slot)

SetPlayerBuff - Usage: SetPlayerBuff(buffIndex)

SetQuestItem

SetQuestLogItem

SetQuestLogRewardSpell

SetQuestRewardSpell

SetSendMailItem

SetShapeshift - Usage: SetShapeshift(slot)

SetSpell

SetTalent - Usage: SetTalent(tabIndex, talentIndex)

SetText

SetTrackingSpell

SetTradePlayerItem

SetTradeSkillItem

SetTradeTargetItem

SetTrainerService

SetUnitBuff - Usage: SetUnitBuff("unit", index)

SetUnitDebuff - Usage: SetUnitDebuff("unit", index)

TaxiRouteFrame

Undocumented in UI.xsd. Methods not verified in-game yet.

LootButton

Undocumented in UI.xsd. Methods not verified in-game yet.

SetSlot - Usage: SetSlot(index)

TabardModel

Undocumented in UI.xsd. Methods not verified in-game yet.

CanSave

CycleVariation - Usage: CycleVariation(variationIndex, delta)

GetLowerBackgroundFileName

GetLowerEmblemFileName

GetLowerEmblemTexture - Usage: GetLowerEmblemTexture(textureName)

GetUpperBackgroundFileName

GetUpperEmblemFileName

GetUpperEmblemTexture - Usage: GetUpperEmblemTexture(textureName)

InitializeTabardColors

Save

PlayerModel

Undocumented in UI.xsd. Methods not verified in-game yet.

RefreshUnit

SetRotation - Usage: SetRotation(rotation (in radians)

SetUnit

UpdateModel

Minimap

Undocumented in UI.xsd. Methods not verified in-game yet.

GetPingPosition

GetZoom

GetZoomLevels

PingLocation

SetZoom - Usage: SetZoom(level)

WorldFrame

Undocumented in UI.xsd. Methods not verified in-game yet.