Difference between revisions of "World of Warcraft API"

From Wowpedia
Jump to: navigation, search
Tag: WoW API docs
(Update summary for C_AuctionHouse.SendSearchQuery and SendSellSearchQuery)
Tags: Visual edit, WoW API docs
 
(127 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
{{wowapi|notitle=1}} {{tocright}}
 
{{wowapi|notitle=1}} {{tocright}}
 
{{for|a complete and automatically generated list|Global functions}}
 
{{for|a complete and automatically generated list|Global functions}}
  +
: ''Navigate to: [[#Classic]], [[#FrameXML]]''
{{for|{{Wow-inline}} Classic only functions|#Classic}}
 
 
The '''WoW API''' is a set of functions to interact with and modify the World of Warcraft user interface available to [[addons]] and macro scripts.
 
The '''WoW API''' is a set of functions to interact with and modify the World of Warcraft user interface available to [[addons]] and macro scripts.
   
 
Wowpedia [[Wowpedia:How to edit API pages|maintains]] the list below, newer API is also officially documented in [https://github.com/Gethe/wow-ui-source/tree/live/AddOns/Blizzard_APIDocumentation Blizzard_APIDocumentation] and accessible with the [[APILink|/api]] command. The user interface code, also known as the FrameXML can be [[Viewing_Blizzard%27s_interface_code|exported]] from the game client. Functions are prefixed with the following tags:
 
Wowpedia [[Wowpedia:How to edit API pages|maintains]] the list below, newer API is also officially documented in [https://github.com/Gethe/wow-ui-source/tree/live/AddOns/Blizzard_APIDocumentation Blizzard_APIDocumentation] and accessible with the [[APILink|/api]] command. The user interface code, also known as the FrameXML can be [[Viewing_Blizzard%27s_interface_code|exported]] from the game client. Functions are prefixed with the following tags:
* '''SECURE''' - This can only be called from [[secure code]].
+
* '''PROTECTED''' - This can only be called from [[secure code]].
 
* '''NOCOMBAT''' - This cannot be called from insecure code while in combat.
 
* '''NOCOMBAT''' - This cannot be called from insecure code while in combat.
 
* '''HW''' - This may only be called in response to a hardware event (user input).
 
* '''HW''' - This may only be called in response to a hardware event (user input).
Line 43: Line 43:
 
: [[API GetAchievementCriteriaInfoByID|GetAchievementCriteriaInfoByID]](<span style="font-size:smaller; color:#ecbc2a">achievementID, criteriaIndex</span>) - Returns achievement criteria info by criteriaIndex.
 
: [[API GetAchievementCriteriaInfoByID|GetAchievementCriteriaInfoByID]](<span style="font-size:smaller; color:#ecbc2a">achievementID, criteriaIndex</span>) - Returns achievement criteria info by criteriaIndex.
 
: [[API GetAchievementGuildRep|GetAchievementGuildRep]]()
 
: [[API GetAchievementGuildRep|GetAchievementGuildRep]]()
: [[API GetAchievementInfo|GetAchievementInfo]](<span style="font-size:smaller; color:#ecbc2a">achievementID or category, offset</span>) - Returns information about the requested achievement.
+
: [[API GetAchievementInfo|GetAchievementInfo]](<span style="font-size:smaller; color:#ecbc2a">achievementID or categoryID, index</span>) - Returns information about the requested achievement.
 
: [[API GetAchievementLink|GetAchievementLink]](<span style="font-size:smaller; color:#ecbc2a">achievementID</span>) - Returns a [[achievementLink]] for the specified achievement.
 
: [[API GetAchievementLink|GetAchievementLink]](<span style="font-size:smaller; color:#ecbc2a">achievementID</span>) - Returns a [[achievementLink]] for the specified achievement.
 
: [[API GetAchievementNumCriteria|GetAchievementNumCriteria]](<span style="font-size:smaller; color:#ecbc2a">achievementID</span>) - Returns the number of criteria the requested achievement has.
 
: [[API GetAchievementNumCriteria|GetAchievementNumCriteria]](<span style="font-size:smaller; color:#ecbc2a">achievementID</span>) - Returns the number of criteria the requested achievement has.
Line 79: Line 79:
 
: [[API ShowAccountAchievements|ShowAccountAchievements]]()
 
: [[API ShowAccountAchievements|ShowAccountAchievements]]()
 
: [[API SwitchAchievementSearchTab|SwitchAchievementSearchTab]](<span style="font-size:smaller; color:#ecbc2a">index</span>)
 
: [[API SwitchAchievementSearchTab|SwitchAchievementSearchTab]](<span style="font-size:smaller; color:#ecbc2a">index</span>)
  +
Statistics
 
  +
==== Statistics ====
 
: [[API GetComparisonStatistic|GetComparisonStatistic]](<span style="font-size:smaller; color:#ecbc2a">achievementID</span>) - Returns the value of the requested statistic for the comparison player.
 
: [[API GetComparisonStatistic|GetComparisonStatistic]](<span style="font-size:smaller; color:#ecbc2a">achievementID</span>) - Returns the value of the requested statistic for the comparison player.
 
: [[API GetLatestUpdatedComparisonStats|GetLatestUpdatedComparisonStats]]() - Returns a list of the latest updated statistics for the comparison player.
 
: [[API GetLatestUpdatedComparisonStats|GetLatestUpdatedComparisonStats]]() - Returns a list of the latest updated statistics for the comparison player.
Line 85: Line 86:
 
: [[API GetStatistic|GetStatistic]](<span style="font-size:smaller; color:#ecbc2a">achievementID</span>) - Returns the value of the requested statistic.
 
: [[API GetStatistic|GetStatistic]](<span style="font-size:smaller; color:#ecbc2a">achievementID</span>) - Returns the value of the requested statistic.
 
: [[API GetStatisticsCategoryList|GetStatisticsCategoryList]]() - Returns the list of statistic categories.
 
: [[API GetStatisticsCategoryList|GetStatisticsCategoryList]]() - Returns the list of statistic categories.
 
=== Action Bars ===
 
: [[API C_ActionBar.GetBonusBarIndexForSlot|C_ActionBar.GetBonusBarIndexForSlot]](<span style="font-size:smaller; color:#ecbc2a">slotID</span>) : <span style="font-size:smaller; color:#4ec9b0">bonusBarIndex</span>
 
: [[API C_ActionBar.IsHarmfulAction|C_ActionBar.IsHarmfulAction]](<span style="font-size:smaller; color:#ecbc2a">actionID, useNeutral</span>) : <span style="font-size:smaller; color:#4ec9b0">isHarmful</span>
 
: [[API C_ActionBar.IsHelpfulAction|C_ActionBar.IsHelpfulAction]](<span style="font-size:smaller; color:#ecbc2a">actionID, useNeutral</span>) : <span style="font-size:smaller; color:#4ec9b0">isHelpful</span>
 
: [[API C_ActionBar.IsOnBarOrSpecialBar|C_ActionBar.IsOnBarOrSpecialBar]](<span style="font-size:smaller; color:#ecbc2a">spellID</span>) : <span style="font-size:smaller; color:#4ec9b0">isOnBarOrSpecialBar</span>
 
: [[API C_ActionBar.PutActionInSlot|C_ActionBar.PutActionInSlot]](<span style="font-size:smaller; color:#ecbc2a">slotID</span>)
 
: [[API C_ActionBar.ShouldOverrideBarShowHealthBar|C_ActionBar.ShouldOverrideBarShowHealthBar]]() : <span style="font-size:smaller; color:#4ec9b0">showHealthBar</span>
 
: [[API C_ActionBar.ShouldOverrideBarShowManaBar|C_ActionBar.ShouldOverrideBarShowManaBar]]() : <span style="font-size:smaller; color:#4ec9b0">showManaBar</span>
 
: <small>NOCOMBAT</small> [[API ChangeActionBarPage|ChangeActionBarPage]](<span style="font-size:smaller; color:#ecbc2a">page</span>) - Changes the current action bar page.
 
: [[API GetActionBarPage|GetActionBarPage]]() - Returns the current action bar page. CURRENT_ACTIONBAR_PAGE is obsolete.
 
: [[API GetActionBarToggles|GetActionBarToggles]]() - Returns the toggles for each action bar.
 
: [[API GetBonusBarIndex|GetBonusBarIndex]]()
 
: [[API GetBonusBarOffset|GetBonusBarOffset]]() - Determine which page of bonus actions to show.
 
: [[API GetExtraBarIndex|GetExtraBarIndex]]()
 
: [[API GetMultiCastBarIndex|GetMultiCastBarIndex]]()
 
: [[API GetOverrideBarIndex|GetOverrideBarIndex]]()
 
: [[API GetOverrideBarSkin|GetOverrideBarSkin]]()
 
: [[API GetTempShapeshiftBarIndex|GetTempShapeshiftBarIndex]]()
 
: [[API GetVehicleBarIndex|GetVehicleBarIndex]]()
 
: [[API HasBonusActionBar|HasBonusActionBar]]()
 
: [[API HasExtraActionBar|HasExtraActionBar]]()
 
: [[API HasOverrideActionBar|HasOverrideActionBar]]()
 
: [[API HasTempShapeshiftActionBar|HasTempShapeshiftActionBar]]()
 
: [[API HasVehicleActionBar|HasVehicleActionBar]]()
 
: [[API IsPossessBarVisible|IsPossessBarVisible]]()
 
: [[API PetHasActionBar|PetHasActionBar]]() - Determine if player has a pet with an action bar.
 
: [[API SetActionBarToggles|SetActionBarToggles]](<span style="font-size:smaller; color:#ecbc2a">show1, show2, show3, show4 [, alwaysShow]</span>) - Set show toggle for each action bar.
 
 
==== Action Buttons ====
 
: [[API C_ActionBar.FindPetActionButtons|C_ActionBar.FindPetActionButtons]](<span style="font-size:smaller; color:#ecbc2a">petActionID</span>) : <span style="font-size:smaller; color:#4ec9b0">slots</span>
 
: [[API C_ActionBar.FindSpellActionButtons|C_ActionBar.FindSpellActionButtons]](<span style="font-size:smaller; color:#ecbc2a">spellID</span>) : <span style="font-size:smaller; color:#4ec9b0">slots</span>
 
: [[API C_ActionBar.GetPetActionPetBarIndices|C_ActionBar.GetPetActionPetBarIndices]](<span style="font-size:smaller; color:#ecbc2a">petActionID</span>) : <span style="font-size:smaller; color:#4ec9b0">slots</span>
 
: [[API C_ActionBar.HasPetActionButtons|C_ActionBar.HasPetActionButtons]](<span style="font-size:smaller; color:#ecbc2a">petActionID</span>) : <span style="font-size:smaller; color:#4ec9b0">hasPetActionButtons</span>
 
: [[API C_ActionBar.HasPetActionPetBarIndices|C_ActionBar.HasPetActionPetBarIndices]](<span style="font-size:smaller; color:#ecbc2a">petActionID</span>) : <span style="font-size:smaller; color:#4ec9b0">hasPetActionPetBarIndices</span>
 
: [[API C_ActionBar.HasSpellActionButtons|C_ActionBar.HasSpellActionButtons]](<span style="font-size:smaller; color:#ecbc2a">spellID</span>) : <span style="font-size:smaller; color:#4ec9b0">hasSpellActionButtons</span>
 
: [[API C_ActionBar.IsAutoCastPetAction|C_ActionBar.IsAutoCastPetAction]](<span style="font-size:smaller; color:#ecbc2a">slotID</span>) : <span style="font-size:smaller; color:#4ec9b0">isAutoCastPetAction</span>
 
: [[API C_ActionBar.IsEnabledAutoCastPetAction|C_ActionBar.IsEnabledAutoCastPetAction]](<span style="font-size:smaller; color:#ecbc2a">slotID</span>) : <span style="font-size:smaller; color:#4ec9b0">isEnabledAutoCastPetAction</span>
 
: [[API C_ActionBar.ToggleAutoCastPetAction|C_ActionBar.ToggleAutoCastPetAction]](<span style="font-size:smaller; color:#ecbc2a">slotID</span>)
 
: [[API ActionHasRange|ActionHasRange]](<span style="font-size:smaller; color:#ecbc2a">slot</span>) - Determine if the specified action is a range restriction (1 if yes, nil if no)
 
: [[API ClickWorldMapActionButton|ClickWorldMapActionButton]]()
 
: [[API GetActionAutocast|GetActionAutocast]](<span style="font-size:smaller; color:#ecbc2a">slot</span>)
 
: [[API GetActionCharges|GetActionCharges]](<span style="font-size:smaller; color:#ecbc2a">slot</span>) - Returns information about the charges of a charge-accumulating player ability.
 
: [[API GetActionCooldown|GetActionCooldown]](<span style="font-size:smaller; color:#ecbc2a">slot</span>) - This returns the cooldown values of the specified action.
 
: [[API GetActionCount|GetActionCount]](<span style="font-size:smaller; color:#ecbc2a">slot</span>) - Get the count (bandage/potion/etc) for an action, returns 0 if none or not applicable.
 
: [[API GetActionInfo|GetActionInfo]](<span style="font-size:smaller; color:#ecbc2a">slot</span>) - Returns type, id, subtype.
 
: [[API GetActionTexture|GetActionTexture]](<span style="font-size:smaller; color:#ecbc2a">slot</span>) - Gets the texture path for the specified action.
 
: [[API GetActionText|GetActionText]](<span style="font-size:smaller; color:#ecbc2a">slot</span>) - Get the text label (macros, etc) for an action, returns nil if none.
 
: [[API GetPossessInfo|GetPossessInfo]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Returns texture, name, enabled.
 
: [[API GetWorldMapActionButtonSpellInfo|GetWorldMapActionButtonSpellInfo]]()
 
: [[API HasAction|HasAction]](<span style="font-size:smaller; color:#ecbc2a">slot</span>) - Returns 1 if the player has an action in the specified slot, nil otherwise.
 
: [[API IsActionInRange|IsActionInRange]](<span style="font-size:smaller; color:#ecbc2a">slot</span>) - Test if an action is in range (1=yes, 0=no, nil=not applicable).
 
: [[API IsAttackAction|IsAttackAction]](<span style="font-size:smaller; color:#ecbc2a">slot</span>) - Returns 1 if an action is an 'attack' action (flashes during combat), nil otherwise.
 
: [[API IsAutoRepeatAction|IsAutoRepeatAction]](<span style="font-size:smaller; color:#ecbc2a">slot</span>) - Returns 1 if an action is auto-repeating, nil otherwise.
 
: [[API IsConsumableAction|IsConsumableAction]](<span style="font-size:smaller; color:#ecbc2a">slot</span>) - Returns 1 if an action is consumable (i.e. has a count), nil otherwise.
 
: [[API IsCurrentAction|IsCurrentAction]](<span style="font-size:smaller; color:#ecbc2a">slot</span>) - Returns 1 if an action is the one currently underway, nil otherwise.
 
: [[API IsEquippedAction|IsEquippedAction]](<span style="font-size:smaller; color:#ecbc2a">slot</span>) - Returns 1 if an action is equipped (i.e. connected to an item that must be equipped), nil otherwise.
 
: [[API IsItemAction|IsItemAction]](<span style="font-size:smaller; color:#ecbc2a">slot</span>)
 
: [[API IsPetAttackAction|IsPetAttackAction]](<span style="font-size:smaller; color:#ecbc2a">index</span>)
 
: [[API IsStackableAction|IsStackableAction]](<span style="font-size:smaller; color:#ecbc2a">slot</span>)
 
: [[API IsUsableAction|IsUsableAction]](<span style="font-size:smaller; color:#ecbc2a">slot</span>) - Returns 1 if an action can be used at present, nil otherwise.
 
: [[API SetActionUIButton|SetActionUIButton]](<span style="font-size:smaller; color:#ecbc2a">checkboxFrame, actionSlot, cooldownFrame</span>)
 
: [[API SetSpellbookPetAction|SetSpellbookPetAction]](<span style="font-size:smaller; color:#ecbc2a">slot, target</span>)
 
: <small>SECURE</small> [[API UseAction|UseAction]](<span style="font-size:smaller; color:#ecbc2a">slot [, checkCursor, onSelf]</span>) - This instructs the interface to use the action associated with the specified ID, optionally on the player (regardless of target).
 
: [[API UseWorldMapActionButtonSpellOnQuest|UseWorldMapActionButtonSpellOnQuest]]()
 
Flyout Buttons
 
: [[API C_ActionBar.FindFlyoutActionButtons|C_ActionBar.FindFlyoutActionButtons]](<span style="font-size:smaller; color:#ecbc2a">flyoutID</span>) : <span style="font-size:smaller; color:#4ec9b0">slots</span>
 
: [[API C_ActionBar.HasFlyoutActionButtons|C_ActionBar.HasFlyoutActionButtons]](<span style="font-size:smaller; color:#ecbc2a">flyoutID</span>) : <span style="font-size:smaller; color:#4ec9b0">hasFlyoutActionButtons</span>
 
: [[API FindFlyoutSlotBySpellID|FindFlyoutSlotBySpellID]](<span style="font-size:smaller; color:#ecbc2a">spellID</span>)
 
: [[API FlyoutHasSpell|FlyoutHasSpell]](<span style="font-size:smaller; color:#ecbc2a">flyoutID, spellID</span>)
 
: [[API GetFlyoutID|GetFlyoutID]](<span style="font-size:smaller; color:#ecbc2a">index</span>)
 
: [[API GetFlyoutInfo|GetFlyoutInfo]](<span style="font-size:smaller; color:#ecbc2a">flyoutID</span>)
 
: [[API GetFlyoutSlotInfo|GetFlyoutSlotInfo]](<span style="font-size:smaller; color:#ecbc2a">flyoutID, slot</span>)
 
: [[API GetNumFlyouts|GetNumFlyouts]]()
 
   
 
=== AddOns ===
 
=== AddOns ===
Line 310: Line 237:
 
: [[API C_AuctionHouse.IsThrottledMessageSystemReady|C_AuctionHouse.IsThrottledMessageSystemReady]]() : <span style="font-size:smaller; color:#4ec9b0">canSendThrottledMessage</span>
 
: [[API C_AuctionHouse.IsThrottledMessageSystemReady|C_AuctionHouse.IsThrottledMessageSystemReady]]() : <span style="font-size:smaller; color:#4ec9b0">canSendThrottledMessage</span>
 
: [[API C_AuctionHouse.MakeItemKey|C_AuctionHouse.MakeItemKey]](<span style="font-size:smaller; color:#ecbc2a">itemID [, itemLevel, itemSuffix, battlePetSpeciesID]</span>) : <span style="font-size:smaller; color:#4ec9b0">itemKey</span>
 
: [[API C_AuctionHouse.MakeItemKey|C_AuctionHouse.MakeItemKey]](<span style="font-size:smaller; color:#ecbc2a">itemID [, itemLevel, itemSuffix, battlePetSpeciesID]</span>) : <span style="font-size:smaller; color:#4ec9b0">itemKey</span>
: [[API C_AuctionHouse.PlaceBid|C_AuctionHouse.PlaceBid]](<span style="font-size:smaller; color:#ecbc2a">auctionID, bidAmount</span>)
+
: <small>HW</small> [[API C_AuctionHouse.PlaceBid|C_AuctionHouse.PlaceBid]](<span style="font-size:smaller; color:#ecbc2a">auctionID, bidAmount</span>) - Places a bid on a non-commodity item.
 
: <small>HW</small> [[API C_AuctionHouse.PostCommodity|C_AuctionHouse.PostCommodity]](<span style="font-size:smaller; color:#ecbc2a">item, duration, quantity, unitPrice</span>) - Posts a commodity item on the auction house.
 
: <small>HW</small> [[API C_AuctionHouse.PostCommodity|C_AuctionHouse.PostCommodity]](<span style="font-size:smaller; color:#ecbc2a">item, duration, quantity, unitPrice</span>) - Posts a commodity item on the auction house.
 
: <small>HW</small> [[API C_AuctionHouse.PostItem|C_AuctionHouse.PostItem]](<span style="font-size:smaller; color:#ecbc2a">item, duration, quantity [, bid, buyout]</span>) - Posts an item on the auction house.
 
: <small>HW</small> [[API C_AuctionHouse.PostItem|C_AuctionHouse.PostItem]](<span style="font-size:smaller; color:#ecbc2a">item, duration, quantity [, bid, buyout]</span>) - Posts an item on the auction house.
Line 321: Line 248:
 
: [[API C_AuctionHouse.RequestMoreItemSearchResults|C_AuctionHouse.RequestMoreItemSearchResults]](<span style="font-size:smaller; color:#ecbc2a">itemKey</span>) : <span style="font-size:smaller; color:#4ec9b0">hasFullResults</span>
 
: [[API C_AuctionHouse.RequestMoreItemSearchResults|C_AuctionHouse.RequestMoreItemSearchResults]](<span style="font-size:smaller; color:#ecbc2a">itemKey</span>) : <span style="font-size:smaller; color:#4ec9b0">hasFullResults</span>
 
: [[API C_AuctionHouse.RequestOwnedAuctionBidderInfo|C_AuctionHouse.RequestOwnedAuctionBidderInfo]](<span style="font-size:smaller; color:#ecbc2a">auctionID</span>) : <span style="font-size:smaller; color:#4ec9b0">bidderName</span>
 
: [[API C_AuctionHouse.RequestOwnedAuctionBidderInfo|C_AuctionHouse.RequestOwnedAuctionBidderInfo]](<span style="font-size:smaller; color:#ecbc2a">auctionID</span>) : <span style="font-size:smaller; color:#4ec9b0">bidderName</span>
: <small>HW</small> [[API C_AuctionHouse.SearchForFavorites|C_AuctionHouse.SearchForFavorites]](<span style="font-size:smaller; color:#ecbc2a">sorts</span>) - Searches for favorited items.
+
: [[API C_AuctionHouse.SearchForFavorites|C_AuctionHouse.SearchForFavorites]](<span style="font-size:smaller; color:#ecbc2a">sorts</span>) - Searches for favorited items.
 
: [[API C_AuctionHouse.SearchForItemKeys|C_AuctionHouse.SearchForItemKeys]](<span style="font-size:smaller; color:#ecbc2a">itemKeys, sorts</span>)
 
: [[API C_AuctionHouse.SearchForItemKeys|C_AuctionHouse.SearchForItemKeys]](<span style="font-size:smaller; color:#ecbc2a">itemKeys, sorts</span>)
 
: [[API C_AuctionHouse.SendBrowseQuery|C_AuctionHouse.SendBrowseQuery]](<span style="font-size:smaller; color:#ecbc2a">query</span>)
 
: [[API C_AuctionHouse.SendBrowseQuery|C_AuctionHouse.SendBrowseQuery]](<span style="font-size:smaller; color:#ecbc2a">query</span>)
: <small>HW</small> [[API C_AuctionHouse.SendSearchQuery|C_AuctionHouse.SendSearchQuery]](<span style="font-size:smaller; color:#ecbc2a">itemKey, sorts, separateOwnerItems</span>) - Queries a (commodity) item in the auction house.
+
: [[API C_AuctionHouse.SendSearchQuery|C_AuctionHouse.SendSearchQuery]](<span style="font-size:smaller; color:#ecbc2a">itemKey, sorts, separateOwnerItems</span>) - Queries an item in the auction house.
: [[API C_AuctionHouse.SendSellSearchQuery|C_AuctionHouse.SendSellSearchQuery]](<span style="font-size:smaller; color:#ecbc2a">itemKey, sorts, separateOwnerItems</span>)
+
: [[API C_AuctionHouse.SendSellSearchQuery|C_AuctionHouse.SendSellSearchQuery]](<span style="font-size:smaller; color:#ecbc2a">itemKey, sorts, separateOwnerItems</span>) - Search for all auctions that are variants of a piece of gear, determined a specific item ID.
 
: [[API C_AuctionHouse.SetFavoriteItem|C_AuctionHouse.SetFavoriteItem]](<span style="font-size:smaller; color:#ecbc2a">itemKey, setFavorite</span>)
 
: [[API C_AuctionHouse.SetFavoriteItem|C_AuctionHouse.SetFavoriteItem]](<span style="font-size:smaller; color:#ecbc2a">itemKey, setFavorite</span>)
 
: <small>HW</small> [[API C_AuctionHouse.StartCommoditiesPurchase|C_AuctionHouse.StartCommoditiesPurchase]](<span style="font-size:smaller; color:#ecbc2a">itemID, quantity</span>) - Starts a commodity item purchase.
 
: <small>HW</small> [[API C_AuctionHouse.StartCommoditiesPurchase|C_AuctionHouse.StartCommoditiesPurchase]](<span style="font-size:smaller; color:#ecbc2a">itemID, quantity</span>) - Starts a commodity item purchase.
Line 373: Line 300:
 
: [[API SetSortBagsRightToLeft|SetSortBagsRightToLeft]](<span style="font-size:smaller; color:#ecbc2a">disable</span>)
 
: [[API SetSortBagsRightToLeft|SetSortBagsRightToLeft]](<span style="font-size:smaller; color:#ecbc2a">disable</span>)
 
: [[API SortBags|SortBags]]()
 
: [[API SortBags|SortBags]]()
: <small>UI</small> {{api|OpenBag}}(<span style="font-size:smaller; color:#ecbc2a">bagID, force</span>)
+
: <small>UI</small> {{api|CloseAllBags}}(<span style="font-size:smaller; color:#ecbc2a">callingFrame, forceUpdate</span>)
  +
: <small>UI</small> {{api|CloseBackpack}}()
 
: <small>UI</small> {{api|CloseBag}}(<span style="font-size:smaller; color:#ecbc2a">bagID</span>)
 
: <small>UI</small> {{api|CloseBag}}(<span style="font-size:smaller; color:#ecbc2a">bagID</span>)
  +
: <small>UI</small> {{api|IsBagOpen}}(<span style="font-size:smaller; color:#ecbc2a">bagID</span>)
 
: <small>UI</small> {{api|OpenAllBags}}(<span style="font-size:smaller; color:#ecbc2a">callingFrame, forceUpdate</span>)
 
: <small>UI</small> {{api|OpenAllBags}}(<span style="font-size:smaller; color:#ecbc2a">callingFrame, forceUpdate</span>)
: <small>UI</small> {{api|CloseAllBags}}(<span style="font-size:smaller; color:#ecbc2a">callingFrame, forceUpdate</span>)
+
: <small>UI</small> {{api|OpenBackpack}}()
  +
: <small>UI</small> {{api|OpenBag}}(<span style="font-size:smaller; color:#ecbc2a">bagID, force</span>)
 
: <small>UI</small> {{api|ToggleAllBags}}()
 
: <small>UI</small> {{api|ToggleAllBags}}()
: <small>UI</small> {{api|IsBagOpen}}(<span style="font-size:smaller; color:#ecbc2a">bagID</span>)
+
: <small>UI</small> {{api|ToggleBackpack}}() - Toggles your backpack open/closed.
  +
: <small>UI</small> {{api|ToggleBag|ToggleBag}}(<span style="font-size:smaller; color:#ecbc2a">bagID</span>) - Opens or closes the specified bag.
   
 
==== Containers ====
 
==== Containers ====
Line 401: Line 332:
 
==== Inventory ====
 
==== Inventory ====
 
These functions manage your inventory, specifically '''equipped items'''.
 
These functions manage your inventory, specifically '''equipped items'''.
: [[API BankButtonIDToInvSlotID|BankButtonIDToInvSlotID]](<span style="font-size:smaller; color:#ecbc2a">buttonID, isBag</span>) - Returns the ID number of a bank button or bag in terms of inventory slot ID.
 
 
: [[API CancelPendingEquip|CancelPendingEquip]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - This function is used to cancel a pending equip.
 
: [[API CancelPendingEquip|CancelPendingEquip]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - This function is used to cancel a pending equip.
: <small>SECURE</small> [[API ConfirmBindOnUse|ConfirmBindOnUse]]()
+
: <small>PROTECTED</small> [[API ConfirmBindOnUse|ConfirmBindOnUse]]()
: <small>SECURE</small> [[API ConfirmNoRefundOnUse|ConfirmNoRefundOnUse]]()
+
: <small>PROTECTED</small> [[API ConfirmNoRefundOnUse|ConfirmNoRefundOnUse]]()
 
: [[API ContainerIDToInventoryID|ContainerIDToInventoryID]](<span style="font-size:smaller; color:#ecbc2a">bagID</span>)
 
: [[API ContainerIDToInventoryID|ContainerIDToInventoryID]](<span style="font-size:smaller; color:#ecbc2a">bagID</span>)
 
: [[API EquipPendingItem|EquipPendingItem]](<span style="font-size:smaller; color:#ecbc2a">invSlot</span>) - Equips the currently pending Bind-on-Equip or Bind-on-Pickup item from the specified inventory slot.
 
: [[API EquipPendingItem|EquipPendingItem]](<span style="font-size:smaller; color:#ecbc2a">invSlot</span>) - Equips the currently pending Bind-on-Equip or Bind-on-Pickup item from the specified inventory slot.
Line 412: Line 342:
 
: [[API GetInventoryItemCooldown|GetInventoryItemCooldown]](<span style="font-size:smaller; color:#ecbc2a">unit, invSlot</span>) - Get cooldown information for an inventory item.
 
: [[API GetInventoryItemCooldown|GetInventoryItemCooldown]](<span style="font-size:smaller; color:#ecbc2a">unit, invSlot</span>) - Get cooldown information for an inventory item.
 
: [[API GetInventoryItemCount|GetInventoryItemCount]](<span style="font-size:smaller; color:#ecbc2a">unit, invSlot</span>) - Determine the quantity of an item in an inventory slot.
 
: [[API GetInventoryItemCount|GetInventoryItemCount]](<span style="font-size:smaller; color:#ecbc2a">unit, invSlot</span>) - Determine the quantity of an item in an inventory slot.
: [[API GetInventoryItemDurability|GetInventoryItemDurability]](<span style="font-size:smaller; color:#ecbc2a">|invSlot</span>) - Returns the maximum and remaining durability points for an inventory item.
+
: [[API GetInventoryItemDurability|GetInventoryItemDurability]](<span style="font-size:smaller; color:#ecbc2a">invSlot</span>) - Returns the maximum and remaining durability points for an inventory item.
 
: [[API GetInventoryItemID|GetInventoryItemID]](<span style="font-size:smaller; color:#ecbc2a">unit, invSlot</span>) - Returns the item id of the item in the specified inventory slot.
 
: [[API GetInventoryItemID|GetInventoryItemID]](<span style="font-size:smaller; color:#ecbc2a">unit, invSlot</span>) - Returns the item id of the item in the specified inventory slot.
 
: [[API GetInventoryItemLink|GetInventoryItemLink]](<span style="font-size:smaller; color:#ecbc2a">unit, invSlot</span>) - Returns an [[itemLink]] for an inventory (equipped) item.
 
: [[API GetInventoryItemLink|GetInventoryItemLink]](<span style="font-size:smaller; color:#ecbc2a">unit, invSlot</span>) - Returns an [[itemLink]] for an inventory (equipped) item.
Line 422: Line 352:
 
: [[API SetInventoryPortraitTexture|SetInventoryPortraitTexture]](<span style="font-size:smaller; color:#ecbc2a">texture, unit, slot</span>)
 
: [[API SetInventoryPortraitTexture|SetInventoryPortraitTexture]](<span style="font-size:smaller; color:#ecbc2a">texture, unit, slot</span>)
 
: [[API UpdateInventoryAlertStatus|UpdateInventoryAlertStatus]]()
 
: [[API UpdateInventoryAlertStatus|UpdateInventoryAlertStatus]]()
: <small>SECURE</small> [[API UseInventoryItem|UseInventoryItem]](<span style="font-size:smaller; color:#ecbc2a">invSlot</span>) - Use an item in a specific inventory slot.
+
: <small>PROTECTED</small> [[API UseInventoryItem|UseInventoryItem]](<span style="font-size:smaller; color:#ecbc2a">invSlot</span>) - Use an item in a specific inventory slot.
   
 
=== Bank ===
 
=== Bank ===
 
Relates to the [[Bank]].
 
Relates to the [[Bank]].
  +
: [[API BankButtonIDToInvSlotID|BankButtonIDToInvSlotID]](<span style="font-size:smaller; color:#ecbc2a">buttonID, isBag</span>) - Returns the ID number of a bank button or bag in terms of inventory slot ID.
 
: [[API BuyReagentBank|BuyReagentBank]]()
 
: [[API BuyReagentBank|BuyReagentBank]]()
 
: [[API CloseBankFrame|CloseBankFrame]]() - Close the bank frame if it's open.
 
: [[API CloseBankFrame|CloseBankFrame]]() - Close the bank frame if it's open.
Line 480: Line 411:
 
: [[API WithdrawGuildBankMoney|WithdrawGuildBankMoney]](<span style="font-size:smaller; color:#ecbc2a">money</span>) - Withdraws "money" copper from the guild bank.
 
: [[API WithdrawGuildBankMoney|WithdrawGuildBankMoney]](<span style="font-size:smaller; color:#ecbc2a">money</span>) - Withdraws "money" copper from the guild bank.
   
=== Barber Shop ===
+
==== Void Storage ====
The [[Barbershop]] was added in [[Patch 3.0.2]]
+
[[Void Storage]] was added in [[Patch 4.3.0]]
  +
: [[API CanUseVoidStorage|CanUseVoidStorage]]() - Returns if the player has access to the Void Storage.
: [[API C_BarberShop.ApplyCustomizationChoices|C_BarberShop.ApplyCustomizationChoices]]() : <span style="font-size:smaller; color:#4ec9b0">success</span>
 
  +
: [[API ClearVoidTransferDepositSlot|ClearVoidTransferDepositSlot]](<span style="font-size:smaller; color:#ecbc2a">slotIndex</span>) - Clears the specified Void Transfer deposit slot.
: [[API C_BarberShop.Cancel|C_BarberShop.Cancel]]()
 
  +
: [[API ClickVoidStorageSlot|ClickVoidStorageSlot]](<span style="font-size:smaller; color:#ecbc2a">slotIndex [, isRightClick]</span>) - Clicks the specified Void Storage slot.
: [[API C_BarberShop.ClearPreviewChoices|C_BarberShop.ClearPreviewChoices]]()
 
: [[API C_BarberShop.GetAvailableCustomizations|C_BarberShop.GetAvailableCustomizations]]() : <span style="font-size:smaller; color:#4ec9b0">categories</span>
+
: [[API ClickVoidTransferDepositSlot|ClickVoidTransferDepositSlot]](<span style="font-size:smaller; color:#ecbc2a">slotIndex [, isRightClick]</span>) - Clicks the specified Void Transfer deposit slot.
: [[API C_BarberShop.GetCurrentCameraZoom|C_BarberShop.GetCurrentCameraZoom]]() : <span style="font-size:smaller; color:#4ec9b0">zoomLevel</span>
+
: [[API ClickVoidTransferWithdrawalSlot|ClickVoidTransferWithdrawalSlot]](<span style="font-size:smaller; color:#ecbc2a">slotIndex [, isRightClick]</span>) - Clicks the specified Void Transfer withdrawal slot.
  +
: [[API CloseVoidStorageFrame|CloseVoidStorageFrame]]()
: [[API C_BarberShop.GetCurrentCharacterData|C_BarberShop.GetCurrentCharacterData]]() : <span style="font-size:smaller; color:#4ec9b0">characterData</span>
 
  +
: [[API ExecuteVoidTransfer|ExecuteVoidTransfer]]() - Applies all pending void transfers (and pays for the cost of any deposited items).
: [[API C_BarberShop.GetCurrentCost|C_BarberShop.GetCurrentCost]]() : <span style="font-size:smaller; color:#4ec9b0">cost</span>
 
  +
: [[API GetNumVoidTransferDeposit|GetNumVoidTransferDeposit]]() - Returns the number of items being deposited into the Void Storage.
: [[API C_BarberShop.HasAnyChanges|C_BarberShop.HasAnyChanges]]() : <span style="font-size:smaller; color:#4ec9b0">hasChanges</span>
 
  +
: [[API GetNumVoidTransferWithdrawal|GetNumVoidTransferWithdrawal]]() - Returns the number of items being withdrawed from the Void Storage.
: [[API C_BarberShop.IsViewingAlteredForm|C_BarberShop.IsViewingAlteredForm]]() : <span style="font-size:smaller; color:#4ec9b0">isViewingAlteredForm</span>
 
  +
: [[API GetVoidItemHyperlinkString|GetVoidItemHyperlinkString]](<span style="font-size:smaller; color:#ecbc2a">slotIndex</span>) - Returns the item link of an item in void storage.
: [[API C_BarberShop.OldBarberShopLoaded|C_BarberShop.OldBarberShopLoaded]]()
 
: [[API C_BarberShop.PreviewCustomizationChoice|C_BarberShop.PreviewCustomizationChoice]](<span style="font-size:smaller; color:#ecbc2a">optionID, choiceID</span>)
+
: [[API GetVoidItemInfo|GetVoidItemInfo]](<span style="font-size:smaller; color:#ecbc2a">slotIndex</span>) - Returns <code>itemID, textureName, locked, recentDeposit, isFiltered</code>.
  +
: [[API GetVoidTransferCost|GetVoidTransferCost]]() - Returns the total Void Transfer cost.
: [[API C_BarberShop.ResetCameraRotation|C_BarberShop.ResetCameraRotation]]()
 
  +
: [[API GetVoidTransferDepositInfo|GetVoidTransferDepositInfo]](<span style="font-size:smaller; color:#ecbc2a">slotIndex</span>) - Returns <code>itemID, textureName</code>.
: [[API C_BarberShop.ResetCustomizationChoices|C_BarberShop.ResetCustomizationChoices]]()
 
: [[API C_BarberShop.RotateCamera|C_BarberShop.RotateCamera]](<span style="font-size:smaller; color:#ecbc2a">diffDegrees</span>)
+
: [[API GetVoidTransferWithdrawalInfo|GetVoidTransferWithdrawalInfo]](<span style="font-size:smaller; color:#ecbc2a">slotIndex</span>) - Returns <code>itemID, textureName</code>.
  +
: [[API IsVoidStorageReady|IsVoidStorageReady]]()
: [[API C_BarberShop.SetCameraDistanceOffset|C_BarberShop.SetCameraDistanceOffset]](<span style="font-size:smaller; color:#ecbc2a">offset</span>)
 
  +
: [[API UnlockVoidStorage|UnlockVoidStorage]]() - Pays for and activates the Void Storage.
: [[API C_BarberShop.SetCameraZoomLevel|C_BarberShop.SetCameraZoomLevel]](<span style="font-size:smaller; color:#ecbc2a">zoomLevel [, keepCustomZoom]</span>)
 
: [[API C_BarberShop.SetCustomizationChoice|C_BarberShop.SetCustomizationChoice]](<span style="font-size:smaller; color:#ecbc2a">optionID, choiceID</span>)
+
: [[API GetVoidStorageSlotPageIndex|GetVoidStorageSlotPageIndex]](<span style="font-size:smaller; color:#ecbc2a">slot</span>)
  +
: [[API GetVoidUnlockCost|GetVoidUnlockCost]]()
: [[API C_BarberShop.SetModelDressState|C_BarberShop.SetModelDressState]](<span style="font-size:smaller; color:#ecbc2a">dressedState</span>)
 
: [[API C_BarberShop.SetSelectedSex|C_BarberShop.SetSelectedSex]](<span style="font-size:smaller; color:#ecbc2a">sex</span>)
 
: [[API C_BarberShop.SetViewingAlteredForm|C_BarberShop.SetViewingAlteredForm]](<span style="font-size:smaller; color:#ecbc2a">isViewingAlteredForm</span>)
 
: [[API C_BarberShop.SetViewingShapeshiftForm|C_BarberShop.SetViewingShapeshiftForm]](<span style="font-size:smaller; color:#ecbc2a">[shapeshiftFormID]</span>)
 
: [[API C_BarberShop.ZoomCamera|C_BarberShop.ZoomCamera]](<span style="font-size:smaller; color:#ecbc2a">zoomAmount</span>)
 
: [[API ApplyBarberShopStyle|ApplyBarberShopStyle]]() - Purchase and apply the cosmetic changes.
 
: [[API BarberShopReset|BarberShopReset]]() - Reset any changes made in the Barber Shop.
 
: [[API CancelBarberShop|CancelBarberShop]]() - Exit the Barber Shop chair.
 
: [[API GetBarberShopStyleInfo|GetBarberShopStyleInfo]](<span style="font-size:smaller; color:#ecbc2a">id</span>) - Returns information about the currently selected style.
 
: [[API GetBarberShopTotalCost|GetBarberShopTotalCost]]() - Returns the total costs of the cosmetic changes.
 
: [[API GetCustomizationDetails|GetCustomizationDetails]](<span style="font-size:smaller; color:#ecbc2a">customizationIndex</span>)
 
: [[API IsBarberShopStyleValid|IsBarberShopStyleValid]]()
 
: [[API SetBarberShopAlternateFormFrame|SetBarberShopAlternateFormFrame]]()
 
: [[API SetNextBarberShopStyle|SetNextBarberShopStyle]](<span style="font-size:smaller; color:#ecbc2a">id [, reverse]</span>) - Alters style selection in a particular category.
 
   
 
=== Books ===
 
=== Books ===
Line 528: Line 446:
   
 
=== Calendar ===
 
=== Calendar ===
The [[Calendar]] was added in [[Patch 3.0.1]]
+
The [[Calendar]] was added in [[Patch 3.0.1]] and reworked in [[Patch 8.0.1]]
 
: <small>HW</small> [[API C_Calendar.AddEvent|C_Calendar.AddEvent]]() - Saves the new event currently being created to the server.
 
: <small>HW</small> [[API C_Calendar.AddEvent|C_Calendar.AddEvent]]() - Saves the new event currently being created to the server.
 
: [[API C_Calendar.AreNamesReady|C_Calendar.AreNamesReady]]() : <span style="font-size:smaller; color:#4ec9b0">ready</span>
 
: [[API C_Calendar.AreNamesReady|C_Calendar.AreNamesReady]]() : <span style="font-size:smaller; color:#4ec9b0">ready</span>
Line 621: Line 539:
 
: <small>HW</small> [[API C_Calendar.UpdateEvent|C_Calendar.UpdateEvent]]() - Saves the selected event.
 
: <small>HW</small> [[API C_Calendar.UpdateEvent|C_Calendar.UpdateEvent]]() - Saves the selected event.
   
=== Camera ===
+
=== Chat ===
  +
These are specific to chat messages and channels.
: <small>SECURE</small> [[API CameraOrSelectOrMoveStart|CameraOrSelectOrMoveStart]]() - Begin "Left click" in the 3D world.
 
: <small>SECURE</small> [[API CameraOrSelectOrMoveStop|CameraOrSelectOrMoveStop]](<span style="font-size:smaller; color:#ecbc2a">[stickyFlag]</span>) - End "Left click" in the 3D world.
 
: [[API CameraZoomIn|CameraZoomIn]](<span style="font-size:smaller; color:#ecbc2a">increment</span>) - Zooms the camera into the viewplane by increment.
 
: [[API CameraZoomOut|CameraZoomOut]](<span style="font-size:smaller; color:#ecbc2a">increment</span>) - Zooms the camera out of the viewplane by increment.
 
: [[API CenterCamera|CenterCamera]]()
 
: [[API FlipCameraYaw|FlipCameraYaw]](<span style="font-size:smaller; color:#ecbc2a">degrees</span>) - Rotates the camera about the Z-axis by the angle amount specified in degrees.
 
: [[API GetCameraZoom|GetCameraZoom]]() - Returns the current zoom level, ignoring camera collisions.
 
: [[API IsMouselooking|IsMouselooking]]() - Returns 1 if mouselook is currently active, nil otherwise.
 
: [[API MouselookStart|MouselookStart]]() - Enters mouse look mode; mouse movement is used to adjust movement/facing direction.
 
: [[API MouselookStop|MouselookStop]]() - Exits mouse look mode; mouse movement is used to move the mouse cursor.
 
: [[API MoveViewDownStart|MoveViewDownStart]]() - Begins rotating the camera downward.
 
: [[API MoveViewDownStop|MoveViewDownStop]]() - Stops rotating the camera after [[API MoveViewDownStart|MoveViewDownStart]]() is called.
 
: [[API MoveViewInStart|MoveViewInStart]]() - Begins zooming the camera in.
 
: [[API MoveViewInStop|MoveViewInStop]]() - Stops zooming the camera in after [[API MoveViewInStart|MoveViewInStart]]() is called.
 
: [[API MoveViewLeftStart|MoveViewLeftStart]]() - Begins rotating the camera to the Left.
 
: [[API MoveViewLeftStop|MoveViewLeftStop]]() - Stops rotating the camera after [[API MoveViewLeftStart|MoveViewLeftStart]]() is called.
 
: [[API MoveViewOutStart|MoveViewOutStart]]() - Begins zooming the camera out.
 
: [[API MoveViewOutStop|MoveViewOutStop]]() - Stops zooming the camera out after [[API MoveViewOutStart|MoveViewOutStart]]() is called.
 
: [[API MoveViewRightStart|MoveViewRightStart]]() - Begins rotating the camera to the Right.
 
: [[API MoveViewRightStop|MoveViewRightStop]]() - Stops rotating the camera after [[API MoveViewRightStart|MoveViewRightStart]]() is called.
 
: [[API MoveViewUpStart|MoveViewUpStart]]() - Begins rotating the camera upward.
 
: [[API MoveViewUpStop|MoveViewUpStop]]() - Stops rotating the camera after [[API MoveViewUpStart|MoveViewUpStart]]() is called.
 
: <small>SECURE</small> [[API PitchDownStart|PitchDownStart]]() - Begins pitching the camera Downward.
 
: <small>SECURE</small> [[API PitchDownStop|PitchDownStop]]() - Stops pitching the camera after [[API PitchDownStart|PitchDownStart]]() is called.
 
: <small>SECURE</small> [[API PitchUpStart|PitchUpStart]]() - Begins pitching the camera Upward.
 
: <small>SECURE</small> [[API PitchUpStop|PitchUpStop]]() - Stops pitching the camera after [[API PitchUpStart|PitchUpStart]]() is called.
 
: [[API NextView|NextView]]() - Cycles forward through the five predefined camera positions.
 
: [[API PrevView|PrevView]]() - Cycles backward through the five predefined camera positions.
 
: [[API ResetView|ResetView]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Resets the specified (1-5) predefined camera position to it's default if it was changed using [[API SaveView|SaveView]](index).
 
: [[API SaveView|SaveView]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Replaces the specified (1-5) predefined camera positions with the current camera position.
 
: [[API SetView|SetView]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Sets camera position to a specified (1-5) predefined camera position.
 
 
=== Channels ===
 
These are chat functions which are specific to channels.
 
 
: [[API C_ChatInfo.GetChannelRosterInfo|C_ChatInfo.GetChannelRosterInfo]](<span style="font-size:smaller; color:#ecbc2a">channelIndex, rosterIndex</span>) : <span style="font-size:smaller; color:#4ec9b0">name, owner, moderator, guid</span>
 
: [[API C_ChatInfo.GetChannelRosterInfo|C_ChatInfo.GetChannelRosterInfo]](<span style="font-size:smaller; color:#ecbc2a">channelIndex, rosterIndex</span>) : <span style="font-size:smaller; color:#4ec9b0">name, owner, moderator, guid</span>
 
: [[API C_ChatInfo.GetChannelRuleset|C_ChatInfo.GetChannelRuleset]](<span style="font-size:smaller; color:#ecbc2a">channelIndex</span>) : <span style="font-size:smaller; color:#4ec9b0">ruleset</span>
 
: [[API C_ChatInfo.GetChannelRuleset|C_ChatInfo.GetChannelRuleset]](<span style="font-size:smaller; color:#ecbc2a">channelIndex</span>) : <span style="font-size:smaller; color:#4ec9b0">ruleset</span>
Line 666: Line 551:
 
: [[API C_ChatInfo.GetMentorChannelID|C_ChatInfo.GetMentorChannelID]]() : <span style="font-size:smaller; color:#4ec9b0">channelID</span>
 
: [[API C_ChatInfo.GetMentorChannelID|C_ChatInfo.GetMentorChannelID]]() : <span style="font-size:smaller; color:#4ec9b0">channelID</span>
 
: [[API C_ChatInfo.GetNumActiveChannels|C_ChatInfo.GetNumActiveChannels]]() : <span style="font-size:smaller; color:#4ec9b0">numChannels</span>
 
: [[API C_ChatInfo.GetNumActiveChannels|C_ChatInfo.GetNumActiveChannels]]() : <span style="font-size:smaller; color:#4ec9b0">numChannels</span>
: [[API C_ChatInfo.GetRegisteredAddonMessagePrefixes|C_ChatInfo.GetRegisteredAddonMessagePrefixes]]() : <span style="font-size:smaller; color:#4ec9b0">registeredPrefixes</span> - Returns addon message prefixes the client is currently registered to receive.
 
: [[API C_ChatInfo.IsAddonMessagePrefixRegistered|C_ChatInfo.IsAddonMessagePrefixRegistered]](<span style="font-size:smaller; color:#ecbc2a">prefix</span>) : <span style="font-size:smaller; color:#4ec9b0">isRegistered</span> - Returns whether the prefix is registered.
 
 
: [[API C_ChatInfo.IsChannelRegional|C_ChatInfo.IsChannelRegional]](<span style="font-size:smaller; color:#ecbc2a">channelIndex</span>) : <span style="font-size:smaller; color:#4ec9b0">isRegional</span>
 
: [[API C_ChatInfo.IsChannelRegional|C_ChatInfo.IsChannelRegional]](<span style="font-size:smaller; color:#ecbc2a">channelIndex</span>) : <span style="font-size:smaller; color:#4ec9b0">isRegional</span>
 
: [[API C_ChatInfo.IsChannelRegionalForChannelID|C_ChatInfo.IsChannelRegionalForChannelID]](<span style="font-size:smaller; color:#ecbc2a">channelID</span>) : <span style="font-size:smaller; color:#4ec9b0">isRegional</span>
 
: [[API C_ChatInfo.IsChannelRegionalForChannelID|C_ChatInfo.IsChannelRegionalForChannelID]](<span style="font-size:smaller; color:#ecbc2a">channelID</span>) : <span style="font-size:smaller; color:#4ec9b0">isRegional</span>
Line 673: Line 556:
 
: [[API C_ChatInfo.IsRegionalServiceAvailable|C_ChatInfo.IsRegionalServiceAvailable]]() : <span style="font-size:smaller; color:#4ec9b0">available</span>
 
: [[API C_ChatInfo.IsRegionalServiceAvailable|C_ChatInfo.IsRegionalServiceAvailable]]() : <span style="font-size:smaller; color:#4ec9b0">available</span>
 
: [[API C_ChatInfo.IsValidChatLine|C_ChatInfo.IsValidChatLine]](<span style="font-size:smaller; color:#ecbc2a">[chatLine]</span>) : <span style="font-size:smaller; color:#4ec9b0">isValid</span>
 
: [[API C_ChatInfo.IsValidChatLine|C_ChatInfo.IsValidChatLine]](<span style="font-size:smaller; color:#ecbc2a">[chatLine]</span>) : <span style="font-size:smaller; color:#4ec9b0">isValid</span>
: [[API C_ChatInfo.RegisterAddonMessagePrefix|C_ChatInfo.RegisterAddonMessagePrefix]](<span style="font-size:smaller; color:#ecbc2a">prefix</span>) : <span style="font-size:smaller; color:#4ec9b0">successfulRequest</span> - Registers an addon message prefix.
 
 
: [[API C_ChatInfo.ReplaceIconAndGroupExpressions|C_ChatInfo.ReplaceIconAndGroupExpressions]](<span style="font-size:smaller; color:#ecbc2a">input [, noIconReplacement, noGroupReplacement]</span>) : <span style="font-size:smaller; color:#4ec9b0">output</span> - Replaces icon and group tags like {rt4}, {diamond} and {g1}.
 
: [[API C_ChatInfo.ReplaceIconAndGroupExpressions|C_ChatInfo.ReplaceIconAndGroupExpressions]](<span style="font-size:smaller; color:#ecbc2a">input [, noIconReplacement, noGroupReplacement]</span>) : <span style="font-size:smaller; color:#4ec9b0">output</span> - Replaces icon and group tags like {rt4}, {diamond} and {g1}.
 
: [[API C_ChatInfo.ResetDefaultZoneChannels|C_ChatInfo.ResetDefaultZoneChannels]]()
 
: [[API C_ChatInfo.ResetDefaultZoneChannels|C_ChatInfo.ResetDefaultZoneChannels]]()
: [[API C_ChatInfo.SendAddonMessage|C_ChatInfo.SendAddonMessage]](<span style="font-size:smaller; color:#ecbc2a">prefix, message [, chatType, target]</span>) : <span style="font-size:smaller; color:#4ec9b0">success</span> - Sends a message to the hidden addon channel.
 
: [[API C_ChatInfo.SendAddonMessageLogged|C_ChatInfo.SendAddonMessageLogged]](<span style="font-size:smaller; color:#ecbc2a">prefix, message [, chatType, target]</span>) : <span style="font-size:smaller; color:#4ec9b0">success</span> - Sends a message to the hidden addon channel, the messages are logged server side.
 
 
: [[API C_ChatInfo.SwapChatChannelsByChannelIndex|C_ChatInfo.SwapChatChannelsByChannelIndex]](<span style="font-size:smaller; color:#ecbc2a">firstChannelIndex, secondChannelIndex</span>)
 
: [[API C_ChatInfo.SwapChatChannelsByChannelIndex|C_ChatInfo.SwapChatChannelsByChannelIndex]](<span style="font-size:smaller; color:#ecbc2a">firstChannelIndex, secondChannelIndex</span>)
 
: [[API C_ChatBubbles.GetAllChatBubbles|C_ChatBubbles.GetAllChatBubbles]](<span style="font-size:smaller; color:#ecbc2a">[includeForbidden]</span>) : <span style="font-size:smaller; color:#4ec9b0">chatBubbles</span> - Returns all active chat bubbles.
 
: [[API C_ChatBubbles.GetAllChatBubbles|C_ChatBubbles.GetAllChatBubbles]](<span style="font-size:smaller; color:#ecbc2a">[includeForbidden]</span>) : <span style="font-size:smaller; color:#4ec9b0">chatBubbles</span> - Returns all active chat bubbles.
Line 720: Line 600:
   
 
==== Chat Window ====
 
==== Chat Window ====
These are functions which are specific to chat ''window'' management.
+
These are specific to chat ''window'' management.
 
: [[API AddChatWindowChannel|AddChatWindowChannel]](<span style="font-size:smaller; color:#ecbc2a">chatFrameIndex, channel</span>) - Make a chat channel visible in a specific ChatFrame.
 
: [[API AddChatWindowChannel|AddChatWindowChannel]](<span style="font-size:smaller; color:#ecbc2a">chatFrameIndex, channel</span>) - Make a chat channel visible in a specific ChatFrame.
 
: [[API AddChatWindowMessages|AddChatWindowMessages]]() - Adds a messaging group to the specified chat window.
 
: [[API AddChatWindowMessages|AddChatWindowMessages]]() - Adds a messaging group to the specified chat window.
 
: [[API ChangeChatColor|ChangeChatColor]](<span style="font-size:smaller; color:#ecbc2a">channelName, r, g, b</span>) - Update the color for a type of chat message.
 
: [[API ChangeChatColor|ChangeChatColor]](<span style="font-size:smaller; color:#ecbc2a">channelName, r, g, b</span>) - Update the color for a type of chat message.
: [[API GetAutoCompleteResults|GetAutoCompleteResults]](<span style="font-size:smaller; color:#ecbc2a">text, include, exclude, maxResults [, cursorPosition]</span>) - Returns possible player names matching a given prefix string and specified requirements.
 
 
: [[API GetChatTypeIndex|GetChatTypeIndex]](<span style="font-size:smaller; color:#ecbc2a">type</span>) - Get the numeric ID of a type of chat message.
 
: [[API GetChatTypeIndex|GetChatTypeIndex]](<span style="font-size:smaller; color:#ecbc2a">type</span>) - Get the numeric ID of a type of chat message.
 
: [[API GetChatWindowChannels|GetChatWindowChannels]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Get the chat channels received by a chat window.
 
: [[API GetChatWindowChannels|GetChatWindowChannels]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Get the chat channels received by a chat window.
Line 752: Line 631:
 
: <small>UI</small> [[API ChatFrame_OnHyperlinkShow|ChatFrame_OnHyperlinkShow]](<span style="font-size:smaller; color:#ecbc2a">reference, link, button</span>) - Called when the user clicks on a chatlink.
 
: <small>UI</small> [[API ChatFrame_OnHyperlinkShow|ChatFrame_OnHyperlinkShow]](<span style="font-size:smaller; color:#ecbc2a">reference, link, button</span>) - Called when the user clicks on a chatlink.
 
: <small>UI</small> [[API ChatFrame_RemoveMessageEventFilter|ChatFrame_RemoveMessageEventFilter]](<span style="font-size:smaller; color:#ecbc2a">event, filterFunc</span>) - Unregister a chat message filtering function.
 
: <small>UI</small> [[API ChatFrame_RemoveMessageEventFilter|ChatFrame_RemoveMessageEventFilter]](<span style="font-size:smaller; color:#ecbc2a">event, filterFunc</span>) - Unregister a chat message filtering function.
  +
  +
==== AddOn Messages ====
  +
: [[API C_ChatInfo.GetRegisteredAddonMessagePrefixes|C_ChatInfo.GetRegisteredAddonMessagePrefixes]]() : <span style="font-size:smaller; color:#4ec9b0">registeredPrefixes</span> - Returns addon message prefixes the client is currently registered to receive.
  +
: [[API C_ChatInfo.IsAddonMessagePrefixRegistered|C_ChatInfo.IsAddonMessagePrefixRegistered]](<span style="font-size:smaller; color:#ecbc2a">prefix</span>) : <span style="font-size:smaller; color:#4ec9b0">isRegistered</span> - Returns whether the prefix is registered.
  +
: [[API C_ChatInfo.RegisterAddonMessagePrefix|C_ChatInfo.RegisterAddonMessagePrefix]](<span style="font-size:smaller; color:#ecbc2a">prefix</span>) : <span style="font-size:smaller; color:#4ec9b0">successfulRequest</span> - Registers an addon message prefix.
  +
: [[API C_ChatInfo.SendAddonMessage|C_ChatInfo.SendAddonMessage]](<span style="font-size:smaller; color:#ecbc2a">prefix, message [, chatType, target]</span>) : <span style="font-size:smaller; color:#4ec9b0">success</span> - Sends a message to the hidden addon channel.
  +
: [[API C_ChatInfo.SendAddonMessageLogged|C_ChatInfo.SendAddonMessageLogged]](<span style="font-size:smaller; color:#ecbc2a">prefix, message [, chatType, target]</span>) : <span style="font-size:smaller; color:#4ec9b0">success</span> - Sends a message to the hidden addon channel, the messages are logged server side.
   
 
==== Communities ====
 
==== Communities ====
Line 889: Line 775:
 
: [[API C_ClubFinder.SetRecruitmentSettings|C_ClubFinder.SetRecruitmentSettings]](<span style="font-size:smaller; color:#ecbc2a">index, checked</span>)
 
: [[API C_ClubFinder.SetRecruitmentSettings|C_ClubFinder.SetRecruitmentSettings]](<span style="font-size:smaller; color:#ecbc2a">index, checked</span>)
 
: [[API C_ClubFinder.ShouldShowClubFinder|C_ClubFinder.ShouldShowClubFinder]]() : <span style="font-size:smaller; color:#4ec9b0">shouldShow</span>
 
: [[API C_ClubFinder.ShouldShowClubFinder|C_ClubFinder.ShouldShowClubFinder]]() : <span style="font-size:smaller; color:#4ec9b0">shouldShow</span>
  +
  +
==== Reporting ====
  +
: [[API C_ReportSystem.CanReportPlayer|C_ReportSystem.CanReportPlayer]](<span style="font-size:smaller; color:#ecbc2a">playerLocation</span>) : <span style="font-size:smaller; color:#4ec9b0">canReport</span> - Returns if a player can be reported.
  +
: [[API C_ReportSystem.CanReportPlayerForLanguage|C_ReportSystem.CanReportPlayerForLanguage]](<span style="font-size:smaller; color:#ecbc2a">playerLocation</span>) : <span style="font-size:smaller; color:#4ec9b0">canReport</span>
  +
: <small>PROTECTED</small> [[API C_ReportSystem.InitiateReportPlayer|C_ReportSystem.InitiateReportPlayer]](<span style="font-size:smaller; color:#ecbc2a">complaintType [, playerLocation]</span>) : <span style="font-size:smaller; color:#4ec9b0">token</span> - Initiates a report against a player.
  +
: [[API C_ReportSystem.OpenReportPlayerDialog|C_ReportSystem.OpenReportPlayerDialog]](<span style="font-size:smaller; color:#ecbc2a">reportType, playerName [, playerLocation]</span>) - Opens a dialog for reporting a player.
  +
: [[API C_ReportSystem.ReportServerLag|C_ReportSystem.ReportServerLag]]()
  +
: [[API C_ReportSystem.ReportStuckInCombat|C_ReportSystem.ReportStuckInCombat]]()
  +
: <small>PROTECTED</small> [[API C_ReportSystem.SendReportPlayer|C_ReportSystem.SendReportPlayer]](<span style="font-size:smaller; color:#ecbc2a">token [, comment]</span>) - Sends an initiated report against a player.
  +
: [[API C_ReportSystem.SetPendingReportPetTarget|C_ReportSystem.SetPendingReportPetTarget]](<span style="font-size:smaller; color:#ecbc2a">[target]</span>) : <span style="font-size:smaller; color:#4ec9b0">set</span> - Report a pet for an inappropriate name.
  +
: [[API C_ReportSystem.SetPendingReportTarget|C_ReportSystem.SetPendingReportTarget]](<span style="font-size:smaller; color:#ecbc2a">[target]</span>) : <span style="font-size:smaller; color:#4ec9b0">set</span>
  +
: [[API C_ReportSystem.SetPendingReportTargetByGuid|C_ReportSystem.SetPendingReportTargetByGuid]](<span style="font-size:smaller; color:#ecbc2a">[guid]</span>) : <span style="font-size:smaller; color:#4ec9b0">set</span>
  +
Restrictions
  +
: [[API C_SocialRestrictions.IsMuted|C_SocialRestrictions.IsMuted]]() : <span style="font-size:smaller; color:#4ec9b0">isMuted</span>
  +
: [[API C_SocialRestrictions.IsSilenced|C_SocialRestrictions.IsSilenced]]() : <span style="font-size:smaller; color:#4ec9b0">isSilenced</span>
  +
: [[API C_SocialRestrictions.IsSquelched|C_SocialRestrictions.IsSquelched]]() : <span style="font-size:smaller; color:#4ec9b0">isSquelched</span>
   
 
==== Voice Chat ====
 
==== Voice Chat ====
Line 971: Line 873:
 
: [[API C_Social.GetTweetLength|C_Social.GetTweetLength]](<span style="font-size:smaller; color:#ecbc2a">tweetText</span>) : <span style="font-size:smaller; color:#4ec9b0">tweetLength</span>
 
: [[API C_Social.GetTweetLength|C_Social.GetTweetLength]](<span style="font-size:smaller; color:#ecbc2a">tweetText</span>) : <span style="font-size:smaller; color:#4ec9b0">tweetLength</span>
 
: [[API C_Social.IsSocialEnabled|C_Social.IsSocialEnabled]]() : <span style="font-size:smaller; color:#4ec9b0">isEnabled</span>
 
: [[API C_Social.IsSocialEnabled|C_Social.IsSocialEnabled]]() : <span style="font-size:smaller; color:#4ec9b0">isEnabled</span>
: <small>SECURE</small> [[API C_Social.RegisterSocialBrowser|C_Social.RegisterSocialBrowser]]()
+
: <small>PROTECTED</small> [[API C_Social.RegisterSocialBrowser|C_Social.RegisterSocialBrowser]]()
 
: [[API C_Social.SetTextureToScreenshot|C_Social.SetTextureToScreenshot]](<span style="font-size:smaller; color:#ecbc2a">texture, index</span>)
 
: [[API C_Social.SetTextureToScreenshot|C_Social.SetTextureToScreenshot]](<span style="font-size:smaller; color:#ecbc2a">texture, index</span>)
: <small>SECURE</small> [[API C_Social.TwitterCheckStatus|C_Social.TwitterCheckStatus]]()
+
: <small>PROTECTED</small> [[API C_Social.TwitterCheckStatus|C_Social.TwitterCheckStatus]]()
: <small>SECURE</small> [[API C_Social.TwitterConnect|C_Social.TwitterConnect]]()
+
: <small>PROTECTED</small> [[API C_Social.TwitterConnect|C_Social.TwitterConnect]]()
: <small>SECURE</small> [[API C_Social.TwitterDisconnect|C_Social.TwitterDisconnect]]()
+
: <small>PROTECTED</small> [[API C_Social.TwitterDisconnect|C_Social.TwitterDisconnect]]()
 
: [[API C_Social.TwitterGetMSTillCanPost|C_Social.TwitterGetMSTillCanPost]]() : <span style="font-size:smaller; color:#4ec9b0">msTimeLeft</span>
 
: [[API C_Social.TwitterGetMSTillCanPost|C_Social.TwitterGetMSTillCanPost]]() : <span style="font-size:smaller; color:#4ec9b0">msTimeLeft</span>
: <small>SECURE</small> [[API C_Social.TwitterPostAchievement|C_Social.TwitterPostAchievement]](<span style="font-size:smaller; color:#ecbc2a">text, width, height, snapshotId, offScreenFrame, lastAchievementID, usedCustomText</span>)
+
: <small>PROTECTED</small> [[API C_Social.TwitterPostAchievement|C_Social.TwitterPostAchievement]](<span style="font-size:smaller; color:#ecbc2a">text, width, height, snapshotId, offScreenFrame, lastAchievementID, usedCustomText</span>)
: <small>SECURE</small> [[API C_Social.TwitterPostItem|C_Social.TwitterPostItem]](<span style="font-size:smaller; color:#ecbc2a">text, width, height, snapshotId, offScreenFrame, lastItemID, usedCustomText</span>)
+
: <small>PROTECTED</small> [[API C_Social.TwitterPostItem|C_Social.TwitterPostItem]](<span style="font-size:smaller; color:#ecbc2a">text, width, height, snapshotId, offScreenFrame, lastItemID, usedCustomText</span>)
: <small>SECURE</small> [[API C_Social.TwitterPostMessage|C_Social.TwitterPostMessage]](<span style="font-size:smaller; color:#ecbc2a">message</span>)
+
: <small>PROTECTED</small> [[API C_Social.TwitterPostMessage|C_Social.TwitterPostMessage]](<span style="font-size:smaller; color:#ecbc2a">message</span>)
: <small>SECURE</small> [[API C_Social.TwitterPostScreenshot|C_Social.TwitterPostScreenshot]](<span style="font-size:smaller; color:#ecbc2a">text, screenshotIndex, texture, usedCustomText</span>)
+
: <small>PROTECTED</small> [[API C_Social.TwitterPostScreenshot|C_Social.TwitterPostScreenshot]](<span style="font-size:smaller; color:#ecbc2a">text, screenshotIndex, texture, usedCustomText</span>)
   
 
=== Character ===
 
=== Character ===
Line 1,002: Line 904:
 
: [[API GetSpellsForCharacterUpgradeTier|GetSpellsForCharacterUpgradeTier]](<span style="font-size:smaller; color:#ecbc2a">tierIndex</span>) - For Level Up Display
 
: [[API GetSpellsForCharacterUpgradeTier|GetSpellsForCharacterUpgradeTier]](<span style="font-size:smaller; color:#ecbc2a">tierIndex</span>) - For Level Up Display
 
: [[API GetTimeToWellRested|GetTimeToWellRested]]()
 
: [[API GetTimeToWellRested|GetTimeToWellRested]]()
: [[API GetTitleName|GetTitleName]](<span style="font-size:smaller; color:#ecbc2a">[[titleId]]</span>) - Returns the player's current title name.
+
: [[API GetTitleName|GetTitleName]](<span style="font-size:smaller; color:#ecbc2a">titleId</span>) - Returns the player's current title name.
 
: [[API GetXPExhaustion|GetXPExhaustion]]() - Returns your character's current rested XP, nil if character is not rested.
 
: [[API GetXPExhaustion|GetXPExhaustion]]() - Returns your character's current rested XP, nil if character is not rested.
 
: [[API HasAlternateForm|HasAlternateForm]]()
 
: [[API HasAlternateForm|HasAlternateForm]]()
Line 1,028: Line 930:
 
: [[API PlayerHasHearthstone|PlayerHasHearthstone]]() - Returns the hearthstone ID
 
: [[API PlayerHasHearthstone|PlayerHasHearthstone]]() - Returns the hearthstone ID
 
: [[API RandomRoll|RandomRoll]](<span style="font-size:smaller; color:#ecbc2a">min, max</span>) - Does a random roll between the two values.
 
: [[API RandomRoll|RandomRoll]](<span style="font-size:smaller; color:#ecbc2a">min, max</span>) - Does a random roll between the two values.
: <small>HW</small> [[API SetCurrentTitle|SetCurrentTitle]](<span style="font-size:smaller; color:#ecbc2a">[[titleId]]</span>) - Sets the player's current title by id.
+
: <small>HW</small> [[API SetCurrentTitle|SetCurrentTitle]](<span style="font-size:smaller; color:#ecbc2a">titleId</span>) - Sets the player's current title by id.
 
: [[API ToggleSheath|ToggleSheath]]() - Toggles sheathed or unsheathed weapons.
 
: [[API ToggleSheath|ToggleSheath]]() - Toggles sheathed or unsheathed weapons.
: <small>SECURE</small> [[API UseHearthstone|UseHearthstone]]()
+
: <small>PROTECTED</small> [[API UseHearthstone|UseHearthstone]]()
   
 
==== Paper Doll ====
 
==== Paper Doll ====
Line 1,095: Line 997:
 
: [[API PlayerEffectiveAttackPower|PlayerEffectiveAttackPower]]()
 
: [[API PlayerEffectiveAttackPower|PlayerEffectiveAttackPower]]()
 
: [[API ResistancePercent|ResistancePercent]](<span style="font-size:smaller; color:#ecbc2a">resistance, casterLevel</span>)
 
: [[API ResistancePercent|ResistancePercent]](<span style="font-size:smaller; color:#ecbc2a">resistance, casterLevel</span>)
  +
  +
==== Equipment Manager ====
  +
The [[Equipment Manager]] was added in [[Patch 3.1.2]]
  +
: [[API C_EquipmentSet.AssignSpecToEquipmentSet|C_EquipmentSet.AssignSpecToEquipmentSet]](<span style="font-size:smaller; color:#ecbc2a">equipmentSetID, specIndex</span>) - Assigns an equipment set to a specialization.
  +
: [[API C_EquipmentSet.CanUseEquipmentSets|C_EquipmentSet.CanUseEquipmentSets]]() : <span style="font-size:smaller; color:#4ec9b0">canUseEquipmentSets</span> - Returns whether any equipment sets can be used.
  +
: [[API C_EquipmentSet.ClearIgnoredSlotsForSave|C_EquipmentSet.ClearIgnoredSlotsForSave]]() - Clears ignored slots for saving.
  +
: [[API C_EquipmentSet.CreateEquipmentSet|C_EquipmentSet.CreateEquipmentSet]](<span style="font-size:smaller; color:#ecbc2a">equipmentSetName [, icon]</span>) - Creates an equipment set.
  +
: [[API C_EquipmentSet.DeleteEquipmentSet|C_EquipmentSet.DeleteEquipmentSet]](<span style="font-size:smaller; color:#ecbc2a">equipmentSetID</span>) - Deletes an equipment set.
  +
: [[API C_EquipmentSet.EquipmentSetContainsLockedItems|C_EquipmentSet.EquipmentSetContainsLockedItems]](<span style="font-size:smaller; color:#ecbc2a">equipmentSetID</span>) : <span style="font-size:smaller; color:#4ec9b0">hasLockedItems</span> - Returns whether an equipment set has locked items
  +
: [[API C_EquipmentSet.GetEquipmentSetAssignedSpec|C_EquipmentSet.GetEquipmentSetAssignedSpec]](<span style="font-size:smaller; color:#ecbc2a">equipmentSetID</span>) : <span style="font-size:smaller; color:#4ec9b0">specIndex</span> - Returns the specialization assigned to an equipment set.
  +
: [[API C_EquipmentSet.GetEquipmentSetForSpec|C_EquipmentSet.GetEquipmentSetForSpec]](<span style="font-size:smaller; color:#ecbc2a">specIndex</span>) : <span style="font-size:smaller; color:#4ec9b0">equipmentSetID</span> - Returns the equipment set currently assigned to a specific specialization.
  +
: [[API C_EquipmentSet.GetEquipmentSetID|C_EquipmentSet.GetEquipmentSetID]](<span style="font-size:smaller; color:#ecbc2a">equipmentSetName</span>) : <span style="font-size:smaller; color:#4ec9b0">equipmentSetID</span> - Returns the set ID of an equipment set with the specified name.
  +
: [[API C_EquipmentSet.GetEquipmentSetIDs|C_EquipmentSet.GetEquipmentSetIDs]]() : <span style="font-size:smaller; color:#4ec9b0">equipmentSetIDs</span> - Returns an array containing all currently saved equipment set IDs.
  +
: [[API C_EquipmentSet.GetEquipmentSetInfo|C_EquipmentSet.GetEquipmentSetInfo]](<span style="font-size:smaller; color:#ecbc2a">equipmentSetID</span>) : <span style="font-size:smaller; color:#4ec9b0">name, iconFileID, setID, isEquipped, numItems, numEquipped, numInInventory, ...</span> - Returns information about a saved equipment set.
  +
: [[API C_EquipmentSet.GetIgnoredSlots|C_EquipmentSet.GetIgnoredSlots]](<span style="font-size:smaller; color:#ecbc2a">equipmentSetID</span>) : <span style="font-size:smaller; color:#4ec9b0">slotIgnored</span> - Returns ignored slots of an equipment set.
  +
: [[API C_EquipmentSet.GetItemIDs|C_EquipmentSet.GetItemIDs]](<span style="font-size:smaller; color:#ecbc2a">equipmentSetID</span>) : <span style="font-size:smaller; color:#4ec9b0">itemIDs</span> - Returns the item IDs of an equipment set.
  +
: [[API C_EquipmentSet.GetItemLocations|C_EquipmentSet.GetItemLocations]](<span style="font-size:smaller; color:#ecbc2a">equipmentSetID</span>) : <span style="font-size:smaller; color:#4ec9b0">locations</span> - Returns the location of all items in an equipment set.
  +
: [[API C_EquipmentSet.GetNumEquipmentSets|C_EquipmentSet.GetNumEquipmentSets]]() : <span style="font-size:smaller; color:#4ec9b0">numEquipmentSets</span> - Returns the number of saved equipment sets.
  +
: [[API C_EquipmentSet.IgnoreSlotForSave|C_EquipmentSet.IgnoreSlotForSave]](<span style="font-size:smaller; color:#ecbc2a">slot</span>) - Ignores an equipment slot for saving.
  +
: [[API C_EquipmentSet.IsSlotIgnoredForSave|C_EquipmentSet.IsSlotIgnoredForSave]](<span style="font-size:smaller; color:#ecbc2a">slot</span>) : <span style="font-size:smaller; color:#4ec9b0">isSlotIgnored</span> - Returns whether a slot is ignored for saving.
  +
: [[API C_EquipmentSet.ModifyEquipmentSet|C_EquipmentSet.ModifyEquipmentSet]](<span style="font-size:smaller; color:#ecbc2a">equipmentSetID, newName [, newIcon]</span>) - Modifies an equipment set.
  +
: [[API C_EquipmentSet.PickupEquipmentSet|C_EquipmentSet.PickupEquipmentSet]](<span style="font-size:smaller; color:#ecbc2a">equipmentSetID</span>) - Picks up an equipment set, placing it on the cursor.
  +
: [[API C_EquipmentSet.SaveEquipmentSet|C_EquipmentSet.SaveEquipmentSet]](<span style="font-size:smaller; color:#ecbc2a">equipmentSetID [, icon]</span>) - Saves your currently equipped items into an equipment set.
  +
: [[API C_EquipmentSet.UnassignEquipmentSetSpec|C_EquipmentSet.UnassignEquipmentSetSpec]](<span style="font-size:smaller; color:#ecbc2a">equipmentSetID</span>) - Unassigns an equipment set from a specialization.
  +
: [[API C_EquipmentSet.UnignoreSlotForSave|C_EquipmentSet.UnignoreSlotForSave]](<span style="font-size:smaller; color:#ecbc2a">slot</span>) - Unignores a slot for saving.
  +
: <small>NOCOMBAT</small> [[API C_EquipmentSet.UseEquipmentSet|C_EquipmentSet.UseEquipmentSet]](<span style="font-size:smaller; color:#ecbc2a">equipmentSetID</span>) : <span style="font-size:smaller; color:#4ec9b0">setWasEquipped</span> - Equips items from a specified equipment set.
  +
: [[API GetInventoryItemEquippedUnusable|GetInventoryItemEquippedUnusable]](<span style="font-size:smaller; color:#ecbc2a">unit, slot</span>)
  +
: [[API GetInventoryItemsForSlot|GetInventoryItemsForSlot]](<span style="font-size:smaller; color:#ecbc2a">slot, returnTable [, transmogrify]</span>)
  +
: [[API IsInventoryItemAnUpgrade|IsInventoryItemAnUpgrade]](<span style="font-size:smaller; color:#ecbc2a">unit, slot</span>)
  +
: <small>UI</small> [[API EquipmentManager_UnpackLocation|EquipmentManager_UnpackLocation]]() - Unpacks a location integer to determine the actual inventory location.
   
 
==== Dressing Room ====
 
==== Dressing Room ====
Line 1,103: Line 1,035:
 
: <small>UI</small> [https://www.townlong-yak.com/framexml/go/SetDressUpBackground SetDressUpBackground](<span style="font-size:smaller; color:#ecbc2a">frame, fileName, atlasPostfix</span>)
 
: <small>UI</small> [https://www.townlong-yak.com/framexml/go/SetDressUpBackground SetDressUpBackground](<span style="font-size:smaller; color:#ecbc2a">frame, fileName, atlasPostfix</span>)
   
==== Movement ====
+
==== Transmogrification ====
  +
[[Transmogrification]] was added in [[Patch 4.3.0]]. See also [[#Appearances|Appearances]] functions.
Most of these functions may only be called on a hardware event from '''secure''' code.
 
  +
: [[API C_Transmog.ApplyAllPending|C_Transmog.ApplyAllPending]]() - Applies all pending transmogrifications, and pays for the cost.
: <small>SECURE</small> [[API AscendStop|AscendStop]]() - Called when you release the jump key.
 
  +
: [[API C_Transmog.CanTransmogItemWithItem|C_Transmog.CanTransmogItemWithItem]](<span style="font-size:smaller; color:#ecbc2a">targetItemLink, sourceItemLink</span>) - Returns whether an item can be transmogrified to look like another item.
: <small>SECURE</small> [[API AttackTarget|AttackTarget]]() - Attacks the targetted unit.
 
  +
: [[API C_Transmog.ClearAllPending|C_Transmog.ClearAllPending]]()
: <small>SECURE</small> [[API DescendStop|DescendStop]]() - The player stops descending (while swimming or flying)
 
: <small>SECURE</small> [[API InteractUnit|InteractUnit]](<span style="font-size:smaller; color:#ecbc2a">unitToken [, exactMatch]</span>)
+
: [[API C_Transmog.ClearPending|C_Transmog.ClearPending]](<span style="font-size:smaller; color:#ecbc2a">transmogLocation</span>) - Clears the specified transmogrify slot.
  +
: [[API C_Transmog.Close|C_Transmog.Close]]()
: [[API FollowUnit|FollowUnit]](<span style="font-size:smaller; color:#ecbc2a">unit</span>) - Follow an ally with the specified UnitID.
 
  +
: [[API C_Transmog.GetApplyWarnings|C_Transmog.GetApplyWarnings]]()
: [[API IsPlayerMoving|IsPlayerMoving]]()
 
  +
: [[API C_Transmog.GetBaseCategory|C_Transmog.GetBaseCategory]](<span style="font-size:smaller; color:#ecbc2a">transmogID</span>) : <span style="font-size:smaller; color:#4ec9b0">categoryID</span>
: <small>SECURE</small> [[API JumpOrAscendStart|JumpOrAscendStart]]() - Makes the player jump.
 
  +
: [[API C_Transmog.GetCost|C_Transmog.GetCost]]()
: <small>SECURE</small> [[API MoveAndSteerStart|MoveAndSteerStart]]()
 
  +
: [[API C_Transmog.GetCreatureDisplayIDForSource|C_Transmog.GetCreatureDisplayIDForSource]](<span style="font-size:smaller; color:#ecbc2a">itemModifiedAppearanceID</span>) : <span style="font-size:smaller; color:#4ec9b0">creatureDisplayID</span>
: <small>SECURE</small> [[API MoveAndSteerStop|MoveAndSteerStop]]()
 
  +
: [[API C_Transmog.GetItemIDForSource|C_Transmog.GetItemIDForSource]](<span style="font-size:smaller; color:#ecbc2a">itemModifiedAppearanceID</span>) : <span style="font-size:smaller; color:#4ec9b0">itemID</span>
: <small>SECURE</small> [[API MoveBackwardStart|MoveBackwardStart]]() - The player begins moving backward at the specified time.
 
  +
: [[API C_Transmog.GetItemInfo|C_Transmog.GetItemInfo]](<span style="font-size:smaller; color:#ecbc2a">item</span>) - Returns how an item can interact with transmogrification.
: <small>SECURE</small> [[API MoveBackwardStop|MoveBackwardStop]]() - The player stops moving backward at the specified time.
 
  +
: [[API C_Transmog.GetSlotForInventoryType|C_Transmog.GetSlotForInventoryType]](<span style="font-size:smaller; color:#ecbc2a">inventoryType</span>) : <span style="font-size:smaller; color:#4ec9b0">slot</span> - Returns the equipment slot for an inventory type.
: <small>SECURE</small> [[API MoveForwardStart|MoveForwardStart]]() - The player begins moving forward at the specified time.
 
  +
: [[API C_Transmog.GetSlotInfo|C_Transmog.GetSlotInfo]](<span style="font-size:smaller; color:#ecbc2a">transmogLocation</span>) : <span style="font-size:smaller; color:#4ec9b0">isTransmogrified, hasPending, isPendingCollected, canTransmogrify, ...</span>
: <small>SECURE</small> [[API MoveForwardStop|MoveForwardStop]]() - The player stops moving forward at the specified time.
 
  +
: [[API C_Transmog.GetSlotUseError|C_Transmog.GetSlotUseError]](<span style="font-size:smaller; color:#ecbc2a">transmogLocation</span>) : <span style="font-size:smaller; color:#4ec9b0">errorCode, errorString</span>
: <small>SECURE</small> [[API SetMoveEnabled|SetMoveEnabled]]()
 
  +
: [[API C_Transmog.GetSlotVisualInfo|C_Transmog.GetSlotVisualInfo]](<span style="font-size:smaller; color:#ecbc2a">transmogLocation</span>) : <span style="font-size:smaller; color:#4ec9b0">baseSourceID, baseVisualID, appliedSourceID, appliedVisualID, ...</span>
: <small>SECURE</small> [[API SetTurnEnabled|SetTurnEnabled]]()
 
  +
: [[API C_Transmog.LoadOutfit|C_Transmog.LoadOutfit]](<span style="font-size:smaller; color:#ecbc2a">outfitID</span>)
: <small>SECURE</small> [[API SitStandOrDescendStart|SitStandOrDescendStart]]() - The player sits, stands, or descends.
 
  +
: [[API C_Transmog.LoadSources|C_Transmog.LoadSources]](<span style="font-size:smaller; color:#ecbc2a">sourceIDTable [, mainHandEnchant, offHandEnchant]</span>)
: <small>SECURE</small> [[API StartAttack|StartAttack]]()
 
  +
: [[API C_Transmog.SetPending|C_Transmog.SetPending]](<span style="font-size:smaller; color:#ecbc2a">transmogLocation, transmogID [, categoryID]</span>)
: [[API StopAttack|StopAttack]]() - Turns off auto-attack, if currently active.
 
  +
: [[API C_Transmog.ValidateAllPending|C_Transmog.ValidateAllPending]]()
: <small>SECURE</small> [[API StartAutoRun|StartAutoRun]]()
 
: <small>SECURE</small> [[API StopAutoRun|StopAutoRun]]()
+
: [[API IsCosmeticItem|IsCosmeticItem]]()
: <small>SECURE</small> [[API StrafeLeftStart|StrafeLeftStart]]() - The player begins strafing left at the specified time.
 
: <small>SECURE</small> [[API StrafeLeftStop|StrafeLeftStop]]() - The player stops strafing left at the specified time.
 
: <small>SECURE</small> [[API StrafeRightStart|StrafeRightStart]]() - The player begins strafing right at the specified time.
 
: <small>SECURE</small> [[API StrafeRightStop|StrafeRightStop]]() - The player stops strafing right at the specified time.
 
: <small>SECURE</small> [[API ToggleAutoRun|ToggleAutoRun]]() - Turns auto-run on or off.
 
: <small>SECURE</small> [[API ToggleRun|ToggleRun]]() - Toggle between running and walking.
 
: <small>SECURE</small> [[API TurnLeftStart|TurnLeftStart]]() - The player starts turning left at the specified time.
 
: <small>SECURE</small> [[API TurnLeftStop|TurnLeftStop]]() - The player stops turning left at the specified time.
 
: <small>SECURE</small> [[API TurnOrActionStart|TurnOrActionStart]]() - Begin "Right Click" in the 3D world.
 
: <small>SECURE</small> [[API TurnOrActionStop|TurnOrActionStop]]() - End "Right Click" in the 3D world.
 
: <small>SECURE</small> [[API TurnRightStart|TurnRightStart]]() - The player starts turning right at the specified time.
 
: <small>SECURE</small> [[API TurnRightStop|TurnRightStop]]() - The player stops turning right at the specified time.
 
   
==== Death ====
+
==== Barber Shop ====
  +
The [[Barbershop]] was added in [[Patch 3.0.2]] and reworked in patch [[Patch 9.0.1]]
: [[API C_DeathInfo.GetCorpseMapPosition|C_DeathInfo.GetCorpseMapPosition]](<span style="font-size:smaller; color:#ecbc2a">uiMapID</span>) : <span style="font-size:smaller; color:#4ec9b0">position</span> - Returns the location of the player's corpse on the map.
 
: [[API C_DeathInfo.GetDeathReleasePosition|C_DeathInfo.GetDeathReleasePosition]](<span style="font-size:smaller; color:#ecbc2a">uiMapID</span>) : <span style="font-size:smaller; color:#4ec9b0">position</span> - Returns the death release location.
+
: [[API C_BarberShop.ApplyCustomizationChoices|C_BarberShop.ApplyCustomizationChoices]]() : <span style="font-size:smaller; color:#4ec9b0">success</span>
  +
: [[API C_BarberShop.Cancel|C_BarberShop.Cancel]]()
: [[API C_DeathInfo.GetGraveyardsForMap|C_DeathInfo.GetGraveyardsForMap]](<span style="font-size:smaller; color:#ecbc2a">uiMapID</span>) : <span style="font-size:smaller; color:#4ec9b0">graveyards</span> - Returns graveyard info and location for a map.
 
  +
: [[API C_BarberShop.ClearPreviewChoices|C_BarberShop.ClearPreviewChoices]]()
: [[API C_DeathInfo.GetSelfResurrectOptions|C_DeathInfo.GetSelfResurrectOptions]]() : <span style="font-size:smaller; color:#4ec9b0">options</span> - Returns self resurrect options for your character, including from soulstones.
 
: [[API C_DeathInfo.UseSelfResurrectOption|C_DeathInfo.UseSelfResurrectOption]](<span style="font-size:smaller; color:#ecbc2a">optionType, id</span>) - Uses a soulstone or similar means of self resurrection.
+
: [[API C_BarberShop.GetAvailableCustomizations|C_BarberShop.GetAvailableCustomizations]]() : <span style="font-size:smaller; color:#4ec9b0">categories</span>
  +
: [[API C_BarberShop.GetCurrentCameraZoom|C_BarberShop.GetCurrentCameraZoom]]() : <span style="font-size:smaller; color:#4ec9b0">zoomLevel</span>
: [[API AcceptResurrect|AcceptResurrect]]() - The player accepts the request from another player to resurrect him/herself.
 
  +
: [[API C_BarberShop.GetCurrentCharacterData|C_BarberShop.GetCurrentCharacterData]]() : <span style="font-size:smaller; color:#4ec9b0">characterData</span>
: [[API AcceptXPLoss|AcceptXPLoss]]() - Accept the durability loss to be reborn by a spirit healer. (The name is a remnant from when sprit res was an XP loss instead.)
 
  +
: [[API C_BarberShop.GetCurrentCost|C_BarberShop.GetCurrentCost]]() : <span style="font-size:smaller; color:#4ec9b0">cost</span>
: [[API CannotBeResurrected|CannotBeResurrected]]()
 
  +
: [[API C_BarberShop.HasAnyChanges|C_BarberShop.HasAnyChanges]]() : <span style="font-size:smaller; color:#4ec9b0">hasChanges</span>
: [[API DeathRecap_GetEvents|DeathRecap_GetEvents]]()
 
  +
: [[API C_BarberShop.IsViewingAlteredForm|C_BarberShop.IsViewingAlteredForm]]() : <span style="font-size:smaller; color:#4ec9b0">isViewingAlteredForm</span>
: [[API DeathRecap_HasEvents|DeathRecap_HasEvents]]()
 
  +
: [[API C_BarberShop.OldBarberShopLoaded|C_BarberShop.OldBarberShopLoaded]]()
: [[API DeclineResurrect|DeclineResurrect]]() - Decline the request from another player to resurrect him/herself.
 
  +
: [[API C_BarberShop.PreviewCustomizationChoice|C_BarberShop.PreviewCustomizationChoice]](<span style="font-size:smaller; color:#ecbc2a">optionID, choiceID</span>)
: [[API GetCemeteryPreference|GetCemeteryPreference]]()
 
  +
: [[API C_BarberShop.ResetCameraRotation|C_BarberShop.ResetCameraRotation]]()
: [[API GetCorpseRecoveryDelay|GetCorpseRecoveryDelay]]() - Time left before a player can accept a resurrection.
 
  +
: [[API C_BarberShop.ResetCustomizationChoices|C_BarberShop.ResetCustomizationChoices]]()
: [[API GetDeathRecapLink|GetDeathRecapLink]](<span style="font-size:smaller; color:#ecbc2a">recapID</span>)
 
  +
: [[API C_BarberShop.RotateCamera|C_BarberShop.RotateCamera]](<span style="font-size:smaller; color:#ecbc2a">diffDegrees</span>)
: [[API GetReleaseTimeRemaining|GetReleaseTimeRemaining]]() - Returns the amount of time left before your ghost is pulled from your body.
 
  +
: [[API C_BarberShop.SetCameraDistanceOffset|C_BarberShop.SetCameraDistanceOffset]](<span style="font-size:smaller; color:#ecbc2a">offset</span>)
: [[API GetResSicknessDuration|GetResSicknessDuration]]()
 
  +
: [[API C_BarberShop.SetCameraZoomLevel|C_BarberShop.SetCameraZoomLevel]](<span style="font-size:smaller; color:#ecbc2a">zoomLevel [, keepCustomZoom]</span>)
: [[API HasNoReleaseAura|HasNoReleaseAura]]()
 
  +
: [[API C_BarberShop.SetCustomizationChoice|C_BarberShop.SetCustomizationChoice]](<span style="font-size:smaller; color:#ecbc2a">optionID, choiceID</span>)
: [[API IsCemeterySelectionAvailable|IsCemeterySelectionAvailable]]()
 
  +
: [[API C_BarberShop.SetModelDressState|C_BarberShop.SetModelDressState]](<span style="font-size:smaller; color:#ecbc2a">dressedState</span>)
: [[API IsEncounterLimitingResurrections|IsEncounterLimitingResurrections]]()
 
  +
: [[API C_BarberShop.SetSelectedSex|C_BarberShop.SetSelectedSex]](<span style="font-size:smaller; color:#ecbc2a">sex</span>)
: [[API IsEncounterSuppressingRelease|IsEncounterSuppressingRelease]]()
 
  +
: [[API C_BarberShop.SetViewingAlteredForm|C_BarberShop.SetViewingAlteredForm]](<span style="font-size:smaller; color:#ecbc2a">isViewingAlteredForm</span>)
: [[API NotWhileDeadError|NotWhileDeadError]]() - Generates an error message saying you cannot do that while dead.
 
  +
: [[API C_BarberShop.SetViewingShapeshiftForm|C_BarberShop.SetViewingShapeshiftForm]](<span style="font-size:smaller; color:#ecbc2a">[shapeshiftFormID]</span>)
: [[API PortGraveyard|PortGraveyard]]()
 
  +
: [[API C_BarberShop.ZoomCamera|C_BarberShop.ZoomCamera]](<span style="font-size:smaller; color:#ecbc2a">zoomAmount</span>)
: [[API RepopMe|RepopMe]]() - The "Release Spirit" button. Sends you to the graveyard when dead.
 
: [[API ResurrectGetOfferer|ResurrectGetOfferer]]() - Returns the name of the person offering to resurrect you.
+
: [[API ApplyBarberShopStyle|ApplyBarberShopStyle]]() - Purchase and apply the cosmetic changes.
  +
: [[API BarberShopReset|BarberShopReset]]() - Reset any changes made in the Barber Shop.
: [[API ResurrectHasSickness|ResurrectHasSickness]]() - Appears to be used when accepting a resurrection will give you resurrection sickessness.
 
: [[API ResurrectHasTimer|ResurrectHasTimer]]() - Does the player have to wait before accepting a resurrection.
+
: [[API CancelBarberShop|CancelBarberShop]]() - Exit the Barber Shop chair.
  +
: [[API GetBarberShopStyleInfo|GetBarberShopStyleInfo]](<span style="font-size:smaller; color:#ecbc2a">id</span>) - Returns information about the currently selected style.
: [[API RetrieveCorpse|RetrieveCorpse]]() - Resurrects when near corpse. e.g., The "Accept" button one sees after running back to your body.
 
  +
: [[API GetBarberShopTotalCost|GetBarberShopTotalCost]]() - Returns the total costs of the cosmetic changes.
: [[API SetCemeteryPreference|SetCemeteryPreference]](<span style="font-size:smaller; color:#ecbc2a">cemeteryID</span>)
 
  +
: [[API GetCustomizationDetails|GetCustomizationDetails]](<span style="font-size:smaller; color:#ecbc2a">customizationIndex</span>)
: [[API TimeoutResurrect|TimeoutResurrect]]()
 
  +
: [[API IsBarberShopStyleValid|IsBarberShopStyleValid]]()
  +
: [[API SetBarberShopAlternateFormFrame|SetBarberShopAlternateFormFrame]]()
  +
: [[API SetNextBarberShopStyle|SetNextBarberShopStyle]](<span style="font-size:smaller; color:#ecbc2a">id [, reverse]</span>) - Alters style selection in a particular category.
   
 
=== Cinematics ===
 
=== Cinematics ===
Line 1,196: Line 1,119:
 
: <small>UI</small> [[API GetClassColor|GetClassColor]](<span style="font-size:smaller; color:#ecbc2a">classFilename</span>) - Returns a class color from RAID_CLASS_COLORS.
 
: <small>UI</small> [[API GetClassColor|GetClassColor]](<span style="font-size:smaller; color:#ecbc2a">classFilename</span>) - Returns a class color from RAID_CLASS_COLORS.
 
[[Shaman totem]]s
 
[[Shaman totem]]s
: <small>SECURE</small> [[API DestroyTotem|DestroyTotem]](<span style="font-size:smaller; color:#ecbc2a">slot</span>) - Destroys a totem/minion.
+
: <small>PROTECTED</small> [[API DestroyTotem|DestroyTotem]](<span style="font-size:smaller; color:#ecbc2a">slot</span>) - Destroys a totem/minion.
 
: [[API GetMultiCastTotemSpells|GetMultiCastTotemSpells]](<span style="font-size:smaller; color:#ecbc2a">totemslot</span>) - Returns a list of spellIDs that are applicable for the specified totem slot (1-4)
 
: [[API GetMultiCastTotemSpells|GetMultiCastTotemSpells]](<span style="font-size:smaller; color:#ecbc2a">totemslot</span>) - Returns a list of spellIDs that are applicable for the specified totem slot (1-4)
 
: [[API GetTotemCannotDismiss|GetTotemCannotDismiss]](<span style="font-size:smaller; color:#ecbc2a">slot</span>)
 
: [[API GetTotemCannotDismiss|GetTotemCannotDismiss]](<span style="font-size:smaller; color:#ecbc2a">slot</span>)
Line 1,202: Line 1,125:
 
: [[API GetTotemTimeLeft|GetTotemTimeLeft]](<span style="font-size:smaller; color:#ecbc2a">slot</span>)
 
: [[API GetTotemTimeLeft|GetTotemTimeLeft]](<span style="font-size:smaller; color:#ecbc2a">slot</span>)
 
: [[API TargetTotem|TargetTotem]](<span style="font-size:smaller; color:#ecbc2a">slot</span>)
 
: [[API TargetTotem|TargetTotem]](<span style="font-size:smaller; color:#ecbc2a">slot</span>)
: <small>SECURE</small> [[API SetMultiCastSpell|SetMultiCastSpell]](<span style="font-size:smaller; color:#ecbc2a">actionID, spellID</span>) - Assigns a spellID to a multicast (totem bar) actionID.
+
: <small>PROTECTED</small> [[API SetMultiCastSpell|SetMultiCastSpell]](<span style="font-size:smaller; color:#ecbc2a">actionID, spellID</span>) - Assigns a spellID to a multicast (totem bar) actionID.
 
[[Druid shapeshift forms]]
 
[[Druid shapeshift forms]]
: <small>SECURE</small> [[API CancelShapeshiftForm|CancelShapeshiftForm]]() - Cancels a druid's shapeshift form buff.
+
: <small>PROTECTED</small> [[API CancelShapeshiftForm|CancelShapeshiftForm]]() - Cancels a druid's shapeshift form buff.
: <small>SECURE</small> [[API CastShapeshiftForm|CastShapeshiftForm]](<span style="font-size:smaller; color:#ecbc2a">index</span>)
+
: <small>PROTECTED</small> [[API CastShapeshiftForm|CastShapeshiftForm]](<span style="font-size:smaller; color:#ecbc2a">index</span>)
 
: [[API GetNumShapeshiftForms|GetNumShapeshiftForms]]()
 
: [[API GetNumShapeshiftForms|GetNumShapeshiftForms]]()
 
: [[API GetShapeshiftForm|GetShapeshiftForm]](<span style="font-size:smaller; color:#ecbc2a">unknown</span>) - Returns zero-based index of current form/stance.
 
: [[API GetShapeshiftForm|GetShapeshiftForm]](<span style="font-size:smaller; color:#ecbc2a">unknown</span>) - Returns zero-based index of current form/stance.
Line 1,235: Line 1,158:
 
: [[API ConfirmTalentWipe|ConfirmTalentWipe]]() - Confirms freeing all talent points.
 
: [[API ConfirmTalentWipe|ConfirmTalentWipe]]() - Confirms freeing all talent points.
 
: [[API GetActiveSpecGroup|GetActiveSpecGroup]](<span style="font-size:smaller; color:#ecbc2a">[isInspect]</span>) - Returns the index of the current active specialization/talent/glyph group.
 
: [[API GetActiveSpecGroup|GetActiveSpecGroup]](<span style="font-size:smaller; color:#ecbc2a">[isInspect]</span>) - Returns the index of the current active specialization/talent/glyph group.
: [[API GetArenaOpponentSpec|GetArenaOpponentSpec]]()
 
 
: [[API GetFailedPVPTalentIDs|GetFailedPVPTalentIDs]]()
 
: [[API GetFailedPVPTalentIDs|GetFailedPVPTalentIDs]]()
 
: [[API GetFailedTalentIDs|GetFailedTalentIDs]]()
 
: [[API GetFailedTalentIDs|GetFailedTalentIDs]]()
 
: [[API GetMaxTalentTier|GetMaxTalentTier]]() - Returns the number of available talent tiers.
 
: [[API GetMaxTalentTier|GetMaxTalentTier]]() - Returns the number of available talent tiers.
: [[API GetNumArenaOpponentSpecs|GetNumArenaOpponentSpecs]]()
 
 
: [[API GetNumSpecGroups|GetNumSpecGroups]](<span style="font-size:smaller; color:#ecbc2a">[isInspect]</span>) - Returns the number of specialization group (dual specs) the player has.
 
: [[API GetNumSpecGroups|GetNumSpecGroups]](<span style="font-size:smaller; color:#ecbc2a">[isInspect]</span>) - Returns the number of specialization group (dual specs) the player has.
: [[API GetNumSpecializations|GetNumSpecializations]](<span style="font-size:smaller; color:#ecbc2a">[isInspect , isPet]</span>) - Returns the number of available specializations.
+
: [[API GetNumSpecializations|GetNumSpecializations]](<span style="font-size:smaller; color:#ecbc2a">[isInspect, isPet]</span>) - Returns the number of available specializations.
 
: [[API GetNumSpecializationsForClassID|GetNumSpecializationsForClassID]](<span style="font-size:smaller; color:#ecbc2a">classID</span>) - Returns the number of specializations available to a particular class.
 
: [[API GetNumSpecializationsForClassID|GetNumSpecializationsForClassID]](<span style="font-size:smaller; color:#ecbc2a">classID</span>) - Returns the number of specializations available to a particular class.
 
: [[API GetNumUnspentPvpTalents|GetNumUnspentPvpTalents]]()
 
: [[API GetNumUnspentPvpTalents|GetNumUnspentPvpTalents]]()
Line 1,274: Line 1,195:
 
: [[API LearnPvpTalents|LearnPvpTalents]]()
 
: [[API LearnPvpTalents|LearnPvpTalents]]()
 
: [[API LearnTalent|LearnTalent]]()
 
: [[API LearnTalent|LearnTalent]]()
: <small>NOCOMBAT</small> [[API LearnTalents|LearnTalents]](<span style="font-size:smaller; color:#ecbc2a">talentID1, talentID2, etc.</span>) - Learns the talents listed.
+
: <small>NOCOMBAT</small> [[API LearnTalents|LearnTalents]](<span style="font-size:smaller; color:#ecbc2a">talentID1, talentID2, ...</span>) - Learns the talents listed.
 
: [[API RemovePvpTalent|RemovePvpTalent]]()
 
: [[API RemovePvpTalent|RemovePvpTalent]]()
 
: <small>NOCOMBAT</small> [[API RemoveTalent|RemoveTalent]](<span style="font-size:smaller; color:#ecbc2a">talentID</span>) - Removes the specified talent.
 
: <small>NOCOMBAT</small> [[API RemoveTalent|RemoveTalent]](<span style="font-size:smaller; color:#ecbc2a">talentID</span>) - Removes the specified talent.
Line 1,570: Line 1,491:
 
Relates to [[Combat pet|Combat Pet]]s.
 
Relates to [[Combat pet|Combat Pet]]s.
 
: [[API CancelPetPossess|CancelPetPossess]]()
 
: [[API CancelPetPossess|CancelPetPossess]]()
: <small>SECURE</small> [[API CastPetAction|CastPetAction]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Cast the corresponding pet skill.
+
: <small>PROTECTED</small> [[API CastPetAction|CastPetAction]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Cast the corresponding pet skill.
 
: [[API DisableSpellAutocast|DisableSpellAutocast]]() - Disables autocasting for a pet spell.
 
: [[API DisableSpellAutocast|DisableSpellAutocast]]() - Disables autocasting for a pet spell.
 
: [[API EnableSpellAutocast|EnableSpellAutocast]]() - Enables autocasting for a pet spell.
 
: [[API EnableSpellAutocast|EnableSpellAutocast]]() - Enables autocasting for a pet spell.
Line 1,587: Line 1,508:
 
: [[API IsPetAttackActive|IsPetAttackActive]]() - Returns true if the pet is currently attacking.
 
: [[API IsPetAttackActive|IsPetAttackActive]]() - Returns true if the pet is currently attacking.
 
: [[API PetAbandon|PetAbandon]]() - Permanently abandons your pet.
 
: [[API PetAbandon|PetAbandon]]() - Permanently abandons your pet.
: <small>SECURE</small> [[API PetAggressiveMode|PetAggressiveMode]]()
+
: <small>PROTECTED</small> [[API PetAggressiveMode|PetAggressiveMode]]()
: <small>SECURE</small> [[API PetAssistMode|PetAssistMode]]() - Set your pet to Assist mode.
+
: <small>PROTECTED</small> [[API PetAssistMode|PetAssistMode]]() - Set your pet to Assist mode.
: <small>SECURE</small> [[API PetAttack|PetAttack]]() - Instruct your pet to attack your target.
+
: <small>PROTECTED</small> [[API PetAttack|PetAttack]]() - Instruct your pet to attack your target.
 
: [[API PetCanBeAbandoned|PetCanBeAbandoned]]() - Returns true if the pet is abandonable.
 
: [[API PetCanBeAbandoned|PetCanBeAbandoned]]() - Returns true if the pet is abandonable.
: <small>SECURE</small> [[API PetMoveTo|PetMoveTo]](<span style="font-size:smaller; color:#ecbc2a">target</span>)
+
: <small>PROTECTED</small> [[API PetMoveTo|PetMoveTo]](<span style="font-size:smaller; color:#ecbc2a">target</span>)
 
: [[API PetCanBeDismissed|PetCanBeDismissed]]()
 
: [[API PetCanBeDismissed|PetCanBeDismissed]]()
 
: [[API PetCanBeRenamed|PetCanBeRenamed]]() - Returns true if the pet can be renamed.
 
: [[API PetCanBeRenamed|PetCanBeRenamed]]() - Returns true if the pet can be renamed.
: <small>SECURE</small> [[API PetDefensiveMode|PetDefensiveMode]]() - Set your pet in defensive mode.
+
: <small>PROTECTED</small> [[API PetDefensiveMode|PetDefensiveMode]]() - Set your pet in defensive mode.
 
: [[API PetDefensiveAssistMode|PetDefensiveAssistMode]]()
 
: [[API PetDefensiveAssistMode|PetDefensiveAssistMode]]()
 
: [[API PetDismiss|PetDismiss]]() - Dismiss your pet.
 
: [[API PetDismiss|PetDismiss]]() - Dismiss your pet.
: <small>SECURE</small> [[API PetFollow|PetFollow]]() - Instruct your pet to follow you.
+
: <small>PROTECTED</small> [[API PetFollow|PetFollow]]() - Instruct your pet to follow you.
 
: [[API PetHasSpellbook|PetHasSpellbook]]()
 
: [[API PetHasSpellbook|PetHasSpellbook]]()
: <small>SECURE</small> [[API PetPassiveMode|PetPassiveMode]]() - Set your pet into passive mode.
+
: <small>PROTECTED</small> [[API PetPassiveMode|PetPassiveMode]]() - Set your pet into passive mode.
 
: [[API PetRename|PetRename]](<span style="font-size:smaller; color:#ecbc2a">name</span>) - Renames the pet.
 
: [[API PetRename|PetRename]](<span style="font-size:smaller; color:#ecbc2a">name</span>) - Renames the pet.
 
: [[API PetStopAttack|PetStopAttack]]() - Stop the attack of the pet.
 
: [[API PetStopAttack|PetStopAttack]]() - Stop the attack of the pet.
 
: [[API PetUsesPetFrame|PetUsesPetFrame]]()
 
: [[API PetUsesPetFrame|PetUsesPetFrame]]()
: <small>SECURE</small> [[API PetWait|PetWait]]() - Instruct your pet to remain still.
+
: <small>PROTECTED</small> [[API PetWait|PetWait]]() - Instruct your pet to remain still.
: <small>SECURE</small> [[API TogglePetAutocast|TogglePetAutocast]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Toggles whether the specified pet ability should autocast or not.
+
: <small>PROTECTED</small> [[API TogglePetAutocast|TogglePetAutocast]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Toggles whether the specified pet ability should autocast or not.
: <small>SECURE</small> [[API ToggleSpellAutocast|ToggleSpellAutocast]](<span style="font-size:smaller; color:#ecbc2a">spellName | spellId, bookType</span>) - Toggles whether the specified Pet spell should autocast or not.
+
: <small>PROTECTED</small> [[API ToggleSpellAutocast|ToggleSpellAutocast]](<span style="font-size:smaller; color:#ecbc2a">spellName | spellId, bookType</span>) - Toggles whether the specified Pet spell should autocast or not.
 
Relates to the [[Stable Master]].
 
Relates to the [[Stable Master]].
 
: [[API ClosePetStables|ClosePetStables]]() - Close the pet stables user interface.
 
: [[API ClosePetStables|ClosePetStables]]() - Close the pet stables user interface.
Line 1,614: Line 1,535:
 
: [[API SetPetStablePaperdoll|SetPetStablePaperdoll]](<span style="font-size:smaller; color:#ecbc2a">modelObject</span>)
 
: [[API SetPetStablePaperdoll|SetPetStablePaperdoll]](<span style="font-size:smaller; color:#ecbc2a">modelObject</span>)
   
=== Commentator ===
+
=== Controls ===
  +
==== Action Bars ====
: [[API C_Commentator.AddPlayerOverrideName|C_Commentator.AddPlayerOverrideName]](<span style="font-size:smaller; color:#ecbc2a">playerName, overrideName</span>)
 
: [[API C_Commentator.AddTrackedDefensiveAuras|C_Commentator.AddTrackedDefensiveAuras]](<span style="font-size:smaller; color:#ecbc2a">spellIDs</span>)
+
: [[API C_ActionBar.GetBonusBarIndexForSlot|C_ActionBar.GetBonusBarIndexForSlot]](<span style="font-size:smaller; color:#ecbc2a">slotID</span>) : <span style="font-size:smaller; color:#4ec9b0">bonusBarIndex</span>
: [[API C_Commentator.AddTrackedOffensiveAuras|C_Commentator.AddTrackedOffensiveAuras]](<span style="font-size:smaller; color:#ecbc2a">spellIDs</span>)
+
: [[API C_ActionBar.IsHarmfulAction|C_ActionBar.IsHarmfulAction]](<span style="font-size:smaller; color:#ecbc2a">actionID, useNeutral</span>) : <span style="font-size:smaller; color:#4ec9b0">isHarmful</span>
: [[API C_Commentator.AreTeamsSwapped|C_Commentator.AreTeamsSwapped]]() : <span style="font-size:smaller; color:#4ec9b0">teamsAreSwapped</span>
+
: [[API C_ActionBar.IsHelpfulAction|C_ActionBar.IsHelpfulAction]](<span style="font-size:smaller; color:#ecbc2a">actionID, useNeutral</span>) : <span style="font-size:smaller; color:#4ec9b0">isHelpful</span>
: [[API C_Commentator.AssignPlayersToTeam|C_Commentator.AssignPlayersToTeam]](<span style="font-size:smaller; color:#ecbc2a">playerName, teamName</span>)
+
: [[API C_ActionBar.IsOnBarOrSpecialBar|C_ActionBar.IsOnBarOrSpecialBar]](<span style="font-size:smaller; color:#ecbc2a">spellID</span>) : <span style="font-size:smaller; color:#4ec9b0">isOnBarOrSpecialBar</span>
: [[API C_Commentator.AssignPlayersToTeamInCurrentInstance|C_Commentator.AssignPlayersToTeamInCurrentInstance]](<span style="font-size:smaller; color:#ecbc2a">teamIndex, teamName</span>)
+
: [[API C_ActionBar.PutActionInSlot|C_ActionBar.PutActionInSlot]](<span style="font-size:smaller; color:#ecbc2a">slotID</span>)
: [[API C_Commentator.AssignPlayerToTeam|C_Commentator.AssignPlayerToTeam]](<span style="font-size:smaller; color:#ecbc2a">playerName, teamName</span>)
+
: [[API C_ActionBar.ShouldOverrideBarShowHealthBar|C_ActionBar.ShouldOverrideBarShowHealthBar]]() : <span style="font-size:smaller; color:#4ec9b0">showHealthBar</span>
: [[API C_Commentator.CanUseCommentatorCheats|C_Commentator.CanUseCommentatorCheats]]() : <span style="font-size:smaller; color:#4ec9b0">canUseCommentatorCheats</span>
+
: [[API C_ActionBar.ShouldOverrideBarShowManaBar|C_ActionBar.ShouldOverrideBarShowManaBar]]() : <span style="font-size:smaller; color:#4ec9b0">showManaBar</span>
  +
: <small>NOCOMBAT</small> [[API ChangeActionBarPage|ChangeActionBarPage]](<span style="font-size:smaller; color:#ecbc2a">page</span>) - Changes the current action bar page.
: [[API C_Commentator.ClearCameraTarget|C_Commentator.ClearCameraTarget]]()
 
  +
: [[API GetActionBarPage|GetActionBarPage]]() - Returns the current action bar page. CURRENT_ACTIONBAR_PAGE is obsolete.
: [[API C_Commentator.ClearFollowTarget|C_Commentator.ClearFollowTarget]]()
 
  +
: [[API GetActionBarToggles|GetActionBarToggles]]() - Returns the toggles for each action bar.
: [[API C_Commentator.ClearLookAtTarget|C_Commentator.ClearLookAtTarget]](<span style="font-size:smaller; color:#ecbc2a">[lookAtIndex]</span>)
 
  +
: [[API GetBonusBarIndex|GetBonusBarIndex]]()
: [[API C_Commentator.EnterInstance|C_Commentator.EnterInstance]]()
 
  +
: [[API GetBonusBarOffset|GetBonusBarOffset]]() - Determine which page of bonus actions to show.
: [[API C_Commentator.ExitInstance|C_Commentator.ExitInstance]]()
 
  +
: [[API GetExtraBarIndex|GetExtraBarIndex]]()
: [[API C_Commentator.FindSpectatedUnit|C_Commentator.FindSpectatedUnit]](<span style="font-size:smaller; color:#ecbc2a">unitToken</span>) : <span style="font-size:smaller; color:#4ec9b0">playerIndex, teamIndex, isPet</span>
 
  +
: [[API GetMultiCastBarIndex|GetMultiCastBarIndex]]()
: [[API C_Commentator.FindTeamNameInCurrentInstance|C_Commentator.FindTeamNameInCurrentInstance]](<span style="font-size:smaller; color:#ecbc2a">teamIndex</span>) : <span style="font-size:smaller; color:#4ec9b0">teamName</span>
 
  +
: [[API GetOverrideBarIndex|GetOverrideBarIndex]]()
: [[API C_Commentator.FindTeamNameInDirectory|C_Commentator.FindTeamNameInDirectory]](<span style="font-size:smaller; color:#ecbc2a">playerNames</span>) : <span style="font-size:smaller; color:#4ec9b0">teamName</span>
 
  +
: [[API GetOverrideBarSkin|GetOverrideBarSkin]]()
: [[API C_Commentator.FlushCommentatorHistory|C_Commentator.FlushCommentatorHistory]]()
 
  +
: [[API GetTempShapeshiftBarIndex|GetTempShapeshiftBarIndex]]()
: [[API C_Commentator.FollowPlayer|C_Commentator.FollowPlayer]](<span style="font-size:smaller; color:#ecbc2a">factionIndex, playerIndex [, forceInstantTransition]</span>)
 
  +
: [[API GetVehicleBarIndex|GetVehicleBarIndex]]()
: [[API C_Commentator.FollowUnit|C_Commentator.FollowUnit]](<span style="font-size:smaller; color:#ecbc2a">token</span>)
 
  +
: [[API HasBonusActionBar|HasBonusActionBar]]()
: [[API C_Commentator.ForceFollowTransition|C_Commentator.ForceFollowTransition]]()
 
  +
: [[API HasExtraActionBar|HasExtraActionBar]]()
: [[API C_Commentator.GetAdditionalCameraWeight|C_Commentator.GetAdditionalCameraWeight]]() : <span style="font-size:smaller; color:#4ec9b0">teamIndex, playerIndex</span>
 
  +
: [[API HasOverrideActionBar|HasOverrideActionBar]]()
: [[API C_Commentator.GetAdditionalCameraWeightByToken|C_Commentator.GetAdditionalCameraWeightByToken]](<span style="font-size:smaller; color:#ecbc2a">unitToken</span>) : <span style="font-size:smaller; color:#4ec9b0">weight</span>
 
  +
: [[API HasTempShapeshiftActionBar|HasTempShapeshiftActionBar]]()
: [[API C_Commentator.GetAllPlayerOverrideNames|C_Commentator.GetAllPlayerOverrideNames]]() : <span style="font-size:smaller; color:#4ec9b0">nameEntries</span>
 
  +
: [[API HasVehicleActionBar|HasVehicleActionBar]]()
: [[API C_Commentator.GetCamera|C_Commentator.GetCamera]]() : <span style="font-size:smaller; color:#4ec9b0">xPos, yPos, zPos, yaw, pitch, roll, fov</span>
 
  +
: [[API IsPossessBarVisible|IsPossessBarVisible]]()
: [[API C_Commentator.GetCameraCollision|C_Commentator.GetCameraCollision]]() : <span style="font-size:smaller; color:#4ec9b0">isColliding</span>
 
  +
: [[API PetHasActionBar|PetHasActionBar]]() - Determine if player has a pet with an action bar.
: [[API C_Commentator.GetCameraPosition|C_Commentator.GetCameraPosition]]() : <span style="font-size:smaller; color:#4ec9b0">xPos, yPos, zPos</span>
 
: [[API C_Commentator.GetCommentatorHistory|C_Commentator.GetCommentatorHistory]]() : <span style="font-size:smaller; color:#4ec9b0">history</span>
+
: [[API SetActionBarToggles|SetActionBarToggles]](<span style="font-size:smaller; color:#ecbc2a">show1, show2, show3, show4 [, alwaysShow]</span>) - Set show toggle for each action bar.
: [[API C_Commentator.GetCurrentMapID|C_Commentator.GetCurrentMapID]]() : <span style="font-size:smaller; color:#4ec9b0">mapID</span>
 
: [[API C_Commentator.GetDampeningPercent|C_Commentator.GetDampeningPercent]]() : <span style="font-size:smaller; color:#4ec9b0">percentage</span>
 
: [[API C_Commentator.GetDistanceBeforeForcedHorizontalConvergence|C_Commentator.GetDistanceBeforeForcedHorizontalConvergence]]() : <span style="font-size:smaller; color:#4ec9b0">distance</span>
 
: [[API C_Commentator.GetDurationToForceHorizontalConvergence|C_Commentator.GetDurationToForceHorizontalConvergence]]() : <span style="font-size:smaller; color:#4ec9b0">ms</span>
 
: [[API C_Commentator.GetExcludeDistance|C_Commentator.GetExcludeDistance]]() : <span style="font-size:smaller; color:#4ec9b0">excludeDistance</span>
 
: [[API C_Commentator.GetHardlockWeight|C_Commentator.GetHardlockWeight]]() : <span style="font-size:smaller; color:#4ec9b0">weight</span>
 
: [[API C_Commentator.GetHorizontalAngleThresholdToSmooth|C_Commentator.GetHorizontalAngleThresholdToSmooth]]() : <span style="font-size:smaller; color:#4ec9b0">angle</span>
 
: [[API C_Commentator.GetIndirectSpellID|C_Commentator.GetIndirectSpellID]](<span style="font-size:smaller; color:#ecbc2a">trackedSpellID</span>) : <span style="font-size:smaller; color:#4ec9b0">indirectSpellID</span>
 
: [[API C_Commentator.GetInstanceInfo|C_Commentator.GetInstanceInfo]](<span style="font-size:smaller; color:#ecbc2a">mapIndex, instanceIndex</span>) : <span style="font-size:smaller; color:#4ec9b0">mapID, mapName, status, instanceIDLow, instanceIDHigh</span>
 
: [[API C_Commentator.GetLookAtLerpAmount|C_Commentator.GetLookAtLerpAmount]]() : <span style="font-size:smaller; color:#4ec9b0">amount</span>
 
: [[API C_Commentator.GetMapInfo|C_Commentator.GetMapInfo]](<span style="font-size:smaller; color:#ecbc2a">mapIndex</span>) : <span style="font-size:smaller; color:#4ec9b0">teamSize, minLevel, maxLevel, numInstances</span>
 
: [[API C_Commentator.GetMatchDuration|C_Commentator.GetMatchDuration]]() : <span style="font-size:smaller; color:#4ec9b0">seconds</span>
 
: [[API C_Commentator.GetMaxNumPlayersPerTeam|C_Commentator.GetMaxNumPlayersPerTeam]]() : <span style="font-size:smaller; color:#4ec9b0">maxNumPlayersPerTeam</span>
 
: [[API C_Commentator.GetMaxNumTeams|C_Commentator.GetMaxNumTeams]]() : <span style="font-size:smaller; color:#4ec9b0">maxNumTeams</span>
 
: [[API C_Commentator.GetMode|C_Commentator.GetMode]]() : <span style="font-size:smaller; color:#4ec9b0">commentatorMode</span>
 
: [[API C_Commentator.GetMsToHoldForHorizontalMovement|C_Commentator.GetMsToHoldForHorizontalMovement]]() : <span style="font-size:smaller; color:#4ec9b0">ms</span>
 
: [[API C_Commentator.GetMsToHoldForVerticalMovement|C_Commentator.GetMsToHoldForVerticalMovement]]() : <span style="font-size:smaller; color:#4ec9b0">ms</span>
 
: [[API C_Commentator.GetMsToSmoothHorizontalChange|C_Commentator.GetMsToSmoothHorizontalChange]]() : <span style="font-size:smaller; color:#4ec9b0">ms</span>
 
: [[API C_Commentator.GetMsToSmoothVerticalChange|C_Commentator.GetMsToSmoothVerticalChange]]() : <span style="font-size:smaller; color:#4ec9b0">ms</span>
 
: [[API C_Commentator.GetNumMaps|C_Commentator.GetNumMaps]]() : <span style="font-size:smaller; color:#4ec9b0">numMaps</span>
 
: [[API C_Commentator.GetNumPlayers|C_Commentator.GetNumPlayers]](<span style="font-size:smaller; color:#ecbc2a">factionIndex</span>) : <span style="font-size:smaller; color:#4ec9b0">numPlayers</span>
 
: [[API C_Commentator.GetOrCreateSeries|C_Commentator.GetOrCreateSeries]](<span style="font-size:smaller; color:#ecbc2a">teamName1, teamName2</span>) : <span style="font-size:smaller; color:#4ec9b0">data</span>
 
: [[API C_Commentator.GetPlayerAuraInfo|C_Commentator.GetPlayerAuraInfo]](<span style="font-size:smaller; color:#ecbc2a">teamIndex, playerIndex, spellID</span>) : <span style="font-size:smaller; color:#4ec9b0">startTime, duration, enable</span>
 
: [[API C_Commentator.GetPlayerAuraInfoByUnit|C_Commentator.GetPlayerAuraInfoByUnit]](<span style="font-size:smaller; color:#ecbc2a">token, spellID</span>) : <span style="font-size:smaller; color:#4ec9b0">startTime, duration, enable</span>
 
: [[API C_Commentator.GetPlayerCooldownInfo|C_Commentator.GetPlayerCooldownInfo]](<span style="font-size:smaller; color:#ecbc2a">teamIndex, playerIndex, spellID</span>) : <span style="font-size:smaller; color:#4ec9b0">startTime, duration, enable</span>
 
: [[API C_Commentator.GetPlayerCooldownInfoByUnit|C_Commentator.GetPlayerCooldownInfoByUnit]](<span style="font-size:smaller; color:#ecbc2a">unitToken, spellID</span>) : <span style="font-size:smaller; color:#4ec9b0">startTime, duration, enable</span>
 
: [[API C_Commentator.GetPlayerCrowdControlInfo|C_Commentator.GetPlayerCrowdControlInfo]](<span style="font-size:smaller; color:#ecbc2a">teamIndex, playerIndex</span>) : <span style="font-size:smaller; color:#4ec9b0">spellID, expiration, duration</span>
 
: [[API C_Commentator.GetPlayerCrowdControlInfoByUnit|C_Commentator.GetPlayerCrowdControlInfoByUnit]](<span style="font-size:smaller; color:#ecbc2a">token</span>) : <span style="font-size:smaller; color:#4ec9b0">spellID, expiration, duration</span>
 
: [[API C_Commentator.GetPlayerData|C_Commentator.GetPlayerData]](<span style="font-size:smaller; color:#ecbc2a">teamIndex, playerIndex</span>) : <span style="font-size:smaller; color:#4ec9b0">info</span>
 
: [[API C_Commentator.GetPlayerFlagInfo|C_Commentator.GetPlayerFlagInfo]](<span style="font-size:smaller; color:#ecbc2a">teamIndex, playerIndex</span>) : <span style="font-size:smaller; color:#4ec9b0">hasFlag</span>
 
: [[API C_Commentator.GetPlayerFlagInfoByUnit|C_Commentator.GetPlayerFlagInfoByUnit]](<span style="font-size:smaller; color:#ecbc2a">unitToken</span>) : <span style="font-size:smaller; color:#4ec9b0">hasFlag</span>
 
: [[API C_Commentator.GetPlayerOverrideName|C_Commentator.GetPlayerOverrideName]](<span style="font-size:smaller; color:#ecbc2a">originalName</span>) : <span style="font-size:smaller; color:#4ec9b0">overrideName</span>
 
: [[API C_Commentator.GetPlayerSpellCharges|C_Commentator.GetPlayerSpellCharges]](<span style="font-size:smaller; color:#ecbc2a">teamIndex, playerIndex, spellID</span>) : <span style="font-size:smaller; color:#4ec9b0">charges, maxCharges, startTime, duration</span>
 
: [[API C_Commentator.GetPlayerSpellChargesByUnit|C_Commentator.GetPlayerSpellChargesByUnit]](<span style="font-size:smaller; color:#ecbc2a">unitToken, spellID</span>) : <span style="font-size:smaller; color:#4ec9b0">charges, maxCharges, startTime, duration</span>
 
: [[API C_Commentator.GetPositionLerpAmount|C_Commentator.GetPositionLerpAmount]]() : <span style="font-size:smaller; color:#4ec9b0">amount</span>
 
: [[API C_Commentator.GetSmoothFollowTransitioning|C_Commentator.GetSmoothFollowTransitioning]]() : <span style="font-size:smaller; color:#4ec9b0">enabled</span>
 
: [[API C_Commentator.GetSoftlockWeight|C_Commentator.GetSoftlockWeight]]() : <span style="font-size:smaller; color:#4ec9b0">weight</span>
 
: [[API C_Commentator.GetSpeedFactor|C_Commentator.GetSpeedFactor]]() : <span style="font-size:smaller; color:#4ec9b0">factor</span>
 
: [[API C_Commentator.GetStartLocation|C_Commentator.GetStartLocation]](<span style="font-size:smaller; color:#ecbc2a">mapID</span>) : <span style="font-size:smaller; color:#4ec9b0">pos</span>
 
: [[API C_Commentator.GetTeamColor|C_Commentator.GetTeamColor]](<span style="font-size:smaller; color:#ecbc2a">teamIndex</span>) : <span style="font-size:smaller; color:#4ec9b0">color</span>
 
: [[API C_Commentator.GetTeamColorByUnit|C_Commentator.GetTeamColorByUnit]](<span style="font-size:smaller; color:#ecbc2a">unitToken</span>) : <span style="font-size:smaller; color:#4ec9b0">color</span>
 
: [[API C_Commentator.GetTimeLeftInMatch|C_Commentator.GetTimeLeftInMatch]]() : <span style="font-size:smaller; color:#4ec9b0">timeLeft</span>
 
: [[API C_Commentator.GetTrackedSpellID|C_Commentator.GetTrackedSpellID]](<span style="font-size:smaller; color:#ecbc2a">indirectSpellID</span>) : <span style="font-size:smaller; color:#4ec9b0">trackedSpellID</span>
 
: [[API C_Commentator.GetTrackedSpells|C_Commentator.GetTrackedSpells]](<span style="font-size:smaller; color:#ecbc2a">teamIndex, playerIndex, category</span>) : <span style="font-size:smaller; color:#4ec9b0">spells</span>
 
: [[API C_Commentator.GetTrackedSpellsByUnit|C_Commentator.GetTrackedSpellsByUnit]](<span style="font-size:smaller; color:#ecbc2a">unitToken, category</span>) : <span style="font-size:smaller; color:#4ec9b0">spells</span>
 
: [[API C_Commentator.GetUnitData|C_Commentator.GetUnitData]](<span style="font-size:smaller; color:#ecbc2a">unitToken</span>) : <span style="font-size:smaller; color:#4ec9b0">data</span>
 
: [[API C_Commentator.GetWargameInfo|C_Commentator.GetWargameInfo]](<span style="font-size:smaller; color:#ecbc2a">listID</span>) : <span style="font-size:smaller; color:#4ec9b0">name, minPlayers, maxPlayers, isArena</span>
 
: [[API C_Commentator.HasTrackedAuras|C_Commentator.HasTrackedAuras]](<span style="font-size:smaller; color:#ecbc2a">token</span>) : <span style="font-size:smaller; color:#4ec9b0">hasOffensiveAura, hasDefensiveAura</span>
 
: [[API C_Commentator.IsSmartCameraLocked|C_Commentator.IsSmartCameraLocked]]() : <span style="font-size:smaller; color:#4ec9b0">isSmartCameraLocked</span>
 
: [[API C_Commentator.IsSpectating|C_Commentator.IsSpectating]]() : <span style="font-size:smaller; color:#4ec9b0">isSpectating</span>
 
: [[API C_Commentator.IsTrackedDefensiveAura|C_Commentator.IsTrackedDefensiveAura]](<span style="font-size:smaller; color:#ecbc2a">spellID</span>) : <span style="font-size:smaller; color:#4ec9b0">isDefensiveTrigger</span>
 
: [[API C_Commentator.IsTrackedOffensiveAura|C_Commentator.IsTrackedOffensiveAura]](<span style="font-size:smaller; color:#ecbc2a">spellID</span>) : <span style="font-size:smaller; color:#4ec9b0">isOffensiveTrigger</span>
 
: [[API C_Commentator.IsTrackedSpell|C_Commentator.IsTrackedSpell]](<span style="font-size:smaller; color:#ecbc2a">teamIndex, playerIndex, spellID, category</span>) : <span style="font-size:smaller; color:#4ec9b0">isTracked</span>
 
: [[API C_Commentator.IsTrackedSpellByUnit|C_Commentator.IsTrackedSpellByUnit]](<span style="font-size:smaller; color:#ecbc2a">unitToken, spellID, category</span>) : <span style="font-size:smaller; color:#4ec9b0">isTracked</span>
 
: [[API C_Commentator.IsUsingSmartCamera|C_Commentator.IsUsingSmartCamera]]() : <span style="font-size:smaller; color:#4ec9b0">isUsingSmartCamera</span>
 
: [[API C_Commentator.LookAtPlayer|C_Commentator.LookAtPlayer]](<span style="font-size:smaller; color:#ecbc2a">factionIndex, playerIndex [, lookAtIndex]</span>)
 
: [[API C_Commentator.RemoveAllOverrideNames|C_Commentator.RemoveAllOverrideNames]]()
 
: [[API C_Commentator.RemovePlayerOverrideName|C_Commentator.RemovePlayerOverrideName]](<span style="font-size:smaller; color:#ecbc2a">originalPlayerName</span>)
 
: [[API C_Commentator.RequestPlayerCooldownInfo|C_Commentator.RequestPlayerCooldownInfo]](<span style="font-size:smaller; color:#ecbc2a">teamIndex, playerIndex</span>)
 
: [[API C_Commentator.ResetFoVTarget|C_Commentator.ResetFoVTarget]]()
 
: [[API C_Commentator.ResetSeriesScores|C_Commentator.ResetSeriesScores]](<span style="font-size:smaller; color:#ecbc2a">teamName1, teamName2</span>)
 
: [[API C_Commentator.ResetSettings|C_Commentator.ResetSettings]]()
 
: [[API C_Commentator.ResetTrackedAuras|C_Commentator.ResetTrackedAuras]]()
 
: [[API C_Commentator.SetAdditionalCameraWeight|C_Commentator.SetAdditionalCameraWeight]](<span style="font-size:smaller; color:#ecbc2a">teamIndex, playerIndex, weight</span>)
 
: [[API C_Commentator.SetAdditionalCameraWeightByToken|C_Commentator.SetAdditionalCameraWeightByToken]](<span style="font-size:smaller; color:#ecbc2a">unitToken, weight</span>)
 
: [[API C_Commentator.SetBlacklistedAuras|C_Commentator.SetBlacklistedAuras]](<span style="font-size:smaller; color:#ecbc2a">spellIDs</span>)
 
: [[API C_Commentator.SetBlacklistedCooldowns|C_Commentator.SetBlacklistedCooldowns]](<span style="font-size:smaller; color:#ecbc2a">specID, spellIDs</span>)
 
: [[API C_Commentator.SetCamera|C_Commentator.SetCamera]](<span style="font-size:smaller; color:#ecbc2a">xPos, yPos, zPos, yaw, pitch, roll, fov</span>)
 
: [[API C_Commentator.SetCameraCollision|C_Commentator.SetCameraCollision]](<span style="font-size:smaller; color:#ecbc2a">collide</span>)
 
: [[API C_Commentator.SetCameraPosition|C_Commentator.SetCameraPosition]](<span style="font-size:smaller; color:#ecbc2a">xPos, yPos, zPos, snapToLocation</span>)
 
: [[API C_Commentator.SetCheatsEnabled|C_Commentator.SetCheatsEnabled]](<span style="font-size:smaller; color:#ecbc2a">enableCheats</span>)
 
: [[API C_Commentator.SetCommentatorHistory|C_Commentator.SetCommentatorHistory]](<span style="font-size:smaller; color:#ecbc2a">history</span>)
 
: [[API C_Commentator.SetDistanceBeforeForcedHorizontalConvergence|C_Commentator.SetDistanceBeforeForcedHorizontalConvergence]](<span style="font-size:smaller; color:#ecbc2a">distance</span>)
 
: [[API C_Commentator.SetDurationToForceHorizontalConvergence|C_Commentator.SetDurationToForceHorizontalConvergence]](<span style="font-size:smaller; color:#ecbc2a">ms</span>)
 
: [[API C_Commentator.SetExcludeDistance|C_Commentator.SetExcludeDistance]](<span style="font-size:smaller; color:#ecbc2a">excludeDistance</span>)
 
: [[API C_Commentator.SetFollowCameraSpeeds|C_Commentator.SetFollowCameraSpeeds]](<span style="font-size:smaller; color:#ecbc2a">elasticSpeed, minSpeed</span>)
 
: [[API C_Commentator.SetHardlockWeight|C_Commentator.SetHardlockWeight]](<span style="font-size:smaller; color:#ecbc2a">weight</span>)
 
: [[API C_Commentator.SetHorizontalAngleThresholdToSmooth|C_Commentator.SetHorizontalAngleThresholdToSmooth]](<span style="font-size:smaller; color:#ecbc2a">angle</span>)
 
: [[API C_Commentator.SetLookAtLerpAmount|C_Commentator.SetLookAtLerpAmount]](<span style="font-size:smaller; color:#ecbc2a">amount</span>)
 
: [[API C_Commentator.SetMapAndInstanceIndex|C_Commentator.SetMapAndInstanceIndex]](<span style="font-size:smaller; color:#ecbc2a">mapIndex, instanceIndex</span>)
 
: [[API C_Commentator.SetMouseDisabled|C_Commentator.SetMouseDisabled]](<span style="font-size:smaller; color:#ecbc2a">disabled</span>)
 
: [[API C_Commentator.SetMoveSpeed|C_Commentator.SetMoveSpeed]](<span style="font-size:smaller; color:#ecbc2a">newSpeed</span>)
 
: [[API C_Commentator.SetMsToHoldForHorizontalMovement|C_Commentator.SetMsToHoldForHorizontalMovement]](<span style="font-size:smaller; color:#ecbc2a">ms</span>)
 
: [[API C_Commentator.SetMsToHoldForVerticalMovement|C_Commentator.SetMsToHoldForVerticalMovement]](<span style="font-size:smaller; color:#ecbc2a">ms</span>)
 
: [[API C_Commentator.SetMsToSmoothHorizontalChange|C_Commentator.SetMsToSmoothHorizontalChange]](<span style="font-size:smaller; color:#ecbc2a">ms</span>)
 
: [[API C_Commentator.SetMsToSmoothVerticalChange|C_Commentator.SetMsToSmoothVerticalChange]](<span style="font-size:smaller; color:#ecbc2a">ms</span>)
 
: [[API C_Commentator.SetPositionLerpAmount|C_Commentator.SetPositionLerpAmount]](<span style="font-size:smaller; color:#ecbc2a">amount</span>)
 
: [[API C_Commentator.SetRequestedDebuffCooldowns|C_Commentator.SetRequestedDebuffCooldowns]](<span style="font-size:smaller; color:#ecbc2a">specID, spellIDs</span>)
 
: [[API C_Commentator.SetRequestedDefensiveCooldowns|C_Commentator.SetRequestedDefensiveCooldowns]](<span style="font-size:smaller; color:#ecbc2a">specID, spellIDs</span>)
 
: [[API C_Commentator.SetRequestedOffensiveCooldowns|C_Commentator.SetRequestedOffensiveCooldowns]](<span style="font-size:smaller; color:#ecbc2a">specID, spellIDs</span>)
 
: [[API C_Commentator.SetSeriesScore|C_Commentator.SetSeriesScore]](<span style="font-size:smaller; color:#ecbc2a">teamName1, teamName2, scoringTeamName, score</span>)
 
: [[API C_Commentator.SetSeriesScores|C_Commentator.SetSeriesScores]](<span style="font-size:smaller; color:#ecbc2a">teamName1, teamName2, score1, score2</span>)
 
: [[API C_Commentator.SetSmartCameraLocked|C_Commentator.SetSmartCameraLocked]](<span style="font-size:smaller; color:#ecbc2a">locked</span>)
 
: [[API C_Commentator.SetSmoothFollowTransitioning|C_Commentator.SetSmoothFollowTransitioning]](<span style="font-size:smaller; color:#ecbc2a">enabled</span>)
 
: [[API C_Commentator.SetSoftlockWeight|C_Commentator.SetSoftlockWeight]](<span style="font-size:smaller; color:#ecbc2a">weight</span>)
 
: [[API C_Commentator.SetSpeedFactor|C_Commentator.SetSpeedFactor]](<span style="font-size:smaller; color:#ecbc2a">factor</span>)
 
: [[API C_Commentator.SetTargetHeightOffset|C_Commentator.SetTargetHeightOffset]](<span style="font-size:smaller; color:#ecbc2a">offset</span>)
 
: [[API C_Commentator.SetUseSmartCamera|C_Commentator.SetUseSmartCamera]](<span style="font-size:smaller; color:#ecbc2a">useSmartCamera</span>)
 
: [[API C_Commentator.SnapCameraLookAtPoint|C_Commentator.SnapCameraLookAtPoint]]()
 
: [[API C_Commentator.StartWargame|C_Commentator.StartWargame]](<span style="font-size:smaller; color:#ecbc2a">listID, teamSize, tournamentRules, teamOneCaptain, teamTwoCaptain</span>)
 
: [[API C_Commentator.SwapTeamSides|C_Commentator.SwapTeamSides]]()
 
: [[API C_Commentator.ToggleCheats|C_Commentator.ToggleCheats]]()
 
: [[API C_Commentator.UpdateMapInfo|C_Commentator.UpdateMapInfo]](<span style="font-size:smaller; color:#ecbc2a">[targetPlayer]</span>)
 
: [[API C_Commentator.UpdatePlayerInfo|C_Commentator.UpdatePlayerInfo]]()
 
: [[API C_Commentator.ZoomIn|C_Commentator.ZoomIn]]()
 
: [[API C_Commentator.ZoomOut|C_Commentator.ZoomOut]]()
 
   
=== Currency ===
+
==== Action Buttons ====
  +
: [[API C_ActionBar.FindPetActionButtons|C_ActionBar.FindPetActionButtons]](<span style="font-size:smaller; color:#ecbc2a">petActionID</span>) : <span style="font-size:smaller; color:#4ec9b0">slots</span>
[[Currencies]] were added in [[Patch 3.0.2]].
 
: [[API C_CurrencyInfo.DoesWarModeBonusApply|C_CurrencyInfo.DoesWarModeBonusApply]](<span style="font-size:smaller; color:#ecbc2a">currencyID</span>) : <span style="font-size:smaller; color:#4ec9b0">warModeApplies, limitOncePerTooltip</span>
+
: [[API C_ActionBar.FindSpellActionButtons|C_ActionBar.FindSpellActionButtons]](<span style="font-size:smaller; color:#ecbc2a">spellID</span>) : <span style="font-size:smaller; color:#4ec9b0">slots</span>
: [[API C_CurrencyInfo.ExpandCurrencyList|C_CurrencyInfo.ExpandCurrencyList]](<span style="font-size:smaller; color:#ecbc2a">index, expand</span>) - Sets the expanded/collapsed state of a currency list header.
+
: [[API C_ActionBar.GetPetActionPetBarIndices|C_ActionBar.GetPetActionPetBarIndices]](<span style="font-size:smaller; color:#ecbc2a">petActionID</span>) : <span style="font-size:smaller; color:#4ec9b0">slots</span>
: [[API C_CurrencyInfo.GetAzeriteCurrencyID|C_CurrencyInfo.GetAzeriteCurrencyID]]() : <span style="font-size:smaller; color:#4ec9b0">azeriteCurrencyID</span>
+
: [[API C_ActionBar.HasPetActionButtons|C_ActionBar.HasPetActionButtons]](<span style="font-size:smaller; color:#ecbc2a">petActionID</span>) : <span style="font-size:smaller; color:#4ec9b0">hasPetActionButtons</span>
: [[API C_CurrencyInfo.GetBackpackCurrencyInfo|C_CurrencyInfo.GetBackpackCurrencyInfo]](<span style="font-size:smaller; color:#ecbc2a">index</span>) : <span style="font-size:smaller; color:#4ec9b0">info</span> - Returns information about a watched currency.
+
: [[API C_ActionBar.HasPetActionPetBarIndices|C_ActionBar.HasPetActionPetBarIndices]](<span style="font-size:smaller; color:#ecbc2a">petActionID</span>) : <span style="font-size:smaller; color:#4ec9b0">hasPetActionPetBarIndices</span>
: [[API C_CurrencyInfo.GetBasicCurrencyInfo|C_CurrencyInfo.GetBasicCurrencyInfo]](<span style="font-size:smaller; color:#ecbc2a">currencyType [, quantity]</span>) : <span style="font-size:smaller; color:#4ec9b0">info</span>
+
: [[API C_ActionBar.HasSpellActionButtons|C_ActionBar.HasSpellActionButtons]](<span style="font-size:smaller; color:#ecbc2a">spellID</span>) : <span style="font-size:smaller; color:#4ec9b0">hasSpellActionButtons</span>
: [[API C_CurrencyInfo.GetCurrencyContainerInfo|C_CurrencyInfo.GetCurrencyContainerInfo]](<span style="font-size:smaller; color:#ecbc2a">currencyType, quantity</span>) : <span style="font-size:smaller; color:#4ec9b0">info</span>
+
: [[API C_ActionBar.IsAutoCastPetAction|C_ActionBar.IsAutoCastPetAction]](<span style="font-size:smaller; color:#ecbc2a">slotID</span>) : <span style="font-size:smaller; color:#4ec9b0">isAutoCastPetAction</span>
: [[API C_CurrencyInfo.GetCurrencyIDFromLink|C_CurrencyInfo.GetCurrencyIDFromLink]](<span style="font-size:smaller; color:#ecbc2a">currencyLink</span>) : <span style="font-size:smaller; color:#4ec9b0">currencyID</span>
+
: [[API C_ActionBar.IsEnabledAutoCastPetAction|C_ActionBar.IsEnabledAutoCastPetAction]](<span style="font-size:smaller; color:#ecbc2a">slotID</span>) : <span style="font-size:smaller; color:#4ec9b0">isEnabledAutoCastPetAction</span>
: [[API C_CurrencyInfo.GetCurrencyInfo|C_CurrencyInfo.GetCurrencyInfo]](<span style="font-size:smaller; color:#ecbc2a">type</span>) : <span style="font-size:smaller; color:#4ec9b0">info</span> - Returns information about currencies.
+
: [[API C_ActionBar.ToggleAutoCastPetAction|C_ActionBar.ToggleAutoCastPetAction]](<span style="font-size:smaller; color:#ecbc2a">slotID</span>)
: [[API C_CurrencyInfo.GetCurrencyInfoFromLink|C_CurrencyInfo.GetCurrencyInfoFromLink]](<span style="font-size:smaller; color:#ecbc2a">link</span>) : <span style="font-size:smaller; color:#4ec9b0">info</span> - Returns information about currencies from a link.
+
: [[API ActionHasRange|ActionHasRange]](<span style="font-size:smaller; color:#ecbc2a">slot</span>) - Determine if the specified action is a range restriction (1 if yes, nil if no)
  +
: [[API ClickWorldMapActionButton|ClickWorldMapActionButton]]()
: [[API C_CurrencyInfo.GetCurrencyLink|C_CurrencyInfo.GetCurrencyLink]](<span style="font-size:smaller; color:#ecbc2a">type, amount</span>) : <span style="font-size:smaller; color:#4ec9b0">link</span> - Returns the currencyLink for the specified currencyID.
 
: [[API C_CurrencyInfo.GetCurrencyListInfo|C_CurrencyInfo.GetCurrencyListInfo]](<span style="font-size:smaller; color:#ecbc2a">index</span>) : <span style="font-size:smaller; color:#4ec9b0">info</span> - Returns information about an element in the currency list.
+
: [[API GetActionAutocast|GetActionAutocast]](<span style="font-size:smaller; color:#ecbc2a">slot</span>)
: [[API C_CurrencyInfo.GetCurrencyListLink|C_CurrencyInfo.GetCurrencyListLink]](<span style="font-size:smaller; color:#ecbc2a">index</span>) : <span style="font-size:smaller; color:#4ec9b0">link</span>
+
: [[API GetActionCharges|GetActionCharges]](<span style="font-size:smaller; color:#ecbc2a">slot</span>) - Returns information about the charges of a charge-accumulating player ability.
: [[API C_CurrencyInfo.GetCurrencyListSize|C_CurrencyInfo.GetCurrencyListSize]]() : <span style="font-size:smaller; color:#4ec9b0">currencyListSize</span> - Returns the number of elements (both headers and currencies) in the currency list.
+
: [[API GetActionCooldown|GetActionCooldown]](<span style="font-size:smaller; color:#ecbc2a">slot</span>) - This returns the cooldown values of the specified action.
: [[API C_CurrencyInfo.GetFactionGrantedByCurrency|C_CurrencyInfo.GetFactionGrantedByCurrency]](<span style="font-size:smaller; color:#ecbc2a">currencyID</span>) : <span style="font-size:smaller; color:#4ec9b0">factionID</span> - Gets the faction ID for currency that is immediately converted into reputation with that faction instead.
+
: [[API GetActionCount|GetActionCount]](<span style="font-size:smaller; color:#ecbc2a">slot</span>) - Get the count (bandage/potion/etc) for an action, returns 0 if none or not applicable.
: [[API C_CurrencyInfo.GetWarResourcesCurrencyID|C_CurrencyInfo.GetWarResourcesCurrencyID]]() : <span style="font-size:smaller; color:#4ec9b0">warResourceCurrencyID</span>
+
: [[API GetActionInfo|GetActionInfo]](<span style="font-size:smaller; color:#ecbc2a">slot</span>) - Returns type, id, subtype.
: [[API C_CurrencyInfo.IsCurrencyContainer|C_CurrencyInfo.IsCurrencyContainer]](<span style="font-size:smaller; color:#ecbc2a">currencyID, quantity</span>) : <span style="font-size:smaller; color:#4ec9b0">isCurrencyContainer</span>
+
: [[API GetActionTexture|GetActionTexture]](<span style="font-size:smaller; color:#ecbc2a">slot</span>) - Gets the texture path for the specified action.
: [[API C_CurrencyInfo.SetCurrencyBackpack|C_CurrencyInfo.SetCurrencyBackpack]](<span style="font-size:smaller; color:#ecbc2a">index, backpack</span>) - Alters whether a currency is tracked.
+
: [[API GetActionText|GetActionText]](<span style="font-size:smaller; color:#ecbc2a">slot</span>) - Get the text label (macros, etc) for an action, returns nil if none.
: [[API C_CurrencyInfo.SetCurrencyUnused|C_CurrencyInfo.SetCurrencyUnused]](<span style="font-size:smaller; color:#ecbc2a">index, unused</span>) - Alters whether a currency is marked as unused.
+
: [[API GetPossessInfo|GetPossessInfo]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Returns texture, name, enabled.
  +
: [[API GetWorldMapActionButtonSpellInfo|GetWorldMapActionButtonSpellInfo]]()
: [[API GetCoinText|GetCoinText]](<span style="font-size:smaller; color:#ecbc2a">amount, separator</span>) - Breaks down money and inserts separator strings.
 
: [[API GetCoinTextureString|GetCoinTextureString]](<span style="font-size:smaller; color:#ecbc2a">amount [, fontHeight]</span>) - Breaks down money and inserts texture strings.
+
: [[API HasAction|HasAction]](<span style="font-size:smaller; color:#ecbc2a">slot</span>) - Returns 1 if the player has an action in the specified slot, nil otherwise.
  +
: [[API IsActionInRange|IsActionInRange]](<span style="font-size:smaller; color:#ecbc2a">slot</span>) - Test if an action is in range (1=yes, 0=no, nil=not applicable).
: [[API GetPlayerTradeCurrency|GetPlayerTradeCurrency]]()
 
  +
: [[API IsAttackAction|IsAttackAction]](<span style="font-size:smaller; color:#ecbc2a">slot</span>) - Returns 1 if an action is an 'attack' action (flashes during combat), nil otherwise.
: [[API GetTargetTradeCurrency|GetTargetTradeCurrency]]()
 
: [[API SetTradeCurrency|SetTradeCurrency]](<span style="font-size:smaller; color:#ecbc2a">type, amount</span>)
+
: [[API IsAutoRepeatAction|IsAutoRepeatAction]](<span style="font-size:smaller; color:#ecbc2a">slot</span>) - Returns 1 if an action is auto-repeating, nil otherwise.
  +
: [[API IsConsumableAction|IsConsumableAction]](<span style="font-size:smaller; color:#ecbc2a">slot</span>) - Returns 1 if an action is consumable (i.e. has a count), nil otherwise.
: <small>UI</small> [[API GetNumWatchedTokens|GetNumWatchedTokens]]() - Returns the number of currently watched currencies.
 
  +
: [[API IsCurrentAction|IsCurrentAction]](<span style="font-size:smaller; color:#ecbc2a">slot</span>) - Returns 1 if an action is the one currently underway, nil otherwise.
  +
: [[API IsEquippedAction|IsEquippedAction]](<span style="font-size:smaller; color:#ecbc2a">slot</span>) - Returns 1 if an action is equipped (i.e. connected to an item that must be equipped), nil otherwise.
  +
: [[API IsItemAction|IsItemAction]](<span style="font-size:smaller; color:#ecbc2a">slot</span>)
  +
: [[API IsPetAttackAction|IsPetAttackAction]](<span style="font-size:smaller; color:#ecbc2a">index</span>)
  +
: [[API IsStackableAction|IsStackableAction]](<span style="font-size:smaller; color:#ecbc2a">slot</span>)
  +
: [[API IsUsableAction|IsUsableAction]](<span style="font-size:smaller; color:#ecbc2a">slot</span>) - Returns 1 if an action can be used at present, nil otherwise.
  +
: [[API SetActionUIButton|SetActionUIButton]](<span style="font-size:smaller; color:#ecbc2a">checkboxFrame, actionSlot, cooldownFrame</span>)
  +
: [[API SetSpellbookPetAction|SetSpellbookPetAction]](<span style="font-size:smaller; color:#ecbc2a">slot, target</span>)
  +
: <small>PROTECTED</small> [[API UseAction|UseAction]](<span style="font-size:smaller; color:#ecbc2a">slot [, checkCursor, onSelf]</span>) - This instructs the interface to use the action associated with the specified ID, optionally on the player (regardless of target).
  +
: [[API UseWorldMapActionButtonSpellOnQuest|UseWorldMapActionButtonSpellOnQuest]]()
  +
Flyout Buttons
  +
: [[API C_ActionBar.FindFlyoutActionButtons|C_ActionBar.FindFlyoutActionButtons]](<span style="font-size:smaller; color:#ecbc2a">flyoutID</span>) : <span style="font-size:smaller; color:#4ec9b0">slots</span>
  +
: [[API C_ActionBar.HasFlyoutActionButtons|C_ActionBar.HasFlyoutActionButtons]](<span style="font-size:smaller; color:#ecbc2a">flyoutID</span>) : <span style="font-size:smaller; color:#4ec9b0">hasFlyoutActionButtons</span>
  +
: [[API FindFlyoutSlotBySpellID|FindFlyoutSlotBySpellID]](<span style="font-size:smaller; color:#ecbc2a">spellID</span>)
  +
: [[API FlyoutHasSpell|FlyoutHasSpell]](<span style="font-size:smaller; color:#ecbc2a">flyoutID, spellID</span>)
  +
: [[API GetFlyoutID|GetFlyoutID]](<span style="font-size:smaller; color:#ecbc2a">index</span>)
  +
: [[API GetFlyoutInfo|GetFlyoutInfo]](<span style="font-size:smaller; color:#ecbc2a">flyoutID</span>)
  +
: [[API GetFlyoutSlotInfo|GetFlyoutSlotInfo]](<span style="font-size:smaller; color:#ecbc2a">flyoutID, slot</span>)
  +
: [[API GetNumFlyouts|GetNumFlyouts]]()
   
=== Cursor ===
+
==== Key Bindings ====
  +
Relates to [[Key Bindings]].
  +
: [[API C_KeyBindings.GetCustomBindingType|C_KeyBindings.GetCustomBindingType]](<span style="font-size:smaller; color:#ecbc2a">bindingIndex</span>) : <span style="font-size:smaller; color:#4ec9b0">customBindingType</span> - Returns the type of a custom binding.
  +
: [[API GetBinding|GetBinding]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Get action and key bindings for that index.
  +
: [[API GetBindingAction|GetBindingAction]](<span style="font-size:smaller; color:#ecbc2a">key [, checkOverride]</span>) - Get the action bound to that key.
  +
: [[API GetBindingByKey|GetBindingByKey]](<span style="font-size:smaller; color:#ecbc2a">action [, mode]</span>)
  +
: [[API GetBindingKey|GetBindingKey]](<span style="font-size:smaller; color:#ecbc2a">command</span>) - Get the key(s) bound to that action.
  +
: [[API GetBindingText|GetBindingText]](<span style="font-size:smaller; color:#ecbc2a">[key, prefix, abbreviate]</span>) - Gets the string value for the key.
  +
: [[API GetCurrentBindingSet|GetCurrentBindingSet]]() - Queries if current set of key bindings is character or account specific.
  +
: [[API GetNumBindings|GetNumBindings]]() - Get total number key bindings and headers.
  +
: [[API LoadBindings|LoadBindings]](<span style="font-size:smaller; color:#ecbc2a">which</span>) - Loads default, account or character specific key binding set into memory from disk.
  +
: [[API RunBinding|RunBinding]](<span style="font-size:smaller; color:#ecbc2a">command [, up]</span>) - Executes the key binding named "command".
  +
: [[API SaveBindings|SaveBindings]](<span style="font-size:smaller; color:#ecbc2a">which</span>) - Saves account or character specific key bindings from memory to disk.
  +
: <small>NOCOMBAT</small> [[API SetBinding|SetBinding]](<span style="font-size:smaller; color:#ecbc2a">key [, command, mode]</span>) - Sets or unsets key bindings. (Can not be used in combat.)
  +
: <small>NOCOMBAT</small> [[API SetBindingSpell|SetBindingSpell]](<span style="font-size:smaller; color:#ecbc2a">key, spellName</span>) - Set a key binding directly to a spell, uses the same spell name syntax as /cast.
  +
: <small>NOCOMBAT</small> [[API SetBindingClick|SetBindingClick]](<span style="font-size:smaller; color:#ecbc2a">key, ButtonName [, mouseButton]</span>) - Set a key binding directly to a Button object. The click sends a mouse down when the key is pressed, and a mouse up when it is released.
  +
: <small>NOCOMBAT</small> [[API SetBindingItem|SetBindingItem]](<span style="font-size:smaller; color:#ecbc2a">key, itemname</span>)
  +
: <small>NOCOMBAT</small> [[API SetBindingMacro|SetBindingMacro]](<span style="font-size:smaller; color:#ecbc2a">key, macroname or macroId</span>)
  +
: <small>NOCOMBAT</small> [[API SetOverrideBinding|SetOverrideBinding]](<span style="font-size:smaller; color:#ecbc2a">owner, isPriority, key [, command]</span>) - Set (or clear) an override key binding.
  +
: <small>NOCOMBAT</small> [[API SetOverrideBindingSpell|SetOverrideBindingSpell]](<span style="font-size:smaller; color:#ecbc2a">owner, isPriority, key, spellname</span>)
  +
: <small>NOCOMBAT</small> [[API SetOverrideBindingClick|SetOverrideBindingClick]](<span style="font-size:smaller; color:#ecbc2a">owner, isPriority, key, buttonName [, mouseClick]</span>) - Sets an override binding that acts like a mouse click on a button.
  +
: <small>NOCOMBAT</small> [[API SetOverrideBindingItem|SetOverrideBindingItem]](<span style="font-size:smaller; color:#ecbc2a">owner, isPriority, key, itemname</span>)
  +
: <small>NOCOMBAT</small> [[API SetOverrideBindingMacro|SetOverrideBindingMacro]](<span style="font-size:smaller; color:#ecbc2a">owner, isPriority, key, macroname or macroId</span>)
  +
: <small>NOCOMBAT</small> [[API ClearOverrideBindings|ClearOverrideBindings]](<span style="font-size:smaller; color:#ecbc2a">owner</span>) - Reset all overrides belonging to an owner.
  +
: [[API SetMouselookOverrideBinding|SetMouselookOverrideBinding]](<span style="font-size:smaller; color:#ecbc2a">key [, command]</span>)
  +
  +
==== Key Modifiers ====
  +
: [[API GetModifiedClick|GetModifiedClick]](<span style="font-size:smaller; color:#ecbc2a">action</span>)
  +
: [[API GetModifiedClickAction|GetModifiedClickAction]](<span style="font-size:smaller; color:#ecbc2a">index</span>)
  +
: [[API GetMouseButtonClicked|GetMouseButtonClicked]]() - Returns the name of the button that triggered a mouse down/up/click/doubleclick event.
  +
: [[API GetNumModifiedClickActions|GetNumModifiedClickActions]]()
  +
: [[API IsAltKeyDown|IsAltKeyDown]]() - Returns true if the alt key is currently depressed.
  +
: [[API IsControlKeyDown|IsControlKeyDown]]() - Returns true if the control key is currently depressed.
  +
: [[API IsKeyDown|IsKeyDown]](<span style="font-size:smaller; color:#ecbc2a">keyOrMouseName [, excludeCurrentBindingState]</span>)
  +
: [[API IsLeftAltKeyDown|IsLeftAltKeyDown]]() - Returns true if the left alt key is currently depressed.
  +
: [[API IsLeftControlKeyDown|IsLeftControlKeyDown]]() - Returns true if the left control key is currently depressed.
  +
: [[API IsLeftMetaKeyDown|IsLeftMetaKeyDown]]()
  +
: [[API IsLeftShiftKeyDown|IsLeftShiftKeyDown]]() - Returns true if the left shift key is currently depressed.
  +
: [[API IsMetaKeyDown|IsMetaKeyDown]]()
  +
: [[API IsModifiedClick|IsModifiedClick]](<span style="font-size:smaller; color:#ecbc2a">action</span>) - Returns 1 if the keys for the specified action are down, nil otherwise.
  +
: [[API IsModifierKeyDown|IsModifierKeyDown]]() - Equivalent to (IsShiftKeyDown() or IsControlKeyDown() or IsAltKeyDown()).
  +
: [[API IsMouseButtonDown|IsMouseButtonDown]](<span style="font-size:smaller; color:#ecbc2a">[button or button]</span>)
  +
: [[API IsRightAltKeyDown|IsRightAltKeyDown]]() - Returns true if the right alt key is currently depressed.
  +
: [[API IsRightControlKeyDown|IsRightControlKeyDown]]() - Returns true if the right control key is currently depressed.
  +
: [[API IsRightMetaKeyDown|IsRightMetaKeyDown]]()
  +
: [[API IsRightShiftKeyDown|IsRightShiftKeyDown]]() - Returns true if the right shift key is currently depressed.
  +
: [[API IsShiftKeyDown|IsShiftKeyDown]]() - Returns true if the shift key is currently depressed.
  +
: [[API SetModifiedClick|SetModifiedClick]](<span style="font-size:smaller; color:#ecbc2a">action, binding</span>)
  +
  +
==== Cursor ====
 
Relates to the [[Cursor]].
 
Relates to the [[Cursor]].
  +
: [[API C_CurrencyInfo.PickupCurrency|C_CurrencyInfo.PickupCurrency]](<span style="font-size:smaller; color:#ecbc2a">type</span>)
 
: [[API AutoEquipCursorItem|AutoEquipCursorItem]]() - Causes the equipment on the cursor to be equipped.
 
: [[API AutoEquipCursorItem|AutoEquipCursorItem]]() - Causes the equipment on the cursor to be equipped.
 
: [[API ClearCursor|ClearCursor]]() - Clears whatever item the cursor is dragging from the cursor.
 
: [[API ClearCursor|ClearCursor]]() - Clears whatever item the cursor is dragging from the cursor.
Line 1,800: Line 1,684:
 
: [[API PickupCompanion|PickupCompanion]](<span style="font-size:smaller; color:#ecbc2a">type, index</span>) - Picks up the indexed companion onto the mouse cursor.
 
: [[API PickupCompanion|PickupCompanion]](<span style="font-size:smaller; color:#ecbc2a">type, index</span>) - Picks up the indexed companion onto the mouse cursor.
 
: [[API PickupContainerItem|PickupContainerItem]](<span style="font-size:smaller; color:#ecbc2a">bagID, slot</span>)
 
: [[API PickupContainerItem|PickupContainerItem]](<span style="font-size:smaller; color:#ecbc2a">bagID, slot</span>)
: [[API C_CurrencyInfo.PickupCurrency|C_CurrencyInfo.PickupCurrency]](<span style="font-size:smaller; color:#ecbc2a">type</span>)
 
 
: [[API PickupGuildBankItem|PickupGuildBankItem]](<span style="font-size:smaller; color:#ecbc2a">tab, slot</span>) - Picks up an item from the guild bank.
 
: [[API PickupGuildBankItem|PickupGuildBankItem]](<span style="font-size:smaller; color:#ecbc2a">tab, slot</span>) - Picks up an item from the guild bank.
 
: [[API PickupGuildBankMoney|PickupGuildBankMoney]](<span style="font-size:smaller; color:#ecbc2a">money</span>) - Picks up "money" copper from the guild bank.
 
: [[API PickupGuildBankMoney|PickupGuildBankMoney]](<span style="font-size:smaller; color:#ecbc2a">money</span>) - Picks up "money" copper from the guild bank.
Line 1,811: Line 1,694:
 
: [[API PickupPlayerMoney|PickupPlayerMoney]](<span style="font-size:smaller; color:#ecbc2a">copper</span>) - Picks up an amount of money from the player.
 
: [[API PickupPlayerMoney|PickupPlayerMoney]](<span style="font-size:smaller; color:#ecbc2a">copper</span>) - Picks up an amount of money from the player.
 
: [[API PickupPvpTalent|PickupPvpTalent]]()
 
: [[API PickupPvpTalent|PickupPvpTalent]]()
  +
: [[API PickupSpell|PickupSpell]](<span style="font-size:smaller; color:#ecbc2a">spellID</span>) - Places the specified spell onto the cursor.
 
: [[API PickupSpellBookItem|PickupSpellBookItem]](<span style="font-size:smaller; color:#ecbc2a">spellSlot</span>)
 
: [[API PickupSpellBookItem|PickupSpellBookItem]](<span style="font-size:smaller; color:#ecbc2a">spellSlot</span>)
: [[API PickupSpell|PickupSpell]](<span style="font-size:smaller; color:#ecbc2a">spellName | spellID, bookType</span>) - Places the specified spell onto the cursor.
 
 
: [[API PickupStablePet|PickupStablePet]](<span style="font-size:smaller; color:#ecbc2a">index</span>)
 
: [[API PickupStablePet|PickupStablePet]](<span style="font-size:smaller; color:#ecbc2a">index</span>)
 
: [[API PickupTalent|PickupTalent]](<span style="font-size:smaller; color:#ecbc2a">talentID</span>) - Grabs the selected talent spell for placement on an action bar.
 
: [[API PickupTalent|PickupTalent]](<span style="font-size:smaller; color:#ecbc2a">talentID</span>) - Grabs the selected talent spell for placement on an action bar.
Line 1,825: Line 1,708:
 
: [[API ShowInventorySellCursor|ShowInventorySellCursor]]()
 
: [[API ShowInventorySellCursor|ShowInventorySellCursor]]()
 
: [[API ShowRepairCursor|ShowRepairCursor]]()
 
: [[API ShowRepairCursor|ShowRepairCursor]]()
  +
  +
==== Camera ====
  +
: <small>PROTECTED</small> [[API CameraOrSelectOrMoveStart|CameraOrSelectOrMoveStart]]() - Begin "Left click" in the 3D world.
  +
: <small>PROTECTED</small> [[API CameraOrSelectOrMoveStop|CameraOrSelectOrMoveStop]](<span style="font-size:smaller; color:#ecbc2a">[stickyFlag]</span>) - End "Left click" in the 3D world.
  +
: [[API CameraZoomIn|CameraZoomIn]](<span style="font-size:smaller; color:#ecbc2a">increment</span>) - Zooms the camera into the viewplane by increment.
  +
: [[API CameraZoomOut|CameraZoomOut]](<span style="font-size:smaller; color:#ecbc2a">increment</span>) - Zooms the camera out of the viewplane by increment.
  +
: [[API CenterCamera|CenterCamera]]()
  +
: [[API FlipCameraYaw|FlipCameraYaw]](<span style="font-size:smaller; color:#ecbc2a">degrees</span>) - Rotates the camera about the Z-axis by the angle amount specified in degrees.
  +
: [[API GetCameraZoom|GetCameraZoom]]() - Returns the current zoom level, ignoring camera collisions.
  +
: [[API IsMouselooking|IsMouselooking]]() - Returns 1 if mouselook is currently active, nil otherwise.
  +
: [[API MouselookStart|MouselookStart]]() - Enters mouse look mode; mouse movement is used to adjust movement/facing direction.
  +
: [[API MouselookStop|MouselookStop]]() - Exits mouse look mode; mouse movement is used to move the mouse cursor.
  +
: [[API MoveViewDownStart|MoveViewDownStart]]() - Begins rotating the camera downward.
  +
: [[API MoveViewDownStop|MoveViewDownStop]]() - Stops rotating the camera after [[API MoveViewDownStart|MoveViewDownStart]]() is called.
  +
: [[API MoveViewInStart|MoveViewInStart]]() - Begins zooming the camera in.
  +
: [[API MoveViewInStop|MoveViewInStop]]() - Stops zooming the camera in after [[API MoveViewInStart|MoveViewInStart]]() is called.
  +
: [[API MoveViewLeftStart|MoveViewLeftStart]]() - Begins rotating the camera to the Left.
  +
: [[API MoveViewLeftStop|MoveViewLeftStop]]() - Stops rotating the camera after [[API MoveViewLeftStart|MoveViewLeftStart]]() is called.
  +
: [[API MoveViewOutStart|MoveViewOutStart]]() - Begins zooming the camera out.
  +
: [[API MoveViewOutStop|MoveViewOutStop]]() - Stops zooming the camera out after [[API MoveViewOutStart|MoveViewOutStart]]() is called.
  +
: [[API MoveViewRightStart|MoveViewRightStart]]() - Begins rotating the camera to the Right.
  +
: [[API MoveViewRightStop|MoveViewRightStop]]() - Stops rotating the camera after [[API MoveViewRightStart|MoveViewRightStart]]() is called.
  +
: [[API MoveViewUpStart|MoveViewUpStart]]() - Begins rotating the camera upward.
  +
: [[API MoveViewUpStop|MoveViewUpStop]]() - Stops rotating the camera after [[API MoveViewUpStart|MoveViewUpStart]]() is called.
  +
: <small>PROTECTED</small> [[API PitchDownStart|PitchDownStart]]() - Begins pitching the camera Downward.
  +
: <small>PROTECTED</small> [[API PitchDownStop|PitchDownStop]]() - Stops pitching the camera after [[API PitchDownStart|PitchDownStart]]() is called.
  +
: <small>PROTECTED</small> [[API PitchUpStart|PitchUpStart]]() - Begins pitching the camera Upward.
  +
: <small>PROTECTED</small> [[API PitchUpStop|PitchUpStop]]() - Stops pitching the camera after [[API PitchUpStart|PitchUpStart]]() is called.
  +
: [[API NextView|NextView]]() - Cycles forward through the five predefined camera positions.
  +
: [[API PrevView|PrevView]]() - Cycles backward through the five predefined camera positions.
  +
: [[API ResetView|ResetView]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Resets the specified (1-5) predefined camera position to it's default if it was changed using [[API SaveView|SaveView]](index).
  +
: [[API SaveView|SaveView]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Replaces the specified (1-5) predefined camera positions with the current camera position.
  +
: [[API SetView|SetView]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Sets camera position to a specified (1-5) predefined camera position.
  +
  +
==== Targeting ====
  +
Relates to [[Target]]s.
  +
: <small>PROTECTED</small> [[API AssistUnit|AssistUnit]](<span style="font-size:smaller; color:#ecbc2a">unit</span>) - Instructs your character to assist the specified unit.
  +
: <small>PROTECTED</small> [[API ClearFocus|ClearFocus]]() - Removes any focus you may have set.
  +
: <small>PROTECTED</small> [[API ClearTarget|ClearTarget]]() - Clears the selected target.
  +
: <small>PROTECTED</small> [[API FocusUnit|FocusUnit]](<span style="font-size:smaller; color:#ecbc2a">unit</span>) - Sets your unit for focus.
  +
: [[API IsReplacingUnit|IsReplacingUnit]]()
  +
: <small>PROTECTED</small> [[API TargetDirectionEnemy|TargetDirectionEnemy]](<span style="font-size:smaller; color:#ecbc2a">facing</span>)
  +
: <small>PROTECTED</small> [[API TargetDirectionFinished|TargetDirectionFinished]]()
  +
: <small>PROTECTED</small> [[API TargetDirectionFriend|TargetDirectionFriend]](<span style="font-size:smaller; color:#ecbc2a">facing</span>)
  +
: <small>PROTECTED</small> [[API TargetLastEnemy|TargetLastEnemy]]() - Selects the last targetted enemy as the current target.
  +
: <small>PROTECTED</small> [[API TargetLastFriend|TargetLastFriend]]()
  +
: <small>PROTECTED</small> [[API TargetLastTarget|TargetLastTarget]]() - Selects the last target as the current target.
  +
: <small>PROTECTED</small> [[API TargetNearestEnemy|TargetNearestEnemy]](<span style="font-size:smaller; color:#ecbc2a">[reverseFlag]</span>) - Selects the nearest enemy as the current target.
  +
: <small>PROTECTED</small> [[API TargetNearestEnemyPlayer|TargetNearestEnemyPlayer]](<span style="font-size:smaller; color:#ecbc2a">[reverseFlag]</span>) - Selects the nearest enemy player as the current target.
  +
: <small>PROTECTED</small> [[API TargetNearestFriend|TargetNearestFriend]](<span style="font-size:smaller; color:#ecbc2a">[reverseFlag]</span>) - Selects the nearest friendly unit as the current target.
  +
: <small>PROTECTED</small> [[API TargetNearestFriendPlayer|TargetNearestFriendPlayer]](<span style="font-size:smaller; color:#ecbc2a">[reverseFlag]</span>) - Selects the nearest friendly player as the current target.
  +
: <small>PROTECTED</small> [[API TargetNearest|TargetNearest]]()
  +
: <small>PROTECTED</small> [[API TargetNearestPartyMember|TargetNearestPartyMember]]() - Selects the nearest Party member as the current target.
  +
: <small>PROTECTED</small> [[API TargetNearestRaidMember|TargetNearestRaidMember]]() - Selects the nearest Raid member as the current target.
  +
: <small>PROTECTED</small> [[API TargetPriorityHighlightEnd|TargetPriorityHighlightEnd]]()
  +
: <small>PROTECTED</small> [[API TargetPriorityHighlightStart|TargetPriorityHighlightStart]]()
  +
: <small>PROTECTED</small> [[API TargetUnit|TargetUnit]](<span style="font-size:smaller; color:#ecbc2a">unit [, exactMatch]</span>) - Selects the specified unit as the current target.
  +
  +
==== Movement ====
  +
Most of these functions may only be called on a hardware event from '''secure''' code.
  +
: <small>PROTECTED</small> [[API AscendStop|AscendStop]]() - Called when you release the jump key.
  +
: <small>PROTECTED</small> [[API AttackTarget|AttackTarget]]() - Attacks the targetted unit.
  +
: <small>PROTECTED</small> [[API DescendStop|DescendStop]]() - The player stops descending (while swimming or flying)
  +
: <small>PROTECTED</small> [[API InteractUnit|InteractUnit]](<span style="font-size:smaller; color:#ecbc2a">unitToken [, exactMatch]</span>)
  +
: [[API FollowUnit|FollowUnit]](<span style="font-size:smaller; color:#ecbc2a">unit</span>) - Follow an ally with the specified UnitID.
  +
: [[API IsPlayerMoving|IsPlayerMoving]]()
  +
: <small>PROTECTED</small> [[API JumpOrAscendStart|JumpOrAscendStart]]() - Makes the player jump.
  +
: <small>PROTECTED</small> [[API MoveAndSteerStart|MoveAndSteerStart]]()
  +
: <small>PROTECTED</small> [[API MoveAndSteerStop|MoveAndSteerStop]]()
  +
: <small>PROTECTED</small> [[API MoveBackwardStart|MoveBackwardStart]]() - The player begins moving backward at the specified time.
  +
: <small>PROTECTED</small> [[API MoveBackwardStop|MoveBackwardStop]]() - The player stops moving backward at the specified time.
  +
: <small>PROTECTED</small> [[API MoveForwardStart|MoveForwardStart]]() - The player begins moving forward at the specified time.
  +
: <small>PROTECTED</small> [[API MoveForwardStop|MoveForwardStop]]() - The player stops moving forward at the specified time.
  +
: <small>PROTECTED</small> [[API SetMoveEnabled|SetMoveEnabled]]()
  +
: <small>PROTECTED</small> [[API SetTurnEnabled|SetTurnEnabled]]()
  +
: <small>PROTECTED</small> [[API SitStandOrDescendStart|SitStandOrDescendStart]]() - The player sits, stands, or descends.
  +
: <small>PROTECTED</small> [[API StartAttack|StartAttack]]()
  +
: [[API StopAttack|StopAttack]]() - Turns off auto-attack, if currently active.
  +
: <small>PROTECTED</small> [[API StartAutoRun|StartAutoRun]]()
  +
: <small>PROTECTED</small> [[API StopAutoRun|StopAutoRun]]()
  +
: <small>PROTECTED</small> [[API StrafeLeftStart|StrafeLeftStart]]() - The player begins strafing left at the specified time.
  +
: <small>PROTECTED</small> [[API StrafeLeftStop|StrafeLeftStop]]() - The player stops strafing left at the specified time.
  +
: <small>PROTECTED</small> [[API StrafeRightStart|StrafeRightStart]]() - The player begins strafing right at the specified time.
  +
: <small>PROTECTED</small> [[API StrafeRightStop|StrafeRightStop]]() - The player stops strafing right at the specified time.
  +
: <small>PROTECTED</small> [[API ToggleAutoRun|ToggleAutoRun]]() - Turns auto-run on or off.
  +
: <small>PROTECTED</small> [[API ToggleRun|ToggleRun]]() - Toggle between running and walking.
  +
: <small>PROTECTED</small> [[API TurnLeftStart|TurnLeftStart]]() - The player starts turning left at the specified time.
  +
: <small>PROTECTED</small> [[API TurnLeftStop|TurnLeftStop]]() - The player stops turning left at the specified time.
  +
: <small>PROTECTED</small> [[API TurnOrActionStart|TurnOrActionStart]]() - Begin "Right Click" in the 3D world.
  +
: <small>PROTECTED</small> [[API TurnOrActionStop|TurnOrActionStop]]() - End "Right Click" in the 3D world.
  +
: <small>PROTECTED</small> [[API TurnRightStart|TurnRightStart]]() - The player starts turning right at the specified time.
  +
: <small>PROTECTED</small> [[API TurnRightStop|TurnRightStop]]() - The player stops turning right at the specified time.
  +
  +
==== Gamepad ====
  +
Native gamepad support was added in [[Patch 9.0.1]], where previously [https://github.com/topher-au/WoWmapper WoWmapper] was needed.
  +
: [[API C_GamePad.ApplyConfigs|C_GamePad.ApplyConfigs]]()
  +
: [[API C_GamePad.AxisIndexToConfigName|C_GamePad.AxisIndexToConfigName]](<span style="font-size:smaller; color:#ecbc2a">axisIndex</span>) : <span style="font-size:smaller; color:#4ec9b0">configName</span>
  +
: [[API C_GamePad.ButtonBindingToIndex|C_GamePad.ButtonBindingToIndex]](<span style="font-size:smaller; color:#ecbc2a">bindingName</span>) : <span style="font-size:smaller; color:#4ec9b0">buttonIndex</span>
  +
: [[API C_GamePad.ButtonIndexToBinding|C_GamePad.ButtonIndexToBinding]](<span style="font-size:smaller; color:#ecbc2a">buttonIndex</span>) : <span style="font-size:smaller; color:#4ec9b0">bindingName</span>
  +
: [[API C_GamePad.ButtonIndexToConfigName|C_GamePad.ButtonIndexToConfigName]](<span style="font-size:smaller; color:#ecbc2a">buttonIndex</span>) : <span style="font-size:smaller; color:#4ec9b0">configName</span>
  +
: [[API C_GamePad.DeleteConfig|C_GamePad.DeleteConfig]](<span style="font-size:smaller; color:#ecbc2a">configID</span>)
  +
: [[API C_GamePad.GetActiveDeviceID|C_GamePad.GetActiveDeviceID]]() : <span style="font-size:smaller; color:#4ec9b0">deviceID</span>
  +
: [[API C_GamePad.GetAllConfigIDs|C_GamePad.GetAllConfigIDs]]() : <span style="font-size:smaller; color:#4ec9b0">configIDs</span>
  +
: [[API C_GamePad.GetAllDeviceIDs|C_GamePad.GetAllDeviceIDs]]() : <span style="font-size:smaller; color:#4ec9b0">deviceIDs</span>
  +
: [[API C_GamePad.GetCombinedDeviceID|C_GamePad.GetCombinedDeviceID]]() : <span style="font-size:smaller; color:#4ec9b0">deviceID</span>
  +
: [[API C_GamePad.GetConfig|C_GamePad.GetConfig]](<span style="font-size:smaller; color:#ecbc2a">configID</span>) : <span style="font-size:smaller; color:#4ec9b0">config</span>
  +
: [[API C_GamePad.GetDeviceMappedState|C_GamePad.GetDeviceMappedState]](<span style="font-size:smaller; color:#ecbc2a">[deviceID]</span>) : <span style="font-size:smaller; color:#4ec9b0">state</span>
  +
: [[API C_GamePad.GetDeviceRawState|C_GamePad.GetDeviceRawState]](<span style="font-size:smaller; color:#ecbc2a">deviceID</span>) : <span style="font-size:smaller; color:#4ec9b0">rawState</span>
  +
: [[API C_GamePad.IsEnabled|C_GamePad.IsEnabled]]() : <span style="font-size:smaller; color:#4ec9b0">enabled</span>
  +
: [[API C_GamePad.SetConfig|C_GamePad.SetConfig]](<span style="font-size:smaller; color:#ecbc2a">config</span>)
  +
: [[API C_GamePad.StickIndexToConfigName|C_GamePad.StickIndexToConfigName]](<span style="font-size:smaller; color:#ecbc2a">stickIndex</span>) : <span style="font-size:smaller; color:#4ec9b0">configName</span>
  +
: [[API CanAutoSetGamePadCursorControl|CanAutoSetGamePadCursorControl]]()
  +
: [[API CanGamePadControlCursor|CanGamePadControlCursor]]()
  +
: [[API IsBindingForGamePad|IsBindingForGamePad]](<span style="font-size:smaller; color:#ecbc2a">KEY</span>)
  +
: [[API IsGamePadCursorControlEnabled|IsGamePadCursorControlEnabled]]()
  +
: [[API IsGamePadFreelookEnabled|IsGamePadFreelookEnabled]]()
  +
: [[API SetGamePadCursorControl|SetGamePadCursorControl]]()
  +
: [[API SetGamePadFreeLook|SetGamePadFreeLook]]()
  +
  +
=== Currency ===
  +
[[Currencies]] were added in [[Patch 3.0.2]].
  +
: [[API C_CurrencyInfo.DoesWarModeBonusApply|C_CurrencyInfo.DoesWarModeBonusApply]](<span style="font-size:smaller; color:#ecbc2a">currencyID</span>) : <span style="font-size:smaller; color:#4ec9b0">warModeApplies, limitOncePerTooltip</span>
  +
: [[API C_CurrencyInfo.ExpandCurrencyList|C_CurrencyInfo.ExpandCurrencyList]](<span style="font-size:smaller; color:#ecbc2a">index, expand</span>) - Sets the expanded/collapsed state of a currency list header.
  +
: [[API C_CurrencyInfo.GetAzeriteCurrencyID|C_CurrencyInfo.GetAzeriteCurrencyID]]() : <span style="font-size:smaller; color:#4ec9b0">azeriteCurrencyID</span>
  +
: [[API C_CurrencyInfo.GetBackpackCurrencyInfo|C_CurrencyInfo.GetBackpackCurrencyInfo]](<span style="font-size:smaller; color:#ecbc2a">index</span>) : <span style="font-size:smaller; color:#4ec9b0">info</span> - Returns information about a watched currency.
  +
: [[API C_CurrencyInfo.GetBasicCurrencyInfo|C_CurrencyInfo.GetBasicCurrencyInfo]](<span style="font-size:smaller; color:#ecbc2a">currencyType [, quantity]</span>) : <span style="font-size:smaller; color:#4ec9b0">info</span>
  +
: [[API C_CurrencyInfo.GetCurrencyContainerInfo|C_CurrencyInfo.GetCurrencyContainerInfo]](<span style="font-size:smaller; color:#ecbc2a">currencyType, quantity</span>) : <span style="font-size:smaller; color:#4ec9b0">info</span>
  +
: [[API C_CurrencyInfo.GetCurrencyIDFromLink|C_CurrencyInfo.GetCurrencyIDFromLink]](<span style="font-size:smaller; color:#ecbc2a">currencyLink</span>) : <span style="font-size:smaller; color:#4ec9b0">currencyID</span>
  +
: [[API C_CurrencyInfo.GetCurrencyInfo|C_CurrencyInfo.GetCurrencyInfo]](<span style="font-size:smaller; color:#ecbc2a">type</span>) : <span style="font-size:smaller; color:#4ec9b0">info</span> - Returns information about currencies.
  +
: [[API C_CurrencyInfo.GetCurrencyInfoFromLink|C_CurrencyInfo.GetCurrencyInfoFromLink]](<span style="font-size:smaller; color:#ecbc2a">link</span>) : <span style="font-size:smaller; color:#4ec9b0">info</span> - Returns information about currencies from a link.
  +
: [[API C_CurrencyInfo.GetCurrencyLink|C_CurrencyInfo.GetCurrencyLink]](<span style="font-size:smaller; color:#ecbc2a">type, amount</span>) : <span style="font-size:smaller; color:#4ec9b0">link</span> - Returns the currencyLink for the specified currencyID.
  +
: [[API C_CurrencyInfo.GetCurrencyListInfo|C_CurrencyInfo.GetCurrencyListInfo]](<span style="font-size:smaller; color:#ecbc2a">index</span>) : <span style="font-size:smaller; color:#4ec9b0">info</span> - Returns information about an element in the currency list.
  +
: [[API C_CurrencyInfo.GetCurrencyListLink|C_CurrencyInfo.GetCurrencyListLink]](<span style="font-size:smaller; color:#ecbc2a">index</span>) : <span style="font-size:smaller; color:#4ec9b0">link</span>
  +
: [[API C_CurrencyInfo.GetCurrencyListSize|C_CurrencyInfo.GetCurrencyListSize]]() : <span style="font-size:smaller; color:#4ec9b0">currencyListSize</span> - Returns the number of elements (both headers and currencies) in the currency list.
  +
: [[API C_CurrencyInfo.GetFactionGrantedByCurrency|C_CurrencyInfo.GetFactionGrantedByCurrency]](<span style="font-size:smaller; color:#ecbc2a">currencyID</span>) : <span style="font-size:smaller; color:#4ec9b0">factionID</span> - Gets the faction ID for currency that is immediately converted into reputation with that faction instead.
  +
: [[API C_CurrencyInfo.GetWarResourcesCurrencyID|C_CurrencyInfo.GetWarResourcesCurrencyID]]() : <span style="font-size:smaller; color:#4ec9b0">warResourceCurrencyID</span>
  +
: [[API C_CurrencyInfo.IsCurrencyContainer|C_CurrencyInfo.IsCurrencyContainer]](<span style="font-size:smaller; color:#ecbc2a">currencyID, quantity</span>) : <span style="font-size:smaller; color:#4ec9b0">isCurrencyContainer</span>
  +
: [[API C_CurrencyInfo.SetCurrencyBackpack|C_CurrencyInfo.SetCurrencyBackpack]](<span style="font-size:smaller; color:#ecbc2a">index, backpack</span>) - Alters whether a currency is tracked.
  +
: [[API C_CurrencyInfo.SetCurrencyUnused|C_CurrencyInfo.SetCurrencyUnused]](<span style="font-size:smaller; color:#ecbc2a">index, unused</span>) - Alters whether a currency is marked as unused.
  +
: [[API GetCoinText|GetCoinText]](<span style="font-size:smaller; color:#ecbc2a">amount, separator</span>) - Breaks down money and inserts separator strings.
  +
: [[API GetCoinTextureString|GetCoinTextureString]](<span style="font-size:smaller; color:#ecbc2a">amount [, fontHeight]</span>) - Breaks down money and inserts texture strings.
  +
: [[API GetPlayerTradeCurrency|GetPlayerTradeCurrency]]()
  +
: [[API GetTargetTradeCurrency|GetTargetTradeCurrency]]()
  +
: [[API SetTradeCurrency|SetTradeCurrency]](<span style="font-size:smaller; color:#ecbc2a">type, amount</span>)
  +
: <small>UI</small> [[API GetNumWatchedTokens|GetNumWatchedTokens]]() - Returns the number of currently watched currencies.
   
 
=== Customer Support ===
 
=== Customer Support ===
 
Relates to [[Customer Support]].
 
Relates to [[Customer Support]].
 
: [[API AcknowledgeSurvey|AcknowledgeSurvey]](<span style="font-size:smaller; color:#ecbc2a">caseIndex</span>)
 
: [[API AcknowledgeSurvey|AcknowledgeSurvey]](<span style="font-size:smaller; color:#ecbc2a">caseIndex</span>)
: <small>SECURE</small> [[API DeleteGMTicket|DeleteGMTicket]]()
+
: <small>PROTECTED</small> [[API DeleteGMTicket|DeleteGMTicket]]()
 
: [[API GetWebTicket|GetWebTicket]]()
 
: [[API GetWebTicket|GetWebTicket]]()
 
: [[API GMEuropaBugsEnabled|GMEuropaBugsEnabled]]()
 
: [[API GMEuropaBugsEnabled|GMEuropaBugsEnabled]]()
Line 1,877: Line 1,905:
 
: [[API KBSystem_GetServerNotice|KBSystem_GetServerNotice]]() - Returns the server notice.
 
: [[API KBSystem_GetServerNotice|KBSystem_GetServerNotice]]() - Returns the server notice.
 
: [[API KBSystem_GetServerStatus|KBSystem_GetServerStatus]]() - Returns the server status text.
 
: [[API KBSystem_GetServerStatus|KBSystem_GetServerStatus]]() - Returns the server status text.
 
=== Equipment Manager ===
 
The [[Equipment Manager]] was added in [[Patch 3.1.2]]
 
: [[API C_EquipmentSet.AssignSpecToEquipmentSet|C_EquipmentSet.AssignSpecToEquipmentSet]](<span style="font-size:smaller; color:#ecbc2a">equipmentSetID, specIndex</span>) - Assigns an equipment set to a specialization.
 
: [[API C_EquipmentSet.CanUseEquipmentSets|C_EquipmentSet.CanUseEquipmentSets]]() : <span style="font-size:smaller; color:#4ec9b0">canUseEquipmentSets</span> - Returns whether any equipment sets can be used.
 
: [[API C_EquipmentSet.ClearIgnoredSlotsForSave|C_EquipmentSet.ClearIgnoredSlotsForSave]]() - Clears ignored slots for saving.
 
: [[API C_EquipmentSet.CreateEquipmentSet|C_EquipmentSet.CreateEquipmentSet]](<span style="font-size:smaller; color:#ecbc2a">equipmentSetName [, icon]</span>) - Creates an equipment set.
 
: [[API C_EquipmentSet.DeleteEquipmentSet|C_EquipmentSet.DeleteEquipmentSet]](<span style="font-size:smaller; color:#ecbc2a">equipmentSetID</span>) - Deletes an equipment set.
 
: [[API C_EquipmentSet.EquipmentSetContainsLockedItems|C_EquipmentSet.EquipmentSetContainsLockedItems]](<span style="font-size:smaller; color:#ecbc2a">equipmentSetID</span>) : <span style="font-size:smaller; color:#4ec9b0">hasLockedItems</span> - Returns whether an equipment set has locked items
 
: [[API C_EquipmentSet.GetEquipmentSetAssignedSpec|C_EquipmentSet.GetEquipmentSetAssignedSpec]](<span style="font-size:smaller; color:#ecbc2a">equipmentSetID</span>) : <span style="font-size:smaller; color:#4ec9b0">specIndex</span> - Returns the specialization assigned to an equipment set.
 
: [[API C_EquipmentSet.GetEquipmentSetForSpec|C_EquipmentSet.GetEquipmentSetForSpec]](<span style="font-size:smaller; color:#ecbc2a">specIndex</span>) : <span style="font-size:smaller; color:#4ec9b0">equipmentSetID</span> - Returns the equipment set currently assigned to a specific specialization.
 
: [[API C_EquipmentSet.GetEquipmentSetID|C_EquipmentSet.GetEquipmentSetID]](<span style="font-size:smaller; color:#ecbc2a">equipmentSetName</span>) : <span style="font-size:smaller; color:#4ec9b0">equipmentSetID</span> - Returns the set ID of an equipment set with the specified name.
 
: [[API C_EquipmentSet.GetEquipmentSetIDs|C_EquipmentSet.GetEquipmentSetIDs]]() : <span style="font-size:smaller; color:#4ec9b0">equipmentSetIDs</span> - Returns an array containing all currently saved equipment set IDs.
 
: [[API C_EquipmentSet.GetEquipmentSetInfo|C_EquipmentSet.GetEquipmentSetInfo]](<span style="font-size:smaller; color:#ecbc2a">equipmentSetID</span>) : <span style="font-size:smaller; color:#4ec9b0">name, iconFileID, setID, isEquipped, numItems, numEquipped, numInInventory, ...</span> - Returns information about a saved equipment set.
 
: [[API C_EquipmentSet.GetIgnoredSlots|C_EquipmentSet.GetIgnoredSlots]](<span style="font-size:smaller; color:#ecbc2a">equipmentSetID</span>) : <span style="font-size:smaller; color:#4ec9b0">slotIgnored</span> - Returns ignored slots of an equipment set.
 
: [[API C_EquipmentSet.GetItemIDs|C_EquipmentSet.GetItemIDs]](<span style="font-size:smaller; color:#ecbc2a">equipmentSetID</span>) : <span style="font-size:smaller; color:#4ec9b0">itemIDs</span> - Returns the item IDs of an equipment set.
 
: [[API C_EquipmentSet.GetItemLocations|C_EquipmentSet.GetItemLocations]](<span style="font-size:smaller; color:#ecbc2a">equipmentSetID</span>) : <span style="font-size:smaller; color:#4ec9b0">locations</span> - Returns the location of all items in an equipment set.
 
: [[API C_EquipmentSet.GetNumEquipmentSets|C_EquipmentSet.GetNumEquipmentSets]]() : <span style="font-size:smaller; color:#4ec9b0">numEquipmentSets</span> - Returns the number of saved equipment sets.
 
: [[API C_EquipmentSet.IgnoreSlotForSave|C_EquipmentSet.IgnoreSlotForSave]](<span style="font-size:smaller; color:#ecbc2a">slot</span>) - Ignores an equipment slot for saving.
 
: [[API C_EquipmentSet.IsSlotIgnoredForSave|C_EquipmentSet.IsSlotIgnoredForSave]](<span style="font-size:smaller; color:#ecbc2a">slot</span>) : <span style="font-size:smaller; color:#4ec9b0">isSlotIgnored</span> - Returns whether a slot is ignored for saving.
 
: [[API C_EquipmentSet.ModifyEquipmentSet|C_EquipmentSet.ModifyEquipmentSet]](<span style="font-size:smaller; color:#ecbc2a">equipmentSetID, newName [, newIcon]</span>) - Modifies an equipment set.
 
: [[API C_EquipmentSet.PickupEquipmentSet|C_EquipmentSet.PickupEquipmentSet]](<span style="font-size:smaller; color:#ecbc2a">equipmentSetID</span>) - Picks up an equipment set, placing it on the cursor.
 
: [[API C_EquipmentSet.SaveEquipmentSet|C_EquipmentSet.SaveEquipmentSet]](<span style="font-size:smaller; color:#ecbc2a">equipmentSetID [, icon]</span>) - Saves your currently equipped items into an equipment set.
 
: [[API C_EquipmentSet.UnassignEquipmentSetSpec|C_EquipmentSet.UnassignEquipmentSetSpec]](<span style="font-size:smaller; color:#ecbc2a">equipmentSetID</span>) - Unassigns an equipment set from a specialization.
 
: [[API C_EquipmentSet.UnignoreSlotForSave|C_EquipmentSet.UnignoreSlotForSave]](<span style="font-size:smaller; color:#ecbc2a">slot</span>) - Unignores a slot for saving.
 
: <small>NOCOMBAT</small> [[API C_EquipmentSet.UseEquipmentSet|C_EquipmentSet.UseEquipmentSet]](<span style="font-size:smaller; color:#ecbc2a">equipmentSetID</span>) : <span style="font-size:smaller; color:#4ec9b0">setWasEquipped</span> - Equips items from a specified equipment set.
 
: [[API GetInventoryItemEquippedUnusable|GetInventoryItemEquippedUnusable]](<span style="font-size:smaller; color:#ecbc2a">unit, slot</span>)
 
: [[API GetInventoryItemsForSlot|GetInventoryItemsForSlot]](<span style="font-size:smaller; color:#ecbc2a">slot, returnTable [, transmogrify]</span>)
 
: [[API IsInventoryItemAnUpgrade|IsInventoryItemAnUpgrade]](<span style="font-size:smaller; color:#ecbc2a">unit, slot</span>)
 
: <small>UI</small> [[API EquipmentManager_UnpackLocation|EquipmentManager_UnpackLocation]]() - Unpacks a location integer to determine the actual inventory location.
 
   
 
=== Expansions ===
 
=== Expansions ===
Line 1,927: Line 1,925:
 
: [[API GetServerExpansionLevel|GetServerExpansionLevel]]() : <span style="font-size:smaller; color:#4ec9b0">serverExpansionLevel</span> - Returns the expansion level currently active on the server.
 
: [[API GetServerExpansionLevel|GetServerExpansionLevel]]() : <span style="font-size:smaller; color:#4ec9b0">serverExpansionLevel</span> - Returns the expansion level currently active on the server.
 
: [[API IsExpansionTrial|IsExpansionTrial]]() : <span style="font-size:smaller; color:#4ec9b0">isExpansionTrialAccount</span>
 
: [[API IsExpansionTrial|IsExpansionTrial]]() : <span style="font-size:smaller; color:#4ec9b0">isExpansionTrialAccount</span>
  +
: [[API C_LevelSquish.ConvertFollowerLevel|C_LevelSquish.ConvertFollowerLevel]](<span style="font-size:smaller; color:#ecbc2a">level, maxFollowerLevel</span>) : <span style="font-size:smaller; color:#4ec9b0">squishedLevel</span>
  +
: [[API C_LevelSquish.ConvertPlayerLevel|C_LevelSquish.ConvertPlayerLevel]](<span style="font-size:smaller; color:#ecbc2a">level</span>) : <span style="font-size:smaller; color:#4ec9b0">squishedLevel</span>
   
=== FrameXML ===
+
==== Chromie Time ====
  +
[[Timewalking Campaigns]] scale older expansion zones up to level 50.
: <small>UI</small> [[API EasyMenu|EasyMenu]](<span style="font-size:smaller; color:#ecbc2a">menuList, menuFrame, anchor, x, y, displayMode, autoHideDelay</span>)
 
  +
: [[API C_ChromieTime.CloseUI|C_ChromieTime.CloseUI]]()
These functions toggle the Interface Panels, but if they use {{api|ShowUIPanel}}() they can not be called in combat.
 
  +
: [[API C_ChromieTime.GetChromieTimeExpansionOption|C_ChromieTime.GetChromieTimeExpansionOption]](<span style="font-size:smaller; color:#ecbc2a">expansionRecID</span>) : <span style="font-size:smaller; color:#4ec9b0">info</span>
: <small>UI</small> [https://www.townlong-yak.com/framexml/go/PVEFrame_ToggleFrame PVEFrame_ToggleFrame]() - Toggles the Group Finder.
 
  +
: [[API C_ChromieTime.GetChromieTimeExpansionOptions|C_ChromieTime.GetChromieTimeExpansionOptions]]() : <span style="font-size:smaller; color:#4ec9b0">expansionOptions</span>
: <small>UI</small> [https://www.townlong-yak.com/framexml/go/ToggleAchievementFrame ToggleAchievementFrame]() - Shows the Achievements frame.
 
  +
: [[API C_ChromieTime.SelectChromieTimeOption|C_ChromieTime.SelectChromieTimeOption]](<span style="font-size:smaller; color:#ecbc2a">chromieTimeExpansionInfoId</span>)
: <small>UI</small> [[API ToggleBackpack|ToggleBackpack]]() - Toggles your backpack open/closed.
 
: <small>UI</small> [[API ToggleBag|ToggleBag]](<span style="font-size:smaller; color:#ecbc2a">bagID</span>) - Opens or closes the specified bag.
+
: [[API C_PlayerInfo.CanPlayerEnterChromieTime|C_PlayerInfo.CanPlayerEnterChromieTime]]() : <span style="font-size:smaller; color:#4ec9b0">canEnter</span>
: <small>UI</small> [[API ToggleCharacter|ToggleCharacter]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Toggles the character pane to the specified frame.
+
: [[API C_PlayerInfo.IsPlayerInChromieTime|C_PlayerInfo.IsPlayerInChromieTime]]() : <span style="font-size:smaller; color:#4ec9b0">inChromieTime</span>
: <small>UI</small> [https://www.townlong-yak.com/framexml/go/ToggleCollectionsJournal ToggleCollectionsJournal](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Toggles the Collections window.
+
: [[API UnitChromieTimeID|UnitChromieTimeID]](<span style="font-size:smaller; color:#ecbc2a">unit</span>) : <span style="font-size:smaller; color:#4ec9b0">ID</span>
: <small>UI</small> [[API ToggleDropDownMenu|ToggleDropDownMenu]](<span style="font-size:smaller; color:#ecbc2a">level, value, dropDownFrame, anchorName, xOffset, yOffset</span>)
 
: <small>UI</small> [https://www.townlong-yak.com/framexml/go/ToggleEncounterJournal ToggleEncounterJournal]() - Toggles the Adventure Guide.
 
: <small>UI</small> [[API ToggleFriendsFrame|ToggleFriendsFrame]](<span style="font-size:smaller; color:#ecbc2a">[tabNumber]</span>) - Opens/closes the friends pane, optionally on a specific tab.
 
: <small>UI</small> [[API ToggleGameMenu|ToggleGameMenu]]() - Opens/closes the game menu.
 
: <small>UI</small> [https://www.townlong-yak.com/framexml/go/ToggleGuildFrame ToggleGuildFrame]() - Toggles the Guild & Communites frame.
 
: <small>UI</small> [https://www.townlong-yak.com/framexml/go/ToggleHelpFrame ToggleHelpFrame]() - Opens the Help Request frame.
 
: <small>UI</small> [[API ToggleMinimap|ToggleMinimap]]() - Turns the minimap display on/off.
 
: <small>UI</small> [[API TogglePVPUI|TogglePVPUI]]() - Opens/closes the PvP frame.
 
: <small>UI</small> [[API ToggleSpellBook|ToggleSpellBook]](<span style="font-size:smaller; color:#ecbc2a">bookType</span>) - Shows the spellbook. Can show your spells or your pet's.
 
: <small>UI</small> [[API ToggleTalentFrame|ToggleTalentFrame]]() - Opens the Talent frame.
 
   
 
=== Friends ===
 
=== Friends ===
Line 2,004: Line 1,994:
 
: [[API BNGetBlockedInfo|BNGetBlockedInfo]](<span style="font-size:smaller; color:#ecbc2a">index</span>)
 
: [[API BNGetBlockedInfo|BNGetBlockedInfo]](<span style="font-size:smaller; color:#ecbc2a">index</span>)
 
: [[API BNGetDisplayName|BNGetDisplayName]](<span style="font-size:smaller; color:#ecbc2a">bnetIdAccount</span>)
 
: [[API BNGetDisplayName|BNGetDisplayName]](<span style="font-size:smaller; color:#ecbc2a">bnetIdAccount</span>)
: [[API BNGetFOFInfo|BNGetFOFInfo]](<span style="font-size:smaller; color:#ecbc2a">presenceID, mutual, non-mutual, index</span>) - Returns presenceID, givenName, surname, isFriend.
+
: [[API BNGetFOFInfo|BNGetFOFInfo]](<span style="font-size:smaller; color:#ecbc2a">mutual, nonMutual, index</span>) - Returns presenceID, givenName, surname, isFriend.
 
: [[API BNGetFriendIndex|BNGetFriendIndex]](<span style="font-size:smaller; color:#ecbc2a">presenceID</span>)
 
: [[API BNGetFriendIndex|BNGetFriendIndex]](<span style="font-size:smaller; color:#ecbc2a">presenceID</span>)
 
: [[API BNGetFriendInviteInfo|BNGetFriendInviteInfo]](<span style="font-size:smaller; color:#ecbc2a">menuValue</span>) - Returns presenceID, givenName, surname.
 
: [[API BNGetFriendInviteInfo|BNGetFriendInviteInfo]](<span style="font-size:smaller; color:#ecbc2a">menuValue</span>) - Returns presenceID, givenName, surname.
Line 2,066: Line 2,056:
 
: [[API C_PlayerMentorship.IsActivePlayerConsideredNewcomer|C_PlayerMentorship.IsActivePlayerConsideredNewcomer]]() : <span style="font-size:smaller; color:#4ec9b0">isConsideredNewcomer</span>
 
: [[API C_PlayerMentorship.IsActivePlayerConsideredNewcomer|C_PlayerMentorship.IsActivePlayerConsideredNewcomer]]() : <span style="font-size:smaller; color:#4ec9b0">isConsideredNewcomer</span>
 
: [[API C_PlayerMentorship.IsMentorRestricted|C_PlayerMentorship.IsMentorRestricted]]() : <span style="font-size:smaller; color:#4ec9b0">isRestricted</span>
 
: [[API C_PlayerMentorship.IsMentorRestricted|C_PlayerMentorship.IsMentorRestricted]]() : <span style="font-size:smaller; color:#4ec9b0">isRestricted</span>
 
=== Gamepad ===
 
The Gamepad API was added in [[Patch 9.0.1]], where previously [https://github.com/topher-au/WoWmapper WoWmapper] was needed.
 
: [[API C_GamePad.ApplyConfigs|C_GamePad.ApplyConfigs]]()
 
: [[API C_GamePad.AxisIndexToConfigName|C_GamePad.AxisIndexToConfigName]](<span style="font-size:smaller; color:#ecbc2a">axisIndex</span>) : <span style="font-size:smaller; color:#4ec9b0">configName</span>
 
: [[API C_GamePad.ButtonBindingToIndex|C_GamePad.ButtonBindingToIndex]](<span style="font-size:smaller; color:#ecbc2a">bindingName</span>) : <span style="font-size:smaller; color:#4ec9b0">buttonIndex</span>
 
: [[API C_GamePad.ButtonIndexToBinding|C_GamePad.ButtonIndexToBinding]](<span style="font-size:smaller; color:#ecbc2a">buttonIndex</span>) : <span style="font-size:smaller; color:#4ec9b0">bindingName</span>
 
: [[API C_GamePad.ButtonIndexToConfigName|C_GamePad.ButtonIndexToConfigName]](<span style="font-size:smaller; color:#ecbc2a">buttonIndex</span>) : <span style="font-size:smaller; color:#4ec9b0">configName</span>
 
: [[API C_GamePad.DeleteConfig|C_GamePad.DeleteConfig]](<span style="font-size:smaller; color:#ecbc2a">configID</span>)
 
: [[API C_GamePad.GetActiveDeviceID|C_GamePad.GetActiveDeviceID]]() : <span style="font-size:smaller; color:#4ec9b0">deviceID</span>
 
: [[API C_GamePad.GetAllConfigIDs|C_GamePad.GetAllConfigIDs]]() : <span style="font-size:smaller; color:#4ec9b0">configIDs</span>
 
: [[API C_GamePad.GetAllDeviceIDs|C_GamePad.GetAllDeviceIDs]]() : <span style="font-size:smaller; color:#4ec9b0">deviceIDs</span>
 
: [[API C_GamePad.GetCombinedDeviceID|C_GamePad.GetCombinedDeviceID]]() : <span style="font-size:smaller; color:#4ec9b0">deviceID</span>
 
: [[API C_GamePad.GetConfig|C_GamePad.GetConfig]](<span style="font-size:smaller; color:#ecbc2a">configID</span>) : <span style="font-size:smaller; color:#4ec9b0">config</span>
 
: [[API C_GamePad.GetDeviceMappedState|C_GamePad.GetDeviceMappedState]](<span style="font-size:smaller; color:#ecbc2a">[deviceID]</span>) : <span style="font-size:smaller; color:#4ec9b0">state</span>
 
: [[API C_GamePad.GetDeviceRawState|C_GamePad.GetDeviceRawState]](<span style="font-size:smaller; color:#ecbc2a">deviceID</span>) : <span style="font-size:smaller; color:#4ec9b0">rawState</span>
 
: [[API C_GamePad.IsEnabled|C_GamePad.IsEnabled]]() : <span style="font-size:smaller; color:#4ec9b0">enabled</span>
 
: [[API C_GamePad.SetConfig|C_GamePad.SetConfig]](<span style="font-size:smaller; color:#ecbc2a">config</span>)
 
: [[API C_GamePad.StickIndexToConfigName|C_GamePad.StickIndexToConfigName]](<span style="font-size:smaller; color:#ecbc2a">stickIndex</span>) : <span style="font-size:smaller; color:#4ec9b0">configName</span>
 
: [[API CanAutoSetGamePadCursorControl|CanAutoSetGamePadCursorControl]]()
 
: [[API CanGamePadControlCursor|CanGamePadControlCursor]]()
 
: [[API IsBindingForGamePad|IsBindingForGamePad]](<span style="font-size:smaller; color:#ecbc2a">KEY</span>)
 
: [[API IsGamePadCursorControlEnabled|IsGamePadCursorControlEnabled]]()
 
: [[API IsGamePadFreelookEnabled|IsGamePadFreelookEnabled]]()
 
: [[API SetGamePadCursorControl|SetGamePadCursorControl]]()
 
: [[API SetGamePadFreeLook|SetGamePadFreeLook]]()
 
   
 
=== Groups ===
 
=== Groups ===
Line 2,129: Line 2,093:
 
: [[API UnitInAnyGroup|UnitInAnyGroup]]()
 
: [[API UnitInAnyGroup|UnitInAnyGroup]]()
 
: [[API UnitInParty|UnitInParty]](<span style="font-size:smaller; color:#ecbc2a">unit</span>) - Returns true if the unit is a member of your party.
 
: [[API UnitInParty|UnitInParty]](<span style="font-size:smaller; color:#ecbc2a">unit</span>) - Returns true if the unit is a member of your party.
: [[API UnitIsGroupLeader|UnitIsGroupLeader]](<span style="font-size:smaller; color:#ecbc2a">unit or player name</span>) - Returns true if the unit is the leader of your party.
+
: [[API UnitIsGroupLeader|UnitIsGroupLeader]](<span style="font-size:smaller; color:#ecbc2a">unit [, partyCategory]</span>) - Returns whether the unit is the leader of a party or raid.
   
 
==== Raid Groups ====
 
==== Raid Groups ====
Line 2,142: Line 2,106:
 
: [[API SetAllowLowLevelRaid|SetAllowLowLevelRaid]](<span style="font-size:smaller; color:#ecbc2a">allowed</span>) - Controls whether the current character can join low-level raids.
 
: [[API SetAllowLowLevelRaid|SetAllowLowLevelRaid]](<span style="font-size:smaller; color:#ecbc2a">allowed</span>) - Controls whether the current character can join low-level raids.
 
: [[API SetEveryoneIsAssistant|SetEveryoneIsAssistant]]()
 
: [[API SetEveryoneIsAssistant|SetEveryoneIsAssistant]]()
: <small>SECURE</small> [[API SetPartyAssignment|SetPartyAssignment]](<span style="font-size:smaller; color:#ecbc2a">assignment, player</span>)
+
: <small>PROTECTED</small> [[API SetPartyAssignment|SetPartyAssignment]](<span style="font-size:smaller; color:#ecbc2a">assignment, player</span>)
 
: [[API SetRaidSubgroup|SetRaidSubgroup]](<span style="font-size:smaller; color:#ecbc2a">index, subgroup</span>) - Move a raid member from his current subgroup into a different (non-full) subgroup.
 
: [[API SetRaidSubgroup|SetRaidSubgroup]](<span style="font-size:smaller; color:#ecbc2a">index, subgroup</span>) - Move a raid member from his current subgroup into a different (non-full) subgroup.
: <small>SECURE</small> [[API SwapRaidSubgroup|SwapRaidSubgroup]](<span style="font-size:smaller; color:#ecbc2a">index1, index2</span>) - Swaps raid members into different groups.
+
: <small>PROTECTED</small> [[API SwapRaidSubgroup|SwapRaidSubgroup]](<span style="font-size:smaller; color:#ecbc2a">index1, index2</span>) - Swaps raid members into different groups.
 
: [[API UnitInRaid|UnitInRaid]](<span style="font-size:smaller; color:#ecbc2a">unit</span>) - Returns 1 if unit is in your raid, nil if not.
 
: [[API UnitInRaid|UnitInRaid]](<span style="font-size:smaller; color:#ecbc2a">unit</span>) - Returns 1 if unit is in your raid, nil if not.
 
: [[API UnitInSubgroup|UnitInSubgroup]]()
 
: [[API UnitInSubgroup|UnitInSubgroup]]()
Line 2,152: Line 2,116:
 
: [[API GetRaidTargetIndex|GetRaidTargetIndex]](<span style="font-size:smaller; color:#ecbc2a">unit</span>) - Get the raid target index assigned to a unit.
 
: [[API GetRaidTargetIndex|GetRaidTargetIndex]](<span style="font-size:smaller; color:#ecbc2a">unit</span>) - Get the raid target index assigned to a unit.
 
: [[API IsRaidMarkerActive|IsRaidMarkerActive]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Returns whether or not the raid marker specified by index is active.
 
: [[API IsRaidMarkerActive|IsRaidMarkerActive]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Returns whether or not the raid marker specified by index is active.
: <small>SECURE</small> [[API PlaceRaidMarker|PlaceRaidMarker]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Brings up a targeting circle to place a raid marker in the world.
+
: <small>PROTECTED</small> [[API PlaceRaidMarker|PlaceRaidMarker]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Brings up a targeting circle to place a raid marker in the world.
 
: [[API SetRaidTarget|SetRaidTarget]](<span style="font-size:smaller; color:#ecbc2a">unit, index</span>) - Sets a raid icon on a unit.
 
: [[API SetRaidTarget|SetRaidTarget]](<span style="font-size:smaller; color:#ecbc2a">unit, index</span>) - Sets a raid icon on a unit.
 
: [[API SetRaidTargetProtected|SetRaidTargetProtected]](<span style="font-size:smaller; color:#ecbc2a">unit, index</span>)
 
: [[API SetRaidTargetProtected|SetRaidTargetProtected]](<span style="font-size:smaller; color:#ecbc2a">unit, index</span>)
Line 2,212: Line 2,176:
 
: [[API C_LFGList.ApplyToGroup|C_LFGList.ApplyToGroup]](<span style="font-size:smaller; color:#ecbc2a">resultID, comment, tank, healer, dps</span>)
 
: [[API C_LFGList.ApplyToGroup|C_LFGList.ApplyToGroup]](<span style="font-size:smaller; color:#ecbc2a">resultID, comment, tank, healer, dps</span>)
 
: [[API C_LFGList.CanActiveEntryUseAutoAccept|C_LFGList.CanActiveEntryUseAutoAccept]]() : <span style="font-size:smaller; color:#4ec9b0">canUseAutoAccept</span>
 
: [[API C_LFGList.CanActiveEntryUseAutoAccept|C_LFGList.CanActiveEntryUseAutoAccept]]() : <span style="font-size:smaller; color:#4ec9b0">canUseAutoAccept</span>
: [[API C_LFGList.CanCreateQuestGroup|C_LFGList.CanCreateQuestGroup]](<span style="font-size:smaller; color:#ecbc2a">questID</span>) : <span style="font-size:smaller; color:#4ec9b0">canCreate</span>
 
 
: [[API C_LFGList.CancelApplication|C_LFGList.CancelApplication]](<span style="font-size:smaller; color:#ecbc2a">resultID</span>)
 
: [[API C_LFGList.CancelApplication|C_LFGList.CancelApplication]](<span style="font-size:smaller; color:#ecbc2a">resultID</span>)
  +
: [[API C_LFGList.CanCreateQuestGroup|C_LFGList.CanCreateQuestGroup]](<span style="font-size:smaller; color:#ecbc2a">questID</span>) : <span style="font-size:smaller; color:#4ec9b0">canCreate</span>
 
: [[API C_LFGList.ClearApplicationTextFields|C_LFGList.ClearApplicationTextFields]]()
 
: [[API C_LFGList.ClearApplicationTextFields|C_LFGList.ClearApplicationTextFields]]()
 
: [[API C_LFGList.ClearCreationTextFields|C_LFGList.ClearCreationTextFields]]()
 
: [[API C_LFGList.ClearCreationTextFields|C_LFGList.ClearCreationTextFields]]()
Line 2,219: Line 2,183:
 
: [[API C_LFGList.ClearSearchTextFields|C_LFGList.ClearSearchTextFields]]()
 
: [[API C_LFGList.ClearSearchTextFields|C_LFGList.ClearSearchTextFields]]()
 
: [[API C_LFGList.CopyActiveEntryInfoToCreationFields|C_LFGList.CopyActiveEntryInfoToCreationFields]]()
 
: [[API C_LFGList.CopyActiveEntryInfoToCreationFields|C_LFGList.CopyActiveEntryInfoToCreationFields]]()
: [[API C_LFGList.CreateListing|C_LFGList.CreateListing]](<span style="font-size:smaller; color:#ecbc2a">activityID, itemLevel, honorLevel, autoAccept, privateGroup, questID</span>)
+
: <small>HW</small> [[API C_LFGList.CreateListing|C_LFGList.CreateListing]](<span style="font-size:smaller; color:#ecbc2a">activityID, itemLevel, honorLevel [, autoAccept, privateGroup, questID]</span>) - Creates a group finder listing.
 
: [[API C_LFGList.DeclineApplicant|C_LFGList.DeclineApplicant]](<span style="font-size:smaller; color:#ecbc2a">applicantID</span>)
 
: [[API C_LFGList.DeclineApplicant|C_LFGList.DeclineApplicant]](<span style="font-size:smaller; color:#ecbc2a">applicantID</span>)
 
: [[API C_LFGList.DeclineInvite|C_LFGList.DeclineInvite]](<span style="font-size:smaller; color:#ecbc2a">searchResultID</span>)
 
: [[API C_LFGList.DeclineInvite|C_LFGList.DeclineInvite]](<span style="font-size:smaller; color:#ecbc2a">searchResultID</span>)
Line 2,225: Line 2,189:
 
: [[API C_LFGList.GetActivityGroupInfo|C_LFGList.GetActivityGroupInfo]](<span style="font-size:smaller; color:#ecbc2a">groupID</span>) - Returns information about an activity group.
 
: [[API C_LFGList.GetActivityGroupInfo|C_LFGList.GetActivityGroupInfo]](<span style="font-size:smaller; color:#ecbc2a">groupID</span>) - Returns information about an activity group.
 
: [[API C_LFGList.GetActivityIDForQuestID|C_LFGList.GetActivityIDForQuestID]](<span style="font-size:smaller; color:#ecbc2a">questID</span>)
 
: [[API C_LFGList.GetActivityIDForQuestID|C_LFGList.GetActivityIDForQuestID]](<span style="font-size:smaller; color:#ecbc2a">questID</span>)
: [[API C_LFGList.GetActivityInfoExpensive|C_LFGList.GetActivityInfoExpensive]](<span style="font-size:smaller; color:#ecbc2a">activityID</span>) - Checks if you are in the zone associated with an activity.
 
 
: [[API C_LFGList.GetActivityInfo|C_LFGList.GetActivityInfo]](<span style="font-size:smaller; color:#ecbc2a">activityID</span>) - Returns information about an activity for premade groups.
 
: [[API C_LFGList.GetActivityInfo|C_LFGList.GetActivityInfo]](<span style="font-size:smaller; color:#ecbc2a">activityID</span>) - Returns information about an activity for premade groups.
  +
: [[API C_LFGList.GetActivityInfoExpensive|C_LFGList.GetActivityInfoExpensive]](<span style="font-size:smaller; color:#ecbc2a">activityID</span>) - Checks if you are in the zone associated with an activity.
 
: [[API C_LFGList.GetApplicantInfo|C_LFGList.GetApplicantInfo]](<span style="font-size:smaller; color:#ecbc2a">applicantID</span>) : <span style="font-size:smaller; color:#4ec9b0">applicantData</span> - Returns status informations and custom message of an applicant.
 
: [[API C_LFGList.GetApplicantInfo|C_LFGList.GetApplicantInfo]](<span style="font-size:smaller; color:#ecbc2a">applicantID</span>) : <span style="font-size:smaller; color:#4ec9b0">applicantData</span> - Returns status informations and custom message of an applicant.
 
: [[API C_LFGList.GetApplicantMemberInfo|C_LFGList.GetApplicantMemberInfo]](<span style="font-size:smaller; color:#ecbc2a">applicantID</span>) - Returns name, class, level and more about an applicant group member.
 
: [[API C_LFGList.GetApplicantMemberInfo|C_LFGList.GetApplicantMemberInfo]](<span style="font-size:smaller; color:#ecbc2a">applicantID</span>) - Returns name, class, level and more about an applicant group member.
Line 2,233: Line 2,197:
 
: [[API C_LFGList.GetApplicationInfo|C_LFGList.GetApplicationInfo]](<span style="font-size:smaller; color:#ecbc2a">searchResultID</span>)
 
: [[API C_LFGList.GetApplicationInfo|C_LFGList.GetApplicationInfo]](<span style="font-size:smaller; color:#ecbc2a">searchResultID</span>)
 
: [[API C_LFGList.GetApplications|C_LFGList.GetApplications]]()
 
: [[API C_LFGList.GetApplications|C_LFGList.GetApplications]]()
: [[API C_LFGList.GetAvailableActivities|C_LFGList.GetAvailableActivities]](<span style="font-size:smaller; color:#ecbc2a">[categoryID, groupID , filter]</span>) - Returns a list of available activityIDs.
+
: [[API C_LFGList.GetAvailableActivities|C_LFGList.GetAvailableActivities]](<span style="font-size:smaller; color:#ecbc2a">[categoryID, groupID, filter]</span>) - Returns a list of available activityIDs.
 
: [[API C_LFGList.GetAvailableActivityGroups|C_LFGList.GetAvailableActivityGroups]](<span style="font-size:smaller; color:#ecbc2a">categoryID [, filter]</span>) - Returns a list of available groupIDs.
 
: [[API C_LFGList.GetAvailableActivityGroups|C_LFGList.GetAvailableActivityGroups]](<span style="font-size:smaller; color:#ecbc2a">categoryID [, filter]</span>) - Returns a list of available groupIDs.
 
: [[API C_LFGList.GetAvailableCategories|C_LFGList.GetAvailableCategories]](<span style="font-size:smaller; color:#ecbc2a">[filter]</span>) - Returns a list of available categoryIDs.
 
: [[API C_LFGList.GetAvailableCategories|C_LFGList.GetAvailableCategories]](<span style="font-size:smaller; color:#ecbc2a">[filter]</span>) - Returns a list of available categoryIDs.
Line 2,287: Line 2,251:
 
: [[API GetLFGBootProposal|GetLFGBootProposal]]() - Returns info about a LFG Kick vote in progress.
 
: [[API GetLFGBootProposal|GetLFGBootProposal]]() - Returns info about a LFG Kick vote in progress.
 
: [[API GetLFGCategoryForID|GetLFGCategoryForID]](<span style="font-size:smaller; color:#ecbc2a">partySlot</span>)
 
: [[API GetLFGCategoryForID|GetLFGCategoryForID]](<span style="font-size:smaller; color:#ecbc2a">partySlot</span>)
: [[API GetLFGCompletionRewardItemLink|GetLFGCompletionRewardItemLink]](<span style="font-size:smaller; color:#ecbc2a">rewardIndex</span>)
 
: [[API GetLFGCompletionRewardItem|GetLFGCompletionRewardItem]](<span style="font-size:smaller; color:#ecbc2a">rewardIndex</span>)
 
 
: [[API GetLFGCompletionReward|GetLFGCompletionReward]]()
 
: [[API GetLFGCompletionReward|GetLFGCompletionReward]]()
  +
: [[API GetLFGCompletionRewardItem|GetLFGCompletionRewardItem]](<span style="font-size:smaller; color:#ecbc2a">rewardIndex</span>)
  +
: [[API GetLFGCompletionRewardItemLink|GetLFGCompletionRewardItemLink]](<span style="font-size:smaller; color:#ecbc2a">rewardIndex</span>)
 
: [[API GetLFGDeserterExpiration|GetLFGDeserterExpiration]]() - Returns the time at which you may once again use the dungeon finder after prematurely leaving a group.
 
: [[API GetLFGDeserterExpiration|GetLFGDeserterExpiration]]() - Returns the time at which you may once again use the dungeon finder after prematurely leaving a group.
 
: [[API GetLFGDungeonEncounterInfo|GetLFGDungeonEncounterInfo]](<span style="font-size:smaller; color:#ecbc2a">dungeonID, encounterIndex</span>)
 
: [[API GetLFGDungeonEncounterInfo|GetLFGDungeonEncounterInfo]](<span style="font-size:smaller; color:#ecbc2a">dungeonID, encounterIndex</span>)
Line 2,304: Line 2,268:
 
: [[API GetLFGInviteRoleAvailability|GetLFGInviteRoleAvailability]](<span style="font-size:smaller; color:#ecbc2a">roleID</span>)
 
: [[API GetLFGInviteRoleAvailability|GetLFGInviteRoleAvailability]](<span style="font-size:smaller; color:#ecbc2a">roleID</span>)
 
: [[API GetLFGInviteRoleRestrictions|GetLFGInviteRoleRestrictions]](<span style="font-size:smaller; color:#ecbc2a">roleID</span>)
 
: [[API GetLFGInviteRoleRestrictions|GetLFGInviteRoleRestrictions]](<span style="font-size:smaller; color:#ecbc2a">roleID</span>)
  +
: [[API GetLFGProposal|GetLFGProposal]]()
 
: [[API GetLFGProposalEncounter|GetLFGProposalEncounter]](<span style="font-size:smaller; color:#ecbc2a">encounterIndex</span>)
 
: [[API GetLFGProposalEncounter|GetLFGProposalEncounter]](<span style="font-size:smaller; color:#ecbc2a">encounterIndex</span>)
 
: [[API GetLFGProposalMember|GetLFGProposalMember]](<span style="font-size:smaller; color:#ecbc2a">memberIndex</span>) - Returns info about the players in the LFG proposal.
 
: [[API GetLFGProposalMember|GetLFGProposalMember]](<span style="font-size:smaller; color:#ecbc2a">memberIndex</span>) - Returns info about the players in the LFG proposal.
: [[API GetLFGProposal|GetLFGProposal]]()
 
: [[API GetLFGQueueStats|GetLFGQueueStats]](<span style="font-size:smaller; color:#ecbc2a">category [, lfgID]</span>) - Returns current state and wait times for being in queue.
 
 
: [[API GetLFGQueuedList|GetLFGQueuedList]](<span style="font-size:smaller; color:#ecbc2a">category [, table]</span>)
 
: [[API GetLFGQueuedList|GetLFGQueuedList]](<span style="font-size:smaller; color:#ecbc2a">category [, table]</span>)
  +
: [[API GetLFGQueueStats|GetLFGQueueStats]](<span style="font-size:smaller; color:#ecbc2a">category [, lfgID]</span>) - Returns current state and wait times for being in queue.
 
: [[API GetLFGRandomCooldownExpiration|GetLFGRandomCooldownExpiration]]() - Returns the time at which you may once again queue for a random dungeon.
 
: [[API GetLFGRandomCooldownExpiration|GetLFGRandomCooldownExpiration]]() - Returns the time at which you may once again queue for a random dungeon.
 
: [[API GetLFGRandomDungeonInfo|GetLFGRandomDungeonInfo]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Returns information about a random dungeon queue.
 
: [[API GetLFGRandomDungeonInfo|GetLFGRandomDungeonInfo]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Returns information about a random dungeon queue.
: [[API GetLFGReadyCheckUpdateBattlegroundInfo|GetLFGReadyCheckUpdateBattlegroundInfo]]()
 
 
: [[API GetLFGReadyCheckUpdate|GetLFGReadyCheckUpdate]]()
 
: [[API GetLFGReadyCheckUpdate|GetLFGReadyCheckUpdate]]()
  +
: [[API GetLFGReadyCheckUpdateBattlegroundInfo|GetLFGReadyCheckUpdateBattlegroundInfo]]()
  +
: [[API GetLFGRoles|GetLFGRoles]]() - Returns the roles you signed up as, not the role you were assigned.
 
: [[API GetLFGRoleShortageRewards|GetLFGRoleShortageRewards]](<span style="font-size:smaller; color:#ecbc2a">dungeonID, shortageIndex</span>) - Returns information about the LFG Call to Arms rewards.
 
: [[API GetLFGRoleShortageRewards|GetLFGRoleShortageRewards]](<span style="font-size:smaller; color:#ecbc2a">dungeonID, shortageIndex</span>) - Returns information about the LFG Call to Arms rewards.
  +
: [[API GetLFGRoleUpdate|GetLFGRoleUpdate]]()
 
: [[API GetLFGRoleUpdateBattlegroundInfo|GetLFGRoleUpdateBattlegroundInfo]]()
 
: [[API GetLFGRoleUpdateBattlegroundInfo|GetLFGRoleUpdateBattlegroundInfo]]()
 
: [[API GetLFGRoleUpdateMember|GetLFGRoleUpdateMember]](<span style="font-size:smaller; color:#ecbc2a">memberIndex</span>)
 
: [[API GetLFGRoleUpdateMember|GetLFGRoleUpdateMember]](<span style="font-size:smaller; color:#ecbc2a">memberIndex</span>)
 
: [[API GetLFGRoleUpdateSlot|GetLFGRoleUpdateSlot]](<span style="font-size:smaller; color:#ecbc2a">slotIndex</span>)
 
: [[API GetLFGRoleUpdateSlot|GetLFGRoleUpdateSlot]](<span style="font-size:smaller; color:#ecbc2a">slotIndex</span>)
: [[API GetLFGRoleUpdate|GetLFGRoleUpdate]]()
 
: [[API GetLFGRoles|GetLFGRoles]]() - Returns the roles you signed up as, not the role you were assigned.
 
 
: [[API GetLFGSuspendedPlayers|GetLFGSuspendedPlayers]](<span style="font-size:smaller; color:#ecbc2a">category</span>)
 
: [[API GetLFGSuspendedPlayers|GetLFGSuspendedPlayers]](<span style="font-size:smaller; color:#ecbc2a">category</span>)
 
: [[API GetNumDungeonForRandomSlot|GetNumDungeonForRandomSlot]](<span style="font-size:smaller; color:#ecbc2a">randomID</span>)
 
: [[API GetNumDungeonForRandomSlot|GetNumDungeonForRandomSlot]](<span style="font-size:smaller; color:#ecbc2a">randomID</span>)
Line 2,335: Line 2,299:
 
: [[API JoinLFG|JoinLFG]](<span style="font-size:smaller; color:#ecbc2a">category</span>)
 
: [[API JoinLFG|JoinLFG]](<span style="font-size:smaller; color:#ecbc2a">category</span>)
 
: [[API JoinSingleLFG|JoinSingleLFG]](<span style="font-size:smaller; color:#ecbc2a">category, lfgID</span>)
 
: [[API JoinSingleLFG|JoinSingleLFG]](<span style="font-size:smaller; color:#ecbc2a">category, lfgID</span>)
: [[API LFGTeleport|LFGTeleport]](<span style="font-size:smaller; color:#ecbc2a">[toSafety]</span>) - Teleports the player to or from a dungeon.
 
 
: [[API LeaveLFG|LeaveLFG]](<span style="font-size:smaller; color:#ecbc2a">category</span>)
 
: [[API LeaveLFG|LeaveLFG]](<span style="font-size:smaller; color:#ecbc2a">category</span>)
 
: [[API LeaveSingleLFG|LeaveSingleLFG]](<span style="font-size:smaller; color:#ecbc2a">category, lfgID</span>)
 
: [[API LeaveSingleLFG|LeaveSingleLFG]](<span style="font-size:smaller; color:#ecbc2a">category, lfgID</span>)
  +
: [[API LFGTeleport|LFGTeleport]](<span style="font-size:smaller; color:#ecbc2a">[toSafety]</span>) - Teleports the player to or from a dungeon.
 
: [[API PartyLFGStartBackfill|PartyLFGStartBackfill]]()
 
: [[API PartyLFGStartBackfill|PartyLFGStartBackfill]]()
 
: [[API RefreshLFGList|RefreshLFGList]]()
 
: [[API RefreshLFGList|RefreshLFGList]]()
Line 2,415: Line 2,379:
 
: [[API CloseGuildRoster|CloseGuildRoster]]()
 
: [[API CloseGuildRoster|CloseGuildRoster]]()
 
: [[API CloseTabardCreation|CloseTabardCreation]]()
 
: [[API CloseTabardCreation|CloseTabardCreation]]()
: [[API CollapseGuildTradeSkillHeader|CollapseGuildTradeSkillHeader]](<span style="font-size:smaller; color:#ecbc2a">trade skill ID</span>)
+
: [[API CollapseGuildTradeSkillHeader|CollapseGuildTradeSkillHeader]](<span style="font-size:smaller; color:#ecbc2a">tradeSkillID</span>)
 
: [[API DeclineGuild|DeclineGuild]]() - The player declines the invitation to join a guild.
 
: [[API DeclineGuild|DeclineGuild]]() - The player declines the invitation to join a guild.
: [[API ExpandGuildTradeSkillHeader|ExpandGuildTradeSkillHeader]](<span style="font-size:smaller; color:#ecbc2a">trade skill ID</span>)
+
: [[API ExpandGuildTradeSkillHeader|ExpandGuildTradeSkillHeader]](<span style="font-size:smaller; color:#ecbc2a">tradeSkillID</span>)
 
: [[API GetAutoDeclineGuildInvites|GetAutoDeclineGuildInvites]]() - Returns if guild invites are blocked.
 
: [[API GetAutoDeclineGuildInvites|GetAutoDeclineGuildInvites]]() - Returns if guild invites are blocked.
 
: [[API GetDemotionRank|GetDemotionRank]](<span style="font-size:smaller; color:#ecbc2a">index</span>)
 
: [[API GetDemotionRank|GetDemotionRank]](<span style="font-size:smaller; color:#ecbc2a">index</span>)
Line 2,464: Line 2,428:
 
: [[API GuildControlGetRankName|GuildControlGetRankName]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Returns name of the rank at index. Any guild member can use this.
 
: [[API GuildControlGetRankName|GuildControlGetRankName]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Returns name of the rank at index. Any guild member can use this.
 
: [[API GuildControlSaveRank|GuildControlSaveRank]](<span style="font-size:smaller; color:#ecbc2a">name</span>) - Saves the permissions for rank "name". Only Guildmaster.
 
: [[API GuildControlSaveRank|GuildControlSaveRank]](<span style="font-size:smaller; color:#ecbc2a">name</span>) - Saves the permissions for rank "name". Only Guildmaster.
: <small>SECURE</small> [[API GuildControlSetRank|GuildControlSetRank]](<span style="font-size:smaller; color:#ecbc2a">rank</span>) - Sets the currently selected rank to view.
+
: <small>PROTECTED</small> [[API GuildControlSetRank|GuildControlSetRank]](<span style="font-size:smaller; color:#ecbc2a">rank</span>) - Sets the currently selected rank to view.
: <small>SECURE</small> [[API GuildControlSetRankFlag|GuildControlSetRankFlag]](<span style="font-size:smaller; color:#ecbc2a">index, enabled</span>) - Enable/disable permission for an action at index. Only Guildmaster.
+
: <small>PROTECTED</small> [[API GuildControlSetRankFlag|GuildControlSetRankFlag]](<span style="font-size:smaller; color:#ecbc2a">index, enabled</span>) - Enable/disable permission for an action at index. Only Guildmaster.
 
: [[API GuildControlShiftRankDown|GuildControlShiftRankDown]](<span style="font-size:smaller; color:#ecbc2a">rankOrder</span>)
 
: [[API GuildControlShiftRankDown|GuildControlShiftRankDown]](<span style="font-size:smaller; color:#ecbc2a">rankOrder</span>)
 
: [[API GuildControlShiftRankUp|GuildControlShiftRankUp]](<span style="font-size:smaller; color:#ecbc2a">rankOrder</span>)
 
: [[API GuildControlShiftRankUp|GuildControlShiftRankUp]](<span style="font-size:smaller; color:#ecbc2a">rankOrder</span>)
: <small>SECURE</small> [[API GuildDemote|GuildDemote]](<span style="font-size:smaller; color:#ecbc2a">name</span>) - Demotes a player "name".
+
: <small>PROTECTED</small> [[API GuildDemote|GuildDemote]](<span style="font-size:smaller; color:#ecbc2a">name</span>) - Demotes a player "name".
 
: [[API GuildDisband|GuildDisband]]() - Disbands at once your guild. You must be the guild's leader to do so. Be careful, no warning is given prior disbanding.
 
: [[API GuildDisband|GuildDisband]]() - Disbands at once your guild. You must be the guild's leader to do so. Be careful, no warning is given prior disbanding.
 
: [[API GuildInfo|GuildInfo]]() - Displays information about the guild you are a member of.
 
: [[API GuildInfo|GuildInfo]]() - Displays information about the guild you are a member of.
Line 2,476: Line 2,440:
 
: [[API GuildNewsSetSticky|GuildNewsSetSticky]](<span style="font-size:smaller; color:#ecbc2a">index, bool</span>)
 
: [[API GuildNewsSetSticky|GuildNewsSetSticky]](<span style="font-size:smaller; color:#ecbc2a">index, bool</span>)
 
: [[API GuildNewsSort|GuildNewsSort]](<span style="font-size:smaller; color:#ecbc2a">byDate</span>)
 
: [[API GuildNewsSort|GuildNewsSort]](<span style="font-size:smaller; color:#ecbc2a">byDate</span>)
: <small>SECURE</small> [[API GuildPromote|GuildPromote]](<span style="font-size:smaller; color:#ecbc2a">name</span>) - Promotes a player "name".
+
: <small>PROTECTED</small> [[API GuildPromote|GuildPromote]](<span style="font-size:smaller; color:#ecbc2a">name</span>) - Promotes a player "name".
 
: [[API GuildRosterSetOfficerNote|GuildRosterSetOfficerNote]](<span style="font-size:smaller; color:#ecbc2a">index, note</span>) - Sets the officer note at index to "note".
 
: [[API GuildRosterSetOfficerNote|GuildRosterSetOfficerNote]](<span style="font-size:smaller; color:#ecbc2a">index, note</span>) - Sets the officer note at index to "note".
 
: [[API GuildRosterSetPublicNote|GuildRosterSetPublicNote]](<span style="font-size:smaller; color:#ecbc2a">index, note</span>) - Sets the public note at index to "note".
 
: [[API GuildRosterSetPublicNote|GuildRosterSetPublicNote]](<span style="font-size:smaller; color:#ecbc2a">index, note</span>) - Sets the public note at index to "note".
 
: [[API GuildSetLeader|GuildSetLeader]](<span style="font-size:smaller; color:#ecbc2a">name</span>) - Transfers guild leadership to another character.
 
: [[API GuildSetLeader|GuildSetLeader]](<span style="font-size:smaller; color:#ecbc2a">name</span>) - Transfers guild leadership to another character.
 
: [[API GuildSetMOTD|GuildSetMOTD]](<span style="font-size:smaller; color:#ecbc2a">note</span>) - Set Guild Message of the Day to "note".
 
: [[API GuildSetMOTD|GuildSetMOTD]](<span style="font-size:smaller; color:#ecbc2a">note</span>) - Set Guild Message of the Day to "note".
: <small>SECURE</small> [[API GuildUninvite|GuildUninvite]](<span style="font-size:smaller; color:#ecbc2a">name</span>) - Removes the member "name".
+
: <small>PROTECTED</small> [[API GuildUninvite|GuildUninvite]](<span style="font-size:smaller; color:#ecbc2a">name</span>) - Removes the member "name".
 
: [[API IsGuildLeader|IsGuildLeader]](<span style="font-size:smaller; color:#ecbc2a">name</span>) - Determine if player "name" is a guild master.
 
: [[API IsGuildLeader|IsGuildLeader]](<span style="font-size:smaller; color:#ecbc2a">name</span>) - Determine if player "name" is a guild master.
 
: [[API IsGuildMember|IsGuildMember]](<span style="font-size:smaller; color:#ecbc2a">guid or unitToken</span>)
 
: [[API IsGuildMember|IsGuildMember]](<span style="font-size:smaller; color:#ecbc2a">guid or unitToken</span>)
: [[API IsGuildRankAssignmentAllowed|IsGuildRankAssignmentAllowed]](<span style="font-size:smaller; color:#ecbc2a">player index, rank index</span>)
+
: [[API IsGuildRankAssignmentAllowed|IsGuildRankAssignmentAllowed]](<span style="font-size:smaller; color:#ecbc2a">playerIndex, rankIndex</span>)
 
: [[API IsInAuthenticatedRank|IsInAuthenticatedRank]]()
 
: [[API IsInAuthenticatedRank|IsInAuthenticatedRank]]()
 
: [[API IsInGuild|IsInGuild]]() - Lets you know whether you are in a guild.
 
: [[API IsInGuild|IsInGuild]]() - Lets you know whether you are in a guild.
Line 2,497: Line 2,461:
 
: [[API SetAutoDeclineGuildInvites|SetAutoDeclineGuildInvites]](<span style="font-size:smaller; color:#ecbc2a">checked</span>) - Blocks guild invites automatically.
 
: [[API SetAutoDeclineGuildInvites|SetAutoDeclineGuildInvites]](<span style="font-size:smaller; color:#ecbc2a">checked</span>) - Blocks guild invites automatically.
 
: [[API SetGuildInfoText|SetGuildInfoText]]() - Sets the persistant Guild Information data. Limit is 500 letters (GuildInfoEditBox is limited to this number). Longer texts are possible, but will be reseted during the day.
 
: [[API SetGuildInfoText|SetGuildInfoText]]() - Sets the persistant Guild Information data. Limit is 500 letters (GuildInfoEditBox is limited to this number). Longer texts are possible, but will be reseted during the day.
: [[API SetGuildMemberRank|SetGuildMemberRank]](<span style="font-size:smaller; color:#ecbc2a">player index, rank index</span>)
+
: [[API SetGuildMemberRank|SetGuildMemberRank]](<span style="font-size:smaller; color:#ecbc2a">playerIndex, rankIndex</span>)
 
: [[API SetGuildNewsFilter|SetGuildNewsFilter]](<span style="font-size:smaller; color:#ecbc2a">index, bool</span>)
 
: [[API SetGuildNewsFilter|SetGuildNewsFilter]](<span style="font-size:smaller; color:#ecbc2a">index, bool</span>)
 
: [[API SetGuildRosterSelection|SetGuildRosterSelection]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Selects/deselects a guild member according current sorting order.
 
: [[API SetGuildRosterSelection|SetGuildRosterSelection]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Selects/deselects a guild member according current sorting order.
 
: [[API SetGuildRosterShowOffline|SetGuildRosterShowOffline]](<span style="font-size:smaller; color:#ecbc2a">enabled</span>) - Sets/Resets the show offline members flag.
 
: [[API SetGuildRosterShowOffline|SetGuildRosterShowOffline]](<span style="font-size:smaller; color:#ecbc2a">enabled</span>) - Sets/Resets the show offline members flag.
: [[API SetGuildTradeSkillCategoryFilter|SetGuildTradeSkillCategoryFilter]](<span style="font-size:smaller; color:#ecbc2a">trade skill ID</span>)
+
: [[API SetGuildTradeSkillCategoryFilter|SetGuildTradeSkillCategoryFilter]](<span style="font-size:smaller; color:#ecbc2a">tradeSkillID</span>)
: [[API SetGuildTradeSkillItemNameFilter|SetGuildTradeSkillItemNameFilter]](<span style="font-size:smaller; color:#ecbc2a">item name</span>)
+
: [[API SetGuildTradeSkillItemNameFilter|SetGuildTradeSkillItemNameFilter]](<span style="font-size:smaller; color:#ecbc2a">itemName</span>)
 
: [[API SortGuildRoster|SortGuildRoster]](<span style="font-size:smaller; color:#ecbc2a">sort</span>) - Sorts guildroster according "sort". Any unknown values sort on "name".
 
: [[API SortGuildRoster|SortGuildRoster]](<span style="font-size:smaller; color:#ecbc2a">sort</span>) - Sorts guildroster according "sort". Any unknown values sort on "name".
 
: [[API SortGuildTradeSkill|SortGuildTradeSkill]](<span style="font-size:smaller; color:#ecbc2a">type</span>)
 
: [[API SortGuildTradeSkill|SortGuildTradeSkill]](<span style="font-size:smaller; color:#ecbc2a">type</span>)
Line 2,531: Line 2,495:
 
: [[API SetGuildApplicantSelection|SetGuildApplicantSelection]]()
 
: [[API SetGuildApplicantSelection|SetGuildApplicantSelection]]()
 
: [[API SetGuildRecruitmentComment|SetGuildRecruitmentComment]](<span style="font-size:smaller; color:#ecbc2a">text</span>)
 
: [[API SetGuildRecruitmentComment|SetGuildRecruitmentComment]](<span style="font-size:smaller; color:#ecbc2a">text</span>)
: [[API SetGuildRecruitmentSettings|SetGuildRecruitmentSettings]](<span style="font-size:smaller; color:#ecbc2a">index, true/false</span>)
+
: [[API SetGuildRecruitmentSettings|SetGuildRecruitmentSettings]](<span style="font-size:smaller; color:#ecbc2a">index, bool</span>)
 
: [[API SetLookingForGuildComment|SetLookingForGuildComment]]()
 
: [[API SetLookingForGuildComment|SetLookingForGuildComment]]()
: [[API SetLookingForGuildSettings|SetLookingForGuildSettings]](<span style="font-size:smaller; color:#ecbc2a">index, true/false</span>)
+
: [[API SetLookingForGuildSettings|SetLookingForGuildSettings]](<span style="font-size:smaller; color:#ecbc2a">index, bool</span>)
 
: [[API SetRecruitingGuildSelection|SetRecruitingGuildSelection]]()
 
: [[API SetRecruitingGuildSelection|SetRecruitingGuildSelection]]()
   
=== Inspection ===
+
==== Petitions ====
  +
Petitions are signup documents for guilds and arena teams. Some functions below only apply to a particular petition type
: [[API CanInspect|CanInspect]](<span style="font-size:smaller; color:#ecbc2a">unit [, showError]</span>) - Returns whether you can inspect the specified unit.
 
  +
: [[API CanSignPetition|CanSignPetition]]() - Returns nil if the player cannot sign the current petition.
: [[API CheckInteractDistance|CheckInteractDistance]](<span style="font-size:smaller; color:#ecbc2a">unit, interaction</span>) - Returns whether you're in range to perform various interactions with the specified unit.
 
: [[API ClearInspectPlayer|ClearInspectPlayer]]() - Reset inspect data once finished with it.
+
: [[API ClosePetition|ClosePetition]]() - Closes the current petition.
  +
: [[API GetNumPetitionNames|GetNumPetitionNames]]() - Gets the number of signatures on the current petition.
: [[API GetInspectArenaData|GetInspectArenaData]](<span style="font-size:smaller; color:#ecbc2a">bracketIndex</span>)
 
  +
: [[API GetPetitionInfo|GetPetitionInfo]]() - Retrieves information about the current petition.
: [[API GetInspectGuildInfo|GetInspectGuildInfo]](<span style="font-size:smaller; color:#ecbc2a">unit</span>)
 
: [[API GetInspectHonorData|GetInspectHonorData]]() - Returns honor information about the inspected player.
+
: [[API GetPetitionNameInfo|GetPetitionNameInfo]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Retrieves information about a signature on the petition.
  +
: [[API OfferPetition|OfferPetition]]() - Offers a petition to your target, inviting them to join your would-be guild/arena team.
: [[API GetInspectRatedBGData|GetInspectRatedBGData]]()
 
: [[API GetInspectSpecialization|GetInspectSpecialization]](<span style="font-size:smaller; color:#ecbc2a">unit</span>) - Returns a number representing the current active specialization of a given unit.
+
: [[API RenamePetition|RenamePetition]](<span style="font-size:smaller; color:#ecbc2a">name</span>) - Renames the current petition.
  +
: [[API SignPetition|SignPetition]]() - Signs the current petition.
: [[API GetInspectTalent|GetInspectTalent]]()
 
  +
: [[API TurnInGuildCharter|TurnInGuildCharter]]() - Founds a guild.
: [[API NotifyInspect|NotifyInspect]](<span style="font-size:smaller; color:#ecbc2a">unit</span>) - Requests information about a unit's inventory and talents from the server.
 
: <small>UI</small> [[API InspectUnit|InspectUnit]](<span style="font-size:smaller; color:#ecbc2a">unit</span>) - Instructs FrameXML to inspect a particular unit (query server; show UI).
 
   
 
=== Instances ===
 
=== Instances ===
Line 2,581: Line 2,544:
 
==== Scenarios ====
 
==== Scenarios ====
 
[[Scenarios]] were added in [[Patch 5.0.4]]
 
[[Scenarios]] were added in [[Patch 5.0.4]]
: [[API C_Scenario.GetBonusStepRewardQuestID|C_Scenario.GetBonusStepRewardQuestID]](<span style="font-size:smaller; color:#ecbc2a">(stepIndex</span>)
+
: [[API C_Scenario.GetBonusStepRewardQuestID|C_Scenario.GetBonusStepRewardQuestID]](<span style="font-size:smaller; color:#ecbc2a">stepIndex</span>)
 
: [[API C_Scenario.GetBonusSteps|C_Scenario.GetBonusSteps]]()
 
: [[API C_Scenario.GetBonusSteps|C_Scenario.GetBonusSteps]]()
 
: [[API C_Scenario.GetCriteriaInfo|C_Scenario.GetCriteriaInfo]](<span style="font-size:smaller; color:#ecbc2a">criteriaIndex</span>)
 
: [[API C_Scenario.GetCriteriaInfo|C_Scenario.GetCriteriaInfo]](<span style="font-size:smaller; color:#ecbc2a">criteriaIndex</span>)
Line 2,641: Line 2,604:
 
: [[API C_ChallengeMode.SlotKeystone|C_ChallengeMode.SlotKeystone]]()
 
: [[API C_ChallengeMode.SlotKeystone|C_ChallengeMode.SlotKeystone]]()
 
: [[API C_ChallengeMode.StartChallengeMode|C_ChallengeMode.StartChallengeMode]]() : <span style="font-size:smaller; color:#4ec9b0">success</span>
 
: [[API C_ChallengeMode.StartChallengeMode|C_ChallengeMode.StartChallengeMode]]() : <span style="font-size:smaller; color:#4ec9b0">success</span>
  +
  +
==== Weekly Rewards ====
  +
: [[API C_WeeklyRewards.CanClaimRewards|C_WeeklyRewards.CanClaimRewards]]() : <span style="font-size:smaller; color:#4ec9b0">canClaimRewards</span>
  +
: [[API C_WeeklyRewards.ClaimReward|C_WeeklyRewards.ClaimReward]](<span style="font-size:smaller; color:#ecbc2a">id</span>)
  +
: [[API C_WeeklyRewards.CloseInteraction|C_WeeklyRewards.CloseInteraction]]()
  +
: [[API C_WeeklyRewards.GetActivities|C_WeeklyRewards.GetActivities]](<span style="font-size:smaller; color:#ecbc2a">[type]</span>) : <span style="font-size:smaller; color:#4ec9b0">activities</span>
  +
: [[API C_WeeklyRewards.GetConquestWeeklyProgress|C_WeeklyRewards.GetConquestWeeklyProgress]]() : <span style="font-size:smaller; color:#4ec9b0">weeklyProgress</span>
  +
: [[API C_WeeklyRewards.GetExampleRewardItemHyperlinks|C_WeeklyRewards.GetExampleRewardItemHyperlinks]](<span style="font-size:smaller; color:#ecbc2a">id</span>) : <span style="font-size:smaller; color:#4ec9b0">hyperlink, upgradeHyperlink</span>
  +
: [[API C_WeeklyRewards.GetItemHyperlink|C_WeeklyRewards.GetItemHyperlink]](<span style="font-size:smaller; color:#ecbc2a">itemDBID</span>) : <span style="font-size:smaller; color:#4ec9b0">hyperlink</span>
  +
: [[API C_WeeklyRewards.HasAvailableRewards|C_WeeklyRewards.HasAvailableRewards]]() : <span style="font-size:smaller; color:#4ec9b0">hasAvailableRewards</span>
  +
: [[API C_WeeklyRewards.HasGeneratedRewards|C_WeeklyRewards.HasGeneratedRewards]]() : <span style="font-size:smaller; color:#4ec9b0">hasGeneratedRewards</span>
   
 
=== Items ===
 
=== Items ===
Line 2,696: Line 2,670:
 
: [[API GetItemCooldown|GetItemCooldown]](<span style="font-size:smaller; color:#ecbc2a">itemId</span>) - Returns startTime, duration, enable.
 
: [[API GetItemCooldown|GetItemCooldown]](<span style="font-size:smaller; color:#ecbc2a">itemId</span>) - Returns startTime, duration, enable.
 
: [[API GetItemCount|GetItemCount]](<span style="font-size:smaller; color:#ecbc2a">item [, includeBank, includeCharges]</span>) - Returns number of such items in inventory, or charges instead if it has charges.
 
: [[API GetItemCount|GetItemCount]](<span style="font-size:smaller; color:#ecbc2a">item [, includeBank, includeCharges]</span>) - Returns number of such items in inventory, or charges instead if it has charges.
: [[API GetItemCreationContext|GetItemCreationContext]](<span style="font-size:smaller; color:#ecbc2a">|itemlink</span>)
+
: [[API GetItemCreationContext|GetItemCreationContext]](<span style="font-size:smaller; color:#ecbc2a">itemlink</span>)
 
: [[API GetItemFamily|GetItemFamily]](<span style="font-size:smaller; color:#ecbc2a">item</span>) - Returns the bag type that an item can go into, or for bags the type of items that it can contain.
 
: [[API GetItemFamily|GetItemFamily]](<span style="font-size:smaller; color:#ecbc2a">item</span>) - Returns the bag type that an item can go into, or for bags the type of items that it can contain.
: [[API GetItemGem|GetItemGem]](<span style="font-size:smaller; color:#ecbc2a">name|itemlink, index</span>)
+
: [[API GetItemGem|GetItemGem]](<span style="font-size:smaller; color:#ecbc2a">item, index</span>)
 
: [[API GetItemIcon|GetItemIcon]](<span style="font-size:smaller; color:#ecbc2a">itemId</span>) - Returns the icon for the item. Works for any valid item even if it's not in the cache.
 
: [[API GetItemIcon|GetItemIcon]](<span style="font-size:smaller; color:#ecbc2a">itemId</span>) - Returns the icon for the item. Works for any valid item even if it's not in the cache.
 
: [[API GetItemInfo|GetItemInfo]](<span style="font-size:smaller; color:#ecbc2a">item</span>) - Returns information about an item.
 
: [[API GetItemInfo|GetItemInfo]](<span style="font-size:smaller; color:#ecbc2a">item</span>) - Returns information about an item.
Line 2,727: Line 2,701:
 
: [[API IsHarmfulItem|IsHarmfulItem]](<span style="font-size:smaller; color:#ecbc2a">item</span>) - Returns whether an item can be used against hostile units
 
: [[API IsHarmfulItem|IsHarmfulItem]](<span style="font-size:smaller; color:#ecbc2a">item</span>) - Returns whether an item can be used against hostile units
 
: [[API IsHelpfulItem|IsHelpfulItem]](<span style="font-size:smaller; color:#ecbc2a">item</span>) - Returns whether an item can be used on the player or friendly units
 
: [[API IsHelpfulItem|IsHelpfulItem]](<span style="font-size:smaller; color:#ecbc2a">item</span>) - Returns whether an item can be used on the player or friendly units
: [[API IsItemInRange|IsItemInRange]](<span style="font-size:smaller; color:#ecbc2a">itemName or itemLink, unit</span>) - Nil for invalid target, false for out of range, true for in range.
+
: [[API IsItemInRange|IsItemInRange]](<span style="font-size:smaller; color:#ecbc2a">item [, unit]</span>) - Returns whether the item is in usable range of the unit.
 
: [[API IsUsableItem|IsUsableItem]](<span style="font-size:smaller; color:#ecbc2a">item</span>) - Returns usable, noMana.
 
: [[API IsUsableItem|IsUsableItem]](<span style="font-size:smaller; color:#ecbc2a">item</span>) - Returns usable, noMana.
 
: [[API ItemHasRange|ItemHasRange]](<span style="font-size:smaller; color:#ecbc2a">item</span>)
 
: [[API ItemHasRange|ItemHasRange]](<span style="font-size:smaller; color:#ecbc2a">item</span>)
 
: [[API TargetSpellReplacesBonusTree|TargetSpellReplacesBonusTree]]()
 
: [[API TargetSpellReplacesBonusTree|TargetSpellReplacesBonusTree]]()
 
: [[API UpgradeItem|UpgradeItem]]()
 
: [[API UpgradeItem|UpgradeItem]]()
: <small>SECURE</small> [[API UseItemByName|UseItemByName]](<span style="font-size:smaller; color:#ecbc2a">itemName, unit</span>) - Use an item on the unit specified.
+
: <small>PROTECTED</small> [[API UseItemByName|UseItemByName]](<span style="font-size:smaller; color:#ecbc2a">itemName, unit</span>) - Use an item on the unit specified.
 
Item Enchants
 
Item Enchants
 
: [[API BindEnchant|BindEnchant]]() - Confirm the binding of the item when enchanting it.
 
: [[API BindEnchant|BindEnchant]]() - Confirm the binding of the item when enchanting it.
 
: [[API ReplaceEnchant|ReplaceEnchant]]() - Confirm the replacement of an enchantment.
 
: [[API ReplaceEnchant|ReplaceEnchant]]() - Confirm the replacement of an enchantment.
 
: [[API ReplaceTradeEnchant|ReplaceTradeEnchant]]() - Confirm the replacement of an enchantment via trade.
 
: [[API ReplaceTradeEnchant|ReplaceTradeEnchant]]() - Confirm the replacement of an enchantment via trade.
 
=== Key Bindings ===
 
Relates to [[Key Bindings]].
 
: [[API C_KeyBindings.GetCustomBindingType|C_KeyBindings.GetCustomBindingType]](<span style="font-size:smaller; color:#ecbc2a">bindingIndex</span>) : <span style="font-size:smaller; color:#4ec9b0">customBindingType</span> - Returns the type of a custom binding.
 
: [[API GetBinding|GetBinding]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Get action and key bindings for that index.
 
: [[API GetBindingAction|GetBindingAction]](<span style="font-size:smaller; color:#ecbc2a">key [, checkOverride]</span>) - Get the action bound to that key.
 
: [[API GetBindingByKey|GetBindingByKey]](<span style="font-size:smaller; color:#ecbc2a">action [, mode]</span>)
 
: [[API GetBindingKey|GetBindingKey]](<span style="font-size:smaller; color:#ecbc2a">command</span>) - Get the key(s) bound to that action.
 
: [[API GetBindingText|GetBindingText]](<span style="font-size:smaller; color:#ecbc2a">[key, prefix, abbreviate]</span>) - Gets the string value for the key.
 
: [[API GetCurrentBindingSet|GetCurrentBindingSet]]() - Queries if current set of key bindings is character or account specific.
 
: [[API GetNumBindings|GetNumBindings]]() - Get total number key bindings and headers.
 
: [[API LoadBindings|LoadBindings]](<span style="font-size:smaller; color:#ecbc2a">which</span>) - Loads default, account or character specific key binding set into memory from disk.
 
: [[API RunBinding|RunBinding]](<span style="font-size:smaller; color:#ecbc2a">command [, up]</span>) - Executes the key binding named "command".
 
: [[API SaveBindings|SaveBindings]](<span style="font-size:smaller; color:#ecbc2a">which</span>) - Saves account or character specific key bindings from memory to disk.
 
: <small>NOCOMBAT</small> [[API SetBinding|SetBinding]](<span style="font-size:smaller; color:#ecbc2a">key [, command, mode]</span>) - Sets or unsets key bindings. (Can not be used in combat.)
 
: <small>NOCOMBAT</small> [[API SetBindingSpell|SetBindingSpell]](<span style="font-size:smaller; color:#ecbc2a">key, Spell Name</span>) - Set a key binding directly to a spell, uses the same spell name syntax as /cast.
 
: <small>NOCOMBAT</small> [[API SetBindingClick|SetBindingClick]](<span style="font-size:smaller; color:#ecbc2a">key, ButtonName [, mouseButton]</span>) - Set a key binding directly to a Button object. The click sends a mouse down when the key is pressed, and a mouse up when it is released.
 
: <small>NOCOMBAT</small> [[API SetBindingItem|SetBindingItem]](<span style="font-size:smaller; color:#ecbc2a">key, itemname</span>)
 
: <small>NOCOMBAT</small> [[API SetBindingMacro|SetBindingMacro]](<span style="font-size:smaller; color:#ecbc2a">key, macroname or macroId</span>)
 
: <small>NOCOMBAT</small> [[API SetOverrideBinding|SetOverrideBinding]](<span style="font-size:smaller; color:#ecbc2a">owner, isPriority, key [, command]</span>) - Set (or clear) an override key binding.
 
: <small>NOCOMBAT</small> [[API SetOverrideBindingSpell|SetOverrideBindingSpell]](<span style="font-size:smaller; color:#ecbc2a">owner, isPriority, key, spellname</span>)
 
: <small>NOCOMBAT</small> [[API SetOverrideBindingClick|SetOverrideBindingClick]](<span style="font-size:smaller; color:#ecbc2a">owner, isPriority, key, buttonName [, mouseClick]</span>) - Sets an override binding that acts like a mouse click on a button.
 
: <small>NOCOMBAT</small> [[API SetOverrideBindingItem|SetOverrideBindingItem]](<span style="font-size:smaller; color:#ecbc2a">owner, isPriority, key, itemname</span>)
 
: <small>NOCOMBAT</small> [[API SetOverrideBindingMacro|SetOverrideBindingMacro]](<span style="font-size:smaller; color:#ecbc2a">owner, isPriority, key, macroname or macroId</span>)
 
: <small>NOCOMBAT</small> [[API ClearOverrideBindings|ClearOverrideBindings]](<span style="font-size:smaller; color:#ecbc2a">owner</span>) - Reset all overrides belonging to an owner.
 
: [[API SetMouselookOverrideBinding|SetMouselookOverrideBinding]](<span style="font-size:smaller; color:#ecbc2a">key [, command]</span>)
 
 
==== Modifiers ====
 
: [[API GetModifiedClick|GetModifiedClick]](<span style="font-size:smaller; color:#ecbc2a">action</span>)
 
: [[API GetModifiedClickAction|GetModifiedClickAction]](<span style="font-size:smaller; color:#ecbc2a">index</span>)
 
: [[API GetMouseButtonClicked|GetMouseButtonClicked]]() - Returns the name of the button that triggered a mouse down/up/click/doubleclick event.
 
: [[API GetNumModifiedClickActions|GetNumModifiedClickActions]]()
 
: [[API IsAltKeyDown|IsAltKeyDown]]() - Returns true if the alt key is currently depressed.
 
: [[API IsControlKeyDown|IsControlKeyDown]]() - Returns true if the control key is currently depressed.
 
: [[API IsKeyDown|IsKeyDown]](<span style="font-size:smaller; color:#ecbc2a">keyOrMouseName [, excludeCurrentBindingState]</span>)
 
: [[API IsLeftAltKeyDown|IsLeftAltKeyDown]]() - Returns true if the left alt key is currently depressed.
 
: [[API IsLeftControlKeyDown|IsLeftControlKeyDown]]() - Returns true if the left control key is currently depressed.
 
: [[API IsLeftMetaKeyDown|IsLeftMetaKeyDown]]()
 
: [[API IsLeftShiftKeyDown|IsLeftShiftKeyDown]]() - Returns true if the left shift key is currently depressed.
 
: [[API IsMetaKeyDown|IsMetaKeyDown]]()
 
: [[API IsModifiedClick|IsModifiedClick]](<span style="font-size:smaller; color:#ecbc2a">action</span>) - Returns 1 if the keys for the specified action are down, nil otherwise.
 
: [[API IsModifierKeyDown|IsModifierKeyDown]]() - Equivalent to (IsShiftKeyDown() or IsControlKeyDown() or IsAltKeyDown()).
 
: [[API IsMouseButtonDown|IsMouseButtonDown]](<span style="font-size:smaller; color:#ecbc2a">[button or button]</span>)
 
: [[API IsRightAltKeyDown|IsRightAltKeyDown]]() - Returns true if the right alt key is currently depressed.
 
: [[API IsRightControlKeyDown|IsRightControlKeyDown]]() - Returns true if the right control key is currently depressed.
 
: [[API IsRightMetaKeyDown|IsRightMetaKeyDown]]()
 
: [[API IsRightShiftKeyDown|IsRightShiftKeyDown]]() - Returns true if the right shift key is currently depressed.
 
: [[API IsShiftKeyDown|IsShiftKeyDown]]() - Returns true if the shift key is currently depressed.
 
: [[API SetModifiedClick|SetModifiedClick]](<span style="font-size:smaller; color:#ecbc2a">action, binding</span>)
 
   
 
=== Looting ===
 
=== Looting ===
Line 2,829: Line 2,754:
 
: [[API SetLootPortrait|SetLootPortrait]]()
 
: [[API SetLootPortrait|SetLootPortrait]]()
 
: [[API SetLootSpecialization|SetLootSpecialization]](<span style="font-size:smaller; color:#ecbc2a">specilizationID</span>)
 
: [[API SetLootSpecialization|SetLootSpecialization]](<span style="font-size:smaller; color:#ecbc2a">specilizationID</span>)
: [[API SetLootThreshold|SetLootThreshold]](<span style="font-size:smaller; color:#ecbc2a">[[itemQuality]]</span>) - Set the threshold for group/master loot.
+
: [[API SetLootThreshold|SetLootThreshold]](<span style="font-size:smaller; color:#ecbc2a">itemQuality</span>) - Set the threshold for group/master loot.
 
: [[API SetOptOutOfLoot|SetOptOutOfLoot]](<span style="font-size:smaller; color:#ecbc2a">optOut</span>) - Enables or disables automatic passing on all loot.
 
: [[API SetOptOutOfLoot|SetOptOutOfLoot]](<span style="font-size:smaller; color:#ecbc2a">optOut</span>) - Enables or disables automatic passing on all loot.
 
==== Weekly Rewards ====
 
: [[API C_WeeklyRewards.CanClaimRewards|C_WeeklyRewards.CanClaimRewards]]() : <span style="font-size:smaller; color:#4ec9b0">canClaimRewards</span>
 
: [[API C_WeeklyRewards.ClaimReward|C_WeeklyRewards.ClaimReward]](<span style="font-size:smaller; color:#ecbc2a">id</span>)
 
: [[API C_WeeklyRewards.CloseInteraction|C_WeeklyRewards.CloseInteraction]]()
 
: [[API C_WeeklyRewards.GetActivities|C_WeeklyRewards.GetActivities]](<span style="font-size:smaller; color:#ecbc2a">[type]</span>) : <span style="font-size:smaller; color:#4ec9b0">activities</span>
 
: [[API C_WeeklyRewards.GetConquestWeeklyProgress|C_WeeklyRewards.GetConquestWeeklyProgress]]() : <span style="font-size:smaller; color:#4ec9b0">weeklyProgress</span>
 
: [[API C_WeeklyRewards.GetExampleRewardItemHyperlinks|C_WeeklyRewards.GetExampleRewardItemHyperlinks]](<span style="font-size:smaller; color:#ecbc2a">id</span>) : <span style="font-size:smaller; color:#4ec9b0">hyperlink, upgradeHyperlink</span>
 
: [[API C_WeeklyRewards.GetItemHyperlink|C_WeeklyRewards.GetItemHyperlink]](<span style="font-size:smaller; color:#ecbc2a">itemDBID</span>) : <span style="font-size:smaller; color:#4ec9b0">hyperlink</span>
 
: [[API C_WeeklyRewards.HasAvailableRewards|C_WeeklyRewards.HasAvailableRewards]]() : <span style="font-size:smaller; color:#4ec9b0">hasAvailableRewards</span>
 
: [[API C_WeeklyRewards.HasGeneratedRewards|C_WeeklyRewards.HasGeneratedRewards]]() : <span style="font-size:smaller; color:#4ec9b0">hasGeneratedRewards</span>
 
   
 
=== Macros ===
 
=== Macros ===
Line 2,860: Line 2,774:
 
: [[API GetRunningMacroButton|GetRunningMacroButton]]()
 
: [[API GetRunningMacroButton|GetRunningMacroButton]]()
 
: [[API GetRunningMacro|GetRunningMacro]]()
 
: [[API GetRunningMacro|GetRunningMacro]]()
: <small>SECURE</small> [[API RunMacro|RunMacro]](<span style="font-size:smaller; color:#ecbc2a">id or name</span>) - Runs a macro.
+
: <small>PROTECTED</small> [[API RunMacro|RunMacro]](<span style="font-size:smaller; color:#ecbc2a">id or name</span>) - Runs a macro.
: <small>SECURE</small> [[API RunMacroText|RunMacroText]](<span style="font-size:smaller; color:#ecbc2a">macro</span>) - Interpret the given string as a macro and run it.
+
: <small>PROTECTED</small> [[API RunMacroText|RunMacroText]](<span style="font-size:smaller; color:#ecbc2a">macro</span>) - Interpret the given string as a macro and run it.
 
: [[API SecureCmdOptionParse|SecureCmdOptionParse]](<span style="font-size:smaller; color:#ecbc2a">command</span>) - Used for evaluating conditionals in macros, returning the appropriate choice.
 
: [[API SecureCmdOptionParse|SecureCmdOptionParse]](<span style="font-size:smaller; color:#ecbc2a">command</span>) - Used for evaluating conditionals in macros, returning the appropriate choice.
 
: [[API SetMacroItem|SetMacroItem]](<span style="font-size:smaller; color:#ecbc2a">macro, item [, target]</span>)
 
: [[API SetMacroItem|SetMacroItem]](<span style="font-size:smaller; color:#ecbc2a">macro, item [, target]</span>)
 
: [[API SetMacroSpell|SetMacroSpell]](<span style="font-size:smaller; color:#ecbc2a">macro, spell [, target]</span>)
 
: [[API SetMacroSpell|SetMacroSpell]](<span style="font-size:smaller; color:#ecbc2a">macro, spell [, target]</span>)
: <small>SECURE</small> [[API StopMacro|StopMacro]]() - Stops the currently executing macro.
+
: <small>PROTECTED</small> [[API StopMacro|StopMacro]]() - Stops the currently executing macro.
   
 
=== Mail ===
 
=== Mail ===
Line 2,900: Line 2,814:
 
: [[API ReturnInboxItem|ReturnInboxItem]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Returns to the sender the attached item in the mail message at the specified index.
 
: [[API ReturnInboxItem|ReturnInboxItem]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Returns to the sender the attached item in the mail message at the specified index.
 
: [[API SendMail|SendMail]](<span style="font-size:smaller; color:#ecbc2a">target, subject, body</span>) - If the mailbox is open, this sends mail.
 
: [[API SendMail|SendMail]](<span style="font-size:smaller; color:#ecbc2a">target, subject, body</span>) - If the mailbox is open, this sends mail.
: <small>SECURE</small> [[API SetSendMailCOD|SetSendMailCOD]](<span style="font-size:smaller; color:#ecbc2a">amount</span>) - Make next mail sent using SendMail() COD target for amount.
+
: <small>PROTECTED</small> [[API SetSendMailCOD|SetSendMailCOD]](<span style="font-size:smaller; color:#ecbc2a">amount</span>) - Make next mail sent using SendMail() COD target for amount.
: <small>SECURE</small> [[API SetSendMailMoney|SetSendMailMoney]](<span style="font-size:smaller; color:#ecbc2a">amount</span>) - Add money to next mail sent using SendMail().
+
: <small>PROTECTED</small> [[API SetSendMailMoney|SetSendMailMoney]](<span style="font-size:smaller; color:#ecbc2a">amount</span>) - Add money to next mail sent using SendMail().
 
: [[API SetSendMailShowing|SetSendMailShowing]]()
 
: [[API SetSendMailShowing|SetSendMailShowing]]()
 
: [[API TakeInboxItem|TakeInboxItem]](<span style="font-size:smaller; color:#ecbc2a">index, itemIndex</span>) - Take the attached item from the mailbox message at index.
 
: [[API TakeInboxItem|TakeInboxItem]](<span style="font-size:smaller; color:#ecbc2a">index, itemIndex</span>) - Take the attached item from the mailbox message at index.
Line 2,908: Line 2,822:
   
 
=== Maps ===
 
=== Maps ===
The [[Map]] API was reworked in [[Patch 8.0.1]]
+
The [[Map]] API was reworked in [[Patch 8.0.1]]. See also [[#MapUtil|MapUtil]] functions.
 
: [[API C_Map.CloseWorldMapInteraction|C_Map.CloseWorldMapInteraction]]()
 
: [[API C_Map.CloseWorldMapInteraction|C_Map.CloseWorldMapInteraction]]()
 
: [[API C_Map.GetAreaInfo|C_Map.GetAreaInfo]](<span style="font-size:smaller; color:#ecbc2a">areaID</span>) : <span style="font-size:smaller; color:#4ec9b0">name</span> - Returns a map subzone name.
 
: [[API C_Map.GetAreaInfo|C_Map.GetAreaInfo]](<span style="font-size:smaller; color:#ecbc2a">areaID</span>) : <span style="font-size:smaller; color:#4ec9b0">name</span> - Returns a map subzone name.
Line 2,949: Line 2,863:
 
: [[API GetZoneText|GetZoneText]]() - Returns the zone text (e.g. "Stormwind City").
 
: [[API GetZoneText|GetZoneText]]() - Returns the zone text (e.g. "Stormwind City").
 
: [[API UnitPosition|UnitPosition]](<span style="font-size:smaller; color:#ecbc2a">unit</span>) - Returns the position of a unit within the current world area.
 
: [[API UnitPosition|UnitPosition]](<span style="font-size:smaller; color:#ecbc2a">unit</span>) - Returns the position of a unit within the current world area.
: <small>UI</small> [https://www.townlong-yak.com/framexml/live/go/MapCanvasMixin:AddDataProvider WorldMapFrame:AddDataProvider](<span style="font-size:smaller; color:#ecbc2a">dataProvider</span>) - Adds a map data provider.
+
: <small>UI</small> [https://www.townlong-yak.com/framexml/go/MapCanvasMixin:AddDataProvider WorldMapFrame:AddDataProvider](<span style="font-size:smaller; color:#ecbc2a">dataProvider</span>) - Adds a map data provider.
: <small>UI</small> [https://www.townlong-yak.com/framexml/live/go/MapCanvasMixin:GetMapID WorldMapFrame:GetMapID]() - Returns the currently viewed world map.
+
: <small>UI</small> [https://www.townlong-yak.com/framexml/go/MapCanvasMixin:GetMapID WorldMapFrame:GetMapID]() - Returns the currently viewed world map.
: <small>UI</small> [https://www.townlong-yak.com/framexml/live/go/MapCanvasMixin:SetMapID WorldMapFrame:SetMapID](<span style="font-size:smaller; color:#ecbc2a">uiMapID</span>) - Sets the world map.
+
: <small>UI</small> [https://www.townlong-yak.com/framexml/go/MapCanvasMixin:SetMapID WorldMapFrame:SetMapID](<span style="font-size:smaller; color:#ecbc2a">uiMapID</span>) - Sets the world map.
: <small>UI</small> [https://www.townlong-yak.com/framexml/live/go/MapCanvasMixin:EnumerateAllPins WorldMapFrame:EnumerateAllPins]() - Enumerates through all map pins.
+
: <small>UI</small> [https://www.townlong-yak.com/framexml/go/MapCanvasMixin:EnumerateAllPins WorldMapFrame:EnumerateAllPins]() - Enumerates through all map pins.
: <small>UI</small> [https://www.townlong-yak.com/framexml/8.1.5/MapUtil.lua#9 MapUtil.GetMapParentInfo](<span style="font-size:smaller; color:#ecbc2a">mapID, mapType [, topMost]</span>) - Returns the parent map object.
 
: <small>UI</small> [https://www.townlong-yak.com/framexml/8.1.5/MapUtil.lua#56 MapUtil.GetDisplayableMapForPlayer]() - Returns the lowest map for a player that has valid map art.
 
   
 
==== Minimap ====
 
==== Minimap ====
The [[Minimap]] was reworked in [[Patch 9.0.1]]
+
The [[Widget_API#Minimap|Minimap]] was reworked in [[Patch 9.0.1]]
 
: [[API C_Minimap.GetDrawGroundTextures|C_Minimap.GetDrawGroundTextures]]() : <span style="font-size:smaller; color:#4ec9b0">draw</span>
 
: [[API C_Minimap.GetDrawGroundTextures|C_Minimap.GetDrawGroundTextures]]() : <span style="font-size:smaller; color:#4ec9b0">draw</span>
 
: [[API C_Minimap.GetUiMapID|C_Minimap.GetUiMapID]]() : <span style="font-size:smaller; color:#4ec9b0">uiMapID</span>
 
: [[API C_Minimap.GetUiMapID|C_Minimap.GetUiMapID]]() : <span style="font-size:smaller; color:#4ec9b0">uiMapID</span>
Line 3,041: Line 2,953:
 
: [[API UnitOnTaxi|UnitOnTaxi]](<span style="font-size:smaller; color:#ecbc2a">unit</span>) - Returns 1 if unit is on a taxi.
 
: [[API UnitOnTaxi|UnitOnTaxi]](<span style="font-size:smaller; color:#ecbc2a">unit</span>) - Returns 1 if unit is on a taxi.
   
=== Merchant ===
+
=== Merchants ===
  +
==== Vendor ====
  +
Relates to [[Vendor]]s.
 
: [[API C_MerchantFrame.GetBuybackItemID|C_MerchantFrame.GetBuybackItemID]](<span style="font-size:smaller; color:#ecbc2a">buybackSlotIndex</span>) : <span style="font-size:smaller; color:#4ec9b0">buybackItemID</span>
 
: [[API C_MerchantFrame.GetBuybackItemID|C_MerchantFrame.GetBuybackItemID]](<span style="font-size:smaller; color:#ecbc2a">buybackSlotIndex</span>) : <span style="font-size:smaller; color:#4ec9b0">buybackItemID</span>
 
: [[API C_MerchantFrame.IsMerchantItemRefundable|C_MerchantFrame.IsMerchantItemRefundable]](<span style="font-size:smaller; color:#ecbc2a">index</span>) : <span style="font-size:smaller; color:#4ec9b0">refundable</span>
 
: [[API C_MerchantFrame.IsMerchantItemRefundable|C_MerchantFrame.IsMerchantItemRefundable]](<span style="font-size:smaller; color:#ecbc2a">index</span>) : <span style="font-size:smaller; color:#4ec9b0">refundable</span>
Line 3,067: Line 2,981:
 
: [[API SetMerchantFilter|SetMerchantFilter]]()
 
: [[API SetMerchantFilter|SetMerchantFilter]]()
   
=== Nameplates ===
+
==== Trainer ====
  +
Relates to [[Trainer]]s.
Nameplates were reworked in [[Patch 7.0.3]]
 
  +
: [[API BuyTrainerService|BuyTrainerService]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Used for buying new/upgrading professions, profession items and class skills.
: [[API C_NamePlate.GetNamePlateEnemyClickThrough|C_NamePlate.GetNamePlateEnemyClickThrough]]()
 
  +
: [[API CloseTrainer|CloseTrainer]]() - Closes the trainer window.
: [[API C_NamePlate.GetNamePlateEnemyPreferredClickInsets|C_NamePlate.GetNamePlateEnemyPreferredClickInsets]]()
 
  +
: [[API GetNumTrainerServices|GetNumTrainerServices]]() - Get the number of the trainer services.
: [[API C_NamePlate.GetNamePlateEnemySize|C_NamePlate.GetNamePlateEnemySize]]()
 
  +
: [[API GetTrainerGreetingText|GetTrainerGreetingText]]() - Get the trainer's greeting text.
: [[API C_NamePlate.GetNamePlateForUnit|C_NamePlate.GetNamePlateForUnit]](<span style="font-size:smaller; color:#ecbc2a">unitToken [, includeForbidden]</span>)
 
  +
: [[API GetTrainerSelectionIndex|GetTrainerSelectionIndex]]() - Get the index of the selected trainer service.
: [[API C_NamePlate.GetNamePlateFriendlyClickThrough|C_NamePlate.GetNamePlateFriendlyClickThrough]]()
 
  +
: [[API GetTrainerServiceAbilityReq|GetTrainerServiceAbilityReq]](<span style="font-size:smaller; color:#ecbc2a">trainerIndex, reqIndex</span>) - Used for displaying the requirements to learn a new profession, profession skill or class skill.
: [[API C_NamePlate.GetNamePlateFriendlyPreferredClickInsets|C_NamePlate.GetNamePlateFriendlyPreferredClickInsets]]()
 
  +
: [[API GetTrainerServiceCost|GetTrainerServiceCost]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Returns the cost of a specific trainer service.
: [[API C_NamePlate.GetNamePlateFriendlySize|C_NamePlate.GetNamePlateFriendlySize]]()
 
  +
: [[API GetTrainerServiceDescription|GetTrainerServiceDescription]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Returns the description of a specific trainer service.
: [[API C_NamePlate.GetNamePlateSelfClickThrough|C_NamePlate.GetNamePlateSelfClickThrough]]()
 
  +
: [[API GetTrainerServiceIcon|GetTrainerServiceIcon]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Returns icon texture for a trainer service.
: [[API C_NamePlate.GetNamePlateSelfPreferredClickInsets|C_NamePlate.GetNamePlateSelfPreferredClickInsets]]()
 
  +
: [[API GetTrainerServiceInfo|GetTrainerServiceInfo]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Returns information about a trainer service.
: [[API C_NamePlate.GetNamePlateSelfSize|C_NamePlate.GetNamePlateSelfSize]]()
 
: [[API C_NamePlate.GetNamePlates|C_NamePlate.GetNamePlates]](<span style="font-size:smaller; color:#ecbc2a">[includeForbidden]</span>)
+
: [[API GetTrainerServiceItemLink|GetTrainerServiceItemLink]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Returns an item link for a trainer service.
  +
: [[API GetTrainerServiceLevelReq|GetTrainerServiceLevelReq]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Get the required level to learn the skill.
: [[API C_NamePlate.GetNumNamePlateMotionTypes|C_NamePlate.GetNumNamePlateMotionTypes]]()
 
  +
: [[API GetTrainerServiceNumAbilityReq|GetTrainerServiceNumAbilityReq]]() - Get the maximum number of requirements that [[API GetTrainerServiceAbilityReq|GetTrainerServiceAbilityReq]] has.
: [[API C_NamePlate.GetTargetClampingInsets|C_NamePlate.GetTargetClampingInsets]]()
 
: [[API C_NamePlate.SetNamePlateEnemyClickThrough|C_NamePlate.SetNamePlateEnemyClickThrough]](<span style="font-size:smaller; color:#ecbc2a">clickthrough</span>)
+
: [[API GetTrainerServiceSkillLine|GetTrainerServiceSkillLine]](<span style="font-size:smaller; color:#ecbc2a">index</span>)
  +
: [[API GetTrainerServiceSkillReq|GetTrainerServiceSkillReq]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Returns a String and Variable for the requirements of a specific trainer service.
: [[API C_NamePlate.SetNamePlateEnemyPreferredClickInsets|C_NamePlate.SetNamePlateEnemyPreferredClickInsets]]()
 
  +
: [[API GetTrainerServiceStepIndex|GetTrainerServiceStepIndex]]()
: [[API C_NamePlate.SetNamePlateEnemySize|C_NamePlate.SetNamePlateEnemySize]](<span style="font-size:smaller; color:#ecbc2a">width, height</span>)
 
  +
: [[API GetTrainerServiceTypeFilter|GetTrainerServiceTypeFilter]](<span style="font-size:smaller; color:#ecbc2a">filter</span>) - Returns the status of a skill filter in the trainer window.
: [[API C_NamePlate.SetNamePlateFriendlyClickThrough|C_NamePlate.SetNamePlateFriendlyClickThrough]]()
 
  +
: [[API GetTrainerTradeskillRankValues|GetTrainerTradeskillRankValues]]()
: [[API C_NamePlate.SetNamePlateFriendlyPreferredClickInsets|C_NamePlate.SetNamePlateFriendlyPreferredClickInsets]](<span style="font-size:smaller; color:#ecbc2a">left, right, top, bottom</span>)
 
  +
: [[API IsTradeskillTrainer|IsTradeskillTrainer]]() - Returns 1 if trainer is for a tradeskill.
: [[API C_NamePlate.SetNamePlateFriendlySize|C_NamePlate.SetNamePlateFriendlySize]](<span style="font-size:smaller; color:#ecbc2a">width, height</span>)
 
  +
: [[API OpenTrainer|OpenTrainer]]()
: [[API C_NamePlate.SetNamePlateSelfClickThrough|C_NamePlate.SetNamePlateSelfClickThrough]](<span style="font-size:smaller; color:#ecbc2a">clickthrough</span>)
 
  +
: [[API SelectTrainerService|SelectTrainerService]]()
: [[API C_NamePlate.SetNamePlateSelfPreferredClickInsets|C_NamePlate.SetNamePlateSelfPreferredClickInsets]](<span style="font-size:smaller; color:#ecbc2a">left, right, top, bottom</span>)
 
: [[API C_NamePlate.SetNamePlateSelfSize|C_NamePlate.SetNamePlateSelfSize]](<span style="font-size:smaller; color:#ecbc2a">width, height</span>)
+
: [[API SetTrainerServiceTypeFilter|SetTrainerServiceTypeFilter]](<span style="font-size:smaller; color:#ecbc2a">filter, state</span>) - Sets the status of a skill filter in the trainer window.
: [[API C_NamePlate.SetTargetClampingInsets|C_NamePlate.SetTargetClampingInsets]](<span style="font-size:smaller; color:#ecbc2a">clickthrough</span>)
 
: [[API SetInWorldUIVisibility|SetInWorldUIVisibility]](<span style="font-size:smaller; color:#ecbc2a">visible</span>) - Allows nameplates to be shown even while the UI is hidden (with Alt-Z)
 
: [[API UnitNameplateShowsWidgetsOnly|UnitNameplateShowsWidgetsOnly]](<span style="font-size:smaller; color:#ecbc2a">unit</span>) : <span style="font-size:smaller; color:#4ec9b0">nameplateShowsWidgetsOnly</span>
 
   
 
=== Pet Battles ===
 
=== Pet Battles ===
Line 3,163: Line 3,074:
 
: [[API UnitIsWildBattlePet|UnitIsWildBattlePet]]()
 
: [[API UnitIsWildBattlePet|UnitIsWildBattlePet]]()
   
=== Petitions ===
+
=== Players ===
  +
: [[API C_PlayerInfo.GetClass|C_PlayerInfo.GetClass]](<span style="font-size:smaller; color:#ecbc2a">playerLocation</span>) : <span style="font-size:smaller; color:#4ec9b0">className, classFilename, classID</span> - Returns the class of a player.
Petitions are signup documents for guilds and arena teams. Some functions below only apply to a particular petition type
 
  +
: [[API C_PlayerInfo.GetName|C_PlayerInfo.GetName]](<span style="font-size:smaller; color:#ecbc2a">playerLocation</span>) : <span style="font-size:smaller; color:#4ec9b0">name</span> - Returns the name of a player.
: [[API CanSignPetition|CanSignPetition]]() - Returns nil if the player cannot sign the current petition.
 
  +
: [[API C_PlayerInfo.GetRace|C_PlayerInfo.GetRace]](<span style="font-size:smaller; color:#ecbc2a">playerLocation</span>) : <span style="font-size:smaller; color:#4ec9b0">raceID</span> - Returns the race of a player.
: [[API ClosePetition|ClosePetition]]() - Closes the current petition.
 
  +
: [[API C_PlayerInfo.GetSex|C_PlayerInfo.GetSex]](<span style="font-size:smaller; color:#ecbc2a">playerLocation</span>) : <span style="font-size:smaller; color:#4ec9b0">sex</span> - Returns the sex of a player.
: [[API GetNumPetitionNames|GetNumPetitionNames]]() - Gets the number of signatures on the current petition.
 
  +
: [[API C_PlayerInfo.GUIDIsPlayer|C_PlayerInfo.GUIDIsPlayer]](<span style="font-size:smaller; color:#ecbc2a">guid</span>) : <span style="font-size:smaller; color:#4ec9b0">isPlayer</span> - Returns true if the guid belongs to a player.
: [[API GetPetitionInfo|GetPetitionInfo]]() - Retrieves information about the current petition.
 
: [[API GetPetitionNameInfo|GetPetitionNameInfo]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Retrieves information about a signature on the petition.
+
: [[API C_PlayerInfo.IsConnected|C_PlayerInfo.IsConnected]](<span style="font-size:smaller; color:#ecbc2a">[playerLocation]</span>) : <span style="font-size:smaller; color:#4ec9b0">isConnected</span> - Returns true if a player is connected.
  +
: [[API C_PlayerInfo.UnitIsSameServer|C_PlayerInfo.UnitIsSameServer]](<span style="font-size:smaller; color:#ecbc2a">playerLocation</span>) : <span style="font-size:smaller; color:#4ec9b0">unitIsSameServer</span> - Returns true if another player is from your own or connected realm.
: [[API OfferPetition|OfferPetition]]() - Offers a petition to your target, inviting them to join your would-be guild/arena team.
 
: [[API RenamePetition|RenamePetition]](<span style="font-size:smaller; color:#ecbc2a">name</span>) - Renames the current petition.
+
: [[API Ambiguate|Ambiguate]](<span style="font-size:smaller; color:#ecbc2a">fullName, context</span>) - Returns a version of a character-realm string suitable for use in a given context.
  +
: [[API GetAutoCompleteResults|GetAutoCompleteResults]](<span style="font-size:smaller; color:#ecbc2a">text, include, exclude, maxResults [, cursorPosition]</span>) - Returns possible player names matching a given prefix string and specified requirements.
: [[API SignPetition|SignPetition]]() - Signs the current petition.
 
  +
: [[API GetPlayerInfoByGUID|GetPlayerInfoByGUID]](<span style="font-size:smaller; color:#ecbc2a">guid</span>) - Returns race, class, sex about the guid (client must have seen the guid)
: [[API TurnInGuildCharter|TurnInGuildCharter]]() - Founds a guild.
 
  +
: [[API IsRecognizedName|IsRecognizedName]](<span style="font-size:smaller; color:#ecbc2a">text, includeBitField, excludeBitField</span>) - Returns true if a given character name is recognized by the client.
  +
  +
==== Inspection ====
  +
: [[API CanInspect|CanInspect]](<span style="font-size:smaller; color:#ecbc2a">unit [, showError]</span>) - Returns whether you can inspect the specified unit.
  +
: [[API CheckInteractDistance|CheckInteractDistance]](<span style="font-size:smaller; color:#ecbc2a">unit, interaction</span>) - Returns whether you're in range to perform various interactions with the specified unit.
  +
: [[API ClearInspectPlayer|ClearInspectPlayer]]() - Reset inspect data once finished with it.
  +
: [[API GetInspectArenaData|GetInspectArenaData]](<span style="font-size:smaller; color:#ecbc2a">bracketIndex</span>)
  +
: [[API GetInspectGuildInfo|GetInspectGuildInfo]](<span style="font-size:smaller; color:#ecbc2a">unit</span>)
  +
: [[API GetInspectHonorData|GetInspectHonorData]]() - Returns honor information about the inspected player.
  +
: [[API GetInspectRatedBGData|GetInspectRatedBGData]]()
  +
: [[API GetInspectSpecialization|GetInspectSpecialization]](<span style="font-size:smaller; color:#ecbc2a">unit</span>) - Returns a number representing the current active specialization of a given unit.
  +
: [[API GetInspectTalent|GetInspectTalent]]()
  +
: [[API NotifyInspect|NotifyInspect]](<span style="font-size:smaller; color:#ecbc2a">unit</span>) - Requests information about a unit's inventory and talents from the server.
  +
: <small>UI</small> [[API InspectUnit|InspectUnit]](<span style="font-size:smaller; color:#ecbc2a">unit</span>) - Instructs FrameXML to inspect a particular unit (query server; show UI).
  +
  +
==== Trading ====
  +
Relates to [[Trade|Trading]].
  +
: <small>HW</small> [[API AcceptTrade|AcceptTrade]]() - A pending trade will be accepted.
  +
: [[API AddTradeMoney|AddTradeMoney]]() - Adds the money dropped into the player's trade frame.
  +
: [[API BeginTrade|BeginTrade]]()
  +
: [[API CancelTrade|CancelTrade]]() - Declines the offer to trade with the other player.
  +
: [[API CancelTradeAccept|CancelTradeAccept]]() - Cancels the trade attempt which required an accept.
  +
: [[API ClickTargetTradeButton|ClickTargetTradeButton]](<span style="font-size:smaller; color:#ecbc2a">index</span>)
  +
: [[API ClickTradeButton|ClickTradeButton]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Equivalent of a mouseclick on the trade window buttons [1-7].
  +
: [[API CloseTrade|CloseTrade]]() - Closes the trade.
  +
: [[API GetPlayerTradeMoney|GetPlayerTradeMoney]]() - Returns the amount of money the player has in the trade window.
  +
: [[API GetTargetTradeMoney|GetTargetTradeMoney]]() - Returns the amount of money in the trade frame of the target player.
  +
: [[API GetTradePlayerItemInfo|GetTradePlayerItemInfo]](<span style="font-size:smaller; color:#ecbc2a">id</span>) - Returns information about a trade item.
  +
: [[API GetTradePlayerItemLink|GetTradePlayerItemLink]](<span style="font-size:smaller; color:#ecbc2a">id</span>) - Returns an [[itemLink]] for the given item in your side of the trade window (if open)
  +
: [[API GetTradeTargetItemInfo|GetTradeTargetItemInfo]](<span style="font-size:smaller; color:#ecbc2a">id</span>) - Returns information about a trade item.
  +
: [[API GetTradeTargetItemLink|GetTradeTargetItemLink]](<span style="font-size:smaller; color:#ecbc2a">id</span>) - Returns an [[itemLink]] for the given item in the other player's side of the trade window (if open)
  +
: [[API InitiateTrade|InitiateTrade]](<span style="font-size:smaller; color:#ecbc2a">UnitId</span>) - Asks the specified unit to trade.
  +
: [[API SetTradeMoney|SetTradeMoney]](<span style="font-size:smaller; color:#ecbc2a">copper</span>) - Sets the amount of money offered as part of the player's trade offer.
  +
  +
==== Summoning ====
  +
: [[API C_IncomingSummon.HasIncomingSummon|C_IncomingSummon.HasIncomingSummon]](<span style="font-size:smaller; color:#ecbc2a">unit</span>) : <span style="font-size:smaller; color:#4ec9b0">summon</span> - Returns whether a group member has an incoming summon.
  +
: [[API C_IncomingSummon.IncomingSummonStatus|C_IncomingSummon.IncomingSummonStatus]](<span style="font-size:smaller; color:#ecbc2a">unit</span>) : <span style="font-size:smaller; color:#4ec9b0">status</span> - Returns the status of an group member's incoming summon.
  +
: [[API C_SummonInfo.CancelSummon|C_SummonInfo.CancelSummon]]() - Rejects a summon request.
  +
: [[API C_SummonInfo.ConfirmSummon|C_SummonInfo.ConfirmSummon]]() - Accepts a summon request.
  +
: [[API C_SummonInfo.GetSummonConfirmAreaName|C_SummonInfo.GetSummonConfirmAreaName]]() : <span style="font-size:smaller; color:#4ec9b0">areaName</span> - Returns the name of the area you're being summoned to.
  +
: [[API C_SummonInfo.GetSummonConfirmSummoner|C_SummonInfo.GetSummonConfirmSummoner]]() : <span style="font-size:smaller; color:#4ec9b0">summoner</span> - Returns the name of the player summoning you.
  +
: [[API C_SummonInfo.GetSummonConfirmTimeLeft|C_SummonInfo.GetSummonConfirmTimeLeft]]() : <span style="font-size:smaller; color:#4ec9b0">timeLeft</span> - Returns the amount of time left before the pending summon expires.
  +
: [[API C_SummonInfo.GetSummonReason|C_SummonInfo.GetSummonReason]]() : <span style="font-size:smaller; color:#4ec9b0">summonReason</span>
  +
: [[API C_SummonInfo.IsSummonSkippingStartExperience|C_SummonInfo.IsSummonSkippingStartExperience]]() : <span style="font-size:smaller; color:#4ec9b0">isSummonSkippingStartExperience</span>
  +
: [[API PlayerCanTeleport|PlayerCanTeleport]]()
  +
  +
==== Death ====
  +
: [[API C_DeathInfo.GetCorpseMapPosition|C_DeathInfo.GetCorpseMapPosition]](<span style="font-size:smaller; color:#ecbc2a">uiMapID</span>) : <span style="font-size:smaller; color:#4ec9b0">position</span> - Returns the location of the player's corpse on the map.
  +
: [[API C_DeathInfo.GetDeathReleasePosition|C_DeathInfo.GetDeathReleasePosition]](<span style="font-size:smaller; color:#ecbc2a">uiMapID</span>) : <span style="font-size:smaller; color:#4ec9b0">position</span> - Returns the death release location.
  +
: [[API C_DeathInfo.GetGraveyardsForMap|C_DeathInfo.GetGraveyardsForMap]](<span style="font-size:smaller; color:#ecbc2a">uiMapID</span>) : <span style="font-size:smaller; color:#4ec9b0">graveyards</span> - Returns graveyard info and location for a map.
  +
: [[API C_DeathInfo.GetSelfResurrectOptions|C_DeathInfo.GetSelfResurrectOptions]]() : <span style="font-size:smaller; color:#4ec9b0">options</span> - Returns self resurrect options for your character, including from soulstones.
  +
: [[API C_DeathInfo.UseSelfResurrectOption|C_DeathInfo.UseSelfResurrectOption]](<span style="font-size:smaller; color:#ecbc2a">optionType, id</span>) - Uses a soulstone or similar means of self resurrection.
  +
: [[API AcceptResurrect|AcceptResurrect]]() - The player accepts the request from another player to resurrect him/herself.
  +
: [[API AcceptXPLoss|AcceptXPLoss]]() - Accept the durability loss to be reborn by a spirit healer. (The name is a remnant from when sprit res was an XP loss instead.)
  +
: [[API CannotBeResurrected|CannotBeResurrected]]()
  +
: [[API DeathRecap_GetEvents|DeathRecap_GetEvents]]()
  +
: [[API DeathRecap_HasEvents|DeathRecap_HasEvents]]()
  +
: [[API DeclineResurrect|DeclineResurrect]]() - Decline the request from another player to resurrect him/herself.
  +
: [[API GetCemeteryPreference|GetCemeteryPreference]]()
  +
: [[API GetCorpseRecoveryDelay|GetCorpseRecoveryDelay]]() - Time left before a player can accept a resurrection.
  +
: [[API GetDeathRecapLink|GetDeathRecapLink]](<span style="font-size:smaller; color:#ecbc2a">recapID</span>)
  +
: [[API GetReleaseTimeRemaining|GetReleaseTimeRemaining]]() - Returns the amount of time left before your ghost is pulled from your body.
  +
: [[API GetResSicknessDuration|GetResSicknessDuration]]()
  +
: [[API HasNoReleaseAura|HasNoReleaseAura]]()
  +
: [[API IsCemeterySelectionAvailable|IsCemeterySelectionAvailable]]()
  +
: [[API IsEncounterLimitingResurrections|IsEncounterLimitingResurrections]]()
  +
: [[API IsEncounterSuppressingRelease|IsEncounterSuppressingRelease]]()
  +
: [[API NotWhileDeadError|NotWhileDeadError]]() - Generates an error message saying you cannot do that while dead.
  +
: [[API PortGraveyard|PortGraveyard]]()
  +
: [[API RepopMe|RepopMe]]() - The "Release Spirit" button. Sends you to the graveyard when dead.
  +
: [[API ResurrectGetOfferer|ResurrectGetOfferer]]() - Returns the name of the person offering to resurrect you.
  +
: [[API ResurrectHasSickness|ResurrectHasSickness]]() - Appears to be used when accepting a resurrection will give you resurrection sickessness.
  +
: [[API ResurrectHasTimer|ResurrectHasTimer]]() - Does the player have to wait before accepting a resurrection.
  +
: [[API RetrieveCorpse|RetrieveCorpse]]() - Resurrects when near corpse. e.g., The "Accept" button one sees after running back to your body.
  +
: [[API SetCemeteryPreference|SetCemeteryPreference]](<span style="font-size:smaller; color:#ecbc2a">cemeteryID</span>)
  +
: [[API TimeoutResurrect|TimeoutResurrect]]()
   
 
=== Professions ===
 
=== Professions ===
Line 3,397: Line 3,384:
 
: [[API C_PvP.IsRatedArena|C_PvP.IsRatedArena]]() : <span style="font-size:smaller; color:#4ec9b0">isRatedArena</span>
 
: [[API C_PvP.IsRatedArena|C_PvP.IsRatedArena]]() : <span style="font-size:smaller; color:#4ec9b0">isRatedArena</span>
 
: [[API CanSurrenderArena|CanSurrenderArena]]()
 
: [[API CanSurrenderArena|CanSurrenderArena]]()
  +
: [[API GetArenaOpponentSpec|GetArenaOpponentSpec]]()
 
: [[API GetBattlefieldArenaFaction|GetBattlefieldArenaFaction]]()
 
: [[API GetBattlefieldArenaFaction|GetBattlefieldArenaFaction]]()
 
: [[API GetBattlefieldTeamInfo|GetBattlefieldTeamInfo]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Gets info about a registered Arena Team at the end of an arena match.
 
: [[API GetBattlefieldTeamInfo|GetBattlefieldTeamInfo]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Gets info about a registered Arena Team at the end of an arena match.
Line 3,402: Line 3,390:
 
: [[API GetMaxArenaCurrency|GetMaxArenaCurrency]]()
 
: [[API GetMaxArenaCurrency|GetMaxArenaCurrency]]()
 
: [[API GetNumArenaOpponents|GetNumArenaOpponents]]()
 
: [[API GetNumArenaOpponents|GetNumArenaOpponents]]()
  +
: [[API GetNumArenaOpponentSpecs|GetNumArenaOpponentSpecs]]()
 
: [[API GetPreviousArenaSeason|GetPreviousArenaSeason]]() - Gets the previous Arena season.
 
: [[API GetPreviousArenaSeason|GetPreviousArenaSeason]]() - Gets the previous Arena season.
 
: [[API IsActiveBattlefieldArena|IsActiveBattlefieldArena]]() - Returns true if in an Arena Match, also Returns true for the second argument if it's a registered match.
 
: [[API IsActiveBattlefieldArena|IsActiveBattlefieldArena]]() - Returns true if in an Arena Match, also Returns true for the second argument if it's a registered match.
Line 3,449: Line 3,438:
 
: [[API GetRatedBattleGroundInfo|GetRatedBattleGroundInfo]]()
 
: [[API GetRatedBattleGroundInfo|GetRatedBattleGroundInfo]]()
 
: [[API IsPVPTimerRunning|IsPVPTimerRunning]]()
 
: [[API IsPVPTimerRunning|IsPVPTimerRunning]]()
: <small>SECURE</small> [[API JoinBattlefield|JoinBattlefield]](<span style="font-size:smaller; color:#ecbc2a">index [, joinAs]</span>) - Queue for a battleground either solo or as a group.
+
: <small>PROTECTED</small> [[API JoinBattlefield|JoinBattlefield]](<span style="font-size:smaller; color:#ecbc2a">index [, joinAs]</span>) - Queue for a battleground either solo or as a group.
: <small>SECURE</small> [[API JoinRatedBattlefield|JoinRatedBattlefield]]()
+
: <small>PROTECTED</small> [[API JoinRatedBattlefield|JoinRatedBattlefield]]()
 
: [[API LeaveBattlefield|LeaveBattlefield]]() - Leave the current battlefield.
 
: [[API LeaveBattlefield|LeaveBattlefield]]() - Leave the current battlefield.
 
: [[API ReportPlayerIsPVPAFK|ReportPlayerIsPVPAFK]](<span style="font-size:smaller; color:#ecbc2a">unit</span>) - Reports the specified player as AFK in a battleground.
 
: [[API ReportPlayerIsPVPAFK|ReportPlayerIsPVPAFK]](<span style="font-size:smaller; color:#ecbc2a">unit</span>) - Reports the specified player as AFK in a battleground.
Line 3,580: Line 3,569:
 
: <small>UI</small> [https://www.townlong-yak.com/framexml/go/PVPGetConquestLevelInfo PVPGetConquestLevelInfo]()
 
: <small>UI</small> [https://www.townlong-yak.com/framexml/go/PVPGetConquestLevelInfo PVPGetConquestLevelInfo]()
 
: <small>UI</small> [https://www.townlong-yak.com/framexml/go/QuestUtils_GetQuestName QuestUtils_GetQuestName]() - Returns the name for a quest ID.
 
: <small>UI</small> [https://www.townlong-yak.com/framexml/go/QuestUtils_GetQuestName QuestUtils_GetQuestName]() - Returns the name for a quest ID.
 
==== Gossip ====
 
Gossip refers to interaction with an NPC.
 
: [[API C_GossipInfo.CloseGossip|C_GossipInfo.CloseGossip]]() - Dismiss the gossip window.
 
: [[API C_GossipInfo.ForceGossip|C_GossipInfo.ForceGossip]]() : <span style="font-size:smaller; color:#4ec9b0">forceGossip</span> - Returns whether the gossip text ''must'' be displayed.
 
: [[API C_GossipInfo.GetActiveQuests|C_GossipInfo.GetActiveQuests]]() : <span style="font-size:smaller; color:#4ec9b0">info</span> - Retrieves a list of quests which can be turned in on the NPC you are talking to.
 
: [[API C_GossipInfo.GetAvailableQuests|C_GossipInfo.GetAvailableQuests]]() : <span style="font-size:smaller; color:#4ec9b0">info</span> - Retrieves a list of the available quests on the NPC you are talking to.
 
: [[API C_GossipInfo.GetNumActiveQuests|C_GossipInfo.GetNumActiveQuests]]() : <span style="font-size:smaller; color:#4ec9b0">numQuests</span> - Returns the number of active quests that you should eventually turn in to this NPC.
 
: [[API C_GossipInfo.GetNumAvailableQuests|C_GossipInfo.GetNumAvailableQuests]]() : <span style="font-size:smaller; color:#4ec9b0">numQuests</span> - Returns the number of quests (that you are not already on) offered by this NPC.
 
: [[API C_GossipInfo.GetNumOptions|C_GossipInfo.GetNumOptions]]() : <span style="font-size:smaller; color:#4ec9b0">numOptions</span> - Returns the number of conversation options available with this NPC.
 
: [[API C_GossipInfo.GetOptions|C_GossipInfo.GetOptions]]() : <span style="font-size:smaller; color:#4ec9b0">info</span> - Retrieves a list of the available gossip items on the NPC you are talking to.
 
: [[API C_GossipInfo.GetPoiForUiMapID|C_GossipInfo.GetPoiForUiMapID]](<span style="font-size:smaller; color:#ecbc2a">uiMapID</span>) : <span style="font-size:smaller; color:#4ec9b0">gossipPoiID</span> - Returns gossip poi for a map.
 
: [[API C_GossipInfo.GetPoiInfo|C_GossipInfo.GetPoiInfo]](<span style="font-size:smaller; color:#ecbc2a">uiMapID, gossipPoiID</span>) : <span style="font-size:smaller; color:#4ec9b0">gossipPoiInfo</span> - Returns gossip poi info.
 
: [[API C_GossipInfo.GetText|C_GossipInfo.GetText]]() : <span style="font-size:smaller; color:#4ec9b0">gossipText</span> - Retrieves the gossip text.
 
: [[API C_GossipInfo.RefreshOptions|C_GossipInfo.RefreshOptions]]()
 
: [[API C_GossipInfo.SelectActiveQuest|C_GossipInfo.SelectActiveQuest]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Selects an active quest.
 
: [[API C_GossipInfo.SelectAvailableQuest|C_GossipInfo.SelectAvailableQuest]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Selects an available quest.
 
: [[API C_GossipInfo.SelectOption|C_GossipInfo.SelectOption]](<span style="font-size:smaller; color:#ecbc2a">index [, text, confirmed]</span>) - Selects a gossip (conversation) option.
 
: [[API AcceptQuest|AcceptQuest]]() - Accept the specified quest.
 
: [[API CloseQuest|CloseQuest]]() - Closes the shown quest.
 
: [[API CompleteQuest|CompleteQuest]]() - Complete the specified quest.
 
: [[API DeclineQuest|DeclineQuest]]() - Declines the currently offered quest.
 
: [[API GetActiveLevel|GetActiveLevel]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Gets the level of an active quest (only available after QUEST_GREETING event).
 
: [[API GetActiveQuestID|GetActiveQuestID]](<span style="font-size:smaller; color:#ecbc2a">index</span>)
 
: [[API GetActiveTitle|GetActiveTitle]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Gets the title of an active quest (only available after QUEST_GREETING event).
 
: [[API GetAvailableLevel|GetAvailableLevel]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Gets the level of an available quest (only available after QUEST_GREETING event).
 
: [[API GetAvailableQuestInfo|GetAvailableQuestInfo]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Returns metadata (quest type) about an available quest.
 
: [[API GetAvailableTitle|GetAvailableTitle]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Gets the title of an available quest (only available after QUEST_GREETING event).
 
: [[API GetGreetingText|GetGreetingText]]()
 
: [[API GetNumActiveQuests|GetNumActiveQuests]]() - Gets the number of currently active quests from this NPC (only available after QUEST_GREETING event).
 
: [[API GetNumAvailableQuests|GetNumAvailableQuests]]() - Gets the number of currently available quests from this NPC (only available after QUEST_GREETING event).
 
: [[API GetNumQuestRewards|GetNumQuestRewards]]() - Returns number of reward items (those that you always get) for quest currently in gossip window.
 
: [[API GetNumRewardCurrencies|GetNumRewardCurrencies]]()
 
: [[API GetNumRewardSpells|GetNumRewardSpells]]()
 
: [[API GetObjectiveText|GetObjectiveText]]() - Gets the objective of the current quest.
 
: [[API GetProgressText|GetProgressText]]() - Returns quest progress text, displayed by the NPC before the player pressed "Continue".
 
: [[API GetQuestID|GetQuestID]]() - Returns the ID of the quest most recently displayed in a gossip frame, even after that frame is closed.
 
: [[API GetQuestItemInfo|GetQuestItemInfo]]() - Returns basic information about the reward/choice/required item for quest currently in gossip window.
 
: [[API GetQuestItemInfoLootType|GetQuestItemInfoLootType]](<span style="font-size:smaller; color:#ecbc2a">type, index</span>)
 
: [[API GetQuestItemLink|GetQuestItemLink]](<span style="font-size:smaller; color:#ecbc2a">type, index</span>) - Returns an [[itemLink]] for a selected quest reward/choice/required item for quest currently in gossip window.
 
: [[API GetQuestMoneyToGet|GetQuestMoneyToGet]]() - Returns amount of money required for quest currently displayed in gossip.
 
: [[API GetQuestPortraitGiver|GetQuestPortraitGiver]]()
 
: [[API GetQuestPortraitTurnIn|GetQuestPortraitTurnIn]]()
 
: [[API GetQuestText|GetQuestText]]() - Gets the description of the current quest.
 
: [[API GetRewardArtifactXP|GetRewardArtifactXP]]()
 
: [[API GetRewardHonor|GetRewardHonor]]()
 
: [[API GetRewardMoney|GetRewardMoney]]() - Returns a amount of copper rewarded for completion of quest displayed in gossip.
 
: [[API GetRewardNumSkillUps|GetRewardNumSkillUps]]()
 
: [[API GetRewardSkillLineID|GetRewardSkillLineID]]()
 
: [[API GetRewardSkillPoints|GetRewardSkillPoints]]()
 
: [[API GetRewardSpell|GetRewardSpell]]() - Returns name and texture of spell awarded for quest completion for quest currently in gossip window.
 
: [[API GetRewardText|GetRewardText]]() - Returns quest reward text, displayed by the NPC before the player hits "Complete Quest".
 
: [[API GetRewardTitle|GetRewardTitle]]() - Returns the title awarded by the currently displayed quest.
 
: [[API GetRewardXP|GetRewardXP]]() - Returns the amount of experience awarded by the currently displayed text.
 
: [[API GetTitleText|GetTitleText]]() - Retrieves the title of the quest while talking to the NPC about it.
 
: [[API IsActiveQuestLegendary|IsActiveQuestLegendary]](<span style="font-size:smaller; color:#ecbc2a">index</span>)
 
: [[API IsActiveQuestTrivial|IsActiveQuestTrivial]](<span style="font-size:smaller; color:#ecbc2a">index</span>)
 
: [[API IsAvailableQuestTrivial|IsAvailableQuestTrivial]](<span style="font-size:smaller; color:#ecbc2a">index</span>)
 
: [[API SelectActiveQuest|SelectActiveQuest]]() - Selects an active quest from the NPC (only available after QUEST_GREETING event).
 
: [[API SelectAvailableQuest|SelectAvailableQuest]]() - Selects an available quest from the NPC (only available after QUEST_GREETING event).
 
   
 
==== Quest Log ====
 
==== Quest Log ====
Line 3,646: Line 3,575:
 
: [[API C_QuestLog.AddWorldQuestWatch|C_QuestLog.AddWorldQuestWatch]](<span style="font-size:smaller; color:#ecbc2a">questID [, watchType]</span>) : <span style="font-size:smaller; color:#4ec9b0">wasWatched</span> - Adds a world quest to the watch list.
 
: [[API C_QuestLog.AddWorldQuestWatch|C_QuestLog.AddWorldQuestWatch]](<span style="font-size:smaller; color:#ecbc2a">questID [, watchType]</span>) : <span style="font-size:smaller; color:#4ec9b0">wasWatched</span> - Adds a world quest to the watch list.
 
: [[API C_QuestLog.CanAbandonQuest|C_QuestLog.CanAbandonQuest]](<span style="font-size:smaller; color:#ecbc2a">questID</span>) : <span style="font-size:smaller; color:#4ec9b0">canAbandon</span>
 
: [[API C_QuestLog.CanAbandonQuest|C_QuestLog.CanAbandonQuest]](<span style="font-size:smaller; color:#ecbc2a">questID</span>) : <span style="font-size:smaller; color:#4ec9b0">canAbandon</span>
: [[API C_QuestLog.GetAbandonQuest|C_QuestLog.GetAbandonQuest]]() : <span style="font-size:smaller; color:#4ec9b0">questID</span> - Gets the name of a quest while it is being abandoned.
+
: [[API C_QuestLog.GetAbandonQuest|C_QuestLog.GetAbandonQuest]]() : <span style="font-size:smaller; color:#4ec9b0">questID</span> - Returns the ID of the quest being abandoned.
 
: [[API C_QuestLog.GetAbandonQuestItems|C_QuestLog.GetAbandonQuestItems]]() : <span style="font-size:smaller; color:#4ec9b0">itemIDs</span>
 
: [[API C_QuestLog.GetAbandonQuestItems|C_QuestLog.GetAbandonQuestItems]]() : <span style="font-size:smaller; color:#4ec9b0">itemIDs</span>
 
: [[API C_QuestLog.GetActiveThreatMaps|C_QuestLog.GetActiveThreatMaps]]() : <span style="font-size:smaller; color:#4ec9b0">uiMapIDs</span>
 
: [[API C_QuestLog.GetActiveThreatMaps|C_QuestLog.GetActiveThreatMaps]]() : <span style="font-size:smaller; color:#4ec9b0">uiMapIDs</span>
Line 3,745: Line 3,674:
 
: [[API QuestLogShouldShowPortrait|QuestLogShouldShowPortrait]]()
 
: [[API QuestLogShouldShowPortrait|QuestLogShouldShowPortrait]]()
 
: [[API UseQuestLogSpecialItem|UseQuestLogSpecialItem]](<span style="font-size:smaller; color:#ecbc2a">index</span>)
 
: [[API UseQuestLogSpecialItem|UseQuestLogSpecialItem]](<span style="font-size:smaller; color:#ecbc2a">index</span>)
  +
  +
==== Gossip ====
  +
Gossip refers to interaction with an NPC.
  +
: [[API C_GossipInfo.CloseGossip|C_GossipInfo.CloseGossip]]() - Dismiss the gossip window.
  +
: [[API C_GossipInfo.ForceGossip|C_GossipInfo.ForceGossip]]() : <span style="font-size:smaller; color:#4ec9b0">forceGossip</span> - Returns whether the gossip text ''must'' be displayed.
  +
: [[API C_GossipInfo.GetActiveQuests|C_GossipInfo.GetActiveQuests]]() : <span style="font-size:smaller; color:#4ec9b0">info</span> - Retrieves a list of quests which can be turned in on the NPC you are talking to.
  +
: [[API C_GossipInfo.GetAvailableQuests|C_GossipInfo.GetAvailableQuests]]() : <span style="font-size:smaller; color:#4ec9b0">info</span> - Retrieves a list of the available quests on the NPC you are talking to.
  +
: [[API C_GossipInfo.GetNumActiveQuests|C_GossipInfo.GetNumActiveQuests]]() : <span style="font-size:smaller; color:#4ec9b0">numQuests</span> - Returns the number of active quests that you should eventually turn in to this NPC.
  +
: [[API C_GossipInfo.GetNumAvailableQuests|C_GossipInfo.GetNumAvailableQuests]]() : <span style="font-size:smaller; color:#4ec9b0">numQuests</span> - Returns the number of quests (that you are not already on) offered by this NPC.
  +
: [[API C_GossipInfo.GetNumOptions|C_GossipInfo.GetNumOptions]]() : <span style="font-size:smaller; color:#4ec9b0">numOptions</span> - Returns the number of conversation options available with this NPC.
  +
: [[API C_GossipInfo.GetOptions|C_GossipInfo.GetOptions]]() : <span style="font-size:smaller; color:#4ec9b0">info</span> - Retrieves a list of the available gossip items on the NPC you are talking to.
  +
: [[API C_GossipInfo.GetPoiForUiMapID|C_GossipInfo.GetPoiForUiMapID]](<span style="font-size:smaller; color:#ecbc2a">uiMapID</span>) : <span style="font-size:smaller; color:#4ec9b0">gossipPoiID</span> - Returns gossip poi for a map.
  +
: [[API C_GossipInfo.GetPoiInfo|C_GossipInfo.GetPoiInfo]](<span style="font-size:smaller; color:#ecbc2a">uiMapID, gossipPoiID</span>) : <span style="font-size:smaller; color:#4ec9b0">gossipPoiInfo</span> - Returns gossip poi info.
  +
: [[API C_GossipInfo.GetText|C_GossipInfo.GetText]]() : <span style="font-size:smaller; color:#4ec9b0">gossipText</span> - Retrieves the gossip text.
  +
: [[API C_GossipInfo.RefreshOptions|C_GossipInfo.RefreshOptions]]()
  +
: [[API C_GossipInfo.SelectActiveQuest|C_GossipInfo.SelectActiveQuest]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Selects an active quest.
  +
: [[API C_GossipInfo.SelectAvailableQuest|C_GossipInfo.SelectAvailableQuest]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Selects an available quest.
  +
: [[API C_GossipInfo.SelectOption|C_GossipInfo.SelectOption]](<span style="font-size:smaller; color:#ecbc2a">index [, text, confirmed]</span>) - Selects a gossip (conversation) option.
  +
: [[API AcceptQuest|AcceptQuest]]() - Accept the specified quest.
  +
: [[API CloseQuest|CloseQuest]]() - Closes the shown quest.
  +
: [[API CompleteQuest|CompleteQuest]]() - Complete the specified quest.
  +
: [[API DeclineQuest|DeclineQuest]]() - Declines the currently offered quest.
  +
: [[API GetActiveLevel|GetActiveLevel]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Gets the level of an active quest (only available after QUEST_GREETING event).
  +
: [[API GetActiveQuestID|GetActiveQuestID]](<span style="font-size:smaller; color:#ecbc2a">index</span>)
  +
: [[API GetActiveTitle|GetActiveTitle]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Gets the title of an active quest (only available after QUEST_GREETING event).
  +
: [[API GetAvailableLevel|GetAvailableLevel]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Gets the level of an available quest (only available after QUEST_GREETING event).
  +
: [[API GetAvailableQuestInfo|GetAvailableQuestInfo]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Returns metadata (quest type) about an available quest.
  +
: [[API GetAvailableTitle|GetAvailableTitle]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Gets the title of an available quest (only available after QUEST_GREETING event).
  +
: [[API GetGreetingText|GetGreetingText]]()
  +
: [[API GetNumActiveQuests|GetNumActiveQuests]]() - Gets the number of currently active quests from this NPC (only available after QUEST_GREETING event).
  +
: [[API GetNumAvailableQuests|GetNumAvailableQuests]]() - Gets the number of currently available quests from this NPC (only available after QUEST_GREETING event).
  +
: [[API GetNumQuestRewards|GetNumQuestRewards]]() - Returns number of reward items (those that you always get) for quest currently in gossip window.
  +
: [[API GetNumRewardCurrencies|GetNumRewardCurrencies]]()
  +
: [[API GetNumRewardSpells|GetNumRewardSpells]]()
  +
: [[API GetObjectiveText|GetObjectiveText]]() - Gets the objective of the current quest.
  +
: [[API GetProgressText|GetProgressText]]() - Returns quest progress text, displayed by the NPC before the player pressed "Continue".
  +
: [[API GetQuestID|GetQuestID]]() - Returns the ID of the quest most recently displayed in a gossip frame, even after that frame is closed.
  +
: [[API GetQuestItemInfo|GetQuestItemInfo]]() - Returns basic information about the reward/choice/required item for quest currently in gossip window.
  +
: [[API GetQuestItemInfoLootType|GetQuestItemInfoLootType]](<span style="font-size:smaller; color:#ecbc2a">type, index</span>)
  +
: [[API GetQuestItemLink|GetQuestItemLink]](<span style="font-size:smaller; color:#ecbc2a">type, index</span>) - Returns an [[itemLink]] for a selected quest reward/choice/required item for quest currently in gossip window.
  +
: [[API GetQuestMoneyToGet|GetQuestMoneyToGet]]() - Returns amount of money required for quest currently displayed in gossip.
  +
: [[API GetQuestPortraitGiver|GetQuestPortraitGiver]]()
  +
: [[API GetQuestPortraitTurnIn|GetQuestPortraitTurnIn]]()
  +
: [[API GetQuestText|GetQuestText]]() - Gets the description of the current quest.
  +
: [[API GetRewardArtifactXP|GetRewardArtifactXP]]()
  +
: [[API GetRewardHonor|GetRewardHonor]]()
  +
: [[API GetRewardMoney|GetRewardMoney]]() - Returns a amount of copper rewarded for completion of quest displayed in gossip.
  +
: [[API GetRewardNumSkillUps|GetRewardNumSkillUps]]()
  +
: [[API GetRewardSkillLineID|GetRewardSkillLineID]]()
  +
: [[API GetRewardSkillPoints|GetRewardSkillPoints]]()
  +
: [[API GetRewardSpell|GetRewardSpell]]() - Returns name and texture of spell awarded for quest completion for quest currently in gossip window.
  +
: [[API GetRewardText|GetRewardText]]() - Returns quest reward text, displayed by the NPC before the player hits "Complete Quest".
  +
: [[API GetRewardTitle|GetRewardTitle]]() - Returns the title awarded by the currently displayed quest.
  +
: [[API GetRewardXP|GetRewardXP]]() - Returns the amount of experience awarded by the currently displayed text.
  +
: [[API GetTitleText|GetTitleText]]() - Retrieves the title of the quest while talking to the NPC about it.
  +
: [[API IsActiveQuestLegendary|IsActiveQuestLegendary]](<span style="font-size:smaller; color:#ecbc2a">index</span>)
  +
: [[API IsActiveQuestTrivial|IsActiveQuestTrivial]](<span style="font-size:smaller; color:#ecbc2a">index</span>)
  +
: [[API IsAvailableQuestTrivial|IsAvailableQuestTrivial]](<span style="font-size:smaller; color:#ecbc2a">index</span>)
  +
: [[API SelectActiveQuest|SelectActiveQuest]]() - Selects an active quest from the NPC (only available after QUEST_GREETING event).
  +
: [[API SelectAvailableQuest|SelectAvailableQuest]]() - Selects an available quest from the NPC (only available after QUEST_GREETING event).
   
 
==== Quest Choices ====
 
==== Quest Choices ====
Line 3,805: Line 3,794:
 
: [[API C_CampaignInfo.UsesNormalQuestIcons|C_CampaignInfo.UsesNormalQuestIcons]](<span style="font-size:smaller; color:#ecbc2a">campaignID</span>) : <span style="font-size:smaller; color:#4ec9b0">useNormalQuestIcons</span>
 
: [[API C_CampaignInfo.UsesNormalQuestIcons|C_CampaignInfo.UsesNormalQuestIcons]](<span style="font-size:smaller; color:#ecbc2a">campaignID</span>) : <span style="font-size:smaller; color:#4ec9b0">useNormalQuestIcons</span>
 
: [[API C_LoreText.RequestLoreTextForCampaignID|C_LoreText.RequestLoreTextForCampaignID]](<span style="font-size:smaller; color:#ecbc2a">campaignID</span>)
 
: [[API C_LoreText.RequestLoreTextForCampaignID|C_LoreText.RequestLoreTextForCampaignID]](<span style="font-size:smaller; color:#ecbc2a">campaignID</span>)
  +
  +
==== Talking Head ====
  +
These functions were added in [[Patch 7.0.3]]
  +
: [[API C_TalkingHead.GetConversationsDeferred|C_TalkingHead.GetConversationsDeferred]]()
  +
: [[API C_TalkingHead.GetCurrentLineAnimationInfo|C_TalkingHead.GetCurrentLineAnimationInfo]]()
  +
: [[API C_TalkingHead.GetCurrentLineInfo|C_TalkingHead.GetCurrentLineInfo]]()
  +
: [[API C_TalkingHead.IgnoreCurrentTalkingHead|C_TalkingHead.IgnoreCurrentTalkingHead]]()
  +
: [[API C_TalkingHead.IsCurrentTalkingHeadIgnored|C_TalkingHead.IsCurrentTalkingHeadIgnored]]()
  +
: [[API C_TalkingHead.SetConversationsDeferred|C_TalkingHead.SetConversationsDeferred]](<span style="font-size:smaller; color:#ecbc2a">deferred</span>)
   
 
=== Races ===
 
=== Races ===
Line 3,825: Line 3,823:
 
: [[API GetRealmName|GetRealmName]]() - Returns the name of the server a user is logged in to.
 
: [[API GetRealmName|GetRealmName]]() - Returns the name of the server a user is logged in to.
 
: [[API IsOnTournamentRealm|IsOnTournamentRealm]]() - Returns true if currently on a tournament realm, nil otherwise.
 
: [[API IsOnTournamentRealm|IsOnTournamentRealm]]() - Returns true if currently on a tournament realm, nil otherwise.
 
=== Reporting ===
 
: [[API C_ReportSystem.CanReportPlayer|C_ReportSystem.CanReportPlayer]](<span style="font-size:smaller; color:#ecbc2a">playerLocation</span>) : <span style="font-size:smaller; color:#4ec9b0">canReport</span> - Returns if a player can be reported.
 
: [[API C_ReportSystem.CanReportPlayerForLanguage|C_ReportSystem.CanReportPlayerForLanguage]](<span style="font-size:smaller; color:#ecbc2a">playerLocation</span>) : <span style="font-size:smaller; color:#4ec9b0">canReport</span>
 
: <small>SECURE</small> [[API C_ReportSystem.InitiateReportPlayer|C_ReportSystem.InitiateReportPlayer]](<span style="font-size:smaller; color:#ecbc2a">complaintType [, playerLocation]</span>) : <span style="font-size:smaller; color:#4ec9b0">token</span> - Initiates a report against a player.
 
: [[API C_ReportSystem.OpenReportPlayerDialog|C_ReportSystem.OpenReportPlayerDialog]](<span style="font-size:smaller; color:#ecbc2a">reportType, playerName [, playerLocation]</span>) - Opens a dialog for reporting a player.
 
: [[API C_ReportSystem.ReportServerLag|C_ReportSystem.ReportServerLag]]()
 
: [[API C_ReportSystem.ReportStuckInCombat|C_ReportSystem.ReportStuckInCombat]]()
 
: <small>SECURE</small> [[API C_ReportSystem.SendReportPlayer|C_ReportSystem.SendReportPlayer]](<span style="font-size:smaller; color:#ecbc2a">token [, comment]</span>) - Sends an initiated report against a player.
 
: [[API C_ReportSystem.SetPendingReportPetTarget|C_ReportSystem.SetPendingReportPetTarget]](<span style="font-size:smaller; color:#ecbc2a">[target]</span>) : <span style="font-size:smaller; color:#4ec9b0">set</span> - Report a pet for an inappropriate name.
 
: [[API C_ReportSystem.SetPendingReportTarget|C_ReportSystem.SetPendingReportTarget]](<span style="font-size:smaller; color:#ecbc2a">[target]</span>) : <span style="font-size:smaller; color:#4ec9b0">set</span>
 
: [[API C_ReportSystem.SetPendingReportTargetByGuid|C_ReportSystem.SetPendingReportTargetByGuid]](<span style="font-size:smaller; color:#ecbc2a">[guid]</span>) : <span style="font-size:smaller; color:#4ec9b0">set</span>
 
Restrictions
 
: [[API C_SocialRestrictions.IsMuted|C_SocialRestrictions.IsMuted]]() : <span style="font-size:smaller; color:#4ec9b0">isMuted</span>
 
: [[API C_SocialRestrictions.IsSilenced|C_SocialRestrictions.IsSilenced]]() : <span style="font-size:smaller; color:#4ec9b0">isSilenced</span>
 
: [[API C_SocialRestrictions.IsSquelched|C_SocialRestrictions.IsSquelched]]() : <span style="font-size:smaller; color:#4ec9b0">isSquelched</span>
 
   
 
=== Reputation ===
 
=== Reputation ===
Line 3,872: Line 3,854:
 
: [[API AcceptSpellConfirmationPrompt|AcceptSpellConfirmationPrompt]](<span style="font-size:smaller; color:#ecbc2a">spellID</span>)
 
: [[API AcceptSpellConfirmationPrompt|AcceptSpellConfirmationPrompt]](<span style="font-size:smaller; color:#ecbc2a">spellID</span>)
 
: <small>NOCOMBAT</small> [[API CancelSpellByName|CancelSpellByName]](<span style="font-size:smaller; color:#ecbc2a">name</span>)
 
: <small>NOCOMBAT</small> [[API CancelSpellByName|CancelSpellByName]](<span style="font-size:smaller; color:#ecbc2a">name</span>)
: <small>SECURE</small> [[API CastSpellByID|CastSpellByID]](<span style="font-size:smaller; color:#ecbc2a">spellID [, target]</span>)
+
: <small>PROTECTED</small> [[API CastSpellByID|CastSpellByID]](<span style="font-size:smaller; color:#ecbc2a">spellID [, target]</span>)
: <small>SECURE</small> [[API CastSpellByName|CastSpellByName]](<span style="font-size:smaller; color:#ecbc2a">name [, target]</span>) - Cast the specified spell by display name.
+
: <small>PROTECTED</small> [[API CastSpellByName|CastSpellByName]](<span style="font-size:smaller; color:#ecbc2a">name [, target]</span>) - Cast the specified spell by display name.
: <small>SECURE</small> [[API CastSpell|CastSpell]](<span style="font-size:smaller; color:#ecbc2a">spellIndex, bookType</span>) - Cast the spell in the specified spell book slot.
+
: <small>PROTECTED</small> [[API CastSpell|CastSpell]](<span style="font-size:smaller; color:#ecbc2a">spellIndex, bookType</span>) - Cast the spell in the specified spell book slot.
 
: [[API DeclineSpellConfirmationPrompt|DeclineSpellConfirmationPrompt]](<span style="font-size:smaller; color:#ecbc2a">spellID</span>)
 
: [[API DeclineSpellConfirmationPrompt|DeclineSpellConfirmationPrompt]](<span style="font-size:smaller; color:#ecbc2a">spellID</span>)
 
: [[API DoesSpellExist|DoesSpellExist]](<span style="font-size:smaller; color:#ecbc2a">spellName</span>)
 
: [[API DoesSpellExist|DoesSpellExist]](<span style="font-size:smaller; color:#ecbc2a">spellName</span>)
Line 3,918: Line 3,900:
 
: [[API SpellIsSelfBuff|SpellIsSelfBuff]](<span style="font-size:smaller; color:#ecbc2a">spellID</span>)
 
: [[API SpellIsSelfBuff|SpellIsSelfBuff]](<span style="font-size:smaller; color:#ecbc2a">spellID</span>)
 
: [[API SpellIsTargeting|SpellIsTargeting]]() - Returns true if a spell has been cast and is awaiting target selection.
 
: [[API SpellIsTargeting|SpellIsTargeting]]() - Returns true if a spell has been cast and is awaiting target selection.
: <small>SECURE</small> [[API SpellStopCasting|SpellStopCasting]]() - Stops the current spellcast.
+
: <small>PROTECTED</small> [[API SpellStopCasting|SpellStopCasting]]() - Stops the current spellcast.
: <small>SECURE</small> [[API SpellStopTargeting|SpellStopTargeting]]() - Cancels the spell awaiting target selection.
+
: <small>PROTECTED</small> [[API SpellStopTargeting|SpellStopTargeting]]() - Cancels the spell awaiting target selection.
: <small>SECURE</small> [[API SpellTargetUnit|SpellTargetUnit]](<span style="font-size:smaller; color:#ecbc2a">unit</span>) - Casts the spell awaiting target selection on the specified unit.
+
: <small>PROTECTED</small> [[API SpellTargetUnit|SpellTargetUnit]](<span style="font-size:smaller; color:#ecbc2a">unit</span>) - Casts the spell awaiting target selection on the specified unit.
: <small>SECURE</small> [[API SpellTargetItem|SpellTargetItem]](<span style="font-size:smaller; color:#ecbc2a">item</span>)
+
: <small>PROTECTED</small> [[API SpellTargetItem|SpellTargetItem]](<span style="font-size:smaller; color:#ecbc2a">item</span>)
: <small>UI</small> [[API AuraUtil.FindAuraByName|AuraUtil.FindAuraByName]](<span style="font-size:smaller; color:#ecbc2a">auraName, unit, filter</span>) - Finds the first aura that matches the name.
 
 
: <small>UI</small> [[API QueryCastSequence|QueryCastSequence]](<span style="font-size:smaller; color:#ecbc2a">sequence</span>) - Returns index, item, spell for the spell/item that will be used next if the cast sequence is executed.
 
: <small>UI</small> [[API QueryCastSequence|QueryCastSequence]](<span style="font-size:smaller; color:#ecbc2a">sequence</span>) - Returns index, item, spell for the spell/item that will be used next if the cast sequence is executed.
   
Line 3,932: Line 3,913:
 
: [[API GetNumSpellTabs|GetNumSpellTabs]]() - Returns the total number of tabs in the user's spellbook.
 
: [[API GetNumSpellTabs|GetNumSpellTabs]]() - Returns the total number of tabs in the user's spellbook.
 
: [[API GetSpellAvailableLevel|GetSpellAvailableLevel]](<span style="font-size:smaller; color:#ecbc2a">spellSlot</span>)
 
: [[API GetSpellAvailableLevel|GetSpellAvailableLevel]](<span style="font-size:smaller; color:#ecbc2a">spellSlot</span>)
: [[API GetSpellBookItemInfo|GetSpellBookItemInfo]](<span style="font-size:smaller; color:#ecbc2a">spellName [or index, bookType]</span>) - Returns the spell's type and spellID for a spell in the player's spellbook.
+
: [[API GetSpellBookItemInfo|GetSpellBookItemInfo]](<span style="font-size:smaller; color:#ecbc2a">spellName or index, bookType</span>) - Returns the spell's type and spellID for a spell in the player's spellbook.
: [[API GetSpellBookItemName|GetSpellBookItemName]](<span style="font-size:smaller; color:#ecbc2a">spellName [or index, bookType]</span>) - Returns the spell name and spell rank for a spell in the player's spellbook.
+
: [[API GetSpellBookItemName|GetSpellBookItemName]](<span style="font-size:smaller; color:#ecbc2a">spellName or index, bookType</span>) - Returns the spell name and spell rank for a spell in the player's spellbook.
: [[API GetSpellBookItemTexture|GetSpellBookItemTexture]](<span style="font-size:smaller; color:#ecbc2a">spellName [or index, bookType]</span>) - Returns the spell icon fileId for a spell in the player's spellbook.
+
: [[API GetSpellBookItemTexture|GetSpellBookItemTexture]](<span style="font-size:smaller; color:#ecbc2a">spellName or index, bookType</span>) - Returns the spell icon fileId for a spell in the player's spellbook.
 
: [[API GetSpellLevelLearned|GetSpellLevelLearned]]()
 
: [[API GetSpellLevelLearned|GetSpellLevelLearned]]()
 
: [[API GetSpellTabInfo|GetSpellTabInfo]](<span style="font-size:smaller; color:#ecbc2a">spellbookTabNum</span>) - Returns information about the specified spellbook tab.
 
: [[API GetSpellTabInfo|GetSpellTabInfo]](<span style="font-size:smaller; color:#ecbc2a">spellbookTabNum</span>) - Returns information about the specified spellbook tab.
 
: [[API IsSelectedSpellBookItem|IsSelectedSpellBookItem]](<span style="font-size:smaller; color:#ecbc2a">spellSlot</span>)
 
: [[API IsSelectedSpellBookItem|IsSelectedSpellBookItem]](<span style="font-size:smaller; color:#ecbc2a">spellSlot</span>)
   
=== Shop ===
+
=== Store ===
 
The [[In-Game Store]] was added in [[Patch 5.4.0]]
 
The [[In-Game Store]] was added in [[Patch 5.4.0]]
 
: [[API C_StorePublic.DoesGroupHavePurchaseableProducts|C_StorePublic.DoesGroupHavePurchaseableProducts]](<span style="font-size:smaller; color:#ecbc2a">groupID</span>) : <span style="font-size:smaller; color:#4ec9b0">hasPurchaseableProducts</span>
 
: [[API C_StorePublic.DoesGroupHavePurchaseableProducts|C_StorePublic.DoesGroupHavePurchaseableProducts]](<span style="font-size:smaller; color:#ecbc2a">groupID</span>) : <span style="font-size:smaller; color:#4ec9b0">hasPurchaseableProducts</span>
Line 3,945: Line 3,926:
 
: [[API C_StorePublic.IsEnabled|C_StorePublic.IsEnabled]]() : <span style="font-size:smaller; color:#4ec9b0">enabled</span> - Returns whether the In-Game Store is available for the player.
 
: [[API C_StorePublic.IsEnabled|C_StorePublic.IsEnabled]]() : <span style="font-size:smaller; color:#4ec9b0">enabled</span> - Returns whether the In-Game Store is available for the player.
 
[[Character Boost]]s were added in [[Patch 5.4.7]]
 
[[Character Boost]]s were added in [[Patch 5.4.7]]
: <small>SECURE</small> [[API C_CharacterServices.AssignUpgradeDistribution|C_CharacterServices.AssignUpgradeDistribution]]()
+
: <small>PROTECTED</small> [[API C_CharacterServices.AssignUpgradeDistribution|C_CharacterServices.AssignUpgradeDistribution]]()
: <small>SECURE</small> [[API C_CharacterServices.GetActiveCharacterUpgradeBoostType|C_CharacterServices.GetActiveCharacterUpgradeBoostType]]()
+
: <small>PROTECTED</small> [[API C_CharacterServices.GetActiveCharacterUpgradeBoostType|C_CharacterServices.GetActiveCharacterUpgradeBoostType]]()
: <small>SECURE</small> [[API C_CharacterServices.GetActiveClassTrialBoostType|C_CharacterServices.GetActiveClassTrialBoostType]]()
+
: <small>PROTECTED</small> [[API C_CharacterServices.GetActiveClassTrialBoostType|C_CharacterServices.GetActiveClassTrialBoostType]]()
: <small>SECURE</small> [[API C_CharacterServices.GetAutomaticBoost|C_CharacterServices.GetAutomaticBoost]]()
+
: <small>PROTECTED</small> [[API C_CharacterServices.GetAutomaticBoost|C_CharacterServices.GetAutomaticBoost]]()
: <small>SECURE</small> [[API C_CharacterServices.GetAutomaticBoostCharacter|C_CharacterServices.GetAutomaticBoostCharacter]]()
+
: <small>PROTECTED</small> [[API C_CharacterServices.GetAutomaticBoostCharacter|C_CharacterServices.GetAutomaticBoostCharacter]]()
: <small>SECURE</small> [[API C_CharacterServices.GetCharacterServiceDisplayData|C_CharacterServices.GetCharacterServiceDisplayData]]()
+
: <small>PROTECTED</small> [[API C_CharacterServices.GetCharacterServiceDisplayData|C_CharacterServices.GetCharacterServiceDisplayData]]()
: <small>SECURE</small> [[API C_CharacterServices.GetCharacterServiceDisplayOrder|C_CharacterServices.GetCharacterServiceDisplayOrder]]()
+
: <small>PROTECTED</small> [[API C_CharacterServices.GetCharacterServiceDisplayOrder|C_CharacterServices.GetCharacterServiceDisplayOrder]]()
: <small>SECURE</small> [[API C_CharacterServices.HasRequiredBoostForClassTrial|C_CharacterServices.HasRequiredBoostForClassTrial]]()
+
: <small>PROTECTED</small> [[API C_CharacterServices.HasRequiredBoostForClassTrial|C_CharacterServices.HasRequiredBoostForClassTrial]]()
: <small>SECURE</small> [[API C_CharacterServices.HasRequiredBoostForUnrevoke|C_CharacterServices.HasRequiredBoostForUnrevoke]]()
+
: <small>PROTECTED</small> [[API C_CharacterServices.HasRequiredBoostForUnrevoke|C_CharacterServices.HasRequiredBoostForUnrevoke]]()
: <small>SECURE</small> [[API C_CharacterServices.SetAutomaticBoost|C_CharacterServices.SetAutomaticBoost]]()
+
: <small>PROTECTED</small> [[API C_CharacterServices.SetAutomaticBoost|C_CharacterServices.SetAutomaticBoost]]()
: <small>SECURE</small> [[API C_CharacterServices.SetAutomaticBoostCharacter|C_CharacterServices.SetAutomaticBoostCharacter]]()
+
: <small>PROTECTED</small> [[API C_CharacterServices.SetAutomaticBoostCharacter|C_CharacterServices.SetAutomaticBoostCharacter]]()
 
: [[API IsCharacterNewlyBoosted|IsCharacterNewlyBoosted]]()
 
: [[API IsCharacterNewlyBoosted|IsCharacterNewlyBoosted]]()
 
[[Class Trial]]s were added in [[Patch 6.0.2]]
 
[[Class Trial]]s were added in [[Patch 6.0.2]]
Line 3,971: Line 3,952:
 
: [[API C_SharedCharacterServices.SetExpansionTrialPopupSeen|C_SharedCharacterServices.SetExpansionTrialPopupSeen]](<span style="font-size:smaller; color:#ecbc2a">expansion_id</span>)
 
: [[API C_SharedCharacterServices.SetExpansionTrialPopupSeen|C_SharedCharacterServices.SetExpansionTrialPopupSeen]](<span style="font-size:smaller; color:#ecbc2a">expansion_id</span>)
 
: [[API C_SharedCharacterServices.SetPromotionalPopupSeen|C_SharedCharacterServices.SetPromotionalPopupSeen]](<span style="font-size:smaller; color:#ecbc2a">seen</span>)
 
: [[API C_SharedCharacterServices.SetPromotionalPopupSeen|C_SharedCharacterServices.SetPromotionalPopupSeen]](<span style="font-size:smaller; color:#ecbc2a">seen</span>)
 
=== Summoning ===
 
: [[API C_IncomingSummon.HasIncomingSummon|C_IncomingSummon.HasIncomingSummon]](<span style="font-size:smaller; color:#ecbc2a">unit</span>) : <span style="font-size:smaller; color:#4ec9b0">summon</span> - Returns whether a group member has an incoming summon.
 
: [[API C_IncomingSummon.IncomingSummonStatus|C_IncomingSummon.IncomingSummonStatus]](<span style="font-size:smaller; color:#ecbc2a">unit</span>) : <span style="font-size:smaller; color:#4ec9b0">status</span> - Returns the status of an group member's incoming summon.
 
: [[API C_SummonInfo.CancelSummon|C_SummonInfo.CancelSummon]]() - Rejects a summon request.
 
: [[API C_SummonInfo.ConfirmSummon|C_SummonInfo.ConfirmSummon]]() - Accepts a summon request.
 
: [[API C_SummonInfo.GetSummonConfirmAreaName|C_SummonInfo.GetSummonConfirmAreaName]]() : <span style="font-size:smaller; color:#4ec9b0">areaName</span> - Returns the name of the area you're being summoned to.
 
: [[API C_SummonInfo.GetSummonConfirmSummoner|C_SummonInfo.GetSummonConfirmSummoner]]() : <span style="font-size:smaller; color:#4ec9b0">summoner</span> - Returns the name of the player summoning you.
 
: [[API C_SummonInfo.GetSummonConfirmTimeLeft|C_SummonInfo.GetSummonConfirmTimeLeft]]() : <span style="font-size:smaller; color:#4ec9b0">timeLeft</span> - Returns the amount of time left before the pending summon expires.
 
: [[API C_SummonInfo.GetSummonReason|C_SummonInfo.GetSummonReason]]() : <span style="font-size:smaller; color:#4ec9b0">summonReason</span>
 
: [[API C_SummonInfo.IsSummonSkippingStartExperience|C_SummonInfo.IsSummonSkippingStartExperience]]() : <span style="font-size:smaller; color:#4ec9b0">isSummonSkippingStartExperience</span>
 
: [[API PlayerCanTeleport|PlayerCanTeleport]]()
 
   
 
=== System ===
 
=== System ===
Line 3,988: Line 3,957:
 
: [[API C_System.GetFrameStack|C_System.GetFrameStack]]() : <span style="font-size:smaller; color:#4ec9b0">objects</span>
 
: [[API C_System.GetFrameStack|C_System.GetFrameStack]]() : <span style="font-size:smaller; color:#4ec9b0">objects</span>
 
: [[API CancelLogout|CancelLogout]]() - Cancels the logout timer (from camping or quitting).
 
: [[API CancelLogout|CancelLogout]]() - Cancels the logout timer (from camping or quitting).
: <small>SECURE</small> [[API CopyToClipboard|CopyToClipboard]](<span style="font-size:smaller; color:#ecbc2a">text</span>) - Copies text to the clipboard.
+
: <small>PROTECTED</small> [[API CopyToClipboard|CopyToClipboard]](<span style="font-size:smaller; color:#ecbc2a">text</span>) - Copies text to the clipboard.
 
: [[API DetectWowMouse|DetectWowMouse]]() - Attempts to detect the world of warcraft MMO mouse.
 
: [[API DetectWowMouse|DetectWowMouse]]() - Attempts to detect the world of warcraft MMO mouse.
 
: [[API FlashClientIcon|FlashClientIcon]]() - Flashes the game client icon in the Operating System.
 
: [[API FlashClientIcon|FlashClientIcon]]() - Flashes the game client icon in the Operating System.
: <small>SECURE</small> [[API ForceLogout|ForceLogout]]()
+
: <small>PROTECTED</small> [[API ForceLogout|ForceLogout]]()
: <small>SECURE</small> [[API ForceQuit|ForceQuit]]() - Instantly quits the game, bypassing the timer.
+
: <small>PROTECTED</small> [[API ForceQuit|ForceQuit]]() - Instantly quits the game, bypassing the timer.
 
: [[API GetBuildInfo|GetBuildInfo]]() - Returns information about current client build.
 
: [[API GetBuildInfo|GetBuildInfo]]() - Returns information about current client build.
 
: [[API GetFramerate|GetFramerate]]() - Returns the current framerate (full precision)
 
: [[API GetFramerate|GetFramerate]]() - Returns the current framerate (full precision)
Line 4,005: Line 3,974:
 
: [[API IsPublicBuild|IsPublicBuild]]()
 
: [[API IsPublicBuild|IsPublicBuild]]()
 
: [[API IsTestBuild|IsTestBuild]]()
 
: [[API IsTestBuild|IsTestBuild]]()
  +
: [[API IsUsingFixedTimeStep|IsUsingFixedTimeStep]]() - Whether the UI is updating at a fixed rate independent of the framerate.
 
: [[API IsWindowsClient|IsWindowsClient]]() - Returns true if WoW is being run on Windows.
 
: [[API IsWindowsClient|IsWindowsClient]]() - Returns true if WoW is being run on Windows.
 
: [[API LoadURLIndex|LoadURLIndex]](<span style="font-size:smaller; color:#ecbc2a">index</span>)
 
: [[API LoadURLIndex|LoadURLIndex]](<span style="font-size:smaller; color:#ecbc2a">index</span>)
: <small>SECURE</small> [[API Logout|Logout]]() - Logs the user out of the game.
+
: <small>PROTECTED</small> [[API Logout|Logout]]() - Logs the user out of the game.
 
: [[API ProcessExceptionClient|ProcessExceptionClient]]()
 
: [[API ProcessExceptionClient|ProcessExceptionClient]]()
: <small>SECURE</small> [[API Quit|Quit]]() - Quits the game.
+
: <small>PROTECTED</small> [[API Quit|Quit]]() - Quits the game.
 
: [[API Screenshot|Screenshot]]() - Takes a screenshot.
 
: [[API Screenshot|Screenshot]]() - Takes a screenshot.
 
: [[API SendSystemMessage|SendSystemMessage]](<span style="font-size:smaller; color:#ecbc2a">message</span>) - Fires a CHAT_MSG_SYSTEM event for yourself.
 
: [[API SendSystemMessage|SendSystemMessage]](<span style="font-size:smaller; color:#ecbc2a">message</span>) - Fires a CHAT_MSG_SYSTEM event for yourself.
: <small>SECURE</small> [[API Stuck|Stuck]]() - Informs the game engine that the player is Stuck.
+
: <small>PROTECTED</small> [[API Stuck|Stuck]]() - Informs the game engine that the player is Stuck.
 
: <small>UI</small> [[API ToggleFramerate|ToggleFramerate]]() - Show/Hide the FPS.
 
: <small>UI</small> [[API ToggleFramerate|ToggleFramerate]]() - Show/Hide the FPS.
   
Line 4,057: Line 4,027:
 
: [[API GetSessionTime|GetSessionTime]]() - Returns the time since you opened the game client.
 
: [[API GetSessionTime|GetSessionTime]]() - Returns the time since you opened the game client.
 
: [[API GetTime|GetTime]]() - Returns the system uptime in seconds (millisecond precision).
 
: [[API GetTime|GetTime]]() - Returns the system uptime in seconds (millisecond precision).
: [[API GetTimePreciseSec|GetTimePreciseSec]]()
+
: [[API GetTimePreciseSec|GetTimePreciseSec]]() - Returns a monotonic timestamp in seconds, with millisecond precision.
 
: [[API RequestTimePlayed|RequestTimePlayed]]() - Request a summary of time played from the server.
 
: [[API RequestTimePlayed|RequestTimePlayed]]() - Request a summary of time played from the server.
: <small>UI</small> [[API SecondsToTime|SecondsToTime]](<span style="font-size:smaller; color:#ecbc2a">seconds [, noSeconds, notAbbreviated, maxCount, roundUp]</span>) - Converts a number of seconds into a readable formatted string.
 
: <small>UI</small> [[API SecondsToTimeAbbrev|SecondsToTimeAbbrev]](<span style="font-size:smaller; color:#ecbc2a">seconds</span>) - Converts a number of seconds into a readable and abbreviated formatted string.
 
 
 
: <small>Lua</small> [[API date|date]](<span style="font-size:smaller; color:#ecbc2a">format, time</span>) - Returns the current date according to the user's machine.
 
: <small>Lua</small> [[API date|date]](<span style="font-size:smaller; color:#ecbc2a">format, time</span>) - Returns the current date according to the user's machine.
 
: <small>Lua</small> [[API time|time]](<span style="font-size:smaller; color:#ecbc2a">table</span>) - Returns a timestamp for the specified time or the current Unix time.
 
: <small>Lua</small> [[API time|time]](<span style="font-size:smaller; color:#ecbc2a">table</span>) - Returns a timestamp for the specified time or the current Unix time.
Line 4,089: Line 4,056:
 
: [[API debugstack|debugstack]](<span style="font-size:smaller; color:#ecbc2a">start, count1, count2</span>) - Returns a string representation of the current calling stack.
 
: [[API debugstack|debugstack]](<span style="font-size:smaller; color:#ecbc2a">start, count1, count2</span>) - Returns a string representation of the current calling stack.
 
: [[API geterrorhandler|geterrorhandler]]() - Returns the currently set error handler.
 
: [[API geterrorhandler|geterrorhandler]]() - Returns the currently set error handler.
: [[API seterrorhandler|seterrorhandler]](<span style="font-size:smaller; color:#ecbc2a">function</span>) - Set the error handler to the given parameter.
+
: [[API seterrorhandler|seterrorhandler]](<span style="font-size:smaller; color:#ecbc2a">errFunc</span>) - Set the error handler to the given parameter.
 
: <small>UI</small> [https://www.townlong-yak.com/framexml/go/DevTools_Dump DevTools_Dump](<span style="font-size:smaller; color:#ecbc2a">value</span>) - Pretty prints a variable or value.
 
: <small>UI</small> [https://www.townlong-yak.com/framexml/go/DevTools_Dump DevTools_Dump](<span style="font-size:smaller; color:#ecbc2a">value</span>) - Pretty prints a variable or value.
 
: <small>UI</small> [[API print|print]](<span style="font-size:smaller; color:#ecbc2a">...</span>) - Calls the current print output handler with the provided values; by default printing the values to the default chat frame.
 
: <small>UI</small> [[API print|print]](<span style="font-size:smaller; color:#ecbc2a">...</span>) - Calls the current print output handler with the provided values; by default printing the values to the default chat frame.
Line 4,095: Line 4,062:
 
: <small>UI</small> [[API setprinthandler|setprinthandler]](<span style="font-size:smaller; color:#ecbc2a">func</span>) - Changes the function handling print() output.
 
: <small>UI</small> [[API setprinthandler|setprinthandler]](<span style="font-size:smaller; color:#ecbc2a">func</span>) - Changes the function handling print() output.
 
: <small>UI</small> [[API message|message]](<span style="font-size:smaller; color:#ecbc2a">text</span>) - Displays a message box with your text message and an "Okay" button.
 
: <small>UI</small> [[API message|message]](<span style="font-size:smaller; color:#ecbc2a">text</span>) - Displays a message box with your text message and an "Okay" button.
: <small>SECURE</small> [[API C_Debug.DashboardIsEnabled|C_Debug.DashboardIsEnabled]]()
+
: <small>PROTECTED</small> [[API C_Debug.DashboardIsEnabled|C_Debug.DashboardIsEnabled]]()
: <small>SECURE</small> [[API C_Debug.GetAllPortLocsForMap|C_Debug.GetAllPortLocsForMap]](<span style="font-size:smaller; color:#ecbc2a">uiMapID</span>)
+
: <small>PROTECTED</small> [[API C_Debug.GetAllPortLocsForMap|C_Debug.GetAllPortLocsForMap]](<span style="font-size:smaller; color:#ecbc2a">uiMapID</span>)
: <small>SECURE</small> [[API C_Debug.GetMapDebugObjects|C_Debug.GetMapDebugObjects]](<span style="font-size:smaller; color:#ecbc2a">uiMapID</span>)
+
: <small>PROTECTED</small> [[API C_Debug.GetMapDebugObjects|C_Debug.GetMapDebugObjects]](<span style="font-size:smaller; color:#ecbc2a">uiMapID</span>)
: <small>SECURE</small> [[API C_Debug.TeleportToMapDebugObject|C_Debug.TeleportToMapDebugObject]](<span style="font-size:smaller; color:#ecbc2a">pinIndex</span>)
+
: <small>PROTECTED</small> [[API C_Debug.TeleportToMapDebugObject|C_Debug.TeleportToMapDebugObject]](<span style="font-size:smaller; color:#ecbc2a">pinIndex</span>)
: <small>SECURE</small> [[API C_Debug.TeleportToMapLocation|C_Debug.TeleportToMapLocation]](<span style="font-size:smaller; color:#ecbc2a">uiMapID, mapX, mapY</span>)
+
: <small>PROTECTED</small> [[API C_Debug.TeleportToMapLocation|C_Debug.TeleportToMapLocation]](<span style="font-size:smaller; color:#ecbc2a">uiMapID, mapX, mapY</span>)
   
 
==== Graphics ====
 
==== Graphics ====
: [[API AntiAliasingSupported|AntiAliasingSupported]]()
 
: [[API AutoChooseCurrentGraphicsSetting|AutoChooseCurrentGraphicsSetting]]()
 
 
: [[API C_ScriptedAnimations.GetAllScriptedAnimationEffects|C_ScriptedAnimations.GetAllScriptedAnimationEffects]]() : <span style="font-size:smaller; color:#4ec9b0">scriptedAnimationEffects</span>
 
: [[API C_ScriptedAnimations.GetAllScriptedAnimationEffects|C_ScriptedAnimations.GetAllScriptedAnimationEffects]]() : <span style="font-size:smaller; color:#4ec9b0">scriptedAnimationEffects</span>
 
: [[API C_VideoOptions.GetGxAdapterInfo|C_VideoOptions.GetGxAdapterInfo]]() : <span style="font-size:smaller; color:#4ec9b0">adapters</span> - Returns info about the system's graphics adapter.
 
: [[API C_VideoOptions.GetGxAdapterInfo|C_VideoOptions.GetGxAdapterInfo]]() : <span style="font-size:smaller; color:#4ec9b0">adapters</span> - Returns info about the system's graphics adapter.
  +
: [[API AntiAliasingSupported|AntiAliasingSupported]]()
  +
: [[API AutoChooseCurrentGraphicsSetting|AutoChooseCurrentGraphicsSetting]]()
 
: [[API GetCurrentGraphicsSetting|GetCurrentGraphicsSetting]]()
 
: [[API GetCurrentGraphicsSetting|GetCurrentGraphicsSetting]]()
 
: [[API GetCurrentResolution|GetCurrentResolution]]() - Get the index of the current screen resolution.
 
: [[API GetCurrentResolution|GetCurrentResolution]]() - Get the index of the current screen resolution.
Line 4,136: Line 4,103:
 
: [[API SetDefaultVideoOptions|SetDefaultVideoOptions]](<span style="font-size:smaller; color:#ecbc2a">value</span>)
 
: [[API SetDefaultVideoOptions|SetDefaultVideoOptions]](<span style="font-size:smaller; color:#ecbc2a">value</span>)
 
: [[API SetScreenResolution|SetScreenResolution]](<span style="font-size:smaller; color:#ecbc2a">width, height, fullscreen</span>)
 
: [[API SetScreenResolution|SetScreenResolution]](<span style="font-size:smaller; color:#ecbc2a">width, height, fullscreen</span>)
: [[API SetSelectedScreenResolutionIndex|SetSelectedScreenResolutionIndex]](<span style="font-size:smaller; color:#ecbc2a">integer index</span>)
+
: [[API SetSelectedScreenResolutionIndex|SetSelectedScreenResolutionIndex]](<span style="font-size:smaller; color:#ecbc2a">integerIndex</span>)
 
: [[API SupportsClipCursor|SupportsClipCursor]]()
 
: [[API SupportsClipCursor|SupportsClipCursor]]()
 
: [[API ToggleSelfHighlight|ToggleSelfHighlight]]()
 
: [[API ToggleSelfHighlight|ToggleSelfHighlight]]()
Line 4,143: Line 4,110:
   
 
==== Locales ====
 
==== Locales ====
  +
: [[API BreakUpLargeNumbers|BreakUpLargeNumbers]](<span style="font-size:smaller; color:#ecbc2a">number [, natural]</span>) - Converts a number into a localized string, grouping digits as required.
 
: [[API DeclineName|DeclineName]](<span style="font-size:smaller; color:#ecbc2a">name, gender, declensionSet</span>) - Returns suggested declensions for a German or Russian name.
 
: [[API DeclineName|DeclineName]](<span style="font-size:smaller; color:#ecbc2a">name, gender, declensionSet</span>) - Returns suggested declensions for a German or Russian name.
: [[API GetAvailableLocales|GetAvailableLocales]]()
 
 
: [[API GetAvailableLocaleInfo|GetAvailableLocaleInfo]](<span style="font-size:smaller; color:#ecbc2a">ignoreLocaleRestrictions</span>)
 
: [[API GetAvailableLocaleInfo|GetAvailableLocaleInfo]](<span style="font-size:smaller; color:#ecbc2a">ignoreLocaleRestrictions</span>)
  +
: [[API GetAvailableLocales|GetAvailableLocales]]()
 
: [[API GetLocale|GetLocale]]() - Returns client locale, example 'enUS'.
 
: [[API GetLocale|GetLocale]]() - Returns client locale, example 'enUS'.
 
: [[API GetNumDeclensionSets|GetNumDeclensionSets]](<span style="font-size:smaller; color:#ecbc2a">name, gender</span>) - Returns the number of suggested declension sets for a German or Russian name.
 
: [[API GetNumDeclensionSets|GetNumDeclensionSets]](<span style="font-size:smaller; color:#ecbc2a">name, gender</span>) - Returns the number of suggested declension sets for a German or Russian name.
Line 4,159: Line 4,127:
 
: [[API GetEventCPUUsage|GetEventCPUUsage]](<span style="font-size:smaller; color:#ecbc2a">[event]</span>) - Returns the time used and number of times the specified event has been triggered. If 'event' is omitted, the time and count will be totals across all events.
 
: [[API GetEventCPUUsage|GetEventCPUUsage]](<span style="font-size:smaller; color:#ecbc2a">[event]</span>) - Returns the time used and number of times the specified event has been triggered. If 'event' is omitted, the time and count will be totals across all events.
 
: [[API GetFrameCPUUsage|GetFrameCPUUsage]](<span style="font-size:smaller; color:#ecbc2a">frame [, includeChildren]</span>) - Returns the time used and number of function calls of any of the frame's script handlers. If 'includeChildren' is true or omitted, the time and call count will include the handlers for all of the frame's children as well.
 
: [[API GetFrameCPUUsage|GetFrameCPUUsage]](<span style="font-size:smaller; color:#ecbc2a">frame [, includeChildren]</span>) - Returns the time used and number of function calls of any of the frame's script handlers. If 'includeChildren' is true or omitted, the time and call count will include the handlers for all of the frame's children as well.
: [[API GetFunctionCPUUsage|GetFunctionCPUUsage]](<span style="font-size:smaller; color:#ecbc2a">function [, includeSubroutines]</span>) - Returns the time used and number of times the specified function was called. If 'includeSubroutines' is true or omitted, the time includes both the time spent in the function and subroutines called by the function. If it is false, then time is only the time actually spent by the code in the function itself.
+
: [[API GetFunctionCPUUsage|GetFunctionCPUUsage]](<span style="font-size:smaller; color:#ecbc2a">func [, includeSubroutines]</span>) - Returns the time used and number of times the specified function was called. If 'includeSubroutines' is true or omitted, the time includes both the time spent in the function and subroutines called by the function. If it is false, then time is only the time actually spent by the code in the function itself.
 
: [[API GetScriptCPUUsage|GetScriptCPUUsage]]() - Returns the total time used by the scripting system.
 
: [[API GetScriptCPUUsage|GetScriptCPUUsage]]() - Returns the total time used by the scripting system.
 
: [[API ResetCPUUsage|ResetCPUUsage]]() - Reset all CPU profiling statistics to zero.
 
: [[API ResetCPUUsage|ResetCPUUsage]]() - Reset all CPU profiling statistics to zero.
Line 4,170: Line 4,138:
 
: [[API StoreSecureReference|StoreSecureReference]](<span style="font-size:smaller; color:#ecbc2a">name, obj</span>)
 
: [[API StoreSecureReference|StoreSecureReference]](<span style="font-size:smaller; color:#ecbc2a">name, obj</span>)
 
: [[API forceinsecure|forceinsecure]]() - Taint the current execution path.
 
: [[API forceinsecure|forceinsecure]]() - Taint the current execution path.
: [[API hooksecurefunc|hooksecurefunc]](<span style="font-size:smaller; color:#ecbc2a">[table,] functionName, hookfunc</span>) - Creates a secure 'post hook' for the named function. The hookfunc is invoked after the original function, and receives the same parameters. Return values from hookfunc are discarded. This is the only safe way to hook functions that execute protected functionality.
+
: [[API hooksecurefunc|hooksecurefunc]](<span style="font-size:smaller; color:#ecbc2a">[table,] funcName, hookfunc</span>) - Creates a secure 'post hook' for the named function. The hookfunc is invoked after the original function, and receives the same parameters. Return values from hookfunc are discarded. This is the only safe way to hook functions that execute protected functionality.
 
: [[API issecure|issecure]]() - Determine if the current environment is secure.
 
: [[API issecure|issecure]]() - Determine if the current environment is secure.
 
: [[API issecurevariable|issecurevariable]](<span style="font-size:smaller; color:#ecbc2a">[table,] name</span>) - Determine if the specified variable is secure.
 
: [[API issecurevariable|issecurevariable]](<span style="font-size:smaller; color:#ecbc2a">[table,] name</span>) - Determine if the specified variable is secure.
Line 4,197: Line 4,165:
 
: [[API Sound_GameSystem_RestartSoundSystem|Sound_GameSystem_RestartSoundSystem]]()
 
: [[API Sound_GameSystem_RestartSoundSystem|Sound_GameSystem_RestartSoundSystem]]()
   
=== Talking Head ===
+
==== Util ====
  +
: [[API CalculateStringEditDistance|CalculateStringEditDistance]](<span style="font-size:smaller; color:#ecbc2a">firstString, secondString</span>) - Returns [https://en.wikipedia.org/wiki/Levenshtein_distance Levenshtein] distance.
These functions were added in [[Patch 7.0.3]]
 
  +
: [[API CaseAccentInsensitiveParse|CaseAccentInsensitiveParse]](<span style="font-size:smaller; color:#ecbc2a">string</span>)
: [[API C_TalkingHead.GetConversationsDeferred|C_TalkingHead.GetConversationsDeferred]]()
 
: [[API C_TalkingHead.GetCurrentLineAnimationInfo|C_TalkingHead.GetCurrentLineAnimationInfo]]()
 
: [[API C_TalkingHead.GetCurrentLineInfo|C_TalkingHead.GetCurrentLineInfo]]()
 
: [[API C_TalkingHead.IgnoreCurrentTalkingHead|C_TalkingHead.IgnoreCurrentTalkingHead]]()
 
: [[API C_TalkingHead.IsCurrentTalkingHeadIgnored|C_TalkingHead.IsCurrentTalkingHeadIgnored]]()
 
: [[API C_TalkingHead.SetConversationsDeferred|C_TalkingHead.SetConversationsDeferred]](<span style="font-size:smaller; color:#ecbc2a">deferred</span>)
 
   
=== Trading ===
+
=== Spectator Mode ===
  +
: [[API C_Commentator.AddPlayerOverrideName|C_Commentator.AddPlayerOverrideName]](<span style="font-size:smaller; color:#ecbc2a">playerName, overrideName</span>)
Relates to [[Trade|Trading]].
 
  +
: [[API C_Commentator.AddTrackedDefensiveAuras|C_Commentator.AddTrackedDefensiveAuras]](<span style="font-size:smaller; color:#ecbc2a">spellIDs</span>)
: <small>HW</small> [[API AcceptTrade|AcceptTrade]]() - A pending trade will be accepted.
 
  +
: [[API C_Commentator.AddTrackedOffensiveAuras|C_Commentator.AddTrackedOffensiveAuras]](<span style="font-size:smaller; color:#ecbc2a">spellIDs</span>)
: [[API AddTradeMoney|AddTradeMoney]]() - Adds the money dropped into the player's trade frame.
 
  +
: [[API C_Commentator.AreTeamsSwapped|C_Commentator.AreTeamsSwapped]]() : <span style="font-size:smaller; color:#4ec9b0">teamsAreSwapped</span>
: [[API BeginTrade|BeginTrade]]()
 
  +
: [[API C_Commentator.AssignPlayersToTeam|C_Commentator.AssignPlayersToTeam]](<span style="font-size:smaller; color:#ecbc2a">playerName, teamName</span>)
: [[API CancelTrade|CancelTrade]]() - Declines the offer to trade with the other player.
 
  +
: [[API C_Commentator.AssignPlayersToTeamInCurrentInstance|C_Commentator.AssignPlayersToTeamInCurrentInstance]](<span style="font-size:smaller; color:#ecbc2a">teamIndex, teamName</span>)
: [[API CancelTradeAccept|CancelTradeAccept]]() - Cancels the trade attempt which required an accept.
 
: [[API ClickTargetTradeButton|ClickTargetTradeButton]](<span style="font-size:smaller; color:#ecbc2a">index</span>)
+
: [[API C_Commentator.AssignPlayerToTeam|C_Commentator.AssignPlayerToTeam]](<span style="font-size:smaller; color:#ecbc2a">playerName, teamName</span>)
: [[API ClickTradeButton|ClickTradeButton]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Equivalent of a mouseclick on the trade window buttons [1-7].
+
: [[API C_Commentator.CanUseCommentatorCheats|C_Commentator.CanUseCommentatorCheats]]() : <span style="font-size:smaller; color:#4ec9b0">canUseCommentatorCheats</span>
  +
: [[API C_Commentator.ClearCameraTarget|C_Commentator.ClearCameraTarget]]()
: [[API CloseTrade|CloseTrade]]() - Closes the trade.
 
  +
: [[API C_Commentator.ClearFollowTarget|C_Commentator.ClearFollowTarget]]()
: [[API GetPlayerTradeMoney|GetPlayerTradeMoney]]() - Returns the amount of money the player has in the trade window.
 
  +
: [[API C_Commentator.ClearLookAtTarget|C_Commentator.ClearLookAtTarget]](<span style="font-size:smaller; color:#ecbc2a">[lookAtIndex]</span>)
: [[API GetTargetTradeMoney|GetTargetTradeMoney]]() - Returns the amount of money in the trade frame of the target player.
 
  +
: [[API C_Commentator.EnterInstance|C_Commentator.EnterInstance]]()
: [[API GetTradePlayerItemInfo|GetTradePlayerItemInfo]](<span style="font-size:smaller; color:#ecbc2a">id</span>) - Returns information about a trade item.
 
  +
: [[API C_Commentator.ExitInstance|C_Commentator.ExitInstance]]()
: [[API GetTradePlayerItemLink|GetTradePlayerItemLink]](<span style="font-size:smaller; color:#ecbc2a">id</span>) - Returns an [[itemLink]] for the given item in your side of the trade window (if open)
 
: [[API GetTradeTargetItemInfo|GetTradeTargetItemInfo]](<span style="font-size:smaller; color:#ecbc2a">id</span>) - Returns information about a trade item.
+
: [[API C_Commentator.FindSpectatedUnit|C_Commentator.FindSpectatedUnit]](<span style="font-size:smaller; color:#ecbc2a">unitToken</span>) : <span style="font-size:smaller; color:#4ec9b0">playerIndex, teamIndex, isPet</span>
: [[API GetTradeTargetItemLink|GetTradeTargetItemLink]](<span style="font-size:smaller; color:#ecbc2a">id</span>) - Returns an [[itemLink]] for the given item in the other player's side of the trade window (if open)
+
: [[API C_Commentator.FindTeamNameInCurrentInstance|C_Commentator.FindTeamNameInCurrentInstance]](<span style="font-size:smaller; color:#ecbc2a">teamIndex</span>) : <span style="font-size:smaller; color:#4ec9b0">teamName</span>
: [[API InitiateTrade|InitiateTrade]](<span style="font-size:smaller; color:#ecbc2a">UnitId</span>) - Asks the specified unit to trade.
+
: [[API C_Commentator.FindTeamNameInDirectory|C_Commentator.FindTeamNameInDirectory]](<span style="font-size:smaller; color:#ecbc2a">playerNames</span>) : <span style="font-size:smaller; color:#4ec9b0">teamName</span>
  +
: [[API C_Commentator.FlushCommentatorHistory|C_Commentator.FlushCommentatorHistory]]()
: [[API SetTradeMoney|SetTradeMoney]](<span style="font-size:smaller; color:#ecbc2a">copper</span>) - Sets the amount of money offered as part of the player's trade offer.
 
  +
: [[API C_Commentator.FollowPlayer|C_Commentator.FollowPlayer]](<span style="font-size:smaller; color:#ecbc2a">factionIndex, playerIndex [, forceInstantTransition]</span>)
 
  +
: [[API C_Commentator.FollowUnit|C_Commentator.FollowUnit]](<span style="font-size:smaller; color:#ecbc2a">token</span>)
=== Trainer ===
 
  +
: [[API C_Commentator.ForceFollowTransition|C_Commentator.ForceFollowTransition]]()
Relates to [[Trainer]]s.
 
: [[API BuyTrainerService|BuyTrainerService]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Used for buying new/upgrading professions, profession items and class skills.
+
: [[API C_Commentator.GetAdditionalCameraWeight|C_Commentator.GetAdditionalCameraWeight]]() : <span style="font-size:smaller; color:#4ec9b0">teamIndex, playerIndex</span>
  +
: [[API C_Commentator.GetAdditionalCameraWeightByToken|C_Commentator.GetAdditionalCameraWeightByToken]](<span style="font-size:smaller; color:#ecbc2a">unitToken</span>) : <span style="font-size:smaller; color:#4ec9b0">weight</span>
: [[API CloseTrainer|CloseTrainer]]() - Closes the trainer window.
 
  +
: [[API C_Commentator.GetAllPlayerOverrideNames|C_Commentator.GetAllPlayerOverrideNames]]() : <span style="font-size:smaller; color:#4ec9b0">nameEntries</span>
: [[API GetNumTrainerServices|GetNumTrainerServices]]() - Get the number of the trainer services.
 
  +
: [[API C_Commentator.GetCamera|C_Commentator.GetCamera]]() : <span style="font-size:smaller; color:#4ec9b0">xPos, yPos, zPos, yaw, pitch, roll, fov</span>
: [[API GetTrainerGreetingText|GetTrainerGreetingText]]() - Get the trainer's greeting text.
 
  +
: [[API C_Commentator.GetCameraCollision|C_Commentator.GetCameraCollision]]() : <span style="font-size:smaller; color:#4ec9b0">isColliding</span>
: [[API GetTrainerSelectionIndex|GetTrainerSelectionIndex]]() - Get the index of the selected trainer service.
 
: [[API GetTrainerServiceAbilityReq|GetTrainerServiceAbilityReq]](<span style="font-size:smaller; color:#ecbc2a">trainerIndex, reqIndex</span>) - Used for displaying the requirements to learn a new profession, profession skill or class skill.
+
: [[API C_Commentator.GetCameraPosition|C_Commentator.GetCameraPosition]]() : <span style="font-size:smaller; color:#4ec9b0">xPos, yPos, zPos</span>
: [[API GetTrainerServiceCost|GetTrainerServiceCost]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Returns the cost of a specific trainer service.
+
: [[API C_Commentator.GetCommentatorHistory|C_Commentator.GetCommentatorHistory]]() : <span style="font-size:smaller; color:#4ec9b0">history</span>
: [[API GetTrainerServiceDescription|GetTrainerServiceDescription]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Returns the description of a specific trainer service.
+
: [[API C_Commentator.GetCurrentMapID|C_Commentator.GetCurrentMapID]]() : <span style="font-size:smaller; color:#4ec9b0">mapID</span>
: [[API GetTrainerServiceIcon|GetTrainerServiceIcon]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Returns icon texture for a trainer service.
+
: [[API C_Commentator.GetDampeningPercent|C_Commentator.GetDampeningPercent]]() : <span style="font-size:smaller; color:#4ec9b0">percentage</span>
: [[API GetTrainerServiceInfo|GetTrainerServiceInfo]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Returns information about a trainer service.
+
: [[API C_Commentator.GetDistanceBeforeForcedHorizontalConvergence|C_Commentator.GetDistanceBeforeForcedHorizontalConvergence]]() : <span style="font-size:smaller; color:#4ec9b0">distance</span>
: [[API GetTrainerServiceItemLink|GetTrainerServiceItemLink]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Returns an item link for a trainer service.
+
: [[API C_Commentator.GetDurationToForceHorizontalConvergence|C_Commentator.GetDurationToForceHorizontalConvergence]]() : <span style="font-size:smaller; color:#4ec9b0">ms</span>
: [[API GetTrainerServiceLevelReq|GetTrainerServiceLevelReq]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Get the required level to learn the skill.
+
: [[API C_Commentator.GetExcludeDistance|C_Commentator.GetExcludeDistance]]() : <span style="font-size:smaller; color:#4ec9b0">excludeDistance</span>
  +
: [[API C_Commentator.GetHardlockWeight|C_Commentator.GetHardlockWeight]]() : <span style="font-size:smaller; color:#4ec9b0">weight</span>
: [[API GetTrainerServiceNumAbilityReq|GetTrainerServiceNumAbilityReq]]() - Get the maximum number of requirements that [[API GetTrainerServiceAbilityReq|GetTrainerServiceAbilityReq]] has.
 
: [[API GetTrainerServiceSkillLine|GetTrainerServiceSkillLine]](<span style="font-size:smaller; color:#ecbc2a">index</span>)
+
: [[API C_Commentator.GetHorizontalAngleThresholdToSmooth|C_Commentator.GetHorizontalAngleThresholdToSmooth]]() : <span style="font-size:smaller; color:#4ec9b0">angle</span>
: [[API GetTrainerServiceSkillReq|GetTrainerServiceSkillReq]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Returns a String and Variable for the requirements of a specific trainer service.
+
: [[API C_Commentator.GetIndirectSpellID|C_Commentator.GetIndirectSpellID]](<span style="font-size:smaller; color:#ecbc2a">trackedSpellID</span>) : <span style="font-size:smaller; color:#4ec9b0">indirectSpellID</span>
  +
: [[API C_Commentator.GetInstanceInfo|C_Commentator.GetInstanceInfo]](<span style="font-size:smaller; color:#ecbc2a">mapIndex, instanceIndex</span>) : <span style="font-size:smaller; color:#4ec9b0">mapID, mapName, status, instanceIDLow, instanceIDHigh</span>
: [[API GetTrainerServiceStepIndex|GetTrainerServiceStepIndex]]()
 
: [[API GetTrainerServiceTypeFilter|GetTrainerServiceTypeFilter]](<span style="font-size:smaller; color:#ecbc2a">filter</span>) - Returns the status of a skill filter in the trainer window.
+
: [[API C_Commentator.GetLookAtLerpAmount|C_Commentator.GetLookAtLerpAmount]]() : <span style="font-size:smaller; color:#4ec9b0">amount</span>
  +
: [[API C_Commentator.GetMapInfo|C_Commentator.GetMapInfo]](<span style="font-size:smaller; color:#ecbc2a">mapIndex</span>) : <span style="font-size:smaller; color:#4ec9b0">teamSize, minLevel, maxLevel, numInstances</span>
: [[API GetTrainerTradeskillRankValues|GetTrainerTradeskillRankValues]]()
 
  +
: [[API C_Commentator.GetMatchDuration|C_Commentator.GetMatchDuration]]() : <span style="font-size:smaller; color:#4ec9b0">seconds</span>
: [[API IsTradeskillTrainer|IsTradeskillTrainer]]() - Returns 1 if trainer is for a tradeskill.
 
  +
: [[API C_Commentator.GetMaxNumPlayersPerTeam|C_Commentator.GetMaxNumPlayersPerTeam]]() : <span style="font-size:smaller; color:#4ec9b0">maxNumPlayersPerTeam</span>
: [[API OpenTrainer|OpenTrainer]]()
 
  +
: [[API C_Commentator.GetMaxNumTeams|C_Commentator.GetMaxNumTeams]]() : <span style="font-size:smaller; color:#4ec9b0">maxNumTeams</span>
: [[API SelectTrainerService|SelectTrainerService]]()
 
: [[API SetTrainerServiceTypeFilter|SetTrainerServiceTypeFilter]](<span style="font-size:smaller; color:#ecbc2a">filter, state</span>) - Sets the status of a skill filter in the trainer window.
+
: [[API C_Commentator.GetMode|C_Commentator.GetMode]]() : <span style="font-size:smaller; color:#4ec9b0">commentatorMode</span>
  +
: [[API C_Commentator.GetMsToHoldForHorizontalMovement|C_Commentator.GetMsToHoldForHorizontalMovement]]() : <span style="font-size:smaller; color:#4ec9b0">ms</span>
 
  +
: [[API C_Commentator.GetMsToHoldForVerticalMovement|C_Commentator.GetMsToHoldForVerticalMovement]]() : <span style="font-size:smaller; color:#4ec9b0">ms</span>
=== Transmogrification ===
 
  +
: [[API C_Commentator.GetMsToSmoothHorizontalChange|C_Commentator.GetMsToSmoothHorizontalChange]]() : <span style="font-size:smaller; color:#4ec9b0">ms</span>
[[Transmogrification]] was added in [[Patch 4.3.0]]. See also [[#Appearances|Appearances]] functions.
 
  +
: [[API C_Commentator.GetMsToSmoothVerticalChange|C_Commentator.GetMsToSmoothVerticalChange]]() : <span style="font-size:smaller; color:#4ec9b0">ms</span>
: [[API C_Transmog.ApplyAllPending|C_Transmog.ApplyAllPending]]() - Applies all pending transmogrifications, and pays for the cost.
 
: [[API C_Transmog.CanTransmogItemWithItem|C_Transmog.CanTransmogItemWithItem]](<span style="font-size:smaller; color:#ecbc2a">targetItemLink, sourceItemLink</span>) - Returns whether an item can be transmogrified to look like another item.
+
: [[API C_Commentator.GetNumMaps|C_Commentator.GetNumMaps]]() : <span style="font-size:smaller; color:#4ec9b0">numMaps</span>
  +
: [[API C_Commentator.GetNumPlayers|C_Commentator.GetNumPlayers]](<span style="font-size:smaller; color:#ecbc2a">factionIndex</span>) : <span style="font-size:smaller; color:#4ec9b0">numPlayers</span>
: [[API C_Transmog.ClearAllPending|C_Transmog.ClearAllPending]]()
 
: [[API C_Transmog.ClearPending|C_Transmog.ClearPending]](<span style="font-size:smaller; color:#ecbc2a">transmogLocation</span>) - Clears the specified transmogrify slot.
+
: [[API C_Commentator.GetOrCreateSeries|C_Commentator.GetOrCreateSeries]](<span style="font-size:smaller; color:#ecbc2a">teamName1, teamName2</span>) : <span style="font-size:smaller; color:#4ec9b0">data</span>
  +
: [[API C_Commentator.GetPlayerAuraInfo|C_Commentator.GetPlayerAuraInfo]](<span style="font-size:smaller; color:#ecbc2a">teamIndex, playerIndex, spellID</span>) : <span style="font-size:smaller; color:#4ec9b0">startTime, duration, enable</span>
: [[API C_Transmog.Close|C_Transmog.Close]]()
 
  +
: [[API C_Commentator.GetPlayerAuraInfoByUnit|C_Commentator.GetPlayerAuraInfoByUnit]](<span style="font-size:smaller; color:#ecbc2a">token, spellID</span>) : <span style="font-size:smaller; color:#4ec9b0">startTime, duration, enable</span>
: [[API C_Transmog.GetApplyWarnings|C_Transmog.GetApplyWarnings]]()
 
: [[API C_Transmog.GetBaseCategory|C_Transmog.GetBaseCategory]](<span style="font-size:smaller; color:#ecbc2a">transmogID</span>) : <span style="font-size:smaller; color:#4ec9b0">categoryID</span>
+
: [[API C_Commentator.GetPlayerCooldownInfo|C_Commentator.GetPlayerCooldownInfo]](<span style="font-size:smaller; color:#ecbc2a">teamIndex, playerIndex, spellID</span>) : <span style="font-size:smaller; color:#4ec9b0">startTime, duration, enable</span>
  +
: [[API C_Commentator.GetPlayerCooldownInfoByUnit|C_Commentator.GetPlayerCooldownInfoByUnit]](<span style="font-size:smaller; color:#ecbc2a">unitToken, spellID</span>) : <span style="font-size:smaller; color:#4ec9b0">startTime, duration, enable</span>
: [[API C_Transmog.GetCost|C_Transmog.GetCost]]()
 
: [[API C_Transmog.GetCreatureDisplayIDForSource|C_Transmog.GetCreatureDisplayIDForSource]](<span style="font-size:smaller; color:#ecbc2a">itemModifiedAppearanceID</span>) : <span style="font-size:smaller; color:#4ec9b0">creatureDisplayID</span>
+
: [[API C_Commentator.GetPlayerCrowdControlInfo|C_Commentator.GetPlayerCrowdControlInfo]](<span style="font-size:smaller; color:#ecbc2a">teamIndex, playerIndex</span>) : <span style="font-size:smaller; color:#4ec9b0">spellID, expiration, duration</span>
: [[API C_Transmog.GetItemIDForSource|C_Transmog.GetItemIDForSource]](<span style="font-size:smaller; color:#ecbc2a">itemModifiedAppearanceID</span>) : <span style="font-size:smaller; color:#4ec9b0">itemID</span>
+
: [[API C_Commentator.GetPlayerCrowdControlInfoByUnit|C_Commentator.GetPlayerCrowdControlInfoByUnit]](<span style="font-size:smaller; color:#ecbc2a">token</span>) : <span style="font-size:smaller; color:#4ec9b0">spellID, expiration, duration</span>
: [[API C_Transmog.GetItemInfo|C_Transmog.GetItemInfo]](<span style="font-size:smaller; color:#ecbc2a">item</span>) - Returns how an item can interact with transmogrification.
+
: [[API C_Commentator.GetPlayerData|C_Commentator.GetPlayerData]](<span style="font-size:smaller; color:#ecbc2a">teamIndex, playerIndex</span>) : <span style="font-size:smaller; color:#4ec9b0">info</span>
: [[API C_Transmog.GetSlotForInventoryType|C_Transmog.GetSlotForInventoryType]](<span style="font-size:smaller; color:#ecbc2a">inventoryType</span>) : <span style="font-size:smaller; color:#4ec9b0">slot</span> - Returns the equipment slot for an inventory type.
+
: [[API C_Commentator.GetPlayerFlagInfo|C_Commentator.GetPlayerFlagInfo]](<span style="font-size:smaller; color:#ecbc2a">teamIndex, playerIndex</span>) : <span style="font-size:smaller; color:#4ec9b0">hasFlag</span>
: [[API C_Transmog.GetSlotInfo|C_Transmog.GetSlotInfo]](<span style="font-size:smaller; color:#ecbc2a">transmogLocation</span>) : <span style="font-size:smaller; color:#4ec9b0">isTransmogrified, hasPending, isPendingCollected, canTransmogrify, ...</span>
+
: [[API C_Commentator.GetPlayerFlagInfoByUnit|C_Commentator.GetPlayerFlagInfoByUnit]](<span style="font-size:smaller; color:#ecbc2a">unitToken</span>) : <span style="font-size:smaller; color:#4ec9b0">hasFlag</span>
: [[API C_Transmog.GetSlotUseError|C_Transmog.GetSlotUseError]](<span style="font-size:smaller; color:#ecbc2a">transmogLocation</span>) : <span style="font-size:smaller; color:#4ec9b0">errorCode, errorString</span>
+
: [[API C_Commentator.GetPlayerOverrideName|C_Commentator.GetPlayerOverrideName]](<span style="font-size:smaller; color:#ecbc2a">originalName</span>) : <span style="font-size:smaller; color:#4ec9b0">overrideName</span>
: [[API C_Transmog.GetSlotVisualInfo|C_Transmog.GetSlotVisualInfo]](<span style="font-size:smaller; color:#ecbc2a">transmogLocation</span>) : <span style="font-size:smaller; color:#4ec9b0">baseSourceID, baseVisualID, appliedSourceID, appliedVisualID, ...</span>
+
: [[API C_Commentator.GetPlayerSpellCharges|C_Commentator.GetPlayerSpellCharges]](<span style="font-size:smaller; color:#ecbc2a">teamIndex, playerIndex, spellID</span>) : <span style="font-size:smaller; color:#4ec9b0">charges, maxCharges, startTime, duration</span>
: [[API C_Transmog.LoadOutfit|C_Transmog.LoadOutfit]](<span style="font-size:smaller; color:#ecbc2a">outfitID</span>)
+
: [[API C_Commentator.GetPlayerSpellChargesByUnit|C_Commentator.GetPlayerSpellChargesByUnit]](<span style="font-size:smaller; color:#ecbc2a">unitToken, spellID</span>) : <span style="font-size:smaller; color:#4ec9b0">charges, maxCharges, startTime, duration</span>
: [[API C_Transmog.LoadSources|C_Transmog.LoadSources]](<span style="font-size:smaller; color:#ecbc2a">sourceIDTable [, mainHandEnchant, offHandEnchant]</span>)
+
: [[API C_Commentator.GetPositionLerpAmount|C_Commentator.GetPositionLerpAmount]]() : <span style="font-size:smaller; color:#4ec9b0">amount</span>
: [[API C_Transmog.SetPending|C_Transmog.SetPending]](<span style="font-size:smaller; color:#ecbc2a">transmogLocation, transmogID [, categoryID]</span>)
+
: [[API C_Commentator.GetSmoothFollowTransitioning|C_Commentator.GetSmoothFollowTransitioning]]() : <span style="font-size:smaller; color:#4ec9b0">enabled</span>
  +
: [[API C_Commentator.GetSoftlockWeight|C_Commentator.GetSoftlockWeight]]() : <span style="font-size:smaller; color:#4ec9b0">weight</span>
: [[API C_Transmog.ValidateAllPending|C_Transmog.ValidateAllPending]]()
 
  +
: [[API C_Commentator.GetSpeedFactor|C_Commentator.GetSpeedFactor]]() : <span style="font-size:smaller; color:#4ec9b0">factor</span>
: [[API IsCosmeticItem|IsCosmeticItem]]()
 
  +
: [[API C_Commentator.GetStartLocation|C_Commentator.GetStartLocation]](<span style="font-size:smaller; color:#ecbc2a">mapID</span>) : <span style="font-size:smaller; color:#4ec9b0">pos</span>
 
  +
: [[API C_Commentator.GetTeamColor|C_Commentator.GetTeamColor]](<span style="font-size:smaller; color:#ecbc2a">teamIndex</span>) : <span style="font-size:smaller; color:#4ec9b0">color</span>
===== Void Storage =====
 
  +
: [[API C_Commentator.GetTeamColorByUnit|C_Commentator.GetTeamColorByUnit]](<span style="font-size:smaller; color:#ecbc2a">unitToken</span>) : <span style="font-size:smaller; color:#4ec9b0">color</span>
[[Void Storage]] was added in [[Patch 4.3.0]]
 
  +
: [[API C_Commentator.GetTimeLeftInMatch|C_Commentator.GetTimeLeftInMatch]]() : <span style="font-size:smaller; color:#4ec9b0">timeLeft</span>
: [[API CanUseVoidStorage|CanUseVoidStorage]]() - Returns if the player has access to the Void Storage.
 
: [[API ClearVoidTransferDepositSlot|ClearVoidTransferDepositSlot]](<span style="font-size:smaller; color:#ecbc2a">slotIndex</span>) - Clears the specified Void Transfer deposit slot.
+
: [[API C_Commentator.GetTrackedSpellID|C_Commentator.GetTrackedSpellID]](<span style="font-size:smaller; color:#ecbc2a">indirectSpellID</span>) : <span style="font-size:smaller; color:#4ec9b0">trackedSpellID</span>
: [[API ClickVoidStorageSlot|ClickVoidStorageSlot]](<span style="font-size:smaller; color:#ecbc2a">slotIndex [, isRightClick]</span>) - Clicks the specified Void Storage slot.
+
: [[API C_Commentator.GetTrackedSpells|C_Commentator.GetTrackedSpells]](<span style="font-size:smaller; color:#ecbc2a">teamIndex, playerIndex, category</span>) : <span style="font-size:smaller; color:#4ec9b0">spells</span>
: [[API ClickVoidTransferDepositSlot|ClickVoidTransferDepositSlot]](<span style="font-size:smaller; color:#ecbc2a">slotIndex [, isRightClick]</span>) - Clicks the specified Void Transfer deposit slot.
+
: [[API C_Commentator.GetTrackedSpellsByUnit|C_Commentator.GetTrackedSpellsByUnit]](<span style="font-size:smaller; color:#ecbc2a">unitToken, category</span>) : <span style="font-size:smaller; color:#4ec9b0">spells</span>
: [[API ClickVoidTransferWithdrawalSlot|ClickVoidTransferWithdrawalSlot]](<span style="font-size:smaller; color:#ecbc2a">slotIndex [, isRightClick]</span>) - Clicks the specified Void Transfer withdrawal slot.
+
: [[API C_Commentator.GetUnitData|C_Commentator.GetUnitData]](<span style="font-size:smaller; color:#ecbc2a">unitToken</span>) : <span style="font-size:smaller; color:#4ec9b0">data</span>
  +
: [[API C_Commentator.GetWargameInfo|C_Commentator.GetWargameInfo]](<span style="font-size:smaller; color:#ecbc2a">listID</span>) : <span style="font-size:smaller; color:#4ec9b0">name, minPlayers, maxPlayers, isArena</span>
: [[API CloseVoidStorageFrame|CloseVoidStorageFrame]]()
 
  +
: [[API C_Commentator.HasTrackedAuras|C_Commentator.HasTrackedAuras]](<span style="font-size:smaller; color:#ecbc2a">token</span>) : <span style="font-size:smaller; color:#4ec9b0">hasOffensiveAura, hasDefensiveAura</span>
: [[API ExecuteVoidTransfer|ExecuteVoidTransfer]]() - Applies all pending void transfers (and pays for the cost of any deposited items).
 
  +
: [[API C_Commentator.IsSmartCameraLocked|C_Commentator.IsSmartCameraLocked]]() : <span style="font-size:smaller; color:#4ec9b0">isSmartCameraLocked</span>
: [[API GetNumVoidTransferDeposit|GetNumVoidTransferDeposit]]() - Returns the number of items being deposited into the Void Storage.
 
  +
: [[API C_Commentator.IsSpectating|C_Commentator.IsSpectating]]() : <span style="font-size:smaller; color:#4ec9b0">isSpectating</span>
: [[API GetNumVoidTransferWithdrawal|GetNumVoidTransferWithdrawal]]() - Returns the number of items being withdrawed from the Void Storage.
 
: [[API GetVoidItemHyperlinkString|GetVoidItemHyperlinkString]](<span style="font-size:smaller; color:#ecbc2a">slotIndex</span>) - Returns the item link of an item in void storage.
+
: [[API C_Commentator.IsTrackedDefensiveAura|C_Commentator.IsTrackedDefensiveAura]](<span style="font-size:smaller; color:#ecbc2a">spellID</span>) : <span style="font-size:smaller; color:#4ec9b0">isDefensiveTrigger</span>
: [[API GetVoidItemInfo|GetVoidItemInfo]](<span style="font-size:smaller; color:#ecbc2a">slotIndex</span>) - Returns <code>itemID, textureName, locked, recentDeposit, isFiltered</code>.
+
: [[API C_Commentator.IsTrackedOffensiveAura|C_Commentator.IsTrackedOffensiveAura]](<span style="font-size:smaller; color:#ecbc2a">spellID</span>) : <span style="font-size:smaller; color:#4ec9b0">isOffensiveTrigger</span>
  +
: [[API C_Commentator.IsTrackedSpell|C_Commentator.IsTrackedSpell]](<span style="font-size:smaller; color:#ecbc2a">teamIndex, playerIndex, spellID, category</span>) : <span style="font-size:smaller; color:#4ec9b0">isTracked</span>
: [[API GetVoidTransferCost|GetVoidTransferCost]]() - Returns the total Void Transfer cost.
 
: [[API GetVoidTransferDepositInfo|GetVoidTransferDepositInfo]](<span style="font-size:smaller; color:#ecbc2a">slotIndex</span>) - Returns <code>itemID, textureName</code>.
+
: [[API C_Commentator.IsTrackedSpellByUnit|C_Commentator.IsTrackedSpellByUnit]](<span style="font-size:smaller; color:#ecbc2a">unitToken, spellID, category</span>) : <span style="font-size:smaller; color:#4ec9b0">isTracked</span>
: [[API GetVoidTransferWithdrawalInfo|GetVoidTransferWithdrawalInfo]](<span style="font-size:smaller; color:#ecbc2a">slotIndex</span>) - Returns <code>itemID, textureName</code>.
+
: [[API C_Commentator.IsUsingSmartCamera|C_Commentator.IsUsingSmartCamera]]() : <span style="font-size:smaller; color:#4ec9b0">isUsingSmartCamera</span>
  +
: [[API C_Commentator.LookAtPlayer|C_Commentator.LookAtPlayer]](<span style="font-size:smaller; color:#ecbc2a">factionIndex, playerIndex [, lookAtIndex]</span>)
: [[API IsVoidStorageReady|IsVoidStorageReady]]()
 
  +
: [[API C_Commentator.RemoveAllOverrideNames|C_Commentator.RemoveAllOverrideNames]]()
: [[API UnlockVoidStorage|UnlockVoidStorage]]() - Pays for and activates the Void Storage.
 
: [[API GetVoidStorageSlotPageIndex|GetVoidStorageSlotPageIndex]](<span style="font-size:smaller; color:#ecbc2a">slot</span>)
+
: [[API C_Commentator.RemovePlayerOverrideName|C_Commentator.RemovePlayerOverrideName]](<span style="font-size:smaller; color:#ecbc2a">originalPlayerName</span>)
  +
: [[API C_Commentator.RequestPlayerCooldownInfo|C_Commentator.RequestPlayerCooldownInfo]](<span style="font-size:smaller; color:#ecbc2a">teamIndex, playerIndex</span>)
: [[API GetVoidUnlockCost|GetVoidUnlockCost]]()
 
  +
: [[API C_Commentator.ResetFoVTarget|C_Commentator.ResetFoVTarget]]()
  +
: [[API C_Commentator.ResetSeriesScores|C_Commentator.ResetSeriesScores]](<span style="font-size:smaller; color:#ecbc2a">teamName1, teamName2</span>)
  +
: [[API C_Commentator.ResetSettings|C_Commentator.ResetSettings]]()
  +
: [[API C_Commentator.ResetTrackedAuras|C_Commentator.ResetTrackedAuras]]()
  +
: [[API C_Commentator.SetAdditionalCameraWeight|C_Commentator.SetAdditionalCameraWeight]](<span style="font-size:smaller; color:#ecbc2a">teamIndex, playerIndex, weight</span>)
  +
: [[API C_Commentator.SetAdditionalCameraWeightByToken|C_Commentator.SetAdditionalCameraWeightByToken]](<span style="font-size:smaller; color:#ecbc2a">unitToken, weight</span>)
  +
: [[API C_Commentator.SetBlacklistedAuras|C_Commentator.SetBlacklistedAuras]](<span style="font-size:smaller; color:#ecbc2a">spellIDs</span>)
  +
: [[API C_Commentator.SetBlacklistedCooldowns|C_Commentator.SetBlacklistedCooldowns]](<span style="font-size:smaller; color:#ecbc2a">specID, spellIDs</span>)
  +
: [[API C_Commentator.SetCamera|C_Commentator.SetCamera]](<span style="font-size:smaller; color:#ecbc2a">xPos, yPos, zPos, yaw, pitch, roll, fov</span>)
  +
: [[API C_Commentator.SetCameraCollision|C_Commentator.SetCameraCollision]](<span style="font-size:smaller; color:#ecbc2a">collide</span>)
  +
: [[API C_Commentator.SetCameraPosition|C_Commentator.SetCameraPosition]](<span style="font-size:smaller; color:#ecbc2a">xPos, yPos, zPos, snapToLocation</span>)
  +
: [[API C_Commentator.SetCheatsEnabled|C_Commentator.SetCheatsEnabled]](<span style="font-size:smaller; color:#ecbc2a">enableCheats</span>)
  +
: [[API C_Commentator.SetCommentatorHistory|C_Commentator.SetCommentatorHistory]](<span style="font-size:smaller; color:#ecbc2a">history</span>)
  +
: [[API C_Commentator.SetDistanceBeforeForcedHorizontalConvergence|C_Commentator.SetDistanceBeforeForcedHorizontalConvergence]](<span style="font-size:smaller; color:#ecbc2a">distance</span>)
  +
: [[API C_Commentator.SetDurationToForceHorizontalConvergence|C_Commentator.SetDurationToForceHorizontalConvergence]](<span style="font-size:smaller; color:#ecbc2a">ms</span>)
  +
: [[API C_Commentator.SetExcludeDistance|C_Commentator.SetExcludeDistance]](<span style="font-size:smaller; color:#ecbc2a">excludeDistance</span>)
  +
: [[API C_Commentator.SetFollowCameraSpeeds|C_Commentator.SetFollowCameraSpeeds]](<span style="font-size:smaller; color:#ecbc2a">elasticSpeed, minSpeed</span>)
  +
: [[API C_Commentator.SetHardlockWeight|C_Commentator.SetHardlockWeight]](<span style="font-size:smaller; color:#ecbc2a">weight</span>)
  +
: [[API C_Commentator.SetHorizontalAngleThresholdToSmooth|C_Commentator.SetHorizontalAngleThresholdToSmooth]](<span style="font-size:smaller; color:#ecbc2a">angle</span>)
  +
: [[API C_Commentator.SetLookAtLerpAmount|C_Commentator.SetLookAtLerpAmount]](<span style="font-size:smaller; color:#ecbc2a">amount</span>)
  +
: [[API C_Commentator.SetMapAndInstanceIndex|C_Commentator.SetMapAndInstanceIndex]](<span style="font-size:smaller; color:#ecbc2a">mapIndex, instanceIndex</span>)
  +
: [[API C_Commentator.SetMouseDisabled|C_Commentator.SetMouseDisabled]](<span style="font-size:smaller; color:#ecbc2a">disabled</span>)
  +
: [[API C_Commentator.SetMoveSpeed|C_Commentator.SetMoveSpeed]](<span style="font-size:smaller; color:#ecbc2a">newSpeed</span>)
  +
: [[API C_Commentator.SetMsToHoldForHorizontalMovement|C_Commentator.SetMsToHoldForHorizontalMovement]](<span style="font-size:smaller; color:#ecbc2a">ms</span>)
  +
: [[API C_Commentator.SetMsToHoldForVerticalMovement|C_Commentator.SetMsToHoldForVerticalMovement]](<span style="font-size:smaller; color:#ecbc2a">ms</span>)
  +
: [[API C_Commentator.SetMsToSmoothHorizontalChange|C_Commentator.SetMsToSmoothHorizontalChange]](<span style="font-size:smaller; color:#ecbc2a">ms</span>)
  +
: [[API C_Commentator.SetMsToSmoothVerticalChange|C_Commentator.SetMsToSmoothVerticalChange]](<span style="font-size:smaller; color:#ecbc2a">ms</span>)
  +
: [[API C_Commentator.SetPositionLerpAmount|C_Commentator.SetPositionLerpAmount]](<span style="font-size:smaller; color:#ecbc2a">amount</span>)
  +
: [[API C_Commentator.SetRequestedDebuffCooldowns|C_Commentator.SetRequestedDebuffCooldowns]](<span style="font-size:smaller; color:#ecbc2a">specID, spellIDs</span>)
  +
: [[API C_Commentator.SetRequestedDefensiveCooldowns|C_Commentator.SetRequestedDefensiveCooldowns]](<span style="font-size:smaller; color:#ecbc2a">specID, spellIDs</span>)
  +
: [[API C_Commentator.SetRequestedOffensiveCooldowns|C_Commentator.SetRequestedOffensiveCooldowns]](<span style="font-size:smaller; color:#ecbc2a">specID, spellIDs</span>)
  +
: [[API C_Commentator.SetSeriesScore|C_Commentator.SetSeriesScore]](<span style="font-size:smaller; color:#ecbc2a">teamName1, teamName2, scoringTeamName, score</span>)
  +
: [[API C_Commentator.SetSeriesScores|C_Commentator.SetSeriesScores]](<span style="font-size:smaller; color:#ecbc2a">teamName1, teamName2, score1, score2</span>)
  +
: [[API C_Commentator.SetSmartCameraLocked|C_Commentator.SetSmartCameraLocked]](<span style="font-size:smaller; color:#ecbc2a">locked</span>)
  +
: [[API C_Commentator.SetSmoothFollowTransitioning|C_Commentator.SetSmoothFollowTransitioning]](<span style="font-size:smaller; color:#ecbc2a">enabled</span>)
  +
: [[API C_Commentator.SetSoftlockWeight|C_Commentator.SetSoftlockWeight]](<span style="font-size:smaller; color:#ecbc2a">weight</span>)
  +
: [[API C_Commentator.SetSpeedFactor|C_Commentator.SetSpeedFactor]](<span style="font-size:smaller; color:#ecbc2a">factor</span>)
  +
: [[API C_Commentator.SetTargetHeightOffset|C_Commentator.SetTargetHeightOffset]](<span style="font-size:smaller; color:#ecbc2a">offset</span>)
  +
: [[API C_Commentator.SetUseSmartCamera|C_Commentator.SetUseSmartCamera]](<span style="font-size:smaller; color:#ecbc2a">useSmartCamera</span>)
  +
: [[API C_Commentator.SnapCameraLookAtPoint|C_Commentator.SnapCameraLookAtPoint]]()
  +
: [[API C_Commentator.StartWargame|C_Commentator.StartWargame]](<span style="font-size:smaller; color:#ecbc2a">listID, teamSize, tournamentRules, teamOneCaptain, teamTwoCaptain</span>)
  +
: [[API C_Commentator.SwapTeamSides|C_Commentator.SwapTeamSides]]()
  +
: [[API C_Commentator.ToggleCheats|C_Commentator.ToggleCheats]]()
  +
: [[API C_Commentator.UpdateMapInfo|C_Commentator.UpdateMapInfo]](<span style="font-size:smaller; color:#ecbc2a">[targetPlayer]</span>)
  +
: [[API C_Commentator.UpdatePlayerInfo|C_Commentator.UpdatePlayerInfo]]()
  +
: [[API C_Commentator.ZoomIn|C_Commentator.ZoomIn]]()
  +
: [[API C_Commentator.ZoomOut|C_Commentator.ZoomOut]]()
   
 
=== Tutorials ===
 
=== Tutorials ===
Line 4,324: Line 4,334:
 
: [[API GetFileIDFromPath|GetFileIDFromPath]](<span style="font-size:smaller; color:#ecbc2a">filePath</span>) - Returns the fileID corresponding to the given game file path (texture, sound, model, etc.).
 
: [[API GetFileIDFromPath|GetFileIDFromPath]](<span style="font-size:smaller; color:#ecbc2a">filePath</span>) - Returns the fileID corresponding to the given game file path (texture, sound, model, etc.).
 
: [[API SetUIVisibility|SetUIVisibility]](<span style="font-size:smaller; color:#ecbc2a">visible</span>) - Hides or shows the entire UI.
 
: [[API SetUIVisibility|SetUIVisibility]](<span style="font-size:smaller; color:#ecbc2a">visible</span>) - Hides or shows the entire UI.
  +
: <small>UI</small> [[API EasyMenu|EasyMenu]](<span style="font-size:smaller; color:#ecbc2a">menuList, menuFrame, anchor, x, y, displayMode, autoHideDelay</span>)
  +
: <small>UI</small> [[API ToggleDropDownMenu|ToggleDropDownMenu]](<span style="font-size:smaller; color:#ecbc2a">level, value, dropDownFrame, anchorName, xOffset, yOffset</span>)
   
 
==== Frame ====
 
==== Frame ====
Line 4,368: Line 4,380:
 
: [[API GetUICameraInfo|GetUICameraInfo]](<span style="font-size:smaller; color:#ecbc2a">uiCameraID</span>)
 
: [[API GetUICameraInfo|GetUICameraInfo]](<span style="font-size:smaller; color:#ecbc2a">uiCameraID</span>)
   
==== Uncategorized ====
+
==== Unknown ====
 
: [[API C_PrototypeDialog.EnsureRemoved|C_PrototypeDialog.EnsureRemoved]](<span style="font-size:smaller; color:#ecbc2a">instanceID</span>)
 
: [[API C_PrototypeDialog.EnsureRemoved|C_PrototypeDialog.EnsureRemoved]](<span style="font-size:smaller; color:#ecbc2a">instanceID</span>)
 
: [[API C_PrototypeDialog.SelectOption|C_PrototypeDialog.SelectOption]](<span style="font-size:smaller; color:#ecbc2a">instanceID, optionIndex</span>)
 
: [[API C_PrototypeDialog.SelectOption|C_PrototypeDialog.SelectOption]](<span style="font-size:smaller; color:#ecbc2a">instanceID, optionIndex</span>)
: [[API IsUsingFixedTimeStep|IsUsingFixedTimeStep]]()
 
   
 
=== UI Widget Manager ===
 
=== UI Widget Manager ===
Line 4,461: Line 4,472:
 
: [[API UnitIsCharmed|UnitIsCharmed]](<span style="font-size:smaller; color:#ecbc2a">unit</span>) - Returns true if the specified unit is charmed, false otherwise.
 
: [[API UnitIsCharmed|UnitIsCharmed]](<span style="font-size:smaller; color:#ecbc2a">unit</span>) - Returns true if the specified unit is charmed, false otherwise.
 
: [[API UnitIsConnected|UnitIsConnected]](<span style="font-size:smaller; color:#ecbc2a">unit</span>) : <span style="font-size:smaller; color:#4ec9b0">isConnected</span> - Returns 1 if the specified unit is connected or npc, nil if offline or not a valid unit.
 
: [[API UnitIsConnected|UnitIsConnected]](<span style="font-size:smaller; color:#ecbc2a">unit</span>) : <span style="font-size:smaller; color:#4ec9b0">isConnected</span> - Returns 1 if the specified unit is connected or npc, nil if offline or not a valid unit.
: [[API UnitIsControlling|UnitIsControlling]]()
+
: [[API UnitIsControlling|UnitIsControlling]](<span style="font-size:smaller; color:#ecbc2a">unit</span>) - Returns true if the local player is directly controlling the specified unit.
 
: [[API UnitIsCorpse|UnitIsCorpse]](<span style="font-size:smaller; color:#ecbc2a">unit</span>) - Returns true if the specified unit is a corpse, false otherwise.
 
: [[API UnitIsCorpse|UnitIsCorpse]](<span style="font-size:smaller; color:#ecbc2a">unit</span>) - Returns true if the specified unit is a corpse, false otherwise.
 
: [[API UnitIsDead|UnitIsDead]](<span style="font-size:smaller; color:#ecbc2a">unit</span>) - Returns true if the specified unit is dead, nil otherwise.
 
: [[API UnitIsDead|UnitIsDead]](<span style="font-size:smaller; color:#ecbc2a">unit</span>) - Returns true if the specified unit is dead, nil otherwise.
Line 4,506: Line 4,517:
 
: [[API UnitSex|UnitSex]](<span style="font-size:smaller; color:#ecbc2a">unit</span>) : <span style="font-size:smaller; color:#4ec9b0">sex</span> - Returns a code indicating the gender of the specified unit, if known. (1=unknown, 2=male, 3=female)
 
: [[API UnitSex|UnitSex]](<span style="font-size:smaller; color:#ecbc2a">unit</span>) : <span style="font-size:smaller; color:#4ec9b0">sex</span> - Returns a code indicating the gender of the specified unit, if known. (1=unknown, 2=male, 3=female)
 
: [[API UnitShouldDisplayName|UnitShouldDisplayName]]()
 
: [[API UnitShouldDisplayName|UnitShouldDisplayName]]()
: [[API UnitSpellHaste|UnitSpellHaste]](<span style="font-size:smaller; color:#ecbc2a">unit or name</span>) - Returns the current spell haste percentage for a unit.
+
: [[API UnitSpellHaste|UnitSpellHaste]](<span style="font-size:smaller; color:#ecbc2a">unit</span>) - Returns the current spell haste percentage for a unit.
 
: [[API UnitStagger|UnitStagger]]()
 
: [[API UnitStagger|UnitStagger]]()
 
: [[API UnitStat|UnitStat]](<span style="font-size:smaller; color:#ecbc2a">unit, statIndex</span>) - Returns the statistics relevant to the specified unit and basic attribute (e.g., strength or intellect).
 
: [[API UnitStat|UnitStat]](<span style="font-size:smaller; color:#ecbc2a">unit, statIndex</span>) - Returns the statistics relevant to the specified unit and basic attribute (e.g., strength or intellect).
Line 4,521: Line 4,532:
 
==== Buffs ====
 
==== Buffs ====
 
: <small>NOCOMBAT</small> [[API CancelUnitBuff|CancelUnitBuff]](<span style="font-size:smaller; color:#ecbc2a">unit, index or spell [, filter or rank]</span>) - Removes a specific buff from the player.
 
: <small>NOCOMBAT</small> [[API CancelUnitBuff|CancelUnitBuff]](<span style="font-size:smaller; color:#ecbc2a">unit, index or spell [, filter or rank]</span>) - Removes a specific buff from the player.
: [[API GetPlayerAuraBySpellID|GetPlayerAuraBySpellID]](<span style="font-size:smaller; color:#ecbc2a">spellID</span>) - Returns any active buff/debuff by spell ID on the player character.
+
: [[API GetPlayerAuraBySpellID|GetPlayerAuraBySpellID]](<span style="font-size:smaller; color:#ecbc2a">spellID</span>) - Returns an active buff/debuff by spell ID on the player character.
 
: [[API UnitAura|UnitAura]](<span style="font-size:smaller; color:#ecbc2a">unit, index [, filter]</span>) - Returns info about buffs and debuffs of a unit.
 
: [[API UnitAura|UnitAura]](<span style="font-size:smaller; color:#ecbc2a">unit, index [, filter]</span>) - Returns info about buffs and debuffs of a unit.
 
: [[API UnitAuraBySlot|UnitAuraBySlot]](<span style="font-size:smaller; color:#ecbc2a">unit, slot</span>)
 
: [[API UnitAuraBySlot|UnitAuraBySlot]](<span style="font-size:smaller; color:#ecbc2a">unit, slot</span>)
 
: [[API UnitAuraSlots|UnitAuraSlots]](<span style="font-size:smaller; color:#ecbc2a">unit [, filter, maxSlots, continuationToken]</span>)
 
: [[API UnitAuraSlots|UnitAuraSlots]](<span style="font-size:smaller; color:#ecbc2a">unit [, filter, maxSlots, continuationToken]</span>)
: [[API UnitBuff|UnitBuff]](<span style="font-size:smaller; color:#ecbc2a">unit, index [, raidFilter]</span>) - Shorthand for UnitAura(__, __, "HELPFUL [...]")
+
: [[API UnitBuff|UnitBuff]](<span style="font-size:smaller; color:#ecbc2a">unit, index [, raidFilter]</span>) - Shorthand for <code>UnitAura(_, _, "HELPFUL")</code>
: [[API UnitDebuff|UnitDebuff]](<span style="font-size:smaller; color:#ecbc2a">unit, index [, raidFilter]</span>) - Shorthand for UnitAura(__, __, "HARMFUL [...]")
+
: [[API UnitDebuff|UnitDebuff]](<span style="font-size:smaller; color:#ecbc2a">unit, index [, raidFilter]</span>) - Shorthand for <code>UnitAura(_, _, "HARMFUL")</code>
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=FindAura AuraUtil.FindAura](<span style="font-size:smaller; color:#ecbc2a">predicate, unit, filter, predicateArg1, predicateArg2, predicateArg3</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=FindAuraByName AuraUtil.FindAuraByName](<span style="font-size:smaller; color:#ecbc2a">auraName, unit, filter</span>) - Finds the first aura that matches the name.
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=ForEachAura AuraUtil.ForEachAura](<span style="font-size:smaller; color:#ecbc2a">unit, filter, maxCount, func</span>)
 
Weapon Enchants
 
Weapon Enchants
: <small>SECURE</small> [[API CancelItemTempEnchantment|CancelItemTempEnchantment]](<span style="font-size:smaller; color:#ecbc2a">weaponHand</span>) - Cancels a temporary weapon enchant on ''weaponHand'' (1 for Main hand, 2 for Off hand).
+
: <small>PROTECTED</small> [[API CancelItemTempEnchantment|CancelItemTempEnchantment]](<span style="font-size:smaller; color:#ecbc2a">weaponHand</span>) - Cancels a temporary weapon enchant on ''weaponHand'' (1 for Main hand, 2 for Off hand).
 
: [[API GetWeaponEnchantInfo|GetWeaponEnchantInfo]]() - Returns information about main and offhand weapon enchantments.
 
: [[API GetWeaponEnchantInfo|GetWeaponEnchantInfo]]() - Returns information about main and offhand weapon enchantments.
  +
  +
==== Nameplates ====
  +
Nameplates were reworked in [[Patch 7.0.3]]
  +
: [[API C_NamePlate.GetNamePlateEnemyClickThrough|C_NamePlate.GetNamePlateEnemyClickThrough]]()
  +
: [[API C_NamePlate.GetNamePlateEnemyPreferredClickInsets|C_NamePlate.GetNamePlateEnemyPreferredClickInsets]]()
  +
: [[API C_NamePlate.GetNamePlateEnemySize|C_NamePlate.GetNamePlateEnemySize]]()
  +
: [[API C_NamePlate.GetNamePlateForUnit|C_NamePlate.GetNamePlateForUnit]](<span style="font-size:smaller; color:#ecbc2a">unitToken [, includeForbidden]</span>)
  +
: [[API C_NamePlate.GetNamePlateFriendlyClickThrough|C_NamePlate.GetNamePlateFriendlyClickThrough]]()
  +
: [[API C_NamePlate.GetNamePlateFriendlyPreferredClickInsets|C_NamePlate.GetNamePlateFriendlyPreferredClickInsets]]()
  +
: [[API C_NamePlate.GetNamePlateFriendlySize|C_NamePlate.GetNamePlateFriendlySize]]()
  +
: [[API C_NamePlate.GetNamePlateSelfClickThrough|C_NamePlate.GetNamePlateSelfClickThrough]]()
  +
: [[API C_NamePlate.GetNamePlateSelfPreferredClickInsets|C_NamePlate.GetNamePlateSelfPreferredClickInsets]]()
  +
: [[API C_NamePlate.GetNamePlateSelfSize|C_NamePlate.GetNamePlateSelfSize]]()
  +
: [[API C_NamePlate.GetNamePlates|C_NamePlate.GetNamePlates]](<span style="font-size:smaller; color:#ecbc2a">[includeForbidden]</span>)
  +
: [[API C_NamePlate.GetNumNamePlateMotionTypes|C_NamePlate.GetNumNamePlateMotionTypes]]()
  +
: [[API C_NamePlate.GetTargetClampingInsets|C_NamePlate.GetTargetClampingInsets]]()
  +
: [[API C_NamePlate.SetNamePlateEnemyClickThrough|C_NamePlate.SetNamePlateEnemyClickThrough]](<span style="font-size:smaller; color:#ecbc2a">clickthrough</span>)
  +
: [[API C_NamePlate.SetNamePlateEnemyPreferredClickInsets|C_NamePlate.SetNamePlateEnemyPreferredClickInsets]]()
  +
: [[API C_NamePlate.SetNamePlateEnemySize|C_NamePlate.SetNamePlateEnemySize]](<span style="font-size:smaller; color:#ecbc2a">width, height</span>)
  +
: [[API C_NamePlate.SetNamePlateFriendlyClickThrough|C_NamePlate.SetNamePlateFriendlyClickThrough]]()
  +
: [[API C_NamePlate.SetNamePlateFriendlyPreferredClickInsets|C_NamePlate.SetNamePlateFriendlyPreferredClickInsets]](<span style="font-size:smaller; color:#ecbc2a">left, right, top, bottom</span>)
  +
: [[API C_NamePlate.SetNamePlateFriendlySize|C_NamePlate.SetNamePlateFriendlySize]](<span style="font-size:smaller; color:#ecbc2a">width, height</span>)
  +
: [[API C_NamePlate.SetNamePlateSelfClickThrough|C_NamePlate.SetNamePlateSelfClickThrough]](<span style="font-size:smaller; color:#ecbc2a">clickthrough</span>)
  +
: [[API C_NamePlate.SetNamePlateSelfPreferredClickInsets|C_NamePlate.SetNamePlateSelfPreferredClickInsets]](<span style="font-size:smaller; color:#ecbc2a">left, right, top, bottom</span>)
  +
: [[API C_NamePlate.SetNamePlateSelfSize|C_NamePlate.SetNamePlateSelfSize]](<span style="font-size:smaller; color:#ecbc2a">width, height</span>)
  +
: [[API C_NamePlate.SetTargetClampingInsets|C_NamePlate.SetTargetClampingInsets]](<span style="font-size:smaller; color:#ecbc2a">clickthrough</span>)
  +
: [[API SetInWorldUIVisibility|SetInWorldUIVisibility]](<span style="font-size:smaller; color:#ecbc2a">visible</span>) - Allows nameplates to be shown even while the UI is hidden (with Alt-Z)
  +
: [[API UnitNameplateShowsWidgetsOnly|UnitNameplateShowsWidgetsOnly]](<span style="font-size:smaller; color:#ecbc2a">unit</span>) : <span style="font-size:smaller; color:#4ec9b0">nameplateShowsWidgetsOnly</span>
   
 
==== Loss of Control ====
 
==== Loss of Control ====
Line 4,543: Line 4,585:
 
: [[API UnitInPartyShard|UnitInPartyShard]](<span style="font-size:smaller; color:#ecbc2a">unit</span>) : <span style="font-size:smaller; color:#4ec9b0">inPartyShard</span>
 
: [[API UnitInPartyShard|UnitInPartyShard]](<span style="font-size:smaller; color:#ecbc2a">unit</span>) : <span style="font-size:smaller; color:#4ec9b0">inPartyShard</span>
 
: [[API UnitPhaseReason|UnitPhaseReason]](<span style="font-size:smaller; color:#ecbc2a">unit</span>) : <span style="font-size:smaller; color:#4ec9b0">reason</span> - Returns the reason if a unit is NOT in the same phase.
 
: [[API UnitPhaseReason|UnitPhaseReason]](<span style="font-size:smaller; color:#ecbc2a">unit</span>) : <span style="font-size:smaller; color:#4ec9b0">reason</span> - Returns the reason if a unit is NOT in the same phase.
 
==== Targeting ====
 
Relates to [[Target]]s.
 
: <small>SECURE</small> [[API AssistUnit|AssistUnit]](<span style="font-size:smaller; color:#ecbc2a">unit</span>) - Instructs your character to assist the specified unit.
 
: <small>SECURE</small> [[API ClearFocus|ClearFocus]]() - Removes any focus you may have set.
 
: <small>SECURE</small> [[API ClearTarget|ClearTarget]]() - Clears the selected target.
 
: <small>SECURE</small> [[API FocusUnit|FocusUnit]](<span style="font-size:smaller; color:#ecbc2a">unit</span>) - Sets your unit for focus.
 
: [[API IsReplacingUnit|IsReplacingUnit]]()
 
: <small>SECURE</small> [[API TargetDirectionEnemy|TargetDirectionEnemy]](<span style="font-size:smaller; color:#ecbc2a">facing</span>)
 
: <small>SECURE</small> [[API TargetDirectionFinished|TargetDirectionFinished]]()
 
: <small>SECURE</small> [[API TargetDirectionFriend|TargetDirectionFriend]](<span style="font-size:smaller; color:#ecbc2a">facing</span>)
 
: <small>SECURE</small> [[API TargetLastEnemy|TargetLastEnemy]]() - Selects the last targetted enemy as the current target.
 
: <small>SECURE</small> [[API TargetLastFriend|TargetLastFriend]]()
 
: <small>SECURE</small> [[API TargetLastTarget|TargetLastTarget]]() - Selects the last target as the current target.
 
: <small>SECURE</small> [[API TargetNearestEnemy|TargetNearestEnemy]](<span style="font-size:smaller; color:#ecbc2a">[reverseFlag]</span>) - Selects the nearest enemy as the current target.
 
: <small>SECURE</small> [[API TargetNearestEnemyPlayer|TargetNearestEnemyPlayer]](<span style="font-size:smaller; color:#ecbc2a">[reverseFlag]</span>) - Selects the nearest enemy player as the current target.
 
: <small>SECURE</small> [[API TargetNearestFriend|TargetNearestFriend]](<span style="font-size:smaller; color:#ecbc2a">[reverseFlag]</span>) - Selects the nearest friendly unit as the current target.
 
: <small>SECURE</small> [[API TargetNearestFriendPlayer|TargetNearestFriendPlayer]](<span style="font-size:smaller; color:#ecbc2a">[reverseFlag]</span>) - Selects the nearest friendly player as the current target.
 
: <small>SECURE</small> [[API TargetNearest|TargetNearest]]()
 
: <small>SECURE</small> [[API TargetNearestPartyMember|TargetNearestPartyMember]]() - Selects the nearest Party member as the current target.
 
: <small>SECURE</small> [[API TargetNearestRaidMember|TargetNearestRaidMember]]() - Selects the nearest Raid member as the current target.
 
: <small>SECURE</small> [[API TargetPriorityHighlightEnd|TargetPriorityHighlightEnd]]()
 
: <small>SECURE</small> [[API TargetPriorityHighlightStart|TargetPriorityHighlightStart]]()
 
: <small>SECURE</small> [[API TargetUnit|TargetUnit]](<span style="font-size:smaller; color:#ecbc2a">unit [, exactMatch]</span>) - Selects the specified unit as the current target.
 
 
==== Players ====
 
: [[API C_PlayerInfo.GetClass|C_PlayerInfo.GetClass]](<span style="font-size:smaller; color:#ecbc2a">playerLocation</span>) : <span style="font-size:smaller; color:#4ec9b0">className, classFilename, classID</span> - Returns the class of a player.
 
: [[API C_PlayerInfo.GetName|C_PlayerInfo.GetName]](<span style="font-size:smaller; color:#ecbc2a">playerLocation</span>) : <span style="font-size:smaller; color:#4ec9b0">name</span> - Returns the name of a player.
 
: [[API C_PlayerInfo.GetRace|C_PlayerInfo.GetRace]](<span style="font-size:smaller; color:#ecbc2a">playerLocation</span>) : <span style="font-size:smaller; color:#4ec9b0">raceID</span> - Returns the race of a player.
 
: [[API C_PlayerInfo.GetSex|C_PlayerInfo.GetSex]](<span style="font-size:smaller; color:#ecbc2a">playerLocation</span>) : <span style="font-size:smaller; color:#4ec9b0">sex</span> - Returns the sex of a player.
 
: [[API C_PlayerInfo.GUIDIsPlayer|C_PlayerInfo.GUIDIsPlayer]](<span style="font-size:smaller; color:#ecbc2a">guid</span>) : <span style="font-size:smaller; color:#4ec9b0">isPlayer</span> - Returns true if the guid belongs to a player.
 
: [[API C_PlayerInfo.IsConnected|C_PlayerInfo.IsConnected]](<span style="font-size:smaller; color:#ecbc2a">[playerLocation]</span>) : <span style="font-size:smaller; color:#4ec9b0">isConnected</span> - Returns true if a player is connected.
 
: [[API C_PlayerInfo.UnitIsSameServer|C_PlayerInfo.UnitIsSameServer]](<span style="font-size:smaller; color:#ecbc2a">playerLocation</span>) : <span style="font-size:smaller; color:#4ec9b0">unitIsSameServer</span> - Returns true if another player is from your own or connected realm.
 
: [[API C_LevelSquish.ConvertFollowerLevel|C_LevelSquish.ConvertFollowerLevel]](<span style="font-size:smaller; color:#ecbc2a">level, maxFollowerLevel</span>) : <span style="font-size:smaller; color:#4ec9b0">squishedLevel</span>
 
: [[API C_LevelSquish.ConvertPlayerLevel|C_LevelSquish.ConvertPlayerLevel]](<span style="font-size:smaller; color:#ecbc2a">level</span>) : <span style="font-size:smaller; color:#4ec9b0">squishedLevel</span>
 
: [[API GetPlayerInfoByGUID|GetPlayerInfoByGUID]](<span style="font-size:smaller; color:#ecbc2a">guid</span>) - Returns race, class, sex about the guid (client must have seen the guid)
 
   
 
==== Power Bar ====
 
==== Power Bar ====
Line 4,590: Line 4,596:
 
: [[API UnitPowerBarID|UnitPowerBarID]](<span style="font-size:smaller; color:#ecbc2a">unitToken</span>) : <span style="font-size:smaller; color:#4ec9b0">barID</span>
 
: [[API UnitPowerBarID|UnitPowerBarID]](<span style="font-size:smaller; color:#ecbc2a">unitToken</span>) : <span style="font-size:smaller; color:#4ec9b0">barID</span>
 
: [[API UnitPowerBarTimerInfo|UnitPowerBarTimerInfo]]()
 
: [[API UnitPowerBarTimerInfo|UnitPowerBarTimerInfo]]()
 
=== Util ===
 
: [[API Ambiguate|Ambiguate]](<span style="font-size:smaller; color:#ecbc2a">fullName, context</span>) - Returns a version of a character-realm string suitable for use in a given context.
 
: [[API BreakUpLargeNumbers|BreakUpLargeNumbers]](<span style="font-size:smaller; color:#ecbc2a">number [, natural]</span>) - Converts a number into a localized string, grouping digits as required.
 
: [[API CalculateStringEditDistance|CalculateStringEditDistance]](<span style="font-size:smaller; color:#ecbc2a">firstString, secondString</span>) - Returns [https://en.wikipedia.org/wiki/Levenshtein_distance Levenshtein] distance.
 
: [[API CaseAccentInsensitiveParse|CaseAccentInsensitiveParse]](<span style="font-size:smaller; color:#ecbc2a">string</span>)
 
: [[API IsRecognizedName|IsRecognizedName]](<span style="font-size:smaller; color:#ecbc2a">text, includeBitField, excludeBitField</span>) - Not used in FrameXML.
 
: <small>UI</small> [https://www.townlong-yak.com/framexml/go/ExecuteFrameScript ExecuteFrameScript](<span style="font-size:smaller; color:#ecbc2a">frame, scriptName, ...</span>) - Manually calls the handler for a frame script.
 
: <small>UI</small> [https://www.townlong-yak.com/framexml/go/ExtractHyperlinkString ExtractHyperlinkString](<span style="font-size:smaller; color:#ecbc2a">linkString</span>) - Strips any color coding from a [[UI_escape_sequences#Hyperlinks|hyperlink]].
 
: <small>UI</small> [https://www.townlong-yak.com/framexml/go/Flags_CreateMask Flags_CreateMask](<span style="font-size:smaller; color:#ecbc2a">...</span>) - Creates a bitmask.
 
: <small>UI</small> [https://www.townlong-yak.com/framexml/go/FormatLargeNumber FormatLargeNumber](<span style="font-size:smaller; color:#ecbc2a">amount</span>) - Formats a number with dot or comma number seperators.
 
: <small>UI</small> [https://www.townlong-yak.com/framexml/go/Lerp Lerp](<span style="font-size:smaller; color:#ecbc2a">startValue, endValue, amount</span>) - Linearly interpolation between two values for a parameter in the closed unit interval [0, 1]
 
: <small>UI</small> [https://www.townlong-yak.com/framexml/go/Round Round](<span style="font-size:smaller; color:#ecbc2a">value</span>) - Rounds a value.
 
: <small>UI</small> [[API SetItemRef|SetItemRef]](<span style="font-size:smaller; color:#ecbc2a">link, text, button</span>) - Handles item link tooltips in chat.
 
: <small>UI</small> [https://www.townlong-yak.com/framexml/go/CopyTable CopyTable](<span style="font-size:smaller; color:#ecbc2a">tbl</span>) - Returns a deep copy of a table.
 
: <small>UI</small> [https://www.townlong-yak.com/framexml/go/tAppendAll tAppendAll](<span style="font-size:smaller; color:#ecbc2a">tbl, addedArray</span>) - Appends the contents of a sequential table to another table.
 
: <small>UI</small> [https://www.townlong-yak.com/framexml/go/tCompare tCompare](<span style="font-size:smaller; color:#ecbc2a">lhsTable, rhsTable, depth</span>) - Does a deep compare on the values of the table.
 
: <small>UI</small> [https://www.townlong-yak.com/framexml/go/tInvert tInvert](<span style="font-size:smaller; color:#ecbc2a">tbl</span>) - Returns an inverted table.
 
: <small>UI</small> [https://www.townlong-yak.com/framexml/go/tIndexOf tIndexOf](<span style="font-size:smaller; color:#ecbc2a">tbl, item</span>) - Returns the index for a value in a table.
 
: <small>UI</small> [[API tContains|tContains]](<span style="font-size:smaller; color:#ecbc2a">tbl, item</span>) - Returns true if a (sequential) table contains a value.
 
: <small>UI</small> [https://www.townlong-yak.com/framexml/go/tDeleteItem tDeleteItem](<span style="font-size:smaller; color:#ecbc2a">tbl, item</span>) - Removes a value from a sequential table.
 
: <small>UI</small> [https://www.townlong-yak.com/framexml/go/tostringall tostringall](<span style="font-size:smaller; color:#ecbc2a">...</span>) - Converts and returns the passed arguments to string.
 
 
==== Mixins ====
 
These interfaces are defined in FrameXML.
 
: <small>UI</small> [[API Mixin|Mixin]](<span style="font-size:smaller; color:#ecbc2a">object, ...</span>) - Mixins mixins into an existing object and returns that.
 
: <small>UI</small> [[API CreateFromMixins|CreateFromMixins]](<span style="font-size:smaller; color:#ecbc2a">...</span>) - Mixins mixins into a new object and returns that.
 
 
: <small>UI</small> [https://www.townlong-yak.com/framexml/go/CreateColor CreateColor](<span style="font-size:smaller; color:#ecbc2a">r, g, b, a</span>) - Returns a [[ColorMixin]] object.
 
: <small>UI</small> [https://www.townlong-yak.com/framexml/go/CreateRectangle CreateRectangle](<span style="font-size:smaller; color:#ecbc2a">left, right, top, bottom</span>) - Returns a [[RectangleMixin]] object.
 
: <small>UI</small> [https://www.townlong-yak.com/framexml/live/go/CreateVector2D CreateVector2D](<span style="font-size:smaller; color:#ecbc2a">x, y</span>) - Returns a [[Vector2DMixin]] object.
 
: <small>UI</small> [https://www.townlong-yak.com/framexml/live/go/CreateVector3D CreateVector3D](<span style="font-size:smaller; color:#ecbc2a">x, y, z</span>) - Returns a [[Vector3DMixin]] object.
 
: <small>UI</small> [https://www.townlong-yak.com/framexml/9.0.2/ObjectAPI/Spell.lua#4 SpellMixin:CreateFromSpellID](<span style="font-size:smaller; color:#ecbc2a">spellID</span>) - Returns a [[SpellMixin]] object.
 
: <small>UI</small> [https://www.townlong-yak.com/framexml/9.0.2/ObjectAPI/Item.lua#40 Item:CreateFromItemID](<span style="font-size:smaller; color:#ecbc2a">itemID</span>) - Returns an [[ItemMixin]] object.
 
: <small>UI</small> [https://www.townlong-yak.com/framexml/9.0.2/ObjectAPI/ItemLocation.lua#9 ItemLocation:CreateFromBagAndSlot]() - Returns an [[ItemLocationMixin]] object.
 
: <small>UI</small> [https://www.townlong-yak.com/framexml/9.0.2/ObjectAPI/PlayerLocation.lua#4 PlayerLocation:CreateFromGUID](<span style="font-size:smaller; color:#ecbc2a">guid</span>) - Returns a [[PlayerLocationMixin]] object.
 
: <small>UI</small> [https://www.townlong-yak.com/framexml/9.0.2/TransmogUtil.lua#76 TransmogUtil.CreateTransmogLocation](<span style="font-size:smaller; color:#ecbc2a">slotDescriptor, transmogType, modification</span>) - Returns a [[TransmogLocationMixin]] object.
 
 
: <small>UI</small> [[API CreateObjectPool|CreateObjectPool]](<span style="font-size:smaller; color:#ecbc2a">creationFunc, resetterFunc</span>) - Creates a [[ObjectPoolMixin]] object for [[UIOBJECT UIObject|widgets]].
 
: <small>UI</small> [[API CreateFramePool|CreateFramePool]](<span style="font-size:smaller; color:#ecbc2a">frameType [, parent, frameTemplate, resetterFunc, forbidden]</span>) - Creates a [[FramePoolMixin]] for [[UIOBJECT Frame|Frames]].
 
: <small>UI</small> [[API CreateTexturePool|CreateTexturePool]](<span style="font-size:smaller; color:#ecbc2a">parent [, layer, subLayer, textureTemplate, resetterFunc]</span>) - Creates a [[TexturePoolMixin]] for [[UIOBJECT Texture|Textures]].
 
: <small>UI</small> [[API CreateFontStringPool|CreateFontStringPool]](<span style="font-size:smaller; color:#ecbc2a">parent [, layer, subLayer, fontStringTemplate, resetterFunc]</span>) - Creates a [[FontStringPoolMixin]] for [[UIOBJECT FontString|FontStrings]].
 
: <small>UI</small> [[API CreateActorPool|CreateActorPool]](<span style="font-size:smaller; color:#ecbc2a">parent [, actorTemplate, resetterFunc]</span>) - Creates an [[ActorPoolMixin]] for [[UIOBJECT Actor|Actors]].
 
: <small>UI</small> [https://www.townlong-yak.com/framexml/go/CreateFramePoolCollection CreateFramePoolCollection]() - Creates a [[FramePoolCollectionMixin]] object for [[FramePoolMixin|frame pools]].
 
   
 
=== Vehicles ===
 
=== Vehicles ===
Line 5,142: Line 5,104:
 
: [[API C_AnimaDiversion.SelectAnimaNode|C_AnimaDiversion.SelectAnimaNode]](<span style="font-size:smaller; color:#ecbc2a">talentID, temporary</span>)
 
: [[API C_AnimaDiversion.SelectAnimaNode|C_AnimaDiversion.SelectAnimaNode]](<span style="font-size:smaller; color:#ecbc2a">talentID, temporary</span>)
 
: [[API C_Item.IsAnimaItemByID|C_Item.IsAnimaItemByID]](<span style="font-size:smaller; color:#ecbc2a">itemInfo</span>) : <span style="font-size:smaller; color:#4ec9b0">isAnimaItem</span>
 
: [[API C_Item.IsAnimaItemByID|C_Item.IsAnimaItemByID]](<span style="font-size:smaller; color:#ecbc2a">itemInfo</span>) : <span style="font-size:smaller; color:#4ec9b0">isAnimaItem</span>
 
==== Chromie Time ====
 
[[Timewalking Campaigns]] scale older expansion zones up to level 50.
 
: [[API C_ChromieTime.CloseUI|C_ChromieTime.CloseUI]]()
 
: [[API C_ChromieTime.GetChromieTimeExpansionOption|C_ChromieTime.GetChromieTimeExpansionOption]](<span style="font-size:smaller; color:#ecbc2a">expansionRecID</span>) : <span style="font-size:smaller; color:#4ec9b0">info</span>
 
: [[API C_ChromieTime.GetChromieTimeExpansionOptions|C_ChromieTime.GetChromieTimeExpansionOptions]]() : <span style="font-size:smaller; color:#4ec9b0">expansionOptions</span>
 
: [[API C_ChromieTime.SelectChromieTimeOption|C_ChromieTime.SelectChromieTimeOption]](<span style="font-size:smaller; color:#ecbc2a">chromieTimeExpansionInfoId</span>)
 
: [[API C_PlayerInfo.CanPlayerEnterChromieTime|C_PlayerInfo.CanPlayerEnterChromieTime]]() : <span style="font-size:smaller; color:#4ec9b0">canEnter</span>
 
: [[API C_PlayerInfo.IsPlayerInChromieTime|C_PlayerInfo.IsPlayerInChromieTime]]() : <span style="font-size:smaller; color:#4ec9b0">inChromieTime</span>
 
: [[API UnitChromieTimeID|UnitChromieTimeID]](<span style="font-size:smaller; color:#ecbc2a">unit</span>) : <span style="font-size:smaller; color:#4ec9b0">ID</span>
 
   
 
==== Covenants ====
 
==== Covenants ====
Line 5,403: Line 5,355:
 
: [[API CancelTrackingBuff|CancelTrackingBuff]]() - Cancels your current tracking buff (skills like Find Minerals and Track Humanoids).
 
: [[API CancelTrackingBuff|CancelTrackingBuff]]() - Cancels your current tracking buff (skills like Find Minerals and Track Humanoids).
 
: [[API GetTrackingTexture|GetTrackingTexture]]() - Returns the texture of the active tracking buff.
 
: [[API GetTrackingTexture|GetTrackingTexture]]() - Returns the texture of the active tracking buff.
  +
  +
== FrameXML ==
  +
See also this [https://wow.gamepedia.com/Global_functions?oldid=5728117#FrameXML_Functions old list] of notable FrameXML functions.
  +
  +
=== MathUtil ===
  +
: <small>UI</small> [http://townlong-yak.com/framexml/go/Lerp Lerp](<span style="font-size:smaller; color:#ecbc2a">startValue, endValue, amount</span>) : <span style="font-size:smaller; color:#4ec9b0">''number''</span> - Linearly interpolates between two values for a parameter <code>amount</code> in the closed unit interval [0, 1]
  +
: <small>UI</small> [http://townlong-yak.com/framexml/go/Clamp Clamp](<span style="font-size:smaller; color:#ecbc2a">value, min, max</span>) : <span style="font-size:smaller; color:#4ec9b0">''number''</span>
  +
: <small>UI</small> [http://townlong-yak.com/framexml/go/Saturate Saturate](<span style="font-size:smaller; color:#ecbc2a">value</span>) : <span style="font-size:smaller; color:#4ec9b0">''number''</span>
  +
: <small>UI</small> [http://townlong-yak.com/framexml/go/Wrap Wrap](<span style="font-size:smaller; color:#ecbc2a">value, max</span>) : <span style="font-size:smaller; color:#4ec9b0">''number''</span>
  +
: <small>UI</small> [http://townlong-yak.com/framexml/go/ClampDegrees ClampDegrees](<span style="font-size:smaller; color:#ecbc2a">value</span>) : <span style="font-size:smaller; color:#4ec9b0">''number''</span>
  +
: <small>UI</small> [http://townlong-yak.com/framexml/go/ClampMod ClampMod](<span style="font-size:smaller; color:#ecbc2a">value, mod</span>) : <span style="font-size:smaller; color:#4ec9b0">''number''</span>
  +
: <small>UI</small> [http://townlong-yak.com/framexml/go/NegateIf NegateIf](<span style="font-size:smaller; color:#ecbc2a">value, condition</span>) : <span style="font-size:smaller; color:#4ec9b0">''number''</span>
  +
: <small>UI</small> [http://townlong-yak.com/framexml/go/PercentageBetween PercentageBetween](<span style="font-size:smaller; color:#ecbc2a">value, startValue, endValue</span>) : <span style="font-size:smaller; color:#4ec9b0">''number''</span>
  +
: <small>UI</small> [http://townlong-yak.com/framexml/go/ClampedPercentageBetween ClampedPercentageBetween](<span style="font-size:smaller; color:#ecbc2a">value, startValue, endValue</span>) : <span style="font-size:smaller; color:#4ec9b0">''number''</span>
  +
: <small>UI</small> [http://townlong-yak.com/framexml/go/DeltaLerp DeltaLerp](<span style="font-size:smaller; color:#ecbc2a">startValue, endValue, amount, timeSec</span>) : <span style="font-size:smaller; color:#4ec9b0">''number''</span>
  +
: <small>UI</small> [http://townlong-yak.com/framexml/go/FrameDeltaLerp FrameDeltaLerp](<span style="font-size:smaller; color:#ecbc2a">startValue, endValue, amount</span>) : <span style="font-size:smaller; color:#4ec9b0">''number''</span>
  +
: <small>UI</small> [http://townlong-yak.com/framexml/go/RandomFloatInRange RandomFloatInRange](<span style="font-size:smaller; color:#ecbc2a">minValue, maxValue</span>) : <span style="font-size:smaller; color:#4ec9b0">''number''</span>
  +
: <small>UI</small> [http://townlong-yak.com/framexml/go/Round Round](<span style="font-size:smaller; color:#ecbc2a">value</span>) : <span style="font-size:smaller; color:#4ec9b0">''number''</span> - Rounds a value.
  +
: <small>UI</small> [http://townlong-yak.com/framexml/go/Square Square](<span style="font-size:smaller; color:#ecbc2a">value</span>) : <span style="font-size:smaller; color:#4ec9b0">''number''</span> - Squares a value.
  +
: <small>UI</small> [http://townlong-yak.com/framexml/go/CalculateDistanceSq CalculateDistanceSq](<span style="font-size:smaller; color:#ecbc2a">x1, y1, x2, y2</span>) : <span style="font-size:smaller; color:#4ec9b0">''number''</span>
  +
: <small>UI</small> [http://townlong-yak.com/framexml/go/CalculateDistance CalculateDistance](<span style="font-size:smaller; color:#ecbc2a">x1, y1, x2, y2</span>) : <span style="font-size:smaller; color:#4ec9b0">''number''</span>
  +
: <small>UI</small> [http://townlong-yak.com/framexml/go/CalculateAngleBetween CalculateAngleBetween](<span style="font-size:smaller; color:#ecbc2a">x1, y1, x2, y2</span>) : <span style="font-size:smaller; color:#4ec9b0">''number''</span>
  +
  +
=== TableUtil ===
  +
: <small>UI</small> [http://townlong-yak.com/framexml/go/ripairs ripairs](<span style="font-size:smaller; color:#ecbc2a">tbl</span>) : <span style="font-size:smaller; color:#4ec9b0">iter, invariant, init</span> - Reverse iterates over a sequential table.
  +
: <small>UI</small> [http://townlong-yak.com/framexml/go/tDeleteItem tDeleteItem](<span style="font-size:smaller; color:#ecbc2a">tbl, item</span>) - Removes a value from a sequential table.
  +
: <small>UI</small> [http://townlong-yak.com/framexml/go/tIndexOf tIndexOf](<span style="font-size:smaller; color:#ecbc2a">tbl, item</span>) : <span style="font-size:smaller; color:#4ec9b0">index</span> - Returns the index for a value in a table.
  +
: <small>UI</small> [http://townlong-yak.com/framexml/go/tContains tContains](<span style="font-size:smaller; color:#ecbc2a">tbl, item</span>) : <span style="font-size:smaller; color:#4ec9b0">''boolean''</span> - Returns true if a sequential table contains a value.
  +
: <small>UI</small> [http://townlong-yak.com/framexml/go/tCompare tCompare](<span style="font-size:smaller; color:#ecbc2a">lhsTable, rhsTable, depth</span>) : <span style="font-size:smaller; color:#4ec9b0">''boolean''</span> - Does a deep compare on the values of the table.
  +
: <small>UI</small> [http://townlong-yak.com/framexml/go/tInvert tInvert](<span style="font-size:smaller; color:#ecbc2a">tbl</span>) : <span style="font-size:smaller; color:#4ec9b0">''table''</span> - Returns an inverted table.
  +
: <small>UI</small> [http://townlong-yak.com/framexml/go/tFilter tFilter](<span style="font-size:smaller; color:#ecbc2a">tbl, pred, isIndexTable</span>) : <span style="font-size:smaller; color:#4ec9b0">''table''</span>
  +
: <small>UI</small> [http://townlong-yak.com/framexml/go/tAppendAll tAppendAll](<span style="font-size:smaller; color:#ecbc2a">table, addedArray</span>) - Appends the contents of a sequential table to another table.
  +
: <small>UI</small> [http://townlong-yak.com/framexml/go/tUnorderedRemove tUnorderedRemove](<span style="font-size:smaller; color:#ecbc2a">tbl, index</span>)
  +
: <small>UI</small> [http://townlong-yak.com/framexml/go/CopyTable CopyTable](<span style="font-size:smaller; color:#ecbc2a">settings</span>) : <span style="font-size:smaller; color:#4ec9b0">''table''</span> - Returns a deep copy of a table.
  +
: <small>UI</small> [http://townlong-yak.com/framexml/go/AccumulateIf AccumulateIf](<span style="font-size:smaller; color:#ecbc2a">tbl, pred</span>) : <span style="font-size:smaller; color:#4ec9b0">count</span>
  +
: <small>UI</small> [http://townlong-yak.com/framexml/go/ContainsIf ContainsIf](<span style="font-size:smaller; color:#ecbc2a">tbl, pred</span>) : <span style="font-size:smaller; color:#4ec9b0">''boolean''</span>
  +
: <small>UI</small> [http://townlong-yak.com/framexml/go/FindInTableIf FindInTableIf](<span style="font-size:smaller; color:#ecbc2a">tbl, pred</span>) : <span style="font-size:smaller; color:#4ec9b0">key, value</span>
  +
: <small>UI</small> [http://townlong-yak.com/framexml/go/SafePack SafePack](<span style="font-size:smaller; color:#ecbc2a">...</span>) : <span style="font-size:smaller; color:#4ec9b0">''table''</span>
  +
: <small>UI</small> [http://townlong-yak.com/framexml/go/SafeUnpack SafeUnpack](<span style="font-size:smaller; color:#ecbc2a">tbl</span>) : <span style="font-size:smaller; color:#4ec9b0">...</span>
  +
  +
=== CvarUtil ===
  +
: <small>UI</small> [http://townlong-yak.com/framexml/go/RegisterCVar RegisterCVar](<span style="font-size:smaller; color:#ecbc2a">name, value</span>)
  +
: <small>UI</small> [http://townlong-yak.com/framexml/go/ResetTestCvars ResetTestCvars]()
  +
: <small>UI</small> [http://townlong-yak.com/framexml/go/SetCVar SetCVar](<span style="font-size:smaller; color:#ecbc2a">name, value, eventName</span>) : <span style="font-size:smaller; color:#4ec9b0">success</span>
  +
: <small>UI</small> [http://townlong-yak.com/framexml/go/GetCVar GetCVar](<span style="font-size:smaller; color:#ecbc2a">name</span>) : <span style="font-size:smaller; color:#4ec9b0">value</span>
  +
: <small>UI</small> [http://townlong-yak.com/framexml/go/SetCVarBitfield SetCVarBitfield](<span style="font-size:smaller; color:#ecbc2a">name, index, value, scriptCVar</span>) : <span style="font-size:smaller; color:#4ec9b0">success</span>
  +
: <small>UI</small> [http://townlong-yak.com/framexml/go/GetCVarBitfield GetCVarBitfield](<span style="font-size:smaller; color:#ecbc2a">name, index</span>) : <span style="font-size:smaller; color:#4ec9b0">''boolean''</span>
  +
: <small>UI</small> [http://townlong-yak.com/framexml/go/GetCVarBool GetCVarBool](<span style="font-size:smaller; color:#ecbc2a">name</span>) : <span style="font-size:smaller; color:#4ec9b0">''boolean''</span>
  +
: <small>UI</small> [http://townlong-yak.com/framexml/go/GetCVarDefault GetCVarDefault](<span style="font-size:smaller; color:#ecbc2a">name</span>) : <span style="font-size:smaller; color:#4ec9b0">value</span>
  +
  +
=== Mixins ===
  +
[[Wikipedia:Mixin|Mixin]]s are similar to classes in OOP languages. An object can "inherit" from multiple mixins.
  +
: <small>UI</small> [https://www.townlong-yak.com/framexml/go/Mixin Mixin](<span style="font-size:smaller; color:#ecbc2a">object, ...</span>) - Mixins mixins into an existing object and returns that.
  +
: <small>UI</small> [https://www.townlong-yak.com/framexml/go/CreateFromMixins CreateFromMixins](<span style="font-size:smaller; color:#ecbc2a">...</span>) - Mixins mixins into a new object and returns that.
  +
  +
: <small>UI</small> [https://www.townlong-yak.com/framexml/go/CreateColor CreateColor](<span style="font-size:smaller; color:#ecbc2a">r, g, b, a</span>) - Returns a [[ColorMixin]] object.
  +
: <small>UI</small> [https://www.townlong-yak.com/framexml/go/CreateRectangle CreateRectangle](<span style="font-size:smaller; color:#ecbc2a">left, right, top, bottom</span>) - Returns a [[RectangleMixin]] object.
  +
: <small>UI</small> [https://www.townlong-yak.com/framexml/go/CreateVector2D CreateVector2D](<span style="font-size:smaller; color:#ecbc2a">x, y</span>) - Returns a [[Vector2DMixin]] object.
  +
: <small>UI</small> [https://www.townlong-yak.com/framexml/go/CreateVector3D CreateVector3D](<span style="font-size:smaller; color:#ecbc2a">x, y, z</span>) - Returns a [[Vector3DMixin]] object.
  +
: <small>UI</small> [https://www.townlong-yak.com/framexml/9.0.2/ObjectAPI/Spell.lua#4 SpellMixin:CreateFromSpellID](<span style="font-size:smaller; color:#ecbc2a">spellID</span>) - Returns a [[SpellMixin]] object.
  +
: <small>UI</small> [https://www.townlong-yak.com/framexml/9.0.2/ObjectAPI/Item.lua#40 Item:CreateFromItemID](<span style="font-size:smaller; color:#ecbc2a">itemID</span>) - Returns an [[ItemMixin]] object.
  +
: <small>UI</small> [https://www.townlong-yak.com/framexml/9.0.2/ObjectAPI/ItemLocation.lua#9 ItemLocation:CreateFromBagAndSlot]() - Returns an [[ItemLocationMixin]] object.
  +
: <small>UI</small> [https://www.townlong-yak.com/framexml/9.0.2/ObjectAPI/PlayerLocation.lua#4 PlayerLocation:CreateFromGUID](<span style="font-size:smaller; color:#ecbc2a">guid</span>) - Returns a [[PlayerLocationMixin]] object.
  +
: <small>UI</small> [https://www.townlong-yak.com/framexml/9.0.2/TransmogUtil.lua#76 TransmogUtil.CreateTransmogLocation](<span style="font-size:smaller; color:#ecbc2a">slotDescriptor, transmogType, modification</span>) - Returns a [[TransmogLocationMixin]] object.
  +
  +
: <small>UI</small> [https://www.townlong-yak.com/framexml/go/AnchorMixin AnchorMixin]
  +
: <small>UI</small> [https://www.townlong-yak.com/framexml/go/AnimatedNumericFontStringMixin AnimatedNumericFontStringMixin]
  +
: <small>UI</small> [https://www.townlong-yak.com/framexml/go/DoublyLinkedListMixin DoublyLinkedListMixin]
  +
: <small>UI</small> [https://www.townlong-yak.com/framexml/go/GridLayoutMixin GridLayoutMixin]
  +
: <small>UI</small> [https://www.townlong-yak.com/framexml/go/LineMixin LineMixin]
  +
: <small>UI</small> [https://www.townlong-yak.com/framexml/go/SecondsFormatterMixin SecondsFormatterMixin]
  +
: <small>UI</small> [https://www.townlong-yak.com/framexml/go/SparseGridMixin SparseGridMixin]
  +
: <small>UI</small> [https://www.townlong-yak.com/framexml/go/TextureLoadingGroupMixin TextureLoadingGroupMixin]
  +
  +
: <small>UI</small> [[API CreateObjectPool|CreateObjectPool]](<span style="font-size:smaller; color:#ecbc2a">creationFunc, resetterFunc</span>) - Creates a [[ObjectPoolMixin]] object for [[UIOBJECT UIObject|widgets]].
  +
: <small>UI</small> [[API CreateFramePool|CreateFramePool]](<span style="font-size:smaller; color:#ecbc2a">frameType [, parent, frameTemplate, resetterFunc, forbidden]</span>) - Creates a [[FramePoolMixin]] for [[UIOBJECT Frame|Frames]].
  +
: <small>UI</small> [[API CreateTexturePool|CreateTexturePool]](<span style="font-size:smaller; color:#ecbc2a">parent [, layer, subLayer, textureTemplate, resetterFunc]</span>) - Creates a [[TexturePoolMixin]] for [[UIOBJECT Texture|Textures]].
  +
: <small>UI</small> [[API CreateFontStringPool|CreateFontStringPool]](<span style="font-size:smaller; color:#ecbc2a">parent [, layer, subLayer, fontStringTemplate, resetterFunc]</span>) - Creates a [[FontStringPoolMixin]] for [[UIOBJECT FontString|FontStrings]].
  +
: <small>UI</small> [[API CreateActorPool|CreateActorPool]](<span style="font-size:smaller; color:#ecbc2a">parent [, actorTemplate, resetterFunc]</span>) - Creates an [[ActorPoolMixin]] for [[UIOBJECT Actor|Actors]].
  +
: <small>UI</small> [https://www.townlong-yak.com/framexml/go/CreateFramePoolCollection CreateFramePoolCollection]() - Creates a [[FramePoolCollectionMixin]] object for [[FramePoolMixin|frame pools]].
  +
  +
=== UIParent ===
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=AbbreviateLargeNumbers AbbreviateLargeNumbers](<span style="font-size:smaller; color:#ecbc2a">value</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=AbbreviateNumbers AbbreviateNumbers](<span style="font-size:smaller; color:#ecbc2a">value</span>)
  +
These functions toggle the Interface Panels, but if they use <code>ShowUIPanel()</code> they cannot be called in combat.
  +
: <small>UI</small> {{api|ShowUIPanel}}(<span style="font-size:smaller; color:#ecbc2a">frame, force</span>)
  +
: <small>UI</small> [https://www.townlong-yak.com/framexml/go/PVEFrame_ToggleFrame PVEFrame_ToggleFrame]() - Toggles the Group Finder.
  +
: <small>UI</small> [https://www.townlong-yak.com/framexml/go/ToggleAchievementFrame ToggleAchievementFrame]() - Shows the Achievements frame.
  +
: <small>UI</small> [[API ToggleCharacter|ToggleCharacter]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Toggles the character pane to the specified frame.
  +
: <small>UI</small> [https://www.townlong-yak.com/framexml/go/ToggleCollectionsJournal ToggleCollectionsJournal](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Toggles the Collections window.
  +
: <small>UI</small> [https://www.townlong-yak.com/framexml/go/ToggleEncounterJournal ToggleEncounterJournal]() - Toggles the Adventure Guide.
  +
: <small>UI</small> [[API ToggleFriendsFrame|ToggleFriendsFrame]](<span style="font-size:smaller; color:#ecbc2a">[tabNumber]</span>) - Opens/closes the friends pane, optionally on a specific tab.
  +
: <small>UI</small> [[API ToggleGameMenu|ToggleGameMenu]]() - Opens/closes the game menu.
  +
: <small>UI</small> [https://www.townlong-yak.com/framexml/go/ToggleGuildFrame ToggleGuildFrame]() - Toggles the Guild & Communites frame.
  +
: <small>UI</small> [https://www.townlong-yak.com/framexml/go/ToggleHelpFrame ToggleHelpFrame]() - Opens the Help Request frame.
  +
: <small>UI</small> [[API ToggleMinimap|ToggleMinimap]]() - Turns the minimap display on/off.
  +
: <small>UI</small> [[API TogglePVPUI|TogglePVPUI]]() - Opens/closes the PvP frame.
  +
: <small>UI</small> [[API ToggleSpellBook|ToggleSpellBook]](<span style="font-size:smaller; color:#ecbc2a">bookType</span>) - Shows the spellbook. Can show your spells or your pet's.
  +
: <small>UI</small> [[API ToggleTalentFrame|ToggleTalentFrame]]() - Opens the Talent frame.
  +
  +
  +
'''[https://github.com/Gethe/wow-ui-source/tree/live/SharedXML Interface/SharedXML]'''
  +
  +
=== AccountUtil ===
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GameLimitedMode_IsActive GameLimitedMode_IsActive]()
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetClampedCurrentExpansionLevel GetClampedCurrentExpansionLevel]()
  +
=== AnchorUtil ===
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=CreateAnchor AnchorUtil.CreateAnchor](<span style="font-size:smaller; color:#ecbc2a">point, relativeTo, relativePoint, x, y</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=CreateGridLayout AnchorUtil.CreateGridLayout](<span style="font-size:smaller; color:#ecbc2a">direction, rowSize, spacingX, spacingY</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=CreateAnchorFromPoint AnchorUtil.CreateAnchorFromPoint](<span style="font-size:smaller; color:#ecbc2a">region, pointIndex</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GridLayout AnchorUtil.GridLayout](<span style="font-size:smaller; color:#ecbc2a">frames, initialAnchor, layout</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GridLayoutFactoryByCount AnchorUtil.GridLayoutFactoryByCount](<span style="font-size:smaller; color:#ecbc2a">factoryFunction, count, initialAnchor, layout</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GridLayoutFactory AnchorUtil.GridLayoutFactory](<span style="font-size:smaller; color:#ecbc2a">factoryFunction, initialAnchor, totalWidth, totalHeight, overrideDirection, overridePaddingX, overridePaddingY</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=MirrorRegionsAlongVerticalAxis AnchorUtil.MirrorRegionsAlongVerticalAxis](<span style="font-size:smaller; color:#ecbc2a">mirrorDescriptions</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=MirrorRegionsAlongHorizontalAxis AnchorUtil.MirrorRegionsAlongHorizontalAxis](<span style="font-size:smaller; color:#ecbc2a">mirrorDescriptions</span>)
  +
=== ColorUtil ===
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=CreateColorFromHexString CreateColorFromHexString](<span style="font-size:smaller; color:#ecbc2a">hexColor</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=CreateColorFromBytes CreateColorFromBytes](<span style="font-size:smaller; color:#ecbc2a">r, g, b, a</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=AreColorsEqual AreColorsEqual](<span style="font-size:smaller; color:#ecbc2a">left, right</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetClassColor GetClassColor](<span style="font-size:smaller; color:#ecbc2a">classFilename</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetClassColorObj GetClassColorObj](<span style="font-size:smaller; color:#ecbc2a">classFilename</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetClassColoredTextForUnit GetClassColoredTextForUnit](<span style="font-size:smaller; color:#ecbc2a">unit, text</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetFactionColor GetFactionColor](<span style="font-size:smaller; color:#ecbc2a">factionGroupTag</span>)
  +
=== EasingUtil ===
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=InQuadratic EasingUtil.InQuadratic](<span style="font-size:smaller; color:#ecbc2a">percent</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=OutQuadratic EasingUtil.OutQuadratic](<span style="font-size:smaller; color:#ecbc2a">percent</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=InOutQuadratic EasingUtil.InOutQuadratic](<span style="font-size:smaller; color:#ecbc2a">percent</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=InCubic EasingUtil.InCubic](<span style="font-size:smaller; color:#ecbc2a">percent</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=OutCubic EasingUtil.OutCubic](<span style="font-size:smaller; color:#ecbc2a">percent</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=InOutCubic EasingUtil.InOutCubic](<span style="font-size:smaller; color:#ecbc2a">percent</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=InQuartic EasingUtil.InQuartic](<span style="font-size:smaller; color:#ecbc2a">percent</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=OutQuartic EasingUtil.OutQuartic](<span style="font-size:smaller; color:#ecbc2a">percent</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=InOutQuartic EasingUtil.InOutQuartic](<span style="font-size:smaller; color:#ecbc2a">percent</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=InQuintic EasingUtil.InQuintic](<span style="font-size:smaller; color:#ecbc2a">percent</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=OutQuintic EasingUtil.OutQuintic](<span style="font-size:smaller; color:#ecbc2a">percent</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=InOutQuintic EasingUtil.InOutQuintic](<span style="font-size:smaller; color:#ecbc2a">percent</span>)
  +
=== ErrorUtil ===
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=CallErrorHandler CallErrorHandler](<span style="font-size:smaller; color:#ecbc2a">...</span>)
  +
=== Flags ===
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=Flags_CreateMask Flags_CreateMask](<span style="font-size:smaller; color:#ecbc2a">...</span>) - Creates a bitmask.
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=Flags_CreateMaskFromTable Flags_CreateMaskFromTable](<span style="font-size:smaller; color:#ecbc2a">flagsTable</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=IsSet FlagsUtil.IsSet](<span style="font-size:smaller; color:#ecbc2a">bitMask, flagOrMask</span>)
  +
=== FormattingUtil ===
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=SplitTextIntoLines SplitTextIntoLines](<span style="font-size:smaller; color:#ecbc2a">text, delimiter</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=SplitTextIntoHeaderAndNonHeader SplitTextIntoHeaderAndNonHeader](<span style="font-size:smaller; color:#ecbc2a">text</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=FormatValueWithSign FormatValueWithSign](<span style="font-size:smaller; color:#ecbc2a">value</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=FormatLargeNumber FormatLargeNumber](<span style="font-size:smaller; color:#ecbc2a">amount</span>) - Formats a number with dot or comma number seperators.
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetMoneyString GetMoneyString](<span style="font-size:smaller; color:#ecbc2a">money, separateThousands</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=FormatPercentage FormatPercentage](<span style="font-size:smaller; color:#ecbc2a">percentage, roundToNearestInteger</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=FormatFraction FormatFraction](<span style="font-size:smaller; color:#ecbc2a">numerator, denominator</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetHighlightedNumberDifferenceString GetHighlightedNumberDifferenceString](<span style="font-size:smaller; color:#ecbc2a">baseString, newString</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=FormatUnreadMailTooltip FormatUnreadMailTooltip](<span style="font-size:smaller; color:#ecbc2a">tooltip, headerText, senders</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetCurrencyString GetCurrencyString](<span style="font-size:smaller; color:#ecbc2a">currencyID, overrideAmount, colorCode, abbreviate</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetCurrenciesString GetCurrenciesString](<span style="font-size:smaller; color:#ecbc2a">currencies</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=ReplaceGenderTokens ReplaceGenderTokens](<span style="font-size:smaller; color:#ecbc2a">string, gender</span>)
  +
=== FrameUtil ===
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=RegisterFrameForEvents FrameUtil.RegisterFrameForEvents](<span style="font-size:smaller; color:#ecbc2a">frame, events</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=UnregisterFrameForEvents FrameUtil.UnregisterFrameForEvents](<span style="font-size:smaller; color:#ecbc2a">frame, events</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=RegisterFrameForUnitEvents FrameUtil.RegisterFrameForUnitEvents](<span style="font-size:smaller; color:#ecbc2a">frame, events, ...</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=DoesAncestryInclude DoesAncestryInclude](<span style="font-size:smaller; color:#ecbc2a">ancestry, frame</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetUnscaledFrameRect GetUnscaledFrameRect](<span style="font-size:smaller; color:#ecbc2a">frame, scale</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=ApplyDefaultScale ApplyDefaultScale](<span style="font-size:smaller; color:#ecbc2a">frame, minScale, maxScale</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=UpdateScaleForFit UpdateScaleForFit](<span style="font-size:smaller; color:#ecbc2a">frame</span>)
  +
=== FunctionUtil ===
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=ExecuteFrameScript ExecuteFrameScript](<span style="font-size:smaller; color:#ecbc2a">frame, scriptName, ...</span>) - Manually calls the handler for a frame script.
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=CallMethodOnNearestAncestor CallMethodOnNearestAncestor](<span style="font-size:smaller; color:#ecbc2a">self, methodName, ...</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetValueOrCallFunction GetValueOrCallFunction](<span style="font-size:smaller; color:#ecbc2a">tbl, key, ...</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GenerateClosure GenerateClosure](<span style="font-size:smaller; color:#ecbc2a">f, ...</span>)
  +
=== InterfaceUtil ===
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=ReloadUI ReloadUI]()
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=OpenToSubscriptionProduct StoreInterfaceUtil.OpenToSubscriptionProduct]()
  +
=== LinkUtil ===
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=ExtractHyperlinkString ExtractHyperlinkString](<span style="font-size:smaller; color:#ecbc2a">linkString</span>) - Strips any UI escape sequence (e.g. color coding) from a [[UI_escape_sequences#Hyperlinks|hyperlink]].
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=ExtractLinkData ExtractLinkData](<span style="font-size:smaller; color:#ecbc2a">link</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=ExtractQuestRewardID ExtractQuestRewardID](<span style="font-size:smaller; color:#ecbc2a">linkString</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetItemInfoFromHyperlink GetItemInfoFromHyperlink](<span style="font-size:smaller; color:#ecbc2a">link</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetAchievementInfoFromHyperlink GetAchievementInfoFromHyperlink](<span style="font-size:smaller; color:#ecbc2a">link</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetURLIndexAndLoadURL GetURLIndexAndLoadURL](<span style="font-size:smaller; color:#ecbc2a">self, link</span>)
  +
  +
=== NineSlice ===
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=ApplyUniqueCornersLayout NineSliceUtil.ApplyUniqueCornersLayout](<span style="font-size:smaller; color:#ecbc2a">self, textureKit</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=ApplyIdenticalCornersLayout NineSliceUtil.ApplyIdenticalCornersLayout](<span style="font-size:smaller; color:#ecbc2a">self, textureKit</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=ApplyLayout NineSliceUtil.ApplyLayout](<span style="font-size:smaller; color:#ecbc2a">container, userLayout, textureKit</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=DisableSharpening NineSliceUtil.DisableSharpening](<span style="font-size:smaller; color:#ecbc2a">container</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=ApplyLayoutByName NineSliceUtil.ApplyLayoutByName](<span style="font-size:smaller; color:#ecbc2a">container, userLayoutName, textureKit</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetLayout NineSliceUtil.GetLayout](<span style="font-size:smaller; color:#ecbc2a">layoutName</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=AddLayout NineSliceUtil.AddLayout](<span style="font-size:smaller; color:#ecbc2a">layoutName, layout</span>)
  +
=== PixelUtil ===
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetPixelToUIUnitFactor PixelUtil.GetPixelToUIUnitFactor]()
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetNearestPixelSize PixelUtil.GetNearestPixelSize](<span style="font-size:smaller; color:#ecbc2a">uiUnitSize, layoutScale, minPixels</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=SetWidth PixelUtil.SetWidth](<span style="font-size:smaller; color:#ecbc2a">region, width, minPixels</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=SetHeight PixelUtil.SetHeight](<span style="font-size:smaller; color:#ecbc2a">region, height, minPixels</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=SetSize PixelUtil.SetSize](<span style="font-size:smaller; color:#ecbc2a">region, width, height, minWidthPixels, minHeightPixels</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=SetPoint PixelUtil.SetPoint](<span style="font-size:smaller; color:#ecbc2a">region, point, relativeTo, relativePoint, offsetX, offsetY, minOffsetXPixels, minOffsetYPixels</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=SetStatusBarValue PixelUtil.SetStatusBarValue](<span style="font-size:smaller; color:#ecbc2a">statusBar, value</span>)
  +
=== RegionUtil ===
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=IsDescendantOf RegionUtil.IsDescendantOf](<span style="font-size:smaller; color:#ecbc2a">potentialDescendant, potentialAncestor</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=IsDescendantOfOrSame RegionUtil.IsDescendantOfOrSame](<span style="font-size:smaller; color:#ecbc2a">potentialDescendant, potentialAncestorOrSame</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=CalculateDistanceSqBetween RegionUtil.CalculateDistanceSqBetween](<span style="font-size:smaller; color:#ecbc2a">region1, region2</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=CalculateDistanceBetween RegionUtil.CalculateDistanceBetween](<span style="font-size:smaller; color:#ecbc2a">region1, region2</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=CalculateAngleBetween RegionUtil.CalculateAngleBetween](<span style="font-size:smaller; color:#ecbc2a">region1, region2</span>)
  +
=== RestrictedInfrastructure ===
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=tostringall tostringall](<span style="font-size:smaller; color:#ecbc2a">...</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=IsFrameHandle IsFrameHandle](<span style="font-size:smaller; color:#ecbc2a">handle, protected</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetFrameHandleFrame GetFrameHandleFrame](<span style="font-size:smaller; color:#ecbc2a">handle, protected, onlyProtected</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetFrameHandle GetFrameHandle](<span style="font-size:smaller; color:#ecbc2a">frame, protected</span>)
  +
=== ScriptAnimationUtil ===
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetScriptAnimationLock ScriptAnimationUtil.GetScriptAnimationLock](<span style="font-size:smaller; color:#ecbc2a">region</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=ReleaseScriptAnimationLock ScriptAnimationUtil.ReleaseScriptAnimationLock](<span style="font-size:smaller; color:#ecbc2a">region</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=IsScriptAnimationLockActive ScriptAnimationUtil.IsScriptAnimationLockActive](<span style="font-size:smaller; color:#ecbc2a">region</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=ShakeFrameRandom ScriptAnimationUtil.ShakeFrameRandom](<span style="font-size:smaller; color:#ecbc2a">region, magnitude, duration, frequency</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=ShakeFrame ScriptAnimationUtil.ShakeFrame](<span style="font-size:smaller; color:#ecbc2a">region, shake, maximumDuration, frequency</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GenerateEasedVariationCallback ScriptAnimationUtil.GenerateEasedVariationCallback](<span style="font-size:smaller; color:#ecbc2a">easingFunction, distanceX, distanceY, alpha, scale</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=StartScriptAnimation ScriptAnimationUtil.StartScriptAnimation](<span style="font-size:smaller; color:#ecbc2a">region, variationCallback, duration, onFinish</span>)
  +
=== ScriptedAnimationEffects ===
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetEffectByID ScriptedAnimationEffectsUtil.GetEffectByID](<span style="font-size:smaller; color:#ecbc2a">effectID</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=ReloadDB ScriptedAnimationEffectsUtil.ReloadDB]()
  +
=== TextureUtil ===
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetTextureInfo GetTextureInfo](<span style="font-size:smaller; color:#ecbc2a">obj</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=SetClampedTextureRotation SetClampedTextureRotation](<span style="font-size:smaller; color:#ecbc2a">texture, rotationDegrees</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=ClearClampedTextureRotation ClearClampedTextureRotation](<span style="font-size:smaller; color:#ecbc2a">texture</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetTexCoordsByGrid GetTexCoordsByGrid](<span style="font-size:smaller; color:#ecbc2a">xOffset, yOffset, textureWidth, textureHeight, gridWidth, gridHeight</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetTexCoordsForRole GetTexCoordsForRole](<span style="font-size:smaller; color:#ecbc2a">role</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=CreateTextureMarkup CreateTextureMarkup](<span style="font-size:smaller; color:#ecbc2a">file, fileWidth, fileHeight, width, height, left, right, top, bottom, xOffset, yOffset</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=CreateAtlasMarkup CreateAtlasMarkup](<span style="font-size:smaller; color:#ecbc2a">atlasName, width, height, offsetX, offsetY</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=SetupAtlasesOnRegions SetupAtlasesOnRegions](<span style="font-size:smaller; color:#ecbc2a">frame, regionsToAtlases, useAtlasSize</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetFinalNameFromTextureKit GetFinalNameFromTextureKit](<span style="font-size:smaller; color:#ecbc2a">fmt, textureKits</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=SetupTextureKitOnFrame SetupTextureKitOnFrame](<span style="font-size:smaller; color:#ecbc2a">textureKit, frame, fmt, setVisibility, useAtlasSize</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=SetupTextureKitOnFrames SetupTextureKitOnFrames](<span style="font-size:smaller; color:#ecbc2a">textureKit, frames, setVisibilityOfRegions, useAtlasSize</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=SetupTextureKitOnRegions SetupTextureKitOnRegions](<span style="font-size:smaller; color:#ecbc2a">textureKit, frame, regions, setVisibilityOfRegions, useAtlasSize</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=SetupTextureKitsFromRegionInfo SetupTextureKitsFromRegionInfo](<span style="font-size:smaller; color:#ecbc2a">textureKit, frame, regionInfoList</span>)
  +
=== TimeUtil ===
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=SecondsToMinutes SecondsToMinutes](<span style="font-size:smaller; color:#ecbc2a">seconds</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=MinutesToSeconds MinutesToSeconds](<span style="font-size:smaller; color:#ecbc2a">minutes</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=HasTimePassed HasTimePassed](<span style="font-size:smaller; color:#ecbc2a">testTime, amountOfTime</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=SecondsToClock SecondsToClock](<span style="font-size:smaller; color:#ecbc2a">seconds, displayZeroHours</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=SecondsToTime SecondsToTime](<span style="font-size:smaller; color:#ecbc2a">seconds, noSeconds, notAbbreviated, maxCount, roundUp</span>) - Converts a number of seconds into a readable formatted string.
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=SecondsToTimeAbbrev SecondsToTimeAbbrev](<span style="font-size:smaller; color:#ecbc2a">seconds</span>) - Converts a number of seconds into a readable and abbreviated formatted string.
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=FormatShortDate FormatShortDate](<span style="font-size:smaller; color:#ecbc2a">day, month, year</span>)
  +
  +
=== UnitUtil ===
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetPlayerGuid GetPlayerGuid]()
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=IsPlayerGuid IsPlayerGuid](<span style="font-size:smaller; color:#ecbc2a">guid</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=IsPlayerInitialSpec IsPlayerInitialSpec]()
  +
  +
  +
'''[https://github.com/Gethe/wow-ui-source/tree/live/FrameXML Interface/FrameXML]'''
  +
=== AchievementUtil ===
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=IsCriteriaAchievementEarned AchievementUtil.IsCriteriaAchievementEarned](<span style="font-size:smaller; color:#ecbc2a">achievementID, criteriaIndex</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=IsCriteriaReputationGained AchievementUtil.IsCriteriaReputationGained](<span style="font-size:smaller; color:#ecbc2a">achievementID, criteriaIndex, checkCriteriaAchievement, countHiddenCriteria</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=IsCategoryFeatOfStrength AchievementUtil.IsCategoryFeatOfStrength](<span style="font-size:smaller; color:#ecbc2a">category</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=IsFeatOfStrength AchievementUtil.IsFeatOfStrength](<span style="font-size:smaller; color:#ecbc2a">achievementID</span>)
  +
=== ActionButtonUtil ===
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=ShowAllActionButtonGrids ActionButtonUtil.ShowAllActionButtonGrids]()
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=HideAllActionButtonGrids ActionButtonUtil.HideAllActionButtonGrids]()
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=SetAllQuickKeybindButtonHighlights ActionButtonUtil.SetAllQuickKeybindButtonHighlights](<span style="font-size:smaller; color:#ecbc2a">show</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=ShowAllQuickKeybindButtonHighlights ActionButtonUtil.ShowAllQuickKeybindButtonHighlights]()
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=HideAllQuickKeybindButtonHighlights ActionButtonUtil.HideAllQuickKeybindButtonHighlights]()
  +
=== AzeriteEssenceUtil ===
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=HasAnyUnlockableMilestones AzeriteEssenceUtil.HasAnyUnlockableMilestones]()
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetMilestoneAtPowerLevel AzeriteEssenceUtil.GetMilestoneAtPowerLevel](<span style="font-size:smaller; color:#ecbc2a">powerLevel</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetMilestoneSpellInfo AzeriteEssenceUtil.GetMilestoneSpellInfo](<span style="font-size:smaller; color:#ecbc2a">milestoneID</span>)
  +
=== AzeriteUtil ===
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=EnumerateEquipedAzeriteEmpoweredItems AzeriteUtil.EnumerateEquipedAzeriteEmpoweredItems]()
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=AreAnyAzeriteEmpoweredItemsEquipped AzeriteUtil.AreAnyAzeriteEmpoweredItemsEquipped]()
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=DoEquippedItemsHaveUnselectedPowers AzeriteUtil.DoEquippedItemsHaveUnselectedPowers]()
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetEquippedItemsUnselectedPowersCount AzeriteUtil.GetEquippedItemsUnselectedPowersCount]()
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GenerateRequiredSpecTooltipLine AzeriteUtil.GenerateRequiredSpecTooltipLine](<span style="font-size:smaller; color:#ecbc2a">powerID</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=FindAzeritePowerTier AzeriteUtil.FindAzeritePowerTier](<span style="font-size:smaller; color:#ecbc2a">azeriteEmpoweredItemSource, powerID</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetSelectedAzeritePowerInTier AzeriteUtil.GetSelectedAzeritePowerInTier](<span style="font-size:smaller; color:#ecbc2a">azeriteEmpoweredItemSource, tierIndex</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=HasSelectedAnyAzeritePower AzeriteUtil.HasSelectedAnyAzeritePower](<span style="font-size:smaller; color:#ecbc2a">azeriteEmpoweredItemSource</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=DoesBagContainAnyAzeriteEmpoweredItems AzeriteUtil.DoesBagContainAnyAzeriteEmpoweredItems](<span style="font-size:smaller; color:#ecbc2a">bagID</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=IsAzeriteItemLocationBankBag AzeriteUtil.IsAzeriteItemLocationBankBag](<span style="font-size:smaller; color:#ecbc2a">azeriteItemLocation</span>)
  +
=== CalendarUtil ===
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetCalendarInviteStatusInfo CalendarUtil.GetCalendarInviteStatusInfo](<span style="font-size:smaller; color:#ecbc2a">inviteStatus</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetEventBroadcastText CalendarUtil.GetEventBroadcastText](<span style="font-size:smaller; color:#ecbc2a">event</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetOngoingEventBroadcastText CalendarUtil.GetOngoingEventBroadcastText](<span style="font-size:smaller; color:#ecbc2a">event</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=FormatCalendarTimeWeekday CalendarUtil.FormatCalendarTimeWeekday](<span style="font-size:smaller; color:#ecbc2a">messageDate</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=AreDatesEqual CalendarUtil.AreDatesEqual](<span style="font-size:smaller; color:#ecbc2a">firstCalendarTime, secondCalendarTime</span>)
  +
=== CampaignUtil ===
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=BuildChapterProgressText CampaignUtil.BuildChapterProgressText](<span style="font-size:smaller; color:#ecbc2a">campaign, formatString</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetSingleChapterText CampaignUtil.GetSingleChapterText](<span style="font-size:smaller; color:#ecbc2a">chapterID, lineSpacing</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=BuildAllChaptersText CampaignUtil.BuildAllChaptersText](<span style="font-size:smaller; color:#ecbc2a">campaign, lineSpacing</span>)
  +
=== CommunitiesUtil ===
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetMemberRGB CommunitiesUtil.GetMemberRGB](<span style="font-size:smaller; color:#ecbc2a">memberInfo</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=SortClubs CommunitiesUtil.SortClubs](<span style="font-size:smaller; color:#ecbc2a">clubs</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=SortStreams CommunitiesUtil.SortStreams](<span style="font-size:smaller; color:#ecbc2a">streams</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=SortMemberInfo CommunitiesUtil.SortMemberInfo](<span style="font-size:smaller; color:#ecbc2a">clubId, memberInfoArray</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetMemberIdsSortedByName CommunitiesUtil.GetMemberIdsSortedByName](<span style="font-size:smaller; color:#ecbc2a">clubId, streamId</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetMemberInfo CommunitiesUtil.GetMemberInfo](<span style="font-size:smaller; color:#ecbc2a">clubId, memberIds</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetMemberInfoLookup CommunitiesUtil.GetMemberInfoLookup](<span style="font-size:smaller; color:#ecbc2a">memberInfoArray</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetOnlineMembers CommunitiesUtil.GetOnlineMembers](<span style="font-size:smaller; color:#ecbc2a">memberInfoArray</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=SortMembersByList CommunitiesUtil.SortMembersByList](<span style="font-size:smaller; color:#ecbc2a">memberInfoLookup, memberIds</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetAndSortMemberInfo CommunitiesUtil.GetAndSortMemberInfo](<span style="font-size:smaller; color:#ecbc2a">clubId, streamId, filterOffline</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=DoesAnyCommunityHaveUnreadMessages CommunitiesUtil.DoesAnyCommunityHaveUnreadMessages]()
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=DoesOtherCommunityHaveUnreadMessages CommunitiesUtil.DoesOtherCommunityHaveUnreadMessages](<span style="font-size:smaller; color:#ecbc2a">ignoreClubId</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=DoesCommunityHaveUnreadMessages CommunitiesUtil.DoesCommunityHaveUnreadMessages](<span style="font-size:smaller; color:#ecbc2a">clubId</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=DoesCommunityHaveOtherUnreadMessages CommunitiesUtil.DoesCommunityHaveOtherUnreadMessages](<span style="font-size:smaller; color:#ecbc2a">clubId, ignoreStreamId</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetStreamNotificationSettingsLookup CommunitiesUtil.GetStreamNotificationSettingsLookup](<span style="font-size:smaller; color:#ecbc2a">clubId</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=DoesCommunityStreamHaveUnreadMessages CommunitiesUtil.DoesCommunityStreamHaveUnreadMessages](<span style="font-size:smaller; color:#ecbc2a">clubId, streamId</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=CanKickClubMember CommunitiesUtil.CanKickClubMember](<span style="font-size:smaller; color:#ecbc2a">clubPrivileges, memberInfo</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=ClearAllUnreadNotifications CommunitiesUtil.ClearAllUnreadNotifications](<span style="font-size:smaller; color:#ecbc2a">clubId</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=OpenInviteDialog CommunitiesUtil.OpenInviteDialog](<span style="font-size:smaller; color:#ecbc2a">clubId, streamId</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=FindCommunityAndStreamByName CommunitiesUtil.FindCommunityAndStreamByName](<span style="font-size:smaller; color:#ecbc2a">communityName, streamName</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=FindGuildStreamByType CommunitiesUtil.FindGuildStreamByType](<span style="font-size:smaller; color:#ecbc2a">clubStreamType</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetRoleSpecClassLine CommunitiesUtil.GetRoleSpecClassLine](<span style="font-size:smaller; color:#ecbc2a">classID, specID</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=AddLookingForLines CommunitiesUtil.AddLookingForLines](<span style="font-size:smaller; color:#ecbc2a">tooltip, recruitingSpecIds, recruitingSpecIdMap, playerSpecs</span>)
  +
=== CovenantUtil ===
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetRenownRewardDisplayData CovenantUtil.GetRenownRewardDisplayData](<span style="font-size:smaller; color:#ecbc2a">rewardInfo, onItemUpdateCallback</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetUnformattedRenownRewardInfo CovenantUtil.GetUnformattedRenownRewardInfo](<span style="font-size:smaller; color:#ecbc2a">rewardInfo, onItemUpdateCallback</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetRenownRewardInfo CovenantUtil.GetRenownRewardInfo](<span style="font-size:smaller; color:#ecbc2a">rewardInfo, onItemUpdateCallback</span>)
  +
=== CurrencyContainer ===
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetCurrencyContainerInfo CurrencyContainerUtil.GetCurrencyContainerInfo](<span style="font-size:smaller; color:#ecbc2a">currencyID, numItems, name, texture, quality</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetCurrencyContainerInfoForAlert CurrencyContainerUtil.GetCurrencyContainerInfoForAlert](<span style="font-size:smaller; color:#ecbc2a">currencyID, quantity, name, texture, quality</span>)
  +
=== DifficultyUtil ===
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetDifficultyName DifficultyUtil.GetDifficultyName](<span style="font-size:smaller; color:#ecbc2a">difficultyID</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=IsPrimaryRaid DifficultyUtil.IsPrimaryRaid](<span style="font-size:smaller; color:#ecbc2a">difficultyID</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetNextPrimaryRaidDifficultyID DifficultyUtil.GetNextPrimaryRaidDifficultyID](<span style="font-size:smaller; color:#ecbc2a">difficultyID</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetMaxPlayers DifficultyUtil.GetMaxPlayers](<span style="font-size:smaller; color:#ecbc2a">difficultyID</span>)
  +
=== ItemRef ===
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=SetItemRef SetItemRef](<span style="font-size:smaller; color:#ecbc2a">link, text, button, chatFrame</span>) - Handles item link tooltips in chat.
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetFixedLink GetFixedLink](<span style="font-size:smaller; color:#ecbc2a">text, quality</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetBattlePetAbilityHyperlink GetBattlePetAbilityHyperlink](<span style="font-size:smaller; color:#ecbc2a">abilityID, maxHealth, power, speed</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetPlayerLink GetPlayerLink](<span style="font-size:smaller; color:#ecbc2a">characterName, linkDisplayText, lineID, chatType, chatTarget</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetBNPlayerLink GetBNPlayerLink](<span style="font-size:smaller; color:#ecbc2a">name, linkDisplayText, bnetIDAccount, lineID, chatType, chatTarget</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetGMLink GetGMLink](<span style="font-size:smaller; color:#ecbc2a">gmName, linkDisplayText, lineID</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetBNPlayerCommunityLink GetBNPlayerCommunityLink](<span style="font-size:smaller; color:#ecbc2a">playerName, linkDisplayText, bnetIDAccount, clubId, streamId, epoch, position</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetPlayerCommunityLink GetPlayerCommunityLink](<span style="font-size:smaller; color:#ecbc2a">playerName, linkDisplayText, clubId, streamId, epoch, position</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetClubTicketLink GetClubTicketLink](<span style="font-size:smaller; color:#ecbc2a">ticketId, clubName, clubType</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetClubFinderLink GetClubFinderLink](<span style="font-size:smaller; color:#ecbc2a">clubFinderId, clubName</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetCalendarEventLink GetCalendarEventLink](<span style="font-size:smaller; color:#ecbc2a">monthOffset, monthDay, index</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetCommunityLink GetCommunityLink](<span style="font-size:smaller; color:#ecbc2a">clubId</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=SplitLink LinkUtil.SplitLink](<span style="font-size:smaller; color:#ecbc2a">link</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=ExtractLink LinkUtil.ExtractLink](<span style="font-size:smaller; color:#ecbc2a">text</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=IsLinkType LinkUtil.IsLinkType](<span style="font-size:smaller; color:#ecbc2a">link, matchLinkType</span>)
  +
=== ItemUtil ===
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=RegisterCallback ItemButtonUtil.RegisterCallback](<span style="font-size:smaller; color:#ecbc2a">...</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=UnregisterCallback ItemButtonUtil.UnregisterCallback](<span style="font-size:smaller; color:#ecbc2a">...</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=TriggerEvent ItemButtonUtil.TriggerEvent](<span style="font-size:smaller; color:#ecbc2a">...</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetItemContext ItemButtonUtil.GetItemContext]()
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=HasItemContext ItemButtonUtil.HasItemContext]()
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetItemContextMatchResultForItem ItemButtonUtil.GetItemContextMatchResultForItem](<span style="font-size:smaller; color:#ecbc2a">itemLocation</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetItemContextMatchResultForContainer ItemButtonUtil.GetItemContextMatchResultForContainer](<span style="font-size:smaller; color:#ecbc2a">bagID</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetItemDetails ItemUtil.GetItemDetails](<span style="font-size:smaller; color:#ecbc2a">itemLink, quantity, isCurrency, lootSource</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=PickupBagItem ItemUtil.PickupBagItem](<span style="font-size:smaller; color:#ecbc2a">itemLocation</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetOptionalReagentCount ItemUtil.GetOptionalReagentCount](<span style="font-size:smaller; color:#ecbc2a">itemID</span>)
  +
=== MapUtil ===
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=IsMapTypeZone MapUtil.IsMapTypeZone](<span style="font-size:smaller; color:#ecbc2a">mapID</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetMapParentInfo MapUtil.GetMapParentInfo](<span style="font-size:smaller; color:#ecbc2a">mapID, mapType, topMost</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=ShouldMapTypeShowQuests MapUtil.ShouldMapTypeShowQuests](<span style="font-size:smaller; color:#ecbc2a">mapType</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=ShouldShowTask MapUtil.ShouldShowTask](<span style="font-size:smaller; color:#ecbc2a">mapID, info</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=MapHasUnlockedBounties MapUtil.MapHasUnlockedBounties](<span style="font-size:smaller; color:#ecbc2a">mapID</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=MapHasEmissaries MapUtil.MapHasEmissaries](<span style="font-size:smaller; color:#ecbc2a">mapID</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=FindBestAreaNameAtMouse MapUtil.FindBestAreaNameAtMouse](<span style="font-size:smaller; color:#ecbc2a">mapID, normalizedCursorX, normalizedCursorY</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetDisplayableMapForPlayer MapUtil.GetDisplayableMapForPlayer]()
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetBountySetMaps MapUtil.GetBountySetMaps](<span style="font-size:smaller; color:#ecbc2a">bountySetID</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetMapCenterOnMap MapUtil.GetMapCenterOnMap](<span style="font-size:smaller; color:#ecbc2a">mapID, topMapID</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=IsChildMap MapUtil.IsChildMap](<span style="font-size:smaller; color:#ecbc2a">mapID, ancestorMapID</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=IsOribosMap MapUtil.IsOribosMap](<span style="font-size:smaller; color:#ecbc2a">mapID</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=IsShadowlandsZoneMap MapUtil.IsShadowlandsZoneMap](<span style="font-size:smaller; color:#ecbc2a">mapID</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=MapShouldShowWorldQuestFilters MapUtil.MapShouldShowWorldQuestFilters](<span style="font-size:smaller; color:#ecbc2a">mapID</span>)
  +
=== PVPUtil ===
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetTierName PVPUtil.GetTierName](<span style="font-size:smaller; color:#ecbc2a">tierEnum</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=ShouldShowLegacyRewards PVPUtil.ShouldShowLegacyRewards]()
  +
=== PartyUtil ===
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetMinLevel PartyUtil.GetMinLevel]()
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetPhasedReasonString PartyUtil.GetPhasedReasonString](<span style="font-size:smaller; color:#ecbc2a">phaseReason, unitToken</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetGroupMemberCountsForDisplay GetGroupMemberCountsForDisplay]()
  +
=== QuestUtils ===
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetWorldQuestAtlasInfo QuestUtil.GetWorldQuestAtlasInfo](<span style="font-size:smaller; color:#ecbc2a">worldQuestType, inProgress, tradeskillLineID</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetQuestIconOffer QuestUtil.GetQuestIconOffer](<span style="font-size:smaller; color:#ecbc2a">isLegendary, frequency, isRepeatable, isCampaign, isCovenantCalling</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=ApplyQuestIconOfferToTexture QuestUtil.ApplyQuestIconOfferToTexture](<span style="font-size:smaller; color:#ecbc2a">texture, ...</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetQuestIconActive QuestUtil.GetQuestIconActive](<span style="font-size:smaller; color:#ecbc2a">isComplete, isLegendary, frequency, isRepeatable, isCampaign, isCovenantCalling</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=ApplyQuestIconActiveToTexture QuestUtil.ApplyQuestIconActiveToTexture](<span style="font-size:smaller; color:#ecbc2a">texture, ...</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=ShouldQuestIconsUseCampaignAppearance QuestUtil.ShouldQuestIconsUseCampaignAppearance](<span style="font-size:smaller; color:#ecbc2a">questID</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetQuestIconOfferForQuestID QuestUtil.GetQuestIconOfferForQuestID](<span style="font-size:smaller; color:#ecbc2a">questID</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=ApplyQuestIconOfferToTextureForQuestID QuestUtil.ApplyQuestIconOfferToTextureForQuestID](<span style="font-size:smaller; color:#ecbc2a">texture, ...</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetQuestIconActiveForQuestID QuestUtil.GetQuestIconActiveForQuestID](<span style="font-size:smaller; color:#ecbc2a">questID</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=ApplyQuestIconActiveToTextureForQuestID QuestUtil.ApplyQuestIconActiveToTextureForQuestID](<span style="font-size:smaller; color:#ecbc2a">texture, ...</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=SetupWorldQuestButton QuestUtil.SetupWorldQuestButton](<span style="font-size:smaller; color:#ecbc2a">button, info, inProgress, selected, isCriteria, isSpellTarget, isEffectivelyTracked</span>)
  +
=== RuneforgeUtil ===
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetCostsString RuneforgeUtil.GetCostsString](<span style="font-size:smaller; color:#ecbc2a">costs</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=IsUpgradeableRuneforgeLegendary RuneforgeUtil.IsUpgradeableRuneforgeLegendary](<span style="font-size:smaller; color:#ecbc2a">itemLocation</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetRuneforgeFilterText RuneforgeUtil.GetRuneforgeFilterText](<span style="font-size:smaller; color:#ecbc2a">filter</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetPreviewClassAndSpec RuneforgeUtil.GetPreviewClassAndSpec]()
  +
=== TitleUtil ===
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetNameFromTitleMaskID TitleUtil.GetNameFromTitleMaskID](<span style="font-size:smaller; color:#ecbc2a">titleMaskID</span>)
  +
=== TransmogUtil ===
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetInfoForEquippedSlot TransmogUtil.GetInfoForEquippedSlot](<span style="font-size:smaller; color:#ecbc2a">transmogLocation</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=CanEnchantSource TransmogUtil.CanEnchantSource](<span style="font-size:smaller; color:#ecbc2a">sourceID</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetWeaponInfoForEnchant TransmogUtil.GetWeaponInfoForEnchant](<span style="font-size:smaller; color:#ecbc2a">transmogLocation</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetBestWeaponInfoForIllusionDressup TransmogUtil.GetBestWeaponInfoForIllusionDressup]()
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetSlotID TransmogUtil.GetSlotID](<span style="font-size:smaller; color:#ecbc2a">slotName</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetSlotName TransmogUtil.GetSlotName](<span style="font-size:smaller; color:#ecbc2a">slotID</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=CreateTransmogLocation TransmogUtil.CreateTransmogLocation](<span style="font-size:smaller; color:#ecbc2a">slotDescriptor, transmogType, modification</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetTransmogLocation TransmogUtil.GetTransmogLocation](<span style="font-size:smaller; color:#ecbc2a">slotDescriptor, transmogType, modification</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetTransmogLocationLookupKey TransmogUtil.GetTransmogLocationLookupKey](<span style="font-size:smaller; color:#ecbc2a">slotID, transmogType, modification</span>)
  +
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetSetIcon TransmogUtil.GetSetIcon](<span style="font-size:smaller; color:#ecbc2a">setID</span>)
   
 
== See also ==
 
== See also ==

Latest revision as of 12:45, 26 February 2021

Contents

For a complete and automatically generated list, see Global functions.
Navigate to: #Classic, #FrameXML

The WoW API is a set of functions to interact with and modify the World of Warcraft user interface available to addons and macro scripts.

Wowpedia maintains the list below, newer API is also officially documented in Blizzard_APIDocumentation and accessible with the /api command. The user interface code, also known as the FrameXML can be exported from the game client. Functions are prefixed with the following tags:

  • PROTECTED - This can only be called from secure code.
  • NOCOMBAT - This cannot be called from insecure code while in combat.
  • HW - This may only be called in response to a hardware event (user input).
  • UI - This is implemented in FrameXML but was considered important enough to be listed.

API Reference

Note
Note: This list is up to date as of Patch 9.0.2 (36949) Dec 14 2020

Account

Relates to the subscription Account. See also Battle.net functions.

GetBillingTimeRested() - Returns the account rested time left. This function is only relevant on Chinese realms.
GetRestrictedAccountData() - Returns the cap on trial character level, money and profession skill.
GetSecondsUntilParentalControlsKick()
IsAccountSecured() - Returns if the account has been secured with Blizzard Mobile Authenticator.
IsRestrictedAccount() - Returns if the acount has trial account restrictions.
IsTrialAccount() : isTrialAccount - Returns whether the player is using a trial (free-to-play) account.
IsVeteranTrialAccount() : isVeteranTrialAccount - Returns whether the wow account has no game time.
NoPlayTime() - Returns whether the account is considered "unhealthy". This function is only relevant on Chinese realms.
PartialPlayTime() - Returns whether the account is considered "tired". This function is only relevant on Chinese realms.
SendSubscriptionInterstitialResponse(response)

Achievements

Achievements were added in Patch 3.0.2

C_AchievementInfo.GetRewardItemID(achievementID) : rewardItemID - Returns whether a GUID is related to the local (self) account.
C_AchievementInfo.GetSupercedingAchievements(achievementID) : supercedingAchievements - Returns the next achievement in a series.
C_AchievementInfo.IsValidAchievement(achievementId) : isValidAchievement
C_AchievementInfo.SetPortraitTexture(textureObject) - Sets a portrait texture for the unit being achievement compared.
AddTrackedAchievement(achievementId) - Add an achievement to tracking.
AreAccountAchievementsHidden()
CanShowAchievementUI() - Returns if the AchievementUI can be displayed.
ClearAchievementComparisonUnit() - Remove the unit being compared.
ClearAchievementSearchString()
GetAchievementCategory(achievementID) - Returns the category number the requested achievement belongs to.
GetAchievementComparisonInfo(achievementID) - Returns information about the comparison unit's achievements.
GetAchievementCriteriaInfo(achievementID, criteriaNum) - Returns information about the requested criteria.
GetAchievementCriteriaInfoByID(achievementID, criteriaIndex) - Returns achievement criteria info by criteriaIndex.
GetAchievementGuildRep()
GetAchievementInfo(achievementID or categoryID, index) - Returns information about the requested achievement.
GetAchievementLink(achievementID) - Returns a achievementLink for the specified achievement.
GetAchievementNumCriteria(achievementID) - Returns the number of criteria the requested achievement has.
GetAchievementNumRewards(achievementID) - Returns the number of rewards the requested achievement has.
GetAchievementReward(achievementID, rewardIndex) - Returns information about a reward item by rewardIndex.
GetAchievementSearchProgress()
GetAchievementSearchSize()
GetCategoryAchievementPoints(categoryID, includeSubCategories)
GetCategoryInfo(category) - Returns information about the requested achievement category.
GetCategoryList() - Returns the list of achievement categories.
GetCategoryNumAchievements(category [, includeAll) - Returns the number of achievements, and number completed and incompleted for the specific category.
GetComparisonAchievementPoints() - Returns the total number of achievement points the comparison unit has earned.
GetComparisonCategoryNumAchievements(achievementID) - Returns a number of achievements in a category for the comparison player.
GetFilteredAchievementID(index) - Returns the ID of a filtered achievement.
GetGuildAchievementMemberInfo(achievementID, index)
GetGuildAchievementMembers(achievementID)
GetGuildAchievementNumMembers(achievementID)
GetLatestCompletedAchievements() - Returns the ID's of the last 5 completed Achievements.
GetLatestCompletedComparisonAchievements() - Returns a list of the latest updated achievements for the comparison player.
GetNextAchievement(achievementID) - Returns the next achievement in a chain.
GetNumComparisonCompletedAchievements() - Returns the number of completed achievements for the comparison player.
GetNumCompletedAchievements() - Returns the total number of achievements, and number completed.
GetNumFilteredAchievements() - Returns the number of achievements that matches search text.
GetNumTrackedAchievements() - Returns the total number of the currently tracked achievements.
GetPreviousAchievement(achievementID) - Returns previous related achievements.
GetTotalAchievementPoints() - Returns the total number of achievement points earned.
GetTrackedAchievements() - Returns the achievementID of the currently tracked achievements.
HasCompletedAnyAchievement(achievementID)
IsAchievementEligible(achievementID)
IsTrackedAchievement(achievementID)
RemoveTrackedAchievement(achievementID) - Stops an achievement from being tracked.
SetAchievementComparisonUnit(unitId) - Set the unit to be compared to.
SetAchievementSearchString(searchText) - Starts a search for achievements containing the specified text.
SetFocusedAchievement(achievementID)
ShowAccountAchievements()
SwitchAchievementSearchTab(index)

Statistics

GetComparisonStatistic(achievementID) - Returns the value of the requested statistic for the comparison player.
GetLatestUpdatedComparisonStats() - Returns a list of the latest updated statistics for the comparison player.
GetLatestUpdatedStats() - Returns the ID's of the last 5 updated Statistics.
GetStatistic(achievementID) - Returns the value of the requested statistic.
GetStatisticsCategoryList() - Returns the list of statistic categories.

AddOns

Relates to AddOns.

DisableAddOn(addonIndex or AddOnName [, character]) - Disable the specified AddOn for subsequent sessions.
DisableAllAddOns([character]) - Disable all AddOns for subsequent sessions.
EnableAddOn(addonIndex or AddOnName [, character]) - Enable the specified AddOn for subsequent sessions.
EnableAllAddOns([character]) - Enable all AddOns for subsequent sessions.
GetAddOnDependencies(addonIndex or AddOnName) - Get dependency list for an AddOn.
GetAddOnEnableState([character], addonIndex or AddOnName)
GetAddOnInfo(addonIndex or AddOnName) - Get information about an AddOn.
GetAddOnMetadata(addonIndex or AddOnName, variable) - Retrieve metadata from addon's TOC file.
GetAddOnOptionalDependencies(addonIndex or AddOnName) - Returns a list of optional dependencies.
GetNumAddOns() - Get the number of user supplied AddOns.
IsAddOnLoaded(addonIndex or AddOnName) - Returns true if the specified AddOn is loaded.
IsAddOnLoadOnDemand(addonIndex or AddOnName) - Test whether an AddOn is load-on-demand.
IsAddonVersionCheckEnabled()
LoadAddOn(addonIndex or AddOnName) - Request loading of a Load-On-Demand AddOn.
ResetAddOns()
ResetDisabledAddOns()
SaveAddOns()
SetAddonVersionCheck(boolean)
UI UIParentLoadAddOn(AddOnName) - Loads or Reloads the specified AddOn, and pops up an error message if it fails to load for any reason.

Adventure Guide

The Adventure Guide was added in Patch 6.2.0

C_AdventureJournal.ActivateEntry(index)
C_AdventureJournal.CanBeShown()
C_AdventureJournal.GetNumAvailableSuggestions()
C_AdventureJournal.GetPrimaryOffset()
C_AdventureJournal.GetReward()
C_AdventureJournal.GetSuggestions([suggestions])
C_AdventureJournal.SetPrimaryOffset(offset)
C_AdventureJournal.UpdateSuggestions([levelUp])

Encounter Journal

The Encounter Journal was added in Patch 4.2.0

C_EncounterJournal.GetDungeonEntrancesForMap(uiMapID) : dungeonEntrances - Returns the instance entrances for a map.
C_EncounterJournal.GetEncountersOnMap(uiMapID) : encounters - Returns boss pin locations for an instance map.
C_EncounterJournal.GetSectionIconFlags(sectionID) : iconFlags - Returns the icon flags for a section, such as Magic Effect and Heroic Difficulty
C_EncounterJournal.GetSectionInfo(sectionID) : info - Returns information about an entry in the Abilities section of the Encounter Journal.
C_EncounterJournal.InstanceHasLoot([instanceID]) : hasLoot - Returns whether an instance has a loot table in the journal.
C_EncounterJournal.IsEncounterComplete(journalEncounterID) : isEncounterComplete - Returns if a boss encounter has been completed.
C_EncounterJournal.SetPreviewMythicPlusLevel(level)
C_EncounterJournal.SetPreviewPvpTier(tier)
C_RaidLocks.IsEncounterComplete(mapID, encounterID [, difficultyID]) : encounterIsComplete
EJ_ClearSearch() - Clears the encounter journal search results.
EJ_EndSearch() - Ends any active encounter journal search.
EJ_GetContentTuningID() - Returns the currently selected content tuning ID for BFA instances.
EJ_GetCreatureInfo(index [, encounterID]) - Returns encounter boss info.
EJ_GetCurrentTier() - Returns the currently active encounter journal tier index.
EJ_GetDifficulty() - Returns the currently viewed difficulty in the journal.
EJ_GetEncounterInfo(encounterID) - Returns encounter info from the journal.
EJ_GetEncounterInfoByIndex(index [, instanceID]) - idem
EJ_GetInstanceByIndex(index, isRaid) - Returns instance info for the Encounter Journal.
EJ_GetInstanceForMap(mapID) - Returns any corresponding instance ID for a UiMapID.
EJ_GetInstanceInfo() - Returns instance info for the Encounter Journal.
EJ_GetMapEncounter(mapID, index [, fromJournal]) - Returns boss pin locations on instance maps.
EJ_GetNumEncountersForLootByIndex(index) - Returns the amount of encounters that drop the same loot item.
EJ_GetNumSearchResults() - Returns the number of search results for the Encounter Journal.
EJ_GetNumTiers() - Returns the number of valid encounter journal tier indices.
EJ_GetSearchProgress() - Returns the search bar's progress ratio.
EJ_GetSearchResult(index) - Returns search results for the Encounter Journal.
EJ_GetSearchSize() - Returns the amount of Encounter Journal objects to search through.
EJ_GetSectionPath(sectionID) - Returns the parent Section ID if available.
EJ_GetTierInfo(index) - Get some information about the encounter journal tier for index.
EJ_HandleLinkPath(jtype, id) - Returns the supplementary instance and encounter ID for an encounter or section ID.
EJ_InstanceIsRaid() - Returns whether the selected instance is a raid.
EJ_IsSearchFinished() - Returns whether the current search has finished.
EJ_IsValidInstanceDifficulty(difficultyID) - Returns whether the difficultyID is valid for use in the journal.
EJ_SelectEncounter(encounterID) - Selects an encounter for the Encounter Journal API state.
EJ_SelectInstance(instanceID) - Selects an instance for the Encounter Journal API state.
EJ_SelectTier(index) - Selects a tier for the Encounter Journal API state.
EJ_SetDifficulty(difficultyID) - Sets the encounter difficulty shown in the Encounter Journal.
EJ_SetSearch(text) - Starts a search in the journal.
GetJournalInfoForSpellConfirmation(spellID)
SetPortraitTextureFromCreatureDisplayID(textureObject, creatureDisplayID)

Loot Journal

C_EncounterJournal.GetLootInfo(id) : itemInfo - Returns loot info for an encounter or instance.
C_EncounterJournal.GetLootInfoByIndex(index [, encounterIndex]) : itemInfo - Returns loot info for an encounter or instance.
C_EncounterJournal.GetSlotFilter() : filter - Returns the current equipment type slot filter.
C_EncounterJournal.ResetSlotFilter() - Resets the current slot filter.
C_EncounterJournal.SetSlotFilter(filterSlot) - Sets the Encounter Journal's equipment slot filter.
EJ_GetInvTypeSortOrder(invType) - Returns the sort order for an inventory type.
EJ_GetLootFilter() - Returns the currently used loot filter.
EJ_GetNumLoot() - Returns the amount of loot for the currently selected instance or encounter.
EJ_IsLootListOutOfDate() - Returns whether the loot list is out of date in relation to any filters when getting new loot data.
EJ_ResetLootFilter() - Clears any current loot filter in the journal.
EJ_SetLootFilter(classID, specID) - Sets the loot filter for a specialization.

Auction House

The Auction House was revamped in Patch 8.3.0

C_AuctionHouse.GetNumReplicateItems() : numReplicateItems - Returns the amount of auctions.
C_AuctionHouse.GetReplicateItemBattlePetInfo(index) : creatureID, displayID
C_AuctionHouse.GetReplicateItemInfo(index) : name, texture, count, qualityID, usable, level, levelType, minBid, ... - Returns information about the specified auction.
C_AuctionHouse.GetReplicateItemLink(index) : itemLink
C_AuctionHouse.GetReplicateItemTimeLeft(index) : timeLeft - Returns the time left for an auction.
C_AuctionHouse.ReplicateItems() - Queries all auctions listed on the Auction House.
C_AuctionHouse.CalculateCommodityDeposit(itemID, duration, quantity) : depositCost
C_AuctionHouse.CalculateItemDeposit(item, duration, quantity) : depositCost
C_AuctionHouse.CanCancelAuction(ownedAuctionID) : canCancelAuction
C_AuctionHouse.CancelAuction(ownedAuctionID)
C_AuctionHouse.CancelCommoditiesPurchase()
C_AuctionHouse.CancelSell()
C_AuctionHouse.CloseAuctionHouse()
C_AuctionHouse.ConfirmCommoditiesPurchase(itemID, quantity) - Completes a commodity item purchase.
C_AuctionHouse.FavoritesAreAvailable() : favoritesAreAvailable
C_AuctionHouse.GetAuctionItemSubClasses(classID) : subClasses
C_AuctionHouse.GetAvailablePostCount(item) : listCount
C_AuctionHouse.GetBidInfo(bidIndex) : bid
C_AuctionHouse.GetBidType(bidTypeIndex) : typeItemKey
C_AuctionHouse.GetBrowseResults() : browseResults
C_AuctionHouse.GetCancelCost(ownedAuctionID) : cancelCost
C_AuctionHouse.GetCommoditySearchResultInfo(itemID, commoditySearchResultIndex) : result - Returns search results for a commodity item.
C_AuctionHouse.GetCommoditySearchResultsQuantity(itemID) : totalQuantity
C_AuctionHouse.GetExtraBrowseInfo(itemKey) : extraInfo
C_AuctionHouse.GetFilterGroups() : filterGroups
C_AuctionHouse.GetItemCommodityStatus(item) : isCommodity
C_AuctionHouse.GetItemKeyFromItem(item) : itemKey
C_AuctionHouse.GetItemKeyInfo(itemKey [, restrictQualityToFilter]) : itemKeyInfo
C_AuctionHouse.GetItemKeyRequiredLevel(itemKey) : requiredLevel
C_AuctionHouse.GetItemSearchResultInfo(itemKey, itemSearchResultIndex) : result - Returns search results for an item.
C_AuctionHouse.GetItemSearchResultsQuantity(itemKey) : totalQuantity
C_AuctionHouse.GetMaxBidItemBid() : maxBid
C_AuctionHouse.GetMaxBidItemBuyout() : maxBuyout
C_AuctionHouse.GetMaxCommoditySearchResultPrice(itemID) : maxUnitPrice
C_AuctionHouse.GetMaxItemSearchResultBid(itemKey) : maxBid
C_AuctionHouse.GetMaxItemSearchResultBuyout(itemKey) : maxBuyout
C_AuctionHouse.GetMaxOwnedAuctionBid() : maxBid
C_AuctionHouse.GetMaxOwnedAuctionBuyout() : maxBuyout
C_AuctionHouse.GetNumBids() : numBids
C_AuctionHouse.GetNumBidTypes() : numBidTypes
C_AuctionHouse.GetNumCommoditySearchResults(itemID) : numSearchResults
C_AuctionHouse.GetNumItemSearchResults(itemKey) : numItemSearchResults
C_AuctionHouse.GetNumOwnedAuctions() : numOwnedAuctions
C_AuctionHouse.GetNumOwnedAuctionTypes() : numOwnedAuctionTypes
C_AuctionHouse.GetOwnedAuctionInfo(ownedAuctionIndex) : ownedAuction
C_AuctionHouse.GetOwnedAuctionType(ownedAuctionTypeIndex) : typeItemKey
C_AuctionHouse.GetQuoteDurationRemaining() : quoteDurationSeconds
C_AuctionHouse.GetTimeLeftBandInfo(timeLeftBand) : timeLeftMinSeconds, timeLeftMaxSeconds
C_AuctionHouse.HasFavorites() : hasFavorites
C_AuctionHouse.HasFullBidResults() : hasFullBidResults
C_AuctionHouse.HasFullBrowseResults() : hasFullBrowseResults
C_AuctionHouse.HasFullCommoditySearchResults(itemID) : hasFullResults
C_AuctionHouse.HasFullItemSearchResults(itemKey) : hasFullResults
C_AuctionHouse.HasFullOwnedAuctionResults() : hasFullOwnedAuctionResults
C_AuctionHouse.HasMaxFavorites() : hasMaxFavorites
C_AuctionHouse.HasSearchResults(itemKey) : hasSearchResults
C_AuctionHouse.IsFavoriteItem(itemKey) : isFavorite
C_AuctionHouse.IsSellItemValid(item [, displayError]) : valid
C_AuctionHouse.IsThrottledMessageSystemReady() : canSendThrottledMessage
C_AuctionHouse.MakeItemKey(itemID [, itemLevel, itemSuffix, battlePetSpeciesID]) : itemKey
HW C_AuctionHouse.PlaceBid(auctionID, bidAmount) - Places a bid on a non-commodity item.
HW C_AuctionHouse.PostCommodity(item, duration, quantity, unitPrice) - Posts a commodity item on the auction house.
HW C_AuctionHouse.PostItem(item, duration, quantity [, bid, buyout]) - Posts an item on the auction house.
C_AuctionHouse.QueryBids(sorts, auctionIDs)
C_AuctionHouse.QueryOwnedAuctions(sorts)
C_AuctionHouse.RefreshCommoditySearchResults(itemID)
C_AuctionHouse.RefreshItemSearchResults(itemKey)
C_AuctionHouse.RequestMoreBrowseResults()
C_AuctionHouse.RequestMoreCommoditySearchResults(itemID) : hasFullResults
C_AuctionHouse.RequestMoreItemSearchResults(itemKey) : hasFullResults
C_AuctionHouse.RequestOwnedAuctionBidderInfo(auctionID) : bidderName
C_AuctionHouse.SearchForFavorites(sorts) - Searches for favorited items.
C_AuctionHouse.SearchForItemKeys(itemKeys, sorts)
C_AuctionHouse.SendBrowseQuery(query)
C_AuctionHouse.SendSearchQuery(itemKey, sorts, separateOwnerItems) - Queries an item in the auction house.
C_AuctionHouse.SendSellSearchQuery(itemKey, sorts, separateOwnerItems) - Search for all auctions that are variants of a piece of gear, determined a specific item ID.
C_AuctionHouse.SetFavoriteItem(itemKey, setFavorite)
HW C_AuctionHouse.StartCommoditiesPurchase(itemID, quantity) - Starts a commodity item purchase.

Black Market AH

The Black Market Auction House was added in Patch 5.0.4

C_BlackMarket.Close() - Notifies the server that the Black Market UI was closed.
C_BlackMarket.GetHotItem() - Returns information about the current "hot item" at the Black Market Auction House.
C_BlackMarket.GetItemInfoByID(marketID) - Returns information about a specific black market auction.
C_BlackMarket.GetItemInfoByIndex(index) - Returns information about a specific black market auction.
C_BlackMarket.GetNumItems() - Returns the number of auctions on the Black Market Auction House.
C_BlackMarket.IsViewOnly()
HW C_BlackMarket.ItemPlaceBid(marketID, bid) - Places a bid on a black market auction.
C_BlackMarket.RequestItems() - Requests updated black market auction information from the server.

WoW Tokens

WoW Tokens were added in Patch 6.1.2

C_WowTokenPublic.BuyToken()
C_WowTokenPublic.GetCommerceSystemStatus()
C_WowTokenPublic.GetCurrentMarketPrice()