Wowpedia

We have moved to Warcraft Wiki. Click here for information and the new URL.

READ MORE

Wowpedia
Register
No edit summary
Tag: WoW API docs
(→‎Communities: SetClubMemberNote)
Tag: WoW API docs
(40 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
{{wowapi|notitle=1}} {{tocright}}
 
{{wowapi|notitle=1}} {{tocright}}
 
:<span class="noexcerpt" data-nosnippet>[[File:Battlenet_icon_flat.svg|24px|link=]] ''For the Web API see https://develop.battle.net/documentation/world-of-warcraft''</span>
 
:<span class="noexcerpt" data-nosnippet>[[File:Battlenet_icon_flat.svg|24px|link=]] ''For the Web API see https://develop.battle.net/documentation/world-of-warcraft''</span>
The '''WoW API''' is available to [[AddOn]]s and macro scripts. More recent functions are officially documented in [https://github.com/Gethe/wow-ui-source/tree/live/Interface/AddOns/Blizzard_APIDocumentation Blizzard_APIDocumentation] and accessible with the [[APILink|/api]] command. The [[Lua]] user interface code can be [[Viewing_Blizzard%27s_interface_code|exported]] from the game client. For guidelines on contributing see [[Wowpedia:How to edit API pages|How to edit API pages]].
+
The '''WoW API''' is available to [[AddOn]]s and macro scripts. More recent functions are officially documented in [https://github.com/Gethe/wow-ui-source/tree/live/Interface/AddOns/Blizzard_APIDocumentation Blizzard_APIDocumentation] and accessible with the [[APILink|/api]] command.<br>The [[Lua]] user interface code can be [[Viewing_Blizzard%27s_interface_code|exported]] from the game client. For guidelines on contributing see [[Wowpedia:How to edit API pages|How to edit API pages]].
   
 
{| class="darktable"
 
{| class="darktable"
 
|Functions are prefixed with the following tags:
 
|Functions are prefixed with the following tags:
* <font color="#dda0dd"><small>'''PROTECTED'''</small></font> - This can only be called from [[secure code]], i.e. by Blizzard.
+
* <font color="#dda0dd"><small>'''PROTECTED'''</small></font> - This can only be called by Blizzard code or from [[secure code|secure]] templates.
* <font color="#dda0dd"><small>'''HW'''</small></font> - This may only be called in response to a hardware event (user input).
+
* <font color="#dda0dd"><small>'''HW'''</small></font> - This may only be called in response to a hardware event, i.e. user input.
 
* <font color="#dda0dd"><small>'''NOCOMBAT'''</small></font> - This cannot be called from insecure code while in combat.
 
* <font color="#dda0dd"><small>'''NOCOMBAT'''</small></font> - This cannot be called from insecure code while in combat.
* <font color="#dda0dd"><small>'''NOINSTANCE'''</small></font> - This only works outdoors and not in instanced content (dungeons/raids/battlegrounds/arena)
+
* <font color="#dda0dd"><small>'''NOINSTANCE'''</small></font> - This only works outdoors and not in instanced content (dungeons/raids/battlegrounds/arena).
 
* <font color="#dda0dd"><small>'''NOSCRIPT'''</small> </font>- This may not be called ''directly'' from (macro) scripts, i.e. [[MACRO_script|/script]], {{api|loadstring}}() and WeakAuras.
 
* <font color="#dda0dd"><small>'''NOSCRIPT'''</small> </font>- This may not be called ''directly'' from (macro) scripts, i.e. [[MACRO_script|/script]], {{api|loadstring}}() and WeakAuras.
* <font color="#dda0dd"><small>'''DEPRECATED'''</small></font> - This function has been replaced or removed and its [https://github.com/Gethe/wow-ui-source/tree/live/Interface/AddOns/Blizzard_Deprecated placeholder] will be removed in the next expansion.
+
* <font color="#dda0dd"><small>'''DEPRECATED'''</small></font> - This is no longer used. Any backwards [https://github.com/Gethe/wow-ui-source/tree/live/Interface/AddOns/Blizzard_Deprecated compat] code will be removed in the next expansion.
 
* <font color="#dda0dd"><small>'''UI'''</small></font> - This is implemented in FrameXML but was considered important enough to be listed.
 
* <font color="#dda0dd"><small>'''UI'''</small></font> - This is implemented in FrameXML but was considered important enough to be listed.
 
|}
 
|}
Line 16: Line 16:
 
Sections: ''[[#Classic]], [[#FrameXML]], [[Global functions]]''
 
Sections: ''[[#Classic]], [[#FrameXML]], [[Global functions]]''
   
== API Reference ==
+
==API Reference==
 
<!-- https://github.com/Ketho/WowpediaApiDoc/tree/master/Pages/World_of_Warcraft_API -->
 
<!-- https://github.com/Ketho/WowpediaApiDoc/tree/master/Pages/World_of_Warcraft_API -->
{{i-note|This list is up to date as of [[Patch_9.2.0/API_changes|Patch 9.2.0]] (42521) Feb 25 2022}}
+
{{i-note|This list is up to date as of [[Patch_9.2.5/API_changes|Patch 9.2.5]] (43971) May 31 2022}}
   
=== Account ===
+
===Account===
 
Relates to the subscription [[Account]]. See also [[#Battle.net|Battle.net]] functions.
 
Relates to the subscription [[Account]]. See also [[#Battle.net|Battle.net]] functions.
: [[API GetBillingTimeRested|GetBillingTimeRested]]() - Returns the account rested time left. This function is only relevant on Chinese realms.
+
: [[API GetBillingTimeRested|GetBillingTimeRested]]() - Returns the amount of "healthy" time left for players on Chinese realms.
 
: [[API GetRestrictedAccountData|GetRestrictedAccountData]]() - Returns the cap on trial character level, money and profession skill.
 
: [[API GetRestrictedAccountData|GetRestrictedAccountData]]() - Returns the cap on trial character level, money and profession skill.
 
: [[API GetSecondsUntilParentalControlsKick|GetSecondsUntilParentalControlsKick]]()
 
: [[API GetSecondsUntilParentalControlsKick|GetSecondsUntilParentalControlsKick]]()
Line 29: Line 29:
 
: [[API IsTrialAccount|IsTrialAccount]]() : <span class="apiret">isTrialAccount</span> - Returns whether the player is using a trial (free-to-play) account.
 
: [[API IsTrialAccount|IsTrialAccount]]() : <span class="apiret">isTrialAccount</span> - Returns whether the player is using a trial (free-to-play) account.
 
: [[API IsVeteranTrialAccount|IsVeteranTrialAccount]]() : <span class="apiret">isVeteranTrialAccount</span> - Returns whether the wow account has no game time.
 
: [[API IsVeteranTrialAccount|IsVeteranTrialAccount]]() : <span class="apiret">isVeteranTrialAccount</span> - Returns whether the wow account has no game time.
: [[API NoPlayTime|NoPlayTime]]() - Returns whether the account is considered "unhealthy". This function is only relevant on Chinese realms.
+
: [[API NoPlayTime|NoPlayTime]]() - True if the account is considered "unhealthy" for players on Chinese realms.
: [[API PartialPlayTime|PartialPlayTime]]() - Returns whether the account is considered "tired". This function is only relevant on Chinese realms.
+
: [[API PartialPlayTime|PartialPlayTime]]() - True if the account is considered "tired" for players on Chinese realms.
 
: [[API SendSubscriptionInterstitialResponse|SendSubscriptionInterstitialResponse]](<span class="apiarg">response</span>)
 
: [[API SendSubscriptionInterstitialResponse|SendSubscriptionInterstitialResponse]](<span class="apiarg">response</span>)
   
=== Achievements ===
+
===Achievements===
 
[[Achievement]]s were added in [[Patch 3.0.2]]
 
[[Achievement]]s were added in [[Patch 3.0.2]]
 
: [[API C_AchievementInfo.GetRewardItemID|C_AchievementInfo.GetRewardItemID]](<span class="apiarg">achievementID</span>) : <span class="apiret">rewardItemID</span>
 
: [[API C_AchievementInfo.GetRewardItemID|C_AchievementInfo.GetRewardItemID]](<span class="apiarg">achievementID</span>) : <span class="apiret">rewardItemID</span>
Line 39: Line 39:
 
: [[API C_AchievementInfo.IsValidAchievement|C_AchievementInfo.IsValidAchievement]](<span class="apiarg">achievementId</span>) : <span class="apiret">isValidAchievement</span>
 
: [[API C_AchievementInfo.IsValidAchievement|C_AchievementInfo.IsValidAchievement]](<span class="apiarg">achievementId</span>) : <span class="apiret">isValidAchievement</span>
 
: [[API C_AchievementInfo.SetPortraitTexture|C_AchievementInfo.SetPortraitTexture]](<span class="apiarg">textureObject</span>) - Sets a portrait texture for the unit being achievement compared.
 
: [[API C_AchievementInfo.SetPortraitTexture|C_AchievementInfo.SetPortraitTexture]](<span class="apiarg">textureObject</span>) - Sets a portrait texture for the unit being achievement compared.
: [[API AddTrackedAchievement|AddTrackedAchievement]](<span class="apiarg">achievementId</span>) - Add an achievement to tracking.
+
: [[API AddTrackedAchievement|AddTrackedAchievement]](<span class="apiarg">achievementId</span>) - Tracks an achievement.
 
: [[API AreAccountAchievementsHidden|AreAccountAchievementsHidden]]()
 
: [[API AreAccountAchievementsHidden|AreAccountAchievementsHidden]]()
 
: [[API CanShowAchievementUI|CanShowAchievementUI]]() - Returns if the AchievementUI can be displayed.
 
: [[API CanShowAchievementUI|CanShowAchievementUI]]() - Returns if the AchievementUI can be displayed.
Line 46: Line 46:
 
: [[API GetAchievementCategory|GetAchievementCategory]](<span class="apiarg">achievementID</span>) - Returns the category number the requested achievement belongs to.
 
: [[API GetAchievementCategory|GetAchievementCategory]](<span class="apiarg">achievementID</span>) - Returns the category number the requested achievement belongs to.
 
: [[API GetAchievementComparisonInfo|GetAchievementComparisonInfo]](<span class="apiarg">achievementID</span>) - Returns information about the comparison unit's achievements.
 
: [[API GetAchievementComparisonInfo|GetAchievementComparisonInfo]](<span class="apiarg">achievementID</span>) - Returns information about the comparison unit's achievements.
: [[API GetAchievementCriteriaInfo|GetAchievementCriteriaInfo]](<span class="apiarg">achievementID, criteriaNum</span>) - Returns information about the requested criteria.
+
: [[API GetAchievementCriteriaInfo|GetAchievementCriteriaInfo]](<span class="apiarg">achievementID, criteriaNum</span>) - Returns info for the specified achievement criteria.
 
: [[API GetAchievementCriteriaInfoByID|GetAchievementCriteriaInfoByID]](<span class="apiarg">achievementID, criteriaIndex</span>) - Returns achievement criteria info by criteriaIndex.
 
: [[API GetAchievementCriteriaInfoByID|GetAchievementCriteriaInfoByID]](<span class="apiarg">achievementID, criteriaIndex</span>) - Returns achievement criteria info by criteriaIndex.
 
: [[API GetAchievementGuildRep|GetAchievementGuildRep]]()
 
: [[API GetAchievementGuildRep|GetAchievementGuildRep]]()
: [[API GetAchievementInfo|GetAchievementInfo]](<span class="apiarg">achievementID or categoryID, index</span>) - Returns information about the requested achievement.
+
: [[API GetAchievementInfo|GetAchievementInfo]](<span class="apiarg">achievementID or categoryID, index</span>) - Returns info for an achievement.
: [[API GetAchievementLink|GetAchievementLink]](<span class="apiarg">achievementID</span>) - Returns a [[achievementLink]] for the specified achievement.
+
: [[API GetAchievementLink|GetAchievementLink]](<span class="apiarg">achievementID</span>) - Returns an achievement link.
: [[API GetAchievementNumCriteria|GetAchievementNumCriteria]](<span class="apiarg">achievementID</span>) - Returns the number of criteria the requested achievement has.
+
: [[API GetAchievementNumCriteria|GetAchievementNumCriteria]](<span class="apiarg">achievementID</span>) - Returns the number of criteria for an achievement.
 
: [[API GetAchievementNumRewards|GetAchievementNumRewards]](<span class="apiarg">achievementID</span>) - Returns the number of rewards the requested achievement has.
 
: [[API GetAchievementNumRewards|GetAchievementNumRewards]](<span class="apiarg">achievementID</span>) - Returns the number of rewards the requested achievement has.
 
: [[API GetAchievementReward|GetAchievementReward]](<span class="apiarg">achievementID, rewardIndex</span>) - Returns information about a reward item by rewardIndex.
 
: [[API GetAchievementReward|GetAchievementReward]](<span class="apiarg">achievementID, rewardIndex</span>) - Returns information about a reward item by rewardIndex.
Line 57: Line 57:
 
: [[API GetAchievementSearchSize|GetAchievementSearchSize]]()
 
: [[API GetAchievementSearchSize|GetAchievementSearchSize]]()
 
: [[API GetCategoryAchievementPoints|GetCategoryAchievementPoints]](<span class="apiarg">categoryID, includeSubCategories</span>)
 
: [[API GetCategoryAchievementPoints|GetCategoryAchievementPoints]](<span class="apiarg">categoryID, includeSubCategories</span>)
: [[API GetCategoryInfo|GetCategoryInfo]](<span class="apiarg">category</span>) - Returns information about the requested achievement category.
+
: [[API GetCategoryInfo|GetCategoryInfo]](<span class="apiarg">category</span>) - Returns info for an achievement category.
 
: [[API GetCategoryList|GetCategoryList]]() - Returns the list of achievement categories.
 
: [[API GetCategoryList|GetCategoryList]]() - Returns the list of achievement categories.
: [[API GetCategoryNumAchievements|GetCategoryNumAchievements]](<span class="apiarg">category [, includeAll</span>) - Returns the number of achievements, and number completed and incompleted for the specific category.
+
: [[API GetCategoryNumAchievements|GetCategoryNumAchievements]](<span class="apiarg">category [, includeAll</span>) - Returns the number of achievements for a category.
 
: [[API GetComparisonAchievementPoints|GetComparisonAchievementPoints]]() - Returns the total number of achievement points the comparison unit has earned.
 
: [[API GetComparisonAchievementPoints|GetComparisonAchievementPoints]]() - Returns the total number of achievement points the comparison unit has earned.
 
: [[API GetComparisonCategoryNumAchievements|GetComparisonCategoryNumAchievements]](<span class="apiarg">achievementID</span>) - Returns a number of achievements in a category for the comparison player.
 
: [[API GetComparisonCategoryNumAchievements|GetComparisonCategoryNumAchievements]](<span class="apiarg">achievementID</span>) - Returns a number of achievements in a category for the comparison player.
: [[API GetFilteredAchievementID|GetFilteredAchievementID]](<span class="apiarg">index</span>) - Returns the ID of a filtered achievement.
+
: [[API GetFilteredAchievementID|GetFilteredAchievementID]](<span class="apiarg">index</span>) - Returns the ID of a filtered achievement by index.
 
: [[API GetGuildAchievementMemberInfo|GetGuildAchievementMemberInfo]](<span class="apiarg">achievementID, index</span>)
 
: [[API GetGuildAchievementMemberInfo|GetGuildAchievementMemberInfo]](<span class="apiarg">achievementID, index</span>)
 
: [[API GetGuildAchievementMembers|GetGuildAchievementMembers]](<span class="apiarg">achievementID</span>)
 
: [[API GetGuildAchievementMembers|GetGuildAchievementMembers]](<span class="apiarg">achievementID</span>)
Line 70: Line 70:
 
: [[API GetNextAchievement|GetNextAchievement]](<span class="apiarg">achievementID</span>) - Returns the next achievement in a chain.
 
: [[API GetNextAchievement|GetNextAchievement]](<span class="apiarg">achievementID</span>) - Returns the next achievement in a chain.
 
: [[API GetNumComparisonCompletedAchievements|GetNumComparisonCompletedAchievements]]() - Returns the number of completed achievements for the comparison player.
 
: [[API GetNumComparisonCompletedAchievements|GetNumComparisonCompletedAchievements]]() - Returns the number of completed achievements for the comparison player.
: [[API GetNumCompletedAchievements|GetNumCompletedAchievements]]() - Returns the total number of achievements, and number completed.
+
: [[API GetNumCompletedAchievements|GetNumCompletedAchievements]]() - Returns the total and completed number of achievements.
: [[API GetNumFilteredAchievements|GetNumFilteredAchievements]]() - Returns the number of achievements that matches search text.
+
: [[API GetNumFilteredAchievements|GetNumFilteredAchievements]]() - Returns the number of achievements after filtering.
: [[API GetNumTrackedAchievements|GetNumTrackedAchievements]]() - Returns the total number of the currently tracked achievements.
+
: [[API GetNumTrackedAchievements|GetNumTrackedAchievements]]() - Returns the number of tracked achievements.
: [[API GetPreviousAchievement|GetPreviousAchievement]](<span class="apiarg">achievementID</span>) - Returns previous related achievements.
+
: [[API GetPreviousAchievement|GetPreviousAchievement]](<span class="apiarg">achievementID</span>) - Returns the previous achievement in a chain.
 
: [[API GetTotalAchievementPoints|GetTotalAchievementPoints]]() - Returns the total number of achievement points earned.
 
: [[API GetTotalAchievementPoints|GetTotalAchievementPoints]]() - Returns the total number of achievement points earned.
: [[API GetTrackedAchievements|GetTrackedAchievements]]() - Returns the achievementID of the currently tracked achievements.
+
: [[API GetTrackedAchievements|GetTrackedAchievements]]() - Returns the currently tracked achievements.
 
: [[API HasCompletedAnyAchievement|HasCompletedAnyAchievement]](<span class="apiarg">achievementID</span>)
 
: [[API HasCompletedAnyAchievement|HasCompletedAnyAchievement]](<span class="apiarg">achievementID</span>)
 
: [[API IsAchievementEligible|IsAchievementEligible]](<span class="apiarg">achievementID</span>)
 
: [[API IsAchievementEligible|IsAchievementEligible]](<span class="apiarg">achievementID</span>)
 
: [[API IsTrackedAchievement|IsTrackedAchievement]](<span class="apiarg">achievementID</span>)
 
: [[API IsTrackedAchievement|IsTrackedAchievement]](<span class="apiarg">achievementID</span>)
: [[API RemoveTrackedAchievement|RemoveTrackedAchievement]](<span class="apiarg">achievementID</span>) - Stops an achievement from being tracked.
+
: [[API RemoveTrackedAchievement|RemoveTrackedAchievement]](<span class="apiarg">achievementID</span>) - Untracks an achievement from the WatchFrame.
: [[API SetAchievementComparisonUnit|SetAchievementComparisonUnit]](<span class="apiarg">unitId</span>) - Set the unit to be compared to.
+
: [[API SetAchievementComparisonUnit|SetAchievementComparisonUnit]](<span class="apiarg">unitId</span>) - Sets the unit to be compared to.
 
: [[API SetAchievementSearchString|SetAchievementSearchString]](<span class="apiarg">searchText</span>) - Starts a search for achievements containing the specified text.
 
: [[API SetAchievementSearchString|SetAchievementSearchString]](<span class="apiarg">searchText</span>) - Starts a search for achievements containing the specified text.
 
: [[API SetFocusedAchievement|SetFocusedAchievement]](<span class="apiarg">achievementID</span>)
 
: [[API SetFocusedAchievement|SetFocusedAchievement]](<span class="apiarg">achievementID</span>)
Line 86: Line 86:
 
: [[API SwitchAchievementSearchTab|SwitchAchievementSearchTab]](<span class="apiarg">index</span>)
 
: [[API SwitchAchievementSearchTab|SwitchAchievementSearchTab]](<span class="apiarg">index</span>)
   
==== Statistics ====
+
====Statistics====
: [[API GetComparisonStatistic|GetComparisonStatistic]](<span class="apiarg">achievementID</span>) - Returns the value of the requested statistic for the comparison player.
+
: [[API GetComparisonStatistic|GetComparisonStatistic]](<span class="apiarg">achievementID</span>) - Returns the specified statistic from the comparison player unit.
 
: [[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.
 
: [[API GetLatestUpdatedStats|GetLatestUpdatedStats]]() - Returns the ID's of the last 5 updated Statistics.
 
: [[API GetLatestUpdatedStats|GetLatestUpdatedStats]]() - Returns the ID's of the last 5 updated Statistics.
: [[API GetStatistic|GetStatistic]](<span class="apiarg">achievementID</span>) - Returns the value of the requested statistic.
+
: [[API GetStatistic|GetStatistic]](<span class="apiarg">achievementID</span>) - Returns a character statistic.
 
: [[API GetStatisticsCategoryList|GetStatisticsCategoryList]]() - Returns the list of statistic categories.
 
: [[API GetStatisticsCategoryList|GetStatisticsCategoryList]]() - Returns the list of statistic categories.
   
=== AddOns ===
+
===AddOns===
 
Relates to [[AddOn]]s.
 
Relates to [[AddOn]]s.
: [[API DisableAddOn|DisableAddOn]](<span class="apiarg">addonIndex or AddOnName [, character]</span>) - Disable the specified AddOn for subsequent sessions.
+
: [[API DisableAddOn|DisableAddOn]](<span class="apiarg">indexOrName [, characterOrAll]</span>) - Disables an addon for subsequent sessions.
 
: [[API DisableAllAddOns|DisableAllAddOns]](<span class="apiarg">[character]</span>) - Disable all AddOns for subsequent sessions.
 
: [[API DisableAllAddOns|DisableAllAddOns]](<span class="apiarg">[character]</span>) - Disable all AddOns for subsequent sessions.
: [[API EnableAddOn|EnableAddOn]](<span class="apiarg">addonIndex or AddOnName [, character]</span>) - Enable the specified AddOn for subsequent sessions.
+
: [[API EnableAddOn|EnableAddOn]](<span class="apiarg">indexOrName [, characterOrAll]</span>) - Enables an addon for subsequent sessions.
 
: [[API EnableAllAddOns|EnableAllAddOns]](<span class="apiarg">[character]</span>) - Enable all AddOns for subsequent sessions.
 
: [[API EnableAllAddOns|EnableAllAddOns]](<span class="apiarg">[character]</span>) - Enable all AddOns for subsequent sessions.
: [[API GetAddOnDependencies|GetAddOnDependencies]](<span class="apiarg">addonIndex or AddOnName</span>) - Get dependency list for an AddOn.
+
: [[API GetAddOnDependencies|GetAddOnDependencies]](<span class="apiarg">addonIndex or AddOnName</span>) - Returns the TOC dependencies of an addon.
 
: [[API GetAddOnEnableState|GetAddOnEnableState]](<span class="apiarg">[character], addonIndex or AddOnName</span>)
 
: [[API GetAddOnEnableState|GetAddOnEnableState]](<span class="apiarg">[character], addonIndex or AddOnName</span>)
 
: [[API GetAddOnInfo|GetAddOnInfo]](<span class="apiarg">addonIndex or AddOnName</span>) - Get information about an AddOn.
 
: [[API GetAddOnInfo|GetAddOnInfo]](<span class="apiarg">addonIndex or AddOnName</span>) - Get information about an AddOn.
: [[API GetAddOnMetadata|GetAddOnMetadata]](<span class="apiarg">addonIndex or AddOnName, variable</span>) - Retrieve metadata from addon's TOC file.
+
: [[API GetAddOnMetadata|GetAddOnMetadata]](<span class="apiarg">addonIndex or AddOnName, variable</span>) - Returns the TOC metadata of an addon.
 
: [[API GetAddOnOptionalDependencies|GetAddOnOptionalDependencies]](<span class="apiarg">addonIndex or AddOnName</span>) - Returns a list of optional dependencies.
 
: [[API GetAddOnOptionalDependencies|GetAddOnOptionalDependencies]](<span class="apiarg">addonIndex or AddOnName</span>) - Returns a list of optional dependencies.
 
: [[API GetNumAddOns|GetNumAddOns]]() - Get the number of user supplied AddOns.
 
: [[API GetNumAddOns|GetNumAddOns]]() - Get the number of user supplied AddOns.
: [[API IsAddOnLoaded|IsAddOnLoaded]](<span class="apiarg">addonIndex or AddOnName</span>) - Returns true if the specified AddOn is loaded.
+
: [[API IsAddOnLoaded|IsAddOnLoaded]](<span class="apiarg">addonIndex or AddOnName</span>) - True if the specified addon is loaded.
: [[API IsAddOnLoadOnDemand|IsAddOnLoadOnDemand]](<span class="apiarg">addonIndex or AddOnName</span>) - Test whether an AddOn is load-on-demand.
+
: [[API IsAddOnLoadOnDemand|IsAddOnLoadOnDemand]](<span class="apiarg">addonIndex or AddOnName</span>) - True if the specified addon is load-on-demand.
 
: [[API IsAddonVersionCheckEnabled|IsAddonVersionCheckEnabled]]()
 
: [[API IsAddonVersionCheckEnabled|IsAddonVersionCheckEnabled]]()
: [[API LoadAddOn|LoadAddOn]](<span class="apiarg">addonIndex or AddOnName</span>) - Request loading of a Load-On-Demand AddOn.
+
: [[API LoadAddOn|LoadAddOn]](<span class="apiarg">addonIndex or AddOnName</span>) - Loads the specified LoadOnDemand addon.
 
: [[API ResetAddOns|ResetAddOns]]()
 
: [[API ResetAddOns|ResetAddOns]]()
 
: [[API ResetDisabledAddOns|ResetDisabledAddOns]]()
 
: [[API ResetDisabledAddOns|ResetDisabledAddOns]]()
 
: [[API SaveAddOns|SaveAddOns]]()
 
: [[API SaveAddOns|SaveAddOns]]()
 
: [[API SetAddonVersionCheck|SetAddonVersionCheck]](<span class="apiarg">boolean</span>)
 
: [[API SetAddonVersionCheck|SetAddonVersionCheck]](<span class="apiarg">boolean</span>)
: <small>UI</small> [[API UIParentLoadAddOn|UIParentLoadAddOn]](<span class="apiarg">AddOnName</span>) - Loads or Reloads the specified AddOn, and pops up an error message if it fails to load for any reason.
+
: <small>''UI''</small> [[API UIParentLoadAddOn|UIParentLoadAddOn]](<span class="apiarg">AddOnName</span>) - Loads or Reloads the specified AddOn, and pops up an error message if it fails to load for any reason.
   
=== Adventure Guide ===
+
===Adventure Guide===
 
The [[Adventure Guide]] was added in [[Patch 6.2.0]]
 
The [[Adventure Guide]] was added in [[Patch 6.2.0]]
 
: [[API C_AdventureJournal.ActivateEntry|C_AdventureJournal.ActivateEntry]](<span class="apiarg">index</span>)
 
: [[API C_AdventureJournal.ActivateEntry|C_AdventureJournal.ActivateEntry]](<span class="apiarg">index</span>)
Line 125: Line 125:
 
: [[API C_AdventureJournal.SetPrimaryOffset|C_AdventureJournal.SetPrimaryOffset]](<span class="apiarg">offset</span>)
 
: [[API C_AdventureJournal.SetPrimaryOffset|C_AdventureJournal.SetPrimaryOffset]](<span class="apiarg">offset</span>)
 
: [[API C_AdventureJournal.UpdateSuggestions|C_AdventureJournal.UpdateSuggestions]](<span class="apiarg">[levelUp]</span>)
 
: [[API C_AdventureJournal.UpdateSuggestions|C_AdventureJournal.UpdateSuggestions]](<span class="apiarg">[levelUp]</span>)
==== Encounter Journal ====
+
====Encounter Journal====
 
The Encounter Journal was added in [[Patch 4.2.0]]
 
The Encounter Journal was added in [[Patch 4.2.0]]
 
: [[API C_EncounterJournal.GetDungeonEntrancesForMap|C_EncounterJournal.GetDungeonEntrancesForMap]](<span class="apiarg">uiMapID</span>) : <span class="apiret">dungeonEntrances</span> - Returns the instance entrances for a map.
 
: [[API C_EncounterJournal.GetDungeonEntrancesForMap|C_EncounterJournal.GetDungeonEntrancesForMap]](<span class="apiarg">uiMapID</span>) : <span class="apiret">dungeonEntrances</span> - Returns the instance entrances for a map.
Line 131: Line 131:
 
: [[API C_EncounterJournal.GetSectionIconFlags|C_EncounterJournal.GetSectionIconFlags]](<span class="apiarg">sectionID</span>) : <span class="apiret">iconFlags</span> - Returns the icon flags for a section, such as Magic Effect and Heroic Difficulty
 
: [[API C_EncounterJournal.GetSectionIconFlags|C_EncounterJournal.GetSectionIconFlags]](<span class="apiarg">sectionID</span>) : <span class="apiret">iconFlags</span> - Returns the icon flags for a section, such as Magic Effect and Heroic Difficulty
 
: [[API C_EncounterJournal.GetSectionInfo|C_EncounterJournal.GetSectionInfo]](<span class="apiarg">sectionID</span>) : <span class="apiret">info</span> - Returns information about an entry in the Abilities section of the Encounter Journal.
 
: [[API C_EncounterJournal.GetSectionInfo|C_EncounterJournal.GetSectionInfo]](<span class="apiarg">sectionID</span>) : <span class="apiret">info</span> - Returns information about an entry in the Abilities section of the Encounter Journal.
: [[API C_EncounterJournal.InstanceHasLoot|C_EncounterJournal.InstanceHasLoot]](<span class="apiarg">[instanceID]</span>) : <span class="apiret">hasLoot</span> - Returns whether an instance has a loot table in the journal.
+
: [[API C_EncounterJournal.InstanceHasLoot|C_EncounterJournal.InstanceHasLoot]](<span class="apiarg">[journalInstanceID]</span>) : <span class="apiret">hasLoot</span> - Returns whether an instance has a loot table in the journal.
 
: [[API C_EncounterJournal.IsEncounterComplete|C_EncounterJournal.IsEncounterComplete]](<span class="apiarg">journalEncounterID</span>) : <span class="apiret">isEncounterComplete</span> - Returns if a boss encounter has been completed.
 
: [[API C_EncounterJournal.IsEncounterComplete|C_EncounterJournal.IsEncounterComplete]](<span class="apiarg">journalEncounterID</span>) : <span class="apiret">isEncounterComplete</span> - Returns if a boss encounter has been completed.
 
: [[API C_EncounterJournal.SetPreviewMythicPlusLevel|C_EncounterJournal.SetPreviewMythicPlusLevel]](<span class="apiarg">level</span>)
 
: [[API C_EncounterJournal.SetPreviewMythicPlusLevel|C_EncounterJournal.SetPreviewMythicPlusLevel]](<span class="apiarg">level</span>)
Line 143: Line 143:
 
: [[API EJ_GetDifficulty|EJ_GetDifficulty]]() - Returns the currently viewed difficulty in the journal.
 
: [[API EJ_GetDifficulty|EJ_GetDifficulty]]() - Returns the currently viewed difficulty in the journal.
 
: [[API EJ_GetEncounterInfo|EJ_GetEncounterInfo]](<span class="apiarg">encounterID</span>) - Returns encounter info from the journal.
 
: [[API EJ_GetEncounterInfo|EJ_GetEncounterInfo]](<span class="apiarg">encounterID</span>) - Returns encounter info from the journal.
: [[API EJ_GetEncounterInfoByIndex|EJ_GetEncounterInfoByIndex]](<span class="apiarg">index [, instanceID]</span>) - idem
+
: [[API EJ_GetEncounterInfoByIndex|EJ_GetEncounterInfoByIndex]](<span class="apiarg">index [, journalInstanceID]</span>) - idem
 
: [[API EJ_GetInstanceByIndex|EJ_GetInstanceByIndex]](<span class="apiarg">index, isRaid</span>) - Returns instance info for the Encounter Journal.
 
: [[API EJ_GetInstanceByIndex|EJ_GetInstanceByIndex]](<span class="apiarg">index, isRaid</span>) - Returns instance info for the Encounter Journal.
 
: [[API EJ_GetInstanceForMap|EJ_GetInstanceForMap]](<span class="apiarg">mapID</span>) - Returns any corresponding instance ID for a UiMapID.
 
: [[API EJ_GetInstanceForMap|EJ_GetInstanceForMap]](<span class="apiarg">mapID</span>) - Returns any corresponding instance ID for a UiMapID.
: [[API EJ_GetInstanceInfo|EJ_GetInstanceInfo]]() - Returns instance info for the Encounter Journal.
+
: [[API EJ_GetInstanceInfo|EJ_GetInstanceInfo]](<span class="apiarg">[journalInstanceID]</span>) - Returns instance info for the Encounter Journal.
 
: [[API EJ_GetMapEncounter|EJ_GetMapEncounter]](<span class="apiarg">mapID, index [, fromJournal]</span>) - Returns boss pin locations on instance maps.
 
: [[API EJ_GetMapEncounter|EJ_GetMapEncounter]](<span class="apiarg">mapID, index [, fromJournal]</span>) - Returns boss pin locations on instance maps.
 
: [[API EJ_GetNumEncountersForLootByIndex|EJ_GetNumEncountersForLootByIndex]](<span class="apiarg">index</span>) - Returns the amount of encounters that drop the same loot item.
 
: [[API EJ_GetNumEncountersForLootByIndex|EJ_GetNumEncountersForLootByIndex]](<span class="apiarg">index</span>) - Returns the amount of encounters that drop the same loot item.
Line 161: Line 161:
 
: [[API EJ_IsValidInstanceDifficulty|EJ_IsValidInstanceDifficulty]](<span class="apiarg">difficultyID</span>) - Returns whether the difficultyID is valid for use in the journal.
 
: [[API EJ_IsValidInstanceDifficulty|EJ_IsValidInstanceDifficulty]](<span class="apiarg">difficultyID</span>) - Returns whether the difficultyID is valid for use in the journal.
 
: [[API EJ_SelectEncounter|EJ_SelectEncounter]](<span class="apiarg">encounterID</span>) - Selects an encounter for the Encounter Journal API state.
 
: [[API EJ_SelectEncounter|EJ_SelectEncounter]](<span class="apiarg">encounterID</span>) - Selects an encounter for the Encounter Journal API state.
: [[API EJ_SelectInstance|EJ_SelectInstance]](<span class="apiarg">instanceID</span>) - Selects an instance for the Encounter Journal API state.
+
: [[API EJ_SelectInstance|EJ_SelectInstance]](<span class="apiarg">journalInstanceID</span>) - Selects an instance for the Encounter Journal API state.
 
: [[API EJ_SelectTier|EJ_SelectTier]](<span class="apiarg">index</span>) - Selects a tier for the Encounter Journal API state.
 
: [[API EJ_SelectTier|EJ_SelectTier]](<span class="apiarg">index</span>) - Selects a tier for the Encounter Journal API state.
 
: [[API EJ_SetDifficulty|EJ_SetDifficulty]](<span class="apiarg">difficultyID</span>) - Sets the encounter difficulty shown in the Encounter Journal.
 
: [[API EJ_SetDifficulty|EJ_SetDifficulty]](<span class="apiarg">difficultyID</span>) - Sets the encounter difficulty shown in the Encounter Journal.
Line 168: Line 168:
 
: [[API SetPortraitTextureFromCreatureDisplayID|SetPortraitTextureFromCreatureDisplayID]](<span class="apiarg">textureObject, creatureDisplayID</span>)
 
: [[API SetPortraitTextureFromCreatureDisplayID|SetPortraitTextureFromCreatureDisplayID]](<span class="apiarg">textureObject, creatureDisplayID</span>)
 
Loot Journal
 
Loot Journal
: [[API C_EncounterJournal.GetLootInfo|C_EncounterJournal.GetLootInfo]](<span class="apiarg">id</span>) : <span class="apiret">itemInfo</span> - Returns loot info for an encounter or instance.
+
: [[API C_LootJournal.GetItemSetItems|C_LootJournal.GetItemSetItems]](<span class="apiarg">setID</span>) : <span class="apiret">items</span>
 
: [[API C_LootJournal.GetItemSets|C_LootJournal.GetItemSets]](<span class="apiarg">[classID, specID]</span>) : <span class="apiret">itemSets</span>
  +
: [[API C_EncounterJournal.GetLootInfo|C_EncounterJournal.GetLootInfo]](<span class="apiarg">id</span>) : <span class="apiret">itemInfo</span> - Returns info for loot items available from an encounter.
 
: [[API C_EncounterJournal.GetLootInfoByIndex|C_EncounterJournal.GetLootInfoByIndex]](<span class="apiarg">index [, encounterIndex]</span>) : <span class="apiret">itemInfo</span> - Returns loot info for an encounter or instance.
 
: [[API C_EncounterJournal.GetLootInfoByIndex|C_EncounterJournal.GetLootInfoByIndex]](<span class="apiarg">index [, encounterIndex]</span>) : <span class="apiret">itemInfo</span> - Returns loot info for an encounter or instance.
: [[API C_EncounterJournal.GetSlotFilter|C_EncounterJournal.GetSlotFilter]]() : <span class="apiret">filter</span> - Returns the current equipment type slot filter.
+
: [[API C_EncounterJournal.GetSlotFilter|C_EncounterJournal.GetSlotFilter]]() : <span class="apiret">filter</span> - Returns the current item slot filter for loot items.
: [[API C_EncounterJournal.ResetSlotFilter|C_EncounterJournal.ResetSlotFilter]]() - Resets the current slot filter.
+
: [[API C_EncounterJournal.ResetSlotFilter|C_EncounterJournal.ResetSlotFilter]]() - Resets the item slot filter for loot items.
: [[API C_EncounterJournal.SetSlotFilter|C_EncounterJournal.SetSlotFilter]](<span class="apiarg">filterSlot</span>) - Sets the Encounter Journal's equipment slot filter.
+
: [[API C_EncounterJournal.SetSlotFilter|C_EncounterJournal.SetSlotFilter]](<span class="apiarg">filterSlot</span>) - Sets the item slot filter for loot items.
 
: [[API EJ_GetInvTypeSortOrder|EJ_GetInvTypeSortOrder]](<span class="apiarg">invType</span>) - Returns the sort order for an inventory type.
 
: [[API EJ_GetInvTypeSortOrder|EJ_GetInvTypeSortOrder]](<span class="apiarg">invType</span>) - Returns the sort order for an inventory type.
 
: [[API EJ_GetLootFilter|EJ_GetLootFilter]]() - Returns the currently used loot filter.
 
: [[API EJ_GetLootFilter|EJ_GetLootFilter]]() - Returns the currently used loot filter.
Line 180: Line 182:
 
: [[API EJ_SetLootFilter|EJ_SetLootFilter]](<span class="apiarg">classID, specID</span>) - Sets the loot filter for a specialization.
 
: [[API EJ_SetLootFilter|EJ_SetLootFilter]](<span class="apiarg">classID, specID</span>) - Sets the loot filter for a specialization.
   
=== Auction House ===
+
===Auction House===
 
The [[Auction House]] was revamped in [[Patch 8.3.0]]
 
The [[Auction House]] was revamped in [[Patch 8.3.0]]
 
: [[API C_AuctionHouse.GetNumReplicateItems|C_AuctionHouse.GetNumReplicateItems]]() : <span class="apiret">numReplicateItems</span> - Returns the amount of auctions.
 
: [[API C_AuctionHouse.GetNumReplicateItems|C_AuctionHouse.GetNumReplicateItems]]() : <span class="apiret">numReplicateItems</span> - Returns the amount of auctions.
: [[API C_AuctionHouse.GetReplicateItemBattlePetInfo|C_AuctionHouse.GetReplicateItemBattlePetInfo]](<span class="apiarg">index</span>) : <span class="apiret">creatureID, displayID</span>
+
: [[API C_AuctionHouse.GetReplicateItemBattlePetInfo|C_AuctionHouse.GetReplicateItemBattlePetInfo]](<span class="apiarg">index</span>) : <span class="apiret">creatureID, displayID</span> - Returns display info for a battle pet from a [[API C_AuctionHouse.ReplicateItems|ReplicateItems]] result.
 
: [[API C_AuctionHouse.GetReplicateItemInfo|C_AuctionHouse.GetReplicateItemInfo]](<span class="apiarg">index</span>) : <span class="apiret">name, texture, count, qualityID, usable, level, levelType, minBid, ...</span> - Returns information about the specified auction.
 
: [[API C_AuctionHouse.GetReplicateItemInfo|C_AuctionHouse.GetReplicateItemInfo]](<span class="apiarg">index</span>) : <span class="apiret">name, texture, count, qualityID, usable, level, levelType, minBid, ...</span> - Returns information about the specified auction.
: [[API C_AuctionHouse.GetReplicateItemLink|C_AuctionHouse.GetReplicateItemLink]](<span class="apiarg">index</span>) : <span class="apiret">itemLink</span>
+
: [[API C_AuctionHouse.GetReplicateItemLink|C_AuctionHouse.GetReplicateItemLink]](<span class="apiarg">index</span>) : <span class="apiret">itemLink</span> - Returns the item link (if loaded) for an item from a [[API C_AuctionHouse.ReplicateItems|ReplicateItems]] result.
 
: [[API C_AuctionHouse.GetReplicateItemTimeLeft|C_AuctionHouse.GetReplicateItemTimeLeft]](<span class="apiarg">index</span>) : <span class="apiret">timeLeft</span> - Returns the time left for an auction.
 
: [[API C_AuctionHouse.GetReplicateItemTimeLeft|C_AuctionHouse.GetReplicateItemTimeLeft]](<span class="apiarg">index</span>) : <span class="apiret">timeLeft</span> - Returns the time left for an auction.
 
: [[API C_AuctionHouse.ReplicateItems|C_AuctionHouse.ReplicateItems]]() - Queries all auctions listed on the Auction House.
 
: [[API C_AuctionHouse.ReplicateItems|C_AuctionHouse.ReplicateItems]]() - Queries all auctions listed on the Auction House.
   
: [[API C_AuctionHouse.CalculateCommodityDeposit|C_AuctionHouse.CalculateCommodityDeposit]](<span class="apiarg">itemID, duration, quantity</span>) : <span class="apiret">depositCost</span>
+
: [[API C_AuctionHouse.CalculateCommodityDeposit|C_AuctionHouse.CalculateCommodityDeposit]](<span class="apiarg">itemID, duration, quantity</span>) : <span class="apiret">depositCost</span> - Returns required deposit for posting a commodity and quantity.
: [[API C_AuctionHouse.CalculateItemDeposit|C_AuctionHouse.CalculateItemDeposit]](<span class="apiarg">item, duration, quantity</span>) : <span class="apiret">depositCost</span>
+
: [[API C_AuctionHouse.CalculateItemDeposit|C_AuctionHouse.CalculateItemDeposit]](<span class="apiarg">item, duration, quantity</span>) : <span class="apiret">depositCost</span> - Returns required deposit for posting a specific item and quantity.
: [[API C_AuctionHouse.CanCancelAuction|C_AuctionHouse.CanCancelAuction]](<span class="apiarg">ownedAuctionID</span>) : <span class="apiret">canCancelAuction</span>
+
: [[API C_AuctionHouse.CanCancelAuction|C_AuctionHouse.CanCancelAuction]](<span class="apiarg">ownedAuctionID</span>) : <span class="apiret">canCancelAuction</span> - Returns if the auction can be cancelled. If it can't, load it with [[API C_AuctionHouse.QueryOwnedAuctions|QueryOwnedAuctions]].
: <small>HW, NOSCRIPT</small> [[API C_AuctionHouse.CancelAuction|C_AuctionHouse.CancelAuction]](<span class="apiarg">ownedAuctionID</span>) - Cancels an auction.
+
: <small>''HW, NOSCRIPT''</small> [[API C_AuctionHouse.CancelAuction|C_AuctionHouse.CancelAuction]](<span class="apiarg">ownedAuctionID</span>) - Cancels an auction.
: [[API C_AuctionHouse.CancelCommoditiesPurchase|C_AuctionHouse.CancelCommoditiesPurchase]]()
+
: [[API C_AuctionHouse.CancelCommoditiesPurchase|C_AuctionHouse.CancelCommoditiesPurchase]]() - Abort an incomplete commodity purchase to avoid it conflicting with another purchase.
: [[API C_AuctionHouse.CancelSell|C_AuctionHouse.CancelSell]]()
+
: [[API C_AuctionHouse.CancelSell|C_AuctionHouse.CancelSell]]() - Stop posting auctions for an non-commodity item.
: [[API C_AuctionHouse.CloseAuctionHouse|C_AuctionHouse.CloseAuctionHouse]]()
+
: [[API C_AuctionHouse.CloseAuctionHouse|C_AuctionHouse.CloseAuctionHouse]]() - Close the auction house window.
 
: [[API C_AuctionHouse.ConfirmCommoditiesPurchase|C_AuctionHouse.ConfirmCommoditiesPurchase]](<span class="apiarg">itemID, quantity</span>) - Completes a commodity item purchase.
 
: [[API C_AuctionHouse.ConfirmCommoditiesPurchase|C_AuctionHouse.ConfirmCommoditiesPurchase]](<span class="apiarg">itemID, quantity</span>) - Completes a commodity item purchase.
 
: [[API C_AuctionHouse.FavoritesAreAvailable|C_AuctionHouse.FavoritesAreAvailable]]() : <span class="apiret">favoritesAreAvailable</span>
 
: [[API C_AuctionHouse.FavoritesAreAvailable|C_AuctionHouse.FavoritesAreAvailable]]() : <span class="apiret">favoritesAreAvailable</span>
 
: [[API C_AuctionHouse.GetAuctionInfoByID|C_AuctionHouse.GetAuctionInfoByID]](<span class="apiarg">auctionID</span>) : <span class="apiret">priceInfo</span>
 
: [[API C_AuctionHouse.GetAuctionInfoByID|C_AuctionHouse.GetAuctionInfoByID]](<span class="apiarg">auctionID</span>) : <span class="apiret">priceInfo</span>
 
: [[API C_AuctionHouse.GetAuctionItemSubClasses|C_AuctionHouse.GetAuctionItemSubClasses]](<span class="apiarg">classID</span>) : <span class="apiret">subClasses</span>
 
: [[API C_AuctionHouse.GetAuctionItemSubClasses|C_AuctionHouse.GetAuctionItemSubClasses]](<span class="apiarg">classID</span>) : <span class="apiret">subClasses</span>
: [[API C_AuctionHouse.GetAvailablePostCount|C_AuctionHouse.GetAvailablePostCount]](<span class="apiarg">item</span>) : <span class="apiret">listCount</span>
+
: [[API C_AuctionHouse.GetAvailablePostCount|C_AuctionHouse.GetAvailablePostCount]](<span class="apiarg">item</span>) : <span class="apiret">listCount</span> - Returns the available quantity of an item for posting.
 
: [[API C_AuctionHouse.GetBidInfo|C_AuctionHouse.GetBidInfo]](<span class="apiarg">bidIndex</span>) : <span class="apiret">bid</span>
 
: [[API C_AuctionHouse.GetBidInfo|C_AuctionHouse.GetBidInfo]](<span class="apiarg">bidIndex</span>) : <span class="apiret">bid</span>
  +
: [[API C_AuctionHouse.GetBids|C_AuctionHouse.GetBids]]() : <span class="apiret">bids</span>
 
: [[API C_AuctionHouse.GetBidType|C_AuctionHouse.GetBidType]](<span class="apiarg">bidTypeIndex</span>) : <span class="apiret">typeItemKey</span>
 
: [[API C_AuctionHouse.GetBidType|C_AuctionHouse.GetBidType]](<span class="apiarg">bidTypeIndex</span>) : <span class="apiret">typeItemKey</span>
: [[API C_AuctionHouse.GetBrowseResults|C_AuctionHouse.GetBrowseResults]]() : <span class="apiret">browseResults</span>
+
: [[API C_AuctionHouse.GetBrowseResults|C_AuctionHouse.GetBrowseResults]]() : <span class="apiret">browseResults</span> - Returns the currently loaded summary results resulting from [[API C_AuctionHouse.SendBrowseQuery|SendBrowseQuery]].
: [[API C_AuctionHouse.GetCancelCost|C_AuctionHouse.GetCancelCost]](<span class="apiarg">ownedAuctionID</span>) : <span class="apiret">cancelCost</span>
+
: [[API C_AuctionHouse.GetCancelCost|C_AuctionHouse.GetCancelCost]](<span class="apiarg">ownedAuctionID</span>) : <span class="apiret">cancelCost</span> - Returns the cost for cancelling a specific owned auction. This is non-zero if it has a bid.
 
: [[API C_AuctionHouse.GetCommoditySearchResultInfo|C_AuctionHouse.GetCommoditySearchResultInfo]](<span class="apiarg">itemID, commoditySearchResultIndex</span>) : <span class="apiret">result</span> - Returns search results for a commodity item.
 
: [[API C_AuctionHouse.GetCommoditySearchResultInfo|C_AuctionHouse.GetCommoditySearchResultInfo]](<span class="apiarg">itemID, commoditySearchResultIndex</span>) : <span class="apiret">result</span> - Returns search results for a commodity item.
: [[API C_AuctionHouse.GetCommoditySearchResultsQuantity|C_AuctionHouse.GetCommoditySearchResultsQuantity]](<span class="apiarg">itemID</span>) : <span class="apiret">totalQuantity</span>
+
: [[API C_AuctionHouse.GetCommoditySearchResultsQuantity|C_AuctionHouse.GetCommoditySearchResultsQuantity]](<span class="apiarg">itemID</span>) : <span class="apiret">totalQuantity</span> - Returns how many of the commodity is on sale.
: [[API C_AuctionHouse.GetExtraBrowseInfo|C_AuctionHouse.GetExtraBrowseInfo]](<span class="apiarg">itemKey</span>) : <span class="apiret">extraInfo</span>
+
: [[API C_AuctionHouse.GetExtraBrowseInfo|C_AuctionHouse.GetExtraBrowseInfo]](<span class="apiarg">itemKey</span>) : <span class="apiret">extraInfo</span> - Returns the level (from 1-120, BfA levels) that some items would be crafted at.
: [[API C_AuctionHouse.GetFilterGroups|C_AuctionHouse.GetFilterGroups]]() : <span class="apiret">filterGroups</span>
+
: [[API C_AuctionHouse.GetFilterGroups|C_AuctionHouse.GetFilterGroups]]() : <span class="apiret">filterGroups</span> - Returns groups of filters for use in the Filter dropdown in the Buy tab.
: [[API C_AuctionHouse.GetItemCommodityStatus|C_AuctionHouse.GetItemCommodityStatus]](<span class="apiarg">item</span>) : <span class="apiret">isCommodity</span>
+
: [[API C_AuctionHouse.GetItemCommodityStatus|C_AuctionHouse.GetItemCommodityStatus]](<span class="apiarg">item</span>) : <span class="apiret">isCommodity</span> - Returns if the item is a commodity, item or neither.
: [[API C_AuctionHouse.GetItemKeyFromItem|C_AuctionHouse.GetItemKeyFromItem]](<span class="apiarg">item</span>) : <span class="apiret">itemKey</span>
+
: [[API C_AuctionHouse.GetItemKeyFromItem|C_AuctionHouse.GetItemKeyFromItem]](<span class="apiarg">item</span>) : <span class="apiret">itemKey</span> - Returns an auction house item key from an item location.
: [[API C_AuctionHouse.GetItemKeyInfo|C_AuctionHouse.GetItemKeyInfo]](<span class="apiarg">itemKey [, restrictQualityToFilter]</span>) : <span class="apiret">itemKeyInfo</span>
+
: [[API C_AuctionHouse.GetItemKeyInfo|C_AuctionHouse.GetItemKeyInfo]](<span class="apiarg">itemKey [, restrictQualityToFilter]</span>) : <span class="apiret">itemKeyInfo</span> - Returns more details about an item from its item key, including its name.
: [[API C_AuctionHouse.GetItemKeyRequiredLevel|C_AuctionHouse.GetItemKeyRequiredLevel]](<span class="apiarg">itemKey</span>) : <span class="apiret">requiredLevel</span>
+
: [[API C_AuctionHouse.GetItemKeyRequiredLevel|C_AuctionHouse.GetItemKeyRequiredLevel]](<span class="apiarg">itemKey</span>) : <span class="apiret">requiredLevel</span> - Returns the required level to use an item found on the auction house.
 
: [[API C_AuctionHouse.GetItemSearchResultInfo|C_AuctionHouse.GetItemSearchResultInfo]](<span class="apiarg">itemKey, itemSearchResultIndex</span>) : <span class="apiret">result</span> - Returns search results for an item.
 
: [[API C_AuctionHouse.GetItemSearchResultInfo|C_AuctionHouse.GetItemSearchResultInfo]](<span class="apiarg">itemKey, itemSearchResultIndex</span>) : <span class="apiret">result</span> - Returns search results for an item.
: [[API C_AuctionHouse.GetItemSearchResultsQuantity|C_AuctionHouse.GetItemSearchResultsQuantity]](<span class="apiarg">itemKey</span>) : <span class="apiret">totalQuantity</span>
+
: [[API C_AuctionHouse.GetItemSearchResultsQuantity|C_AuctionHouse.GetItemSearchResultsQuantity]](<span class="apiarg">itemKey</span>) : <span class="apiret">totalQuantity</span> - Returns how many of the item is available on the auction house.
 
: [[API C_AuctionHouse.GetMaxBidItemBid|C_AuctionHouse.GetMaxBidItemBid]]() : <span class="apiret">maxBid</span>
 
: [[API C_AuctionHouse.GetMaxBidItemBid|C_AuctionHouse.GetMaxBidItemBid]]() : <span class="apiret">maxBid</span>
 
: [[API C_AuctionHouse.GetMaxBidItemBuyout|C_AuctionHouse.GetMaxBidItemBuyout]]() : <span class="apiret">maxBuyout</span>
 
: [[API C_AuctionHouse.GetMaxBidItemBuyout|C_AuctionHouse.GetMaxBidItemBuyout]]() : <span class="apiret">maxBuyout</span>
Line 224: Line 227:
 
: [[API C_AuctionHouse.GetNumBids|C_AuctionHouse.GetNumBids]]() : <span class="apiret">numBids</span>
 
: [[API C_AuctionHouse.GetNumBids|C_AuctionHouse.GetNumBids]]() : <span class="apiret">numBids</span>
 
: [[API C_AuctionHouse.GetNumBidTypes|C_AuctionHouse.GetNumBidTypes]]() : <span class="apiret">numBidTypes</span>
 
: [[API C_AuctionHouse.GetNumBidTypes|C_AuctionHouse.GetNumBidTypes]]() : <span class="apiret">numBidTypes</span>
: [[API C_AuctionHouse.GetNumCommoditySearchResults|C_AuctionHouse.GetNumCommoditySearchResults]](<span class="apiarg">itemID</span>) : <span class="apiret">numSearchResults</span>
+
: [[API C_AuctionHouse.GetNumCommoditySearchResults|C_AuctionHouse.GetNumCommoditySearchResults]](<span class="apiarg">itemID</span>) : <span class="apiret">numSearchResults</span> - Returns the number of commodity results, the different prices.
: [[API C_AuctionHouse.GetNumItemSearchResults|C_AuctionHouse.GetNumItemSearchResults]](<span class="apiarg">itemKey</span>) : <span class="apiret">numItemSearchResults</span>
+
: [[API C_AuctionHouse.GetNumItemSearchResults|C_AuctionHouse.GetNumItemSearchResults]](<span class="apiarg">itemKey</span>) : <span class="apiret">numItemSearchResults</span> - Returns the number of item results, the different auctions.
: [[API C_AuctionHouse.GetNumOwnedAuctions|C_AuctionHouse.GetNumOwnedAuctions]]() : <span class="apiret">numOwnedAuctions</span>
+
: [[API C_AuctionHouse.GetNumOwnedAuctions|C_AuctionHouse.GetNumOwnedAuctions]]() : <span class="apiret">numOwnedAuctions</span> - Returns the number of auctions the player has active on the auction house.
 
: [[API C_AuctionHouse.GetNumOwnedAuctionTypes|C_AuctionHouse.GetNumOwnedAuctionTypes]]() : <span class="apiret">numOwnedAuctionTypes</span>
 
: [[API C_AuctionHouse.GetNumOwnedAuctionTypes|C_AuctionHouse.GetNumOwnedAuctionTypes]]() : <span class="apiret">numOwnedAuctionTypes</span>
: [[API C_AuctionHouse.GetOwnedAuctionInfo|C_AuctionHouse.GetOwnedAuctionInfo]](<span class="apiarg">ownedAuctionIndex</span>) : <span class="apiret">ownedAuction</span>
+
: [[API C_AuctionHouse.GetOwnedAuctionInfo|C_AuctionHouse.GetOwnedAuctionInfo]](<span class="apiarg">ownedAuctionIndex</span>) : <span class="apiret">ownedAuction</span> - Returns information for one of the player's active auctions.
  +
: [[API C_AuctionHouse.GetOwnedAuctions|C_AuctionHouse.GetOwnedAuctions]]() : <span class="apiret">ownedAuctions</span>
 
: [[API C_AuctionHouse.GetOwnedAuctionType|C_AuctionHouse.GetOwnedAuctionType]](<span class="apiarg">ownedAuctionTypeIndex</span>) : <span class="apiret">typeItemKey</span>
 
: [[API C_AuctionHouse.GetOwnedAuctionType|C_AuctionHouse.GetOwnedAuctionType]](<span class="apiarg">ownedAuctionTypeIndex</span>) : <span class="apiret">typeItemKey</span>
 
: [[API C_AuctionHouse.GetQuoteDurationRemaining|C_AuctionHouse.GetQuoteDurationRemaining]]() : <span class="apiret">quoteDurationSeconds</span>
 
: [[API C_AuctionHouse.GetQuoteDurationRemaining|C_AuctionHouse.GetQuoteDurationRemaining]]() : <span class="apiret">quoteDurationSeconds</span>
Line 234: Line 238:
 
: [[API C_AuctionHouse.HasFavorites|C_AuctionHouse.HasFavorites]]() : <span class="apiret">hasFavorites</span>
 
: [[API C_AuctionHouse.HasFavorites|C_AuctionHouse.HasFavorites]]() : <span class="apiret">hasFavorites</span>
 
: [[API C_AuctionHouse.HasFullBidResults|C_AuctionHouse.HasFullBidResults]]() : <span class="apiret">hasFullBidResults</span>
 
: [[API C_AuctionHouse.HasFullBidResults|C_AuctionHouse.HasFullBidResults]]() : <span class="apiret">hasFullBidResults</span>
: [[API C_AuctionHouse.HasFullBrowseResults|C_AuctionHouse.HasFullBrowseResults]]() : <span class="apiret">hasFullBrowseResults</span>
+
: [[API C_AuctionHouse.HasFullBrowseResults|C_AuctionHouse.HasFullBrowseResults]]() : <span class="apiret">hasFullBrowseResults</span> - Returns if the last group of summary results (groups of 500) is available.
 
: [[API C_AuctionHouse.HasFullCommoditySearchResults|C_AuctionHouse.HasFullCommoditySearchResults]](<span class="apiarg">itemID</span>) : <span class="apiret">hasFullResults</span>
 
: [[API C_AuctionHouse.HasFullCommoditySearchResults|C_AuctionHouse.HasFullCommoditySearchResults]](<span class="apiarg">itemID</span>) : <span class="apiret">hasFullResults</span>
 
: [[API C_AuctionHouse.HasFullItemSearchResults|C_AuctionHouse.HasFullItemSearchResults]](<span class="apiarg">itemKey</span>) : <span class="apiret">hasFullResults</span>
 
: [[API C_AuctionHouse.HasFullItemSearchResults|C_AuctionHouse.HasFullItemSearchResults]](<span class="apiarg">itemKey</span>) : <span class="apiret">hasFullResults</span>
Line 241: Line 245:
 
: [[API C_AuctionHouse.HasSearchResults|C_AuctionHouse.HasSearchResults]](<span class="apiarg">itemKey</span>) : <span class="apiret">hasSearchResults</span>
 
: [[API C_AuctionHouse.HasSearchResults|C_AuctionHouse.HasSearchResults]](<span class="apiarg">itemKey</span>) : <span class="apiret">hasSearchResults</span>
 
: [[API C_AuctionHouse.IsFavoriteItem|C_AuctionHouse.IsFavoriteItem]](<span class="apiarg">itemKey</span>) : <span class="apiret">isFavorite</span>
 
: [[API C_AuctionHouse.IsFavoriteItem|C_AuctionHouse.IsFavoriteItem]](<span class="apiarg">itemKey</span>) : <span class="apiret">isFavorite</span>
: [[API C_AuctionHouse.IsSellItemValid|C_AuctionHouse.IsSellItemValid]](<span class="apiarg">item [, displayError]</span>) : <span class="apiret">valid</span>
+
: [[API C_AuctionHouse.IsSellItemValid|C_AuctionHouse.IsSellItemValid]](<span class="apiarg">item [, displayError]</span>) : <span class="apiret">valid</span> - Returns if an item from your bag can be posted on the auction house.
: [[API C_AuctionHouse.IsThrottledMessageSystemReady|C_AuctionHouse.IsThrottledMessageSystemReady]]() : <span class="apiret">canSendThrottledMessage</span>
+
: [[API C_AuctionHouse.IsThrottledMessageSystemReady|C_AuctionHouse.IsThrottledMessageSystemReady]]() : <span class="apiret">canSendThrottledMessage</span> - Returns if the next query will be throttled, either delayed or cancelled.
: [[API C_AuctionHouse.MakeItemKey|C_AuctionHouse.MakeItemKey]](<span class="apiarg">itemID [, itemLevel, itemSuffix, battlePetSpeciesID]</span>) : <span class="apiret">itemKey</span>
+
: [[API C_AuctionHouse.MakeItemKey|C_AuctionHouse.MakeItemKey]](<span class="apiarg">itemID [, itemLevel, itemSuffix, battlePetSpeciesID]</span>) : <span class="apiret">itemKey</span> - Returns an auction house item key.
: <small>HW, NOSCRIPT</small> [[API C_AuctionHouse.PlaceBid|C_AuctionHouse.PlaceBid]](<span class="apiarg">auctionID, bidAmount</span>) - Places a bid on a non-commodity item.
+
: <small>''HW, NOSCRIPT''</small> [[API C_AuctionHouse.PlaceBid|C_AuctionHouse.PlaceBid]](<span class="apiarg">auctionID, bidAmount</span>) - Places a bid on a non-commodity item.
: <small>HW, NOSCRIPT</small> [[API C_AuctionHouse.PostCommodity|C_AuctionHouse.PostCommodity]](<span class="apiarg">item, duration, quantity, unitPrice</span>) - Posts a commodity item on the auction house.
+
: <small>''HW, NOSCRIPT''</small> [[API C_AuctionHouse.PostCommodity|C_AuctionHouse.PostCommodity]](<span class="apiarg">item, duration, quantity, unitPrice</span>) - Posts a commodity item on the auction house.
: <small>HW, NOSCRIPT</small> [[API C_AuctionHouse.PostItem|C_AuctionHouse.PostItem]](<span class="apiarg">item, duration, quantity [, bid, buyout]</span>) - Posts an item on the auction house.
+
: <small>''HW, NOSCRIPT''</small> [[API C_AuctionHouse.PostItem|C_AuctionHouse.PostItem]](<span class="apiarg">item, duration, quantity [, bid, buyout]</span>) - Posts an item on the auction house.
 
: [[API C_AuctionHouse.QueryBids|C_AuctionHouse.QueryBids]](<span class="apiarg">sorts, auctionIDs</span>)
 
: [[API C_AuctionHouse.QueryBids|C_AuctionHouse.QueryBids]](<span class="apiarg">sorts, auctionIDs</span>)
: [[API C_AuctionHouse.QueryOwnedAuctions|C_AuctionHouse.QueryOwnedAuctions]](<span class="apiarg">sorts</span>)
+
: <small>''NOSCRIPT''</small> [[API C_AuctionHouse.QueryOwnedAuctions|C_AuctionHouse.QueryOwnedAuctions]](<span class="apiarg">sorts</span>) - Queries the auction house for the player's active auctions.
 
: [[API C_AuctionHouse.RefreshCommoditySearchResults|C_AuctionHouse.RefreshCommoditySearchResults]](<span class="apiarg">itemID</span>)
 
: [[API C_AuctionHouse.RefreshCommoditySearchResults|C_AuctionHouse.RefreshCommoditySearchResults]](<span class="apiarg">itemID</span>)
 
: [[API C_AuctionHouse.RefreshItemSearchResults|C_AuctionHouse.RefreshItemSearchResults]](<span class="apiarg">itemKey [, minLevelFilter, maxLevelFilter]</span>)
 
: [[API C_AuctionHouse.RefreshItemSearchResults|C_AuctionHouse.RefreshItemSearchResults]](<span class="apiarg">itemKey [, minLevelFilter, maxLevelFilter]</span>)
: <small>NOSCRIPT</small> [[API C_AuctionHouse.RequestMoreBrowseResults|C_AuctionHouse.RequestMoreBrowseResults]]()
+
: [[API C_AuctionHouse.RequestFavorites|C_AuctionHouse.RequestFavorites]]()
  +
: <small>''NOSCRIPT''</small> [[API C_AuctionHouse.RequestMoreBrowseResults|C_AuctionHouse.RequestMoreBrowseResults]]()
 
: [[API C_AuctionHouse.RequestMoreCommoditySearchResults|C_AuctionHouse.RequestMoreCommoditySearchResults]](<span class="apiarg">itemID</span>) : <span class="apiret">hasFullResults</span>
 
: [[API C_AuctionHouse.RequestMoreCommoditySearchResults|C_AuctionHouse.RequestMoreCommoditySearchResults]](<span class="apiarg">itemID</span>) : <span class="apiret">hasFullResults</span>
 
: [[API C_AuctionHouse.RequestMoreItemSearchResults|C_AuctionHouse.RequestMoreItemSearchResults]](<span class="apiarg">itemKey</span>) : <span class="apiret">hasFullResults</span>
 
: [[API C_AuctionHouse.RequestMoreItemSearchResults|C_AuctionHouse.RequestMoreItemSearchResults]](<span class="apiarg">itemKey</span>) : <span class="apiret">hasFullResults</span>
 
: [[API C_AuctionHouse.RequestOwnedAuctionBidderInfo|C_AuctionHouse.RequestOwnedAuctionBidderInfo]](<span class="apiarg">auctionID</span>) : <span class="apiret">bidderName</span>
 
: [[API C_AuctionHouse.RequestOwnedAuctionBidderInfo|C_AuctionHouse.RequestOwnedAuctionBidderInfo]](<span class="apiarg">auctionID</span>) : <span class="apiret">bidderName</span>
: <small>NOSCRIPT</small> [[API C_AuctionHouse.SearchForFavorites|C_AuctionHouse.SearchForFavorites]](<span class="apiarg">sorts</span>) - Searches for favorited items.
+
: <small>''NOSCRIPT''</small> [[API C_AuctionHouse.SearchForFavorites|C_AuctionHouse.SearchForFavorites]](<span class="apiarg">sorts</span>) - Searches for favorited items.
: [[API C_AuctionHouse.SearchForItemKeys|C_AuctionHouse.SearchForItemKeys]](<span class="apiarg">itemKeys, sorts</span>)
+
: [[API C_AuctionHouse.SearchForItemKeys|C_AuctionHouse.SearchForItemKeys]](<span class="apiarg">itemKeys, sorts</span>) - Queries the auction house for summary results of up to 100 specific items.
: <small>NOSCRIPT</small> [[API C_AuctionHouse.SendBrowseQuery|C_AuctionHouse.SendBrowseQuery]](<span class="apiarg">query</span>)
+
: <small>''NOSCRIPT''</small> [[API C_AuctionHouse.SendBrowseQuery|C_AuctionHouse.SendBrowseQuery]](<span class="apiarg">query</span>)
: <small>NOSCRIPT</small> [[API C_AuctionHouse.SendSearchQuery|C_AuctionHouse.SendSearchQuery]](<span class="apiarg">itemKey, sorts, separateOwnerItems [, minLevelFilter, maxLevelFilter]</span>) - Queries an item in the auction house.
+
: <small>''NOSCRIPT''</small> [[API C_AuctionHouse.SendSearchQuery|C_AuctionHouse.SendSearchQuery]](<span class="apiarg">itemKey, sorts, separateOwnerItems [, minLevelFilter, maxLevelFilter]</span>) - Queries an item in the auction house.
 
: [[API C_AuctionHouse.SendSellSearchQuery|C_AuctionHouse.SendSellSearchQuery]](<span class="apiarg">itemKey, sorts, separateOwnerItems</span>) - Search for all auctions that are variants of a piece of gear, determined a specific item ID.
 
: [[API C_AuctionHouse.SendSellSearchQuery|C_AuctionHouse.SendSellSearchQuery]](<span class="apiarg">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 class="apiarg">itemKey, setFavorite</span>)
 
: [[API C_AuctionHouse.SetFavoriteItem|C_AuctionHouse.SetFavoriteItem]](<span class="apiarg">itemKey, setFavorite</span>)
: <small>HW, NOSCRIPT</small> [[API C_AuctionHouse.StartCommoditiesPurchase|C_AuctionHouse.StartCommoditiesPurchase]](<span class="apiarg">itemID, quantity</span>) - Starts a commodity item purchase.
+
: <small>''HW, NOSCRIPT''</small> [[API C_AuctionHouse.StartCommoditiesPurchase|C_AuctionHouse.StartCommoditiesPurchase]](<span class="apiarg">itemID, quantity</span>) - Starts a commodity item purchase.
   
==== Black Market AH ====
+
====Black Market AH====
 
The [[Black Market Auction House]] was added in [[Patch 5.0.4]]
 
The [[Black Market Auction House]] was added in [[Patch 5.0.4]]
: [[API C_BlackMarket.Close|C_BlackMarket.Close]]() - Notifies the server that the Black Market UI was closed.
+
: [[API C_BlackMarket.Close|C_BlackMarket.Close]]() - Closes the [[Black Market]] window.
 
: [[API C_BlackMarket.GetHotItem|C_BlackMarket.GetHotItem]]() - Returns information about the current "hot item" at the [[Black Market Auction House]].
 
: [[API C_BlackMarket.GetHotItem|C_BlackMarket.GetHotItem]]() - Returns information about the current "hot item" at the [[Black Market Auction House]].
: [[API C_BlackMarket.GetItemInfoByID|C_BlackMarket.GetItemInfoByID]](<span class="apiarg">marketID</span>) - Returns information about a specific black market auction.
+
: [[API C_BlackMarket.GetItemInfoByID|C_BlackMarket.GetItemInfoByID]](<span class="apiarg">marketID</span>) - Returns info for a [[Black Market]] auction.
 
: [[API C_BlackMarket.GetItemInfoByIndex|C_BlackMarket.GetItemInfoByIndex]](<span class="apiarg">index</span>) - Returns information about a specific black market auction.
 
: [[API C_BlackMarket.GetItemInfoByIndex|C_BlackMarket.GetItemInfoByIndex]](<span class="apiarg">index</span>) - Returns information about a specific black market auction.
 
: [[API C_BlackMarket.GetNumItems|C_BlackMarket.GetNumItems]]() - Returns the number of auctions on the [[Black Market Auction House]].
 
: [[API C_BlackMarket.GetNumItems|C_BlackMarket.GetNumItems]]() - Returns the number of auctions on the [[Black Market Auction House]].
 
: [[API C_BlackMarket.IsViewOnly|C_BlackMarket.IsViewOnly]]()
 
: [[API C_BlackMarket.IsViewOnly|C_BlackMarket.IsViewOnly]]()
: <small>HW</small> [[API C_BlackMarket.ItemPlaceBid|C_BlackMarket.ItemPlaceBid]](<span class="apiarg">marketID, bid</span>) - Places a bid on a black market auction.
+
: <small>''HW''</small> [[API C_BlackMarket.ItemPlaceBid|C_BlackMarket.ItemPlaceBid]](<span class="apiarg">marketID, bid</span>) - Places a bid on a black market auction.
 
: [[API C_BlackMarket.RequestItems|C_BlackMarket.RequestItems]]() - Requests updated black market auction information from the server.
 
: [[API C_BlackMarket.RequestItems|C_BlackMarket.RequestItems]]() - Requests updated black market auction information from the server.
   
==== WoW Tokens ====
+
====WoW Tokens====
 
[[WoW Token]]s were added in [[Patch 6.1.2]]
 
[[WoW Token]]s were added in [[Patch 6.1.2]]
 
: [[API C_WowTokenPublic.BuyToken|C_WowTokenPublic.BuyToken]]()
 
: [[API C_WowTokenPublic.BuyToken|C_WowTokenPublic.BuyToken]]()
Line 289: Line 294:
 
: [[API C_WowTokenUI.StartTokenSell|C_WowTokenUI.StartTokenSell]](<span class="apiarg">tokenGUID</span>)
 
: [[API C_WowTokenUI.StartTokenSell|C_WowTokenUI.StartTokenSell]](<span class="apiarg">tokenGUID</span>)
   
=== Bags ===
+
===Bags===
 
: [[API GetBackpackAutosortDisabled|GetBackpackAutosortDisabled]]()
 
: [[API GetBackpackAutosortDisabled|GetBackpackAutosortDisabled]]()
: [[API GetBagName|GetBagName]](<span class="apiarg">bagID</span>) - Get the name of one of the player's bags.
+
: [[API GetBagName|GetBagName]](<span class="apiarg">bagID</span>) - Returns the item name of the specified player bag.
 
: [[API GetBagSlotFlag|GetBagSlotFlag]](<span class="apiarg">index, flagIndex</span>)
 
: [[API GetBagSlotFlag|GetBagSlotFlag]](<span class="apiarg">index, flagIndex</span>)
 
: [[API GetInsertItemsLeftToRight|GetInsertItemsLeftToRight]]()
 
: [[API GetInsertItemsLeftToRight|GetInsertItemsLeftToRight]]()
Line 297: Line 302:
 
: [[API IsBagSlotFlagEnabledOnOtherBags|IsBagSlotFlagEnabledOnOtherBags]](<span class="apiarg">index, flagIndex</span>)
 
: [[API IsBagSlotFlagEnabledOnOtherBags|IsBagSlotFlagEnabledOnOtherBags]](<span class="apiarg">index, flagIndex</span>)
 
: [[API IsInventoryItemProfessionBag|IsInventoryItemProfessionBag]](<span class="apiarg">unit, slot</span>)
 
: [[API IsInventoryItemProfessionBag|IsInventoryItemProfessionBag]](<span class="apiarg">unit, slot</span>)
: [[API PutItemInBackpack|PutItemInBackpack]]() - Attempts to place item in backpack (bag slot 0).
+
: [[API PutItemInBackpack|PutItemInBackpack]]() - Places the item on the cursor into the player's backpack.
: [[API PutItemInBag|PutItemInBag]](<span class="apiarg">inventoryId</span>) - Attempts to place item in a specific bag.
+
: [[API PutItemInBag|PutItemInBag]](<span class="apiarg">inventoryId</span>) - Places the item on the cursor into the specified bag slot.
 
: [[API SetBackpackAutosortDisabled|SetBackpackAutosortDisabled]](<span class="apiarg">disable</span>)
 
: [[API SetBackpackAutosortDisabled|SetBackpackAutosortDisabled]](<span class="apiarg">disable</span>)
 
: [[API SetBagPortraitTexture|SetBagPortraitTexture]](<span class="apiarg">texture, slot</span>)
 
: [[API SetBagPortraitTexture|SetBagPortraitTexture]](<span class="apiarg">texture, slot</span>)
Line 307: Line 312:
 
: [[API SetSortBagsRightToLeft|SetSortBagsRightToLeft]](<span class="apiarg">disable</span>)
 
: [[API SetSortBagsRightToLeft|SetSortBagsRightToLeft]](<span class="apiarg">disable</span>)
 
: [[API SortBags|SortBags]]()
 
: [[API SortBags|SortBags]]()
: <small>UI</small> {{api|CloseAllBags}}(<span class="apiarg">callingFrame, forceUpdate</span>)
+
: <small>''UI''</small> {{api|CloseAllBags}}(<span class="apiarg">callingFrame, forceUpdate</span>)
: <small>UI</small> {{api|CloseBackpack}}()
+
: <small>''UI''</small> {{api|CloseBackpack}}()
: <small>UI</small> {{api|CloseBag}}(<span class="apiarg">bagID</span>)
+
: <small>''UI''</small> {{api|CloseBag}}(<span class="apiarg">bagID</span>)
: <small>UI</small> {{api|IsBagOpen}}(<span class="apiarg">bagID</span>)
+
: <small>''UI''</small> {{api|IsBagOpen}}(<span class="apiarg">bagID</span>)
: <small>UI</small> {{api|OpenAllBags}}(<span class="apiarg">callingFrame, forceUpdate</span>)
+
: <small>''UI''</small> {{api|OpenAllBags}}(<span class="apiarg">callingFrame, forceUpdate</span>)
: <small>UI</small> {{api|OpenBackpack}}()
+
: <small>''UI''</small> {{api|OpenBackpack}}()
: <small>UI</small> {{api|OpenBag}}(<span class="apiarg">bagID, force</span>)
+
: <small>''UI''</small> {{api|OpenBag}}(<span class="apiarg">bagID, force</span>)
: <small>UI</small> {{api|ToggleAllBags}}()
+
: <small>''UI''</small> {{api|ToggleAllBags}}()
: <small>UI</small> {{api|ToggleBackpack}}() - Toggles your backpack open/closed.
+
: <small>''UI''</small> {{api|ToggleBackpack}}() - Toggles your backpack open/closed.
: <small>UI</small> {{api|ToggleBag|ToggleBag}}(<span class="apiarg">bagID</span>) - Opens or closes the specified bag.
+
: <small>''UI''</small> {{api|ToggleBag|ToggleBag}}(<span class="apiarg">bagID</span>) - Opens or closes the specified bag.
   
==== Containers ====
+
====Containers====
 
: [[API GetContainerFreeSlots|GetContainerFreeSlots]](<span class="apiarg">index [, returnTable]</span>)
 
: [[API GetContainerFreeSlots|GetContainerFreeSlots]](<span class="apiarg">index [, returnTable]</span>)
 
: [[API GetContainerItemCooldown|GetContainerItemCooldown]](<span class="apiarg">bagID, slot</span>)
 
: [[API GetContainerItemCooldown|GetContainerItemCooldown]](<span class="apiarg">bagID, slot</span>)
: [[API GetContainerItemDurability|GetContainerItemDurability]](<span class="apiarg">bag, slot</span>) - Get current and maximum durability of an item in the character's bags.
+
: [[API GetContainerItemDurability|GetContainerItemDurability]](<span class="apiarg">bag, slot</span>) - Returns the durability of an item in a container slot.
 
: [[API GetContainerItemEquipmentSetInfo|GetContainerItemEquipmentSetInfo]](<span class="apiarg">index, slot</span>)
 
: [[API GetContainerItemEquipmentSetInfo|GetContainerItemEquipmentSetInfo]](<span class="apiarg">index, slot</span>)
: [[API GetContainerItemID|GetContainerItemID]](<span class="apiarg">bag, slot</span>) - Returns the item ID of the item in a particular container slot.
+
: [[API GetContainerItemID|GetContainerItemID]](<span class="apiarg">bag, slot</span>) - Returns the item ID in a container slot.
: [[API GetContainerItemInfo|GetContainerItemInfo]](<span class="apiarg">bagID, slot</span>) - Get the info for an item in one of the player's bags.
+
: [[API GetContainerItemInfo|GetContainerItemInfo]](<span class="apiarg">bagID, slot</span>) - Returns info for an item in a container slot.
 
: [[API GetContainerItemLink|GetContainerItemLink]](<span class="apiarg">bagID, slot</span>) - Returns a link of the object located in the specified slot of a specified bag.
 
: [[API GetContainerItemLink|GetContainerItemLink]](<span class="apiarg">bagID, slot</span>) - Returns a link of the object located in the specified slot of a specified bag.
 
: [[API GetContainerItemPurchaseCurrency|GetContainerItemPurchaseCurrency]](<span class="apiarg">bag, slot, itemIndex [, isEquipped]</span>)
 
: [[API GetContainerItemPurchaseCurrency|GetContainerItemPurchaseCurrency]](<span class="apiarg">bag, slot, itemIndex [, isEquipped]</span>)
 
: [[API GetContainerItemPurchaseInfo|GetContainerItemPurchaseInfo]](<span class="apiarg">index, slot [, isEquipped]</span>)
 
: [[API GetContainerItemPurchaseInfo|GetContainerItemPurchaseInfo]](<span class="apiarg">index, slot [, isEquipped]</span>)
 
: [[API GetContainerItemPurchaseItem|GetContainerItemPurchaseItem]](<span class="apiarg">bag, slot, itemIndex [, isEquipped]</span>)
 
: [[API GetContainerItemPurchaseItem|GetContainerItemPurchaseItem]](<span class="apiarg">bag, slot, itemIndex [, isEquipped]</span>)
: [[API GetContainerItemQuestInfo|GetContainerItemQuestInfo]](<span class="apiarg">bag, slot</span>) - Returns information about quest and quest-starting items in your bags.
+
: [[API GetContainerItemQuestInfo|GetContainerItemQuestInfo]](<span class="apiarg">bag, slot</span>) - Returns info for a quest item in a container slot.
: [[API GetContainerNumFreeSlots|GetContainerNumFreeSlots]](<span class="apiarg">bagID</span>) - Returns the number of free slots and type of slots in the bag specified by the index.
+
: [[API GetContainerNumFreeSlots|GetContainerNumFreeSlots]](<span class="apiarg">bagID</span>) - Returns the number of free slots in a bag.
 
: [[API GetContainerNumSlots|GetContainerNumSlots]](<span class="apiarg">bagID</span>) - Returns the total number of slots in the bag specified by the index.
 
: [[API GetContainerNumSlots|GetContainerNumSlots]](<span class="apiarg">bagID</span>) - Returns the total number of slots in the bag specified by the index.
 
: [[API IsContainerFiltered|IsContainerFiltered]](<span class="apiarg">index</span>)
 
: [[API IsContainerFiltered|IsContainerFiltered]](<span class="apiarg">index</span>)
 
: [[API IsContainerItemAnUpgrade|IsContainerItemAnUpgrade]](<span class="apiarg">index, slot</span>)
 
: [[API IsContainerItemAnUpgrade|IsContainerItemAnUpgrade]](<span class="apiarg">index, slot</span>)
: [[API SplitContainerItem|SplitContainerItem]](<span class="apiarg">bagID, slot, amount</span>) - Picks up part of a stack.
+
: [[API SplitContainerItem|SplitContainerItem]](<span class="apiarg">bagID, slot, amount</span>) - Places part of a stack of items from a container onto the cursor.
: [[API UseContainerItem|UseContainerItem]](<span class="apiarg">bagID, slot [, target]</span>) - Performs a "right click" action on, or targeted use of, on an item in bags.
+
: [[API UseContainerItem|UseContainerItem]](<span class="apiarg">bagID, slot [, target]</span>) - Uses an item from a container depending on the situation.
   
==== Inventory ====
+
====Inventory====
 
These functions manage your inventory, specifically '''equipped items'''.
 
These functions manage your inventory, specifically '''equipped items'''.
: [[API CancelPendingEquip|CancelPendingEquip]](<span class="apiarg">index</span>) - This function is used to cancel a pending equip.
+
: [[API CancelPendingEquip|CancelPendingEquip]](<span class="apiarg">index</span>) - Cancels a pending equip confirmation.
: <small>PROTECTED</small> [[API ConfirmBindOnUse|ConfirmBindOnUse]]()
+
: <small>''PROTECTED''</small> [[API ConfirmBindOnUse|ConfirmBindOnUse]]()
: <small>PROTECTED</small> [[API ConfirmNoRefundOnUse|ConfirmNoRefundOnUse]]()
+
: <small>''PROTECTED''</small> [[API ConfirmNoRefundOnUse|ConfirmNoRefundOnUse]]()
 
: [[API ContainerIDToInventoryID|ContainerIDToInventoryID]](<span class="apiarg">bagID</span>)
 
: [[API ContainerIDToInventoryID|ContainerIDToInventoryID]](<span class="apiarg">bagID</span>)
 
: [[API EquipPendingItem|EquipPendingItem]](<span class="apiarg">invSlot</span>) - Equips the currently pending Bind-on-Equip or Bind-on-Pickup item from the specified inventory slot.
 
: [[API EquipPendingItem|EquipPendingItem]](<span class="apiarg">invSlot</span>) - Equips the currently pending Bind-on-Equip or Bind-on-Pickup item from the specified inventory slot.
: [[API GetAverageItemLevel|GetAverageItemLevel]]() - Returns the character's current average iLevel and current average iLevel equipped.
+
: [[API GetAverageItemLevel|GetAverageItemLevel]]() - Returns the character's average item level.
: [[API GetInventoryAlertStatus|GetInventoryAlertStatus]](<span class="apiarg">index</span>) - Returns one of several codes describing the "status" of an equipped item.
+
: [[API GetInventoryAlertStatus|GetInventoryAlertStatus]](<span class="apiarg">index</span>) - Returns the durability status of an equipped item.
: [[API GetInventoryItemBroken|GetInventoryItemBroken]](<span class="apiarg">unit, invSlot</span>) - Determine if an inventory item is broken (no durability).
+
: [[API GetInventoryItemBroken|GetInventoryItemBroken]](<span class="apiarg">unit, invSlot</span>) - True if an inventory item has zero durability.
 
: [[API GetInventoryItemCooldown|GetInventoryItemCooldown]](<span class="apiarg">unit, invSlot</span>) - Get cooldown information for an inventory item.
 
: [[API GetInventoryItemCooldown|GetInventoryItemCooldown]](<span class="apiarg">unit, invSlot</span>) - Get cooldown information for an inventory item.
 
: [[API GetInventoryItemCount|GetInventoryItemCount]](<span class="apiarg">unit, invSlot</span>) - Determine the quantity of an item in an inventory slot.
 
: [[API GetInventoryItemCount|GetInventoryItemCount]](<span class="apiarg">unit, invSlot</span>) - Determine the quantity of an item in an inventory slot.
: [[API GetInventoryItemDurability|GetInventoryItemDurability]](<span class="apiarg">invSlot</span>) - Returns the maximum and remaining durability points for an inventory item.
+
: [[API GetInventoryItemDurability|GetInventoryItemDurability]](<span class="apiarg">invSlot</span>) - Returns the durability of an equipped item.
: [[API GetInventoryItemID|GetInventoryItemID]](<span class="apiarg">unit, invSlot</span>) - Returns the item id of the item in the specified inventory slot.
+
: [[API GetInventoryItemID|GetInventoryItemID]](<span class="apiarg">unit, invSlot</span>) - Returns the item ID for an equipped item.
: [[API GetInventoryItemLink|GetInventoryItemLink]](<span class="apiarg">unit, invSlot</span>) - Returns an [[itemLink]] for an inventory (equipped) item.
+
: [[API GetInventoryItemLink|GetInventoryItemLink]](<span class="apiarg">unit, invSlot</span>) - Returns the item link for an equipped item.
: [[API GetInventoryItemQuality|GetInventoryItemQuality]](<span class="apiarg">unit, invSlot</span>) - Returns the quality of an inventory item.
+
: [[API GetInventoryItemQuality|GetInventoryItemQuality]](<span class="apiarg">unit, invSlot</span>) - Returns the quality of an equipped item.
: [[API GetInventoryItemTexture|GetInventoryItemTexture]](<span class="apiarg">unit, invSlot</span>) - Returns the texture for an inventory item.
+
: [[API GetInventoryItemTexture|GetInventoryItemTexture]](<span class="apiarg">unit, invSlot</span>) - Returns the texture for an equipped item.
: [[API GetInventorySlotInfo|GetInventorySlotInfo]](<span class="apiarg">invSlotName</span>) - Get the info for a named inventory slot (slot ID and texture)
+
: [[API GetInventorySlotInfo|GetInventorySlotInfo]](<span class="apiarg">invSlotName</span>) - Returns info for an equipment slot.
: [[API HasWandEquipped|HasWandEquipped]]() - Returns 1 if a wand is equipped, false otherwise.
+
: [[API HasWandEquipped|HasWandEquipped]]() - True if a wand is equipped.
 
: [[API IsInventoryItemLocked|IsInventoryItemLocked]](<span class="apiarg">id</span>) - Returns whether an inventory item is locked, usually as it awaits pending action.
 
: [[API IsInventoryItemLocked|IsInventoryItemLocked]](<span class="apiarg">id</span>) - Returns whether an inventory item is locked, usually as it awaits pending action.
 
: [[API SetInventoryPortraitTexture|SetInventoryPortraitTexture]](<span class="apiarg">texture, unit, slot</span>)
 
: [[API SetInventoryPortraitTexture|SetInventoryPortraitTexture]](<span class="apiarg">texture, unit, slot</span>)
 
: [[API UpdateInventoryAlertStatus|UpdateInventoryAlertStatus]]()
 
: [[API UpdateInventoryAlertStatus|UpdateInventoryAlertStatus]]()
: <small>PROTECTED</small> [[API UseInventoryItem|UseInventoryItem]](<span class="apiarg">invSlot</span>) - Use an item in a specific inventory slot.
+
: <small>''PROTECTED''</small> [[API UseInventoryItem|UseInventoryItem]](<span class="apiarg">invSlot</span>) - Use an item in a specific inventory slot.
   
=== Bank ===
+
===Bank===
 
Relates to the [[Bank]].
 
Relates to the [[Bank]].
: [[API BankButtonIDToInvSlotID|BankButtonIDToInvSlotID]](<span class="apiarg">buttonID, isBag</span>) - Returns the ID number of a bank button or bag in terms of inventory slot ID.
+
: [[API BankButtonIDToInvSlotID|BankButtonIDToInvSlotID]](<span class="apiarg">buttonID, isBag</span>) - Maps a BankButtonID to InventorySlotID.
 
: [[API BuyReagentBank|BuyReagentBank]]()
 
: [[API BuyReagentBank|BuyReagentBank]]()
: [[API CloseBankFrame|CloseBankFrame]]() - Close the bank frame if it's open.
+
: [[API CloseBankFrame|CloseBankFrame]]() - Closes the bank window.
 
: [[API DepositReagentBank|DepositReagentBank]]()
 
: [[API DepositReagentBank|DepositReagentBank]]()
 
: [[API GetBankAutosortDisabled|GetBankAutosortDisabled]]()
 
: [[API GetBankAutosortDisabled|GetBankAutosortDisabled]]()
 
: [[API GetBankBagSlotFlag|GetBankBagSlotFlag]]()
 
: [[API GetBankBagSlotFlag|GetBankBagSlotFlag]]()
: [[API GetBankSlotCost|GetBankSlotCost]](<span class="apiarg">numSlots</span>) - Returns the cost of the next bank slot.
+
: [[API GetBankSlotCost|GetBankSlotCost]](<span class="apiarg">numSlots</span>) - Returns the cost of the next bank bag slot.
: [[API GetNumBankSlots|GetNumBankSlots]]() - Returns total purchased bank bag slots, and a flag indicating if it's full.
+
: [[API GetNumBankSlots|GetNumBankSlots]]() - Returns the number of purchased bank bag slots.
 
: [[API GetReagentBankCost|GetReagentBankCost]]()
 
: [[API GetReagentBankCost|GetReagentBankCost]]()
 
: [[API IsBagSlotFlagEnabledOnOtherBankBags|IsBagSlotFlagEnabledOnOtherBankBags]]()
 
: [[API IsBagSlotFlagEnabledOnOtherBankBags|IsBagSlotFlagEnabledOnOtherBankBags]]()
Line 381: Line 386:
 
: [[API SortReagentBankBags|SortReagentBankBags]]()
 
: [[API SortReagentBankBags|SortReagentBankBags]]()
   
==== Guild Bank ====
+
====Guild Bank====
 
The [[Guild bank]] was added in [[Patch 2.3.0]]
 
The [[Guild bank]] was added in [[Patch 2.3.0]]
: [[API AutoStoreGuildBankItem|AutoStoreGuildBankItem]](<span class="apiarg">tab, slot</span>) - Withdraws an item from the bank, and automatically stores it in the player's inventory.
+
: [[API AutoStoreGuildBankItem|AutoStoreGuildBankItem]](<span class="apiarg">tab, slot</span>) - Withdraws an item from the Guild Bank to the character's inventory.
 
: [[API BuyGuildBankTab|BuyGuildBankTab]]() - Buys a guild bank tab, without confirmation.
 
: [[API BuyGuildBankTab|BuyGuildBankTab]]() - Buys a guild bank tab, without confirmation.
 
: [[API CanEditGuildBankTabInfo|CanEditGuildBankTabInfo]]()
 
: [[API CanEditGuildBankTabInfo|CanEditGuildBankTabInfo]]()
Line 392: Line 397:
 
: [[API GetCurrentGuildBankTab|GetCurrentGuildBankTab]]() - Integer of selected tab, >= 1.
 
: [[API GetCurrentGuildBankTab|GetCurrentGuildBankTab]]() - Integer of selected tab, >= 1.
 
: [[API GetGuildBankBonusDepositMoney|GetGuildBankBonusDepositMoney]]()
 
: [[API GetGuildBankBonusDepositMoney|GetGuildBankBonusDepositMoney]]()
: [[API GetGuildBankItemInfo|GetGuildBankItemInfo]](<span class="apiarg">tab, slot</span>) - Returns texture, amount and integer 1 or nil depending on locked state.
+
: [[API GetGuildBankItemInfo|GetGuildBankItemInfo]](<span class="apiarg">tab, slot</span>) - Returns item info for a guild bank slot.
: [[API GetGuildBankItemLink|GetGuildBankItemLink]](<span class="apiarg">tab, slot</span>) - Returns itemLink.
+
: [[API GetGuildBankItemLink|GetGuildBankItemLink]](<span class="apiarg">tab, slot</span>) - Returns the item link for a guild bank slot.
: [[API GetGuildBankMoney|GetGuildBankMoney]]() - Integer, funds available in copper.
+
: [[API GetGuildBankMoney|GetGuildBankMoney]]() - Returns the amount of money in the guild bank.
: [[API GetGuildBankMoneyTransaction|GetGuildBankMoneyTransaction]](<span class="apiarg">index</span>) - No bank proximity required, however QueryGuildBankLog function requires proximity.
+
: [[API GetGuildBankMoneyTransaction|GetGuildBankMoneyTransaction]](<span class="apiarg">index</span>) - Returns info for a money transaction from the guild bank.
 
: [[API GetGuildBankTabCost|GetGuildBankTabCost]]() - Integer OR nil - cost in copper OR no tabs available to buy.
 
: [[API GetGuildBankTabCost|GetGuildBankTabCost]]() - Integer OR nil - cost in copper OR no tabs available to buy.
: [[API GetGuildBankTabInfo|GetGuildBankTabInfo]](<span class="apiarg">tab</span>) - Returns the name and icon of the guild bank tab queried.
+
: [[API GetGuildBankTabInfo|GetGuildBankTabInfo]](<span class="apiarg">tab</span>) - Returns info for a guild bank tab.
 
: [[API GetGuildBankTabPermissions|GetGuildBankTabPermissions]](<span class="apiarg">tab</span>) - Gets display / player's access info. Limited data available without bank proximity.
 
: [[API GetGuildBankTabPermissions|GetGuildBankTabPermissions]](<span class="apiarg">tab</span>) - Gets display / player's access info. Limited data available without bank proximity.
 
: [[API GetGuildBankText|GetGuildBankText]](<span class="apiarg">tab</span>) - Returns info text for a tab.
 
: [[API GetGuildBankText|GetGuildBankText]](<span class="apiarg">tab</span>) - Returns info text for a tab.
: [[API GetGuildBankTransaction|GetGuildBankTransaction]](<span class="apiarg">tab, index</span>) - Requires Guild Bank Proximity.
+
: [[API GetGuildBankTransaction|GetGuildBankTransaction]](<span class="apiarg">tab, index</span>) - Returns info for an item transaction from the guild bank.
 
: [[API GetGuildBankWithdrawGoldLimit|GetGuildBankWithdrawGoldLimit]]() - Returns withdraw limit for currently selected rank in guild control.
 
: [[API GetGuildBankWithdrawGoldLimit|GetGuildBankWithdrawGoldLimit]]() - Returns withdraw limit for currently selected rank in guild control.
 
: [[API GetGuildBankWithdrawMoney|GetGuildBankWithdrawMoney]]()
 
: [[API GetGuildBankWithdrawMoney|GetGuildBankWithdrawMoney]]()
Line 410: Line 415:
 
: [[API QueryGuildBankText|QueryGuildBankText]]()
 
: [[API QueryGuildBankText|QueryGuildBankText]]()
 
: [[API SetCurrentGuildBankTab|SetCurrentGuildBankTab]](<span class="apiarg">tab</span>) - Select different bank tab in the UI.
 
: [[API SetCurrentGuildBankTab|SetCurrentGuildBankTab]](<span class="apiarg">tab</span>) - Select different bank tab in the UI.
: [[API SetGuildBankTabInfo|SetGuildBankTabInfo]](<span class="apiarg">tab, name, icon</span>) - Modifies name and icon for tab.
+
: [[API SetGuildBankTabInfo|SetGuildBankTabInfo]](<span class="apiarg">tab, name, icon</span>) - Sets the name and icon of a guild bank tab.
 
: [[API SetGuildBankTabItemWithdraw|SetGuildBankTabItemWithdraw]]()
 
: [[API SetGuildBankTabItemWithdraw|SetGuildBankTabItemWithdraw]]()
: [[API SetGuildBankTabPermissions|SetGuildBankTabPermissions]](<span class="apiarg">tab, index, enabled</span>) - Modifies the permissions for the GuildBankTab. Guild Leader Only.
+
: [[API SetGuildBankTabPermissions|SetGuildBankTabPermissions]](<span class="apiarg">tab, index, enabled</span>) - Modifies the permissions for a guild bank tab.
 
: [[API SetGuildBankText|SetGuildBankText]](<span class="apiarg">tab, infoText</span>) - Modifies info text for a tab.
 
: [[API SetGuildBankText|SetGuildBankText]](<span class="apiarg">tab, infoText</span>) - Modifies info text for a tab.
: [[API SetGuildBankWithdrawGoldLimit|SetGuildBankWithdrawGoldLimit]](<span class="apiarg">amount</span>) - Sets the gold withdraw limit from the guild bank. Guild Leader Only.
+
: [[API SetGuildBankWithdrawGoldLimit|SetGuildBankWithdrawGoldLimit]](<span class="apiarg">amount</span>) - Sets the gold withdraw limit for the guild bank.
 
: [[API SplitGuildBankItem|SplitGuildBankItem]](<span class="apiarg">tab, slot, amount</span>) - Picks up part of a stack.
 
: [[API SplitGuildBankItem|SplitGuildBankItem]](<span class="apiarg">tab, slot, amount</span>) - Picks up part of a stack.
 
: [[API WithdrawGuildBankMoney|WithdrawGuildBankMoney]](<span class="apiarg">money</span>) - Withdraws "money" copper from the guild bank.
 
: [[API WithdrawGuildBankMoney|WithdrawGuildBankMoney]](<span class="apiarg">money</span>) - Withdraws "money" copper from the guild bank.
   
==== Void Storage ====
+
====Void Storage====
 
[[Void Storage]] was added in [[Patch 4.3.0]]
 
[[Void Storage]] was added in [[Patch 4.3.0]]
 
: [[API CanUseVoidStorage|CanUseVoidStorage]]() - Returns if the player has access to the Void Storage.
 
: [[API CanUseVoidStorage|CanUseVoidStorage]]() - Returns if the player has access to the Void Storage.
Line 430: Line 435:
 
: [[API GetNumVoidTransferWithdrawal|GetNumVoidTransferWithdrawal]]() - Returns the number of items being withdrawed from the Void Storage.
 
: [[API GetNumVoidTransferWithdrawal|GetNumVoidTransferWithdrawal]]() - Returns the number of items being withdrawed from the Void Storage.
 
: [[API GetVoidItemHyperlinkString|GetVoidItemHyperlinkString]](<span class="apiarg">slotIndex</span>) - Returns the item link of an item in void storage.
 
: [[API GetVoidItemHyperlinkString|GetVoidItemHyperlinkString]](<span class="apiarg">slotIndex</span>) - Returns the item link of an item in void storage.
: [[API GetVoidItemInfo|GetVoidItemInfo]](<span class="apiarg">slotIndex</span>) - Returns <code>itemID, textureName, locked, recentDeposit, isFiltered</code>.
+
: [[API GetVoidItemInfo|GetVoidItemInfo]](<span class="apiarg">slotIndex</span>) - Returns info for a Void Storage slot.
 
: [[API GetVoidTransferCost|GetVoidTransferCost]]() - Returns the total Void Transfer cost.
 
: [[API GetVoidTransferCost|GetVoidTransferCost]]() - Returns the total Void Transfer cost.
: [[API GetVoidTransferDepositInfo|GetVoidTransferDepositInfo]](<span class="apiarg">slotIndex</span>) - Returns <code>itemID, textureName</code>.
+
: [[API GetVoidTransferDepositInfo|GetVoidTransferDepositInfo]](<span class="apiarg">slotIndex</span>) - Returns info for the item being deposited into the Void Storage.
: [[API GetVoidTransferWithdrawalInfo|GetVoidTransferWithdrawalInfo]](<span class="apiarg">slotIndex</span>) - Returns <code>itemID, textureName</code>.
+
: [[API GetVoidTransferWithdrawalInfo|GetVoidTransferWithdrawalInfo]](<span class="apiarg">slotIndex</span>) - Returns info for the item being withdrawn from the Void Storage.
 
: [[API IsVoidStorageReady|IsVoidStorageReady]]()
 
: [[API IsVoidStorageReady|IsVoidStorageReady]]()
: [[API UnlockVoidStorage|UnlockVoidStorage]]() - Pays for and activates the Void Storage.
+
: [[API UnlockVoidStorage|UnlockVoidStorage]]() - Purchases the Void Storage.
 
: [[API GetVoidStorageSlotPageIndex|GetVoidStorageSlotPageIndex]](<span class="apiarg">slot</span>)
 
: [[API GetVoidStorageSlotPageIndex|GetVoidStorageSlotPageIndex]](<span class="apiarg">slot</span>)
 
: [[API GetVoidUnlockCost|GetVoidUnlockCost]]()
 
: [[API GetVoidUnlockCost|GetVoidUnlockCost]]()
   
=== Books ===
+
===Books===
 
Relates to item text from books, etc.
 
Relates to item text from books, etc.
 
: [[API CloseItemText|CloseItemText]]() - Close an open item text (book, plaque, etc).
 
: [[API CloseItemText|CloseItemText]]() - Close an open item text (book, plaque, etc).
: [[API ItemTextGetCreator|ItemTextGetCreator]]() - Get the creator of the current text (if player-created).
+
: [[API ItemTextGetCreator|ItemTextGetCreator]]() - Returns the name of the character who created the item text.
: [[API ItemTextGetItem|ItemTextGetItem]]() - Get the name of the text.
+
: [[API ItemTextGetItem|ItemTextGetItem]]() - Returns the item name that the item text belongs to.
: [[API ItemTextGetMaterial|ItemTextGetMaterial]]() - Get the material on which the text is printed.
+
: [[API ItemTextGetMaterial|ItemTextGetMaterial]]() - Returns the material texture for the item text.
: [[API ItemTextGetPage|ItemTextGetPage]]() - Get the page number of the currently viewed page.
+
: [[API ItemTextGetPage|ItemTextGetPage]]() - Returns the page number of the currently displayed page.
: [[API ItemTextGetText|ItemTextGetText]]() - Get the page contents of the currently viewed page.
+
: [[API ItemTextGetText|ItemTextGetText]]() - Returns the contents of the currently displayed page.
: [[API ItemTextHasNextPage|ItemTextHasNextPage]]() - Determine if there is another page after the current one.
+
: [[API ItemTextHasNextPage|ItemTextHasNextPage]]() - True if there is a page after the current page.
 
: [[API ItemTextIsFullPage|ItemTextIsFullPage]]()
 
: [[API ItemTextIsFullPage|ItemTextIsFullPage]]()
: [[API ItemTextNextPage|ItemTextNextPage]]() - Request the next page of the text.
+
: [[API ItemTextNextPage|ItemTextNextPage]]() - Moves to the next page of the item text.
: [[API ItemTextPrevPage|ItemTextPrevPage]]() - Request the previous page of the text.
+
: [[API ItemTextPrevPage|ItemTextPrevPage]]() - Moves to the previous page of the item text.
   
=== Calendar ===
+
===Calendar===
 
The [[Calendar]] was added in [[Patch 3.0.1]] and reworked in [[Patch 8.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 class="apiret">ready</span>
 
: [[API C_Calendar.AreNamesReady|C_Calendar.AreNamesReady]]() : <span class="apiret">ready</span>
 
: [[API C_Calendar.CanAddEvent|C_Calendar.CanAddEvent]]() : <span class="apiret">canAddEvent</span> - Returns whether the player can add an event.
 
: [[API C_Calendar.CanAddEvent|C_Calendar.CanAddEvent]]() : <span class="apiret">canAddEvent</span> - Returns whether the player can add an event.
Line 463: Line 468:
 
: [[API C_Calendar.ContextMenuEventCanRemove|C_Calendar.ContextMenuEventCanRemove]](<span class="apiarg">offsetMonths, monthDay, eventIndex</span>) : <span class="apiret">canRemove</span> - Returns whether the player can remove the event.
 
: [[API C_Calendar.ContextMenuEventCanRemove|C_Calendar.ContextMenuEventCanRemove]](<span class="apiarg">offsetMonths, monthDay, eventIndex</span>) : <span class="apiret">canRemove</span> - Returns whether the player can remove the event.
 
: [[API C_Calendar.ContextMenuEventClipboard|C_Calendar.ContextMenuEventClipboard]]() : <span class="apiret">exists</span>
 
: [[API C_Calendar.ContextMenuEventClipboard|C_Calendar.ContextMenuEventClipboard]]() : <span class="apiret">exists</span>
: [[API C_Calendar.ContextMenuEventComplain|C_Calendar.ContextMenuEventComplain]]() - Reports the event as spam.
 
 
: [[API C_Calendar.ContextMenuEventCopy|C_Calendar.ContextMenuEventCopy]]() - Copies the event to the clipboard.
 
: [[API C_Calendar.ContextMenuEventCopy|C_Calendar.ContextMenuEventCopy]]() - Copies the event to the clipboard.
 
: [[API C_Calendar.ContextMenuEventGetCalendarType|C_Calendar.ContextMenuEventGetCalendarType]]() : <span class="apiret">calendarType</span>
 
: [[API C_Calendar.ContextMenuEventGetCalendarType|C_Calendar.ContextMenuEventGetCalendarType]]() : <span class="apiret">calendarType</span>
Line 544: Line 548:
 
: [[API C_Calendar.SetMonth|C_Calendar.SetMonth]](<span class="apiarg">offsetMonths</span>)
 
: [[API C_Calendar.SetMonth|C_Calendar.SetMonth]](<span class="apiarg">offsetMonths</span>)
 
: [[API C_Calendar.SetNextClubId|C_Calendar.SetNextClubId]](<span class="apiarg">[clubId]</span>)
 
: [[API C_Calendar.SetNextClubId|C_Calendar.SetNextClubId]](<span class="apiarg">[clubId]</span>)
: <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.
   
=== Chat ===
+
===Chat===
 
These are specific to chat messages and channels.
 
These are specific to chat messages and channels.
 
: [[API C_ChatInfo.GetChannelInfoFromIdentifier|C_ChatInfo.GetChannelInfoFromIdentifier]](<span class="apiarg">channelIdentifier</span>) : <span class="apiret">info</span>
 
: [[API C_ChatInfo.GetChannelInfoFromIdentifier|C_ChatInfo.GetChannelInfoFromIdentifier]](<span class="apiarg">channelIdentifier</span>) : <span class="apiret">info</span>
Line 573: Line 577:
 
: [[API ChannelBan|ChannelBan]](<span class="apiarg">channel, name</span>) - Bans a player from the specified channel.
 
: [[API ChannelBan|ChannelBan]](<span class="apiarg">channel, name</span>) - Bans a player from the specified channel.
 
: [[API ChannelInvite|ChannelInvite]](<span class="apiarg">channel, name</span>) - Invites the specified user to the channel.
 
: [[API ChannelInvite|ChannelInvite]](<span class="apiarg">channel, name</span>) - Invites the specified user to the channel.
: [[API ChannelKick|ChannelKick]](<span class="apiarg">channel, name</span>) - Kicks the specified user from the channel.
+
: [[API ChannelKick|ChannelKick]](<span class="apiarg">channel, name</span>) - Kicks a player from the specified channel.
 
: [[API ChannelModerator|ChannelModerator]](<span class="apiarg">channel, name</span>) - Sets the specified player as the channel moderator.
 
: [[API ChannelModerator|ChannelModerator]](<span class="apiarg">channel, name</span>) - Sets the specified player as the channel moderator.
 
: [[API ChannelToggleAnnouncements|ChannelToggleAnnouncements]](<span class="apiarg">channel</span>) - Toggles the channel to display announcements either on or off.
 
: [[API ChannelToggleAnnouncements|ChannelToggleAnnouncements]](<span class="apiarg">channel</span>) - Toggles the channel to display announcements either on or off.
: [[API ChannelUnban|ChannelUnban]](<span class="apiarg">channel, name</span>) - Unbans a player from a channel.
+
: [[API ChannelUnban|ChannelUnban]](<span class="apiarg">channel, name</span>) - Unbans a player from the specified channel.
 
: [[API ChannelUnmoderator|ChannelUnmoderator]](<span class="apiarg">channel, name</span>) - Takes the specified user away from the moderator status.
 
: [[API ChannelUnmoderator|ChannelUnmoderator]](<span class="apiarg">channel, name</span>) - Takes the specified user away from the moderator status.
 
: [[API DeclineChannelInvite|DeclineChannelInvite]](<span class="apiarg">channel</span>)
 
: [[API DeclineChannelInvite|DeclineChannelInvite]](<span class="apiarg">channel</span>)
: [[API DisplayChannelOwner|DisplayChannelOwner]](<span class="apiarg">channel</span>) - Displays the owner of the specified channel in the default chat.
+
: [[API DisplayChannelOwner|DisplayChannelOwner]](<span class="apiarg">channel</span>) - Prints the name of the owner of the specified channel.
: [[API DoEmote|DoEmote]](<span class="apiarg">emote [, target]</span>) - Perform a voice emote.
+
: [[API DoEmote|DoEmote]](<span class="apiarg">emote [, target]</span>) - Performs an emote.
: [[API EnumerateServerChannels|EnumerateServerChannels]]() - Retrieves all available server channels (zone dependent).
+
: [[API EnumerateServerChannels|EnumerateServerChannels]]() - Returns all available server channels (zone dependent).
 
: [[API GetAlternativeDefaultLanguage|GetAlternativeDefaultLanguage]]()
 
: [[API GetAlternativeDefaultLanguage|GetAlternativeDefaultLanguage]]()
: [[API GetChannelDisplayInfo|GetChannelDisplayInfo]](<span class="apiarg">channelID</span>) - Returns the name of the channel according to the given id.
+
: [[API GetChannelDisplayInfo|GetChannelDisplayInfo]](<span class="apiarg">channelID</span>) - Returns info for chat channels and headers in the Chat Pane.
: [[API GetChannelList|GetChannelList]]() - Retrieves joined channels.
+
: [[API GetChannelList|GetChannelList]]() - Returns the list of joined chat channels.
: [[API GetChannelName|GetChannelName]](<span class="apiarg">channel or index</span>) - Retrieves the name from a specific channel.
+
: [[API GetChannelName|GetChannelName]](<span class="apiarg">channel or index</span>) - Returns info for a chat channel.
: [[API GetDefaultLanguage|GetDefaultLanguage]](<span class="apiarg">unit</span>) - Returns the default language that the unit is speaking after logon.
+
: [[API GetDefaultLanguage|GetDefaultLanguage]](<span class="apiarg">unit</span>) - Returns the character's default language.
: [[API GetLanguageByIndex|GetLanguageByIndex]](<span class="apiarg">index</span>) - Returns the language specified by the index.
+
: [[API GetLanguageByIndex|GetLanguageByIndex]](<span class="apiarg">index</span>) - Returns the languages that the character can speak by index.
 
: [[API GetNumChannelMembers|GetNumChannelMembers]]()
 
: [[API GetNumChannelMembers|GetNumChannelMembers]]()
 
: [[API GetNumDisplayChannels|GetNumDisplayChannels]]()
 
: [[API GetNumDisplayChannels|GetNumDisplayChannels]]()
Line 595: Line 599:
 
: [[API IsDisplayChannelModerator|IsDisplayChannelModerator]]()
 
: [[API IsDisplayChannelModerator|IsDisplayChannelModerator]]()
 
: [[API IsDisplayChannelOwner|IsDisplayChannelOwner]]()
 
: [[API IsDisplayChannelOwner|IsDisplayChannelOwner]]()
: [[API JoinChannelByName|JoinChannelByName]](<span class="apiarg">channelName [, password, frameID, hasVoice]</span>) - Join the specified chat channel (with optional password, and register for specified frame).
+
: [[API JoinChannelByName|JoinChannelByName]](<span class="apiarg">channelName [, password, frameID, hasVoice]</span>) - Joins the specified chat channel.
: [[API JoinPermanentChannel|JoinPermanentChannel]](<span class="apiarg">channelName [, password, frameID, hasVoice]</span>) - Permanently join the specified chat channel (with optional password, and register for specified frame)
+
: [[API JoinPermanentChannel|JoinPermanentChannel]](<span class="apiarg">channelName [, password, frameID, hasVoice]</span>) - Joins the specified chat channel; the channel will be rejoined after relogging.
: [[API JoinTemporaryChannel|JoinTemporaryChannel]](<span class="apiarg">channelName [, password, frameID, hasVoice]</span>) - Temporary join the specified chat channel (with optional password, and register for specified frame)
+
: [[API JoinTemporaryChannel|JoinTemporaryChannel]](<span class="apiarg">channelName [, password, frameID, hasVoice]</span>) - Joins the specified chat channel; the channel will be left on logout.
 
: [[API LeaveChannelByLocalID|LeaveChannelByLocalID]](<span class="apiarg">localID</span>)
 
: [[API LeaveChannelByLocalID|LeaveChannelByLocalID]](<span class="apiarg">localID</span>)
 
: [[API LeaveChannelByName|LeaveChannelByName]](<span class="apiarg">channel</span>) - Leaves the channel with the specified name.
 
: [[API LeaveChannelByName|LeaveChannelByName]](<span class="apiarg">channel</span>) - Leaves the channel with the specified name.
: [[API ListChannelByName|ListChannelByName]](<span class="apiarg">channelMatch</span>) - Lists members in the given channel to the chat window.
+
: [[API ListChannelByName|ListChannelByName]](<span class="apiarg">channelMatch</span>) - Prints the list of members in the specified channel.
: [[API ListChannels|ListChannels]]() - Lists all of the channels into the chat window.
+
: [[API ListChannels|ListChannels]]() - Prints the list of currently joined chat channel.
 
: [[API LoggingChat|LoggingChat]](<span class="apiarg">newState</span>) - Gets or sets whether logging chat to Logs\WoWChatLog.txt is enabled.
 
: [[API LoggingChat|LoggingChat]](<span class="apiarg">newState</span>) - Gets or sets whether logging chat to Logs\WoWChatLog.txt is enabled.
 
: [[API LoggingCombat|LoggingCombat]](<span class="apiarg">newState</span>) - Gets or sets whether logging combat to Logs\WoWCombatLog.txt is enabled.
 
: [[API LoggingCombat|LoggingCombat]](<span class="apiarg">newState</span>) - Gets or sets whether logging combat to Logs\WoWCombatLog.txt is enabled.
Line 609: Line 613:
 
: [[API SetSelectedDisplayChannel|SetSelectedDisplayChannel]](<span class="apiarg">channelID</span>)
 
: [[API SetSelectedDisplayChannel|SetSelectedDisplayChannel]](<span class="apiarg">channelID</span>)
   
==== Chat Window ====
+
====Chat Window====
 
These are specific to chat ''window'' management.
 
These are specific to chat ''window'' management.
: [[API AddChatWindowChannel|AddChatWindowChannel]](<span class="apiarg">chatFrameIndex, channel</span>) - Make a chat channel visible in a specific ChatFrame.
+
: [[API AddChatWindowChannel|AddChatWindowChannel]](<span class="apiarg">chatFrameIndex, channel</span>) - Enables messages from a chat channel index for a chat window.
: [[API AddChatWindowMessages|AddChatWindowMessages]]() - Adds a messaging group to the specified chat window.
+
: [[API AddChatWindowMessages|AddChatWindowMessages]]() - Enables messages from the chat message type (e.g. "SAY") for a chat window.
: [[API ChangeChatColor|ChangeChatColor]](<span class="apiarg">channelName, r, g, b</span>) - Update the color for a type of chat message.
+
: [[API ChangeChatColor|ChangeChatColor]](<span class="apiarg">channelName, r, g, b</span>) - Updates the color for a type of chat message.
: [[API GetChatTypeIndex|GetChatTypeIndex]](<span class="apiarg">type</span>) - Get the numeric ID of a type of chat message.
+
: [[API GetChatTypeIndex|GetChatTypeIndex]](<span class="apiarg">type</span>) - Returns the index for a chat type.
: [[API GetChatWindowChannels|GetChatWindowChannels]](<span class="apiarg">index</span>) - Get the chat channels received by a chat window.
+
: [[API GetChatWindowChannels|GetChatWindowChannels]](<span class="apiarg">index</span>) - Returns subscribed channels for a chat window.
: [[API GetChatWindowInfo|GetChatWindowInfo]](<span class="apiarg">index</span>) - Get setup information about a chat window.
+
: [[API GetChatWindowInfo|GetChatWindowInfo]](<span class="apiarg">index</span>) - Returns info for a chat window.
: [[API GetChatWindowMessages|GetChatWindowMessages]](<span class="apiarg">index</span>) - Get the chat message types received by a chat window.
+
: [[API GetChatWindowMessages|GetChatWindowMessages]](<span class="apiarg">index</span>) - Returns subscribed message types for a chat window.
 
: [[API GetChatWindowSavedDimensions|GetChatWindowSavedDimensions]](<span class="apiarg">index</span>)
 
: [[API GetChatWindowSavedDimensions|GetChatWindowSavedDimensions]](<span class="apiarg">index</span>)
 
: [[API GetChatWindowSavedPosition|GetChatWindowSavedPosition]](<span class="apiarg">index</span>)
 
: [[API GetChatWindowSavedPosition|GetChatWindowSavedPosition]](<span class="apiarg">index</span>)
 
: [[API RedockChatWindows|RedockChatWindows]]()
 
: [[API RedockChatWindows|RedockChatWindows]]()
: [[API RemoveChatWindowChannel|RemoveChatWindowChannel]](<span class="apiarg">chatFrameIndex, channel</span>) - Make a chat channel invisible (hidden) in a specific ChatFrame.
+
: [[API RemoveChatWindowChannel|RemoveChatWindowChannel]](<span class="apiarg">chatFrameIndex, channel</span>) - Removes the specified chat channel from a chat window.
: [[API RemoveChatWindowMessages|RemoveChatWindowMessages]](<span class="apiarg">chatFrameIndex, messageGroup</span>) - Remove a set of chat messages from this window.
+
: [[API RemoveChatWindowMessages|RemoveChatWindowMessages]](<span class="apiarg">chatFrameIndex, messageGroup</span>) - Removes the specified chat message type from a chat window.
 
: [[API ResetChatColors|ResetChatColors]]()
 
: [[API ResetChatColors|ResetChatColors]]()
 
: [[API ResetChatWindows|ResetChatWindows]]()
 
: [[API ResetChatWindows|ResetChatWindows]]()
Line 636: Line 640:
 
: [[API SetChatWindowSize|SetChatWindowSize]](<span class="apiarg">index, size</span>) - Sets the font size of a chat window. (size - default 14)
 
: [[API SetChatWindowSize|SetChatWindowSize]](<span class="apiarg">index, size</span>) - Sets the font size of a chat window. (size - default 14)
 
: [[API SetChatWindowUninteractable|SetChatWindowUninteractable]](<span class="apiarg">id, isUninteractable</span>)
 
: [[API SetChatWindowUninteractable|SetChatWindowUninteractable]](<span class="apiarg">id, isUninteractable</span>)
: <small>UI</small> [[API ChatFrame_AddChannel|ChatFrame_AddChannel]](<span class="apiarg">chatFrame, channelName</span>) - Activate channel in chatFrame.
+
: <small>''UI''</small> [[API ChatFrame_AddChannel|ChatFrame_AddChannel]](<span class="apiarg">chatFrame, channelName</span>) - Activate channel in chatFrame.
: <small>UI</small> [[API ChatFrame_AddMessageEventFilter|ChatFrame_AddMessageEventFilter]](<span class="apiarg">event, filterFunc</span>) - Add a chat message filtering function.
+
: <small>''UI''</small> [[API ChatFrame_AddMessageEventFilter|ChatFrame_AddMessageEventFilter]](<span class="apiarg">event, filterFunc</span>) - Add a chat message filtering function.
: <small>UI</small> [[API ChatFrame_GetMessageEventFilters|ChatFrame_GetMessageEventFilters]](<span class="apiarg">event</span>) - Retreive the list of chat message filtering functions.
+
: <small>''UI''</small> [[API ChatFrame_GetMessageEventFilters|ChatFrame_GetMessageEventFilters]](<span class="apiarg">event</span>) - Retreive the list of chat message filtering functions.
: <small>UI</small> [[API ChatFrame_OnHyperlinkShow|ChatFrame_OnHyperlinkShow]](<span class="apiarg">reference, link, button</span>) - Called when the user clicks on a chatlink.
+
: <small>''UI''</small> [[API ChatFrame_OnHyperlinkShow|ChatFrame_OnHyperlinkShow]](<span class="apiarg">reference, link, button</span>) - Called when the user clicks on a chatlink.
: <small>UI</small> [[API ChatFrame_RemoveMessageEventFilter|ChatFrame_RemoveMessageEventFilter]](<span class="apiarg">event, filterFunc</span>) - Unregister a chat message filtering function.
+
: <small>''UI''</small> [[API ChatFrame_RemoveMessageEventFilter|ChatFrame_RemoveMessageEventFilter]](<span class="apiarg">event, filterFunc</span>) - Unregister a chat message filtering function.
   
==== AddOn Messages ====
+
====AddOn Messages====
 
: [[API C_ChatInfo.GetRegisteredAddonMessagePrefixes|C_ChatInfo.GetRegisteredAddonMessagePrefixes]]() : <span class="apiret">registeredPrefixes</span> - Returns addon message prefixes the client is currently registered to receive.
 
: [[API C_ChatInfo.GetRegisteredAddonMessagePrefixes|C_ChatInfo.GetRegisteredAddonMessagePrefixes]]() : <span class="apiret">registeredPrefixes</span> - Returns addon message prefixes the client is currently registered to receive.
 
: [[API C_ChatInfo.IsAddonMessagePrefixRegistered|C_ChatInfo.IsAddonMessagePrefixRegistered]](<span class="apiarg">prefix</span>) : <span class="apiret">isRegistered</span> - Returns whether the prefix is registered.
 
: [[API C_ChatInfo.IsAddonMessagePrefixRegistered|C_ChatInfo.IsAddonMessagePrefixRegistered]](<span class="apiarg">prefix</span>) : <span class="apiret">isRegistered</span> - Returns whether the prefix is registered.
: [[API C_ChatInfo.RegisterAddonMessagePrefix|C_ChatInfo.RegisterAddonMessagePrefix]](<span class="apiarg">prefix</span>) : <span class="apiret">successfulRequest</span> - Registers an addon message prefix.
+
: [[API C_ChatInfo.RegisterAddonMessagePrefix|C_ChatInfo.RegisterAddonMessagePrefix]](<span class="apiarg">prefix</span>) : <span class="apiret">successfulRequest</span> - Registers an addon message prefix to receive messages for that prefix.
: [[API C_ChatInfo.SendAddonMessage|C_ChatInfo.SendAddonMessage]](<span class="apiarg">prefix, message [, chatType, target]</span>) : <span class="apiret">success</span> - Sends a message to the hidden addon channel.
+
: [[API C_ChatInfo.SendAddonMessage|C_ChatInfo.SendAddonMessage]](<span class="apiarg">prefix, message [, chatType, target]</span>) : <span class="apiret">success</span> - Sends a message over an addon comm channel.
 
: [[API C_ChatInfo.SendAddonMessageLogged|C_ChatInfo.SendAddonMessageLogged]](<span class="apiarg">prefix, message [, chatType, target]</span>) : <span class="apiret">success</span> - Sends a message to the hidden addon channel, the messages are logged server side.
 
: [[API C_ChatInfo.SendAddonMessageLogged|C_ChatInfo.SendAddonMessageLogged]](<span class="apiarg">prefix, message [, chatType, target]</span>) : <span class="apiret">success</span> - Sends a message to the hidden addon channel, the messages are logged server side.
   
==== Communities ====
+
====Communities====
 
[[Guild_%26_Communities|Communities]] were added in [[Patch 8.0.1]]
 
[[Guild_%26_Communities|Communities]] were added in [[Patch 8.0.1]]
 
: [[API C_Club.AcceptInvitation|C_Club.AcceptInvitation]](<span class="apiarg">clubId</span>)
 
: [[API C_Club.AcceptInvitation|C_Club.AcceptInvitation]](<span class="apiarg">clubId</span>)
Line 659: Line 663:
 
: [[API C_Club.ClearClubPresenceSubscription|C_Club.ClearClubPresenceSubscription]]()
 
: [[API C_Club.ClearClubPresenceSubscription|C_Club.ClearClubPresenceSubscription]]()
 
: [[API C_Club.CompareBattleNetDisplayName|C_Club.CompareBattleNetDisplayName]](<span class="apiarg">clubId, lhsMemberId, rhsMemberId</span>) : <span class="apiret">comparison</span>
 
: [[API C_Club.CompareBattleNetDisplayName|C_Club.CompareBattleNetDisplayName]](<span class="apiarg">clubId, lhsMemberId, rhsMemberId</span>) : <span class="apiret">comparison</span>
: [[API C_Club.CreateClub|C_Club.CreateClub]](<span class="apiarg">name, [shortName], description, clubType, avatarId</span>)
+
: [[API C_Club.CreateClub|C_Club.CreateClub]](<span class="apiarg">name, [shortName], description, clubType, avatarId, [isCrossFaction]</span>)
 
: [[API C_Club.CreateStream|C_Club.CreateStream]](<span class="apiarg">clubId, name, subject, leadersAndModeratorsOnly</span>)
 
: [[API C_Club.CreateStream|C_Club.CreateStream]](<span class="apiarg">clubId, name, subject, leadersAndModeratorsOnly</span>)
: [[API C_Club.CreateTicket|C_Club.CreateTicket]](<span class="apiarg">clubId [, allowedRedeemCount, duration, defaultStreamId]</span>)
+
: [[API C_Club.CreateTicket|C_Club.CreateTicket]](<span class="apiarg">clubId [, allowedRedeemCount, duration, defaultStreamId, isCrossFaction]</span>)
 
: [[API C_Club.DeclineInvitation|C_Club.DeclineInvitation]](<span class="apiarg">clubId</span>)
 
: [[API C_Club.DeclineInvitation|C_Club.DeclineInvitation]](<span class="apiarg">clubId</span>)
 
: [[API C_Club.DestroyClub|C_Club.DestroyClub]](<span class="apiarg">clubId</span>)
 
: [[API C_Club.DestroyClub|C_Club.DestroyClub]](<span class="apiarg">clubId</span>)
Line 667: Line 671:
 
: [[API C_Club.DestroyStream|C_Club.DestroyStream]](<span class="apiarg">clubId, streamId</span>)
 
: [[API C_Club.DestroyStream|C_Club.DestroyStream]](<span class="apiarg">clubId, streamId</span>)
 
: [[API C_Club.DestroyTicket|C_Club.DestroyTicket]](<span class="apiarg">clubId, ticketId</span>)
 
: [[API C_Club.DestroyTicket|C_Club.DestroyTicket]](<span class="apiarg">clubId, ticketId</span>)
: [[API C_Club.EditClub|C_Club.EditClub]](<span class="apiarg">clubId [, name, shortName, description, avatarId, broadcast]</span>)
+
: [[API C_Club.DoesCommunityHaveMembersOfTheOppositeFaction|C_Club.DoesCommunityHaveMembersOfTheOppositeFaction]](<span class="apiarg">clubId</span>) : <span class="apiret">hasMembersOfOppositeFaction</span>
  +
: [[API C_Club.EditClub|C_Club.EditClub]](<span class="apiarg">clubId [, name, shortName, description, avatarId, broadcast, crossFaction]</span>)
 
: [[API C_Club.EditMessage|C_Club.EditMessage]](<span class="apiarg">clubId, streamId, messageId, message</span>)
 
: [[API C_Club.EditMessage|C_Club.EditMessage]](<span class="apiarg">clubId, streamId, messageId, message</span>)
 
: [[API C_Club.EditStream|C_Club.EditStream]](<span class="apiarg">clubId, streamId [, name, subject, leadersAndModeratorsOnly]</span>)
 
: [[API C_Club.EditStream|C_Club.EditStream]](<span class="apiarg">clubId, streamId [, name, subject, leadersAndModeratorsOnly]</span>)
Line 705: Line 710:
 
: [[API C_Club.IsRestricted|C_Club.IsRestricted]]() : <span class="apiret">restrictionReason</span>
 
: [[API C_Club.IsRestricted|C_Club.IsRestricted]]() : <span class="apiret">restrictionReason</span>
 
: [[API C_Club.IsSubscribedToStream|C_Club.IsSubscribedToStream]](<span class="apiarg">clubId, streamId</span>) : <span class="apiret">subscribed</span>
 
: [[API C_Club.IsSubscribedToStream|C_Club.IsSubscribedToStream]](<span class="apiarg">clubId, streamId</span>) : <span class="apiret">subscribed</span>
: [[API C_Club.KickMember|C_Club.KickMember]](<span class="apiarg">clubId, memberId</span>)
+
: <small>''PROTECTED''</small> [[API C_Club.KickMember|C_Club.KickMember]](<span class="apiarg">clubId, memberId</span>)
 
: [[API C_Club.LeaveClub|C_Club.LeaveClub]](<span class="apiarg">clubId</span>)
 
: [[API C_Club.LeaveClub|C_Club.LeaveClub]](<span class="apiarg">clubId</span>)
 
: [[API C_Club.RedeemTicket|C_Club.RedeemTicket]](<span class="apiarg">ticketId</span>)
 
: [[API C_Club.RedeemTicket|C_Club.RedeemTicket]](<span class="apiarg">ticketId</span>)
Line 719: Line 724:
 
: [[API C_Club.SetAutoAdvanceStreamViewMarker|C_Club.SetAutoAdvanceStreamViewMarker]](<span class="apiarg">clubId, streamId</span>)
 
: [[API C_Club.SetAutoAdvanceStreamViewMarker|C_Club.SetAutoAdvanceStreamViewMarker]](<span class="apiarg">clubId, streamId</span>)
 
: [[API C_Club.SetAvatarTexture|C_Club.SetAvatarTexture]](<span class="apiarg">texture, avatarId, clubType</span>)
 
: [[API C_Club.SetAvatarTexture|C_Club.SetAvatarTexture]](<span class="apiarg">texture, avatarId, clubType</span>)
: [[API C_Club.SetClubMemberNote|C_Club.SetClubMemberNote]](<span class="apiarg">clubId, memberId, note</span>)
+
: <small>''PROTECTED''</small> [[API C_Club.SetClubMemberNote|C_Club.SetClubMemberNote]](<span class="apiarg">clubId, memberId, note</span>)
 
: [[API C_Club.SetClubPresenceSubscription|C_Club.SetClubPresenceSubscription]](<span class="apiarg">clubId</span>)
 
: [[API C_Club.SetClubPresenceSubscription|C_Club.SetClubPresenceSubscription]](<span class="apiarg">clubId</span>)
 
: [[API C_Club.SetClubStreamNotificationSettings|C_Club.SetClubStreamNotificationSettings]](<span class="apiarg">clubId, settings</span>)
 
: [[API C_Club.SetClubStreamNotificationSettings|C_Club.SetClubStreamNotificationSettings]](<span class="apiarg">clubId, settings</span>)
Line 728: Line 733:
 
: [[API C_Club.UnfocusStream|C_Club.UnfocusStream]](<span class="apiarg">clubId, streamId</span>)
 
: [[API C_Club.UnfocusStream|C_Club.UnfocusStream]](<span class="apiarg">clubId, streamId</span>)
 
: [[API C_Club.ValidateText|C_Club.ValidateText]](<span class="apiarg">clubType, text, clubFieldType</span>) : <span class="apiret">result</span>
 
: [[API C_Club.ValidateText|C_Club.ValidateText]](<span class="apiarg">clubType, text, clubFieldType</span>) : <span class="apiret">result</span>
: [[API C_Cursor.DropCursorCommunitiesStream|C_Cursor.DropCursorCommunitiesStream]]()
 
: [[API C_Cursor.GetCursorCommunitiesStream|C_Cursor.GetCursorCommunitiesStream]]() : <span class="apiret">clubId, streamId</span>
 
 
: [[API C_Cursor.GetCursorItem|C_Cursor.GetCursorItem]]() : <span class="apiret">item</span>
 
: [[API C_Cursor.GetCursorItem|C_Cursor.GetCursorItem]]() : <span class="apiret">item</span>
: [[API C_Cursor.SetCursorCommunitiesStream|C_Cursor.SetCursorCommunitiesStream]](<span class="apiarg">clubId, streamId</span>)
 
 
The Club Finder was added in [[Patch 8.2.0]] and enabled in [[Patch 8.2.5]]
 
The Club Finder was added in [[Patch 8.2.0]] and enabled in [[Patch 8.2.5]]
 
: [[API C_ClubFinder.ApplicantAcceptClubInvite|C_ClubFinder.ApplicantAcceptClubInvite]](<span class="apiarg">clubFinderGUID</span>)
 
: [[API C_ClubFinder.ApplicantAcceptClubInvite|C_ClubFinder.ApplicantAcceptClubInvite]](<span class="apiarg">clubFinderGUID</span>)
Line 765: Line 767:
 
: [[API C_ClubFinder.PlayerReturnPendingCommunitiesList|C_ClubFinder.PlayerReturnPendingCommunitiesList]]() : <span class="apiret">info</span>
 
: [[API C_ClubFinder.PlayerReturnPendingCommunitiesList|C_ClubFinder.PlayerReturnPendingCommunitiesList]]() : <span class="apiret">info</span>
 
: [[API C_ClubFinder.PlayerReturnPendingGuildsList|C_ClubFinder.PlayerReturnPendingGuildsList]]() : <span class="apiret">info</span>
 
: [[API C_ClubFinder.PlayerReturnPendingGuildsList|C_ClubFinder.PlayerReturnPendingGuildsList]]() : <span class="apiret">info</span>
: [[API C_ClubFinder.PostClub|C_ClubFinder.PostClub]](<span class="apiarg">clubId, itemLevelRequirement, name, description, avatarId, specs, type</span>) : <span class="apiret">succesful</span>
+
: [[API C_ClubFinder.PostClub|C_ClubFinder.PostClub]](<span class="apiarg">clubId, itemLevelRequirement, name, description, avatarId, specs, type [, crossFaction]</span>) : <span class="apiret">succesful</span>
: [[API C_ClubFinder.ReportPosting|C_ClubFinder.ReportPosting]](<span class="apiarg">reportType, clubFinderGUID, playerGUID, complaintNote</span>)
 
 
: [[API C_ClubFinder.RequestApplicantList|C_ClubFinder.RequestApplicantList]](<span class="apiarg">type</span>)
 
: [[API C_ClubFinder.RequestApplicantList|C_ClubFinder.RequestApplicantList]](<span class="apiarg">type</span>)
 
: [[API C_ClubFinder.RequestClubsList|C_ClubFinder.RequestClubsList]](<span class="apiarg">guildListRequested, searchString, specIDs</span>)
 
: [[API C_ClubFinder.RequestClubsList|C_ClubFinder.RequestClubsList]](<span class="apiarg">guildListRequested, searchString, specIDs</span>)
Line 780: Line 781:
 
: [[API C_ClubFinder.ReturnMatchingGuildList|C_ClubFinder.ReturnMatchingGuildList]]() : <span class="apiret">recruitingClubs</span>
 
: [[API C_ClubFinder.ReturnMatchingGuildList|C_ClubFinder.ReturnMatchingGuildList]]() : <span class="apiret">recruitingClubs</span>
 
: [[API C_ClubFinder.ReturnPendingClubApplicantList|C_ClubFinder.ReturnPendingClubApplicantList]](<span class="apiarg">clubId</span>) : <span class="apiret">info</span>
 
: [[API C_ClubFinder.ReturnPendingClubApplicantList|C_ClubFinder.ReturnPendingClubApplicantList]](<span class="apiarg">clubId</span>) : <span class="apiret">info</span>
 
: [[API C_ClubFinder.SendChatWhisper|C_ClubFinder.SendChatWhisper]](<span class="apiarg">clubFinderGUID, playerGUID, applicantType, name</span>)
 
: [[API C_ClubFinder.SetAllRecruitmentSettings|C_ClubFinder.SetAllRecruitmentSettings]](<span class="apiarg">value</span>)
 
: [[API C_ClubFinder.SetAllRecruitmentSettings|C_ClubFinder.SetAllRecruitmentSettings]](<span class="apiarg">value</span>)
 
: [[API C_ClubFinder.SetPlayerApplicantLocaleFlags|C_ClubFinder.SetPlayerApplicantLocaleFlags]](<span class="apiarg">localeFlags</span>)
 
: [[API C_ClubFinder.SetPlayerApplicantLocaleFlags|C_ClubFinder.SetPlayerApplicantLocaleFlags]](<span class="apiarg">localeFlags</span>)
Line 787: Line 789:
 
: [[API C_ClubFinder.ShouldShowClubFinder|C_ClubFinder.ShouldShowClubFinder]]() : <span class="apiret">shouldShow</span>
 
: [[API C_ClubFinder.ShouldShowClubFinder|C_ClubFinder.ShouldShowClubFinder]]() : <span class="apiret">shouldShow</span>
   
==== Reporting ====
+
====Reporting====
 
: [[API C_BehavioralMessaging.SendNotificationReceipt|C_BehavioralMessaging.SendNotificationReceipt]](<span class="apiarg">dbId, openTimeSeconds, readTimeSeconds</span>)
 
: [[API C_BehavioralMessaging.SendNotificationReceipt|C_BehavioralMessaging.SendNotificationReceipt]](<span class="apiarg">dbId, openTimeSeconds, readTimeSeconds</span>)
 
: [[API C_ReportSystem.CanReportPlayer|C_ReportSystem.CanReportPlayer]](<span class="apiarg">playerLocation</span>) : <span class="apiret">canReport</span> - Returns if a player can be reported.
 
: [[API C_ReportSystem.CanReportPlayer|C_ReportSystem.CanReportPlayer]](<span class="apiarg">playerLocation</span>) : <span class="apiret">canReport</span> - Returns if a player can be reported.
 
: [[API C_ReportSystem.CanReportPlayerForLanguage|C_ReportSystem.CanReportPlayerForLanguage]](<span class="apiarg">playerLocation</span>) : <span class="apiret">canReport</span>
 
: [[API C_ReportSystem.CanReportPlayerForLanguage|C_ReportSystem.CanReportPlayerForLanguage]](<span class="apiarg">playerLocation</span>) : <span class="apiret">canReport</span>
: <small>PROTECTED</small> [[API C_ReportSystem.InitiateReportPlayer|C_ReportSystem.InitiateReportPlayer]](<span class="apiarg">complaintType [, playerLocation]</span>) : <span class="apiret">token</span> - Initiates a report against a player.
+
: [[API C_ReportSystem.GetMajorCategoriesForReportType|C_ReportSystem.GetMajorCategoriesForReportType]](<span class="apiarg">reportType</span>) : <span class="apiret">majorCategories</span>
: [[API C_ReportSystem.OpenReportPlayerDialog|C_ReportSystem.OpenReportPlayerDialog]](<span class="apiarg">reportType, playerName [, playerLocation]</span>) - Opens a dialog for reporting a player.
+
: [[API C_ReportSystem.GetMajorCategoryString|C_ReportSystem.GetMajorCategoryString]](<span class="apiarg">majorCategory</span>) : <span class="apiret">majorCategoryString</span>
 
: [[API C_ReportSystem.GetMinorCategoriesForReportTypeAndMajorCategory|C_ReportSystem.GetMinorCategoriesForReportTypeAndMajorCategory]](<span class="apiarg">reportType, majorCategory</span>) : <span class="apiret">minorCategories</span>
 
: [[API C_ReportSystem.GetMinorCategoryString|C_ReportSystem.GetMinorCategoryString]](<span class="apiarg">minorCategory</span>) : <span class="apiret">minorCategoryString</span>
 
: [[API C_ReportSystem.ReportServerLag|C_ReportSystem.ReportServerLag]]()
 
: [[API C_ReportSystem.ReportServerLag|C_ReportSystem.ReportServerLag]]()
 
: [[API C_ReportSystem.ReportStuckInCombat|C_ReportSystem.ReportStuckInCombat]]()
 
: [[API C_ReportSystem.ReportStuckInCombat|C_ReportSystem.ReportStuckInCombat]]()
: <small>PROTECTED</small> [[API C_ReportSystem.SendReportPlayer|C_ReportSystem.SendReportPlayer]](<span class="apiarg">token [, comment]</span>) - Sends an initiated report against a player.
+
: <small>''PROTECTED''</small> [[API C_ReportSystem.SendReport|C_ReportSystem.SendReport]](<span class="apiarg">reportInfo [, playerLocation]</span>)
: [[API C_ReportSystem.SetPendingReportPetTarget|C_ReportSystem.SetPendingReportPetTarget]](<span class="apiarg">[target]</span>) : <span class="apiret">set</span> - Report a pet for an inappropriate name.
 
: [[API C_ReportSystem.SetPendingReportTarget|C_ReportSystem.SetPendingReportTarget]](<span class="apiarg">[target]</span>) : <span class="apiret">set</span>
 
: [[API C_ReportSystem.SetPendingReportTargetByGuid|C_ReportSystem.SetPendingReportTargetByGuid]](<span class="apiarg">[guid]</span>) : <span class="apiret">set</span>
 
 
Restrictions
 
Restrictions
 
: [[API C_SocialRestrictions.AcknowledgeRegionalChatDisabled|C_SocialRestrictions.AcknowledgeRegionalChatDisabled]]()
 
: [[API C_SocialRestrictions.AcknowledgeRegionalChatDisabled|C_SocialRestrictions.AcknowledgeRegionalChatDisabled]]()
Line 807: Line 808:
 
: [[API C_SocialRestrictions.SetChatDisabled|C_SocialRestrictions.SetChatDisabled]](<span class="apiarg">disabled</span>)
 
: [[API C_SocialRestrictions.SetChatDisabled|C_SocialRestrictions.SetChatDisabled]](<span class="apiarg">disabled</span>)
   
==== Voice Chat ====
+
====Voice Chat====
 
[[Voice Chat]] was added in [[Patch 2.2]] and reworked in [[Patch 8.0.1]]
 
[[Voice Chat]] was added in [[Patch 2.2]] and reworked in [[Patch 8.0.1]]
 
: [[API C_VoiceChat.ActivateChannel|C_VoiceChat.ActivateChannel]](<span class="apiarg">channelID</span>)
 
: [[API C_VoiceChat.ActivateChannel|C_VoiceChat.ActivateChannel]](<span class="apiarg">channelID</span>)
Line 879: Line 880:
 
: [[API IsChatChannelRaid|IsChatChannelRaid]]()
 
: [[API IsChatChannelRaid|IsChatChannelRaid]]()
   
==== Text-to-Speech ====
+
====Text-to-Speech====
 
[[Wikipedia:Speech synthesis|Text-to-Speech]] was added in [[Patch 9.1.0]]
 
[[Wikipedia:Speech synthesis|Text-to-Speech]] was added in [[Patch 9.1.0]]
 
: [[API C_VoiceChat.ActivateChannelTranscription|C_VoiceChat.ActivateChannelTranscription]](<span class="apiarg">channelID</span>)
 
: [[API C_VoiceChat.ActivateChannelTranscription|C_VoiceChat.ActivateChannelTranscription]](<span class="apiarg">channelID</span>)
Line 911: Line 912:
 
: [[API C_TTSSettings.ShouldOverrideMessage|C_TTSSettings.ShouldOverrideMessage]](<span class="apiarg">language</span>) : <span class="apiret">overrideMessage</span>
 
: [[API C_TTSSettings.ShouldOverrideMessage|C_TTSSettings.ShouldOverrideMessage]](<span class="apiarg">language</span>) : <span class="apiret">overrideMessage</span>
   
==== Twitter ====
+
====Twitter====
 
Twitter integration was added in [[Patch 6.1.0]]
 
Twitter integration was added in [[Patch 6.1.0]]
 
: [[API C_Social.GetLastAchievement|C_Social.GetLastAchievement]]() : <span class="apiret">achievementID, achievementName, achievementDesc, iconFileID</span>
 
: [[API C_Social.GetLastAchievement|C_Social.GetLastAchievement]]() : <span class="apiret">achievementID, achievementName, achievementDesc, iconFileID</span>
Line 920: Line 921:
 
: [[API C_Social.GetTweetLength|C_Social.GetTweetLength]](<span class="apiarg">tweetText</span>) : <span class="apiret">tweetLength</span>
 
: [[API C_Social.GetTweetLength|C_Social.GetTweetLength]](<span class="apiarg">tweetText</span>) : <span class="apiret">tweetLength</span>
 
: [[API C_Social.IsSocialEnabled|C_Social.IsSocialEnabled]]() : <span class="apiret">isEnabled</span>
 
: [[API C_Social.IsSocialEnabled|C_Social.IsSocialEnabled]]() : <span class="apiret">isEnabled</span>
: <small>PROTECTED</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 class="apiarg">texture, index</span>)
 
: [[API C_Social.SetTextureToScreenshot|C_Social.SetTextureToScreenshot]](<span class="apiarg">texture, index</span>)
: <small>PROTECTED</small> [[API C_Social.TwitterCheckStatus|C_Social.TwitterCheckStatus]]()
+
: <small>''PROTECTED''</small> [[API C_Social.TwitterCheckStatus|C_Social.TwitterCheckStatus]]()
: <small>PROTECTED</small> [[API C_Social.TwitterConnect|C_Social.TwitterConnect]]()
+
: <small>''PROTECTED''</small> [[API C_Social.TwitterConnect|C_Social.TwitterConnect]]()
: <small>PROTECTED</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 class="apiret">msTimeLeft</span>
 
: [[API C_Social.TwitterGetMSTillCanPost|C_Social.TwitterGetMSTillCanPost]]() : <span class="apiret">msTimeLeft</span>
: <small>PROTECTED</small> [[API C_Social.TwitterPostAchievement|C_Social.TwitterPostAchievement]](<span class="apiarg">text, width, height, snapshotId, offScreenFrame, lastAchievementID, usedCustomText</span>)
+
: <small>''PROTECTED''</small> [[API C_Social.TwitterPostAchievement|C_Social.TwitterPostAchievement]](<span class="apiarg">text, width, height, snapshotId, offScreenFrame, lastAchievementID, usedCustomText</span>)
: <small>PROTECTED</small> [[API C_Social.TwitterPostItem|C_Social.TwitterPostItem]](<span class="apiarg">text, width, height, snapshotId, offScreenFrame, lastItemID, usedCustomText</span>)
+
: <small>''PROTECTED''</small> [[API C_Social.TwitterPostItem|C_Social.TwitterPostItem]](<span class="apiarg">text, width, height, snapshotId, offScreenFrame, lastItemID, usedCustomText</span>)
: <small>PROTECTED</small> [[API C_Social.TwitterPostMessage|C_Social.TwitterPostMessage]](<span class="apiarg">message</span>)
+
: <small>''PROTECTED''</small> [[API C_Social.TwitterPostMessage|C_Social.TwitterPostMessage]](<span class="apiarg">message</span>)
: <small>PROTECTED</small> [[API C_Social.TwitterPostScreenshot|C_Social.TwitterPostScreenshot]](<span class="apiarg">text, screenshotIndex, texture, usedCustomText</span>)
+
: <small>''PROTECTED''</small> [[API C_Social.TwitterPostScreenshot|C_Social.TwitterPostScreenshot]](<span class="apiarg">text, screenshotIndex, texture, usedCustomText</span>)
   
=== Character ===
+
===Character===
 
: [[API CheckBinderDist|CheckBinderDist]]() - Check whether the player is close enough to interact with the Hearthstone binder.
 
: [[API CheckBinderDist|CheckBinderDist]]() - Check whether the player is close enough to interact with the Hearthstone binder.
 
: [[API ConfirmBinder|ConfirmBinder]]() - Confirm the request to set the binding of the player's Hearthstone.
 
: [[API ConfirmBinder|ConfirmBinder]]() - Confirm the request to set the binding of the player's Hearthstone.
: [[API Dismount|Dismount]]() - The player dismounts the current mount.
+
: [[API Dismount|Dismount]]() - Dismounts the character.
: [[API GetBindLocation|GetBindLocation]]() - Get the name of the location for your Hearthstone.
+
: [[API GetBindLocation|GetBindLocation]]() - Returns the subzone the character's Hearthstone is set to.
: [[API GetComboPoints|GetComboPoints]]() - Get the current number of combo points.
+
: [[API GetComboPoints|GetComboPoints]]() - Returns the amount of current combo points.
 
: [[API GetCurrentLevelFeatures|GetCurrentLevelFeatures]](<span class="apiarg">level</span>) - For Level Up Display
 
: [[API GetCurrentLevelFeatures|GetCurrentLevelFeatures]](<span class="apiarg">level</span>) - For Level Up Display
: [[API GetCurrentTitle|GetCurrentTitle]]() - Returns the player's current [[titleId]].
+
: [[API GetCurrentTitle|GetCurrentTitle]]() - Returns the current [[title]].
: [[API GetMirrorTimerInfo|GetMirrorTimerInfo]](<span class="apiarg">id</span>) - Returns information about a mirror timer (exhaustion, breath and feign death timers)
+
: [[API GetMirrorTimerInfo|GetMirrorTimerInfo]](<span class="apiarg">id</span>) - Returns info for the mirror timer, e.g. fatigue, breath and feign death.
: [[API GetMirrorTimerProgress|GetMirrorTimerProgress]](<span class="apiarg">id</span>) - Returns the current value of a mirror timer (exhaustion, breath and feign death timers)
+
: [[API GetMirrorTimerProgress|GetMirrorTimerProgress]](<span class="apiarg">id</span>) - Returns the current value of the mirror timer.
: [[API GetMoney|GetMoney]]() - Returns an integer value of your held money in copper.
+
: [[API GetMoney|GetMoney]]() - Returns the amount of money the player character owns.
: [[API GetNumTitles|GetNumTitles]]() - Returns the maximum [[titleId]].
+
: [[API GetNumTitles|GetNumTitles]]() - Returns the number of titles, specifically the highest title ID.
: [[API GetRestState|GetRestState]]() - Returns information about a player's rest state. (saved up experience bonus)
+
: [[API GetRestState|GetRestState]]() - Returns if the character is in a [[Rest|rested]] or normal state.
: [[API GetRuneCooldown|GetRuneCooldown]](<span class="apiarg">id</span>) - Returns cooldown information about a given rune.
+
: [[API GetRuneCooldown|GetRuneCooldown]](<span class="apiarg">id</span>) - Returns the Death Knight's cooldown info for the specified rune.
: [[API GetRuneCount|GetRuneCount]](<span class="apiarg">slot</span>) - Returns the number of Runes in the given slot. (Death Knight)
+
: [[API GetRuneCount|GetRuneCount]](<span class="apiarg">slot</span>) - Returns the Death Knight's number of runes for a slot.
: [[API GetSheathState|GetSheathState]]() - Returns the sheath state of the player's weapons.
+
: [[API GetSheathState|GetSheathState]]() - Returns which type of weapon the player currently has unsheathed.
 
: [[API GetSpellsForCharacterUpgradeTier|GetSpellsForCharacterUpgradeTier]](<span class="apiarg">tierIndex</span>) - For Level Up Display
 
: [[API GetSpellsForCharacterUpgradeTier|GetSpellsForCharacterUpgradeTier]](<span class="apiarg">tierIndex</span>) - For Level Up Display
 
: [[API GetTimeToWellRested|GetTimeToWellRested]]()
 
: [[API GetTimeToWellRested|GetTimeToWellRested]]()
: [[API GetTitleName|GetTitleName]](<span class="apiarg">titleId</span>) - Returns the player's current title name.
+
: [[API GetTitleName|GetTitleName]](<span class="apiarg">titleId</span>) - Returns the name of a player title.
: [[API GetXPExhaustion|GetXPExhaustion]]() - Returns your character's current rested XP, nil if character is not rested.
+
: [[API GetXPExhaustion|GetXPExhaustion]]() - Returns the amount of current rested XP for the character.
 
: [[API HasFullControl|HasFullControl]]()
 
: [[API HasFullControl|HasFullControl]]()
 
: [[API IsChatAFK|IsChatAFK]]()
 
: [[API IsChatAFK|IsChatAFK]]()
 
: [[API IsChatDND|IsChatDND]]()
 
: [[API IsChatDND|IsChatDND]]()
 
: [[API IsEncounterInProgress|IsEncounterInProgress]]()
 
: [[API IsEncounterInProgress|IsEncounterInProgress]]()
: [[API IsFalling|IsFalling]]() - Returns 1 if your character is currently plummeting to their doom.
+
: [[API IsFalling|IsFalling]]() - True if the character is currently falling.
: [[API IsFlyableArea|IsFlyableArea]]() - Returns 1 if it is possible to fly here, nil otherwise.
+
: [[API IsFlyableArea|IsFlyableArea]]() - True if the current zone is a flyable area.
: [[API IsFlying|IsFlying]]() - Returns 1 if flying, otherwise nil.
+
: [[API IsFlying|IsFlying]]() - True if the character is currently on a flying mount.
: [[API IsIndoors|IsIndoors]]() - Returns 1 if you are indoors, otherwise nil. Returns nil for indoor areas where you can still mount.
+
: [[API IsIndoors|IsIndoors]]() - True if the character is currently indoors.
 
: [[API IsInsane|IsInsane]]() - Used for the Insanity bar
 
: [[API IsInsane|IsInsane]]() - Used for the Insanity bar
: [[API IsMounted|IsMounted]]() - Returns 1 if mounted, otherwise nil.
+
: [[API IsMounted|IsMounted]]() - True if the character is currently mounted.
: [[API IsOutOfBounds|IsOutOfBounds]]() - Returns 1 if you fell off the map.
+
: [[API IsOutOfBounds|IsOutOfBounds]]() - True if the player is currently outside of map boundaries.
: [[API IsOutdoors|IsOutdoors]]() - Returns 1 if you are outdoors, otherwise nil. Returns 1 for indoor areas where you can still mount.
+
: [[API IsOutdoors|IsOutdoors]]() - True if the character is currently outdoors.
 
: [[API IsPlayerInWorld|IsPlayerInWorld]]()
 
: [[API IsPlayerInWorld|IsPlayerInWorld]]()
 
: [[API IsPlayerNeutral|IsPlayerNeutral]]()
 
: [[API IsPlayerNeutral|IsPlayerNeutral]]()
: [[API IsResting|IsResting]]() - Returns 1 if your character is currently resting.
+
: [[API IsResting|IsResting]]() - True if the character is currently resting.
: [[API IsStealthed|IsStealthed]]() - Returns 1 if stealthed or shadowmeld, otherwise nil.
+
: [[API IsStealthed|IsStealthed]]() - True if the character is currently stealthed.
 
: [[API IsSubmerged|IsSubmerged]]()
 
: [[API IsSubmerged|IsSubmerged]]()
: [[API IsSwimming|IsSwimming]]() - Returns 1 if your character is currently swimming.
+
: [[API IsSwimming|IsSwimming]]() - True if the character is currently swimming.
: [[API IsThreatWarningEnabled|IsThreatWarningEnabled]]() - Returns whether threat warnings should currently be displayed.
+
: [[API IsThreatWarningEnabled|IsThreatWarningEnabled]]() - True if threat warnings are currently enabled.
: [[API IsTitleKnown|IsTitleKnown]](<span class="apiarg">index</span>) - Returns 1 if the title is valid for the player, otherwise 0.
+
: [[API IsTitleKnown|IsTitleKnown]](<span class="apiarg">index</span>) - True if the character can use a player title.
 
: [[API IsXPUserDisabled|IsXPUserDisabled]]() - Returns 1 if the character has disabled experience gain.
 
: [[API IsXPUserDisabled|IsXPUserDisabled]]() - Returns 1 if the character has disabled experience gain.
 
: [[API PlayerHasHearthstone|PlayerHasHearthstone]]() - Returns the hearthstone ID
 
: [[API PlayerHasHearthstone|PlayerHasHearthstone]]() - Returns the hearthstone ID
: [[API RandomRoll|RandomRoll]](<span class="apiarg">min, max</span>) - Does a random roll between the two values.
+
: [[API RandomRoll|RandomRoll]](<span class="apiarg">min, max</span>) - Performs a random roll between two values.
: <small>HW</small> [[API SetCurrentTitle|SetCurrentTitle]](<span class="apiarg">titleId</span>) - Sets the player's current title by id.
+
: <small>''HW''</small> [[API SetCurrentTitle|SetCurrentTitle]](<span class="apiarg">titleId</span>) - Sets the player's displayed title.
 
: [[API ToggleSheath|ToggleSheath]]() - Toggles sheathed or unsheathed weapons.
 
: [[API ToggleSheath|ToggleSheath]]() - Toggles sheathed or unsheathed weapons.
: <small>PROTECTED</small> [[API UseHearthstone|UseHearthstone]]()
+
: <small>''PROTECTED''</small> [[API UseHearthstone|UseHearthstone]]()
: <small>DEPRECATED</small> [[API HasAlternateForm|HasAlternateForm]]()
+
: <small>''DEPRECATED''</small> [[API HasAlternateForm|HasAlternateForm]]()
   
==== Paper Doll ====
+
====Paper Doll====
 
Relates to the [[Paper doll]] (also known as Character sheet).
 
Relates to the [[Paper doll]] (also known as Character sheet).
 
: [[API C_PaperDollInfo.GetArmorEffectiveness|C_PaperDollInfo.GetArmorEffectiveness]](<span class="apiarg">armor, attackerLevel</span>) : <span class="apiret">effectiveness</span>
 
: [[API C_PaperDollInfo.GetArmorEffectiveness|C_PaperDollInfo.GetArmorEffectiveness]](<span class="apiarg">armor, attackerLevel</span>) : <span class="apiret">effectiveness</span>
Line 989: Line 990:
 
: [[API C_PaperDollInfo.OffhandHasWeapon|C_PaperDollInfo.OffhandHasWeapon]]() : <span class="apiret">offhandHasWeapon</span>
 
: [[API C_PaperDollInfo.OffhandHasWeapon|C_PaperDollInfo.OffhandHasWeapon]]() : <span class="apiret">offhandHasWeapon</span>
 
: [[API CanDualWield|CanDualWield]]()
 
: [[API CanDualWield|CanDualWield]]()
: [[API GetAttackPowerForStat|GetAttackPowerForStat]](<span class="apiarg">stat, value</span>) - Returns the amount of attack power contributed by a specified amount of a particular stat.
+
: [[API GetAttackPowerForStat|GetAttackPowerForStat]](<span class="apiarg">stat, value</span>) - Returns the amount of attack power contributed by a specific amount of a stat.
 
: [[API GetAvoidance|GetAvoidance]]()
 
: [[API GetAvoidance|GetAvoidance]]()
: [[API GetBlockChance|GetBlockChance]]() - Returns the player's percentage block chance.
+
: [[API GetBlockChance|GetBlockChance]]() - Returns the block chance percentage.
: [[API GetCombatRating|GetCombatRating]](<span class="apiarg">ratingID</span>) - Returns the player's combat rating for a particular combat rating.
+
: [[API GetCombatRating|GetCombatRating]](<span class="apiarg">ratingID</span>) - Returns a specific combat rating.
: [[API GetCombatRatingBonus|GetCombatRatingBonus]](<span class="apiarg">ratingID</span>) - Returns the player's combat rating bonus for a particular combat rating.
+
: [[API GetCombatRatingBonus|GetCombatRatingBonus]](<span class="apiarg">ratingID</span>) - Returns the bonus percentage for a specific combat rating.
 
: [[API GetCombatRatingBonusForCombatRatingValue|GetCombatRatingBonusForCombatRatingValue]](<span class="apiarg">ratingIndex, value</span>)
 
: [[API GetCombatRatingBonusForCombatRatingValue|GetCombatRatingBonusForCombatRatingValue]](<span class="apiarg">ratingIndex, value</span>)
: [[API GetCritChance|GetCritChance]]() - Returns the player's melee critical hit chance.
+
: [[API GetCritChance|GetCritChance]]() - Returns the melee critical hit chance percentage.
 
: [[API GetCritChanceProvidesParryEffect|GetCritChanceProvidesParryEffect]]()
 
: [[API GetCritChanceProvidesParryEffect|GetCritChanceProvidesParryEffect]]()
: [[API GetDodgeChance|GetDodgeChance]]() - Returns the player's percentage dodge chance.
+
: [[API GetDodgeChance|GetDodgeChance]]() - Returns the dodge chance percentage.
 
: [[API GetDodgeChanceFromAttribute|GetDodgeChanceFromAttribute]]()
 
: [[API GetDodgeChanceFromAttribute|GetDodgeChanceFromAttribute]]()
 
: [[API GetExpertise|GetExpertise]]() - Returns the player's expertise percentage for main hand, offhand and ranged attacks.
 
: [[API GetExpertise|GetExpertise]]() - Returns the player's expertise percentage for main hand, offhand and ranged attacks.
Line 1,003: Line 1,004:
 
: [[API GetHitModifier|GetHitModifier]]()
 
: [[API GetHitModifier|GetHitModifier]]()
 
: [[API GetLifesteal|GetLifesteal]]()
 
: [[API GetLifesteal|GetLifesteal]]()
: [[API GetManaRegen|GetManaRegen]]() - Returns the player's mana regeneration rates.
+
: [[API GetManaRegen|GetManaRegen]]() - Returns the mana regeneration per second.
: [[API GetMastery|GetMastery]]() - Returns the player's mastery before mastery rating.
+
: [[API GetMastery|GetMastery]]() - Returns the base mastery percentage.
: [[API GetMasteryEffect|GetMasteryEffect]]() - Returns the player's buffed mastery in percentage and (unknown number value).
+
: [[API GetMasteryEffect|GetMasteryEffect]]() - Returns the effective mastery percentage.
 
: [[API GetMaxCombatRatingBonus|GetMaxCombatRatingBonus]](<span class="apiarg">ratingIndex</span>)
 
: [[API GetMaxCombatRatingBonus|GetMaxCombatRatingBonus]](<span class="apiarg">ratingIndex</span>)
 
: [[API GetMeleeHaste|GetMeleeHaste]]() - Returns player's Melee attack haste.
 
: [[API GetMeleeHaste|GetMeleeHaste]]() - Returns player's Melee attack haste.
Line 1,011: Line 1,012:
 
: [[API GetOverrideAPBySpellPower|GetOverrideAPBySpellPower]]()
 
: [[API GetOverrideAPBySpellPower|GetOverrideAPBySpellPower]]()
 
: [[API GetOverrideSpellPowerByAP|GetOverrideSpellPowerByAP]]()
 
: [[API GetOverrideSpellPowerByAP|GetOverrideSpellPowerByAP]]()
: [[API GetParryChance|GetParryChance]]() - Returns the player's percentage parry chance.
+
: [[API GetParryChance|GetParryChance]]() - Returns the parry chance percentage.
 
: [[API GetParryChanceFromAttribute|GetParryChanceFromAttribute]]()
 
: [[API GetParryChanceFromAttribute|GetParryChanceFromAttribute]]()
 
: [[API GetPetMeleeHaste|GetPetMeleeHaste]]()
 
: [[API GetPetMeleeHaste|GetPetMeleeHaste]]()
Line 1,020: Line 1,021:
 
: [[API GetPvpPowerDamage|GetPvpPowerDamage]]()
 
: [[API GetPvpPowerDamage|GetPvpPowerDamage]]()
 
: [[API GetPvpPowerHealing|GetPvpPowerHealing]]()
 
: [[API GetPvpPowerHealing|GetPvpPowerHealing]]()
: [[API GetRangedCritChance|GetRangedCritChance]]() - Returns the players ranged critical strike chance.
+
: [[API GetRangedCritChance|GetRangedCritChance]]() - Returns the ranged critical hit chance.
 
: [[API GetRangedHaste|GetRangedHaste]]()
 
: [[API GetRangedHaste|GetRangedHaste]]()
 
: [[API GetShieldBlock|GetShieldBlock]]()
 
: [[API GetShieldBlock|GetShieldBlock]]()
 
: [[API GetSpeed|GetSpeed]]()
 
: [[API GetSpeed|GetSpeed]]()
: [[API GetSpellBonusDamage|GetSpellBonusDamage]](<span class="apiarg">spellTreeID</span>) - Returns the raw spell damage of the player for a given spell tree.
+
: [[API GetSpellBonusDamage|GetSpellBonusDamage]](<span class="apiarg">spellTreeID</span>) - Returns the raw spell damage bonus for the specified spell tree.
: [[API GetSpellBonusHealing|GetSpellBonusHealing]]() - Returns the raw bonus healing of the player.
+
: [[API GetSpellBonusHealing|GetSpellBonusHealing]]() - Returns the raw spell healing bonus.
: [[API GetSpellCritChance|GetSpellCritChance]](<span class="apiarg">school</span>) - Returns the players critical hit chance with a particular spell school.
+
: [[API GetSpellCritChance|GetSpellCritChance]](<span class="apiarg">school</span>) - Returns the critical hit chance for the specified spell school.
 
: [[API GetSpellHitModifier|GetSpellHitModifier]]()
 
: [[API GetSpellHitModifier|GetSpellHitModifier]]()
 
: [[API GetSpellPenetration|GetSpellPenetration]]()
 
: [[API GetSpellPenetration|GetSpellPenetration]]()
Line 1,043: Line 1,044:
 
: [[API ResistancePercent|ResistancePercent]](<span class="apiarg">resistance, casterLevel</span>)
 
: [[API ResistancePercent|ResistancePercent]](<span class="apiarg">resistance, casterLevel</span>)
   
==== Equipment Manager ====
+
====Equipment Manager====
 
The [[Equipment Manager]] was added in [[Patch 3.1.2]]
 
The [[Equipment Manager]] was added in [[Patch 3.1.2]]
 
: [[API C_EquipmentSet.AssignSpecToEquipmentSet|C_EquipmentSet.AssignSpecToEquipmentSet]](<span class="apiarg">equipmentSetID, specIndex</span>) - Assigns an equipment set to a specialization.
 
: [[API C_EquipmentSet.AssignSpecToEquipmentSet|C_EquipmentSet.AssignSpecToEquipmentSet]](<span class="apiarg">equipmentSetID, specIndex</span>) - Assigns an equipment set to a specialization.
Line 1,067: Line 1,068:
 
: [[API C_EquipmentSet.UnassignEquipmentSetSpec|C_EquipmentSet.UnassignEquipmentSetSpec]](<span class="apiarg">equipmentSetID</span>) - Unassigns an equipment set from a specialization.
 
: [[API C_EquipmentSet.UnassignEquipmentSetSpec|C_EquipmentSet.UnassignEquipmentSetSpec]](<span class="apiarg">equipmentSetID</span>) - Unassigns an equipment set from a specialization.
 
: [[API C_EquipmentSet.UnignoreSlotForSave|C_EquipmentSet.UnignoreSlotForSave]](<span class="apiarg">slot</span>) - Unignores a slot for saving.
 
: [[API C_EquipmentSet.UnignoreSlotForSave|C_EquipmentSet.UnignoreSlotForSave]](<span class="apiarg">slot</span>) - Unignores a slot for saving.
: <small>NOCOMBAT</small> [[API C_EquipmentSet.UseEquipmentSet|C_EquipmentSet.UseEquipmentSet]](<span class="apiarg">equipmentSetID</span>) : <span class="apiret">setWasEquipped</span> - Equips items from a specified equipment set.
+
: <small>''NOCOMBAT''</small> [[API C_EquipmentSet.UseEquipmentSet|C_EquipmentSet.UseEquipmentSet]](<span class="apiarg">equipmentSetID</span>) : <span class="apiret">setWasEquipped</span> - Equips items from a specified equipment set.
 
: [[API GetInventoryItemEquippedUnusable|GetInventoryItemEquippedUnusable]](<span class="apiarg">unit, slot</span>)
 
: [[API GetInventoryItemEquippedUnusable|GetInventoryItemEquippedUnusable]](<span class="apiarg">unit, slot</span>)
 
: [[API GetInventoryItemsForSlot|GetInventoryItemsForSlot]](<span class="apiarg">slot, returnTable [, transmogrify]</span>)
 
: [[API GetInventoryItemsForSlot|GetInventoryItemsForSlot]](<span class="apiarg">slot, returnTable [, transmogrify]</span>)
 
: [[API IsInventoryItemAnUpgrade|IsInventoryItemAnUpgrade]](<span class="apiarg">unit, slot</span>)
 
: [[API IsInventoryItemAnUpgrade|IsInventoryItemAnUpgrade]](<span class="apiarg">unit, slot</span>)
: <small>UI</small> [[API EquipmentManager_UnpackLocation|EquipmentManager_UnpackLocation]]() - Unpacks a location integer to determine the actual inventory location.
+
: <small>''UI''</small> [[API EquipmentManager_UnpackLocation|EquipmentManager_UnpackLocation]]() - Unpacks a location integer to determine the actual inventory location.
   
==== Dressing Room ====
+
====Dressing Room====
 
The [[Dressing room]] was added in [[Patch 1.7.0]]
 
The [[Dressing room]] was added in [[Patch 1.7.0]]
: <small>UI</small> [https://www.townlong-yak.com/framexml/go/DressUpItemLink DressUpItemLink](<span class="apiarg">itemLink</span>) - Shows the Dressing Room with the given item equipped.
+
: <small>''UI''</small> [https://www.townlong-yak.com/framexml/go/DressUpItemLink DressUpItemLink](<span class="apiarg">itemLink</span>) - Shows the Dressing Room with the given item equipped.
: <small>UI</small> [https://www.townlong-yak.com/framexml/go/DressUpMountLink DressUpMountLink](<span class="apiarg">itemLink | spellLink</span>) - Shows the Dressing Room for the mount.
+
: <small>''UI''</small> [https://www.townlong-yak.com/framexml/go/DressUpMountLink DressUpMountLink](<span class="apiarg">itemLink | spellLink</span>) - Shows the Dressing Room for the mount.
: <small>UI</small> [https://www.townlong-yak.com/framexml/go/DressUpTransmogLink DressUpTransmogLink](<span class="apiarg">transmogLink</span>) - Shows the Dressing Room for transmog appearance or illusion.
+
: <small>''UI''</small> [https://www.townlong-yak.com/framexml/go/DressUpTransmogLink DressUpTransmogLink](<span class="apiarg">transmogLink</span>) - Shows the Dressing Room for transmog appearance or illusion.
: <small>UI</small> [https://www.townlong-yak.com/framexml/go/SetDressUpBackground SetDressUpBackground](<span class="apiarg">frame, fileName, atlasPostfix</span>)
+
: <small>''UI''</small> [https://www.townlong-yak.com/framexml/go/SetDressUpBackground SetDressUpBackground](<span class="apiarg">frame, fileName, atlasPostfix</span>)
   
==== Transmogrification ====
+
====Transmogrification====
 
[[Transmogrification]] was added in [[Patch 4.3.0]]. See also [[#Appearances|Appearances]] functions.
 
[[Transmogrification]] was added in [[Patch 4.3.0]]. See also [[#Appearances|Appearances]] functions.
: [[API C_Transmog.ApplyAllPending|C_Transmog.ApplyAllPending]](<span class="apiarg">[currentSpecOnly]</span>) : <span class="apiret">requestSent</span> - Applies all pending transmogrifications, and pays for the cost.
+
: [[API C_Transmog.ApplyAllPending|C_Transmog.ApplyAllPending]](<span class="apiarg">[currentSpecOnly]</span>) : <span class="apiret">requestSent</span> - Confirms all pending transmogs.
 
: [[API C_Transmog.CanHaveSecondaryAppearanceForSlotID|C_Transmog.CanHaveSecondaryAppearanceForSlotID]](<span class="apiarg">slotID</span>) : <span class="apiret">canHaveSecondaryAppearance</span>
 
: [[API C_Transmog.CanHaveSecondaryAppearanceForSlotID|C_Transmog.CanHaveSecondaryAppearanceForSlotID]](<span class="apiarg">slotID</span>) : <span class="apiret">canHaveSecondaryAppearance</span>
 
: [[API C_Transmog.CanTransmogItem|C_Transmog.CanTransmogItem]](<span class="apiarg">itemInfo</span>) : <span class="apiret">canBeTransmogged, selfFailureReason, canTransmogOthers, ...</span>
 
: [[API C_Transmog.CanTransmogItem|C_Transmog.CanTransmogItem]](<span class="apiarg">itemInfo</span>) : <span class="apiret">canBeTransmogged, selfFailureReason, canTransmogOthers, ...</span>
 
: [[API C_Transmog.CanTransmogItemWithItem|C_Transmog.CanTransmogItemWithItem]](<span class="apiarg">targetItemInfo, sourceItemInfo</span>) : <span class="apiret">canTransmog, failureReason</span> - Returns whether an item can be transmogrified to look like another item.
 
: [[API C_Transmog.CanTransmogItemWithItem|C_Transmog.CanTransmogItemWithItem]](<span class="apiarg">targetItemInfo, sourceItemInfo</span>) : <span class="apiret">canTransmog, failureReason</span> - Returns whether an item can be transmogrified to look like another item.
 
: [[API C_Transmog.ClearAllPending|C_Transmog.ClearAllPending]]()
 
: [[API C_Transmog.ClearAllPending|C_Transmog.ClearAllPending]]()
: [[API C_Transmog.ClearPending|C_Transmog.ClearPending]](<span class="apiarg">transmogLocation</span>) - Clears the specified transmogrify slot.
+
: [[API C_Transmog.ClearPending|C_Transmog.ClearPending]](<span class="apiarg">transmogLocation</span>) - Clears an equipment slot of pending transmogs.
 
: [[API C_Transmog.Close|C_Transmog.Close]]()
 
: [[API C_Transmog.Close|C_Transmog.Close]]()
 
: [[API C_Transmog.ExtractTransmogIDList|C_Transmog.ExtractTransmogIDList]](<span class="apiarg">input</span>) : <span class="apiret">transmogIDList</span>
 
: [[API C_Transmog.ExtractTransmogIDList|C_Transmog.ExtractTransmogIDList]](<span class="apiarg">input</span>) : <span class="apiret">transmogIDList</span>
Line 1,111: Line 1,112:
 
: [[API C_Item.IsDressableItemByID|C_Item.IsDressableItemByID]](<span class="apiarg">itemInfo</span>) : <span class="apiret">isDressableItem</span>
 
: [[API C_Item.IsDressableItemByID|C_Item.IsDressableItemByID]](<span class="apiarg">itemInfo</span>) : <span class="apiret">isDressableItem</span>
 
: [[API IsCosmeticItem|IsCosmeticItem]]()
 
: [[API IsCosmeticItem|IsCosmeticItem]]()
: <small>DEPRECATED</small> [[API C_Transmog.GetCost|C_Transmog.GetCost]]()
+
: <small>''DEPRECATED''</small> [[API C_Transmog.GetCost|C_Transmog.GetCost]]()
   
==== Barber Shop ====
+
====Barber Shop====
 
The [[Barbershop]] was added in [[Patch 3.0.2]] and reworked in patch [[Patch 9.0.1]]
 
The [[Barbershop]] was added in [[Patch 3.0.2]] and reworked in patch [[Patch 9.0.1]]
 
: [[API C_BarberShop.ApplyCustomizationChoices|C_BarberShop.ApplyCustomizationChoices]]() : <span class="apiret">success</span>
 
: [[API C_BarberShop.ApplyCustomizationChoices|C_BarberShop.ApplyCustomizationChoices]]() : <span class="apiret">success</span>
Line 1,141: Line 1,142:
 
: [[API C_BarberShop.ZoomCamera|C_BarberShop.ZoomCamera]](<span class="apiarg">zoomAmount</span>)
 
: [[API C_BarberShop.ZoomCamera|C_BarberShop.ZoomCamera]](<span class="apiarg">zoomAmount</span>)
   
=== Cinematics ===
+
===Cinematics===
 
Relates to in-game cinematics/cutscenes.
 
Relates to in-game cinematics/cutscenes.
 
: [[API CanCancelScene|CanCancelScene]]()
 
: [[API CanCancelScene|CanCancelScene]]()
Line 1,155: Line 1,156:
 
: [[API GameMovieFinished|GameMovieFinished]]() - Ends the movie.
 
: [[API GameMovieFinished|GameMovieFinished]]() - Ends the movie.
 
: [[API IsMovieLocal|IsMovieLocal]](<span class="apiarg">movieId</span>)
 
: [[API IsMovieLocal|IsMovieLocal]](<span class="apiarg">movieId</span>)
: [[API IsMoviePlayable|IsMoviePlayable]](<span class="apiarg">movieId</span>) - Returns if a movie can be played.
+
: [[API IsMoviePlayable|IsMoviePlayable]](<span class="apiarg">movieId</span>) - True if the specified movie exists and can be played.
 
: [[API PreloadMovie|PreloadMovie]](<span class="apiarg">movieId</span>)
 
: [[API PreloadMovie|PreloadMovie]](<span class="apiarg">movieId</span>)
: <small>UI</small> [[API MovieFrame_PlayMovie|MovieFrame_PlayMovie]](<span class="apiarg">MovieFrame, movieID</span>) - Plays a movie.
+
: <small>''UI''</small> [[API MovieFrame_PlayMovie|MovieFrame_PlayMovie]](<span class="apiarg">MovieFrame, movieID</span>) - Plays a movie.
   
=== Class ===
+
===Class===
: [[API C_ClassColor.GetClassColor|C_ClassColor.GetClassColor]](<span class="apiarg">className</span>) : <span class="apiret">classColor</span> - Returns information about a class' color.
+
: [[API C_ClassColor.GetClassColor|C_ClassColor.GetClassColor]](<span class="apiarg">className</span>) : <span class="apiret">classColor</span> - Returns a ColorMixin for a class.
: [[API C_CreatureInfo.GetClassInfo|C_CreatureInfo.GetClassInfo]](<span class="apiarg">classID</span>) : <span class="apiret">classInfo</span> - Returns both localized and locale-independent class names.
+
: [[API C_CreatureInfo.GetClassInfo|C_CreatureInfo.GetClassInfo]](<span class="apiarg">classID</span>) : <span class="apiret">classInfo</span> - Returns info for a class by ID.
: [[API FillLocalizedClassList|FillLocalizedClassList]](<span class="apiarg">classTable [, isFemale]</span>) - Fills table with localized class names.
+
: [[API FillLocalizedClassList|FillLocalizedClassList]](<span class="apiarg">classTable [, isFemale]</span>) - Fills a table with localized (female) class names.
 
: [[API GetClassInfo|GetClassInfo]](<span class="apiarg">index</span>) - Returns information about a class.
 
: [[API GetClassInfo|GetClassInfo]](<span class="apiarg">index</span>) - Returns information about a class.
: [[API GetNumClasses|GetNumClasses]]() - Returns the amount of classes in the game.
+
: [[API GetNumClasses|GetNumClasses]]() - Returns the number of player classes in the game.
 
: [[API IsDemonHunterAvailable|IsDemonHunterAvailable]]()
 
: [[API IsDemonHunterAvailable|IsDemonHunterAvailable]]()
: <small>UI</small> [[API GetClassColor|GetClassColor]](<span class="apiarg">classFilename</span>) - Returns a class color from RAID_CLASS_COLORS.
+
: <small>''UI''</small> [[API GetClassColor|GetClassColor]](<span class="apiarg">classFilename</span>) - Returns a class color from RAID_CLASS_COLORS.
[[Shaman totem]]s
 
: <small>PROTECTED</small> [[API DestroyTotem|DestroyTotem]](<span class="apiarg">slot</span>) - Destroys a totem/minion.
 
: [[API GetMultiCastTotemSpells|GetMultiCastTotemSpells]](<span class="apiarg">totemslot</span>) - Returns a list of spellIDs that are applicable for the specified totem slot (1-4)
 
: [[API GetTotemCannotDismiss|GetTotemCannotDismiss]](<span class="apiarg">slot</span>)
 
: [[API GetTotemInfo|GetTotemInfo]](<span class="apiarg">slot</span>) - Returns information about a totem.
 
: [[API GetTotemTimeLeft|GetTotemTimeLeft]](<span class="apiarg">slot</span>)
 
: [[API TargetTotem|TargetTotem]](<span class="apiarg">slot</span>)
 
: <small>PROTECTED</small> [[API SetMultiCastSpell|SetMultiCastSpell]](<span class="apiarg">actionID, spellID</span>) - Assigns a spellID to a multicast (totem bar) actionID.
 
[[Druid shapeshift forms]]
 
: <small>PROTECTED</small> [[API CancelShapeshiftForm|CancelShapeshiftForm]]() - Cancels a druid's shapeshift form buff.
 
: <small>PROTECTED</small> [[API CastShapeshiftForm|CastShapeshiftForm]](<span class="apiarg">index</span>)
 
: [[API GetNumShapeshiftForms|GetNumShapeshiftForms]]()
 
: [[API GetShapeshiftForm|GetShapeshiftForm]](<span class="apiarg">unknown</span>) - Returns zero-based index of current form/stance.
 
: [[API GetShapeshiftFormCooldown|GetShapeshiftFormCooldown]](<span class="apiarg">index</span>)
 
: [[API GetShapeshiftFormID|GetShapeshiftFormID]]() - Returns the current shapeshift form as a constant. If the player is not shapeshifted it returns nil.
 
: [[API GetShapeshiftFormInfo|GetShapeshiftFormInfo]](<span class="apiarg">index</span>) - Retrieves information about an available ShapeshiftForm or Stance.
 
   
==== Talents ====
+
====Talents====
 
Relates to [[Specialization|Specializations]].
 
Relates to [[Specialization|Specializations]].
 
: [[API C_SpecializationInfo.CanPlayerUsePVPTalentUI|C_SpecializationInfo.CanPlayerUsePVPTalentUI]]() : <span class="apiret">canUse, failureReason</span>
 
: [[API C_SpecializationInfo.CanPlayerUsePVPTalentUI|C_SpecializationInfo.CanPlayerUsePVPTalentUI]]() : <span class="apiret">canUse, failureReason</span>
Line 1,223: Line 1,208:
 
: [[API GetSpecChangeCost|GetSpecChangeCost]]()
 
: [[API GetSpecChangeCost|GetSpecChangeCost]]()
 
: [[API GetSpecialization|GetSpecialization]](<span class="apiarg">[isInspect, isPet, specGroup]</span>) - Returns the index of the player's current specialization.
 
: [[API GetSpecialization|GetSpecialization]](<span class="apiarg">[isInspect, isPet, specGroup]</span>) - Returns the index of the player's current specialization.
: [[API GetSpecializationInfo|GetSpecializationInfo]](<span class="apiarg">specIndex [, isInspect, isPet, inspectTarget, sex]</span>) - Returns information about the player's specializations.
+
: [[API GetSpecializationInfo|GetSpecializationInfo]](<span class="apiarg">specIndex [, isInspect, isPet, inspectTarget, sex]</span>) - Returns info for a specialization.
 
: [[API GetSpecializationInfoByID|GetSpecializationInfoByID]](<span class="apiarg">specID</span>) - Returns information about the specified specialization.
 
: [[API GetSpecializationInfoByID|GetSpecializationInfoByID]](<span class="apiarg">specID</span>) - Returns information about the specified specialization.
 
: [[API GetSpecializationInfoForClassID|GetSpecializationInfoForClassID]](<span class="apiarg">classID, specIndex</span>) - Returns information about the specified specialization.
 
: [[API GetSpecializationInfoForClassID|GetSpecializationInfoForClassID]](<span class="apiarg">classID, specIndex</span>) - Returns information about the specified specialization.
 
: [[API GetSpecializationInfoForSpecID|GetSpecializationInfoForSpecID]](<span class="apiarg">specID [, sex]</span>)
 
: [[API GetSpecializationInfoForSpecID|GetSpecializationInfoForSpecID]](<span class="apiarg">specID [, sex]</span>)
: [[API GetSpecializationMasterySpells|GetSpecializationMasterySpells]](<span class="apiarg">specIndex [, isInspect, isPet]</span>) - Returns the mastery spellID of the current player's specialization.
+
: [[API GetSpecializationMasterySpells|GetSpecializationMasterySpells]](<span class="apiarg">specIndex [, isInspect, isPet]</span>) - Returns the mastery spell ID of the specified specialization.
 
: [[API GetSpecializationNameForSpecID|GetSpecializationNameForSpecID]](<span class="apiarg">specID [, sex]</span>)
 
: [[API GetSpecializationNameForSpecID|GetSpecializationNameForSpecID]](<span class="apiarg">specID [, sex]</span>)
 
: [[API GetSpecializationRole|GetSpecializationRole]](<span class="apiarg">specIndex [, isInspect, isPet]</span>) - Returns the role a specialization is intended to perform.
 
: [[API GetSpecializationRole|GetSpecializationRole]](<span class="apiarg">specIndex [, isInspect, isPet]</span>) - Returns the role a specialization is intended to perform.
 
: [[API GetSpecializationRoleByID|GetSpecializationRoleByID]](<span class="apiarg">specID</span>) - Returns the role a specialization is intended to perform.
 
: [[API GetSpecializationRoleByID|GetSpecializationRoleByID]](<span class="apiarg">specID</span>) - Returns the role a specialization is intended to perform.
: [[API GetSpecializationSpells|GetSpecializationSpells]](<span class="apiarg">specIndex [, isInspect, isPet]</span>) - Returns the spellID of key abilities used by the specified specialization.
+
: [[API GetSpecializationSpells|GetSpecializationSpells]](<span class="apiarg">specIndex [, isInspect, isPet]</span>) - Returns the spells learned as part of the specified specialization.
 
: [[API GetSpecsForSpell|GetSpecsForSpell]](<span class="apiarg">spellName or spellIndex, bookType</span>) - Returns the specs for which the specified spell can be used.
 
: [[API GetSpecsForSpell|GetSpecsForSpell]](<span class="apiarg">spellName or spellIndex, bookType</span>) - Returns the specs for which the specified spell can be used.
: [[API GetTalentInfo|GetTalentInfo]](<span class="apiarg">tier, column, specGroupIndex [, isInspect, inspectUnit]</span>) - Returns information about a talent.
+
: [[API GetTalentInfo|GetTalentInfo]](<span class="apiarg">tier, column, specGroupIndex [, isInspect, inspectUnit]</span>) - Returns info for the specified talent.
 
: [[API GetTalentInfoByID|GetTalentInfoByID]](<span class="apiarg">talentID, specGroupIndex [, isInspect, inspectUnit]</span>) - Returns information about a talent.
 
: [[API GetTalentInfoByID|GetTalentInfoByID]](<span class="apiarg">talentID, specGroupIndex [, isInspect, inspectUnit]</span>) - Returns information about a talent.
 
: [[API GetTalentInfoBySpecialization|GetTalentInfoBySpecialization]](<span class="apiarg">specGroupIndex, tier, column</span>)
 
: [[API GetTalentInfoBySpecialization|GetTalentInfoBySpecialization]](<span class="apiarg">specGroupIndex, tier, column</span>)
Line 1,240: Line 1,225:
 
: [[API IsPvpTalentSpell|IsPvpTalentSpell]]()
 
: [[API IsPvpTalentSpell|IsPvpTalentSpell]]()
 
: [[API IsSpellClassOrSpec|IsSpellClassOrSpec]](<span class="apiarg">spellName or spellIndex, bookType</span>) - Returns whether a given spell is specific to a specialization and/or class.
 
: [[API IsSpellClassOrSpec|IsSpellClassOrSpec]](<span class="apiarg">spellName or spellIndex, bookType</span>) - Returns whether a given spell is specific to a specialization and/or class.
: [[API IsTalentSpell|IsTalentSpell]](<span class="apiarg">slot, bookType</span>) - Returns whether or not the specified spell is learned from a talent.
+
: [[API IsTalentSpell|IsTalentSpell]](<span class="apiarg">slot, bookType</span>) - True if the specified spell is learned from a talent.
 
: [[API LearnPvpTalent|LearnPvpTalent]]()
 
: [[API LearnPvpTalent|LearnPvpTalent]]()
 
: [[API LearnPvpTalents|LearnPvpTalents]]()
 
: [[API LearnPvpTalents|LearnPvpTalents]]()
 
: [[API LearnTalent|LearnTalent]](<span class="apiarg">talentID</span>)
 
: [[API LearnTalent|LearnTalent]](<span class="apiarg">talentID</span>)
: <small>NOCOMBAT</small> [[API LearnTalents|LearnTalents]](<span class="apiarg">talentID1, talentID2, ...</span>) - Learns the talents listed.
+
: <small>''NOCOMBAT''</small> [[API LearnTalents|LearnTalents]](<span class="apiarg">talentID1, talentID2, ...</span>) - Learns the talents listed.
 
: [[API RemovePvpTalent|RemovePvpTalent]]()
 
: [[API RemovePvpTalent|RemovePvpTalent]]()
: <small>NOCOMBAT</small> [[API RemoveTalent|RemoveTalent]](<span class="apiarg">talentID</span>) - Removes the specified talent.
+
: <small>''NOCOMBAT''</small> [[API RemoveTalent|RemoveTalent]](<span class="apiarg">talentID</span>) - Removes the specified talent.
: <small>NOCOMBAT</small> [[API SetSpecialization|SetSpecialization]](<span class="apiarg">specIndex [, isPet]</span>) - Selects a specialization.
+
: <small>''NOCOMBAT''</small> [[API SetSpecialization|SetSpecialization]](<span class="apiarg">specIndex [, isPet]</span>) - Selects a specialization.
: <small>NOCOMBAT</small> [[API UnlearnSpecialization|UnlearnSpecialization]](<span class="apiarg">specIndex [, isPet]</span>)
+
: <small>''NOCOMBAT''</small> [[API UnlearnSpecialization|UnlearnSpecialization]](<span class="apiarg">specIndex [, isPet]</span>)
  +
 
====[[Shaman totem]]s====
 
: <small>''PROTECTED''</small> [[API DestroyTotem|DestroyTotem]](<span class="apiarg">slot</span>) - Destroys a totem/minion.
 
: [[API GetMultiCastTotemSpells|GetMultiCastTotemSpells]](<span class="apiarg">totemslot</span>) - Returns a list of valid spells for a totem bar slot.
 
: [[API GetTotemCannotDismiss|GetTotemCannotDismiss]](<span class="apiarg">slot</span>)
 
: [[API GetTotemInfo|GetTotemInfo]](<span class="apiarg">slot</span>) - Returns info for the specified totem.
 
: [[API GetTotemTimeLeft|GetTotemTimeLeft]](<span class="apiarg">slot</span>)
 
: [[API TargetTotem|TargetTotem]](<span class="apiarg">slot</span>)
 
: <small>''PROTECTED''</small> [[API SetMultiCastSpell|SetMultiCastSpell]](<span class="apiarg">actionID, spellID</span>) - Sets the totem spell for a specific totem bar slot.
  +
 
====[[Druid shapeshift forms]]====
 
: <small>''PROTECTED''</small> [[API CancelShapeshiftForm|CancelShapeshiftForm]]() - Cancels a shapeshift form.
 
: <small>''PROTECTED''</small> [[API CastShapeshiftForm|CastShapeshiftForm]](<span class="apiarg">index</span>)
 
: [[API GetNumShapeshiftForms|GetNumShapeshiftForms]]()
 
: [[API GetShapeshiftForm|GetShapeshiftForm]](<span class="apiarg">unknown</span>) - Returns zero-based index of current form/stance.
 
: [[API GetShapeshiftFormCooldown|GetShapeshiftFormCooldown]](<span class="apiarg">index</span>)
 
: [[API GetShapeshiftFormID|GetShapeshiftFormID]]() - Returns the ID of the form or stance the player is currently in.
 
: [[API GetShapeshiftFormInfo|GetShapeshiftFormInfo]](<span class="apiarg">index</span>) - Returns info for an available form or stance.
  +
  +
====Stables====
 
: [[API C_StableInfo.GetNumActivePets|C_StableInfo.GetNumActivePets]]() : <span class="apiret">numActivePets</span>
 
: [[API C_StableInfo.GetNumStablePets|C_StableInfo.GetNumStablePets]]() : <span class="apiret">numStablePets</span>
   
=== Collections ===
+
===Collections===
 
The [[Collections]] window was added in [[Patch 5.0.4]]
 
The [[Collections]] window was added in [[Patch 5.0.4]]
   
==== Mount Journal ====
+
====Mount Journal====
 
The [[Mounts_tab|Mount Journal]] was added in [[Patch 6.0.2]]
 
The [[Mounts_tab|Mount Journal]] was added in [[Patch 6.0.2]]
 
: [[API C_MountJournal.ClearFanfare|C_MountJournal.ClearFanfare]](<span class="apiarg">mountID</span>)
 
: [[API C_MountJournal.ClearFanfare|C_MountJournal.ClearFanfare]](<span class="apiarg">mountID</span>)
Line 1,263: Line 1,270:
 
: [[API C_MountJournal.GetDisplayedMountInfoExtra|C_MountJournal.GetDisplayedMountInfoExtra]](<span class="apiarg">mountIndex</span>) : <span class="apiret">creatureDisplayInfoID, description, source, isSelfMount, mountTypeID, ...</span> - Returns extra information about the specified mount.
 
: [[API C_MountJournal.GetDisplayedMountInfoExtra|C_MountJournal.GetDisplayedMountInfoExtra]](<span class="apiarg">mountIndex</span>) : <span class="apiret">creatureDisplayInfoID, description, source, isSelfMount, mountTypeID, ...</span> - Returns extra information about the specified mount.
 
: [[API C_MountJournal.GetIsFavorite|C_MountJournal.GetIsFavorite]](<span class="apiarg">mountIndex</span>) : <span class="apiret">isFavorite, canSetFavorite</span> - Indicates whether the specified mount is marked as a favorite.
 
: [[API C_MountJournal.GetIsFavorite|C_MountJournal.GetIsFavorite]](<span class="apiarg">mountIndex</span>) : <span class="apiret">isFavorite, canSetFavorite</span> - Indicates whether the specified mount is marked as a favorite.
: [[API C_MountJournal.GetMountAllCreatureDisplayInfoByID|C_MountJournal.GetMountAllCreatureDisplayInfoByID]](<span class="apiarg">mountID</span>) : <span class="apiret">allDisplayInfo</span> - Returns all display IDs for a mount by ID.
+
: [[API C_MountJournal.GetMountAllCreatureDisplayInfoByID|C_MountJournal.GetMountAllCreatureDisplayInfoByID]](<span class="apiarg">mountID</span>) : <span class="apiret">allDisplayInfo</span> - Returns the display IDs for a mount.
 
: [[API C_MountJournal.GetMountFromItem|C_MountJournal.GetMountFromItem]](<span class="apiarg">itemID</span>) : <span class="apiret">mountID</span> - Returns the mount for an item ID.
 
: [[API C_MountJournal.GetMountFromItem|C_MountJournal.GetMountFromItem]](<span class="apiarg">itemID</span>) : <span class="apiret">mountID</span> - Returns the mount for an item ID.
 
: [[API C_MountJournal.GetMountFromSpell|C_MountJournal.GetMountFromSpell]](<span class="apiarg">spellID</span>) : <span class="apiret">mountID</span> - Returns the mount for a spell ID.
 
: [[API C_MountJournal.GetMountFromSpell|C_MountJournal.GetMountFromSpell]](<span class="apiarg">spellID</span>) : <span class="apiret">mountID</span> - Returns the mount for a spell ID.
Line 1,270: Line 1,277:
 
: [[API C_MountJournal.GetMountInfoExtraByID|C_MountJournal.GetMountInfoExtraByID]](<span class="apiarg">mountID</span>) : <span class="apiret">creatureDisplayInfoID, description, source, isSelfMount, mountTypeID, ...</span> - Returns extra information about the specified mount.
 
: [[API C_MountJournal.GetMountInfoExtraByID|C_MountJournal.GetMountInfoExtraByID]](<span class="apiarg">mountID</span>) : <span class="apiret">creatureDisplayInfoID, description, source, isSelfMount, mountTypeID, ...</span> - Returns extra information about the specified mount.
 
: [[API C_MountJournal.GetMountUsabilityByID|C_MountJournal.GetMountUsabilityByID]](<span class="apiarg">mountID, checkIndoors</span>) : <span class="apiret">isUsable, useError</span> - Returns if a mount is currently usable by the player.
 
: [[API C_MountJournal.GetMountUsabilityByID|C_MountJournal.GetMountUsabilityByID]](<span class="apiarg">mountID, checkIndoors</span>) : <span class="apiret">isUsable, useError</span> - Returns if a mount is currently usable by the player.
: [[API C_MountJournal.GetNumDisplayedMounts|C_MountJournal.GetNumDisplayedMounts]]() : <span class="apiret">numMounts</span> - Returns the number of mounts shown in the mount journal.
+
: [[API C_MountJournal.GetNumDisplayedMounts|C_MountJournal.GetNumDisplayedMounts]]() : <span class="apiret">numMounts</span> - Returns the number of (filtered) mounts shown in the mount journal.
 
: [[API C_MountJournal.GetNumMounts|C_MountJournal.GetNumMounts]]() : <span class="apiret">numMounts</span> - Returns the number of mounts listed in the mount journal.
 
: [[API C_MountJournal.GetNumMounts|C_MountJournal.GetNumMounts]]() : <span class="apiret">numMounts</span> - Returns the number of mounts listed in the mount journal.
 
: [[API C_MountJournal.GetNumMountsNeedingFanfare|C_MountJournal.GetNumMountsNeedingFanfare]]() : <span class="apiret">numMountsNeedingFanfare</span>
 
: [[API C_MountJournal.GetNumMountsNeedingFanfare|C_MountJournal.GetNumMountsNeedingFanfare]]() : <span class="apiret">numMountsNeedingFanfare</span>
 
: [[API C_MountJournal.IsSourceChecked|C_MountJournal.IsSourceChecked]](<span class="apiarg">filterIndex</span>) : <span class="apiret">isChecked</span>
 
: [[API C_MountJournal.IsSourceChecked|C_MountJournal.IsSourceChecked]](<span class="apiarg">filterIndex</span>) : <span class="apiret">isChecked</span>
 
: [[API C_MountJournal.IsTypeChecked|C_MountJournal.IsTypeChecked]](<span class="apiarg">filterIndex</span>) : <span class="apiret">isChecked</span>
 
: [[API C_MountJournal.IsTypeChecked|C_MountJournal.IsTypeChecked]](<span class="apiarg">filterIndex</span>) : <span class="apiret">isChecked</span>
  +
: [[API C_MountJournal.IsUsingDefaultFilters|C_MountJournal.IsUsingDefaultFilters]]() : <span class="apiret">isUsingDefaultFilters</span>
 
: [[API C_MountJournal.IsValidSourceFilter|C_MountJournal.IsValidSourceFilter]](<span class="apiarg">filterIndex</span>) : <span class="apiret">isValid</span>
 
: [[API C_MountJournal.IsValidSourceFilter|C_MountJournal.IsValidSourceFilter]](<span class="apiarg">filterIndex</span>) : <span class="apiret">isValid</span>
 
: [[API C_MountJournal.IsValidTypeFilter|C_MountJournal.IsValidTypeFilter]](<span class="apiarg">filterIndex</span>) : <span class="apiret">isValid</span>
 
: [[API C_MountJournal.IsValidTypeFilter|C_MountJournal.IsValidTypeFilter]](<span class="apiarg">filterIndex</span>) : <span class="apiret">isValid</span>
Line 1,282: Line 1,290:
 
: [[API C_MountJournal.SetAllTypeFilters|C_MountJournal.SetAllTypeFilters]](<span class="apiarg">isChecked</span>)
 
: [[API C_MountJournal.SetAllTypeFilters|C_MountJournal.SetAllTypeFilters]](<span class="apiarg">isChecked</span>)
 
: [[API C_MountJournal.SetCollectedFilterSetting|C_MountJournal.SetCollectedFilterSetting]](<span class="apiarg">filterIndex, isChecked</span>) - Enables or disables the specified mount journal filter.
 
: [[API C_MountJournal.SetCollectedFilterSetting|C_MountJournal.SetCollectedFilterSetting]](<span class="apiarg">filterIndex, isChecked</span>) - Enables or disables the specified mount journal filter.
  +
: [[API C_MountJournal.SetDefaultFilters|C_MountJournal.SetDefaultFilters]]()
 
: [[API C_MountJournal.SetIsFavorite|C_MountJournal.SetIsFavorite]](<span class="apiarg">mountIndex, isFavorite</span>) - Marks or unmarks the specified mount as a favorite.
 
: [[API C_MountJournal.SetIsFavorite|C_MountJournal.SetIsFavorite]](<span class="apiarg">mountIndex, isFavorite</span>) - Marks or unmarks the specified mount as a favorite.
 
: [[API C_MountJournal.SetSearch|C_MountJournal.SetSearch]](<span class="apiarg">searchValue</span>)
 
: [[API C_MountJournal.SetSearch|C_MountJournal.SetSearch]](<span class="apiarg">searchValue</span>)
Line 1,288: Line 1,297:
 
: [[API C_MountJournal.SummonByID|C_MountJournal.SummonByID]](<span class="apiarg">mountID</span>) - Summons the specified mount.
 
: [[API C_MountJournal.SummonByID|C_MountJournal.SummonByID]](<span class="apiarg">mountID</span>) - Summons the specified mount.
 
[[Mount equipment]] was added in [[Patch 8.2.0]]
 
[[Mount equipment]] was added in [[Patch 8.2.0]]
: <small>PROTECTED</small> [[API C_MountJournal.ApplyMountEquipment|C_MountJournal.ApplyMountEquipment]](<span class="apiarg">itemLocation</span>) : <span class="apiret">canContinue</span>
+
: <small>''PROTECTED''</small> [[API C_MountJournal.ApplyMountEquipment|C_MountJournal.ApplyMountEquipment]](<span class="apiarg">itemLocation</span>) : <span class="apiret">canContinue</span>
 
: [[API C_MountJournal.AreMountEquipmentEffectsSuppressed|C_MountJournal.AreMountEquipmentEffectsSuppressed]]() : <span class="apiret">areEffectsSuppressed</span>
 
: [[API C_MountJournal.AreMountEquipmentEffectsSuppressed|C_MountJournal.AreMountEquipmentEffectsSuppressed]]() : <span class="apiret">areEffectsSuppressed</span>
 
: [[API C_MountJournal.GetAppliedMountEquipmentID|C_MountJournal.GetAppliedMountEquipmentID]]() : <span class="apiret">itemID</span>
 
: [[API C_MountJournal.GetAppliedMountEquipmentID|C_MountJournal.GetAppliedMountEquipmentID]]() : <span class="apiret">itemID</span>
Line 1,296: Line 1,305:
 
: [[API C_PlayerInfo.CanPlayerUseMountEquipment|C_PlayerInfo.CanPlayerUseMountEquipment]]() : <span class="apiret">canUseMountEquipment, failureReason</span> - Returns true if the player can use mount equipment.
 
: [[API C_PlayerInfo.CanPlayerUseMountEquipment|C_PlayerInfo.CanPlayerUseMountEquipment]]() : <span class="apiret">canUseMountEquipment, failureReason</span> - Returns true if the player can use mount equipment.
 
The old companion API (non-combat pets and mounts) was added in [[Patch 3.0.2]]
 
The old companion API (non-combat pets and mounts) was added in [[Patch 3.0.2]]
: [[API CallCompanion|CallCompanion]](<span class="apiarg">type, slotid</span>) - Summons a companion.
+
: <small>''DEPRECATED''</small> [[API CallCompanion|CallCompanion]](<span class="apiarg">type, slotid</span>) - Summons a companion.
: [[API DismissCompanion|DismissCompanion]](<span class="apiarg">type</span>) - Dismisses an active companion.
+
: <small>''DEPRECATED''</small> [[API DismissCompanion|DismissCompanion]](<span class="apiarg">type</span>) - Dismisses the current companion.
: [[API GetCompanionInfo|GetCompanionInfo]](<span class="apiarg">type, slotid</span>) - Returns info about a selected companion.
+
: <small>''DEPRECATED''</small> [[API GetCompanionInfo|GetCompanionInfo]](<span class="apiarg">type, slotid</span>) - Returns info for a companion.
: [[API GetNumCompanions|GetNumCompanions]](<span class="apiarg">type</span>) - Get the number of companions of the specified type.
+
: <small>''DEPRECATED''</small> [[API GetNumCompanions|GetNumCompanions]](<span class="apiarg">type</span>) - Returns the number of mounts.
: [[API SummonRandomCritter|SummonRandomCritter]]() - Summons a random critter companion.
+
: <small>''DEPRECATED''</small> [[API SummonRandomCritter|SummonRandomCritter]]() - No longer does anything.
   
==== Pet Journal ====
+
====Pet Journal====
 
The [[Pet Journal]] was added in [[Patch 5.0.4]]. See also [[#Pet Battles|Pet Battle]] functions.
 
The [[Pet Journal]] was added in [[Patch 5.0.4]]. See also [[#Pet Battles|Pet Battle]] functions.
 
: [[API C_PetInfo.GetPetTamersForMap|C_PetInfo.GetPetTamersForMap]](<span class="apiarg">uiMapID</span>) : <span class="apiret">petTamers</span> - Returns the pet tamers on a map.
 
: [[API C_PetInfo.GetPetTamersForMap|C_PetInfo.GetPetTamersForMap]](<span class="apiarg">uiMapID</span>) : <span class="apiret">petTamers</span> - Returns the pet tamers on a map.
Line 1,310: Line 1,319:
 
: [[API C_PetJournal.ClearSearchFilter|C_PetJournal.ClearSearchFilter]]() - Clears the search box in the pet journal.
 
: [[API C_PetJournal.ClearSearchFilter|C_PetJournal.ClearSearchFilter]]() - Clears the search box in the pet journal.
 
: [[API C_PetJournal.FindPetIDByName|C_PetJournal.FindPetIDByName]]()
 
: [[API C_PetJournal.FindPetIDByName|C_PetJournal.FindPetIDByName]]()
: [[API C_PetJournal.GetBattlePetLink|C_PetJournal.GetBattlePetLink]](<span class="apiarg">petID</span>) - Returns a battle pet hyperlink for the given petID.
+
: [[API C_PetJournal.GetBattlePetLink|C_PetJournal.GetBattlePetLink]](<span class="apiarg">petID</span>) - Returns a battle pet link.
 
: [[API C_PetJournal.GetDisplayIDByIndex|C_PetJournal.GetDisplayIDByIndex]](<span class="apiarg">speciesID, index</span>) : <span class="apiret">displayID</span>
 
: [[API C_PetJournal.GetDisplayIDByIndex|C_PetJournal.GetDisplayIDByIndex]](<span class="apiarg">speciesID, index</span>) : <span class="apiret">displayID</span>
 
: [[API C_PetJournal.GetDisplayProbabilityByIndex|C_PetJournal.GetDisplayProbabilityByIndex]](<span class="apiarg">speciesID, index</span>) : <span class="apiret">displayProbability</span>
 
: [[API C_PetJournal.GetDisplayProbabilityByIndex|C_PetJournal.GetDisplayProbabilityByIndex]](<span class="apiarg">speciesID, index</span>) : <span class="apiret">displayProbability</span>
Line 1,319: Line 1,328:
 
: [[API C_PetJournal.GetNumPetSources|C_PetJournal.GetNumPetSources]]() - Returns information about the number of pet sources.
 
: [[API C_PetJournal.GetNumPetSources|C_PetJournal.GetNumPetSources]]() - Returns information about the number of pet sources.
 
: [[API C_PetJournal.GetNumPetTypes|C_PetJournal.GetNumPetTypes]]() - Returns information about the number of pet types.
 
: [[API C_PetJournal.GetNumPetTypes|C_PetJournal.GetNumPetTypes]]() - Returns information about the number of pet types.
: [[API C_PetJournal.GetOwnedBattlePetString|C_PetJournal.GetOwnedBattlePetString]](<span class="apiarg">speciesID</span>) - Returns string about numbers of battle pets in journal.
+
: [[API C_PetJournal.GetOwnedBattlePetString|C_PetJournal.GetOwnedBattlePetString]](<span class="apiarg">speciesID</span>) - Returns a formatted string how many of a battle pet species the player has collected.
 
: [[API C_PetJournal.GetPetAbilityInfo|C_PetJournal.GetPetAbilityInfo]](<span class="apiarg">abilityID</span>) : <span class="apiret">name, icon, petType</span>
 
: [[API C_PetJournal.GetPetAbilityInfo|C_PetJournal.GetPetAbilityInfo]](<span class="apiarg">abilityID</span>) : <span class="apiret">name, icon, petType</span>
 
: [[API C_PetJournal.GetPetAbilityList|C_PetJournal.GetPetAbilityList]](<span class="apiarg">speciesID [, idTable, levelTable]</span>)
 
: [[API C_PetJournal.GetPetAbilityList|C_PetJournal.GetPetAbilityList]](<span class="apiarg">speciesID [, idTable, levelTable]</span>)
Line 1,332: Line 1,341:
 
: [[API C_PetJournal.GetPetModelSceneInfoBySpeciesID|C_PetJournal.GetPetModelSceneInfoBySpeciesID]](<span class="apiarg">speciesID</span>)
 
: [[API C_PetJournal.GetPetModelSceneInfoBySpeciesID|C_PetJournal.GetPetModelSceneInfoBySpeciesID]](<span class="apiarg">speciesID</span>)
 
: [[API C_PetJournal.GetPetSortParameter|C_PetJournal.GetPetSortParameter]]()
 
: [[API C_PetJournal.GetPetSortParameter|C_PetJournal.GetPetSortParameter]]()
: [[API C_PetJournal.GetPetStats|C_PetJournal.GetPetStats]](<span class="apiarg">petID</span>) - Returns a pet's stats from the Pet Journal.
+
: [[API C_PetJournal.GetPetStats|C_PetJournal.GetPetStats]](<span class="apiarg">petID</span>) - Returns the stats of a collected battle pet.
 
: [[API C_PetJournal.GetPetSummonInfo|C_PetJournal.GetPetSummonInfo]](<span class="apiarg">battlePetGUID</span>) : <span class="apiret">isSummonable, error, errorText</span>
 
: [[API C_PetJournal.GetPetSummonInfo|C_PetJournal.GetPetSummonInfo]](<span class="apiarg">battlePetGUID</span>) : <span class="apiret">isSummonable, error, errorText</span>
 
: [[API C_PetJournal.GetPetTeamAverageLevel|C_PetJournal.GetPetTeamAverageLevel]]()
 
: [[API C_PetJournal.GetPetTeamAverageLevel|C_PetJournal.GetPetTeamAverageLevel]]()
Line 1,344: Line 1,353:
 
: [[API C_PetJournal.IsPetSourceChecked|C_PetJournal.IsPetSourceChecked]]()
 
: [[API C_PetJournal.IsPetSourceChecked|C_PetJournal.IsPetSourceChecked]]()
 
: [[API C_PetJournal.IsPetTypeChecked|C_PetJournal.IsPetTypeChecked]]()
 
: [[API C_PetJournal.IsPetTypeChecked|C_PetJournal.IsPetTypeChecked]]()
  +
: [[API C_PetJournal.IsUsingDefaultFilters|C_PetJournal.IsUsingDefaultFilters]]() : <span class="apiret">isUsingDefaultFilters</span>
 
: [[API C_PetJournal.PetCanBeReleased|C_PetJournal.PetCanBeReleased]](<span class="apiarg">petID</span>) - Returns true if you can release the pet.
 
: [[API C_PetJournal.PetCanBeReleased|C_PetJournal.PetCanBeReleased]](<span class="apiarg">petID</span>) - Returns true if you can release the pet.
 
: [[API C_PetJournal.PetIsCapturable|C_PetJournal.PetIsCapturable]](<span class="apiarg">petID</span>)
 
: [[API C_PetJournal.PetIsCapturable|C_PetJournal.PetIsCapturable]](<span class="apiarg">petID</span>)
: [[API C_PetJournal.PetIsFavorite|C_PetJournal.PetIsFavorite]](<span class="apiarg">petID</span>) - Returns true if this pet is marked as a favorite.
+
: [[API C_PetJournal.PetIsFavorite|C_PetJournal.PetIsFavorite]](<span class="apiarg">petID</span>) - True if the collected battle pet is favorited.
 
: [[API C_PetJournal.PetIsHurt|C_PetJournal.PetIsHurt]](<span class="apiarg">petID</span>)
 
: [[API C_PetJournal.PetIsHurt|C_PetJournal.PetIsHurt]](<span class="apiarg">petID</span>)
 
: [[API C_PetJournal.PetIsLockedForConvert|C_PetJournal.PetIsLockedForConvert]](<span class="apiarg">petID</span>)
 
: [[API C_PetJournal.PetIsLockedForConvert|C_PetJournal.PetIsLockedForConvert]](<span class="apiarg">petID</span>)
Line 1,363: Line 1,373:
 
: [[API C_PetJournal.SetAllPetTypesChecked|C_PetJournal.SetAllPetTypesChecked]]()
 
: [[API C_PetJournal.SetAllPetTypesChecked|C_PetJournal.SetAllPetTypesChecked]]()
 
: [[API C_PetJournal.SetCustomName|C_PetJournal.SetCustomName]](<span class="apiarg">petID, customName</span>) - Sets a custom name for the pet.
 
: [[API C_PetJournal.SetCustomName|C_PetJournal.SetCustomName]](<span class="apiarg">petID, customName</span>) - Sets a custom name for the pet.
  +
: [[API C_PetJournal.SetDefaultFilters|C_PetJournal.SetDefaultFilters]]()
 
: [[API C_PetJournal.SetFavorite|C_PetJournal.SetFavorite]](<span class="apiarg">petID, value</span>) - Sets (or clears) the pet as a favorite.
 
: [[API C_PetJournal.SetFavorite|C_PetJournal.SetFavorite]](<span class="apiarg">petID, value</span>) - Sets (or clears) the pet as a favorite.
 
: [[API C_PetJournal.SetFilterChecked|C_PetJournal.SetFilterChecked]]()
 
: [[API C_PetJournal.SetFilterChecked|C_PetJournal.SetFilterChecked]]()
Line 1,370: Line 1,381:
 
: [[API C_PetJournal.SetPetTypeFilter|C_PetJournal.SetPetTypeFilter]](<span class="apiarg">index, value</span>) - Sets the pet type in the filter menu.
 
: [[API C_PetJournal.SetPetTypeFilter|C_PetJournal.SetPetTypeFilter]](<span class="apiarg">index, value</span>) - Sets the pet type in the filter menu.
 
: [[API C_PetJournal.SetSearchFilter|C_PetJournal.SetSearchFilter]](<span class="apiarg">text</span>) - Sets the search filter in the pet journal.
 
: [[API C_PetJournal.SetSearchFilter|C_PetJournal.SetSearchFilter]](<span class="apiarg">text</span>) - Sets the search filter in the pet journal.
: <small>NOCOMBAT</small> [[API C_PetJournal.SummonPetByGUID|C_PetJournal.SummonPetByGUID]](<span class="apiarg">petID</span>) - Summons (or dismisses) a pet.
+
: <small>''NOCOMBAT''</small> [[API C_PetJournal.SummonPetByGUID|C_PetJournal.SummonPetByGUID]](<span class="apiarg">petID</span>) - Summons (or dismisses) a pet.
: <small>NOCOMBAT</small> [[API C_PetJournal.SummonRandomPet|C_PetJournal.SummonRandomPet]](<span class="apiarg">allPets</span>) - Summons a random battle pet companion.
+
: <small>''NOCOMBAT''</small> [[API C_PetJournal.SummonRandomPet|C_PetJournal.SummonRandomPet]](<span class="apiarg">allPets</span>) - Summons a random battle pet companion.
   
==== Toy Box ====
+
====Toy Box====
 
The [[Toy Box]] was added in [[Patch 6.0.2]]
 
The [[Toy Box]] was added in [[Patch 6.0.2]]
 
: [[API C_ToyBox.ForceToyRefilter|C_ToyBox.ForceToyRefilter]]()
 
: [[API C_ToyBox.ForceToyRefilter|C_ToyBox.ForceToyRefilter]]()
Line 1,384: Line 1,395:
 
: [[API C_ToyBox.GetToyFromIndex|C_ToyBox.GetToyFromIndex]](<span class="apiarg">itemIndex</span>)
 
: [[API C_ToyBox.GetToyFromIndex|C_ToyBox.GetToyFromIndex]](<span class="apiarg">itemIndex</span>)
 
: [[API C_ToyBox.GetToyInfo|C_ToyBox.GetToyInfo]](<span class="apiarg">itemID</span>) - Returns toy info.
 
: [[API C_ToyBox.GetToyInfo|C_ToyBox.GetToyInfo]](<span class="apiarg">itemID</span>) - Returns toy info.
: [[API C_ToyBox.GetToyLink|C_ToyBox.GetToyLink]](<span class="apiarg">itemID</span>) - Returns item link.
+
: [[API C_ToyBox.GetToyLink|C_ToyBox.GetToyLink]](<span class="apiarg">itemID</span>) - Returns the item link for a toy.
 
: [[API C_ToyBox.GetUncollectedShown|C_ToyBox.GetUncollectedShown]]()
 
: [[API C_ToyBox.GetUncollectedShown|C_ToyBox.GetUncollectedShown]]()
 
: [[API C_ToyBox.GetUnusableShown|C_ToyBox.GetUnusableShown]]()
 
: [[API C_ToyBox.GetUnusableShown|C_ToyBox.GetUnusableShown]]()
Line 1,402: Line 1,413:
 
: [[API C_ToyBox.SetUnusableShown|C_ToyBox.SetUnusableShown]](<span class="apiarg">checked</span>)
 
: [[API C_ToyBox.SetUnusableShown|C_ToyBox.SetUnusableShown]](<span class="apiarg">checked</span>)
 
: [[API C_ToyBoxInfo.ClearFanfare|C_ToyBoxInfo.ClearFanfare]](<span class="apiarg">itemID</span>)
 
: [[API C_ToyBoxInfo.ClearFanfare|C_ToyBoxInfo.ClearFanfare]](<span class="apiarg">itemID</span>)
 
: [[API C_ToyBoxInfo.IsToySourceValid|C_ToyBoxInfo.IsToySourceValid]](<span class="apiarg">source</span>) : <span class="apiret">isToySourceValid</span>
  +
: [[API C_ToyBoxInfo.IsUsingDefaultFilters|C_ToyBoxInfo.IsUsingDefaultFilters]]() : <span class="apiret">isUsingDefaultFilters</span>
 
: [[API C_ToyBoxInfo.NeedsFanfare|C_ToyBoxInfo.NeedsFanfare]](<span class="apiarg">itemID</span>) : <span class="apiret">needsFanfare</span>
 
: [[API C_ToyBoxInfo.NeedsFanfare|C_ToyBoxInfo.NeedsFanfare]](<span class="apiarg">itemID</span>) : <span class="apiret">needsFanfare</span>
  +
: [[API C_ToyBoxInfo.SetDefaultFilters|C_ToyBoxInfo.SetDefaultFilters]]()
 
: [[API PlayerHasToy|PlayerHasToy]](<span class="apiarg">itemID</span>)
 
: [[API PlayerHasToy|PlayerHasToy]](<span class="apiarg">itemID</span>)
 
: [[API UseToy|UseToy]](<span class="apiarg">itemID</span>)
 
: [[API UseToy|UseToy]](<span class="apiarg">itemID</span>)
 
: [[API UseToyByName|UseToyByName]](<span class="apiarg">toyName</span>)
 
: [[API UseToyByName|UseToyByName]](<span class="apiarg">toyName</span>)
   
==== Heirlooms ====
+
====Heirlooms====
 
[[Heirloom]]s were added in [[Patch 3.0.3]] and added to the Collections window in [[Patch 6.1.0]]
 
[[Heirloom]]s were added in [[Patch 3.0.3]] and added to the Collections window in [[Patch 6.1.0]]
 
: [[API C_Heirloom.CanHeirloomUpgradeFromPending|C_Heirloom.CanHeirloomUpgradeFromPending]](<span class="apiarg">itemID</span>)
 
: [[API C_Heirloom.CanHeirloomUpgradeFromPending|C_Heirloom.CanHeirloomUpgradeFromPending]](<span class="apiarg">itemID</span>)
Line 1,423: Line 1,437:
 
: [[API C_Heirloom.GetNumKnownHeirlooms|C_Heirloom.GetNumKnownHeirlooms]]()
 
: [[API C_Heirloom.GetNumKnownHeirlooms|C_Heirloom.GetNumKnownHeirlooms]]()
 
: [[API C_Heirloom.GetUncollectedHeirloomFilter|C_Heirloom.GetUncollectedHeirloomFilter]]()
 
: [[API C_Heirloom.GetUncollectedHeirloomFilter|C_Heirloom.GetUncollectedHeirloomFilter]]()
: [[API C_Heirloom.IsHeirloomSourceValid|C_Heirloom.IsHeirloomSourceValid]](<span class="apiarg">source</span>)
 
 
: [[API C_Heirloom.IsItemHeirloom|C_Heirloom.IsItemHeirloom]](<span class="apiarg">itemID</span>)
 
: [[API C_Heirloom.IsItemHeirloom|C_Heirloom.IsItemHeirloom]](<span class="apiarg">itemID</span>)
 
: [[API C_Heirloom.IsPendingHeirloomUpgrade|C_Heirloom.IsPendingHeirloomUpgrade]]()
 
: [[API C_Heirloom.IsPendingHeirloomUpgrade|C_Heirloom.IsPendingHeirloomUpgrade]]()
Line 1,435: Line 1,448:
 
: [[API C_Heirloom.UpgradeHeirloom|C_Heirloom.UpgradeHeirloom]](<span class="apiarg">itemID</span>)
 
: [[API C_Heirloom.UpgradeHeirloom|C_Heirloom.UpgradeHeirloom]](<span class="apiarg">itemID</span>)
 
: [[API DoesItemContainSpec|DoesItemContainSpec]](<span class="apiarg">item, classID [, specializationID]</span>)
 
: [[API DoesItemContainSpec|DoesItemContainSpec]](<span class="apiarg">item, classID [, specializationID]</span>)
  +
: [[API C_HeirloomInfo.AreAllCollectionFiltersChecked|C_HeirloomInfo.AreAllCollectionFiltersChecked]]() : <span class="apiret">areAllCollectionFiltersChecked</span>
  +
: [[API C_HeirloomInfo.AreAllSourceFiltersChecked|C_HeirloomInfo.AreAllSourceFiltersChecked]]() : <span class="apiret">areAllSourceFiltersChecked</span>
 
: [[API C_HeirloomInfo.IsHeirloomSourceValid|C_HeirloomInfo.IsHeirloomSourceValid]](<span class="apiarg">source</span>) : <span class="apiret">isHeirloomSourceValid</span>
  +
: [[API C_HeirloomInfo.IsUsingDefaultFilters|C_HeirloomInfo.IsUsingDefaultFilters]]() : <span class="apiret">isUsingDefaultFilters</span>
  +
: [[API C_HeirloomInfo.SetAllCollectionFilters|C_HeirloomInfo.SetAllCollectionFilters]](<span class="apiarg">checked</span>)
  +
: [[API C_HeirloomInfo.SetAllSourceFilters|C_HeirloomInfo.SetAllSourceFilters]](<span class="apiarg">checked</span>)
  +
: [[API C_HeirloomInfo.SetDefaultFilters|C_HeirloomInfo.SetDefaultFilters]]()
   
==== Appearances ====
+
====Appearances====
 
The [[Appearances]] tab (also known as the Wardrobe) was added in [[Patch 7.0.3]]. See also [[#Transmogrification|Transmogrification]] functions.
 
The [[Appearances]] tab (also known as the Wardrobe) was added in [[Patch 7.0.3]]. See also [[#Transmogrification|Transmogrification]] functions.
 
: [[API C_TransmogCollection.AccountCanCollectSource|C_TransmogCollection.AccountCanCollectSource]](<span class="apiarg">sourceID</span>) : <span class="apiret">hasItemData, canCollect</span>
 
: [[API C_TransmogCollection.AccountCanCollectSource|C_TransmogCollection.AccountCanCollectSource]](<span class="apiarg">sourceID</span>) : <span class="apiret">hasItemData, canCollect</span>
  +
: [[API C_TransmogCollection.AreAllCollectionTypeFiltersChecked|C_TransmogCollection.AreAllCollectionTypeFiltersChecked]]() : <span class="apiret">areAllCollectionTypeFiltersChecked</span>
  +
: [[API C_TransmogCollection.AreAllSourceTypeFiltersChecked|C_TransmogCollection.AreAllSourceTypeFiltersChecked]]() : <span class="apiret">areAllSourceTypeFiltersChecked</span>
 
: [[API C_TransmogCollection.CanAppearanceHaveIllusion|C_TransmogCollection.CanAppearanceHaveIllusion]](<span class="apiarg">appearanceID</span>) : <span class="apiret">canHaveIllusion</span>
 
: [[API C_TransmogCollection.CanAppearanceHaveIllusion|C_TransmogCollection.CanAppearanceHaveIllusion]](<span class="apiarg">appearanceID</span>) : <span class="apiret">canHaveIllusion</span>
 
: [[API C_TransmogCollection.ClearNewAppearance|C_TransmogCollection.ClearNewAppearance]](<span class="apiarg">visualID</span>)
 
: [[API C_TransmogCollection.ClearNewAppearance|C_TransmogCollection.ClearNewAppearance]](<span class="apiarg">visualID</span>)
Line 1,450: Line 1,472:
 
: [[API C_TransmogCollection.GetAppearanceSourceDrops|C_TransmogCollection.GetAppearanceSourceDrops]](<span class="apiarg">itemModifiedAppearanceID</span>) : <span class="apiret">encounterInfo</span>
 
: [[API C_TransmogCollection.GetAppearanceSourceDrops|C_TransmogCollection.GetAppearanceSourceDrops]](<span class="apiarg">itemModifiedAppearanceID</span>) : <span class="apiret">encounterInfo</span>
 
: [[API C_TransmogCollection.GetAppearanceSourceInfo|C_TransmogCollection.GetAppearanceSourceInfo]](<span class="apiarg">itemModifiedAppearanceID</span>) : <span class="apiret">category, itemAppearanceID, canHaveIllusion, icon, isCollected, ...</span>
 
: [[API C_TransmogCollection.GetAppearanceSourceInfo|C_TransmogCollection.GetAppearanceSourceInfo]](<span class="apiarg">itemModifiedAppearanceID</span>) : <span class="apiret">category, itemAppearanceID, canHaveIllusion, icon, isCollected, ...</span>
: [[API C_TransmogCollection.GetAppearanceSources|C_TransmogCollection.GetAppearanceSources]](<span class="apiarg">appearanceID [, categoryType]</span>) : <span class="apiret">sources</span>
+
: [[API C_TransmogCollection.GetAppearanceSources|C_TransmogCollection.GetAppearanceSources]](<span class="apiarg">appearanceID, categoryType, transmogLocation</span>) : <span class="apiret">sources</span>
 
: [[API C_TransmogCollection.GetArtifactAppearanceStrings|C_TransmogCollection.GetArtifactAppearanceStrings]](<span class="apiarg">appearanceID</span>) : <span class="apiret">name, hyperlink</span>
 
: [[API C_TransmogCollection.GetArtifactAppearanceStrings|C_TransmogCollection.GetArtifactAppearanceStrings]](<span class="apiarg">appearanceID</span>) : <span class="apiret">name, hyperlink</span>
: [[API C_TransmogCollection.GetCategoryAppearances|C_TransmogCollection.GetCategoryAppearances]](<span class="apiarg">category</span>) : <span class="apiret">appearances</span>
+
: [[API C_TransmogCollection.GetCategoryAppearances|C_TransmogCollection.GetCategoryAppearances]](<span class="apiarg">category, transmogLocation</span>) : <span class="apiret">appearances</span>
 
: [[API C_TransmogCollection.GetCategoryCollectedCount|C_TransmogCollection.GetCategoryCollectedCount]](<span class="apiarg">category</span>) : <span class="apiret">count</span>
 
: [[API C_TransmogCollection.GetCategoryCollectedCount|C_TransmogCollection.GetCategoryCollectedCount]](<span class="apiarg">category</span>) : <span class="apiret">count</span>
  +
: [[API C_TransmogCollection.GetCategoryForItem|C_TransmogCollection.GetCategoryForItem]](<span class="apiarg">itemModifiedAppearanceID</span>) : <span class="apiret">collectionCategory</span>
 
: [[API C_TransmogCollection.GetCategoryInfo|C_TransmogCollection.GetCategoryInfo]](<span class="apiarg">category</span>) : <span class="apiret">name, isWeapon, canHaveIllusions, canMainHand, canOffHand</span>
 
: [[API C_TransmogCollection.GetCategoryInfo|C_TransmogCollection.GetCategoryInfo]](<span class="apiarg">category</span>) : <span class="apiret">name, isWeapon, canHaveIllusions, canMainHand, canOffHand</span>
 
: [[API C_TransmogCollection.GetCategoryTotal|C_TransmogCollection.GetCategoryTotal]](<span class="apiarg">category</span>) : <span class="apiret">total</span>
 
: [[API C_TransmogCollection.GetCategoryTotal|C_TransmogCollection.GetCategoryTotal]](<span class="apiarg">category</span>) : <span class="apiret">total</span>
Line 1,485: Line 1,508:
 
: [[API C_TransmogCollection.IsSearchInProgress|C_TransmogCollection.IsSearchInProgress]](<span class="apiarg">searchType</span>) : <span class="apiret">inProgress</span>
 
: [[API C_TransmogCollection.IsSearchInProgress|C_TransmogCollection.IsSearchInProgress]](<span class="apiarg">searchType</span>) : <span class="apiret">inProgress</span>
 
: [[API C_TransmogCollection.IsSourceTypeFilterChecked|C_TransmogCollection.IsSourceTypeFilterChecked]](<span class="apiarg">index</span>) : <span class="apiret">checked</span>
 
: [[API C_TransmogCollection.IsSourceTypeFilterChecked|C_TransmogCollection.IsSourceTypeFilterChecked]](<span class="apiarg">index</span>) : <span class="apiret">checked</span>
  +
: [[API C_TransmogCollection.IsUsingDefaultFilters|C_TransmogCollection.IsUsingDefaultFilters]]() : <span class="apiret">isUsingDefaultFilters</span>
 
: [[API C_TransmogCollection.ModifyOutfit|C_TransmogCollection.ModifyOutfit]](<span class="apiarg">outfitID, itemTransmogInfoList</span>)
 
: [[API C_TransmogCollection.ModifyOutfit|C_TransmogCollection.ModifyOutfit]](<span class="apiarg">outfitID, itemTransmogInfoList</span>)
 
: [[API C_TransmogCollection.NewOutfit|C_TransmogCollection.NewOutfit]](<span class="apiarg">name, icon, itemTransmogInfoList</span>) : <span class="apiret">outfitID</span>
 
: [[API C_TransmogCollection.NewOutfit|C_TransmogCollection.NewOutfit]](<span class="apiarg">name, icon, itemTransmogInfoList</span>) : <span class="apiret">outfitID</span>
Line 1,495: Line 1,519:
 
: [[API C_TransmogCollection.SearchProgress|C_TransmogCollection.SearchProgress]](<span class="apiarg">searchType</span>) : <span class="apiret">progress</span>
 
: [[API C_TransmogCollection.SearchProgress|C_TransmogCollection.SearchProgress]](<span class="apiarg">searchType</span>) : <span class="apiret">progress</span>
 
: [[API C_TransmogCollection.SearchSize|C_TransmogCollection.SearchSize]](<span class="apiarg">searchType</span>) : <span class="apiret">size</span>
 
: [[API C_TransmogCollection.SearchSize|C_TransmogCollection.SearchSize]](<span class="apiarg">searchType</span>) : <span class="apiret">size</span>
  +
: [[API C_TransmogCollection.SetAllCollectionTypeFilters|C_TransmogCollection.SetAllCollectionTypeFilters]](<span class="apiarg">checked</span>)
 
: [[API C_TransmogCollection.SetAllSourceTypeFilters|C_TransmogCollection.SetAllSourceTypeFilters]](<span class="apiarg">checked</span>)
 
: [[API C_TransmogCollection.SetAllSourceTypeFilters|C_TransmogCollection.SetAllSourceTypeFilters]](<span class="apiarg">checked</span>)
 
: [[API C_TransmogCollection.SetCollectedShown|C_TransmogCollection.SetCollectedShown]](<span class="apiarg">shown</span>)
 
: [[API C_TransmogCollection.SetCollectedShown|C_TransmogCollection.SetCollectedShown]](<span class="apiarg">shown</span>)
  +
: [[API C_TransmogCollection.SetDefaultFilters|C_TransmogCollection.SetDefaultFilters]]()
 
: [[API C_TransmogCollection.SetIsAppearanceFavorite|C_TransmogCollection.SetIsAppearanceFavorite]](<span class="apiarg">itemAppearanceID, isFavorite</span>)
 
: [[API C_TransmogCollection.SetIsAppearanceFavorite|C_TransmogCollection.SetIsAppearanceFavorite]](<span class="apiarg">itemAppearanceID, isFavorite</span>)
 
: [[API C_TransmogCollection.SetSearch|C_TransmogCollection.SetSearch]](<span class="apiarg">searchType, searchText</span>) : <span class="apiret">completed</span>
 
: [[API C_TransmogCollection.SetSearch|C_TransmogCollection.SetSearch]](<span class="apiarg">searchType, searchText</span>) : <span class="apiret">completed</span>
Line 1,503: Line 1,529:
 
: [[API C_TransmogCollection.SetUncollectedShown|C_TransmogCollection.SetUncollectedShown]](<span class="apiarg">shown</span>)
 
: [[API C_TransmogCollection.SetUncollectedShown|C_TransmogCollection.SetUncollectedShown]](<span class="apiarg">shown</span>)
 
: [[API C_TransmogCollection.UpdateUsableAppearances|C_TransmogCollection.UpdateUsableAppearances]]()
 
: [[API C_TransmogCollection.UpdateUsableAppearances|C_TransmogCollection.UpdateUsableAppearances]]()
: <small>DEPRECATED</small> [[API C_TransmogCollection.CanSetFavoriteInCategory|C_TransmogCollection.CanSetFavoriteInCategory]](<span class="apiarg">categoryID</span>)
+
: <small>''DEPRECATED''</small> [[API C_TransmogCollection.CanSetFavoriteInCategory|C_TransmogCollection.CanSetFavoriteInCategory]](<span class="apiarg">categoryID</span>)
: <small>DEPRECATED</small> [[API C_TransmogCollection.GetIllusionFallbackWeaponSource|C_TransmogCollection.GetIllusionFallbackWeaponSource]]()
+
: <small>''DEPRECATED''</small> [[API C_TransmogCollection.GetIllusionFallbackWeaponSource|C_TransmogCollection.GetIllusionFallbackWeaponSource]]()
: <small>DEPRECATED</small> [[API C_TransmogCollection.GetIllusionSourceInfo|C_TransmogCollection.GetIllusionSourceInfo]](<span class="apiarg">sourceID</span>) : <span class="apiret">visualID, name, hyperlink, icon</span>
+
: <small>''DEPRECATED''</small> [[API C_TransmogCollection.GetIllusionSourceInfo|C_TransmogCollection.GetIllusionSourceInfo]](<span class="apiarg">sourceID</span>) : <span class="apiret">visualID, name, hyperlink, icon</span>
: <small>DEPRECATED</small> [[API C_TransmogCollection.GetShowMissingSourceInItemTooltips|C_TransmogCollection.GetShowMissingSourceInItemTooltips]]()
+
: <small>''DEPRECATED''</small> [[API C_TransmogCollection.GetShowMissingSourceInItemTooltips|C_TransmogCollection.GetShowMissingSourceInItemTooltips]]()
: <small>DEPRECATED</small> [[API C_TransmogCollection.SetShowMissingSourceInItemTooltips|C_TransmogCollection.SetShowMissingSourceInItemTooltips]](<span class="apiarg">bool</span>)
+
: <small>''DEPRECATED''</small> [[API C_TransmogCollection.SetShowMissingSourceInItemTooltips|C_TransmogCollection.SetShowMissingSourceInItemTooltips]](<span class="apiarg">bool</span>)
 
: [[API C_TransmogSets.ClearLatestSource|C_TransmogSets.ClearLatestSource]]()
 
: [[API C_TransmogSets.ClearLatestSource|C_TransmogSets.ClearLatestSource]]()
 
: [[API C_TransmogSets.ClearNewSource|C_TransmogSets.ClearNewSource]](<span class="apiarg">sourceID</span>)
 
: [[API C_TransmogSets.ClearNewSource|C_TransmogSets.ClearNewSource]](<span class="apiarg">sourceID</span>)
Line 1,532: Line 1,558:
 
: [[API C_TransmogSets.IsNewSource|C_TransmogSets.IsNewSource]](<span class="apiarg">sourceID</span>) : <span class="apiret">isNew</span>
 
: [[API C_TransmogSets.IsNewSource|C_TransmogSets.IsNewSource]](<span class="apiarg">sourceID</span>) : <span class="apiret">isNew</span>
 
: [[API C_TransmogSets.IsSetVisible|C_TransmogSets.IsSetVisible]](<span class="apiarg">transmogSetID</span>) : <span class="apiret">isVisible</span>
 
: [[API C_TransmogSets.IsSetVisible|C_TransmogSets.IsSetVisible]](<span class="apiarg">transmogSetID</span>) : <span class="apiret">isVisible</span>
  +
: [[API C_TransmogSets.IsUsingDefaultBaseSetsFilters|C_TransmogSets.IsUsingDefaultBaseSetsFilters]]() : <span class="apiret">isUsingDefaultBaseSetsFilters</span>
 
: [[API C_TransmogSets.SetBaseSetsFilter|C_TransmogSets.SetBaseSetsFilter]](<span class="apiarg">index, isChecked</span>)
 
: [[API C_TransmogSets.SetBaseSetsFilter|C_TransmogSets.SetBaseSetsFilter]](<span class="apiarg">index, isChecked</span>)
  +
: [[API C_TransmogSets.SetDefaultBaseSetsFilters|C_TransmogSets.SetDefaultBaseSetsFilters]]()
 
: [[API C_TransmogSets.SetHasNewSources|C_TransmogSets.SetHasNewSources]](<span class="apiarg">transmogSetID</span>) : <span class="apiret">hasNewSources</span>
 
: [[API C_TransmogSets.SetHasNewSources|C_TransmogSets.SetHasNewSources]](<span class="apiarg">transmogSetID</span>) : <span class="apiret">hasNewSources</span>
 
: [[API C_TransmogSets.SetHasNewSourcesForSlot|C_TransmogSets.SetHasNewSourcesForSlot]](<span class="apiarg">transmogSetID, slot</span>) : <span class="apiret">hasNewSources</span>
 
: [[API C_TransmogSets.SetHasNewSourcesForSlot|C_TransmogSets.SetHasNewSourcesForSlot]](<span class="apiarg">transmogSetID, slot</span>) : <span class="apiret">hasNewSources</span>
 
: [[API C_TransmogSets.SetIsFavorite|C_TransmogSets.SetIsFavorite]](<span class="apiarg">transmogSetID, isFavorite</span>)
 
: [[API C_TransmogSets.SetIsFavorite|C_TransmogSets.SetIsFavorite]](<span class="apiarg">transmogSetID, isFavorite</span>)
: <small>DEPRECATED</small> [[API C_TransmogSets.GetSetSources|C_TransmogSets.GetSetSources]](<span class="apiarg">setID</span>)
+
: <small>''DEPRECATED''</small> [[API C_TransmogSets.GetSetSources|C_TransmogSets.GetSetSources]](<span class="apiarg">setID</span>)
 
: [[API IsUnitModelReadyForUI|IsUnitModelReadyForUI]](<span class="apiarg">unitToken</span>) : <span class="apiret">isReady</span>
 
: [[API IsUnitModelReadyForUI|IsUnitModelReadyForUI]](<span class="apiarg">unitToken</span>) : <span class="apiret">isReady</span>
   
=== Combat Log ===
+
===Combat Log===
 
Relates to the [[Combat Log]].
 
Relates to the [[Combat Log]].
 
: [[API CombatLogAddFilter|CombatLogAddFilter]](<span class="apiarg">[eList, sourceFlags, destFlags]</span>)
 
: [[API CombatLogAddFilter|CombatLogAddFilter]](<span class="apiarg">[eList, sourceFlags, destFlags]</span>)
Line 1,545: Line 1,573:
 
: [[API CombatLogClearEntries|CombatLogClearEntries]]()
 
: [[API CombatLogClearEntries|CombatLogClearEntries]]()
 
: [[API CombatLogGetCurrentEntry|CombatLogGetCurrentEntry]]()
 
: [[API CombatLogGetCurrentEntry|CombatLogGetCurrentEntry]]()
: [[API CombatLogGetCurrentEventInfo|CombatLogGetCurrentEventInfo]]() - Returns the current {{api|t=e|COMBAT_LOG_EVENT}} values.
+
: [[API CombatLogGetCurrentEventInfo|CombatLogGetCurrentEventInfo]]() - Returns the current {{api|t=e|COMBAT_LOG_EVENT}} payload.
 
: [[API CombatLogGetNumEntries|CombatLogGetNumEntries]]()
 
: [[API CombatLogGetNumEntries|CombatLogGetNumEntries]]()
 
: [[API CombatLogGetRetentionTime|CombatLogGetRetentionTime]]()
 
: [[API CombatLogGetRetentionTime|CombatLogGetRetentionTime]]()
Line 1,552: Line 1,580:
 
: [[API CombatLogSetRetentionTime|CombatLogSetRetentionTime]](<span class="apiarg">seconds</span>)
 
: [[API CombatLogSetRetentionTime|CombatLogSetRetentionTime]](<span class="apiarg">seconds</span>)
 
: [[API CombatLog_Object_IsA|CombatLog_Object_IsA]]()
 
: [[API CombatLog_Object_IsA|CombatLog_Object_IsA]]()
: [[API CombatTextSetActiveUnit|CombatTextSetActiveUnit]](<span class="apiarg">unit</span>) - Changes the entity for which COMBAT_TEXT_UPDATE events fire.
+
: [[API CombatTextSetActiveUnit|CombatTextSetActiveUnit]](<span class="apiarg">unit</span>) - Changes the entity for which {{api|t=e|COMBAT_TEXT_UPDATE}} events fire.
 
: [[API GetCurrentCombatTextEventInfo|GetCurrentCombatTextEventInfo]]()
 
: [[API GetCurrentCombatTextEventInfo|GetCurrentCombatTextEventInfo]]()
   
=== Combat Pets ===
+
===Combat Pets===
 
Relates to [[Combat pet|Combat Pet]]s.
 
Relates to [[Combat pet|Combat Pet]]s.
 
: [[API CancelPetPossess|CancelPetPossess]]()
 
: [[API CancelPetPossess|CancelPetPossess]]()
: <small>PROTECTED</small> [[API CastPetAction|CastPetAction]](<span class="apiarg">index</span>) - Cast the corresponding pet skill.
+
: <small>''PROTECTED''</small> [[API CastPetAction|CastPetAction]](<span class="apiarg">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.
 
: [[API GetCallPetSpellInfo|GetCallPetSpellInfo]](<span class="apiarg">spellID</span>)
 
: [[API GetCallPetSpellInfo|GetCallPetSpellInfo]](<span class="apiarg">spellID</span>)
: [[API GetPetActionCooldown|GetPetActionCooldown]](<span class="apiarg">index</span>) - Returns cooldown information for the pet action at the specificed pet action bar slot.
+
: [[API GetPetActionCooldown|GetPetActionCooldown]](<span class="apiarg">index</span>) - Returns cooldown info for an action on the pet action bar.
: [[API GetPetActionInfo|GetPetActionInfo]](<span class="apiarg">index</span>) - Returns information on the pet action at the specified pet action bar slot.
+
: [[API GetPetActionInfo|GetPetActionInfo]](<span class="apiarg">index</span>) - Returns info for an action on the pet action bar.
 
: [[API GetPetActionSlotUsable|GetPetActionSlotUsable]](<span class="apiarg">slot</span>)
 
: [[API GetPetActionSlotUsable|GetPetActionSlotUsable]](<span class="apiarg">slot</span>)
 
: [[API GetPetActionsUsable|GetPetActionsUsable]]() - Returns a value indicating if the player's pet's actions can be used at this time.
 
: [[API GetPetActionsUsable|GetPetActionsUsable]]() - Returns a value indicating if the player's pet's actions can be used at this time.
: [[API GetPetExperience|GetPetExperience]]() - Returns the pet's current xp, and total xp required for next level.
+
: [[API GetPetExperience|GetPetExperience]]() - Returns the pet's current and total XP required for the next level.
: [[API GetPetFoodTypes|GetPetFoodTypes]]() - Returns a list of the food types the player's pet can eat.
+
: [[API GetPetFoodTypes|GetPetFoodTypes]]() - Returns the food types the pet can eat.
 
: [[API GetPetIcon|GetPetIcon]]() - Returns the path to the texture to use as the icon for the player's pet.
 
: [[API GetPetIcon|GetPetIcon]]() - Returns the path to the texture to use as the icon for the player's pet.
 
: [[API GetPetTimeRemaining|GetPetTimeRemaining]]() - Returns in milliseconds about some timeout for the player's pet.
 
: [[API GetPetTimeRemaining|GetPetTimeRemaining]]() - Returns in milliseconds about some timeout for the player's pet.
: [[API HasPetSpells|HasPetSpells]]() - Returns true if the player has pet spells.
+
: [[API HasPetSpells|HasPetSpells]]() - Returns the number of available abilities for the player's combat pet.
: [[API HasPetUI|HasPetUI]]() - Returns 1 if the player has a pet User Interface.
+
: [[API HasPetUI|HasPetUI]]() - True if the player currently has an active (hunter) pet out.
 
: [[API IsPetActive|IsPetActive]]()
 
: [[API IsPetActive|IsPetActive]]()
: [[API IsPetAttackActive|IsPetAttackActive]]() - Returns true if the pet is currently attacking.
+
: [[API IsPetAttackActive|IsPetAttackActive]]() - True if the pet is currently auto attacking.
 
: [[API PetAbandon|PetAbandon]]() - Permanently abandons your pet.
 
: [[API PetAbandon|PetAbandon]]() - Permanently abandons your pet.
: <small>PROTECTED</small> [[API PetAggressiveMode|PetAggressiveMode]]()
+
: <small>''PROTECTED''</small> [[API PetAggressiveMode|PetAggressiveMode]]()
: <small>PROTECTED</small> [[API PetAssistMode|PetAssistMode]]() - Set your pet to Assist mode.
+
: <small>''PROTECTED''</small> [[API PetAssistMode|PetAssistMode]]() - Set your pet to Assist mode.
: <small>PROTECTED</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]]() - True if the pet can be abandoned.
: <small>PROTECTED</small> [[API PetMoveTo|PetMoveTo]](<span class="apiarg">target</span>)
+
: <small>''PROTECTED''</small> [[API PetMoveTo|PetMoveTo]](<span class="apiarg">target</span>)
 
: [[API PetCanBeDismissed|PetCanBeDismissed]]()
 
: [[API PetCanBeDismissed|PetCanBeDismissed]]()
: [[API PetCanBeRenamed|PetCanBeRenamed]]() - Returns true if the pet can be renamed.
+
: [[API PetCanBeRenamed|PetCanBeRenamed]]() - True if the pet can be renamed.
: <small>PROTECTED</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>PROTECTED</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>PROTECTED</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 class="apiarg">name</span>) - Renames the pet.
+
: [[API PetRename|PetRename]](<span class="apiarg">name</span>) - Renames your pet.
: [[API PetStopAttack|PetStopAttack]]() - Stop the attack of the pet.
+
: [[API PetStopAttack|PetStopAttack]]() - Stops the pet from attacking.
 
: [[API PetUsesPetFrame|PetUsesPetFrame]]()
 
: [[API PetUsesPetFrame|PetUsesPetFrame]]()
: <small>PROTECTED</small> [[API PetWait|PetWait]]() - Instruct your pet to remain still.
+
: <small>''PROTECTED''</small> [[API PetWait|PetWait]]() - Instruct your pet to remain still.
: <small>PROTECTED</small> [[API TogglePetAutocast|TogglePetAutocast]](<span class="apiarg">index</span>) - Toggles whether the specified pet ability should autocast or not.
+
: <small>''PROTECTED''</small> [[API TogglePetAutocast|TogglePetAutocast]](<span class="apiarg">index</span>) - Toggles whether the specified pet ability should autocast or not.
: <small>PROTECTED</small> [[API ToggleSpellAutocast|ToggleSpellAutocast]](<span class="apiarg">spellName | spellId, bookType</span>) - Toggles whether the specified Pet spell should autocast or not.
+
: <small>''PROTECTED''</small> [[API ToggleSpellAutocast|ToggleSpellAutocast]](<span class="apiarg">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]]() - Closes the pet stable window.
: [[API GetStablePetFoodTypes|GetStablePetFoodTypes]](<span class="apiarg">index</span>) - Returns a list of the food types a specific stabled pet can eat.
+
: [[API GetStablePetFoodTypes|GetStablePetFoodTypes]](<span class="apiarg">index</span>) - Returns the food types the specified stabled pet can eat.
 
: [[API GetStablePetInfo|GetStablePetInfo]](<span class="apiarg">index</span>) - Returns information about a specific stabled pet.
 
: [[API GetStablePetInfo|GetStablePetInfo]](<span class="apiarg">index</span>) - Returns information about a specific stabled pet.
 
: [[API IsAtStableMaster|IsAtStableMaster]]()
 
: [[API IsAtStableMaster|IsAtStableMaster]]()
Line 1,602: Line 1,630:
 
: [[API SetPetStablePaperdoll|SetPetStablePaperdoll]](<span class="apiarg">modelObject</span>)
 
: [[API SetPetStablePaperdoll|SetPetStablePaperdoll]](<span class="apiarg">modelObject</span>)
   
=== Controls ===
+
===Controls===
==== Action Bars ====
+
====Action Bars====
 
: [[API C_ActionBar.GetBonusBarIndexForSlot|C_ActionBar.GetBonusBarIndexForSlot]](<span class="apiarg">slotID</span>) : <span class="apiret">bonusBarIndex</span>
 
: [[API C_ActionBar.GetBonusBarIndexForSlot|C_ActionBar.GetBonusBarIndexForSlot]](<span class="apiarg">slotID</span>) : <span class="apiret">bonusBarIndex</span>
 
: [[API C_ActionBar.IsHarmfulAction|C_ActionBar.IsHarmfulAction]](<span class="apiarg">actionID, useNeutral</span>) : <span class="apiret">isHarmful</span>
 
: [[API C_ActionBar.IsHarmfulAction|C_ActionBar.IsHarmfulAction]](<span class="apiarg">actionID, useNeutral</span>) : <span class="apiret">isHarmful</span>
Line 1,611: Line 1,639:
 
: [[API C_ActionBar.ShouldOverrideBarShowHealthBar|C_ActionBar.ShouldOverrideBarShowHealthBar]]() : <span class="apiret">showHealthBar</span>
 
: [[API C_ActionBar.ShouldOverrideBarShowHealthBar|C_ActionBar.ShouldOverrideBarShowHealthBar]]() : <span class="apiret">showHealthBar</span>
 
: [[API C_ActionBar.ShouldOverrideBarShowManaBar|C_ActionBar.ShouldOverrideBarShowManaBar]]() : <span class="apiret">showManaBar</span>
 
: [[API C_ActionBar.ShouldOverrideBarShowManaBar|C_ActionBar.ShouldOverrideBarShowManaBar]]() : <span class="apiret">showManaBar</span>
: <small>NOCOMBAT</small> [[API ChangeActionBarPage|ChangeActionBarPage]](<span class="apiarg">page</span>) - Changes the current action bar page.
+
: <small>''NOCOMBAT''</small> [[API ChangeActionBarPage|ChangeActionBarPage]](<span class="apiarg">page</span>) - Changes the current action bar page.
: [[API GetActionBarPage|GetActionBarPage]]() - Returns the current action bar page. CURRENT_ACTIONBAR_PAGE is obsolete.
+
: [[API GetActionBarPage|GetActionBarPage]]() - Returns the current action bar page.
: [[API GetActionBarToggles|GetActionBarToggles]]() - Returns the toggles for each action bar.
+
: [[API GetActionBarToggles|GetActionBarToggles]]() - Returns the enabled states for the extra action bars.
 
: [[API GetBonusBarIndex|GetBonusBarIndex]]()
 
: [[API GetBonusBarIndex|GetBonusBarIndex]]()
: [[API GetBonusBarOffset|GetBonusBarOffset]]() - Determine which page of bonus actions to show.
+
: [[API GetBonusBarOffset|GetBonusBarOffset]]() - Returns the current bonus action bar index (e.g. for the Rogue stealth bar).
 
: [[API GetExtraBarIndex|GetExtraBarIndex]]()
 
: [[API GetExtraBarIndex|GetExtraBarIndex]]()
 
: [[API GetMultiCastBarIndex|GetMultiCastBarIndex]]()
 
: [[API GetMultiCastBarIndex|GetMultiCastBarIndex]]()
Line 1,629: Line 1,657:
 
: [[API IsPossessBarVisible|IsPossessBarVisible]]()
 
: [[API IsPossessBarVisible|IsPossessBarVisible]]()
 
: [[API PetHasActionBar|PetHasActionBar]]() - Determine if player has a pet with an action bar.
 
: [[API PetHasActionBar|PetHasActionBar]]() - Determine if player has a pet with an action bar.
: [[API SetActionBarToggles|SetActionBarToggles]](<span class="apiarg">show1, show2, show3, show4 [, alwaysShow]</span>) - Set show toggle for each action bar.
+
: [[API SetActionBarToggles|SetActionBarToggles]](<span class="apiarg">show1, show2, show3, show4 [, alwaysShow]</span>) - Sets the visible state for each action bar.
   
==== Action Buttons ====
+
====Action Buttons====
 
: [[API C_ActionBar.FindPetActionButtons|C_ActionBar.FindPetActionButtons]](<span class="apiarg">petActionID</span>) : <span class="apiret">slots</span>
 
: [[API C_ActionBar.FindPetActionButtons|C_ActionBar.FindPetActionButtons]](<span class="apiarg">petActionID</span>) : <span class="apiret">slots</span>
 
: [[API C_ActionBar.FindSpellActionButtons|C_ActionBar.FindSpellActionButtons]](<span class="apiarg">spellID</span>) : <span class="apiret">slots</span>
 
: [[API C_ActionBar.FindSpellActionButtons|C_ActionBar.FindSpellActionButtons]](<span class="apiarg">spellID</span>) : <span class="apiret">slots</span>
Line 1,641: Line 1,669:
 
: [[API C_ActionBar.IsEnabledAutoCastPetAction|C_ActionBar.IsEnabledAutoCastPetAction]](<span class="apiarg">slotID</span>) : <span class="apiret">isEnabledAutoCastPetAction</span>
 
: [[API C_ActionBar.IsEnabledAutoCastPetAction|C_ActionBar.IsEnabledAutoCastPetAction]](<span class="apiarg">slotID</span>) : <span class="apiret">isEnabledAutoCastPetAction</span>
 
: [[API C_ActionBar.ToggleAutoCastPetAction|C_ActionBar.ToggleAutoCastPetAction]](<span class="apiarg">slotID</span>)
 
: [[API C_ActionBar.ToggleAutoCastPetAction|C_ActionBar.ToggleAutoCastPetAction]](<span class="apiarg">slotID</span>)
: [[API ActionHasRange|ActionHasRange]](<span class="apiarg">slot</span>) - Determine if the specified action is a range restriction (1 if yes, nil if no)
+
: [[API ActionHasRange|ActionHasRange]](<span class="apiarg">slot</span>) - True if the action has has a range requirement.
 
: [[API ClickWorldMapActionButton|ClickWorldMapActionButton]]()
 
: [[API ClickWorldMapActionButton|ClickWorldMapActionButton]]()
 
: [[API GetActionAutocast|GetActionAutocast]](<span class="apiarg">slot</span>)
 
: [[API GetActionAutocast|GetActionAutocast]](<span class="apiarg">slot</span>)
 
: [[API GetActionCharges|GetActionCharges]](<span class="apiarg">slot</span>) - Returns information about the charges of a charge-accumulating player ability.
 
: [[API GetActionCharges|GetActionCharges]](<span class="apiarg">slot</span>) - Returns information about the charges of a charge-accumulating player ability.
: [[API GetActionCooldown|GetActionCooldown]](<span class="apiarg">slot</span>) - This returns the cooldown values of the specified action.
+
: [[API GetActionCooldown|GetActionCooldown]](<span class="apiarg">slot</span>) - Returns cooldown info for the specified action slot.
: [[API GetActionCount|GetActionCount]](<span class="apiarg">slot</span>) - Get the count (bandage/potion/etc) for an action, returns 0 if none or not applicable.
+
: [[API GetActionCount|GetActionCount]](<span class="apiarg">slot</span>) - Returns the available number of uses for an action.
: [[API GetActionInfo|GetActionInfo]](<span class="apiarg">slot</span>) - Returns type, id, subtype.
+
: [[API GetActionInfo|GetActionInfo]](<span class="apiarg">slot</span>) - Returns info for an action.
: [[API GetActionTexture|GetActionTexture]](<span class="apiarg">slot</span>) - Gets the texture path for the specified action.
+
: [[API GetActionText|GetActionText]](<span class="apiarg">slot</span>) - Returns the label text for an action.
: [[API GetActionText|GetActionText]](<span class="apiarg">slot</span>) - Get the text label (macros, etc) for an action, returns nil if none.
+
: [[API GetActionTexture|GetActionTexture]](<span class="apiarg">slot</span>) - Returns the icon texture for an action.
: [[API GetPossessInfo|GetPossessInfo]](<span class="apiarg">index</span>) - Returns texture, name, enabled.
+
: [[API GetPossessInfo|GetPossessInfo]](<span class="apiarg">index</span>) - Returns info for an action on the possession bar.
 
: [[API GetWorldMapActionButtonSpellInfo|GetWorldMapActionButtonSpellInfo]]()
 
: [[API GetWorldMapActionButtonSpellInfo|GetWorldMapActionButtonSpellInfo]]()
: [[API HasAction|HasAction]](<span class="apiarg">slot</span>) - Returns 1 if the player has an action in the specified slot, nil otherwise.
+
: [[API HasAction|HasAction]](<span class="apiarg">slot</span>) - True if an action slot is occupied.
: [[API IsActionInRange|IsActionInRange]](<span class="apiarg">slot</span>) - Test if an action is in range (1=yes, 0=no, nil=not applicable).
+
: [[API IsActionInRange|IsActionInRange]](<span class="apiarg">slot</span>) - True if the specified action is in range.
: [[API IsAttackAction|IsAttackAction]](<span class="apiarg">slot</span>) - Returns 1 if an action is an 'attack' action (flashes during combat), nil otherwise.
+
: [[API IsAttackAction|IsAttackAction]](<span class="apiarg">slot</span>) - True if an action is the "Auto Attack" action.
: [[API IsAutoRepeatAction|IsAutoRepeatAction]](<span class="apiarg">slot</span>) - Returns 1 if an action is auto-repeating, nil otherwise.
+
: [[API IsAutoRepeatAction|IsAutoRepeatAction]](<span class="apiarg">slot</span>) - True if an action is currently auto-repeating (e.g. Shoot for wand and Auto Shot for Hunters).
: [[API IsConsumableAction|IsConsumableAction]](<span class="apiarg">slot</span>) - Returns 1 if an action is consumable (i.e. has a count), nil otherwise.
+
: [[API IsConsumableAction|IsConsumableAction]](<span class="apiarg">slot</span>) - True if an action is a consumable, i.e. it has a count.
: [[API IsCurrentAction|IsCurrentAction]](<span class="apiarg">slot</span>) - Returns 1 if an action is the one currently underway, nil otherwise.
+
: [[API IsCurrentAction|IsCurrentAction]](<span class="apiarg">slot</span>) - True if the specified action is currently being used.
: [[API IsEquippedAction|IsEquippedAction]](<span class="apiarg">slot</span>) - Returns 1 if an action is equipped (i.e. connected to an item that must be equipped), nil otherwise.
+
: [[API IsEquippedAction|IsEquippedAction]](<span class="apiarg">slot</span>) - True if the specified action slot is an equipped item.
 
: [[API IsItemAction|IsItemAction]](<span class="apiarg">slot</span>)
 
: [[API IsItemAction|IsItemAction]](<span class="apiarg">slot</span>)
 
: [[API IsPetAttackAction|IsPetAttackAction]](<span class="apiarg">index</span>)
 
: [[API IsPetAttackAction|IsPetAttackAction]](<span class="apiarg">index</span>)
 
: [[API IsStackableAction|IsStackableAction]](<span class="apiarg">slot</span>)
 
: [[API IsStackableAction|IsStackableAction]](<span class="apiarg">slot</span>)
: [[API IsUsableAction|IsUsableAction]](<span class="apiarg">slot</span>) - Returns 1 if an action can be used at present, nil otherwise.
+
: [[API IsUsableAction|IsUsableAction]](<span class="apiarg">slot</span>) - True if the character can currently use the specified action (sufficient mana, reagents and not on cooldown).
 
: [[API SetActionUIButton|SetActionUIButton]](<span class="apiarg">checkboxFrame, actionSlot, cooldownFrame</span>)
 
: [[API SetActionUIButton|SetActionUIButton]](<span class="apiarg">checkboxFrame, actionSlot, cooldownFrame</span>)
 
: [[API SetSpellbookPetAction|SetSpellbookPetAction]](<span class="apiarg">slot, target</span>)
 
: [[API SetSpellbookPetAction|SetSpellbookPetAction]](<span class="apiarg">slot, target</span>)
: <small>PROTECTED</small> [[API UseAction|UseAction]](<span class="apiarg">slot [, checkCursor, onSelf]</span>) - This instructs the interface to use the action associated with the specified ID, optionally on the player (regardless of target).
+
: <small>''PROTECTED''</small> [[API UseAction|UseAction]](<span class="apiarg">slot [, checkCursor, onSelf]</span>) - Perform the action in the specified action slot.
 
: [[API UseWorldMapActionButtonSpellOnQuest|UseWorldMapActionButtonSpellOnQuest]]()
 
: [[API UseWorldMapActionButtonSpellOnQuest|UseWorldMapActionButtonSpellOnQuest]]()
 
Flyout Buttons
 
Flyout Buttons
Line 1,677: Line 1,705:
 
: [[API GetNumFlyouts|GetNumFlyouts]]()
 
: [[API GetNumFlyouts|GetNumFlyouts]]()
   
==== Key Bindings ====
+
====Key Bindings====
 
Relates to [[Key Bindings]].
 
Relates to [[Key Bindings]].
 
: [[API C_KeyBindings.GetCustomBindingType|C_KeyBindings.GetCustomBindingType]](<span class="apiarg">bindingIndex</span>) : <span class="apiret">customBindingType</span> - Returns the type of a custom binding.
 
: [[API C_KeyBindings.GetCustomBindingType|C_KeyBindings.GetCustomBindingType]](<span class="apiarg">bindingIndex</span>) : <span class="apiret">customBindingType</span> - Returns the type of a custom binding.
: [[API GetBinding|GetBinding]](<span class="apiarg">index</span>) - Get action and key bindings for that index.
+
: [[API GetBinding|GetBinding]](<span class="apiarg">index</span>) - Returns the name and keys for a binding by index.
: [[API GetBindingAction|GetBindingAction]](<span class="apiarg">key [, checkOverride]</span>) - Get the action bound to that key.
+
: [[API GetBindingAction|GetBindingAction]](<span class="apiarg">key [, checkOverride]</span>) - Returns the binding name for a key (combination).
 
: [[API GetBindingByKey|GetBindingByKey]](<span class="apiarg">action [, mode]</span>)
 
: [[API GetBindingByKey|GetBindingByKey]](<span class="apiarg">action [, mode]</span>)
: [[API GetBindingKey|GetBindingKey]](<span class="apiarg">command</span>) - Get the key(s) bound to that action.
+
: [[API GetBindingKey|GetBindingKey]](<span class="apiarg">command</span>) - [Returns the binding name for a key (combination). Discards key modifiers until it finds a binding.
: [[API GetBindingText|GetBindingText]](<span class="apiarg">[key, prefix, abbreviate]</span>) - Gets the string value for the key.
+
: [[API GetBindingText|GetBindingText]](<span class="apiarg">[key, prefix, abbreviate]</span>) - Returns the string for the given key and prefix. Essentially a specialized getglobal() for bindings.
: [[API GetCurrentBindingSet|GetCurrentBindingSet]]() - Queries if current set of key bindings is character or account specific.
+
: [[API GetCurrentBindingSet|GetCurrentBindingSet]]() - Returns if either account or character-specific bindings are active.
: [[API GetNumBindings|GetNumBindings]]() - Get total number key bindings and headers.
+
: [[API GetNumBindings|GetNumBindings]]() - Returns the number of bindings and headers in the key bindings window.
: [[API LoadBindings|LoadBindings]](<span class="apiarg">which</span>) - Loads default, account or character specific key binding set into memory from disk.
+
: [[API LoadBindings|LoadBindings]](<span class="apiarg">which</span>) - Loads default, account or character specific key bindings.
: [[API RunBinding|RunBinding]](<span class="apiarg">command [, up]</span>) - Executes the key binding named "command".
+
: [[API RunBinding|RunBinding]](<span class="apiarg">command [, up]</span>) - Executes a key binding.
: [[API SaveBindings|SaveBindings]](<span class="apiarg">which</span>) - Saves account or character specific key bindings from memory to disk.
+
: [[API SaveBindings|SaveBindings]](<span class="apiarg">which</span>) - Saves account or character specific key bindings.
: <small>NOCOMBAT</small> [[API SetBinding|SetBinding]](<span class="apiarg">key [, command, mode]</span>) - Sets or unsets key bindings. (Can not be used in combat.)
+
: <small>''NOCOMBAT''</small> [[API SetBinding|SetBinding]](<span class="apiarg">key [, command, mode]</span>) - Sets a key binding to an action.
: <small>NOCOMBAT</small> [[API SetBindingSpell|SetBindingSpell]](<span class="apiarg">key, spellName</span>) - Set a key binding directly to a spell, uses the same spell name syntax as /cast.
+
: <small>''NOCOMBAT''</small> [[API SetBindingSpell|SetBindingSpell]](<span class="apiarg">key, spellName</span>) - Sets a binding to cast the specified spell.
: <small>NOCOMBAT</small> [[API SetBindingClick|SetBindingClick]](<span class="apiarg">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 SetBindingClick|SetBindingClick]](<span class="apiarg">key, ButtonName [, mouseButton]</span>) - Sets a binding to click the specified Button widget.
: <small>NOCOMBAT</small> [[API SetBindingItem|SetBindingItem]](<span class="apiarg">key, itemname</span>)
+
: <small>''NOCOMBAT''</small> [[API SetBindingItem|SetBindingItem]](<span class="apiarg">key, itemname</span>)
: <small>NOCOMBAT</small> [[API SetBindingMacro|SetBindingMacro]](<span class="apiarg">key, macroname or macroId</span>)
+
: <small>''NOCOMBAT''</small> [[API SetBindingMacro|SetBindingMacro]](<span class="apiarg">key, macroname or macroId</span>)
: <small>NOCOMBAT</small> [[API SetOverrideBinding|SetOverrideBinding]](<span class="apiarg">owner, isPriority, key [, command]</span>) - Set (or clear) an override key binding.
+
: <small>''NOCOMBAT''</small> [[API SetOverrideBinding|SetOverrideBinding]](<span class="apiarg">owner, isPriority, key [, command]</span>) - Sets an override key binding.
: <small>NOCOMBAT</small> [[API SetOverrideBindingSpell|SetOverrideBindingSpell]](<span class="apiarg">owner, isPriority, key, spellname</span>)
+
: <small>''NOCOMBAT''</small> [[API SetOverrideBindingSpell|SetOverrideBindingSpell]](<span class="apiarg">owner, isPriority, key, spellname</span>)
: <small>NOCOMBAT</small> [[API SetOverrideBindingClick|SetOverrideBindingClick]](<span class="apiarg">owner, isPriority, key, buttonName [, mouseClick]</span>) - Sets an override binding that acts like a mouse click on a button.
+
: <small>''NOCOMBAT''</small> [[API SetOverrideBindingClick|SetOverrideBindingClick]](<span class="apiarg">owner, isPriority, key, buttonName [, mouseClick]</span>) - Sets an override binding that performs a button click.
: <small>NOCOMBAT</small> [[API SetOverrideBindingItem|SetOverrideBindingItem]](<span class="apiarg">owner, isPriority, key, itemname</span>)
+
: <small>''NOCOMBAT''</small> [[API SetOverrideBindingItem|SetOverrideBindingItem]](<span class="apiarg">owner, isPriority, key, itemname</span>)
: <small>NOCOMBAT</small> [[API SetOverrideBindingMacro|SetOverrideBindingMacro]](<span class="apiarg">owner, isPriority, key, macroname or macroId</span>)
+
: <small>''NOCOMBAT''</small> [[API SetOverrideBindingMacro|SetOverrideBindingMacro]](<span class="apiarg">owner, isPriority, key, macroname or macroId</span>)
: <small>NOCOMBAT</small> [[API ClearOverrideBindings|ClearOverrideBindings]](<span class="apiarg">owner</span>) - Reset all overrides belonging to an owner.
+
: <small>''NOCOMBAT''</small> [[API ClearOverrideBindings|ClearOverrideBindings]](<span class="apiarg">owner</span>) - Removes all override bindings owned by a specific frame.
 
: [[API SetMouselookOverrideBinding|SetMouselookOverrideBinding]](<span class="apiarg">key [, command]</span>)
 
: [[API SetMouselookOverrideBinding|SetMouselookOverrideBinding]](<span class="apiarg">key [, command]</span>)
   
==== Click Bindings ====
+
====Click Bindings====
 
: [[API C_ClickBindings.CanSpellBeClickBound|C_ClickBindings.CanSpellBeClickBound]](<span class="apiarg">spellID</span>) : <span class="apiret">canBeBound</span>
 
: [[API C_ClickBindings.CanSpellBeClickBound|C_ClickBindings.CanSpellBeClickBound]](<span class="apiarg">spellID</span>) : <span class="apiret">canBeBound</span>
 
: [[API C_ClickBindings.ExecuteBinding|C_ClickBindings.ExecuteBinding]](<span class="apiarg">targetToken, button, modifiers</span>)
 
: [[API C_ClickBindings.ExecuteBinding|C_ClickBindings.ExecuteBinding]](<span class="apiarg">targetToken, button, modifiers</span>)
Line 1,716: Line 1,744:
 
: [[API C_ClickBindings.SetTutorialShown|C_ClickBindings.SetTutorialShown]]()
 
: [[API C_ClickBindings.SetTutorialShown|C_ClickBindings.SetTutorialShown]]()
   
==== Key Modifiers ====
+
====Key Modifiers====
 
: [[API GetModifiedClick|GetModifiedClick]](<span class="apiarg">action</span>)
 
: [[API GetModifiedClick|GetModifiedClick]](<span class="apiarg">action</span>)
 
: [[API GetModifiedClickAction|GetModifiedClickAction]](<span class="apiarg">index</span>)
 
: [[API GetModifiedClickAction|GetModifiedClickAction]](<span class="apiarg">index</span>)
: [[API GetMouseButtonClicked|GetMouseButtonClicked]]() - Returns the name of the button that triggered a mouse down/up/click/doubleclick event.
+
: [[API GetMouseButtonClicked|GetMouseButtonClicked]]() - Returns the mouse button responsible during an OnClick event (e.g. "RightButton").
 
: [[API GetNumModifiedClickActions|GetNumModifiedClickActions]]()
 
: [[API GetNumModifiedClickActions|GetNumModifiedClickActions]]()
 
: [[API IsAltKeyDown|IsAltKeyDown]]() - Returns true if the alt key is currently depressed.
 
: [[API IsAltKeyDown|IsAltKeyDown]]() - Returns true if the alt key is currently depressed.
Line 1,729: Line 1,757:
 
: [[API IsLeftShiftKeyDown|IsLeftShiftKeyDown]]() - Returns true if the left shift key is currently depressed.
 
: [[API IsLeftShiftKeyDown|IsLeftShiftKeyDown]]() - Returns true if the left shift key is currently depressed.
 
: [[API IsMetaKeyDown|IsMetaKeyDown]]()
 
: [[API IsMetaKeyDown|IsMetaKeyDown]]()
: [[API IsModifiedClick|IsModifiedClick]](<span class="apiarg">action</span>) - Returns 1 if the keys for the specified action are down, nil otherwise.
+
: [[API IsModifiedClick|IsModifiedClick]](<span class="apiarg">action</span>) - True if the modifier key needed for an an action is pressed.
: [[API IsModifierKeyDown|IsModifierKeyDown]]() - Equivalent to (IsShiftKeyDown() or IsControlKeyDown() or IsAltKeyDown()).
+
: [[API IsModifierKeyDown|IsModifierKeyDown]]() - True if any modifier key is currently pressed.
 
: [[API IsMouseButtonDown|IsMouseButtonDown]](<span class="apiarg">[button]</span>)
 
: [[API IsMouseButtonDown|IsMouseButtonDown]](<span class="apiarg">[button]</span>)
 
: [[API IsRightAltKeyDown|IsRightAltKeyDown]]() - Returns true if the right alt key is currently depressed.
 
: [[API IsRightAltKeyDown|IsRightAltKeyDown]]() - Returns true if the right alt key is currently depressed.
Line 1,739: Line 1,767:
 
: [[API SetModifiedClick|SetModifiedClick]](<span class="apiarg">action, binding</span>)
 
: [[API SetModifiedClick|SetModifiedClick]](<span class="apiarg">action, binding</span>)
   
==== Cursor ====
+
====Cursor====
 
Relates to the [[Cursor]].
 
Relates to the [[Cursor]].
 
: [[API C_CurrencyInfo.PickupCurrency|C_CurrencyInfo.PickupCurrency]](<span class="apiarg">type</span>)
 
: [[API C_CurrencyInfo.PickupCurrency|C_CurrencyInfo.PickupCurrency]](<span class="apiarg">type</span>)
: [[API AutoEquipCursorItem|AutoEquipCursorItem]]() - Causes the equipment on the cursor to be equipped.
+
: [[API AutoEquipCursorItem|AutoEquipCursorItem]]() - Equips the item currently held by the cursor.
: [[API ClearCursor|ClearCursor]]() - Clears whatever item the cursor is dragging from the cursor.
+
: [[API ClearCursor|ClearCursor]]() - Clears any objects from the cursor.
 
: [[API ClickSocketButton|ClickSocketButton]](<span class="apiarg">id</span>) - If the cursor is currently holding a gem, tentatively insert it into the socket.
 
: [[API ClickSocketButton|ClickSocketButton]](<span class="apiarg">id</span>) - If the cursor is currently holding a gem, tentatively insert it into the socket.
: [[API CursorCanGoInSlot|CursorCanGoInSlot]](<span class="apiarg">invSlot</span>) - Returns true if the item currently held by the cursor can go into the given inventory (equipment) slot.
+
: [[API CursorCanGoInSlot|CursorCanGoInSlot]](<span class="apiarg">invSlot</span>) - True if the item held by the cursor can be equipped in the specified (equipment) inventory slot.
: [[API CursorHasItem|CursorHasItem]]() - Returns true if the cursor currently holds an item.
+
: [[API CursorHasItem|CursorHasItem]]() - True if the cursor currently holds an item.
 
: [[API CursorHasMacro|CursorHasMacro]]() - Returns 1 if the cursor is currently dragging a macro.
 
: [[API CursorHasMacro|CursorHasMacro]]() - Returns 1 if the cursor is currently dragging a macro.
 
: [[API CursorHasMoney|CursorHasMoney]]() - Returns true if the cursor currently holds money.
 
: [[API CursorHasMoney|CursorHasMoney]]() - Returns true if the cursor currently holds money.
 
: [[API CursorHasSpell|CursorHasSpell]]() - Returns true if the cursor currently holds a spell.
 
: [[API CursorHasSpell|CursorHasSpell]]() - Returns true if the cursor currently holds a spell.
: <small>HW, SCRIPT</small> [[API DeleteCursorItem|DeleteCursorItem]]() - Destroys the item on the cursor.
+
: <small>''HW, SCRIPT''</small> [[API DeleteCursorItem|DeleteCursorItem]]() - Destroys the item held by the cursor.
: [[API DropCursorMoney|DropCursorMoney]]() - Drops the amount of money held by the cursor.
+
: [[API DropCursorMoney|DropCursorMoney]]() - Drops money held by the cursor back into your bag.
: [[API DropItemOnUnit|DropItemOnUnit]](<span class="apiarg">unit</span>) - Drops an item from the cursor onto a unit.
+
: [[API DropItemOnUnit|DropItemOnUnit]](<span class="apiarg">unit</span>) - Drops an item from the cursor onto a unit, i.e. to initiate a trade.
 
: [[API EquipCursorItem|EquipCursorItem]](<span class="apiarg">invSlot</span>) - Equips the currently picked up item to a specific inventory slot.
 
: [[API EquipCursorItem|EquipCursorItem]](<span class="apiarg">invSlot</span>) - Equips the currently picked up item to a specific inventory slot.
 
: [[API GetCursorDelta|GetCursorDelta]]()
 
: [[API GetCursorDelta|GetCursorDelta]]()
: [[API GetCursorInfo|GetCursorInfo]]() - Returns information about what the cursor is holding.
+
: [[API GetCursorInfo|GetCursorInfo]]() - Returns what the mouse cursor is holding.
 
: [[API GetCursorMoney|GetCursorMoney]]() - Returns the amount of money held by the cursor.
 
: [[API GetCursorMoney|GetCursorMoney]]() - Returns the amount of money held by the cursor.
 
: [[API GetCursorPosition|GetCursorPosition]]() - Returns the cursor's position on the screen.
 
: [[API GetCursorPosition|GetCursorPosition]]() - Returns the cursor's position on the screen.
: [[API HideRepairCursor|HideRepairCursor]]() - Hides the repair cursor.
+
: [[API HideRepairCursor|HideRepairCursor]]() - Takes the cursor out of repair mode.
: [[API InRepairMode|InRepairMode]]() - Returns true if your cursor is in repair mode.
+
: [[API InRepairMode|InRepairMode]]() - True if the cursor is in repair mode.
: [[API PickupAction|PickupAction]](<span class="apiarg">slot</span>) - Drags an action out of the specified quickbar slot and holds it on the cursor.
+
: [[API PickupAction|PickupAction]](<span class="apiarg">slot</span>) - Places an action onto the cursor.
 
: [[API PickupBagFromSlot|PickupBagFromSlot]](<span class="apiarg">slot</span>) - Picks up the bag from the specified slot, placing it in the cursor.
 
: [[API PickupBagFromSlot|PickupBagFromSlot]](<span class="apiarg">slot</span>) - Picks up the bag from the specified slot, placing it in the cursor.
: [[API PickupCompanion|PickupCompanion]](<span class="apiarg">type, index</span>) - Picks up the indexed companion onto the mouse cursor.
+
: [[API PickupCompanion|PickupCompanion]](<span class="apiarg">type, index</span>) - Places a mount onto the cursor.
 
: [[API PickupContainerItem|PickupContainerItem]](<span class="apiarg">bagID, slot</span>)
 
: [[API PickupContainerItem|PickupContainerItem]](<span class="apiarg">bagID, slot</span>)
 
: [[API PickupGuildBankItem|PickupGuildBankItem]](<span class="apiarg">tab, slot</span>) - Picks up an item from the guild bank.
 
: [[API PickupGuildBankItem|PickupGuildBankItem]](<span class="apiarg">tab, slot</span>) - Picks up an item from the guild bank.
 
: [[API PickupGuildBankMoney|PickupGuildBankMoney]](<span class="apiarg">money</span>) - Picks up "money" copper from the guild bank.
 
: [[API PickupGuildBankMoney|PickupGuildBankMoney]](<span class="apiarg">money</span>) - Picks up "money" copper from the guild bank.
: [[API PickupInventoryItem|PickupInventoryItem]](<span class="apiarg">invSlot</span>) - Picks up an item from the player's worn inventory.
+
: [[API PickupInventoryItem|PickupInventoryItem]](<span class="apiarg">invSlot</span>) - Picks up / interacts with an equipment slot.
 
: [[API PickupItem|PickupItem]](<span class="apiarg">item</span>)
 
: [[API PickupItem|PickupItem]](<span class="apiarg">item</span>)
: [[API PickupMacro|PickupMacro]](<span class="apiarg">macroName or index</span>) - Places the specified macro onto the cursor.
+
: [[API PickupMacro|PickupMacro]](<span class="apiarg">macroName or index</span>) - Places a macro onto the cursor.
: [[API PickupMerchantItem|PickupMerchantItem]](<span class="apiarg">index</span>) - Places the item onto the cursor. If the cursor already has an item, the item in the cursor will be sold.
+
: [[API PickupMerchantItem|PickupMerchantItem]](<span class="apiarg">index</span>) - Places a merchant item onto the cursor. If the cursor already has an item, it will be sold.
: [[API PickupPetAction|PickupPetAction]](<span class="apiarg">slot</span>) - Drags an action from the specified pet action bar slot into the cursor.
+
: [[API PickupPetAction|PickupPetAction]](<span class="apiarg">slot</span>) - Places a pet action onto the cursor.
 
: [[API PickupPetSpell|PickupPetSpell]](<span class="apiarg">spellID</span>)
 
: [[API PickupPetSpell|PickupPetSpell]](<span class="apiarg">spellID</span>)
: [[API PickupPlayerMoney|PickupPlayerMoney]](<span class="apiarg">copper</span>) - Picks up an amount of money from the player.
+
: [[API PickupPlayerMoney|PickupPlayerMoney]](<span class="apiarg">copper</span>) - Picks up an amount of money from the player onto the cursor.
 
: [[API PickupPvpTalent|PickupPvpTalent]]()
 
: [[API PickupPvpTalent|PickupPvpTalent]]()
: [[API PickupSpell|PickupSpell]](<span class="apiarg">spellID</span>) - Places the specified spell onto the cursor.
+
: [[API PickupSpell|PickupSpell]](<span class="apiarg">spellID</span>) - Places a spell onto the cursor.
 
: [[API PickupSpellBookItem|PickupSpellBookItem]](<span class="apiarg">spellSlot</span>)
 
: [[API PickupSpellBookItem|PickupSpellBookItem]](<span class="apiarg">spellSlot</span>)
 
: [[API PickupStablePet|PickupStablePet]](<span class="apiarg">index</span>)
 
: [[API PickupStablePet|PickupStablePet]](<span class="apiarg">index</span>)
 
: [[API PickupTalent|PickupTalent]](<span class="apiarg">talentID</span>) - Grabs the selected talent spell for placement on an action bar.
 
: [[API PickupTalent|PickupTalent]](<span class="apiarg">talentID</span>) - Grabs the selected talent spell for placement on an action bar.
: [[API PickupTradeMoney|PickupTradeMoney]](<span class="apiarg">copper</span>) - Picks up an amount of money from the player's trade offer.
+
: [[API PickupTradeMoney|PickupTradeMoney]](<span class="apiarg">copper</span>) - Places an amount of money from the player's trade offer onto the cursor.
: [[API PlaceAction|PlaceAction]](<span class="apiarg">slot</span>) - Drops an action from the cursor into the specified quickbar slot.
+
: [[API PlaceAction|PlaceAction]](<span class="apiarg">slot</span>) - Places an action onto into the specified action slot.
 
: [[API ResetCursor|ResetCursor]]()
 
: [[API ResetCursor|ResetCursor]]()
 
: [[API SellCursorItem|SellCursorItem]]()
 
: [[API SellCursorItem|SellCursorItem]]()
: [[API SetCursor|SetCursor]](<span class="apiarg">cursor</span>) - Path to a texture to use as the cursor image (must be 32x32 pixels) or one of the built-in cursor tokens or nil.
+
: [[API SetCursor|SetCursor]](<span class="apiarg">cursor</span>) - Sets the current cursor texture.
 
: [[API ShowBuybackSellCursor|ShowBuybackSellCursor]](<span class="apiarg">index</span>)
 
: [[API ShowBuybackSellCursor|ShowBuybackSellCursor]](<span class="apiarg">index</span>)
 
: [[API ShowContainerSellCursor|ShowContainerSellCursor]](<span class="apiarg">index, slot</span>)
 
: [[API ShowContainerSellCursor|ShowContainerSellCursor]](<span class="apiarg">index, slot</span>)
Line 1,788: Line 1,816:
 
: [[API ShowRepairCursor|ShowRepairCursor]]()
 
: [[API ShowRepairCursor|ShowRepairCursor]]()
   
==== Camera ====
+
====Camera====
: <small>PROTECTED</small> [[API CameraOrSelectOrMoveStart|CameraOrSelectOrMoveStart]]() - Begin "Left click" in the 3D world.
+
: <small>''PROTECTED''</small> [[API CameraOrSelectOrMoveStart|CameraOrSelectOrMoveStart]]() - Begin "Left click" in the 3D world.
: <small>PROTECTED</small> [[API CameraOrSelectOrMoveStop|CameraOrSelectOrMoveStop]](<span class="apiarg">[stickyFlag]</span>) - End "Left click" in the 3D world.
+
: <small>''PROTECTED''</small> [[API CameraOrSelectOrMoveStop|CameraOrSelectOrMoveStop]](<span class="apiarg">[stickyFlag]</span>) - Called when you release the "Left-Click" mouse button.
: [[API CameraZoomIn|CameraZoomIn]](<span class="apiarg">increment</span>) - Zooms the camera into the viewplane by increment.
+
: [[API CameraZoomIn|CameraZoomIn]](<span class="apiarg">increment</span>) - Zooms the camera in.
: [[API CameraZoomOut|CameraZoomOut]](<span class="apiarg">increment</span>) - Zooms the camera out of the viewplane by increment.
+
: [[API CameraZoomOut|CameraZoomOut]](<span class="apiarg">increment</span>) - Zooms the camera out.
 
: [[API CenterCamera|CenterCamera]]()
 
: [[API CenterCamera|CenterCamera]]()
: [[API FlipCameraYaw|FlipCameraYaw]](<span class="apiarg">degrees</span>) - Rotates the camera about the Z-axis by the angle amount specified in degrees.
+
: [[API FlipCameraYaw|FlipCameraYaw]](<span class="apiarg">degrees</span>) - Rotates the camera around the Z-axis.
: [[API GetCameraZoom|GetCameraZoom]]() - Returns the current zoom level, ignoring camera collisions.
+
: [[API GetCameraZoom|GetCameraZoom]]() - Returns the current zoom level of the camera.
: [[API IsMouselooking|IsMouselooking]]() - Returns 1 if mouselook is currently active, nil otherwise.
+
: [[API IsMouselooking|IsMouselooking]]() - True if the player is currently in mouselook mode.
: [[API MouselookStart|MouselookStart]]() - Enters mouse look mode; mouse movement is used to adjust movement/facing direction.
+
: [[API MouselookStart|MouselookStart]]() - Enters mouse look mode; alters the character's movement/facing direction.
: [[API MouselookStop|MouselookStop]]() - Exits mouse look mode; mouse movement is used to move the mouse cursor.
+
: [[API MouselookStop|MouselookStop]]() - Exits mouse look mode.
: [[API MoveViewDownStart|MoveViewDownStart]]() - Begins rotating the camera downward.
+
: [[API MoveViewDownStart|MoveViewDownStart]]() - Starts rotating the camera downward.
: [[API MoveViewDownStop|MoveViewDownStop]]() - Stops rotating the camera after [[API MoveViewDownStart|MoveViewDownStart]]() is called.
+
: [[API MoveViewDownStop|MoveViewDownStop]]() - Stops rotating the camera downward.
 
: [[API MoveViewInStart|MoveViewInStart]]() - Begins zooming the camera in.
 
: [[API MoveViewInStart|MoveViewInStart]]() - Begins zooming the camera in.
: [[API MoveViewInStop|MoveViewInStop]]() - Stops zooming the camera in after [[API MoveViewInStart|MoveViewInStart]]() is called.
+
: [[API MoveViewInStop|MoveViewInStop]]() - Stops zooming the camera in.
: [[API MoveViewLeftStart|MoveViewLeftStart]]() - Begins rotating the camera to the Left.
+
: [[API MoveViewLeftStart|MoveViewLeftStart]]() - Starts rotating the camera to the left.
: [[API MoveViewLeftStop|MoveViewLeftStop]]() - Stops rotating the camera after [[API MoveViewLeftStart|MoveViewLeftStart]]() is called.
+
: [[API MoveViewLeftStop|MoveViewLeftStop]]() - Stops rotating the camera to the left.
 
: [[API MoveViewOutStart|MoveViewOutStart]]() - Begins zooming the camera out.
 
: [[API MoveViewOutStart|MoveViewOutStart]]() - Begins zooming the camera out.
: [[API MoveViewOutStop|MoveViewOutStop]]() - Stops zooming the camera out after [[API MoveViewOutStart|MoveViewOutStart]]() is called.
+
: [[API MoveViewOutStop|MoveViewOutStop]]() - Stops zooming the camera out.
: [[API MoveViewRightStart|MoveViewRightStart]]() - Begins rotating the camera to the Right.
+
: [[API MoveViewRightStart|MoveViewRightStart]]() - Starts rotating the camera to the right.
: [[API MoveViewRightStop|MoveViewRightStop]]() - Stops rotating the camera after [[API MoveViewRightStart|MoveViewRightStart]]() is called.
+
: [[API MoveViewRightStop|MoveViewRightStop]]() - Stops rotating the camera to the right.
: [[API MoveViewUpStart|MoveViewUpStart]]() - Begins rotating the camera upward.
+
: [[API MoveViewUpStart|MoveViewUpStart]]() - Starts rotating the camera upward.
: [[API MoveViewUpStop|MoveViewUpStop]]() - Stops rotating the camera after [[API MoveViewUpStart|MoveViewUpStart]]() is called.
+
: [[API MoveViewUpStop|MoveViewUpStop]]() - Stops rotating the camera upward.
: <small>PROTECTED</small> [[API PitchDownStart|PitchDownStart]]() - Begins pitching the camera Downward.
+
: <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 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 PitchUpStart|PitchUpStart]]() - Begins pitching the camera Upward.
: <small>PROTECTED</small> [[API PitchUpStop|PitchUpStop]]() - Stops pitching the camera after [[API PitchUpStart|PitchUpStart]]() is called.
+
: <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 NextView|NextView]]() - Cycles forward through the five predefined camera positions.
 
: [[API PrevView|PrevView]]() - Cycles backward through the five predefined camera positions.
 
: [[API PrevView|PrevView]]() - Cycles backward through the five predefined camera positions.
 
: [[API ResetView|ResetView]](<span class="apiarg">index</span>) - Resets the specified (1-5) predefined camera position to it's default if it was changed using [[API SaveView|SaveView]](index).
 
: [[API ResetView|ResetView]](<span class="apiarg">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 class="apiarg">index</span>) - Replaces the specified (1-5) predefined camera positions with the current camera position.
+
: [[API SaveView|SaveView]](<span class="apiarg">index</span>) - Saves a camera angle. The last position loaded is stored in the [[CVar cameraView]].
: [[API SetView|SetView]](<span class="apiarg">index</span>) - Sets camera position to a specified (1-5) predefined camera position.
+
: [[API SetView|SetView]](<span class="apiarg">index</span>) - Sets the camera to a predefined camera position (1-5).
   
==== Targeting ====
+
====Targeting====
 
Relates to [[Target]]s.
 
Relates to [[Target]]s.
: <small>PROTECTED</small> [[API AssistUnit|AssistUnit]](<span class="apiarg">unit</span>) - Instructs your character to assist the specified unit.
+
: <small>''PROTECTED''</small> [[API AssistUnit|AssistUnit]](<span class="apiarg">unit</span>) - Assists the unit by targeting the same target.
: <small>PROTECTED</small> [[API ClearFocus|ClearFocus]]() - Removes any focus you may have set.
+
: <small>''PROTECTED''</small> [[API ClearFocus|ClearFocus]]() - Clears the focus target.
: <small>PROTECTED</small> [[API ClearTarget|ClearTarget]]() - Clears the selected target.
+
: <small>''PROTECTED''</small> [[API ClearTarget|ClearTarget]]() - Clears the selected target.
: <small>PROTECTED</small> [[API FocusUnit|FocusUnit]](<span class="apiarg">unit</span>) - Sets your unit for focus.
+
: <small>''PROTECTED''</small> [[API FocusUnit|FocusUnit]](<span class="apiarg">unit</span>) - Sets the [[focus target]].
 
: [[API IsReplacingUnit|IsReplacingUnit]]()
 
: [[API IsReplacingUnit|IsReplacingUnit]]()
: <small>PROTECTED</small> [[API TargetDirectionEnemy|TargetDirectionEnemy]](<span class="apiarg">facing</span>)
+
: <small>''PROTECTED''</small> [[API TargetDirectionEnemy|TargetDirectionEnemy]](<span class="apiarg">facing</span>)
: <small>PROTECTED</small> [[API TargetDirectionFinished|TargetDirectionFinished]]()
+
: <small>''PROTECTED''</small> [[API TargetDirectionFinished|TargetDirectionFinished]]()
: <small>PROTECTED</small> [[API TargetDirectionFriend|TargetDirectionFriend]](<span class="apiarg">facing</span>)
+
: <small>''PROTECTED''</small> [[API TargetDirectionFriend|TargetDirectionFriend]](<span class="apiarg">facing</span>)
: <small>PROTECTED</small> [[API TargetLastEnemy|TargetLastEnemy]]() - Selects the last targetted enemy as the current target.
+
: <small>''PROTECTED''</small> [[API TargetLastEnemy|TargetLastEnemy]]() - Targets the previously targeted enemy.
: <small>PROTECTED</small> [[API TargetLastFriend|TargetLastFriend]]()
+
: <small>''PROTECTED''</small> [[API TargetLastFriend|TargetLastFriend]]()
: <small>PROTECTED</small> [[API TargetLastTarget|TargetLastTarget]]() - Selects the last target as the current target.
+
: <small>''PROTECTED''</small> [[API TargetLastTarget|TargetLastTarget]]() - Selects the last target as the current target.
: <small>PROTECTED</small> [[API TargetNearestEnemy|TargetNearestEnemy]](<span class="apiarg">[reverseFlag]</span>) - Selects the nearest enemy as the current target.
+
: <small>''PROTECTED''</small> [[API TargetNearestEnemy|TargetNearestEnemy]](<span class="apiarg">[reverseFlag]</span>) - Selects the nearest enemy as the current target.
: <small>PROTECTED</small> [[API TargetNearestEnemyPlayer|TargetNearestEnemyPlayer]](<span class="apiarg">[reverseFlag]</span>) - Selects the nearest enemy player as the current target.
+
: <small>''PROTECTED''</small> [[API TargetNearestEnemyPlayer|TargetNearestEnemyPlayer]](<span class="apiarg">[reverseFlag]</span>) - Selects the nearest enemy player as the current target.
: <small>PROTECTED</small> [[API TargetNearestFriend|TargetNearestFriend]](<span class="apiarg">[reverseFlag]</span>) - Selects the nearest friendly unit as the current target.
+
: <small>''PROTECTED''</small> [[API TargetNearestFriend|TargetNearestFriend]](<span class="apiarg">[reverseFlag]</span>) - Targets the nearest friendly unit.
: <small>PROTECTED</small> [[API TargetNearestFriendPlayer|TargetNearestFriendPlayer]](<span class="apiarg">[reverseFlag]</span>) - Selects the nearest friendly player as the current target.
+
: <small>''PROTECTED''</small> [[API TargetNearestFriendPlayer|TargetNearestFriendPlayer]](<span class="apiarg">[reverseFlag]</span>) - Selects the nearest friendly player as the current target.
: <small>PROTECTED</small> [[API TargetNearest|TargetNearest]]()
+
: <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 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 TargetNearestRaidMember|TargetNearestRaidMember]]() - Selects the nearest Raid member as the current target.
: <small>PROTECTED</small> [[API TargetPriorityHighlightEnd|TargetPriorityHighlightEnd]]()
+
: <small>''PROTECTED''</small> [[API TargetPriorityHighlightEnd|TargetPriorityHighlightEnd]]()
: <small>PROTECTED</small> [[API TargetPriorityHighlightStart|TargetPriorityHighlightStart]]()
+
: <small>''PROTECTED''</small> [[API TargetPriorityHighlightStart|TargetPriorityHighlightStart]]()
: <small>PROTECTED</small> [[API TargetUnit|TargetUnit]](<span class="apiarg">unit [, exactMatch]</span>) - Selects the specified unit as the current target.
+
: <small>''PROTECTED''</small> [[API TargetUnit|TargetUnit]](<span class="apiarg">unit [, exactMatch]</span>) - Targets the specified unit.
   
==== Movement ====
+
====Movement====
 
Most of these functions may only be called on a hardware event from '''secure''' code.
 
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 AscendStop|AscendStop]]() - Called when the player releases the jump key.
: <small>PROTECTED</small> [[API AttackTarget|AttackTarget]]() - Attacks the targetted unit.
+
: <small>''PROTECTED''</small> [[API AttackTarget|AttackTarget]]() - Toggles auto-attacking of the current target.
: <small>PROTECTED</small> [[API DescendStop|DescendStop]]() - The player stops descending (while swimming or flying)
+
: <small>''PROTECTED''</small> [[API DescendStop|DescendStop]]() - Stops descending while flying or swimming.
: <small>PROTECTED</small> [[API InteractUnit|InteractUnit]](<span class="apiarg">unitToken [, exactMatch]</span>)
+
: <small>''PROTECTED''</small> [[API InteractUnit|InteractUnit]](<span class="apiarg">unitToken [, exactMatch]</span>)
: [[API FollowUnit|FollowUnit]](<span class="apiarg">unit</span>) - Follow an ally with the specified UnitID.
+
: [[API FollowUnit|FollowUnit]](<span class="apiarg">unit</span>) - Follows a friendly player unit.
 
: [[API IsPlayerMoving|IsPlayerMoving]]()
 
: [[API IsPlayerMoving|IsPlayerMoving]]()
: <small>PROTECTED</small> [[API JumpOrAscendStart|JumpOrAscendStart]]() - Makes the player jump.
+
: <small>''PROTECTED''</small> [[API JumpOrAscendStart|JumpOrAscendStart]]() - Makes the character jump or swim/fly upwards.
: <small>PROTECTED</small> [[API MoveAndSteerStart|MoveAndSteerStart]]()
+
: <small>''PROTECTED''</small> [[API MoveAndSteerStart|MoveAndSteerStart]]()
: <small>PROTECTED</small> [[API MoveAndSteerStop|MoveAndSteerStop]]()
+
: <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 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 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 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 MoveForwardStop|MoveForwardStop]]() - The player stops moving forward at the specified time.
: <small>PROTECTED</small> [[API SetMoveEnabled|SetMoveEnabled]]()
+
: <small>''PROTECTED''</small> [[API SetMoveEnabled|SetMoveEnabled]]()
: <small>PROTECTED</small> [[API SetTurnEnabled|SetTurnEnabled]]()
+
: <small>''PROTECTED''</small> [[API SetTurnEnabled|SetTurnEnabled]]()
: <small>PROTECTED</small> [[API SitStandOrDescendStart|SitStandOrDescendStart]]() - The player sits, stands, or descends.
+
: <small>''PROTECTED''</small> [[API SitStandOrDescendStart|SitStandOrDescendStart]]() - Makes the player sit, stand, or descend (while swimming or flying).
: <small>PROTECTED</small> [[API StartAttack|StartAttack]]()
+
: <small>''PROTECTED''</small> [[API StartAttack|StartAttack]]()
 
: [[API StopAttack|StopAttack]]() - Turns off auto-attack, if currently active.
 
: [[API StopAttack|StopAttack]]() - Turns off auto-attack, if currently active.
: <small>PROTECTED</small> [[API StartAutoRun|StartAutoRun]]()
+
: <small>''PROTECTED''</small> [[API StartAutoRun|StartAutoRun]]()
: <small>PROTECTED</small> [[API StopAutoRun|StopAutoRun]]()
+
: <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 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 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 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 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 ToggleAutoRun|ToggleAutoRun]]() - Turns auto-run on or off.
: <small>PROTECTED</small> [[API ToggleRun|ToggleRun]]() - Toggle between running and walking.
+
: <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 TurnLeftStart|TurnLeftStart]]() - Turns the player left at the specified time.
: <small>PROTECTED</small> [[API TurnLeftStop|TurnLeftStop]]() - The player stops 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 TurnOrActionStart|TurnOrActionStart]]() - Starts a "right click" in the 3D game world.
: <small>PROTECTED</small> [[API TurnOrActionStop|TurnOrActionStop]]() - End "Right Click" in the 3D world.
+
: <small>''PROTECTED''</small> [[API TurnOrActionStop|TurnOrActionStop]]() - Stops a "right click" in the 3D game world.
: <small>PROTECTED</small> [[API TurnRightStart|TurnRightStart]]() - The player starts turning right at the specified time.
+
: <small>''PROTECTED''</small> [[API TurnRightStart|TurnRightStart]]() - Turns the player right at the specified time.
: <small>PROTECTED</small> [[API TurnRightStop|TurnRightStop]]() - The player stops turning right at the specified time.
+
: <small>''PROTECTED''</small> [[API TurnRightStop|TurnRightStop]]() - The player stops turning right at the specified time.
   
==== Gamepad ====
+
====Gamepad====
 
Native gamepad support was added in [[Patch 9.0.1]], where previously [https://github.com/topher-au/WoWmapper WoWmapper] was needed.
 
Native gamepad support was added in [[Patch 9.0.1]], where previously [https://github.com/topher-au/WoWmapper WoWmapper] was needed.
  +
: [[API C_GamePad.AddSDLMapping|C_GamePad.AddSDLMapping]](<span class="apiarg">platform, mapping</span>) : <span class="apiret">success</span>
 
: [[API C_GamePad.ApplyConfigs|C_GamePad.ApplyConfigs]]()
 
: [[API C_GamePad.ApplyConfigs|C_GamePad.ApplyConfigs]]()
 
: [[API C_GamePad.AxisIndexToConfigName|C_GamePad.AxisIndexToConfigName]](<span class="apiarg">axisIndex</span>) : <span class="apiret">configName</span>
 
: [[API C_GamePad.AxisIndexToConfigName|C_GamePad.AxisIndexToConfigName]](<span class="apiarg">axisIndex</span>) : <span class="apiret">configName</span>
Line 1,897: Line 1,926:
 
: [[API C_GamePad.GetDeviceRawState|C_GamePad.GetDeviceRawState]](<span class="apiarg">deviceID</span>) : <span class="apiret">rawState</span>
 
: [[API C_GamePad.GetDeviceRawState|C_GamePad.GetDeviceRawState]](<span class="apiarg">deviceID</span>) : <span class="apiret">rawState</span>
 
: [[API C_GamePad.GetLedColor|C_GamePad.GetLedColor]]() : <span class="apiret">color</span>
 
: [[API C_GamePad.GetLedColor|C_GamePad.GetLedColor]]() : <span class="apiret">color</span>
  +
: [[API C_GamePad.GetPowerLevel|C_GamePad.GetPowerLevel]](<span class="apiarg">[deviceID]</span>) : <span class="apiret">powerLevel</span>
 
: [[API C_GamePad.IsEnabled|C_GamePad.IsEnabled]]() : <span class="apiret">enabled</span>
 
: [[API C_GamePad.IsEnabled|C_GamePad.IsEnabled]]() : <span class="apiret">enabled</span>
 
: [[API C_GamePad.SetConfig|C_GamePad.SetConfig]](<span class="apiarg">config</span>)
 
: [[API C_GamePad.SetConfig|C_GamePad.SetConfig]](<span class="apiarg">config</span>)
Line 1,911: Line 1,941:
 
: [[API SetGamePadFreeLook|SetGamePadFreeLook]]()
 
: [[API SetGamePadFreeLook|SetGamePadFreeLook]]()
   
=== Currency ===
+
===Currency===
 
[[Currencies]] were added in [[Patch 3.0.2]].
 
[[Currencies]] were added in [[Patch 3.0.2]].
 
: [[API C_CurrencyInfo.DoesWarModeBonusApply|C_CurrencyInfo.DoesWarModeBonusApply]](<span class="apiarg">currencyID</span>) : <span class="apiret">warModeApplies, limitOncePerTooltip</span>
 
: [[API C_CurrencyInfo.DoesWarModeBonusApply|C_CurrencyInfo.DoesWarModeBonusApply]](<span class="apiarg">currencyID</span>) : <span class="apiret">warModeApplies, limitOncePerTooltip</span>
: [[API C_CurrencyInfo.ExpandCurrencyList|C_CurrencyInfo.ExpandCurrencyList]](<span class="apiarg">index, expand</span>) - Sets the expanded/collapsed state of a currency list header.
+
: [[API C_CurrencyInfo.ExpandCurrencyList|C_CurrencyInfo.ExpandCurrencyList]](<span class="apiarg">index, expand</span>) - Expands/collapses a currency list header.
 
: [[API C_CurrencyInfo.GetAzeriteCurrencyID|C_CurrencyInfo.GetAzeriteCurrencyID]]() : <span class="apiret">azeriteCurrencyID</span>
 
: [[API C_CurrencyInfo.GetAzeriteCurrencyID|C_CurrencyInfo.GetAzeriteCurrencyID]]() : <span class="apiret">azeriteCurrencyID</span>
: [[API C_CurrencyInfo.GetBackpackCurrencyInfo|C_CurrencyInfo.GetBackpackCurrencyInfo]](<span class="apiarg">index</span>) : <span class="apiret">info</span> - Returns information about a watched currency.
+
: [[API C_CurrencyInfo.GetBackpackCurrencyInfo|C_CurrencyInfo.GetBackpackCurrencyInfo]](<span class="apiarg">index</span>) : <span class="apiret">info</span> - Returns info for a tracked currency in the backpack.
 
: [[API C_CurrencyInfo.GetBasicCurrencyInfo|C_CurrencyInfo.GetBasicCurrencyInfo]](<span class="apiarg">currencyType [, quantity]</span>) : <span class="apiret">info</span>
 
: [[API C_CurrencyInfo.GetBasicCurrencyInfo|C_CurrencyInfo.GetBasicCurrencyInfo]](<span class="apiarg">currencyType [, quantity]</span>) : <span class="apiret">info</span>
 
: [[API C_CurrencyInfo.GetCurrencyContainerInfo|C_CurrencyInfo.GetCurrencyContainerInfo]](<span class="apiarg">currencyType, quantity</span>) : <span class="apiret">info</span>
 
: [[API C_CurrencyInfo.GetCurrencyContainerInfo|C_CurrencyInfo.GetCurrencyContainerInfo]](<span class="apiarg">currencyType, quantity</span>) : <span class="apiret">info</span>
 
: [[API C_CurrencyInfo.GetCurrencyIDFromLink|C_CurrencyInfo.GetCurrencyIDFromLink]](<span class="apiarg">currencyLink</span>) : <span class="apiret">currencyID</span>
 
: [[API C_CurrencyInfo.GetCurrencyIDFromLink|C_CurrencyInfo.GetCurrencyIDFromLink]](<span class="apiarg">currencyLink</span>) : <span class="apiret">currencyID</span>
: [[API C_CurrencyInfo.GetCurrencyInfo|C_CurrencyInfo.GetCurrencyInfo]](<span class="apiarg">type</span>) : <span class="apiret">info</span> - Returns information about currencies.
+
: [[API C_CurrencyInfo.GetCurrencyInfo|C_CurrencyInfo.GetCurrencyInfo]](<span class="apiarg">type</span>) : <span class="apiret">info</span> - Returns info for a currency by ID.
 
: [[API C_CurrencyInfo.GetCurrencyInfoFromLink|C_CurrencyInfo.GetCurrencyInfoFromLink]](<span class="apiarg">link</span>) : <span class="apiret">info</span> - Returns information about currencies from a link.
 
: [[API C_CurrencyInfo.GetCurrencyInfoFromLink|C_CurrencyInfo.GetCurrencyInfoFromLink]](<span class="apiarg">link</span>) : <span class="apiret">info</span> - Returns information about currencies from a link.
: [[API C_CurrencyInfo.GetCurrencyLink|C_CurrencyInfo.GetCurrencyLink]](<span class="apiarg">type [, amount]</span>) : <span class="apiret">link</span> - Returns the currencyLink for the specified currencyID.
+
: [[API C_CurrencyInfo.GetCurrencyLink|C_CurrencyInfo.GetCurrencyLink]](<span class="apiarg">type [, amount]</span>) : <span class="apiret">link</span> - Returns a currency link.
: [[API C_CurrencyInfo.GetCurrencyListInfo|C_CurrencyInfo.GetCurrencyListInfo]](<span class="apiarg">index</span>) : <span class="apiret">info</span> - Returns information about an element in the currency list.
+
: [[API C_CurrencyInfo.GetCurrencyListInfo|C_CurrencyInfo.GetCurrencyListInfo]](<span class="apiarg">index</span>) : <span class="apiret">info</span> - Returns info for a currency in the [[currency tab]].
 
: [[API C_CurrencyInfo.GetCurrencyListLink|C_CurrencyInfo.GetCurrencyListLink]](<span class="apiarg">index</span>) : <span class="apiret">link</span>
 
: [[API C_CurrencyInfo.GetCurrencyListLink|C_CurrencyInfo.GetCurrencyListLink]](<span class="apiarg">index</span>) : <span class="apiret">link</span>
: [[API C_CurrencyInfo.GetCurrencyListSize|C_CurrencyInfo.GetCurrencyListSize]]() : <span class="apiret">currencyListSize</span> - Returns the number of elements (both headers and currencies) in the currency list.
+
: [[API C_CurrencyInfo.GetCurrencyListSize|C_CurrencyInfo.GetCurrencyListSize]]() : <span class="apiret">currencyListSize</span> - Returns the amount of currencies and headers in the currency tab.
 
: [[API C_CurrencyInfo.GetFactionGrantedByCurrency|C_CurrencyInfo.GetFactionGrantedByCurrency]](<span class="apiarg">currencyID</span>) : <span class="apiret">factionID</span> - Gets the faction ID for currency that is immediately converted into reputation with that faction instead.
 
: [[API C_CurrencyInfo.GetFactionGrantedByCurrency|C_CurrencyInfo.GetFactionGrantedByCurrency]](<span class="apiarg">currencyID</span>) : <span class="apiret">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 class="apiret">warResourceCurrencyID</span>
 
: [[API C_CurrencyInfo.GetWarResourcesCurrencyID|C_CurrencyInfo.GetWarResourcesCurrencyID]]() : <span class="apiret">warResourceCurrencyID</span>
 
: [[API C_CurrencyInfo.IsCurrencyContainer|C_CurrencyInfo.IsCurrencyContainer]](<span class="apiarg">currencyID, quantity</span>) : <span class="apiret">isCurrencyContainer</span>
 
: [[API C_CurrencyInfo.IsCurrencyContainer|C_CurrencyInfo.IsCurrencyContainer]](<span class="apiarg">currencyID, quantity</span>) : <span class="apiret">isCurrencyContainer</span>
: [[API C_CurrencyInfo.SetCurrencyBackpack|C_CurrencyInfo.SetCurrencyBackpack]](<span class="apiarg">index, backpack</span>) - Alters whether a currency is tracked.
+
: [[API C_CurrencyInfo.SetCurrencyBackpack|C_CurrencyInfo.SetCurrencyBackpack]](<span class="apiarg">index, backpack</span>) - Tracks a currency in the backpack.
: [[API C_CurrencyInfo.SetCurrencyUnused|C_CurrencyInfo.SetCurrencyUnused]](<span class="apiarg">index, unused</span>) - Alters whether a currency is marked as unused.
+
: [[API C_CurrencyInfo.SetCurrencyUnused|C_CurrencyInfo.SetCurrencyUnused]](<span class="apiarg">index, unused</span>) - Marks a currency as unused in the currency tab.
: [[API GetCoinText|GetCoinText]](<span class="apiarg">amount, separator</span>) - Breaks down money and inserts separator strings.
+
: [[API C_Item.GetLimitedCurrencyItemInfo|C_Item.GetLimitedCurrencyItemInfo]](<span class="apiarg">itemInfo</span>) : <span class="apiret">name, icon, quantity, maxQuantity, totalEarned</span>
: [[API GetCoinTextureString|GetCoinTextureString]](<span class="apiarg">amount [, fontHeight]</span>) - Breaks down money and inserts texture strings.
+
: [[API GetCoinText|GetCoinText]](<span class="apiarg">amount, separator</span>) - Breaks up an amount of money into gold/silver/copper.
  +
: [[API GetCoinTextureString|GetCoinTextureString]](<span class="apiarg">amount [, fontHeight]</span>) - Breaks up an amount of money into gold/silver/copper with icons.
 
: [[API GetPlayerTradeCurrency|GetPlayerTradeCurrency]]()
 
: [[API GetPlayerTradeCurrency|GetPlayerTradeCurrency]]()
 
: [[API GetTargetTradeCurrency|GetTargetTradeCurrency]]()
 
: [[API GetTargetTradeCurrency|GetTargetTradeCurrency]]()
 
: [[API SetTradeCurrency|SetTradeCurrency]](<span class="apiarg">type, amount</span>)
 
: [[API SetTradeCurrency|SetTradeCurrency]](<span class="apiarg">type, amount</span>)
: <small>UI</small> [[API GetNumWatchedTokens|GetNumWatchedTokens]]() - Returns the number of currently watched currencies.
+
: <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 class="apiarg">caseIndex</span>)
 
: [[API AcknowledgeSurvey|AcknowledgeSurvey]](<span class="apiarg">caseIndex</span>)
: <small>PROTECTED</small> [[API DeleteGMTicket|DeleteGMTicket]]()
+
: <small>''PROTECTED''</small> [[API DeleteGMTicket|DeleteGMTicket]]()
 
: [[API GetWebTicket|GetWebTicket]]()
 
: [[API GetWebTicket|GetWebTicket]]()
 
: [[API GMEuropaBugsEnabled|GMEuropaBugsEnabled]]()
 
: [[API GMEuropaBugsEnabled|GMEuropaBugsEnabled]]()
Line 1,990: Line 2,021:
 
: [[API KBSystem_GetServerStatus|KBSystem_GetServerStatus]]() - Returns the server status text.
 
: [[API KBSystem_GetServerStatus|KBSystem_GetServerStatus]]() - Returns the server status text.
   
=== Expansions ===
+
===Expansions===
 
Relates to [[Expansion]]s.
 
Relates to [[Expansion]]s.
 
: [[API CanUpgradeExpansion|CanUpgradeExpansion]]() : <span class="apiret">canUpgradeExpansion</span>
 
: [[API CanUpgradeExpansion|CanUpgradeExpansion]]() : <span class="apiret">canUpgradeExpansion</span>
Line 2,012: Line 2,043:
 
: [[API C_LevelSquish.ConvertPlayerLevel|C_LevelSquish.ConvertPlayerLevel]](<span class="apiarg">level</span>) : <span class="apiret">squishedLevel</span>
 
: [[API C_LevelSquish.ConvertPlayerLevel|C_LevelSquish.ConvertPlayerLevel]](<span class="apiarg">level</span>) : <span class="apiret">squishedLevel</span>
   
==== Chromie Time ====
+
====Chromie Time====
 
[[Timewalking Campaigns]] scale older expansion zones up to level 50.
 
[[Timewalking Campaigns]] scale older expansion zones up to level 50.
 
: [[API C_ChromieTime.CloseUI|C_ChromieTime.CloseUI]]()
 
: [[API C_ChromieTime.CloseUI|C_ChromieTime.CloseUI]]()
Line 2,022: Line 2,053:
 
: [[API UnitChromieTimeID|UnitChromieTimeID]](<span class="apiarg">unit</span>) : <span class="apiret">ID</span>
 
: [[API UnitChromieTimeID|UnitChromieTimeID]](<span class="apiarg">unit</span>) : <span class="apiret">ID</span>
   
=== Friends ===
+
===Friends===
 
Relates to the [[Friends list]].
 
Relates to the [[Friends list]].
: <small>NOSCRIPT</small> [[API C_FriendList.AddFriend|C_FriendList.AddFriend]](<span class="apiarg">name [, notes]</span>) - Adds a friend to your friend list.
+
: <small>''NOSCRIPT''</small> [[API C_FriendList.AddFriend|C_FriendList.AddFriend]](<span class="apiarg">name [, notes]</span>) - Adds a friend to your friend list.
 
: [[API C_FriendList.AddIgnore|C_FriendList.AddIgnore]](<span class="apiarg">name</span>) : <span class="apiret">added</span> - Adds a player to your ignore list.
 
: [[API C_FriendList.AddIgnore|C_FriendList.AddIgnore]](<span class="apiarg">name</span>) : <span class="apiret">added</span> - Adds a player to your ignore list.
 
: [[API C_FriendList.AddOrDelIgnore|C_FriendList.AddOrDelIgnore]](<span class="apiarg">name</span>) - Adds or removes a player to/from the ignore list.
 
: [[API C_FriendList.AddOrDelIgnore|C_FriendList.AddOrDelIgnore]](<span class="apiarg">name</span>) - Adds or removes a player to/from the ignore list.
Line 2,041: Line 2,072:
 
: [[API C_FriendList.IsIgnored|C_FriendList.IsIgnored]](<span class="apiarg">token</span>) : <span class="apiret">isIgnored</span> - Returns whether a character is being ignored by you.
 
: [[API C_FriendList.IsIgnored|C_FriendList.IsIgnored]](<span class="apiarg">token</span>) : <span class="apiret">isIgnored</span> - Returns whether a character is being ignored by you.
 
: [[API C_FriendList.IsIgnoredByGuid|C_FriendList.IsIgnoredByGuid]](<span class="apiarg">guid</span>) : <span class="apiret">isIgnored</span> - Returns whether a character is being ignored by you.
 
: [[API C_FriendList.IsIgnoredByGuid|C_FriendList.IsIgnoredByGuid]](<span class="apiarg">guid</span>) : <span class="apiret">isIgnored</span> - Returns whether a character is being ignored by you.
  +
: [[API C_FriendList.IsOnIgnoredList|C_FriendList.IsOnIgnoredList]](<span class="apiarg">token</span>) : <span class="apiret">isIgnored</span>
 
: [[API C_FriendList.RemoveFriend|C_FriendList.RemoveFriend]](<span class="apiarg">name</span>) : <span class="apiret">removed</span> - Removes a friend from the friends list.
 
: [[API C_FriendList.RemoveFriend|C_FriendList.RemoveFriend]](<span class="apiarg">name</span>) : <span class="apiret">removed</span> - Removes a friend from the friends list.
 
: [[API C_FriendList.RemoveFriendByIndex|C_FriendList.RemoveFriendByIndex]](<span class="apiarg">index</span>) - Removes a friend from the friends list.
 
: [[API C_FriendList.RemoveFriendByIndex|C_FriendList.RemoveFriendByIndex]](<span class="apiarg">index</span>) - Removes a friend from the friends list.
Line 2,049: Line 2,081:
 
: [[API C_FriendList.ShowFriends|C_FriendList.ShowFriends]]() - Requests updated friends information from server.
 
: [[API C_FriendList.ShowFriends|C_FriendList.ShowFriends]]() - Requests updated friends information from server.
   
==== Who List ====
+
====Who List====
 
Relates to the [[Who List]].
 
Relates to the [[Who List]].
 
: [[API C_FriendList.GetNumWhoResults|C_FriendList.GetNumWhoResults]]() : <span class="apiret">numWhos, totalNumWhos</span> - Get the number of entries resulting from your most recent /who query.
 
: [[API C_FriendList.GetNumWhoResults|C_FriendList.GetNumWhoResults]]() : <span class="apiret">numWhos, totalNumWhos</span> - Get the number of entries resulting from your most recent /who query.
 
: [[API C_FriendList.GetWhoInfo|C_FriendList.GetWhoInfo]](<span class="apiarg">index</span>) : <span class="apiret">info</span> - Retrieves info about a character on your current /who list.
 
: [[API C_FriendList.GetWhoInfo|C_FriendList.GetWhoInfo]](<span class="apiarg">index</span>) : <span class="apiret">info</span> - Retrieves info about a character on your current /who list.
: <small>HW</small> [[API C_FriendList.SendWho|C_FriendList.SendWho]](<span class="apiarg">filter</span>) - Sends a Who request, much like using the slash command /who or entering a query in the entry field of the Who List.
+
: <small>''HW''</small> [[API C_FriendList.SendWho|C_FriendList.SendWho]](<span class="apiarg">filter</span>) - Requests a list of other online players.
: [[API C_FriendList.SetWhoToUi|C_FriendList.SetWhoToUi]](<span class="apiarg">whoToUi</span>) - Sets how the result of a /who request will be handled.
+
: [[API C_FriendList.SetWhoToUi|C_FriendList.SetWhoToUi]](<span class="apiarg">whoToUi</span>) - Sets how the result of a [[MACRO who|/who]] request will be delivered.
: [[API C_FriendList.SortWho|C_FriendList.SortWho]](<span class="apiarg">sorting</span>) - Sorts the last /who reply received by the client.
+
: [[API C_FriendList.SortWho|C_FriendList.SortWho]](<span class="apiarg">sorting</span>) - Sorts the last [[MACRO_who|/who]] reply received by the client.
   
==== Battle.net ====
+
====Battle.net====
 
[[Real ID]] friends were added in [[Patch 3.3.5]]
 
[[Real ID]] friends were added in [[Patch 3.3.5]]
 
: [[API C_BattleNet.GetAccountInfoByID|C_BattleNet.GetAccountInfoByID]](<span class="apiarg">id [, wowAccountGUID]</span>) : <span class="apiret">accountInfo</span> - Returns information about a Battle.net friend account.
 
: [[API C_BattleNet.GetAccountInfoByID|C_BattleNet.GetAccountInfoByID]](<span class="apiarg">id [, wowAccountGUID]</span>) : <span class="apiret">accountInfo</span> - Returns information about a Battle.net friend account.
Line 2,065: Line 2,097:
 
: [[API C_BattleNet.GetGameAccountInfoByGUID|C_BattleNet.GetGameAccountInfoByGUID]](<span class="apiarg">guid</span>) : <span class="apiret">gameAccountInfo</span>
 
: [[API C_BattleNet.GetGameAccountInfoByGUID|C_BattleNet.GetGameAccountInfoByGUID]](<span class="apiarg">guid</span>) : <span class="apiret">gameAccountInfo</span>
 
: [[API C_BattleNet.GetFriendGameAccountInfo|C_BattleNet.GetFriendGameAccountInfo]](<span class="apiarg">friendIndex, accountIndex</span>) : <span class="apiret">gameAccountInfo</span>
 
: [[API C_BattleNet.GetFriendGameAccountInfo|C_BattleNet.GetFriendGameAccountInfo]](<span class="apiarg">friendIndex, accountIndex</span>) : <span class="apiret">gameAccountInfo</span>
: [[API C_BattleNet.GetFriendNumGameAccounts|C_BattleNet.GetFriendNumGameAccounts]](<span class="apiarg">friendIndex</span>) : <span class="apiret">numGameAccounts</span> - Returns the Battle.net friend's number of game accounts.
+
: [[API C_BattleNet.GetFriendNumGameAccounts|C_BattleNet.GetFriendNumGameAccounts]](<span class="apiarg">friendIndex</span>) : <span class="apiret">numGameAccounts</span> - Returns the number of game accounts for the Battle.net friend.
 
: [[API C_AccountInfo.GetIDFromBattleNetAccountGUID|C_AccountInfo.GetIDFromBattleNetAccountGUID]](<span class="apiarg">battleNetAccountGUID</span>) : <span class="apiret">battleNetAccountID</span>
 
: [[API C_AccountInfo.GetIDFromBattleNetAccountGUID|C_AccountInfo.GetIDFromBattleNetAccountGUID]](<span class="apiarg">battleNetAccountGUID</span>) : <span class="apiret">battleNetAccountID</span>
 
: [[API C_AccountInfo.IsGUIDBattleNetAccountType|C_AccountInfo.IsGUIDBattleNetAccountType]](<span class="apiarg">guid</span>) : <span class="apiret">isBNet</span>
 
: [[API C_AccountInfo.IsGUIDBattleNetAccountType|C_AccountInfo.IsGUIDBattleNetAccountType]](<span class="apiarg">guid</span>) : <span class="apiret">isBNet</span>
Line 2,072: Line 2,104:
 
: [[API BNCheckBattleTagInviteToGuildMember|BNCheckBattleTagInviteToGuildMember]](<span class="apiarg">fullname</span>)
 
: [[API BNCheckBattleTagInviteToGuildMember|BNCheckBattleTagInviteToGuildMember]](<span class="apiarg">fullname</span>)
 
: [[API BNCheckBattleTagInviteToUnit|BNCheckBattleTagInviteToUnit]](<span class="apiarg">unit</span>)
 
: [[API BNCheckBattleTagInviteToUnit|BNCheckBattleTagInviteToUnit]](<span class="apiarg">unit</span>)
: [[API BNConnected|BNConnected]]() - Returns whether your battle.net state is connected.
+
: [[API BNConnected|BNConnected]]() - True if the WoW Client is connected to Battle.net.
 
: [[API BNDeclineFriendInvite|BNDeclineFriendInvite]](<span class="apiarg">ID</span>)
 
: [[API BNDeclineFriendInvite|BNDeclineFriendInvite]](<span class="apiarg">ID</span>)
 
: [[API BNFeaturesEnabledAndConnected|BNFeaturesEnabledAndConnected]]()
 
: [[API BNFeaturesEnabledAndConnected|BNFeaturesEnabledAndConnected]]()
Line 2,078: Line 2,110:
 
: [[API BNGetBlockedInfo|BNGetBlockedInfo]](<span class="apiarg">index</span>)
 
: [[API BNGetBlockedInfo|BNGetBlockedInfo]](<span class="apiarg">index</span>)
 
: [[API BNGetDisplayName|BNGetDisplayName]](<span class="apiarg">bnetIdAccount</span>)
 
: [[API BNGetDisplayName|BNGetDisplayName]](<span class="apiarg">bnetIdAccount</span>)
: [[API BNGetFOFInfo|BNGetFOFInfo]](<span class="apiarg">mutual, nonMutual, index</span>) - Returns presenceID, givenName, surname, isFriend.
+
: [[API BNGetFOFInfo|BNGetFOFInfo]](<span class="apiarg">mutual, nonMutual, index</span>) - Returns info for the specified friend of a Battle.net friend.
 
: [[API BNGetFriendIndex|BNGetFriendIndex]](<span class="apiarg">presenceID</span>)
 
: [[API BNGetFriendIndex|BNGetFriendIndex]](<span class="apiarg">presenceID</span>)
: [[API BNGetFriendInviteInfo|BNGetFriendInviteInfo]](<span class="apiarg">menuValue</span>) - Returns presenceID, givenName, surname.
+
: [[API BNGetFriendInviteInfo|BNGetFriendInviteInfo]](<span class="apiarg">menuValue</span>) - Returns info for a Battle.net friend invite.
: [[API BNGetInfo|BNGetInfo]]() - Returns own battle.net data like battleTag.
+
: [[API BNGetInfo|BNGetInfo]]() - Returns the player's own Battle.net info.
 
: [[API BNGetNumBlocked|BNGetNumBlocked]]()
 
: [[API BNGetNumBlocked|BNGetNumBlocked]]()
 
: [[API BNGetNumFOF|BNGetNumFOF]](<span class="apiarg">ID, mutual, non</span>)
 
: [[API BNGetNumFOF|BNGetNumFOF]](<span class="apiarg">ID, mutual, non</span>)
 
: [[API BNGetNumFriendInvites|BNGetNumFriendInvites]]()
 
: [[API BNGetNumFriendInvites|BNGetNumFriendInvites]]()
: [[API BNGetNumFriends|BNGetNumFriends]]() - Returns numBNetTotal, numBNetOnline, numBNetFavorite, numBNetFavoriteOnline.
+
: [[API BNGetNumFriends|BNGetNumFriends]]() - Returns the amount of (online) Battle.net friends.
 
: [[API BNGetSelectedBlock|BNGetSelectedBlock]]()
 
: [[API BNGetSelectedBlock|BNGetSelectedBlock]]()
 
: [[API BNGetSelectedFriend|BNGetSelectedFriend]]()
 
: [[API BNGetSelectedFriend|BNGetSelectedFriend]]()
Line 2,097: Line 2,129:
 
: [[API BNSendFriendInviteByID|BNSendFriendInviteByID]](<span class="apiarg">ID, noteText</span>)
 
: [[API BNSendFriendInviteByID|BNSendFriendInviteByID]](<span class="apiarg">ID, noteText</span>)
 
: [[API BNSendFriendInvite|BNSendFriendInvite]](<span class="apiarg">text, noteText</span>)
 
: [[API BNSendFriendInvite|BNSendFriendInvite]](<span class="apiarg">text, noteText</span>)
: [[API BNSendGameData|BNSendGameData]](<span class="apiarg">id, addonPrefix, text</span>) - BNet equivalent of SendAddonMessage.
+
: [[API BNSendGameData|BNSendGameData]](<span class="apiarg">id, addonPrefix, text</span>) - Sends an addon comm message to a Battle.net friend.
 
: [[API BNSendSoR|BNSendSoR]](<span class="apiarg">target, comment</span>)
 
: [[API BNSendSoR|BNSendSoR]](<span class="apiarg">target, comment</span>)
 
: [[API BNSendVerifiedBattleTagInvite|BNSendVerifiedBattleTagInvite]]() - Unit should have been set with [[API BNCheckBattleTagInviteToUnit|BNCheckBattleTagInviteToUnit]] or [[API BNCheckBattleTagInviteToGuildMember|BNCheckBattleTagInviteToGuildMember]].
 
: [[API BNSendVerifiedBattleTagInvite|BNSendVerifiedBattleTagInvite]]() - Unit should have been set with [[API BNCheckBattleTagInviteToUnit|BNCheckBattleTagInviteToUnit]] or [[API BNCheckBattleTagInviteToGuildMember|BNCheckBattleTagInviteToGuildMember]].
 
: [[API BNSendWhisper|BNSendWhisper]](<span class="apiarg">id, text</span>)
 
: [[API BNSendWhisper|BNSendWhisper]](<span class="apiarg">id, text</span>)
: [[API BNSetAFK|BNSetAFK]](<span class="apiarg">bool</span>) - Set or unset afk status.
+
: [[API BNSetAFK|BNSetAFK]](<span class="apiarg">bool</span>) - Sets the player's online AFK status.
 
: [[API BNSetBlocked|BNSetBlocked]](<span class="apiarg">ID, bool</span>)
 
: [[API BNSetBlocked|BNSetBlocked]](<span class="apiarg">ID, bool</span>)
 
: [[API BNSetCustomMessage|BNSetCustomMessage]](<span class="apiarg">text</span>)
 
: [[API BNSetCustomMessage|BNSetCustomMessage]](<span class="apiarg">text</span>)
: [[API BNSetDND|BNSetDND]](<span class="apiarg">bool</span>) - Set or unset dnd status.
+
: [[API BNSetDND|BNSetDND]](<span class="apiarg">bool</span>) - Sets the player's online DND status.
: [[API BNSetFriendFavoriteFlag|BNSetFriendFavoriteFlag]](<span class="apiarg">id, isFavorite</span>) - Set a battle.net friend as favorite.
+
: [[API BNSetFriendFavoriteFlag|BNSetFriendFavoriteFlag]](<span class="apiarg">id, isFavorite</span>) - Favorites a Battle.net friend.
 
: [[API BNSetFriendNote|BNSetFriendNote]](<span class="apiarg">ID, noteText</span>)
 
: [[API BNSetFriendNote|BNSetFriendNote]](<span class="apiarg">ID, noteText</span>)
 
: [[API BNSetSelectedBlock|BNSetSelectedBlock]](<span class="apiarg">index</span>)
 
: [[API BNSetSelectedBlock|BNSetSelectedBlock]](<span class="apiarg">index</span>)
Line 2,114: Line 2,146:
 
: [[API IsBNLogin|IsBNLogin]]()
 
: [[API IsBNLogin|IsBNLogin]]()
   
==== Recruit-a-Friend ====
+
====Recruit-a-Friend====
 
[[Recruit-A-Friend]] was reworked in [[Patch 8.2.5]]
 
[[Recruit-A-Friend]] was reworked in [[Patch 8.2.5]]
 
: [[API C_RecruitAFriend.ClaimActivityReward|C_RecruitAFriend.ClaimActivityReward]](<span class="apiarg">activityID, acceptanceID</span>) : <span class="apiret">success</span>
 
: [[API C_RecruitAFriend.ClaimActivityReward|C_RecruitAFriend.ClaimActivityReward]](<span class="apiarg">activityID, acceptanceID</span>) : <span class="apiret">success</span>
Line 2,128: Line 2,160:
 
: [[API C_RecruitAFriend.RequestUpdatedRecruitmentInfo|C_RecruitAFriend.RequestUpdatedRecruitmentInfo]]() : <span class="apiret">success</span>
 
: [[API C_RecruitAFriend.RequestUpdatedRecruitmentInfo|C_RecruitAFriend.RequestUpdatedRecruitmentInfo]]() : <span class="apiret">success</span>
 
: [[API CanSummonFriend|CanSummonFriend]](<span class="apiarg">unit</span>) - Returns whether you can RaF summon a particular unit.
 
: [[API CanSummonFriend|CanSummonFriend]](<span class="apiarg">unit</span>) - Returns whether you can RaF summon a particular unit.
: [[API GetSummonFriendCooldown|GetSummonFriendCooldown]]() - Returns the cooldown (start, duration) of the RaF Summon Friend ability.
+
: [[API GetSummonFriendCooldown|GetSummonFriendCooldown]]() - Returns the cooldown info of the RaF Summon Friend ability.
 
: [[API IsRecruitAFriendLinked|IsRecruitAFriendLinked]]()
 
: [[API IsRecruitAFriendLinked|IsRecruitAFriendLinked]]()
 
: [[API SelectedRealmName|SelectedRealmName]]() - Returns the realm name that will be used in Recruit-a-Friend invitations.
 
: [[API SelectedRealmName|SelectedRealmName]]() - Returns the realm name that will be used in Recruit-a-Friend invitations.
 
: [[API SummonFriend|SummonFriend]](<span class="apiarg">unit</span>) - Summons a player using the RaF system.
 
: [[API SummonFriend|SummonFriend]](<span class="apiarg">unit</span>) - Summons a player using the RaF system.
   
==== Mentor System ====
+
====Mentor System====
 
[https://www.wowhead.com/news=317554/guide-mentor-system-requirements-changed-in-shadowlands-build-35598 Newcomer Guides] were added in [[Patch 9.0.1]]
 
[https://www.wowhead.com/news=317554/guide-mentor-system-requirements-changed-in-shadowlands-build-35598 Newcomer Guides] were added in [[Patch 9.0.1]]
 
: [[API C_PlayerMentorship.GetMentorLevelRequirement|C_PlayerMentorship.GetMentorLevelRequirement]]() : <span class="apiret">level</span>
 
: [[API C_PlayerMentorship.GetMentorLevelRequirement|C_PlayerMentorship.GetMentorLevelRequirement]]() : <span class="apiret">level</span>
Line 2,141: Line 2,173:
 
: [[API C_PlayerMentorship.IsMentorRestricted|C_PlayerMentorship.IsMentorRestricted]]() : <span class="apiret">isRestricted</span>
 
: [[API C_PlayerMentorship.IsMentorRestricted|C_PlayerMentorship.IsMentorRestricted]]() : <span class="apiret">isRestricted</span>
   
=== Groups ===
+
===Groups===
 
: [[API C_PartyInfo.AllowedToDoPartyConversion|C_PartyInfo.AllowedToDoPartyConversion]](<span class="apiarg">toRaid</span>) : <span class="apiret">allowed</span>
 
: [[API C_PartyInfo.AllowedToDoPartyConversion|C_PartyInfo.AllowedToDoPartyConversion]](<span class="apiarg">toRaid</span>) : <span class="apiret">allowed</span>
 
: [[API C_PartyInfo.CanInvite|C_PartyInfo.CanInvite]]() : <span class="apiret">allowedToInvite</span>
 
: [[API C_PartyInfo.CanInvite|C_PartyInfo.CanInvite]]() : <span class="apiret">allowedToInvite</span>
Line 2,152: Line 2,184:
 
: [[API C_PartyInfo.DoCountdown|C_PartyInfo.DoCountdown]](<span class="apiarg">seconds</span>)
 
: [[API C_PartyInfo.DoCountdown|C_PartyInfo.DoCountdown]](<span class="apiarg">seconds</span>)
 
: [[API C_PartyInfo.GetMinLevel|C_PartyInfo.GetMinLevel]](<span class="apiarg">[category]</span>) : <span class="apiret">minLevel</span>
 
: [[API C_PartyInfo.GetMinLevel|C_PartyInfo.GetMinLevel]](<span class="apiarg">[category]</span>) : <span class="apiret">minLevel</span>
: [[API C_PartyInfo.InviteUnit|C_PartyInfo.InviteUnit]](<span class="apiarg">targetName</span>) - Invites the specified player to the group you are currently in.
+
: [[API C_PartyInfo.InviteUnit|C_PartyInfo.InviteUnit]](<span class="apiarg">targetName</span>) - Invites a player to your group.
 
: [[API C_PartyInfo.IsPartyFull|C_PartyInfo.IsPartyFull]](<span class="apiarg">[category]</span>) : <span class="apiret">isFull</span>
 
: [[API C_PartyInfo.IsPartyFull|C_PartyInfo.IsPartyFull]](<span class="apiarg">[category]</span>) : <span class="apiret">isFull</span>
: [[API C_PartyInfo.LeaveParty|C_PartyInfo.LeaveParty]](<span class="apiarg">[category]</span>) - Quit the party, often useful to troubleshoot "phantom party" bugs which may list you in a party when you are in fact not.
+
: [[API C_PartyInfo.LeaveParty|C_PartyInfo.LeaveParty]](<span class="apiarg">[category]</span>) - Leaves the group.
: [[API AcceptGroup|AcceptGroup]]() - Accept the invitation to party.
+
: [[API AcceptGroup|AcceptGroup]]() - Accepts the invitation from a group.
: [[API ConfirmReadyCheck|ConfirmReadyCheck]](<span class="apiarg">isReady</span>) - Indicate if you are ready or not.
+
: [[API ConfirmReadyCheck|ConfirmReadyCheck]](<span class="apiarg">isReady</span>) - Responds to a ready check.
 
: [[API DeclineGroup|DeclineGroup]]() - Decline the invitation to a party.
 
: [[API DeclineGroup|DeclineGroup]]() - Decline the invitation to a party.
: [[API DoReadyCheck|DoReadyCheck]]() - Initiate a ready check.
+
: [[API DoReadyCheck|DoReadyCheck]]() - Initiates a ready check.
 
: [[API GetHomePartyInfo|GetHomePartyInfo]]()
 
: [[API GetHomePartyInfo|GetHomePartyInfo]]()
 
: [[API GetInviteConfirmationInfo|GetInviteConfirmationInfo]](<span class="apiarg">guid</span>)
 
: [[API GetInviteConfirmationInfo|GetInviteConfirmationInfo]](<span class="apiarg">guid</span>)
 
: [[API GetNextPendingInviteConfirmation|GetNextPendingInviteConfirmation]]()
 
: [[API GetNextPendingInviteConfirmation|GetNextPendingInviteConfirmation]]()
: [[API GetNumGroupMembers|GetNumGroupMembers]](<span class="apiarg">[groupType]</span>) - Returns the total number of players in your group/raid.
+
: [[API GetNumGroupMembers|GetNumGroupMembers]](<span class="apiarg">[groupType]</span>) - Returns the number of players in the group.
: [[API GetNumSubgroupMembers|GetNumSubgroupMembers]](<span class="apiarg">[groupType]</span>) - Returns the number of ''other'' players in your party (or raid subgroup).
+
: [[API GetNumSubgroupMembers|GetNumSubgroupMembers]](<span class="apiarg">[groupType]</span>) - Returns the number of other players in the party or raid subgroup.
 
: [[API GetPendingInviteConfirmations|GetPendingInviteConfirmations]]()
 
: [[API GetPendingInviteConfirmations|GetPendingInviteConfirmations]]()
 
: [[API GetReadyCheckStatus|GetReadyCheckStatus]](<span class="apiarg">unit</span>) - Returns a group member's response to the current ready check.
 
: [[API GetReadyCheckStatus|GetReadyCheckStatus]](<span class="apiarg">unit</span>) - Returns a group member's response to the current ready check.
Line 2,169: Line 2,201:
 
: [[API InGuildParty|InGuildParty]]()
 
: [[API InGuildParty|InGuildParty]]()
 
: [[API IsGUIDInGroup|IsGUIDInGroup]](<span class="apiarg">guid [, groupType]</span>)
 
: [[API IsGUIDInGroup|IsGUIDInGroup]](<span class="apiarg">guid [, groupType]</span>)
: [[API IsInGroup|IsInGroup]](<span class="apiarg">[groupType]</span>) - Returns true if in a group.
+
: [[API IsInGroup|IsInGroup]](<span class="apiarg">[groupType]</span>) - True if the player is in a group.
 
: [[API IsInGuildGroup|IsInGuildGroup]]()
 
: [[API IsInGuildGroup|IsInGuildGroup]]()
: [[API IsInRaid|IsInRaid]](<span class="apiarg">[groupType]</span>) - Returns true if in a raid.
+
: [[API IsInRaid|IsInRaid]](<span class="apiarg">[groupType]</span>) - True if the player is in a raid.
: [[API PromoteToLeader|PromoteToLeader]](<span class="apiarg">unit</span>) - Promote a unit to party leader.
+
: [[API PromoteToLeader|PromoteToLeader]](<span class="apiarg">unit</span>) - Promotes a unit to group leader.
 
: [[API RespondToInviteConfirmation|RespondToInviteConfirmation]](<span class="apiarg">guid, accept</span>)
 
: [[API RespondToInviteConfirmation|RespondToInviteConfirmation]](<span class="apiarg">guid, accept</span>)
: <small>HW</small> [[API UninviteUnit|UninviteUnit]](<span class="apiarg">name [, reason]</span>) - Kick a unit from the party if player is group leader; or initiate a kick vote in an LFD group.
+
: <small>''HW''</small> [[API UninviteUnit|UninviteUnit]](<span class="apiarg">name [, reason]</span>) - Removes a player from the group if you're the leader, or initiates a vote to kick.
 
: [[API UnitInAnyGroup|UnitInAnyGroup]]()
 
: [[API UnitInAnyGroup|UnitInAnyGroup]]()
: [[API UnitInParty|UnitInParty]](<span class="apiarg">unit</span>) - Returns true if the unit is a member of your party.
+
: [[API UnitInParty|UnitInParty]](<span class="apiarg">unit</span>) - True if the unit is a member of your party.
 
: [[API UnitIsGroupLeader|UnitIsGroupLeader]](<span class="apiarg">unit [, partyCategory]</span>) - Returns whether the unit is the leader of a party or raid.
 
: [[API UnitIsGroupLeader|UnitIsGroupLeader]](<span class="apiarg">unit [, partyCategory]</span>) - Returns whether the unit is the leader of a party or raid.
  +
Cross Realm
  +
: [[API C_PartyInfo.CanFormCrossFactionParties|C_PartyInfo.CanFormCrossFactionParties]]() : <span class="apiret">canFormCrossFactionParties</span>
  +
: [[API C_PartyInfo.IsCrossFactionParty|C_PartyInfo.IsCrossFactionParty]](<span class="apiarg">[category]</span>) : <span class="apiret">isCrossFactionParty</span>
   
==== Raid Groups ====
+
====Raid Groups====
 
: [[API ClearPartyAssignment|ClearPartyAssignment]]()
 
: [[API ClearPartyAssignment|ClearPartyAssignment]]()
 
: [[API DemoteAssistant|DemoteAssistant]](<span class="apiarg">unit</span>) - Demotes player from assistant status. Requires raid leadership.
 
: [[API DemoteAssistant|DemoteAssistant]](<span class="apiarg">unit</span>) - Demotes player from assistant status. Requires raid leadership.
 
: [[API GetAllowLowLevelRaid|GetAllowLowLevelRaid]]() - Returns whether joining low-level raids is enabled for the current character.
 
: [[API GetAllowLowLevelRaid|GetAllowLowLevelRaid]]() - Returns whether joining low-level raids is enabled for the current character.
: [[API GetPartyAssignment|GetPartyAssignment]](<span class="apiarg">assignment [, unit, exactMatch]</span>) - Returns a value based on whether the unit is assigned to given role.
+
: [[API GetPartyAssignment|GetPartyAssignment]](<span class="apiarg">assignment [, unit, exactMatch]</span>) - True if a group member is assigned the main tank/assist role.
: [[API GetRaidRosterInfo|GetRaidRosterInfo]](<span class="apiarg">index</span>) - Returns information about the members of your raid.
+
: [[API GetRaidRosterInfo|GetRaidRosterInfo]](<span class="apiarg">index</span>) - Returns info for a member of your raid.
 
: [[API InitiateRolePoll|InitiateRolePoll]]()
 
: [[API InitiateRolePoll|InitiateRolePoll]]()
 
: [[API IsEveryoneAssistant|IsEveryoneAssistant]]()
 
: [[API IsEveryoneAssistant|IsEveryoneAssistant]]()
Line 2,190: Line 2,225:
 
: [[API SetAllowLowLevelRaid|SetAllowLowLevelRaid]](<span class="apiarg">allowed</span>) - Controls whether the current character can join low-level raids.
 
: [[API SetAllowLowLevelRaid|SetAllowLowLevelRaid]](<span class="apiarg">allowed</span>) - Controls whether the current character can join low-level raids.
 
: [[API SetEveryoneIsAssistant|SetEveryoneIsAssistant]]()
 
: [[API SetEveryoneIsAssistant|SetEveryoneIsAssistant]]()
: <small>PROTECTED</small> [[API SetPartyAssignment|SetPartyAssignment]](<span class="apiarg">assignment, player</span>)
+
: <small>''PROTECTED''</small> [[API SetPartyAssignment|SetPartyAssignment]](<span class="apiarg">assignment, player</span>)
: <small>NOCOMBAT</small> [[API SetRaidSubgroup|SetRaidSubgroup]](<span class="apiarg">index, subgroup</span>) - Move a raid member from his current subgroup into a different (non-full) subgroup.
+
: <small>''NOCOMBAT''</small> [[API SetRaidSubgroup|SetRaidSubgroup]](<span class="apiarg">index, subgroup</span>) - Move a raid member from his current subgroup into a different (non-full) subgroup.
: <small>NOCOMBAT</small> [[API SwapRaidSubgroup|SwapRaidSubgroup]](<span class="apiarg">index1, index2</span>) - Swaps raid members into different groups.
+
: <small>''NOCOMBAT''</small> [[API SwapRaidSubgroup|SwapRaidSubgroup]](<span class="apiarg">index1, index2</span>) - Swaps two raid members into different groups.
: [[API UnitInRaid|UnitInRaid]](<span class="apiarg">unit</span>) - Returns 1 if unit is in your raid, nil if not.
+
: [[API UnitInRaid|UnitInRaid]](<span class="apiarg">unit</span>) - Returns the index if the unit is in your raid group.
 
: [[API UnitInSubgroup|UnitInSubgroup]]()
 
: [[API UnitInSubgroup|UnitInSubgroup]]()
 
Relates to [[Target_marker|Raid Target]]s and [[World Marker]]s.
 
Relates to [[Target_marker|Raid Target]]s and [[World Marker]]s.
: [[API CanBeRaidTarget|CanBeRaidTarget]](<span class="apiarg">unit</span>) - Returns if a unit can be marked with a raid target symbol.
+
: [[API CanBeRaidTarget|CanBeRaidTarget]](<span class="apiarg">unit</span>) - True if the unit can be marked with a raid target icon.
 
: [[API ClearRaidMarker|ClearRaidMarker]](<span class="apiarg">index</span>) - Removes a raid marker from the world.
 
: [[API ClearRaidMarker|ClearRaidMarker]](<span class="apiarg">index</span>) - Removes a raid marker from the world.
: [[API GetRaidTargetIndex|GetRaidTargetIndex]](<span class="apiarg">unit</span>) - Get the raid target index assigned to a unit.
+
: [[API GetRaidTargetIndex|GetRaidTargetIndex]](<span class="apiarg">unit</span>) - Returns the [[Target marker|raid target]] of a unit.
 
: [[API IsRaidMarkerActive|IsRaidMarkerActive]](<span class="apiarg">index</span>) - Returns whether or not the raid marker specified by index is active.
 
: [[API IsRaidMarkerActive|IsRaidMarkerActive]](<span class="apiarg">index</span>) - Returns whether or not the raid marker specified by index is active.
: <small>PROTECTED</small> [[API PlaceRaidMarker|PlaceRaidMarker]](<span class="apiarg">index</span>) - Brings up a targeting circle to place a raid marker in the world.
+
: <small>''PROTECTED''</small> [[API PlaceRaidMarker|PlaceRaidMarker]](<span class="apiarg">index</span>) - Brings up a targeting circle to place a raid marker in the world.
: [[API SetRaidTarget|SetRaidTarget]](<span class="apiarg">unit, index</span>) - Sets a raid icon on a unit.
+
: [[API SetRaidTarget|SetRaidTarget]](<span class="apiarg">unit, index</span>) - Assigns a [[Target marker|raid target]] icon to a unit.
 
: [[API SetRaidTargetProtected|SetRaidTargetProtected]](<span class="apiarg">unit, index</span>)
 
: [[API SetRaidTargetProtected|SetRaidTargetProtected]](<span class="apiarg">unit, index</span>)
: <small>UI</small> [[API SetRaidTargetIcon|SetRaidTargetIcon]](<span class="apiarg">unit, index</span>) - Sets or resets a raid icon on a unit.
+
: <small>''UI''</small> [[API SetRaidTargetIcon|SetRaidTargetIcon]](<span class="apiarg">unit, index</span>) - Sets or resets a raid icon on a unit.
 
Raid Profiles
 
Raid Profiles
 
: [[API CreateNewRaidProfile|CreateNewRaidProfile]](<span class="apiarg">name [, baseOnProfile]</span>)
 
: [[API CreateNewRaidProfile|CreateNewRaidProfile]](<span class="apiarg">name [, baseOnProfile]</span>)
Line 2,221: Line 2,256:
 
: [[API SetRaidProfileSavedPosition|SetRaidProfileSavedPosition]](<span class="apiarg">profile, isDynamic, topPoint, topOffset, bottomPoint, bottomOffset, leftPoint, leftOffset</span>)
 
: [[API SetRaidProfileSavedPosition|SetRaidProfileSavedPosition]](<span class="apiarg">profile, isDynamic, topPoint, topOffset, bottomPoint, bottomOffset, leftPoint, leftOffset</span>)
   
==== Party Sync ====
+
====Party Sync====
 
[[Party Sync]] was added in [[Patch 8.2.5]]
 
[[Party Sync]] was added in [[Patch 8.2.5]]
 
: [[API C_LevelLink.IsActionLocked|C_LevelLink.IsActionLocked]](<span class="apiarg">actionID</span>) : <span class="apiret">isLocked</span>
 
: [[API C_LevelLink.IsActionLocked|C_LevelLink.IsActionLocked]](<span class="apiarg">actionID</span>) : <span class="apiret">isLocked</span>
Line 2,245: Line 2,280:
 
: [[API ConfirmBNRequestInviteFriend|ConfirmBNRequestInviteFriend]](<span class="apiarg">presenceID [, tank, heal, dps]</span>)
 
: [[API ConfirmBNRequestInviteFriend|ConfirmBNRequestInviteFriend]](<span class="apiarg">presenceID [, tank, heal, dps]</span>)
   
=== Group Finder ===
+
===Group Finder===
 
The Looking For Group tool was added in [[Patch 2.0.1]]. It was renamed to the [[Dungeon Finder]] in [[Patch 3.3.0]] and raid queuing moved to a separate [[Raid Browser]]. The [[Raid Finder]] was added in [[Patch 4.3.0]] and merged into the Dungeon Finder in [[Patch 5.0.4]]. The Dungeon Finder was reworked in [[Patch 6.0.2]] into the [[Group Finder]].
 
The Looking For Group tool was added in [[Patch 2.0.1]]. It was renamed to the [[Dungeon Finder]] in [[Patch 3.3.0]] and raid queuing moved to a separate [[Raid Browser]]. The [[Raid Finder]] was added in [[Patch 4.3.0]] and merged into the Dungeon Finder in [[Patch 5.0.4]]. The Dungeon Finder was reworked in [[Patch 6.0.2]] into the [[Group Finder]].
 
: [[API C_LFGInfo.CanPlayerUseGroupFinder|C_LFGInfo.CanPlayerUseGroupFinder]]() : <span class="apiret">canUse, failureReason</span>
 
: [[API C_LFGInfo.CanPlayerUseGroupFinder|C_LFGInfo.CanPlayerUseGroupFinder]]() : <span class="apiret">canUse, failureReason</span>
Line 2,258: Line 2,293:
 
: [[API C_LFGInfo.GetRoleCheckDifficultyDetails|C_LFGInfo.GetRoleCheckDifficultyDetails]]() : <span class="apiret">maxLevel, isLevelReduced</span>
 
: [[API C_LFGInfo.GetRoleCheckDifficultyDetails|C_LFGInfo.GetRoleCheckDifficultyDetails]]() : <span class="apiret">maxLevel, isLevelReduced</span>
 
: [[API C_LFGInfo.HideNameFromUI|C_LFGInfo.HideNameFromUI]](<span class="apiarg">dungeonID</span>) : <span class="apiret">shouldHide</span>
 
: [[API C_LFGInfo.HideNameFromUI|C_LFGInfo.HideNameFromUI]](<span class="apiarg">dungeonID</span>) : <span class="apiret">shouldHide</span>
: [[API AcceptProposal|AcceptProposal]]() - Accept an LFD group invite and enter the dungeon.
+
: [[API AcceptProposal|AcceptProposal]]() - Enters the Dungeon if the LFG queue is ready.
 
: [[API GetDungeonForRandomSlot|GetDungeonForRandomSlot]](<span class="apiarg">randomID, index</span>)
 
: [[API GetDungeonForRandomSlot|GetDungeonForRandomSlot]](<span class="apiarg">randomID, index</span>)
 
: [[API GetGroupMemberCounts|GetGroupMemberCounts]]()
 
: [[API GetGroupMemberCounts|GetGroupMemberCounts]]()
Line 2,267: Line 2,302:
 
: [[API IsAllowedToUserTeleport|IsAllowedToUserTeleport]]()
 
: [[API IsAllowedToUserTeleport|IsAllowedToUserTeleport]]()
 
: [[API IsServerControlledBackfill|IsServerControlledBackfill]]()
 
: [[API IsServerControlledBackfill|IsServerControlledBackfill]]()
: [[API RejectProposal|RejectProposal]]() - Rejects an LFG group invite and exits the queue.
+
: [[API RejectProposal|RejectProposal]]() - Declines a LFG invite and leaves the queue.
: [[API RequestBattlegroundInstanceInfo|RequestBattlegroundInstanceInfo]](<span class="apiarg">index</span>) - Requests data about the available instances of a battleground.
+
: [[API RequestBattlegroundInstanceInfo|RequestBattlegroundInstanceInfo]](<span class="apiarg">index</span>) - Requests the available instances of a battleground.
   
==== LFGList ====
+
====LFGList====
 
: [[API C_LFGList.AcceptInvite|C_LFGList.AcceptInvite]](<span class="apiarg">resultID</span>)
 
: [[API C_LFGList.AcceptInvite|C_LFGList.AcceptInvite]](<span class="apiarg">resultID</span>)
 
: [[API C_LFGList.ApplyToGroup|C_LFGList.ApplyToGroup]](<span class="apiarg">resultID, comment, tank, healer, dps</span>)
 
: [[API C_LFGList.ApplyToGroup|C_LFGList.ApplyToGroup]](<span class="apiarg">resultID, comment, tank, healer, dps</span>)
Line 2,281: Line 2,316:
 
: [[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]]()
: <small>HW</small> [[API C_LFGList.CreateListing|C_LFGList.CreateListing]](<span class="apiarg">activityID, itemLevel, honorLevel [, autoAccept, privateGroup, questID]</span>) - Creates a group finder listing.
+
: <small>''HW''</small> [[API C_LFGList.CreateListing|C_LFGList.CreateListing]](<span class="apiarg">activityID, itemLevel, honorLevel [, autoAccept, privateGroup, questID]</span>) - Creates a group finder listing.
 
: [[API C_LFGList.DeclineApplicant|C_LFGList.DeclineApplicant]](<span class="apiarg">applicantID</span>)
 
: [[API C_LFGList.DeclineApplicant|C_LFGList.DeclineApplicant]](<span class="apiarg">applicantID</span>)
 
: [[API C_LFGList.DeclineInvite|C_LFGList.DeclineInvite]](<span class="apiarg">searchResultID</span>)
 
: [[API C_LFGList.DeclineInvite|C_LFGList.DeclineInvite]](<span class="apiarg">searchResultID</span>)
Line 2,287: Line 2,322:
 
: [[API C_LFGList.GetActiveEntryInfo|C_LFGList.GetActiveEntryInfo]]() : <span class="apiret">entryData</span> - Returns information about your currently listed group.
 
: [[API C_LFGList.GetActiveEntryInfo|C_LFGList.GetActiveEntryInfo]]() : <span class="apiret">entryData</span> - Returns information about your currently listed group.
 
: [[API C_LFGList.GetActivityFullName|C_LFGList.GetActivityFullName]](<span class="apiarg">activityID [, questID, showWarmode]</span>) : <span class="apiret">fullName</span>
 
: [[API C_LFGList.GetActivityFullName|C_LFGList.GetActivityFullName]](<span class="apiarg">activityID [, questID, showWarmode]</span>) : <span class="apiret">fullName</span>
: [[API C_LFGList.GetActivityGroupInfo|C_LFGList.GetActivityGroupInfo]](<span class="apiarg">groupID</span>) : <span class="apiret">name, orderIndex</span> - Returns information about an activity group.
+
: [[API C_LFGList.GetActivityGroupInfo|C_LFGList.GetActivityGroupInfo]](<span class="apiarg">groupID</span>) : <span class="apiret">name, orderIndex</span> - Returns info for an activity group.
 
: [[API C_LFGList.GetActivityIDForQuestID|C_LFGList.GetActivityIDForQuestID]](<span class="apiarg">questID</span>)
 
: [[API C_LFGList.GetActivityIDForQuestID|C_LFGList.GetActivityIDForQuestID]](<span class="apiarg">questID</span>)
: [[API C_LFGList.GetActivityInfoExpensive|C_LFGList.GetActivityInfoExpensive]](<span class="apiarg">activityID</span>) - Checks if you are in the zone associated with an activity.
+
: [[API C_LFGList.GetActivityInfoExpensive|C_LFGList.GetActivityInfoExpensive]](<span class="apiarg">activityID</span>) - Returns the zone associated with an activity.
 
: [[API C_LFGList.GetActivityInfoTable|C_LFGList.GetActivityInfoTable]](<span class="apiarg">activityID [, questID, showWarmode]</span>) : <span class="apiret">activityInfo</span>
 
: [[API C_LFGList.GetActivityInfoTable|C_LFGList.GetActivityInfoTable]](<span class="apiarg">activityID [, questID, showWarmode]</span>) : <span class="apiret">activityInfo</span>
 
: [[API C_LFGList.GetApplicantDungeonScoreForListing|C_LFGList.GetApplicantDungeonScoreForListing]](<span class="apiarg">localID, applicantIndex, activityID</span>) : <span class="apiret">bestDungeonScoreForListing</span>
 
: [[API C_LFGList.GetApplicantDungeonScoreForListing|C_LFGList.GetApplicantDungeonScoreForListing]](<span class="apiarg">localID, applicantIndex, activityID</span>) : <span class="apiret">bestDungeonScoreForListing</span>
 
: [[API C_LFGList.GetApplicantInfo|C_LFGList.GetApplicantInfo]](<span class="apiarg">applicantID</span>) : <span class="apiret">applicantData</span> - Returns status informations and custom message of an applicant.
 
: [[API C_LFGList.GetApplicantInfo|C_LFGList.GetApplicantInfo]](<span class="apiarg">applicantID</span>) : <span class="apiret">applicantData</span> - Returns status informations and custom message of an applicant.
: [[API C_LFGList.GetApplicantMemberInfo|C_LFGList.GetApplicantMemberInfo]](<span class="apiarg">applicantID</span>) - Returns name, class, level and more about an applicant group member.
+
: [[API C_LFGList.GetApplicantMemberInfo|C_LFGList.GetApplicantMemberInfo]](<span class="apiarg">applicantID</span>) - Returns info for an applicant.
: [[API C_LFGList.GetApplicantMemberStats|C_LFGList.GetApplicantMemberStats]](<span class="apiarg">applicantID</span>) - Returns stats about an applicant group member.
+
: [[API C_LFGList.GetApplicantMemberStats|C_LFGList.GetApplicantMemberStats]](<span class="apiarg">applicantID</span>) - Returns the [[Proving Grounds]] stats of an applicant.
 
: [[API C_LFGList.GetApplicantPvpRatingInfoForListing|C_LFGList.GetApplicantPvpRatingInfoForListing]](<span class="apiarg">localID, applicantIndex, activityID</span>) : <span class="apiret">pvpRatingInfo</span>
 
: [[API C_LFGList.GetApplicantPvpRatingInfoForListing|C_LFGList.GetApplicantPvpRatingInfoForListing]](<span class="apiarg">localID, applicantIndex, activityID</span>) : <span class="apiret">pvpRatingInfo</span>
: [[API C_LFGList.GetApplicants|C_LFGList.GetApplicants]]() - Returns a table with applicantIDs.
+
: [[API C_LFGList.GetApplicants|C_LFGList.GetApplicants]]() - Returns the list of applicants to your group.
 
: [[API C_LFGList.GetApplicationInfo|C_LFGList.GetApplicationInfo]](<span class="apiarg">searchResultID</span>)
 
: [[API C_LFGList.GetApplicationInfo|C_LFGList.GetApplicationInfo]](<span class="apiarg">searchResultID</span>)
 
: [[API C_LFGList.GetApplications|C_LFGList.GetApplications]]()
 
: [[API C_LFGList.GetApplications|C_LFGList.GetApplications]]()
: [[API C_LFGList.GetAvailableActivities|C_LFGList.GetAvailableActivities]](<span class="apiarg">[categoryID, groupID, filter]</span>) - Returns a list of available activityIDs.
+
: [[API C_LFGList.GetAvailableActivities|C_LFGList.GetAvailableActivities]](<span class="apiarg">[categoryID, groupID, filter]</span>) - Returns a list of available LFG activities.
: [[API C_LFGList.GetAvailableActivityGroups|C_LFGList.GetAvailableActivityGroups]](<span class="apiarg">categoryID [, filter]</span>) - Returns a list of available groupIDs.
+
: [[API C_LFGList.GetAvailableActivityGroups|C_LFGList.GetAvailableActivityGroups]](<span class="apiarg">categoryID [, filter]</span>) - Returns a list of available LFG groups.
: [[API C_LFGList.GetAvailableCategories|C_LFGList.GetAvailableCategories]](<span class="apiarg">[filter]</span>) - Returns a list of available categoryIDs.
+
: [[API C_LFGList.GetAvailableCategories|C_LFGList.GetAvailableCategories]](<span class="apiarg">[filter]</span>) - Returns a list of available LFG categories.
 
: [[API C_LFGList.GetAvailableLanguageSearchFilter|C_LFGList.GetAvailableLanguageSearchFilter]]()
 
: [[API C_LFGList.GetAvailableLanguageSearchFilter|C_LFGList.GetAvailableLanguageSearchFilter]]()
 
: [[API C_LFGList.GetAvailableRoles|C_LFGList.GetAvailableRoles]]()
 
: [[API C_LFGList.GetAvailableRoles|C_LFGList.GetAvailableRoles]]()
Line 2,331: Line 2,366:
 
: [[API C_LFGList.RemoveApplicant|C_LFGList.RemoveApplicant]](<span class="apiarg">applicantID</span>)
 
: [[API C_LFGList.RemoveApplicant|C_LFGList.RemoveApplicant]](<span class="apiarg">applicantID</span>)
 
: [[API C_LFGList.RemoveListing|C_LFGList.RemoveListing]]()
 
: [[API C_LFGList.RemoveListing|C_LFGList.RemoveListing]]()
: [[API C_LFGList.ReportApplicant|C_LFGList.ReportApplicant]](<span class="apiarg">applicantID</span>)
 
: [[API C_LFGList.ReportSearchResult|C_LFGList.ReportSearchResult]](<span class="apiarg">resultID, complaintType</span>)
 
 
: [[API C_LFGList.RequestAvailableActivities|C_LFGList.RequestAvailableActivities]]()
 
: [[API C_LFGList.RequestAvailableActivities|C_LFGList.RequestAvailableActivities]]()
 
: [[API C_LFGList.SaveLanguageSearchFilter|C_LFGList.SaveLanguageSearchFilter]](<span class="apiarg">enabled</span>)
 
: [[API C_LFGList.SaveLanguageSearchFilter|C_LFGList.SaveLanguageSearchFilter]](<span class="apiarg">enabled</span>)
: [[API C_LFGList.Search|C_LFGList.Search]](<span class="apiarg">categoryID [, filter, preferredFilters, languageFilter]</span>)
+
: [[API C_LFGList.Search|C_LFGList.Search]](<span class="apiarg">categoryID [, filter, preferredFilters, languageFilter, searchCrossFactionListings]</span>)
 
: [[API C_LFGList.SetApplicantMemberRole|C_LFGList.SetApplicantMemberRole]](<span class="apiarg">applicantID, memberIndex, role</span>)
 
: [[API C_LFGList.SetApplicantMemberRole|C_LFGList.SetApplicantMemberRole]](<span class="apiarg">applicantID, memberIndex, role</span>)
 
: [[API C_LFGList.SetEntryTitle|C_LFGList.SetEntryTitle]](<span class="apiarg">activityID, groupID [, playstyle]</span>)
 
: [[API C_LFGList.SetEntryTitle|C_LFGList.SetEntryTitle]](<span class="apiarg">activityID, groupID [, playstyle]</span>)
Line 2,343: Line 2,376:
 
: [[API C_LFGList.ValidateRequiredDungeonScore|C_LFGList.ValidateRequiredDungeonScore]](<span class="apiarg">dungeonScore</span>) : <span class="apiret">passes</span>
 
: [[API C_LFGList.ValidateRequiredDungeonScore|C_LFGList.ValidateRequiredDungeonScore]](<span class="apiarg">dungeonScore</span>) : <span class="apiret">passes</span>
 
: [[API C_LFGList.ValidateRequiredPvpRatingForActivity|C_LFGList.ValidateRequiredPvpRatingForActivity]](<span class="apiarg">activityID, rating</span>) : <span class="apiret">passes</span>
 
: [[API C_LFGList.ValidateRequiredPvpRatingForActivity|C_LFGList.ValidateRequiredPvpRatingForActivity]](<span class="apiarg">activityID, rating</span>) : <span class="apiret">passes</span>
: <small>DEPRECATED</small> [[API C_LFGList.GetActivityInfo|C_LFGList.GetActivityInfo]](<span class="apiarg">activityID</span>) - Returns information about an activity for premade groups.
+
: <small>''DEPRECATED''</small> [[API C_LFGList.GetActivityInfo|C_LFGList.GetActivityInfo]](<span class="apiarg">activityID</span>) - Returns information about an activity for premade groups.
: <small>DEPRECATED</small> [[API C_LFGList.GetCategoryInfo|C_LFGList.GetCategoryInfo]](<span class="apiarg">categoryID</span>) - Returns information about a specific category.
+
: <small>''DEPRECATED''</small> [[API C_LFGList.GetCategoryInfo|C_LFGList.GetCategoryInfo]](<span class="apiarg">categoryID</span>) - Returns information about a specific category.
   
==== LFG ====
+
====LFG====
 
LFG is used for for generic functions/values that may be used for LFD, LFR, and any other LF_ system we may implement in the future.<sup>[https://github.com/Gethe/wow-ui-source/blob/live/Interface/FrameXML/LFGFrame.lua]</sup>
 
LFG is used for for generic functions/values that may be used for LFD, LFR, and any other LF_ system we may implement in the future.<sup>[https://github.com/Gethe/wow-ui-source/blob/live/Interface/FrameXML/LFGFrame.lua]</sup>
 
: [[API CanPartyLFGBackfill|CanPartyLFGBackfill]]() - Returns whether the party is eligible to recruit additional members from the LFG pool.
 
: [[API CanPartyLFGBackfill|CanPartyLFGBackfill]]() - Returns whether the party is eligible to recruit additional members from the LFG pool.
Line 2,352: Line 2,385:
 
: [[API CompleteLFGReadyCheck|CompleteLFGReadyCheck]](<span class="apiarg">isReady</span>)
 
: [[API CompleteLFGReadyCheck|CompleteLFGReadyCheck]](<span class="apiarg">isReady</span>)
 
: [[API CompleteLFGRoleCheck|CompleteLFGRoleCheck]](<span class="apiarg">isReady</span>) - Returns true if the role check was successful.
 
: [[API CompleteLFGRoleCheck|CompleteLFGRoleCheck]](<span class="apiarg">isReady</span>) - Returns true if the role check was successful.
: [[API GetLFGBootProposal|GetLFGBootProposal]]() - Returns info about a LFG Kick vote in progress.
+
: [[API GetLFGBootProposal|GetLFGBootProposal]]() - Returns info for a LFG votekick in progress.
 
: [[API GetLFGCategoryForID|GetLFGCategoryForID]](<span class="apiarg">partySlot</span>)
 
: [[API GetLFGCategoryForID|GetLFGCategoryForID]](<span class="apiarg">partySlot</span>)
 
: [[API GetLFGCompletionReward|GetLFGCompletionReward]]()
 
: [[API GetLFGCompletionReward|GetLFGCompletionReward]]()
Line 2,359: Line 2,392:
 
: [[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 class="apiarg">dungeonID, encounterIndex</span>)
 
: [[API GetLFGDungeonEncounterInfo|GetLFGDungeonEncounterInfo]](<span class="apiarg">dungeonID, encounterIndex</span>)
: [[API GetLFGDungeonInfo|GetLFGDungeonInfo]](<span class="apiarg">dungeonID</span>) - Returns dungeon information.
+
: [[API GetLFGDungeonInfo|GetLFGDungeonInfo]](<span class="apiarg">dungeonID</span>) - Returns info for a LFG dungeon.
 
: [[API GetLFGDungeonNumEncounters|GetLFGDungeonNumEncounters]](<span class="apiarg">dungeonID</span>)
 
: [[API GetLFGDungeonNumEncounters|GetLFGDungeonNumEncounters]](<span class="apiarg">dungeonID</span>)
: [[API GetLFGDungeonRewardCapBarInfo|GetLFGDungeonRewardCapBarInfo]](<span class="apiarg">dungeonID</span>) - Returns information on the weekly point limits.
+
: [[API GetLFGDungeonRewardCapBarInfo|GetLFGDungeonRewardCapBarInfo]](<span class="apiarg">dungeonID</span>) - Returns the weekly limits reward for a currency (e.g. Valor Point Cap).
 
: [[API GetLFGDungeonRewardCapInfo|GetLFGDungeonRewardCapInfo]](<span class="apiarg">dungeonID</span>)
 
: [[API GetLFGDungeonRewardCapInfo|GetLFGDungeonRewardCapInfo]](<span class="apiarg">dungeonID</span>)
 
: [[API GetLFGDungeonRewardInfo|GetLFGDungeonRewardInfo]](<span class="apiarg">dungeonID, rewardIndex</span>)
 
: [[API GetLFGDungeonRewardInfo|GetLFGDungeonRewardInfo]](<span class="apiarg">dungeonID, rewardIndex</span>)
Line 2,375: Line 2,408:
 
: [[API GetLFGProposalMember|GetLFGProposalMember]](<span class="apiarg">memberIndex</span>) - Returns info about the players in the LFG proposal.
 
: [[API GetLFGProposalMember|GetLFGProposalMember]](<span class="apiarg">memberIndex</span>) - Returns info about the players in the LFG proposal.
 
: [[API GetLFGQueuedList|GetLFGQueuedList]](<span class="apiarg">category [, table]</span>)
 
: [[API GetLFGQueuedList|GetLFGQueuedList]](<span class="apiarg">category [, table]</span>)
: [[API GetLFGQueueStats|GetLFGQueueStats]](<span class="apiarg">category [, lfgID]</span>) - Returns current state and wait times for being in queue.
+
: [[API GetLFGQueueStats|GetLFGQueueStats]](<span class="apiarg">category [, lfgID]</span>) - Returns info for the current LFG 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 class="apiarg">index</span>) - Returns information about a random dungeon queue.
 
: [[API GetLFGRandomDungeonInfo|GetLFGRandomDungeonInfo]](<span class="apiarg">index</span>) - Returns information about a random dungeon queue.
 
: [[API GetLFGReadyCheckUpdate|GetLFGReadyCheckUpdate]]()
 
: [[API GetLFGReadyCheckUpdate|GetLFGReadyCheckUpdate]]()
 
: [[API GetLFGReadyCheckUpdateBattlegroundInfo|GetLFGReadyCheckUpdateBattlegroundInfo]]()
 
: [[API GetLFGReadyCheckUpdateBattlegroundInfo|GetLFGReadyCheckUpdateBattlegroundInfo]]()
: [[API GetLFGRoles|GetLFGRoles]]() - Returns the roles you signed up as, not the role you were assigned.
+
: [[API GetLFGRoles|GetLFGRoles]]() - Returns the roles the player signed up for in the Dungeon Finder.
: [[API GetLFGRoleShortageRewards|GetLFGRoleShortageRewards]](<span class="apiarg">dungeonID, shortageIndex</span>) - Returns information about the LFG Call to Arms rewards.
+
: [[API GetLFGRoleShortageRewards|GetLFGRoleShortageRewards]](<span class="apiarg">dungeonID, shortageIndex</span>) - Returns info for the LFG [[Call_to_Arms_(dungeon)|Call to Arms]] rewards.
 
: [[API GetLFGRoleUpdate|GetLFGRoleUpdate]]()
 
: [[API GetLFGRoleUpdate|GetLFGRoleUpdate]]()
 
: [[API GetLFGRoleUpdateBattlegroundInfo|GetLFGRoleUpdateBattlegroundInfo]]()
 
: [[API GetLFGRoleUpdateBattlegroundInfo|GetLFGRoleUpdateBattlegroundInfo]]()
Line 2,398: Line 2,431:
 
: [[API LeaveLFG|LeaveLFG]](<span class="apiarg">category</span>)
 
: [[API LeaveLFG|LeaveLFG]](<span class="apiarg">category</span>)
 
: [[API LeaveSingleLFG|LeaveSingleLFG]](<span class="apiarg">category, lfgID</span>)
 
: [[API LeaveSingleLFG|LeaveSingleLFG]](<span class="apiarg">category, lfgID</span>)
: [[API LFGTeleport|LFGTeleport]](<span class="apiarg">[toSafety]</span>) - Teleports the player to or from a dungeon.
+
: [[API LFGTeleport|LFGTeleport]](<span class="apiarg">[toSafety]</span>) - Teleports the player to or from a LFG dungeon.
 
: [[API PartyLFGStartBackfill|PartyLFGStartBackfill]]()
 
: [[API PartyLFGStartBackfill|PartyLFGStartBackfill]]()
 
: [[API RefreshLFGList|RefreshLFGList]]()
 
: [[API RefreshLFGList|RefreshLFGList]]()
Line 2,407: Line 2,440:
 
: [[API SearchLFGGetResults|SearchLFGGetResults]](<span class="apiarg">[index]</span>)
 
: [[API SearchLFGGetResults|SearchLFGGetResults]](<span class="apiarg">[index]</span>)
 
: [[API SearchLFGLeave|SearchLFGLeave]]() - Removes yourself from looking through the Raid Browser. Equivalent to selecting "none" in the Raid Browser.
 
: [[API SearchLFGLeave|SearchLFGLeave]]() - Removes yourself from looking through the Raid Browser. Equivalent to selecting "none" in the Raid Browser.
: <small>HW</small> [[API SearchLFGJoin|SearchLFGJoin]](<span class="apiarg">typeID, lfgID</span>)
+
: <small>''HW''</small> [[API SearchLFGJoin|SearchLFGJoin]](<span class="apiarg">typeID, lfgID</span>)
 
: [[API SearchLFGSort|SearchLFGSort]](<span class="apiarg">type</span>)
 
: [[API SearchLFGSort|SearchLFGSort]](<span class="apiarg">type</span>)
 
: [[API SetLFGBootVote|SetLFGBootVote]](<span class="apiarg">shouldKick</span>) - Responds to a vote-kick.
 
: [[API SetLFGBootVote|SetLFGBootVote]](<span class="apiarg">shouldKick</span>) - Responds to a vote-kick.
: [[API SetLFGComment|SetLFGComment]](<span class="apiarg">[comment]</span>) - Sets the comment in the raid browser.
+
: [[API SetLFGComment|SetLFGComment]](<span class="apiarg">[comment]</span>) - Sets the comment in the LFG browser.
 
: [[API SetLFGDungeon|SetLFGDungeon]](<span class="apiarg">LE_LFG_CATEGORY, type</span>)
 
: [[API SetLFGDungeon|SetLFGDungeon]](<span class="apiarg">LE_LFG_CATEGORY, type</span>)
 
: [[API SetLFGDungeonEnabled|SetLFGDungeonEnabled]](<span class="apiarg">dungeonID, isEnabled</span>)
 
: [[API SetLFGDungeonEnabled|SetLFGDungeonEnabled]](<span class="apiarg">dungeonID, isEnabled</span>)
Line 2,416: Line 2,449:
 
: [[API SetLFGRoles|SetLFGRoles]](<span class="apiarg">[leader, tank, healer, dps]</span>) - Changes the selected roles.
 
: [[API SetLFGRoles|SetLFGRoles]](<span class="apiarg">[leader, tank, healer, dps]</span>) - Changes the selected roles.
   
==== LFD ====
+
====LFD====
 
LFD is used for Dungeon-specific functions and values
 
LFD is used for Dungeon-specific functions and values
 
: [[API DungeonAppearsInRandomLFD|DungeonAppearsInRandomLFD]](<span class="apiarg">dungeonID</span>)
 
: [[API DungeonAppearsInRandomLFD|DungeonAppearsInRandomLFD]](<span class="apiarg">dungeonID</span>)
Line 2,429: Line 2,462:
 
: [[API RequestLFDPlayerLockInfo|RequestLFDPlayerLockInfo]]()
 
: [[API RequestLFDPlayerLockInfo|RequestLFDPlayerLockInfo]]()
   
==== Flex Raid ====
+
====Flex Raid====
 
: [[API GetBestFlexRaidChoice|GetBestFlexRaidChoice]]()
 
: [[API GetBestFlexRaidChoice|GetBestFlexRaidChoice]]()
 
: [[API GetFlexRaidDungeonInfo|GetFlexRaidDungeonInfo]](<span class="apiarg">index</span>)
 
: [[API GetFlexRaidDungeonInfo|GetFlexRaidDungeonInfo]](<span class="apiarg">index</span>)
 
: [[API GetNumFlexRaidDungeons|GetNumFlexRaidDungeons]]()
 
: [[API GetNumFlexRaidDungeons|GetNumFlexRaidDungeons]]()
   
==== Raid Finder ====
+
====Raid Finder====
: [[API GetBestRFChoice|GetBestRFChoice]]() - Returns the suggested/default dungeonId for the Raid Finder.
+
: [[API GetBestRFChoice|GetBestRFChoice]]() - Returns the suggested raid for the Raid Finder.
 
: [[API GetLFRChoiceOrder|GetLFRChoiceOrder]](<span class="apiarg">[LFRRaidList]</span>)
 
: [[API GetLFRChoiceOrder|GetLFRChoiceOrder]](<span class="apiarg">[LFRRaidList]</span>)
 
: [[API GetNumRFDungeons|GetNumRFDungeons]]()
 
: [[API GetNumRFDungeons|GetNumRFDungeons]]()
 
: [[API GetRFDungeonInfo|GetRFDungeonInfo]](<span class="apiarg">index</span>)
 
: [[API GetRFDungeonInfo|GetRFDungeonInfo]](<span class="apiarg">index</span>)
   
==== Quick Join ====
+
====Quick Join====
 
[[Quick Join]] was added in [[Patch 7.1.0]]
 
[[Quick Join]] was added in [[Patch 7.1.0]]
 
: [[API C_PartyInfo.ConfirmRequestInviteFromUnit|C_PartyInfo.ConfirmRequestInviteFromUnit]](<span class="apiarg">targetName [, tank, healer, dps]</span>)
 
: [[API C_PartyInfo.ConfirmRequestInviteFromUnit|C_PartyInfo.ConfirmRequestInviteFromUnit]](<span class="apiarg">targetName [, tank, healer, dps]</span>)
Line 2,456: Line 2,489:
 
: [[API C_SocialQueue.SignalToastDisplayed|C_SocialQueue.SignalToastDisplayed]](<span class="apiarg">groupGUID, priority</span>)
 
: [[API C_SocialQueue.SignalToastDisplayed|C_SocialQueue.SignalToastDisplayed]](<span class="apiarg">groupGUID, priority</span>)
   
=== Guild ===
+
===Guild===
: [[API C_GuildInfo.CanEditOfficerNote|C_GuildInfo.CanEditOfficerNote]]() : <span class="apiret">canEditOfficerNote</span> - Returns if the player is allowed to edit guild officer notes.
+
: [[API C_GuildInfo.CanEditOfficerNote|C_GuildInfo.CanEditOfficerNote]]() : <span class="apiret">canEditOfficerNote</span> - True if the player can edit guild officer notes.
: [[API C_GuildInfo.CanSpeakInGuildChat|C_GuildInfo.CanSpeakInGuildChat]]() : <span class="apiret">canSpeakInGuildChat</span> - Returns if the player is allowed to use guild chat.
+
: [[API C_GuildInfo.CanSpeakInGuildChat|C_GuildInfo.CanSpeakInGuildChat]]() : <span class="apiret">canSpeakInGuildChat</span> - True if the player can use guild chat.
: [[API C_GuildInfo.CanViewOfficerNote|C_GuildInfo.CanViewOfficerNote]]() : <span class="apiret">canViewOfficerNote</span> - Returns if the player is allowed to view guild officer notes.
+
: [[API C_GuildInfo.CanViewOfficerNote|C_GuildInfo.CanViewOfficerNote]]() : <span class="apiret">canViewOfficerNote</span> - True if the player can view guild officer notes.
 
: [[API C_GuildInfo.GetGuildNewsInfo|C_GuildInfo.GetGuildNewsInfo]](<span class="apiarg">index</span>) : <span class="apiret">newsInfo</span>
 
: [[API C_GuildInfo.GetGuildNewsInfo|C_GuildInfo.GetGuildNewsInfo]](<span class="apiarg">index</span>) : <span class="apiret">newsInfo</span>
 
: [[API C_GuildInfo.GetGuildRankOrder|C_GuildInfo.GetGuildRankOrder]](<span class="apiarg">guid</span>) : <span class="apiret">rankOrder</span> - Returns the current rank of a guild member.
 
: [[API C_GuildInfo.GetGuildRankOrder|C_GuildInfo.GetGuildRankOrder]](<span class="apiarg">guid</span>) : <span class="apiret">rankOrder</span> - Returns the current rank of a guild member.
Line 2,472: Line 2,505:
 
: [[API C_GuildInfo.SetGuildRankOrder|C_GuildInfo.SetGuildRankOrder]](<span class="apiarg">guid, rankOrder</span>) - Sets the guild rank for a member.
 
: [[API C_GuildInfo.SetGuildRankOrder|C_GuildInfo.SetGuildRankOrder]](<span class="apiarg">guid, rankOrder</span>) - Sets the guild rank for a member.
 
: [[API C_GuildInfo.SetNote|C_GuildInfo.SetNote]](<span class="apiarg">guid, note, isPublic</span>) - Sets the guild note for a member.
 
: [[API C_GuildInfo.SetNote|C_GuildInfo.SetNote]](<span class="apiarg">guid, note, isPublic</span>) - Sets the guild note for a member.
  +
: [[API C_PlayerInfo.IsPlayerInGuildFromGUID|C_PlayerInfo.IsPlayerInGuildFromGUID]](<span class="apiarg">playerGUID</span>) : <span class="apiret">IsInGuild</span>
: [[API AcceptGuild|AcceptGuild]]() - The player accepts the invitation to join a guild.
 
: [[API BuyGuildCharter|BuyGuildCharter]](<span class="apiarg">guildName</span>) - Purchases a guild charter for ''guildName''.
+
: [[API AcceptGuild|AcceptGuild]]() - Accepts a guild invite.
  +
: [[API BuyGuildCharter|BuyGuildCharter]](<span class="apiarg">guildName</span>) - Purchases a [[Guild Charter]].
 
: [[API CanEditGuildEvent|CanEditGuildEvent]]() - Returns true if you are allowed to edit guild events (in the calendar).
 
: [[API CanEditGuildEvent|CanEditGuildEvent]]() - Returns true if you are allowed to edit guild events (in the calendar).
 
: [[API CanEditGuildInfo|CanEditGuildInfo]]() - Returns true if you are allowed to edit the guild info.
 
: [[API CanEditGuildInfo|CanEditGuildInfo]]() - Returns true if you are allowed to edit the guild info.
 
: [[API CanEditGuildTabInfo|CanEditGuildTabInfo]](<span class="apiarg">tab</span>)
 
: [[API CanEditGuildTabInfo|CanEditGuildTabInfo]](<span class="apiarg">tab</span>)
: [[API CanEditMOTD|CanEditMOTD]]() - Returns true if you are allowed to edit the guild motd.
+
: [[API CanEditMOTD|CanEditMOTD]]() - True if the player can edit the guild message of the day.
 
: [[API CanEditPublicNote|CanEditPublicNote]]() - Returns true if you are allowed to edit a guild member's public note.
 
: [[API CanEditPublicNote|CanEditPublicNote]]() - Returns true if you are allowed to edit a guild member's public note.
: [[API CanGuildDemote|CanGuildDemote]]() - Returns true if you are allowed to demote a guild member.
+
: [[API CanGuildDemote|CanGuildDemote]]() - True if the player can demote guild members.
: [[API CanGuildInvite|CanGuildInvite]]() - Returns true if you are allowed to invite a new member to the guild.
+
: [[API CanGuildInvite|CanGuildInvite]]() - True if the player can invite new members to the guild.
: [[API CanGuildPromote|CanGuildPromote]]() - Returns true if you are allowed to demote a guild member.
+
: [[API CanGuildPromote|CanGuildPromote]]() - True if the player can promote guild members.
 
: [[API CanGuildRemove|CanGuildRemove]]() - Returns true if you are allowed to remove a guild member.
 
: [[API CanGuildRemove|CanGuildRemove]]() - Returns true if you are allowed to remove a guild member.
 
: [[API CanReplaceGuildMaster|CanReplaceGuildMaster]]() - Returns whether you can impeach the Guild Master due to inactivity.
 
: [[API CanReplaceGuildMaster|CanReplaceGuildMaster]]() - Returns whether you can impeach the Guild Master due to inactivity.
Line 2,489: Line 2,523:
 
: [[API CloseTabardCreation|CloseTabardCreation]]()
 
: [[API CloseTabardCreation|CloseTabardCreation]]()
 
: [[API CollapseGuildTradeSkillHeader|CollapseGuildTradeSkillHeader]](<span class="apiarg">tradeSkillID</span>)
 
: [[API CollapseGuildTradeSkillHeader|CollapseGuildTradeSkillHeader]](<span class="apiarg">tradeSkillID</span>)
: [[API DeclineGuild|DeclineGuild]]() - The player declines the invitation to join a guild.
+
: [[API DeclineGuild|DeclineGuild]]() - Declines a guild invite.
 
: [[API ExpandGuildTradeSkillHeader|ExpandGuildTradeSkillHeader]](<span class="apiarg">tradeSkillID</span>)
 
: [[API ExpandGuildTradeSkillHeader|ExpandGuildTradeSkillHeader]](<span class="apiarg">tradeSkillID</span>)
: [[API GetAutoDeclineGuildInvites|GetAutoDeclineGuildInvites]]() - Returns if guild invites are blocked.
+
: [[API GetAutoDeclineGuildInvites|GetAutoDeclineGuildInvites]]() - True if guild invites are being automatically declined.
 
: [[API GetDemotionRank|GetDemotionRank]](<span class="apiarg">index</span>)
 
: [[API GetDemotionRank|GetDemotionRank]](<span class="apiarg">index</span>)
 
: [[API GetGuildCategoryList|GetGuildCategoryList]]()
 
: [[API GetGuildCategoryList|GetGuildCategoryList]]()
Line 2,500: Line 2,534:
 
: [[API GetGuildFactionGroup|GetGuildFactionGroup]]()
 
: [[API GetGuildFactionGroup|GetGuildFactionGroup]]()
 
: [[API GetGuildFactionInfo|GetGuildFactionInfo]]() - Returns the guild name and faction standing of the player.
 
: [[API GetGuildFactionInfo|GetGuildFactionInfo]]() - Returns the guild name and faction standing of the player.
 
: [[API GetGuildInfo|GetGuildInfo]](<span class="apiarg">unit</span>) - Returns guild info for a player unit.
 
: [[API GetGuildInfoText|GetGuildInfoText]]() - Returns the persistant Guild Information data.
 
: [[API GetGuildInfoText|GetGuildInfoText]]() - Returns the persistant Guild Information data.
: [[API GetGuildInfo|GetGuildInfo]](<span class="apiarg">unit</span>) - This function returns the name of the guild ''unit'' belongs to.
 
 
: [[API GetGuildLogoInfo|GetGuildLogoInfo]]()
 
: [[API GetGuildLogoInfo|GetGuildLogoInfo]]()
 
: [[API GetGuildMemberRecipes|GetGuildMemberRecipes]](<span class="apiarg">name, skillLineID</span>)
 
: [[API GetGuildMemberRecipes|GetGuildMemberRecipes]](<span class="apiarg">name, skillLineID</span>)
Line 2,512: Line 2,546:
 
: [[API GetGuildRenameRequired|GetGuildRenameRequired]]()
 
: [[API GetGuildRenameRequired|GetGuildRenameRequired]]()
 
: [[API GetGuildRewardInfo|GetGuildRewardInfo]](<span class="apiarg">index</span>)
 
: [[API GetGuildRewardInfo|GetGuildRewardInfo]](<span class="apiarg">index</span>)
: [[API GetGuildRosterInfo|GetGuildRosterInfo]](<span class="apiarg">index</span>) - This function is used to get info on members in the guild.
+
: [[API GetGuildRosterInfo|GetGuildRosterInfo]](<span class="apiarg">index</span>) - Returns info for a guild member.
 
: [[API GetGuildRosterLargestAchievementPoints|GetGuildRosterLargestAchievementPoints]]() - Returns max achievements points.
 
: [[API GetGuildRosterLargestAchievementPoints|GetGuildRosterLargestAchievementPoints]]() - Returns max achievements points.
: [[API GetGuildRosterLastOnline|GetGuildRosterLastOnline]](<span class="apiarg">index</span>) - Returns time since last online for indexth member in current sort order.
+
: [[API GetGuildRosterLastOnline|GetGuildRosterLastOnline]](<span class="apiarg">index</span>) - Returns time since the guild member was last online.
: [[API GetGuildRosterMOTD|GetGuildRosterMOTD]]() - Returns guild's MOTD.
+
: [[API GetGuildRosterMOTD|GetGuildRosterMOTD]]() - Returns the guild message of the day.
: [[API GetGuildRosterSelection|GetGuildRosterSelection]]() - Returns the index of the current selected guild member.
+
: [[API GetGuildRosterSelection|GetGuildRosterSelection]]() - Returns the index of the selected guild member in the roster.
: [[API GetGuildRosterShowOffline|GetGuildRosterShowOffline]]() - Returns true if showing offline members of the guild.
+
: [[API GetGuildRosterShowOffline|GetGuildRosterShowOffline]]() - True if the guild roster is showing offline members.
 
: [[API GetGuildTabardFiles|GetGuildTabardFiles]]() - Returns File IDs of tabard textures used in guild bank logo.
 
: [[API GetGuildTabardFiles|GetGuildTabardFiles]]() - Returns File IDs of tabard textures used in guild bank logo.
: [[API GetGuildTradeSkillInfo|GetGuildTradeSkillInfo]](<span class="apiarg">index</span>) - Returns the tradeskill index for a guild tradeskill using the index from GetNumGuildTradeSkill.
+
: [[API GetGuildTradeSkillInfo|GetGuildTradeSkillInfo]](<span class="apiarg">index</span>) - Returns info for a profession in the guild roster.
 
: [[API GetNumGuildChallenges|GetNumGuildChallenges]]()
 
: [[API GetNumGuildChallenges|GetNumGuildChallenges]]()
 
: [[API GetNumGuildEvents|GetNumGuildEvents]]() - Returns the number of guild events.
 
: [[API GetNumGuildEvents|GetNumGuildEvents]]() - Returns the number of guild events.
Line 2,532: Line 2,566:
 
: [[API GetTabardInfo|GetTabardInfo]]()
 
: [[API GetTabardInfo|GetTabardInfo]]()
 
: [[API GuildControlAddRank|GuildControlAddRank]](<span class="apiarg">name</span>) - Add another rank called "name". Only Guildmaster.
 
: [[API GuildControlAddRank|GuildControlAddRank]](<span class="apiarg">name</span>) - Add another rank called "name". Only Guildmaster.
: [[API GuildControlDelRank|GuildControlDelRank]](<span class="apiarg">name</span>) - Delete rank "name". Only Guildmaster.
+
: [[API GuildControlDelRank|GuildControlDelRank]](<span class="apiarg">name</span>) - Deletes a guild rank.
 
: [[API GuildControlGetAllowedShifts|GuildControlGetAllowedShifts]](<span class="apiarg">rankOrder</span>)
 
: [[API GuildControlGetAllowedShifts|GuildControlGetAllowedShifts]](<span class="apiarg">rankOrder</span>)
 
: [[API GuildControlGetNumRanks|GuildControlGetNumRanks]]() - Returns number of ranks after guild frame open. Any guild member can use this.
 
: [[API GuildControlGetNumRanks|GuildControlGetNumRanks]]() - Returns number of ranks after guild frame open. Any guild member can use this.
: [[API GuildControlGetRankName|GuildControlGetRankName]](<span class="apiarg">index</span>) - Returns name of the rank at index. Any guild member can use this.
+
: [[API GuildControlGetRankName|GuildControlGetRankName]](<span class="apiarg">index</span>) - Returns a guild rank name by index.
: [[API GuildControlSaveRank|GuildControlSaveRank]](<span class="apiarg">name</span>) - Saves the permissions for rank "name". Only Guildmaster.
+
: [[API GuildControlSaveRank|GuildControlSaveRank]](<span class="apiarg">name</span>) - Saves the current rank name.
: <small>PROTECTED</small> [[API GuildControlSetRank|GuildControlSetRank]](<span class="apiarg">rank</span>) - Sets the currently selected rank to view.
+
: <small>''PROTECTED''</small> [[API GuildControlSetRank|GuildControlSetRank]](<span class="apiarg">rank</span>) - Selects a guild rank.
: <small>PROTECTED</small> [[API GuildControlSetRankFlag|GuildControlSetRankFlag]](<span class="apiarg">index, enabled</span>) - Enable/disable permission for an action at index. Only Guildmaster.
+
: <small>''PROTECTED''</small> [[API GuildControlSetRankFlag|GuildControlSetRankFlag]](<span class="apiarg">index, enabled</span>) - Sets guild rank permissions.
 
: [[API GuildControlShiftRankDown|GuildControlShiftRankDown]](<span class="apiarg">rankOrder</span>)
 
: [[API GuildControlShiftRankDown|GuildControlShiftRankDown]](<span class="apiarg">rankOrder</span>)
 
: [[API GuildControlShiftRankUp|GuildControlShiftRankUp]](<span class="apiarg">rankOrder</span>)
 
: [[API GuildControlShiftRankUp|GuildControlShiftRankUp]](<span class="apiarg">rankOrder</span>)
: <small>PROTECTED</small> [[API GuildDemote|GuildDemote]](<span class="apiarg">name</span>) - Demotes a player "name".
+
: <small>''PROTECTED''</small> [[API GuildDemote|GuildDemote]](<span class="apiarg">name</span>) - Demotes the specified player in the guild.
: [[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 the guild; no warning is given.
: [[API GuildInfo|GuildInfo]]() - Displays information about the guild you are a member of.
+
: [[API GuildInfo|GuildInfo]]() - Prints info for the guild the player belongs to.
: [[API GuildInvite|GuildInvite]](<span class="apiarg">name</span>) - Invites a player to your guild.
+
: <small>''HW''</small> [[API GuildInvite|GuildInvite]](<span class="apiarg">name</span>) - Invites a player to the guild.
 
: [[API GuildLeave|GuildLeave]]() - Removes you from your current guild.
 
: [[API GuildLeave|GuildLeave]]() - Removes you from your current guild.
 
: [[API GuildMasterAbsent|GuildMasterAbsent]]()
 
: [[API GuildMasterAbsent|GuildMasterAbsent]]()
 
: [[API GuildNewsSetSticky|GuildNewsSetSticky]](<span class="apiarg">index, bool</span>)
 
: [[API GuildNewsSetSticky|GuildNewsSetSticky]](<span class="apiarg">index, bool</span>)
 
: [[API GuildNewsSort|GuildNewsSort]](<span class="apiarg">byDate</span>)
 
: [[API GuildNewsSort|GuildNewsSort]](<span class="apiarg">byDate</span>)
: <small>PROTECTED</small> [[API GuildPromote|GuildPromote]](<span class="apiarg">name</span>) - Promotes a player "name".
+
: <small>''PROTECTED''</small> [[API GuildPromote|GuildPromote]](<span class="apiarg">name</span>) - Promotes the specified player in the guild.
: [[API GuildRosterSetOfficerNote|GuildRosterSetOfficerNote]](<span class="apiarg">index, note</span>) - Sets the officer note at index to "note".
+
: [[API GuildRosterSetOfficerNote|GuildRosterSetOfficerNote]](<span class="apiarg">index, note</span>) - Sets the officer note of a guild member.
: [[API GuildRosterSetPublicNote|GuildRosterSetPublicNote]](<span class="apiarg">index, note</span>) - Sets the public note at index to "note".
+
: [[API GuildRosterSetPublicNote|GuildRosterSetPublicNote]](<span class="apiarg">index, note</span>) - Sets the public note of a guild member.
: [[API GuildSetLeader|GuildSetLeader]](<span class="apiarg">name</span>) - Transfers guild leadership to another character.
+
: [[API GuildSetLeader|GuildSetLeader]](<span class="apiarg">name</span>) - Transfers guild leadership to another player.
: [[API GuildSetMOTD|GuildSetMOTD]](<span class="apiarg">note</span>) - Set Guild Message of the Day to "note".
+
: [[API GuildSetMOTD|GuildSetMOTD]](<span class="apiarg">note</span>) - Sets the guild message of the day.
: <small>PROTECTED</small> [[API GuildUninvite|GuildUninvite]](<span class="apiarg">name</span>) - Removes the member "name".
+
: <small>''PROTECTED''</small> [[API GuildUninvite|GuildUninvite]](<span class="apiarg">name</span>) - Removes a player from the guild.
: [[API IsGuildLeader|IsGuildLeader]](<span class="apiarg">name</span>) - Determine if player "name" is a guild master.
+
: [[API IsGuildLeader|IsGuildLeader]](<span class="apiarg">name</span>) - True if the player is the guild master.
 
: [[API IsGuildMember|IsGuildMember]](<span class="apiarg">guid or unitToken</span>)
 
: [[API IsGuildMember|IsGuildMember]](<span class="apiarg">guid or unitToken</span>)
 
: [[API IsGuildRankAssignmentAllowed|IsGuildRankAssignmentAllowed]](<span class="apiarg">playerIndex, rankIndex</span>)
 
: [[API IsGuildRankAssignmentAllowed|IsGuildRankAssignmentAllowed]](<span class="apiarg">playerIndex, rankIndex</span>)
Line 2,567: Line 2,601:
 
: [[API RequestGuildPartyState|RequestGuildPartyState]]()
 
: [[API RequestGuildPartyState|RequestGuildPartyState]]()
 
: [[API RequestGuildRewards|RequestGuildRewards]]()
 
: [[API RequestGuildRewards|RequestGuildRewards]]()
: [[API SetAutoDeclineGuildInvites|SetAutoDeclineGuildInvites]](<span class="apiarg">checked</span>) - Blocks guild invites automatically.
+
: [[API SetAutoDeclineGuildInvites|SetAutoDeclineGuildInvites]](<span class="apiarg">checked</span>) - Sets whether guild invites should be automatically declined.
: [[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 guild info text.
 
: [[API SetGuildMemberRank|SetGuildMemberRank]](<span class="apiarg">playerIndex, rankIndex</span>)
 
: [[API SetGuildMemberRank|SetGuildMemberRank]](<span class="apiarg">playerIndex, rankIndex</span>)
 
: [[API SetGuildNewsFilter|SetGuildNewsFilter]](<span class="apiarg">index, bool</span>)
 
: [[API SetGuildNewsFilter|SetGuildNewsFilter]](<span class="apiarg">index, bool</span>)
: [[API SetGuildRosterSelection|SetGuildRosterSelection]](<span class="apiarg">index</span>) - Selects/deselects a guild member according current sorting order.
+
: [[API SetGuildRosterSelection|SetGuildRosterSelection]](<span class="apiarg">index</span>) - Selects a guild member in the roster.
: [[API SetGuildRosterShowOffline|SetGuildRosterShowOffline]](<span class="apiarg">enabled</span>) - Sets/Resets the show offline members flag.
+
: [[API SetGuildRosterShowOffline|SetGuildRosterShowOffline]](<span class="apiarg">enabled</span>) - Sets the show offline guild members flag.
 
: [[API SetGuildTradeSkillCategoryFilter|SetGuildTradeSkillCategoryFilter]](<span class="apiarg">tradeSkillID</span>)
 
: [[API SetGuildTradeSkillCategoryFilter|SetGuildTradeSkillCategoryFilter]](<span class="apiarg">tradeSkillID</span>)
 
: [[API SetGuildTradeSkillItemNameFilter|SetGuildTradeSkillItemNameFilter]](<span class="apiarg">itemName</span>)
 
: [[API SetGuildTradeSkillItemNameFilter|SetGuildTradeSkillItemNameFilter]](<span class="apiarg">itemName</span>)
: [[API SortGuildRoster|SortGuildRoster]](<span class="apiarg">sort</span>) - Sorts guildroster according "sort". Any unknown values sort on "name".
+
: [[API SortGuildRoster|SortGuildRoster]](<span class="apiarg">sort</span>) - Sorts the guild roster on a certain column.
 
: [[API SortGuildTradeSkill|SortGuildTradeSkill]](<span class="apiarg">type</span>)
 
: [[API SortGuildTradeSkill|SortGuildTradeSkill]](<span class="apiarg">type</span>)
 
: [[API SubmitRequiredGuildRename|SubmitRequiredGuildRename]]()
 
: [[API SubmitRequiredGuildRename|SubmitRequiredGuildRename]]()
 
: [[API ViewGuildRecipes|ViewGuildRecipes]](<span class="apiarg">skillLineID</span>)
 
: [[API ViewGuildRecipes|ViewGuildRecipes]](<span class="apiarg">skillLineID</span>)
   
==== Petitions ====
+
====Petitions====
 
Petitions are signup documents for guilds and arena teams. Some functions below only apply to a particular petition type
 
Petitions are signup documents for guilds and arena teams. Some functions below only apply to a particular petition type
 
: [[API CanSignPetition|CanSignPetition]]() - Returns nil if the player cannot sign the current petition.
 
: [[API CanSignPetition|CanSignPetition]]() - Returns nil if the player cannot sign the current petition.
 
: [[API ClosePetition|ClosePetition]]() - Closes the current petition.
 
: [[API ClosePetition|ClosePetition]]() - Closes the current petition.
: [[API GetNumPetitionNames|GetNumPetitionNames]]() - Gets the number of signatures on the current petition.
+
: [[API GetNumPetitionNames|GetNumPetitionNames]]() - Returns the number of signatures on the current petition.
: [[API GetPetitionInfo|GetPetitionInfo]]() - Retrieves information about the current petition.
+
: [[API GetPetitionInfo|GetPetitionInfo]]() - Returns info for the petition being viewed.
 
: [[API GetPetitionNameInfo|GetPetitionNameInfo]](<span class="apiarg">index</span>) - Retrieves information about a signature on the petition.
 
: [[API GetPetitionNameInfo|GetPetitionNameInfo]](<span class="apiarg">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 OfferPetition|OfferPetition]]() - Offers a petition to your target.
 
: [[API RenamePetition|RenamePetition]](<span class="apiarg">name</span>) - Renames the current petition.
 
: [[API RenamePetition|RenamePetition]](<span class="apiarg">name</span>) - Renames the current petition.
: [[API SignPetition|SignPetition]]() - Signs the current petition.
+
: [[API SignPetition|SignPetition]]() - Signs the currently viewed petition.
 
: [[API TurnInGuildCharter|TurnInGuildCharter]]() - Founds a guild.
 
: [[API TurnInGuildCharter|TurnInGuildCharter]]() - Founds a guild.
   
=== Instances ===
+
===Instances===
  +
: [[API C_ModifiedInstance.GetModifiedInstanceInfoFromMapID|C_ModifiedInstance.GetModifiedInstanceInfoFromMapID]](<span class="apiarg">mapID</span>) : <span class="apiret">info</span>
 
: [[API C_PlayerInfo.GetInstancesUnlockedAtLevel|C_PlayerInfo.GetInstancesUnlockedAtLevel]](<span class="apiarg">level, isRaid</span>) : <span class="apiret">dungeonID</span>
 
: [[API C_PlayerInfo.GetInstancesUnlockedAtLevel|C_PlayerInfo.GetInstancesUnlockedAtLevel]](<span class="apiarg">level, isRaid</span>) : <span class="apiret">dungeonID</span>
 
: [[API CanChangePlayerDifficulty|CanChangePlayerDifficulty]]()
 
: [[API CanChangePlayerDifficulty|CanChangePlayerDifficulty]]()
 
: [[API CanMapChangeDifficulty|CanMapChangeDifficulty]]()
 
: [[API CanMapChangeDifficulty|CanMapChangeDifficulty]]()
: [[API CanShowResetInstances|CanShowResetInstances]]() - Determine if player can reset instances at the moment.
+
: [[API CanShowResetInstances|CanShowResetInstances]]() - True if the character can currently reset their instances.
 
: [[API GetDifficultyInfo|GetDifficultyInfo]]() - Returns information about a difficulty.
 
: [[API GetDifficultyInfo|GetDifficultyInfo]]() - Returns information about a difficulty.
: [[API GetDungeonDifficultyID|GetDungeonDifficultyID]]() - Returns the player's current Dungeon Difficulty setting (1, 2, 8).
+
: [[API GetDungeonDifficultyID|GetDungeonDifficultyID]]() - Returns the selected dungeon difficulty.
 
: [[API GetInstanceBootTimeRemaining|GetInstanceBootTimeRemaining]]() - Gets the time in seconds after which the player will be ejected from an instance.
 
: [[API GetInstanceBootTimeRemaining|GetInstanceBootTimeRemaining]]() - Gets the time in seconds after which the player will be ejected from an instance.
: [[API GetInstanceInfo|GetInstanceInfo]]() - Gets informations about the current Instance.
+
: [[API GetInstanceInfo|GetInstanceInfo]]() - Returns info for the map instance the character is currently in.
 
: [[API GetLegacyRaidDifficultyID|GetLegacyRaidDifficultyID]]()
 
: [[API GetLegacyRaidDifficultyID|GetLegacyRaidDifficultyID]]()
: [[API GetRaidDifficultyID|GetRaidDifficultyID]]() - Returns the player's current Raid Difficulty setting (1-14).
+
: [[API GetRaidDifficultyID|GetRaidDifficultyID]]() - Returns the player's currently selected raid difficulty.
: [[API IsInInstance|IsInInstance]]() - Returns 1 if the player is in an instance, as well as the type of instance (pvp, raid, etc.).
+
: [[API IsInInstance|IsInInstance]]() - Returns true if the player is in an instance, and the type of instance.
 
: [[API IsLegacyDifficulty|IsLegacyDifficulty]](<span class="apiarg">difficultyID</span>)
 
: [[API IsLegacyDifficulty|IsLegacyDifficulty]](<span class="apiarg">difficultyID</span>)
: [[API ResetInstances|ResetInstances]]() - Reset instances.
+
: [[API ResetInstances|ResetInstances]]() - Resets all instances for the character.
: [[API SetDungeonDifficultyID|SetDungeonDifficultyID]](<span class="apiarg">difficultyID</span>) - Sets the player's Dungeon Difficulty setting (for the 5-man instances). See [[difficultyID]].
+
: [[API SetDungeonDifficultyID|SetDungeonDifficultyID]](<span class="apiarg">difficultyID</span>) - Sets the player's dungeon difficulty.
 
: [[API SetLegacyRaidDifficultyID|SetLegacyRaidDifficultyID]](<span class="apiarg">difficultyID [, force]</span>)
 
: [[API SetLegacyRaidDifficultyID|SetLegacyRaidDifficultyID]](<span class="apiarg">difficultyID [, force]</span>)
: [[API SetRaidDifficultyID|SetRaidDifficultyID]](<span class="apiarg">difficultyID</span>) - Sets the players Raid Difficulty settings (for 10-man, 25-man instances). See [[difficultyID]].
+
: [[API SetRaidDifficultyID|SetRaidDifficultyID]](<span class="apiarg">difficultyID</span>) - Sets the raid difficulty.
 
: [[API ShowBossFrameWhenUninteractable|ShowBossFrameWhenUninteractable]](<span class="apiarg">unit</span>)
 
: [[API ShowBossFrameWhenUninteractable|ShowBossFrameWhenUninteractable]](<span class="apiarg">unit</span>)
 
Relates to [[Raid lockout|Instance Locks]]
 
Relates to [[Raid lockout|Instance Locks]]
  +
: [[API GetInstanceLockTimeRemaining|GetInstanceLockTimeRemaining]]() - Returns info for the instance lock timer for the current instance.
 
: [[API GetInstanceLockTimeRemainingEncounter|GetInstanceLockTimeRemainingEncounter]](<span class="apiarg">id</span>) - Returns information about bosses in the instance the player is about to be saved to.
 
: [[API GetInstanceLockTimeRemainingEncounter|GetInstanceLockTimeRemainingEncounter]](<span class="apiarg">id</span>) - Returns information about bosses in the instance the player is about to be saved to.
: [[API GetInstanceLockTimeRemaining|GetInstanceLockTimeRemaining]]() - Returns information about the instance lock timer for the instance the player is currently entering.
+
: [[API GetNumSavedInstances|GetNumSavedInstances]]() - Returns the number of instances for which the character is locked out.
: [[API GetNumSavedInstances|GetNumSavedInstances]]() - Gets the number of instances for which the player currently has lockout data saved.
 
 
: [[API GetNumSavedWorldBosses|GetNumSavedWorldBosses]]()
 
: [[API GetNumSavedWorldBosses|GetNumSavedWorldBosses]]()
 
: [[API GetSavedInstanceChatLink|GetSavedInstanceChatLink]](<span class="apiarg">index</span>)
 
: [[API GetSavedInstanceChatLink|GetSavedInstanceChatLink]](<span class="apiarg">index</span>)
 
: [[API GetSavedInstanceEncounterInfo|GetSavedInstanceEncounterInfo]](<span class="apiarg">instanceIndex, encounterIndex</span>)
 
: [[API GetSavedInstanceEncounterInfo|GetSavedInstanceEncounterInfo]](<span class="apiarg">instanceIndex, encounterIndex</span>)
: [[API GetSavedInstanceInfo|GetSavedInstanceInfo]](<span class="apiarg">index</span>) - Gets information about an instance for which the player has saved lockout data.
+
: [[API GetSavedInstanceInfo|GetSavedInstanceInfo]](<span class="apiarg">index</span>) - Returns instance lock info.
 
: [[API GetSavedWorldBossInfo|GetSavedWorldBossInfo]](<span class="apiarg">index</span>)
 
: [[API GetSavedWorldBossInfo|GetSavedWorldBossInfo]](<span class="apiarg">index</span>)
: [[API RequestRaidInfo|RequestRaidInfo]]() - Returns information about which instances you are saved to.
+
: [[API RequestRaidInfo|RequestRaidInfo]]() - Requests which instances the player is saved to.
 
: [[API RespondInstanceLock|RespondInstanceLock]]()
 
: [[API RespondInstanceLock|RespondInstanceLock]]()
 
: [[API SetSavedInstanceExtend|SetSavedInstanceExtend]](<span class="apiarg">index, extend</span>)
 
: [[API SetSavedInstanceExtend|SetSavedInstanceExtend]](<span class="apiarg">index, extend</span>)
   
==== 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 class="apiarg">stepIndex</span>)
 
: [[API C_Scenario.GetBonusStepRewardQuestID|C_Scenario.GetBonusStepRewardQuestID]](<span class="apiarg">stepIndex</span>)
Line 2,630: Line 2,665:
 
: [[API C_Scenario.GetCriteriaInfoByStep|C_Scenario.GetCriteriaInfoByStep]](<span class="apiarg">stepID, criteriaIndex</span>)
 
: [[API C_Scenario.GetCriteriaInfoByStep|C_Scenario.GetCriteriaInfoByStep]](<span class="apiarg">stepID, criteriaIndex</span>)
 
: [[API C_Scenario.GetInfo|C_Scenario.GetInfo]]()
 
: [[API C_Scenario.GetInfo|C_Scenario.GetInfo]]()
: [[API C_Scenario.GetProvingGroundsInfo|C_Scenario.GetProvingGroundsInfo]]() - Returns information about the current Proving Grounds trial.
+
: [[API C_Scenario.GetProvingGroundsInfo|C_Scenario.GetProvingGroundsInfo]]() - Returns info for the current [[Proving Grounds]] trial.
 
: [[API C_Scenario.GetScenarioIconInfo|C_Scenario.GetScenarioIconInfo]](<span class="apiarg">uiMapID</span>)
 
: [[API C_Scenario.GetScenarioIconInfo|C_Scenario.GetScenarioIconInfo]](<span class="apiarg">uiMapID</span>)
 
: [[API C_Scenario.GetStepInfo|C_Scenario.GetStepInfo]](<span class="apiarg">[bonusStepIndex]</span>)
 
: [[API C_Scenario.GetStepInfo|C_Scenario.GetStepInfo]](<span class="apiarg">[bonusStepIndex]</span>)
Line 2,648: Line 2,683:
 
: [[API IsInScenarioGroup|IsInScenarioGroup]]()
 
: [[API IsInScenarioGroup|IsInScenarioGroup]]()
   
==== Mythic+ ====
+
====Mythic+====
  +
: [[API nil|nil]]()
 
[[Mythic+]] mode was added in [[Patch 7.0.3]]
 
[[Mythic+]] mode was added in [[Patch 7.0.3]]
 
: [[API C_MythicPlus.GetCurrentAffixes|C_MythicPlus.GetCurrentAffixes]]() : <span class="apiret">affixIDs</span>
 
: [[API C_MythicPlus.GetCurrentAffixes|C_MythicPlus.GetCurrentAffixes]]() : <span class="apiret">affixIDs</span>
Line 2,700: Line 2,736:
 
: [[API C_ChallengeMode.StartChallengeMode|C_ChallengeMode.StartChallengeMode]]() : <span class="apiret">success</span>
 
: [[API C_ChallengeMode.StartChallengeMode|C_ChallengeMode.StartChallengeMode]]() : <span class="apiret">success</span>
   
==== Weekly Rewards ====
+
====Weekly Rewards====
 
: [[API C_WeeklyRewards.AreRewardsForCurrentRewardPeriod|C_WeeklyRewards.AreRewardsForCurrentRewardPeriod]]() : <span class="apiret">isCurrentPeriod</span>
 
: [[API C_WeeklyRewards.AreRewardsForCurrentRewardPeriod|C_WeeklyRewards.AreRewardsForCurrentRewardPeriod]]() : <span class="apiret">isCurrentPeriod</span>
 
: [[API C_WeeklyRewards.CanClaimRewards|C_WeeklyRewards.CanClaimRewards]]() : <span class="apiret">canClaimRewards</span>
 
: [[API C_WeeklyRewards.CanClaimRewards|C_WeeklyRewards.CanClaimRewards]]() : <span class="apiret">canClaimRewards</span>
Line 2,714: Line 2,750:
 
: [[API C_WeeklyRewards.HasGeneratedRewards|C_WeeklyRewards.HasGeneratedRewards]]() : <span class="apiret">hasGeneratedRewards</span>
 
: [[API C_WeeklyRewards.HasGeneratedRewards|C_WeeklyRewards.HasGeneratedRewards]]() : <span class="apiret">hasGeneratedRewards</span>
 
: [[API C_WeeklyRewards.HasInteraction|C_WeeklyRewards.HasInteraction]]() : <span class="apiret">isInteracting</span>
 
: [[API C_WeeklyRewards.HasInteraction|C_WeeklyRewards.HasInteraction]]() : <span class="apiret">isInteracting</span>
  +
: [[API C_WeeklyRewards.OnUIInteract|C_WeeklyRewards.OnUIInteract]]()
   
=== Items ===
+
===Items===
 
These functions operate on item links or item information directly. See also [[#Bags|Bag]] functions.
 
These functions operate on item links or item information directly. See also [[#Bags|Bag]] functions.
 
: [[API C_Item.CanViewItemPowers|C_Item.CanViewItemPowers]](<span class="apiarg">itemLoc</span>) : <span class="apiret">isItemViewable</span>
 
: [[API C_Item.CanViewItemPowers|C_Item.CanViewItemPowers]](<span class="apiarg">itemLoc</span>) : <span class="apiret">isItemViewable</span>
Line 2,761: Line 2,798:
 
: [[API C_ItemInteraction.SetPendingItem|C_ItemInteraction.SetPendingItem]](<span class="apiarg">[item]</span>) : <span class="apiret">success</span>
 
: [[API C_ItemInteraction.SetPendingItem|C_ItemInteraction.SetPendingItem]](<span class="apiarg">[item]</span>) : <span class="apiret">success</span>
 
: [[API C_NewItems.ClearAll|C_NewItems.ClearAll]]() - Clears the new item flag on all items in the player's inventory.
 
: [[API C_NewItems.ClearAll|C_NewItems.ClearAll]]() - Clears the new item flag on all items in the player's inventory.
: [[API C_NewItems.IsNewItem|C_NewItems.IsNewItem]](<span class="apiarg">bag, slot</span>) - Returns whether the item in the specified container slot is flagged as new.
+
: [[API C_NewItems.IsNewItem|C_NewItems.IsNewItem]](<span class="apiarg">bag, slot</span>) - True if the item in the inventory slot is flagged as new.
 
: [[API C_NewItems.RemoveNewItem|C_NewItems.RemoveNewItem]](<span class="apiarg">bag, slot</span>) - Clears the "new item" flag.
 
: [[API C_NewItems.RemoveNewItem|C_NewItems.RemoveNewItem]](<span class="apiarg">bag, slot</span>) - Clears the "new item" flag.
 
: [[API ActionBindsItem|ActionBindsItem]]() - Confirms this will bind this item to you.
 
: [[API ActionBindsItem|ActionBindsItem]]() - Confirms this will bind this item to you.
Line 2,768: Line 2,805:
 
: [[API EndRefund|EndRefund]]() - Confirms this will make this item non-refundable.
 
: [[API EndRefund|EndRefund]]() - Confirms this will make this item non-refundable.
 
: [[API EquipItemByName|EquipItemByName]](<span class="apiarg">item [, invSlot]</span>) - Equips an item, optionally into a specified slot.
 
: [[API EquipItemByName|EquipItemByName]](<span class="apiarg">item [, invSlot]</span>) - Equips an item, optionally into a specified slot.
: [[API GetDetailedItemLevelInfo|GetDetailedItemLevelInfo]](<span class="apiarg">item</span>) - Returns an item's item level.
+
: [[API GetDetailedItemLevelInfo|GetDetailedItemLevelInfo]](<span class="apiarg">item</span>) - Returns detailed item level info.
 
: [[API GetItemChildInfo|GetItemChildInfo]](<span class="apiarg">item [, slotID]</span>)
 
: [[API GetItemChildInfo|GetItemChildInfo]](<span class="apiarg">item [, slotID]</span>)
 
: [[API GetItemClassInfo|GetItemClassInfo]](<span class="apiarg">itemClassID</span>) - Returns the name of the item type.
 
: [[API GetItemClassInfo|GetItemClassInfo]](<span class="apiarg">itemClassID</span>) - Returns the name of the item type.
: [[API GetItemCooldown|GetItemCooldown]](<span class="apiarg">itemId</span>) - Returns startTime, duration, enable.
+
: [[API GetItemCooldown|GetItemCooldown]](<span class="apiarg">itemId</span>) - Returns cooldown info for an item ID.
: [[API GetItemCount|GetItemCount]](<span class="apiarg">item [, includeBank, includeCharges]</span>) - Returns number of such items in inventory, or charges instead if it has charges.
+
: [[API GetItemCount|GetItemCount]](<span class="apiarg">item [, includeBank, includeCharges]</span>) - Returns the number (or available charges) of an item in the inventory.
 
: [[API GetItemCreationContext|GetItemCreationContext]](<span class="apiarg">itemlink</span>)
 
: [[API GetItemCreationContext|GetItemCreationContext]](<span class="apiarg">itemlink</span>)
 
: [[API GetItemFamily|GetItemFamily]](<span class="apiarg">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 class="apiarg">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 class="apiarg">item, index</span>)
 
: [[API GetItemGem|GetItemGem]](<span class="apiarg">item, index</span>)
: [[API GetItemIcon|GetItemIcon]](<span class="apiarg">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 class="apiarg">itemId</span>) - Returns the icon texture for an item.
: [[API GetItemInfo|GetItemInfo]](<span class="apiarg">item</span>) - Returns information about an item.
+
: [[API GetItemInfo|GetItemInfo]](<span class="apiarg">item</span>) - Returns info for an item.
: [[API GetItemInfoInstant|GetItemInfoInstant]](<span class="apiarg">item</span>) - Returns basic information about an item.
+
: [[API GetItemInfoInstant|GetItemInfoInstant]](<span class="apiarg">item</span>) - Returns readily available info for an item.
 
: [[API GetItemInventorySlotInfo|GetItemInventorySlotInfo]](<span class="apiarg">inventorySlot</span>)
 
: [[API GetItemInventorySlotInfo|GetItemInventorySlotInfo]](<span class="apiarg">inventorySlot</span>)
 
: [[API GetItemLevelColor|GetItemLevelColor]]()
 
: [[API GetItemLevelColor|GetItemLevelColor]]()
: [[API GetItemQualityColor|GetItemQualityColor]](<span class="apiarg">quality</span>) - Returns the RGB color codes for a quality.
+
: [[API GetItemQualityColor|GetItemQualityColor]](<span class="apiarg">quality</span>) - Returns the color for an item quality.
 
: [[API GetItemSetInfo|GetItemSetInfo]](<span class="apiarg">setID</span>)
 
: [[API GetItemSetInfo|GetItemSetInfo]](<span class="apiarg">setID</span>)
 
: [[API GetItemSpecInfo|GetItemSpecInfo]](<span class="apiarg">item [, specTable]</span>)
 
: [[API GetItemSpecInfo|GetItemSpecInfo]](<span class="apiarg">item [, specTable]</span>)
: [[API GetItemSpell|GetItemSpell]](<span class="apiarg">item</span>) - Returns name, rank.
+
: [[API GetItemSpell|GetItemSpell]](<span class="apiarg">item</span>) - Returns the spell effect for an item.
 
: [[API GetItemStatDelta|GetItemStatDelta]](<span class="apiarg">itemLink1, itemLink2 [, statTable]</span>)
 
: [[API GetItemStatDelta|GetItemStatDelta]](<span class="apiarg">itemLink1, itemLink2 [, statTable]</span>)
 
: [[API GetItemStats|GetItemStats]](<span class="apiarg">itemLink, statTable</span>) - Returns a table of stats for an item.
 
: [[API GetItemStats|GetItemStats]](<span class="apiarg">itemLink, statTable</span>) - Returns a table of stats for an item.
Line 2,792: Line 2,829:
 
: [[API IsConsumableItem|IsConsumableItem]](<span class="apiarg">item</span>)
 
: [[API IsConsumableItem|IsConsumableItem]](<span class="apiarg">item</span>)
 
: [[API IsCurrentItem|IsCurrentItem]](<span class="apiarg">item</span>)
 
: [[API IsCurrentItem|IsCurrentItem]](<span class="apiarg">item</span>)
: [[API IsEquippableItem|IsEquippableItem]](<span class="apiarg">item</span>) - Returns whether an item can be equipped.
+
: [[API IsEquippableItem|IsEquippableItem]](<span class="apiarg">item</span>) - True if an item is equipable by the player.
 
: [[API IsEquippedItem|IsEquippedItem]](<span class="apiarg">item</span>)
 
: [[API IsEquippedItem|IsEquippedItem]](<span class="apiarg">item</span>)
: [[API IsEquippedItemType|IsEquippedItemType]](<span class="apiarg">type</span>) - Where "type" is any valid inventory type, item class, or item subclass.
+
: [[API IsEquippedItemType|IsEquippedItemType]](<span class="apiarg">type</span>) - True if an item of a given type is equipped.
 
: [[API IsHarmfulItem|IsHarmfulItem]](<span class="apiarg">item</span>) - Returns whether an item can be used against hostile units
 
: [[API IsHarmfulItem|IsHarmfulItem]](<span class="apiarg">item</span>) - Returns whether an item can be used against hostile units
 
: [[API IsHelpfulItem|IsHelpfulItem]](<span class="apiarg">item</span>) - Returns whether an item can be used on the player or friendly units
 
: [[API IsHelpfulItem|IsHelpfulItem]](<span class="apiarg">item</span>) - Returns whether an item can be used on the player or friendly units
Line 2,801: Line 2,838:
 
: [[API ItemHasRange|ItemHasRange]](<span class="apiarg">item</span>)
 
: [[API ItemHasRange|ItemHasRange]](<span class="apiarg">item</span>)
 
: [[API TargetSpellReplacesBonusTree|TargetSpellReplacesBonusTree]]()
 
: [[API TargetSpellReplacesBonusTree|TargetSpellReplacesBonusTree]]()
: <small>PROTECTED</small> [[API UseItemByName|UseItemByName]](<span class="apiarg">itemName, unit</span>) - Use an item on the unit specified.
+
: <small>''PROTECTED''</small> [[API UseItemByName|UseItemByName]](<span class="apiarg">itemName, unit</span>) - Uses the specified item.
 
Item Enchants
 
Item Enchants
: [[API BindEnchant|BindEnchant]]() - Confirm the binding of the item when enchanting it.
+
: [[API BindEnchant|BindEnchant]]() - Confirms that enchanting an item will make it soulbound.
: [[API ReplaceEnchant|ReplaceEnchant]]() - Confirm the replacement of an enchantment.
+
: [[API ReplaceEnchant|ReplaceEnchant]]() - Confirms the "Replace Enchant" dialog.
: [[API ReplaceTradeEnchant|ReplaceTradeEnchant]]() - Confirm the replacement of an enchantment via trade.
+
: [[API ReplaceTradeEnchant|ReplaceTradeEnchant]]() - Confirms that an enchant applied to the trade frame should replace an existing enchant.
: <small>DEPRECATED</small> [[API GetItemUpdateLevel|GetItemUpdateLevel]]()
+
: <small>''DEPRECATED''</small> [[API GetItemUpdateLevel|GetItemUpdateLevel]]()
: <small>DEPRECATED</small> [[API GetItemUpgradeItemInfo|GetItemUpgradeItemInfo]]()
+
: <small>''DEPRECATED''</small> [[API GetItemUpgradeItemInfo|GetItemUpgradeItemInfo]]()
: <small>DEPRECATED</small> [[API GetItemUpgradeStats|GetItemUpgradeStats]](<span class="apiarg">upgraded</span>)
+
: <small>''DEPRECATED''</small> [[API GetItemUpgradeStats|GetItemUpgradeStats]](<span class="apiarg">upgraded</span>)
: <small>DEPRECATED</small> [[API IsDressableItem|IsDressableItem]](<span class="apiarg">item</span>) - Returns if the item can be shown in the [[Dressing room]].
+
: <small>''DEPRECATED''</small> [[API IsDressableItem|IsDressableItem]](<span class="apiarg">item</span>) - Returns if the item can be shown in the [[Dressing room]].
   
=== Item Upgrade ===
+
===Item Upgrade===
 
: [[API C_ItemUpgrade.CanUpgradeItem|C_ItemUpgrade.CanUpgradeItem]](<span class="apiarg">baseItem</span>) : <span class="apiret">isValid</span>
 
: [[API C_ItemUpgrade.CanUpgradeItem|C_ItemUpgrade.CanUpgradeItem]](<span class="apiarg">baseItem</span>) : <span class="apiret">isValid</span>
 
: [[API C_ItemUpgrade.ClearItemUpgrade|C_ItemUpgrade.ClearItemUpgrade]]()
 
: [[API C_ItemUpgrade.ClearItemUpgrade|C_ItemUpgrade.ClearItemUpgrade]]()
Line 2,824: Line 2,861:
 
: [[API C_ItemUpgrade.SetItemUpgradeFromLocation|C_ItemUpgrade.SetItemUpgradeFromLocation]](<span class="apiarg">itemToSet</span>)
 
: [[API C_ItemUpgrade.SetItemUpgradeFromLocation|C_ItemUpgrade.SetItemUpgradeFromLocation]](<span class="apiarg">itemToSet</span>)
 
: [[API C_ItemUpgrade.UpgradeItem|C_ItemUpgrade.UpgradeItem]](<span class="apiarg">[numUpgrades]</span>)
 
: [[API C_ItemUpgrade.UpgradeItem|C_ItemUpgrade.UpgradeItem]](<span class="apiarg">[numUpgrades]</span>)
: <small>DEPRECATED</small> [[API C_ItemUpgrade.GetItemLevelIncrement|C_ItemUpgrade.GetItemLevelIncrement]](<span class="apiarg">[numUpgradeLevels]</span>) : <span class="apiret">itemLevelIncrement</span>
+
: <small>''DEPRECATED''</small> [[API C_ItemUpgrade.GetItemLevelIncrement|C_ItemUpgrade.GetItemLevelIncrement]](<span class="apiarg">[numUpgradeLevels]</span>) : <span class="apiret">itemLevelIncrement</span>
   
=== Looting ===
+
===Looting===
 
Relates to [[Loot]].
 
Relates to [[Loot]].
 
: [[API C_Loot.IsLegacyLootModeEnabled|C_Loot.IsLegacyLootModeEnabled]]() : <span class="apiret">isLegacyLootModeEnabled</span>
 
: [[API C_Loot.IsLegacyLootModeEnabled|C_Loot.IsLegacyLootModeEnabled]]() : <span class="apiret">isLegacyLootModeEnabled</span>
Line 2,840: Line 2,877:
 
: [[API CancelMasterLootRoll|CancelMasterLootRoll]](<span class="apiarg">slot</span>)
 
: [[API CancelMasterLootRoll|CancelMasterLootRoll]](<span class="apiarg">slot</span>)
 
: [[API CloseLoot|CloseLoot]](<span class="apiarg">[uiFailedFlag]</span>)
 
: [[API CloseLoot|CloseLoot]](<span class="apiarg">[uiFailedFlag]</span>)
: [[API ConfirmLootRoll|ConfirmLootRoll]](<span class="apiarg">rollId [, roll]</span>) - Confirm a loot roll.
+
: [[API ConfirmLootRoll|ConfirmLootRoll]](<span class="apiarg">rollId [, roll]</span>) - Confirms a loot roll.
: [[API ConfirmLootSlot|ConfirmLootSlot]](<span class="apiarg">slot</span>) - Confirm looting of a BoP item.
+
: [[API ConfirmLootSlot|ConfirmLootSlot]](<span class="apiarg">slot</span>) - Confirms looting of a BoP item.
 
: [[API DoMasterLootRoll|DoMasterLootRoll]](<span class="apiarg">slot</span>)
 
: [[API DoMasterLootRoll|DoMasterLootRoll]](<span class="apiarg">slot</span>)
 
: [[API GetActiveLootRollIDs|GetActiveLootRollIDs]]()
 
: [[API GetActiveLootRollIDs|GetActiveLootRollIDs]]()
 
: [[API GetLootInfo|GetLootInfo]]()
 
: [[API GetLootInfo|GetLootInfo]]()
: [[API GetLootMethod|GetLootMethod]]() - Returns the currently active [[lootMethod]].
+
: [[API GetLootMethod|GetLootMethod]]() - Returns the current loot method.
 
: [[API GetLootRollItemInfo|GetLootRollItemInfo]](<span class="apiarg">rollId</span>)
 
: [[API GetLootRollItemInfo|GetLootRollItemInfo]](<span class="apiarg">rollId</span>)
 
: [[API GetLootRollItemLink|GetLootRollItemLink]](<span class="apiarg">id</span>)
 
: [[API GetLootRollItemLink|GetLootRollItemLink]](<span class="apiarg">id</span>)
 
: [[API GetLootRollTimeLeft|GetLootRollTimeLeft]](<span class="apiarg">rollid</span>)
 
: [[API GetLootRollTimeLeft|GetLootRollTimeLeft]](<span class="apiarg">rollid</span>)
: [[API GetLootSlotInfo|GetLootSlotInfo]](<span class="apiarg">slot</span>) - Returns icon path, item name, and item quantity for the item in the given loot window slot.
+
: [[API GetLootSlotInfo|GetLootSlotInfo]](<span class="apiarg">slot</span>) - Returns info for a loot slot.
: [[API GetLootSlotLink|GetLootSlotLink]](<span class="apiarg">slot</span>) - Returns an [[itemLink]] for the item in the given loot window slot.
+
: [[API GetLootSlotLink|GetLootSlotLink]](<span class="apiarg">slot</span>) - Returns the item link for a loot slot.
 
: [[API GetLootSlotType|GetLootSlotType]](<span class="apiarg">slot</span>)
 
: [[API GetLootSlotType|GetLootSlotType]](<span class="apiarg">slot</span>)
 
: [[API GetLootSourceInfo|GetLootSourceInfo]](<span class="apiarg">slot</span>) - Returns information about the source of the objects in a loot slot.
 
: [[API GetLootSourceInfo|GetLootSourceInfo]](<span class="apiarg">slot</span>) - Returns information about the source of the objects in a loot slot.
 
: [[API GetLootSpecialization|GetLootSpecialization]]()
 
: [[API GetLootSpecialization|GetLootSpecialization]]()
: [[API GetLootThreshold|GetLootThreshold]]() - Returns the current loot threshold (for group/master loot)
+
: [[API GetLootThreshold|GetLootThreshold]]() - Returns the loot threshold quality for e.g. master loot.
: [[API GetMasterLootCandidate|GetMasterLootCandidate]](<span class="apiarg">index</span>) - Returns the name of a player who is eligible to receive loot in master mode.
+
: [[API GetMasterLootCandidate|GetMasterLootCandidate]](<span class="apiarg">index</span>) - Returns the name of an eligible player for receiving master loot by index.
: [[API GetNumLootItems|GetNumLootItems]]() - Returns amount of objects to loot (number)
+
: [[API GetNumLootItems|GetNumLootItems]]() - Returns the number of items in the loot window.
: [[API GetOptOutOfLoot|GetOptOutOfLoot]]() - Returns whether the character is currently automatically passing on all loot.
+
: [[API GetOptOutOfLoot|GetOptOutOfLoot]]() - True if the player is automatically passing on all loot.
 
: [[API GiveMasterLoot|GiveMasterLoot]](<span class="apiarg">slot, index</span>)
 
: [[API GiveMasterLoot|GiveMasterLoot]](<span class="apiarg">slot, index</span>)
 
: [[API IsFishingLoot|IsFishingLoot]]()
 
: [[API IsFishingLoot|IsFishingLoot]]()
 
: [[API IsMasterLooter|IsMasterLooter]]()
 
: [[API IsMasterLooter|IsMasterLooter]]()
 
: [[API LootMoneyNotify|LootMoneyNotify]](<span class="apiarg">money, soleLooter</span>)
 
: [[API LootMoneyNotify|LootMoneyNotify]](<span class="apiarg">money, soleLooter</span>)
: [[API LootSlot|LootSlot]](<span class="apiarg">slot</span>) - Used to loot the specified slot.
+
: [[API LootSlot|LootSlot]](<span class="apiarg">slot</span>) - Loots the specified slot; can require confirmation with [[API ConfirmLootSlot|ConfirmLootSlot]].
 
: [[API LootSlotHasItem|LootSlotHasItem]](<span class="apiarg">slot</span>)
 
: [[API LootSlotHasItem|LootSlotHasItem]](<span class="apiarg">slot</span>)
: [[API RollOnLoot|RollOnLoot]](<span class="apiarg">rollId [, roll]</span>) - Roll or pass on a loot event started by the game engine.
+
: [[API RollOnLoot|RollOnLoot]](<span class="apiarg">rollId [, roll]</span>) - Rolls or passes on loot.
 
: [[API SetLootMethod|SetLootMethod]](<span class="apiarg">lootMethod [, masterPlayer or threshold]</span>) - Set the current loot method.
 
: [[API SetLootMethod|SetLootMethod]](<span class="apiarg">lootMethod [, masterPlayer or threshold]</span>) - Set the current loot method.
 
: [[API SetLootPortrait|SetLootPortrait]]()
 
: [[API SetLootPortrait|SetLootPortrait]]()
 
: [[API SetLootSpecialization|SetLootSpecialization]](<span class="apiarg">specilizationID</span>)
 
: [[API SetLootSpecialization|SetLootSpecialization]](<span class="apiarg">specilizationID</span>)
: [[API SetLootThreshold|SetLootThreshold]](<span class="apiarg">itemQuality</span>) - Set the threshold for group/master loot.
+
: [[API SetLootThreshold|SetLootThreshold]](<span class="apiarg">itemQuality</span>) - Sets the loot quality threshold for group/master loot.
: [[API SetOptOutOfLoot|SetOptOutOfLoot]](<span class="apiarg">optOut</span>) - Enables or disables automatic passing on all loot.
+
: [[API SetOptOutOfLoot|SetOptOutOfLoot]](<span class="apiarg">optOut</span>) - Sets whether to automatically pass on all loot.
   
=== Macros ===
+
===Macros===
 
Relates to [[Macro]]s.
 
Relates to [[Macro]]s.
: <small>NOCOMBAT</small> [[API CreateMacro|CreateMacro]](<span class="apiarg">name, icon, body, perCharacter, isLocal</span>) - Create a new macro.
+
: <small>''NOCOMBAT''</small> [[API CreateMacro|CreateMacro]](<span class="apiarg">name, icon, body, perCharacter, isLocal</span>) - Creates a macro.
 
: [[API DeleteMacro|DeleteMacro]](<span class="apiarg">id or name</span>) - Deletes a macro.
 
: [[API DeleteMacro|DeleteMacro]](<span class="apiarg">id or name</span>) - Deletes a macro.
: <small>NOCOMBAT</small> [[API EditMacro|EditMacro]](<span class="apiarg">index, name, iconIndex, body, isLocal, perCharacter</span>) - Saves a macro.
+
: <small>''NOCOMBAT''</small> [[API EditMacro|EditMacro]](<span class="apiarg">index, name, iconIndex, body, isLocal, perCharacter</span>) - Modifies an existing macro.
 
: [[API GetLooseMacroIcons|GetLooseMacroIcons]]()
 
: [[API GetLooseMacroIcons|GetLooseMacroIcons]]()
 
: [[API GetLooseMacroItemIcons|GetLooseMacroItemIcons]]()
 
: [[API GetLooseMacroItemIcons|GetLooseMacroItemIcons]]()
 
: [[API GetMacroBody|GetMacroBody]](<span class="apiarg">id or name</span>) - Returns the body (macro text) of a macro.
 
: [[API GetMacroBody|GetMacroBody]](<span class="apiarg">id or name</span>) - Returns the body (macro text) of a macro.
 
: [[API GetMacroIcons|GetMacroIcons]](<span class="apiarg">table</span>) - Returns an array of available macro texture paths (but not icons of items).
 
: [[API GetMacroIcons|GetMacroIcons]](<span class="apiarg">table</span>) - Returns an array of available macro texture paths (but not icons of items).
: [[API GetMacroIndexByName|GetMacroIndexByName]](<span class="apiarg">name</span>) - Returns macro index.
+
: [[API GetMacroIndexByName|GetMacroIndexByName]](<span class="apiarg">name</span>) - Returns the index for a macro by name.
: [[API GetMacroInfo|GetMacroInfo]](<span class="apiarg">id or name</span>) - Returns "name", "iconTexture", "body", isLocal.
+
: [[API GetMacroInfo|GetMacroInfo]](<span class="apiarg">id or name</span>) - Returns info for a macro.
 
: [[API GetMacroItemIcons|GetMacroItemIcons]](<span class="apiarg">table</span>) - Returns an array of available macro texture paths (icons of items).
 
: [[API GetMacroItemIcons|GetMacroItemIcons]](<span class="apiarg">table</span>) - Returns an array of available macro texture paths (icons of items).
 
: [[API GetMacroItem|GetMacroItem]]()
 
: [[API GetMacroItem|GetMacroItem]]()
 
: [[API GetMacroSpell|GetMacroSpell]]()
 
: [[API GetMacroSpell|GetMacroSpell]]()
: [[API GetNumMacros|GetNumMacros]]() - Returns the number of macros the user has.
+
: [[API GetNumMacros|GetNumMacros]]() - Returns the number of account and character macros.
 
: [[API GetRunningMacroButton|GetRunningMacroButton]]()
 
: [[API GetRunningMacroButton|GetRunningMacroButton]]()
 
: [[API GetRunningMacro|GetRunningMacro]]()
 
: [[API GetRunningMacro|GetRunningMacro]]()
: <small>PROTECTED</small> [[API RunMacro|RunMacro]](<span class="apiarg">id or name</span>) - Runs a macro.
+
: <small>''PROTECTED''</small> [[API RunMacro|RunMacro]](<span class="apiarg">id or name</span>) - Executes a macro.
: <small>PROTECTED</small> [[API RunMacroText|RunMacroText]](<span class="apiarg">macro</span>) - Interpret the given string as a macro and run it.
+
: <small>''PROTECTED''</small> [[API RunMacroText|RunMacroText]](<span class="apiarg">macro</span>) - Executes a string as if it was a macro.
: [[API SecureCmdOptionParse|SecureCmdOptionParse]](<span class="apiarg">command</span>) - Used for evaluating conditionals in macros, returning the appropriate choice.
+
: [[API SecureCmdOptionParse|SecureCmdOptionParse]](<span class="apiarg">command</span>) - Evaluates macro conditionals without the need of a macro.
 
: [[API SetMacroItem|SetMacroItem]](<span class="apiarg">macro, item [, target]</span>)
 
: [[API SetMacroItem|SetMacroItem]](<span class="apiarg">macro, item [, target]</span>)
 
: [[API SetMacroSpell|SetMacroSpell]](<span class="apiarg">macro, spell [, target]</span>)
 
: [[API SetMacroSpell|SetMacroSpell]](<span class="apiarg">macro, spell [, target]</span>)
: <small>PROTECTED</small> [[API StopMacro|StopMacro]]() - Stops the currently executing macro.
+
: <small>''PROTECTED''</small> [[API StopMacro|StopMacro]]() - Stops the currently executing macro.
   
=== Mail ===
+
===Mail===
 
Relates to [[Mail]].
 
Relates to [[Mail]].
 
: [[API C_Mail.CanCheckInbox|C_Mail.CanCheckInbox]]() : <span class="apiret">canCheckInbox, secondsUntilAllowed</span>
 
: [[API C_Mail.CanCheckInbox|C_Mail.CanCheckInbox]]() : <span class="apiret">canCheckInbox, secondsUntilAllowed</span>
Line 2,902: Line 2,939:
 
: [[API AutoLootMailItem|AutoLootMailItem]](<span class="apiarg">index</span>) - Loot all items from mail message.
 
: [[API AutoLootMailItem|AutoLootMailItem]](<span class="apiarg">index</span>) - Loot all items from mail message.
 
: [[API CanComplainInboxItem|CanComplainInboxItem]](<span class="apiarg">index</span>) - Determines if we should show the “report spam” button on a mail item.
 
: [[API CanComplainInboxItem|CanComplainInboxItem]](<span class="apiarg">index</span>) - Determines if we should show the “report spam” button on a mail item.
: [[API CheckInbox|CheckInbox]]() - Populate client's inbox with mail from server.
+
: [[API CheckInbox|CheckInbox]]() - Queries the server for mail.
: [[API ClearSendMail|ClearSendMail]]() - This clears the text in the send mail tab and places the COD item in the inventory.
+
: [[API ClearSendMail|ClearSendMail]]() - Clears the text and item attachments in the Send Mail tab.
: [[API ClickSendMailItemButton|ClickSendMailItemButton]](<span class="apiarg">[itemIndex, clearItem]</span>) - Places or picks up an item from the send mail frame.
+
: [[API ClickSendMailItemButton|ClickSendMailItemButton]](<span class="apiarg">[itemIndex, clearItem]</span>) - Drops or picks up an item from the cursor to the Send Mail tab.
 
: [[API CloseMail|CloseMail]]() - Closes the mail window.
 
: [[API CloseMail|CloseMail]]() - Closes the mail window.
: [[API ComplainInboxItem|ComplainInboxItem]](<span class="apiarg">index</span>) - Complains about a particular mail item.
+
: [[API DeleteInboxItem|DeleteInboxItem]](<span class="apiarg">index</span>) - Requests the server to remove a mailbox message.
: [[API DeleteInboxItem|DeleteInboxItem]](<span class="apiarg">index</span>) - Deletes the inbox item at index. It returns immediately, it does not seem to wait for the deletion to go through, giving the normal problems with rapid mail removal attempts.
 
 
: [[API GetCoinIcon|GetCoinIcon]](<span class="apiarg">amount</span>)
 
: [[API GetCoinIcon|GetCoinIcon]](<span class="apiarg">amount</span>)
: [[API GetInboxHeaderInfo|GetInboxHeaderInfo]](<span class="apiarg">index</span>) - Returns information about a message in the inbox.
+
: [[API GetInboxHeaderInfo|GetInboxHeaderInfo]](<span class="apiarg">index</span>) - Returns info for a message in the mailbox.
: [[API GetInboxItem|GetInboxItem]](<span class="apiarg">index, itemIndex</span>) - Returns description of the attachment attached to message at (index).
+
: [[API GetInboxItem|GetInboxItem]](<span class="apiarg">index, itemIndex</span>) - Returns info for an item attached to a message in the mailbox.
: [[API GetInboxItemLink|GetInboxItemLink]](<span class="apiarg">index, itemIndex</span>) - Returns link of the attachment attached to message at (index).
+
: [[API GetInboxItemLink|GetInboxItemLink]](<span class="apiarg">index, itemIndex</span>) - Returns the item link of an item attached to a message in the mailbox.
: [[API GetInboxNumItems|GetInboxNumItems]]() - Returns the number of messages in your inbox.
+
: [[API GetInboxNumItems|GetInboxNumItems]]() - Returns the number of messages in the mailbox.
: [[API GetInboxText|GetInboxText]](<span class="apiarg">index</span>) - Returns the message text of message at (index).
+
: [[API GetInboxText|GetInboxText]](<span class="apiarg">index</span>) - Returns the text of a message in the mailbox.
: [[API GetInboxInvoiceInfo|GetInboxInvoiceInfo]](<span class="apiarg">index</span>) - Returns informations about an auction house invoice.
+
: [[API GetInboxInvoiceInfo|GetInboxInvoiceInfo]](<span class="apiarg">index</span>) - Returns info for an auction house invoice.
: [[API GetLatestThreeSenders|GetLatestThreeSenders]]() - Returns the senders of the most recent unread mail.
+
: [[API GetLatestThreeSenders|GetLatestThreeSenders]]() - Returns up to three senders of unread mail.
: [[API GetSendMailCOD|GetSendMailCOD]]() - Determine amount of gold entered in COD box in mail frame when mail is sent.
+
: [[API GetSendMailCOD|GetSendMailCOD]]() - Returns the Cash-On-Delivery cost of the outgoing message.
: [[API GetSendMailItem|GetSendMailItem]](<span class="apiarg">index</span>) - Get information about an item attached on the send mail frame.
+
: [[API GetSendMailItem|GetSendMailItem]](<span class="apiarg">index</span>) - Returns info for an item attached in the outgoing message.
: [[API GetSendMailItemLink|GetSendMailItemLink]](<span class="apiarg">index</span>) - Get link for an item attached on the send mail frame.
+
: [[API GetSendMailItemLink|GetSendMailItemLink]](<span class="apiarg">index</span>) - Returns the item link of an item attached in the outgoing message.
 
: [[API GetSendMailMoney|GetSendMailMoney]]()
 
: [[API GetSendMailMoney|GetSendMailMoney]]()
 
: [[API GetSendMailPrice|GetSendMailPrice]]() - Gets the cost for sending mail.
 
: [[API GetSendMailPrice|GetSendMailPrice]]() - Gets the cost for sending mail.
Line 2,924: Line 2,960:
 
: [[API HasNewMail|HasNewMail]]() - Returns nil if there is no new mail.
 
: [[API HasNewMail|HasNewMail]]() - Returns nil if there is no new mail.
 
: [[API HasSendMailItem|HasSendMailItem]](<span class="apiarg">index</span>) - Returns boolean if item is attached to send mail frame in specified slot.
 
: [[API HasSendMailItem|HasSendMailItem]](<span class="apiarg">index</span>) - Returns boolean if item is attached to send mail frame in specified slot.
: [[API InboxItemCanDelete|InboxItemCanDelete]](<span class="apiarg">index</span>) - Boolean check for whether a message is returnable to the sender.
+
: [[API InboxItemCanDelete|InboxItemCanDelete]](<span class="apiarg">index</span>) - True if a message can be deleted, false if it can be returned to sender.
 
: [[API RespondMailLockSendItem|RespondMailLockSendItem]](<span class="apiarg">slot, keepItem</span>) - Confirm item wont be refunded, keepItem boolean.
 
: [[API RespondMailLockSendItem|RespondMailLockSendItem]](<span class="apiarg">slot, keepItem</span>) - Confirm item wont be refunded, keepItem boolean.
 
: [[API ReturnInboxItem|ReturnInboxItem]](<span class="apiarg">index</span>) - Returns to the sender the attached item in the mail message at the specified index.
 
: [[API ReturnInboxItem|ReturnInboxItem]](<span class="apiarg">index</span>) - Returns to the sender the attached item in the mail message at the specified index.
: <small>SCRIPT</small> [[API SendMail|SendMail]](<span class="apiarg">target, subject, body</span>) - If the mailbox is open, this sends mail.
+
: <small>''SCRIPT''</small> [[API SendMail|SendMail]](<span class="apiarg">target, subject, body</span>) - Sends in-game mail.
: <small>PROTECTED</small> [[API SetSendMailCOD|SetSendMailCOD]](<span class="apiarg">amount</span>) - Make next mail sent using SendMail() COD target for amount.
+
: <small>''PROTECTED''</small> [[API SetSendMailCOD|SetSendMailCOD]](<span class="apiarg">amount</span>) - Make next mail sent using SendMail() COD target for amount.
: <small>PROTECTED</small> [[API SetSendMailMoney|SetSendMailMoney]](<span class="apiarg">amount</span>) - Add money to next mail sent using SendMail().
+
: <small>''PROTECTED''</small> [[API SetSendMailMoney|SetSendMailMoney]](<span class="apiarg">amount</span>) - Add money to next mail sent using SendMail().
 
: [[API SetSendMailShowing|SetSendMailShowing]]()
 
: [[API SetSendMailShowing|SetSendMailShowing]]()
: [[API TakeInboxItem|TakeInboxItem]](<span class="apiarg">index, itemIndex</span>) - Take the attached item from the mailbox message at index.
+
: [[API TakeInboxItem|TakeInboxItem]](<span class="apiarg">index, itemIndex</span>) - Takes the attached item from the mailbox message.
 
: [[API TakeInboxMoney|TakeInboxMoney]](<span class="apiarg">index</span>) - Take the attached money from the mailbox message at index.
 
: [[API TakeInboxMoney|TakeInboxMoney]](<span class="apiarg">index</span>) - Take the attached money from the mailbox message at index.
 
: [[API TakeInboxTextItem|TakeInboxTextItem]](<span class="apiarg">index</span>) - Creates a permanent copy of letter (readable "Plain Letter").
 
: [[API TakeInboxTextItem|TakeInboxTextItem]](<span class="apiarg">index</span>) - Creates a permanent copy of letter (readable "Plain Letter").
   
=== Maps ===
+
===Maps===
 
The [[Map]] API was reworked in [[Patch 8.0.1]]. See also [[#MapUtil|MapUtil]] functions.
 
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]]()
Line 2,948: Line 2,984:
 
: [[API C_Map.GetMapArtLayerTextures|C_Map.GetMapArtLayerTextures]](<span class="apiarg">uiMapID, layerIndex</span>) : <span class="apiret">textures</span> - Returns the art layer textures for a map.
 
: [[API C_Map.GetMapArtLayerTextures|C_Map.GetMapArtLayerTextures]](<span class="apiarg">uiMapID, layerIndex</span>) : <span class="apiret">textures</span> - Returns the art layer textures for a map.
 
: [[API C_Map.GetMapBannersForMap|C_Map.GetMapBannersForMap]](<span class="apiarg">uiMapID</span>) : <span class="apiret">mapBanners</span> - Returns the poi banners for a map.
 
: [[API C_Map.GetMapBannersForMap|C_Map.GetMapBannersForMap]](<span class="apiarg">uiMapID</span>) : <span class="apiret">mapBanners</span> - Returns the poi banners for a map.
: [[API C_Map.GetMapChildrenInfo|C_Map.GetMapChildrenInfo]](<span class="apiarg">uiMapID [, mapType, allDescendants]</span>) : <span class="apiret">info</span> - Returns information on the sub-maps of the given uiMapID, optionally restricted to a specific "map type", and/or recursive.
+
: [[API C_Map.GetMapChildrenInfo|C_Map.GetMapChildrenInfo]](<span class="apiarg">uiMapID [, mapType, allDescendants]</span>) : <span class="apiret">info</span> - Returns info for the children of a map.
 
: [[API C_Map.GetMapDisplayInfo|C_Map.GetMapDisplayInfo]](<span class="apiarg">uiMapID</span>) : <span class="apiret">hideIcons</span> - Returns whether group member pins should be hidden.
 
: [[API C_Map.GetMapDisplayInfo|C_Map.GetMapDisplayInfo]](<span class="apiarg">uiMapID</span>) : <span class="apiret">hideIcons</span> - Returns whether group member pins should be hidden.
 
: [[API C_Map.GetMapGroupID|C_Map.GetMapGroupID]](<span class="apiarg">uiMapID</span>) : <span class="apiret">uiMapGroupID</span> - Returns the map group for a map.
 
: [[API C_Map.GetMapGroupID|C_Map.GetMapGroupID]](<span class="apiarg">uiMapID</span>) : <span class="apiret">uiMapGroupID</span> - Returns the map group for a map.
Line 2,954: Line 2,990:
 
: [[API C_Map.GetMapHighlightInfoAtPosition|C_Map.GetMapHighlightInfoAtPosition]](<span class="apiarg">uiMapID, x, y</span>) : <span class="apiret">fileDataID, atlasID, texturePercentageX, texturePercentageY, ...</span> - Returns a map highlight pin for a location.
 
: [[API C_Map.GetMapHighlightInfoAtPosition|C_Map.GetMapHighlightInfoAtPosition]](<span class="apiarg">uiMapID, x, y</span>) : <span class="apiret">fileDataID, atlasID, texturePercentageX, texturePercentageY, ...</span> - Returns a map highlight pin for a location.
 
: [[API C_Map.GetMapInfo|C_Map.GetMapInfo]](<span class="apiarg">uiMapID</span>) : <span class="apiret">info</span> - Returns map information.
 
: [[API C_Map.GetMapInfo|C_Map.GetMapInfo]](<span class="apiarg">uiMapID</span>) : <span class="apiret">info</span> - Returns map information.
: [[API C_Map.GetMapInfoAtPosition|C_Map.GetMapInfoAtPosition]](<span class="apiarg">uiMapID, x, y</span>) : <span class="apiret">info</span> - Returns map info for a location on the map.
+
: [[API C_Map.GetMapInfoAtPosition|C_Map.GetMapInfoAtPosition]](<span class="apiarg">uiMapID, x, y</span>) : <span class="apiret">info</span> - Returns info for any child or adjacent maps at a position on the map.
 
: [[API C_Map.GetMapLevels|C_Map.GetMapLevels]](<span class="apiarg">uiMapID</span>) : <span class="apiret">playerMinLevel, playerMaxLevel, petMinLevel, petMaxLevel</span> - Returns the suggested player and battle pet levels for a map.
 
: [[API C_Map.GetMapLevels|C_Map.GetMapLevels]](<span class="apiarg">uiMapID</span>) : <span class="apiret">playerMinLevel, playerMaxLevel, petMinLevel, petMaxLevel</span> - Returns the suggested player and battle pet levels for a map.
 
: [[API C_Map.GetMapLinksForMap|C_Map.GetMapLinksForMap]](<span class="apiarg">uiMapID</span>) : <span class="apiret">mapLinks</span> - Returns the map pins that link to another map.
 
: [[API C_Map.GetMapLinksForMap|C_Map.GetMapLinksForMap]](<span class="apiarg">uiMapID</span>) : <span class="apiret">mapLinks</span> - Returns the map pins that link to another map.
Line 2,960: Line 2,996:
 
: [[API C_Map.GetMapRectOnMap|C_Map.GetMapRectOnMap]](<span class="apiarg">uiMapID, topUiMapID</span>) : <span class="apiret">minX, maxX, minY, maxY</span> - Returns the map rectangle location for a map on its parent map.
 
: [[API C_Map.GetMapRectOnMap|C_Map.GetMapRectOnMap]](<span class="apiarg">uiMapID, topUiMapID</span>) : <span class="apiret">minX, maxX, minY, maxY</span> - Returns the map rectangle location for a map on its parent map.
 
: [[API C_Map.GetMapWorldSize|C_Map.GetMapWorldSize]](<span class="apiarg">uiMapID</span>) : <span class="apiret">width, height</span>
 
: [[API C_Map.GetMapWorldSize|C_Map.GetMapWorldSize]](<span class="apiarg">uiMapID</span>) : <span class="apiret">width, height</span>
: <small>NOINSTANCE</small> [[API C_Map.GetPlayerMapPosition|C_Map.GetPlayerMapPosition]](<span class="apiarg">uiMapID, unitToken</span>) : <span class="apiret">position</span> - Returns the location of the given unit. Only works for the player and party members.
+
: <small>''NOINSTANCE''</small> [[API C_Map.GetPlayerMapPosition|C_Map.GetPlayerMapPosition]](<span class="apiarg">uiMapID, unitToken</span>) : <span class="apiret">position</span> - Returns the location of the unit on a map.
: [[API C_Map.GetWorldPosFromMapPos|C_Map.GetWorldPosFromMapPos]](<span class="apiarg">uiMapID, mapPosition</span>) : <span class="apiret">continentID, worldPosition</span> - Translates a world map position to a map position.
+
: [[API C_Map.GetWorldPosFromMapPos|C_Map.GetWorldPosFromMapPos]](<span class="apiarg">uiMapID, mapPosition</span>) : <span class="apiret">continentID, worldPosition</span> - Translates a map position to a world map position.
 
: [[API C_Map.IsMapValidForNavBarDropDown|C_Map.IsMapValidForNavBarDropDown]](<span class="apiarg">uiMapID</span>) : <span class="apiret">isValid</span>
 
: [[API C_Map.IsMapValidForNavBarDropDown|C_Map.IsMapValidForNavBarDropDown]](<span class="apiarg">uiMapID</span>) : <span class="apiret">isValid</span>
 
: [[API C_Map.MapHasArt|C_Map.MapHasArt]](<span class="apiarg">uiMapID</span>) : <span class="apiret">hasArt</span> - Returns true if the map has art and can be displayed by the FrameXML.
 
: [[API C_Map.MapHasArt|C_Map.MapHasArt]](<span class="apiarg">uiMapID</span>) : <span class="apiret">hasArt</span> - Returns true if the map has art and can be displayed by the FrameXML.
Line 2,967: Line 3,003:
 
: [[API C_MapExplorationInfo.GetExploredAreaIDsAtPosition|C_MapExplorationInfo.GetExploredAreaIDsAtPosition]](<span class="apiarg">uiMapID, normalizedPosition</span>) : <span class="apiret">areaID</span> - Returns the explored areas for the location on a map.
 
: [[API C_MapExplorationInfo.GetExploredAreaIDsAtPosition|C_MapExplorationInfo.GetExploredAreaIDsAtPosition]](<span class="apiarg">uiMapID, normalizedPosition</span>) : <span class="apiret">areaID</span> - Returns the explored areas for the location on a map.
 
: [[API C_MapExplorationInfo.GetExploredMapTextures|C_MapExplorationInfo.GetExploredMapTextures]](<span class="apiarg">uiMapID</span>) : <span class="apiret">overlayInfo</span> - Returns explored map textures for a map.
 
: [[API C_MapExplorationInfo.GetExploredMapTextures|C_MapExplorationInfo.GetExploredMapTextures]](<span class="apiarg">uiMapID</span>) : <span class="apiret">overlayInfo</span> - Returns explored map textures for a map.
: [[API C_FogOfWar.GetFogOfWarForMap|C_FogOfWar.GetFogOfWarForMap]](<span class="apiarg">uiMapID</span>) : <span class="apiret">fogOfWarID</span> - Returns the fog of war ID for an (Island Expedition) map.
+
: [[API C_FogOfWar.GetFogOfWarForMap|C_FogOfWar.GetFogOfWarForMap]](<span class="apiarg">uiMapID</span>) : <span class="apiret">fogOfWarID</span> - Returns the fog of war for an [[Island Expedition]] map.
: [[API C_FogOfWar.GetFogOfWarInfo|C_FogOfWar.GetFogOfWarInfo]](<span class="apiarg">fogOfWarID</span>) : <span class="apiret">fogOfWarInfo</span> - Returns fog of war info for an (Island Expedition) map.
+
: [[API C_FogOfWar.GetFogOfWarInfo|C_FogOfWar.GetFogOfWarInfo]](<span class="apiarg">fogOfWarID</span>) : <span class="apiret">fogOfWarInfo</span> - Returns info for the fog of war for an [[Island Expedition]] map.
 
: [[API GetAreaText|GetAreaText]]()
 
: [[API GetAreaText|GetAreaText]]()
: [[API GetMinimapZoneText|GetMinimapZoneText]]() - Returns the zone text, that is displayed over the minimap.
+
: [[API GetMinimapZoneText|GetMinimapZoneText]]() - Returns the zone text that is displayed over the minimap.
: <small>NOINSTANCE</small> [[API GetPlayerFacing|GetPlayerFacing]]() - Returns the direction the player is facing.
+
: <small>''NOINSTANCE''</small> [[API GetPlayerFacing|GetPlayerFacing]]() - Returns the direction the character is facing in radians.
: [[API GetRealZoneText|GetRealZoneText]](<span class="apiarg">[mapID]</span>) - Returns either instance name or zone name.
+
: [[API GetRealZoneText|GetRealZoneText]](<span class="apiarg">[mapID]</span>) - Returns the map instance name.
: [[API GetSubZoneText|GetSubZoneText]]() - Returns the subzone text (e.g. "The Canals").
+
: [[API GetSubZoneText|GetSubZoneText]]() - Returns the subzone name.
 
: [[API GetZonePVPInfo|GetZonePVPInfo]]() - Returns PVP info for the current zone.
 
: [[API GetZonePVPInfo|GetZonePVPInfo]]() - Returns PVP info for the current zone.
: [[API GetZoneText|GetZoneText]]() - Returns the zone text (e.g. "Stormwind City").
+
: [[API GetZoneText|GetZoneText]]() - Returns the name of the zone the player is in.
: <small>NOINSTANCE</small> [[API UnitDistanceSquared|UnitDistanceSquared]](<span class="apiarg">unit</span>) - Returns the squared distance to a unit in your group.
+
: <small>''NOINSTANCE''</small> [[API UnitDistanceSquared|UnitDistanceSquared]](<span class="apiarg">unit</span>) - Returns the squared distance to a unit in your group.
: <small>NOINSTANCE</small> [[API UnitPosition|UnitPosition]](<span class="apiarg">unit</span>) - Returns the position of a unit within the current world area.
+
: <small>''NOINSTANCE''</small> [[API UnitPosition|UnitPosition]](<span class="apiarg">unit</span>) - Returns the position of a unit in the current world area.
: <small>UI</small> [https://www.townlong-yak.com/framexml/go/MapCanvasMixin:AddDataProvider WorldMapFrame:AddDataProvider](<span class="apiarg">dataProvider</span>) - Adds a map data provider.
+
: <small>''UI''</small> [https://www.townlong-yak.com/framexml/go/MapCanvasMixin:AddDataProvider WorldMapFrame:AddDataProvider](<span class="apiarg">dataProvider</span>) - Adds a map data provider.
: <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/go/MapCanvasMixin:GetMapID WorldMapFrame:GetMapID]() - Returns the currently viewed world map.
: <small>UI</small> [https://www.townlong-yak.com/framexml/go/MapCanvasMixin:SetMapID WorldMapFrame:SetMapID](<span class="apiarg">uiMapID</span>) - Sets the world map.
+
: <small>''UI''</small> [https://www.townlong-yak.com/framexml/go/MapCanvasMixin:SetMapID WorldMapFrame:SetMapID](<span class="apiarg">uiMapID</span>) - Sets the world map.
: <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/go/MapCanvasMixin:EnumerateAllPins WorldMapFrame:EnumerateAllPins]() - Enumerates through all map pins.
   
==== Minimap ====
+
====Minimap====
 
The [[Widget_API#Minimap|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 class="apiret">draw</span>
 
: [[API C_Minimap.GetDrawGroundTextures|C_Minimap.GetDrawGroundTextures]]() : <span class="apiret">draw</span>
Line 2,993: Line 3,029:
 
: [[API C_Minimap.ShouldUseHybridMinimap|C_Minimap.ShouldUseHybridMinimap]]() : <span class="apiret">shouldUse</span>
 
: [[API C_Minimap.ShouldUseHybridMinimap|C_Minimap.ShouldUseHybridMinimap]]() : <span class="apiret">shouldUse</span>
   
==== Tracking ====
+
====Tracking====
 
Relates to [[Tracking]] on the minimap.
 
Relates to [[Tracking]] on the minimap.
 
: [[API ClearAllTracking|ClearAllTracking]]()
 
: [[API ClearAllTracking|ClearAllTracking]]()
: [[API GetNumTrackingTypes|GetNumTrackingTypes]]() - Returns number of available tracking methods.
+
: [[API GetNumTrackingTypes|GetNumTrackingTypes]]() - Returns the number of available tracking types for the minimap.
: [[API GetTrackingInfo|GetTrackingInfo]](<span class="apiarg">id</span>) - Retrieves tracking information from specified id.
+
: [[API GetTrackingInfo|GetTrackingInfo]](<span class="apiarg">id</span>) - Returns tracking info by index.
: [[API SetTracking|SetTracking]](<span class="apiarg">id, enabled</span>) - Enables or disables a tracking method.
+
: [[API SetTracking|SetTracking]](<span class="apiarg">id, enabled</span>) - Sets a minimap tracking method.
   
==== Points of Interest ====
+
====Points of Interest====
 
: [[API C_AreaPoiInfo.GetAreaPOIForMap|C_AreaPoiInfo.GetAreaPOIForMap]](<span class="apiarg">uiMapID</span>) : <span class="apiret">areaPoiIDs</span> - Returns area points of interest for a map.
 
: [[API C_AreaPoiInfo.GetAreaPOIForMap|C_AreaPoiInfo.GetAreaPOIForMap]](<span class="apiarg">uiMapID</span>) : <span class="apiret">areaPoiIDs</span> - Returns area points of interest for a map.
: [[API C_AreaPoiInfo.GetAreaPOIInfo|C_AreaPoiInfo.GetAreaPOIInfo]](<span class="apiarg">uiMapID, areaPoiID</span>) : <span class="apiret">poiInfo</span> - Returns area point of interest info.
+
: [[API C_AreaPoiInfo.GetAreaPOIInfo|C_AreaPoiInfo.GetAreaPOIInfo]](<span class="apiarg">uiMapID, areaPoiID</span>) : <span class="apiret">poiInfo</span> - Returns info for an area point of interest (e.g. World PvP objectives).
: [[API C_AreaPoiInfo.GetAreaPOISecondsLeft|C_AreaPoiInfo.GetAreaPOISecondsLeft]](<span class="apiarg">areaPoiID</span>) : <span class="apiret">secondsLeft</span> - Returns the time left for an area poi.
+
: [[API C_AreaPoiInfo.GetAreaPOISecondsLeft|C_AreaPoiInfo.GetAreaPOISecondsLeft]](<span class="apiarg">areaPoiID</span>) : <span class="apiret">secondsLeft</span> - Returns the time left in seconds for an area point of interest.
 
: [[API C_AreaPoiInfo.IsAreaPOITimed|C_AreaPoiInfo.IsAreaPOITimed]](<span class="apiarg">areaPoiID</span>) : <span class="apiret">isTimed</span> - Returns whether an area poi is timed.
 
: [[API C_AreaPoiInfo.IsAreaPOITimed|C_AreaPoiInfo.IsAreaPOITimed]](<span class="apiarg">areaPoiID</span>) : <span class="apiret">isTimed</span> - Returns whether an area poi is timed.
 
: [[API GetPOITextureCoords|GetPOITextureCoords]](<span class="apiarg">textureIndex</span>)
 
: [[API GetPOITextureCoords|GetPOITextureCoords]](<span class="apiarg">textureIndex</span>)
Line 3,014: Line 3,050:
 
: [[API C_VignetteInfo.GetVignettes|C_VignetteInfo.GetVignettes]]() : <span class="apiret">vignetteGUIDs</span>
 
: [[API C_VignetteInfo.GetVignettes|C_VignetteInfo.GetVignettes]]() : <span class="apiret">vignetteGUIDs</span>
   
==== Waypoints ====
+
====Waypoints====
 
Tracked waypoints were added in [[Patch 9.0.1]]
 
Tracked waypoints were added in [[Patch 9.0.1]]
 
: [[API C_Map.CanSetUserWaypointOnMap|C_Map.CanSetUserWaypointOnMap]](<span class="apiarg">uiMapID</span>) : <span class="apiret">canSet</span>
 
: [[API C_Map.CanSetUserWaypointOnMap|C_Map.CanSetUserWaypointOnMap]](<span class="apiarg">uiMapID</span>) : <span class="apiret">canSet</span>
Line 3,042: Line 3,078:
 
: [[API C_QuestLog.GetNextWaypointText|C_QuestLog.GetNextWaypointText]](<span class="apiarg">questID</span>) : <span class="apiret">waypointText</span>
 
: [[API C_QuestLog.GetNextWaypointText|C_QuestLog.GetNextWaypointText]](<span class="apiarg">questID</span>) : <span class="apiret">waypointText</span>
   
==== Flight Master ====
+
====Flight Master====
 
Relates to [[Flight master]] taxi services.
 
Relates to [[Flight master]] taxi services.
 
: [[API C_TaxiMap.GetAllTaxiNodes|C_TaxiMap.GetAllTaxiNodes]](<span class="apiarg">uiMapID</span>) : <span class="apiret">taxiNodes</span>
 
: [[API C_TaxiMap.GetAllTaxiNodes|C_TaxiMap.GetAllTaxiNodes]](<span class="apiarg">uiMapID</span>) : <span class="apiret">taxiNodes</span>
 
: [[API C_TaxiMap.GetTaxiNodesForMap|C_TaxiMap.GetTaxiNodesForMap]](<span class="apiarg">uiMapID</span>) : <span class="apiret">mapTaxiNodes</span>
 
: [[API C_TaxiMap.GetTaxiNodesForMap|C_TaxiMap.GetTaxiNodesForMap]](<span class="apiarg">uiMapID</span>) : <span class="apiret">mapTaxiNodes</span>
 
: [[API C_TaxiMap.ShouldMapShowTaxiNodes|C_TaxiMap.ShouldMapShowTaxiNodes]](<span class="apiarg">uiMapID</span>) : <span class="apiret">shouldShowNodes</span>
 
: [[API C_TaxiMap.ShouldMapShowTaxiNodes|C_TaxiMap.ShouldMapShowTaxiNodes]](<span class="apiarg">uiMapID</span>) : <span class="apiret">shouldShowNodes</span>
: [[API CloseTaxiMap|CloseTaxiMap]]() - Closes the Flightpath Map.
+
: [[API CloseTaxiMap|CloseTaxiMap]]() - Closes the [[Flight Map]].
 
: [[API GetNumRoutes|GetNumRoutes]](<span class="apiarg">slot</span>) - Gets the number of hops between current-slot and slot.
 
: [[API GetNumRoutes|GetNumRoutes]](<span class="apiarg">slot</span>) - Gets the number of hops between current-slot and slot.
 
: [[API GetTaxiBenchmarkMode|GetTaxiBenchmarkMode]]()
 
: [[API GetTaxiBenchmarkMode|GetTaxiBenchmarkMode]]()
 
: [[API GetTaxiMapID|GetTaxiMapID]]()
 
: [[API GetTaxiMapID|GetTaxiMapID]]()
: [[API NumTaxiNodes|NumTaxiNodes]]() - Returns the number of nodes (flight paths) on an open taxi map.
+
: [[API NumTaxiNodes|NumTaxiNodes]]() - Returns the number of flight paths on the taxi map.
 
: [[API SetTaxiBenchmarkMode|SetTaxiBenchmarkMode]]()
 
: [[API SetTaxiBenchmarkMode|SetTaxiBenchmarkMode]]()
 
: [[API SetTaxiMap|SetTaxiMap]](<span class="apiarg">frame</span>)
 
: [[API SetTaxiMap|SetTaxiMap]](<span class="apiarg">frame</span>)
: [[API TakeTaxiNode|TakeTaxiNode]](<span class="apiarg">slot</span>) - Takes the named taxi node.
+
: [[API TakeTaxiNode|TakeTaxiNode]](<span class="apiarg">slot</span>) - Travels to the specified flight path node.
 
: [[API TaxiGetDestX|TaxiGetDestX]](<span class="apiarg">slot, hop</span>)
 
: [[API TaxiGetDestX|TaxiGetDestX]](<span class="apiarg">slot, hop</span>)
 
: [[API TaxiGetDestY|TaxiGetDestY]](<span class="apiarg">slot, hop</span>)
 
: [[API TaxiGetDestY|TaxiGetDestY]](<span class="apiarg">slot, hop</span>)
Line 3,061: Line 3,097:
 
: [[API TaxiGetSrcY|TaxiGetSrcY]](<span class="apiarg">slot, hop</span>)
 
: [[API TaxiGetSrcY|TaxiGetSrcY]](<span class="apiarg">slot, hop</span>)
 
: [[API TaxiIsDirectFlight|TaxiIsDirectFlight]]()
 
: [[API TaxiIsDirectFlight|TaxiIsDirectFlight]]()
: [[API TaxiNodeCost|TaxiNodeCost]](<span class="apiarg">slot</span>) - Returns the cost in copper of a node.
+
: [[API TaxiNodeCost|TaxiNodeCost]](<span class="apiarg">slot</span>) - Returns the cost of the flight path in copper.
: [[API TaxiNodeGetType|TaxiNodeGetType]](<span class="apiarg">slot</span>) - Returns the status of a node.
+
: [[API TaxiNodeGetType|TaxiNodeGetType]](<span class="apiarg">slot</span>) - Returns the type of a flight path node.
: [[API TaxiNodeName|TaxiNodeName]](<span class="apiarg">slot</span>) - Returns the name of a node.
+
: [[API TaxiNodeName|TaxiNodeName]](<span class="apiarg">slot</span>) - Returns the name of a flight path node.
: [[API TaxiNodePosition|TaxiNodePosition]](<span class="apiarg">slot</span>) - Returns position (x,y) of node on the map.
+
: [[API TaxiNodePosition|TaxiNodePosition]](<span class="apiarg">slot</span>) - Returns the position of a flight point on the taxi map.
 
: [[API TaxiRequestEarlyLanding|TaxiRequestEarlyLanding]]()
 
: [[API TaxiRequestEarlyLanding|TaxiRequestEarlyLanding]]()
: [[API UnitOnTaxi|UnitOnTaxi]](<span class="apiarg">unit</span>) - Returns 1 if unit is on a taxi.
+
: [[API UnitOnTaxi|UnitOnTaxi]](<span class="apiarg">unit</span>) - True if the unit is on a flight path.
   
=== Merchants ===
+
===Merchants===
==== Vendor ====
+
====Vendor====
 
Relates to [[Vendor]]s.
 
Relates to [[Vendor]]s.
 
: [[API C_MerchantFrame.GetBuybackItemID|C_MerchantFrame.GetBuybackItemID]](<span class="apiarg">buybackSlotIndex</span>) : <span class="apiret">buybackItemID</span>
 
: [[API C_MerchantFrame.GetBuybackItemID|C_MerchantFrame.GetBuybackItemID]](<span class="apiarg">buybackSlotIndex</span>) : <span class="apiret">buybackItemID</span>
 
: [[API C_MerchantFrame.IsMerchantItemRefundable|C_MerchantFrame.IsMerchantItemRefundable]](<span class="apiarg">index</span>) : <span class="apiret">refundable</span>
 
: [[API C_MerchantFrame.IsMerchantItemRefundable|C_MerchantFrame.IsMerchantItemRefundable]](<span class="apiarg">index</span>) : <span class="apiret">refundable</span>
 
: [[API BuyMerchantItem|BuyMerchantItem]](<span class="apiarg">index [, qty]</span>) - Buys an item from a merchant.
 
: [[API BuyMerchantItem|BuyMerchantItem]](<span class="apiarg">index [, qty]</span>) - Buys an item from a merchant.
: [[API BuybackItem|BuybackItem]](<span class="apiarg">index</span>) - Buys back a sold item.
+
: [[API BuybackItem|BuybackItem]](<span class="apiarg">index</span>) - Buys back an item from the merchant.
 
: [[API CanAffordMerchantItem|CanAffordMerchantItem]](<span class="apiarg">index</span>)
 
: [[API CanAffordMerchantItem|CanAffordMerchantItem]](<span class="apiarg">index</span>)
: [[API CanMerchantRepair|CanMerchantRepair]]() - Returns true if the merchant can repair items.
+
: [[API CanMerchantRepair|CanMerchantRepair]]() - True if the merchant can repair items.
 
: [[API CloseMerchant|CloseMerchant]]() - Closes the merchant window.
 
: [[API CloseMerchant|CloseMerchant]]() - Closes the merchant window.
 
: [[API ContainerRefundItemPurchase|ContainerRefundItemPurchase]](<span class="apiarg">index, slot [, isEquipped]</span>)
 
: [[API ContainerRefundItemPurchase|ContainerRefundItemPurchase]](<span class="apiarg">index, slot [, isEquipped]</span>)
: [[API GetBuybackItemInfo|GetBuybackItemInfo]](<span class="apiarg">index</span>) - Returns information about the buyback item.
+
: [[API GetBuybackItemInfo|GetBuybackItemInfo]](<span class="apiarg">index</span>) - Returns info for an item that can be bought back from a merchant.
 
: [[API GetBuybackItemLink|GetBuybackItemLink]](<span class="apiarg">index</span>) - Returns an [[itemLink]] for the buyback item.
 
: [[API GetBuybackItemLink|GetBuybackItemLink]](<span class="apiarg">index</span>) - Returns an [[itemLink]] for the buyback item.
 
: [[API GetMerchantCurrencies|GetMerchantCurrencies]]()
 
: [[API GetMerchantCurrencies|GetMerchantCurrencies]]()
 
: [[API GetMerchantFilter|GetMerchantFilter]]()
 
: [[API GetMerchantFilter|GetMerchantFilter]]()
 
: [[API GetMerchantItemCostInfo|GetMerchantItemCostInfo]](<span class="apiarg">index</span>) - Returns "alternative currency" information about an item.
 
: [[API GetMerchantItemCostInfo|GetMerchantItemCostInfo]](<span class="apiarg">index</span>) - Returns "alternative currency" information about an item.
: [[API GetMerchantItemCostItem|GetMerchantItemCostItem]](<span class="apiarg">index, itemIndex</span>) - Returns information about an "alternative currency" component of the price for a purchasable item.
+
: [[API GetMerchantItemCostItem|GetMerchantItemCostItem]](<span class="apiarg">index, itemIndex</span>) - Returns info for the currency cost for a merchant item.
 
: [[API GetMerchantItemID|GetMerchantItemID]](<span class="apiarg">index</span>)
 
: [[API GetMerchantItemID|GetMerchantItemID]](<span class="apiarg">index</span>)
: [[API GetMerchantItemInfo|GetMerchantItemInfo]](<span class="apiarg">index</span>) - Returns information about the given purchasable item.
+
: [[API GetMerchantItemInfo|GetMerchantItemInfo]](<span class="apiarg">index</span>) - Returns info for a merchant item.
: [[API GetMerchantItemLink|GetMerchantItemLink]](<span class="apiarg">index</span>) - Returns an [[itemLink]] for the given purchasable item.
+
: [[API GetMerchantItemLink|GetMerchantItemLink]](<span class="apiarg">index</span>) - Returns the item link for a merchant item.
: [[API GetMerchantItemMaxStack|GetMerchantItemMaxStack]](<span class="apiarg">index</span>) - Returns the maximum number of items in a stack.
+
: [[API GetMerchantItemMaxStack|GetMerchantItemMaxStack]](<span class="apiarg">index</span>) - Returns the maximum stack size for a merchant item.
: [[API GetMerchantNumItems|GetMerchantNumItems]]() - Returns the number of items the merchant sells.
+
: [[API GetMerchantNumItems|GetMerchantNumItems]]() - Returns the number of different items a merchant sells.
 
: [[API GetNumBuybackItems|GetNumBuybackItems]]() - Returns number of items available for buyback.
 
: [[API GetNumBuybackItems|GetNumBuybackItems]]() - Returns number of items available for buyback.
 
: [[API GetRepairAllCost|GetRepairAllCost]]()
 
: [[API GetRepairAllCost|GetRepairAllCost]]()
Line 3,096: Line 3,132:
 
: [[API SetMerchantFilter|SetMerchantFilter]]()
 
: [[API SetMerchantFilter|SetMerchantFilter]]()
   
==== Trainer ====
+
====Trainer====
 
Relates to [[Trainer]]s.
 
Relates to [[Trainer]]s.
: [[API BuyTrainerService|BuyTrainerService]](<span class="apiarg">index</span>) - Used for buying new/upgrading professions, profession items and class skills.
+
: [[API BuyTrainerService|BuyTrainerService]](<span class="apiarg">index</span>) - Buys a trainer service (e.g. class skills and profession recipes).
 
: [[API CloseTrainer|CloseTrainer]]() - Closes the trainer window.
 
: [[API CloseTrainer|CloseTrainer]]() - Closes the trainer window.
: [[API GetNumTrainerServices|GetNumTrainerServices]]() - Get the number of the trainer services.
+
: [[API GetNumTrainerServices|GetNumTrainerServices]]() - Returns the number of trainer services.
: [[API GetTrainerGreetingText|GetTrainerGreetingText]]() - Get the trainer's greeting text.
+
: [[API GetTrainerGreetingText|GetTrainerGreetingText]]() - Returns the trainer's greeting text.
: [[API GetTrainerSelectionIndex|GetTrainerSelectionIndex]]() - Get the index of the selected trainer service.
+
: [[API GetTrainerSelectionIndex|GetTrainerSelectionIndex]]() - Returns the index of the selected trainer service.
: [[API GetTrainerServiceAbilityReq|GetTrainerServiceAbilityReq]](<span class="apiarg">trainerIndex, reqIndex</span>) - Used for displaying the requirements to learn a new profession, profession skill or class skill.
+
: [[API GetTrainerServiceAbilityReq|GetTrainerServiceAbilityReq]](<span class="apiarg">trainerIndex, reqIndex</span>) - Returns the name of a requirement for training a skill and if the player meets the requirement.
: [[API GetTrainerServiceCost|GetTrainerServiceCost]](<span class="apiarg">index</span>) - Returns the cost of a specific trainer service.
+
: [[API GetTrainerServiceCost|GetTrainerServiceCost]](<span class="apiarg">index</span>) - Returns the cost of the specified trainer service.
 
: [[API GetTrainerServiceDescription|GetTrainerServiceDescription]](<span class="apiarg">index</span>) - Returns the description of a specific trainer service.
 
: [[API GetTrainerServiceDescription|GetTrainerServiceDescription]](<span class="apiarg">index</span>) - Returns the description of a specific trainer service.
: [[API GetTrainerServiceIcon|GetTrainerServiceIcon]](<span class="apiarg">index</span>) - Returns icon texture for a trainer service.
+
: [[API GetTrainerServiceIcon|GetTrainerServiceIcon]](<span class="apiarg">index</span>) - Returns the icon texture for a specific trainer service.
 
: [[API GetTrainerServiceInfo|GetTrainerServiceInfo]](<span class="apiarg">index</span>) - Returns information about a trainer service.
 
: [[API GetTrainerServiceInfo|GetTrainerServiceInfo]](<span class="apiarg">index</span>) - Returns information about a trainer service.
 
: [[API GetTrainerServiceItemLink|GetTrainerServiceItemLink]](<span class="apiarg">index</span>) - Returns an item link for a trainer service.
 
: [[API GetTrainerServiceItemLink|GetTrainerServiceItemLink]](<span class="apiarg">index</span>) - Returns an item link for a trainer service.
: [[API GetTrainerServiceLevelReq|GetTrainerServiceLevelReq]](<span class="apiarg">index</span>) - Get the required level to learn the skill.
+
: [[API GetTrainerServiceLevelReq|GetTrainerServiceLevelReq]](<span class="apiarg">index</span>) - Returns the required level to learn a skill from the trainer.
 
: [[API GetTrainerServiceNumAbilityReq|GetTrainerServiceNumAbilityReq]]() - Get the maximum number of requirements that [[API GetTrainerServiceAbilityReq|GetTrainerServiceAbilityReq]] has.
 
: [[API GetTrainerServiceNumAbilityReq|GetTrainerServiceNumAbilityReq]]() - Get the maximum number of requirements that [[API GetTrainerServiceAbilityReq|GetTrainerServiceAbilityReq]] has.
 
: [[API GetTrainerServiceSkillLine|GetTrainerServiceSkillLine]](<span class="apiarg">index</span>)
 
: [[API GetTrainerServiceSkillLine|GetTrainerServiceSkillLine]](<span class="apiarg">index</span>)
: [[API GetTrainerServiceSkillReq|GetTrainerServiceSkillReq]](<span class="apiarg">index</span>) - Returns a String and Variable for the requirements of a specific trainer service.
+
: [[API GetTrainerServiceSkillReq|GetTrainerServiceSkillReq]](<span class="apiarg">index</span>) - Returns the name of the required skill and the amount needed in that skill.
 
: [[API GetTrainerServiceStepIndex|GetTrainerServiceStepIndex]]()
 
: [[API GetTrainerServiceStepIndex|GetTrainerServiceStepIndex]]()
 
: [[API GetTrainerServiceTypeFilter|GetTrainerServiceTypeFilter]](<span class="apiarg">filter</span>) - Returns the status of a skill filter in the trainer window.
 
: [[API GetTrainerServiceTypeFilter|GetTrainerServiceTypeFilter]](<span class="apiarg">filter</span>) - Returns the status of a skill filter in the trainer window.
 
: [[API GetTrainerTradeskillRankValues|GetTrainerTradeskillRankValues]]()
 
: [[API GetTrainerTradeskillRankValues|GetTrainerTradeskillRankValues]]()
: [[API IsTradeskillTrainer|IsTradeskillTrainer]]() - Returns 1 if trainer is for a tradeskill.
+
: [[API IsTradeskillTrainer|IsTradeskillTrainer]]() - True if the training window is used for a profession trainer.
 
: [[API OpenTrainer|OpenTrainer]]()
 
: [[API OpenTrainer|OpenTrainer]]()
 
: [[API SelectTrainerService|SelectTrainerService]]()
 
: [[API SelectTrainerService|SelectTrainerService]]()
 
: [[API SetTrainerServiceTypeFilter|SetTrainerServiceTypeFilter]](<span class="apiarg">filter, state</span>) - Sets the status of a skill filter in the trainer window.
 
: [[API SetTrainerServiceTypeFilter|SetTrainerServiceTypeFilter]](<span class="apiarg">filter, state</span>) - Sets the status of a skill filter in the trainer window.
   
=== Pet Battles ===
+
===Pet Battles===
 
The [[Pet Battle System]] was added in [[Patch 5.0.4]]. See also [[#Pet Journal|Pet Journal]] functions.
 
The [[Pet Battle System]] was added in [[Patch 5.0.4]]. See also [[#Pet Journal|Pet Journal]] functions.
 
: [[API C_PetBattles.AcceptPVPDuel|C_PetBattles.AcceptPVPDuel]]()
 
: [[API C_PetBattles.AcceptPVPDuel|C_PetBattles.AcceptPVPDuel]]()
Line 3,173: Line 3,209:
 
: [[API C_PetBattles.SetPendingReportTargetFromUnit|C_PetBattles.SetPendingReportTargetFromUnit]](<span class="apiarg">unit</span>)
 
: [[API C_PetBattles.SetPendingReportTargetFromUnit|C_PetBattles.SetPendingReportTargetFromUnit]](<span class="apiarg">unit</span>)
 
: [[API C_PetBattles.ShouldShowPetSelect|C_PetBattles.ShouldShowPetSelect]]()
 
: [[API C_PetBattles.ShouldShowPetSelect|C_PetBattles.ShouldShowPetSelect]]()
: <small>HW</small> [[API C_PetBattles.SkipTurn|C_PetBattles.SkipTurn]]()
+
: <small>''HW''</small> [[API C_PetBattles.SkipTurn|C_PetBattles.SkipTurn]]()
 
: [[API C_PetBattles.StartPVPDuel|C_PetBattles.StartPVPDuel]]()
 
: [[API C_PetBattles.StartPVPDuel|C_PetBattles.StartPVPDuel]]()
 
: [[API C_PetBattles.StartPVPMatchmaking|C_PetBattles.StartPVPMatchmaking]]()
 
: [[API C_PetBattles.StartPVPMatchmaking|C_PetBattles.StartPVPMatchmaking]]()
 
: [[API C_PetBattles.StopPVPMatchmaking|C_PetBattles.StopPVPMatchmaking]]()
 
: [[API C_PetBattles.StopPVPMatchmaking|C_PetBattles.StopPVPMatchmaking]]()
: <small>HW</small> [[API C_PetBattles.UseAbility|C_PetBattles.UseAbility]](<span class="apiarg">actionIndex</span>)
+
: <small>''HW''</small> [[API C_PetBattles.UseAbility|C_PetBattles.UseAbility]](<span class="apiarg">actionIndex</span>)
: <small>HW</small> [[API C_PetBattles.UseTrap|C_PetBattles.UseTrap]]()
+
: <small>''HW''</small> [[API C_PetBattles.UseTrap|C_PetBattles.UseTrap]]()
 
: [[API CanTrackBattlePets|CanTrackBattlePets]]() - Returns whether the player can track battle pets.
 
: [[API CanTrackBattlePets|CanTrackBattlePets]]() - Returns whether the player can track battle pets.
 
: [[API IsTrackingBattlePets|IsTrackingBattlePets]]() - Returns whether the player is currently tracking battle pets.
 
: [[API IsTrackingBattlePets|IsTrackingBattlePets]]() - Returns whether the player is currently tracking battle pets.
Line 3,189: Line 3,225:
 
: [[API UnitIsWildBattlePet|UnitIsWildBattlePet]](<span class="apiarg">unit</span>)
 
: [[API UnitIsWildBattlePet|UnitIsWildBattlePet]](<span class="apiarg">unit</span>)
   
=== Players ===
+
===Players===
 
: [[API C_PlayerInfo.GetAlternateFormInfo|C_PlayerInfo.GetAlternateFormInfo]]() : <span class="apiret">hasAlternateForm, inAlternateForm</span>
 
: [[API C_PlayerInfo.GetAlternateFormInfo|C_PlayerInfo.GetAlternateFormInfo]]() : <span class="apiret">hasAlternateForm, inAlternateForm</span>
 
: [[API C_PlayerInfo.GetClass|C_PlayerInfo.GetClass]](<span class="apiarg">playerLocation</span>) : <span class="apiret">className, classFilename, classID</span> - Returns the class of a player.
 
: [[API C_PlayerInfo.GetClass|C_PlayerInfo.GetClass]](<span class="apiarg">playerLocation</span>) : <span class="apiret">className, classFilename, classID</span> - Returns the class of a player.
Line 3,195: Line 3,231:
 
: [[API C_PlayerInfo.GetRace|C_PlayerInfo.GetRace]](<span class="apiarg">playerLocation</span>) : <span class="apiret">raceID</span> - Returns the race of a player.
 
: [[API C_PlayerInfo.GetRace|C_PlayerInfo.GetRace]](<span class="apiarg">playerLocation</span>) : <span class="apiret">raceID</span> - Returns the race of a player.
 
: [[API C_PlayerInfo.GetSex|C_PlayerInfo.GetSex]](<span class="apiarg">playerLocation</span>) : <span class="apiret">sex</span> - Returns the sex of a player.
 
: [[API C_PlayerInfo.GetSex|C_PlayerInfo.GetSex]](<span class="apiarg">playerLocation</span>) : <span class="apiret">sex</span> - Returns the sex of a player.
: [[API C_PlayerInfo.GUIDIsPlayer|C_PlayerInfo.GUIDIsPlayer]](<span class="apiarg">guid</span>) : <span class="apiret">isPlayer</span> - Returns true if the guid belongs to a player.
+
: [[API C_PlayerInfo.GUIDIsPlayer|C_PlayerInfo.GUIDIsPlayer]](<span class="apiarg">guid</span>) : <span class="apiret">isPlayer</span> - True if the GUID belongs to a player.
: [[API C_PlayerInfo.IsConnected|C_PlayerInfo.IsConnected]](<span class="apiarg">[playerLocation]</span>) : <span class="apiret">isConnected</span> - Returns true if a player is connected.
+
: [[API C_PlayerInfo.IsConnected|C_PlayerInfo.IsConnected]](<span class="apiarg">[playerLocation]</span>) : <span class="apiret">isConnected</span> - True if the player is connected.
: [[API C_PlayerInfo.UnitIsSameServer|C_PlayerInfo.UnitIsSameServer]](<span class="apiarg">playerLocation</span>) : <span class="apiret">unitIsSameServer</span> - Returns true if another player is from your own or connected realm.
+
: [[API C_PlayerInfo.UnitIsSameServer|C_PlayerInfo.UnitIsSameServer]](<span class="apiarg">playerLocation</span>) : <span class="apiret">unitIsSameServer</span> - True if a player is from the same or [[Connected Realm|connected]] realm.
 
: [[API Ambiguate|Ambiguate]](<span class="apiarg">fullName, context</span>) - Returns a version of a character-realm string suitable for use in a given context.
 
: [[API Ambiguate|Ambiguate]](<span class="apiarg">fullName, context</span>) - Returns a version of a character-realm string suitable for use in a given context.
 
: [[API GetAutoCompleteResults|GetAutoCompleteResults]](<span class="apiarg">text, include, exclude, maxResults [, cursorPosition]</span>) - Returns possible player names matching a given prefix string and specified requirements.
 
: [[API GetAutoCompleteResults|GetAutoCompleteResults]](<span class="apiarg">text, include, exclude, maxResults [, cursorPosition]</span>) - Returns possible player names matching a given prefix string and specified requirements.
: [[API GetPlayerInfoByGUID|GetPlayerInfoByGUID]](<span class="apiarg">guid</span>) - Returns race, class, sex about the guid (client must have seen the guid)
+
: [[API GetPlayerInfoByGUID|GetPlayerInfoByGUID]](<span class="apiarg">guid</span>) - Returns character info for another player from their GUID.
 
: [[API IsRecognizedName|IsRecognizedName]](<span class="apiarg">text, includeBitField, excludeBitField</span>) - Returns true if a given character name is recognized by the client.
 
: [[API IsRecognizedName|IsRecognizedName]](<span class="apiarg">text, includeBitField, excludeBitField</span>) - Returns true if a given character name is recognized by the client.
   
==== Inspection ====
+
====Inspection====
: [[API CanInspect|CanInspect]](<span class="apiarg">unit [, showError]</span>) - Returns whether you can inspect the specified unit.
+
: [[API CanInspect|CanInspect]](<span class="apiarg">unit [, showError]</span>) - True if the player can inspect the unit.
: [[API CheckInteractDistance|CheckInteractDistance]](<span class="apiarg">unit, interaction</span>) - Returns whether you're in range to perform various interactions with the specified unit.
+
: [[API CheckInteractDistance|CheckInteractDistance]](<span class="apiarg">unit, interaction</span>) - True if the player is in range to perform a specific interaction with the unit.
 
: [[API ClearInspectPlayer|ClearInspectPlayer]]() - Reset inspect data once finished with it.
 
: [[API ClearInspectPlayer|ClearInspectPlayer]]() - Reset inspect data once finished with it.
 
: [[API GetInspectArenaData|GetInspectArenaData]](<span class="apiarg">bracketIndex</span>)
 
: [[API GetInspectArenaData|GetInspectArenaData]](<span class="apiarg">bracketIndex</span>)
 
: [[API GetInspectGuildInfo|GetInspectGuildInfo]](<span class="apiarg">unit</span>)
 
: [[API GetInspectGuildInfo|GetInspectGuildInfo]](<span class="apiarg">unit</span>)
: [[API GetInspectHonorData|GetInspectHonorData]]() - Returns honor information about the inspected player.
+
: [[API GetInspectHonorData|GetInspectHonorData]]() - Returns honor info for the inspected player unit.
 
: [[API GetInspectRatedBGData|GetInspectRatedBGData]]()
 
: [[API GetInspectRatedBGData|GetInspectRatedBGData]]()
: [[API GetInspectSpecialization|GetInspectSpecialization]](<span class="apiarg">unit</span>) - Returns a number representing the current active specialization of a given unit.
+
: [[API GetInspectSpecialization|GetInspectSpecialization]](<span class="apiarg">unit</span>) - Returns the specialization for the inspected player unit.
 
: [[API GetInspectTalent|GetInspectTalent]]()
 
: [[API GetInspectTalent|GetInspectTalent]]()
: [[API NotifyInspect|NotifyInspect]](<span class="apiarg">unit</span>) - Requests information about a unit's inventory and talents from the server.
+
: [[API NotifyInspect|NotifyInspect]](<span class="apiarg">unit</span>) - Requests another player's inventory and talent info before inspecting.
: <small>UI</small> [[API InspectUnit|InspectUnit]](<span class="apiarg">unit</span>) - Instructs FrameXML to inspect a particular unit (query server; show UI).
+
: <small>''UI''</small> [[API InspectUnit|InspectUnit]](<span class="apiarg">unit</span>) - Instructs FrameXML to inspect a particular unit (query server; show UI).
   
==== Trading ====
+
====Trading====
 
Relates to [[Trade|Trading]].
 
Relates to [[Trade|Trading]].
: <small>HW</small> [[API AcceptTrade|AcceptTrade]]() - A pending trade will be accepted.
+
: <small>''HW''</small> [[API AcceptTrade|AcceptTrade]]() - Accepts the current trade offer.
: [[API AddTradeMoney|AddTradeMoney]]() - Adds the money dropped into the player's trade frame.
+
: [[API AddTradeMoney|AddTradeMoney]]() - Adds money currently held by the cursor to the trade offer.
 
: [[API BeginTrade|BeginTrade]]()
 
: [[API BeginTrade|BeginTrade]]()
: [[API CancelTrade|CancelTrade]]() - Declines the offer to trade with the other player.
+
: [[API CancelTrade|CancelTrade]]() - Declines the current trade offer.
 
: [[API CancelTradeAccept|CancelTradeAccept]]() - Cancels the trade attempt which required an accept.
 
: [[API CancelTradeAccept|CancelTradeAccept]]() - Cancels the trade attempt which required an accept.
 
: [[API ClickTargetTradeButton|ClickTargetTradeButton]](<span class="apiarg">index</span>)
 
: [[API ClickTargetTradeButton|ClickTargetTradeButton]](<span class="apiarg">index</span>)
 
: [[API ClickTradeButton|ClickTradeButton]](<span class="apiarg">index</span>) - Equivalent of a mouseclick on the trade window buttons [1-7].
 
: [[API ClickTradeButton|ClickTradeButton]](<span class="apiarg">index</span>) - Equivalent of a mouseclick on the trade window buttons [1-7].
: [[API CloseTrade|CloseTrade]]() - Closes the trade.
+
: [[API CloseTrade|CloseTrade]]() - Closes the trade window.
 
: [[API GetPlayerTradeMoney|GetPlayerTradeMoney]]() - Returns the amount of money the player has in the trade window.
 
: [[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 GetTargetTradeMoney|GetTargetTradeMoney]]() - Returns the amount of money in the trade window for the other player.
 
: [[API GetTradePlayerItemInfo|GetTradePlayerItemInfo]](<span class="apiarg">id</span>) - Returns information about a trade item.
 
: [[API GetTradePlayerItemInfo|GetTradePlayerItemInfo]](<span class="apiarg">id</span>) - Returns information about a trade item.
: [[API GetTradePlayerItemLink|GetTradePlayerItemLink]](<span class="apiarg">id</span>) - Returns an [[itemLink]] for the given item in your side of the trade window (if open)
+
: [[API GetTradePlayerItemLink|GetTradePlayerItemLink]](<span class="apiarg">id</span>) - Returns the item link for an item in the trade window.
: [[API GetTradeTargetItemInfo|GetTradeTargetItemInfo]](<span class="apiarg">id</span>) - Returns information about a trade item.
+
: [[API GetTradeTargetItemInfo|GetTradeTargetItemInfo]](<span class="apiarg">id</span>) - Returns item info for the other player in the trade window.
: [[API GetTradeTargetItemLink|GetTradeTargetItemLink]](<span class="apiarg">id</span>) - Returns an [[itemLink]] for the given item in the other player's side of the trade window (if open)
+
: [[API GetTradeTargetItemLink|GetTradeTargetItemLink]](<span class="apiarg">id</span>) - Returns the item link for an item from the other player in the trade window.
: [[API InitiateTrade|InitiateTrade]](<span class="apiarg">UnitId</span>) - Asks the specified unit to trade.
+
: [[API InitiateTrade|InitiateTrade]](<span class="apiarg">UnitId</span>) - Opens a trade with the specified unit.
 
: [[API SetTradeMoney|SetTradeMoney]](<span class="apiarg">copper</span>) - Sets the amount of money offered as part of the player's trade offer.
 
: [[API SetTradeMoney|SetTradeMoney]](<span class="apiarg">copper</span>) - Sets the amount of money offered as part of the player's trade offer.
   
==== Summoning ====
+
====Summoning====
 
: [[API C_IncomingSummon.HasIncomingSummon|C_IncomingSummon.HasIncomingSummon]](<span class="apiarg">unit</span>) : <span class="apiret">summon</span> - Returns whether a group member has an incoming summon.
 
: [[API C_IncomingSummon.HasIncomingSummon|C_IncomingSummon.HasIncomingSummon]](<span class="apiarg">unit</span>) : <span class="apiret">summon</span> - Returns whether a group member has an incoming summon.
 
: [[API C_IncomingSummon.IncomingSummonStatus|C_IncomingSummon.IncomingSummonStatus]](<span class="apiarg">unit</span>) : <span class="apiret">status</span> - Returns the status of an group member's incoming summon.
 
: [[API C_IncomingSummon.IncomingSummonStatus|C_IncomingSummon.IncomingSummonStatus]](<span class="apiarg">unit</span>) : <span class="apiret">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.CancelSummon|C_SummonInfo.CancelSummon]]() - Declines a summon request.
 
: [[API C_SummonInfo.ConfirmSummon|C_SummonInfo.ConfirmSummon]]() - Accepts a summon request.
 
: [[API C_SummonInfo.ConfirmSummon|C_SummonInfo.ConfirmSummon]]() - Accepts a summon request.
: [[API C_SummonInfo.GetSummonConfirmAreaName|C_SummonInfo.GetSummonConfirmAreaName]]() : <span class="apiret">areaName</span> - Returns the name of the area you're being summoned to.
+
: [[API C_SummonInfo.GetSummonConfirmAreaName|C_SummonInfo.GetSummonConfirmAreaName]]() : <span class="apiret">areaName</span> - Returns the zone where you will be summoned to.
 
: [[API C_SummonInfo.GetSummonConfirmSummoner|C_SummonInfo.GetSummonConfirmSummoner]]() : <span class="apiret">summoner</span> - Returns the name of the player summoning you.
 
: [[API C_SummonInfo.GetSummonConfirmSummoner|C_SummonInfo.GetSummonConfirmSummoner]]() : <span class="apiret">summoner</span> - Returns the name of the player summoning you.
: [[API C_SummonInfo.GetSummonConfirmTimeLeft|C_SummonInfo.GetSummonConfirmTimeLeft]]() : <span class="apiret">timeLeft</span> - Returns the amount of time left before the pending summon expires.
+
: [[API C_SummonInfo.GetSummonConfirmTimeLeft|C_SummonInfo.GetSummonConfirmTimeLeft]]() : <span class="apiret">timeLeft</span> - Returns the time left in seconds for accepting a summon.
 
: [[API C_SummonInfo.GetSummonReason|C_SummonInfo.GetSummonReason]]() : <span class="apiret">summonReason</span>
 
: [[API C_SummonInfo.GetSummonReason|C_SummonInfo.GetSummonReason]]() : <span class="apiret">summonReason</span>
 
: [[API C_SummonInfo.IsSummonSkippingStartExperience|C_SummonInfo.IsSummonSkippingStartExperience]]() : <span class="apiret">isSummonSkippingStartExperience</span>
 
: [[API C_SummonInfo.IsSummonSkippingStartExperience|C_SummonInfo.IsSummonSkippingStartExperience]]() : <span class="apiret">isSummonSkippingStartExperience</span>
 
: [[API PlayerCanTeleport|PlayerCanTeleport]]()
 
: [[API PlayerCanTeleport|PlayerCanTeleport]]()
   
==== Death ====
+
====Death====
 
: [[API C_DeathInfo.GetCorpseMapPosition|C_DeathInfo.GetCorpseMapPosition]](<span class="apiarg">uiMapID</span>) : <span class="apiret">position</span> - Returns the location of the player's corpse on the map.
 
: [[API C_DeathInfo.GetCorpseMapPosition|C_DeathInfo.GetCorpseMapPosition]](<span class="apiarg">uiMapID</span>) : <span class="apiret">position</span> - Returns the location of the player's corpse on the map.
: [[API C_DeathInfo.GetDeathReleasePosition|C_DeathInfo.GetDeathReleasePosition]](<span class="apiarg">uiMapID</span>) : <span class="apiret">position</span> - Returns the death release location.
+
: [[API C_DeathInfo.GetDeathReleasePosition|C_DeathInfo.GetDeathReleasePosition]](<span class="apiarg">uiMapID</span>) : <span class="apiret">position</span> - When the player is dead and hasn't released spirit, returns the location of the graveyard they will release to.
 
: [[API C_DeathInfo.GetGraveyardsForMap|C_DeathInfo.GetGraveyardsForMap]](<span class="apiarg">uiMapID</span>) : <span class="apiret">graveyards</span> - Returns graveyard info and location for a map.
 
: [[API C_DeathInfo.GetGraveyardsForMap|C_DeathInfo.GetGraveyardsForMap]](<span class="apiarg">uiMapID</span>) : <span class="apiret">graveyards</span> - Returns graveyard info and location for a map.
 
: [[API C_DeathInfo.GetSelfResurrectOptions|C_DeathInfo.GetSelfResurrectOptions]]() : <span class="apiret">options</span> - Returns self resurrect options for your character, including from soulstones.
 
: [[API C_DeathInfo.GetSelfResurrectOptions|C_DeathInfo.GetSelfResurrectOptions]]() : <span class="apiret">options</span> - Returns self resurrect options for your character, including from soulstones.
 
: [[API C_DeathInfo.UseSelfResurrectOption|C_DeathInfo.UseSelfResurrectOption]](<span class="apiarg">optionType, id</span>) - Uses a soulstone or similar means of self resurrection.
 
: [[API C_DeathInfo.UseSelfResurrectOption|C_DeathInfo.UseSelfResurrectOption]](<span class="apiarg">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 AcceptResurrect|AcceptResurrect]]() - Accepts a resurrection offer.
: [[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 AcceptXPLoss|AcceptXPLoss]]() - Confirms the [[resurrection sickness]] and durability loss penalty on being resurrected by a spirit healer.
 
: [[API CannotBeResurrected|CannotBeResurrected]]()
 
: [[API CannotBeResurrected|CannotBeResurrected]]()
 
: [[API DeathRecap_GetEvents|DeathRecap_GetEvents]]()
 
: [[API DeathRecap_GetEvents|DeathRecap_GetEvents]]()
 
: [[API DeathRecap_HasEvents|DeathRecap_HasEvents]]()
 
: [[API DeathRecap_HasEvents|DeathRecap_HasEvents]]()
: [[API DeclineResurrect|DeclineResurrect]]() - Decline the request from another player to resurrect him/herself.
+
: [[API DeclineResurrect|DeclineResurrect]]() - Declines a resurrection offer.
 
: [[API GetCemeteryPreference|GetCemeteryPreference]]()
 
: [[API GetCemeteryPreference|GetCemeteryPreference]]()
 
: [[API GetCorpseRecoveryDelay|GetCorpseRecoveryDelay]]() - Time left before a player can accept a resurrection.
 
: [[API GetCorpseRecoveryDelay|GetCorpseRecoveryDelay]]() - Time left before a player can accept a resurrection.
Line 3,269: Line 3,305:
 
: [[API IsEncounterSuppressingRelease|IsEncounterSuppressingRelease]]()
 
: [[API IsEncounterSuppressingRelease|IsEncounterSuppressingRelease]]()
 
: [[API NotWhileDeadError|NotWhileDeadError]]() - Generates an error message saying you cannot do that while dead.
 
: [[API NotWhileDeadError|NotWhileDeadError]]() - Generates an error message saying you cannot do that while dead.
: <small>PROTECTED</small> [[API PortGraveyard|PortGraveyard]]()
+
: <small>''PROTECTED''</small> [[API PortGraveyard|PortGraveyard]]()
: [[API RepopMe|RepopMe]]() - The "Release Spirit" button. Sends you to the graveyard when dead.
+
: [[API RepopMe|RepopMe]]() - Releases your ghost to the graveyard when dead.
 
: [[API ResurrectGetOfferer|ResurrectGetOfferer]]() - Returns the name of the person offering to resurrect you.
 
: [[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 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 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 RetrieveCorpse|RetrieveCorpse]]() - Resurrects when the player is standing near its corpse.
 
: [[API SetCemeteryPreference|SetCemeteryPreference]](<span class="apiarg">cemeteryID</span>)
 
: [[API SetCemeteryPreference|SetCemeteryPreference]](<span class="apiarg">cemeteryID</span>)
 
: [[API TimeoutResurrect|TimeoutResurrect]]()
 
: [[API TimeoutResurrect|TimeoutResurrect]]()
   
=== Professions ===
+
===Professions===
 
Relates to [[Profession]]s.
 
Relates to [[Profession]]s.
 
: [[API C_TradeSkillUI.AnyRecipeCategoriesFiltered|C_TradeSkillUI.AnyRecipeCategoriesFiltered]]()
 
: [[API C_TradeSkillUI.AnyRecipeCategoriesFiltered|C_TradeSkillUI.AnyRecipeCategoriesFiltered]]()
Line 3,294: Line 3,330:
 
: [[API C_TradeSkillUI.GetAllFilterableInventorySlots|C_TradeSkillUI.GetAllFilterableInventorySlots]]()
 
: [[API C_TradeSkillUI.GetAllFilterableInventorySlots|C_TradeSkillUI.GetAllFilterableInventorySlots]]()
 
: [[API C_TradeSkillUI.GetAllProfessionTradeSkillLines|C_TradeSkillUI.GetAllProfessionTradeSkillLines]]() : <span class="apiret">skillLineID</span>
 
: [[API C_TradeSkillUI.GetAllProfessionTradeSkillLines|C_TradeSkillUI.GetAllProfessionTradeSkillLines]]() : <span class="apiret">skillLineID</span>
: [[API C_TradeSkillUI.GetAllRecipeIDs|C_TradeSkillUI.GetAllRecipeIDs]]() - Returns a table containing all the recipe IDs for the current trade skill.
+
: [[API C_TradeSkillUI.GetAllRecipeIDs|C_TradeSkillUI.GetAllRecipeIDs]]() - Returns all recipes for the current profession.
 
: [[API C_TradeSkillUI.GetCategories|C_TradeSkillUI.GetCategories]]()
 
: [[API C_TradeSkillUI.GetCategories|C_TradeSkillUI.GetCategories]]()
 
: [[API C_TradeSkillUI.GetCategoryInfo|C_TradeSkillUI.GetCategoryInfo]](<span class="apiarg">categoryID [, returnTable]</span>)
 
: [[API C_TradeSkillUI.GetCategoryInfo|C_TradeSkillUI.GetCategoryInfo]](<span class="apiarg">categoryID [, returnTable]</span>)
Line 3,305: Line 3,341:
 
: [[API C_TradeSkillUI.GetOnlyShowUnlearnedRecipes|C_TradeSkillUI.GetOnlyShowUnlearnedRecipes]]()
 
: [[API C_TradeSkillUI.GetOnlyShowUnlearnedRecipes|C_TradeSkillUI.GetOnlyShowUnlearnedRecipes]]()
 
: [[API C_TradeSkillUI.GetOptionalReagentBonusText|C_TradeSkillUI.GetOptionalReagentBonusText]](<span class="apiarg">recipeSpellID, optionalReagentIndex, optionalReagents</span>) : <span class="apiret">bonusText</span>
 
: [[API C_TradeSkillUI.GetOptionalReagentBonusText|C_TradeSkillUI.GetOptionalReagentBonusText]](<span class="apiarg">recipeSpellID, optionalReagentIndex, optionalReagents</span>) : <span class="apiret">bonusText</span>
: [[API C_TradeSkillUI.GetOptionalReagentInfo|C_TradeSkillUI.GetOptionalReagentInfo]](<span class="apiarg">recipeSpellID</span>) : <span class="apiret">slots</span>
+
: [[API C_TradeSkillUI.GetOptionalReagentInfo|C_TradeSkillUI.GetOptionalReagentInfo]](<span class="apiarg">recipeSpellID [, recipeLevel]</span>) : <span class="apiret">slots</span>
 
: [[API C_TradeSkillUI.GetPendingObliterateItemID|C_TradeSkillUI.GetPendingObliterateItemID]]()
 
: [[API C_TradeSkillUI.GetPendingObliterateItemID|C_TradeSkillUI.GetPendingObliterateItemID]]()
 
: [[API C_TradeSkillUI.GetPendingObliterateItemLink|C_TradeSkillUI.GetPendingObliterateItemLink]]()
 
: [[API C_TradeSkillUI.GetPendingObliterateItemLink|C_TradeSkillUI.GetPendingObliterateItemLink]]()
 
: [[API C_TradeSkillUI.GetRecipeCooldown|C_TradeSkillUI.GetRecipeCooldown]](<span class="apiarg">recipeID</span>) - Returns the number of seconds left for a skill to cooldown.
 
: [[API C_TradeSkillUI.GetRecipeCooldown|C_TradeSkillUI.GetRecipeCooldown]](<span class="apiarg">recipeID</span>) - Returns the number of seconds left for a skill to cooldown.
: [[API C_TradeSkillUI.GetRecipeDescription|C_TradeSkillUI.GetRecipeDescription]](<span class="apiarg">recipeID</span>) - Returns the description text of the indicated trade skill.
+
: [[API C_TradeSkillUI.GetRecipeDescription|C_TradeSkillUI.GetRecipeDescription]](<span class="apiarg">recipeID</span>) - Returns the description for a recipe.
 
: [[API C_TradeSkillUI.GetRecipeInfo|C_TradeSkillUI.GetRecipeInfo]](<span class="apiarg">recipeSpellID [, recipeLevel]</span>) : <span class="apiret">recipeInfo</span> - Returns information for a recipe.
 
: [[API C_TradeSkillUI.GetRecipeInfo|C_TradeSkillUI.GetRecipeInfo]](<span class="apiarg">recipeSpellID [, recipeLevel]</span>) : <span class="apiret">recipeInfo</span> - Returns information for a recipe.
 
: [[API C_TradeSkillUI.GetRecipeItemLevelFilter|C_TradeSkillUI.GetRecipeItemLevelFilter]]()
 
: [[API C_TradeSkillUI.GetRecipeItemLevelFilter|C_TradeSkillUI.GetRecipeItemLevelFilter]]()
: [[API C_TradeSkillUI.GetRecipeItemLink|C_TradeSkillUI.GetRecipeItemLink]](<span class="apiarg">recipeID</span>) - Returns the [[itemLink]] for a trade skill item.
+
: [[API C_TradeSkillUI.GetRecipeItemLink|C_TradeSkillUI.GetRecipeItemLink]](<span class="apiarg">recipeID</span>) - Returns the result item link for a recipe.
 
: [[API C_TradeSkillUI.GetRecipeItemNameFilter|C_TradeSkillUI.GetRecipeItemNameFilter]]()
 
: [[API C_TradeSkillUI.GetRecipeItemNameFilter|C_TradeSkillUI.GetRecipeItemNameFilter]]()
 
: [[API C_TradeSkillUI.GetRecipeLink|C_TradeSkillUI.GetRecipeLink]](<span class="apiarg">recipeID</span>)
 
: [[API C_TradeSkillUI.GetRecipeLink|C_TradeSkillUI.GetRecipeLink]](<span class="apiarg">recipeID</span>)
: [[API C_TradeSkillUI.GetRecipeNumItemsProduced|C_TradeSkillUI.GetRecipeNumItemsProduced]](<span class="apiarg">recipeID</span>) - Gets the number of items made in a single use of a skill.
+
: [[API C_TradeSkillUI.GetRecipeNumItemsProduced|C_TradeSkillUI.GetRecipeNumItemsProduced]](<span class="apiarg">recipeID</span>) - Returns the number of items produced for a recipe.
 
: [[API C_TradeSkillUI.GetRecipeNumReagents|C_TradeSkillUI.GetRecipeNumReagents]](<span class="apiarg">recipeSpellID [, recipeLevel]</span>) : <span class="apiret">numReagents</span> - Returns the number of distinct reagents needed for the specified recipe.
 
: [[API C_TradeSkillUI.GetRecipeNumReagents|C_TradeSkillUI.GetRecipeNumReagents]](<span class="apiarg">recipeSpellID [, recipeLevel]</span>) : <span class="apiret">numReagents</span> - Returns the number of distinct reagents needed for the specified recipe.
 
: [[API C_TradeSkillUI.GetRecipeReagentInfo|C_TradeSkillUI.GetRecipeReagentInfo]](<span class="apiarg">recipeSpellID, reagentIndex [, recipeLevel]</span>) : <span class="apiret">reagentName, reagentFileID, reagentCount, playerReagentCount</span> - Returns the information for a reagent needed by a recipe.
 
: [[API C_TradeSkillUI.GetRecipeReagentInfo|C_TradeSkillUI.GetRecipeReagentInfo]](<span class="apiarg">recipeSpellID, reagentIndex [, recipeLevel]</span>) : <span class="apiret">reagentName, reagentFileID, reagentCount, playerReagentCount</span> - Returns the information for a reagent needed by a recipe.
Line 3,321: Line 3,357:
 
: [[API C_TradeSkillUI.GetRecipeRepeatCount|C_TradeSkillUI.GetRecipeRepeatCount]]() : <span class="apiret">recastTimes</span> - Returns the number of times the current item is being crafted.
 
: [[API C_TradeSkillUI.GetRecipeRepeatCount|C_TradeSkillUI.GetRecipeRepeatCount]]() : <span class="apiret">recastTimes</span> - Returns the number of times the current item is being crafted.
 
: [[API C_TradeSkillUI.GetRecipeSourceText|C_TradeSkillUI.GetRecipeSourceText]](<span class="apiarg">recipeID</span>)
 
: [[API C_TradeSkillUI.GetRecipeSourceText|C_TradeSkillUI.GetRecipeSourceText]](<span class="apiarg">recipeID</span>)
: [[API C_TradeSkillUI.GetRecipeTools|C_TradeSkillUI.GetRecipeTools]](<span class="apiarg">recipeID</span>) - Returns information about the tools needed for a tradeskill.
+
: [[API C_TradeSkillUI.GetRecipeTools|C_TradeSkillUI.GetRecipeTools]](<span class="apiarg">recipeID</span>) - Returns the required tools for a recipe.
 
: [[API C_TradeSkillUI.GetSubCategories|C_TradeSkillUI.GetSubCategories]](<span class="apiarg">categoryID</span>)
 
: [[API C_TradeSkillUI.GetSubCategories|C_TradeSkillUI.GetSubCategories]](<span class="apiarg">categoryID</span>)
 
: [[API C_TradeSkillUI.GetTradeSkillDisplayName|C_TradeSkillUI.GetTradeSkillDisplayName]](<span class="apiarg">skillLineID</span>) : <span class="apiret">professionDisplayName</span>
 
: [[API C_TradeSkillUI.GetTradeSkillDisplayName|C_TradeSkillUI.GetTradeSkillDisplayName]](<span class="apiarg">skillLineID</span>) : <span class="apiret">professionDisplayName</span>
: [[API C_TradeSkillUI.GetTradeSkillLine|C_TradeSkillUI.GetTradeSkillLine]]() : <span class="apiret">skillLineID, skillLineDisplayName, skillLineRank, skillLineMaxRank, ...</span> - Returns information about the selected skill line.
+
: [[API C_TradeSkillUI.GetTradeSkillLine|C_TradeSkillUI.GetTradeSkillLine]]() : <span class="apiret">skillLineID, skillLineDisplayName, skillLineRank, skillLineMaxRank, ...</span> - Returns the current profession displayed in the trade skill window.
 
: [[API C_TradeSkillUI.GetTradeSkillLineForRecipe|C_TradeSkillUI.GetTradeSkillLineForRecipe]](<span class="apiarg">recipeID</span>)
 
: [[API C_TradeSkillUI.GetTradeSkillLineForRecipe|C_TradeSkillUI.GetTradeSkillLineForRecipe]](<span class="apiarg">recipeID</span>)
 
: [[API C_TradeSkillUI.GetTradeSkillLineInfoByID|C_TradeSkillUI.GetTradeSkillLineInfoByID]](<span class="apiarg">skillLineID</span>) : <span class="apiret">skillLineDisplayName, skillLineRank, skillLineMaxRank, skillLineModifier, ...</span>
 
: [[API C_TradeSkillUI.GetTradeSkillLineInfoByID|C_TradeSkillUI.GetTradeSkillLineInfoByID]](<span class="apiarg">skillLineID</span>) : <span class="apiret">skillLineDisplayName, skillLineRank, skillLineMaxRank, skillLineModifier, ...</span>
: [[API C_TradeSkillUI.GetTradeSkillListLink|C_TradeSkillUI.GetTradeSkillListLink]]() - Returns the [[TradeSkillLink]] for a trade skill.
+
: [[API C_TradeSkillUI.GetTradeSkillListLink|C_TradeSkillUI.GetTradeSkillListLink]]() - Returns a link for the currently displayed profession.
 
: [[API C_TradeSkillUI.GetTradeSkillTexture|C_TradeSkillUI.GetTradeSkillTexture]](<span class="apiarg">tradeSkillID</span>)
 
: [[API C_TradeSkillUI.GetTradeSkillTexture|C_TradeSkillUI.GetTradeSkillTexture]](<span class="apiarg">tradeSkillID</span>)
 
: [[API C_TradeSkillUI.IsAnyRecipeFromSource|C_TradeSkillUI.IsAnyRecipeFromSource]](<span class="apiarg">sourceType</span>)
 
: [[API C_TradeSkillUI.IsAnyRecipeFromSource|C_TradeSkillUI.IsAnyRecipeFromSource]](<span class="apiarg">sourceType</span>)
Line 3,333: Line 3,369:
 
: [[API C_TradeSkillUI.IsEmptySkillLineCategory|C_TradeSkillUI.IsEmptySkillLineCategory]](<span class="apiarg">categoryID</span>) : <span class="apiret">effectivelyKnown</span>
 
: [[API C_TradeSkillUI.IsEmptySkillLineCategory|C_TradeSkillUI.IsEmptySkillLineCategory]](<span class="apiarg">categoryID</span>) : <span class="apiret">effectivelyKnown</span>
 
: [[API C_TradeSkillUI.IsInventorySlotFiltered|C_TradeSkillUI.IsInventorySlotFiltered]](<span class="apiarg">index</span>)
 
: [[API C_TradeSkillUI.IsInventorySlotFiltered|C_TradeSkillUI.IsInventorySlotFiltered]](<span class="apiarg">index</span>)
: [[API C_TradeSkillUI.IsNPCCrafting|C_TradeSkillUI.IsNPCCrafting]]() - Checks if the Trade Skill UI is open for crafting by an NPC.
+
: [[API C_TradeSkillUI.IsNPCCrafting|C_TradeSkillUI.IsNPCCrafting]]() - True if the trade skill window is displayed for an NPC.
 
: [[API C_TradeSkillUI.IsRecipeCategoryFiltered|C_TradeSkillUI.IsRecipeCategoryFiltered]](<span class="apiarg">categoryID [, subCategoryID]</span>)
 
: [[API C_TradeSkillUI.IsRecipeCategoryFiltered|C_TradeSkillUI.IsRecipeCategoryFiltered]](<span class="apiarg">categoryID [, subCategoryID]</span>)
 
: [[API C_TradeSkillUI.IsRecipeFavorite|C_TradeSkillUI.IsRecipeFavorite]](<span class="apiarg">recipeID</span>)
 
: [[API C_TradeSkillUI.IsRecipeFavorite|C_TradeSkillUI.IsRecipeFavorite]](<span class="apiarg">recipeID</span>)
Line 3,359: Line 3,395:
 
: [[API AbandonSkill|AbandonSkill]](<span class="apiarg">index</span>) - The player abandons a skill.
 
: [[API AbandonSkill|AbandonSkill]](<span class="apiarg">index</span>) - The player abandons a skill.
 
: [[API GetProfessionInfo|GetProfessionInfo]](<span class="apiarg">index</span>) - Gets details on a profession from its index including name, icon, and skill level.
 
: [[API GetProfessionInfo|GetProfessionInfo]](<span class="apiarg">index</span>) - Gets details on a profession from its index including name, icon, and skill level.
: [[API GetProfessions|GetProfessions]]() - Gives all of the current character's professions.
+
: [[API GetProfessions|GetProfessions]]() - Returns the spell tab indices of the character's current professions.
 
: [[API GetSpellRank|GetSpellRank]](<span class="apiarg">recipeID</span>) - Returns recipe rank.
 
: [[API GetSpellRank|GetSpellRank]](<span class="apiarg">recipeID</span>) - Returns recipe rank.
   
==== Archaeology ====
+
====Archaeology====
 
[[Archaeology]] was added in [[Patch 4.0.1]]
 
[[Archaeology]] was added in [[Patch 4.0.1]]
 
: [[API C_ResearchInfo.GetDigSitesForMap|C_ResearchInfo.GetDigSitesForMap]](<span class="apiarg">uiMapID</span>) : <span class="apiret">digSites</span> - Returns the dig sites on a map.
 
: [[API C_ResearchInfo.GetDigSitesForMap|C_ResearchInfo.GetDigSitesForMap]](<span class="apiarg">uiMapID</span>) : <span class="apiret">digSites</span> - Returns the dig sites on a map.
: [[API ArchaeologyMapUpdateAll|ArchaeologyMapUpdateAll]]() - Updates the digsites and returns the number of digsites in the current map-zone.
+
: [[API ArchaeologyMapUpdateAll|ArchaeologyMapUpdateAll]]() - Updates and returns the amount of [[digsite]]s in a zone.
 
: [[API ArchaeologyGetIconInfo|ArchaeologyGetIconInfo]](<span class="apiarg">index</span>)
 
: [[API ArchaeologyGetIconInfo|ArchaeologyGetIconInfo]](<span class="apiarg">index</span>)
 
: [[API ArcheologyGetVisibleBlobID|ArcheologyGetVisibleBlobID]](<span class="apiarg">index</span>) - Returns BlobID of a digsite in the current map-zone.
 
: [[API ArcheologyGetVisibleBlobID|ArcheologyGetVisibleBlobID]](<span class="apiarg">index</span>) - Returns BlobID of a digsite in the current map-zone.
 
: [[API CanItemBeSocketedToArtifact|CanItemBeSocketedToArtifact]](<span class="apiarg">itemID</span>) - Returns 1 if item could be added to the [[API SetSelectedArtifact|selected]] artifact.
 
: [[API CanItemBeSocketedToArtifact|CanItemBeSocketedToArtifact]](<span class="apiarg">itemID</span>) - Returns 1 if item could be added to the [[API SetSelectedArtifact|selected]] artifact.
: [[API CanScanResearchSite|CanScanResearchSite]]() - Returns whether the player is currently on a digsite.
+
: [[API CanScanResearchSite|CanScanResearchSite]]() - True if the character is on a [[digsite]].
 
: [[API CanSolveArtifact|CanSolveArtifact]]() - Returns true if artifact can be solved.
 
: [[API CanSolveArtifact|CanSolveArtifact]]() - Returns true if artifact can be solved.
 
: [[API CloseResearch|CloseResearch]]()
 
: [[API CloseResearch|CloseResearch]]()
: [[API GetActiveArtifactByRace|GetActiveArtifactByRace]](<span class="apiarg">raceIndex</span>) - Returns the information for the active artifact of raceIndex.
+
: [[API GetActiveArtifactByRace|GetActiveArtifactByRace]](<span class="apiarg">raceIndex</span>) - Returns the active Archaeology artifact for a race.
: [[API GetArchaeologyInfo|GetArchaeologyInfo]]() - Returns localized name of Archaeology skill.
+
: [[API GetArchaeologyInfo|GetArchaeologyInfo]]() - Returns the localized name for the Archaeology profession.
 
: [[API GetArchaeologyRaceInfo|GetArchaeologyRaceInfo]](<span class="apiarg">raceIndex</span>) - Returns the information for a specific race used in Archaeology.
 
: [[API GetArchaeologyRaceInfo|GetArchaeologyRaceInfo]](<span class="apiarg">raceIndex</span>) - Returns the information for a specific race used in Archaeology.
: [[API GetArchaeologyRaceInfoByID|GetArchaeologyRaceInfoByID]](<span class="apiarg">researchBranchID</span>) - Returns Racename and texture.
+
: [[API GetArchaeologyRaceInfoByID|GetArchaeologyRaceInfoByID]](<span class="apiarg">researchBranchID</span>) - Returns info for an Archaeology race.
 
: [[API GetArtifactInfoByRace|GetArtifactInfoByRace]](<span class="apiarg">raceIndex, artifactIndex</span>) - Returns the information for a specific race's artifact.
 
: [[API GetArtifactInfoByRace|GetArtifactInfoByRace]](<span class="apiarg">raceIndex, artifactIndex</span>) - Returns the information for a specific race's artifact.
: [[API GetNumArchaeologyRaces|GetNumArchaeologyRaces]]() - Returns the amount of Archaeology races in the game.
+
: [[API GetNumArchaeologyRaces|GetNumArchaeologyRaces]]() - Returns the number of Archaeology races in the game.
 
: [[API GetNumArtifactsByRace|GetNumArtifactsByRace]](<span class="apiarg">raceIndex</span>) - Returns the amount of artifacts the player has acquired from the provided race.
 
: [[API GetNumArtifactsByRace|GetNumArtifactsByRace]](<span class="apiarg">raceIndex</span>) - Returns the amount of artifacts the player has acquired from the provided race.
: [[API GetSelectedArtifactInfo|GetSelectedArtifactInfo]]() - Returns the information for the [[API SetSelectedArtifact|selected]] race.
+
: [[API GetSelectedArtifactInfo|GetSelectedArtifactInfo]]() - Returns info for the selected race's Archaeology artifact.
: [[API GetArtifactProgress|GetArtifactProgress]]() - Returns fragment-information about the [[API SetSelectedArtifact|selected]] artifact.
+
: [[API GetArtifactProgress|GetArtifactProgress]]() - Returns progress info for the selected Archaeology artifact.
 
: [[API IsArtifactCompletionHistoryAvailable|IsArtifactCompletionHistoryAvailable]]()
 
: [[API IsArtifactCompletionHistoryAvailable|IsArtifactCompletionHistoryAvailable]]()
 
: [[API ItemAddedToArtifact|ItemAddedToArtifact]](<span class="apiarg">keystoneindex</span>) - Returns if there is a keystone in the artifact.
 
: [[API ItemAddedToArtifact|ItemAddedToArtifact]](<span class="apiarg">keystoneindex</span>) - Returns if there is a keystone in the artifact.
: [[API SetSelectedArtifact|SetSelectedArtifact]](<span class="apiarg">raceIndex</span>) - Sets the selected artifact to raceIndex.
+
: [[API SetSelectedArtifact|SetSelectedArtifact]](<span class="apiarg">raceIndex</span>) - Sets the selected artifact to an archaeology race.
: [[API RemoveItemFromArtifact|RemoveItemFromArtifact]]() - Remove a keystone from the [[API SetSelectedArtifact|selected]] artifact.
+
: [[API RemoveItemFromArtifact|RemoveItemFromArtifact]]() - Removes a [[Keystone]] from the selected artifact.
 
: [[API RequestArtifactCompletionHistory|RequestArtifactCompletionHistory]]()
 
: [[API RequestArtifactCompletionHistory|RequestArtifactCompletionHistory]]()
: [[API SocketItemToArtifact|SocketItemToArtifact]]() - Add a keystone to the [[API SetSelectedArtifact|selected]] artifact.
+
: [[API SocketItemToArtifact|SocketItemToArtifact]]() - Adds a [[keystone]] to the selected archaeology artifact.
 
: [[API SolveArtifact|SolveArtifact]]() - Solve the [[API SetSelectedArtifact|selected]] artifact.
 
: [[API SolveArtifact|SolveArtifact]]() - Solve the [[API SetSelectedArtifact|selected]] artifact.
   
==== Glyphs ====
+
====Glyphs====
 
[[Glyph]]s were added in [[Patch 3.0.2]]. After the Glyph interface was removed in [[Patch 7.0.3]] they were streamlined into the [[Spellbook]].
 
[[Glyph]]s were added in [[Patch 3.0.2]]. After the Glyph interface was removed in [[Patch 7.0.3]] they were streamlined into the [[Spellbook]].
 
: [[API AttachGlyphToSpell|AttachGlyphToSpell]](<span class="apiarg">spellID</span>)
 
: [[API AttachGlyphToSpell|AttachGlyphToSpell]](<span class="apiarg">spellID</span>)
Line 3,400: Line 3,436:
 
: [[API IsSpellValidForPendingGlyph|IsSpellValidForPendingGlyph]](<span class="apiarg">spellID</span>)
 
: [[API IsSpellValidForPendingGlyph|IsSpellValidForPendingGlyph]](<span class="apiarg">spellID</span>)
   
==== Item Socketing ====
+
====Item Socketing====
 
The following were added along with socketed items and gems in [[Patch 2.0]]. ID refers to a 1-based index of the sockets in the item being considered for socketing.
 
The following were added along with socketed items and gems in [[Patch 2.0]]. ID refers to a 1-based index of the sockets in the item being considered for socketing.
 
: [[API C_ItemSocketInfo.CompleteSocketing|C_ItemSocketInfo.CompleteSocketing]]() - Completes socketing an item, binding it to the player.
 
: [[API C_ItemSocketInfo.CompleteSocketing|C_ItemSocketInfo.CompleteSocketing]]() - Completes socketing an item, binding it to the player.
: [[API AcceptSockets|AcceptSockets]]() - Sockets tentative gems into the sockets, replacing existing gems if necessary.
+
: [[API AcceptSockets|AcceptSockets]]() - Confirms pending gems for socketing.
: [[API CloseSocketInfo|CloseSocketInfo]]() - Stops considering the item for socketing, without applying changes.
+
: [[API CloseSocketInfo|CloseSocketInfo]]() - Cancels pending gems for socketing.
 
: [[API GetExistingSocketInfo|GetExistingSocketInfo]](<span class="apiarg">id</span>) - Returns information about the existing gem in the socket.
 
: [[API GetExistingSocketInfo|GetExistingSocketInfo]](<span class="apiarg">id</span>) - Returns information about the existing gem in the socket.
 
: [[API GetExistingSocketLink|GetExistingSocketLink]](<span class="apiarg">id</span>) - Returns an item link for the existing gem in the socket.
 
: [[API GetExistingSocketLink|GetExistingSocketLink]](<span class="apiarg">id</span>) - Returns an item link for the existing gem in the socket.
 
: [[API GetNewSocketInfo|GetNewSocketInfo]](<span class="apiarg">id</span>) - Returns information about the new (tentative) gem in the socket.
 
: [[API GetNewSocketInfo|GetNewSocketInfo]](<span class="apiarg">id</span>) - Returns information about the new (tentative) gem in the socket.
 
: [[API GetNewSocketLink|GetNewSocketLink]](<span class="apiarg">id</span>) - Returns an item link for the new (tentative) gem in the socket.
 
: [[API GetNewSocketLink|GetNewSocketLink]](<span class="apiarg">id</span>) - Returns an item link for the new (tentative) gem in the socket.
: [[API GetNumSockets|GetNumSockets]]() - Returns the number of sockets in the item currently being socketed.
+
: [[API GetNumSockets|GetNumSockets]]() - Returns the number of sockets for an item in the socketing window.
: [[API GetSocketItemBoundTradeable|GetSocketItemBoundTradeable]]() - Returns whether the item currently being socketed is temporarily tradable (BoP boss loot).
+
: [[API GetSocketItemBoundTradeable|GetSocketItemBoundTradeable]]() - True if the item currently being socketed can be traded to other eligible players (BoP boss loot).
: [[API GetSocketItemInfo|GetSocketItemInfo]]() - Returns information about the item currently being socketed.
+
: [[API GetSocketItemInfo|GetSocketItemInfo]]() - Returns info for the item currently being socketed.
 
: [[API GetSocketItemRefundable|GetSocketItemRefundable]]() - Returns whether the item currently being socketed is refundable.
 
: [[API GetSocketItemRefundable|GetSocketItemRefundable]]() - Returns whether the item currently being socketed is refundable.
 
: [[API GetSocketTypes|GetSocketTypes]](<span class="apiarg">id</span>) - Returns the type (color) of a socket in the item.
 
: [[API GetSocketTypes|GetSocketTypes]](<span class="apiarg">id</span>) - Returns the type (color) of a socket in the item.
Line 3,418: Line 3,454:
 
: [[API SocketInventoryItem|SocketInventoryItem]](<span class="apiarg">slot</span>) - Considers the item in the inventory slot for socketing.
 
: [[API SocketInventoryItem|SocketInventoryItem]](<span class="apiarg">slot</span>) - Considers the item in the inventory slot for socketing.
   
=== PvP ===
+
===PvP===
 
Relates to [[Player vs. Player]].
 
Relates to [[Player vs. Player]].
 
: [[API C_PvP.CanDisplayDamage|C_PvP.CanDisplayDamage]]() : <span class="apiret">canDisplay</span>
 
: [[API C_PvP.CanDisplayDamage|C_PvP.CanDisplayDamage]]() : <span class="apiret">canDisplay</span>
Line 3,437: Line 3,473:
 
: [[API C_PvP.GetMatchPVPStatColumns|C_PvP.GetMatchPVPStatColumns]]() : <span class="apiret">columns</span>
 
: [[API C_PvP.GetMatchPVPStatColumns|C_PvP.GetMatchPVPStatColumns]]() : <span class="apiret">columns</span>
 
: [[API C_PvP.GetNextHonorLevelForReward|C_PvP.GetNextHonorLevelForReward]](<span class="apiarg">honorLevel</span>) : <span class="apiret">nextHonorLevelWithReward</span>
 
: [[API C_PvP.GetNextHonorLevelForReward|C_PvP.GetNextHonorLevelForReward]](<span class="apiarg">honorLevel</span>) : <span class="apiret">nextHonorLevelWithReward</span>
: [[API C_PvP.GetOutdoorPvPWaitTime|C_PvP.GetOutdoorPvPWaitTime]](<span class="apiarg">uiMapID</span>) : <span class="apiret">pvpWaitTime</span> - Returns the number of seconds until the next battle in a given world PvP zone.
+
: [[API C_PvP.GetOutdoorPvPWaitTime|C_PvP.GetOutdoorPvPWaitTime]](<span class="apiarg">uiMapID</span>) : <span class="apiret">pvpWaitTime</span> - Returns the time until the next battle in a PvP zone like Wintergrasp and Tol Barad.
 
: [[API C_PvP.GetPostMatchCurrencyRewards|C_PvP.GetPostMatchCurrencyRewards]]() : <span class="apiret">rewards</span>
 
: [[API C_PvP.GetPostMatchCurrencyRewards|C_PvP.GetPostMatchCurrencyRewards]]() : <span class="apiret">rewards</span>
 
: [[API C_PvP.GetPostMatchItemRewards|C_PvP.GetPostMatchItemRewards]]() : <span class="apiret">rewards</span>
 
: [[API C_PvP.GetPostMatchItemRewards|C_PvP.GetPostMatchItemRewards]]() : <span class="apiret">rewards</span>
Line 3,456: Line 3,492:
 
: [[API C_PvP.IsRatedMap|C_PvP.IsRatedMap]]() : <span class="apiret">isRatedMap</span>
 
: [[API C_PvP.IsRatedMap|C_PvP.IsRatedMap]]() : <span class="apiret">isRatedMap</span>
 
: [[API C_PvP.RequestCrowdControlSpell|C_PvP.RequestCrowdControlSpell]](<span class="apiarg">playerToken</span>)
 
: [[API C_PvP.RequestCrowdControlSpell|C_PvP.RequestCrowdControlSpell]](<span class="apiarg">playerToken</span>)
: [[API AcceptDuel|AcceptDuel]]() - The player accepts the challenge to duel.
+
: [[API AcceptDuel|AcceptDuel]]() - Accepts a duel challenge.
: [[API CancelDuel|CancelDuel]]() - Refuse the invitation to fight a duel.
+
: [[API CancelDuel|CancelDuel]]() - Forfeits the current duel or declines a duel invitation.
 
: [[API ClearBattlemaster|ClearBattlemaster]]()
 
: [[API ClearBattlemaster|ClearBattlemaster]]()
 
: [[API ForfeitDuel|ForfeitDuel]]()
 
: [[API ForfeitDuel|ForfeitDuel]]()
 
: [[API GetPVPDesired|GetPVPDesired]]() - Returns whether the player has permanently turned on their PvP flag.
 
: [[API GetPVPDesired|GetPVPDesired]]() - Returns whether the player has permanently turned on their PvP flag.
: [[API GetPVPLifetimeStats|GetPVPLifetimeStats]]() - Get your PvP/Honor statistics for your lifetime.
+
: [[API GetPVPLifetimeStats|GetPVPLifetimeStats]]() - Returns the character's lifetime PvP statistics.
 
: [[API GetPVPRoles|GetPVPRoles]]()
 
: [[API GetPVPRoles|GetPVPRoles]]()
: [[API GetPVPSessionStats|GetPVPSessionStats]]() - Get your PvP/Honor statistics for this session.
+
: [[API GetPVPSessionStats|GetPVPSessionStats]]() - Returns the character's Honor statistics for this session.
: [[API GetPVPTimer|GetPVPTimer]]() - Returns the amount of time until your PvP flag fades.
+
: [[API GetPVPTimer|GetPVPTimer]]() - Returns the time left in milliseconds until the player is unflagged for PvP.
: [[API GetPVPYesterdayStats|GetPVPYesterdayStats]]() - Get your PvP/Honor statistics for yesterday.
+
: [[API GetPVPYesterdayStats|GetPVPYesterdayStats]]() - Returns the character's Honor statistics for yesterday.
 
: [[API GetRewardPackArtifactPower|GetRewardPackArtifactPower]](<span class="apiarg">rewardPackID</span>)
 
: [[API GetRewardPackArtifactPower|GetRewardPackArtifactPower]](<span class="apiarg">rewardPackID</span>)
 
: [[API GetRewardPackCurrencies|GetRewardPackCurrencies]](<span class="apiarg">rewardPackID</span>)
 
: [[API GetRewardPackCurrencies|GetRewardPackCurrencies]](<span class="apiarg">rewardPackID</span>)
Line 3,479: Line 3,515:
 
: [[API RequestPVPOptionsEnabled|RequestPVPOptionsEnabled]]()
 
: [[API RequestPVPOptionsEnabled|RequestPVPOptionsEnabled]]()
 
: [[API RequestPVPRewards|RequestPVPRewards]]()
 
: [[API RequestPVPRewards|RequestPVPRewards]]()
: [[API SetPVP|SetPVP]](<span class="apiarg">enable</span>) - Sets the players PVP mode (1 to enable, nil to toggle off eventually).
+
: [[API SetPVP|SetPVP]](<span class="apiarg">enable</span>) - Flags the player for PvP combat.
 
: [[API SetPVPRoles|SetPVPRoles]]()
 
: [[API SetPVPRoles|SetPVPRoles]]()
 
: [[API SortBGList|SortBGList]]()
 
: [[API SortBGList|SortBGList]]()
: [[API StartDuel|StartDuel]](<span class="apiarg">name</span>) - Challenge someone to a duel (by name)
+
: [[API StartDuel|StartDuel]](<span class="apiarg">name</span>) - Challenges the specified player to a duel.
 
: [[API TogglePVP|TogglePVP]]() - Toggles PVP status.
 
: [[API TogglePVP|TogglePVP]]() - Toggles PVP status.
: [[API UnitHonor|UnitHonor]](<span class="apiarg">unit</span>) - Returns the amount of honor the unit has for the current rank.
+
: [[API UnitHonor|UnitHonor]](<span class="apiarg">unit</span>) - Returns the current amount of honor the unit has for the current rank.
: [[API UnitHonorLevel|UnitHonorLevel]](<span class="apiarg">unit</span>) - Returns the current honor rank for the unit.
+
: [[API UnitHonorLevel|UnitHonorLevel]](<span class="apiarg">unit</span>) - Returns the current honor rank of the unit.
 
: [[API UnitHonorMax|UnitHonorMax]](<span class="apiarg">unit</span>) - Returns the maximum amount of honor for the current rank.
 
: [[API UnitHonorMax|UnitHonorMax]](<span class="apiarg">unit</span>) - Returns the maximum amount of honor for the current rank.
 
: [[API UnitIsMercenary|UnitIsMercenary]]()
 
: [[API UnitIsMercenary|UnitIsMercenary]]()
: [[API UnitIsPVPFreeForAll|UnitIsPVPFreeForAll]](<span class="apiarg">unit</span>) - Returns true if the specified unit is flagged for free-for-all PVP, false otherwise.
+
: [[API UnitIsPVPFreeForAll|UnitIsPVPFreeForAll]](<span class="apiarg">unit</span>) - True if the unit is flagged for free-for-all PVP (e.g. in a world arena).
 
: [[API UnitIsPVPSanctuary|UnitIsPVPSanctuary]](<span class="apiarg">unit</span>) - Returns whether the unit is in a PvP sanctuary, and therefore cannot be attacked by other players.
 
: [[API UnitIsPVPSanctuary|UnitIsPVPSanctuary]](<span class="apiarg">unit</span>) - Returns whether the unit is in a PvP sanctuary, and therefore cannot be attacked by other players.
: [[API UnitIsPVP|UnitIsPVP]](<span class="apiarg">unit</span>) - Returns true if the specified unit is flagged for PVP, false otherwise.
+
: [[API UnitIsPVP|UnitIsPVP]](<span class="apiarg">unit</span>) - True if the unit is flagged for PVP.
: [[API UnitPVPName|UnitPVPName]](<span class="apiarg">unit</span>) - Returns unit's name with PvP rank prefix (e.g., "Corporal Allianceguy").
+
: [[API UnitPVPName|UnitPVPName]](<span class="apiarg">unit</span>) - Returns the unit's name with title (e.g. "Bob the Explorer").
 
: [[API UnitPvpClassification|UnitPvpClassification]](<span class="apiarg">unit</span>) : <span class="apiret">classification</span> - Returns whether the unit is a flag/orb carrier or cart runner.
 
: [[API UnitPvpClassification|UnitPvpClassification]](<span class="apiarg">unit</span>) : <span class="apiret">classification</span> - Returns whether the unit is a flag/orb carrier or cart runner.
   
==== Arena ====
+
====Arena====
 
: [[API C_PvP.GetArenaCrowdControlInfo|C_PvP.GetArenaCrowdControlInfo]](<span class="apiarg">playerToken</span>) : <span class="apiret">spellID, startTime, duration</span>
 
: [[API C_PvP.GetArenaCrowdControlInfo|C_PvP.GetArenaCrowdControlInfo]](<span class="apiarg">playerToken</span>) : <span class="apiret">spellID, startTime, duration</span>
 
: [[API C_PvP.GetArenaRewards|C_PvP.GetArenaRewards]](<span class="apiarg">teamSize</span>) : <span class="apiret">honor, experience, itemRewards, currencyRewards</span>
 
: [[API C_PvP.GetArenaRewards|C_PvP.GetArenaRewards]](<span class="apiarg">teamSize</span>) : <span class="apiret">honor, experience, itemRewards, currencyRewards</span>
Line 3,505: Line 3,541:
 
: [[API GetArenaOpponentSpec|GetArenaOpponentSpec]]()
 
: [[API GetArenaOpponentSpec|GetArenaOpponentSpec]]()
 
: [[API GetBattlefieldArenaFaction|GetBattlefieldArenaFaction]]()
 
: [[API GetBattlefieldArenaFaction|GetBattlefieldArenaFaction]]()
: [[API GetBattlefieldTeamInfo|GetBattlefieldTeamInfo]](<span class="apiarg">index</span>) - Gets info about a registered Arena Team at the end of an arena match.
+
: [[API GetBattlefieldTeamInfo|GetBattlefieldTeamInfo]](<span class="apiarg">index</span>) - Returns info for an Arena team at the end of the match.
: [[API GetCurrentArenaSeason|GetCurrentArenaSeason]]() - Gets the current Arena season.
+
: [[API GetCurrentArenaSeason|GetCurrentArenaSeason]]() - Returns the current arena season.
 
: [[API GetMaxArenaCurrency|GetMaxArenaCurrency]]()
 
: [[API GetMaxArenaCurrency|GetMaxArenaCurrency]]()
 
: [[API GetNumArenaOpponents|GetNumArenaOpponents]]()
 
: [[API GetNumArenaOpponents|GetNumArenaOpponents]]()
 
: [[API GetNumArenaOpponentSpecs|GetNumArenaOpponentSpecs]]()
 
: [[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]]() - True if the player is inside a (rated) arena.
 
: [[API IsArenaSkirmish|IsArenaSkirmish]]()
 
: [[API IsArenaSkirmish|IsArenaSkirmish]]()
 
: [[API IsArenaTeamCaptain|IsArenaTeamCaptain]](<span class="apiarg">teamIndex</span>) - Returns a value based on whether the player is the arena team captain.
 
: [[API IsArenaTeamCaptain|IsArenaTeamCaptain]](<span class="apiarg">teamIndex</span>) - Returns a value based on whether the player is the arena team captain.
Line 3,520: Line 3,556:
 
: [[API SurrenderArena|SurrenderArena]]()
 
: [[API SurrenderArena|SurrenderArena]]()
   
==== Solo Shuffle ====
+
====Solo Shuffle====
 
: [[API C_PvP.IsSoloShuffle|C_PvP.IsSoloShuffle]]() : <span class="apiret">isSoloShuffle</span>
 
: [[API C_PvP.IsSoloShuffle|C_PvP.IsSoloShuffle]]() : <span class="apiret">isSoloShuffle</span>
 
: [[API StartSoloShuffleWarGameByName|StartSoloShuffleWarGameByName]]()
 
: [[API StartSoloShuffleWarGameByName|StartSoloShuffleWarGameByName]]()
 
: [[API StartSpectatorSoloShuffleWarGame|StartSpectatorSoloShuffleWarGame]]()
 
: [[API StartSpectatorSoloShuffleWarGame|StartSpectatorSoloShuffleWarGame]]()
   
==== Battlegrounds ====
+
====Battlegrounds====
 
: [[API C_PvP.GetBattlefieldFlagPosition|C_PvP.GetBattlefieldFlagPosition]](<span class="apiarg">flagIndex, uiMapId</span>) : <span class="apiret">uiPosx, uiPosy, flagTexture</span>
 
: [[API C_PvP.GetBattlefieldFlagPosition|C_PvP.GetBattlefieldFlagPosition]](<span class="apiarg">flagIndex, uiMapId</span>) : <span class="apiret">uiPosx, uiPosy, flagTexture</span>
 
: [[API C_PvP.GetLevelUpBattlegrounds|C_PvP.GetLevelUpBattlegrounds]](<span class="apiarg">level</span>) : <span class="apiret">battlefields</span>
 
: [[API C_PvP.GetLevelUpBattlegrounds|C_PvP.GetLevelUpBattlegrounds]](<span class="apiarg">level</span>) : <span class="apiret">battlefields</span>
Line 3,536: Line 3,572:
 
: [[API C_PvP.IsBattlegroundEnlistmentBonusActive|C_PvP.IsBattlegroundEnlistmentBonusActive]]() : <span class="apiret">battlegroundActive, brawlActive</span>
 
: [[API C_PvP.IsBattlegroundEnlistmentBonusActive|C_PvP.IsBattlegroundEnlistmentBonusActive]]() : <span class="apiret">battlegroundActive, brawlActive</span>
 
: [[API C_PvP.IsRatedBattleground|C_PvP.IsRatedBattleground]]() : <span class="apiret">isRatedBattleground</span>
 
: [[API C_PvP.IsRatedBattleground|C_PvP.IsRatedBattleground]]() : <span class="apiret">isRatedBattleground</span>
: [[API AcceptAreaSpiritHeal|AcceptAreaSpiritHeal]]() - Accept a spirit heal.
+
: [[API AcceptAreaSpiritHeal|AcceptAreaSpiritHeal]]() - Signs up for the Spirit Healer's resurrection timer in battlegrounds when in range.
: [[API AcceptBattlefieldPort|AcceptBattlefieldPort]](<span class="apiarg">index [, acceptFlag]</span>) - Accept or reject an offered battlefield port.
+
: [[API AcceptBattlefieldPort|AcceptBattlefieldPort]](<span class="apiarg">index [, acceptFlag]</span>) - Enters the Battleground if the queue is ready.
 
: [[API CanJoinBattlefieldAsGroup|CanJoinBattlefieldAsGroup]]() - True if the player can join a battlefield with a group.
: [[API BattlefieldSetPendingReportTarget|BattlefieldSetPendingReportTarget]](<span class="apiarg">index</span>)
 
 
: [[API CancelAreaSpiritHeal|CancelAreaSpiritHeal]]() - Cancels the Spirit Healer's resurrection in battlegrounds.
: [[API CanJoinBattlefieldAsGroup|CanJoinBattlefieldAsGroup]]() - Returns nil if the player can not do a group join for a battlefield.
 
: [[API CancelAreaSpiritHeal|CancelAreaSpiritHeal]]() - Cancel a spirit heal.
 
 
: [[API CheckSpiritHealerDist|CheckSpiritHealerDist]]() - Returns true if you are in range with spirit healer while dead.
 
: [[API CheckSpiritHealerDist|CheckSpiritHealerDist]]() - Returns true if you are in range with spirit healer while dead.
: [[API GetAreaSpiritHealerTime|GetAreaSpiritHealerTime]]() - Returns the time left until the next resurrection by the Sprit Guide.
+
: [[API GetAreaSpiritHealerTime|GetAreaSpiritHealerTime]]() - Returns the time left in seconds until the next Spirit Healer resurrection in battlegrounds.
: [[API GetBattlefieldEstimatedWaitTime|GetBattlefieldEstimatedWaitTime]](<span class="apiarg">index</span>) - Get the estimated wait for entry into the battlefield.
+
: [[API GetBattlefieldEstimatedWaitTime|GetBattlefieldEstimatedWaitTime]](<span class="apiarg">index</span>) - Returns the estimated queue time to enter the battlefield.
 
: [[API GetBattlefieldInstanceExpiration|GetBattlefieldInstanceExpiration]]() - Get shutdown timer for the battlefield instance.
 
: [[API GetBattlefieldInstanceExpiration|GetBattlefieldInstanceExpiration]]() - Get shutdown timer for the battlefield instance.
: [[API GetBattlefieldInstanceRunTime|GetBattlefieldInstanceRunTime]]() - In milliseconds, the time since battleground started (seems to be queried from server because it is not in sync with time()).
+
: [[API GetBattlefieldInstanceRunTime|GetBattlefieldInstanceRunTime]]() - Returns the time passed since the battlefield started.
 
: [[API GetBattlefieldMapIconScale|GetBattlefieldMapIconScale]]() - Scale of the landmark icons on the battlefield minimap.
 
: [[API GetBattlefieldMapIconScale|GetBattlefieldMapIconScale]]() - Scale of the landmark icons on the battlefield minimap.
: [[API GetBattlefieldPortExpiration|GetBattlefieldPortExpiration]](<span class="apiarg">index</span>) - Get the remaining seconds before the battlefield port expires.
+
: [[API GetBattlefieldPortExpiration|GetBattlefieldPortExpiration]](<span class="apiarg">index</span>) - Returns the remaining seconds before the battlefield port expires.
: [[API GetBattlefieldScore|GetBattlefieldScore]](<span class="apiarg">index</span>) - Get score information about a player.
+
: <small>''DEPRECATED''</small> [[API GetBattlefieldScore|GetBattlefieldScore]](<span class="apiarg">index</span>) - Returns info for a player's score in battlefields.
: [[API GetBattlefieldStatData|GetBattlefieldStatData]](<span class="apiarg">playerIndex, slotIndex</span>) - Get information for a player from a column thats specific to a battleground (like Warsong Gulch flag captures).
+
: <small>''DEPRECATED''</small> [[API GetBattlefieldStatData|GetBattlefieldStatData]](<span class="apiarg">playerIndex, slotIndex</span>) - Returns battlefield-specific info for a player (e.g. Warsong Gulch flag captures).
: [[API GetBattlefieldStatus|GetBattlefieldStatus]](<span class="apiarg">index</span>) - Get the battlefield's current status.
+
: [[API GetBattlefieldStatus|GetBattlefieldStatus]](<span class="apiarg">index</span>) - Returns the status of the battlefield the player is either queued for or inside.
: [[API GetBattlefieldTimeWaited|GetBattlefieldTimeWaited]](<span class="apiarg">index</span>) - Get time waited in queue in milliseconds.
+
: [[API GetBattlefieldTimeWaited|GetBattlefieldTimeWaited]](<span class="apiarg">index</span>) - Returns the time the player has waited in the queue.
: [[API GetBattlefieldWinner|GetBattlefieldWinner]]() - Get the battlefields winner.
+
: [[API GetBattlefieldWinner|GetBattlefieldWinner]]() - Returns the winner of the battlefield.
 
: [[API GetBattlegroundInfo|GetBattlegroundInfo]](<span class="apiarg">index</span>) - Returns information about a battleground type.
 
: [[API GetBattlegroundInfo|GetBattlegroundInfo]](<span class="apiarg">index</span>) - Returns information about a battleground type.
 
: [[API GetBattlegroundPoints|GetBattlegroundPoints]]()
 
: [[API GetBattlegroundPoints|GetBattlegroundPoints]]()
 
: [[API GetMaxBattlefieldID|GetMaxBattlefieldID]]() - Returns the max number of battlefields you can queue for.
 
: [[API GetMaxBattlefieldID|GetMaxBattlefieldID]]() - Returns the max number of battlefields you can queue for.
 
: [[API GetNumBattlefieldFlagPositions|GetNumBattlefieldFlagPositions]]() - Get the number of flag positions available from GetBattlefieldFlagPosition().
 
: [[API GetNumBattlefieldFlagPositions|GetNumBattlefieldFlagPositions]]() - Get the number of flag positions available from GetBattlefieldFlagPosition().
: [[API GetNumBattlefieldScores|GetNumBattlefieldScores]]() - Returns the number of scores(players) listed in the battlefield scoreboard.
+
: [[API GetNumBattlefieldScores|GetNumBattlefieldScores]]() - Returns the number of players listed in the battlefield scoreboard.
 
: [[API GetNumBattlegroundTypes|GetNumBattlegroundTypes]]()
 
: [[API GetNumBattlegroundTypes|GetNumBattlegroundTypes]]()
 
: [[API GetPersonalRatedInfo|GetPersonalRatedInfo]](<span class="apiarg">bracketIndex</span>)
 
: [[API GetPersonalRatedInfo|GetPersonalRatedInfo]](<span class="apiarg">bracketIndex</span>)
 
: [[API GetRatedBattleGroundInfo|GetRatedBattleGroundInfo]]()
 
: [[API GetRatedBattleGroundInfo|GetRatedBattleGroundInfo]]()
 
: [[API IsPVPTimerRunning|IsPVPTimerRunning]]()
 
: [[API IsPVPTimerRunning|IsPVPTimerRunning]]()
: <small>PROTECTED</small> [[API JoinBattlefield|JoinBattlefield]](<span class="apiarg">index [, joinAs]</span>) - Queue for a battleground either solo or as a group.
+
: <small>''PROTECTED''</small> [[API JoinBattlefield|JoinBattlefield]](<span class="apiarg">index [, joinAs]</span>) - Joins the battleground queue solo or as a group.
: <small>PROTECTED</small> [[API JoinRatedBattlefield|JoinRatedBattlefield]]()
+
: <small>''PROTECTED''</small> [[API JoinRatedBattlefield|JoinRatedBattlefield]]()
: [[API LeaveBattlefield|LeaveBattlefield]]() - Leave the current battlefield.
+
: [[API LeaveBattlefield|LeaveBattlefield]]() - Leaves the current battleground.
 
: [[API ReportPlayerIsPVPAFK|ReportPlayerIsPVPAFK]](<span class="apiarg">unit</span>) - Reports the specified player as AFK in a battleground.
 
: [[API ReportPlayerIsPVPAFK|ReportPlayerIsPVPAFK]](<span class="apiarg">unit</span>) - Reports the specified player as AFK in a battleground.
: [[API RequestBattlefieldScoreData|RequestBattlefieldScoreData]]() - Request new data for GetBattlefieldScore().
+
: [[API RequestBattlefieldScoreData|RequestBattlefieldScoreData]]() - Requests the latest battlefield score data from the server.
 
: [[API RequestRandomBattlegroundInstanceInfo|RequestRandomBattlegroundInstanceInfo]]()
 
: [[API RequestRandomBattlegroundInstanceInfo|RequestRandomBattlegroundInstanceInfo]]()
 
: [[API RequestRatedInfo|RequestRatedInfo]]()
 
: [[API RequestRatedInfo|RequestRatedInfo]]()
: [[API SetBattlefieldScoreFaction|SetBattlefieldScoreFaction]](<span class="apiarg">[faction]</span>) - Set the faction to show on the battlefield scoreboard.
+
: [[API SetBattlefieldScoreFaction|SetBattlefieldScoreFaction]](<span class="apiarg">[faction]</span>) - Sets the faction to show on the battlefield scoreboard.
 
: [[API SortBattlefieldScoreData|SortBattlefieldScoreData]](<span class="apiarg">type</span>)
 
: [[API SortBattlefieldScoreData|SortBattlefieldScoreData]](<span class="apiarg">type</span>)
: [[API UnitInBattleground|UnitInBattleground]](<span class="apiarg">unit</span>) - Returns the unit index if the unit is in your battleground, nil otherwise.
+
: [[API UnitInBattleground|UnitInBattleground]](<span class="apiarg">unit</span>) - Returns the unit index if the unit is in your battleground.
   
==== World Battlefields ====
+
====World Battlefields====
 
The following functions are used for population-limited world PvP zones, like [[Lake Wintergrasp]] or [[Tol Barad]].
 
The following functions are used for population-limited world PvP zones, like [[Lake Wintergrasp]] or [[Tol Barad]].
 
: [[API C_PvP.IsActiveBattlefield|C_PvP.IsActiveBattlefield]]() : <span class="apiret">isActiveBattlefield</span>
 
: [[API C_PvP.IsActiveBattlefield|C_PvP.IsActiveBattlefield]]() : <span class="apiret">isActiveBattlefield</span>
Line 3,583: Line 3,618:
 
: [[API HearthAndResurrectFromArea|HearthAndResurrectFromArea]]() - Resurrects the player, and ports them out of the world PvP zone.
 
: [[API HearthAndResurrectFromArea|HearthAndResurrectFromArea]]() - Resurrects the player, and ports them out of the world PvP zone.
 
: [[API GetNumWorldPVPAreas|GetNumWorldPVPAreas]]() - Returns the number of world PvP zones available.
 
: [[API GetNumWorldPVPAreas|GetNumWorldPVPAreas]]() - Returns the number of world PvP zones available.
: [[API GetWorldPVPAreaInfo|GetWorldPVPAreaInfo]](<span class="apiarg">index</span>) - Returns information about a world PvP zone.
+
: [[API GetWorldPVPAreaInfo|GetWorldPVPAreaInfo]](<span class="apiarg">index</span>) - Returns info for a world PvP zone (e.g. Wintergrasp or Tol Barad).
 
: [[API GetWorldPVPQueueStatus|GetWorldPVPQueueStatus]](<span class="apiarg">queueId</span>)
 
: [[API GetWorldPVPQueueStatus|GetWorldPVPQueueStatus]](<span class="apiarg">queueId</span>)
   
==== Brawl ====
+
====Brawl====
 
: [[API C_PvP.GetActiveBrawlInfo|C_PvP.GetActiveBrawlInfo]]() : <span class="apiret">brawlInfo</span>
 
: [[API C_PvP.GetActiveBrawlInfo|C_PvP.GetActiveBrawlInfo]]() : <span class="apiret">brawlInfo</span>
 
: [[API C_PvP.GetAvailableBrawlInfo|C_PvP.GetAvailableBrawlInfo]]() : <span class="apiret">brawlInfo</span>
 
: [[API C_PvP.GetAvailableBrawlInfo|C_PvP.GetAvailableBrawlInfo]]() : <span class="apiret">brawlInfo</span>
Line 3,594: Line 3,629:
 
: [[API C_PvP.JoinBrawl|C_PvP.JoinBrawl]](<span class="apiarg">[isSpecialBrawl]</span>)
 
: [[API C_PvP.JoinBrawl|C_PvP.JoinBrawl]](<span class="apiarg">[isSpecialBrawl]</span>)
   
==== War Games ====
+
====War Games====
 
[[War Game]]s were added in [[Patch 4.0.1]]
 
[[War Game]]s were added in [[Patch 4.0.1]]
 
: [[API CanInitiateWarGame|CanInitiateWarGame]]()
 
: [[API CanInitiateWarGame|CanInitiateWarGame]]()
Line 3,611: Line 3,646:
 
: [[API WarGameRespond|WarGameRespond]](<span class="apiarg">accept</span>)
 
: [[API WarGameRespond|WarGameRespond]](<span class="apiarg">accept</span>)
   
==== War Mode ====
+
====War Mode====
 
[[War Mode]] was added in [[Patch 8.0.1]]
 
[[War Mode]] was added in [[Patch 8.0.1]]
 
: [[API C_PvP.CanToggleWarMode|C_PvP.CanToggleWarMode]](<span class="apiarg">toggle</span>) : <span class="apiret">canTogglePvP</span>
 
: [[API C_PvP.CanToggleWarMode|C_PvP.CanToggleWarMode]](<span class="apiarg">toggle</span>) : <span class="apiret">canTogglePvP</span>
Line 3,623: Line 3,658:
 
: [[API C_PvP.ToggleWarMode|C_PvP.ToggleWarMode]]()
 
: [[API C_PvP.ToggleWarMode|C_PvP.ToggleWarMode]]()
   
=== Quests ===
+
===Quests===
 
Relates to [[Quest]]s.
 
Relates to [[Quest]]s.
 
: [[API C_QuestLine.GetAvailableQuestLines|C_QuestLine.GetAvailableQuestLines]](<span class="apiarg">uiMapID</span>) : <span class="apiret">questLines</span>
 
: [[API C_QuestLine.GetAvailableQuestLines|C_QuestLine.GetAvailableQuestLines]](<span class="apiarg">uiMapID</span>) : <span class="apiret">questLines</span>
Line 3,631: Line 3,666:
 
: [[API C_QuestLine.RequestQuestLinesForMap|C_QuestLine.RequestQuestLinesForMap]](<span class="apiarg">uiMapID</span>)
 
: [[API C_QuestLine.RequestQuestLinesForMap|C_QuestLine.RequestQuestLinesForMap]](<span class="apiarg">uiMapID</span>)
 
: [[API AcknowledgeAutoAcceptQuest|AcknowledgeAutoAcceptQuest]]()
 
: [[API AcknowledgeAutoAcceptQuest|AcknowledgeAutoAcceptQuest]]()
: [[API AddAutoQuestPopUp|AddAutoQuestPopUp]](<span class="apiarg">QuestID, Type</span>) - Adds quest to an internal list of quests for offer/completion popup notification.
+
: [[API AddAutoQuestPopUp|AddAutoQuestPopUp]](<span class="apiarg">QuestID, Type</span>) - Adds a notification to the ObjectiveTrackerFrame that a quest is available or completed.
 
: [[API ClearAutoAcceptQuestSound|ClearAutoAcceptQuestSound]]()
 
: [[API ClearAutoAcceptQuestSound|ClearAutoAcceptQuestSound]]()
 
: [[API CollapseQuestHeader|CollapseQuestHeader]]() - Collapses a quest header.
 
: [[API CollapseQuestHeader|CollapseQuestHeader]]() - Collapses a quest header.
: [[API ConfirmAcceptQuest|ConfirmAcceptQuest]]() - Accepts an offered quest that has been started by a party member; usually escort quests. (Might only be available after QUEST_ACCEPT_CONFIRM event.)
+
: [[API ConfirmAcceptQuest|ConfirmAcceptQuest]]() - Accepts a quest started by a group member (e.g. escort quests).
: [[API ExpandQuestHeader|ExpandQuestHeader]]() - Expands a quest header.
+
: [[API ExpandQuestHeader|ExpandQuestHeader]]() - Expands/collapses a quest log header.
: [[API GetAutoQuestPopUp|GetAutoQuestPopUp]](<span class="apiarg">Index</span>) - Retrieves quest info by index that added using [[API AddAutoQuestPopUp|AddAutoQuestPopUp]].
+
: [[API GetAutoQuestPopUp|GetAutoQuestPopUp]](<span class="apiarg">Index</span>) - Returns info for a popup quest notification.
 
: [[API GetCriteriaSpell|GetCriteriaSpell]]()
 
: [[API GetCriteriaSpell|GetCriteriaSpell]]()
 
: [[API GetDailyQuestsCompleted|GetDailyQuestsCompleted]]() - Returns the current number of daily quests completed today.
 
: [[API GetDailyQuestsCompleted|GetDailyQuestsCompleted]]() - Returns the current number of daily quests completed today.
 
: [[API GetMaxRewardCurrencies|GetMaxRewardCurrencies]]()
 
: [[API GetMaxRewardCurrencies|GetMaxRewardCurrencies]]()
: [[API GetNumAutoQuestPopUps|GetNumAutoQuestPopUps]]() - Retrieves number of quests added via [[API AddAutoQuestPopUp|AddAutoQuestPopUp]].
+
: [[API GetNumAutoQuestPopUps|GetNumAutoQuestPopUps]]() - Returns the number of displayed popup quest notifications.
 
: [[API GetNumQuestCurrencies|GetNumQuestCurrencies]]()
 
: [[API GetNumQuestCurrencies|GetNumQuestCurrencies]]()
 
: [[API GetNumQuestItemDrops|GetNumQuestItemDrops]]()
 
: [[API GetNumQuestItemDrops|GetNumQuestItemDrops]]()
: [[API GetNumQuestItems|GetNumQuestItems]]() - Returns the number of items necessary to complete a particular quest.
+
: [[API GetNumQuestItems|GetNumQuestItems]]() - Returns the number of required items to complete the current quest.
: [[API GetNumQuestLeaderBoards|GetNumQuestLeaderBoards]](<span class="apiarg">[questIndex]</span>) - Returns the number of available quest objectives.
+
: [[API GetNumQuestLeaderBoards|GetNumQuestLeaderBoards]](<span class="apiarg">[questIndex]</span>) - Returns the number of objectives for a quest.
 
: [[API GetNumQuestPOIWorldEffects|GetNumQuestPOIWorldEffects]]()
 
: [[API GetNumQuestPOIWorldEffects|GetNumQuestPOIWorldEffects]]()
: [[API GetQuestBackgroundMaterial|GetQuestBackgroundMaterial]]() - Returns the material string associated with the particular quest.
+
: [[API GetQuestBackgroundMaterial|GetQuestBackgroundMaterial]]() - Returns the background texture for the displayed quest.
 
: [[API GetQuestCurrencyID|GetQuestCurrencyID]](<span class="apiarg">type, index</span>)
 
: [[API GetQuestCurrencyID|GetQuestCurrencyID]](<span class="apiarg">type, index</span>)
 
: [[API GetQuestCurrencyInfo|GetQuestCurrencyInfo]](<span class="apiarg">type, index</span>)
 
: [[API GetQuestCurrencyInfo|GetQuestCurrencyInfo]](<span class="apiarg">type, index</span>)
Line 3,657: Line 3,692:
 
: [[API GetQuestPOIs|GetQuestPOIs]]()
 
: [[API GetQuestPOIs|GetQuestPOIs]]()
 
: [[API GetQuestProgressBarPercent|GetQuestProgressBarPercent]](<span class="apiarg">questID</span>)
 
: [[API GetQuestProgressBarPercent|GetQuestProgressBarPercent]](<span class="apiarg">questID</span>)
: [[API GetQuestResetTime|GetQuestResetTime]]() - Returns number of seconds until quest reset.
+
: [[API GetQuestResetTime|GetQuestResetTime]]() - Returns the number of seconds until daily quests reset.
: [[API GetQuestReward|GetQuestReward]](<span class="apiarg">rewardIndex</span>) - Completes the quest with the specified quest reward.
+
: [[API GetQuestReward|GetQuestReward]](<span class="apiarg">rewardIndex</span>) - Completes the quest and chooses a quest reward, if applicable.
 
: [[API GetQuestSortIndex|GetQuestSortIndex]](<span class="apiarg">questIndex</span>)
 
: [[API GetQuestSortIndex|GetQuestSortIndex]](<span class="apiarg">questIndex</span>)
 
: [[API GetQuestSpellLink|GetQuestSpellLink]](<span class="apiarg">rewardSpellIndex</span>)
 
: [[API GetQuestSpellLink|GetQuestSpellLink]](<span class="apiarg">rewardSpellIndex</span>)
Line 3,667: Line 3,702:
 
: [[API IsBreadcrumbQuest|IsBreadcrumbQuest]](<span class="apiarg">questID</span>)
 
: [[API IsBreadcrumbQuest|IsBreadcrumbQuest]](<span class="apiarg">questID</span>)
 
: [[API IsCurrentQuestFailed|IsCurrentQuestFailed]]()
 
: [[API IsCurrentQuestFailed|IsCurrentQuestFailed]]()
: [[API IsQuestCompletable|IsQuestCompletable]]() - Returns true if a quest is possible to complete.
+
: [[API IsQuestCompletable|IsQuestCompletable]]() - True if the displayed quest at a quest giver can be completed.
 
: [[API IsQuestIDValidSpellTarget|IsQuestIDValidSpellTarget]](<span class="apiarg">questID</span>)
 
: [[API IsQuestIDValidSpellTarget|IsQuestIDValidSpellTarget]](<span class="apiarg">questID</span>)
 
: [[API IsQuestItemHidden|IsQuestItemHidden]](<span class="apiarg">index</span>)
 
: [[API IsQuestItemHidden|IsQuestItemHidden]](<span class="apiarg">index</span>)
Line 3,674: Line 3,709:
 
: [[API IsTrackingHiddenQuests|IsTrackingHiddenQuests]]()
 
: [[API IsTrackingHiddenQuests|IsTrackingHiddenQuests]]()
 
: [[API PlayAutoAcceptQuestSound|PlayAutoAcceptQuestSound]]()
 
: [[API PlayAutoAcceptQuestSound|PlayAutoAcceptQuestSound]]()
: [[API QuestChooseRewardError|QuestChooseRewardError]]() - Throws an error when the quest choose reward method doesn't work.
+
: [[API QuestChooseRewardError|QuestChooseRewardError]]() - Throws an error when the quest reward method doesn't work.
 
: [[API QuestFlagsPVP|QuestFlagsPVP]]() - Determine if the quest will flag you you for PvP when accepted.
 
: [[API QuestFlagsPVP|QuestFlagsPVP]]() - Determine if the quest will flag you you for PvP when accepted.
 
: [[API QuestGetAutoAccept|QuestGetAutoAccept]]() - Returns whether the last-offered quest was automatically accepted.
 
: [[API QuestGetAutoAccept|QuestGetAutoAccept]]() - Returns whether the last-offered quest was automatically accepted.
 
: [[API QuestGetAutoLaunched|QuestGetAutoLaunched]]()
 
: [[API QuestGetAutoLaunched|QuestGetAutoLaunched]]()
 
: [[API QuestHasPOIInfo|QuestHasPOIInfo]](<span class="apiarg">questID</span>)
 
: [[API QuestHasPOIInfo|QuestHasPOIInfo]](<span class="apiarg">questID</span>)
: [[API QuestIsDaily|QuestIsDaily]]() - Returns whether the offered quest is a daily quest.
+
: [[API QuestIsDaily|QuestIsDaily]]() - True if the offered quest is a daily quest.
 
: [[API QuestIsFromAreaTrigger|QuestIsFromAreaTrigger]]()
 
: [[API QuestIsFromAreaTrigger|QuestIsFromAreaTrigger]]()
: [[API QuestIsWeekly|QuestIsWeekly]]() - Returns whether the offered quest is a weekly quest.
+
: [[API QuestIsWeekly|QuestIsWeekly]]() - True if the offered quest is a weekly quest.
 
: [[API QuestMapUpdateAllQuests|QuestMapUpdateAllQuests]]()
 
: [[API QuestMapUpdateAllQuests|QuestMapUpdateAllQuests]]()
 
: [[API QuestPOIGetIconInfo|QuestPOIGetIconInfo]](<span class="apiarg">questID</span>)
 
: [[API QuestPOIGetIconInfo|QuestPOIGetIconInfo]](<span class="apiarg">questID</span>)
Line 3,692: Line 3,727:
 
: [[API SortQuestSortTypes|SortQuestSortTypes]]()
 
: [[API SortQuestSortTypes|SortQuestSortTypes]]()
 
: [[API UnitQuestTrivialLevelRangeScaling|UnitQuestTrivialLevelRangeScaling]](<span class="apiarg">unit</span>) : <span class="apiret">levelRange</span>
 
: [[API UnitQuestTrivialLevelRangeScaling|UnitQuestTrivialLevelRangeScaling]](<span class="apiarg">unit</span>) : <span class="apiret">levelRange</span>
: <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.
   
==== Quest Log ====
+
====Quest Log====
: [[API C_QuestLog.AbandonQuest|C_QuestLog.AbandonQuest]]() - Abandon the specified quest.
+
: [[API C_QuestLog.AbandonQuest|C_QuestLog.AbandonQuest]]() - Abandons the quest specified by {{api|C_QuestLog.SetAbandonQuest}}.
: [[API C_QuestLog.AddQuestWatch|C_QuestLog.AddQuestWatch]](<span class="apiarg">questID [, watchType]</span>) : <span class="apiret">wasWatched</span> - Add a quest to the watch list.
+
: [[API C_QuestLog.AddQuestWatch|C_QuestLog.AddQuestWatch]](<span class="apiarg">questID [, watchType]</span>) : <span class="apiret">wasWatched</span> - Tracks a quest.
: [[API C_QuestLog.AddWorldQuestWatch|C_QuestLog.AddWorldQuestWatch]](<span class="apiarg">questID [, watchType]</span>) : <span class="apiret">wasWatched</span> - Adds a world quest to the watch list.
+
: [[API C_QuestLog.AddWorldQuestWatch|C_QuestLog.AddWorldQuestWatch]](<span class="apiarg">questID [, watchType]</span>) : <span class="apiret">wasWatched</span> - Tracks a world quest.
 
: [[API C_QuestLog.CanAbandonQuest|C_QuestLog.CanAbandonQuest]](<span class="apiarg">questID</span>) : <span class="apiret">canAbandon</span>
 
: [[API C_QuestLog.CanAbandonQuest|C_QuestLog.CanAbandonQuest]](<span class="apiarg">questID</span>) : <span class="apiret">canAbandon</span>
: [[API C_QuestLog.GetAbandonQuest|C_QuestLog.GetAbandonQuest]]() : <span class="apiret">questID</span> - Returns the ID of the quest being abandoned.
+
: [[API C_QuestLog.GetAbandonQuest|C_QuestLog.GetAbandonQuest]]() : <span class="apiret">questID</span> - Returns the quest specified by {{api|C_QuestLog.SetAbandonQuest}}.
 
: [[API C_QuestLog.GetAbandonQuestItems|C_QuestLog.GetAbandonQuestItems]]() : <span class="apiret">itemIDs</span>
 
: [[API C_QuestLog.GetAbandonQuestItems|C_QuestLog.GetAbandonQuestItems]]() : <span class="apiret">itemIDs</span>
 
: [[API C_QuestLog.GetActiveThreatMaps|C_QuestLog.GetActiveThreatMaps]]() : <span class="apiret">uiMapIDs</span>
 
: [[API C_QuestLog.GetActiveThreatMaps|C_QuestLog.GetActiveThreatMaps]]() : <span class="apiret">uiMapIDs</span>
: [[API C_QuestLog.GetAllCompletedQuestIDs|C_QuestLog.GetAllCompletedQuestIDs]]() : <span class="apiret">quests</span> - Returns all completed quests for a character.
+
: [[API C_QuestLog.GetAllCompletedQuestIDs|C_QuestLog.GetAllCompletedQuestIDs]]() : <span class="apiret">quests</span> - Returns all completed quests for the character.
 
: [[API C_QuestLog.GetBountiesForMapID|C_QuestLog.GetBountiesForMapID]](<span class="apiarg">uiMapID</span>) : <span class="apiret">bounties</span>
 
: [[API C_QuestLog.GetBountiesForMapID|C_QuestLog.GetBountiesForMapID]](<span class="apiarg">uiMapID</span>) : <span class="apiret">bounties</span>
 
: [[API C_QuestLog.GetBountySetInfoForMapID|C_QuestLog.GetBountySetInfoForMapID]](<span class="apiarg">uiMapID</span>) : <span class="apiret">displayLocation, lockQuestID, bountySetID</span>
 
: [[API C_QuestLog.GetBountySetInfoForMapID|C_QuestLog.GetBountySetInfoForMapID]](<span class="apiarg">uiMapID</span>) : <span class="apiret">displayLocation, lockQuestID, bountySetID</span>
 
: [[API C_QuestLog.GetDistanceSqToQuest|C_QuestLog.GetDistanceSqToQuest]](<span class="apiarg">questID</span>) : <span class="apiret">distanceSq, onContinent</span>
 
: [[API C_QuestLog.GetDistanceSqToQuest|C_QuestLog.GetDistanceSqToQuest]](<span class="apiarg">questID</span>) : <span class="apiret">distanceSq, onContinent</span>
 
: [[API C_QuestLog.GetInfo|C_QuestLog.GetInfo]](<span class="apiarg">questLogIndex</span>) : <span class="apiret">info</span> - Returns information about a quest in the player's quest log.
 
: [[API C_QuestLog.GetInfo|C_QuestLog.GetInfo]](<span class="apiarg">questLogIndex</span>) : <span class="apiret">info</span> - Returns information about a quest in the player's quest log.
: [[API C_QuestLog.GetLogIndexForQuestID|C_QuestLog.GetLogIndexForQuestID]](<span class="apiarg">questID</span>) : <span class="apiret">questLogIndex</span> - Returns the index of the specified questID in the quest log.
+
: [[API C_QuestLog.GetLogIndexForQuestID|C_QuestLog.GetLogIndexForQuestID]](<span class="apiarg">questID</span>) : <span class="apiret">questLogIndex</span> - Returns the quest log index for a quest ID.
 
: [[API C_QuestLog.GetMapForQuestPOIs|C_QuestLog.GetMapForQuestPOIs]]() : <span class="apiret">uiMapID</span>
 
: [[API C_QuestLog.GetMapForQuestPOIs|C_QuestLog.GetMapForQuestPOIs]]() : <span class="apiret">uiMapID</span>
 
: [[API C_QuestLog.GetMaxNumQuests|C_QuestLog.GetMaxNumQuests]]() : <span class="apiret">maxNumQuests</span> - This is the maximum number of quests a player can be on, including hidden quests, world quests, emissaries etc
 
: [[API C_QuestLog.GetMaxNumQuests|C_QuestLog.GetMaxNumQuests]]() : <span class="apiret">maxNumQuests</span> - This is the maximum number of quests a player can be on, including hidden quests, world quests, emissaries etc
Line 3,714: Line 3,749:
 
: [[API C_QuestLog.GetNumQuestLogEntries|C_QuestLog.GetNumQuestLogEntries]]() : <span class="apiret">numShownEntries, numQuests</span> - Returns the number of entries in the quest log.
 
: [[API C_QuestLog.GetNumQuestLogEntries|C_QuestLog.GetNumQuestLogEntries]]() : <span class="apiret">numShownEntries, numQuests</span> - Returns the number of entries in the quest log.
 
: [[API C_QuestLog.GetNumQuestObjectives|C_QuestLog.GetNumQuestObjectives]](<span class="apiarg">questID</span>) : <span class="apiret">leaderboardCount</span>
 
: [[API C_QuestLog.GetNumQuestObjectives|C_QuestLog.GetNumQuestObjectives]](<span class="apiarg">questID</span>) : <span class="apiret">leaderboardCount</span>
: [[API C_QuestLog.GetNumQuestWatches|C_QuestLog.GetNumQuestWatches]]() : <span class="apiret">numQuestWatches</span> - Returns the number of quest watches active.
+
: [[API C_QuestLog.GetNumQuestWatches|C_QuestLog.GetNumQuestWatches]]() : <span class="apiret">numQuestWatches</span> - Returns the number of tracked quests.
 
: [[API C_QuestLog.GetNumWorldQuestWatches|C_QuestLog.GetNumWorldQuestWatches]]() : <span class="apiret">numQuestWatches</span>
 
: [[API C_QuestLog.GetNumWorldQuestWatches|C_QuestLog.GetNumWorldQuestWatches]]() : <span class="apiret">numQuestWatches</span>
 
: [[API C_QuestLog.GetQuestAdditionalHighlights|C_QuestLog.GetQuestAdditionalHighlights]](<span class="apiarg">questID</span>) : <span class="apiret">uiMapID, worldQuests, worldQuestsElite, dungeons, treasures</span>
 
: [[API C_QuestLog.GetQuestAdditionalHighlights|C_QuestLog.GetQuestAdditionalHighlights]](<span class="apiarg">questID</span>) : <span class="apiret">uiMapID, worldQuests, worldQuestsElite, dungeons, treasures</span>
Line 3,723: Line 3,758:
 
: [[API C_QuestLog.GetQuestIDForWorldQuestWatchIndex|C_QuestLog.GetQuestIDForWorldQuestWatchIndex]](<span class="apiarg">questWatchIndex</span>) : <span class="apiret">questID</span>
 
: [[API C_QuestLog.GetQuestIDForWorldQuestWatchIndex|C_QuestLog.GetQuestIDForWorldQuestWatchIndex]](<span class="apiarg">questWatchIndex</span>) : <span class="apiret">questID</span>
 
: [[API C_QuestLog.GetQuestLogPortraitGiver|C_QuestLog.GetQuestLogPortraitGiver]](<span class="apiarg">[questLogIndex]</span>) : <span class="apiret">portraitGiver, portraitGiverText, portraitGiverName, portraitGiverMount, ...</span>
 
: [[API C_QuestLog.GetQuestLogPortraitGiver|C_QuestLog.GetQuestLogPortraitGiver]](<span class="apiarg">[questLogIndex]</span>) : <span class="apiret">portraitGiver, portraitGiverText, portraitGiverName, portraitGiverMount, ...</span>
: [[API C_QuestLog.GetQuestObjectives|C_QuestLog.GetQuestObjectives]](<span class="apiarg">questID</span>) : <span class="apiret">objectives</span> - Returns information about objective status for a quest.
+
: [[API C_QuestLog.GetQuestObjectives|C_QuestLog.GetQuestObjectives]](<span class="apiarg">questID</span>) : <span class="apiret">objectives</span> - Returns info for the objectives of a quest.
 
: [[API C_QuestLog.GetQuestsOnMap|C_QuestLog.GetQuestsOnMap]](<span class="apiarg">uiMapID</span>) : <span class="apiret">quests</span>
 
: [[API C_QuestLog.GetQuestsOnMap|C_QuestLog.GetQuestsOnMap]](<span class="apiarg">uiMapID</span>) : <span class="apiret">quests</span>
: [[API C_QuestLog.GetQuestTagInfo|C_QuestLog.GetQuestTagInfo]](<span class="apiarg">questID</span>) : <span class="apiret">info</span> - Returns tag information about the specified quest.
+
: [[API C_QuestLog.GetQuestTagInfo|C_QuestLog.GetQuestTagInfo]](<span class="apiarg">questID</span>) : <span class="apiret">info</span> - Returns metadata for a quest.
 
: [[API C_QuestLog.GetQuestType|C_QuestLog.GetQuestType]](<span class="apiarg">questID</span>) : <span class="apiret">questType</span>
 
: [[API C_QuestLog.GetQuestType|C_QuestLog.GetQuestType]](<span class="apiarg">questID</span>) : <span class="apiret">questType</span>
 
: [[API C_QuestLog.GetQuestWatchType|C_QuestLog.GetQuestWatchType]](<span class="apiarg">questID</span>) : <span class="apiret">watchType</span>
 
: [[API C_QuestLog.GetQuestWatchType|C_QuestLog.GetQuestWatchType]](<span class="apiarg">questID</span>) : <span class="apiret">watchType</span>
: [[API C_QuestLog.GetRequiredMoney|C_QuestLog.GetRequiredMoney]](<span class="apiarg">[questID]</span>) : <span class="apiret">requiredMoney</span> - Returns amount of money required for quest completion from quest log.
+
: [[API C_QuestLog.GetRequiredMoney|C_QuestLog.GetRequiredMoney]](<span class="apiarg">[questID]</span>) : <span class="apiret">requiredMoney</span> - Returns the amount of money required for quest completion.
: [[API C_QuestLog.GetSelectedQuest|C_QuestLog.GetSelectedQuest]]() : <span class="apiret">questID</span> - Returns a number associated with the QuestLogSelection index.
+
: [[API C_QuestLog.GetSelectedQuest|C_QuestLog.GetSelectedQuest]]() : <span class="apiret">questID</span> - Returns the quest specified by {{api|C_QuestLog.SetSelectedQuest}}.
: [[API C_QuestLog.GetSuggestedGroupSize|C_QuestLog.GetSuggestedGroupSize]](<span class="apiarg">questID</span>) : <span class="apiret">suggestedGroupSize</span> - Returns suggested number of players for quest selected currently in log or 0 if there's no suggestion.
+
: [[API C_QuestLog.GetSuggestedGroupSize|C_QuestLog.GetSuggestedGroupSize]](<span class="apiarg">questID</span>) : <span class="apiret">suggestedGroupSize</span> - Returns the suggested number of players for a quest.
 
: [[API C_QuestLog.GetTimeAllowed|C_QuestLog.GetTimeAllowed]](<span class="apiarg">questID</span>) : <span class="apiret">totalTime, elapsedTime</span> - Returns the time available to complete a quest.
 
: [[API C_QuestLog.GetTimeAllowed|C_QuestLog.GetTimeAllowed]](<span class="apiarg">questID</span>) : <span class="apiret">totalTime, elapsedTime</span> - Returns the time available to complete a quest.
 
: [[API C_QuestLog.GetTitleForLogIndex|C_QuestLog.GetTitleForLogIndex]](<span class="apiarg">questLogIndex</span>) : <span class="apiret">title</span>
 
: [[API C_QuestLog.GetTitleForLogIndex|C_QuestLog.GetTitleForLogIndex]](<span class="apiarg">questLogIndex</span>) : <span class="apiret">title</span>
Line 3,742: Line 3,777:
 
: [[API C_QuestLog.IsOnMap|C_QuestLog.IsOnMap]](<span class="apiarg">questID</span>) : <span class="apiret">onMap, hasLocalPOI</span>
 
: [[API C_QuestLog.IsOnMap|C_QuestLog.IsOnMap]](<span class="apiarg">questID</span>) : <span class="apiret">onMap, hasLocalPOI</span>
 
: [[API C_QuestLog.IsOnQuest|C_QuestLog.IsOnQuest]](<span class="apiarg">questID</span>) : <span class="apiret">isOnQuest</span>
 
: [[API C_QuestLog.IsOnQuest|C_QuestLog.IsOnQuest]](<span class="apiarg">questID</span>) : <span class="apiret">isOnQuest</span>
: [[API C_QuestLog.IsPushableQuest|C_QuestLog.IsPushableQuest]](<span class="apiarg">questID</span>) : <span class="apiret">isPushable</span> - Returns true if the currently loaded quest in the quest window can be shared.
+
: [[API C_QuestLog.IsPushableQuest|C_QuestLog.IsPushableQuest]](<span class="apiarg">questID</span>) : <span class="apiret">isPushable</span> - True if the quest can be shared with other players.
 
: [[API C_QuestLog.IsQuestBounty|C_QuestLog.IsQuestBounty]](<span class="apiarg">questID</span>) : <span class="apiret">isBounty</span>
 
: [[API C_QuestLog.IsQuestBounty|C_QuestLog.IsQuestBounty]](<span class="apiarg">questID</span>) : <span class="apiret">isBounty</span>
 
: [[API C_QuestLog.IsQuestCalling|C_QuestLog.IsQuestCalling]](<span class="apiarg">questID</span>) : <span class="apiret">isCalling</span>
 
: [[API C_QuestLog.IsQuestCalling|C_QuestLog.IsQuestCalling]](<span class="apiarg">questID</span>) : <span class="apiret">isCalling</span>
Line 3,751: Line 3,786:
 
: [[API C_QuestLog.IsRepeatableQuest|C_QuestLog.IsRepeatableQuest]](<span class="apiarg">questID</span>) : <span class="apiret">isRepeatable</span>
 
: [[API C_QuestLog.IsRepeatableQuest|C_QuestLog.IsRepeatableQuest]](<span class="apiarg">questID</span>) : <span class="apiret">isRepeatable</span>
 
: [[API C_QuestLog.IsThreatQuest|C_QuestLog.IsThreatQuest]](<span class="apiarg">questID</span>) : <span class="apiret">isThreat</span>
 
: [[API C_QuestLog.IsThreatQuest|C_QuestLog.IsThreatQuest]](<span class="apiarg">questID</span>) : <span class="apiret">isThreat</span>
: [[API C_QuestLog.IsUnitOnQuest|C_QuestLog.IsUnitOnQuest]](<span class="apiarg">unit, questID</span>) : <span class="apiret">isOnQuest</span> - Determine if the specified unit is on the given quest.
+
: [[API C_QuestLog.IsUnitOnQuest|C_QuestLog.IsUnitOnQuest]](<span class="apiarg">unit, questID</span>) : <span class="apiret">isOnQuest</span> - True if the unit is on the specified quest.
 
: [[API C_QuestLog.QuestCanHaveWarModeBonus|C_QuestLog.QuestCanHaveWarModeBonus]](<span class="apiarg">questID</span>) : <span class="apiret">hasBonus</span>
 
: [[API C_QuestLog.QuestCanHaveWarModeBonus|C_QuestLog.QuestCanHaveWarModeBonus]](<span class="apiarg">questID</span>) : <span class="apiret">hasBonus</span>
 
: [[API C_QuestLog.QuestHasWarModeBonus|C_QuestLog.QuestHasWarModeBonus]](<span class="apiarg">questID</span>) : <span class="apiret">hasBonus</span>
 
: [[API C_QuestLog.QuestHasWarModeBonus|C_QuestLog.QuestHasWarModeBonus]](<span class="apiarg">questID</span>) : <span class="apiret">hasBonus</span>
 
: [[API C_QuestLog.ReadyForTurnIn|C_QuestLog.ReadyForTurnIn]](<span class="apiarg">questID</span>) : <span class="apiret">readyForTurnIn</span>
 
: [[API C_QuestLog.ReadyForTurnIn|C_QuestLog.ReadyForTurnIn]](<span class="apiarg">questID</span>) : <span class="apiret">readyForTurnIn</span>
: [[API C_QuestLog.RemoveQuestWatch|C_QuestLog.RemoveQuestWatch]](<span class="apiarg">questID</span>) : <span class="apiret">wasRemoved</span> - Removes a quest watch.
+
: [[API C_QuestLog.RemoveQuestWatch|C_QuestLog.RemoveQuestWatch]](<span class="apiarg">questID</span>) : <span class="apiret">wasRemoved</span> - Untracks a quest.
: [[API C_QuestLog.RemoveWorldQuestWatch|C_QuestLog.RemoveWorldQuestWatch]](<span class="apiarg">questID</span>) : <span class="apiret">wasRemoved</span> - Removes a world quest from the watch.
+
: [[API C_QuestLog.RemoveWorldQuestWatch|C_QuestLog.RemoveWorldQuestWatch]](<span class="apiarg">questID</span>) : <span class="apiret">wasRemoved</span> - Untracks a world quest.
 
: [[API C_QuestLog.RequestLoadQuestByID|C_QuestLog.RequestLoadQuestByID]](<span class="apiarg">questID</span>)
 
: [[API C_QuestLog.RequestLoadQuestByID|C_QuestLog.RequestLoadQuestByID]](<span class="apiarg">questID</span>)
: [[API C_QuestLog.SetAbandonQuest|C_QuestLog.SetAbandonQuest]]() - Called before [[API AbandonQuest|AbandonQuest]].
+
: [[API C_QuestLog.SetAbandonQuest|C_QuestLog.SetAbandonQuest]]() - Sets the selected quest to be abandoned.
 
: [[API C_QuestLog.SetMapForQuestPOIs|C_QuestLog.SetMapForQuestPOIs]](<span class="apiarg">uiMapID</span>)
 
: [[API C_QuestLog.SetMapForQuestPOIs|C_QuestLog.SetMapForQuestPOIs]](<span class="apiarg">uiMapID</span>)
: [[API C_QuestLog.SetSelectedQuest|C_QuestLog.SetSelectedQuest]](<span class="apiarg">questID</span>) - Sets the selected quest, required for most GetQuest functions.
+
: [[API C_QuestLog.SetSelectedQuest|C_QuestLog.SetSelectedQuest]](<span class="apiarg">questID</span>) - Selects a quest in the quest log.
 
: [[API C_QuestLog.ShouldDisplayTimeRemaining|C_QuestLog.ShouldDisplayTimeRemaining]](<span class="apiarg">questID</span>) : <span class="apiret">displayTimeRemaining</span>
 
: [[API C_QuestLog.ShouldDisplayTimeRemaining|C_QuestLog.ShouldDisplayTimeRemaining]](<span class="apiarg">questID</span>) : <span class="apiret">displayTimeRemaining</span>
 
: [[API C_QuestLog.ShouldShowQuestRewards|C_QuestLog.ShouldShowQuestRewards]](<span class="apiarg">questID</span>) : <span class="apiret">shouldShow</span>
 
: [[API C_QuestLog.ShouldShowQuestRewards|C_QuestLog.ShouldShowQuestRewards]](<span class="apiarg">questID</span>) : <span class="apiret">shouldShow</span>
Line 3,768: Line 3,803:
 
: [[API GetNumQuestLogRewardCurrencies|GetNumQuestLogRewardCurrencies]]()
 
: [[API GetNumQuestLogRewardCurrencies|GetNumQuestLogRewardCurrencies]]()
 
: [[API GetNumQuestLogRewardFactions|GetNumQuestLogRewardFactions]]()
 
: [[API GetNumQuestLogRewardFactions|GetNumQuestLogRewardFactions]]()
: [[API GetNumQuestLogRewards|GetNumQuestLogRewards]]() - Returns the count of the rewards for a particular quest. (7.0.3)
+
: [[API GetNumQuestLogRewards|GetNumQuestLogRewards]]() - Returns the number of unconditional rewards for the current quest in the quest log.
 
: [[API GetNumQuestLogRewardSpells|GetNumQuestLogRewardSpells]]() - Returns the number of spell rewards for the current selected quest.
 
: [[API GetNumQuestLogRewardSpells|GetNumQuestLogRewardSpells]]() - Returns the number of spell rewards for the current selected quest.
 
: [[API GetNumTreasurePickerItems|GetNumTreasurePickerItems]]()
 
: [[API GetNumTreasurePickerItems|GetNumTreasurePickerItems]]()
Line 3,776: Line 3,811:
 
: [[API GetQuestLogItemDrop|GetQuestLogItemDrop]](<span class="apiarg">index</span>)
 
: [[API GetQuestLogItemDrop|GetQuestLogItemDrop]](<span class="apiarg">index</span>)
 
: [[API GetQuestLogItemLink|GetQuestLogItemLink]](<span class="apiarg">type, index</span>) - Returns item link for selected quest reward/choice/required item from quest log.
 
: [[API GetQuestLogItemLink|GetQuestLogItemLink]](<span class="apiarg">type, index</span>) - Returns item link for selected quest reward/choice/required item from quest log.
: [[API GetQuestLogLeaderBoard|GetQuestLogLeaderBoard]](<span class="apiarg">ldrIndex [, questIndex]</span>) - Gets information about the objectives for a quest.
+
: [[API GetQuestLogLeaderBoard|GetQuestLogLeaderBoard]](<span class="apiarg">ldrIndex [, questIndex]</span>) - Returns info for a quest objective in the quest log.
 
: [[API GetQuestLogPortraitTurnIn|GetQuestLogPortraitTurnIn]]()
 
: [[API GetQuestLogPortraitTurnIn|GetQuestLogPortraitTurnIn]]()
: [[API GetQuestLogQuestText|GetQuestLogQuestText]]() - Returns the description and objectives required for the specified quest.
+
: [[API GetQuestLogQuestText|GetQuestLogQuestText]]() - Returns the description and objective text in the quest log.
 
: [[API GetQuestLogQuestType|GetQuestLogQuestType]]()
 
: [[API GetQuestLogQuestType|GetQuestLogQuestType]]()
 
: [[API GetQuestLogRewardArtifactXP|GetQuestLogRewardArtifactXP]]()
 
: [[API GetQuestLogRewardArtifactXP|GetQuestLogRewardArtifactXP]]()
Line 3,784: Line 3,819:
 
: [[API GetQuestLogRewardFactionInfo|GetQuestLogRewardFactionInfo]](<span class="apiarg">questIndex</span>)
 
: [[API GetQuestLogRewardFactionInfo|GetQuestLogRewardFactionInfo]](<span class="apiarg">questIndex</span>)
 
: [[API GetQuestLogRewardHonor|GetQuestLogRewardHonor]]()
 
: [[API GetQuestLogRewardHonor|GetQuestLogRewardHonor]]()
: [[API GetQuestLogRewardInfo|GetQuestLogRewardInfo]]() - Returns a pile of reward item info from the quest log.
+
: [[API GetQuestLogRewardInfo|GetQuestLogRewardInfo]]() - Returns info for an unconditional quest reward item in the quest log.
: [[API GetQuestLogRewardMoney|GetQuestLogRewardMoney]]() - Returns a number representing the amount of copper returned by a particular quest.
+
: [[API GetQuestLogRewardMoney|GetQuestLogRewardMoney]]() - Returns the amount of money rewarded for a quest.
 
: [[API GetQuestLogRewardSkillPoints|GetQuestLogRewardSkillPoints]]()
 
: [[API GetQuestLogRewardSkillPoints|GetQuestLogRewardSkillPoints]]()
: [[API GetQuestLogRewardSpell|GetQuestLogRewardSpell]]() - Returns name and texture of spell awarded for quest completion from quest log.
+
: [[API GetQuestLogRewardSpell|GetQuestLogRewardSpell]]() - Returns the spell reward for a quest.
 
: [[API GetQuestLogRewardTitle|GetQuestLogRewardTitle]]()
 
: [[API GetQuestLogRewardTitle|GetQuestLogRewardTitle]]()
 
: [[API GetQuestLogRewardXP|GetQuestLogRewardXP]]()
 
: [[API GetQuestLogRewardXP|GetQuestLogRewardXP]]()
Line 3,793: Line 3,828:
 
: [[API GetQuestLogSpecialItemInfo|GetQuestLogSpecialItemInfo]](<span class="apiarg">index</span>)
 
: [[API GetQuestLogSpecialItemInfo|GetQuestLogSpecialItemInfo]](<span class="apiarg">index</span>)
 
: [[API GetQuestLogSpellLink|GetQuestLogSpellLink]](<span class="apiarg">rewardSpellIndex</span>)
 
: [[API GetQuestLogSpellLink|GetQuestLogSpellLink]](<span class="apiarg">rewardSpellIndex</span>)
: [[API GetQuestLogTimeLeft|GetQuestLogTimeLeft]]() - Returns the seconds remaining on the current quest timer.
+
: [[API GetQuestLogTimeLeft|GetQuestLogTimeLeft]]() - Returns the time left in seconds for the current quest.
 
: [[API GetTreasurePickerItemInfo|GetTreasurePickerItemInfo]](<span class="apiarg">index [, questID]</span>)
 
: [[API GetTreasurePickerItemInfo|GetTreasurePickerItemInfo]](<span class="apiarg">index [, questID]</span>)
 
: [[API IsQuestLogSpecialItemInRange|IsQuestLogSpecialItemInRange]](<span class="apiarg">index [, target]</span>)
 
: [[API IsQuestLogSpecialItemInRange|IsQuestLogSpecialItemInRange]](<span class="apiarg">index [, target]</span>)
 
: [[API ProcessQuestLogRewardFactions|ProcessQuestLogRewardFactions]]()
 
: [[API ProcessQuestLogRewardFactions|ProcessQuestLogRewardFactions]]()
: [[API QuestLogPushQuest|QuestLogPushQuest]]() - Initiates the sharing of the currently viewed quest in the quest log.
+
: [[API QuestLogPushQuest|QuestLogPushQuest]]() - Shares the current quest in the quest log with other players.
 
: [[API QuestLogRewardHasTreasurePicker|QuestLogRewardHasTreasurePicker]]()
 
: [[API QuestLogRewardHasTreasurePicker|QuestLogRewardHasTreasurePicker]]()
 
: [[API QuestLogShouldShowPortrait|QuestLogShouldShowPortrait]]()
 
: [[API QuestLogShouldShowPortrait|QuestLogShouldShowPortrait]]()
 
: [[API UseQuestLogSpecialItem|UseQuestLogSpecialItem]](<span class="apiarg">index</span>)
 
: [[API UseQuestLogSpecialItem|UseQuestLogSpecialItem]](<span class="apiarg">index</span>)
   
==== Gossip ====
+
====Gossip====
 
Gossip refers to interaction with an NPC.
 
Gossip refers to interaction with an NPC.
: [[API C_GossipInfo.CloseGossip|C_GossipInfo.CloseGossip]]() - Dismiss the gossip window.
+
: [[API C_GossipInfo.CloseGossip|C_GossipInfo.CloseGossip]]() - Closes the gossip window.
: [[API C_GossipInfo.ForceGossip|C_GossipInfo.ForceGossip]]() : <span class="apiret">forceGossip</span> - Returns whether the gossip text ''must'' be displayed.
+
: [[API C_GossipInfo.ForceGossip|C_GossipInfo.ForceGossip]]() : <span class="apiret">forceGossip</span> - True if gossip text must be displayed. For example making this return true shows the Banker gossip.
: [[API C_GossipInfo.GetActiveQuests|C_GossipInfo.GetActiveQuests]]() : <span class="apiret">info</span> - Retrieves a list of quests which can be turned in on the NPC you are talking to.
+
: [[API C_GossipInfo.GetActiveQuests|C_GossipInfo.GetActiveQuests]]() : <span class="apiret">info</span> - Returns the quests which can be turned in at a quest giver.
: [[API C_GossipInfo.GetAvailableQuests|C_GossipInfo.GetAvailableQuests]]() : <span class="apiret">info</span> - Retrieves a list of the available quests on the NPC you are talking to.
+
: [[API C_GossipInfo.GetAvailableQuests|C_GossipInfo.GetAvailableQuests]]() : <span class="apiret">info</span> - Returns the available quests at a quest giver.
 
: [[API C_GossipInfo.GetCompletedOptionDescriptionString|C_GossipInfo.GetCompletedOptionDescriptionString]]() : <span class="apiret">description</span>
 
: [[API C_GossipInfo.GetCompletedOptionDescriptionString|C_GossipInfo.GetCompletedOptionDescriptionString]]() : <span class="apiret">description</span>
 
: [[API C_GossipInfo.GetCustomGossipDescriptionString|C_GossipInfo.GetCustomGossipDescriptionString]]() : <span class="apiret">description</span>
 
: [[API C_GossipInfo.GetCustomGossipDescriptionString|C_GossipInfo.GetCustomGossipDescriptionString]]() : <span class="apiret">description</span>
Line 3,813: Line 3,848:
 
: [[API C_GossipInfo.GetNumAvailableQuests|C_GossipInfo.GetNumAvailableQuests]]() : <span class="apiret">numQuests</span> - Returns the number of quests (that you are not already on) offered by this NPC.
 
: [[API C_GossipInfo.GetNumAvailableQuests|C_GossipInfo.GetNumAvailableQuests]]() : <span class="apiret">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 class="apiret">numOptions</span> - Returns the number of conversation options available with this NPC.
 
: [[API C_GossipInfo.GetNumOptions|C_GossipInfo.GetNumOptions]]() : <span class="apiret">numOptions</span> - Returns the number of conversation options available with this NPC.
: [[API C_GossipInfo.GetOptions|C_GossipInfo.GetOptions]]() : <span class="apiret">info</span> - Retrieves a list of the available gossip items on the NPC you are talking to.
+
: [[API C_GossipInfo.GetOptions|C_GossipInfo.GetOptions]]() : <span class="apiret">info</span> - Returns the available gossip options at a quest giver.
: [[API C_GossipInfo.GetPoiForUiMapID|C_GossipInfo.GetPoiForUiMapID]](<span class="apiarg">uiMapID</span>) : <span class="apiret">gossipPoiID</span> - Returns gossip poi for a map.
+
: [[API C_GossipInfo.GetPoiForUiMapID|C_GossipInfo.GetPoiForUiMapID]](<span class="apiarg">uiMapID</span>) : <span class="apiret">gossipPoiID</span> - Returns any gossip point of interest on the map.
: [[API C_GossipInfo.GetPoiInfo|C_GossipInfo.GetPoiInfo]](<span class="apiarg">uiMapID, gossipPoiID</span>) : <span class="apiret">gossipPoiInfo</span> - Returns gossip poi info.
+
: [[API C_GossipInfo.GetPoiInfo|C_GossipInfo.GetPoiInfo]](<span class="apiarg">uiMapID, gossipPoiID</span>) : <span class="apiret">gossipPoiInfo</span> - Returns info for a gossip point of interest (e.g. the red flags when asking city guards for directions).
: [[API C_GossipInfo.GetText|C_GossipInfo.GetText]]() : <span class="apiret">gossipText</span> - Retrieves the gossip text.
+
: [[API C_GossipInfo.GetText|C_GossipInfo.GetText]]() : <span class="apiret">gossipText</span> - Returns the gossip text.
 
: [[API C_GossipInfo.RefreshOptions|C_GossipInfo.RefreshOptions]]()
 
: [[API C_GossipInfo.RefreshOptions|C_GossipInfo.RefreshOptions]]()
: [[API C_GossipInfo.SelectActiveQuest|C_GossipInfo.SelectActiveQuest]](<span class="apiarg">index</span>) - Selects an active quest.
+
: [[API C_GossipInfo.SelectActiveQuest|C_GossipInfo.SelectActiveQuest]](<span class="apiarg">index</span>) - Selects an active quest from the gossip window.
: [[API C_GossipInfo.SelectAvailableQuest|C_GossipInfo.SelectAvailableQuest]](<span class="apiarg">index</span>) - Selects an available quest.
+
: [[API C_GossipInfo.SelectAvailableQuest|C_GossipInfo.SelectAvailableQuest]](<span class="apiarg">index</span>) - Selects an available quest from the gossip window.
 
: [[API C_GossipInfo.SelectOption|C_GossipInfo.SelectOption]](<span class="apiarg">index [, text, confirmed]</span>) - Selects a gossip (conversation) option.
 
: [[API C_GossipInfo.SelectOption|C_GossipInfo.SelectOption]](<span class="apiarg">index [, text, confirmed]</span>) - Selects a gossip (conversation) option.
: [[API AcceptQuest|AcceptQuest]]() - Accept the specified quest.
+
: [[API AcceptQuest|AcceptQuest]]() - Accepts the currently offered quest.
 
: [[API CloseQuest|CloseQuest]]() - Closes the shown quest.
 
: [[API CloseQuest|CloseQuest]]() - Closes the shown quest.
: [[API CompleteQuest|CompleteQuest]]() - Complete the specified quest.
+
: [[API CompleteQuest|CompleteQuest]]() - Continues the quest dialog to the reward selection step.
 
: [[API DeclineQuest|DeclineQuest]]() - Declines the currently offered quest.
 
: [[API DeclineQuest|DeclineQuest]]() - Declines the currently offered quest.
 
: [[API GetActiveLevel|GetActiveLevel]](<span class="apiarg">index</span>) - Gets the level of an active quest (only available after QUEST_GREETING event).
 
: [[API GetActiveLevel|GetActiveLevel]](<span class="apiarg">index</span>) - Gets the level of an active quest (only available after QUEST_GREETING event).
Line 3,829: Line 3,864:
 
: [[API GetActiveTitle|GetActiveTitle]](<span class="apiarg">index</span>) - Gets the title of an active quest (only available after QUEST_GREETING event).
 
: [[API GetActiveTitle|GetActiveTitle]](<span class="apiarg">index</span>) - Gets the title of an active quest (only available after QUEST_GREETING event).
 
: [[API GetAvailableLevel|GetAvailableLevel]](<span class="apiarg">index</span>) - Gets the level of an available quest (only available after QUEST_GREETING event).
 
: [[API GetAvailableLevel|GetAvailableLevel]](<span class="apiarg">index</span>) - Gets the level of an available quest (only available after QUEST_GREETING event).
: [[API GetAvailableQuestInfo|GetAvailableQuestInfo]](<span class="apiarg">index</span>) - Returns metadata (quest type) about an available quest.
+
: [[API GetAvailableQuestInfo|GetAvailableQuestInfo]](<span class="apiarg">index</span>) - Returns info for an available quest.
 
: [[API GetAvailableTitle|GetAvailableTitle]](<span class="apiarg">index</span>) - Gets the title of an available quest (only available after QUEST_GREETING event).
 
: [[API GetAvailableTitle|GetAvailableTitle]](<span class="apiarg">index</span>) - Gets the title of an available quest (only available after QUEST_GREETING event).
 
: [[API GetGreetingText|GetGreetingText]]()
 
: [[API GetGreetingText|GetGreetingText]]()
: [[API GetNumActiveQuests|GetNumActiveQuests]]() - Gets the number of currently active quests from this NPC (only available after QUEST_GREETING event).
+
: [[API GetNumActiveQuests|GetNumActiveQuests]]() - Returns the number of quests which can be turned in at a non-gossip quest giver.
: [[API GetNumAvailableQuests|GetNumAvailableQuests]]() - Gets the number of currently available quests from this NPC (only available after QUEST_GREETING event).
+
: [[API GetNumAvailableQuests|GetNumAvailableQuests]]() - Returns the number of available quests at a non-gossip quest giver.
: [[API GetNumQuestRewards|GetNumQuestRewards]]() - Returns number of reward items (those that you always get) for quest currently in gossip window.
+
: [[API GetNumQuestRewards|GetNumQuestRewards]]() - Returns the number of unconditional rewards at a quest giver.
 
: [[API GetNumRewardCurrencies|GetNumRewardCurrencies]]()
 
: [[API GetNumRewardCurrencies|GetNumRewardCurrencies]]()
 
: [[API GetNumRewardSpells|GetNumRewardSpells]]()
 
: [[API GetNumRewardSpells|GetNumRewardSpells]]()
 
: [[API GetObjectiveText|GetObjectiveText]]() - Gets the objective of the current quest.
 
: [[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 GetProgressText|GetProgressText]]() - Returns quest progress text at a quest giver.
: [[API GetQuestID|GetQuestID]]() - Returns the ID of the quest most recently displayed in a gossip frame, even after that frame is closed.
+
: [[API GetQuestID|GetQuestID]]() - Returns the ID of the displayed quest at a quest giver.
: [[API GetQuestItemInfo|GetQuestItemInfo]]() - Returns basic information about the reward/choice/required item for quest currently in gossip window.
+
: [[API GetQuestItemInfo|GetQuestItemInfo]]() - Returns info for a required/reward/choice quest item.
 
: [[API GetQuestItemInfoLootType|GetQuestItemInfoLootType]](<span class="apiarg">type, index</span>)
 
: [[API GetQuestItemInfoLootType|GetQuestItemInfoLootType]](<span class="apiarg">type, index</span>)
: [[API GetQuestItemLink|GetQuestItemLink]](<span class="apiarg">type, index</span>) - Returns an [[itemLink]] for a selected quest reward/choice/required item for quest currently in gossip window.
+
: [[API GetQuestItemLink|GetQuestItemLink]](<span class="apiarg">type, index</span>) - Returns the item link for a required/reward/choice quest item.
 
: [[API GetQuestMoneyToGet|GetQuestMoneyToGet]]() - Returns amount of money required for quest currently displayed in gossip.
 
: [[API GetQuestMoneyToGet|GetQuestMoneyToGet]]() - Returns amount of money required for quest currently displayed in gossip.
 
: [[API GetQuestPortraitGiver|GetQuestPortraitGiver]]()
 
: [[API GetQuestPortraitGiver|GetQuestPortraitGiver]]()
Line 3,853: Line 3,888:
 
: [[API GetRewardSkillLineID|GetRewardSkillLineID]]()
 
: [[API GetRewardSkillLineID|GetRewardSkillLineID]]()
 
: [[API GetRewardSkillPoints|GetRewardSkillPoints]]()
 
: [[API GetRewardSkillPoints|GetRewardSkillPoints]]()
: [[API GetRewardSpell|GetRewardSpell]]() - Returns name and texture of spell awarded for quest completion for quest currently in gossip window.
+
: [[API GetRewardSpell|GetRewardSpell]]() - Returns the spell reward for the quest in the gossip window.
 
: [[API GetRewardText|GetRewardText]]() - Returns quest reward text, displayed by the NPC before the player hits "Complete Quest".
 
: [[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 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 GetRewardXP|GetRewardXP]]() - Returns the [[experience]] reward for the quest in the gossip window.
: [[API GetTitleText|GetTitleText]]() - Retrieves the title of the quest while talking to the NPC about it.
+
: [[API GetTitleText|GetTitleText]]() - Returns the name of the quest at the quest giver.
 
: [[API IsActiveQuestLegendary|IsActiveQuestLegendary]](<span class="apiarg">index</span>)
 
: [[API IsActiveQuestLegendary|IsActiveQuestLegendary]](<span class="apiarg">index</span>)
 
: [[API IsActiveQuestTrivial|IsActiveQuestTrivial]](<span class="apiarg">index</span>)
 
: [[API IsActiveQuestTrivial|IsActiveQuestTrivial]](<span class="apiarg">index</span>)
Line 3,864: Line 3,899:
 
: [[API SelectAvailableQuest|SelectAvailableQuest]]() - Selects an available 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====
 
Relates to multiple quest choices, for instance at the [[Hero's Call Board]] and [[Warchief's Command Board]].
 
Relates to multiple quest choices, for instance at the [[Hero's Call Board]] and [[Warchief's Command Board]].
 
: [[API C_PlayerChoice.GetCurrentPlayerChoiceInfo|C_PlayerChoice.GetCurrentPlayerChoiceInfo]]() : <span class="apiret">choiceInfo</span>
 
: [[API C_PlayerChoice.GetCurrentPlayerChoiceInfo|C_PlayerChoice.GetCurrentPlayerChoiceInfo]]() : <span class="apiret">choiceInfo</span>
Line 3,873: Line 3,908:
 
: [[API C_PlayerChoice.RequestRerollPlayerChoice|C_PlayerChoice.RequestRerollPlayerChoice]]()
 
: [[API C_PlayerChoice.RequestRerollPlayerChoice|C_PlayerChoice.RequestRerollPlayerChoice]]()
 
: [[API C_PlayerChoice.SendPlayerChoiceResponse|C_PlayerChoice.SendPlayerChoiceResponse]](<span class="apiarg">responseID</span>)
 
: [[API C_PlayerChoice.SendPlayerChoiceResponse|C_PlayerChoice.SendPlayerChoiceResponse]](<span class="apiarg">responseID</span>)
: [[API GetNumQuestChoices|GetNumQuestChoices]]() - Returns the number of rewards available for choice for quest currently in gossip window.
+
: [[API GetNumQuestChoices|GetNumQuestChoices]]() - Returns the number of available rewards for the current quest.
 
: [[API GetQuestLogChoiceInfo|GetQuestLogChoiceInfo]]() - Returns a bunch of data about a quest reward choice from the quest log.
 
: [[API GetQuestLogChoiceInfo|GetQuestLogChoiceInfo]]() - Returns a bunch of data about a quest reward choice from the quest log.
: <small>DEPRECATED</small> [[API ClosePlayerChoice|ClosePlayerChoice]]()
+
: <small>''DEPRECATED''</small> [[API ClosePlayerChoice|ClosePlayerChoice]]()
: <small>DEPRECATED</small> [[API C_PlayerChoice.GetPlayerChoiceInfo|C_PlayerChoice.GetPlayerChoiceInfo]]() : <span class="apiret">choiceInfo</span> - Returns information about a quest choice fork.
+
: <small>''DEPRECATED''</small> [[API C_PlayerChoice.GetPlayerChoiceInfo|C_PlayerChoice.GetPlayerChoiceInfo]]() : <span class="apiret">choiceInfo</span> - Returns information about a quest choice fork.
: <small>DEPRECATED</small> [[API C_PlayerChoice.GetPlayerChoiceOptionInfo|C_PlayerChoice.GetPlayerChoiceOptionInfo]](<span class="apiarg">optionIndex</span>) : <span class="apiret">info</span> - Returns information about an offered quest choice option.
+
: <small>''DEPRECATED''</small> [[API C_PlayerChoice.GetPlayerChoiceOptionInfo|C_PlayerChoice.GetPlayerChoiceOptionInfo]](<span class="apiarg">optionIndex</span>) : <span class="apiret">info</span> - Returns information about an offered quest choice option.
: <small>DEPRECATED</small> [[API C_PlayerChoice.GetPlayerChoiceRewardInfo|C_PlayerChoice.GetPlayerChoiceRewardInfo]](<span class="apiarg">rewardIndex</span>) : <span class="apiret">rewardInfo</span> - Returns reward info on a quest option.
+
: <small>''DEPRECATED''</small> [[API C_PlayerChoice.GetPlayerChoiceRewardInfo|C_PlayerChoice.GetPlayerChoiceRewardInfo]](<span class="apiarg">rewardIndex</span>) : <span class="apiret">rewardInfo</span> - Returns reward info on a quest option.
   
==== World Quests ====
+
====World Quests====
 
Task Quests refer to [[World Quest]]s or [[Quest#Bonus_Objectives|Bonus Objective]] quests.
 
Task Quests refer to [[World Quest]]s or [[Quest#Bonus_Objectives|Bonus Objective]] quests.
 
: [[API C_TaskQuest.DoesMapShowTaskQuestObjectives|C_TaskQuest.DoesMapShowTaskQuestObjectives]](<span class="apiarg">uiMapID</span>) : <span class="apiret">showsTaskQuestObjectives</span>
 
: [[API C_TaskQuest.DoesMapShowTaskQuestObjectives|C_TaskQuest.DoesMapShowTaskQuestObjectives]](<span class="apiarg">uiMapID</span>) : <span class="apiret">showsTaskQuestObjectives</span>
Line 3,900: Line 3,935:
 
: [[API GetTasksTable|GetTasksTable]]()
 
: [[API GetTasksTable|GetTasksTable]]()
   
==== Adventure Map ====
+
====Adventure Map====
 
The [[Scouting Map]] was added in [[Patch 7.0.3]]
 
The [[Scouting Map]] was added in [[Patch 7.0.3]]
 
: [[API C_AdventureMap.Close|C_AdventureMap.Close]]()
 
: [[API C_AdventureMap.Close|C_AdventureMap.Close]]()
Line 3,915: Line 3,950:
 
: [[API QuestIsFromAdventureMap|QuestIsFromAdventureMap]]()
 
: [[API QuestIsFromAdventureMap|QuestIsFromAdventureMap]]()
   
==== War Campaigns ====
+
====War Campaigns====
 
[[War Campaign]]s were added in [[Patch 8.0.1]]
 
[[War Campaign]]s were added in [[Patch 8.0.1]]
 
: [[API C_CampaignInfo.GetAvailableCampaigns|C_CampaignInfo.GetAvailableCampaigns]]() : <span class="apiret">campaignIDs</span>
 
: [[API C_CampaignInfo.GetAvailableCampaigns|C_CampaignInfo.GetAvailableCampaigns]]() : <span class="apiret">campaignIDs</span>
Line 3,929: Line 3,964:
 
: [[API C_LoreText.RequestLoreTextForCampaignID|C_LoreText.RequestLoreTextForCampaignID]](<span class="apiarg">campaignID</span>)
 
: [[API C_LoreText.RequestLoreTextForCampaignID|C_LoreText.RequestLoreTextForCampaignID]](<span class="apiarg">campaignID</span>)
   
==== Talking Head ====
+
====Talking Head====
 
These functions were added in [[Patch 7.0.3]]
 
These functions were added in [[Patch 7.0.3]]
 
: [[API C_TalkingHead.GetConversationsDeferred|C_TalkingHead.GetConversationsDeferred]]()
 
: [[API C_TalkingHead.GetConversationsDeferred|C_TalkingHead.GetConversationsDeferred]]()
Line 3,938: Line 3,973:
 
: [[API C_TalkingHead.SetConversationsDeferred|C_TalkingHead.SetConversationsDeferred]](<span class="apiarg">deferred</span>)
 
: [[API C_TalkingHead.SetConversationsDeferred|C_TalkingHead.SetConversationsDeferred]](<span class="apiarg">deferred</span>)
   
=== Races ===
+
===Races===
 
: [[API C_CreatureInfo.GetFactionInfo|C_CreatureInfo.GetFactionInfo]](<span class="apiarg">raceID</span>) : <span class="apiret">factionInfo</span> - Returns the faction name for a race.
 
: [[API C_CreatureInfo.GetFactionInfo|C_CreatureInfo.GetFactionInfo]](<span class="apiarg">raceID</span>) : <span class="apiret">factionInfo</span> - Returns the faction name for a race.
 
: [[API C_CreatureInfo.GetRaceInfo|C_CreatureInfo.GetRaceInfo]](<span class="apiarg">raceID</span>) : <span class="apiret">raceInfo</span> - Returns both localized and locale-independent race names.
 
: [[API C_CreatureInfo.GetRaceInfo|C_CreatureInfo.GetRaceInfo]](<span class="apiarg">raceID</span>) : <span class="apiret">raceInfo</span> - Returns both localized and locale-independent race names.
: [[API NeutralPlayerSelectFaction|NeutralPlayerSelectFaction]]() - Allows Pandaren to choose a faction.
+
: [[API NeutralPlayerSelectFaction|NeutralPlayerSelectFaction]]() - Allows a Pandaren to choose a faction.
 
[[Allied Races]] were added in [[Patch 7.3.5]]
 
[[Allied Races]] were added in [[Patch 7.3.5]]
 
: [[API C_AlliedRaces.ClearAlliedRaceDetailsGiver|C_AlliedRaces.ClearAlliedRaceDetailsGiver]]()
 
: [[API C_AlliedRaces.ClearAlliedRaceDetailsGiver|C_AlliedRaces.ClearAlliedRaceDetailsGiver]]()
Line 3,948: Line 3,983:
 
: [[API UnitAlliedRaceInfo|UnitAlliedRaceInfo]](<span class="apiarg">unit</span>) : <span class="apiret">isAlliedRace, hasHeritageArmorUnlocked</span>
 
: [[API UnitAlliedRaceInfo|UnitAlliedRaceInfo]](<span class="apiarg">unit</span>) : <span class="apiret">isAlliedRace, hasHeritageArmorUnlocked</span>
   
=== Realms ===
+
===Realms===
 
Relates to [[Realm]]s.
 
Relates to [[Realm]]s.
 
: [[API GetAutoCompleteRealms|GetAutoCompleteRealms]]()
 
: [[API GetAutoCompleteRealms|GetAutoCompleteRealms]]()
Line 3,955: Line 3,990:
 
: [[API GetNormalizedRealmName|GetNormalizedRealmName]]() - Returns the name of the server, but omitting spaces and hyphens.
 
: [[API GetNormalizedRealmName|GetNormalizedRealmName]]() - Returns the name of the server, but omitting spaces and hyphens.
 
: [[API GetRealmID|GetRealmID]]()
 
: [[API GetRealmID|GetRealmID]]()
: [[API GetRealmName|GetRealmName]]() - Returns the name of the server a user is logged in to.
+
: [[API GetRealmName|GetRealmName]]() - Returns the realm name.
 
: [[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.
   
=== Reputation ===
+
===Reputation===
 
Relates to [[Reputation]].
 
Relates to [[Reputation]].
: [[API C_Reputation.GetFactionParagonInfo|C_Reputation.GetFactionParagonInfo]](<span class="apiarg">factionID</span>) : <span class="apiret">currentValue, threshold, rewardQuestID, hasRewardPending, ...</span> - Gets Paragon information.
+
: [[API C_Reputation.GetFactionParagonInfo|C_Reputation.GetFactionParagonInfo]](<span class="apiarg">factionID</span>) : <span class="apiret">currentValue, threshold, rewardQuestID, hasRewardPending, ...</span> - Returns [[Emissary system|Paragon]] info on a faction.
: [[API C_Reputation.IsFactionParagon|C_Reputation.IsFactionParagon]](<span class="apiarg">factionID</span>) : <span class="apiret">hasParagon</span> - Returns true/false if a factionID is a Paragon.
+
: [[API C_Reputation.IsFactionParagon|C_Reputation.IsFactionParagon]](<span class="apiarg">factionID</span>) : <span class="apiret">hasParagon</span> - True if a faction is a paragon reputation.
 
: [[API C_Reputation.RequestFactionParagonPreloadRewardData|C_Reputation.RequestFactionParagonPreloadRewardData]](<span class="apiarg">factionID</span>) - Queries the server to pre-load Paragon reward data.
 
: [[API C_Reputation.RequestFactionParagonPreloadRewardData|C_Reputation.RequestFactionParagonPreloadRewardData]](<span class="apiarg">factionID</span>) - Queries the server to pre-load Paragon reward data.
 
: [[API CollapseFactionHeader|CollapseFactionHeader]](<span class="apiarg">index</span>) - Collapse a faction header row.
 
: [[API CollapseFactionHeader|CollapseFactionHeader]](<span class="apiarg">index</span>) - Collapse a faction header row.
Line 3,967: Line 4,002:
 
: [[API ExpandFactionHeader|ExpandFactionHeader]](<span class="apiarg">index</span>) - Expand a faction header row.
 
: [[API ExpandFactionHeader|ExpandFactionHeader]](<span class="apiarg">index</span>) - Expand a faction header row.
 
: [[API ExpandAllFactionHeaders|ExpandAllFactionHeaders]]() - Expand all faction header rows.
 
: [[API ExpandAllFactionHeaders|ExpandAllFactionHeaders]]() - Expand all faction header rows.
: [[API FactionToggleAtWar|FactionToggleAtWar]](<span class="apiarg">index</span>) - Toggle the At War flag for a faction.
+
: [[API FactionToggleAtWar|FactionToggleAtWar]](<span class="apiarg">index</span>) - Toggles the [[At War]] status for a faction.
: [[API GetFactionInfo|GetFactionInfo]](<span class="apiarg">index</span>) - Gets details for a specific faction/faction header.
+
: [[API GetFactionInfo|GetFactionInfo]](<span class="apiarg">index</span>) - Returns info for a faction.
 
: [[API GetFactionInfoByID|GetFactionInfoByID]](<span class="apiarg">factionID</span>) - Gets details for a specific faction by factionID.
 
: [[API GetFactionInfoByID|GetFactionInfoByID]](<span class="apiarg">factionID</span>) - Gets details for a specific faction by factionID.
: [[API GetFriendshipReputation|GetFriendshipReputation]](<span class="apiarg">factionID</span>) - Gets details about an NPC friend.
+
: [[API GetFriendshipReputation|GetFriendshipReputation]](<span class="apiarg">factionID</span>) - Returns info for a friendship reputation.
: [[API GetFriendshipReputationRanks|GetFriendshipReputationRanks]](<span class="apiarg">factionID</span>) - Gets rank data about an NPC friend.
+
: [[API GetFriendshipReputationRanks|GetFriendshipReputationRanks]](<span class="apiarg">factionID</span>) - Returns the (max) rank for a friendship reputation.
 
: [[API GetNumFactions|GetNumFactions]]() - Returns the number of lines in the faction display.
 
: [[API GetNumFactions|GetNumFactions]]() - Returns the number of lines in the faction display.
 
: [[API GetSelectedFaction|GetSelectedFaction]]() - Returns the row index of the currently selected faction in reputation window.
 
: [[API GetSelectedFaction|GetSelectedFaction]]() - Returns the row index of the currently selected faction in reputation window.
: [[API GetWatchedFactionInfo|GetWatchedFactionInfo]]() - Returns information about the currently watched faction.
+
: [[API GetWatchedFactionInfo|GetWatchedFactionInfo]]() - Returns info for the currently watched faction.
: [[API IsFactionInactive|IsFactionInactive]](<span class="apiarg">index</span>) - Returns true if the faction is marked inactive.
+
: [[API IsFactionInactive|IsFactionInactive]](<span class="apiarg">index</span>) - True if the specified faction is marked inactive.
: [[API SetFactionActive|SetFactionActive]](<span class="apiarg">index</span>) - Remove a faction from inactive group.
+
: [[API SetFactionActive|SetFactionActive]](<span class="apiarg">index</span>) - Flags the specified faction as active in the reputation window.
: [[API SetFactionInactive|SetFactionInactive]](<span class="apiarg">index</span>) - Move a faction to inactive group.
+
: [[API SetFactionInactive|SetFactionInactive]](<span class="apiarg">index</span>) - Flags the specified faction as inactive in the reputation window.
 
: [[API SetSelectedFaction|SetSelectedFaction]](<span class="apiarg">index</span>) - Sets the currently selected faction in reputation window.
 
: [[API SetSelectedFaction|SetSelectedFaction]](<span class="apiarg">index</span>) - Sets the currently selected faction in reputation window.
: [[API SetWatchedFactionIndex|SetWatchedFactionIndex]](<span class="apiarg">index</span>) - Sets which faction should be watched in Blizzard reputation bar.
+
: [[API SetWatchedFactionIndex|SetWatchedFactionIndex]](<span class="apiarg">index</span>) - Watches a faction in the reputation window.
   
=== Spells ===
+
===Spells===
 
: [[API C_Spell.DoesSpellExist|C_Spell.DoesSpellExist]](<span class="apiarg">spellID</span>) : <span class="apiret">spellExists</span>
 
: [[API C_Spell.DoesSpellExist|C_Spell.DoesSpellExist]](<span class="apiarg">spellID</span>) : <span class="apiret">spellExists</span>
 
: [[API C_Spell.IsSpellDataCached|C_Spell.IsSpellDataCached]](<span class="apiarg">spellID</span>) : <span class="apiret">isCached</span>
 
: [[API C_Spell.IsSpellDataCached|C_Spell.IsSpellDataCached]](<span class="apiarg">spellID</span>) : <span class="apiret">isCached</span>
Line 3,987: Line 4,022:
 
: [[API C_ZoneAbility.GetActiveAbilities|C_ZoneAbility.GetActiveAbilities]]() : <span class="apiret">zoneAbilities</span>
 
: [[API C_ZoneAbility.GetActiveAbilities|C_ZoneAbility.GetActiveAbilities]]() : <span class="apiret">zoneAbilities</span>
 
: [[API AcceptSpellConfirmationPrompt|AcceptSpellConfirmationPrompt]](<span class="apiarg">spellID</span>)
 
: [[API AcceptSpellConfirmationPrompt|AcceptSpellConfirmationPrompt]](<span class="apiarg">spellID</span>)
: <small>NOCOMBAT</small> [[API CancelSpellByName|CancelSpellByName]](<span class="apiarg">name</span>)
+
: <small>''NOCOMBAT''</small> [[API CancelSpellByName|CancelSpellByName]](<span class="apiarg">name</span>)
: <small>PROTECTED</small> [[API CastSpell|CastSpell]](<span class="apiarg">spellIndex, bookType</span>) - Cast the spell in the specified spell book slot.
+
: <small>''PROTECTED''</small> [[API CastSpell|CastSpell]](<span class="apiarg">spellIndex, bookType</span>) - Casts a spell from the spellbook.
: <small>PROTECTED</small> [[API CastSpellByID|CastSpellByID]](<span class="apiarg">spellID [, target]</span>)
+
: <small>''PROTECTED''</small> [[API CastSpellByID|CastSpellByID]](<span class="apiarg">spellID [, target]</span>)
: <small>PROTECTED</small> [[API CastSpellByName|CastSpellByName]](<span class="apiarg">name [, target]</span>) - Cast the specified spell by display name.
+
: <small>''PROTECTED''</small> [[API CastSpellByName|CastSpellByName]](<span class="apiarg">name [, target]</span>) - Casts a spell by name.
 
: [[API DeclineSpellConfirmationPrompt|DeclineSpellConfirmationPrompt]](<span class="apiarg">spellID</span>)
 
: [[API DeclineSpellConfirmationPrompt|DeclineSpellConfirmationPrompt]](<span class="apiarg">spellID</span>)
 
: [[API DoesSpellExist|DoesSpellExist]](<span class="apiarg">spellName</span>)
 
: [[API DoesSpellExist|DoesSpellExist]](<span class="apiarg">spellName</span>)
Line 3,997: Line 4,032:
 
: [[API GetMaxSpellStartRecoveryOffset|GetMaxSpellStartRecoveryOffset]]()
 
: [[API GetMaxSpellStartRecoveryOffset|GetMaxSpellStartRecoveryOffset]]()
 
: [[API GetSchoolString|GetSchoolString]](<span class="apiarg">schoolMask</span>)
 
: [[API GetSchoolString|GetSchoolString]](<span class="apiarg">schoolMask</span>)
: [[API GetSpellAutocast|GetSpellAutocast]](<span class="apiarg">spellName | spellId, bookType</span>) - Check whether the specified spell autocasts or not.
+
: [[API GetSpellAutocast|GetSpellAutocast]](<span class="apiarg">spellName | spellId, bookType</span>) - True if a (pet) spell is autocastable.
 
: [[API GetSpellBaseCooldown|GetSpellBaseCooldown]](<span class="apiarg">spellID</span>)
 
: [[API GetSpellBaseCooldown|GetSpellBaseCooldown]](<span class="apiarg">spellID</span>)
 
: [[API GetSpellCharges|GetSpellCharges]](<span class="apiarg">spellId | spellName</span>) - Returns information about the charges of a charge-accumulating player ability.
 
: [[API GetSpellCharges|GetSpellCharges]](<span class="apiarg">spellId | spellName</span>) - Returns information about the charges of a charge-accumulating player ability.
 
: [[API GetSpellConfirmationPromptsInfo|GetSpellConfirmationPromptsInfo]]()
 
: [[API GetSpellConfirmationPromptsInfo|GetSpellConfirmationPromptsInfo]]()
: [[API GetSpellCooldown|GetSpellCooldown]](<span class="apiarg">spellName | spellID, bookType</span>) - Retrieves data on the cooldown of a specific spell.
+
: [[API GetSpellCooldown|GetSpellCooldown]](<span class="apiarg">spellName | spellID, bookType</span>) - Returns the cooldown info of a spell.
 
: [[API GetSpellCount|GetSpellCount]]()
 
: [[API GetSpellCount|GetSpellCount]]()
 
: [[API GetSpellDescription|GetSpellDescription]](<span class="apiarg">spellId</span>) - Returns the spell description.
 
: [[API GetSpellDescription|GetSpellDescription]](<span class="apiarg">spellId</span>) - Returns the spell description.
 
: [[API GetSpellInfo|GetSpellInfo]](<span class="apiarg">spellId</span>) : <span class="apiret">name, rank, icon, castTime, minRange, maxRange, spellID</span> - Returns spell info.
 
: [[API GetSpellInfo|GetSpellInfo]](<span class="apiarg">spellId</span>) : <span class="apiret">name, rank, icon, castTime, minRange, maxRange, spellID</span> - Returns spell info.
: [[API GetSpellLink|GetSpellLink]](<span class="apiarg">spellName, spellRank</span>) - Returns the spell's link.
+
: [[API GetSpellLink|GetSpellLink]](<span class="apiarg">spellName, spellRank</span>) - Returns the hyperlink for a spell.
: [[API GetSpellPowerCost|GetSpellPowerCost]](<span class="apiarg">spellId | spellName</span>) - Returns information about a spell's resource cost.
+
: [[API GetSpellPowerCost|GetSpellPowerCost]](<span class="apiarg">spellId | spellName</span>) - Returns resource cost info for a spell.
 
: [[API GetSpellQueueWindow|GetSpellQueueWindow]]()
 
: [[API GetSpellQueueWindow|GetSpellQueueWindow]]()
 
: [[API GetSpellSubtext|GetSpellSubtext]]()
 
: [[API GetSpellSubtext|GetSpellSubtext]]()
: [[API GetSpellTexture|GetSpellTexture]](<span class="apiarg">spellId | spellName</span>) - Returns the fileId used for the spell's icon.
+
: [[API GetSpellTexture|GetSpellTexture]](<span class="apiarg">spellId | spellName</span>) - Returns the icon texture of a spell.
 
: [[API GetSpellTradeSkillLink|GetSpellTradeSkillLink]]()
 
: [[API GetSpellTradeSkillLink|GetSpellTradeSkillLink]]()
: [[API IsAttackSpell|IsAttackSpell]](<span class="apiarg">spell</span>) - Returns 1 if the spell is the "Attack" spell.
+
: [[API IsAttackSpell|IsAttackSpell]](<span class="apiarg">spell</span>) - True if a spellbook item is the "Auto Attack" spell.
 
: [[API IsAutoRepeatSpell|IsAutoRepeatSpell]](<span class="apiarg">spell</span>)
 
: [[API IsAutoRepeatSpell|IsAutoRepeatSpell]](<span class="apiarg">spell</span>)
 
: [[API IsConsumableSpell|IsConsumableSpell]]()
 
: [[API IsConsumableSpell|IsConsumableSpell]]()
: [[API IsCurrentSpell|IsCurrentSpell]](<span class="apiarg">spellID</span>) - Returns true if the spell is currently being casted by the player or is placed in the queue to be casted next. False otherwise.
+
: [[API IsCurrentSpell|IsCurrentSpell]](<span class="apiarg">spellID</span>) - True if the specified spell ID is currently being casted or queued.
 
: [[API IsHarmfulSpell|IsHarmfulSpell]](<span class="apiarg">spellSlot</span>) - Returns whether a spell can be used against hostile units
 
: [[API IsHarmfulSpell|IsHarmfulSpell]](<span class="apiarg">spellSlot</span>) - Returns whether a spell can be used against hostile units
 
: [[API IsHelpfulSpell|IsHelpfulSpell]](<span class="apiarg">spellSlot</span>) - Returns whether an item can be used on the player or friendly units
 
: [[API IsHelpfulSpell|IsHelpfulSpell]](<span class="apiarg">spellSlot</span>) - Returns whether an item can be used on the player or friendly units
: [[API IsPassiveSpell|IsPassiveSpell]](<span class="apiarg">spellID, bookType</span>) - Returns whether the icon in your spellbook is a Passive ability. Formerly IsSpellPassive(spell).
+
: [[API IsPassiveSpell|IsPassiveSpell]](<span class="apiarg">spellID, bookType</span>) - True if the specified spell is a passive ability.
 
: [[API IsPlayerSpell|IsPlayerSpell]](<span class="apiarg">spellID</span>)
 
: [[API IsPlayerSpell|IsPlayerSpell]](<span class="apiarg">spellID</span>)
: [[API IsSpellInRange|IsSpellInRange]](<span class="apiarg">spellName [, unit]</span>) - Is nil for no valid target, 0 for out of range, 1 for in range.
+
: [[API IsSpellInRange|IsSpellInRange]](<span class="apiarg">spellName [, unit]</span>) - True if the player is in range to use the specified spell on the target unit.
 
: [[API IsSpellKnown|IsSpellKnown]](<span class="apiarg">spellID, isPetSpell</span>) - Returns whether the player (or pet) knows the given spell.
 
: [[API IsSpellKnown|IsSpellKnown]](<span class="apiarg">spellID, isPetSpell</span>) - Returns whether the player (or pet) knows the given spell.
 
: [[API IsSpellKnownOrOverridesKnown|IsSpellKnownOrOverridesKnown]](<span class="apiarg">spellID [, isPet]</span>)
 
: [[API IsSpellKnownOrOverridesKnown|IsSpellKnownOrOverridesKnown]](<span class="apiarg">spellID [, isPet]</span>)
: [[API IsSpellOverlayed|IsSpellOverlayed]](<span class="apiarg">spellID</span>) - Returns whether the spell is currently affected by a proc (glow highlighting).
+
: [[API IsSpellOverlayed|IsSpellOverlayed]](<span class="apiarg">spellID</span>) - True if the specified spell currently has a proc / spell activation alert (glowing border).
 
: [[API IsUsableSpell|IsUsableSpell]](<span class="apiarg">spellName | spellID | spellIndex, bookType</span>) - Determines whether a spell can be used by the player character.
 
: [[API IsUsableSpell|IsUsableSpell]](<span class="apiarg">spellName | spellID | spellIndex, bookType</span>) - Determines whether a spell can be used by the player character.
 
: [[API SpellCancelQueuedSpell|SpellCancelQueuedSpell]]()
 
: [[API SpellCancelQueuedSpell|SpellCancelQueuedSpell]]()
Line 4,028: Line 4,063:
 
: [[API SpellCanTargetItemID|SpellCanTargetItemID]]()
 
: [[API SpellCanTargetItemID|SpellCanTargetItemID]]()
 
: [[API SpellCanTargetQuest|SpellCanTargetQuest]]()
 
: [[API SpellCanTargetQuest|SpellCanTargetQuest]]()
: [[API SpellCanTargetUnit|SpellCanTargetUnit]](<span class="apiarg">unit</span>) - Returns true if the spell awaiting target selection can be cast on the specified unit.
+
: [[API SpellCanTargetUnit|SpellCanTargetUnit]](<span class="apiarg">unit</span>) - True if the spell awaiting target selection can be cast on the unit.
 
: [[API SpellGetVisibilityInfo|SpellGetVisibilityInfo]](<span class="apiarg">spellID, visType</span>)
 
: [[API SpellGetVisibilityInfo|SpellGetVisibilityInfo]](<span class="apiarg">spellID, visType</span>)
 
: [[API SpellHasRange|SpellHasRange]](<span class="apiarg">spell</span>) - Returns true if the specified spell has a ranged effect (i.e. requires a target).
 
: [[API SpellHasRange|SpellHasRange]](<span class="apiarg">spell</span>) - Returns true if the specified spell has a ranged effect (i.e. requires a target).
Line 4,034: Line 4,069:
 
: [[API SpellIsPriorityAura|SpellIsPriorityAura]](<span class="apiarg">spellID</span>)
 
: [[API SpellIsPriorityAura|SpellIsPriorityAura]](<span class="apiarg">spellID</span>)
 
: [[API SpellIsSelfBuff|SpellIsSelfBuff]](<span class="apiarg">spellID</span>)
 
: [[API SpellIsSelfBuff|SpellIsSelfBuff]](<span class="apiarg">spellID</span>)
: [[API SpellIsTargeting|SpellIsTargeting]]() - Returns true if a spell has been cast and is awaiting target selection.
+
: [[API SpellIsTargeting|SpellIsTargeting]]() - True if a spell is about to be cast and is waiting for the player to select a target.
: <small>PROTECTED</small> [[API SpellStopCasting|SpellStopCasting]]() - Stops the current spellcast.
+
: <small>''PROTECTED''</small> [[API SpellStopCasting|SpellStopCasting]]() - Stops the current spellcast.
: <small>PROTECTED</small> [[API SpellStopTargeting|SpellStopTargeting]]() - Cancels the spell awaiting target selection.
+
: <small>''PROTECTED''</small> [[API SpellStopTargeting|SpellStopTargeting]]() - Cancels the spell awaiting target selection.
: <small>PROTECTED</small> [[API SpellTargetUnit|SpellTargetUnit]](<span class="apiarg">unit</span>) - Casts the spell awaiting target selection on the specified unit.
+
: <small>''PROTECTED''</small> [[API SpellTargetUnit|SpellTargetUnit]](<span class="apiarg">unit</span>) - Casts the spell awaiting target selection on the unit.
: <small>PROTECTED</small> [[API SpellTargetItem|SpellTargetItem]](<span class="apiarg">item</span>)
+
: <small>''PROTECTED''</small> [[API SpellTargetItem|SpellTargetItem]](<span class="apiarg">item</span>)
: <small>UI</small> [[API QueryCastSequence|QueryCastSequence]](<span class="apiarg">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 class="apiarg">sequence</span>) - Returns index, item, spell for the spell/item that will be used next if the cast sequence is executed.
   
==== Spell Book ====
+
====Spell Book====
 
: [[API C_SpellBook.ContainsAnyDisenchantSpell|C_SpellBook.ContainsAnyDisenchantSpell]]() : <span class="apiret">contains</span>
 
: [[API C_SpellBook.ContainsAnyDisenchantSpell|C_SpellBook.ContainsAnyDisenchantSpell]]() : <span class="apiret">contains</span>
 
: [[API C_SpellBook.GetCurrentLevelSpells|C_SpellBook.GetCurrentLevelSpells]](<span class="apiarg">level</span>) : <span class="apiret">spellIDs</span>
 
: [[API C_SpellBook.GetCurrentLevelSpells|C_SpellBook.GetCurrentLevelSpells]](<span class="apiarg">level</span>) : <span class="apiret">spellIDs</span>
Line 4,049: Line 4,084:
 
: [[API C_SpellBook.IsSpellDisabled|C_SpellBook.IsSpellDisabled]](<span class="apiarg">spellID</span>) : <span class="apiret">disabled</span>
 
: [[API C_SpellBook.IsSpellDisabled|C_SpellBook.IsSpellDisabled]](<span class="apiarg">spellID</span>) : <span class="apiret">disabled</span>
 
: [[API FindSpellBookSlotBySpellID|FindSpellBookSlotBySpellID]](<span class="apiarg">spellID [, isPet]</span>)
 
: [[API FindSpellBookSlotBySpellID|FindSpellBookSlotBySpellID]](<span class="apiarg">spellID [, isPet]</span>)
: [[API GetNumSpellTabs|GetNumSpellTabs]]() - Returns the total number of tabs in the user's spellbook.
+
: [[API GetNumSpellTabs|GetNumSpellTabs]]() - Returns the number of tabs in the spellbook.
 
: [[API GetSpellAvailableLevel|GetSpellAvailableLevel]](<span class="apiarg">spellSlot</span>)
 
: [[API GetSpellAvailableLevel|GetSpellAvailableLevel]](<span class="apiarg">spellSlot</span>)
: [[API GetSpellBookItemInfo|GetSpellBookItemInfo]](<span class="apiarg">spellName or index, bookType</span>) - Returns the spell's type and spellID for a spell in the player's spellbook.
+
: [[API GetSpellBookItemInfo|GetSpellBookItemInfo]](<span class="apiarg">spellName or index, bookType</span>) - Returns info for a [[spellbook]] item.
: [[API GetSpellBookItemName|GetSpellBookItemName]](<span class="apiarg">spellName or index, bookType</span>) - Returns the spell name and spell rank for a spell in the player's spellbook.
+
: [[API GetSpellBookItemName|GetSpellBookItemName]](<span class="apiarg">spellName or index, bookType</span>) - Returns the name of a [[spellbook]] item.
: [[API GetSpellBookItemTexture|GetSpellBookItemTexture]](<span class="apiarg">spellName or index, bookType</span>) - Returns the spell icon fileId for a spell in the player's spellbook.
+
: [[API GetSpellBookItemTexture|GetSpellBookItemTexture]](<span class="apiarg">spellName or index, bookType</span>) - Returns the icon texture of a spellbook item.
 
: [[API GetSpellLevelLearned|GetSpellLevelLearned]]()
 
: [[API GetSpellLevelLearned|GetSpellLevelLearned]]()
: [[API GetSpellTabInfo|GetSpellTabInfo]](<span class="apiarg">spellbookTabNum</span>) - Returns information about the specified spellbook tab.
+
: [[API GetSpellTabInfo|GetSpellTabInfo]](<span class="apiarg">spellbookTabNum</span>) - Returns info for the specified spellbook tab.
 
: [[API IsSelectedSpellBookItem|IsSelectedSpellBookItem]](<span class="apiarg">spellSlot</span>)
 
: [[API IsSelectedSpellBookItem|IsSelectedSpellBookItem]](<span class="apiarg">spellSlot</span>)
   
=== Store ===
+
===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 class="apiarg">groupID</span>) : <span class="apiret">hasPurchaseableProducts</span>
 
: [[API C_StorePublic.DoesGroupHavePurchaseableProducts|C_StorePublic.DoesGroupHavePurchaseableProducts]](<span class="apiarg">groupID</span>) : <span class="apiret">hasPurchaseableProducts</span>
Line 4,064: Line 4,099:
 
: [[API C_StorePublic.IsEnabled|C_StorePublic.IsEnabled]]() : <span class="apiret">enabled</span> - Returns whether the In-Game Store is available for the player.
 
: [[API C_StorePublic.IsEnabled|C_StorePublic.IsEnabled]]() : <span class="apiret">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>PROTECTED</small> [[API C_CharacterServices.AssignPCTDistribution|C_CharacterServices.AssignPCTDistribution]]()
+
: <small>''PROTECTED''</small> [[API C_CharacterServices.AssignPCTDistribution|C_CharacterServices.AssignPCTDistribution]]()
: <small>PROTECTED</small> [[API C_CharacterServices.AssignUpgradeDistribution|C_CharacterServices.AssignUpgradeDistribution]]()
+
: <small>''PROTECTED''</small> [[API C_CharacterServices.AssignPFCDistribution|C_CharacterServices.AssignPFCDistribution]]()
: <small>PROTECTED</small> [[API C_CharacterServices.GetActiveCharacterUpgradeBoostType|C_CharacterServices.GetActiveCharacterUpgradeBoostType]]()
+
: <small>''PROTECTED''</small> [[API C_CharacterServices.AssignUpgradeDistribution|C_CharacterServices.AssignUpgradeDistribution]]()
: <small>PROTECTED</small> [[API C_CharacterServices.GetActiveClassTrialBoostType|C_CharacterServices.GetActiveClassTrialBoostType]]()
+
: <small>''PROTECTED''</small> [[API C_CharacterServices.GetActiveCharacterUpgradeBoostType|C_CharacterServices.GetActiveCharacterUpgradeBoostType]]()
: <small>PROTECTED</small> [[API C_CharacterServices.GetAutomaticBoost|C_CharacterServices.GetAutomaticBoost]]()
+
: <small>''PROTECTED''</small> [[API C_CharacterServices.GetActiveClassTrialBoostType|C_CharacterServices.GetActiveClassTrialBoostType]]()
: <small>PROTECTED</small> [[API C_CharacterServices.GetAutomaticBoostCharacter|C_CharacterServices.GetAutomaticBoostCharacter]]()
+
: <small>''PROTECTED''</small> [[API C_CharacterServices.GetAutomaticBoost|C_CharacterServices.GetAutomaticBoost]]()
: <small>PROTECTED</small> [[API C_CharacterServices.GetCharacterServiceDisplayData|C_CharacterServices.GetCharacterServiceDisplayData]]()
+
: <small>''PROTECTED''</small> [[API C_CharacterServices.GetAutomaticBoostCharacter|C_CharacterServices.GetAutomaticBoostCharacter]]()
: <small>PROTECTED</small> [[API C_CharacterServices.GetCharacterServiceDisplayDataByVASType|C_CharacterServices.GetCharacterServiceDisplayDataByVASType]]()
+
: <small>''PROTECTED''</small> [[API C_CharacterServices.GetCharacterServiceDisplayData|C_CharacterServices.GetCharacterServiceDisplayData]]()
: <small>PROTECTED</small> [[API C_CharacterServices.GetCharacterServiceDisplayInfo|C_CharacterServices.GetCharacterServiceDisplayInfo]]()
+
: <small>''PROTECTED''</small> [[API C_CharacterServices.GetCharacterServiceDisplayDataByVASType|C_CharacterServices.GetCharacterServiceDisplayDataByVASType]]()
: <small>PROTECTED</small> [[API C_CharacterServices.GetVASDistributions|C_CharacterServices.GetVASDistributions]]()
+
: <small>''PROTECTED''</small> [[API C_CharacterServices.GetCharacterServiceDisplayInfo|C_CharacterServices.GetCharacterServiceDisplayInfo]]()
: <small>PROTECTED</small> [[API C_CharacterServices.HasRequiredBoostForClassTrial|C_CharacterServices.HasRequiredBoostForClassTrial]]()
+
: <small>''PROTECTED''</small> [[API C_CharacterServices.GetVASDistributions|C_CharacterServices.GetVASDistributions]]()
: <small>PROTECTED</small> [[API C_CharacterServices.HasRequiredBoostForUnrevoke|C_CharacterServices.HasRequiredBoostForUnrevoke]]()
+
: <small>''PROTECTED''</small> [[API C_CharacterServices.HasRequiredBoostForClassTrial|C_CharacterServices.HasRequiredBoostForClassTrial]]()
: <small>PROTECTED</small> [[API C_CharacterServices.SetAutomaticBoost|C_CharacterServices.SetAutomaticBoost]]()
+
: <small>''PROTECTED''</small> [[API C_CharacterServices.HasRequiredBoostForUnrevoke|C_CharacterServices.HasRequiredBoostForUnrevoke]]()
: <small>PROTECTED</small> [[API C_CharacterServices.SetAutomaticBoostCharacter|C_CharacterServices.SetAutomaticBoostCharacter]]()
+
: <small>''PROTECTED''</small> [[API C_CharacterServices.SetAutomaticBoost|C_CharacterServices.SetAutomaticBoost]]()
  +
: <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 4,094: Line 4,130:
 
: [[API C_SharedCharacterServices.SetPromotionalPopupSeen|C_SharedCharacterServices.SetPromotionalPopupSeen]](<span class="apiarg">seen</span>)
 
: [[API C_SharedCharacterServices.SetPromotionalPopupSeen|C_SharedCharacterServices.SetPromotionalPopupSeen]](<span class="apiarg">seen</span>)
   
=== System ===
+
===System===
: <small>HW</small> [[API C_UI.Reload|C_UI.Reload]]() - Reloads the UI from source files.
+
: <small>''HW''</small> [[API C_UI.Reload|C_UI.Reload]]() - Reloads the User Interface.
 
: [[API C_System.GetFrameStack|C_System.GetFrameStack]]() : <span class="apiret">objects</span>
 
: [[API C_System.GetFrameStack|C_System.GetFrameStack]]() : <span class="apiret">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>PROTECTED</small> [[API CopyToClipboard|CopyToClipboard]](<span class="apiarg">text</span>) - Copies text to the clipboard.
+
: <small>''PROTECTED''</small> [[API CopyToClipboard|CopyToClipboard]](<span class="apiarg">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>PROTECTED</small> [[API ForceLogout|ForceLogout]]()
+
: <small>''PROTECTED''</small> [[API ForceLogout|ForceLogout]]()
: <small>PROTECTED</small> [[API ForceQuit|ForceQuit]]() - Instantly quits the game, bypassing the timer.
+
: <small>''PROTECTED''</small> [[API ForceQuit|ForceQuit]]() - Instantly quits the game, ignoring the 20 seconds timer.
: [[API GetBuildInfo|GetBuildInfo]]() - Returns information about current client build.
+
: [[API GetBuildInfo|GetBuildInfo]]() - Returns info for the current client build.
: [[API GetFramerate|GetFramerate]]() - Returns the current framerate (full precision)
+
: [[API GetFramerate|GetFramerate]]() - Returns the current framerate.
 
: [[API GetTickTime|GetTickTime]]() - Returns the time in seconds since the end of the previous frame and the start of the current frame.
 
: [[API GetTickTime|GetTickTime]]() - Returns the time in seconds since the end of the previous frame and the start of the current frame.
 
: [[API Is64BitClient|Is64BitClient]]()
 
: [[API Is64BitClient|Is64BitClient]]()
 
: [[API IsDebugBuild|IsDebugBuild]]()
 
: [[API IsDebugBuild|IsDebugBuild]]()
 
: [[API IsGMClient|IsGMClient]]()
 
: [[API IsGMClient|IsGMClient]]()
: [[API IsLinuxClient|IsLinuxClient]]() - Boolean - Returns true if WoW is being run on Linux.
+
: [[API IsLinuxClient|IsLinuxClient]]() - True if on a Linux client.
 
: [[API IsLoggedIn|IsLoggedIn]]() - Returns nil before the PLAYER_LOGIN event has fired, 1 afterwards.
 
: [[API IsLoggedIn|IsLoggedIn]]() - Returns nil before the PLAYER_LOGIN event has fired, 1 afterwards.
: [[API IsMacClient|IsMacClient]]() - Returns true if WoW is being run on Mac.
+
: [[API IsMacClient|IsMacClient]]() - True if on a Mac client.
 
: [[API IsOnGlueScreen|IsOnGlueScreen]]()
 
: [[API IsOnGlueScreen|IsOnGlueScreen]]()
 
: [[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 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]]() - True if on a Windows client.
 
: [[API LoadURLIndex|LoadURLIndex]](<span class="apiarg">index</span>)
 
: [[API LoadURLIndex|LoadURLIndex]](<span class="apiarg">index</span>)
: <small>PROTECTED</small> [[API Logout|Logout]]() - Logs the user out of the game.
+
: <small>''PROTECTED''</small> [[API Logout|Logout]]() - Logs the player out of the game.
 
: [[API ProcessExceptionClient|ProcessExceptionClient]]()
 
: [[API ProcessExceptionClient|ProcessExceptionClient]]()
: <small>PROTECTED</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 class="apiarg">message</span>) - Fires a CHAT_MSG_SYSTEM event for yourself.
+
: [[API SendSystemMessage|SendSystemMessage]](<span class="apiarg">message</span>) - Prints a yellow CHAT_MSG_SYSTEM message.
: <small>PROTECTED</small> [[API Stuck|Stuck]]() - Informs the game engine that the player is Stuck.
+
: <small>''PROTECTED''</small> [[API Stuck|Stuck]]() - Notifies 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.
   
==== Network ====
+
====Network====
 
: [[API GetAvailableBandwidth|GetAvailableBandwidth]]()
 
: [[API GetAvailableBandwidth|GetAvailableBandwidth]]()
 
: [[API GetBackgroundLoadingStatus|GetBackgroundLoadingStatus]]()
 
: [[API GetBackgroundLoadingStatus|GetBackgroundLoadingStatus]]()
Line 4,132: Line 4,168:
 
: [[API GetFileStreamingStatus|GetFileStreamingStatus]]()
 
: [[API GetFileStreamingStatus|GetFileStreamingStatus]]()
 
: [[API GetNetIpTypes|GetNetIpTypes]]()
 
: [[API GetNetIpTypes|GetNetIpTypes]]()
: [[API GetNetStats|GetNetStats]]() - Get bandwidth and latency network information.
+
: [[API GetNetStats|GetNetStats]]() - Returns bandwidth and latency network information.
   
==== Console ====
+
====Console====
 
Relates to [[Console variables]] and commands.
 
Relates to [[Console variables]] and commands.
 
: [[API C_CVar.GetCVar|C_CVar.GetCVar]](<span class="apiarg">name</span>) : <span class="apiret">value</span> - Returns the current value of a console variable.
 
: [[API C_CVar.GetCVar|C_CVar.GetCVar]](<span class="apiarg">name</span>) : <span class="apiret">value</span> - Returns the current value of a console variable.
Line 4,140: Line 4,176:
 
: [[API C_CVar.GetCVarBool|C_CVar.GetCVarBool]](<span class="apiarg">name</span>) : <span class="apiret">value</span> - Returns the boolean value of a console variable.
 
: [[API C_CVar.GetCVarBool|C_CVar.GetCVarBool]](<span class="apiarg">name</span>) : <span class="apiret">value</span> - Returns the boolean value of a console variable.
 
: [[API C_CVar.GetCVarDefault|C_CVar.GetCVarDefault]](<span class="apiarg">name</span>) : <span class="apiret">defaultValue</span> - Returns the default value of a console variable.
 
: [[API C_CVar.GetCVarDefault|C_CVar.GetCVarDefault]](<span class="apiarg">name</span>) : <span class="apiret">defaultValue</span> - Returns the default value of a console variable.
: [[API C_CVar.RegisterCVar|C_CVar.RegisterCVar]](<span class="apiarg">name [, value]</span>) - Registers a custom cvar (temporarily).
+
: [[API C_CVar.RegisterCVar|C_CVar.RegisterCVar]](<span class="apiarg">name [, value]</span>) - Temporarily registers a custom console variable.
 
: [[API C_CVar.ResetTestCVars|C_CVar.ResetTestCVars]]() - Resets the {{api|t=c|ActionCam}} cvars.
 
: [[API C_CVar.ResetTestCVars|C_CVar.ResetTestCVars]]() - Resets the {{api|t=c|ActionCam}} cvars.
 
: [[API C_CVar.SetCVar|C_CVar.SetCVar]](<span class="apiarg">name [, value, scriptCVar]</span>) : <span class="apiret">success</span> - Sets a console variable.
 
: [[API C_CVar.SetCVar|C_CVar.SetCVar]](<span class="apiarg">name [, value, scriptCVar]</span>) : <span class="apiret">success</span> - Sets a console variable.
Line 4,152: Line 4,188:
 
: [[API ConsoleExec|ConsoleExec]](<span class="apiarg">command</span>) - Execute a console command.
 
: [[API ConsoleExec|ConsoleExec]](<span class="apiarg">command</span>) - Execute a console command.
 
: [[API GetCVarInfo|GetCVarInfo]](<span class="apiarg">name</span>) - Returns information on a console variable.
 
: [[API GetCVarInfo|GetCVarInfo]](<span class="apiarg">name</span>) - Returns information on a console variable.
: [[API SetConsoleKey|SetConsoleKey]](<span class="apiarg">key</span>) - Sets the console key (normally ~ ).
+
: [[API SetConsoleKey|SetConsoleKey]](<span class="apiarg">key</span>) - Sets the console key (normally ~).
   
==== Date & Time ====
+
====Date & Time====
: [[API C_DateAndTime.AdjustTimeByDays|C_DateAndTime.AdjustTimeByDays]](<span class="apiarg">date, days</span>) : <span class="apiret">newDate</span> - Returns the date after a given amount of days.
+
: [[API C_DateAndTime.AdjustTimeByDays|C_DateAndTime.AdjustTimeByDays]](<span class="apiarg">date, days</span>) : <span class="apiret">newDate</span> - Returns the date after a specified amount of days.
 
: [[API C_DateAndTime.AdjustTimeByMinutes|C_DateAndTime.AdjustTimeByMinutes]](<span class="apiarg">date, minutes</span>) : <span class="apiret">newDate</span> - Returns the date after a given amount of minutes.
 
: [[API C_DateAndTime.AdjustTimeByMinutes|C_DateAndTime.AdjustTimeByMinutes]](<span class="apiarg">date, minutes</span>) : <span class="apiret">newDate</span> - Returns the date after a given amount of minutes.
 
: [[API C_DateAndTime.CompareCalendarTime|C_DateAndTime.CompareCalendarTime]](<span class="apiarg">lhsCalendarTime, rhsCalendarTime</span>) : <span class="apiret">comparison</span> - Compares two dates with eachother.
 
: [[API C_DateAndTime.CompareCalendarTime|C_DateAndTime.CompareCalendarTime]](<span class="apiarg">lhsCalendarTime, rhsCalendarTime</span>) : <span class="apiret">comparison</span> - Compares two dates with eachother.
: [[API C_DateAndTime.GetCalendarTimeFromEpoch|C_DateAndTime.GetCalendarTimeFromEpoch]](<span class="apiarg">epoch</span>) : <span class="apiret">date</span> - Returns the date of a given amount of time since the UNIX epoch.
+
: [[API C_DateAndTime.GetCalendarTimeFromEpoch|C_DateAndTime.GetCalendarTimeFromEpoch]](<span class="apiarg">epoch</span>) : <span class="apiret">date</span> - Returns the date for a specified amount of time since the UNIX epoch for the OS time zone.
 
: [[API C_DateAndTime.GetCurrentCalendarTime|C_DateAndTime.GetCurrentCalendarTime]]() : <span class="apiret">date</span> - Returns the realm's current date and time.
 
: [[API C_DateAndTime.GetCurrentCalendarTime|C_DateAndTime.GetCurrentCalendarTime]]() : <span class="apiret">date</span> - Returns the realm's current date and time.
 
: [[API C_DateAndTime.GetSecondsUntilDailyReset|C_DateAndTime.GetSecondsUntilDailyReset]]() : <span class="apiret">seconds</span>
 
: [[API C_DateAndTime.GetSecondsUntilDailyReset|C_DateAndTime.GetSecondsUntilDailyReset]]() : <span class="apiret">seconds</span>
 
: [[API C_DateAndTime.GetSecondsUntilWeeklyReset|C_DateAndTime.GetSecondsUntilWeeklyReset]]() : <span class="apiret">seconds</span>
 
: [[API C_DateAndTime.GetSecondsUntilWeeklyReset|C_DateAndTime.GetSecondsUntilWeeklyReset]]() : <span class="apiret">seconds</span>
: [[API C_DateAndTime.GetServerTimeLocal|C_DateAndTime.GetServerTimeLocal]]() : <span class="apiret">serverTimeLocal</span> - Returns the server's Unix time offset by the server's UTC timezone.
+
: [[API C_DateAndTime.GetServerTimeLocal|C_DateAndTime.GetServerTimeLocal]]() : <span class="apiret">serverTimeLocal</span> - Returns the server's [[Wikipedia:Unix_time|Unix time]] offset by the server's timezone.
 
: [[API GetGameTime|GetGameTime]]() - Returns the realm's current time in hours and minutes.
 
: [[API GetGameTime|GetGameTime]]() - Returns the realm's current time in hours and minutes.
 
: [[API GetLocalGameTime|GetLocalGameTime]]()
 
: [[API GetLocalGameTime|GetLocalGameTime]]()
: [[API GetServerTime|GetServerTime]]() - Returns the server's Unix time.
+
: [[API GetServerTime|GetServerTime]]() - Returns the server's [[Wikipedia:Unix_time|Unix time]].
 
: [[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 of your computer in seconds, with millisecond precision.
 
: [[API GetTimePreciseSec|GetTimePreciseSec]]() - Returns a monotonic timestamp in seconds, with millisecond precision.
 
: [[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]]() - Requests a summary of time played.
: <small>Lua</small> [[API date|date]](<span class="apiarg">format, time</span>) - Returns the current date according to the user's machine.
+
: <small>''Lua''</small> [[API date|date]](<span class="apiarg">format, time</span>) - Returns the current date according to the user's machine.
: <small>Lua</small> [[API time|time]](<span class="apiarg">table</span>) - Returns a timestamp for the specified time or the current Unix time.
+
: <small>''Lua''</small> [[API time|time]](<span class="apiarg">table</span>) - Returns a timestamp for the specified time or the current Unix time.
   
==== Timers ====
+
====Timers====
: [[API C_Timer.After|C_Timer.After]](<span class="apiarg">duration, callback</span>) - Runs callback after given duration.
+
: [[API C_Timer.After|C_Timer.After]](<span class="apiarg">duration, callback</span>) - Schedules a timer.
: <small>UI</small> [[API C_Timer.NewTimer|C_Timer.NewTimer]](<span class="apiarg">duration, callback</span>) - Runs callback after given duration. (Cancelable)
+
: <small>''UI''</small> [[API C_Timer.NewTimer|C_Timer.NewTimer]](<span class="apiarg">duration, callback</span>) - Runs callback after given duration. (Cancelable)
: <small>UI</small> [[API C_Timer.NewTicker|C_Timer.NewTicker]](<span class="apiarg">duration, callback [, iterations]</span>) - Runs callback multiple times iterating every given duration. (Cancelable)
+
: <small>''UI''</small> [[API C_Timer.NewTicker|C_Timer.NewTicker]](<span class="apiarg">duration, callback [, iterations]</span>) - Runs callback multiple times iterating every given duration. (Cancelable)
   
==== Debugging ====
+
====Debugging====
 
: [[API AreDangerousScriptsAllowed|AreDangerousScriptsAllowed]]()
 
: [[API AreDangerousScriptsAllowed|AreDangerousScriptsAllowed]]()
 
: [[API DumpMovementCapture|DumpMovementCapture]]() - Used in the protected Commentator UI.
 
: [[API DumpMovementCapture|DumpMovementCapture]]() - Used in the protected Commentator UI.
Line 4,186: Line 4,222:
 
: [[API GetGameMessageInfo|GetGameMessageInfo]](<span class="apiarg">gameMessageType</span>) - Returns the error message for an id.
 
: [[API GetGameMessageInfo|GetGameMessageInfo]](<span class="apiarg">gameMessageType</span>) - Returns the error message for an id.
 
: [[API HandleAtlasMemberCommand|HandleAtlasMemberCommand]]()
 
: [[API HandleAtlasMemberCommand|HandleAtlasMemberCommand]]()
: [[API RunScript|RunScript]](<span class="apiarg">script</span>) - Execute "script" as a block of Lua code.
+
: [[API RunScript|RunScript]](<span class="apiarg">script</span>) - Executes a string of Lua code.
 
: [[API ScriptsDisallowedForBeta|ScriptsDisallowedForBeta]]()
 
: [[API ScriptsDisallowedForBeta|ScriptsDisallowedForBeta]]()
 
: [[API SetAllowDangerousScripts|SetAllowDangerousScripts]]()
 
: [[API SetAllowDangerousScripts|SetAllowDangerousScripts]]()
Line 4,194: Line 4,230:
 
: [[API debuglocals|debuglocals]]()
 
: [[API debuglocals|debuglocals]]()
 
: [[API debugprofilestart|debugprofilestart]]() - Starts a timer for profiling during debugging.
 
: [[API debugprofilestart|debugprofilestart]]() - Starts a timer for profiling during debugging.
: [[API debugprofilestop|debugprofilestop]]() - Returns the time in milliseconds since the last call to debugprofilestart()
+
: [[API debugprofilestop|debugprofilestop]]() - Returns the time in milliseconds since the last call to debugprofilestart().
 
: [[API debugstack|debugstack]](<span class="apiarg">start, count1, count2</span>) - Returns a string representation of the current calling stack.
 
: [[API debugstack|debugstack]](<span class="apiarg">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 class="apiarg">errFunc</span>) - Set the error handler to the given parameter.
+
: [[API seterrorhandler|seterrorhandler]](<span class="apiarg">errFunc</span>) - Sets the error handler to the given function.
: <small>UI</small> [https://www.townlong-yak.com/framexml/go/DevTools_Dump DevTools_Dump](<span class="apiarg">value [, startKey]</span>) - Pretty prints a variable or value. Equivalent to the [[MACRO dump|<code>/dump</code> macro]].
+
: <small>''UI''</small> [https://www.townlong-yak.com/framexml/go/DevTools_Dump DevTools_Dump](<span class="apiarg">value [, startKey]</span>) - Pretty prints a variable or value. Equivalent to the [[MACRO dump|<code>/dump</code> macro]].
: <small>UI</small> [[API print|print]](<span class="apiarg">...</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 class="apiarg">...</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 getprinthandler|getprinthandler]]() - Returns the function currently handling print() output.
+
: <small>''UI''</small> [[API getprinthandler|getprinthandler]]() - Returns the function currently handling print() output.
: <small>UI</small> [[API setprinthandler|setprinthandler]](<span class="apiarg">func</span>) - Changes the function handling print() output.
+
: <small>''UI''</small> [[API setprinthandler|setprinthandler]](<span class="apiarg">func</span>) - Changes the function handling print() output.
: <small>UI</small> [[API message|message]](<span class="apiarg">text</span>) - Displays a message box with your text message and an "Okay" button.
+
: <small>''UI''</small> [[API message|message]](<span class="apiarg">text</span>) - Displays a message box with your text message and an "Okay" button.
: <small>PROTECTED</small> [[API C_Debug.DashboardIsEnabled|C_Debug.DashboardIsEnabled]]()
+
: <small>''PROTECTED''</small> [[API C_Debug.DashboardIsEnabled|C_Debug.DashboardIsEnabled]]()
: <small>PROTECTED</small> [[API C_Debug.GetAllPortLocsForMap|C_Debug.GetAllPortLocsForMap]](<span class="apiarg">uiMapID</span>)
+
: <small>''PROTECTED''</small> [[API C_Debug.GetAllPortLocsForMap|C_Debug.GetAllPortLocsForMap]](<span class="apiarg">uiMapID</span>)
: <small>PROTECTED</small> [[API C_Debug.GetMapDebugObjects|C_Debug.GetMapDebugObjects]](<span class="apiarg">uiMapID</span>)
+
: <small>''PROTECTED''</small> [[API C_Debug.GetMapDebugObjects|C_Debug.GetMapDebugObjects]](<span class="apiarg">uiMapID</span>)
: <small>PROTECTED</small> [[API C_Debug.TeleportToMapDebugObject|C_Debug.TeleportToMapDebugObject]](<span class="apiarg">pinIndex</span>)
+
: <small>''PROTECTED''</small> [[API C_Debug.TeleportToMapDebugObject|C_Debug.TeleportToMapDebugObject]](<span class="apiarg">pinIndex</span>)
: <small>PROTECTED</small> [[API C_Debug.TeleportToMapLocation|C_Debug.TeleportToMapLocation]](<span class="apiarg">uiMapID, mapX, mapY</span>)
+
: <small>''PROTECTED''</small> [[API C_Debug.TeleportToMapLocation|C_Debug.TeleportToMapLocation]](<span class="apiarg">uiMapID, mapX, mapY</span>)
   
==== Graphics ====
+
====Graphics====
 
: [[API C_ScriptedAnimations.GetAllScriptedAnimationEffects|C_ScriptedAnimations.GetAllScriptedAnimationEffects]]() : <span class="apiret">scriptedAnimationEffects</span>
 
: [[API C_ScriptedAnimations.GetAllScriptedAnimationEffects|C_ScriptedAnimations.GetAllScriptedAnimationEffects]]() : <span class="apiret">scriptedAnimationEffects</span>
 
: [[API C_VideoOptions.GetGxAdapterInfo|C_VideoOptions.GetGxAdapterInfo]]() : <span class="apiret">adapters</span> - Returns info about the system's graphics adapter.
 
: [[API C_VideoOptions.GetGxAdapterInfo|C_VideoOptions.GetGxAdapterInfo]]() : <span class="apiret">adapters</span> - Returns info about the system's graphics adapter.
Line 4,215: Line 4,251:
 
: [[API AutoChooseCurrentGraphicsSetting|AutoChooseCurrentGraphicsSetting]]()
 
: [[API AutoChooseCurrentGraphicsSetting|AutoChooseCurrentGraphicsSetting]]()
 
: [[API GetCurrentGraphicsSetting|GetCurrentGraphicsSetting]]()
 
: [[API GetCurrentGraphicsSetting|GetCurrentGraphicsSetting]]()
: [[API GetCurrentResolution|GetCurrentResolution]]() - Get the index of the current screen resolution.
+
: [[API GetCurrentResolution|GetCurrentResolution]]() - Returns the index of the current screen resolution.
 
: [[API GetCurrentScaledResolution|GetCurrentScaledResolution]]()
 
: [[API GetCurrentScaledResolution|GetCurrentScaledResolution]]()
 
: [[API GetCVarSettingValidity|GetCVarSettingValidity]](<span class="apiarg">cvar, settingsCount [, isRaid]</span>)
 
: [[API GetCVarSettingValidity|GetCVarSettingValidity]](<span class="apiarg">cvar, settingsCount [, isRaid]</span>)
Line 4,231: Line 4,267:
 
: [[API GetPhysicalScreenSize|GetPhysicalScreenSize]]()
 
: [[API GetPhysicalScreenSize|GetPhysicalScreenSize]]()
 
: [[API GetScreenDPIScale|GetScreenDPIScale]]()
 
: [[API GetScreenDPIScale|GetScreenDPIScale]]()
: [[API GetScreenHeight|GetScreenHeight]]() - Returns the height of the window in pixels.
+
: [[API GetScreenHeight|GetScreenHeight]]() - Returns the height of the window in pixels, affected by UI scale.
 
: [[API GetScreenResolutions|GetScreenResolutions]]()
 
: [[API GetScreenResolutions|GetScreenResolutions]]()
: [[API GetScreenWidth|GetScreenWidth]]() - Returns the width of the window in pixels.
+
: [[API GetScreenWidth|GetScreenWidth]]() - Returns the width of the window in pixels, affected by UI scale.
 
: [[API GetToolTipInfo|GetToolTipInfo]](<span class="apiarg">1, size-1, cvar, validValue1, ...</span>) - Returns validity info for a graphics cvar.
 
: [[API GetToolTipInfo|GetToolTipInfo]](<span class="apiarg">1, size-1, cvar, validValue1, ...</span>) - Returns validity info for a graphics cvar.
 
: [[API GetVideoCaps|GetVideoCaps]]()
 
: [[API GetVideoCaps|GetVideoCaps]]()
Line 4,240: Line 4,276:
 
: [[API IsOutlineModeSupported|IsOutlineModeSupported]]()
 
: [[API IsOutlineModeSupported|IsOutlineModeSupported]]()
 
: [[API MultiSampleAntiAliasingSupported|MultiSampleAntiAliasingSupported]]()
 
: [[API MultiSampleAntiAliasingSupported|MultiSampleAntiAliasingSupported]]()
: [[API RestartGx|RestartGx]]() - Restarts the graphical engine. Needed for things such as resolution changes to take effect.
+
: [[API RestartGx|RestartGx]]() - Restarts the graphics engine.
 
: [[API SetCurrentGraphicsSetting|SetCurrentGraphicsSetting]](<span class="apiarg">setting{0=normal, 1=raid/BG}</span>)
 
: [[API SetCurrentGraphicsSetting|SetCurrentGraphicsSetting]](<span class="apiarg">setting{0=normal, 1=raid/BG}</span>)
 
: [[API SetDefaultVideoOptions|SetDefaultVideoOptions]](<span class="apiarg">value</span>)
 
: [[API SetDefaultVideoOptions|SetDefaultVideoOptions]](<span class="apiarg">value</span>)
Line 4,250: Line 4,286:
 
: [[API UpdateWindow|UpdateWindow]]() - When in windowed mode, updates the window. This also aligns it to the top of the screen and increases the size to max widowed size.
 
: [[API UpdateWindow|UpdateWindow]]() - When in windowed mode, updates the window. This also aligns it to the top of the screen and increases the size to max widowed size.
   
==== Locales ====
+
====Locales====
: [[API BreakUpLargeNumbers|BreakUpLargeNumbers]](<span class="apiarg">number [, natural]</span>) - Converts a number into a localized string, grouping digits as required.
+
: [[API BreakUpLargeNumbers|BreakUpLargeNumbers]](<span class="apiarg">number [, natural]</span>) - Divides digits into groups using a localized delimiter character.
: [[API DeclineName|DeclineName]](<span class="apiarg">name, gender, declensionSet</span>) - Returns suggested declensions for a German or Russian name.
+
: [[API DeclineName|DeclineName]](<span class="apiarg">name, gender, declensionSet</span>) - Returns suggested declensions for a Russian name.
 
: [[API GetAvailableLocaleInfo|GetAvailableLocaleInfo]](<span class="apiarg">ignoreLocaleRestrictions</span>)
 
: [[API GetAvailableLocaleInfo|GetAvailableLocaleInfo]](<span class="apiarg">ignoreLocaleRestrictions</span>)
 
: [[API GetAvailableLocales|GetAvailableLocales]](<span class="apiarg">ignoreLocaleRestrictions</span>)
 
: [[API GetAvailableLocales|GetAvailableLocales]](<span class="apiarg">ignoreLocaleRestrictions</span>)
: [[API GetLocale|GetLocale]]() - Returns client locale, example 'enUS'.
+
: [[API GetLocale|GetLocale]]() - Returns the game client locale.
: [[API GetNumDeclensionSets|GetNumDeclensionSets]](<span class="apiarg">name, gender</span>) - Returns the number of suggested declension sets for a German or Russian name.
+
: [[API GetNumDeclensionSets|GetNumDeclensionSets]](<span class="apiarg">name, gender</span>) - Returns the number of suggested declension sets for a Russian name.
 
: [[API GetOSLocale|GetOSLocale]]()
 
: [[API GetOSLocale|GetOSLocale]]()
: [[API GetText|GetText]]() - Used to localize some client text.
+
: [[API GetText|GetText]]() - Returns localized text depending on the specified gender.
 
: [[API IsEuropeanNumbers|IsEuropeanNumbers]]()
 
: [[API IsEuropeanNumbers|IsEuropeanNumbers]]()
 
: [[API SetEuropeanNumbers|SetEuropeanNumbers]](<span class="apiarg">flag</span>) - Sets the decimal separator to a comma instead of a dot.
 
: [[API SetEuropeanNumbers|SetEuropeanNumbers]](<span class="apiarg">flag</span>) - Sets the decimal separator to a comma instead of a dot.
   
==== Script Profiling ====
+
====Script Profiling====
 
Note: CPU profiling is disabled by default since it has some overhead. CPU profiling is controlled by the [[CVar_scriptProfile|scriptProfile]] cvar, which persists across sessions, and takes effect after a UI reload. Memory profiling is always available. These functions have been added in Patch 2.1.
 
Note: CPU profiling is disabled by default since it has some overhead. CPU profiling is controlled by the [[CVar_scriptProfile|scriptProfile]] cvar, which persists across sessions, and takes effect after a UI reload. Memory profiling is always available. These functions have been added in Patch 2.1.
: [[API GetAddOnCPUUsage|GetAddOnCPUUsage]](<span class="apiarg">index or name</span>) - Returns the total time used by the specified AddOn. This returns a cached value calculated by UpdateAddOnCPUUsage().
+
: [[API GetAddOnCPUUsage|GetAddOnCPUUsage]](<span class="apiarg">index or name</span>) - Returns the total time used for an addon.
 
: [[API GetAddOnMemoryUsage|GetAddOnMemoryUsage]](<span class="apiarg">index or name</span>) - Query an addon's memory use (in K, precision to 1 byte) - This returns a cached value calculated by UpdateAddOnMemoryUsage().
 
: [[API GetAddOnMemoryUsage|GetAddOnMemoryUsage]](<span class="apiarg">index or name</span>) - Query an addon's memory use (in K, precision to 1 byte) - This returns a cached value calculated by UpdateAddOnMemoryUsage().
 
: [[API GetEventCPUUsage|GetEventCPUUsage]](<span class="apiarg">[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 class="apiarg">[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 class="apiarg">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 class="apiarg">frame [, includeChildren]</span>) - Returns the total time used by and number of calls of a frame's event handlers.
 
: [[API GetFunctionCPUUsage|GetFunctionCPUUsage]](<span class="apiarg">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 GetFunctionCPUUsage|GetFunctionCPUUsage]](<span class="apiarg">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.
Line 4,274: Line 4,310:
 
: [[API UpdateAddOnMemoryUsage|UpdateAddOnMemoryUsage]]() - Scan through memory profiling data and update the per-addon statistics.
 
: [[API UpdateAddOnMemoryUsage|UpdateAddOnMemoryUsage]]() - Scan through memory profiling data and update the per-addon statistics.
   
==== Secure Execution ====
+
====Secure Execution====
 
Relates to [[Secure Execution and Tainting]].
 
Relates to [[Secure Execution and Tainting]].
: [[API forceinsecure|forceinsecure]]() - Taint the current execution path.
+
: [[API forceinsecure|forceinsecure]]() - Taints the current execution path.
: [[API hooksecurefunc|hooksecurefunc]](<span class="apiarg">[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 hooksecurefunc|hooksecurefunc]](<span class="apiarg">[table,] funcName, hookfunc</span>) - Securely posthooks the specified function. The hook will be called with the same arguments after the original call is performed.
: [[API InCombatLockdown|InCombatLockdown]]() - Returns true if the in-combat AddOn restrictions are active.
+
: [[API InCombatLockdown|InCombatLockdown]]() - True if the combat lockdown restrictions are active.
: [[API issecure|issecure]]() - Determine if the current environment is secure.
+
: [[API issecure|issecure]]() - True if the current execution path is secure.
: [[API issecurevariable|issecurevariable]](<span class="apiarg">[table,] name</span>) - Determine if the specified variable is secure.
+
: [[API issecurevariable|issecurevariable]](<span class="apiarg">[table,] name</span>) - True if the specified variable is secure.
 
: [[API scrub|scrub]](<span class="apiarg">...</span>) - Returns the argument list with non-number/boolean/string values changed to nil.
 
: [[API scrub|scrub]](<span class="apiarg">...</span>) - Returns the argument list with non-number/boolean/string values changed to nil.
: [[API securecall|securecall]](<span class="apiarg">function or functionName, ...</span>) - Call a function from a secure environment without risking secure status.
+
: [[API securecall|securecall]](<span class="apiarg">function or functionName, ...</span>) - Calls the specified function without propagating taint to the caller.
 
: [[API securecallfunction|securecallfunction]]()
 
: [[API securecallfunction|securecallfunction]]()
 
: [[API secureexecuterange|secureexecuterange]]()
 
: [[API secureexecuterange|secureexecuterange]]()
 
: [[API StoreSecureReference|StoreSecureReference]](<span class="apiarg">name, obj</span>)
 
: [[API StoreSecureReference|StoreSecureReference]](<span class="apiarg">name, obj</span>)
: <small>UI</small> [https://www.townlong-yak.com/framexml/go/CanAccessObject CanAccessObject](<span class="apiarg">obj</span>) - Returns true if an object is secure and not forbidden.
+
: <small>''UI''</small> [https://www.townlong-yak.com/framexml/go/CanAccessObject CanAccessObject](<span class="apiarg">obj</span>) - Returns true if an object is secure and not forbidden.
   
==== Sound ====
+
====Sound====
 
: [[API MuteSoundFile|MuteSoundFile]](<span class="apiarg">soundFile or fileDataID</span>) - Mutes a sound file.
 
: [[API MuteSoundFile|MuteSoundFile]](<span class="apiarg">soundFile or fileDataID</span>) - Mutes a sound file.
 
: [[API PlayMusic|PlayMusic]](<span class="apiarg">musicfile or fileDataID</span>) - Plays the specified sound file on loop to the "Music" sound channel.
 
: [[API PlayMusic|PlayMusic]](<span class="apiarg">musicfile or fileDataID</span>) - Plays the specified sound file on loop to the "Music" sound channel.
 
: [[API PlaySound|PlaySound]](<span class="apiarg">soundKitID [, channel, forceNoDuplicates, runFinishCallback]</span>) - Plays the specified sound by SoundKitID.
 
: [[API PlaySound|PlaySound]](<span class="apiarg">soundKitID [, channel, forceNoDuplicates, runFinishCallback]</span>) - Plays the specified sound by SoundKitID.
: [[API PlaySoundFile|PlaySoundFile]](<span class="apiarg">soundFile or soundFileID [, channel]</span>) - Plays the specified sound by [[FileDataID]] or by addon file path.
+
: [[API PlaySoundFile|PlaySoundFile]](<span class="apiarg">soundFile or soundFileID [, channel]</span>) - Plays the specified sound by [[FileDataID]] or addon file path.
 
: [[API PlayVocalErrorSoundID|PlayVocalErrorSoundID]](<span class="apiarg">vocalErrorSoundID</span>)
 
: [[API PlayVocalErrorSoundID|PlayVocalErrorSoundID]](<span class="apiarg">vocalErrorSoundID</span>)
 
: [[API StopMusic|StopMusic]]() - Stops the currently playing music.
 
: [[API StopMusic|StopMusic]]() - Stops the currently playing music.
Line 4,308: Line 4,344:
 
: [[API Sound_GameSystem_RestartSoundSystem|Sound_GameSystem_RestartSoundSystem]]()
 
: [[API Sound_GameSystem_RestartSoundSystem|Sound_GameSystem_RestartSoundSystem]]()
   
==== Util ====
+
====Util====
 
: [[API CalculateStringEditDistance|CalculateStringEditDistance]](<span class="apiarg">firstString, secondString</span>) - Returns [https://en.wikipedia.org/wiki/Levenshtein_distance Levenshtein] distance.
 
: [[API CalculateStringEditDistance|CalculateStringEditDistance]](<span class="apiarg">firstString, secondString</span>) - Returns [https://en.wikipedia.org/wiki/Levenshtein_distance Levenshtein] distance.
 
: [[API CaseAccentInsensitiveParse|CaseAccentInsensitiveParse]](<span class="apiarg">string</span>) - Converts a string with accented letters to lowercase.
 
: [[API CaseAccentInsensitiveParse|CaseAccentInsensitiveParse]](<span class="apiarg">string</span>) - Converts a string with accented letters to lowercase.
   
=== Spectator Mode ===
+
===Spectator Mode===
 
: [[API C_Commentator.AddPlayerOverrideName|C_Commentator.AddPlayerOverrideName]](<span class="apiarg">playerName, overrideName</span>)
 
: [[API C_Commentator.AddPlayerOverrideName|C_Commentator.AddPlayerOverrideName]](<span class="apiarg">playerName, overrideName</span>)
 
: [[API C_Commentator.AddTrackedDefensiveAuras|C_Commentator.AddTrackedDefensiveAuras]](<span class="apiarg">spellIDs</span>)
 
: [[API C_Commentator.AddTrackedDefensiveAuras|C_Commentator.AddTrackedDefensiveAuras]](<span class="apiarg">spellIDs</span>)
Line 4,447: Line 4,483:
 
: [[API C_Commentator.ZoomOut|C_Commentator.ZoomOut]]()
 
: [[API C_Commentator.ZoomOut|C_Commentator.ZoomOut]]()
   
=== Tutorials ===
+
===Tutorials===
 
: [[API C_PlayerInfo.IsPlayerEligibleForNPE|C_PlayerInfo.IsPlayerEligibleForNPE]]() : <span class="apiret">isEligible, failureReason</span>
 
: [[API C_PlayerInfo.IsPlayerEligibleForNPE|C_PlayerInfo.IsPlayerEligibleForNPE]]() : <span class="apiret">isEligible, failureReason</span>
 
: [[API C_PlayerInfo.IsPlayerEligibleForNPEv2|C_PlayerInfo.IsPlayerEligibleForNPEv2]]() : <span class="apiret">isEligible, failureReason</span>
 
: [[API C_PlayerInfo.IsPlayerEligibleForNPEv2|C_PlayerInfo.IsPlayerEligibleForNPEv2]]() : <span class="apiret">isEligible, failureReason</span>
Line 4,454: Line 4,490:
 
: [[API C_SplashScreen.CanViewSplashScreen|C_SplashScreen.CanViewSplashScreen]]() : <span class="apiret">canView</span>
 
: [[API C_SplashScreen.CanViewSplashScreen|C_SplashScreen.CanViewSplashScreen]]() : <span class="apiret">canView</span>
 
: [[API C_SplashScreen.RequestLatestSplashScreen|C_SplashScreen.RequestLatestSplashScreen]](<span class="apiarg">fromGameMenu</span>)
 
: [[API C_SplashScreen.RequestLatestSplashScreen|C_SplashScreen.RequestLatestSplashScreen]](<span class="apiarg">fromGameMenu</span>)
: [[API C_StableInfo.GetNumActivePets|C_StableInfo.GetNumActivePets]]() : <span class="apiret">numActivePets</span>
 
: [[API C_StableInfo.GetNumStablePets|C_StableInfo.GetNumStablePets]]() : <span class="apiret">numStablePets</span>
 
 
: [[API C_Tutorial.AbandonTutorialArea|C_Tutorial.AbandonTutorialArea]]()
 
: [[API C_Tutorial.AbandonTutorialArea|C_Tutorial.AbandonTutorialArea]]()
 
: [[API C_Tutorial.ReturnToTutorialArea|C_Tutorial.ReturnToTutorialArea]]()
 
: [[API C_Tutorial.ReturnToTutorialArea|C_Tutorial.ReturnToTutorialArea]]()
Line 4,474: Line 4,508:
 
: [[API TriggerTutorial|TriggerTutorial]](<span class="apiarg">tutorial</span>)
 
: [[API TriggerTutorial|TriggerTutorial]](<span class="apiarg">tutorial</span>)
   
=== UI Objects ===
+
===UI Objects===
: [[API GetFileIDFromPath|GetFileIDFromPath]](<span class="apiarg">filePath</span>) - Returns the fileID corresponding to the given game file path (texture, sound, model, etc.).
+
: [[API GetFileIDFromPath|GetFileIDFromPath]](<span class="apiarg">filePath</span>) - Returns the FileID for an Interface file path.
 
: [[API SetUIVisibility|SetUIVisibility]](<span class="apiarg">visible</span>) - Hides or shows the entire UI.
 
: [[API SetUIVisibility|SetUIVisibility]](<span class="apiarg">visible</span>) - Hides or shows the entire UI.
: <small>UI</small> [[API EasyMenu|EasyMenu]](<span class="apiarg">menuList, menuFrame, anchor, x, y, displayMode, autoHideDelay</span>)
+
: <small>''UI''</small> [[API EasyMenu|EasyMenu]](<span class="apiarg">menuList, menuFrame, anchor, x, y, displayMode, autoHideDelay</span>)
: <small>UI</small> [[API ToggleDropDownMenu|ToggleDropDownMenu]](<span class="apiarg">level, value, dropDownFrame, anchorName, xOffset, yOffset</span>)
+
: <small>''UI''</small> [[API ToggleDropDownMenu|ToggleDropDownMenu]](<span class="apiarg">level, value, dropDownFrame, anchorName, xOffset, yOffset</span>)
   
==== Frame ====
+
====Frame====
 
: [[API C_FrameManager.GetFrameVisibilityState|C_FrameManager.GetFrameVisibilityState]](<span class="apiarg">frameType</span>) : <span class="apiret">shouldShow</span>
 
: [[API C_FrameManager.GetFrameVisibilityState|C_FrameManager.GetFrameVisibilityState]](<span class="apiarg">frameType</span>) : <span class="apiret">shouldShow</span>
: [[API CreateFrame|CreateFrame]](<span class="apiarg">frameType [, frameName, parentFrame, inheritsFrame, id]</span>) - Create a new frame of the specified type.
+
: [[API CreateFrame|CreateFrame]](<span class="apiarg">frameType [, frameName, parentFrame, inheritsFrame, id]</span>) - Creates a {{api|t=o|Frame}} object.
 
: [[API DoesTemplateExist|DoesTemplateExist]](<span class="apiarg">template</span>) - Returns if a virtual frame template exists.
 
: [[API DoesTemplateExist|DoesTemplateExist]](<span class="apiarg">template</span>) - Returns if a virtual frame template exists.
: [[API EnumerateFrames|EnumerateFrames]](<span class="apiarg">currentFrame</span>) - Get the Frame which follows currentFrame.
+
: [[API EnumerateFrames|EnumerateFrames]](<span class="apiarg">currentFrame</span>) - Returns the frame which follows the current frame.
 
: [[API GetClickFrame|GetClickFrame]](<span class="apiarg">name</span>)
 
: [[API GetClickFrame|GetClickFrame]](<span class="apiarg">name</span>)
 
: [[API GetCurrentKeyBoardFocus|GetCurrentKeyBoardFocus]]() - Returns the [editbox] widget currently handling keyboard events.
 
: [[API GetCurrentKeyBoardFocus|GetCurrentKeyBoardFocus]]() - Returns the [editbox] widget currently handling keyboard events.
 
: [[API GetDefaultScale|GetDefaultScale]]()
 
: [[API GetDefaultScale|GetDefaultScale]]()
: [[API GetFramesRegisteredForEvent|GetFramesRegisteredForEvent]](<span class="apiarg">event</span>) - Returns a list of frames that are registered for the given event.
+
: [[API GetFramesRegisteredForEvent|GetFramesRegisteredForEvent]](<span class="apiarg">event</span>) - Returns all frames registered for the specified event, in dispatch order.
 
: [[API GetMouseButtonName|GetMouseButtonName]]()
 
: [[API GetMouseButtonName|GetMouseButtonName]]()
 
: [[API GetMouseClickFocus|GetMouseClickFocus]]()
 
: [[API GetMouseClickFocus|GetMouseClickFocus]]()
: [[API GetMouseFocus|GetMouseFocus]]() - Returns the frame that currently has the mouse focus.
+
: [[API GetMouseFocus|GetMouseFocus]]() - Returns the frame that currently has mouse focus.
 
: [[API GetMouseMotionFocus|GetMouseMotionFocus]]()
 
: [[API GetMouseMotionFocus|GetMouseMotionFocus]]()
 
: [[API GetNumFrames|GetNumFrames]]() - Get the current number of Frame (and derivative) objects.
 
: [[API GetNumFrames|GetNumFrames]]() - Get the current number of Frame (and derivative) objects.
: [[API SetupFullscreenScale|SetupFullscreenScale]](<span class="apiarg">frame</span>) - Configures scale of full-screen views, such as the world map, to best fill screen.
+
: [[API SetupFullscreenScale|SetupFullscreenScale]](<span class="apiarg">frame</span>) - Sizes a frame to take up the entire screen regardless of screen resolution.
: <small>UI</small> [[API MouseIsOver|MouseIsOver]](<span class="apiarg">region, topOffset, bottomOffset, leftOffset, rightOffset</span>) - Checks whether the mouse is over the frame (or within specified offsets).
+
: <small>''UI''</small> [[API MouseIsOver|MouseIsOver]](<span class="apiarg">region, topOffset, bottomOffset, leftOffset, rightOffset</span>) - Checks whether the mouse is over the frame (or within specified offsets).
: <small>UI</small> [[API UIFrameFadeIn|UIFrameFadeIn]](<span class="apiarg">frame, timeToFade, startAlpha, endAlpha</span>) - Fades a frame in.
+
: <small>''UI''</small> [[API UIFrameFadeIn|UIFrameFadeIn]](<span class="apiarg">frame, timeToFade, startAlpha, endAlpha</span>) - Fades a frame in.
: <small>UI</small> [[API UIFrameFadeOut|UIFrameFadeOut]](<span class="apiarg">frame, timeToFade, startAlpha, endAlpha</span>) - Fades a frame out.
+
: <small>''UI''</small> [[API UIFrameFadeOut|UIFrameFadeOut]](<span class="apiarg">frame, timeToFade, startAlpha, endAlpha</span>) - Fades a frame out.
   
==== Font ====
+
====Font====
: [[API CreateFont|CreateFont]](<span class="apiarg">name</span>) - Dynamically creates a font object.
+
: [[API CreateFont|CreateFont]](<span class="apiarg">name</span>) - Creates a {{api|t=o|Font}} object.
 
: [[API GetFontInfo|GetFontInfo]](<span class="apiarg">font or name</span>)
 
: [[API GetFontInfo|GetFontInfo]](<span class="apiarg">font or name</span>)
: [[API GetFonts|GetFonts]]() - Returns all available fonts.
+
: [[API GetFonts|GetFonts]]() - Returns a list of available fonts.
   
==== Texture ====
+
====Texture====
 
: [[API C_Texture.GetAtlasInfo|C_Texture.GetAtlasInfo]](<span class="apiarg">atlas</span>) : <span class="apiret">info</span> - Returns atlas info.
 
: [[API C_Texture.GetAtlasInfo|C_Texture.GetAtlasInfo]](<span class="apiarg">atlas</span>) : <span class="apiret">info</span> - Returns atlas info.
 
: [[API GetObjectIconTextureCoords|GetObjectIconTextureCoords]](<span class="apiarg">textureIndex</span>)
 
: [[API GetObjectIconTextureCoords|GetObjectIconTextureCoords]](<span class="apiarg">textureIndex</span>)
 
: [[API SetPortraitTexture|SetPortraitTexture]](<span class="apiarg">textureObject, unitToken</span>) - Sets a texture to a unit's 2D portrait.
 
: [[API SetPortraitTexture|SetPortraitTexture]](<span class="apiarg">textureObject, unitToken</span>) - Sets a texture to a unit's 2D portrait.
 
: [[API SetPortraitToTexture|SetPortraitToTexture]](<span class="apiarg">textureObject, texturePath</span>) - Applies a circular mask to a texture, making it resemble a portrait.
 
: [[API SetPortraitToTexture|SetPortraitToTexture]](<span class="apiarg">textureObject, texturePath</span>) - Applies a circular mask to a texture, making it resemble a portrait.
: <small>UI</small> [https://www.townlong-yak.com/framexml/go/CreateAtlasMarkup CreateAtlasMarkup](<span class="apiarg">atlasName [, height, width, offsetX, offsetY]</span>) - Returns a texture fontstring for an atlas.
+
: <small>''UI''</small> [https://www.townlong-yak.com/framexml/go/CreateAtlasMarkup CreateAtlasMarkup](<span class="apiarg">atlasName [, height, width, offsetX, offsetY]</span>) - Returns a texture fontstring for an atlas.
: <small>UI</small> [https://www.townlong-yak.com/framexml/go/CreateTextureMarkup CreateTextureMarkup](<span class="apiarg">file, fileWidth, fileHeight, width, height, left, right, top, bottom [, xOffset, yOffset]</span>) - Returns a texture fontstring.
+
: <small>''UI''</small> [https://www.townlong-yak.com/framexml/go/CreateTextureMarkup CreateTextureMarkup](<span class="apiarg">file, fileWidth, fileHeight, width, height, left, right, top, bottom [, xOffset, yOffset]</span>) - Returns a texture fontstring.
: <small>UI</small> [https://www.townlong-yak.com/framexml/go/GetTextureInfo GetTextureInfo](<span class="apiarg">obj</span>) - Returns the type and info of a texture.
+
: <small>''UI''</small> [https://www.townlong-yak.com/framexml/go/GetTextureInfo GetTextureInfo](<span class="apiarg">obj</span>) - Returns the type and info of a texture.
   
==== ModelScene ====
+
====ModelScene====
 
: [[API C_ModelInfo.AddActiveModelScene|C_ModelInfo.AddActiveModelScene]](<span class="apiarg">modelSceneFrame, modelSceneID</span>)
 
: [[API C_ModelInfo.AddActiveModelScene|C_ModelInfo.AddActiveModelScene]](<span class="apiarg">modelSceneFrame, modelSceneID</span>)
 
: [[API C_ModelInfo.AddActiveModelSceneActor|C_ModelInfo.AddActiveModelSceneActor]](<span class="apiarg">modelSceneFrameActor, modelSceneActorID</span>)
 
: [[API C_ModelInfo.AddActiveModelSceneActor|C_ModelInfo.AddActiveModelSceneActor]](<span class="apiarg">modelSceneFrameActor, modelSceneActorID</span>)
Line 4,524: Line 4,558:
 
: [[API GetUICameraInfo|GetUICameraInfo]](<span class="apiarg">uiCameraID</span>)
 
: [[API GetUICameraInfo|GetUICameraInfo]](<span class="apiarg">uiCameraID</span>)
   
==== Blizzard ====
+
====Blizzard====
 
Used internally for the Blizzard_PrototypeDialog addon.
 
Used internally for the Blizzard_PrototypeDialog addon.
 
: [[API C_PrototypeDialog.EnsureRemoved|C_PrototypeDialog.EnsureRemoved]](<span class="apiarg">instanceID</span>)
 
: [[API C_PrototypeDialog.EnsureRemoved|C_PrototypeDialog.EnsureRemoved]](<span class="apiarg">instanceID</span>)
 
: [[API C_PrototypeDialog.SelectOption|C_PrototypeDialog.SelectOption]](<span class="apiarg">instanceID, optionIndex</span>)
 
: [[API C_PrototypeDialog.SelectOption|C_PrototypeDialog.SelectOption]](<span class="apiarg">instanceID, optionIndex</span>)
   
==== Toasts ====
+
====Toasts====
 
: [[API C_EventToastManager.GetLevelUpDisplayToastsFromLevel|C_EventToastManager.GetLevelUpDisplayToastsFromLevel]](<span class="apiarg">level</span>) : <span class="apiret">toastInfo</span>
 
: [[API C_EventToastManager.GetLevelUpDisplayToastsFromLevel|C_EventToastManager.GetLevelUpDisplayToastsFromLevel]](<span class="apiarg">level</span>) : <span class="apiret">toastInfo</span>
 
: [[API C_EventToastManager.GetNextToastToDisplay|C_EventToastManager.GetNextToastToDisplay]]() : <span class="apiret">toastInfo</span>
 
: [[API C_EventToastManager.GetNextToastToDisplay|C_EventToastManager.GetNextToastToDisplay]]() : <span class="apiret">toastInfo</span>
 
: [[API C_EventToastManager.RemoveCurrentToast|C_EventToastManager.RemoveCurrentToast]]()
 
: [[API C_EventToastManager.RemoveCurrentToast|C_EventToastManager.RemoveCurrentToast]]()
   
=== Macbook Pro Notch ===
+
====Macbook Pro Notch====
 
: [[API C_UI.DoesAnyDisplayHaveNotch|C_UI.DoesAnyDisplayHaveNotch]]() : <span class="apiret">notchPresent</span>
 
: [[API C_UI.DoesAnyDisplayHaveNotch|C_UI.DoesAnyDisplayHaveNotch]]() : <span class="apiret">notchPresent</span>
 
: [[API C_UI.GetTopLeftNotchSafeRegion|C_UI.GetTopLeftNotchSafeRegion]]() : <span class="apiret">left, right, top, bottom</span>
 
: [[API C_UI.GetTopLeftNotchSafeRegion|C_UI.GetTopLeftNotchSafeRegion]]() : <span class="apiret">left, right, top, bottom</span>
Line 4,540: Line 4,574:
 
: [[API C_UI.ShouldUIParentAvoidNotch|C_UI.ShouldUIParentAvoidNotch]]() : <span class="apiret">willAvoidNotch</span>
 
: [[API C_UI.ShouldUIParentAvoidNotch|C_UI.ShouldUIParentAvoidNotch]]() : <span class="apiret">willAvoidNotch</span>
   
=== UI Widget Manager ===
+
===UI Widget Manager===
 
The UI widget system was added in [[Patch_8.0.1/API_changes|Patch 8.0.1]] to replace the WorldStateFrame. It renders the UI elements used for e.g. PvP objectives.
 
The UI widget system was added in [[Patch_8.0.1/API_changes|Patch 8.0.1]] to replace the WorldStateFrame. It renders the UI elements used for e.g. PvP objectives.
   
  +
WidgetSet
Position
 
 
: [[API C_UIWidgetManager.GetAllWidgetsBySetID|C_UIWidgetManager.GetAllWidgetsBySetID]](<span class="apiarg">setID</span>) : <span class="apiret">widgets</span> - Returns all widgets for a widget set ID.
 
: [[API C_UIWidgetManager.GetAllWidgetsBySetID|C_UIWidgetManager.GetAllWidgetsBySetID]](<span class="apiarg">setID</span>) : <span class="apiret">widgets</span> - Returns all widgets for a widget set ID.
 
: [[API C_UIWidgetManager.GetBelowMinimapWidgetSetID|C_UIWidgetManager.GetBelowMinimapWidgetSetID]]() : <span class="apiret">setID</span>
 
: [[API C_UIWidgetManager.GetBelowMinimapWidgetSetID|C_UIWidgetManager.GetBelowMinimapWidgetSetID]]() : <span class="apiret">setID</span>
Line 4,550: Line 4,584:
 
: [[API C_UIWidgetManager.GetTopCenterWidgetSetID|C_UIWidgetManager.GetTopCenterWidgetSetID]]() : <span class="apiret">setID</span> - Returns the widget set ID for the top center part of the screen.
 
: [[API C_UIWidgetManager.GetTopCenterWidgetSetID|C_UIWidgetManager.GetTopCenterWidgetSetID]]() : <span class="apiret">setID</span> - Returns the widget set ID for the top center part of the screen.
 
: [[API C_UIWidgetManager.GetWidgetSetInfo|C_UIWidgetManager.GetWidgetSetInfo]](<span class="apiarg">widgetSetID</span>) : <span class="apiret">widgetSetInfo</span>
 
: [[API C_UIWidgetManager.GetWidgetSetInfo|C_UIWidgetManager.GetWidgetSetInfo]](<span class="apiarg">widgetSetID</span>) : <span class="apiret">widgetSetInfo</span>
  +
: [[API C_TaskQuest.GetUIWidgetSetIDFromQuestID|C_TaskQuest.GetUIWidgetSetIDFromQuestID]](<span class="apiarg">questID</span>) : <span class="apiret">UiWidgetSetID</span>
  +
: [[API UnitWidgetSet|UnitWidgetSet]](<span class="apiarg">unit</span>) : <span class="apiret">uiWidgetSet</span>
 
Visualization
 
Visualization
 
: [[API C_UIWidgetManager.GetBulletTextListWidgetVisualizationInfo|C_UIWidgetManager.GetBulletTextListWidgetVisualizationInfo]](<span class="apiarg">widgetID</span>) : <span class="apiret">widgetInfo</span>
 
: [[API C_UIWidgetManager.GetBulletTextListWidgetVisualizationInfo|C_UIWidgetManager.GetBulletTextListWidgetVisualizationInfo]](<span class="apiarg">widgetID</span>) : <span class="apiret">widgetInfo</span>
Line 4,580: Line 4,616:
 
: [[API C_UIWidgetManager.SetProcessingUnitGuid|C_UIWidgetManager.SetProcessingUnitGuid]](<span class="apiarg">[unit]</span>)
 
: [[API C_UIWidgetManager.SetProcessingUnitGuid|C_UIWidgetManager.SetProcessingUnitGuid]](<span class="apiarg">[unit]</span>)
 
: [[API C_UIWidgetManager.UnregisterUnitForWidgetUpdates|C_UIWidgetManager.UnregisterUnitForWidgetUpdates]](<span class="apiarg">unitToken [, isGuid]</span>)
 
: [[API C_UIWidgetManager.UnregisterUnitForWidgetUpdates|C_UIWidgetManager.UnregisterUnitForWidgetUpdates]](<span class="apiarg">unitToken [, isGuid]</span>)
: [[API C_TaskQuest.GetUIWidgetSetIDFromQuestID|C_TaskQuest.GetUIWidgetSetIDFromQuestID]](<span class="apiarg">questID</span>) : <span class="apiret">UiWidgetSetID</span>
 
 
: [[API C_Widget.IsFrameWidget|C_Widget.IsFrameWidget]]()
 
: [[API C_Widget.IsFrameWidget|C_Widget.IsFrameWidget]]()
 
: [[API C_Widget.IsRenderableWidget|C_Widget.IsRenderableWidget]]()
 
: [[API C_Widget.IsRenderableWidget|C_Widget.IsRenderableWidget]]()
 
: [[API C_Widget.IsWidget|C_Widget.IsWidget]](<span class="apiarg">object</span>)
 
: [[API C_Widget.IsWidget|C_Widget.IsWidget]](<span class="apiarg">object</span>)
: [[API UnitWidgetSet|UnitWidgetSet]](<span class="apiarg">unit</span>) : <span class="apiret">uiWidgetSet</span>
 
   
=== Units ===
+
===Units===
 
These are functions which act on one or more units. Units are identified by [[UnitId]]s.
 
These are functions which act on one or more units. Units are identified by [[UnitId]]s.
 
: [[API C_PlayerInfo.GetContentDifficultyCreatureForPlayer|C_PlayerInfo.GetContentDifficultyCreatureForPlayer]](<span class="apiarg">unitToken</span>) : <span class="apiret">difficulty</span>
 
: [[API C_PlayerInfo.GetContentDifficultyCreatureForPlayer|C_PlayerInfo.GetContentDifficultyCreatureForPlayer]](<span class="apiarg">unitToken</span>) : <span class="apiret">difficulty</span>
: [[API GetThreatStatusColor|GetThreatStatusColor]](<span class="apiarg">status</span>) - Returns RGB values for a given UnitThreatSituation return value.
+
: [[API GetThreatStatusColor|GetThreatStatusColor]](<span class="apiarg">status</span>) - Returns the color for a threat status.
 
: [[API GetUnitChargedPowerPoints|GetUnitChargedPowerPoints]](<span class="apiarg">unit</span>) : <span class="apiret">pointIndices</span>
 
: [[API GetUnitChargedPowerPoints|GetUnitChargedPowerPoints]](<span class="apiarg">unit</span>) : <span class="apiret">pointIndices</span>
: [[API GetUnitSpeed|GetUnitSpeed]](<span class="apiarg">unit</span>) - Returns the moving speed of the unit.
+
: [[API GetUnitSpeed|GetUnitSpeed]](<span class="apiarg">unit</span>) - Returns the movement speed of the unit.
: [[API UnitAffectingCombat|UnitAffectingCombat]](<span class="apiarg">unit</span>) - Determine if the unit is in combat or has aggro. (returns nil if "false" and 1 if "true")
+
: [[API UnitAffectingCombat|UnitAffectingCombat]](<span class="apiarg">unit</span>) - True if the unit is in combat.
: [[API UnitArmor|UnitArmor]](<span class="apiarg">unit</span>) - Returns the armor statistics relevant to the specified unit.
+
: [[API UnitArmor|UnitArmor]](<span class="apiarg">unit</span>) - Returns the armor stats for the unit.
 
: [[API UnitAttackPower|UnitAttackPower]](<span class="apiarg">unit</span>) - Returns the unit's melee attack power and modifiers.
 
: [[API UnitAttackPower|UnitAttackPower]](<span class="apiarg">unit</span>) - Returns the unit's melee attack power and modifiers.
 
: [[API UnitAttackSpeed|UnitAttackSpeed]](<span class="apiarg">unit</span>) - Returns the unit's melee attack speed for each hand.
 
: [[API UnitAttackSpeed|UnitAttackSpeed]](<span class="apiarg">unit</span>) - Returns the unit's melee attack speed for each hand.
Line 4,602: Line 4,636:
 
: [[API UnitCastingInfo|UnitCastingInfo]](<span class="apiarg">unit</span>) - Returns information about the spell currently being cast by the specified unit.
 
: [[API UnitCastingInfo|UnitCastingInfo]](<span class="apiarg">unit</span>) - Returns information about the spell currently being cast by the specified unit.
 
: [[API UnitChannelInfo|UnitChannelInfo]](<span class="apiarg">unit</span>) - Returns information about the spell currently being channeled by the specified unit.
 
: [[API UnitChannelInfo|UnitChannelInfo]](<span class="apiarg">unit</span>) - Returns information about the spell currently being channeled by the specified unit.
: [[API UnitClass|UnitClass]](<span class="apiarg">unit</span>) : <span class="apiret">className, classFilename, classID</span> - Returns the class name of the specified unit (e.g., "Warrior" or "Shaman").
+
: [[API UnitClass|UnitClass]](<span class="apiarg">unit</span>) : <span class="apiret">className, classFilename, classID</span> - Returns the class of the unit.
 
: [[API UnitClassBase|UnitClassBase]](<span class="apiarg">unit</span>) : <span class="apiret">classFilename, classID</span>
 
: [[API UnitClassBase|UnitClassBase]](<span class="apiarg">unit</span>) : <span class="apiret">classFilename, classID</span>
 
: [[API UnitClassification|UnitClassification]](<span class="apiarg">unit</span>) - Returns the classification of the specified unit (e.g., "elite" or "worldboss").
 
: [[API UnitClassification|UnitClassification]](<span class="apiarg">unit</span>) - Returns the classification of the specified unit (e.g., "elite" or "worldboss").
: [[API UnitCreatureFamily|UnitCreatureFamily]](<span class="apiarg">unit</span>) - Returns the type of creature of the specified unit (e.g., "Crab").
+
: [[API UnitCreatureFamily|UnitCreatureFamily]](<span class="apiarg">unit</span>) - Returns the creature type of the unit (e.g. Crab).
: [[API UnitCreatureType|UnitCreatureType]](<span class="apiarg">unit</span>) - Returns the classification type of creature of the specified unit (e.g., "Beast").
+
: [[API UnitCreatureType|UnitCreatureType]](<span class="apiarg">unit</span>) - Returns the creature classification type of the unit (e.g. Beast).
: [[API UnitDamage|UnitDamage]](<span class="apiarg">unit</span>) - Returns the damage statistics relevant to the specified unit.
+
: [[API UnitDamage|UnitDamage]](<span class="apiarg">unit</span>) - Returns the damage stats for the unit.
: [[API UnitDetailedThreatSituation|UnitDetailedThreatSituation]](<span class="apiarg">unit, unitMob</span>) - Returns detailed information about the specified unit's threat on a mob.
+
: [[API UnitDetailedThreatSituation|UnitDetailedThreatSituation]](<span class="apiarg">unit, unitMob</span>) - Returns detailed info for the threat status of one unit against another.
 
: [[API UnitEffectiveLevel|UnitEffectiveLevel]](<span class="apiarg">unit</span>) - Returns the unit's effective (scaled) level.
 
: [[API UnitEffectiveLevel|UnitEffectiveLevel]](<span class="apiarg">unit</span>) - Returns the unit's effective (scaled) level.
: [[API UnitExists|UnitExists]](<span class="apiarg">unit</span>) - Returns 1 if the specified unit exists, nil otherwise.
+
: [[API UnitExists|UnitExists]](<span class="apiarg">unit</span>) - True if the unit exists.
: [[API UnitFactionGroup|UnitFactionGroup]](<span class="apiarg">unit</span>) - Returns the faction group id and name of the specified unit. (eg. "Alliance") - string returned is localization-independent (used in filepath)
+
: [[API UnitFactionGroup|UnitFactionGroup]](<span class="apiarg">unit</span>) - Returns the faction (Horde/Alliance) a unit belongs to.
 
: [[API UnitFullName|UnitFullName]](<span class="apiarg">unit</span>) - Returns the player's (unit's) name and server.
 
: [[API UnitFullName|UnitFullName]](<span class="apiarg">unit</span>) - Returns the player's (unit's) name and server.
 
: [[API UnitGetAvailableRoles|UnitGetAvailableRoles]]()
 
: [[API UnitGetAvailableRoles|UnitGetAvailableRoles]]()
Line 4,618: Line 4,652:
 
: [[API UnitGetTotalHealAbsorbs|UnitGetTotalHealAbsorbs]](<span class="apiarg">unit</span>) - Returns the total amount of healing the unit can absorb without gaining health.
 
: [[API UnitGetTotalHealAbsorbs|UnitGetTotalHealAbsorbs]](<span class="apiarg">unit</span>) - Returns the total amount of healing the unit can absorb without gaining health.
 
: [[API UnitGroupRolesAssigned|UnitGroupRolesAssigned]](<span class="apiarg">unit</span>) - Returns the assigned role in a group formed via the Dungeon Finder Tool.
 
: [[API UnitGroupRolesAssigned|UnitGroupRolesAssigned]](<span class="apiarg">unit</span>) - Returns the assigned role in a group formed via the Dungeon Finder Tool.
: [[API UnitGUID|UnitGUID]](<span class="apiarg">unit</span>) - Returns the GUID as a string for the specified unit matching the GUIDs used by the new combat logs.
+
: [[API UnitGUID|UnitGUID]](<span class="apiarg">unit</span>) - Returns the GUID of the unit.
: [[API UnitHasIncomingResurrection|UnitHasIncomingResurrection]](<span class="apiarg">unit</span>) - Returns whether the unit is currently being resurrected.
+
: [[API UnitHasIncomingResurrection|UnitHasIncomingResurrection]](<span class="apiarg">unit</span>) - True if the unit is currently being resurrected.
 
: [[API UnitHasLFGDeserter|UnitHasLFGDeserter]](<span class="apiarg">unit</span>) - Returns whether the unit is currently unable to use the dungeon finder due to leaving a group prematurely.
 
: [[API UnitHasLFGDeserter|UnitHasLFGDeserter]](<span class="apiarg">unit</span>) - Returns whether the unit is currently unable to use the dungeon finder due to leaving a group prematurely.
 
: [[API UnitHasLFGRandomCooldown|UnitHasLFGRandomCooldown]](<span class="apiarg">unit</span>) - Returns whether the unit is currently under the effects of the random dungeon cooldown.
 
: [[API UnitHasLFGRandomCooldown|UnitHasLFGRandomCooldown]](<span class="apiarg">unit</span>) - Returns whether the unit is currently under the effects of the random dungeon cooldown.
 
: [[API UnitHasRelicSlot|UnitHasRelicSlot]](<span class="apiarg">unit</span>)
 
: [[API UnitHasRelicSlot|UnitHasRelicSlot]](<span class="apiarg">unit</span>)
: [[API UnitHealth|UnitHealth]](<span class="apiarg">unit</span>) - Returns the current health, in points, of the specified unit.
+
: [[API UnitHealth|UnitHealth]](<span class="apiarg">unit</span>) - Returns the current health of the unit.
: [[API UnitHealthMax|UnitHealthMax]](<span class="apiarg">unit</span>) - Returns the maximum health, in points, of the specified unit.
+
: [[API UnitHealthMax|UnitHealthMax]](<span class="apiarg">unit</span>) - Returns the maximum health of the unit.
 
: [[API UnitHPPerStamina|UnitHPPerStamina]]()
 
: [[API UnitHPPerStamina|UnitHPPerStamina]]()
 
: [[API UnitInOtherParty|UnitInOtherParty]]()
 
: [[API UnitInOtherParty|UnitInOtherParty]]()
: [[API UnitInRange|UnitInRange]](<span class="apiarg">unit</span>) - Returns true if the unit (party or raid only) is in range of a typical spell such as flash heal.
+
: [[API UnitInRange|UnitInRange]](<span class="apiarg">unit</span>) - True if the unit (party or raid only) is in 40 yards range.
: [[API UnitIsAFK|UnitIsAFK]](<span class="apiarg">unit</span>) - Only works for friendly units.
+
: [[API UnitIsAFK|UnitIsAFK]](<span class="apiarg">unit</span>) - True if a friendly unit is AFK (Away from keyboard).
: [[API UnitIsCharmed|UnitIsCharmed]](<span class="apiarg">unit</span>) - Returns true if the specified unit is charmed, false otherwise.
+
: [[API UnitIsCharmed|UnitIsCharmed]](<span class="apiarg">unit</span>) - True if the unit is charmed.
: [[API UnitIsConnected|UnitIsConnected]](<span class="apiarg">unit</span>) : <span class="apiret">isConnected</span> - Returns 1 if the specified unit is connected or npc, nil if offline or not a valid unit.
+
: [[API UnitIsConnected|UnitIsConnected]](<span class="apiarg">unit</span>) : <span class="apiret">isConnected</span> - True if the unit is connected to the game (i.e. not offline).
 
: [[API UnitIsControlling|UnitIsControlling]](<span class="apiarg">unit</span>) - Returns true if the local player is directly controlling the specified unit.
 
: [[API UnitIsControlling|UnitIsControlling]](<span class="apiarg">unit</span>) - Returns true if the local player is directly controlling the specified unit.
 
: [[API UnitIsCorpse|UnitIsCorpse]](<span class="apiarg">unit</span>) - Returns true if the specified unit is a corpse, false otherwise.
 
: [[API UnitIsCorpse|UnitIsCorpse]](<span class="apiarg">unit</span>) - Returns true if the specified unit is a corpse, false otherwise.
: [[API UnitIsDead|UnitIsDead]](<span class="apiarg">unit</span>) - Returns true if the specified unit is dead, nil otherwise.
+
: [[API UnitIsDead|UnitIsDead]](<span class="apiarg">unit</span>) - True if the unit is dead.
: [[API UnitIsDeadOrGhost|UnitIsDeadOrGhost]](<span class="apiarg">unit</span>) - Returns true if the specified unit is dead or a ghost, nil otherwise.
+
: [[API UnitIsDeadOrGhost|UnitIsDeadOrGhost]](<span class="apiarg">unit</span>) - True if the unit is dead or in ghost form.
: [[API UnitIsDND|UnitIsDND]](<span class="apiarg">unit</span>) - Only works for friendly units.
+
: [[API UnitIsDND|UnitIsDND]](<span class="apiarg">unit</span>) - True if a unit is DND (Do not disturb).
: [[API UnitIsEnemy|UnitIsEnemy]](<span class="apiarg">unit, otherUnit</span>) - Returns true if the specified units are enemies, false otherwise.
+
: [[API UnitIsEnemy|UnitIsEnemy]](<span class="apiarg">unit, otherUnit</span>) - True if the specified units are hostile to each other.
: [[API UnitIsFeignDeath|UnitIsFeignDeath]](<span class="apiarg">unit</span>) - Returns true if the specified unit (must be a member of your group) is feigning death.
+
: [[API UnitIsFeignDeath|UnitIsFeignDeath]](<span class="apiarg">unit</span>) - True if the unit (must be a group member) is feigning death.
: [[API UnitIsFriend|UnitIsFriend]](<span class="apiarg">unit, otherUnit</span>) - Returns true if the specified units are friends (PC of same faction or friendly NPC), false otherwise.
+
: [[API UnitIsFriend|UnitIsFriend]](<span class="apiarg">unit, otherUnit</span>) - True if the specified units are friendly to each other.
: [[API UnitIsGhost|UnitIsGhost]](<span class="apiarg">unit</span>) - Returns true if the specified unit is a ghost, false otherwise.
+
: [[API UnitIsGhost|UnitIsGhost]](<span class="apiarg">unit</span>) - True if the unit is in ghost form.
 
: [[API UnitIsGroupAssistant|UnitIsGroupAssistant]]()
 
: [[API UnitIsGroupAssistant|UnitIsGroupAssistant]]()
 
: [[API UnitIsInMyGuild|UnitIsInMyGuild]](<span class="apiarg">unit</span>) - Returns whether the specified unit is in the same guild as the player's character.
 
: [[API UnitIsInMyGuild|UnitIsInMyGuild]](<span class="apiarg">unit</span>) - Returns whether the specified unit is in the same guild as the player's character.
 
: [[API UnitIsOtherPlayersPet|UnitIsOtherPlayersPet]]()
 
: [[API UnitIsOtherPlayersPet|UnitIsOtherPlayersPet]]()
 
: [[API UnitIsOwnerOrControllerOfUnit|UnitIsOwnerOrControllerOfUnit]](<span class="apiarg">controllingUnit, controlledUnit</span>) : <span class="apiret">unitIsOwnerOrControllerOfUnit</span>
 
: [[API UnitIsOwnerOrControllerOfUnit|UnitIsOwnerOrControllerOfUnit]](<span class="apiarg">controllingUnit, controlledUnit</span>) : <span class="apiret">unitIsOwnerOrControllerOfUnit</span>
: [[API UnitIsPlayer|UnitIsPlayer]](<span class="apiarg">unit</span>) - Returns true if the specified unit is a player character, false otherwise.
+
: [[API UnitIsPlayer|UnitIsPlayer]](<span class="apiarg">unit</span>) - True if the unit is a player character.
: [[API UnitIsPossessed|UnitIsPossessed]](<span class="apiarg">unit</span>) - Returns whether the specified unit is currently under control of another (i.e. "pet" when casting Mind Control).
+
: [[API UnitIsPossessed|UnitIsPossessed]](<span class="apiarg">unit</span>) - True if the unit is currently under control of another (e.g. Mind Control).
 
: [[API UnitIsQuestBoss|UnitIsQuestBoss]](<span class="apiarg">unit</span>) - Returns true if the specified unit is the "boss" (objective) of a kill quest. If true, then the default UI displays a shield with a yellow "!" on it on the unit's unitframe.
 
: [[API UnitIsQuestBoss|UnitIsQuestBoss]](<span class="apiarg">unit</span>) - Returns true if the specified unit is the "boss" (objective) of a kill quest. If true, then the default UI displays a shield with a yellow "!" on it on the unit's unitframe.
 
: [[API UnitIsRaidOfficer|UnitIsRaidOfficer]](<span class="apiarg">unit</span>) - Returns whether the specified unit is an officer in your raid.
 
: [[API UnitIsRaidOfficer|UnitIsRaidOfficer]](<span class="apiarg">unit</span>) - Returns whether the specified unit is an officer in your raid.
: [[API UnitIsSameServer|UnitIsSameServer]](<span class="apiarg">unit</span>) - Returns whether the specified unit is from the same server as the player's character.
+
: [[API UnitIsSameServer|UnitIsSameServer]](<span class="apiarg">unit</span>) - True if the unit is from the same (connected) realm.
 
: [[API UnitIsTapDenied|UnitIsTapDenied]]()
 
: [[API UnitIsTapDenied|UnitIsTapDenied]]()
: [[API UnitIsTrivial|UnitIsTrivial]](<span class="apiarg">unit</span>) - Returns true if the specified unit is trivial (Trivial means the unit is "grey" to the player. false otherwise.
+
: [[API UnitIsTrivial|UnitIsTrivial]](<span class="apiarg">unit</span>) - Ttrue if the unit is trivial (i.e. "grey" to the player).
 
: [[API UnitIsUnconscious|UnitIsUnconscious]]()
 
: [[API UnitIsUnconscious|UnitIsUnconscious]]()
: [[API UnitIsUnit|UnitIsUnit]](<span class="apiarg">unit, otherUnit</span>) - Determine if two units are the same unit.
+
: [[API UnitIsUnit|UnitIsUnit]](<span class="apiarg">unit, otherUnit</span>) - True if the specified units are the same unit.
: [[API UnitIsVisible|UnitIsVisible]](<span class="apiarg">unit</span>) - 1 if visible, nil if not.
+
: [[API UnitIsVisible|UnitIsVisible]](<span class="apiarg">unit</span>) - True if the game client can see the unit.
 
: [[API UnitLeadsAnyGroup|UnitLeadsAnyGroup]]()
 
: [[API UnitLeadsAnyGroup|UnitLeadsAnyGroup]]()
: [[API UnitLevel|UnitLevel]](<span class="apiarg">unit</span>) - Returns the level of a unit.
+
: [[API UnitLevel|UnitLevel]](<span class="apiarg">unit</span>) - Returns the level of the unit.
: [[API UnitName|UnitName]](<span class="apiarg">unit</span>) - Returns the name (and realm name) of a unit.
+
: [[API UnitName|UnitName]](<span class="apiarg">unit</span>) - Returns the name and realm of the unit.
 
: [[API UnitNameUnmodified|UnitNameUnmodified]]()
 
: [[API UnitNameUnmodified|UnitNameUnmodified]]()
: [[API UnitPlayerControlled|UnitPlayerControlled]](<span class="apiarg">unit</span>) - Returns true if the specified unit is controlled by a player, false otherwise.
+
: [[API UnitPlayerControlled|UnitPlayerControlled]](<span class="apiarg">unit</span>) - True if the unit is controlled by a player.
: [[API UnitPlayerOrPetInParty|UnitPlayerOrPetInParty]](<span class="apiarg">unit</span>) - Returns 1 if the specified unit/pet is a member of the player's party, nil otherwise (returns nil for "player" and "pet")
+
: [[API UnitPlayerOrPetInParty|UnitPlayerOrPetInParty]](<span class="apiarg">unit</span>) - True if a different unit or pet is a member of the party.
: [[API UnitPlayerOrPetInRaid|UnitPlayerOrPetInRaid]](<span class="apiarg">unit</span>) - Returns 1 if the specified unit/pet is a member of the player's raid, nil otherwise (returns nil for "player" and "pet")
+
: [[API UnitPlayerOrPetInRaid|UnitPlayerOrPetInRaid]](<span class="apiarg">unit</span>) - True if a different unit or pet is a member of the raid.
: [[API UnitPower|UnitPower]](<span class="apiarg">unitToken [, powerType, unmodified]</span>) : <span class="apiret">power</span> - Returns current power of the specified unit (Replaces [[API UnitMana|UnitMana]])
+
: [[API UnitPower|UnitPower]](<span class="apiarg">unitToken [, powerType, unmodified]</span>) : <span class="apiret">power</span> - Returns the current power resource of the unit.
 
: [[API UnitPowerDisplayMod|UnitPowerDisplayMod]](<span class="apiarg">powerType</span>) : <span class="apiret">displayMod</span>
 
: [[API UnitPowerDisplayMod|UnitPowerDisplayMod]](<span class="apiarg">powerType</span>) : <span class="apiret">displayMod</span>
: [[API UnitPowerMax|UnitPowerMax]](<span class="apiarg">unitToken [, powerType, unmodified]</span>) : <span class="apiret">maxPower</span> - Returns max power of the specified unit (Replaces [[API UnitManaMax|UnitManaMax]])
+
: [[API UnitPowerMax|UnitPowerMax]](<span class="apiarg">unitToken [, powerType, unmodified]</span>) : <span class="apiret">maxPower</span> - Returns the maximum power resource of the unit.
 
: [[API UnitPowerType|UnitPowerType]](<span class="apiarg">unit</span>) - Returns a number corresponding to the power type (e.g., mana, rage or energy) of the specified unit.
 
: [[API UnitPowerType|UnitPowerType]](<span class="apiarg">unit</span>) - Returns a number corresponding to the power type (e.g., mana, rage or energy) of the specified unit.
 
: [[API UnitQuestTrivialLevelRange|UnitQuestTrivialLevelRange]](<span class="apiarg">unit</span>) : <span class="apiret">levelRange</span> - Returns the difference between the units' current level and the level at which fixed-level quests are of trivial difficulty.
 
: [[API UnitQuestTrivialLevelRange|UnitQuestTrivialLevelRange]](<span class="apiarg">unit</span>) : <span class="apiret">levelRange</span> - Returns the difference between the units' current level and the level at which fixed-level quests are of trivial difficulty.
: [[API UnitRace|UnitRace]](<span class="apiarg">unit</span>) - Returns the race name of the specified unit (e.g., "Human" or "Troll").
+
: [[API UnitRace|UnitRace]](<span class="apiarg">unit</span>) - Returns the race of the unit.
 
: [[API UnitRangedAttackPower|UnitRangedAttackPower]](<span class="apiarg">unit</span>) - Returns the ranged attack power of the unit.
 
: [[API UnitRangedAttackPower|UnitRangedAttackPower]](<span class="apiarg">unit</span>) - Returns the ranged attack power of the unit.
 
: [[API UnitRangedDamage|UnitRangedDamage]](<span class="apiarg">unit</span>) - Returns the ranged attack speed and damage of the unit.
 
: [[API UnitRangedDamage|UnitRangedDamage]](<span class="apiarg">unit</span>) - Returns the ranged attack speed and damage of the unit.
: [[API UnitReaction|UnitReaction]](<span class="apiarg">unit, otherUnit</span>) - Returns a number corresponding to the reaction (aggressive, neutral or friendly) of the first unit towards the second unit.
+
: [[API UnitReaction|UnitReaction]](<span class="apiarg">unit, otherUnit</span>) - Returns the reaction of the specified unit to another unit.
 
: [[API UnitRealmRelationship|UnitRealmRelationship]]()
 
: [[API UnitRealmRelationship|UnitRealmRelationship]]()
: [[API UnitSelectionColor|UnitSelectionColor]](<span class="apiarg">unit [, useExtendedColors]</span>) - Returns RGBA values for the color of a unit's selection (the outline around and the circle underneath a player character or an NPC).
+
: [[API UnitSelectionColor|UnitSelectionColor]](<span class="apiarg">unit [, useExtendedColors]</span>) - Returns the color of the outline and circle underneath the unit.
: [[API UnitSelectionType|UnitSelectionType]](<span class="apiarg">unit [, useExtendedColors]</span>) - Returns a number corresponding to the type of a unit's selection (the outline around and the circle underneath a player character or an NPC).
+
: [[API UnitSelectionType|UnitSelectionType]](<span class="apiarg">unit [, useExtendedColors]</span>) - Returns the selection type of the outline and circle underneath the unit.
 
: [[API UnitSetRole|UnitSetRole]]()
 
: [[API UnitSetRole|UnitSetRole]]()
: [[API UnitSex|UnitSex]](<span class="apiarg">unit</span>) : <span class="apiret">sex</span> - Returns a code indicating the gender of the specified unit, if known. (1=unknown, 2=male, 3=female)
+
: [[API UnitSex|UnitSex]](<span class="apiarg">unit</span>) : <span class="apiret">sex</span> - Returns the gender of the unit.
 
: [[API UnitShouldDisplayName|UnitShouldDisplayName]]()
 
: [[API UnitShouldDisplayName|UnitShouldDisplayName]]()
 
: [[API UnitSpellHaste|UnitSpellHaste]](<span class="apiarg">unit</span>) - Returns the current spell haste percentage for a unit.
 
: [[API UnitSpellHaste|UnitSpellHaste]](<span class="apiarg">unit</span>) - Returns the current spell haste percentage for a unit.
 
: [[API UnitStagger|UnitStagger]]()
 
: [[API UnitStagger|UnitStagger]]()
: [[API UnitStat|UnitStat]](<span class="apiarg">unit, statIndex</span>) - Returns the statistics relevant to the specified unit and basic attribute (e.g., strength or intellect).
+
: [[API UnitStat|UnitStat]](<span class="apiarg">unit, statIndex</span>) - Returns the basic attributes for a unit (strength, agility, stamina, intellect).
 
: [[API UnitThreatPercentageOfLead|UnitThreatPercentageOfLead]]()
 
: [[API UnitThreatPercentageOfLead|UnitThreatPercentageOfLead]]()
: [[API UnitThreatSituation|UnitThreatSituation]](<span class="apiarg">unit, mobUnit</span>) - Returns the specified unit's threat status on a mob.
+
: [[API UnitThreatSituation|UnitThreatSituation]](<span class="apiarg">unit, mobUnit</span>) - Returns the threat status of the specified unit to another unit.
 
: [[API UnitTreatAsPlayerForDisplay|UnitTreatAsPlayerForDisplay]](<span class="apiarg">unit</span>) : <span class="apiret">treatAsPlayer</span> - Whether a unit should be treated as if it was an actual player.
 
: [[API UnitTreatAsPlayerForDisplay|UnitTreatAsPlayerForDisplay]](<span class="apiarg">unit</span>) : <span class="apiret">treatAsPlayer</span> - Whether a unit should be treated as if it was an actual player.
 
: [[API UnitTrialBankedLevels|UnitTrialBankedLevels]](<span class="apiarg">unit</span>)
 
: [[API UnitTrialBankedLevels|UnitTrialBankedLevels]](<span class="apiarg">unit</span>)
 
: [[API UnitTrialXP|UnitTrialXP]](<span class="apiarg">unit</span>)
 
: [[API UnitTrialXP|UnitTrialXP]](<span class="apiarg">unit</span>)
 
: [[API UnitWeaponAttackPower|UnitWeaponAttackPower]](<span class="apiarg">unit</span>)
 
: [[API UnitWeaponAttackPower|UnitWeaponAttackPower]](<span class="apiarg">unit</span>)
: [[API UnitXP|UnitXP]](<span class="apiarg">unit</span>) - Returns the number of experience points the specified unit has in their current level. (only works on your player)
+
: [[API UnitXP|UnitXP]](<span class="apiarg">unit</span>) - Returns the current XP of the unit; only works on the player.
: [[API UnitXPMax|UnitXPMax]](<span class="apiarg">unit</span>) - Returns the number of experience points the specified unit needs to reach their next level. (only works on your player)
+
: [[API UnitXPMax|UnitXPMax]](<span class="apiarg">unit</span>) - Returns the maximum XP of the unit; only works on the player.
: <small>UI</small> [[API GetUnitName|GetUnitName]](<span class="apiarg">unit [, showServerName]</span>) - Returns the name and optionally the realm of the unit.
+
: <small>''UI''</small> [[API GetUnitName|GetUnitName]](<span class="apiarg">unit [, showServerName]</span>) - Returns the name and optionally the realm of the unit.
   
==== Buffs ====
+
====Buffs====
: <small>NOCOMBAT</small> [[API CancelUnitBuff|CancelUnitBuff]](<span class="apiarg">unit, index or spell [, filter or rank]</span>) - Removes a specific buff from the player.
+
: <small>''NOCOMBAT''</small> [[API CancelUnitBuff|CancelUnitBuff]](<span class="apiarg">unit, index or spell [, filter or rank]</span>) - Removes a specific buff from the character.
 
: [[API GetPlayerAuraBySpellID|GetPlayerAuraBySpellID]](<span class="apiarg">spellID</span>) - Returns an active buff/debuff by spell ID on the player character.
 
: [[API GetPlayerAuraBySpellID|GetPlayerAuraBySpellID]](<span class="apiarg">spellID</span>) - Returns an active buff/debuff by spell ID on the player character.
: [[API UnitAura|UnitAura]](<span class="apiarg">unit, index [, filter]</span>) - Returns info about buffs and debuffs of a unit.
+
: [[API UnitAura|UnitAura]](<span class="apiarg">unit, index [, filter]</span>) - Returns the buffs/debuffs for the unit.
 
: [[API UnitAuraBySlot|UnitAuraBySlot]](<span class="apiarg">unit, slot</span>)
 
: [[API UnitAuraBySlot|UnitAuraBySlot]](<span class="apiarg">unit, slot</span>)
 
: [[API UnitAuraSlots|UnitAuraSlots]](<span class="apiarg">unit [, filter, maxSlots, continuationToken]</span>)
 
: [[API UnitAuraSlots|UnitAuraSlots]](<span class="apiarg">unit [, filter, maxSlots, continuationToken]</span>)
 
: [[API UnitBuff|UnitBuff]](<span class="apiarg">unit, index [, raidFilter]</span>) - Shorthand for <code>UnitAura(unit, index, "HELPFUL")</code>
 
: [[API UnitBuff|UnitBuff]](<span class="apiarg">unit, index [, raidFilter]</span>) - Shorthand for <code>UnitAura(unit, index, "HELPFUL")</code>
 
: [[API UnitDebuff|UnitDebuff]](<span class="apiarg">unit, index [, raidFilter]</span>) - Shorthand for <code>UnitAura(unit, index, "HARMFUL")</code>
 
: [[API UnitDebuff|UnitDebuff]](<span class="apiarg">unit, index [, raidFilter]</span>) - Shorthand for <code>UnitAura(unit, index, "HARMFUL")</code>
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=FindAura AuraUtil.FindAura](<span class="apiarg">predicate, unit, filter, predicateArg1, predicateArg2, predicateArg3</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=FindAura AuraUtil.FindAura](<span class="apiarg">predicate, unit, filter, predicateArg1, predicateArg2, predicateArg3</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=FindAuraByName AuraUtil.FindAuraByName](<span class="apiarg">auraName, unit, filter</span>) - Finds the first aura that matches the name.
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=FindAuraByName AuraUtil.FindAuraByName](<span class="apiarg">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 class="apiarg">unit, filter, maxCount, func</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=ForEachAura AuraUtil.ForEachAura](<span class="apiarg">unit, filter, maxCount, func</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=ShouldSkipAuraUpdate AuraUtil.ShouldSkipAuraUpdate](<span class="apiarg">isFullUpdate, updatedAuraInfos, isRelevantFunc, ...</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=ShouldSkipAuraUpdate AuraUtil.ShouldSkipAuraUpdate](<span class="apiarg">isFullUpdate, updatedAuraInfos, isRelevantFunc, ...</span>)
 
Weapon Enchants
 
Weapon Enchants
: <small>PROTECTED</small> [[API CancelItemTempEnchantment|CancelItemTempEnchantment]](<span class="apiarg">weaponHand</span>) - Cancels a temporary weapon enchant on ''weaponHand'' (1 for Main hand, 2 for Off hand).
+
: <small>''PROTECTED''</small> [[API CancelItemTempEnchantment|CancelItemTempEnchantment]](<span class="apiarg">weaponHand</span>) - Removes temporary weapon enchants (e.g. Rogue poisons and sharpening stones).
: [[API GetWeaponEnchantInfo|GetWeaponEnchantInfo]]() - Returns information about main and offhand weapon enchantments.
+
: [[API GetWeaponEnchantInfo|GetWeaponEnchantInfo]]() - Returns info for temporary weapon enchantments (e.g. sharpening stones).
   
==== Nameplates ====
+
====Nameplates====
 
Nameplates were reworked in [[Patch 7.0.3]]
 
Nameplates were reworked in [[Patch 7.0.3]]
 
: [[API C_NamePlate.GetNamePlateEnemyClickThrough|C_NamePlate.GetNamePlateEnemyClickThrough]]()
 
: [[API C_NamePlate.GetNamePlateEnemyClickThrough|C_NamePlate.GetNamePlateEnemyClickThrough]]()
Line 4,733: Line 4,767:
 
: [[API UnitNameplateShowsWidgetsOnly|UnitNameplateShowsWidgetsOnly]](<span class="apiarg">unit</span>) : <span class="apiret">nameplateShowsWidgetsOnly</span>
 
: [[API UnitNameplateShowsWidgetsOnly|UnitNameplateShowsWidgetsOnly]](<span class="apiarg">unit</span>) : <span class="apiret">nameplateShowsWidgetsOnly</span>
   
==== Loss of Control ====
+
====Loss of Control====
 
: [[API C_LossOfControl.GetActiveLossOfControlData|C_LossOfControl.GetActiveLossOfControlData]](<span class="apiarg">index</span>) : <span class="apiret">event</span> - Returns info about an active loss-of-control effect.
 
: [[API C_LossOfControl.GetActiveLossOfControlData|C_LossOfControl.GetActiveLossOfControlData]](<span class="apiarg">index</span>) : <span class="apiret">event</span> - Returns info about an active loss-of-control effect.
 
: [[API C_LossOfControl.GetActiveLossOfControlDataByUnit|C_LossOfControl.GetActiveLossOfControlDataByUnit]](<span class="apiarg">unitToken, index</span>) : <span class="apiret">event</span>
 
: [[API C_LossOfControl.GetActiveLossOfControlDataByUnit|C_LossOfControl.GetActiveLossOfControlDataByUnit]](<span class="apiarg">unitToken, index</span>) : <span class="apiret">event</span>
Line 4,741: Line 4,775:
 
: [[API GetSpellLossOfControlCooldown|GetSpellLossOfControlCooldown]](<span class="apiarg">spellSlot</span>)
 
: [[API GetSpellLossOfControlCooldown|GetSpellLossOfControlCooldown]](<span class="apiarg">spellSlot</span>)
   
==== Phasing ====
+
====Phasing====
 
Players in different [[Phasing|Phases]] cannot see eachother.
 
Players in different [[Phasing|Phases]] cannot see eachother.
 
: [[API UnitInPartyShard|UnitInPartyShard]](<span class="apiarg">unit</span>) : <span class="apiret">inPartyShard</span>
 
: [[API UnitInPartyShard|UnitInPartyShard]](<span class="apiarg">unit</span>) : <span class="apiret">inPartyShard</span>
 
: [[API UnitPhaseReason|UnitPhaseReason]](<span class="apiarg">unit</span>) : <span class="apiret">reason</span> - Returns the reason if a unit is NOT in the same phase.
 
: [[API UnitPhaseReason|UnitPhaseReason]](<span class="apiarg">unit</span>) : <span class="apiret">reason</span> - Returns the reason if a unit is NOT in the same phase.
   
==== Power Bar ====
+
====Power Bar====
 
: [[API GetUnitPowerBarInfo|GetUnitPowerBarInfo]](<span class="apiarg">unitToken</span>) : <span class="apiret">info</span>
 
: [[API GetUnitPowerBarInfo|GetUnitPowerBarInfo]](<span class="apiarg">unitToken</span>) : <span class="apiret">info</span>
 
: [[API GetUnitPowerBarInfoByID|GetUnitPowerBarInfoByID]](<span class="apiarg">barID</span>) : <span class="apiret">info</span>
 
: [[API GetUnitPowerBarInfoByID|GetUnitPowerBarInfoByID]](<span class="apiarg">barID</span>) : <span class="apiret">info</span>
Line 4,757: Line 4,791:
 
: [[API UnitPowerBarTimerInfo|UnitPowerBarTimerInfo]]()
 
: [[API UnitPowerBarTimerInfo|UnitPowerBarTimerInfo]]()
   
=== Vehicles ===
+
===Vehicles===
 
These functions were added in [[Patch 3.0.2]]
 
These functions were added in [[Patch 3.0.2]]
 
: [[API C_PvP.GetBattlefieldVehicleInfo|C_PvP.GetBattlefieldVehicleInfo]](<span class="apiarg">vehicleIndex, uiMapID</span>) : <span class="apiret">info</span>
 
: [[API C_PvP.GetBattlefieldVehicleInfo|C_PvP.GetBattlefieldVehicleInfo]](<span class="apiarg">vehicleIndex, uiMapID</span>) : <span class="apiret">info</span>
Line 4,781: Line 4,815:
 
: [[API UnitSwitchToVehicleSeat|UnitSwitchToVehicleSeat]](<span class="apiarg">unit, seatId</span>)
 
: [[API UnitSwitchToVehicleSeat|UnitSwitchToVehicleSeat]](<span class="apiarg">unit, seatId</span>)
 
: [[API UnitTargetsVehicleInRaidUI|UnitTargetsVehicleInRaidUI]](<span class="apiarg">unit</span>)
 
: [[API UnitTargetsVehicleInRaidUI|UnitTargetsVehicleInRaidUI]](<span class="apiarg">unit</span>)
: [[API UnitUsingVehicle|UnitUsingVehicle]](<span class="apiarg">unit</span>) - Returns whether the specified unit is currently using a vehicle (including transitioning between seats).
+
: [[API UnitUsingVehicle|UnitUsingVehicle]](<span class="apiarg">unit</span>) - True if the unit is currently in a vehicle.
 
: [[API UnitVehicleSeatCount|UnitVehicleSeatCount]](<span class="apiarg">unit</span>)
 
: [[API UnitVehicleSeatCount|UnitVehicleSeatCount]](<span class="apiarg">unit</span>)
 
: [[API UnitVehicleSeatInfo|UnitVehicleSeatInfo]](<span class="apiarg">unit, seatId</span>)
 
: [[API UnitVehicleSeatInfo|UnitVehicleSeatInfo]](<span class="apiarg">unit, seatId</span>)
Line 4,801: Line 4,835:
 
: [[API VehiclePrevSeat|VehiclePrevSeat]]()
 
: [[API VehiclePrevSeat|VehiclePrevSeat]]()
   
=== Warlords of Draenor ===
+
===Warlords of Draenor===
==== Garrison Tech ====
+
====Garrison Tech====
 
[[Garrison]]s were added in [[Patch 6.0.2]] and also utilized in later expanions.
 
[[Garrison]]s were added in [[Patch 6.0.2]] and also utilized in later expanions.
 
: [[API C_Garrison.CanUpgradeGarrison|C_Garrison.CanUpgradeGarrison]]()
 
: [[API C_Garrison.CanUpgradeGarrison|C_Garrison.CanUpgradeGarrison]]()
Line 4,863: Line 4,897:
 
: [[API ReopenInteraction|ReopenInteraction]]() - Reopens the order hall talents interaction.
 
: [[API ReopenInteraction|ReopenInteraction]]() - Reopens the order hall talents interaction.
   
==== Buildings ====
+
====Buildings====
 
: [[API C_Garrison.CancelConstruction|C_Garrison.CancelConstruction]](<span class="apiarg">plotInstanceID</span>)
 
: [[API C_Garrison.CancelConstruction|C_Garrison.CancelConstruction]](<span class="apiarg">plotInstanceID</span>)
 
: [[API C_Garrison.GetBuildingInfo|C_Garrison.GetBuildingInfo]](<span class="apiarg">buildingID</span>)
 
: [[API C_Garrison.GetBuildingInfo|C_Garrison.GetBuildingInfo]](<span class="apiarg">buildingID</span>)
Line 4,901: Line 4,935:
 
: [[API C_Trophy.MonumentSaveSelection|C_Trophy.MonumentSaveSelection]](<span class="apiarg">trophyID</span>)
 
: [[API C_Trophy.MonumentSaveSelection|C_Trophy.MonumentSaveSelection]](<span class="apiarg">trophyID</span>)
   
==== Missions ====
+
====Missions====
 
Relates to [[Follower]]s and [[Mission]]s.
 
Relates to [[Follower]]s and [[Mission]]s.
 
: [[API C_Garrison.AddFollowerToMission|C_Garrison.AddFollowerToMission]](<span class="apiarg">missionID, followerID [, boardIndex]</span>) : <span class="apiret">followerAdded</span>
 
: [[API C_Garrison.AddFollowerToMission|C_Garrison.AddFollowerToMission]](<span class="apiarg">missionID, followerID [, boardIndex]</span>) : <span class="apiret">followerAdded</span>
Line 4,965: Line 4,999:
 
: [[API C_Garrison.GetFollowerRecentlyGainedAbilityIDs|C_Garrison.GetFollowerRecentlyGainedAbilityIDs]](<span class="apiarg">followerID</span>)
 
: [[API C_Garrison.GetFollowerRecentlyGainedAbilityIDs|C_Garrison.GetFollowerRecentlyGainedAbilityIDs]](<span class="apiarg">followerID</span>)
 
: [[API C_Garrison.GetFollowerRecentlyGainedTraitIDs|C_Garrison.GetFollowerRecentlyGainedTraitIDs]](<span class="apiarg">followerID</span>)
 
: [[API C_Garrison.GetFollowerRecentlyGainedTraitIDs|C_Garrison.GetFollowerRecentlyGainedTraitIDs]](<span class="apiarg">followerID</span>)
: [[API C_Garrison.GetFollowers|C_Garrison.GetFollowers]]() - Returns a table of followers and their attributes.
+
: [[API C_Garrison.GetFollowers|C_Garrison.GetFollowers]]() - Returns a list of garrison tech followers.
 
: [[API C_Garrison.GetFollowerShipments|C_Garrison.GetFollowerShipments]](<span class="apiarg">garrTypeID</span>)
 
: [[API C_Garrison.GetFollowerShipments|C_Garrison.GetFollowerShipments]](<span class="apiarg">garrTypeID</span>)
 
: [[API C_Garrison.GetFollowerSoftCap|C_Garrison.GetFollowerSoftCap]](<span class="apiarg">garrFollowerTypeID</span>)
 
: [[API C_Garrison.GetFollowerSoftCap|C_Garrison.GetFollowerSoftCap]](<span class="apiarg">garrFollowerTypeID</span>)
Line 5,039: Line 5,073:
 
: [[API SpellCanTargetGarrisonMission|SpellCanTargetGarrisonMission]]()
 
: [[API SpellCanTargetGarrisonMission|SpellCanTargetGarrisonMission]]()
   
==== Auto Missions ====
+
====Auto Missions====
 
: [[API C_Garrison.GetAutoCombatDamageClassValues|C_Garrison.GetAutoCombatDamageClassValues]]() : <span class="apiret">damageClassStrings</span>
 
: [[API C_Garrison.GetAutoCombatDamageClassValues|C_Garrison.GetAutoCombatDamageClassValues]]() : <span class="apiret">damageClassStrings</span>
 
: [[API C_Garrison.GetAutoMissionBoardState|C_Garrison.GetAutoMissionBoardState]](<span class="apiarg">missionID</span>) : <span class="apiret">targetInfo</span>
 
: [[API C_Garrison.GetAutoMissionBoardState|C_Garrison.GetAutoMissionBoardState]](<span class="apiarg">missionID</span>) : <span class="apiret">targetInfo</span>
Line 5,052: Line 5,086:
 
: [[API C_Garrison.SetAutoCombatSpellFastForward|C_Garrison.SetAutoCombatSpellFastForward]](<span class="apiarg">state</span>)
 
: [[API C_Garrison.SetAutoCombatSpellFastForward|C_Garrison.SetAutoCombatSpellFastForward]](<span class="apiarg">state</span>)
   
=== Legion ===
+
===Legion===
==== Artifacts ====
+
====Artifacts====
 
[[Artifact]]s were added in [[Patch 7.0.3]]
 
[[Artifact]]s were added in [[Patch 7.0.3]]
 
: [[API C_ArtifactUI.AddPower|C_ArtifactUI.AddPower]](<span class="apiarg">powerID</span>) : <span class="apiret">success</span>
 
: [[API C_ArtifactUI.AddPower|C_ArtifactUI.AddPower]](<span class="apiarg">powerID</span>) : <span class="apiret">success</span>
Line 5,062: Line 5,096:
 
: [[API C_ArtifactUI.CanApplyRelicItemIDToSlot|C_ArtifactUI.CanApplyRelicItemIDToSlot]](<span class="apiarg">relicItemID, relicSlotIndex</span>) : <span class="apiret">canApply</span>
 
: [[API C_ArtifactUI.CanApplyRelicItemIDToSlot|C_ArtifactUI.CanApplyRelicItemIDToSlot]](<span class="apiarg">relicItemID, relicSlotIndex</span>) : <span class="apiret">canApply</span>
 
: [[API C_ArtifactUI.CheckRespecNPC|C_ArtifactUI.CheckRespecNPC]]() : <span class="apiret">canRespec</span>
 
: [[API C_ArtifactUI.CheckRespecNPC|C_ArtifactUI.CheckRespecNPC]]() : <span class="apiret">canRespec</span>
: [[API C_ArtifactUI.Clear|C_ArtifactUI.Clear]]() - Clear artifact data of last opened artifact weapon.
+
: [[API C_ArtifactUI.Clear|C_ArtifactUI.Clear]]() - Clears data of the last opened artifact weapon.
 
: [[API C_ArtifactUI.ClearForgeCamera|C_ArtifactUI.ClearForgeCamera]]()
 
: [[API C_ArtifactUI.ClearForgeCamera|C_ArtifactUI.ClearForgeCamera]]()
 
: [[API C_ArtifactUI.ConfirmRespec|C_ArtifactUI.ConfirmRespec]]()
 
: [[API C_ArtifactUI.ConfirmRespec|C_ArtifactUI.ConfirmRespec]]()
Line 5,120: Line 5,154:
 
: [[API IsArtifactRelicItem|IsArtifactRelicItem]](<span class="apiarg">item</span>)
 
: [[API IsArtifactRelicItem|IsArtifactRelicItem]](<span class="apiarg">item</span>)
   
==== Invasions ====
+
====Invasions====
 
[[Legion Invasions|Invasions]] were added in [[Patch 7.0.3]]
 
[[Legion Invasions|Invasions]] were added in [[Patch 7.0.3]]
 
: [[API C_InvasionInfo.AreInvasionsAvailable|C_InvasionInfo.AreInvasionsAvailable]]() : <span class="apiret">areInvasionsAvailable</span> - Returns true if invasions are active in the same physical area as the player.
 
: [[API C_InvasionInfo.AreInvasionsAvailable|C_InvasionInfo.AreInvasionsAvailable]]() : <span class="apiret">areInvasionsAvailable</span> - Returns true if invasions are active in the same physical area as the player.
Line 5,127: Line 5,161:
 
: [[API C_InvasionInfo.GetInvasionTimeLeft|C_InvasionInfo.GetInvasionTimeLeft]](<span class="apiarg">invasionID</span>) : <span class="apiret">timeLeftMinutes</span> - Returns the time left for an invasion.
 
: [[API C_InvasionInfo.GetInvasionTimeLeft|C_InvasionInfo.GetInvasionTimeLeft]](<span class="apiarg">invasionID</span>) : <span class="apiret">timeLeftMinutes</span> - Returns the time left for an invasion.
   
==== Contribution ====
+
====Contribution====
 
Relates to buildings on the [[Broken Shore]] or [[Warfront|Warfronts]]; added in [[Patch 7.2.0]].
 
Relates to buildings on the [[Broken Shore]] or [[Warfront|Warfronts]]; added in [[Patch 7.2.0]].
 
: [[API C_ContributionCollector.Close|C_ContributionCollector.Close]]() - Closes the contribution collector API state.
 
: [[API C_ContributionCollector.Close|C_ContributionCollector.Close]]() - Closes the contribution collector API state.
Line 5,133: Line 5,167:
 
: [[API C_ContributionCollector.GetActive|C_ContributionCollector.GetActive]]() : <span class="apiret">contributionID</span> - Returns the currently active buildings.
 
: [[API C_ContributionCollector.GetActive|C_ContributionCollector.GetActive]]() : <span class="apiret">contributionID</span> - Returns the currently active buildings.
 
: [[API C_ContributionCollector.GetAtlases|C_ContributionCollector.GetAtlases]](<span class="apiarg">contributionID</span>) : <span class="apiret">atlasName</span> - Returns a table listing the possible states for a building.
 
: [[API C_ContributionCollector.GetAtlases|C_ContributionCollector.GetAtlases]](<span class="apiarg">contributionID</span>) : <span class="apiret">atlasName</span> - Returns a table listing the possible states for a building.
: [[API C_ContributionCollector.GetBuffs|C_ContributionCollector.GetBuffs]](<span class="apiarg">contributionID</span>) : <span class="apiret">spellID</span> - Returns the buffs provided when a building is active.
+
: [[API C_ContributionCollector.GetBuffs|C_ContributionCollector.GetBuffs]](<span class="apiarg">contributionID</span>) : <span class="apiret">spellID</span> - Returns the buffs provided by a building (e.g. in a [[Warfront]]).
 
: [[API C_ContributionCollector.GetContributionAppearance|C_ContributionCollector.GetContributionAppearance]](<span class="apiarg">contributionID, contributionState</span>) : <span class="apiret">appearance</span> - Returns contribution appearance info.
 
: [[API C_ContributionCollector.GetContributionAppearance|C_ContributionCollector.GetContributionAppearance]](<span class="apiarg">contributionID, contributionState</span>) : <span class="apiret">appearance</span> - Returns contribution appearance info.
 
: [[API C_ContributionCollector.GetContributionCollectorsForMap|C_ContributionCollector.GetContributionCollectorsForMap]](<span class="apiarg">uiMapID</span>) : <span class="apiret">contributionCollectors</span> - Returns contribution buildings on a map.
 
: [[API C_ContributionCollector.GetContributionCollectorsForMap|C_ContributionCollector.GetContributionCollectorsForMap]](<span class="apiarg">uiMapID</span>) : <span class="apiret">contributionCollectors</span> - Returns contribution buildings on a map.
Line 5,146: Line 5,180:
 
: [[API C_ContributionCollector.GetState|C_ContributionCollector.GetState]](<span class="apiarg">contributionID</span>) : <span class="apiret">contributionState, contributionPercentageComplete, timeOfNextStateChange, ...</span> - Returns the current state of a building, its completion percentage, and time until next state change.
 
: [[API C_ContributionCollector.GetState|C_ContributionCollector.GetState]](<span class="apiarg">contributionID</span>) : <span class="apiret">contributionState, contributionPercentageComplete, timeOfNextStateChange, ...</span> - Returns the current state of a building, its completion percentage, and time until next state change.
 
: [[API C_ContributionCollector.HasPendingContribution|C_ContributionCollector.HasPendingContribution]](<span class="apiarg">contributionID</span>) : <span class="apiret">hasPending</span> - Returns whether there is a pending contribution.
 
: [[API C_ContributionCollector.HasPendingContribution|C_ContributionCollector.HasPendingContribution]](<span class="apiarg">contributionID</span>) : <span class="apiret">hasPending</span> - Returns whether there is a pending contribution.
: [[API C_ContributionCollector.IsAwaitingRewardQuestData|C_ContributionCollector.IsAwaitingRewardQuestData]](<span class="apiarg">contributionID</span>) : <span class="apiret">awaitingData</span> - Returns whether the contribution API is waiting for quest data.
+
: [[API C_ContributionCollector.IsAwaitingRewardQuestData|C_ContributionCollector.IsAwaitingRewardQuestData]](<span class="apiarg">contributionID</span>) : <span class="apiret">awaitingData</span> - True if the client is waiting for quest reward data.
   
=== Battle for Azeroth ===
+
===Battle for Azeroth===
==== Azerite ====
+
====Azerite====
 
[[:Azerite]] was added in [[Patch 8.0.1]]
 
[[:Azerite]] was added in [[Patch 8.0.1]]
 
: [[API C_AzeriteItem.FindActiveAzeriteItem|C_AzeriteItem.FindActiveAzeriteItem]]() : <span class="apiret">activeAzeriteItemLocation</span>
 
: [[API C_AzeriteItem.FindActiveAzeriteItem|C_AzeriteItem.FindActiveAzeriteItem]]() : <span class="apiret">activeAzeriteItemLocation</span>
Line 5,203: Line 5,237:
 
: [[API C_AzeriteEssence.UnlockMilestone|C_AzeriteEssence.UnlockMilestone]](<span class="apiarg">milestoneID</span>)
 
: [[API C_AzeriteEssence.UnlockMilestone|C_AzeriteEssence.UnlockMilestone]](<span class="apiarg">milestoneID</span>)
   
==== Corruption ====
+
====Corruption====
 
[[Corrupted item]]s were added in [[Patch 8.3.0]]
 
[[Corrupted item]]s were added in [[Patch 8.3.0]]
 
: [[API C_Item.IsItemCorrupted|C_Item.IsItemCorrupted]](<span class="apiarg">itemLoc</span>) : <span class="apiret">isCorrupted</span>
 
: [[API C_Item.IsItemCorrupted|C_Item.IsItemCorrupted]](<span class="apiarg">itemLoc</span>) : <span class="apiret">isCorrupted</span>
Line 5,214: Line 5,248:
 
: [[API IsCorruptedItem|IsCorruptedItem]](<span class="apiarg">item</span>)
 
: [[API IsCorruptedItem|IsCorruptedItem]](<span class="apiarg">item</span>)
   
==== Island Expeditions ====
+
====Island Expeditions====
 
[[Island Expeditions]] were added in [[Patch 8.0.1]]
 
[[Island Expeditions]] were added in [[Patch 8.0.1]]
 
: [[API C_IslandsQueue.CloseIslandsQueueScreen|C_IslandsQueue.CloseIslandsQueueScreen]]() - Closes the islands queue screen.
 
: [[API C_IslandsQueue.CloseIslandsQueueScreen|C_IslandsQueue.CloseIslandsQueueScreen]]() - Closes the islands queue screen.
Line 5,222: Line 5,256:
 
: [[API C_IslandsQueue.QueueForIsland|C_IslandsQueue.QueueForIsland]](<span class="apiarg">difficultyID</span>) - Queues for an island expedition.
 
: [[API C_IslandsQueue.QueueForIsland|C_IslandsQueue.QueueForIsland]](<span class="apiarg">difficultyID</span>) - Queues for an island expedition.
 
: [[API C_IslandsQueue.RequestPreloadRewardData|C_IslandsQueue.RequestPreloadRewardData]](<span class="apiarg">questId</span>) - Preloads reward data for a quest id.
 
: [[API C_IslandsQueue.RequestPreloadRewardData|C_IslandsQueue.RequestPreloadRewardData]](<span class="apiarg">questId</span>) - Preloads reward data for a quest id.
: [[API C_PartyPose.GetPartyPoseInfoByMapID|C_PartyPose.GetPartyPoseInfoByMapID]](<span class="apiarg">mapID</span>) : <span class="apiret">info</span> - Returns party pose info for a map.
+
: [[API C_PartyPose.GetPartyPoseInfoByMapID|C_PartyPose.GetPartyPoseInfoByMapID]](<span class="apiarg">mapID</span>) : <span class="apiret">info</span> - Returns party pose info for an [[Island Expedition]] or [[Warfront]].
 
: [[API ShouldShowIslandsWeeklyPOI|ShouldShowIslandsWeeklyPOI]]()
 
: [[API ShouldShowIslandsWeeklyPOI|ShouldShowIslandsWeeklyPOI]]()
   
==== Scrapping Machine ====
+
====Scrapping Machine====
 
The [[Scrapper]] was added in [[Patch 8.0.1]]
 
The [[Scrapper]] was added in [[Patch 8.0.1]]
 
: [[API C_Item.CanScrapItem|C_Item.CanScrapItem]](<span class="apiarg">itemLoc</span>) : <span class="apiret">canBeScrapped</span>
 
: [[API C_Item.CanScrapItem|C_Item.CanScrapItem]](<span class="apiarg">itemLoc</span>) : <span class="apiret">canBeScrapped</span>
Line 5,241: Line 5,275:
 
: [[API C_ScrappingMachineUI.ValidateScrappingList|C_ScrappingMachineUI.ValidateScrappingList]]()
 
: [[API C_ScrappingMachineUI.ValidateScrappingList|C_ScrappingMachineUI.ValidateScrappingList]]()
   
=== Shadowlands ===
+
===Shadowlands===
 
Ardenweald
 
Ardenweald
 
: [[API C_ArdenwealdGardening.GetGardenData|C_ArdenwealdGardening.GetGardenData]]() : <span class="apiret">data</span>
 
: [[API C_ArdenwealdGardening.GetGardenData|C_ArdenwealdGardening.GetGardenData]]() : <span class="apiret">data</span>
Line 5,256: Line 5,290:
 
: [[API IsOnGroundFloorInJailersTower|IsOnGroundFloorInJailersTower]]()
 
: [[API IsOnGroundFloorInJailersTower|IsOnGroundFloorInJailersTower]]()
   
==== Anima ====
+
====Anima====
 
[[:Anima]] was added in [[Patch 9.0.1]]
 
[[:Anima]] was added in [[Patch 9.0.1]]
 
: [[API C_AnimaDiversion.CloseUI|C_AnimaDiversion.CloseUI]]()
 
: [[API C_AnimaDiversion.CloseUI|C_AnimaDiversion.CloseUI]]()
Line 5,267: Line 5,301:
 
: [[API C_Item.IsAnimaItemByID|C_Item.IsAnimaItemByID]](<span class="apiarg">itemInfo</span>) : <span class="apiret">isAnimaItem</span>
 
: [[API C_Item.IsAnimaItemByID|C_Item.IsAnimaItemByID]](<span class="apiarg">itemInfo</span>) : <span class="apiret">isAnimaItem</span>
   
==== Covenants ====
+
====Covenants====
 
[[Covenant]]s were added in [[Patch 9.0.1]]
 
[[Covenant]]s were added in [[Patch 9.0.1]]
 
: [[API C_Covenants.GetActiveCovenantID|C_Covenants.GetActiveCovenantID]]() : <span class="apiret">covenantID</span>
 
: [[API C_Covenants.GetActiveCovenantID|C_Covenants.GetActiveCovenantID]]() : <span class="apiret">covenantID</span>
Line 5,293: Line 5,327:
 
: [[API C_CovenantSanctumUI.RequestCatchUpState|C_CovenantSanctumUI.RequestCatchUpState]]()
 
: [[API C_CovenantSanctumUI.RequestCatchUpState|C_CovenantSanctumUI.RequestCatchUpState]]()
   
==== Legendary Crafting ====
+
====Legendary Crafting====
 
Shadowlands legendaries can be crafted in the [[Forge of Domination]].
 
Shadowlands legendaries can be crafted in the [[Forge of Domination]].
 
: [[API C_LegendaryCrafting.CloseRuneforgeInteraction|C_LegendaryCrafting.CloseRuneforgeInteraction]]()
 
: [[API C_LegendaryCrafting.CloseRuneforgeInteraction|C_LegendaryCrafting.CloseRuneforgeInteraction]]()
Line 5,315: Line 5,349:
 
: [[API C_LegendaryCrafting.MakeRuneforgeCraftDescription|C_LegendaryCrafting.MakeRuneforgeCraftDescription]](<span class="apiarg">baseItem, runeforgePowerID, modifiers</span>) : <span class="apiret">description</span>
 
: [[API C_LegendaryCrafting.MakeRuneforgeCraftDescription|C_LegendaryCrafting.MakeRuneforgeCraftDescription]](<span class="apiarg">baseItem, runeforgePowerID, modifiers</span>) : <span class="apiret">description</span>
 
: [[API C_LegendaryCrafting.UpgradeRuneforgeLegendary|C_LegendaryCrafting.UpgradeRuneforgeLegendary]](<span class="apiarg">runeforgeLegendary, upgradeItem</span>)
 
: [[API C_LegendaryCrafting.UpgradeRuneforgeLegendary|C_LegendaryCrafting.UpgradeRuneforgeLegendary]](<span class="apiarg">runeforgeLegendary, upgradeItem</span>)
: <small>DEPRECATED</small> [[API C_LegendaryCrafting.GetRuneforgePowersByClassAndSpec|C_LegendaryCrafting.GetRuneforgePowersByClassAndSpec]](<span class="apiarg">[classID, specID, filter]</span>) : <span class="apiret">runeforgePowerIDs</span>
+
: <small>''DEPRECATED''</small> [[API C_LegendaryCrafting.GetRuneforgePowersByClassAndSpec|C_LegendaryCrafting.GetRuneforgePowersByClassAndSpec]](<span class="apiarg">[classID, specID, filter]</span>) : <span class="apiret">runeforgePowerIDs</span>
   
==== Soulbinds ====
+
====Soulbinds====
 
Relates to [[Soulbinding]] and [[Conduit]]s.
 
Relates to [[Soulbinding]] and [[Conduit]]s.
 
: [[API C_Soulbinds.ActivateSoulbind|C_Soulbinds.ActivateSoulbind]](<span class="apiarg">soulbindID</span>)
 
: [[API C_Soulbinds.ActivateSoulbind|C_Soulbinds.ActivateSoulbind]](<span class="apiarg">soulbindID</span>)
Line 5,360: Line 5,394:
 
: [[API C_Item.IsItemConduit|C_Item.IsItemConduit]](<span class="apiarg">itemLoc</span>) : <span class="apiret">isConduit</span>
 
: [[API C_Item.IsItemConduit|C_Item.IsItemConduit]](<span class="apiarg">itemLoc</span>) : <span class="apiret">isConduit</span>
 
: [[API SetCursorVirtualItem|SetCursorVirtualItem]]()
 
: [[API SetCursorVirtualItem|SetCursorVirtualItem]]()
: <small>DEPRECATED</small> [[API C_Soulbinds.GetConduitItemLevel|C_Soulbinds.GetConduitItemLevel]](<span class="apiarg">conduitID, rank</span>) : <span class="apiret">itemLevel</span>
+
: <small>''DEPRECATED''</small> [[API C_Soulbinds.GetConduitItemLevel|C_Soulbinds.GetConduitItemLevel]](<span class="apiarg">conduitID, rank</span>) : <span class="apiret">itemLevel</span>
   
=== Cypher Equipment ====
+
====Cypher Equipment====
 
: [[API C_Garrison.GetCurrentCypherEquipmentLevel|C_Garrison.GetCurrentCypherEquipmentLevel]]() : <span class="apiret">equipmentLevel</span>
 
: [[API C_Garrison.GetCurrentCypherEquipmentLevel|C_Garrison.GetCurrentCypherEquipmentLevel]]() : <span class="apiret">equipmentLevel</span>
 
: [[API C_Garrison.GetCyphersToNextEquipmentLevel|C_Garrison.GetCyphersToNextEquipmentLevel]]() : <span class="apiret">cyphersToNext</span>
 
: [[API C_Garrison.GetCyphersToNextEquipmentLevel|C_Garrison.GetCyphersToNextEquipmentLevel]]() : <span class="apiret">cyphersToNext</span>
 
: [[API C_Garrison.GetMaxCypherEquipmentLevel|C_Garrison.GetMaxCypherEquipmentLevel]]() : <span class="apiret">maxEquipmentLevel</span>
 
: [[API C_Garrison.GetMaxCypherEquipmentLevel|C_Garrison.GetMaxCypherEquipmentLevel]]() : <span class="apiret">maxEquipmentLevel</span>
   
== Classic ==
+
==Classic==
 
{{Wow-inline}} See [[Global functions/Classic]] for a complete list.
 
{{Wow-inline}} See [[Global functions/Classic]] for a complete list.
 
{{i-note|This incomplete list is up to date as of [[Patch_2.5.3/API_changes|Patch 2.5.3]] (41812) Jan 7 2022}}
 
{{i-note|This incomplete list is up to date as of [[Patch_2.5.3/API_changes|Patch 2.5.3]] (41812) Jan 7 2022}}
Line 5,383: Line 5,417:
 
: [[API UnitResistance|UnitResistance]](<span class="apiarg">unit [, resistanceIndex]</span>) - Returns information about a unit's resistance.
 
: [[API UnitResistance|UnitResistance]](<span class="apiarg">unit [, resistanceIndex]</span>) - Returns information about a unit's resistance.
   
=== Seasons ===
+
===Seasons===
 
: [[API C_Seasons.GetActiveSeason|C_Seasons.GetActiveSeason]]()
 
: [[API C_Seasons.GetActiveSeason|C_Seasons.GetActiveSeason]]()
 
: [[API C_Seasons.HasActiveSeason|C_Seasons.HasActiveSeason]]()
 
: [[API C_Seasons.HasActiveSeason|C_Seasons.HasActiveSeason]]()
   
=== Auction House ===
+
===Auction House===
 
: [[API CanCancelAuction|CanCancelAuction]](<span class="apiarg">index</span>) - Returns 1 if auction can be canceled.
 
: [[API CanCancelAuction|CanCancelAuction]](<span class="apiarg">index</span>) - Returns 1 if auction can be canceled.
 
: [[API CanSendAuctionQuery|CanSendAuctionQuery]]() - Returns 1 if auction search button would be active, nil otherwise.
 
: [[API CanSendAuctionQuery|CanSendAuctionQuery]]() - Returns 1 if auction search button would be active, nil otherwise.
Line 5,418: Line 5,452:
 
: [[API SortAuctionSetSort|SortAuctionSetSort]](<span class="apiarg">type, sort [, reverse]</span>) - Sorts the specific auction list by a specific column, optionally in reverse order. Requires SortAuctionApplySort() or another search query afterwards to update.
 
: [[API SortAuctionSetSort|SortAuctionSetSort]](<span class="apiarg">type, sort [, reverse]</span>) - Sorts the specific auction list by a specific column, optionally in reverse order. Requires SortAuctionApplySort() or another search query afterwards to update.
   
=== Hunter Pets ===
+
===Hunter Pets===
 
: [[API ConfirmPetUnlearn|ConfirmPetUnlearn]]() - Confirms unlearning the current pet's skills.
 
: [[API ConfirmPetUnlearn|ConfirmPetUnlearn]]() - Confirms unlearning the current pet's skills.
 
: [[API GetPetHappiness|GetPetHappiness]]() - Returns the pet's happiness, damage percentage, and loyalty gain rate.
 
: [[API GetPetHappiness|GetPetHappiness]]() - Returns the pet's happiness, damage percentage, and loyalty gain rate.
Line 5,424: Line 5,458:
 
: [[API GetPetTrainingPoints|GetPetTrainingPoints]]() - Gets the training point information about the current pet.
 
: [[API GetPetTrainingPoints|GetPetTrainingPoints]]() - Gets the training point information about the current pet.
   
==== Stables ====
+
====Stables====
 
: [[API BuyStableSlot|BuyStableSlot]]() - Buys the next stable slot if the stable window is open and you can afford it.
 
: [[API BuyStableSlot|BuyStableSlot]]() - Buys the next stable slot if the stable window is open and you can afford it.
 
: [[API ClickStablePet|ClickStablePet]](<span class="apiarg">index</span>) - Selects a stable pet.
 
: [[API ClickStablePet|ClickStablePet]](<span class="apiarg">index</span>) - Selects a stable pet.
Line 5,434: Line 5,468:
 
: [[API UnstablePet|UnstablePet]](<span class="apiarg">index</span>) - Unstables a pet.
 
: [[API UnstablePet|UnstablePet]](<span class="apiarg">index</span>) - Unstables a pet.
   
=== Keyring ===
+
===Keyring===
 
The [[Keyring]] was added again in [[Patch 1.13.3]]
 
The [[Keyring]] was added again in [[Patch 1.13.3]]
 
: [[API HasKey|HasKey]]() - Returns whether or not the player has a key ring.
 
: [[API HasKey|HasKey]]() - Returns whether or not the player has a key ring.
 
: [[API KeyRingButtonIDToInvSlotID|KeyRingButtonIDToInvSlotID]](<span class="apiarg">buttonID</span>) - Map a keyring button to an inventory slot button for use in inventory functions.
 
: [[API KeyRingButtonIDToInvSlotID|KeyRingButtonIDToInvSlotID]](<span class="apiarg">buttonID</span>) - Map a keyring button to an inventory slot button for use in inventory functions.
   
=== Professions ===
+
===Professions===
 
: [[API CloseTradeSkill|CloseTradeSkill]]()
 
: [[API CloseTradeSkill|CloseTradeSkill]]()
 
: [[API CollapseTradeSkillSubClass|CollapseTradeSkillSubClass]](<span class="apiarg">index</span>)
 
: [[API CollapseTradeSkillSubClass|CollapseTradeSkillSubClass]](<span class="apiarg">index</span>)
Line 5,468: Line 5,502:
 
: [[API SetTradeSkillSubClassFilter|SetTradeSkillSubClassFilter]](<span class="apiarg">index [, on\off, exclusive]</span>)
 
: [[API SetTradeSkillSubClassFilter|SetTradeSkillSubClassFilter]](<span class="apiarg">index [, on\off, exclusive]</span>)
   
==== Crafting ====
+
====Crafting====
 
The Craft UI is used for Enchanting and [[:Beast Training]].
 
The Craft UI is used for Enchanting and [[:Beast Training]].
 
: [[API CloseCraft|CloseCraft]]()
 
: [[API CloseCraft|CloseCraft]]()
Line 5,490: Line 5,524:
 
: [[API SelectCraft|SelectCraft]](<span class="apiarg">index</span>)
 
: [[API SelectCraft|SelectCraft]](<span class="apiarg">index</span>)
   
=== PvP ===
+
===PvP===
 
: [[API GetInspectPVPRankProgress|GetInspectPVPRankProgress]]() - Gets the inspected unit's progress towards the next PvP rank.
 
: [[API GetInspectPVPRankProgress|GetInspectPVPRankProgress]]() - Gets the inspected unit's progress towards the next PvP rank.
 
: [[API GetPVPLastWeekStats|GetPVPLastWeekStats]]() - Gets the player's PVP contribution statistics for the previous week.
 
: [[API GetPVPLastWeekStats|GetPVPLastWeekStats]]() - Gets the player's PVP contribution statistics for the previous week.
Line 5,499: Line 5,533:
 
: [[API UnitPVPRank|UnitPVPRank]](<span class="apiarg">unit</span>) - Returns the specified unit's PvP rank ID.
 
: [[API UnitPVPRank|UnitPVPRank]](<span class="apiarg">unit</span>) - Returns the specified unit's PvP rank ID.
   
==== Battlegrounds ====
+
====Battlegrounds====
 
: [[API GetBattlefieldInstanceInfo|GetBattlefieldInstanceInfo]](<span class="apiarg">index</span>) - Returns the battlefield instance ID for an index in the battlemaster listing.
 
: [[API GetBattlefieldInstanceInfo|GetBattlefieldInstanceInfo]](<span class="apiarg">index</span>) - Returns the battlefield instance ID for an index in the battlemaster listing.
 
: [[API GetNumBattlefields|GetNumBattlefields]]() - Returns the number of available instances for the selected battleground at the battlemaster.
 
: [[API GetNumBattlefields|GetNumBattlefields]]() - Returns the number of available instances for the selected battleground at the battlemaster.
Line 5,505: Line 5,539:
 
: [[API SetSelectedBattlefield|SetSelectedBattlefield]](<span class="apiarg">index</span>) - Selects a battlefield instance at the battlemaster.
 
: [[API SetSelectedBattlefield|SetSelectedBattlefield]](<span class="apiarg">index</span>) - Selects a battlefield instance at the battlemaster.
   
=== Arena ===
+
===Arena===
 
: [[API AcceptArenaTeam|AcceptArenaTeam]]()
 
: [[API AcceptArenaTeam|AcceptArenaTeam]]()
 
: [[API ArenaTeamDisband|ArenaTeamDisband]](<span class="apiarg">index</span>)
 
: [[API ArenaTeamDisband|ArenaTeamDisband]](<span class="apiarg">index</span>)
Line 5,532: Line 5,566:
 
: [[API TurnInArenaPetition|TurnInArenaPetition]]()
 
: [[API TurnInArenaPetition|TurnInArenaPetition]]()
   
=== Skills ===
+
===Skills===
 
Relates to player/trainer [[Skill]]s.
 
Relates to player/trainer [[Skill]]s.
 
: [[API CollapseSkillHeader|CollapseSkillHeader]](<span class="apiarg">index</span>) - Collapses a header in the skills window.
 
: [[API CollapseSkillHeader|CollapseSkillHeader]](<span class="apiarg">index</span>) - Collapses a header in the skills window.
Line 5,544: Line 5,578:
 
: [[API SetSelectedSkill|SetSelectedSkill]](<span class="apiarg">index</span>) - Selects a skill line in the skill window.
 
: [[API SetSelectedSkill|SetSelectedSkill]](<span class="apiarg">index</span>) - Selects a skill line in the skill window.
   
=== Talents ===
+
===Talents===
 
: [[API GetNumTalents|GetNumTalents]](<span class="apiarg">tabIndex</span>) - Returns the amount of talents for a specialization.
 
: [[API GetNumTalents|GetNumTalents]](<span class="apiarg">tabIndex</span>) - Returns the amount of talents for a specialization.
 
: [[API GetNumTalentTabs|GetNumTalentTabs]]() - Returns the total number of talent tabs for the player.
 
: [[API GetNumTalentTabs|GetNumTalentTabs]]() - Returns the total number of talent tabs for the player.
Line 5,552: Line 5,586:
 
: [[API UnitCharacterPoints|UnitCharacterPoints]](<span class="apiarg">unit</span>) - Returns the number of unspent talent points of the player.
 
: [[API UnitCharacterPoints|UnitCharacterPoints]](<span class="apiarg">unit</span>) - Returns the number of unspent talent points of the player.
   
=== Tracking ===
+
===Tracking===
 
: [[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 ==
+
==FrameXML==
=== MathUtil ===
+
===MathUtil===
: <small>UI</small> [http://townlong-yak.com/framexml/go/Lerp Lerp](<span class="apiarg">startValue, endValue, amount</span>) : <span class="apiret">''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/Lerp Lerp](<span class="apiarg">startValue, endValue, amount</span>) : <span class="apiret">''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 class="apiarg">value, min, max</span>) : <span class="apiret">''number''</span>
+
: <small>''UI''</small> [http://townlong-yak.com/framexml/go/Clamp Clamp](<span class="apiarg">value, min, max</span>) : <span class="apiret">''number''</span>
: <small>UI</small> [http://townlong-yak.com/framexml/go/Saturate Saturate](<span class="apiarg">value</span>) : <span class="apiret">''number''</span>
+
: <small>''UI''</small> [http://townlong-yak.com/framexml/go/Saturate Saturate](<span class="apiarg">value</span>) : <span class="apiret">''number''</span>
: <small>UI</small> [http://townlong-yak.com/framexml/go/Wrap Wrap](<span class="apiarg">value, max</span>) : <span class="apiret">''number''</span>
+
: <small>''UI''</small> [http://townlong-yak.com/framexml/go/Wrap Wrap](<span class="apiarg">value, max</span>) : <span class="apiret">''number''</span>
: <small>UI</small> [http://townlong-yak.com/framexml/go/ClampDegrees ClampDegrees](<span class="apiarg">value</span>) : <span class="apiret">''number''</span>
+
: <small>''UI''</small> [http://townlong-yak.com/framexml/go/ClampDegrees ClampDegrees](<span class="apiarg">value</span>) : <span class="apiret">''number''</span>
: <small>UI</small> [http://townlong-yak.com/framexml/go/ClampMod ClampMod](<span class="apiarg">value, mod</span>) : <span class="apiret">''number''</span>
+
: <small>''UI''</small> [http://townlong-yak.com/framexml/go/ClampMod ClampMod](<span class="apiarg">value, mod</span>) : <span class="apiret">''number''</span>
: <small>UI</small> [http://townlong-yak.com/framexml/go/NegateIf NegateIf](<span class="apiarg">value, condition</span>) : <span class="apiret">''number''</span>
+
: <small>''UI''</small> [http://townlong-yak.com/framexml/go/NegateIf NegateIf](<span class="apiarg">value, condition</span>) : <span class="apiret">''number''</span>
: <small>UI</small> [http://townlong-yak.com/framexml/go/PercentageBetween PercentageBetween](<span class="apiarg">value, startValue, endValue</span>) : <span class="apiret">''number''</span>
+
: <small>''UI''</small> [http://townlong-yak.com/framexml/go/PercentageBetween PercentageBetween](<span class="apiarg">value, startValue, endValue</span>) : <span class="apiret">''number''</span>
: <small>UI</small> [http://townlong-yak.com/framexml/go/ClampedPercentageBetween ClampedPercentageBetween](<span class="apiarg">value, startValue, endValue</span>) : <span class="apiret">''number''</span>
+
: <small>''UI''</small> [http://townlong-yak.com/framexml/go/ClampedPercentageBetween ClampedPercentageBetween](<span class="apiarg">value, startValue, endValue</span>) : <span class="apiret">''number''</span>
: <small>UI</small> [http://townlong-yak.com/framexml/go/DeltaLerp DeltaLerp](<span class="apiarg">startValue, endValue, amount, timeSec</span>) : <span class="apiret">''number''</span>
+
: <small>''UI''</small> [http://townlong-yak.com/framexml/go/DeltaLerp DeltaLerp](<span class="apiarg">startValue, endValue, amount, timeSec</span>) : <span class="apiret">''number''</span>
: <small>UI</small> [http://townlong-yak.com/framexml/go/FrameDeltaLerp FrameDeltaLerp](<span class="apiarg">startValue, endValue, amount</span>) : <span class="apiret">''number''</span>
+
: <small>''UI''</small> [http://townlong-yak.com/framexml/go/FrameDeltaLerp FrameDeltaLerp](<span class="apiarg">startValue, endValue, amount</span>) : <span class="apiret">''number''</span>
: <small>UI</small> [http://townlong-yak.com/framexml/go/RandomFloatInRange RandomFloatInRange](<span class="apiarg">minValue, maxValue</span>) : <span class="apiret">''number''</span>
+
: <small>''UI''</small> [http://townlong-yak.com/framexml/go/RandomFloatInRange RandomFloatInRange](<span class="apiarg">minValue, maxValue</span>) : <span class="apiret">''number''</span>
: <small>UI</small> [http://townlong-yak.com/framexml/go/Round Round](<span class="apiarg">value</span>) : <span class="apiret">''number''</span> - Rounds a value.
+
: <small>''UI''</small> [http://townlong-yak.com/framexml/go/Round Round](<span class="apiarg">value</span>) : <span class="apiret">''number''</span> - Rounds a value.
: <small>UI</small> [http://townlong-yak.com/framexml/go/Square Square](<span class="apiarg">value</span>) : <span class="apiret">''number''</span> - Squares a value.
+
: <small>''UI''</small> [http://townlong-yak.com/framexml/go/Square Square](<span class="apiarg">value</span>) : <span class="apiret">''number''</span> - Squares a value.
: <small>UI</small> [http://townlong-yak.com/framexml/go/CalculateDistanceSq CalculateDistanceSq](<span class="apiarg">x1, y1, x2, y2</span>) : <span class="apiret">''number''</span>
+
: <small>''UI''</small> [http://townlong-yak.com/framexml/go/CalculateDistanceSq CalculateDistanceSq](<span class="apiarg">x1, y1, x2, y2</span>) : <span class="apiret">''number''</span>
: <small>UI</small> [http://townlong-yak.com/framexml/go/CalculateDistance CalculateDistance](<span class="apiarg">x1, y1, x2, y2</span>) : <span class="apiret">''number''</span>
+
: <small>''UI''</small> [http://townlong-yak.com/framexml/go/CalculateDistance CalculateDistance](<span class="apiarg">x1, y1, x2, y2</span>) : <span class="apiret">''number''</span>
: <small>UI</small> [http://townlong-yak.com/framexml/go/CalculateAngleBetween CalculateAngleBetween](<span class="apiarg">x1, y1, x2, y2</span>) : <span class="apiret">''number''</span>
+
: <small>''UI''</small> [http://townlong-yak.com/framexml/go/CalculateAngleBetween CalculateAngleBetween](<span class="apiarg">x1, y1, x2, y2</span>) : <span class="apiret">''number''</span>
   
=== TableUtil ===
+
===TableUtil===
: <small>UI</small> [http://townlong-yak.com/framexml/go/ripairs ripairs](<span class="apiarg">tbl</span>) : <span class="apiret">iter, invariant, init</span> - Reverse iterates over a sequential table.
+
: <small>''UI''</small> [http://townlong-yak.com/framexml/go/ripairs ripairs](<span class="apiarg">tbl</span>) : <span class="apiret">iter, invariant, init</span> - Reverse iterates over a sequential table.
: <small>UI</small> [http://townlong-yak.com/framexml/go/tDeleteItem tDeleteItem](<span class="apiarg">tbl, item</span>) - Removes a value from a sequential table.
+
: <small>''UI''</small> [http://townlong-yak.com/framexml/go/tDeleteItem tDeleteItem](<span class="apiarg">tbl, item</span>) - Removes a value from a sequential table.
: <small>UI</small> [http://townlong-yak.com/framexml/go/tIndexOf tIndexOf](<span class="apiarg">tbl, item</span>) : <span class="apiret">index</span> - Returns the index for a value in a table.
+
: <small>''UI''</small> [http://townlong-yak.com/framexml/go/tIndexOf tIndexOf](<span class="apiarg">tbl, item</span>) : <span class="apiret">index</span> - Returns the index for a value in a table.
: <small>UI</small> [http://townlong-yak.com/framexml/go/tContains tContains](<span class="apiarg">tbl, item</span>) : <span class="apiret">''boolean''</span> - Returns true if a sequential table contains a value.
+
: <small>''UI''</small> [http://townlong-yak.com/framexml/go/tContains tContains](<span class="apiarg">tbl, item</span>) : <span class="apiret">''boolean''</span> - Returns true if a sequential table contains a value.
: <small>UI</small> [http://townlong-yak.com/framexml/go/tCompare tCompare](<span class="apiarg">lhsTable, rhsTable [, depth]</span>) : <span class="apiret">''boolean''</span> - Does a deep compare on the values of the table.
+
: <small>''UI''</small> [http://townlong-yak.com/framexml/go/tCompare tCompare](<span class="apiarg">lhsTable, rhsTable [, depth]</span>) : <span class="apiret">''boolean''</span> - Does a deep compare on the values of the table.
: <small>UI</small> [http://townlong-yak.com/framexml/go/tInvert tInvert](<span class="apiarg">tbl</span>) : <span class="apiret">''table''</span> - Returns an inverted table.
+
: <small>''UI''</small> [http://townlong-yak.com/framexml/go/tInvert tInvert](<span class="apiarg">tbl</span>) : <span class="apiret">''table''</span> - Returns an inverted table.
: <small>UI</small> [http://townlong-yak.com/framexml/go/tFilter tFilter](<span class="apiarg">tbl, pred, isIndexTable</span>) : <span class="apiret">''table''</span>
+
: <small>''UI''</small> [http://townlong-yak.com/framexml/go/tFilter tFilter](<span class="apiarg">tbl, pred, isIndexTable</span>) : <span class="apiret">''table''</span>
: <small>UI</small> [http://townlong-yak.com/framexml/go/tAppendAll tAppendAll](<span class="apiarg">table, addedArray</span>) - Appends the contents of a sequential table to another table.
+
: <small>''UI''</small> [http://townlong-yak.com/framexml/go/tAppendAll tAppendAll](<span class="apiarg">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 class="apiarg">tbl, index</span>)
+
: <small>''UI''</small> [http://townlong-yak.com/framexml/go/tUnorderedRemove tUnorderedRemove](<span class="apiarg">tbl, index</span>)
: <small>UI</small> [http://townlong-yak.com/framexml/go/CopyTable CopyTable](<span class="apiarg">settings</span>) : <span class="apiret">''table''</span> - Returns a deep copy of a table.
+
: <small>''UI''</small> [http://townlong-yak.com/framexml/go/CopyTable CopyTable](<span class="apiarg">settings</span>) : <span class="apiret">''table''</span> - Returns a deep copy of a table.
: <small>UI</small> [http://townlong-yak.com/framexml/go/AccumulateIf AccumulateIf](<span class="apiarg">tbl, pred</span>) : <span class="apiret">count</span>
+
: <small>''UI''</small> [http://townlong-yak.com/framexml/go/AccumulateIf AccumulateIf](<span class="apiarg">tbl, pred</span>) : <span class="apiret">count</span>
: <small>UI</small> [http://townlong-yak.com/framexml/go/ContainsIf ContainsIf](<span class="apiarg">tbl, pred</span>) : <span class="apiret">''boolean''</span>
+
: <small>''UI''</small> [http://townlong-yak.com/framexml/go/ContainsIf ContainsIf](<span class="apiarg">tbl, pred</span>) : <span class="apiret">''boolean''</span>
: <small>UI</small> [http://townlong-yak.com/framexml/go/FindInTableIf FindInTableIf](<span class="apiarg">tbl, pred</span>) : <span class="apiret">key, value</span>
+
: <small>''UI''</small> [http://townlong-yak.com/framexml/go/FindInTableIf FindInTableIf](<span class="apiarg">tbl, pred</span>) : <span class="apiret">key, value</span>
: <small>UI</small> [http://townlong-yak.com/framexml/go/SafePack SafePack](<span class="apiarg">...</span>) : <span class="apiret">''table''</span>
+
: <small>''UI''</small> [http://townlong-yak.com/framexml/go/SafePack SafePack](<span class="apiarg">...</span>) : <span class="apiret">''table''</span>
: <small>UI</small> [http://townlong-yak.com/framexml/go/SafeUnpack SafeUnpack](<span class="apiarg">tbl</span>) : <span class="apiret">...</span>
+
: <small>''UI''</small> [http://townlong-yak.com/framexml/go/SafeUnpack SafeUnpack](<span class="apiarg">tbl</span>) : <span class="apiret">...</span>
   
=== CvarUtil ===
+
===CvarUtil===
: <small>UI</small> [http://townlong-yak.com/framexml/go/RegisterCVar RegisterCVar](<span class="apiarg">name, value</span>)
+
: <small>''UI''</small> [http://townlong-yak.com/framexml/go/RegisterCVar RegisterCVar](<span class="apiarg">name, value</span>)
: <small>UI</small> [http://townlong-yak.com/framexml/go/ResetTestCvars ResetTestCvars]()
+
: <small>''UI''</small> [http://townlong-yak.com/framexml/go/ResetTestCvars ResetTestCvars]()
: <small>UI</small> [http://townlong-yak.com/framexml/go/SetCVar SetCVar](<span class="apiarg">name, value, eventName</span>) : <span class="apiret">success</span>
+
: <small>''UI''</small> [http://townlong-yak.com/framexml/go/SetCVar SetCVar](<span class="apiarg">name, value, eventName</span>) : <span class="apiret">success</span>
: <small>UI</small> [http://townlong-yak.com/framexml/go/GetCVar GetCVar](<span class="apiarg">name</span>) : <span class="apiret">value</span>
+
: <small>''UI''</small> [http://townlong-yak.com/framexml/go/GetCVar GetCVar](<span class="apiarg">name</span>) : <span class="apiret">value</span>
: <small>UI</small> [http://townlong-yak.com/framexml/go/SetCVarBitfield SetCVarBitfield](<span class="apiarg">name, index, value, scriptCVar</span>) : <span class="apiret">success</span>
+
: <small>''UI''</small> [http://townlong-yak.com/framexml/go/SetCVarBitfield SetCVarBitfield](<span class="apiarg">name, index, value, scriptCVar</span>) : <span class="apiret">success</span>
: <small>UI</small> [http://townlong-yak.com/framexml/go/GetCVarBitfield GetCVarBitfield](<span class="apiarg">name, index</span>) : <span class="apiret">''boolean''</span>
+
: <small>''UI''</small> [http://townlong-yak.com/framexml/go/GetCVarBitfield GetCVarBitfield](<span class="apiarg">name, index</span>) : <span class="apiret">''boolean''</span>
: <small>UI</small> [http://townlong-yak.com/framexml/go/GetCVarBool GetCVarBool](<span class="apiarg">name</span>) : <span class="apiret">''boolean''</span>
+
: <small>''UI''</small> [http://townlong-yak.com/framexml/go/GetCVarBool GetCVarBool](<span class="apiarg">name</span>) : <span class="apiret">''boolean''</span>
: <small>UI</small> [http://townlong-yak.com/framexml/go/GetCVarDefault GetCVarDefault](<span class="apiarg">name</span>) : <span class="apiret">value</span>
+
: <small>''UI''</small> [http://townlong-yak.com/framexml/go/GetCVarDefault GetCVarDefault](<span class="apiarg">name</span>) : <span class="apiret">value</span>
   
=== Mixins ===
+
===Mixins===
 
: <span class="noexcerpt" data-nosnippet>''See also the [https://github.com/Ketho/BlizzardInterfaceResources/blob/mainline/Resources/Mixins.lua Complete list]'' of mixins</span>
 
: <span class="noexcerpt" data-nosnippet>''See also the [https://github.com/Ketho/BlizzardInterfaceResources/blob/mainline/Resources/Mixins.lua Complete list]'' of mixins</span>
 
[[Wikipedia:Mixin|Mixin]]s are similar to classes in OOP languages. An object can "inherit" from multiple 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 class="apiarg">object, ...</span>) - Copies mixins into an existing object.
+
: <small>''UI''</small> [https://www.townlong-yak.com/framexml/go/Mixin Mixin](<span class="apiarg">object, ...</span>) - Copies mixins into an existing object.
: <small>UI</small> [https://www.townlong-yak.com/framexml/go/CreateFromMixins CreateFromMixins](<span class="apiarg">...</span>) - Copies mixins into a new object.
+
: <small>''UI''</small> [https://www.townlong-yak.com/framexml/go/CreateFromMixins CreateFromMixins](<span class="apiarg">...</span>) - Copies mixins into a new object.
   
: <small>UI</small> [https://www.townlong-yak.com/framexml/go/CreateColor CreateColor](<span class="apiarg">r, g, b, a</span>) - Returns a [[ColorMixin]] object.
+
: <small>''UI''</small> [https://www.townlong-yak.com/framexml/go/CreateColor CreateColor](<span class="apiarg">r, g, b, a</span>) - Returns a [[ColorMixin]] object.
: <small>UI</small> [https://www.townlong-yak.com/framexml/go/CreateRectangle CreateRectangle](<span class="apiarg">left, right, top, bottom</span>) - Returns a [[RectangleMixin]] object.
+
: <small>''UI''</small> [https://www.townlong-yak.com/framexml/go/CreateRectangle CreateRectangle](<span class="apiarg">left, right, top, bottom</span>) - Returns a [[RectangleMixin]] object.
: <small>UI</small> [https://www.townlong-yak.com/framexml/go/CreateVector2D CreateVector2D](<span class="apiarg">x, y</span>) - Returns a [[Vector2DMixin]] object.
+
: <small>''UI''</small> [https://www.townlong-yak.com/framexml/go/CreateVector2D CreateVector2D](<span class="apiarg">x, y</span>) - Returns a [[Vector2DMixin]] object.
: <small>UI</small> [https://www.townlong-yak.com/framexml/go/CreateVector3D CreateVector3D](<span class="apiarg">x, y, z</span>) - Returns a [[Vector3DMixin]] object.
+
: <small>''UI''</small> [https://www.townlong-yak.com/framexml/go/CreateVector3D CreateVector3D](<span class="apiarg">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 class="apiarg">spellID</span>) - Returns a [[SpellMixin]] object.
+
: <small>''UI''</small> [https://www.townlong-yak.com/framexml/9.0.2/ObjectAPI/Spell.lua#4 SpellMixin:CreateFromSpellID](<span class="apiarg">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 class="apiarg">itemID</span>) - Returns an [[ItemMixin]] object.
+
: <small>''UI''</small> [https://www.townlong-yak.com/framexml/9.0.2/ObjectAPI/Item.lua#40 Item:CreateFromItemID](<span class="apiarg">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/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 class="apiarg">guid</span>) - Returns a [[PlayerLocationMixin]] object.
+
: <small>''UI''</small> [https://www.townlong-yak.com/framexml/9.0.2/ObjectAPI/PlayerLocation.lua#4 PlayerLocation:CreateFromGUID](<span class="apiarg">guid</span>) - Returns a [[PlayerLocationMixin]] object.
: <small>UI</small> [https://www.townlong-yak.com/framexml/9.0.2/TransmogUtil.lua#76 TransmogUtil.CreateTransmogLocation](<span class="apiarg">slotDescriptor, transmogType, modification</span>) - Returns a [[TransmogLocationMixin]] object.
+
: <small>''UI''</small> [https://www.townlong-yak.com/framexml/9.0.2/TransmogUtil.lua#76 TransmogUtil.CreateTransmogLocation](<span class="apiarg">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/AnchorMixin AnchorMixin]
: <small>UI</small> [https://www.townlong-yak.com/framexml/go/AnimatedNumericFontStringMixin AnimatedNumericFontStringMixin]
+
: <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/DoublyLinkedListMixin DoublyLinkedListMixin]
: <small>UI</small> [https://www.townlong-yak.com/framexml/go/GridLayoutMixin GridLayoutMixin]
+
: <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/LineMixin LineMixin]
: <small>UI</small> [https://www.townlong-yak.com/framexml/go/SecondsFormatterMixin SecondsFormatterMixin]
+
: <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/SparseGridMixin SparseGridMixin]
: <small>UI</small> [https://www.townlong-yak.com/framexml/go/TextureLoadingGroupMixin TextureLoadingGroupMixin]
+
: <small>''UI''</small> [https://www.townlong-yak.com/framexml/go/TextureLoadingGroupMixin TextureLoadingGroupMixin]
   
: <small>UI</small> [[API CreateObjectPool|CreateObjectPool]](<span class="apiarg">creationFunc, resetterFunc</span>) - Creates a [[ObjectPoolMixin]] object for [[UIOBJECT UIObject|widgets]].
+
: <small>''UI''</small> [[API CreateObjectPool|CreateObjectPool]](<span class="apiarg">creationFunc, resetterFunc</span>) - Creates a [[ObjectPoolMixin]] object for [[UIOBJECT UIObject|widgets]].
: <small>UI</small> [[API CreateFramePool|CreateFramePool]](<span class="apiarg">frameType [, parent, frameTemplate, resetterFunc, forbidden]</span>) - Creates a [[FramePoolMixin]] for [[UIOBJECT Frame|Frames]].
+
: <small>''UI''</small> [[API CreateFramePool|CreateFramePool]](<span class="apiarg">frameType [, parent, frameTemplate, resetterFunc, forbidden]</span>) - Creates a [[FramePoolMixin]] for [[UIOBJECT Frame|Frames]].
: <small>UI</small> [[API CreateTexturePool|CreateTexturePool]](<span class="apiarg">parent [, layer, subLayer, textureTemplate, resetterFunc]</span>) - Creates a [[TexturePoolMixin]] for [[UIOBJECT Texture|Textures]].
+
: <small>''UI''</small> [[API CreateTexturePool|CreateTexturePool]](<span class="apiarg">parent [, layer, subLayer, textureTemplate, resetterFunc]</span>) - Creates a [[TexturePoolMixin]] for [[UIOBJECT Texture|Textures]].
: <small>UI</small> [[API CreateFontStringPool|CreateFontStringPool]](<span class="apiarg">parent [, layer, subLayer, fontStringTemplate, resetterFunc]</span>) - Creates a [[FontStringPoolMixin]] for [[UIOBJECT FontString|FontStrings]].
+
: <small>''UI''</small> [[API CreateFontStringPool|CreateFontStringPool]](<span class="apiarg">parent [, layer, subLayer, fontStringTemplate, resetterFunc]</span>) - Creates a [[FontStringPoolMixin]] for [[UIOBJECT FontString|FontStrings]].
: <small>UI</small> [[API CreateActorPool|CreateActorPool]](<span class="apiarg">parent [, actorTemplate, resetterFunc]</span>) - Creates an [[ActorPoolMixin]] for [[UIOBJECT Actor|Actors]].
+
: <small>''UI''</small> [[API CreateActorPool|CreateActorPool]](<span class="apiarg">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]].
+
: <small>''UI''</small> [https://www.townlong-yak.com/framexml/go/CreateFramePoolCollection CreateFramePoolCollection]() - Creates a [[FramePoolCollectionMixin]] object for [[FramePoolMixin|frame pools]].
   
=== UIParent ===
+
===UIParent===
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=AbbreviateLargeNumbers AbbreviateLargeNumbers](<span class="apiarg">value</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=AbbreviateLargeNumbers AbbreviateLargeNumbers](<span class="apiarg">value</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=AbbreviateNumbers AbbreviateNumbers](<span class="apiarg">value</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=AbbreviateNumbers AbbreviateNumbers](<span class="apiarg">value</span>)
 
These functions toggle the Interface Panels, but if they use <code>ShowUIPanel()</code> they cannot be called in combat.
 
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 class="apiarg">frame, force</span>)
+
: <small>''UI''</small> {{api|ShowUIPanel}}(<span class="apiarg">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/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> [https://www.townlong-yak.com/framexml/go/ToggleAchievementFrame ToggleAchievementFrame]() - Shows the Achievements frame.
: <small>UI</small> [[API ToggleCharacter|ToggleCharacter]](<span class="apiarg">index</span>) - Toggles the character pane to the specified frame.
+
: <small>''UI''</small> [[API ToggleCharacter|ToggleCharacter]](<span class="apiarg">index</span>) - Toggles the character pane to the specified frame.
: <small>UI</small> [https://www.townlong-yak.com/framexml/go/ToggleCollectionsJournal ToggleCollectionsJournal](<span class="apiarg">index</span>) - Toggles the Collections window.
+
: <small>''UI''</small> [https://www.townlong-yak.com/framexml/go/ToggleCollectionsJournal ToggleCollectionsJournal](<span class="apiarg">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> [https://www.townlong-yak.com/framexml/go/ToggleEncounterJournal ToggleEncounterJournal]() - Toggles the Adventure Guide.
: <small>UI</small> [[API ToggleFriendsFrame|ToggleFriendsFrame]](<span class="apiarg">[tabNumber]</span>) - Opens/closes the friends pane, optionally on a specific tab.
+
: <small>''UI''</small> [[API ToggleFriendsFrame|ToggleFriendsFrame]](<span class="apiarg">[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> [[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/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> [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 ToggleMinimap|ToggleMinimap]]() - Turns the minimap display on/off.
: <small>UI</small> [[API TogglePVPUI|TogglePVPUI]]() - Opens/closes the PvP frame.
+
: <small>''UI''</small> [[API TogglePVPUI|TogglePVPUI]]() - Opens/closes the PvP frame.
: <small>UI</small> [[API ToggleSpellBook|ToggleSpellBook]](<span class="apiarg">bookType</span>) - Shows the spellbook. Can show your spells or your pet's.
+
: <small>''UI''</small> [[API ToggleSpellBook|ToggleSpellBook]](<span class="apiarg">bookType</span>) - Shows the spellbook. Can show your spells or your pet's.
: <small>UI</small> [[API ToggleTalentFrame|ToggleTalentFrame]]() - Opens the Talent frame.
+
: <small>''UI''</small> [[API ToggleTalentFrame|ToggleTalentFrame]]() - Opens the Talent frame.
   
   
 
'''[https://github.com/Gethe/wow-ui-source/tree/live/Interface/SharedXML Interface/SharedXML]'''
 
'''[https://github.com/Gethe/wow-ui-source/tree/live/Interface/SharedXML Interface/SharedXML]'''
   
=== AccountUtil ===
+
===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=GameLimitedMode_IsActive GameLimitedMode_IsActive]()
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetClampedCurrentExpansionLevel GetClampedCurrentExpansionLevel]()
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=GetClampedCurrentExpansionLevel GetClampedCurrentExpansionLevel]()
=== AnchorUtil ===
+
===AnchorUtil===
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=CreateAnchor AnchorUtil.CreateAnchor](<span class="apiarg">point, relativeTo, relativePoint, x, y</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=CreateAnchor AnchorUtil.CreateAnchor](<span class="apiarg">point, relativeTo, relativePoint, x, y</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=CreateGridLayout AnchorUtil.CreateGridLayout](<span class="apiarg">direction, rowSize, spacingX, spacingY</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=CreateGridLayout AnchorUtil.CreateGridLayout](<span class="apiarg">direction, rowSize, spacingX, spacingY</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=CreateAnchorFromPoint AnchorUtil.CreateAnchorFromPoint](<span class="apiarg">region, pointIndex</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=CreateAnchorFromPoint AnchorUtil.CreateAnchorFromPoint](<span class="apiarg">region, pointIndex</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GridLayout AnchorUtil.GridLayout](<span class="apiarg">frames, initialAnchor, layout</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=GridLayout AnchorUtil.GridLayout](<span class="apiarg">frames, initialAnchor, layout</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GridLayoutFactoryByCount AnchorUtil.GridLayoutFactoryByCount](<span class="apiarg">factoryFunction, count, initialAnchor, layout</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=GridLayoutFactoryByCount AnchorUtil.GridLayoutFactoryByCount](<span class="apiarg">factoryFunction, count, initialAnchor, layout</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GridLayoutFactory AnchorUtil.GridLayoutFactory](<span class="apiarg">factoryFunction, initialAnchor, totalWidth, totalHeight, overrideDirection, overridePaddingX, overridePaddingY</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=GridLayoutFactory AnchorUtil.GridLayoutFactory](<span class="apiarg">factoryFunction, initialAnchor, totalWidth, totalHeight, overrideDirection, overridePaddingX, overridePaddingY</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=MirrorRegionsAlongVerticalAxis AnchorUtil.MirrorRegionsAlongVerticalAxis](<span class="apiarg">mirrorDescriptions</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=MirrorRegionsAlongVerticalAxis AnchorUtil.MirrorRegionsAlongVerticalAxis](<span class="apiarg">mirrorDescriptions</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=MirrorRegionsAlongHorizontalAxis AnchorUtil.MirrorRegionsAlongHorizontalAxis](<span class="apiarg">mirrorDescriptions</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=MirrorRegionsAlongHorizontalAxis AnchorUtil.MirrorRegionsAlongHorizontalAxis](<span class="apiarg">mirrorDescriptions</span>)
=== ColorUtil ===
+
===ColorUtil===
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=CreateColorFromHexString CreateColorFromHexString](<span class="apiarg">hexColor</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=CreateColorFromHexString CreateColorFromHexString](<span class="apiarg">hexColor</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=CreateColorFromBytes CreateColorFromBytes](<span class="apiarg">r, g, b, a</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=CreateColorFromBytes CreateColorFromBytes](<span class="apiarg">r, g, b, a</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=AreColorsEqual AreColorsEqual](<span class="apiarg">left, right</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=AreColorsEqual AreColorsEqual](<span class="apiarg">left, right</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetClassColor GetClassColor](<span class="apiarg">classFilename</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=GetClassColor GetClassColor](<span class="apiarg">classFilename</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetClassColorObj GetClassColorObj](<span class="apiarg">classFilename</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=GetClassColorObj GetClassColorObj](<span class="apiarg">classFilename</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetClassColoredTextForUnit GetClassColoredTextForUnit](<span class="apiarg">unit, text</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=GetClassColoredTextForUnit GetClassColoredTextForUnit](<span class="apiarg">unit, text</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetFactionColor GetFactionColor](<span class="apiarg">factionGroupTag</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=GetFactionColor GetFactionColor](<span class="apiarg">factionGroupTag</span>)
=== EasingUtil ===
+
===EasingUtil===
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=InQuadratic EasingUtil.InQuadratic](<span class="apiarg">percent</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=InQuadratic EasingUtil.InQuadratic](<span class="apiarg">percent</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=OutQuadratic EasingUtil.OutQuadratic](<span class="apiarg">percent</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=OutQuadratic EasingUtil.OutQuadratic](<span class="apiarg">percent</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=InOutQuadratic EasingUtil.InOutQuadratic](<span class="apiarg">percent</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=InOutQuadratic EasingUtil.InOutQuadratic](<span class="apiarg">percent</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=InCubic EasingUtil.InCubic](<span class="apiarg">percent</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=InCubic EasingUtil.InCubic](<span class="apiarg">percent</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=OutCubic EasingUtil.OutCubic](<span class="apiarg">percent</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=OutCubic EasingUtil.OutCubic](<span class="apiarg">percent</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=InOutCubic EasingUtil.InOutCubic](<span class="apiarg">percent</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=InOutCubic EasingUtil.InOutCubic](<span class="apiarg">percent</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=InQuartic EasingUtil.InQuartic](<span class="apiarg">percent</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=InQuartic EasingUtil.InQuartic](<span class="apiarg">percent</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=OutQuartic EasingUtil.OutQuartic](<span class="apiarg">percent</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=OutQuartic EasingUtil.OutQuartic](<span class="apiarg">percent</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=InOutQuartic EasingUtil.InOutQuartic](<span class="apiarg">percent</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=InOutQuartic EasingUtil.InOutQuartic](<span class="apiarg">percent</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=InQuintic EasingUtil.InQuintic](<span class="apiarg">percent</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=InQuintic EasingUtil.InQuintic](<span class="apiarg">percent</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=OutQuintic EasingUtil.OutQuintic](<span class="apiarg">percent</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=OutQuintic EasingUtil.OutQuintic](<span class="apiarg">percent</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=InOutQuintic EasingUtil.InOutQuintic](<span class="apiarg">percent</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=InOutQuintic EasingUtil.InOutQuintic](<span class="apiarg">percent</span>)
=== ErrorUtil ===
+
===ErrorUtil===
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=CallErrorHandler CallErrorHandler](<span class="apiarg">...</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=CallErrorHandler CallErrorHandler](<span class="apiarg">...</span>)
=== Flags ===
+
===Flags===
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=Flags_CreateMask Flags_CreateMask](<span class="apiarg">...</span>) - Creates a bitmask.
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=Flags_CreateMask Flags_CreateMask](<span class="apiarg">...</span>) - Creates a bitmask.
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=Flags_CreateMaskFromTable Flags_CreateMaskFromTable](<span class="apiarg">flagsTable</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=Flags_CreateMaskFromTable Flags_CreateMaskFromTable](<span class="apiarg">flagsTable</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=IsSet FlagsUtil.IsSet](<span class="apiarg">bitMask, flagOrMask</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=IsSet FlagsUtil.IsSet](<span class="apiarg">bitMask, flagOrMask</span>)
=== FormattingUtil ===
+
===FormattingUtil===
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=SplitTextIntoLines SplitTextIntoLines](<span class="apiarg">text, delimiter</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=SplitTextIntoLines SplitTextIntoLines](<span class="apiarg">text, delimiter</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=SplitTextIntoHeaderAndNonHeader SplitTextIntoHeaderAndNonHeader](<span class="apiarg">text</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=SplitTextIntoHeaderAndNonHeader SplitTextIntoHeaderAndNonHeader](<span class="apiarg">text</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=FormatValueWithSign FormatValueWithSign](<span class="apiarg">value</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=FormatValueWithSign FormatValueWithSign](<span class="apiarg">value</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=FormatLargeNumber FormatLargeNumber](<span class="apiarg">amount</span>) - Formats a number with dot or comma number seperators.
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=FormatLargeNumber FormatLargeNumber](<span class="apiarg">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 class="apiarg">money, separateThousands</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=GetMoneyString GetMoneyString](<span class="apiarg">money, separateThousands</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=FormatPercentage FormatPercentage](<span class="apiarg">percentage, roundToNearestInteger</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=FormatPercentage FormatPercentage](<span class="apiarg">percentage, roundToNearestInteger</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=FormatFraction FormatFraction](<span class="apiarg">numerator, denominator</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=FormatFraction FormatFraction](<span class="apiarg">numerator, denominator</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetHighlightedNumberDifferenceString GetHighlightedNumberDifferenceString](<span class="apiarg">baseString, newString</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=GetHighlightedNumberDifferenceString GetHighlightedNumberDifferenceString](<span class="apiarg">baseString, newString</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=FormatUnreadMailTooltip FormatUnreadMailTooltip](<span class="apiarg">tooltip, headerText, senders</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=FormatUnreadMailTooltip FormatUnreadMailTooltip](<span class="apiarg">tooltip, headerText, senders</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetCurrencyString GetCurrencyString](<span class="apiarg">currencyID, overrideAmount, colorCode, abbreviate</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=GetCurrencyString GetCurrencyString](<span class="apiarg">currencyID, overrideAmount, colorCode, abbreviate</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetCurrenciesString GetCurrenciesString](<span class="apiarg">currencies</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=GetCurrenciesString GetCurrenciesString](<span class="apiarg">currencies</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=ReplaceGenderTokens ReplaceGenderTokens](<span class="apiarg">string, gender</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=ReplaceGenderTokens ReplaceGenderTokens](<span class="apiarg">string, gender</span>)
=== FrameUtil ===
+
===FrameUtil===
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=RegisterFrameForEvents FrameUtil.RegisterFrameForEvents](<span class="apiarg">frame, events</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=RegisterFrameForEvents FrameUtil.RegisterFrameForEvents](<span class="apiarg">frame, events</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=UnregisterFrameForEvents FrameUtil.UnregisterFrameForEvents](<span class="apiarg">frame, events</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=UnregisterFrameForEvents FrameUtil.UnregisterFrameForEvents](<span class="apiarg">frame, events</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=RegisterFrameForUnitEvents FrameUtil.RegisterFrameForUnitEvents](<span class="apiarg">frame, events, ...</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=RegisterFrameForUnitEvents FrameUtil.RegisterFrameForUnitEvents](<span class="apiarg">frame, events, ...</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=DoesAncestryInclude DoesAncestryInclude](<span class="apiarg">ancestry, frame</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=DoesAncestryInclude DoesAncestryInclude](<span class="apiarg">ancestry, frame</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetUnscaledFrameRect GetUnscaledFrameRect](<span class="apiarg">frame, scale</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=GetUnscaledFrameRect GetUnscaledFrameRect](<span class="apiarg">frame, scale</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=ApplyDefaultScale ApplyDefaultScale](<span class="apiarg">frame, minScale, maxScale</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=ApplyDefaultScale ApplyDefaultScale](<span class="apiarg">frame, minScale, maxScale</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=UpdateScaleForFit UpdateScaleForFit](<span class="apiarg">frame</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=UpdateScaleForFit UpdateScaleForFit](<span class="apiarg">frame</span>)
=== FunctionUtil ===
+
===FunctionUtil===
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=ExecuteFrameScript ExecuteFrameScript](<span class="apiarg">frame, scriptName, ...</span>) - Manually calls the handler for a frame script.
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=ExecuteFrameScript ExecuteFrameScript](<span class="apiarg">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 class="apiarg">self, methodName, ...</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=CallMethodOnNearestAncestor CallMethodOnNearestAncestor](<span class="apiarg">self, methodName, ...</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetValueOrCallFunction GetValueOrCallFunction](<span class="apiarg">tbl, key, ...</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=GetValueOrCallFunction GetValueOrCallFunction](<span class="apiarg">tbl, key, ...</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GenerateClosure GenerateClosure](<span class="apiarg">f, ...</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=GenerateClosure GenerateClosure](<span class="apiarg">f, ...</span>)
=== InterfaceUtil ===
+
===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=ReloadUI ReloadUI]()
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=OpenToSubscriptionProduct StoreInterfaceUtil.OpenToSubscriptionProduct]()
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=OpenToSubscriptionProduct StoreInterfaceUtil.OpenToSubscriptionProduct]()
=== LinkUtil ===
+
===LinkUtil===
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=ExtractHyperlinkString ExtractHyperlinkString](<span class="apiarg">linkString</span>) - Gets the contents from a [[Hyperlinks|hyperlink]].
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=ExtractHyperlinkString ExtractHyperlinkString](<span class="apiarg">linkString</span>) - Gets the contents from a [[Hyperlinks|hyperlink]].
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=ExtractLinkData ExtractLinkData](<span class="apiarg">link</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=ExtractLinkData ExtractLinkData](<span class="apiarg">link</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=ExtractQuestRewardID ExtractQuestRewardID](<span class="apiarg">linkString</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=ExtractQuestRewardID ExtractQuestRewardID](<span class="apiarg">linkString</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetItemInfoFromHyperlink GetItemInfoFromHyperlink](<span class="apiarg">link</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=GetItemInfoFromHyperlink GetItemInfoFromHyperlink](<span class="apiarg">link</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetAchievementInfoFromHyperlink GetAchievementInfoFromHyperlink](<span class="apiarg">link</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=GetAchievementInfoFromHyperlink GetAchievementInfoFromHyperlink](<span class="apiarg">link</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetURLIndexAndLoadURL GetURLIndexAndLoadURL](<span class="apiarg">self, link</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=GetURLIndexAndLoadURL GetURLIndexAndLoadURL](<span class="apiarg">self, link</span>)
   
=== NineSlice ===
+
===NineSlice===
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=ApplyUniqueCornersLayout NineSliceUtil.ApplyUniqueCornersLayout](<span class="apiarg">self, textureKit</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=ApplyUniqueCornersLayout NineSliceUtil.ApplyUniqueCornersLayout](<span class="apiarg">self, textureKit</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=ApplyIdenticalCornersLayout NineSliceUtil.ApplyIdenticalCornersLayout](<span class="apiarg">self, textureKit</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=ApplyIdenticalCornersLayout NineSliceUtil.ApplyIdenticalCornersLayout](<span class="apiarg">self, textureKit</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=ApplyLayout NineSliceUtil.ApplyLayout](<span class="apiarg">container, userLayout, textureKit</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=ApplyLayout NineSliceUtil.ApplyLayout](<span class="apiarg">container, userLayout, textureKit</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=DisableSharpening NineSliceUtil.DisableSharpening](<span class="apiarg">container</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=DisableSharpening NineSliceUtil.DisableSharpening](<span class="apiarg">container</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=ApplyLayoutByName NineSliceUtil.ApplyLayoutByName](<span class="apiarg">container, userLayoutName, textureKit</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=ApplyLayoutByName NineSliceUtil.ApplyLayoutByName](<span class="apiarg">container, userLayoutName, textureKit</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetLayout NineSliceUtil.GetLayout](<span class="apiarg">layoutName</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=GetLayout NineSliceUtil.GetLayout](<span class="apiarg">layoutName</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=AddLayout NineSliceUtil.AddLayout](<span class="apiarg">layoutName, layout</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=AddLayout NineSliceUtil.AddLayout](<span class="apiarg">layoutName, layout</span>)
=== PixelUtil ===
+
===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=GetPixelToUIUnitFactor PixelUtil.GetPixelToUIUnitFactor]()
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetNearestPixelSize PixelUtil.GetNearestPixelSize](<span class="apiarg">uiUnitSize, layoutScale, minPixels</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=GetNearestPixelSize PixelUtil.GetNearestPixelSize](<span class="apiarg">uiUnitSize, layoutScale, minPixels</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=SetWidth PixelUtil.SetWidth](<span class="apiarg">region, width, minPixels</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=SetWidth PixelUtil.SetWidth](<span class="apiarg">region, width, minPixels</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=SetHeight PixelUtil.SetHeight](<span class="apiarg">region, height, minPixels</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=SetHeight PixelUtil.SetHeight](<span class="apiarg">region, height, minPixels</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=SetSize PixelUtil.SetSize](<span class="apiarg">region, width, height, minWidthPixels, minHeightPixels</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=SetSize PixelUtil.SetSize](<span class="apiarg">region, width, height, minWidthPixels, minHeightPixels</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=SetPoint PixelUtil.SetPoint](<span class="apiarg">region, point, relativeTo, relativePoint, offsetX, offsetY, minOffsetXPixels, minOffsetYPixels</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=SetPoint PixelUtil.SetPoint](<span class="apiarg">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 class="apiarg">statusBar, value</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=SetStatusBarValue PixelUtil.SetStatusBarValue](<span class="apiarg">statusBar, value</span>)
=== RegionUtil ===
+
===RegionUtil===
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=IsDescendantOf RegionUtil.IsDescendantOf](<span class="apiarg">potentialDescendant, potentialAncestor</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=IsDescendantOf RegionUtil.IsDescendantOf](<span class="apiarg">potentialDescendant, potentialAncestor</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=IsDescendantOfOrSame RegionUtil.IsDescendantOfOrSame](<span class="apiarg">potentialDescendant, potentialAncestorOrSame</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=IsDescendantOfOrSame RegionUtil.IsDescendantOfOrSame](<span class="apiarg">potentialDescendant, potentialAncestorOrSame</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=CalculateDistanceSqBetween RegionUtil.CalculateDistanceSqBetween](<span class="apiarg">region1, region2</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=CalculateDistanceSqBetween RegionUtil.CalculateDistanceSqBetween](<span class="apiarg">region1, region2</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=CalculateDistanceBetween RegionUtil.CalculateDistanceBetween](<span class="apiarg">region1, region2</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=CalculateDistanceBetween RegionUtil.CalculateDistanceBetween](<span class="apiarg">region1, region2</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=CalculateAngleBetween RegionUtil.CalculateAngleBetween](<span class="apiarg">region1, region2</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=CalculateAngleBetween RegionUtil.CalculateAngleBetween](<span class="apiarg">region1, region2</span>)
=== RestrictedInfrastructure ===
+
===RestrictedInfrastructure===
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=tostringall tostringall](<span class="apiarg">...</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=tostringall tostringall](<span class="apiarg">...</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=IsFrameHandle IsFrameHandle](<span class="apiarg">handle, protected</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=IsFrameHandle IsFrameHandle](<span class="apiarg">handle, protected</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetFrameHandleFrame GetFrameHandleFrame](<span class="apiarg">handle, protected, onlyProtected</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=GetFrameHandleFrame GetFrameHandleFrame](<span class="apiarg">handle, protected, onlyProtected</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetFrameHandle GetFrameHandle](<span class="apiarg">frame, protected</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=GetFrameHandle GetFrameHandle](<span class="apiarg">frame, protected</span>)
=== ScriptAnimationUtil ===
+
===ScriptAnimationUtil===
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetScriptAnimationLock ScriptAnimationUtil.GetScriptAnimationLock](<span class="apiarg">region</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=GetScriptAnimationLock ScriptAnimationUtil.GetScriptAnimationLock](<span class="apiarg">region</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=ReleaseScriptAnimationLock ScriptAnimationUtil.ReleaseScriptAnimationLock](<span class="apiarg">region</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=ReleaseScriptAnimationLock ScriptAnimationUtil.ReleaseScriptAnimationLock](<span class="apiarg">region</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=IsScriptAnimationLockActive ScriptAnimationUtil.IsScriptAnimationLockActive](<span class="apiarg">region</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=IsScriptAnimationLockActive ScriptAnimationUtil.IsScriptAnimationLockActive](<span class="apiarg">region</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=ShakeFrameRandom ScriptAnimationUtil.ShakeFrameRandom](<span class="apiarg">region, magnitude, duration, frequency</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=ShakeFrameRandom ScriptAnimationUtil.ShakeFrameRandom](<span class="apiarg">region, magnitude, duration, frequency</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=ShakeFrame ScriptAnimationUtil.ShakeFrame](<span class="apiarg">region, shake, maximumDuration, frequency</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=ShakeFrame ScriptAnimationUtil.ShakeFrame](<span class="apiarg">region, shake, maximumDuration, frequency</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GenerateEasedVariationCallback ScriptAnimationUtil.GenerateEasedVariationCallback](<span class="apiarg">easingFunction, distanceX, distanceY, alpha, scale</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=GenerateEasedVariationCallback ScriptAnimationUtil.GenerateEasedVariationCallback](<span class="apiarg">easingFunction, distanceX, distanceY, alpha, scale</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=StartScriptAnimation ScriptAnimationUtil.StartScriptAnimation](<span class="apiarg">region, variationCallback, duration, onFinish</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=StartScriptAnimation ScriptAnimationUtil.StartScriptAnimation](<span class="apiarg">region, variationCallback, duration, onFinish</span>)
=== ScriptedAnimationEffects ===
+
===ScriptedAnimationEffects===
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetEffectByID ScriptedAnimationEffectsUtil.GetEffectByID](<span class="apiarg">effectID</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=GetEffectByID ScriptedAnimationEffectsUtil.GetEffectByID](<span class="apiarg">effectID</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=ReloadDB ScriptedAnimationEffectsUtil.ReloadDB]()
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=ReloadDB ScriptedAnimationEffectsUtil.ReloadDB]()
=== TextureUtil ===
+
===TextureUtil===
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetTextureInfo GetTextureInfo](<span class="apiarg">obj</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=GetTextureInfo GetTextureInfo](<span class="apiarg">obj</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=SetClampedTextureRotation SetClampedTextureRotation](<span class="apiarg">texture, rotationDegrees</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=SetClampedTextureRotation SetClampedTextureRotation](<span class="apiarg">texture, rotationDegrees</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=ClearClampedTextureRotation ClearClampedTextureRotation](<span class="apiarg">texture</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=ClearClampedTextureRotation ClearClampedTextureRotation](<span class="apiarg">texture</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetTexCoordsByGrid GetTexCoordsByGrid](<span class="apiarg">xOffset, yOffset, textureWidth, textureHeight, gridWidth, gridHeight</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=GetTexCoordsByGrid GetTexCoordsByGrid](<span class="apiarg">xOffset, yOffset, textureWidth, textureHeight, gridWidth, gridHeight</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetTexCoordsForRole GetTexCoordsForRole](<span class="apiarg">role</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=GetTexCoordsForRole GetTexCoordsForRole](<span class="apiarg">role</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=CreateTextureMarkup CreateTextureMarkup](<span class="apiarg">file, fileWidth, fileHeight, width, height, left, right, top, bottom, xOffset, yOffset</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=CreateTextureMarkup CreateTextureMarkup](<span class="apiarg">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 class="apiarg">atlasName, width, height, offsetX, offsetY</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=CreateAtlasMarkup CreateAtlasMarkup](<span class="apiarg">atlasName, width, height, offsetX, offsetY</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=SetupAtlasesOnRegions SetupAtlasesOnRegions](<span class="apiarg">frame, regionsToAtlases, useAtlasSize</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=SetupAtlasesOnRegions SetupAtlasesOnRegions](<span class="apiarg">frame, regionsToAtlases, useAtlasSize</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetFinalNameFromTextureKit GetFinalNameFromTextureKit](<span class="apiarg">fmt, textureKits</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=GetFinalNameFromTextureKit GetFinalNameFromTextureKit](<span class="apiarg">fmt, textureKits</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=SetupTextureKitOnFrame SetupTextureKitOnFrame](<span class="apiarg">textureKit, frame, fmt, setVisibility, useAtlasSize</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=SetupTextureKitOnFrame SetupTextureKitOnFrame](<span class="apiarg">textureKit, frame, fmt, setVisibility, useAtlasSize</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=SetupTextureKitOnFrames SetupTextureKitOnFrames](<span class="apiarg">textureKit, frames, setVisibilityOfRegions, useAtlasSize</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=SetupTextureKitOnFrames SetupTextureKitOnFrames](<span class="apiarg">textureKit, frames, setVisibilityOfRegions, useAtlasSize</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=SetupTextureKitOnRegions SetupTextureKitOnRegions](<span class="apiarg">textureKit, frame, regions, setVisibilityOfRegions, useAtlasSize</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=SetupTextureKitOnRegions SetupTextureKitOnRegions](<span class="apiarg">textureKit, frame, regions, setVisibilityOfRegions, useAtlasSize</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=SetupTextureKitsFromRegionInfo SetupTextureKitsFromRegionInfo](<span class="apiarg">textureKit, frame, regionInfoList</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=SetupTextureKitsFromRegionInfo SetupTextureKitsFromRegionInfo](<span class="apiarg">textureKit, frame, regionInfoList</span>)
=== TimeUtil ===
+
===TimeUtil===
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=SecondsToMinutes SecondsToMinutes](<span class="apiarg">seconds</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=SecondsToMinutes SecondsToMinutes](<span class="apiarg">seconds</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=MinutesToSeconds MinutesToSeconds](<span class="apiarg">minutes</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=MinutesToSeconds MinutesToSeconds](<span class="apiarg">minutes</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=HasTimePassed HasTimePassed](<span class="apiarg">testTime, amountOfTime</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=HasTimePassed HasTimePassed](<span class="apiarg">testTime, amountOfTime</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=SecondsToClock SecondsToClock](<span class="apiarg">seconds, displayZeroHours</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=SecondsToClock SecondsToClock](<span class="apiarg">seconds, displayZeroHours</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=SecondsToTime SecondsToTime](<span class="apiarg">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=SecondsToTime SecondsToTime](<span class="apiarg">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 class="apiarg">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=SecondsToTimeAbbrev SecondsToTimeAbbrev](<span class="apiarg">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 class="apiarg">day, month, year</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=FormatShortDate FormatShortDate](<span class="apiarg">day, month, year</span>)
   
=== UnitUtil ===
+
===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=GetPlayerGuid GetPlayerGuid]()
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=IsPlayerGuid IsPlayerGuid](<span class="apiarg">guid</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=IsPlayerGuid IsPlayerGuid](<span class="apiarg">guid</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=IsPlayerInitialSpec IsPlayerInitialSpec]()
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=IsPlayerInitialSpec IsPlayerInitialSpec]()
   
   
 
'''[https://github.com/Gethe/wow-ui-source/tree/live/Interface/FrameXML Interface/FrameXML]'''
 
'''[https://github.com/Gethe/wow-ui-source/tree/live/Interface/FrameXML Interface/FrameXML]'''
=== AchievementUtil ===
+
===AchievementUtil===
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=IsCriteriaAchievementEarned AchievementUtil.IsCriteriaAchievementEarned](<span class="apiarg">achievementID, criteriaIndex</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=IsCriteriaAchievementEarned AchievementUtil.IsCriteriaAchievementEarned](<span class="apiarg">achievementID, criteriaIndex</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=IsCriteriaReputationGained AchievementUtil.IsCriteriaReputationGained](<span class="apiarg">achievementID, criteriaIndex, checkCriteriaAchievement, countHiddenCriteria</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=IsCriteriaReputationGained AchievementUtil.IsCriteriaReputationGained](<span class="apiarg">achievementID, criteriaIndex, checkCriteriaAchievement, countHiddenCriteria</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=IsCategoryFeatOfStrength AchievementUtil.IsCategoryFeatOfStrength](<span class="apiarg">category</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=IsCategoryFeatOfStrength AchievementUtil.IsCategoryFeatOfStrength](<span class="apiarg">category</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=IsFeatOfStrength AchievementUtil.IsFeatOfStrength](<span class="apiarg">achievementID</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=IsFeatOfStrength AchievementUtil.IsFeatOfStrength](<span class="apiarg">achievementID</span>)
=== ActionButtonUtil ===
+
===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=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=HideAllActionButtonGrids ActionButtonUtil.HideAllActionButtonGrids]()
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=SetAllQuickKeybindButtonHighlights ActionButtonUtil.SetAllQuickKeybindButtonHighlights](<span class="apiarg">show</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=SetAllQuickKeybindButtonHighlights ActionButtonUtil.SetAllQuickKeybindButtonHighlights](<span class="apiarg">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=ShowAllQuickKeybindButtonHighlights ActionButtonUtil.ShowAllQuickKeybindButtonHighlights]()
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=HideAllQuickKeybindButtonHighlights ActionButtonUtil.HideAllQuickKeybindButtonHighlights]()
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=HideAllQuickKeybindButtonHighlights ActionButtonUtil.HideAllQuickKeybindButtonHighlights]()
=== AzeriteEssenceUtil ===
+
===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=HasAnyUnlockableMilestones AzeriteEssenceUtil.HasAnyUnlockableMilestones]()
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetMilestoneAtPowerLevel AzeriteEssenceUtil.GetMilestoneAtPowerLevel](<span class="apiarg">powerLevel</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=GetMilestoneAtPowerLevel AzeriteEssenceUtil.GetMilestoneAtPowerLevel](<span class="apiarg">powerLevel</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetMilestoneSpellInfo AzeriteEssenceUtil.GetMilestoneSpellInfo](<span class="apiarg">milestoneID</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=GetMilestoneSpellInfo AzeriteEssenceUtil.GetMilestoneSpellInfo](<span class="apiarg">milestoneID</span>)
=== AzeriteUtil ===
+
===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=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=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=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=GetEquippedItemsUnselectedPowersCount AzeriteUtil.GetEquippedItemsUnselectedPowersCount]()
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GenerateRequiredSpecTooltipLine AzeriteUtil.GenerateRequiredSpecTooltipLine](<span class="apiarg">powerID</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=GenerateRequiredSpecTooltipLine AzeriteUtil.GenerateRequiredSpecTooltipLine](<span class="apiarg">powerID</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=FindAzeritePowerTier AzeriteUtil.FindAzeritePowerTier](<span class="apiarg">azeriteEmpoweredItemSource, powerID</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=FindAzeritePowerTier AzeriteUtil.FindAzeritePowerTier](<span class="apiarg">azeriteEmpoweredItemSource, powerID</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetSelectedAzeritePowerInTier AzeriteUtil.GetSelectedAzeritePowerInTier](<span class="apiarg">azeriteEmpoweredItemSource, tierIndex</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=GetSelectedAzeritePowerInTier AzeriteUtil.GetSelectedAzeritePowerInTier](<span class="apiarg">azeriteEmpoweredItemSource, tierIndex</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=HasSelectedAnyAzeritePower AzeriteUtil.HasSelectedAnyAzeritePower](<span class="apiarg">azeriteEmpoweredItemSource</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=HasSelectedAnyAzeritePower AzeriteUtil.HasSelectedAnyAzeritePower](<span class="apiarg">azeriteEmpoweredItemSource</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=DoesBagContainAnyAzeriteEmpoweredItems AzeriteUtil.DoesBagContainAnyAzeriteEmpoweredItems](<span class="apiarg">bagID</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=DoesBagContainAnyAzeriteEmpoweredItems AzeriteUtil.DoesBagContainAnyAzeriteEmpoweredItems](<span class="apiarg">bagID</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=IsAzeriteItemLocationBankBag AzeriteUtil.IsAzeriteItemLocationBankBag](<span class="apiarg">azeriteItemLocation</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=IsAzeriteItemLocationBankBag AzeriteUtil.IsAzeriteItemLocationBankBag](<span class="apiarg">azeriteItemLocation</span>)
=== CalendarUtil ===
+
===CalendarUtil===
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetCalendarInviteStatusInfo CalendarUtil.GetCalendarInviteStatusInfo](<span class="apiarg">inviteStatus</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=GetCalendarInviteStatusInfo CalendarUtil.GetCalendarInviteStatusInfo](<span class="apiarg">inviteStatus</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetEventBroadcastText CalendarUtil.GetEventBroadcastText](<span class="apiarg">event</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=GetEventBroadcastText CalendarUtil.GetEventBroadcastText](<span class="apiarg">event</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetOngoingEventBroadcastText CalendarUtil.GetOngoingEventBroadcastText](<span class="apiarg">event</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=GetOngoingEventBroadcastText CalendarUtil.GetOngoingEventBroadcastText](<span class="apiarg">event</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=FormatCalendarTimeWeekday CalendarUtil.FormatCalendarTimeWeekday](<span class="apiarg">messageDate</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=FormatCalendarTimeWeekday CalendarUtil.FormatCalendarTimeWeekday](<span class="apiarg">messageDate</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=AreDatesEqual CalendarUtil.AreDatesEqual](<span class="apiarg">firstCalendarTime, secondCalendarTime</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=AreDatesEqual CalendarUtil.AreDatesEqual](<span class="apiarg">firstCalendarTime, secondCalendarTime</span>)
=== CampaignUtil ===
+
===CampaignUtil===
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=BuildChapterProgressText CampaignUtil.BuildChapterProgressText](<span class="apiarg">campaign, formatString</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=BuildChapterProgressText CampaignUtil.BuildChapterProgressText](<span class="apiarg">campaign, formatString</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetSingleChapterText CampaignUtil.GetSingleChapterText](<span class="apiarg">chapterID, lineSpacing</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=GetSingleChapterText CampaignUtil.GetSingleChapterText](<span class="apiarg">chapterID, lineSpacing</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=BuildAllChaptersText CampaignUtil.BuildAllChaptersText](<span class="apiarg">campaign, lineSpacing</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=BuildAllChaptersText CampaignUtil.BuildAllChaptersText](<span class="apiarg">campaign, lineSpacing</span>)
=== CommunitiesUtil ===
+
===CommunitiesUtil===
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetMemberRGB CommunitiesUtil.GetMemberRGB](<span class="apiarg">memberInfo</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=GetMemberRGB CommunitiesUtil.GetMemberRGB](<span class="apiarg">memberInfo</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=SortClubs CommunitiesUtil.SortClubs](<span class="apiarg">clubs</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=SortClubs CommunitiesUtil.SortClubs](<span class="apiarg">clubs</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=SortStreams CommunitiesUtil.SortStreams](<span class="apiarg">streams</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=SortStreams CommunitiesUtil.SortStreams](<span class="apiarg">streams</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=SortMemberInfo CommunitiesUtil.SortMemberInfo](<span class="apiarg">clubId, memberInfoArray</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=SortMemberInfo CommunitiesUtil.SortMemberInfo](<span class="apiarg">clubId, memberInfoArray</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetMemberIdsSortedByName CommunitiesUtil.GetMemberIdsSortedByName](<span class="apiarg">clubId, streamId</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=GetMemberIdsSortedByName CommunitiesUtil.GetMemberIdsSortedByName](<span class="apiarg">clubId, streamId</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetMemberInfo CommunitiesUtil.GetMemberInfo](<span class="apiarg">clubId, memberIds</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=GetMemberInfo CommunitiesUtil.GetMemberInfo](<span class="apiarg">clubId, memberIds</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetMemberInfoLookup CommunitiesUtil.GetMemberInfoLookup](<span class="apiarg">memberInfoArray</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=GetMemberInfoLookup CommunitiesUtil.GetMemberInfoLookup](<span class="apiarg">memberInfoArray</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetOnlineMembers CommunitiesUtil.GetOnlineMembers](<span class="apiarg">memberInfoArray</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=GetOnlineMembers CommunitiesUtil.GetOnlineMembers](<span class="apiarg">memberInfoArray</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=SortMembersByList CommunitiesUtil.SortMembersByList](<span class="apiarg">memberInfoLookup, memberIds</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=SortMembersByList CommunitiesUtil.SortMembersByList](<span class="apiarg">memberInfoLookup, memberIds</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetAndSortMemberInfo CommunitiesUtil.GetAndSortMemberInfo](<span class="apiarg">clubId, streamId, filterOffline</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=GetAndSortMemberInfo CommunitiesUtil.GetAndSortMemberInfo](<span class="apiarg">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=DoesAnyCommunityHaveUnreadMessages CommunitiesUtil.DoesAnyCommunityHaveUnreadMessages]()
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=DoesOtherCommunityHaveUnreadMessages CommunitiesUtil.DoesOtherCommunityHaveUnreadMessages](<span class="apiarg">ignoreClubId</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=DoesOtherCommunityHaveUnreadMessages CommunitiesUtil.DoesOtherCommunityHaveUnreadMessages](<span class="apiarg">ignoreClubId</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=DoesCommunityHaveUnreadMessages CommunitiesUtil.DoesCommunityHaveUnreadMessages](<span class="apiarg">clubId</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=DoesCommunityHaveUnreadMessages CommunitiesUtil.DoesCommunityHaveUnreadMessages](<span class="apiarg">clubId</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=DoesCommunityHaveOtherUnreadMessages CommunitiesUtil.DoesCommunityHaveOtherUnreadMessages](<span class="apiarg">clubId, ignoreStreamId</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=DoesCommunityHaveOtherUnreadMessages CommunitiesUtil.DoesCommunityHaveOtherUnreadMessages](<span class="apiarg">clubId, ignoreStreamId</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetStreamNotificationSettingsLookup CommunitiesUtil.GetStreamNotificationSettingsLookup](<span class="apiarg">clubId</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=GetStreamNotificationSettingsLookup CommunitiesUtil.GetStreamNotificationSettingsLookup](<span class="apiarg">clubId</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=DoesCommunityStreamHaveUnreadMessages CommunitiesUtil.DoesCommunityStreamHaveUnreadMessages](<span class="apiarg">clubId, streamId</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=DoesCommunityStreamHaveUnreadMessages CommunitiesUtil.DoesCommunityStreamHaveUnreadMessages](<span class="apiarg">clubId, streamId</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=CanKickClubMember CommunitiesUtil.CanKickClubMember](<span class="apiarg">clubPrivileges, memberInfo</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=CanKickClubMember CommunitiesUtil.CanKickClubMember](<span class="apiarg">clubPrivileges, memberInfo</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=ClearAllUnreadNotifications CommunitiesUtil.ClearAllUnreadNotifications](<span class="apiarg">clubId</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=ClearAllUnreadNotifications CommunitiesUtil.ClearAllUnreadNotifications](<span class="apiarg">clubId</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=OpenInviteDialog CommunitiesUtil.OpenInviteDialog](<span class="apiarg">clubId, streamId</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=OpenInviteDialog CommunitiesUtil.OpenInviteDialog](<span class="apiarg">clubId, streamId</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=FindCommunityAndStreamByName CommunitiesUtil.FindCommunityAndStreamByName](<span class="apiarg">communityName, streamName</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=FindCommunityAndStreamByName CommunitiesUtil.FindCommunityAndStreamByName](<span class="apiarg">communityName, streamName</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=FindGuildStreamByType CommunitiesUtil.FindGuildStreamByType](<span class="apiarg">clubStreamType</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=FindGuildStreamByType CommunitiesUtil.FindGuildStreamByType](<span class="apiarg">clubStreamType</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetRoleSpecClassLine CommunitiesUtil.GetRoleSpecClassLine](<span class="apiarg">classID, specID</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=GetRoleSpecClassLine CommunitiesUtil.GetRoleSpecClassLine](<span class="apiarg">classID, specID</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=AddLookingForLines CommunitiesUtil.AddLookingForLines](<span class="apiarg">tooltip, recruitingSpecIds, recruitingSpecIdMap, playerSpecs</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=AddLookingForLines CommunitiesUtil.AddLookingForLines](<span class="apiarg">tooltip, recruitingSpecIds, recruitingSpecIdMap, playerSpecs</span>)
=== CovenantUtil ===
+
===CovenantUtil===
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetRenownRewardDisplayData CovenantUtil.GetRenownRewardDisplayData](<span class="apiarg">rewardInfo, onItemUpdateCallback</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=GetRenownRewardDisplayData CovenantUtil.GetRenownRewardDisplayData](<span class="apiarg">rewardInfo, onItemUpdateCallback</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetUnformattedRenownRewardInfo CovenantUtil.GetUnformattedRenownRewardInfo](<span class="apiarg">rewardInfo, onItemUpdateCallback</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=GetUnformattedRenownRewardInfo CovenantUtil.GetUnformattedRenownRewardInfo](<span class="apiarg">rewardInfo, onItemUpdateCallback</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetRenownRewardInfo CovenantUtil.GetRenownRewardInfo](<span class="apiarg">rewardInfo, onItemUpdateCallback</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=GetRenownRewardInfo CovenantUtil.GetRenownRewardInfo](<span class="apiarg">rewardInfo, onItemUpdateCallback</span>)
=== CurrencyContainer ===
+
===CurrencyContainer===
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetCurrencyContainerInfo CurrencyContainerUtil.GetCurrencyContainerInfo](<span class="apiarg">currencyID, numItems, name, texture, quality</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=GetCurrencyContainerInfo CurrencyContainerUtil.GetCurrencyContainerInfo](<span class="apiarg">currencyID, numItems, name, texture, quality</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetCurrencyContainerInfoForAlert CurrencyContainerUtil.GetCurrencyContainerInfoForAlert](<span class="apiarg">currencyID, quantity, name, texture, quality</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=GetCurrencyContainerInfoForAlert CurrencyContainerUtil.GetCurrencyContainerInfoForAlert](<span class="apiarg">currencyID, quantity, name, texture, quality</span>)
=== DifficultyUtil ===
+
===DifficultyUtil===
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetDifficultyName DifficultyUtil.GetDifficultyName](<span class="apiarg">difficultyID</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=GetDifficultyName DifficultyUtil.GetDifficultyName](<span class="apiarg">difficultyID</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=IsPrimaryRaid DifficultyUtil.IsPrimaryRaid](<span class="apiarg">difficultyID</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=IsPrimaryRaid DifficultyUtil.IsPrimaryRaid](<span class="apiarg">difficultyID</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetNextPrimaryRaidDifficultyID DifficultyUtil.GetNextPrimaryRaidDifficultyID](<span class="apiarg">difficultyID</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=GetNextPrimaryRaidDifficultyID DifficultyUtil.GetNextPrimaryRaidDifficultyID](<span class="apiarg">difficultyID</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetMaxPlayers DifficultyUtil.GetMaxPlayers](<span class="apiarg">difficultyID</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=GetMaxPlayers DifficultyUtil.GetMaxPlayers](<span class="apiarg">difficultyID</span>)
=== ItemRef ===
+
===ItemRef===
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=SetItemRef SetItemRef](<span class="apiarg">link, text, button, chatFrame</span>) - Handles item link tooltips in chat.
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=SetItemRef SetItemRef](<span class="apiarg">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 class="apiarg">text, quality</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=GetFixedLink GetFixedLink](<span class="apiarg">text, quality</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetBattlePetAbilityHyperlink GetBattlePetAbilityHyperlink](<span class="apiarg">abilityID, maxHealth, power, speed</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=GetBattlePetAbilityHyperlink GetBattlePetAbilityHyperlink](<span class="apiarg">abilityID, maxHealth, power, speed</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetPlayerLink GetPlayerLink](<span class="apiarg">characterName, linkDisplayText, lineID, chatType, chatTarget</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=GetPlayerLink GetPlayerLink](<span class="apiarg">characterName, linkDisplayText, lineID, chatType, chatTarget</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetBNPlayerLink GetBNPlayerLink](<span class="apiarg">name, linkDisplayText, bnetIDAccount, lineID, chatType, chatTarget</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=GetBNPlayerLink GetBNPlayerLink](<span class="apiarg">name, linkDisplayText, bnetIDAccount, lineID, chatType, chatTarget</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetGMLink GetGMLink](<span class="apiarg">gmName, linkDisplayText, lineID</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=GetGMLink GetGMLink](<span class="apiarg">gmName, linkDisplayText, lineID</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetBNPlayerCommunityLink GetBNPlayerCommunityLink](<span class="apiarg">playerName, linkDisplayText, bnetIDAccount, clubId, streamId, epoch, position</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=GetBNPlayerCommunityLink GetBNPlayerCommunityLink](<span class="apiarg">playerName, linkDisplayText, bnetIDAccount, clubId, streamId, epoch, position</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetPlayerCommunityLink GetPlayerCommunityLink](<span class="apiarg">playerName, linkDisplayText, clubId, streamId, epoch, position</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=GetPlayerCommunityLink GetPlayerCommunityLink](<span class="apiarg">playerName, linkDisplayText, clubId, streamId, epoch, position</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetClubTicketLink GetClubTicketLink](<span class="apiarg">ticketId, clubName, clubType</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=GetClubTicketLink GetClubTicketLink](<span class="apiarg">ticketId, clubName, clubType</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetClubFinderLink GetClubFinderLink](<span class="apiarg">clubFinderId, clubName</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=GetClubFinderLink GetClubFinderLink](<span class="apiarg">clubFinderId, clubName</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetCalendarEventLink GetCalendarEventLink](<span class="apiarg">monthOffset, monthDay, index</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=GetCalendarEventLink GetCalendarEventLink](<span class="apiarg">monthOffset, monthDay, index</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetCommunityLink GetCommunityLink](<span class="apiarg">clubId</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=GetCommunityLink GetCommunityLink](<span class="apiarg">clubId</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=SplitLink LinkUtil.SplitLink](<span class="apiarg">link</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=SplitLink LinkUtil.SplitLink](<span class="apiarg">link</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=ExtractLink LinkUtil.ExtractLink](<span class="apiarg">text</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=ExtractLink LinkUtil.ExtractLink](<span class="apiarg">text</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=IsLinkType LinkUtil.IsLinkType](<span class="apiarg">link, matchLinkType</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=IsLinkType LinkUtil.IsLinkType](<span class="apiarg">link, matchLinkType</span>)
=== ItemUtil ===
+
===ItemUtil===
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=RegisterCallback ItemButtonUtil.RegisterCallback](<span class="apiarg">...</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=RegisterCallback ItemButtonUtil.RegisterCallback](<span class="apiarg">...</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=UnregisterCallback ItemButtonUtil.UnregisterCallback](<span class="apiarg">...</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=UnregisterCallback ItemButtonUtil.UnregisterCallback](<span class="apiarg">...</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=TriggerEvent ItemButtonUtil.TriggerEvent](<span class="apiarg">...</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=TriggerEvent ItemButtonUtil.TriggerEvent](<span class="apiarg">...</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=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=HasItemContext ItemButtonUtil.HasItemContext]()
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetItemContextMatchResultForItem ItemButtonUtil.GetItemContextMatchResultForItem](<span class="apiarg">itemLocation</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=GetItemContextMatchResultForItem ItemButtonUtil.GetItemContextMatchResultForItem](<span class="apiarg">itemLocation</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetItemContextMatchResultForContainer ItemButtonUtil.GetItemContextMatchResultForContainer](<span class="apiarg">bagID</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=GetItemContextMatchResultForContainer ItemButtonUtil.GetItemContextMatchResultForContainer](<span class="apiarg">bagID</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetItemDetails ItemUtil.GetItemDetails](<span class="apiarg">itemLink, quantity, isCurrency, lootSource</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=GetItemDetails ItemUtil.GetItemDetails](<span class="apiarg">itemLink, quantity, isCurrency, lootSource</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=PickupBagItem ItemUtil.PickupBagItem](<span class="apiarg">itemLocation</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=PickupBagItem ItemUtil.PickupBagItem](<span class="apiarg">itemLocation</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetOptionalReagentCount ItemUtil.GetOptionalReagentCount](<span class="apiarg">itemID</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=GetOptionalReagentCount ItemUtil.GetOptionalReagentCount](<span class="apiarg">itemID</span>)
=== MapUtil ===
+
===MapUtil===
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=IsMapTypeZone MapUtil.IsMapTypeZone](<span class="apiarg">mapID</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=IsMapTypeZone MapUtil.IsMapTypeZone](<span class="apiarg">mapID</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetMapParentInfo MapUtil.GetMapParentInfo](<span class="apiarg">mapID, mapType, topMost</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=GetMapParentInfo MapUtil.GetMapParentInfo](<span class="apiarg">mapID, mapType, topMost</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=ShouldMapTypeShowQuests MapUtil.ShouldMapTypeShowQuests](<span class="apiarg">mapType</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=ShouldMapTypeShowQuests MapUtil.ShouldMapTypeShowQuests](<span class="apiarg">mapType</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=ShouldShowTask MapUtil.ShouldShowTask](<span class="apiarg">mapID, info</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=ShouldShowTask MapUtil.ShouldShowTask](<span class="apiarg">mapID, info</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=MapHasUnlockedBounties MapUtil.MapHasUnlockedBounties](<span class="apiarg">mapID</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=MapHasUnlockedBounties MapUtil.MapHasUnlockedBounties](<span class="apiarg">mapID</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=MapHasEmissaries MapUtil.MapHasEmissaries](<span class="apiarg">mapID</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=MapHasEmissaries MapUtil.MapHasEmissaries](<span class="apiarg">mapID</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=FindBestAreaNameAtMouse MapUtil.FindBestAreaNameAtMouse](<span class="apiarg">mapID, normalizedCursorX, normalizedCursorY</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=FindBestAreaNameAtMouse MapUtil.FindBestAreaNameAtMouse](<span class="apiarg">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=GetDisplayableMapForPlayer MapUtil.GetDisplayableMapForPlayer]()
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetBountySetMaps MapUtil.GetBountySetMaps](<span class="apiarg">bountySetID</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=GetBountySetMaps MapUtil.GetBountySetMaps](<span class="apiarg">bountySetID</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetMapCenterOnMap MapUtil.GetMapCenterOnMap](<span class="apiarg">mapID, topMapID</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=GetMapCenterOnMap MapUtil.GetMapCenterOnMap](<span class="apiarg">mapID, topMapID</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=IsChildMap MapUtil.IsChildMap](<span class="apiarg">mapID, ancestorMapID</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=IsChildMap MapUtil.IsChildMap](<span class="apiarg">mapID, ancestorMapID</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=IsOribosMap MapUtil.IsOribosMap](<span class="apiarg">mapID</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=IsOribosMap MapUtil.IsOribosMap](<span class="apiarg">mapID</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=IsShadowlandsZoneMap MapUtil.IsShadowlandsZoneMap](<span class="apiarg">mapID</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=IsShadowlandsZoneMap MapUtil.IsShadowlandsZoneMap](<span class="apiarg">mapID</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=MapShouldShowWorldQuestFilters MapUtil.MapShouldShowWorldQuestFilters](<span class="apiarg">mapID</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=MapShouldShowWorldQuestFilters MapUtil.MapShouldShowWorldQuestFilters](<span class="apiarg">mapID</span>)
=== PVPUtil ===
+
===PVPUtil===
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetTierName PVPUtil.GetTierName](<span class="apiarg">tierEnum</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=GetTierName PVPUtil.GetTierName](<span class="apiarg">tierEnum</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=ShouldShowLegacyRewards PVPUtil.ShouldShowLegacyRewards]()
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=ShouldShowLegacyRewards PVPUtil.ShouldShowLegacyRewards]()
=== PartyUtil ===
+
===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=GetMinLevel PartyUtil.GetMinLevel]()
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetPhasedReasonString PartyUtil.GetPhasedReasonString](<span class="apiarg">phaseReason, unitToken</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=GetPhasedReasonString PartyUtil.GetPhasedReasonString](<span class="apiarg">phaseReason, unitToken</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetGroupMemberCountsForDisplay GetGroupMemberCountsForDisplay]()
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=GetGroupMemberCountsForDisplay GetGroupMemberCountsForDisplay]()
=== QuestUtils ===
+
===QuestUtils===
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetWorldQuestAtlasInfo QuestUtil.GetWorldQuestAtlasInfo](<span class="apiarg">worldQuestType, inProgress, tradeskillLineID</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=GetWorldQuestAtlasInfo QuestUtil.GetWorldQuestAtlasInfo](<span class="apiarg">worldQuestType, inProgress, tradeskillLineID</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetQuestIconOffer QuestUtil.GetQuestIconOffer](<span class="apiarg">isLegendary, frequency, isRepeatable, isCampaign, isCovenantCalling</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=GetQuestIconOffer QuestUtil.GetQuestIconOffer](<span class="apiarg">isLegendary, frequency, isRepeatable, isCampaign, isCovenantCalling</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=ApplyQuestIconOfferToTexture QuestUtil.ApplyQuestIconOfferToTexture](<span class="apiarg">texture, ...</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=ApplyQuestIconOfferToTexture QuestUtil.ApplyQuestIconOfferToTexture](<span class="apiarg">texture, ...</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetQuestIconActive QuestUtil.GetQuestIconActive](<span class="apiarg">isComplete, isLegendary, frequency, isRepeatable, isCampaign, isCovenantCalling</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=GetQuestIconActive QuestUtil.GetQuestIconActive](<span class="apiarg">isComplete, isLegendary, frequency, isRepeatable, isCampaign, isCovenantCalling</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=ApplyQuestIconActiveToTexture QuestUtil.ApplyQuestIconActiveToTexture](<span class="apiarg">texture, ...</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=ApplyQuestIconActiveToTexture QuestUtil.ApplyQuestIconActiveToTexture](<span class="apiarg">texture, ...</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=ShouldQuestIconsUseCampaignAppearance QuestUtil.ShouldQuestIconsUseCampaignAppearance](<span class="apiarg">questID</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=ShouldQuestIconsUseCampaignAppearance QuestUtil.ShouldQuestIconsUseCampaignAppearance](<span class="apiarg">questID</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetQuestIconOfferForQuestID QuestUtil.GetQuestIconOfferForQuestID](<span class="apiarg">questID</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=GetQuestIconOfferForQuestID QuestUtil.GetQuestIconOfferForQuestID](<span class="apiarg">questID</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=ApplyQuestIconOfferToTextureForQuestID QuestUtil.ApplyQuestIconOfferToTextureForQuestID](<span class="apiarg">texture, ...</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=ApplyQuestIconOfferToTextureForQuestID QuestUtil.ApplyQuestIconOfferToTextureForQuestID](<span class="apiarg">texture, ...</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetQuestIconActiveForQuestID QuestUtil.GetQuestIconActiveForQuestID](<span class="apiarg">questID</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=GetQuestIconActiveForQuestID QuestUtil.GetQuestIconActiveForQuestID](<span class="apiarg">questID</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=ApplyQuestIconActiveToTextureForQuestID QuestUtil.ApplyQuestIconActiveToTextureForQuestID](<span class="apiarg">texture, ...</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=ApplyQuestIconActiveToTextureForQuestID QuestUtil.ApplyQuestIconActiveToTextureForQuestID](<span class="apiarg">texture, ...</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=SetupWorldQuestButton QuestUtil.SetupWorldQuestButton](<span class="apiarg">button, info, inProgress, selected, isCriteria, isSpellTarget, isEffectivelyTracked</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=SetupWorldQuestButton QuestUtil.SetupWorldQuestButton](<span class="apiarg">button, info, inProgress, selected, isCriteria, isSpellTarget, isEffectivelyTracked</span>)
=== RuneforgeUtil ===
+
===RuneforgeUtil===
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetCostsString RuneforgeUtil.GetCostsString](<span class="apiarg">costs</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=GetCostsString RuneforgeUtil.GetCostsString](<span class="apiarg">costs</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=IsUpgradeableRuneforgeLegendary RuneforgeUtil.IsUpgradeableRuneforgeLegendary](<span class="apiarg">itemLocation</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=IsUpgradeableRuneforgeLegendary RuneforgeUtil.IsUpgradeableRuneforgeLegendary](<span class="apiarg">itemLocation</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetRuneforgeFilterText RuneforgeUtil.GetRuneforgeFilterText](<span class="apiarg">filter</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=GetRuneforgeFilterText RuneforgeUtil.GetRuneforgeFilterText](<span class="apiarg">filter</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetPreviewClassAndSpec RuneforgeUtil.GetPreviewClassAndSpec]()
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=GetPreviewClassAndSpec RuneforgeUtil.GetPreviewClassAndSpec]()
=== TitleUtil ===
+
===TitleUtil===
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetNameFromTitleMaskID TitleUtil.GetNameFromTitleMaskID](<span class="apiarg">titleMaskID</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=GetNameFromTitleMaskID TitleUtil.GetNameFromTitleMaskID](<span class="apiarg">titleMaskID</span>)
=== TransmogUtil ===
+
===TransmogUtil===
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetInfoForEquippedSlot TransmogUtil.GetInfoForEquippedSlot](<span class="apiarg">transmogLocation</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=GetInfoForEquippedSlot TransmogUtil.GetInfoForEquippedSlot](<span class="apiarg">transmogLocation</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=CanEnchantSource TransmogUtil.CanEnchantSource](<span class="apiarg">sourceID</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=CanEnchantSource TransmogUtil.CanEnchantSource](<span class="apiarg">sourceID</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetWeaponInfoForEnchant TransmogUtil.GetWeaponInfoForEnchant](<span class="apiarg">transmogLocation</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=GetWeaponInfoForEnchant TransmogUtil.GetWeaponInfoForEnchant](<span class="apiarg">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=GetBestWeaponInfoForIllusionDressup TransmogUtil.GetBestWeaponInfoForIllusionDressup]()
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetSlotID TransmogUtil.GetSlotID](<span class="apiarg">slotName</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=GetSlotID TransmogUtil.GetSlotID](<span class="apiarg">slotName</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetSlotName TransmogUtil.GetSlotName](<span class="apiarg">slotID</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=GetSlotName TransmogUtil.GetSlotName](<span class="apiarg">slotID</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=CreateTransmogLocation TransmogUtil.CreateTransmogLocation](<span class="apiarg">slotDescriptor, transmogType, modification</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=CreateTransmogLocation TransmogUtil.CreateTransmogLocation](<span class="apiarg">slotDescriptor, transmogType, modification</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetTransmogLocation TransmogUtil.GetTransmogLocation](<span class="apiarg">slotDescriptor, transmogType, modification</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=GetTransmogLocation TransmogUtil.GetTransmogLocation](<span class="apiarg">slotDescriptor, transmogType, modification</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetTransmogLocationLookupKey TransmogUtil.GetTransmogLocationLookupKey](<span class="apiarg">slotID, transmogType, modification</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=GetTransmogLocationLookupKey TransmogUtil.GetTransmogLocationLookupKey](<span class="apiarg">slotID, transmogType, modification</span>)
: <small>UI</small> [https://github.com/Gethe/wow-ui-source/search?q=GetSetIcon TransmogUtil.GetSetIcon](<span class="apiarg">setID</span>)
+
: <small>''UI''</small> [https://github.com/Gethe/wow-ui-source/search?q=GetSetIcon TransmogUtil.GetSetIcon](<span class="apiarg">setID</span>)
   
== See also ==
+
==See also==
 
* [[Widget API]] documents methods that can be called on widgets objects
 
* [[Widget API]] documents methods that can be called on widgets objects
 
* [[Lua functions]] describe the language and library functions available in the WoW client.
 
* [[Lua functions]] describe the language and library functions available in the WoW client.
Line 5,963: Line 5,997:
 
* [[World of Warcraft Non-Public API]] for functions not used in FrameXML.
 
* [[World of Warcraft Non-Public API]] for functions not used in FrameXML.
   
== External links ==
+
==External links==
 
* {{elink|type=wowus|site=US official UI and Macro forum|link=https://us.forums.blizzard.com/en/wow/c/guides/ui-macro}}
 
* {{elink|type=wowus|site=US official UI and Macro forum|link=https://us.forums.blizzard.com/en/wow/c/guides/ui-macro}}
 
* {{elink|type=woweu|site=EU official Interface and Macros forum|link=https://eu.forums.blizzard.com/en/wow/c/guides/interface-and-macros}}
 
* {{elink|type=woweu|site=EU official Interface and Macros forum|link=https://eu.forums.blizzard.com/en/wow/c/guides/interface-and-macros}}

Revision as of 13:04, 23 June 2022

Battlenet icon flat For the Web API see https://develop.battle.net/documentation/world-of-warcraft

The WoW API is available to AddOns and macro scripts. More recent functions are officially documented in Blizzard_APIDocumentation and accessible with the /api command.
The Lua user interface code can be exported from the game client. For guidelines on contributing see How to edit API pages.

Functions are prefixed with the following tags:
  • PROTECTED - This can only be called by Blizzard code or from secure templates.
  • HW - This may only be called in response to a hardware event, i.e. user input.
  • NOCOMBAT - This cannot be called from insecure code while in combat.
  • NOINSTANCE - This only works outdoors and not in instanced content (dungeons/raids/battlegrounds/arena).
  • NOSCRIPT - This may not be called directly from (macro) scripts, i.e. /script, loadstring() and WeakAuras.
  • DEPRECATED - This is no longer used. Any backwards compat code will be removed in the next expansion.
  • UI - This is implemented in FrameXML but was considered important enough to be listed.

Sections: #Classic, #FrameXML, Global functions

API Reference

Note
Note: This list is up to date as of Patch 9.2.5 (43971) May 31 2022

Account

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

GetBillingTimeRested() - Returns the amount of "healthy" time left for players 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() - True if the account is considered "unhealthy" for players on Chinese realms.
PartialPlayTime() - True if the account is considered "tired" for players on Chinese realms.
SendSubscriptionInterstitialResponse(response)

Achievements

Achievements were added in Patch 3.0.2

C_AchievementInfo.GetRewardItemID(achievementID) : rewardItemID
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) - Tracks an achievement.
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 info for the specified achievement criteria.
GetAchievementCriteriaInfoByID(achievementID, criteriaIndex) - Returns achievement criteria info by criteriaIndex.
GetAchievementGuildRep()
GetAchievementInfo(achievementID or categoryID, index) - Returns info for an achievement.
GetAchievementLink(achievementID) - Returns an achievement link.
GetAchievementNumCriteria(achievementID) - Returns the number of criteria for an achievement.
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 info for an achievement category.
GetCategoryList() - Returns the list of achievement categories.
GetCategoryNumAchievements(category [, includeAll) - Returns the number of achievements for a 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 by index.
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 and completed number of achievements.
GetNumFilteredAchievements() - Returns the number of achievements after filtering.
GetNumTrackedAchievements() - Returns the number of tracked achievements.
GetPreviousAchievement(achievementID) - Returns the previous achievement in a chain.
GetTotalAchievementPoints() - Returns the total number of achievement points earned.
GetTrackedAchievements() - Returns the currently tracked achievements.
HasCompletedAnyAchievement(achievementID)
IsAchievementEligible(achievementID)
IsTrackedAchievement(achievementID)
RemoveTrackedAchievement(achievementID) - Untracks an achievement from the WatchFrame.
SetAchievementComparisonUnit(unitId) - Sets 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 specified statistic from the comparison player unit.
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 a character statistic.
GetStatisticsCategoryList() - Returns the list of statistic categories.

AddOns

Relates to AddOns.

DisableAddOn(indexOrName [, characterOrAll]) - Disables an addon for subsequent sessions.
DisableAllAddOns([character]) - Disable all AddOns for subsequent sessions.
EnableAddOn(indexOrName [, characterOrAll]) - Enables an addon for subsequent sessions.
EnableAllAddOns([character]) - Enable all AddOns for subsequent sessions.
GetAddOnDependencies(addonIndex or AddOnName) - Returns the TOC dependencies of an addon.
GetAddOnEnableState([character], addonIndex or AddOnName)
GetAddOnInfo(addonIndex or AddOnName) - Get information about an AddOn.
GetAddOnMetadata(addonIndex or AddOnName, variable) - Returns the TOC metadata of an addon.
GetAddOnOptionalDependencies(addonIndex or AddOnName) - Returns a list of optional dependencies.
GetNumAddOns() - Get the number of user supplied AddOns.
IsAddOnLoaded(addonIndex or AddOnName) - True if the specified addon is loaded.
IsAddOnLoadOnDemand(addonIndex or AddOnName) - True if the specified addon is load-on-demand.
IsAddonVersionCheckEnabled()
LoadAddOn(addonIndex or AddOnName) - Loads the specified LoadOnDemand 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([journalInstanceID]) : 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 [, journalInstanceID]) - 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([journalInstanceID]) - 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(journalInstanceID) - 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_LootJournal.GetItemSetItems(setID) : items
C_LootJournal.GetItemSets([classID, specID]) : itemSets
C_EncounterJournal.GetLootInfo(id) : itemInfo - Returns info for loot items available from an encounter.
C_EncounterJournal.GetLootInfoByIndex(index [, encounterIndex]) : itemInfo - Returns loot info for an encounter or instance.
C_EncounterJournal.GetSlotFilter() : filter - Returns the current item slot filter for loot items.
C_EncounterJournal.ResetSlotFilter() - Resets the item slot filter for loot items.
C_EncounterJournal.SetSlotFilter(filterSlot) - Sets the item slot filter for loot items.
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 - Returns display info for a battle pet from a ReplicateItems result.
C_AuctionHouse.GetReplicateItemInfo(index) : name, texture, count, qualityID, usable, level, levelType, minBid, ... - Returns information about the specified auction.
C_AuctionHouse.GetReplicateItemLink(index) : itemLink - Returns the item link (if loaded) for an item from a ReplicateItems result.
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 - Returns required deposit for posting a commodity and quantity.
C_AuctionHouse.CalculateItemDeposit(item, duration, quantity) : depositCost - Returns required deposit for posting a specific item and quantity.
C_AuctionHouse.CanCancelAuction(ownedAuctionID) : canCancelAuction - Returns if the auction can be cancelled. If it can't, load it with QueryOwnedAuctions.
HW, NOSCRIPT C_AuctionHouse.CancelAuction(ownedAuctionID) - Cancels an auction.
C_AuctionHouse.CancelCommoditiesPurchase() - Abort an incomplete commodity purchase to avoid it conflicting with another purchase.
C_AuctionHouse.CancelSell() - Stop posting auctions for an non-commodity item.
C_AuctionHouse.CloseAuctionHouse() - Close the auction house window.
C_AuctionHouse.ConfirmCommoditiesPurchase(itemID, quantity) - Completes a commodity item purchase.
C_AuctionHouse.FavoritesAreAvailable() : favoritesAreAvailable
C_AuctionHouse.GetAuctionInfoByID(auctionID) : priceInfo
C_AuctionHouse.GetAuctionItemSubClasses(classID) : subClasses
C_AuctionHouse.GetAvailablePostCount(item) : listCount - Returns the available quantity of an item for posting.
C_AuctionHouse.GetBidInfo(bidIndex) : bid
C_AuctionHouse.GetBids() : bids
C_AuctionHouse.GetBidType(bidTypeIndex) : typeItemKey
C_AuctionHouse.GetBrowseResults() : browseResults - Returns the currently loaded summary results resulting from SendBrowseQuery.
C_AuctionHouse.GetCancelCost(ownedAuctionID) : cancelCost - Returns the cost for cancelling a specific owned auction. This is non-zero if it has a bid.
C_AuctionHouse.GetCommoditySearchResultInfo(itemID, commoditySearchResultIndex) : result - Returns search results for a commodity item.
C_AuctionHouse.GetCommoditySearchResultsQuantity(itemID) : totalQuantity - Returns how many of the commodity is on sale.
C_AuctionHouse.GetExtraBrowseInfo(itemKey) : extraInfo - Returns the level (from 1-120, BfA levels) that some items would be crafted at.
C_AuctionHouse.GetFilterGroups() : filterGroups - Returns groups of filters for use in the Filter dropdown in the Buy tab.
C_AuctionHouse.GetItemCommodityStatus(item) : isCommodity - Returns if the item is a commodity, item or neither.
C_AuctionHouse.GetItemKeyFromItem(item) : itemKey - Returns an auction house item key from an item location.
C_AuctionHouse.GetItemKeyInfo(itemKey [, restrictQualityToFilter]) : itemKeyInfo - Returns more details about an item from its item key, including its name.
C_AuctionHouse.GetItemKeyRequiredLevel(itemKey) : requiredLevel - Returns the required level to use an item found on the auction house.
C_AuctionHouse.GetItemSearchResultInfo(itemKey, itemSearchResultIndex) : result - Returns search results for an item.
C_AuctionHouse.GetItemSearchResultsQuantity(itemKey) : totalQuantity - Returns how many of the item is available on the auction house.
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 - Returns the number of commodity results, the different prices.
C_AuctionHouse.GetNumItemSearchResults(itemKey) : numItemSearchResults - Returns the number of item results, the different auctions.
C_AuctionHouse.GetNumOwnedAuctions() : numOwnedAuctions - Returns the number of auctions the player has active on the auction house.
C_AuctionHouse.GetNumOwnedAuctionTypes() : numOwnedAuctionTypes
C_AuctionHouse.GetOwnedAuctionInfo(ownedAuctionIndex) : ownedAuction - Returns information for one of the player's active auctions.
C_AuctionHouse.GetOwnedAuctions() : ownedAuctions
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 - Returns if the last group of summary results (groups of 500) is available.
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 - Returns if an item from your bag can be posted on the auction house.
C_AuctionHouse.IsThrottledMessageSystemReady() : canSendThrottledMessage - Returns if the next query will be throttled, either delayed or cancelled.
C_AuctionHouse.MakeItemKey(itemID [, itemLevel, itemSuffix, battlePetSpeciesID]) : itemKey - Returns an auction house item key.
HW, NOSCRIPT C_AuctionHouse.PlaceBid(auctionID, bidAmount) - Places a bid on a non-commodity item.
HW, NOSCRIPT C_AuctionHouse.PostCommodity(item, duration, quantity, unitPrice) - Posts a commodity item on the auction house.
HW, NOSCRIPT C_AuctionHouse.PostItem(item, duration, quantity [, bid, buyout]) - Posts an item on the auction house.
C_AuctionHouse.QueryBids(sorts, auctionIDs)
NOSCRIPT C_AuctionHouse.QueryOwnedAuctions(sorts) - Queries the auction house for the player's active auctions.
C_AuctionHouse.RefreshCommoditySearchResults(itemID)
C_AuctionHouse.RefreshItemSearchResults(itemKey [, minLevelFilter, maxLevelFilter])
C_AuctionHouse.RequestFavorites()
NOSCRIPT C_AuctionHouse.RequestMoreBrowseResults()
C_AuctionHouse.RequestMoreCommoditySearchResults(itemID) : hasFullResults
C_AuctionHouse.RequestMoreItemSearchResults(itemKey) : hasFullResults
C_AuctionHouse.RequestOwnedAuctionBidderInfo(auctionID) : bidderName
NOSCRIPT C_AuctionHouse.SearchForFavorites(sorts) - Searches for favorited items.
C_AuctionHouse.SearchForItemKeys(itemKeys, sorts) - Queries the auction house for summary results of up to 100 specific items.
NOSCRIPT C_AuctionHouse.SendBrowseQuery(query)
NOSCRIPT C_AuctionHouse.SendSearchQuery(itemKey, sorts, separateOwnerItems [, minLevelFilter, maxLevelFilter]) - 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, NOSCRIPT 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() - Closes the Black Market window.
C_BlackMarket.GetHotItem() - Returns information about the current "hot item" at the Black Market Auction House.
C_BlackMarket.GetItemInfoByID(marketID) - Returns info for a 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()
C_WowTokenPublic.GetGuaranteedPrice()
C_WowTokenPublic.GetListedAuctionableTokenInfo(index)
C_WowTokenPublic.GetNumListedAuctionableTokens()
C_WowTokenPublic.IsAuctionableWowToken(itemID)
C_WowTokenPublic.IsConsumableWowToken()
C_WowTokenPublic.UpdateListedAuctionableTokens()
C_WowTokenPublic.UpdateMarketPrice()
C_WowTokenPublic.UpdateTokenCount()
C_WowTokenUI.StartTokenSell(tokenGUID)

Bags

GetBackpackAutosortDisabled()
GetBagName(bagID) - Returns the item name of the specified player bag.
GetBagSlotFlag(index, flagIndex)
GetInsertItemsLeftToRight()
GetSortBagsRightToLeft()
IsBagSlotFlagEnabledOnOtherBags(index, flagIndex)
IsInventoryItemProfessionBag(unit, slot)
PutItemInBackpack() - Places the item on the cursor into the player's backpack.
PutItemInBag(inventoryId) - Places the item on the cursor into the specified bag slot.
SetBackpackAutosortDisabled(disable)
SetBagPortraitTexture(texture, slot)
SetBagSlotFlag(index, flagIndex, checked)
SetBarSlotFromIntro(slot)
SetInsertItemsLeftToRight(disable)
SetItemSearch(search)
SetSortBagsRightToLeft(disable)
SortBags()
UI CloseAllBags(callingFrame, forceUpdate)
UI CloseBackpack()
UI CloseBag(bagID)
UI IsBagOpen(bagID)
UI OpenAllBags(callingFrame, forceUpdate)
UI OpenBackpack()
UI OpenBag(bagID, force)
UI ToggleAllBags()
UI ToggleBackpack() - Toggles your backpack open/closed.
UI ToggleBag(bagID) - Opens or closes the specified bag.

Containers

GetContainerFreeSlots(index [, returnTable])
GetContainerItemCooldown(bagID, slot)
GetContainerItemDurability(bag, slot) - Returns the durability of an item in a container slot.
GetContainerItemEquipmentSetInfo(index, slot)
GetContainerItemID(bag, slot) - Returns the item ID in a container slot.
GetContainerItemInfo(bagID, slot) - Returns info for an item in a container slot.
GetContainerItemLink(bagID, slot) - Returns a link of the object located in the specified slot of a specified bag.
GetContainerItemPurchaseCurrency(bag, slot, itemIndex [, isEquipped])
GetContainerItemPurchaseInfo(index, slot [, isEquipped])
GetContainerItemPurchaseItem(bag, slot, itemIndex [, isEquipped])
GetContainerItemQuestInfo(bag, slot) - Returns info for a quest item in a container slot.
GetContainerNumFreeSlots(bagID) - Returns the number of free slots in a bag.
GetContainerNumSlots(bagID) - Returns the total number of slots in the bag specified by the index.
IsContainerFiltered(index)
IsContainerItemAnUpgrade(index, slot)
SplitContainerItem(bagID, slot, amount) - Places part of a stack of items from a container onto the cursor.
UseContainerItem(bagID, slot [, target]) - Uses an item from a container depending on the situation.

Inventory

These functions manage your inventory, specifically equipped items.

CancelPendingEquip(index) - Cancels a pending equip confirmation.
PROTECTED ConfirmBindOnUse()
PROTECTED ConfirmNoRefundOnUse()
ContainerIDToInventoryID(bagID)
EquipPendingItem(invSlot) - Equips the currently pending Bind-on-Equip or Bind-on-Pickup item from the specified inventory slot.
GetAverageItemLevel() - Returns the character's average item level.
GetInventoryAlertStatus(index) - Returns the durability status of an equipped item.
GetInventoryItemBroken(unit, invSlot) - True if an inventory item has zero durability.
GetInventoryItemCooldown(unit, invSlot) - Get cooldown information for an inventory item.
GetInventoryItemCount(unit, invSlot) - Determine the quantity of an item in an inventory slot.
GetInventoryItemDurability(invSlot) - Returns the durability of an equipped item.
GetInventoryItemID(unit, invSlot) - Returns the item ID for an equipped item.
GetInventoryItemLink(unit, invSlot) - Returns the item link for an equipped item.
GetInventoryItemQuality(unit, invSlot) - Returns the quality of an equipped item.
GetInventoryItemTexture(unit, invSlot) - Returns the texture for an equipped item.
GetInventorySlotInfo(invSlotName) - Returns info for an equipment slot.
HasWandEquipped() - True if a wand is equipped.
IsInventoryItemLocked(id) - Returns whether an inventory item is locked, usually as it awaits pending action.
SetInventoryPortraitTexture(texture, unit, slot)
UpdateInventoryAlertStatus()
PROTECTED UseInventoryItem(invSlot) - Use an item in a specific inventory slot.

Bank

Relates to the Bank.

BankButtonIDToInvSlotID(buttonID, isBag) - Maps a BankButtonID to InventorySlotID.
BuyReagentBank()
CloseBankFrame() - Closes the bank window.
DepositReagentBank()
GetBankAutosortDisabled()
GetBankBagSlotFlag()
GetBankSlotCost(numSlots) - Returns the cost of the next bank bag slot.
GetNumBankSlots() - Returns the number of purchased bank bag slots.
GetReagentBankCost()
IsBagSlotFlagEnabledOnOtherBankBags()
IsReagentBankUnlocked()
PurchaseSlot() - Buys another bank slot if available.
ReagentBankButtonIDToInvSlotID()
SetBankAutosortDisabled()
SetBankBagSlotFlag()
SortBankBags()
SortReagentBankBags()

Guild Bank

The Guild bank was added in Patch 2.3.0

AutoStoreGuildBankItem(tab, slot) - Withdraws an item from the Guild Bank to the character's inventory.
BuyGuildBankTab() - Buys a guild bank tab, without confirmation.
CanEditGuildBankTabInfo()
CanGuildBankRepair()
CanWithdrawGuildBankMoney() - Boolean, true if player is permitted to withdraw funds. No bank proximity required.
CloseGuildBankFrame() - Closes the guild bank frame.
DepositGuildBankMoney(money) - Deposits "money" amount in copper.
GetCurrentGuildBankTab() - Integer of selected tab, >= 1.
GetGuildBankBonusDepositMoney()
GetGuildBankItemInfo(tab, slot) - Returns item info for a guild bank slot.
GetGuildBankItemLink(tab, slot) - Returns the item link for a guild bank slot.
GetGuildBankMoney() - Returns the amount of money in the guild bank.
GetGuildBankMoneyTransaction(index) - Returns info for a money transaction from the guild bank.
GetGuildBankTabCost() - Integer OR nil - cost in copper OR no tabs available to buy.
GetGuildBankTabInfo(tab) - Returns info for a guild bank tab.
GetGuildBankTabPermissions(tab) - Gets display / player's access info. Limited data available without bank proximity.
GetGuildBankText(tab) - Returns info text for a tab.
GetGuildBankTransaction(tab, index) - Returns info for an item transaction from the guild bank.
GetGuildBankWithdrawGoldLimit() - Returns withdraw limit for currently selected rank in guild control.
GetGuildBankWithdrawMoney()
GetNumGuildBankMoneyTransactions() - Returns number of money log entries.
GetNumGuildBankTabs() - Integer count of bought tabs, >= 0. No bank proximity required.
GetNumGuildBankTransactions(tab) - Returns number of log transactions for tab "tab".
QueryGuildBankLog(tab) - Updates bank log data from the server, called before all transaction functions. "Money tab" is MAX_GUILDBANK_TABS+1.
QueryGuildBankTab(tab) - Updates bank tab data from the server, called before all item functions.
QueryGuildBankText()
SetCurrentGuildBankTab(tab) - Select different bank tab in the UI.
SetGuildBankTabInfo(tab, name, icon) - Sets the name and icon of a guild bank tab.
SetGuildBankTabItemWithdraw()
SetGuildBankTabPermissions(tab, index, enabled) - Modifies the permissions for a guild bank tab.
SetGuildBankText(tab, infoText) - Modifies info text for a tab.
SetGuildBankWithdrawGoldLimit(amount) - Sets the gold withdraw limit for the guild bank.
SplitGuildBankItem(tab, slot, amount) - Picks up part of a stack.
WithdrawGuildBankMoney(money) - Withdraws "money" copper from the guild bank.

Void Storage

Void Storage was added in Patch 4.3.0

CanUseVoidStorage() - Returns if the player has access to the Void Storage.
ClearVoidTransferDepositSlot(slotIndex) - Clears the specified Void Transfer deposit slot.
ClickVoidStorageSlot(slotIndex [, isRightClick]) - Clicks the specified Void Storage slot.
ClickVoidTransferDepositSlot(slotIndex [, isRightClick]) - Clicks the specified Void Transfer deposit slot.
ClickVoidTransferWithdrawalSlot(slotIndex [, isRightClick]) - Clicks the specified Void Transfer withdrawal slot.
CloseVoidStorageFrame()
ExecuteVoidTransfer() - Applies all pending void transfers (and pays for the cost of any deposited items).
GetNumVoidTransferDeposit() - Returns the number of items being deposited into the Void Storage.
GetNumVoidTransferWithdrawal() - Returns the number of items being withdrawed from the Void Storage.
GetVoidItemHyperlinkString(slotIndex) - Returns the item link of an item in void storage.
GetVoidItemInfo(slotIndex) - Returns info for a Void Storage slot.
GetVoidTransferCost() - Returns the total Void Transfer cost.
GetVoidTransferDepositInfo(slotIndex) - Returns info for the item being deposited into the Void Storage.
GetVoidTransferWithdrawalInfo(slotIndex) - Returns info for the item being withdrawn from the Void Storage.
IsVoidStorageReady()
UnlockVoidStorage() - Purchases the Void Storage.
GetVoidStorageSlotPageIndex(slot)
GetVoidUnlockCost()

Books

Relates to item text from books, etc.

CloseItemText() - Close an open item text (book, plaque, etc).
ItemTextGetCreator() - Returns the name of the character who created the item text.
ItemTextGetItem() - Returns the item name that the item text belongs to.
ItemTextGetMaterial() - Returns the material texture for the item text.
ItemTextGetPage() - Returns the page number of the currently displayed page.
ItemTextGetText() - Returns the contents of the currently displayed page.
ItemTextHasNextPage() - True if there is a page after the current page.
ItemTextIsFullPage()
ItemTextNextPage() - Moves to the next page of the item text.
ItemTextPrevPage() - Moves to the previous page of the item text.

Calendar

The Calendar was added in Patch 3.0.1 and reworked in Patch 8.0.1

HW C_Calendar.AddEvent() - Saves the new event currently being created to the server.
C_Calendar.AreNamesReady() : ready
C_Calendar.CanAddEvent() : canAddEvent - Returns whether the player can add an event.
C_Calendar.CanSendInvite() : canSendInvite - Returns whether the player can send invites.
C_Calendar.CloseEvent() - Closes the selected event without saving it.
C_Calendar.ContextMenuEventCanComplain(offsetMonths, monthDay, eventIndex) : canComplain - Returns whether the player can report the event as spam.
C_Calendar.ContextMenuEventCanEdit(offsetMonths, monthDay, eventIndex) : canEdit - Returns whether the player can edit the event.
C_Calendar.ContextMenuEventCanRemove(offsetMonths, monthDay, eventIndex) : canRemove - Returns whether the player can remove the event.
C_Calendar.ContextMenuEventClipboard() : exists
C_Calendar.ContextMenuEventCopy() - Copies the event to the clipboard.
C_Calendar.ContextMenuEventGetCalendarType() : calendarType
C_Calendar.ContextMenuEventPaste(offsetMonths, monthDay) - Pastes the clipboard event to the date.
C_Calendar.ContextMenuEventRemove() - Deletes the event.
C_Calendar.ContextMenuEventSignUp()
C_Calendar.ContextMenuGetEventIndex() : info
C_Calendar.ContextMenuInviteAvailable() - Accepts the invitation to the event.
C_Calendar.ContextMenuInviteDecline() - Declines the invitation to the event.
C_Calendar.ContextMenuInviteRemove() - Removes the event from the calendar.
C_Calendar.ContextMenuInviteTentative()
C_Calendar.ContextMenuSelectEvent(offsetMonths, monthDay, eventIndex)
C_Calendar.CreateCommunitySignUpEvent()
C_Calendar.CreateGuildAnnouncementEvent()
C_Calendar.CreateGuildSignUpEvent()
C_Calendar.CreatePlayerEvent() - Creates a new calendar event candidate for the player.
C_Calendar.EventAvailable() - Accepts the invitation to the currently open event.
C_Calendar.EventCanEdit() : canEdit - Returns whether the event can be edited.
C_Calendar.EventClearAutoApprove() - Turns off automatic confirmations.
C_Calendar.EventClearLocked() - Unlocks the event.
C_Calendar.EventClearModerator(inviteIndex)
C_Calendar.EventDecline() - Declines the invitation to the currently open event.
C_Calendar.EventGetCalendarType() : calendarType
C_Calendar.EventGetClubId() : info
C_Calendar.EventGetInvite(eventIndex) : info - Returns status information for an invitee for the currently opened event.
C_Calendar.EventGetInviteResponseTime(eventIndex) : time
C_Calendar.EventGetInviteSortCriterion() : criterion, reverse
C_Calendar.EventGetSelectedInvite() : inviteIndex
C_Calendar.EventGetStatusOptions(eventIndex) : options
C_Calendar.EventGetTextures(eventType) : textures
C_Calendar.EventGetTypes() : types
C_Calendar.EventGetTypesDisplayOrdered() : infos
C_Calendar.EventHasPendingInvite() : hasPendingInvite - Returns whether the player has an unanswered invitation to the currently selected event.
C_Calendar.EventHaveSettingsChanged() : haveSettingsChanged - Returns whether the currently opened event has been modified.
C_Calendar.EventInvite(name) - Invites a player to the currently selected event.
C_Calendar.EventRemoveInvite(inviteIndex)
C_Calendar.EventRemoveInviteByGuid(guid)
C_Calendar.EventSelectInvite(inviteIndex)
C_Calendar.EventSetAutoApprove()
C_Calendar.EventSetClubId([clubId])
C_Calendar.EventSetDate(month, monthDay, year) - Sets the date for the currently opened event.
C_Calendar.EventSetDescription(description)
C_Calendar.EventSetInviteStatus(eventIndex, status) - Sets the invitation status of a player to the current event.
C_Calendar.EventSetLocked()
C_Calendar.EventSetModerator(inviteIndex)
C_Calendar.EventSetTextureID(textureIndex)
C_Calendar.EventSetTime(hour, minute) - Sets the time for the currently opened event.
C_Calendar.EventSetTitle(title) - Sets the title for the currently opened event.
C_Calendar.EventSetType(typeIndex) - Sets the event type for the current calendar event.
C_Calendar.EventSignUp()
C_Calendar.EventSortInvites(criterion, reverse)
C_Calendar.EventTentative()
C_Calendar.GetClubCalendarEvents(clubId, startTime, endTime) : events
C_Calendar.GetDayEvent(monthOffset, monthDay, index) : event - Retrieve information about the specified event.
C_Calendar.GetDefaultGuildFilter() : info
C_Calendar.GetEventIndex() : info
C_Calendar.GetEventIndexInfo(eventID [, monthOffset, monthDay]) : eventIndexInfo
C_Calendar.GetEventInfo() : info - Returns detailed information about an event.
C_Calendar.GetFirstPendingInvite(offsetMonths, monthDay) : firstPendingInvite
C_Calendar.GetGuildEventInfo(index) : info
C_Calendar.GetGuildEventSelectionInfo(index) : info
C_Calendar.GetHolidayInfo(monthOffset, monthDay, index) : event - Returns seasonal holiday info.
C_Calendar.GetMaxCreateDate() : maxCreateDate - Returns the last day supported by the Calendar API.
C_Calendar.GetMinDate() : minDate - Returns the first day supported by the Calendar API.
C_Calendar.GetMonthInfo([offsetMonths]) : monthInfo - Returns information about the calendar month by offset.
C_Calendar.GetNextClubId() : clubId
C_Calendar.GetNumDayEvents(offsetMonths, monthDay) : numDayEvents - Returns the number of events for a given day/month offset.
C_Calendar.GetNumGuildEvents() : numGuildEvents
C_Calendar.GetNumInvites() : num - Returns the number of invitees for the currently opened event.
C_Calendar.GetNumPendingInvites() : num
C_Calendar.GetRaidInfo(offsetMonths, monthDay, eventIndex) : info
C_Calendar.IsActionPending() : actionPending
C_Calendar.IsEventOpen() : isOpen
C_Calendar.MassInviteCommunity(clubId, minLevel, maxLevel [, maxRankOrder])
C_Calendar.MassInviteGuild(minLevel, maxLevel, maxRankOrder)
C_Calendar.OpenCalendar() - Requests calendar information from the server. Does not open the calendar frame.
C_Calendar.OpenEvent(offsetMonths, monthDay, index) : success - Establishes an event for future calendar API calls
C_Calendar.RemoveEvent() - Removes the selected event from the calendar (invitees only).
C_Calendar.SetAbsMonth(month, year) - Sets the reference month and year for functions which use a month offset.
C_Calendar.SetMonth(offsetMonths)
C_Calendar.SetNextClubId([clubId])
HW C_Calendar.UpdateEvent() - Saves the selected event.

Chat

These are specific to chat messages and channels.

C_ChatInfo.GetChannelInfoFromIdentifier(channelIdentifier) : info
C_ChatInfo.GetChannelRosterInfo(channelIndex, rosterIndex) : name, owner, moderator, guid
C_ChatInfo.GetChannelRuleset(channelIndex) : ruleset
C_ChatInfo.GetChannelRulesetForChannelID(channelID) : ruleset
C_ChatInfo.GetChannelShortcut(channelIndex) : shortcut
C_ChatInfo.GetChannelShortcutForChannelID(channelID) : shortcut
C_ChatInfo.GetChatTypeName(typeID) : name
C_ChatInfo.GetClubStreamIDs(clubID) : ids
C_ChatInfo.GetGeneralChannelID() : channelID
C_ChatInfo.GetGeneralChannelLocalID() : localID
C_ChatInfo.GetMentorChannelID() : channelID
C_ChatInfo.GetNumActiveChannels() : numChannels
C_ChatInfo.GetNumReservedChatWindows() : numReserved
C_ChatInfo.IsChannelRegional(channelIndex) : isRegional
C_ChatInfo.IsChannelRegionalForChannelID(channelID) : isRegional
C_ChatInfo.IsPartyChannelType(channelType) : isPartyChannelType
C_ChatInfo.IsRegionalServiceAvailable() : available
C_ChatInfo.IsValidChatLine([chatLine]) : isValid
C_ChatInfo.ReplaceIconAndGroupExpressions(input [, noIconReplacement, noGroupReplacement]) : output - Replaces icon and group tags like {rt4}, {diamond} and {g1}.
C_ChatInfo.ResetDefaultZoneChannels()
C_ChatInfo.SwapChatChannelsByChannelIndex(firstChannelIndex, secondChannelIndex)
C_ChatBubbles.GetAllChatBubbles([includeForbidden]) : chatBubbles - Returns all active chat bubbles.
CancelEmote() - Stops an active emote, e.g. when closing the map.
ChannelBan(channel, name) - Bans a player from the specified channel.
ChannelInvite(channel, name) - Invites the specified user to the channel.
ChannelKick(channel, name) - Kicks a player from the specified channel.
ChannelModerator(channel, name) - Sets the specified player as the channel moderator.
ChannelToggleAnnouncements(channel) - Toggles the channel to display announcements either on or off.
ChannelUnban(channel, name) - Unbans a player from the specified channel.
ChannelUnmoderator(channel, name) - Takes the specified user away from the moderator status.
DeclineChannelInvite(channel)
DisplayChannelOwner(channel) - Prints the name of the owner of the specified channel.
DoEmote(emote [, target]) - Performs an emote.
EnumerateServerChannels() - Returns all available server channels (zone dependent).
GetAlternativeDefaultLanguage()
GetChannelDisplayInfo(channelID) - Returns info for chat channels and headers in the Chat Pane.
GetChannelList() - Returns the list of joined chat channels.
GetChannelName(channel or index) - Returns info for a chat channel.
GetDefaultLanguage(unit) - Returns the character's default language.
GetLanguageByIndex(index) - Returns the languages that the character can speak by index.
GetNumChannelMembers()
GetNumDisplayChannels()
GetNumGroupChannels()
GetNumLanguages() - Returns the number of languages your character can speak.
GetSelectedDisplayChannel()
IsDisplayChannelModerator()
IsDisplayChannelOwner()
JoinChannelByName(channelName [, password, frameID, hasVoice]) - Joins the specified chat channel.
JoinPermanentChannel(channelName [, password, frameID, hasVoice]) - Joins the specified chat channel; the channel will be rejoined after relogging.
JoinTemporaryChannel(channelName [, password, frameID, hasVoice]) - Joins the specified chat channel; the channel will be left on logout.
LeaveChannelByLocalID(localID)
LeaveChannelByName(channel) - Leaves the channel with the specified name.
ListChannelByName(channelMatch) - Prints the list of members in the specified channel.
ListChannels() - Prints the list of currently joined chat channel.
LoggingChat(newState) - Gets or sets whether logging chat to Logs\WoWChatLog.txt is enabled.
LoggingCombat(newState) - Gets or sets whether logging combat to Logs\WoWCombatLog.txt is enabled.
SendChatMessage(msg [, chatType, languageID, target]) - Sends a chat message.
SetChannelOwner(channel, name) - Sets the channel owner.
SetChannelPassword(channel, password) - Changes the password of the current channel.
SetSelectedDisplayChannel(channelID)

Chat Window

These are specific to chat window management.

AddChatWindowChannel(chatFrameIndex, channel) - Enables messages from a chat channel index for a chat window.
AddChatWindowMessages() - Enables messages from the chat message type (e.g. "SAY") for a chat window.
ChangeChatColor(channelName, r, g, b) - Updates the color for a type of chat message.
GetChatTypeIndex(type) - Returns the index for a chat type.
GetChatWindowChannels(index) - Returns subscribed channels for a chat window.
GetChatWindowInfo(index) - Returns info for a chat window.
GetChatWindowMessages(index) - Returns subscribed message types for a chat window.
GetChatWindowSavedDimensions(index)
GetChatWindowSavedPosition(index)
RedockChatWindows()
RemoveChatWindowChannel(chatFrameIndex, channel) - Removes the specified chat channel from a chat window.
RemoveChatWindowMessages(chatFrameIndex, messageGroup) - Removes the specified chat message type from a chat window.
ResetChatColors()
ResetChatWindows()
SetChatColorNameByClass(chatType, colorNameByClass)
SetChatWindowAlpha(index, alpha) - Sets the Alpha value(transparency) of ChatFrame<index> (alpha - 0-100)
SetChatWindowColor(index, r, g, b) - Sets the background color of a a chat window. (r/g/b - 0-255)
SetChatWindowDocked(index, docked) - Set whether a chat window is docked. (docked - 0/1)
SetChatWindowLocked(index, locked) - Sets ChatFrame<index> so that it is or is not movable. (locked - 0/1)
SetChatWindowName(index, name) - Sets the alpha value of ChatFrame.
SetChatWindowSavedDimensions(index, width, height)
SetChatWindowSavedPosition(index, point, xOffsetRatio, yOffsetRatio)
SetChatWindowShown(index, shown) - Shows or Hides ChatFrame<index> depending on value of <shown> (shown - 0/1)
SetChatWindowSize(index, size) - Sets the font size of a chat window. (size - default 14)
SetChatWindowUninteractable(id, isUninteractable)
UI ChatFrame_AddChannel(chatFrame, channelName) - Activate channel in chatFrame.
UI ChatFrame_AddMessageEventFilter(event, filterFunc) - Add a chat message filtering function.
UI ChatFrame_GetMessageEventFilters(event) - Retreive the list of chat message filtering functions.
UI ChatFrame_OnHyperlinkShow(reference, link, button) - Called when the user clicks on a chatlink.
UI ChatFrame_RemoveMessageEventFilter(event, filterFunc) - Unregister a chat message filtering function.

AddOn Messages

C_ChatInfo.GetRegisteredAddonMessagePrefixes() : registeredPrefixes - Returns addon message prefixes the client is currently registered to receive.
C_ChatInfo.IsAddonMessagePrefixRegistered(prefix) : isRegistered - Returns whether the prefix is registered.
C_ChatInfo.RegisterAddonMessagePrefix(prefix) : successfulRequest - Registers an addon message prefix to receive messages for that prefix.
C_ChatInfo.SendAddonMessage(prefix, message [, chatType, target]) : success - Sends a message over an addon comm channel.
C_ChatInfo.SendAddonMessageLogged(prefix, message [, chatType, target]) : success - Sends a message to the hidden addon channel, the messages are logged server side.

Communities

Communities were added in Patch 8.0.1

C_Club.AcceptInvitation(clubId)
C_Club.AddClubStreamChatChannel(clubId, streamId)
C_Club.AdvanceStreamViewMarker(clubId, streamId)
C_Club.AssignMemberRole(clubId, memberId, roleId)
C_Club.CanResolvePlayerLocationFromClubMessageData(clubId, streamId, epoch, position) : canResolve
C_Club.ClearAutoAdvanceStreamViewMarker()
C_Club.ClearClubPresenceSubscription()
C_Club.CompareBattleNetDisplayName(clubId, lhsMemberId, rhsMemberId) : comparison
C_Club.CreateClub(name, [shortName], description, clubType, avatarId, [isCrossFaction])
C_Club.CreateStream(clubId, name, subject, leadersAndModeratorsOnly)
C_Club.CreateTicket(clubId [, allowedRedeemCount, duration, defaultStreamId, isCrossFaction])
C_Club.DeclineInvitation(clubId)
C_Club.DestroyClub(clubId)
C_Club.DestroyMessage(clubId, streamId, messageId)
C_Club.DestroyStream(clubId, streamId)
C_Club.DestroyTicket(clubId, ticketId)
C_Club.DoesCommunityHaveMembersOfTheOppositeFaction(clubId) : hasMembersOfOppositeFaction
C_Club.EditClub(clubId [, name, shortName, description, avatarId, broadcast, crossFaction])
C_Club.EditMessage(clubId, streamId, messageId, message)
C_Club.EditStream(clubId, streamId [, name, subject, leadersAndModeratorsOnly])
C_Club.Flush()
C_Club.FocusCommunityStreams()
C_Club.FocusStream(clubId, streamId) : focused
C_Club.GetAssignableRoles(clubId, memberId) : assignableRoles
C_Club.GetAvatarIdList(clubType) : avatarIds
C_Club.GetClubCapacity() : capacity
C_Club.GetClubInfo(clubId) : info
C_Club.GetClubLimits(clubType) : clubLimits
C_Club.GetClubMembers(clubId [, streamId]) : members
C_Club.GetClubPrivileges(clubId) : privilegeInfo
C_Club.GetClubStreamNotificationSettings(clubId) : settings
C_Club.GetCommunityNameResultText(result) : errorCode
C_Club.GetGuildClubId() : guildClubId
C_Club.GetInfoFromLastCommunityChatLine() : messageInfo, clubId, streamId, clubType
C_Club.GetInvitationCandidates([filter], [maxResults], [cursorPosition], [allowFullMatch], clubId) : candidates
C_Club.GetInvitationInfo(clubId) : invitation
C_Club.GetInvitationsForClub(clubId) : invitations
C_Club.GetInvitationsForSelf() : invitations
C_Club.GetLastTicketResponse(ticket) : error, info, showError
C_Club.GetMemberInfo(clubId, memberId) : info
C_Club.GetMemberInfoForSelf(clubId) : info
C_Club.GetMessageInfo(clubId, streamId, messageId) : message
C_Club.GetMessageRanges(clubId, streamId) : ranges
C_Club.GetMessagesBefore(clubId, streamId, newest, count) : messages
C_Club.GetMessagesInRange(clubId, streamId, oldest, newest) : messages
C_Club.GetStreamInfo(clubId, streamId) : streamInfo
C_Club.GetStreams(clubId) : streams
C_Club.GetStreamViewMarker(clubId, streamId) : lastReadTime
C_Club.GetSubscribedClubs() : clubs
C_Club.GetTickets(clubId) : tickets
C_Club.IsAccountMuted(clubId) : accountMuted
C_Club.IsBeginningOfStream(clubId, streamId, messageId) : isBeginningOfStream
C_Club.IsEnabled() : clubsEnabled
C_Club.IsRestricted() : restrictionReason
C_Club.IsSubscribedToStream(clubId, streamId) : subscribed
PROTECTED C_Club.KickMember(clubId, memberId)
C_Club.LeaveClub(clubId)
C_Club.RedeemTicket(ticketId)
C_Club.RequestInvitationsForClub(clubId)
C_Club.RequestMoreMessagesBefore(clubId, streamId [, messageId, count]) : alreadyHasMessages
C_Club.RequestTicket(ticketId)
C_Club.RequestTickets(clubId)
C_Club.RevokeInvitation(clubId, memberId)
C_Club.SendBattleTagFriendRequest(guildClubId, memberId)
C_Club.SendCharacterInvitation(clubId, character)
C_Club.SendInvitation(clubId, memberId)
C_Club.SendMessage(clubId, streamId, message)
C_Club.SetAutoAdvanceStreamViewMarker(clubId, streamId)
C_Club.SetAvatarTexture(texture, avatarId, clubType)
PROTECTED C_Club.SetClubMemberNote(clubId, memberId, note)
C_Club.SetClubPresenceSubscription(clubId)
C_Club.SetClubStreamNotificationSettings(clubId, settings)
C_Club.SetFavorite(clubId, isFavorite)
C_Club.SetSocialQueueingEnabled(clubId, enabled)
C_Club.ShouldAllowClubType(clubType) : clubTypeIsAllowed
C_Club.UnfocusAllStreams(unsubscribe)
C_Club.UnfocusStream(clubId, streamId)
C_Club.ValidateText(clubType, text, clubFieldType) : result
C_Cursor.GetCursorItem() : item

The Club Finder was added in Patch 8.2.0 and enabled in Patch 8.2.5

C_ClubFinder.ApplicantAcceptClubInvite(clubFinderGUID)
C_ClubFinder.ApplicantDeclineClubInvite(clubFinderGUID)
C_ClubFinder.CancelMembershipRequest(clubFinderGUID)
C_ClubFinder.CheckAllPlayerApplicantSettings()
C_ClubFinder.ClearAllFinderCache()
C_ClubFinder.ClearClubApplicantsCache()
C_ClubFinder.ClearClubFinderPostingsCache()
C_ClubFinder.DoesPlayerBelongToClubFromClubGUID(clubFinderGUID) : belongsToClub
C_ClubFinder.GetClubFinderDisableReason() : disableReason
C_ClubFinder.GetClubRecruitmentSettings() : settings
C_ClubFinder.GetClubTypeFromFinderGUID(clubFinderGUID) : clubType
C_ClubFinder.GetFocusIndexFromFlag(flags) : index
C_ClubFinder.GetPlayerApplicantLocaleFlags() : localeFlags
C_ClubFinder.GetPlayerApplicantSettings() : settings
C_ClubFinder.GetPlayerClubApplicationStatus(clubFinderGUID) : clubStatus
C_ClubFinder.GetPlayerSettingsFocusFlagsSelectedCount() : focusCount
C_ClubFinder.GetPostingIDFromClubFinderGUID(clubFinderGUID) : postingID
C_ClubFinder.GetRecruitingClubInfoFromClubID(clubId) : clubInfo
C_ClubFinder.GetRecruitingClubInfoFromFinderGUID(clubFinderGUID) : clubInfo
C_ClubFinder.GetStatusOfPostingFromClubId(postingID) : postingFlags
C_ClubFinder.GetTotalMatchingCommunityListSize() : totalSize
C_ClubFinder.GetTotalMatchingGuildListSize() : totalSize
C_ClubFinder.HasAlreadyAppliedToLinkedPosting(clubFinderGUID) : hasAlreadyApplied
C_ClubFinder.HasPostingBeenDelisted(postingID) : postingDelisted
C_ClubFinder.IsEnabled() : isEnabled
C_ClubFinder.IsListingEnabledFromFlags(flags) : isListed
C_ClubFinder.IsPostingBanned(postingID) : postingBanned
C_ClubFinder.LookupClubPostingFromClubFinderGUID(clubFinderGUID, isLinkedPosting)
C_ClubFinder.PlayerGetClubInvitationList() : inviteList
C_ClubFinder.PlayerRequestPendingClubsList(type)
C_ClubFinder.PlayerReturnPendingCommunitiesList() : info
C_ClubFinder.PlayerReturnPendingGuildsList() : info
C_ClubFinder.PostClub(clubId, itemLevelRequirement, name, description, avatarId, specs, type [, crossFaction]) : succesful
C_ClubFinder.RequestApplicantList(type)
C_ClubFinder.RequestClubsList(guildListRequested, searchString, specIDs)
C_ClubFinder.RequestMembershipToClub(clubFinderGUID, comment, specIDs)
C_ClubFinder.RequestNextCommunityPage(startingIndex, pageSize)
C_ClubFinder.RequestNextGuildPage(startingIndex, pageSize)
C_ClubFinder.RequestPostingInformationFromClubId(clubId) : success
C_ClubFinder.RequestSubscribedClubPostingIDs()
C_ClubFinder.ResetClubPostingMapCache()
C_ClubFinder.RespondToApplicant(clubFinderGUID, playerGUID, shouldAccept, requestType, playerName, forceAccept [, reported])
C_ClubFinder.ReturnClubApplicantList(clubId) : info
C_ClubFinder.ReturnMatchingCommunityList() : recruitingClubs
C_ClubFinder.ReturnMatchingGuildList() : recruitingClubs
C_ClubFinder.ReturnPendingClubApplicantList(clubId) : info
C_ClubFinder.SendChatWhisper(clubFinderGUID, playerGUID, applicantType, name)
C_ClubFinder.SetAllRecruitmentSettings(value)
C_ClubFinder.SetPlayerApplicantLocaleFlags(localeFlags)
C_ClubFinder.SetPlayerApplicantSettings(index, checked)
C_ClubFinder.SetRecruitmentLocale(locale)
C_ClubFinder.SetRecruitmentSettings(index, checked)
C_ClubFinder.ShouldShowClubFinder() : shouldShow

Reporting

C_BehavioralMessaging.SendNotificationReceipt(dbId, openTimeSeconds, readTimeSeconds)
C_ReportSystem.CanReportPlayer(playerLocation) : canReport - Returns if a player can be reported.
C_ReportSystem.CanReportPlayerForLanguage(playerLocation) : canReport
C_ReportSystem.GetMajorCategoriesForReportType(reportType) : majorCategories
C_ReportSystem.GetMajorCategoryString(majorCategory) : majorCategoryString
C_ReportSystem.GetMinorCategoriesForReportTypeAndMajorCategory(reportType, majorCategory) : minorCategories
C_ReportSystem.GetMinorCategoryString(minorCategory) : minorCategoryString
C_ReportSystem.ReportServerLag()
C_ReportSystem.ReportStuckInCombat()
PROTECTED C_ReportSystem.SendReport(reportInfo [, playerLocation])

Restrictions

C_SocialRestrictions.AcknowledgeRegionalChatDisabled()
C_SocialRestrictions.IsChatDisabled() : disabled
C_SocialRestrictions.IsMuted() : isMuted
C_SocialRestrictions.IsSilenced() : isSilenced
C_SocialRestrictions.IsSquelched() : isSquelched
C_SocialRestrictions.SetChatDisabled(disabled)

Voice Chat

Voice Chat was added in Patch 2.2 and reworked in Patch 8.0.1

C_VoiceChat.ActivateChannel(channelID)
C_VoiceChat.BeginLocalCapture(listenToLocalUser)
C_VoiceChat.CanPlayerUseVoiceChat() : canUseVoiceChat
C_VoiceChat.CreateChannel(channelDisplayName) : status
C_VoiceChat.DeactivateChannel(channelID)
C_VoiceChat.EndLocalCapture()
C_VoiceChat.GetActiveChannelID() : channelID
C_VoiceChat.GetActiveChannelType() : channelType
C_VoiceChat.GetAvailableInputDevices() : inputDevices
C_VoiceChat.GetAvailableOutputDevices() : outputDevices
C_VoiceChat.GetChannel(channelID) : channel
C_VoiceChat.GetChannelForChannelType(channelType) : channel
C_VoiceChat.GetChannelForCommunityStream(clubId, streamId) : channel
C_VoiceChat.GetCommunicationMode() : communicationMode
C_VoiceChat.GetCurrentVoiceChatConnectionStatusCode() : statusCode
C_VoiceChat.GetInputVolume() : volume
C_VoiceChat.GetJoinClubVoiceChannelError(clubId) : errorReason
C_VoiceChat.GetLocalPlayerActiveChannelMemberInfo() : memberInfo
C_VoiceChat.GetLocalPlayerMemberID(channelID) : memberID
C_VoiceChat.GetMasterVolumeScale() : scale
C_VoiceChat.GetMemberGUID(memberID, channelID) : memberGUID
C_VoiceChat.GetMemberID(channelID, memberGUID) : memberID
C_VoiceChat.GetMemberInfo(memberID, channelID) : memberInfo
C_VoiceChat.GetMemberName(memberID, channelID) : memberName
C_VoiceChat.GetMemberVolume(playerLocation) : volume
C_VoiceChat.GetOutputVolume() : volume
C_VoiceChat.GetProcesses() : processes
C_VoiceChat.GetPTTButtonPressedState() : isPressed
C_VoiceChat.GetPushToTalkBinding() : keys
C_VoiceChat.GetVADSensitivity() : sensitivity
C_VoiceChat.IsChannelJoinPending(channelType [, clubId, streamId]) : isPending
C_VoiceChat.IsDeafened() : isDeafened
C_VoiceChat.IsEnabled() : isEnabled
C_VoiceChat.IsLoggedIn() : isLoggedIn
C_VoiceChat.IsMemberLocalPlayer(memberID, channelID) : isLocalPlayer
C_VoiceChat.IsMemberMuted(playerLocation) : mutedForMe
C_VoiceChat.IsMemberMutedForAll(memberID, channelID) : mutedForAll
C_VoiceChat.IsMemberSilenced(memberID, channelID) : silenced
C_VoiceChat.IsMuted() : isMuted
C_VoiceChat.IsParentalDisabled() : isParentalDisabled
C_VoiceChat.IsParentalMuted() : isParentalMuted
C_VoiceChat.IsPlayerUsingVoice(playerLocation) : isUsingVoice
C_VoiceChat.IsSilenced() : isSilenced
C_VoiceChat.LeaveChannel(channelID)
C_VoiceChat.Login() : status
C_VoiceChat.Logout() : status
C_VoiceChat.MarkChannelsDiscovered()
C_VoiceChat.RequestJoinAndActivateCommunityStreamChannel(clubId, streamId)
C_VoiceChat.RequestJoinChannelByChannelType(channelType [, autoActivate])
C_VoiceChat.SetCommunicationMode(communicationMode)
C_VoiceChat.SetDeafened(isDeafened)
C_VoiceChat.SetInputDevice(deviceID)
C_VoiceChat.SetInputVolume(volume)
C_VoiceChat.SetMasterVolumeScale(scale)
C_VoiceChat.SetMemberMuted(playerLocation, muted)
C_VoiceChat.SetMemberVolume(playerLocation, volume)
C_VoiceChat.SetMuted(isMuted)
C_VoiceChat.SetOutputDevice(deviceID)
C_VoiceChat.SetOutputVolume(volume)
C_VoiceChat.SetPortraitTexture(textureObject, memberID, channelID)
C_VoiceChat.SetPushToTalkBinding(keys)
C_VoiceChat.SetVADSensitivity(sensitivity)
C_VoiceChat.ShouldDiscoverChannels() : shouldDiscoverChannels
C_VoiceChat.ToggleDeafened()
C_VoiceChat.ToggleMemberMuted(playerLocation)
C_VoiceChat.ToggleMuted()
ChannelSetAllSilent([channelNumber | channelName], memberName, silenceOn)
ChannelSetPartyMemberSilent(partyMemberName, silenceOn)
IsChatChannelRaid()

Text-to-Speech

Text-to-Speech was added in Patch 9.1.0

C_VoiceChat.ActivateChannelTranscription(channelID)
C_VoiceChat.DeactivateChannelTranscription(channelID)
C_VoiceChat.GetRemoteTtsVoices() : ttsVoices
C_VoiceChat.GetTtsVoices() : ttsVoices
C_VoiceChat.IsSpeakForMeActive() : isActive
C_VoiceChat.IsSpeakForMeAllowed() : isAllowed
C_VoiceChat.IsTranscriptionAllowed() : isAllowed
C_VoiceChat.SpeakRemoteTextSample(text)
C_VoiceChat.SpeakText(voiceID, text, destination, rate, volume)
C_VoiceChat.StopSpeakingText()
C_TTSSettings.GetChannelEnabled(channelInfo) : enabled
C_TTSSettings.GetCharacterSettingsSaved() : settingsBeenSaved
C_TTSSettings.GetChatTypeEnabled(chatName) : enabled
C_TTSSettings.GetSetting(setting) : enabled
C_TTSSettings.GetSpeechRate() : rate
C_TTSSettings.GetSpeechVolume() : volume
C_TTSSettings.GetVoiceOptionID(voiceType) : voiceID
C_TTSSettings.GetVoiceOptionName(voiceType) : voiceName
C_TTSSettings.MarkCharacterSettingsSaved()
C_TTSSettings.SetChannelEnabled(channelInfo [, newVal])
C_TTSSettings.SetChannelKeyEnabled(channelKey [, newVal])
C_TTSSettings.SetChatTypeEnabled(chatName [, newVal])
C_TTSSettings.SetDefaultSettings()
C_TTSSettings.SetSetting(setting [, newVal])
C_TTSSettings.SetSpeechRate(newVal)
C_TTSSettings.SetSpeechVolume(newVal)
C_TTSSettings.SetVoiceOption(voiceType, voiceID)
C_TTSSettings.SetVoiceOptionName(voiceType, voiceName)
C_TTSSettings.ShouldOverrideMessage(language) : overrideMessage

Twitter

Twitter integration was added in Patch 6.1.0

C_Social.GetLastAchievement() : achievementID, achievementName, achievementDesc, iconFileID
C_Social.GetLastItem() : itemID, itemName, iconFileID, itemQuality, itemLevel, ...
C_Social.GetLastScreenshotIndex() : screenShotIndex - Returns the index of the last screenshot.
C_Social.GetMaxTweetLength() : maxTweetLength - Returns the max character length of a tweet.
C_Social.GetScreenshotInfoByIndex(index) : screenWidth, screenHeight - Returns the display resolution of a screenshot.
C_Social.GetTweetLength(tweetText) : tweetLength
C_Social.IsSocialEnabled() : isEnabled
PROTECTED C_Social.RegisterSocialBrowser()
C_Social.SetTextureToScreenshot(texture, index)
PROTECTED C_Social.TwitterCheckStatus()
PROTECTED C_Social.TwitterConnect()
PROTECTED C_Social.TwitterDisconnect()
C_Social.TwitterGetMSTillCanPost() : msTimeLeft
PROTECTED C_Social.TwitterPostAchievement(text, width, height, snapshotId, offScreenFrame, lastAchievementID, usedCustomText)
PROTECTED C_Social.TwitterPostItem(text, width, height, snapshotId, offScreenFrame, lastItemID, usedCustomText)
PROTECTED C_Social.TwitterPostMessage(message)
PROTECTED C_Social.TwitterPostScreenshot(text, screenshotIndex, texture, usedCustomText)

Character

CheckBinderDist() - Check whether the player is close enough to interact with the Hearthstone binder.
ConfirmBinder() - Confirm the request to set the binding of the player's Hearthstone.
Dismount() - Dismounts the character.
GetBindLocation() - Returns the subzone the character's Hearthstone is set to.
GetComboPoints() - Returns the amount of current combo points.
GetCurrentLevelFeatures(level) - For Level Up Display
GetCurrentTitle() - Returns the current title.
GetMirrorTimerInfo(id) - Returns info for the mirror timer, e.g. fatigue, breath and feign death.
GetMirrorTimerProgress(id) - Returns the current value of the mirror timer.
GetMoney() - Returns the amount of money the player character owns.
GetNumTitles() - Returns the number of titles, specifically the highest title ID.
GetRestState() - Returns if the character is in a rested or normal state.
GetRuneCooldown(id) - Returns the Death Knight's cooldown info for the specified rune.
GetRuneCount(slot) - Returns the Death Knight's number of runes for a slot.
GetSheathState() - Returns which type of weapon the player currently has unsheathed.
GetSpellsForCharacterUpgradeTier(tierIndex) - For Level Up Display
GetTimeToWellRested()
GetTitleName(titleId) - Returns the name of a player title.
GetXPExhaustion() - Returns the amount of current rested XP for the character.
HasFullControl()
IsChatAFK()
IsChatDND()
IsEncounterInProgress()
IsFalling() - True if the character is currently falling.
IsFlyableArea() - True if the current zone is a flyable area.
IsFlying() - True if the character is currently on a flying mount.
IsIndoors() - True if the character is currently indoors.
IsInsane() - Used for the Insanity bar
IsMounted() - True if the character is currently mounted.
IsOutOfBounds() - True if the player is currently outside of map boundaries.
IsOutdoors() - True if the character is currently outdoors.
IsPlayerInWorld()
IsPlayerNeutral()
IsResting() - True if the character is currently resting.
IsStealthed() - True if the character is currently stealthed.
IsSubmerged()
IsSwimming() - True if the character is currently swimming.
IsThreatWarningEnabled() - True if threat warnings are currently enabled.
IsTitleKnown(index) - True if the character can use a player title.
IsXPUserDisabled() - Returns 1 if the character has disabled experience gain.
PlayerHasHearthstone() - Returns the hearthstone ID
RandomRoll(min, max) - Performs a random roll between two values.
HW SetCurrentTitle(titleId) - Sets the player's displayed title.
ToggleSheath() - Toggles sheathed or unsheathed weapons.
PROTECTED UseHearthstone()
DEPRECATED HasAlternateForm()

Paper Doll

Relates to the Paper doll (also known as Character sheet).

C_PaperDollInfo.GetArmorEffectiveness(armor, attackerLevel) : effectiveness
C_PaperDollInfo.GetArmorEffectivenessAgainstTarget(armor) : effectiveness
C_PaperDollInfo.GetInspectItemLevel(unit) : equippedItemLevel - Returns the average item level for the unit being inspected.
C_PaperDollInfo.GetMinItemLevel() : minItemLevel
C_PaperDollInfo.GetStaggerPercentage(unit) : stagger, staggerAgainstTarget
C_PaperDollInfo.OffhandHasShield() : offhandHasShield
C_PaperDollInfo.OffhandHasWeapon() : offhandHasWeapon
CanDualWield()
GetAttackPowerForStat(stat, value) - Returns the amount of attack power contributed by a specific amount of a stat.
GetAvoidance()
GetBlockChance() - Returns the block chance percentage.
GetCombatRating(ratingID) - Returns a specific combat rating.
GetCombatRatingBonus(ratingID) - Returns the bonus percentage for a specific combat rating.
GetCombatRatingBonusForCombatRatingValue(ratingIndex, value)
GetCritChance() - Returns the melee critical hit chance percentage.
GetCritChanceProvidesParryEffect()
GetDodgeChance() - Returns the dodge chance percentage.
GetDodgeChanceFromAttribute()
GetExpertise() - Returns the player's expertise percentage for main hand, offhand and ranged attacks.
GetHaste() - Returns the player's haste percentage.
GetHitModifier()
GetLifesteal()
GetManaRegen() - Returns the mana regeneration per second.
GetMastery() - Returns the base mastery percentage.
GetMasteryEffect() - Returns the effective mastery percentage.
GetMaxCombatRatingBonus(ratingIndex)
GetMeleeHaste() - Returns player's Melee attack haste.
GetModResilienceDamageReduction()
GetOverrideAPBySpellPower()
GetOverrideSpellPowerByAP()
GetParryChance() - Returns the parry chance percentage.
GetParryChanceFromAttribute()
GetPetMeleeHaste()
GetPetSpellBonusDamage()
GetPowerRegen() - Returns normal and combat power regeneration rates.
GetPowerRegenForPowerType(POWER_TYPE)
GetPVPGearStatRules()
GetPvpPowerDamage()
GetPvpPowerHealing()
GetRangedCritChance() - Returns the ranged critical hit chance.
GetRangedHaste()
GetShieldBlock()
GetSpeed()
GetSpellBonusDamage(spellTreeID) - Returns the raw spell damage bonus for the specified spell tree.
GetSpellBonusHealing() - Returns the raw spell healing bonus.
GetSpellCritChance(school) - Returns the critical hit chance for the specified spell school.
GetSpellHitModifier()
GetSpellPenetration()
GetSturdiness()
GetUnitHealthModifier(unit)
GetUnitMaxHealthModifier(unit)
GetUnitPowerModifier(unit)
GetVersatilityBonus(COMBAT_RATING)
HasAPEffectsSpellPower()
HasDualWieldPenalty()
HasIgnoreDualWieldWeapon()
HasSPEffectsAttackPower()
IsDualWielding()
IsRangedWeapon()
PlayerEffectiveAttackPower()
ResistancePercent(resistance, casterLevel)

Equipment Manager

The Equipment Manager was added in Patch 3.1.2

C_EquipmentSet.AssignSpecToEquipmentSet(equipmentSetID, specIndex) - Assigns an equipment set to a specialization.
C_EquipmentSet.CanUseEquipmentSets() : canUseEquipmentSets - Returns whether any equipment sets can be used.
C_EquipmentSet.ClearIgnoredSlotsForSave() - Clears ignored slots for saving.
C_EquipmentSet.CreateEquipmentSet(equipmentSetName [, icon]) - Creates an equipment set.
C_EquipmentSet.DeleteEquipmentSet(equipmentSetID) - Deletes an equipment set.
C_EquipmentSet.EquipmentSetContainsLockedItems(equipmentSetID) : hasLockedItems - Returns whether an equipment set has locked items
C_EquipmentSet.GetEquipmentSetAssignedSpec(equipmentSetID) : specIndex - Returns the specialization assigned to an equipment set.
C_EquipmentSet.GetEquipmentSetForSpec(specIndex) : equipmentSetID - Returns the equipment set currently assigned to a specific specialization.
C_EquipmentSet.GetEquipmentSetID(equipmentSetName) : equipmentSetID - Returns the set ID of an equipment set with the specified name.
C_EquipmentSet.GetEquipmentSetIDs() : equipmentSetIDs - Returns an array containing all currently saved equipment set IDs.
C_EquipmentSet.GetEquipmentSetInfo(equipmentSetID) : name, iconFileID, setID, isEquipped, numItems, numEquipped, numInInventory, ... - Returns information about a saved equipment set.
C_EquipmentSet.GetIgnoredSlots(equipmentSetID) : slotIgnored - Returns ignored slots of an equipment set.
C_EquipmentSet.GetItemIDs(equipmentSetID) : itemIDs - Returns the item IDs of an equipment set.
C_EquipmentSet.GetItemLocations(equipmentSetID) : locations - Returns the location of all items in an equipment set.
C_EquipmentSet.GetNumEquipmentSets() : numEquipmentSets - Returns the number of saved equipment sets.
C_EquipmentSet.IgnoreSlotForSave(slot) - Ignores an equipment slot for saving.
C_EquipmentSet.IsSlotIgnoredForSave(slot) : isSlotIgnored - Returns whether a slot is ignored for saving.
C_EquipmentSet.ModifyEquipmentSet(equipmentSetID, newName [, newIcon]) - Modifies an equipment set.
C_EquipmentSet.PickupEquipmentSet(equipmentSetID) - Picks up an equipment set, placing it on the cursor.
C_EquipmentSet.SaveEquipmentSet(equipmentSetID [, icon]) - Saves your currently equipped items into an equipment set.
C_EquipmentSet.UnassignEquipmentSetSpec(equipmentSetID) - Unassigns an equipment set from a specialization.
C_EquipmentSet.UnignoreSlotForSave(slot) - Unignores a slot for saving.
NOCOMBAT C_EquipmentSet.UseEquipmentSet(equipmentSetID) : setWasEquipped - Equips items from a specified equipment set.
GetInventoryItemEquippedUnusable(unit, slot)
GetInventoryItemsForSlot(slot, returnTable [, transmogrify])
IsInventoryItemAnUpgrade(unit, slot)
UI EquipmentManager_UnpackLocation() - Unpacks a location integer to determine the actual inventory location.

Dressing Room

The Dressing room was added in Patch 1.7.0

UI DressUpItemLink(itemLink) - Shows the Dressing Room with the given item equipped.
UI DressUpMountLink(itemLink | spellLink) - Shows the Dressing Room for the mount.
UI DressUpTransmogLink(transmogLink) - Shows the Dressing Room for transmog appearance or illusion.
UI SetDressUpBackground(frame, fileName, atlasPostfix)

Transmogrification

Transmogrification was added in Patch 4.3.0. See also Appearances functions.

C_Transmog.ApplyAllPending([currentSpecOnly]) : requestSent - Confirms all pending transmogs.
C_Transmog.CanHaveSecondaryAppearanceForSlotID(slotID) : canHaveSecondaryAppearance
C_Transmog.CanTransmogItem(itemInfo) : canBeTransmogged, selfFailureReason, canTransmogOthers, ...
C_Transmog.CanTransmogItemWithItem(targetItemInfo, sourceItemInfo) : canTransmog, failureReason - Returns whether an item can be transmogrified to look like another item.
C_Transmog.ClearAllPending()
C_Transmog.ClearPending(transmogLocation) - Clears an equipment slot of pending transmogs.
C_Transmog.Close()
C_Transmog.ExtractTransmogIDList(input) : transmogIDList
C_Transmog.GetApplyCost() : cost
C_Transmog.GetApplyWarnings() : warnings
C_Transmog.GetBaseCategory(transmogID) : categoryID
C_Transmog.GetCreatureDisplayIDForSource(itemModifiedAppearanceID) : creatureDisplayID
C_Transmog.GetItemIDForSource(itemModifiedAppearanceID) : itemID
C_Transmog.GetPending(transmogLocation) : pendingInfo
C_Transmog.GetSlotEffectiveCategory(transmogLocation) : categoryID
C_Transmog.GetSlotForInventoryType(inventoryType) : slot - Returns the equipment slot for an inventory type.
C_Transmog.GetSlotInfo(transmogLocation) : isTransmogrified, hasPending, isPendingCollected, canTransmogrify, ...
C_Transmog.GetSlotUseError(transmogLocation) : errorCode, errorString
C_Transmog.GetSlotVisualInfo(transmogLocation) : baseSourceID, baseVisualID, appliedSourceID, appliedVisualID, ...
C_Transmog.IsAtTransmogNPC() : isAtNPC
C_Transmog.IsSlotBeingCollapsed(transmogLocation) : isBeingCollapsed
C_Transmog.LoadOutfit(outfitID)
C_Transmog.SetPending(transmogLocation, pendingInfo)
C_Item.CanItemTransmogAppearance(itemLoc) : canTransmog, errorCode
C_Item.GetAppliedItemTransmogInfo(itemLoc) : info
C_Item.GetBaseItemTransmogInfo(itemLoc) : info
C_Item.GetCurrentItemTransmogInfo(itemLoc) : info
C_Item.IsDressableItemByID(itemInfo) : isDressableItem
IsCosmeticItem()
DEPRECATED C_Transmog.GetCost()

Barber Shop

The Barbershop was added in Patch 3.0.2 and reworked in patch Patch 9.0.1

C_BarberShop.ApplyCustomizationChoices() : success
C_BarberShop.Cancel()
C_BarberShop.ClearPreviewChoices([clearSavedChoices])
C_BarberShop.GetAvailableCustomizations() : categories
C_BarberShop.GetCurrentCameraZoom() : zoomLevel
C_BarberShop.GetCurrentCharacterData() : characterData
C_BarberShop.GetCurrentCost() : cost
C_BarberShop.HasAnyChanges() : hasChanges
C_BarberShop.IsViewingAlteredForm() : isViewingAlteredForm
C_BarberShop.MarkCustomizationChoiceAsSeen(choiceID)
C_BarberShop.MarkCustomizationOptionAsSeen(optionID)
C_BarberShop.PreviewCustomizationChoice(optionID, choiceID)
C_BarberShop.RandomizeCustomizationChoices()
C_BarberShop.ResetCameraRotation()
C_BarberShop.ResetCustomizationChoices()
C_BarberShop.RotateCamera(diffDegrees)
C_BarberShop.SaveSeenChoices()
C_BarberShop.SetCameraDistanceOffset(offset)
C_BarberShop.SetCameraZoomLevel(zoomLevel [, keepCustomZoom])
C_BarberShop.SetCustomizationChoice(optionID, choiceID)
C_BarberShop.SetModelDressState(dressedState)
C_BarberShop.SetSelectedSex(sex)
C_BarberShop.SetViewingAlteredForm(isViewingAlteredForm)
C_BarberShop.SetViewingShapeshiftForm([shapeshiftFormID])
C_BarberShop.ZoomCamera(zoomAmount)

Cinematics

Relates to in-game cinematics/cutscenes.

CanCancelScene()
CancelScene()
InCinematic()
IsInCinematicScene()
MouseOverrideCinematicDisable()
OpeningCinematic() - Shows the opening cinematic for a player's race. Only works as long as the player has earned zero exp.
StopCinematic()

Relates to pre-rendered movies.

CancelPreloadingMovie(movieId)
GetMovieDownloadProgress(movieId)
GameMovieFinished() - Ends the movie.
IsMovieLocal(movieId)
IsMoviePlayable(movieId) - True if the specified movie exists and can be played.
PreloadMovie(movieId)
UI MovieFrame_PlayMovie(MovieFrame, movieID) - Plays a movie.

Class

C_ClassColor.GetClassColor(className) : classColor - Returns a ColorMixin for a class.
C_CreatureInfo.GetClassInfo(classID) : classInfo - Returns info for a class by ID.
FillLocalizedClassList(classTable [, isFemale]) - Fills a table with localized (female) class names.
GetClassInfo(index) - Returns information about a class.
GetNumClasses() - Returns the number of player classes in the game.
IsDemonHunterAvailable()
UI GetClassColor(classFilename) - Returns a class color from RAID_CLASS_COLORS.

Talents

Relates to Specializations.

C_SpecializationInfo.CanPlayerUsePVPTalentUI() : canUse, failureReason
C_SpecializationInfo.CanPlayerUseTalentSpecUI() : canUse, failureReason
C_SpecializationInfo.CanPlayerUseTalentUI() : canUse, failureReason
C_SpecializationInfo.GetAllSelectedPvpTalentIDs() : selectedPvpTalentIDs
C_SpecializationInfo.GetInspectSelectedPvpTalent(inspectedUnit, talentIndex) : selectedTalentID
C_SpecializationInfo.GetPvpTalentAlertStatus() : hasUnspentSlot, hasNewTalent
C_SpecializationInfo.GetPvpTalentSlotInfo(talentIndex) : slotInfo
C_SpecializationInfo.GetPvpTalentSlotUnlockLevel(talentIndex) : requiredLevel
C_SpecializationInfo.GetPvpTalentUnlockLevel(talentID) : requiredLevel
C_SpecializationInfo.GetSpecIDs(specSetID) : specIDs
C_SpecializationInfo.GetSpellsDisplay(specializationID) : spellID
C_SpecializationInfo.IsInitialized() : isSpecializationDataInitialized
C_SpecializationInfo.IsPvpTalentLocked(talentID) : locked
C_SpecializationInfo.MatchesCurrentSpecSet(specSetID) : matches
C_SpecializationInfo.SetPvpTalentLocked(talentID, locked)
AreTalentsLocked()
CheckTalentMasterDist() - Returns nil if the player is too far away from the talent master to use the talent methods.
ClearFailedPVPTalentIDs()
ClearFailedTalentIDs()
ConfirmTalentWipe() - Confirms freeing all talent points.
GetActiveSpecGroup([isInspect]) - Returns the index of the current active specialization/talent/glyph group.
GetFailedPVPTalentIDs()
GetFailedTalentIDs()
GetMaxTalentTier() - Returns the number of available talent tiers.
GetNumSpecGroups([isInspect]) - Returns the number of specialization group (dual specs) the player has.
GetNumSpecializations([isInspect, isPet]) - Returns the number of available specializations.
GetNumSpecializationsForClassID(classID) - Returns the number of specializations available to a particular class.
GetNumUnspentPvpTalents()
GetNumUnspentTalents() - Returns the number of unspent talents.
GetPetTalentTree()
GetPrimarySpecialization()
GetPvpTalentInfoByID(talentID [, specGroupIndex, isInspect, inspectUnit])
GetPvpTalentInfoBySpecialization()
GetPvpTalentLink()
GetSetBonusesForSpecializationByItemID(specID, itemID)
GetSpecChangeCost()
GetSpecialization([isInspect, isPet, specGroup]) - Returns the index of the player's current specialization.
GetSpecializationInfo(specIndex [, isInspect, isPet, inspectTarget, sex]) - Returns info for a specialization.
GetSpecializationInfoByID(specID) - Returns information about the specified specialization.
GetSpecializationInfoForClassID(classID, specIndex) - Returns information about the specified specialization.
GetSpecializationInfoForSpecID(specID [, sex])
GetSpecializationMasterySpells(specIndex [, isInspect, isPet]) - Returns the mastery spell ID of the specified specialization.
GetSpecializationNameForSpecID(specID [, sex])
GetSpecializationRole(specIndex [, isInspect, isPet]) - Returns the role a specialization is intended to perform.
GetSpecializationRoleByID(specID) - Returns the role a specialization is intended to perform.
GetSpecializationSpells(specIndex [, isInspect, isPet]) - Returns the spells learned as part of the specified specialization.
GetSpecsForSpell(spellName or spellIndex, bookType) - Returns the specs for which the specified spell can be used.
GetTalentInfo(tier, column, specGroupIndex [, isInspect, inspectUnit]) - Returns info for the specified talent.
GetTalentInfoByID(talentID, specGroupIndex [, isInspect, inspectUnit]) - Returns information about a talent.
GetTalentInfoBySpecialization(specGroupIndex, tier, column)
GetTalentLink(talentID [, isInspect, specGroup, inspectID, classID]) - Returns the talent link.
GetTalentTierInfo(tier)
IsPvpTalentSpell()
IsSpellClassOrSpec(spellName or spellIndex, bookType) - Returns whether a given spell is specific to a specialization and/or class.
IsTalentSpell(slot, bookType) - True if the specified spell is learned from a talent.
LearnPvpTalent()
LearnPvpTalents()
LearnTalent(talentID)
NOCOMBAT LearnTalents(talentID1, talentID2, ...) - Learns the talents listed.
RemovePvpTalent()
NOCOMBAT RemoveTalent(talentID) - Removes the specified talent.
NOCOMBAT SetSpecialization(specIndex [, isPet]) - Selects a specialization.
NOCOMBAT UnlearnSpecialization(specIndex [, isPet])

Shaman totems

PROTECTED DestroyTotem(slot) - Destroys a totem/minion.
GetMultiCastTotemSpells(totemslot) - Returns a list of valid spells for a totem bar slot.
GetTotemCannotDismiss(slot)
GetTotemInfo(slot) - Returns info for the specified totem.
GetTotemTimeLeft(slot)
TargetTotem(slot)
PROTECTED SetMultiCastSpell(actionID, spellID) - Sets the totem spell for a specific totem bar slot.

Druid shapeshift forms

PROTECTED CancelShapeshiftForm() - Cancels a shapeshift form.
PROTECTED CastShapeshiftForm(index)
GetNumShapeshiftForms()
GetShapeshiftForm(unknown) - Returns zero-based index of current form/stance.
GetShapeshiftFormCooldown(index)
GetShapeshiftFormID() - Returns the ID of the form or stance the player is currently in.
GetShapeshiftFormInfo(index) - Returns info for an available form or stance.

Stables

C_StableInfo.GetNumActivePets() : numActivePets
C_StableInfo.GetNumStablePets() : numStablePets

Collections

The Collections window was added in Patch 5.0.4

Mount Journal

The Mount Journal was added in Patch 6.0.2

C_MountJournal.ClearFanfare(mountID)
C_MountJournal.ClearRecentFanfares()
C_MountJournal.Dismiss() - Dismisses the currently summoned mount.
C_MountJournal.GetCollectedFilterSetting(filterIndex) : isChecked - Indicates whether the specified mount journal filter is enabled.
C_MountJournal.GetDisplayedMountAllCreatureDisplayInfo(mountIndex) : allDisplayInfo - Returns all display IDs for a mount by index.
C_MountJournal.GetDisplayedMountInfo(displayIndex) : name, spellID, icon, isActive, isUsable, sourceType, isFavorite, ... - Returns information about the specified mount.
C_MountJournal.GetDisplayedMountInfoExtra(mountIndex) : creatureDisplayInfoID, description, source, isSelfMount, mountTypeID, ... - Returns extra information about the specified mount.
C_MountJournal.GetIsFavorite(mountIndex) : isFavorite, canSetFavorite - Indicates whether the specified mount is marked as a favorite.
C_MountJournal.GetMountAllCreatureDisplayInfoByID(mountID) : allDisplayInfo - Returns the display IDs for a mount.
C_MountJournal.GetMountFromItem(itemID) : mountID - Returns the mount for an item ID.
C_MountJournal.GetMountFromSpell(spellID) : mountID - Returns the mount for a spell ID.
C_MountJournal.GetMountIDs() : mountIDs - Returns the IDs of mounts listed in the mount journal.
C_MountJournal.GetMountInfoByID(mountID) : name, spellID, icon, isActive, isUsable, sourceType, isFavorite, ... - Returns information about the specified mount.
C_MountJournal.GetMountInfoExtraByID(mountID) : creatureDisplayInfoID, description, source, isSelfMount, mountTypeID, ... - Returns extra information about the specified mount.
C_MountJournal.GetMountUsabilityByID(mountID, checkIndoors) : isUsable, useError - Returns if a mount is currently usable by the player.
C_MountJournal.GetNumDisplayedMounts() : numMounts - Returns the number of (filtered) mounts shown in the mount journal.
C_MountJournal.GetNumMounts() : numMounts - Returns the number of mounts listed in the mount journal.
C_MountJournal.GetNumMountsNeedingFanfare() : numMountsNeedingFanfare
C_MountJournal.IsSourceChecked(filterIndex) : isChecked
C_MountJournal.IsTypeChecked(filterIndex) : isChecked
C_MountJournal.IsUsingDefaultFilters() : isUsingDefaultFilters
C_MountJournal.IsValidSourceFilter(filterIndex) : isValid
C_MountJournal.IsValidTypeFilter(filterIndex) : isValid
C_MountJournal.NeedsFanfare(mountID) : needsFanfare
C_MountJournal.Pickup(displayIndex) - Picks up the specified mount onto the cursor, usually in preparation for placing it on an action button.
C_MountJournal.SetAllSourceFilters(isChecked)
C_MountJournal.SetAllTypeFilters(isChecked)
C_MountJournal.SetCollectedFilterSetting(filterIndex, isChecked) - Enables or disables the specified mount journal filter.
C_MountJournal.SetDefaultFilters()
C_MountJournal.SetIsFavorite(mountIndex, isFavorite) - Marks or unmarks the specified mount as a favorite.
C_MountJournal.SetSearch(searchValue)
C_MountJournal.SetSourceFilter(filterIndex, isChecked)
C_MountJournal.SetTypeFilter(filterIndex, isChecked)
C_MountJournal.SummonByID(mountID) - Summons the specified mount.

Mount equipment was added in Patch 8.2.0

PROTECTED C_MountJournal.ApplyMountEquipment(itemLocation) : canContinue
C_MountJournal.AreMountEquipmentEffectsSuppressed() : areEffectsSuppressed
C_MountJournal.GetAppliedMountEquipmentID() : itemID
C_MountJournal.GetMountEquipmentUnlockLevel() : level
C_MountJournal.IsItemMountEquipment(itemLocation) : isMountEquipment
C_MountJournal.IsMountEquipmentApplied() : isApplied
C_PlayerInfo.CanPlayerUseMountEquipment() : canUseMountEquipment, failureReason - Returns true if the player can use mount equipment.

The old companion API (non-combat pets and mounts) was added in Patch 3.0.2

DEPRECATED CallCompanion(type, slotid) - Summons a companion.
DEPRECATED DismissCompanion(type) - Dismisses the current companion.
DEPRECATED GetCompanionInfo(type, slotid) - Returns info for a companion.
DEPRECATED GetNumCompanions(type) - Returns the number of mounts.
DEPRECATED SummonRandomCritter() - No longer does anything.

Pet Journal

The Pet Journal was added in Patch 5.0.4. See also Pet Battle functions.

C_PetInfo.GetPetTamersForMap(uiMapID) : petTamers - Returns the pet tamers on a map.
C_PetJournal.CagePetByID(petID) - Puts the pet into a cage.
C_PetJournal.ClearFanfare()
C_PetJournal.ClearRecentFanfares()
C_PetJournal.ClearSearchFilter() - Clears the search box in the pet journal.
C_PetJournal.FindPetIDByName()
C_PetJournal.GetBattlePetLink(petID) - Returns a battle pet link.
C_PetJournal.GetDisplayIDByIndex(speciesID, index) : displayID
C_PetJournal.GetDisplayProbabilityByIndex(speciesID, index) : displayProbability
C_PetJournal.GetNumCollectedInfo(speciesID) : numCollected, limit
C_PetJournal.GetNumDisplays(speciesID) : numDisplays
C_PetJournal.GetNumPets() - Returns information about the number of battle pets.
C_PetJournal.GetNumPetsNeedingFanfare()
C_PetJournal.GetNumPetSources() - Returns information about the number of pet sources.
C_PetJournal.GetNumPetTypes() - Returns information about the number of pet types.
C_PetJournal.GetOwnedBattlePetString(speciesID) - Returns a formatted string how many of a battle pet species the player has collected.
C_PetJournal.GetPetAbilityInfo(abilityID) : name, icon, petType
C_PetJournal.GetPetAbilityList(speciesID [, idTable, levelTable])
C_PetJournal.GetPetAbilityListTable(speciesID) : info
C_PetJournal.GetPetCooldownByGUID()
C_PetJournal.GetPetInfoByIndex(index) - Returns information about a battle pet.
C_PetJournal.GetPetInfoByItemID(itemID)
C_PetJournal.GetPetInfoByPetID(petID) - Returns information about a battle pet.
C_PetJournal.GetPetInfoBySpeciesID(speciesID) - Returns information about a pet species.
C_PetJournal.GetPetInfoTableByPetID(petID) : info
C_PetJournal.GetPetLoadOutInfo(slot) : petID, ability1ID, ability2ID, ability3ID, locked
C_PetJournal.GetPetModelSceneInfoBySpeciesID(speciesID)
C_PetJournal.GetPetSortParameter()
C_PetJournal.GetPetStats(petID) - Returns the stats of a collected battle pet.
C_PetJournal.GetPetSummonInfo(battlePetGUID) : isSummonable, error, errorText
C_PetJournal.GetPetTeamAverageLevel()
C_PetJournal.GetSummonBattlePetCooldown()
C_PetJournal.GetSummonedPetGUID() - Returns information about a battle pet.
C_PetJournal.GetSummonRandomFavoritePetGUID()
C_PetJournal.IsFilterChecked()
C_PetJournal.IsFindBattleEnabled()
C_PetJournal.IsJournalReadOnly()
C_PetJournal.IsJournalUnlocked()
C_PetJournal.IsPetSourceChecked()
C_PetJournal.IsPetTypeChecked()
C_PetJournal.IsUsingDefaultFilters() : isUsingDefaultFilters
C_PetJournal.PetCanBeReleased(petID) - Returns true if you can release the pet.
C_PetJournal.PetIsCapturable(petID)
C_PetJournal.PetIsFavorite(petID) - True if the collected battle pet is favorited.
C_PetJournal.PetIsHurt(petID)
C_PetJournal.PetIsLockedForConvert(petID)
C_PetJournal.PetIsRevoked(petID)
C_PetJournal.PetIsSlotted(petID)
C_PetJournal.PetIsSummonable(battlePetGUID) : isSummonable - Returns true if you can summon this pet.
C_PetJournal.PetIsTradable(petID) - Returns whether or not a pet from the Pet Journal is tradable.
C_PetJournal.PetIsUsable(petID)
C_PetJournal.PetNeedsFanfare()
C_PetJournal.PetUsesRandomDisplay(speciesID) : usesRandomDisplay
C_PetJournal.PickupPet(petID)
C_PetJournal.PickupSummonRandomPet()
C_PetJournal.ReleasePetByID(petID) - Releases the pet.
C_PetJournal.SetAbility(slotIndex, spellIndex, petSpellID)
C_PetJournal.SetAllPetSourcesChecked()
C_PetJournal.SetAllPetTypesChecked()
C_PetJournal.SetCustomName(petID, customName) - Sets a custom name for the pet.
C_PetJournal.SetDefaultFilters()
C_PetJournal.SetFavorite(petID, value) - Sets (or clears) the pet as a favorite.
C_PetJournal.SetFilterChecked()
C_PetJournal.SetPetLoadOutInfo(slotIndex, petID)
C_PetJournal.SetPetSortParameter()
C_PetJournal.SetPetSourceChecked()
C_PetJournal.SetPetTypeFilter(index, value) - Sets the pet type in the filter menu.
C_PetJournal.SetSearchFilter(text) - Sets the search filter in the pet journal.
NOCOMBAT C_PetJournal.SummonPetByGUID(petID) - Summons (or dismisses) a pet.
NOCOMBAT C_PetJournal.SummonRandomPet(allPets) - Summons a random battle pet companion.

Toy Box

The Toy Box was added in Patch 6.0.2

C_ToyBox.ForceToyRefilter()
C_ToyBox.GetCollectedShown()
C_ToyBox.GetIsFavorite(itemID)
C_ToyBox.GetNumFilteredToys()
C_ToyBox.GetNumLearnedDisplayedToys()
C_ToyBox.GetNumTotalDisplayedToys()
C_ToyBox.GetNumToys()
C_ToyBox.GetToyFromIndex(itemIndex)
C_ToyBox.GetToyInfo(itemID) - Returns toy info.
C_ToyBox.GetToyLink(itemID) - Returns the item link for a toy.
C_ToyBox.GetUncollectedShown()
C_ToyBox.GetUnusableShown()
C_ToyBox.HasFavorites()
C_ToyBox.IsExpansionTypeFilterChecked(expansionIndex)
C_ToyBox.IsSourceTypeFilterChecked(sourceIndex)
C_ToyBox.IsToyUsable(itemID)
C_ToyBox.PickupToyBoxItem(itemID)
C_ToyBox.SetAllExpansionTypeFilters([checked])
C_ToyBox.SetAllSourceTypeFilters(checked)
C_ToyBox.SetCollectedShown(checked)
C_ToyBox.SetExpansionTypeFilter(expansionIndex, checked)
C_ToyBox.SetFilterString(searchString)
C_ToyBox.SetIsFavorite(itemID, value)
C_ToyBox.SetSourceTypeFilter(sourceIndex, checked)
C_ToyBox.SetUncollectedShown(checked)
C_ToyBox.SetUnusableShown(checked)
C_ToyBoxInfo.ClearFanfare(itemID)
C_ToyBoxInfo.IsToySourceValid(source) : isToySourceValid
C_ToyBoxInfo.IsUsingDefaultFilters() : isUsingDefaultFilters
C_ToyBoxInfo.NeedsFanfare(itemID) : needsFanfare
C_ToyBoxInfo.SetDefaultFilters()
PlayerHasToy(itemID)
UseToy(itemID)
UseToyByName(toyName)

Heirlooms

Heirlooms were added in Patch 3.0.3 and added to the Collections window in Patch 6.1.0

C_Heirloom.CanHeirloomUpgradeFromPending(itemID)
C_Heirloom.CreateHeirloom(itemID)
C_Heirloom.GetClassAndSpecFilters()
C_Heirloom.GetCollectedHeirloomFilter()
C_Heirloom.GetHeirloomInfo(itemID)
C_Heirloom.GetHeirloomItemIDFromDisplayedIndex(heirloomIndex)
C_Heirloom.GetHeirloomItemIDs()
C_Heirloom.GetHeirloomLink(itemID)
C_Heirloom.GetHeirloomMaxUpgradeLevel(itemID)
C_Heirloom.GetHeirloomSourceFilter(source)
C_Heirloom.GetNumDisplayedHeirlooms()
C_Heirloom.GetNumHeirlooms()
C_Heirloom.GetNumKnownHeirlooms()
C_Heirloom.GetUncollectedHeirloomFilter()
C_Heirloom.IsItemHeirloom(itemID)
C_Heirloom.IsPendingHeirloomUpgrade()
C_Heirloom.PlayerHasHeirloom(itemID)
C_Heirloom.SetClassAndSpecFilters(classID, specID)
C_Heirloom.SetCollectedHeirloomFilter(boolean)
C_Heirloom.SetHeirloomSourceFilter(source, filtered)
C_Heirloom.SetSearch(searchValue)
C_Heirloom.SetUncollectedHeirloomFilter(boolean)
C_Heirloom.ShouldShowHeirloomHelp()
C_Heirloom.UpgradeHeirloom(itemID)
DoesItemContainSpec(item, classID [, specializationID])
C_HeirloomInfo.AreAllCollectionFiltersChecked() : areAllCollectionFiltersChecked
C_HeirloomInfo.AreAllSourceFiltersChecked() : areAllSourceFiltersChecked
C_HeirloomInfo.IsHeirloomSourceValid(source) : isHeirloomSourceValid
C_HeirloomInfo.IsUsingDefaultFilters() : isUsingDefaultFilters
C_HeirloomInfo.SetAllCollectionFilters(checked)
C_HeirloomInfo.SetAllSourceFilters(checked)
C_HeirloomInfo.SetDefaultFilters()

Appearances

The Appearances tab (also known as the Wardrobe) was added in Patch 7.0.3. See also Transmogrification functions.

C_TransmogCollection.AccountCanCollectSource(sourceID) : hasItemData, canCollect
C_TransmogCollection.AreAllCollectionTypeFiltersChecked() : areAllCollectionTypeFiltersChecked
C_TransmogCollection.AreAllSourceTypeFiltersChecked() : areAllSourceTypeFiltersChecked
C_TransmogCollection.CanAppearanceHaveIllusion(appearanceID) : canHaveIllusion
C_TransmogCollection.ClearNewAppearance(visualID)
C_TransmogCollection.ClearSearch(searchType) : completed
C_TransmogCollection.DeleteOutfit(outfitID)
C_TransmogCollection.EndSearch()
C_TransmogCollection.GetAllAppearanceSources(itemAppearanceID) : itemModifiedAppearanceIDs
C_TransmogCollection.GetAppearanceCameraID(itemAppearanceID [, variation]) : cameraID
C_TransmogCollection.GetAppearanceCameraIDBySource(itemModifiedAppearanceID [, variation]) : cameraID
C_TransmogCollection.GetAppearanceInfoBySource(itemModifiedAppearanceID) : info
C_TransmogCollection.GetAppearanceSourceDrops(itemModifiedAppearanceID) : encounterInfo
C_TransmogCollection.GetAppearanceSourceInfo(itemModifiedAppearanceID) : category, itemAppearanceID, canHaveIllusion, icon, isCollected, ...
C_TransmogCollection.GetAppearanceSources(appearanceID, categoryType, transmogLocation) : sources
C_TransmogCollection.GetArtifactAppearanceStrings(appearanceID) : name, hyperlink
C_TransmogCollection.GetCategoryAppearances(category, transmogLocation) : appearances
C_TransmogCollection.GetCategoryCollectedCount(category) : count
C_TransmogCollection.GetCategoryForItem(itemModifiedAppearanceID) : collectionCategory
C_TransmogCollection.GetCategoryInfo(category) : name, isWeapon, canHaveIllusions, canMainHand, canOffHand
C_TransmogCollection.GetCategoryTotal(category) : total
C_TransmogCollection.GetCollectedShown() : shown
C_TransmogCollection.GetFallbackWeaponAppearance() : appearanceID
C_TransmogCollection.GetIllusionInfo(illusionID) : info
C_TransmogCollection.GetIllusions() : illusions
C_TransmogCollection.GetIllusionStrings(illusionID) : name, hyperlink, sourceText
C_TransmogCollection.GetInspectItemTransmogInfoList() : list
C_TransmogCollection.GetIsAppearanceFavorite(itemAppearanceID) : isFavorite
C_TransmogCollection.GetItemInfo(itemInfo) : itemAppearanceID, itemModifiedAppearanceID
C_TransmogCollection.GetItemTransmogInfoListFromOutfitHyperlink(hyperlink) : list
C_TransmogCollection.GetLatestAppearance() : visualID, category
C_TransmogCollection.GetNumMaxOutfits() : maxOutfits
C_TransmogCollection.GetNumTransmogSources() : count
C_TransmogCollection.GetOutfitHyperlinkFromItemTransmogInfoList(itemTransmogInfoList) : hyperlink
C_TransmogCollection.GetOutfitInfo(outfitID) : name, icon
C_TransmogCollection.GetOutfitItemTransmogInfoList(outfitID) : list
C_TransmogCollection.GetOutfits() : outfitID
C_TransmogCollection.GetPairedArtifactAppearance(itemModifiedAppearanceID) : pairedItemModifiedAppearanceID
C_TransmogCollection.GetSourceIcon(itemModifiedAppearanceID) : icon
C_TransmogCollection.GetSourceInfo(sourceID) : sourceInfo
C_TransmogCollection.GetSourceItemID(itemModifiedAppearanceID) : itemID
C_TransmogCollection.GetSourceRequiredHoliday(itemModifiedAppearanceID) : holidayName
C_TransmogCollection.GetUncollectedShown() : shown
C_TransmogCollection.HasFavorites() : hasFavorites
C_TransmogCollection.IsAppearanceHiddenVisual(appearanceID) : isHiddenVisual
C_TransmogCollection.IsCategoryValidForItem(category, itemInfo) : isValid
C_TransmogCollection.IsNewAppearance(visualID) : isNew
C_TransmogCollection.IsSearchDBLoading() : isLoading
C_TransmogCollection.IsSearchInProgress(searchType) : inProgress
C_TransmogCollection.IsSourceTypeFilterChecked(index) : checked
C_TransmogCollection.IsUsingDefaultFilters() : isUsingDefaultFilters
C_TransmogCollection.ModifyOutfit(outfitID, itemTransmogInfoList)
C_TransmogCollection.NewOutfit(name, icon, itemTransmogInfoList) : outfitID
C_TransmogCollection.PlayerCanCollectSource(sourceID) : hasItemData, canCollect
C_TransmogCollection.PlayerHasTransmog(itemID [, itemAppearanceModID]) : hasTransmog
C_TransmogCollection.PlayerHasTransmogByItemInfo(itemInfo) : hasTransmog
C_TransmogCollection.PlayerHasTransmogItemModifiedAppearance(itemModifiedAppearanceID) : hasTransmog
C_TransmogCollection.PlayerKnowsSource(sourceID) : isKnown
C_TransmogCollection.RenameOutfit(outfitID, name)
C_TransmogCollection.SearchProgress(searchType) : progress
C_TransmogCollection.SearchSize(searchType) : size
C_TransmogCollection.SetAllCollectionTypeFilters(checked)
C_TransmogCollection.SetAllSourceTypeFilters(checked)
C_TransmogCollection.SetCollectedShown(shown)
C_TransmogCollection.SetDefaultFilters()
C_TransmogCollection.SetIsAppearanceFavorite(itemAppearanceID, isFavorite)
C_TransmogCollection.SetSearch(searchType, searchText) : completed
C_TransmogCollection.SetSearchAndFilterCategory(category)
C_TransmogCollection.SetSourceTypeFilter(index, checked)
C_TransmogCollection.SetUncollectedShown(shown)
C_TransmogCollection.UpdateUsableAppearances()
DEPRECATED C_TransmogCollection.CanSetFavoriteInCategory(categoryID)
DEPRECATED C_TransmogCollection.GetIllusionFallbackWeaponSource()
DEPRECATED C_TransmogCollection.GetIllusionSourceInfo(sourceID) : visualID, name, hyperlink, icon
DEPRECATED C_TransmogCollection.GetShowMissingSourceInItemTooltips()
DEPRECATED C_TransmogCollection.SetShowMissingSourceInItemTooltips(bool)
C_TransmogSets.ClearLatestSource()
C_TransmogSets.ClearNewSource(sourceID)
C_TransmogSets.ClearSetNewSourcesForSlot(transmogSetID, slot)
C_TransmogSets.GetAllSets() : sets
C_TransmogSets.GetAllSourceIDs(transmogSetID) : sources
C_TransmogSets.GetBaseSetID(transmogSetID) : baseTransmogSetID
C_TransmogSets.GetBaseSets() : sets
C_TransmogSets.GetBaseSetsCounts() : numCollected, numTotal
C_TransmogSets.GetBaseSetsFilter(index) : isChecked
C_TransmogSets.GetCameraIDs() : detailsCameraID, vendorCameraID
C_TransmogSets.GetIsFavorite(transmogSetID) : isFavorite, isGroupFavorite
C_TransmogSets.GetLatestSource() : sourceID
C_TransmogSets.GetSetInfo(transmogSetID) : set
C_TransmogSets.GetSetNewSources(transmogSetID) : sourceIDs
C_TransmogSets.GetSetPrimaryAppearances(transmogSetID) : apppearances
C_TransmogSets.GetSetsContainingSourceID(sourceID) : setIDs
C_TransmogSets.GetSourceIDsForSlot(transmogSetID, slot) : sources
C_TransmogSets.GetSourcesForSlot(transmogSetID, slot) : sources
C_TransmogSets.GetUsableSets() : sets
C_TransmogSets.GetVariantSets(transmogSetID) : sets
C_TransmogSets.HasUsableSets() : hasUsableSets
C_TransmogSets.IsBaseSetCollected(transmogSetID) : isCollected
C_TransmogSets.IsNewSource(sourceID) : isNew
C_TransmogSets.IsSetVisible(transmogSetID) : isVisible
C_TransmogSets.IsUsingDefaultBaseSetsFilters() : isUsingDefaultBaseSetsFilters
C_TransmogSets.SetBaseSetsFilter(index, isChecked)
C_TransmogSets.SetDefaultBaseSetsFilters()
C_TransmogSets.SetHasNewSources(transmogSetID) : hasNewSources
C_TransmogSets.SetHasNewSourcesForSlot(transmogSetID, slot) : hasNewSources
C_TransmogSets.SetIsFavorite(transmogSetID, isFavorite)
DEPRECATED C_TransmogSets.GetSetSources(setID)
IsUnitModelReadyForUI(unitToken) : isReady

Combat Log

Relates to the Combat Log.

CombatLogAddFilter([eList, sourceFlags, destFlags])
CombatLogAdvanceEntry(count [, ignoreFilter])
CombatLogClearEntries()
CombatLogGetCurrentEntry()
CombatLogGetCurrentEventInfo() - Returns the current COMBAT_LOG_EVENT payload.
CombatLogGetNumEntries()
CombatLogGetRetentionTime()
CombatLogResetFilter()
CombatLogSetCurrentEntry(index [, ignoreFilter])
CombatLogSetRetentionTime(seconds)
CombatLog_Object_IsA()
CombatTextSetActiveUnit(unit) - Changes the entity for which COMBAT_TEXT_UPDATE events fire.
GetCurrentCombatTextEventInfo()

Combat Pets

Relates to Combat Pets.

CancelPetPossess()
PROTECTED CastPetAction(index) - Cast the corresponding pet skill.
DisableSpellAutocast() - Disables autocasting for a pet spell.
EnableSpellAutocast() - Enables autocasting for a pet spell.
GetCallPetSpellInfo(spellID)
GetPetActionCooldown(index) - Returns cooldown info for an action on the pet action bar.
GetPetActionInfo(index) - Returns info for an action on the pet action bar.
GetPetActionSlotUsable(slot)
GetPetActionsUsable() - Returns a value indicating if the player's pet's actions can be used at this time.
GetPetExperience() - Returns the pet's current and total XP required for the next level.
GetPetFoodTypes() - Returns the food types the pet can eat.
GetPetIcon() - Returns the path to the texture to use as the icon for the player's pet.
GetPetTimeRemaining() - Returns in milliseconds about some timeout for the player's pet.
HasPetSpells() - Returns the number of available abilities for the player's combat pet.
HasPetUI() - True if the player currently has an active (hunter) pet out.
IsPetActive()
IsPetAttackActive() - True if the pet is currently auto attacking.
PetAbandon() - Permanently abandons your pet.
PROTECTED PetAggressiveMode()
PROTECTED PetAssistMode() - Set your pet to Assist mode.
PROTECTED PetAttack() - Instruct your pet to attack your target.
PetCanBeAbandoned() - True if the pet can be abandoned.
PROTECTED PetMoveTo(target)
PetCanBeDismissed()
PetCanBeRenamed() - True if the pet can be renamed.
PROTECTED PetDefensiveMode() - Set your pet in defensive mode.
PetDefensiveAssistMode()
PetDismiss() - Dismiss your pet.
PROTECTED PetFollow() - Instruct your pet to follow you.
PetHasSpellbook()
PROTECTED PetPassiveMode() - Set your pet into passive mode.
PetRename(name) - Renames your pet.
PetStopAttack() - Stops the pet from attacking.
PetUsesPetFrame()
PROTECTED PetWait() - Instruct your pet to remain still.
PROTECTED TogglePetAutocast(index) - Toggles whether the specified pet ability should autocast or not.
PROTECTED ToggleSpellAutocast(spellName | spellId, bookType) - Toggles whether the specified Pet spell should autocast or not.

Relates to the Stable Master.

ClosePetStables() - Closes the pet stable window.
GetStablePetFoodTypes(index) - Returns the food types the specified stabled pet can eat.
GetStablePetInfo(index) - Returns information about a specific stabled pet.
IsAtStableMaster()
SetPetSlot(index, slot)
SetPetStablePaperdoll(modelObject)

Controls

Action Bars

C_ActionBar.GetBonusBarIndexForSlot(slotID) : bonusBarIndex
C_ActionBar.IsHarmfulAction(actionID, useNeutral) : isHarmful
C_ActionBar.IsHelpfulAction(actionID, useNeutral) : isHelpful
C_ActionBar.IsOnBarOrSpecialBar(spellID) : isOnBarOrSpecialBar
C_ActionBar.PutActionInSlot(slotID)
C_ActionBar.ShouldOverrideBarShowHealthBar() : showHealthBar
C_ActionBar.ShouldOverrideBarShowManaBar() : showManaBar
NOCOMBAT ChangeActionBarPage(page) - Changes the current action bar page.
GetActionBarPage() - Returns the current action bar page.
GetActionBarToggles() - Returns the enabled states for the extra action bars.
GetBonusBarIndex()
GetBonusBarOffset() - Returns the current bonus action bar index (e.g. for the Rogue stealth bar).
GetExtraBarIndex()
GetMultiCastBarIndex()
GetOverrideBarIndex()
GetOverrideBarSkin()
GetTempShapeshiftBarIndex()
GetVehicleBarIndex()
HasBonusActionBar()
HasExtraActionBar()
HasOverrideActionBar()
HasTempShapeshiftActionBar()
HasVehicleActionBar()
IsPossessBarVisible()
PetHasActionBar() - Determine if player has a pet with an action bar.
SetActionBarToggles(show1, show2, show3, show4 [, alwaysShow]) - Sets the visible state for each action bar.

Action Buttons

C_ActionBar.FindPetActionButtons(petActionID) : slots
C_ActionBar.FindSpellActionButtons(spellID) : slots
C_ActionBar.GetPetActionPetBarIndices(petActionID) : slots
C_ActionBar.HasPetActionButtons(petActionID) : hasPetActionButtons
C_ActionBar.HasPetActionPetBarIndices(petActionID) : hasPetActionPetBarIndices
C_ActionBar.HasSpellActionButtons(spellID) : hasSpellActionButtons
C_ActionBar.IsAutoCastPetAction(slotID) : isAutoCastPetAction
C_ActionBar.IsEnabledAutoCastPetAction(slotID) : isEnabledAutoCastPetAction
C_ActionBar.ToggleAutoCastPetAction(slotID)
ActionHasRange(slot) - True if the action has has a range requirement.
ClickWorldMapActionButton()
GetActionAutocast(slot)
GetActionCharges(slot) - Returns information about the charges of a charge-accumulating player ability.
GetActionCooldown(slot) - Returns cooldown info for the specified action slot.
GetActionCount(slot) - Returns the available number of uses for an action.
GetActionInfo(slot) - Returns info for an action.
GetActionText(slot) - Returns the label text for an action.
GetActionTexture(slot) - Returns the icon texture for an action.
GetPossessInfo(index) - Returns info for an action on the possession bar.
GetWorldMapActionButtonSpellInfo()
HasAction(slot) - True if an action slot is occupied.
IsActionInRange(slot) - True if the specified action is in range.
IsAttackAction(slot) - True if an action is the "Auto Attack" action.
IsAutoRepeatAction(slot) - True if an action is currently auto-repeating (e.g. Shoot for wand and Auto Shot for Hunters).
IsConsumableAction(slot) - True if an action is a consumable, i.e. it has a count.
IsCurrentAction(slot) - True if the specified action is currently being used.
IsEquippedAction(slot) - True if the specified action slot is an equipped item.
IsItemAction(slot)
IsPetAttackAction(index)
IsStackableAction(slot)
IsUsableAction(slot) - True if the character can currently use the specified action (sufficient mana, reagents and not on cooldown).
SetActionUIButton(checkboxFrame, actionSlot, cooldownFrame)
SetSpellbookPetAction(slot, target)
PROTECTED UseAction(slot [, checkCursor, onSelf]) - Perform the action in the specified action slot.
UseWorldMapActionButtonSpellOnQuest()

Flyout Buttons

C_ActionBar.FindFlyoutActionButtons(flyoutID) : slots
C_ActionBar.HasFlyoutActionButtons(flyoutID) : hasFlyoutActionButtons
FindFlyoutSlotBySpellID(spellID)
FlyoutHasSpell(flyoutID, spellID)
GetFlyoutID(index)
GetFlyoutInfo(flyoutID)
GetFlyoutSlotInfo(flyoutID, slot)
GetNumFlyouts()

Key Bindings

Relates to Key Bindings.

C_KeyBindings.GetCustomBindingType(bindingIndex) : customBindingType - Returns the type of a custom binding.
GetBinding(index) - Returns the name and keys for a binding by index.
GetBindingAction(key [, checkOverride]) - Returns the binding name for a key (combination).
GetBindingByKey(action [, mode])
GetBindingKey(command) - [Returns the binding name for a key (combination). Discards key modifiers until it finds a binding.
GetBindingText([key, prefix, abbreviate]) - Returns the string for the given key and prefix. Essentially a specialized getglobal() for bindings.
GetCurrentBindingSet() - Returns if either account or character-specific bindings are active.
GetNumBindings() - Returns the number of bindings and headers in the key bindings window.
LoadBindings(which) - Loads default, account or character specific key bindings.
RunBinding(command [, up]) - Executes a key binding.
SaveBindings(which) - Saves account or character specific key bindings.
NOCOMBAT SetBinding(key [, command, mode]) - Sets a key binding to an action.
NOCOMBAT SetBindingSpell(key, spellName) - Sets a binding to cast the specified spell.
NOCOMBAT SetBindingClick(key, ButtonName [, mouseButton]) - Sets a binding to click the specified Button widget.
NOCOMBAT SetBindingItem(key, itemname)
NOCOMBAT SetBindingMacro(key, macroname or macroId)
NOCOMBAT SetOverrideBinding(owner, isPriority, key [, command]) - Sets an override key binding.
NOCOMBAT SetOverrideBindingSpell(owner, isPriority, key, spellname)
NOCOMBAT SetOverrideBindingClick(owner, isPriority, key, buttonName [, mouseClick]) - Sets an override binding that performs a button click.
NOCOMBAT SetOverrideBindingItem(owner, isPriority, key, itemname)
NOCOMBAT SetOverrideBindingMacro(owner, isPriority, key, macroname or macroId)
NOCOMBAT ClearOverrideBindings(owner) - Removes all override bindings owned by a specific frame.
SetMouselookOverrideBinding(key [, command])

Click Bindings

C_ClickBindings.CanSpellBeClickBound(spellID) : canBeBound
C_ClickBindings.ExecuteBinding(targetToken, button, modifiers)
C_ClickBindings.GetBindingType(button, modifiers) : type
C_ClickBindings.GetEffectiveInteractionButton(button, modifiers) : effectiveButton
C_ClickBindings.GetProfileInfo() : infoVec
C_ClickBindings.GetStringFromModifiers(modifiers) : modifierString
C_ClickBindings.GetTutorialShown() : tutorialShown
C_ClickBindings.MakeModifiers() : modifiers
C_ClickBindings.ResetCurrentProfile()
C_ClickBindings.SetProfileByInfo(infoVec)
C_ClickBindings.SetTutorialShown()

Key Modifiers

GetModifiedClick(action)
GetModifiedClickAction(index)
GetMouseButtonClicked() - Returns the mouse button responsible during an OnClick event (e.g. "RightButton").
GetNumModifiedClickActions()
IsAltKeyDown() - Returns true if the alt key is currently depressed.
IsControlKeyDown() - Returns true if the control key is currently depressed.
IsKeyDown(keyOrMouseName [, excludeCurrentBindingState])
IsLeftAltKeyDown() - Returns true if the left alt key is currently depressed.
IsLeftControlKeyDown() - Returns true if the left control key is currently depressed.
IsLeftMetaKeyDown()
IsLeftShiftKeyDown() - Returns true if the left shift key is currently depressed.
IsMetaKeyDown()
IsModifiedClick(action) - True if the modifier key needed for an an action is pressed.
IsModifierKeyDown() - True if any modifier key is currently pressed.
IsMouseButtonDown([button])
IsRightAltKeyDown() - Returns true if the right alt key is currently depressed.
IsRightControlKeyDown() - Returns true if the right control key is currently depressed.
IsRightMetaKeyDown()
IsRightShiftKeyDown() - Returns true if the right shift key is currently depressed.
IsShiftKeyDown() - Returns true if the shift key is currently depressed.
SetModifiedClick(action, binding)

Cursor

Relates to the Cursor.

C_CurrencyInfo.PickupCurrency(type)
AutoEquipCursorItem() - Equips the item currently held by the cursor.
ClearCursor() - Clears any objects from the cursor.
ClickSocketButton(id) - If the cursor is currently holding a gem, tentatively insert it into the socket.
CursorCanGoInSlot(invSlot) - True if the item held by the cursor can be equipped in the specified (equipment) inventory slot.
CursorHasItem() - True if the cursor currently holds an item.
CursorHasMacro() - Returns 1 if the cursor is currently dragging a macro.
CursorHasMoney() - Returns true if the cursor currently holds money.
CursorHasSpell() - Returns true if the cursor currently holds a spell.
HW, SCRIPT DeleteCursorItem() - Destroys the item held by the cursor.
DropCursorMoney() - Drops money held by the cursor back into your bag.
DropItemOnUnit(unit) - Drops an item from the cursor onto a unit, i.e. to initiate a trade.
EquipCursorItem(invSlot) - Equips the currently picked up item to a specific inventory slot.
GetCursorDelta()
GetCursorInfo() - Returns what the mouse cursor is holding.
GetCursorMoney() - Returns the amount of money held by the cursor.
GetCursorPosition() - Returns the cursor's position on the screen.
HideRepairCursor() - Takes the cursor out of repair mode.
InRepairMode() - True if the cursor is in repair mode.
PickupAction(slot) - Places an action onto the cursor.
PickupBagFromSlot(slot) - Picks up the bag from the specified slot, placing it in the cursor.
PickupCompanion(type, index) - Places a mount onto the cursor.
PickupContainerItem(bagID, slot)
PickupGuildBankItem(tab, slot) - Picks up an item from the guild bank.
PickupGuildBankMoney(money) - Picks up "money" copper from the guild bank.
PickupInventoryItem(invSlot) - Picks up / interacts with an equipment slot.
PickupItem(item)
PickupMacro(macroName or index) - Places a macro onto the cursor.
PickupMerchantItem(index) - Places a merchant item onto the cursor. If the cursor already has an item, it will be sold.
PickupPetAction(slot) - Places a pet action onto the cursor.
PickupPetSpell(spellID)
PickupPlayerMoney(copper) - Picks up an amount of money from the player onto the cursor.
PickupPvpTalent()
PickupSpell(spellID) - Places a spell onto the cursor.
PickupSpellBookItem(spellSlot)
PickupStablePet(index)
PickupTalent(talentID) - Grabs the selected talent spell for placement on an action bar.
PickupTradeMoney(copper) - Places an amount of money from the player's trade offer onto the cursor.
PlaceAction(slot) - Places an action onto into the specified action slot.
ResetCursor()
SellCursorItem()
SetCursor(cursor) - Sets the current cursor texture.
ShowBuybackSellCursor(index)
ShowContainerSellCursor(index, slot)
ShowInventorySellCursor()
ShowRepairCursor()

Camera

PROTECTED CameraOrSelectOrMoveStart() - Begin "Left click" in the 3D world.
PROTECTED CameraOrSelectOrMoveStop([stickyFlag]) - Called when you release the "Left-Click" mouse button.
CameraZoomIn(increment) - Zooms the camera in.
CameraZoomOut(increment) - Zooms the camera out.
CenterCamera()
FlipCameraYaw(degrees) - Rotates the camera around the Z-axis.
GetCameraZoom() - Returns the current zoom level of the camera.
IsMouselooking() - True if the player is currently in mouselook mode.
MouselookStart() - Enters mouse look mode; alters the character's movement/facing direction.
MouselookStop() - Exits mouse look mode.
MoveViewDownStart() - Starts rotating the camera downward.
MoveViewDownStop() - Stops rotating the camera downward.
MoveViewInStart() - Begins zooming the camera in.
MoveViewInStop() - Stops zooming the camera in.
MoveViewLeftStart() - Starts rotating the camera to the left.
MoveViewLeftStop() - Stops rotating the camera to the left.
MoveViewOutStart() - Begins zooming the camera out.
MoveViewOutStop() - Stops zooming the camera out.
MoveViewRightStart() - Starts rotating the camera to the right.
MoveViewRightStop() - Stops rotating the camera to the right.
MoveViewUpStart() - Starts rotating the camera upward.
MoveViewUpStop() - Stops rotating the camera upward.
PROTECTED PitchDownStart() - Begins pitching the camera Downward.
PROTECTED PitchDownStop() - Stops pitching the camera after PitchDownStart() is called.
PROTECTED PitchUpStart() - Begins pitching the camera Upward.
PROTECTED PitchUpStop() - Stops pitching the camera after PitchUpStart() is called.
NextView() - Cycles forward through the five predefined camera positions.
PrevView() - Cycles backward through the five predefined camera positions.
ResetView(index) - Resets the specified (1-5) predefined camera position to it's default if it was changed using SaveView(index).
SaveView(index) - Saves a camera angle. The last position loaded is stored in the CVar cameraView.
SetView(index) - Sets the camera to a predefined camera position (1-5).

Targeting

Relates to Targets.

PROTECTED AssistUnit(unit) - Assists the unit by targeting the same target.
PROTECTED ClearFocus() - Clears the focus target.
PROTECTED ClearTarget() - Clears the selected target.
PROTECTED FocusUnit(unit) - Sets the focus target.
IsReplacingUnit()
PROTECTED TargetDirectionEnemy(facing)
PROTECTED TargetDirectionFinished()
PROTECTED TargetDirectionFriend(facing)
PROTECTED TargetLastEnemy() - Targets the previously targeted enemy.
PROTECTED TargetLastFriend()
PROTECTED TargetLastTarget() - Selects the last target as the current target.
PROTECTED TargetNearestEnemy([reverseFlag]) - Selects the nearest enemy as the current target.
PROTECTED TargetNearestEnemyPlayer([reverseFlag]) - Selects the nearest enemy player as the current target.
PROTECTED TargetNearestFriend([reverseFlag]) - Targets the nearest friendly unit.
PROTECTED TargetNearestFriendPlayer([reverseFlag]) - Selects the nearest friendly player as the current target.
PROTECTED TargetNearest()
PROTECTED TargetNearestPartyMember() - Selects the nearest Party member as the current target.
PROTECTED TargetNearestRaidMember() - Selects the nearest Raid member as the current target.
PROTECTED TargetPriorityHighlightEnd()
PROTECTED TargetPriorityHighlightStart()
PROTECTED TargetUnit(unit [, exactMatch]) - Targets the specified unit.

Movement

Most of these functions may only be called on a hardware event from secure code.

PROTECTED AscendStop() - Called when the player releases the jump key.
PROTECTED AttackTarget() - Toggles auto-attacking of the current target.
PROTECTED DescendStop() - Stops descending while flying or swimming.
PROTECTED InteractUnit(unitToken [, exactMatch])
FollowUnit(unit) - Follows a friendly player unit.
IsPlayerMoving()
PROTECTED JumpOrAscendStart() - Makes the character jump or swim/fly upwards.
PROTECTED MoveAndSteerStart()
PROTECTED MoveAndSteerStop()
PROTECTED MoveBackwardStart() - The player begins moving backward at the specified time.
PROTECTED MoveBackwardStop() - The player stops moving backward at the specified time.
PROTECTED MoveForwardStart() - The player begins moving forward at the specified time.
PROTECTED MoveForwardStop() - The player stops moving forward at the specified time.
PROTECTED SetMoveEnabled()
PROTECTED SetTurnEnabled()
PROTECTED SitStandOrDescendStart() - Makes the player sit, stand, or descend (while swimming or flying).
PROTECTED StartAttack()
StopAttack() - Turns off auto-attack, if currently active.
PROTECTED StartAutoRun()
PROTECTED StopAutoRun()
PROTECTED StrafeLeftStart() - The player begins strafing left at the specified time.
PROTECTED StrafeLeftStop() - The player stops strafing left at the specified time.
PROTECTED StrafeRightStart() - The player begins strafing right at the specified time.
PROTECTED StrafeRightStop() - The player stops strafing right at the specified time.
PROTECTED ToggleAutoRun() - Turns auto-run on or off.
PROTECTED ToggleRun() - Toggle between running and walking.
PROTECTED TurnLeftStart() - Turns the player left at the specified time.
PROTECTED TurnLeftStop() - The player stops turning left at the specified time.
PROTECTED TurnOrActionStart() - Starts a "right click" in the 3D game world.
PROTECTED TurnOrActionStop() - Stops a "right click" in the 3D game world.
PROTECTED TurnRightStart() - Turns the player right at the specified time.
PROTECTED TurnRightStop() - The player stops turning right at the specified time.

Gamepad

Native gamepad support was added in Patch 9.0.1, where previously WoWmapper was needed.

C_GamePad.AddSDLMapping(platform, mapping) : success
C_GamePad.ApplyConfigs()
C_GamePad.AxisIndexToConfigName(axisIndex) : configName
C_GamePad.ButtonBindingToIndex(bindingName) : buttonIndex
C_GamePad.ButtonIndexToBinding(buttonIndex) : bindingName
C_GamePad.ButtonIndexToConfigName(buttonIndex) : configName
C_GamePad.ClearLedColor()
C_GamePad.DeleteConfig(configID)
C_GamePad.GetActiveDeviceID() : deviceID
C_GamePad.GetAllConfigIDs() : configIDs
C_GamePad.GetAllDeviceIDs() : deviceIDs
C_GamePad.GetCombinedDeviceID() : deviceID
C_GamePad.GetConfig(configID) : config
C_GamePad.GetDeviceMappedState([deviceID]) : state
C_GamePad.GetDeviceRawState(deviceID) : rawState
C_GamePad.GetLedColor() : color
C_GamePad.GetPowerLevel([deviceID]) : powerLevel
C_GamePad.IsEnabled() : enabled
C_GamePad.SetConfig(config)
C_GamePad.SetLedColor(color)
C_GamePad.SetVibration(vibrationType, intensity)
C_GamePad.StickIndexToConfigName(stickIndex) : configName
C_GamePad.StopVibration()
CanAutoSetGamePadCursorControl()
CanGamePadControlCursor()
IsBindingForGamePad(KEY)
IsGamePadCursorControlEnabled()
IsGamePadFreelookEnabled()
SetGamePadCursorControl()
SetGamePadFreeLook()

Currency

Currencies were added in Patch 3.0.2.

C_CurrencyInfo.DoesWarModeBonusApply(currencyID) : warModeApplies, limitOncePerTooltip
C_CurrencyInfo.ExpandCurrencyList(index, expand) - Expands/collapses a currency list header.
C_CurrencyInfo.GetAzeriteCurrencyID() : azeriteCurrencyID
C_CurrencyInfo.GetBackpackCurrencyInfo(index) : info - Returns info for a tracked currency in the backpack.
C_CurrencyInfo.GetBasicCurrencyInfo(currencyType [, quantity]) : info
C_CurrencyInfo.GetCurrencyContainerInfo(currencyType, quantity) : info
C_CurrencyInfo.GetCurrencyIDFromLink(currencyLink) : currencyID
C_CurrencyInfo.GetCurrencyInfo(type) : info - Returns info for a currency by ID.
C_CurrencyInfo.GetCurrencyInfoFromLink(link) : info - Returns information about currencies from a link.
C_CurrencyInfo.GetCurrencyLink(type [, amount]) : link - Returns a currency link.
C_CurrencyInfo.GetCurrencyListInfo(index) : info - Returns info for a currency in the currency tab.
C_CurrencyInfo.GetCurrencyListLink(index) : link
C_CurrencyInfo.GetCurrencyListSize() : currencyListSize - Returns the amount of currencies and headers in the currency tab.
C_CurrencyInfo.GetFactionGrantedByCurrency(currencyID) : factionID - Gets the faction ID for currency that is immediately converted into reputation with that faction instead.
C_CurrencyInfo.GetWarResourcesCurrencyID() : warResourceCurrencyID
C_CurrencyInfo.IsCurrencyContainer(currencyID, quantity) : isCurrencyContainer
C_CurrencyInfo.SetCurrencyBackpack(index, backpack) - Tracks a currency in the backpack.
C_CurrencyInfo.SetCurrencyUnused(index, unused) - Marks a currency as unused in the currency tab.
C_Item.GetLimitedCurrencyItemInfo(itemInfo) : name, icon, quantity, maxQuantity, totalEarned
GetCoinText(amount, separator) - Breaks up an amount of money into gold/silver/copper.
GetCoinTextureString(amount [, fontHeight]) - Breaks up an amount of money into gold/silver/copper with icons.
GetPlayerTradeCurrency()
GetTargetTradeCurrency()
SetTradeCurrency(type, amount)
UI GetNumWatchedTokens() - Returns the number of currently watched currencies.

Customer Support

Relates to Customer Support.

AcknowledgeSurvey(caseIndex)
PROTECTED DeleteGMTicket()
GetWebTicket()
GMEuropaBugsEnabled()
GMEuropaComplaintsEnabled()
GMEuropaSuggestionsEnabled()
GMEuropaTicketsEnabled()
GMItemRestorationButtonEnabled()
GMQuickTicketSystemEnabled()
GMQuickTicketSystemThrottled()
GMReportLag()
GMRequestPlayerInfo()
GMResponseResolve()
C_UserFeedback.SubmitBug(bugInfo [, suppressNotification]) : success
C_UserFeedback.SubmitSuggestion(suggestion) : success
GMSurveyAnswerSubmit(question, rank, comment)
GMSurveyAnswer()
GMSurveyCommentSubmit(comment)
GMSurveyNumAnswers()
GMSurveyQuestion()
GMSurveySubmit()
GetGMStatus()
GetGMTicket()
RegisterStaticConstants(table) - Populates the STATIC_CONSTANTS table for GetGMTicketCategories.
ReportBug(description)
ReportSuggestion(description)

Knowledge Base

KBArticle_BeginLoading(articleId, searchType) - Starts the article loading process.
KBArticle_GetData() - Returns information about the current article.
KBArticle_IsLoaded() - Returns true if an article is loaded.
KBQuery_BeginLoading(searchText, categoryIndex, subcategoryIndex, articlesPerPage, curPage) - Starts a query for articles.
KBQuery_GetArticleHeaderCount() - Returns the number of article headers in the current query.
KBQuery_GetArticleHeaderData(index) - Returns information about an article header of the current query.
KBQuery_GetTotalArticleCount() - Returns the total number of articles that matches the current query.
KBQuery_IsLoaded() - Returns true if a query loaded successfuly.
KBSetup_BeginLoading(articlesPerPage, curPage) - Starts the loading process for the KB start page.
KBSetup_GetArticleHeaderCount() - Returns the number of articles for the current page.
KBSetup_GetArticleHeaderData(index) - Returns information for an article header.
KBSetup_GetCategoryCount() - Returns the number of categories in the knowledge base.
KBSetup_GetCategoryData(index) - Returns information about a category.
KBSetup_GetLanguageCount() - Returns the number of languages in the knowledge base.
KBSetup_GetLanguageData(index) - Returns information about a language.
KBSetup_GetSubCategoryCount(category) - Returns the number of subcategories for a category.
KBSetup_GetSubCategoryData(category, index) - Returns information about a subcategory.
KBSetup_GetTotalArticleCount() - Returns the total number of articles in the knowlege base.
KBSetup_IsLoaded() - Returns true if the knowledge base is loaded successfuly.
KBSystem_GetMOTD() - Returns the server message of the day.
KBSystem_GetServerNotice() - Returns the server notice.
KBSystem_GetServerStatus() - Returns the server status text.

Expansions

Relates to Expansions.

CanUpgradeExpansion() : canUpgradeExpansion
DoesCurrentLocaleSellExpansionLevels() : regionSellsExpansions
GetAccountExpansionLevel() : expansionLevel - Returns the expansion level the account has been flagged for.
GetClientDisplayExpansionLevel() : expansionLevel - Returns the expansion level of the game client.
GetExpansionDisplayInfo(expansionLevel) : info
GetExpansionForLevel(playerLevel) : expansionLevel
GetExpansionLevel() : expansionLevel - Returns the expansion level currently accessible by the player.
GetExpansionTrialInfo() : isExpansionTrialAccount, expansionTrialRemainingSeconds
GetMaximumExpansionLevel() : expansionLevel
GetMaxLevelForExpansionLevel(expansionLevel) : maxLevel
GetMaxLevelForLatestExpansion() : maxLevel
GetMaxLevelForPlayerExpansion() : maxLevel
GetMaxPlayerLevel()
GetMinimumExpansionLevel() : expansionLevel
GetNumExpansions() : numExpansions
GetServerExpansionLevel() : serverExpansionLevel - Returns the expansion level currently active on the server.
IsExpansionTrial() : isExpansionTrialAccount
C_LevelSquish.ConvertFollowerLevel(level, maxFollowerLevel) : squishedLevel
C_LevelSquish.ConvertPlayerLevel(level) : squishedLevel

Chromie Time

Timewalking Campaigns scale older expansion zones up to level 50.

C_ChromieTime.CloseUI()
C_ChromieTime.GetChromieTimeExpansionOption(expansionRecID) : info
C_ChromieTime.GetChromieTimeExpansionOptions() : expansionOptions
C_ChromieTime.SelectChromieTimeOption(chromieTimeExpansionInfoId)
C_PlayerInfo.CanPlayerEnterChromieTime() : canEnter
C_PlayerInfo.IsPlayerInChromieTime() : inChromieTime
UnitChromieTimeID(unit) : ID

Friends

Relates to the Friends list.

NOSCRIPT C_FriendList.AddFriend(name [, notes]) - Adds a friend to your friend list.
C_FriendList.AddIgnore(name) : added - Adds a player to your ignore list.
C_FriendList.AddOrDelIgnore(name) - Adds or removes a player to/from the ignore list.
C_FriendList.AddOrRemoveFriend(name, notes) - Adds or removes a player to or from the friends list.
C_FriendList.DelIgnore(name) : removed - Removes a player from your ignore list.
C_FriendList.DelIgnoreByIndex(index) - Removes a player from your ignore list.
C_FriendList.GetFriendInfo(name) : info - Retrieves information about a person on your friends list.
C_FriendList.GetFriendInfoByIndex(index) : info - Retrieves information about a person on your friends list.
C_FriendList.GetIgnoreName(index) : name - Returns the name of a currently ignored player.
C_FriendList.GetNumFriends() : numFriends - Returns how many friends you have.
C_FriendList.GetNumIgnores() : numIgnores - Returns the number of entries on your ignore list.
C_FriendList.GetNumOnlineFriends() : numOnline - Returns the number of online friends.
C_FriendList.GetSelectedFriend() : index - Returns the index of the currently selected friend.
C_FriendList.GetSelectedIgnore() : index - Returns the currently selected index in the ignore listing.
C_FriendList.IsFriend(guid) : isFriend - Returns whether a character is your friend.
C_FriendList.IsIgnored(token) : isIgnored - Returns whether a character is being ignored by you.
C_FriendList.IsIgnoredByGuid(guid) : isIgnored - Returns whether a character is being ignored by you.
C_FriendList.IsOnIgnoredList(token) : isIgnored
C_FriendList.RemoveFriend(name) : removed - Removes a friend from the friends list.
C_FriendList.RemoveFriendByIndex(index) - Removes a friend from the friends list.
C_FriendList.SetFriendNotes(name, notes) : found - Sets the note text for a friend.
C_FriendList.SetFriendNotesByIndex(index, notes) - Sets the note text for a friend.
C_FriendList.SetSelectedFriend(index) - Updates the current selected friend.
C_FriendList.SetSelectedIgnore(index) - Sets the currently selected ignore entry.
C_FriendList.ShowFriends() - Requests updated friends information from server.

Who List

Relates to the Who List.

C_FriendList.GetNumWhoResults() : numWhos, totalNumWhos - Get the number of entries resulting from your most recent /who query.
C_FriendList.GetWhoInfo(index) : info - Retrieves info about a character on your current /who list.
HW C_FriendList.SendWho(filter) - Requests a list of other online players.
C_FriendList.SetWhoToUi(whoToUi) - Sets how the result of a /who request will be delivered.
C_FriendList.SortWho(sorting) - Sorts the last /who reply received by the client.

Battle.net

Real ID friends were added in Patch 3.3.5

C_BattleNet.GetAccountInfoByID(id [, wowAccountGUID]) : accountInfo - Returns information about a Battle.net friend account.
C_BattleNet.GetAccountInfoByGUID(guid) : accountInfo
C_BattleNet.GetFriendAccountInfo(friendIndex [, wowAccountGUID]) : accountInfo
C_BattleNet.GetGameAccountInfoByID(id) : gameAccountInfo - Returns information on the game the Battle.net friend is playing.
C_BattleNet.GetGameAccountInfoByGUID(guid) : gameAccountInfo
C_BattleNet.GetFriendGameAccountInfo(friendIndex, accountIndex) : gameAccountInfo
C_BattleNet.GetFriendNumGameAccounts(friendIndex) : numGameAccounts - Returns the number of game accounts for the Battle.net friend.
C_AccountInfo.GetIDFromBattleNetAccountGUID(battleNetAccountGUID) : battleNetAccountID
C_AccountInfo.IsGUIDBattleNetAccountType(guid) : isBNet
C_AccountInfo.IsGUIDRelatedToLocalAccount(guid) : isLocalUser
BNAcceptFriendInvite(ID)
BNCheckBattleTagInviteToGuildMember(fullname)
BNCheckBattleTagInviteToUnit(unit)
BNConnected() - True if the WoW Client is connected to Battle.net.
BNDeclineFriendInvite(ID)
BNFeaturesEnabledAndConnected()
BNFeaturesEnabled()
BNGetBlockedInfo(index)
BNGetDisplayName(bnetIdAccount)
BNGetFOFInfo(mutual, nonMutual, index) - Returns info for the specified friend of a Battle.net friend.
BNGetFriendIndex(presenceID)
BNGetFriendInviteInfo(menuValue) - Returns info for a Battle.net friend invite.
BNGetInfo() - Returns the player's own Battle.net info.
BNGetNumBlocked()
BNGetNumFOF(ID, mutual, non)
BNGetNumFriendInvites()
BNGetNumFriends() - Returns the amount of (online) Battle.net friends.
BNGetSelectedBlock()
BNGetSelectedFriend()
BNInviteFriend(bnetIDGameAccount)
BNIsBlocked(ID)
BNIsFriend(presenceID)
BNIsSelf(presenceID) - Returns true if the specified presenceID is your own, false otherwise.
BNRemoveFriend(ID)
BNRequestFOFInfo(bnetIDAccount)
BNRequestInviteFriend(presenceID [, tank, heal, dps])
BNSendFriendInviteByID(ID, noteText)
BNSendFriendInvite(text, noteText)
BNSendGameData(id, addonPrefix, text) - Sends an addon comm message to a Battle.net friend.
BNSendSoR(target, comment)
BNSendVerifiedBattleTagInvite() - Unit should have been set with BNCheckBattleTagInviteToUnit or BNCheckBattleTagInviteToGuildMember.
BNSendWhisper(id, text)
BNSetAFK(bool) - Sets the player's online AFK status.
BNSetBlocked(ID, bool)
BNSetCustomMessage(text)
BNSetDND(bool) - Sets the player's online DND status.
BNSetFriendFavoriteFlag(id, isFavorite) - Favorites a Battle.net friend.
BNSetFriendNote(ID, noteText)
BNSetSelectedBlock(index)
BNSetSelectedFriend(index)
BNSummonFriendByIndex(id)
BNTokenFindName(target)
GetAutoCompletePresenceID(name)
IsBNLogin()

Recruit-a-Friend

Recruit-A-Friend was reworked in Patch 8.2.5

C_RecruitAFriend.ClaimActivityReward(activityID, acceptanceID) : success
C_RecruitAFriend.ClaimNextReward() : success
C_RecruitAFriend.GenerateRecruitmentLink() : success
C_RecruitAFriend.GetRAFInfo() : info
C_RecruitAFriend.GetRAFSystemInfo() : systemInfo
C_RecruitAFriend.GetRecruitActivityRequirementsText(activityID, acceptanceID) : requirementsText
C_RecruitAFriend.GetRecruitInfo() : active, faction
C_RecruitAFriend.IsEnabled() : enabled
C_RecruitAFriend.IsRecruitingEnabled() : enabled
C_RecruitAFriend.RemoveRAFRecruit(wowAccountGUID) : success
C_RecruitAFriend.RequestUpdatedRecruitmentInfo() : success
CanSummonFriend(unit) - Returns whether you can RaF summon a particular unit.
GetSummonFriendCooldown() - Returns the cooldown info of the RaF Summon Friend ability.
IsRecruitAFriendLinked()
SelectedRealmName() - Returns the realm name that will be used in Recruit-a-Friend invitations.
SummonFriend(unit) - Summons a player using the RaF system.

Mentor System

Newcomer Guides were added in Patch 9.0.1

C_PlayerMentorship.GetMentorLevelRequirement() : level
C_PlayerMentorship.GetMentorRequirements() : achievementIDs, optionalAchievementIDs, ...
C_PlayerMentorship.GetMentorshipStatus(playerLocation) : status
C_PlayerMentorship.IsActivePlayerConsideredNewcomer() : isConsideredNewcomer
C_PlayerMentorship.IsMentorRestricted() : isRestricted

Groups

C_PartyInfo.AllowedToDoPartyConversion(toRaid) : allowed
C_PartyInfo.CanInvite() : allowedToInvite
C_PartyInfo.ConfirmConvertToRaid()
C_PartyInfo.ConfirmInviteTravelPass(targetName, targetGUID)
C_PartyInfo.ConfirmInviteUnit(targetName)
C_PartyInfo.ConfirmLeaveParty([category])
C_PartyInfo.ConvertToParty() - Converts a raid group with 5 or less members to a party.
C_PartyInfo.ConvertToRaid() - Converts a party to a raid.
C_PartyInfo.DoCountdown(seconds)
C_PartyInfo.GetMinLevel([category]) : minLevel
C_PartyInfo.InviteUnit(targetName) - Invites a player to your group.
C_PartyInfo.IsPartyFull([category]) : isFull
C_PartyInfo.LeaveParty([category]) - Leaves the group.
AcceptGroup() - Accepts the invitation from a group.
ConfirmReadyCheck(isReady) - Responds to a ready check.
DeclineGroup() - Decline the invitation to a party.
DoReadyCheck() - Initiates a ready check.
GetHomePartyInfo()
GetInviteConfirmationInfo(guid)
GetNextPendingInviteConfirmation()
GetNumGroupMembers([groupType]) - Returns the number of players in the group.
GetNumSubgroupMembers([groupType]) - Returns the number of other players in the party or raid subgroup.
GetPendingInviteConfirmations()
GetReadyCheckStatus(unit) - Returns a group member's response to the current ready check.
GetReadyCheckTimeLeft()
InGuildParty()
IsGUIDInGroup(guid [, groupType])
IsInGroup([groupType]) - True if the player is in a group.
IsInGuildGroup()
IsInRaid([groupType]) - True if the player is in a raid.
PromoteToLeader(unit) - Promotes a unit to group leader.
RespondToInviteConfirmation(guid, accept)
HW UninviteUnit(name [, reason]) - Removes a player from the group if you're the leader, or initiates a vote to kick.
UnitInAnyGroup()
UnitInParty(unit) - True if the unit is a member of your party.
UnitIsGroupLeader(unit [, partyCategory]) - Returns whether the unit is the leader of a party or raid.

Cross Realm

C_PartyInfo.CanFormCrossFactionParties() : canFormCrossFactionParties
C_PartyInfo.IsCrossFactionParty([category]) : isCrossFactionParty

Raid Groups

ClearPartyAssignment()
DemoteAssistant(unit) - Demotes player from assistant status. Requires raid leadership.
GetAllowLowLevelRaid() - Returns whether joining low-level raids is enabled for the current character.
GetPartyAssignment(assignment [, unit, exactMatch]) - True if a group member is assigned the main tank/assist role.
GetRaidRosterInfo(index) - Returns info for a member of your raid.
InitiateRolePoll()
IsEveryoneAssistant()
PromoteToAssistant(unit) - Promotes player to assistant status. Requires raid leadership.
SetAllowLowLevelRaid(allowed) - Controls whether the current character can join low-level raids.
SetEveryoneIsAssistant()
PROTECTED SetPartyAssignment(assignment, player)
NOCOMBAT SetRaidSubgroup(index, subgroup) - Move a raid member from his current subgroup into a different (non-full) subgroup.
NOCOMBAT SwapRaidSubgroup(index1, index2) - Swaps two raid members into different groups.
UnitInRaid(unit) - Returns the index if the unit is in your raid group.
UnitInSubgroup()

Relates to Raid Targets and World Markers.

CanBeRaidTarget(unit) - True if the unit can be marked with a raid target icon.
ClearRaidMarker(index) - Removes a raid marker from the world.
GetRaidTargetIndex(unit) - Returns the raid target of a unit.
IsRaidMarkerActive(index) - Returns whether or not the raid marker specified by index is active.
PROTECTED PlaceRaidMarker(index) - Brings up a targeting circle to place a raid marker in the world.
SetRaidTarget(unit, index) - Assigns a raid target icon to a unit.
SetRaidTargetProtected(unit, index)
UI SetRaidTargetIcon(unit, index) - Sets or resets a raid icon on a unit.

Raid Profiles

CreateNewRaidProfile(name [, baseOnProfile])
DeleteRaidProfile(profile)
GetMaxNumCUFProfiles()
GetNumRaidProfiles()
GetRaidProfileFlattenedOptions(profile)
GetRaidProfileName(index)
GetRaidProfileOption(profile, optionName)
GetRaidProfileSavedPosition(profile)
HasLoadedCUFProfiles()
RaidProfileExists(profile)
RaidProfileHasUnsavedChanges()
RestoreRaidProfileFromCopy()
SaveRaidProfileCopy(profile)
SetRaidProfileOption(profile, optionName, value)
SetRaidProfileSavedPosition(profile, isDynamic, topPoint, topOffset, bottomPoint, bottomOffset, leftPoint, leftOffset)

Party Sync

Party Sync was added in Patch 8.2.5

C_LevelLink.IsActionLocked(actionID) : isLocked
C_LevelLink.IsSpellLocked(spellID) : isLocked
C_QuestLog.IsQuestDisabledForSession(questID) : isDisabled
C_QuestLog.IsQuestReplayable(questID) : isReplayable
C_QuestLog.IsQuestReplayedRecently(questID) : recentlyReplayed
C_QuestLog.QuestHasQuestSessionBonus(questID) : hasBonus
C_QuestSession.CanStart() : allowed
C_QuestSession.CanStop() : allowed
C_QuestSession.Exists() : exists
C_QuestSession.GetAvailableSessionCommand() : command
C_QuestSession.GetPendingCommand() : command
C_QuestSession.GetProposedMaxLevelForSession() : proposedMaxLevel
C_QuestSession.GetSessionBeginDetails() : details
C_QuestSession.GetSuperTrackedQuest() : questID
C_QuestSession.HasJoined() : hasJoined
C_QuestSession.HasPendingCommand() : hasPendingCommand
C_QuestSession.RequestSessionStart()
C_QuestSession.RequestSessionStop()
C_QuestSession.SendSessionBeginResponse(beginSession)
C_QuestSession.SetQuestIsSuperTracked(questID, superTrack)
ConfirmBNRequestInviteFriend(presenceID [, tank, heal, dps])

Group Finder

The Looking For Group tool was added in Patch 2.0.1. It was renamed to the Dungeon Finder in Patch 3.3.0 and raid queuing moved to a separate Raid Browser. The Raid Finder was added in Patch 4.3.0 and merged into the Dungeon Finder in Patch 5.0.4. The Dungeon Finder was reworked in Patch 6.0.2 into the Group Finder.

C_LFGInfo.CanPlayerUseGroupFinder() : canUse, failureReason
C_LFGInfo.CanPlayerUseLFD() : canUse, failureReason
C_LFGInfo.CanPlayerUseLFR() : canUse, failureReason
C_LFGInfo.CanPlayerUsePremadeGroup() : canUse, failureReason
C_LFGInfo.CanPlayerUsePVP() : canUse, failureReason
C_LFGInfo.ConfirmLfgExpandSearch()
C_LFGInfo.GetAllEntriesForCategory(category) : lfgDungeonIDs
C_LFGInfo.GetDungeonInfo(lfgDungeonID) : dungeonInfo
C_LFGInfo.GetLFDLockStates() : lockInfo
C_LFGInfo.GetRoleCheckDifficultyDetails() : maxLevel, isLevelReduced
C_LFGInfo.HideNameFromUI(dungeonID) : shouldHide
AcceptProposal() - Enters the Dungeon if the LFG queue is ready.
GetDungeonForRandomSlot(randomID, index)
GetGroupMemberCounts()
GetNumDungeonForRandomSlot(randomID)
GetNumRandomDungeons() - Returns the number of specific dungeons that can be queued for.
GetRandomDungeonBestChoice() - Returns the suggested random dungeon ID.
GroupHasOfflineMember()
IsAllowedToUserTeleport()
IsServerControlledBackfill()
RejectProposal() - Declines a LFG invite and leaves the queue.
RequestBattlegroundInstanceInfo(index) - Requests the available instances of a battleground.

LFGList

C_LFGList.AcceptInvite(resultID)
C_LFGList.ApplyToGroup(resultID, comment, tank, healer, dps)
C_LFGList.CanActiveEntryUseAutoAccept() : canUseAutoAccept
C_LFGList.CancelApplication(resultID)
C_LFGList.CanCreateQuestGroup(questID) : canCreate
C_LFGList.ClearApplicationTextFields()
C_LFGList.ClearCreationTextFields()
C_LFGList.ClearSearchResults()
C_LFGList.ClearSearchTextFields()
C_LFGList.CopyActiveEntryInfoToCreationFields()
HW C_LFGList.CreateListing(activityID, itemLevel, honorLevel [, autoAccept, privateGroup, questID]) - Creates a group finder listing.
C_LFGList.DeclineApplicant(applicantID)
C_LFGList.DeclineInvite(searchResultID)
C_LFGList.DoesEntryTitleMatchPrebuiltTitle(activityID, groupID [, playstyle]) : matches
C_LFGList.GetActiveEntryInfo() : entryData - Returns information about your currently listed group.
C_LFGList.GetActivityFullName(activityID [, questID, showWarmode]) : fullName
C_LFGList.GetActivityGroupInfo(groupID) : name, orderIndex - Returns info for an activity group.
C_LFGList.GetActivityIDForQuestID(questID)
C_LFGList.GetActivityInfoExpensive(activityID) - Returns the zone associated with an activity.
C_LFGList.GetActivityInfoTable(activityID [, questID, showWarmode]) : activityInfo
C_LFGList.GetApplicantDungeonScoreForListing(localID, applicantIndex, activityID) : bestDungeonScoreForListing
C_LFGList.GetApplicantInfo(applicantID) : applicantData - Returns status informations and custom message of an applicant.
C_LFGList.GetApplicantMemberInfo(applicantID) - Returns info for an applicant.
C_LFGList.GetApplicantMemberStats(applicantID) - Returns the Proving Grounds stats of an applicant.
C_LFGList.GetApplicantPvpRatingInfoForListing(localID, applicantIndex, activityID) : pvpRatingInfo
C_LFGList.GetApplicants() - Returns the list of applicants to your group.
C_LFGList.GetApplicationInfo(searchResultID)
C_LFGList.GetApplications()
C_LFGList.GetAvailableActivities([categoryID, groupID, filter]) - Returns a list of available LFG activities.
C_LFGList.GetAvailableActivityGroups(categoryID [, filter]) - Returns a list of available LFG groups.
C_LFGList.GetAvailableCategories([filter]) - Returns a list of available LFG categories.
C_LFGList.GetAvailableLanguageSearchFilter()
C_LFGList.GetAvailableRoles()
C_LFGList.GetDefaultLanguageSearchFilter()
C_LFGList.GetFilteredSearchResults() : totalResultsFound, filteredResults
C_LFGList.GetKeystoneForActivity(activityID) : level
C_LFGList.GetLanguageSearchFilter()
C_LFGList.GetLfgCategoryInfo(categoryID) : categoryData
C_LFGList.GetNumApplicants()
C_LFGList.GetNumApplications()
C_LFGList.GetNumInvitedApplicantMembers()
C_LFGList.GetNumPendingApplicantMembers()
C_LFGList.GetOwnedKeystoneActivityAndGroupAndLevel([getTimewalking]) : activityID, groupID, keystoneLevel
C_LFGList.GetPlaystyleString(playstyle, activityInfo) : playstyleString
C_LFGList.GetRoleCheckInfo()
C_LFGList.GetSearchResultEncounterInfo(searchResultID)
C_LFGList.GetSearchResultFriends(searchResultID)
C_LFGList.GetSearchResultInfo(searchResultID) : searchResultData
C_LFGList.GetSearchResultMemberCounts(searchResultID)
C_LFGList.GetSearchResultMemberInfo(searchResultID, memberIndex)
C_LFGList.GetSearchResults() : totalResultsFound, results
C_LFGList.HasActiveEntryInfo() : hasActiveEntryInfo
C_LFGList.HasActivityList()
C_LFGList.HasSearchResultInfo(searchResultID) : hasSearchResultInfo
C_LFGList.InviteApplicant(applicantID)
C_LFGList.IsCurrentlyApplying()
C_LFGList.IsPlayerAuthenticatedForLFG([activityID]) : isAuthenticated
C_LFGList.RefreshApplicants()
C_LFGList.RemoveApplicant(applicantID)
C_LFGList.RemoveListing()
C_LFGList.RequestAvailableActivities()
C_LFGList.SaveLanguageSearchFilter(enabled)
C_LFGList.Search(categoryID [, filter, preferredFilters, languageFilter, searchCrossFactionListings])
C_LFGList.SetApplicantMemberRole(applicantID, memberIndex, role)
C_LFGList.SetEntryTitle(activityID, groupID [, playstyle])
C_LFGList.SetSearchToActivity(activityID)
C_LFGList.SetSearchToQuestID(questID)
C_LFGList.UpdateListing(lfgID, itemLevel, honorLevel, autoAccept, private [, questID])
C_LFGList.ValidateRequiredDungeonScore(dungeonScore) : passes
C_LFGList.ValidateRequiredPvpRatingForActivity(activityID, rating) : passes
DEPRECATED C_LFGList.GetActivityInfo(activityID) - Returns information about an activity for premade groups.
DEPRECATED C_LFGList.GetCategoryInfo(categoryID) - Returns information about a specific category.

LFG

LFG is used for for generic functions/values that may be used for LFD, LFR, and any other LF_ system we may implement in the future.[1]

CanPartyLFGBackfill() - Returns whether the party is eligible to recruit additional members from the LFG pool.
ClearAllLFGDungeons(category)
CompleteLFGReadyCheck(isReady)
CompleteLFGRoleCheck(isReady) - Returns true if the role check was successful.
GetLFGBootProposal() - Returns info for a LFG votekick in progress.
GetLFGCategoryForID(partySlot)
GetLFGCompletionReward()
GetLFGCompletionRewardItem(rewardIndex)
GetLFGCompletionRewardItemLink(rewardIndex)
GetLFGDeserterExpiration() - Returns the time at which you may once again use the dungeon finder after prematurely leaving a group.
GetLFGDungeonEncounterInfo(dungeonID, encounterIndex)
GetLFGDungeonInfo(dungeonID) - Returns info for a LFG dungeon.
GetLFGDungeonNumEncounters(dungeonID)
GetLFGDungeonRewardCapBarInfo(dungeonID) - Returns the weekly limits reward for a currency (e.g. Valor Point Cap).
GetLFGDungeonRewardCapInfo(dungeonID)
GetLFGDungeonRewardInfo(dungeonID, rewardIndex)
GetLFGDungeonRewardLink(dungeonID, rewardIndex)
GetLFGDungeonRewards(dungeonID)
GetLFGDungeonShortageRewardInfo(dungeonID, shortageIndex, rewardIndex)
GetLFGDungeonShortageRewardLink(dungeonID, shortageIndex, rewardIndex)
GetLFGInfoServer(category [, lfgID])
GetLFGInviteRoleAvailability(roleID)
GetLFGInviteRoleRestrictions(roleID)
GetLFGProposal()
GetLFGProposalEncounter(encounterIndex)
GetLFGProposalMember(memberIndex) - Returns info about the players in the LFG proposal.
GetLFGQueuedList(category [, table])
GetLFGQueueStats(category [, lfgID]) - Returns info for the current LFG queue.
GetLFGRandomCooldownExpiration() - Returns the time at which you may once again queue for a random dungeon.
GetLFGRandomDungeonInfo(index) - Returns information about a random dungeon queue.
GetLFGReadyCheckUpdate()
GetLFGReadyCheckUpdateBattlegroundInfo()
GetLFGRoles() - Returns the roles the player signed up for in the Dungeon Finder.
GetLFGRoleShortageRewards(dungeonID, shortageIndex) - Returns info for the LFG Call to Arms rewards.
GetLFGRoleUpdate()
GetLFGRoleUpdateBattlegroundInfo()
GetLFGRoleUpdateMember(memberIndex)
GetLFGRoleUpdateSlot(slotIndex)
GetLFGSuspendedPlayers(category)
GetPartyLFGBackfillInfo() - Returns information about the dungeon for which you may currently recruit additional members from the LFG pool.
GetPartyLFGID()
HasLFGRestrictions() - Returns whether the player is in a random party formed by the dungeon finder system.
IsInLFGDungeon()
IsLFGComplete() - Returns whether you have currently finished a Dungeon Finder instance.
IsLFGDungeonJoinable() - Returns whether you can queue for a particular dungeon
IsPartyLFG()
JoinLFG(category)
JoinSingleLFG(category, lfgID)
LeaveLFG(category)
LeaveSingleLFG(category, lfgID)
LFGTeleport([toSafety]) - Teleports the player to or from a LFG dungeon.
PartyLFGStartBackfill()
RefreshLFGList()
SearchLFGGetEncounterResults(index, encounterIndex)
SearchLFGGetJoinedID() - Returns the currently selected raid ID.
SearchLFGGetNumResults()
SearchLFGGetPartyResults([index, memberIndex])
SearchLFGGetResults([index])
SearchLFGLeave() - Removes yourself from looking through the Raid Browser. Equivalent to selecting "none" in the Raid Browser.
HW SearchLFGJoin(typeID, lfgID)
SearchLFGSort(type)
SetLFGBootVote(shouldKick) - Responds to a vote-kick.
SetLFGComment([comment]) - Sets the comment in the LFG browser.
SetLFGDungeon(LE_LFG_CATEGORY, type)
SetLFGDungeonEnabled(dungeonID, isEnabled)
SetLFGHeaderCollapsed(headerID, isCollapsed)
SetLFGRoles([leader, tank, healer, dps]) - Changes the selected roles.

LFD

LFD is used for Dungeon-specific functions and values

DungeonAppearsInRandomLFD(dungeonID)
GetLFDChoiceCollapseState([LFGCollapseList])
GetLFDChoiceEnabledState([LFGEnabledList])
GetLFDChoiceOrder([LFDDungeonList])
GetLFDLockInfo(dungeonID, playerIndex)
GetLFDLockPlayerCount()
GetLFDRoleLockInfo(dungeonID, roleID)
GetLFDRoleRestrictions(dungeonID)
RequestLFDPartyLockInfo()
RequestLFDPlayerLockInfo()

Flex Raid

GetBestFlexRaidChoice()
GetFlexRaidDungeonInfo(index)
GetNumFlexRaidDungeons()

Raid Finder

GetBestRFChoice() - Returns the suggested raid for the Raid Finder.
GetLFRChoiceOrder([LFRRaidList])
GetNumRFDungeons()
GetRFDungeonInfo(index)

Quick Join

Quick Join was added in Patch 7.1.0

C_PartyInfo.ConfirmRequestInviteFromUnit(targetName [, tank, healer, dps])
C_PartyInfo.GetActiveCategories() : categories
C_PartyInfo.GetInviteConfirmationInvalidQueues(inviteGUID) : invalidQueues
C_PartyInfo.GetInviteReferralInfo(inviteGUID) : outReferredByGuid, outReferredByName, outRelationType, outIsQuickJoin, ... - Returns info for Quick join invites.
C_PartyInfo.RequestInviteFromUnit(targetName [, tank, healer, dps])
C_SocialQueue.GetAllGroups([allowNonJoinable, allowNonQueuedGroups]) : groupGUIDs
C_SocialQueue.GetConfig() : config
C_SocialQueue.GetGroupForPlayer(playerGUID) : groupGUID, isSoloQueueParty
C_SocialQueue.GetGroupInfo(groupGUID) : canJoin, numQueues, needTank, needHealer, needDamage, isSoloQueueParty, ...
C_SocialQueue.GetGroupMembers(groupGUID) : groupMembers
C_SocialQueue.GetGroupQueues(groupGUID) : queues
C_SocialQueue.RequestToJoin(groupGUID [, applyAsTank, applyAsHealer, applyAsDamage]) : requestSuccessful
C_SocialQueue.SignalToastDisplayed(groupGUID, priority)

Guild

C_GuildInfo.CanEditOfficerNote() : canEditOfficerNote - True if the player can edit guild officer notes.
C_GuildInfo.CanSpeakInGuildChat() : canSpeakInGuildChat - True if the player can use guild chat.
C_GuildInfo.CanViewOfficerNote() : canViewOfficerNote - True if the player can view guild officer notes.
C_GuildInfo.GetGuildNewsInfo(index) : newsInfo
C_GuildInfo.GetGuildRankOrder(guid) : rankOrder - Returns the current rank of a guild member.
C_GuildInfo.GetGuildTabardInfo([unit]) : tabardInfo
C_GuildInfo.GuildControlGetRankFlags(rankOrder) : permissions - Returns the permission flags for a rank index.
C_GuildInfo.GuildRoster() - Requests updated guild roster information from the server.
C_GuildInfo.IsGuildOfficer() : isOfficer
C_GuildInfo.IsGuildRankAssignmentAllowed(guid, rankOrder) : isGuildRankAssignmentAllowed
C_GuildInfo.QueryGuildMemberRecipes(guildMemberGUID, skillLineID) - Shows the guild member recipes for a profession.
C_GuildInfo.QueryGuildMembersForRecipe(skillLineID, recipeSpellID [, recipeLevel]) : updatedRecipeSpellID
C_GuildInfo.RemoveFromGuild(guid) - Removes a member from the guild.
C_GuildInfo.SetGuildRankOrder(guid, rankOrder) - Sets the guild rank for a member.
C_GuildInfo.SetNote(guid, note, isPublic) - Sets the guild note for a member.
C_PlayerInfo.IsPlayerInGuildFromGUID(playerGUID) : IsInGuild
AcceptGuild() - Accepts a guild invite.
BuyGuildCharter(guildName) - Purchases a Inv letter 17 .
CanEditGuildEvent() - Returns true if you are allowed to edit guild events (in the calendar).
CanEditGuildInfo() - Returns true if you are allowed to edit the guild info.
CanEditGuildTabInfo(tab)
CanEditMOTD() - True if the player can edit the guild message of the day.
CanEditPublicNote() - Returns true if you are allowed to edit a guild member's public note.
CanGuildDemote() - True if the player can demote guild members.
CanGuildInvite() - True if the player can invite new members to the guild.
CanGuildPromote() - True if the player can promote guild members.
CanGuildRemove() - Returns true if you are allowed to remove a guild member.
CanReplaceGuildMaster() - Returns whether you can impeach the Guild Master due to inactivity.
CanViewGuildRecipes(skillLineID)
CloseGuildRegistrar()
CloseGuildRoster()
CloseTabardCreation()
CollapseGuildTradeSkillHeader(tradeSkillID)
DeclineGuild() - Declines a guild invite.
ExpandGuildTradeSkillHeader(tradeSkillID)
GetAutoDeclineGuildInvites() - True if guild invites are being automatically declined.
GetDemotionRank(index)
GetGuildCategoryList()
GetGuildChallengeInfo(index)
GetGuildCharterCost() - Returns the cost of purchasing a guild charter.
GetGuildEventInfo(index) - Returns the event information.
GetGuildExpirationTime()
GetGuildFactionGroup()
GetGuildFactionInfo() - Returns the guild name and faction standing of the player.
GetGuildInfo(unit) - Returns guild info for a player unit.
GetGuildInfoText() - Returns the persistant Guild Information data.
GetGuildLogoInfo()
GetGuildMemberRecipes(name, skillLineID)
GetGuildNewsFilters()
GetGuildNewsMemberName(index, nameIndex)
GetGuildNewsSort()
GetGuildPerkInfo()
GetGuildRecipeInfoPostQuery()
GetGuildRecipeMember(index)
GetGuildRenameRequired()
GetGuildRewardInfo(index)
GetGuildRosterInfo(index) - Returns info for a guild member.
GetGuildRosterLargestAchievementPoints() - Returns max achievements points.
GetGuildRosterLastOnline(index) - Returns time since the guild member was last online.
GetGuildRosterMOTD() - Returns the guild message of the day.
GetGuildRosterSelection() - Returns the index of the selected guild member in the roster.
GetGuildRosterShowOffline() - True if the guild roster is showing offline members.
GetGuildTabardFiles() - Returns File IDs of tabard textures used in guild bank logo.
GetGuildTradeSkillInfo(index) - Returns info for a profession in the guild roster.
GetNumGuildChallenges()
GetNumGuildEvents() - Returns the number of guild events.
GetNumGuildMembers() - Returns the number of total and online guild members.
GetNumGuildNews()
GetNumGuildPerks()
GetNumGuildRewards()
GetNumGuildTradeSkill() - Returns the number of tradeskills available to the guild UI.
GetNumMembersInRank(index)
GetPromotionRank(index)
GetTabardCreationCost() - Returns cost in coppers.
GetTabardInfo()
GuildControlAddRank(name) - Add another rank called "name". Only Guildmaster.
GuildControlDelRank(name) - Deletes a guild rank.
GuildControlGetAllowedShifts(rankOrder)
GuildControlGetNumRanks() - Returns number of ranks after guild frame open. Any guild member can use this.
GuildControlGetRankName(index) - Returns a guild rank name by index.
GuildControlSaveRank(name) - Saves the current rank name.
PROTECTED GuildControlSetRank(rank) - Selects a guild rank.
PROTECTED GuildControlSetRankFlag(index, enabled) - Sets guild rank permissions.
GuildControlShiftRankDown(rankOrder)
GuildControlShiftRankUp(rankOrder)
PROTECTED GuildDemote(name) - Demotes the specified player in the guild.
GuildDisband() - Disbands the guild; no warning is given.
GuildInfo() - Prints info for the guild the player belongs to.
HW GuildInvite(name) - Invites a player to the guild.
GuildLeave() - Removes you from your current guild.
GuildMasterAbsent()
GuildNewsSetSticky(index, bool)
GuildNewsSort(byDate)
PROTECTED GuildPromote(name) - Promotes the specified player in the guild.
GuildRosterSetOfficerNote(index, note) - Sets the officer note of a guild member.
GuildRosterSetPublicNote(index, note) - Sets the public note of a guild member.
GuildSetLeader(name) - Transfers guild leadership to another player.
GuildSetMOTD(note) - Sets the guild message of the day.
PROTECTED GuildUninvite(name) - Removes a player from the guild.
IsGuildLeader(name) - True if the player is the guild master.
IsGuildMember(guid or unitToken)
IsGuildRankAssignmentAllowed(playerIndex, rankIndex)
IsInAuthenticatedRank()
IsInGuild() - Lets you know whether you are in a guild.
QueryGuildEventLog() - Fetches the guild event list and fires a GUILD_EVENT_LOG_UPDATE event.
QueryGuildNews()
QueryGuildRecipes()
ReplaceGuildMaster() - Impeaches the current Guild Master.
RequestGuildChallengeInfo()
RequestGuildPartyState()
RequestGuildRewards()
SetAutoDeclineGuildInvites(checked) - Sets whether guild invites should be automatically declined.
SetGuildInfoText() - Sets the guild info text.
SetGuildMemberRank(playerIndex, rankIndex)
SetGuildNewsFilter(index, bool)
SetGuildRosterSelection(index) - Selects a guild member in the roster.
SetGuildRosterShowOffline(enabled) - Sets the show offline guild members flag.
SetGuildTradeSkillCategoryFilter(tradeSkillID)
SetGuildTradeSkillItemNameFilter(itemName)
SortGuildRoster(sort) - Sorts the guild roster on a certain column.
SortGuildTradeSkill(type)
SubmitRequiredGuildRename()
ViewGuildRecipes(skillLineID)

Petitions

Petitions are signup documents for guilds and arena teams. Some functions below only apply to a particular petition type

CanSignPetition() - Returns nil if the player cannot sign the current petition.
ClosePetition() - Closes the current petition.
GetNumPetitionNames() - Returns the number of signatures on the current petition.
GetPetitionInfo() - Returns info for the petition being viewed.
GetPetitionNameInfo(index) - Retrieves information about a signature on the petition.
OfferPetition() - Offers a petition to your target.
RenamePetition(name) - Renames the current petition.
SignPetition() - Signs the currently viewed petition.
TurnInGuildCharter() - Founds a guild.

Instances

C_ModifiedInstance.GetModifiedInstanceInfoFromMapID(mapID) : info
C_PlayerInfo.GetInstancesUnlockedAtLevel(level, isRaid) : dungeonID
CanChangePlayerDifficulty()
CanMapChangeDifficulty()
CanShowResetInstances() - True if the character can currently reset their instances.
GetDifficultyInfo() - Returns information about a difficulty.
GetDungeonDifficultyID() - Returns the selected dungeon difficulty.
GetInstanceBootTimeRemaining() - Gets the time in seconds after which the player will be ejected from an instance.
GetInstanceInfo() - Returns info for the map instance the character is currently in.
GetLegacyRaidDifficultyID()
GetRaidDifficultyID() - Returns the player's currently selected raid difficulty.
IsInInstance() - Returns true if the player is in an instance, and the type of instance.
IsLegacyDifficulty(difficultyID)
ResetInstances() - Resets all instances for the character.
SetDungeonDifficultyID(difficultyID) - Sets the player's dungeon difficulty.
SetLegacyRaidDifficultyID(difficultyID [, force])
SetRaidDifficultyID(difficultyID) - Sets the raid difficulty.
ShowBossFrameWhenUninteractable(unit)

Relates to Instance Locks

GetInstanceLockTimeRemaining() - Returns info for the instance lock timer for the current instance.
GetInstanceLockTimeRemainingEncounter(id) - Returns information about bosses in the instance the player is about to be saved to.
GetNumSavedInstances() - Returns the number of instances for which the character is locked out.
GetNumSavedWorldBosses()
GetSavedInstanceChatLink(index)
GetSavedInstanceEncounterInfo(instanceIndex, encounterIndex)
GetSavedInstanceInfo(index) - Returns instance lock info.
GetSavedWorldBossInfo(index)
RequestRaidInfo() - Requests which instances the player is saved to.
RespondInstanceLock()
SetSavedInstanceExtend(index, extend)

Scenarios

Scenarios were added in Patch 5.0.4

C_Scenario.GetBonusStepRewardQuestID(stepIndex)
C_Scenario.GetBonusSteps()
C_Scenario.GetCriteriaInfo(criteriaIndex)
C_Scenario.GetCriteriaInfoByStep(stepID, criteriaIndex)
C_Scenario.GetInfo()
C_Scenario.GetProvingGroundsInfo() - Returns info for the current Proving Grounds trial.
C_Scenario.GetScenarioIconInfo(uiMapID)
C_Scenario.GetStepInfo([bonusStepIndex])
C_Scenario.GetSupersededObjectives()
C_Scenario.IsInScenario()
C_Scenario.ShouldShowCriteria()
C_Scenario.TreatScenarioAsDungeon()
C_ScenarioInfo.GetScenarioInfo() : scenarioInfo
C_ScenarioInfo.GetScenarioStepInfo([scenarioStepID]) : scenarioStepInfo
GetNumRandomScenarios()
GetNumScenarios()
GetRandomScenarioBestChoice()
GetRandomScenarioInfo(index)
GetScenariosChoiceOrder()
GetWorldElapsedTimers()
GetWorldElapsedTime(timerID)
IsInScenarioGroup()

Mythic+

nil()

Mythic+ mode was added in Patch 7.0.3

C_MythicPlus.GetCurrentAffixes() : affixIDs
C_MythicPlus.GetCurrentSeason() : seasonID
C_MythicPlus.GetCurrentSeasonValues() : displaySeasonID, milestoneSeasonID, rewardSeasonID
C_MythicPlus.GetLastWeeklyBestInformation() : challengeMapId, level
C_MythicPlus.GetOwnedKeystoneChallengeMapID() : challengeMapID
C_MythicPlus.GetOwnedKeystoneLevel() : keyStoneLevel
C_MythicPlus.GetOwnedKeystoneMapID() : mapID
C_MythicPlus.GetRewardLevelForDifficultyLevel(difficultyLevel) : weeklyRewardLevel, endOfRunRewardLevel
C_MythicPlus.GetRewardLevelFromKeystoneLevel(keystoneLevel) : rewardLevel
C_MythicPlus.GetRunHistory([includePreviousWeeks, includeIncompleteRuns]) : runs
C_MythicPlus.GetSeasonBestAffixScoreInfoForMap(mapChallengeModeID) : affixScores, bestOverAllScore
C_MythicPlus.GetSeasonBestForMap(mapChallengeModeID) : intimeInfo, overtimeInfo
C_MythicPlus.GetSeasonBestMythicRatingFromThisExpansion() : bestSeasonScore, bestSeason
C_MythicPlus.GetWeeklyBestForMap(mapChallengeModeID) : durationSec, level, completionDate, affixIDs, members, ...
C_MythicPlus.GetWeeklyChestRewardLevel() : currentWeekBestLevel, weeklyRewardLevel, nextDifficultyWeeklyRewardLevel, ...
C_MythicPlus.IsMythicPlusActive() : isMythicPlusActive
C_MythicPlus.IsWeeklyRewardAvailable() : weeklyRewardAvailable
C_MythicPlus.RequestCurrentAffixes()
C_MythicPlus.RequestMapInfo()
C_MythicPlus.RequestRewards()
C_PlayerInfo.GetPlayerMythicPlusRatingSummary(playerToken) : ratingSummary

Challenge Mode was added in Patch 5.0.4

C_ChallengeMode.CanUseKeystoneInCurrentMap(itemLocation) : canUse
C_ChallengeMode.ClearKeystone()
C_ChallengeMode.CloseKeystoneFrame()
C_ChallengeMode.GetActiveChallengeMapID() : mapChallengeModeID
C_ChallengeMode.GetActiveKeystoneInfo() : activeKeystoneLevel, activeAffixIDs, ...
C_ChallengeMode.GetAffixInfo(affixID) : name, description, filedataid
C_ChallengeMode.GetCompletionInfo() : mapChallengeModeID, level, time, onTime, keystoneUpgradeLevels, ...
C_ChallengeMode.GetDeathCount() : numDeaths, timeLost
C_ChallengeMode.GetDungeonScoreRarityColor(dungeonScore) : scoreColor
C_ChallengeMode.GetGuildLeaders() : topAttempt
C_ChallengeMode.GetKeystoneLevelRarityColor(level) : levelScore
C_ChallengeMode.GetMapScoreInfo() : displayScores
C_ChallengeMode.GetMapTable() : mapChallengeModeIDs
C_ChallengeMode.GetMapUIInfo(mapChallengeModeID) : name, id, timeLimit, texture, backgroundTexture
C_ChallengeMode.GetOverallDungeonScore() : overallDungeonScore
C_ChallengeMode.GetPowerLevelDamageHealthMod(powerLevel) : damageMod, healthMod
C_ChallengeMode.GetSlottedKeystoneInfo() : mapChallengeModeID, affixIDs, keystoneLevel
C_ChallengeMode.GetSpecificDungeonOverallScoreRarityColor(specificDungeonOverallScore) : specificDungeonOverallScoreColor
C_ChallengeMode.GetSpecificDungeonScoreRarityColor(specificDungeonScore) : specificDungeonScoreColor
C_ChallengeMode.HasSlottedKeystone() : hasSlottedKeystone
C_ChallengeMode.IsChallengeModeActive() : challengeModeActive
C_ChallengeMode.RemoveKeystone() : removalSuccessful
C_ChallengeMode.RequestLeaders(mapChallengeModeID)
C_ChallengeMode.Reset()
C_ChallengeMode.SetKeystoneTooltip()
C_ChallengeMode.SlotKeystone()
C_ChallengeMode.StartChallengeMode() : success

Weekly Rewards

C_WeeklyRewards.AreRewardsForCurrentRewardPeriod() : isCurrentPeriod
C_WeeklyRewards.CanClaimRewards() : canClaimRewards
C_WeeklyRewards.ClaimReward(id)
C_WeeklyRewards.CloseInteraction()
C_WeeklyRewards.GetActivities([type]) : activities
C_WeeklyRewards.GetActivityEncounterInfo(type, index) : info
C_WeeklyRewards.GetConquestWeeklyProgress() : weeklyProgress
C_WeeklyRewards.GetExampleRewardItemHyperlinks(id) : hyperlink, upgradeHyperlink
C_WeeklyRewards.GetItemHyperlink(itemDBID) : hyperlink
C_WeeklyRewards.GetNextMythicPlusIncrease(mythicPlusLevel) : hasSeasonData, nextMythicPlusLevel, itemLevel
C_WeeklyRewards.HasAvailableRewards() : hasAvailableRewards
C_WeeklyRewards.HasGeneratedRewards() : hasGeneratedRewards
C_WeeklyRewards.HasInteraction() : isInteracting
C_WeeklyRewards.OnUIInteract()

Items

These functions operate on item links or item information directly. See also Bag functions.

C_Item.CanViewItemPowers(itemLoc) : isItemViewable
C_Item.DoesItemExist(emptiableItemLocation) : itemExists
C_Item.DoesItemExistByID(itemInfo) : itemExists
C_Item.DoesItemMatchBonusTreeReplacement(itemLoc) : matchesBonusTree
C_Item.GetCurrentItemLevel(itemLocation) : currentItemLevel
C_Item.GetItemConversionOutputIcon(itemLoc) : icon
C_Item.GetItemGUID(itemLocation) : itemGuid
C_Item.GetItemIcon(itemLocation) : icon
C_Item.GetItemIconByID(itemInfo) : icon
C_Item.GetItemID(itemLocation) : itemID
C_Item.GetItemInventoryType(itemLocation) : inventoryType
C_Item.GetItemInventoryTypeByID(itemInfo) : inventoryType
C_Item.GetItemLink(itemLocation) : itemLink
C_Item.GetItemName(itemLocation) : itemName
C_Item.GetItemNameByID(itemInfo) : itemName
C_Item.GetItemQuality(itemLocation) : itemQuality
C_Item.GetItemQualityByID(itemInfo) : itemQuality
C_Item.GetItemUniquenessByID(itemInfo) : isUnique, limitCategoryName, limitCategoryCount, ...
C_Item.GetStackCount(itemLocation) : stackCount
C_Item.IsBound(itemLocation) : isBound
C_Item.IsItemConvertibleAndValidForPlayer(itemLoc) : isItemConvertibleAndValidForPlayer
C_Item.IsItemDataCached(itemLocation) : isCached
C_Item.IsItemDataCachedByID(itemInfo) : isCached
C_Item.IsItemKeystoneByID(itemInfo) : isKeystone
C_Item.IsItemSpecificToPlayerClass(itemInfo) : isItemSpecificToPlayerClass
C_Item.IsLocked(itemLocation) : isLocked
C_Item.LockItem(itemLocation)
C_Item.LockItemByGUID(itemGUID)
C_Item.RequestLoadItemData(itemLocation)
C_Item.RequestLoadItemDataByID(itemInfo)
C_Item.UnlockItem(itemLocation)
C_Item.UnlockItemByGUID(itemGUID)
C_ItemInteraction.ClearPendingItem()
C_ItemInteraction.CloseUI()
C_ItemInteraction.GetChargeInfo() : chargeInfo
C_ItemInteraction.GetItemConversionCurrencyCost(item) : conversionCost
C_ItemInteraction.GetItemInteractionInfo() : info
C_ItemInteraction.GetItemInteractionSpellId() : spellId
C_ItemInteraction.InitializeFrame()
C_ItemInteraction.PerformItemInteraction()
C_ItemInteraction.Reset()
C_ItemInteraction.SetItemConversionOutputTooltip()
C_ItemInteraction.SetPendingItem([item]) : success
C_NewItems.ClearAll() - Clears the new item flag on all items in the player's inventory.
C_NewItems.IsNewItem(bag, slot) - True if the item in the inventory slot is flagged as new.
C_NewItems.RemoveNewItem(bag, slot) - Clears the "new item" flag.
ActionBindsItem() - Confirms this will bind this item to you.
ConfirmOnUse() - Confirms you want to use the item.
EndBoundTradeable(type) - Confirms this will make this item non-tradeable.
EndRefund() - Confirms this will make this item non-refundable.
EquipItemByName(item [, invSlot]) - Equips an item, optionally into a specified slot.
GetDetailedItemLevelInfo(item) - Returns detailed item level info.
GetItemChildInfo(item [, slotID])
GetItemClassInfo(itemClassID) - Returns the name of the item type.
GetItemCooldown(itemId) - Returns cooldown info for an item ID.
GetItemCount(item [, includeBank, includeCharges]) - Returns the number (or available charges) of an item in the inventory.
GetItemCreationContext(itemlink)
GetItemFamily(item) - Returns the bag type that an item can go into, or for bags the type of items that it can contain.
GetItemGem(item, index)
GetItemIcon(itemId) - Returns the icon texture for an item.
GetItemInfo(item) - Returns info for an item.
GetItemInfoInstant(item) - Returns readily available info for an item.
GetItemInventorySlotInfo(inventorySlot)
GetItemLevelColor()
GetItemQualityColor(quality) - Returns the color for an item quality.
GetItemSetInfo(setID)
GetItemSpecInfo(item [, specTable])
GetItemSpell(item) - Returns the spell effect for an item.
GetItemStatDelta(itemLink1, itemLink2 [, statTable])
GetItemStats(itemLink, statTable) - Returns a table of stats for an item.
GetItemSubClassInfo(itemClassID, itemSubClassID) - Returns the name of the item subtype.
GetItemUniqueness(item)
IsBattlePayItem(bag, slot)
IsConsumableItem(item)
IsCurrentItem(item)
IsEquippableItem(item) - True if an item is equipable by the player.
IsEquippedItem(item)
IsEquippedItemType(type) - True if an item of a given type is equipped.
IsHarmfulItem(item) - Returns whether an item can be used against hostile units
IsHelpfulItem(item) - Returns whether an item can be used on the player or friendly units
IsItemInRange(item [, unit]) - Returns whether the item is in usable range of the unit.
IsUsableItem(item) - Returns usable, noMana.
ItemHasRange(item)
TargetSpellReplacesBonusTree()
PROTECTED UseItemByName(itemName, unit) - Uses the specified item.

Item Enchants

BindEnchant() - Confirms that enchanting an item will make it soulbound.
ReplaceEnchant() - Confirms the "Replace Enchant" dialog.
ReplaceTradeEnchant() - Confirms that an enchant applied to the trade frame should replace an existing enchant.
DEPRECATED GetItemUpdateLevel()
DEPRECATED GetItemUpgradeItemInfo()
DEPRECATED GetItemUpgradeStats(upgraded)
DEPRECATED IsDressableItem(item) - Returns if the item can be shown in the Dressing room.

Item Upgrade

C_ItemUpgrade.CanUpgradeItem(baseItem) : isValid
C_ItemUpgrade.ClearItemUpgrade()
C_ItemUpgrade.CloseItemUpgrade()
C_ItemUpgrade.GetItemHyperlink() : link
C_ItemUpgrade.GetItemUpgradeCurrentLevel() : itemLevel, isPvpItemLevel
C_ItemUpgrade.GetItemUpgradeEffect(effectIndex [, numUpgradeLevels]) : outBaseEffect, outUpgradedEffect
C_ItemUpgrade.GetItemUpgradeItemInfo() : itemInfo
C_ItemUpgrade.GetItemUpgradePvpItemLevelDeltaValues(numUpgradeLevels) : currentPvPItemLevel, upgradedPvPItemLevel
C_ItemUpgrade.GetNumItemUpgradeEffects() : numItemUpgradeEffects
C_ItemUpgrade.SetItemUpgradeFromCursorItem()
C_ItemUpgrade.SetItemUpgradeFromLocation(itemToSet)
C_ItemUpgrade.UpgradeItem([numUpgrades])
DEPRECATED C_ItemUpgrade.GetItemLevelIncrement([numUpgradeLevels]) : itemLevelIncrement

Looting

Relates to Loot.

C_Loot.IsLegacyLootModeEnabled() : isLegacyLootModeEnabled
C_LootHistory.CanMasterLoot(itemIndex, playerIndex)
C_LootHistory.GetExpiration()
C_LootHistory.GetItem(itemIndex)
C_LootHistory.GetNumItems()
C_LootHistory.GetPlayerInfo(itemIndex, playerIndex)
C_LootHistory.GiveMasterLoot(itemIndex, playerIndex)
C_LootHistory.SetExpiration(numItemsToSave, secondsToSave)
C_PlayerInfo.CanPlayerUseAreaLoot() : canUseAreaLoot
CanLootUnit(unitGUID)
CancelMasterLootRoll(slot)
CloseLoot([uiFailedFlag])
ConfirmLootRoll(rollId [, roll]) - Confirms a loot roll.
ConfirmLootSlot(slot) - Confirms looting of a BoP item.
DoMasterLootRoll(slot)
GetActiveLootRollIDs()
GetLootInfo()
GetLootMethod() - Returns the current loot method.
GetLootRollItemInfo(rollId)
GetLootRollItemLink(id)
GetLootRollTimeLeft(rollid)
GetLootSlotInfo(slot) - Returns info for a loot slot.
GetLootSlotLink(slot) - Returns the item link for a loot slot.
GetLootSlotType(slot)
GetLootSourceInfo(slot) - Returns information about the source of the objects in a loot slot.
GetLootSpecialization()
GetLootThreshold() - Returns the loot threshold quality for e.g. master loot.
GetMasterLootCandidate(index) - Returns the name of an eligible player for receiving master loot by index.
GetNumLootItems() - Returns the number of items in the loot window.
GetOptOutOfLoot() - True if the player is automatically passing on all loot.
GiveMasterLoot(slot, index)
IsFishingLoot()
IsMasterLooter()
LootMoneyNotify(money, soleLooter)
LootSlot(slot) - Loots the specified slot; can require confirmation with ConfirmLootSlot.
LootSlotHasItem(slot)
RollOnLoot(rollId [, roll]) - Rolls or passes on loot.
SetLootMethod(lootMethod [, masterPlayer or threshold]) - Set the current loot method.
SetLootPortrait()
SetLootSpecialization(specilizationID)
SetLootThreshold(itemQuality) - Sets the loot quality threshold for group/master loot.
SetOptOutOfLoot(optOut) - Sets whether to automatically pass on all loot.

Macros

Relates to Macros.

NOCOMBAT CreateMacro(name, icon, body, perCharacter, isLocal) - Creates a macro.
DeleteMacro(id or name) - Deletes a macro.
NOCOMBAT EditMacro(index, name, iconIndex, body, isLocal, perCharacter) - Modifies an existing macro.
GetLooseMacroIcons()
GetLooseMacroItemIcons()
GetMacroBody(id or name) - Returns the body (macro text) of a macro.
GetMacroIcons(table) - Returns an array of available macro texture paths (but not icons of items).
GetMacroIndexByName(name) - Returns the index for a macro by name.
GetMacroInfo(id or name) - Returns info for a macro.
GetMacroItemIcons(table) - Returns an array of available macro texture paths (icons of items).
GetMacroItem()
GetMacroSpell()
GetNumMacros() - Returns the number of account and character macros.
GetRunningMacroButton()
GetRunningMacro()
PROTECTED RunMacro(id or name) - Executes a macro.
PROTECTED RunMacroText(macro) - Executes a string as if it was a macro.
SecureCmdOptionParse(command) - Evaluates macro conditionals without the need of a macro.
SetMacroItem(macro, item [, target])
SetMacroSpell(macro, spell [, target])
PROTECTED StopMacro() - Stops the currently executing macro.

Mail

Relates to Mail.

C_Mail.CanCheckInbox() : canCheckInbox, secondsUntilAllowed
C_Mail.HasInboxMoney(inboxIndex) : inboxItemHasMoneyAttached - Returns true if a mail has money attached.
C_Mail.IsCommandPending() : isCommandPending - Returns true if the current mail command is still processing.
AutoLootMailItem(index) - Loot all items from mail message.
CanComplainInboxItem(index) - Determines if we should show the “report spam” button on a mail item.
CheckInbox() - Queries the server for mail.
ClearSendMail() - Clears the text and item attachments in the Send Mail tab.
ClickSendMailItemButton([itemIndex, clearItem]) - Drops or picks up an item from the cursor to the Send Mail tab.
CloseMail() - Closes the mail window.
DeleteInboxItem(index) - Requests the server to remove a mailbox message.
GetCoinIcon(amount)
GetInboxHeaderInfo(index) - Returns info for a message in the mailbox.
GetInboxItem(index, itemIndex) - Returns info for an item attached to a message in the mailbox.
GetInboxItemLink(index, itemIndex) - Returns the item link of an item attached to a message in the mailbox.
GetInboxNumItems() - Returns the number of messages in the mailbox.
GetInboxText(index) - Returns the text of a message in the mailbox.
GetInboxInvoiceInfo(index) - Returns info for an auction house invoice.
GetLatestThreeSenders() - Returns up to three senders of unread mail.
GetSendMailCOD() - Returns the Cash-On-Delivery cost of the outgoing message.
GetSendMailItem(index) - Returns info for an item attached in the outgoing message.
GetSendMailItemLink(index) - Returns the item link of an item attached in the outgoing message.
GetSendMailMoney()
GetSendMailPrice() - Gets the cost for sending mail.
HasInboxItem()
HasNewMail() - Returns nil if there is no new mail.
HasSendMailItem(index) - Returns boolean if item is attached to send mail frame in specified slot.
InboxItemCanDelete(index) - True if a message can be deleted, false if it can be returned to sender.
RespondMailLockSendItem(slot, keepItem) - Confirm item wont be refunded, keepItem boolean.
ReturnInboxItem(index) - Returns to the sender the attached item in the mail message at the specified index.
SCRIPT SendMail(target, subject, body) - Sends in-game mail.
PROTECTED SetSendMailCOD(amount) - Make next mail sent using SendMail() COD target for amount.
PROTECTED SetSendMailMoney(amount) - Add money to next mail sent using SendMail().
SetSendMailShowing()
TakeInboxItem(index, itemIndex) - Takes the attached item from the mailbox message.
TakeInboxMoney(index) - Take the attached money from the mailbox message at index.
TakeInboxTextItem(index) - Creates a permanent copy of letter (readable "Plain Letter").

Maps

The Map API was reworked in Patch 8.0.1. See also MapUtil functions.

C_Map.CloseWorldMapInteraction()
C_Map.GetAreaInfo(areaID) : name - Returns a map subzone name.
C_Map.GetBestMapForUnit(unitToken) : uiMapID - Returns the current UI map for the given unit. Only works for the player and party members.
C_Map.GetBountySetMaps(bountySetID) : mapIDs - Returns the maps for a bounty.
C_Map.GetFallbackWorldMapID() : uiMapID - Returns the world map id.
C_Map.GetMapArtBackgroundAtlas(uiMapID) : atlasName - Returns the background atlas for a map.
C_Map.GetMapArtHelpTextPosition(uiMapID) : position - Returns the position for the "Click to Zoom In" hint text on flight maps.
C_Map.GetMapArtID(uiMapID) : uiMapArtID - Returns the art for a (phased) map.
C_Map.GetMapArtLayers(uiMapID) : layerInfo - Returns the art layers for a map.
C_Map.GetMapArtLayerTextures(uiMapID, layerIndex) : textures - Returns the art layer textures for a map.
C_Map.GetMapBannersForMap(uiMapID) : mapBanners - Returns the poi banners for a map.
C_Map.GetMapChildrenInfo(uiMapID [, mapType, allDescendants]) : info - Returns info for the children of a map.
C_Map.GetMapDisplayInfo(uiMapID) : hideIcons - Returns whether group member pins should be hidden.
C_Map.GetMapGroupID(uiMapID) : uiMapGroupID - Returns the map group for a map.
C_Map.GetMapGroupMembersInfo(uiMapGroupID) : info - Returns the floors for a map group.
C_Map.GetMapHighlightInfoAtPosition(uiMapID, x, y) : fileDataID, atlasID, texturePercentageX, texturePercentageY, ... - Returns a map highlight pin for a location.
C_Map.GetMapInfo(uiMapID) : info - Returns map information.
C_Map.GetMapInfoAtPosition(uiMapID, x, y) : info - Returns info for any child or adjacent maps at a position on the map.
C_Map.GetMapLevels(uiMapID) : playerMinLevel, playerMaxLevel, petMinLevel, petMaxLevel - Returns the suggested player and battle pet levels for a map.
C_Map.GetMapLinksForMap(uiMapID) : mapLinks - Returns the map pins that link to another map.
C_Map.GetMapPosFromWorldPos(continentID, worldPosition [, overrideUiMapID]) : uiMapID, mapPosition - Translates a world map position to a map position.
C_Map.GetMapRectOnMap(uiMapID, topUiMapID) : minX, maxX, minY, maxY - Returns the map rectangle location for a map on its parent map.
C_Map.GetMapWorldSize(uiMapID) : width, height
NOINSTANCE C_Map.GetPlayerMapPosition(uiMapID, unitToken) : position - Returns the location of the unit on a map.
C_Map.GetWorldPosFromMapPos(uiMapID, mapPosition) : continentID, worldPosition - Translates a map position to a world map position.
C_Map.IsMapValidForNavBarDropDown(uiMapID) : isValid
C_Map.MapHasArt(uiMapID) : hasArt - Returns true if the map has art and can be displayed by the FrameXML.
C_Map.RequestPreloadMap(uiMapID) - Preloads textures for a map.
C_MapExplorationInfo.GetExploredAreaIDsAtPosition(uiMapID, normalizedPosition) : areaID - Returns the explored areas for the location on a map.
C_MapExplorationInfo.GetExploredMapTextures(uiMapID) : overlayInfo - Returns explored map textures for a map.
C_FogOfWar.GetFogOfWarForMap(uiMapID) : fogOfWarID - Returns the fog of war for an Island Expedition map.
C_FogOfWar.GetFogOfWarInfo(fogOfWarID) : fogOfWarInfo - Returns info for the fog of war for an Island Expedition map.
GetAreaText()
GetMinimapZoneText() - Returns the zone text that is displayed over the minimap.
NOINSTANCE GetPlayerFacing() - Returns the direction the character is facing in radians.
GetRealZoneText([mapID]) - Returns the map instance name.
GetSubZoneText() - Returns the subzone name.
GetZonePVPInfo() - Returns PVP info for the current zone.
GetZoneText() - Returns the name of the zone the player is in.
NOINSTANCE UnitDistanceSquared(unit) - Returns the squared distance to a unit in your group.
NOINSTANCE UnitPosition(unit) - Returns the position of a unit in the current world area.
UI WorldMapFrame:AddDataProvider(dataProvider) - Adds a map data provider.
UI WorldMapFrame:GetMapID() - Returns the currently viewed world map.
UI WorldMapFrame:SetMapID(uiMapID) - Sets the world map.
UI WorldMapFrame:EnumerateAllPins() - Enumerates through all map pins.

Minimap

The Minimap was reworked in Patch 9.0.1

C_Minimap.GetDrawGroundTextures() : draw
C_Minimap.GetUiMapID() : uiMapID
C_Minimap.GetViewRadius() : yards
C_Minimap.IsRotateMinimapIgnored() : isIgnored
C_Minimap.SetDrawGroundTextures(draw)
C_Minimap.SetIgnoreRotateMinimap(ignore)
C_Minimap.ShouldUseHybridMinimap() : shouldUse

Tracking

Relates to Tracking on the minimap.

ClearAllTracking()
GetNumTrackingTypes() - Returns the number of available tracking types for the minimap.
GetTrackingInfo(id) - Returns tracking info by index.
SetTracking(id, enabled) - Sets a minimap tracking method.

Points of Interest

C_AreaPoiInfo.GetAreaPOIForMap(uiMapID) : areaPoiIDs - Returns area points of interest for a map.
C_AreaPoiInfo.GetAreaPOIInfo(uiMapID, areaPoiID) : poiInfo - Returns info for an area point of interest (e.g. World PvP objectives).
C_AreaPoiInfo.GetAreaPOISecondsLeft(areaPoiID) : secondsLeft - Returns the time left in seconds for an area point of interest.
C_AreaPoiInfo.IsAreaPOITimed(areaPoiID) : isTimed - Returns whether an area poi is timed.
GetPOITextureCoords(textureIndex)
SetPOIIconOverlapDistance(index)
SetPOIIconOverlapPushDistance(index)

Vignettes are used for one-time rare mobs and treasure chests.

C_VignetteInfo.FindBestUniqueVignette(vignetteGUIDs) : bestUniqueVignetteIndex
C_VignetteInfo.GetVignetteInfo(vignetteGUID) : vignetteInfo
C_VignetteInfo.GetVignettePosition(vignetteGUID, uiMapID) : vignettePosition
C_VignetteInfo.GetVignettes() : vignetteGUIDs

Waypoints

Tracked waypoints were added in Patch 9.0.1

C_Map.CanSetUserWaypointOnMap(uiMapID) : canSet
C_Map.ClearUserWaypoint()
C_Map.GetUserWaypoint() : point
C_Map.GetUserWaypointFromHyperlink(hyperlink) : point
C_Map.GetUserWaypointHyperlink() : hyperlink
C_Map.GetUserWaypointPositionForMap(uiMapID) : mapPosition
C_Map.HasUserWaypoint() : hasUserWaypoint
C_Map.SetUserWaypoint(point)
C_Navigation.GetDistance() : distance
C_Navigation.GetFrame() : frame
C_Navigation.GetTargetState() : state
C_Navigation.HasValidScreenPosition() : hasValidScreenPosition
C_Navigation.WasClampedToScreen() : wasClamped

Controls what's actively being tracked.

C_SuperTrack.GetHighestPrioritySuperTrackingType() : type
C_SuperTrack.GetSuperTrackedQuestID() : questID
C_SuperTrack.IsSuperTrackingAnything() : isSuperTracking
C_SuperTrack.IsSuperTrackingCorpse() : isSuperTracking
C_SuperTrack.IsSuperTrackingQuest() : isSuperTracking
C_SuperTrack.IsSuperTrackingUserWaypoint() : isSuperTracking
C_SuperTrack.SetSuperTrackedQuestID(questID)
C_SuperTrack.SetSuperTrackedUserWaypoint(superTracked)
C_QuestLog.GetNextWaypoint(questID) : mapID, x, y
C_QuestLog.GetNextWaypointForMap(questID, uiMapID) : x, y
C_QuestLog.GetNextWaypointText(questID) : waypointText

Flight Master

Relates to Flight master taxi services.

C_TaxiMap.GetAllTaxiNodes(uiMapID) : taxiNodes
C_TaxiMap.GetTaxiNodesForMap(uiMapID) : mapTaxiNodes
C_TaxiMap.ShouldMapShowTaxiNodes(uiMapID) : shouldShowNodes
CloseTaxiMap() - Closes the Flight Map.
GetNumRoutes(slot) - Gets the number of hops between current-slot and slot.
GetTaxiBenchmarkMode()
GetTaxiMapID()
NumTaxiNodes() - Returns the number of flight paths on the taxi map.
SetTaxiBenchmarkMode()
SetTaxiMap(frame)
TakeTaxiNode(slot) - Travels to the specified flight path node.
TaxiGetDestX(slot, hop)
TaxiGetDestY(slot, hop)
TaxiGetNodeSlot()
TaxiGetSrcX(slot, hop)
TaxiGetSrcY(slot, hop)
TaxiIsDirectFlight()
TaxiNodeCost(slot) - Returns the cost of the flight path in copper.
TaxiNodeGetType(slot) - Returns the type of a flight path node.
TaxiNodeName(slot) - Returns the name of a flight path node.
TaxiNodePosition(slot) - Returns the position of a flight point on the taxi map.
TaxiRequestEarlyLanding()
UnitOnTaxi(unit) - True if the unit is on a flight path.

Merchants

Vendor

Relates to Vendors.

C_MerchantFrame.GetBuybackItemID(buybackSlotIndex) : buybackItemID
C_MerchantFrame.IsMerchantItemRefundable(index) : refundable
BuyMerchantItem(index [, qty]) - Buys an item from a merchant.
BuybackItem(index) - Buys back an item from the merchant.
CanAffordMerchantItem(index)
CanMerchantRepair() - True if the merchant can repair items.
CloseMerchant() - Closes the merchant window.
ContainerRefundItemPurchase(index, slot [, isEquipped])
GetBuybackItemInfo(index) - Returns info for an item that can be bought back from a merchant.
GetBuybackItemLink(index) - Returns an itemLink for the buyback item.
GetMerchantCurrencies()
GetMerchantFilter()
GetMerchantItemCostInfo(index) - Returns "alternative currency" information about an item.
GetMerchantItemCostItem(index, itemIndex) - Returns info for the currency cost for a merchant item.
GetMerchantItemID(index)
GetMerchantItemInfo(index) - Returns info for a merchant item.
GetMerchantItemLink(index) - Returns the item link for a merchant item.
GetMerchantItemMaxStack(index) - Returns the maximum stack size for a merchant item.
GetMerchantNumItems() - Returns the number of different items a merchant sells.
GetNumBuybackItems() - Returns number of items available for buyback.
GetRepairAllCost()
RepairAllItems([guildBankRepair]) - Repairs all equipped and inventory items.
ResetSetMerchantFilter()
SetMerchantFilter()

Trainer

Relates to Trainers.

BuyTrainerService(index) - Buys a trainer service (e.g. class skills and profession recipes).
CloseTrainer() - Closes the trainer window.
GetNumTrainerServices() - Returns the number of trainer services.
GetTrainerGreetingText() - Returns the trainer's greeting text.
GetTrainerSelectionIndex() - Returns the index of the selected trainer service.
GetTrainerServiceAbilityReq(trainerIndex, reqIndex) - Returns the name of a requirement for training a skill and if the player meets the requirement.
GetTrainerServiceCost(index) - Returns the cost of the specified trainer service.
GetTrainerServiceDescription(index) - Returns the description of a specific trainer service.
GetTrainerServiceIcon(index) - Returns the icon texture for a specific trainer service.
GetTrainerServiceInfo(index) - Returns information about a trainer service.
GetTrainerServiceItemLink(index) - Returns an item link for a trainer service.
GetTrainerServiceLevelReq(index) - Returns the required level to learn a skill from the trainer.
GetTrainerServiceNumAbilityReq() - Get the maximum number of requirements that GetTrainerServiceAbilityReq has.
GetTrainerServiceSkillLine(index)
GetTrainerServiceSkillReq(index) - Returns the name of the required skill and the amount needed in that skill.
GetTrainerServiceStepIndex()
GetTrainerServiceTypeFilter(filter) - Returns the status of a skill filter in the trainer window.
GetTrainerTradeskillRankValues()
IsTradeskillTrainer() - True if the training window is used for a profession trainer.
OpenTrainer()
SelectTrainerService()
SetTrainerServiceTypeFilter(filter, state) - Sets the status of a skill filter in the trainer window.

Pet Battles

The Pet Battle System was added in Patch 5.0.4. See also Pet Journal functions.

C_PetBattles.AcceptPVPDuel()
C_PetBattles.AcceptQueuedPVPMatch()
C_PetBattles.CanAcceptQueuedPVPMatch()
C_PetBattles.CanActivePetSwapOut()
C_PetBattles.CanPetSwapIn(petIndex)
C_PetBattles.CancelPVPDuel()
C_PetBattles.ChangePet(petIndex)
C_PetBattles.DeclineQueuedPVPMatch()
C_PetBattles.ForfeitGame()
C_PetBattles.GetAbilityEffectInfo(abilityID, turnIndex, effectIndex, effectName)
C_PetBattles.GetAbilityInfoByID(abilityID)
C_PetBattles.GetAbilityInfo(petOwner, petIndex, abilityIndex)
C_PetBattles.GetAbilityProcTurnIndex(abilityID, procType)
C_PetBattles.GetAbilityStateModification(abilityID, stateID)
C_PetBattles.GetAbilityState(petOwner, petIndex, actionIndex)
C_PetBattles.GetActivePet(petOwner)
C_PetBattles.GetAllEffectNames()
C_PetBattles.GetAllStates()
C_PetBattles.GetAttackModifier(petType, enemyPetType)
C_PetBattles.GetAuraInfo(petOwner, petIndex, auraIndex)
C_PetBattles.GetBattleState()
C_PetBattles.GetBreedQuality(petOwner, slot) : quality
C_PetBattles.GetDisplayID(petOwner, petIndex)
C_PetBattles.GetForfeitPenalty()
C_PetBattles.GetHealth(petOwner, petIndex)
C_PetBattles.GetIcon(petOwner, slot) : iconFileID
C_PetBattles.GetLevel(petOwner, petIndex)
C_PetBattles.GetMaxHealth(petOwner, petIndex)
C_PetBattles.GetName(petOwner, slot) : customName, speciesName
C_PetBattles.GetNumAuras(petOwner, petIndex)
C_PetBattles.GetNumPets(petOwner)
C_PetBattles.GetPVPMatchmakingInfo()
C_PetBattles.GetPetSpeciesID(petOwner, petIndex)
C_PetBattles.GetPetType(petOwner, petIndex)
C_PetBattles.GetPlayerTrapAbility()
C_PetBattles.GetPower(petOwner, petIndex)
C_PetBattles.GetSelectedAction()
C_PetBattles.GetSpeed(petOwner, petIndex)
C_PetBattles.GetStateValue(petOwner, petIndex, stateID)
C_PetBattles.GetTurnTimeInfo()
C_PetBattles.GetXP(petOwner, petIndex)
C_PetBattles.IsInBattle()
C_PetBattles.IsPlayerNPC() : isPlayerNPC
C_PetBattles.IsSkipAvailable()
C_PetBattles.IsTrapAvailable()
C_PetBattles.IsWaitingOnOpponent()
C_PetBattles.IsWildBattle() : isWildBattle
C_PetBattles.SetPendingReportBattlePetTarget(petIndex)
C_PetBattles.SetPendingReportTargetFromUnit(unit)
C_PetBattles.ShouldShowPetSelect()
HW C_PetBattles.SkipTurn()
C_PetBattles.StartPVPDuel()
C_PetBattles.StartPVPMatchmaking()
C_PetBattles.StopPVPMatchmaking()
HW C_PetBattles.UseAbility(actionIndex)
HW C_PetBattles.UseTrap()
CanTrackBattlePets() - Returns whether the player can track battle pets.
IsTrackingBattlePets() - Returns whether the player is currently tracking battle pets.
UnitBattlePetLevel()
UnitBattlePetSpeciesID()
UnitBattlePetType()
UnitIsBattlePet(unit)
UnitIsBattlePetCompanion(unit)
UnitIsOtherPlayersBattlePet(unit)
UnitIsWildBattlePet(unit)

Players

C_PlayerInfo.GetAlternateFormInfo() : hasAlternateForm, inAlternateForm
C_PlayerInfo.GetClass(playerLocation) : className, classFilename, classID - Returns the class of a player.
C_PlayerInfo.GetName(playerLocation) : name - Returns the name of a player.
C_PlayerInfo.GetRace(playerLocation) : raceID - Returns the race of a player.
C_PlayerInfo.GetSex(playerLocation) : sex - Returns the sex of a player.
C_PlayerInfo.GUIDIsPlayer(guid) : isPlayer - True if the GUID belongs to a player.
C_PlayerInfo.IsConnected([playerLocation]) : isConnected - True if the player is connected.
C_PlayerInfo.UnitIsSameServer(playerLocation) : unitIsSameServer - True if a player is from the same or connected realm.
Ambiguate(fullName, context) - Returns a version of a character-realm string suitable for use in a given context.
GetAutoCompleteResults(text, include, exclude, maxResults [, cursorPosition]) - Returns possible player names matching a given prefix string and specified requirements.
GetPlayerInfoByGUID(guid) - Returns character info for another player from their GUID.
IsRecognizedName(text, includeBitField, excludeBitField) - Returns true if a given character name is recognized by the client.

Inspection

CanInspect(unit [, showError]) - True if the player can inspect the unit.
CheckInteractDistance(unit, interaction) - True if the player is in range to perform a specific interaction with the unit.
ClearInspectPlayer() - Reset inspect data once finished with it.
GetInspectArenaData(bracketIndex)
GetInspectGuildInfo(unit)
GetInspectHonorData() - Returns honor info for the inspected player unit.
GetInspectRatedBGData()
GetInspectSpecialization(unit) - Returns the specialization for the inspected player unit.
GetInspectTalent()
NotifyInspect(unit) - Requests another player's inventory and talent info before inspecting.
UI InspectUnit(unit) - Instructs FrameXML to inspect a particular unit (query server; show UI).

Trading

Relates to Trading.

HW AcceptTrade() - Accepts the current trade offer.
AddTradeMoney() - Adds money currently held by the cursor to the trade offer.
BeginTrade()
CancelTrade() - Declines the current trade offer.
CancelTradeAccept() - Cancels the trade attempt which required an accept.
ClickTargetTradeButton(index)
ClickTradeButton(index) - Equivalent of a mouseclick on the trade window buttons [1-7].
CloseTrade() - Closes the trade window.
GetPlayerTradeMoney() - Returns the amount of money the player has in the trade window.
GetTargetTradeMoney() - Returns the amount of money in the trade window for the other player.
GetTradePlayerItemInfo(id) - Returns information about a trade item.
GetTradePlayerItemLink(id) - Returns the item link for an item in the trade window.
GetTradeTargetItemInfo(id) - Returns item info for the other player in the trade window.
GetTradeTargetItemLink(id) - Returns the item link for an item from the other player in the trade window.
InitiateTrade(UnitId) - Opens a trade with the specified unit.
SetTradeMoney(copper) - Sets the amount of money offered as part of the player's trade offer.

Summoning

C_IncomingSummon.HasIncomingSummon(unit) : summon - Returns whether a group member has an incoming summon.
C_IncomingSummon.IncomingSummonStatus(unit) : status - Returns the status of an group member's incoming summon.
C_SummonInfo.CancelSummon() - Declines a summon request.
C_SummonInfo.ConfirmSummon() - Accepts a summon request.
C_SummonInfo.GetSummonConfirmAreaName() : areaName - Returns the zone where you will be summoned to.
C_SummonInfo.GetSummonConfirmSummoner() : summoner - Returns the name of the player summoning you.
C_SummonInfo.GetSummonConfirmTimeLeft() : timeLeft - Returns the time left in seconds for accepting a summon.
C_SummonInfo.GetSummonReason() : summonReason
C_SummonInfo.IsSummonSkippingStartExperience() : isSummonSkippingStartExperience
PlayerCanTeleport()

Death

C_DeathInfo.GetCorpseMapPosition(uiMapID) : position - Returns the location of the player's corpse on the map.
C_DeathInfo.GetDeathReleasePosition(uiMapID) : position - When the player is dead and hasn't released spirit, returns the location of the graveyard they will release to.
C_DeathInfo.GetGraveyardsForMap(uiMapID) : graveyards - Returns graveyard info and location for a map.
C_DeathInfo.GetSelfResurrectOptions() : options - Returns self resurrect options for your character, including from soulstones.
C_DeathInfo.UseSelfResurrectOption(optionType, id) - Uses a soulstone or similar means of self resurrection.
AcceptResurrect() - Accepts a resurrection offer.
AcceptXPLoss() - Confirms the resurrection sickness and durability loss penalty on being resurrected by a spirit healer.
CannotBeResurrected()
DeathRecap_GetEvents()
DeathRecap_HasEvents()
DeclineResurrect() - Declines a resurrection offer.
GetCemeteryPreference()
GetCorpseRecoveryDelay() - Time left before a player can accept a resurrection.
GetDeathRecapLink(recapID)
GetReleaseTimeRemaining() - Returns the amount of time left before your ghost is pulled from your body.
GetResSicknessDuration()
HasNoReleaseAura()
IsCemeterySelectionAvailable()
IsEncounterLimitingResurrections()
IsEncounterSuppressingRelease()
NotWhileDeadError() - Generates an error message saying you cannot do that while dead.
PROTECTED PortGraveyard()
RepopMe() - Releases your ghost to the graveyard when dead.
ResurrectGetOfferer() - Returns the name of the person offering to resurrect you.
ResurrectHasSickness() - Appears to be used when accepting a resurrection will give you resurrection sickessness.
ResurrectHasTimer() - Does the player have to wait before accepting a resurrection.
RetrieveCorpse() - Resurrects when the player is standing near its corpse.
SetCemeteryPreference(cemeteryID)
TimeoutResurrect()

Professions

Relates to Professions.

C_TradeSkillUI.AnyRecipeCategoriesFiltered()
C_TradeSkillUI.AreAnyInventorySlotsFiltered()
C_TradeSkillUI.CanObliterateCursorItem()
C_TradeSkillUI.CanTradeSkillListLink()
C_TradeSkillUI.ClearInventorySlotFilter()
C_TradeSkillUI.ClearPendingObliterateItem()
C_TradeSkillUI.ClearRecipeCategoryFilter()
C_TradeSkillUI.ClearRecipeSourceTypeFilter()
C_TradeSkillUI.CloseObliterumForge()
C_TradeSkillUI.CloseTradeSkill() - Closes an open trade skill window.
C_TradeSkillUI.CraftRecipe(recipeSpellID [, numCasts, optionalReagents, recipeLevel]) - Performs the tradeskill a specified number of times.
C_TradeSkillUI.DropPendingObliterateItemFromCursor()
C_TradeSkillUI.GetAllFilterableInventorySlots()
C_TradeSkillUI.GetAllProfessionTradeSkillLines() : skillLineID
C_TradeSkillUI.GetAllRecipeIDs() - Returns all recipes for the current profession.
C_TradeSkillUI.GetCategories()
C_TradeSkillUI.GetCategoryInfo(categoryID [, returnTable])
C_TradeSkillUI.GetFilterableInventorySlots()
C_TradeSkillUI.GetFilteredRecipeIDs()
C_TradeSkillUI.GetObliterateSpellID()
C_TradeSkillUI.GetOnlyShowLearnedRecipes()
C_TradeSkillUI.GetOnlyShowMakeableRecipes()
C_TradeSkillUI.GetOnlyShowSkillUpRecipes()
C_TradeSkillUI.GetOnlyShowUnlearnedRecipes()
C_TradeSkillUI.GetOptionalReagentBonusText(recipeSpellID, optionalReagentIndex, optionalReagents) : bonusText
C_TradeSkillUI.GetOptionalReagentInfo(recipeSpellID [, recipeLevel]) : slots
C_TradeSkillUI.GetPendingObliterateItemID()
C_TradeSkillUI.GetPendingObliterateItemLink()
C_TradeSkillUI.GetRecipeCooldown(recipeID) - Returns the number of seconds left for a skill to cooldown.
C_TradeSkillUI.GetRecipeDescription(recipeID) - Returns the description for a recipe.
C_TradeSkillUI.GetRecipeInfo(recipeSpellID [, recipeLevel]) : recipeInfo - Returns information for a recipe.
C_TradeSkillUI.GetRecipeItemLevelFilter()
C_TradeSkillUI.GetRecipeItemLink(recipeID) - Returns the result item link for a recipe.
C_TradeSkillUI.GetRecipeItemNameFilter()
C_TradeSkillUI.GetRecipeLink(recipeID)
C_TradeSkillUI.GetRecipeNumItemsProduced(recipeID) - Returns the number of items produced for a recipe.
C_TradeSkillUI.GetRecipeNumReagents(recipeSpellID [, recipeLevel]) : numReagents - Returns the number of distinct reagents needed for the specified recipe.
C_TradeSkillUI.GetRecipeReagentInfo(recipeSpellID, reagentIndex [, recipeLevel]) : reagentName, reagentFileID, reagentCount, playerReagentCount - Returns the information for a reagent needed by a recipe.
C_TradeSkillUI.GetRecipeReagentItemLink(recipeID, reagentIndex) - Returns a link for a reagent needed by a recipe.
C_TradeSkillUI.GetRecipeRepeatCount() : recastTimes - Returns the number of times the current item is being crafted.
C_TradeSkillUI.GetRecipeSourceText(recipeID)
C_TradeSkillUI.GetRecipeTools(recipeID) - Returns the required tools for a recipe.
C_TradeSkillUI.GetSubCategories(categoryID)
C_TradeSkillUI.GetTradeSkillDisplayName(skillLineID) : professionDisplayName
C_TradeSkillUI.GetTradeSkillLine() : skillLineID, skillLineDisplayName, skillLineRank, skillLineMaxRank, ... - Returns the current profession displayed in the trade skill window.
C_TradeSkillUI.GetTradeSkillLineForRecipe(recipeID)
C_TradeSkillUI.GetTradeSkillLineInfoByID(skillLineID) : skillLineDisplayName, skillLineRank, skillLineMaxRank, skillLineModifier, ...
C_TradeSkillUI.GetTradeSkillListLink() - Returns a link for the currently displayed profession.
C_TradeSkillUI.GetTradeSkillTexture(tradeSkillID)
C_TradeSkillUI.IsAnyRecipeFromSource(sourceType)
C_TradeSkillUI.IsDataSourceChanging()
C_TradeSkillUI.IsEmptySkillLineCategory(categoryID) : effectivelyKnown
C_TradeSkillUI.IsInventorySlotFiltered(index)
C_TradeSkillUI.IsNPCCrafting() - True if the trade skill window is displayed for an NPC.
C_TradeSkillUI.IsRecipeCategoryFiltered(categoryID [, subCategoryID])
C_TradeSkillUI.IsRecipeFavorite(recipeID)
C_TradeSkillUI.IsRecipeRepeating()
C_TradeSkillUI.IsRecipeSearchInProgress()
C_TradeSkillUI.IsRecipeSourceTypeFiltered(sourceType)
C_TradeSkillUI.IsTradeSkillGuild() - Checks if the Trade Skill UI is open for a profession in the guild.
C_TradeSkillUI.IsTradeSkillGuildMember()
C_TradeSkillUI.IsTradeSkillLinked() - Checks if the Trade Skill UI is open for a profession linked by another character.
C_TradeSkillUI.IsTradeSkillReady()
C_TradeSkillUI.ObliterateItem()
C_TradeSkillUI.OpenTradeSkill(tradeSkillID)
C_TradeSkillUI.SetInventorySlotFilter(index [, enable, exclusive])
C_TradeSkillUI.SetOnlyShowLearnedRecipes()
C_TradeSkillUI.SetOnlyShowMakeableRecipes(onlyMakable) - Controls whether only recipes you have the reagents to craft are shown.
C_TradeSkillUI.SetOnlyShowSkillUpRecipes()
C_TradeSkillUI.SetOnlyShowUnlearnedRecipes()
C_TradeSkillUI.SetRecipeCategoryFilter(categoryID [, subCategoryID])
C_TradeSkillUI.SetRecipeFavorite(recipeID, favorite)
C_TradeSkillUI.SetRecipeItemLevelFilter(minLevel, maxLevel)
C_TradeSkillUI.SetRecipeItemNameFilter()
C_TradeSkillUI.SetRecipeRepeatCount(recipeSpellID [, numCasts, optionalReagents])
C_TradeSkillUI.SetRecipeSourceTypeFilter(sourceType, filtered)
C_TradeSkillUI.StopRecipeRepeat() - Stops creating additional queued items.
AbandonSkill(index) - The player abandons a skill.
GetProfessionInfo(index) - Gets details on a profession from its index including name, icon, and skill level.
GetProfessions() - Returns the spell tab indices of the character's current professions.
GetSpellRank(recipeID) - Returns recipe rank.

Archaeology

Archaeology was added in Patch 4.0.1

C_ResearchInfo.GetDigSitesForMap(uiMapID) : digSites - Returns the dig sites on a map.
ArchaeologyMapUpdateAll() - Updates and returns the amount of digsites in a zone.
ArchaeologyGetIconInfo(index)
ArcheologyGetVisibleBlobID(index) - Returns BlobID of a digsite in the current map-zone.
CanItemBeSocketedToArtifact(itemID) - Returns 1 if item could be added to the selected artifact.
CanScanResearchSite() - True if the character is on a digsite.
CanSolveArtifact() - Returns true if artifact can be solved.
CloseResearch()
GetActiveArtifactByRace(raceIndex) - Returns the active Archaeology artifact for a race.
GetArchaeologyInfo() - Returns the localized name for the Archaeology profession.
GetArchaeologyRaceInfo(raceIndex) - Returns the information for a specific race used in Archaeology.
GetArchaeologyRaceInfoByID(researchBranchID) - Returns info for an Archaeology race.
GetArtifactInfoByRace(raceIndex, artifactIndex) - Returns the information for a specific race's artifact.
GetNumArchaeologyRaces() - Returns the number of Archaeology races in the game.
GetNumArtifactsByRace(raceIndex) - Returns the amount of artifacts the player has acquired from the provided race.
GetSelectedArtifactInfo() - Returns info for the selected race's Archaeology artifact.
GetArtifactProgress() - Returns progress info for the selected Archaeology artifact.
IsArtifactCompletionHistoryAvailable()
ItemAddedToArtifact(keystoneindex) - Returns if there is a keystone in the artifact.
SetSelectedArtifact(raceIndex) - Sets the selected artifact to an archaeology race.
RemoveItemFromArtifact() - Removes a Keystone from the selected artifact.
RequestArtifactCompletionHistory()
SocketItemToArtifact() - Adds a keystone to the selected archaeology artifact.
SolveArtifact() - Solve the selected artifact.

Glyphs

Glyphs were added in Patch 3.0.2. After the Glyph interface was removed in Patch 7.0.3 they were streamlined into the Spellbook.

AttachGlyphToSpell(spellID)
GetCurrentGlyphNameForSpell(spellID)
GetPendingGlyphName()
HasAttachedGlyph(spellID)
HasPendingGlyphCast()
IsCastingGlyph()
IsPendingGlyphRemoval()
IsSpellValidForPendingGlyph(spellID)

Item Socketing

The following were added along with socketed items and gems in Patch 2.0. ID refers to a 1-based index of the sockets in the item being considered for socketing.

C_ItemSocketInfo.CompleteSocketing() - Completes socketing an item, binding it to the player.
AcceptSockets() - Confirms pending gems for socketing.
CloseSocketInfo() - Cancels pending gems for socketing.
GetExistingSocketInfo(id) - Returns information about the existing gem in the socket.
GetExistingSocketLink(id) - Returns an item link for the existing gem in the socket.
GetNewSocketInfo(id) - Returns information about the new (tentative) gem in the socket.
GetNewSocketLink(id) - Returns an item link for the new (tentative) gem in the socket.
GetNumSockets() - Returns the number of sockets for an item in the socketing window.
GetSocketItemBoundTradeable() - True if the item currently being socketed can be traded to other eligible players (BoP boss loot).
GetSocketItemInfo() - Returns info for the item currently being socketed.
GetSocketItemRefundable() - Returns whether the item currently being socketed is refundable.
GetSocketTypes(id) - Returns the type (color) of a socket in the item.
HasBoundGemProposed()
SocketContainerItem(bag, slot) - Consider an item in a container slot for socketing.
SocketInventoryItem(slot) - Considers the item in the inventory slot for socketing.

PvP

Relates to Player vs. Player.

C_PvP.CanDisplayDamage() : canDisplay
C_PvP.CanDisplayDeaths() : canDisplay
C_PvP.CanDisplayHealing() : canDisplay
C_PvP.CanDisplayHonorableKills() : canDisplay
C_PvP.CanDisplayKillingBlows() : canDisplay
C_PvP.CanPlayerUseRatedPVPUI() : canUse, failureReason
C_PvP.DoesMatchOutcomeAffectRating() : doesAffect
C_PvP.GetActiveMatchBracket() : bracket
C_PvP.GetActiveMatchDuration() : seconds
C_PvP.GetActiveMatchState() : state
C_PvP.GetActiveMatchWinner() : winner
C_PvP.GetCustomVictoryStatID() : statID
C_PvP.GetGlobalPvpScalingInfoForSpecID(specializationID) : pvpScalingData
C_PvP.GetHonorRewardInfo(honorLevel) : info
C_PvP.GetMatchPVPStatColumn(pvpStatID) : info
C_PvP.GetMatchPVPStatColumns() : columns
C_PvP.GetNextHonorLevelForReward(honorLevel) : nextHonorLevelWithReward
C_PvP.GetOutdoorPvPWaitTime(uiMapID) : pvpWaitTime - Returns the time until the next battle in a PvP zone like Wintergrasp and Tol Barad.
C_PvP.GetPostMatchCurrencyRewards() : rewards
C_PvP.GetPostMatchItemRewards() : rewards
C_PvP.GetPVPActiveMatchPersonalRatedInfo() : info
C_PvP.GetPVPSeasonRewardAchievementID() : achievementID
C_PvP.GetPvpTierID(tierEnum, bracketEnum) : id
C_PvP.GetPvpTierInfo(tierID) : pvpTierInfo
C_PvP.GetRewardItemLevelsByTierEnum(pvpTierEnum) : activityItemLevel, weeklyItemLevel
C_PvP.GetScoreInfo(offsetIndex) : info
C_PvP.GetScoreInfoByPlayerGuid(guid) : info
C_PvP.GetSeasonBestInfo() : tierID, nextTierID
C_PvP.GetSkirmishInfo(pvpBracket) : battlemasterListInfo
C_PvP.GetTeamInfo(factionIndex) : info
C_PvP.GetWeeklyChestInfo() : rewardAchieved, lastWeekRewardAchieved, lastWeekRewardClaimed, ...
C_PvP.IsActiveMatchRegistered() : registered
C_PvP.IsMatchFactional() : isFactional
C_PvP.IsPVPMap() : isPVPMap
C_PvP.IsRatedMap() : isRatedMap
C_PvP.RequestCrowdControlSpell(playerToken)
AcceptDuel() - Accepts a duel challenge.
CancelDuel() - Forfeits the current duel or declines a duel invitation.
ClearBattlemaster()
ForfeitDuel()
GetPVPDesired() - Returns whether the player has permanently turned on their PvP flag.
GetPVPLifetimeStats() - Returns the character's lifetime PvP statistics.
GetPVPRoles()
GetPVPSessionStats() - Returns the character's Honor statistics for this session.
GetPVPTimer() - Returns the time left in milliseconds until the player is unflagged for PvP.
GetPVPYesterdayStats() - Returns the character's Honor statistics for yesterday.
GetRewardPackArtifactPower(rewardPackID)
GetRewardPackCurrencies(rewardPackID)
GetRewardPackItems(rewardPackID)
GetRewardPackMoney(rewardPackID)
GetRewardPackTitleName(titleID)
GetRewardPackTitle(rewardPackID)
IsCompetitiveModeEnabled()
IsInActiveWorldPVP()
IsPartyWorldPVP()
IsSubZonePVPPOI()
PlayerIsPVPInactive(unit)
RequestPVPOptionsEnabled()
RequestPVPRewards()
SetPVP(enable) - Flags the player for PvP combat.
SetPVPRoles()
SortBGList()
StartDuel(name) - Challenges the specified player to a duel.
TogglePVP() - Toggles PVP status.
UnitHonor(unit) - Returns the current amount of honor the unit has for the current rank.
UnitHonorLevel(unit) - Returns the current honor rank of the unit.
UnitHonorMax(unit) - Returns the maximum amount of honor for the current rank.
UnitIsMercenary()
UnitIsPVPFreeForAll(unit) - True if the unit is flagged for free-for-all PVP (e.g. in a world arena).
UnitIsPVPSanctuary(unit) - Returns whether the unit is in a PvP sanctuary, and therefore cannot be attacked by other players.
UnitIsPVP(unit) - True if the unit is flagged for PVP.
UnitPVPName(unit) - Returns the unit's name with title (e.g. "Bob the Explorer").
UnitPvpClassification(unit) : classification - Returns whether the unit is a flag/orb carrier or cart runner.

Arena

C_PvP.GetArenaCrowdControlInfo(playerToken) : spellID, startTime, duration
C_PvP.GetArenaRewards(teamSize) : honor, experience, itemRewards, currencyRewards
C_PvP.GetArenaSkirmishRewards() : honor, experience, itemRewards, currencyRewards
C_PvP.HasArenaSkirmishWinToday() : hasArenaSkirmishWinToday
C_PvP.IsArena() : isArena
C_PvP.IsMatchConsideredArena() : asArena
C_PvP.IsRatedArena() : isRatedArena
CanSurrenderArena()
GetArenaOpponentSpec()
GetBattlefieldArenaFaction()
GetBattlefieldTeamInfo(index) - Returns info for an Arena team at the end of the match.
GetCurrentArenaSeason() - Returns the current arena season.
GetMaxArenaCurrency()
GetNumArenaOpponents()
GetNumArenaOpponentSpecs()
GetPreviousArenaSeason() - Gets the previous Arena season.
IsActiveBattlefieldArena() - True if the player is inside a (rated) arena.
IsArenaSkirmish()
IsArenaTeamCaptain(teamIndex) - Returns a value based on whether the player is the arena team captain.
IsInArenaTeam() - Returns true if you are a member of an arena team.
JoinArena()
JoinSkirmish(arenaID, joinAsGroup) - Queue for a arena either solo or as a group.
RequeueSkirmish() - Requeues for an arena skirmish.
SurrenderArena()

Solo Shuffle

C_PvP.IsSoloShuffle() : isSoloShuffle
StartSoloShuffleWarGameByName()
StartSpectatorSoloShuffleWarGame()

Battlegrounds

C_PvP.GetBattlefieldFlagPosition(flagIndex, uiMapId) : uiPosx, uiPosy, flagTexture
C_PvP.GetLevelUpBattlegrounds(level) : battlefields
C_PvP.GetRandomBGInfo() : info
C_PvP.GetRandomBGRewards() : honor, experience, itemRewards, currencyRewards
C_PvP.GetRandomEpicBGInfo() : info
C_PvP.GetRandomEpicBGRewards() : honor, experience, itemRewards, currencyRewards
C_PvP.GetRatedBGRewards() : honor, experience, itemRewards, currencyRewards
C_PvP.IsBattleground() : isBattleground
C_PvP.IsBattlegroundEnlistmentBonusActive() : battlegroundActive, brawlActive
C_PvP.IsRatedBattleground() : isRatedBattleground
AcceptAreaSpiritHeal() - Signs up for the Spirit Healer's resurrection timer in battlegrounds when in range.
AcceptBattlefieldPort(index [, acceptFlag]) - Enters the Battleground if the queue is ready.
CanJoinBattlefieldAsGroup() - True if the player can join a battlefield with a group.
CancelAreaSpiritHeal() - Cancels the Spirit Healer's resurrection in battlegrounds.
CheckSpiritHealerDist() - Returns true if you are in range with spirit healer while dead.
GetAreaSpiritHealerTime() - Returns the time left in seconds until the next Spirit Healer resurrection in battlegrounds.
GetBattlefieldEstimatedWaitTime(index) - Returns the estimated queue time to enter the battlefield.
GetBattlefieldInstanceExpiration() - Get shutdown timer for the battlefield instance.
GetBattlefieldInstanceRunTime() - Returns the time passed since the battlefield started.
GetBattlefieldMapIconScale() - Scale of the landmark icons on the battlefield minimap.
GetBattlefieldPortExpiration(index) - Returns the remaining seconds before the battlefield port expires.
DEPRECATED GetBattlefieldScore(index) - Returns info for a player's score in battlefields.
DEPRECATED GetBattlefieldStatData(playerIndex, slotIndex) - Returns battlefield-specific info for a player (e.g. Warsong Gulch flag captures).
GetBattlefieldStatus(index) - Returns the status of the battlefield the player is either queued for or inside.
GetBattlefieldTimeWaited(index) - Returns the time the player has waited in the queue.
GetBattlefieldWinner() - Returns the winner of the battlefield.
GetBattlegroundInfo(index) - Returns information about a battleground type.
GetBattlegroundPoints()
GetMaxBattlefieldID() - Returns the max number of battlefields you can queue for.
GetNumBattlefieldFlagPositions() - Get the number of flag positions available from GetBattlefieldFlagPosition().
GetNumBattlefieldScores() - Returns the number of players listed in the battlefield scoreboard.
GetNumBattlegroundTypes()
GetPersonalRatedInfo(bracketIndex)
GetRatedBattleGroundInfo()
IsPVPTimerRunning()
PROTECTED JoinBattlefield(index [, joinAs]) - Joins the battleground queue solo or as a group.
PROTECTED JoinRatedBattlefield()
LeaveBattlefield() - Leaves the current battleground.
ReportPlayerIsPVPAFK(unit) - Reports the specified player as AFK in a battleground.
RequestBattlefieldScoreData() - Requests the latest battlefield score data from the server.
RequestRandomBattlegroundInstanceInfo()
RequestRatedInfo()
SetBattlefieldScoreFaction([faction]) - Sets the faction to show on the battlefield scoreboard.
SortBattlefieldScoreData(type)
UnitInBattleground(unit) - Returns the unit index if the unit is in your battleground.

World Battlefields

The following functions are used for population-limited world PvP zones, like Lake Wintergrasp or Tol Barad.

C_PvP.IsActiveBattlefield() : isActiveBattlefield
BattlefieldMgrEntryInviteResponse(queueId, accept)
BattlefieldMgrExitRequest(queueId)
BattlefieldMgrQueueInviteResponse(queueId, accept)
BattlefieldMgrQueueRequest()
CanHearthAndResurrectFromArea() - Returns whether you can currently be resurrected and teleported out of the world PvP zone.
HearthAndResurrectFromArea() - Resurrects the player, and ports them out of the world PvP zone.
GetNumWorldPVPAreas() - Returns the number of world PvP zones available.
GetWorldPVPAreaInfo(index) - Returns info for a world PvP zone (e.g. Wintergrasp or Tol Barad).
GetWorldPVPQueueStatus(queueId)

Brawl

C_PvP.GetActiveBrawlInfo() : brawlInfo
C_PvP.GetAvailableBrawlInfo() : brawlInfo
C_PvP.GetBrawlRewards(brawlType) : honor, experience, itemRewards, currencyRewards, hasWon
C_PvP.GetSpecialEventBrawlInfo() : brawlInfo
C_PvP.IsInBrawl() : isInBrawl
C_PvP.JoinBrawl([isSpecialBrawl])

War Games

War Games were added in Patch 4.0.1

CanInitiateWarGame()
CollapseWarGameHeader(index)
ExpandWarGameHeader(index)
GetNumWarGameTypes()
GetSelectedWarGameType()
GetWarGameQueueStatus()
GetWarGameTypeInfo(index)
IsWargame()
SetSelectedWarGameType(index)
StartSpectatorWarGame(target1, target2, size, area, isTournamentMode)
StartWarGameByName(msg) - Starts a War Game. Parameters are playername, area, isTournamentMode but passed as a whitespace delimited string.
StartWarGame(target, name [, isTournament])
UpdateWarGamesList()
WarGameRespond(accept)

War Mode

War Mode was added in Patch 8.0.1

C_PvP.CanToggleWarMode(toggle) : canTogglePvP
C_PvP.CanToggleWarModeInArea() : canTogglePvPInArea
C_PvP.GetWarModeRewardBonus() : rewardBonus
C_PvP.GetWarModeRewardBonusDefault() : defaultBonus
C_PvP.IsWarModeActive() : warModeActive
C_PvP.IsWarModeDesired() : warModeDesired
C_PvP.IsWarModeFeatureEnabled() : warModeEnabled
C_PvP.SetWarModeDesired(warModeDesired)
C_PvP.ToggleWarMode()

Quests

Relates to Quests.

C_QuestLine.GetAvailableQuestLines(uiMapID) : questLines
C_QuestLine.GetQuestLineInfo(questID, uiMapID) : questLineInfo
C_QuestLine.GetQuestLineQuests(questLineID) : questIDs
C_QuestLine.IsComplete(questLineID) : isComplete
C_QuestLine.RequestQuestLinesForMap(uiMapID)
AcknowledgeAutoAcceptQuest()
AddAutoQuestPopUp(QuestID, Type) - Adds a notification to the ObjectiveTrackerFrame that a quest is available or completed.
ClearAutoAcceptQuestSound()
CollapseQuestHeader() - Collapses a quest header.
ConfirmAcceptQuest() - Accepts a quest started by a group member (e.g. escort quests).
ExpandQuestHeader() - Expands/collapses a quest log header.
GetAutoQuestPopUp(Index) - Returns info for a popup quest notification.
GetCriteriaSpell()
GetDailyQuestsCompleted() - Returns the current number of daily quests completed today.
GetMaxRewardCurrencies()
GetNumAutoQuestPopUps() - Returns the number of displayed popup quest notifications.
GetNumQuestCurrencies()
GetNumQuestItemDrops()
GetNumQuestItems() - Returns the number of required items to complete the current quest.
GetNumQuestLeaderBoards([questIndex]) - Returns the number of objectives for a quest.
GetNumQuestPOIWorldEffects()
GetQuestBackgroundMaterial() - Returns the background texture for the displayed quest.
GetQuestCurrencyID(type, index)
GetQuestCurrencyInfo(type, index)
GetQuestExpansion(questID)
GetQuestFactionGroup(questID)
GetQuestLink(index) - Returns a QuestLink for a quest.
GetQuestObjectiveInfo(questID, index, displayComplete)
GetQuestPOIBlobCount(questID)
GetQuestPOILeaderBoard(index)
GetQuestPOIs()
GetQuestProgressBarPercent(questID)
GetQuestResetTime() - Returns the number of seconds until daily quests reset.
GetQuestReward(rewardIndex) - Completes the quest and chooses a quest reward, if applicable.
GetQuestSortIndex(questIndex)
GetQuestSpellLink(rewardSpellIndex)
GetQuestUiMapID(questID)
GetSuggestedGroupSize()
HaveQuestData(questID)
HaveQuestRewardData(questID)
IsBreadcrumbQuest(questID)
IsCurrentQuestFailed()
IsQuestCompletable() - True if the displayed quest at a quest giver can be completed.
IsQuestIDValidSpellTarget(questID)
IsQuestItemHidden(index)
IsQuestSequenced(questID)
IsStoryQuest(questID)
IsTrackingHiddenQuests()
PlayAutoAcceptQuestSound()
QuestChooseRewardError() - Throws an error when the quest reward method doesn't work.
QuestFlagsPVP() - Determine if the quest will flag you you for PvP when accepted.
QuestGetAutoAccept() - Returns whether the last-offered quest was automatically accepted.
QuestGetAutoLaunched()
QuestHasPOIInfo(questID)
QuestIsDaily() - True if the offered quest is a daily quest.
QuestIsFromAreaTrigger()
QuestIsWeekly() - True if the offered quest is a weekly quest.
QuestMapUpdateAllQuests()
QuestPOIGetIconInfo(questID)
QuestPOIGetSecondaryLocations(questID [, table])
QuestPOIUpdateIcons()
RemoveAutoQuestPopUp()
ShowQuestComplete(index)
ShowQuestOffer(index)
SortQuests()
SortQuestSortTypes()
UnitQuestTrivialLevelRangeScaling(unit) : levelRange
UI PVPGetConquestLevelInfo()
UI QuestUtils_GetQuestName() - Returns the name for a quest ID.

Quest Log

C_QuestLog.AbandonQuest() - Abandons the quest specified by C_QuestLog.SetAbandonQuest.
C_QuestLog.AddQuestWatch(questID [, watchType]) : wasWatched - Tracks a quest.
C_QuestLog.AddWorldQuestWatch(questID [, watchType]) : wasWatched - Tracks a world quest.
C_QuestLog.CanAbandonQuest(questID) : canAbandon
C_QuestLog.GetAbandonQuest() : questID - Returns the quest specified by C_QuestLog.SetAbandonQuest.
C_QuestLog.GetAbandonQuestItems() : itemIDs
C_QuestLog.GetActiveThreatMaps() : uiMapIDs
C_QuestLog.GetAllCompletedQuestIDs() : quests - Returns all completed quests for the character.
C_QuestLog.GetBountiesForMapID(uiMapID) : bounties
C_QuestLog.GetBountySetInfoForMapID(uiMapID) : displayLocation, lockQuestID, bountySetID
C_QuestLog.GetDistanceSqToQuest(questID) : distanceSq, onContinent
C_QuestLog.GetInfo(questLogIndex) : info - Returns information about a quest in the player's quest log.
C_QuestLog.GetLogIndexForQuestID(questID) : questLogIndex - Returns the quest log index for a quest ID.
C_QuestLog.GetMapForQuestPOIs() : uiMapID
C_QuestLog.GetMaxNumQuests() : maxNumQuests - This is the maximum number of quests a player can be on, including hidden quests, world quests, emissaries etc
C_QuestLog.GetMaxNumQuestsCanAccept() : maxNumQuestsCanAccept - This is the maximum number of standard quests a player can accept. These are quests that are normally visible in the quest log.
C_QuestLog.GetNumQuestLogEntries() : numShownEntries, numQuests - Returns the number of entries in the quest log.
C_QuestLog.GetNumQuestObjectives(questID) : leaderboardCount
C_QuestLog.GetNumQuestWatches() : numQuestWatches - Returns the number of tracked quests.
C_QuestLog.GetNumWorldQuestWatches() : numQuestWatches
C_QuestLog.GetQuestAdditionalHighlights(questID) : uiMapID, worldQuests, worldQuestsElite, dungeons, treasures
C_QuestLog.GetQuestDetailsTheme(questID) : theme
C_QuestLog.GetQuestDifficultyLevel(questID) : level
C_QuestLog.GetQuestIDForLogIndex(questLogIndex) : questID
C_QuestLog.GetQuestIDForQuestWatchIndex(questWatchIndex) : questID
C_QuestLog.GetQuestIDForWorldQuestWatchIndex(questWatchIndex) : questID
C_QuestLog.GetQuestLogPortraitGiver([questLogIndex]) : portraitGiver, portraitGiverText, portraitGiverName, portraitGiverMount, ...
C_QuestLog.GetQuestObjectives(questID) : objectives - Returns info for the objectives of a quest.
C_QuestLog.GetQuestsOnMap(uiMapID) : quests
C_QuestLog.GetQuestTagInfo(questID) : info - Returns metadata for a quest.
C_QuestLog.GetQuestType(questID) : questType
C_QuestLog.GetQuestWatchType(questID) : watchType
C_QuestLog.GetRequiredMoney([questID]) : requiredMoney - Returns the amount of money required for quest completion.
C_QuestLog.GetSelectedQuest() : questID - Returns the quest specified by C_QuestLog.SetSelectedQuest.
C_QuestLog.GetSuggestedGroupSize(questID) : suggestedGroupSize - Returns the suggested number of players for a quest.
C_QuestLog.GetTimeAllowed(questID) : totalTime, elapsedTime - Returns the time available to complete a quest.
C_QuestLog.GetTitleForLogIndex(questLogIndex) : title
C_QuestLog.GetTitleForQuestID(questID) : title - Returns the name for a Quest ID.
C_QuestLog.GetZoneStoryInfo(uiMapID) : achievementID, storyMapID
C_QuestLog.HasActiveThreats() : hasActiveThreats
C_QuestLog.IsAccountQuest(questID) : isAccountQuest
C_QuestLog.IsComplete(questID) : isComplete
C_QuestLog.IsFailed(questID) : isFailed
C_QuestLog.IsLegendaryQuest(questID) : isLegendaryQuest
C_QuestLog.IsOnMap(questID) : onMap, hasLocalPOI
C_QuestLog.IsOnQuest(questID) : isOnQuest
C_QuestLog.IsPushableQuest(questID) : isPushable - True if the quest can be shared with other players.
C_QuestLog.IsQuestBounty(questID) : isBounty
C_QuestLog.IsQuestCalling(questID) : isCalling
C_QuestLog.IsQuestCriteriaForBounty(questID, bountyQuestID) : isCriteriaForBounty
C_QuestLog.IsQuestFlaggedCompleted(questID) : isCompleted - Returns if a quest has been completed.
C_QuestLog.IsQuestInvasion(questID) : isInvasion
C_QuestLog.IsQuestTrivial(questID) : isTrivial
C_QuestLog.IsRepeatableQuest(questID) : isRepeatable
C_QuestLog.IsThreatQuest(questID) : isThreat
C_QuestLog.IsUnitOnQuest(unit, questID) : isOnQuest - True if the unit is on the specified quest.
C_QuestLog.QuestCanHaveWarModeBonus(questID) : hasBonus
C_QuestLog.QuestHasWarModeBonus(questID) : hasBonus
C_QuestLog.ReadyForTurnIn(questID) : readyForTurnIn
C_QuestLog.RemoveQuestWatch(questID) : wasRemoved - Untracks a quest.
C_QuestLog.RemoveWorldQuestWatch(questID) : wasRemoved - Untracks a world quest.
C_QuestLog.RequestLoadQuestByID(questID)
C_QuestLog.SetAbandonQuest() - Sets the selected quest to be abandoned.
C_QuestLog.SetMapForQuestPOIs(uiMapID)
C_QuestLog.SetSelectedQuest(questID) - Selects a quest in the quest log.
C_QuestLog.ShouldDisplayTimeRemaining(questID) : displayTimeRemaining
C_QuestLog.ShouldShowQuestRewards(questID) : shouldShow
C_QuestLog.SortQuestWatches() - Sorts watched quests by proximity to the player character.
C_PlayerInfo.GetContentDifficultyQuestForPlayer(questID) : difficulty
GetNumQuestLogChoices() - Returns the number of options someone has when getting a quest item.
GetNumQuestLogRewardCurrencies()
GetNumQuestLogRewardFactions()
GetNumQuestLogRewards() - Returns the number of unconditional rewards for the current quest in the quest log.
GetNumQuestLogRewardSpells() - Returns the number of spell rewards for the current selected quest.
GetNumTreasurePickerItems()
GetQuestLogChoiceInfoLootType(index)
GetQuestLogCompletionText()
GetQuestLogCriteriaSpell()
GetQuestLogItemDrop(index)
GetQuestLogItemLink(type, index) - Returns item link for selected quest reward/choice/required item from quest log.
GetQuestLogLeaderBoard(ldrIndex [, questIndex]) - Returns info for a quest objective in the quest log.
GetQuestLogPortraitTurnIn()
GetQuestLogQuestText() - Returns the description and objective text in the quest log.
GetQuestLogQuestType()
GetQuestLogRewardArtifactXP()
GetQuestLogRewardCurrencyInfo(index [, questID])
GetQuestLogRewardFactionInfo(questIndex)
GetQuestLogRewardHonor()
GetQuestLogRewardInfo() - Returns info for an unconditional quest reward item in the quest log.
GetQuestLogRewardMoney() - Returns the amount of money rewarded for a quest.
GetQuestLogRewardSkillPoints()
GetQuestLogRewardSpell() - Returns the spell reward for a quest.
GetQuestLogRewardTitle()
GetQuestLogRewardXP()
GetQuestLogSpecialItemCooldown(index)
GetQuestLogSpecialItemInfo(index)
GetQuestLogSpellLink(rewardSpellIndex)
GetQuestLogTimeLeft() - Returns the time left in seconds for the current quest.
GetTreasurePickerItemInfo(index [, questID])
IsQuestLogSpecialItemInRange(index [, target])
ProcessQuestLogRewardFactions()
QuestLogPushQuest() - Shares the current quest in the quest log with other players.
QuestLogRewardHasTreasurePicker()
QuestLogShouldShowPortrait()
UseQuestLogSpecialItem(index)

Gossip

Gossip refers to interaction with an NPC.

C_GossipInfo.CloseGossip() - Closes the gossip window.
C_GossipInfo.ForceGossip() : forceGossip - True if gossip text must be displayed. For example making this return true shows the Banker gossip.
C_GossipInfo.GetActiveQuests() : info - Returns the quests which can be turned in at a quest giver.
C_GossipInfo.GetAvailableQuests() : info - Returns the available quests at a quest giver.
C_GossipInfo.GetCompletedOptionDescriptionString() : description
C_GossipInfo.GetCustomGossipDescriptionString() : description
C_GossipInfo.GetNumActiveQuests() : numQuests - Returns the number of active quests that you should eventually turn in to this NPC.
C_GossipInfo.GetNumAvailableQuests() : numQuests - Returns the number of quests (that you are not already on) offered by this NPC.
C_GossipInfo.GetNumOptions() : numOptions - Returns the number of conversation options available with this NPC.
C_GossipInfo.GetOptions() : info - Returns the available gossip options at a quest giver.
C_GossipInfo.GetPoiForUiMapID(uiMapID) : gossipPoiID - Returns any gossip point of interest on the map.
C_GossipInfo.GetPoiInfo(uiMapID, gossipPoiID) : gossipPoiInfo - Returns info for a gossip point of interest (e.g. the red flags when asking city guards for directions).
C_GossipInfo.GetText() : gossipText - Returns the gossip text.
C_GossipInfo.RefreshOptions()
C_GossipInfo.SelectActiveQuest(index) - Selects an active quest from the gossip window.
C_GossipInfo.SelectAvailableQuest(index) - Selects an available quest from the gossip window.
C_GossipInfo.SelectOption(index [, text, confirmed]) - Selects a gossip (conversation) option.
AcceptQuest() - Accepts the currently offered quest.
CloseQuest() - Closes the shown quest.
CompleteQuest() - Continues the quest dialog to the reward selection step.
DeclineQuest() - Declines the currently offered quest.
GetActiveLevel(index) - Gets the level of an active quest (only available after QUEST_GREETING event).
GetActiveQuestID(index)
GetActiveTitle(index) - Gets the title of an active quest (only available after QUEST_GREETING event).
GetAvailableLevel(index) - Gets the level of an available quest (only available after QUEST_GREETING event).
GetAvailableQuestInfo(index) - Returns info for an available quest.
GetAvailableTitle(index) - Gets the title of an available quest (only available after QUEST_GREETING event).
GetGreetingText()
GetNumActiveQuests() - Returns the number of quests which can be turned in at a non-gossip quest giver.
GetNumAvailableQuests() - Returns the number of available quests at a non-gossip quest giver.
GetNumQuestRewards() - Returns the number of unconditional rewards at a quest giver.
GetNumRewardCurrencies()
GetNumRewardSpells()
GetObjectiveText() - Gets the objective of the current quest.
GetProgressText() - Returns quest progress text at a quest giver.
GetQuestID() - Returns the ID of the displayed quest at a quest giver.
GetQuestItemInfo() - Returns info for a required/reward/choice quest item.
GetQuestItemInfoLootType(type, index)
GetQuestItemLink(type, index) - Returns the item link for a required/reward/choice quest item.
GetQuestMoneyToGet() - Returns amount of money required for quest currently displayed in gossip.
GetQuestPortraitGiver()
GetQuestPortraitTurnIn()
GetQuestText() - Gets the description of the current quest.
GetRewardArtifactXP()
GetRewardHonor()
GetRewardMoney() - Returns a amount of copper rewarded for completion of quest displayed in gossip.
GetRewardNumSkillUps()
GetRewardSkillLineID()
GetRewardSkillPoints()
GetRewardSpell() - Returns the spell reward for the quest in the gossip window.
GetRewardText() - Returns quest reward text, displayed by the NPC before the player hits "Complete Quest".
GetRewardTitle() - Returns the title awarded by the currently displayed quest.
GetRewardXP() - Returns the experience reward for the quest in the gossip window.
GetTitleText() - Returns the name of the quest at the quest giver.
IsActiveQuestLegendary(index)
IsActiveQuestTrivial(index)
IsAvailableQuestTrivial(index)
SelectActiveQuest() - Selects an active quest from the NPC (only available after QUEST_GREETING event).
SelectAvailableQuest() - Selects an available quest from the NPC (only available after QUEST_GREETING event).

Quest Choices

Relates to multiple quest choices, for instance at the Hero's Call Board and Warchief's Command Board.

C_PlayerChoice.GetCurrentPlayerChoiceInfo() : choiceInfo
C_PlayerChoice.GetNumRerolls() : numRerolls
C_PlayerChoice.GetRemainingTime() : remainingTime
C_PlayerChoice.IsWaitingForPlayerChoiceResponse() : isWaitingForResponse
C_PlayerChoice.OnUIClosed()
C_PlayerChoice.RequestRerollPlayerChoice()
C_PlayerChoice.SendPlayerChoiceResponse(responseID)
GetNumQuestChoices() - Returns the number of available rewards for the current quest.
GetQuestLogChoiceInfo() - Returns a bunch of data about a quest reward choice from the quest log.
DEPRECATED ClosePlayerChoice()
DEPRECATED C_PlayerChoice.GetPlayerChoiceInfo() : choiceInfo - Returns information about a quest choice fork.
DEPRECATED C_PlayerChoice.GetPlayerChoiceOptionInfo(optionIndex) : info - Returns information about an offered quest choice option.
DEPRECATED C_PlayerChoice.GetPlayerChoiceRewardInfo(rewardIndex) : rewardInfo - Returns reward info on a quest option.

World Quests

Task Quests refer to World Quests or Bonus Objective quests.

C_TaskQuest.DoesMapShowTaskQuestObjectives(uiMapID) : showsTaskQuestObjectives
C_TaskQuest.GetQuestInfoByQuestID(questID) : questTitle, factionID, capped, displayAsObjective
C_TaskQuest.GetQuestLocation(questID, uiMapID) : locationX, locationY
C_TaskQuest.GetQuestProgressBarInfo(questID) : progress
C_TaskQuest.GetQuestTimeLeftMinutes(questID) : minutesLeft
C_TaskQuest.GetQuestTimeLeftSeconds(questID) : secondsLeft
C_TaskQuest.GetQuestZoneID(questID) : uiMapID
C_TaskQuest.GetQuestsForPlayerByMapID(uiMapID) : taskPOIs
C_TaskQuest.GetThreatQuests() : quests
C_TaskQuest.IsActive(questID) : active
C_TaskQuest.RequestPreloadRewardData(questID)
C_QuestLog.IsQuestTask(questID) : isTask
C_QuestLog.IsWorldQuest(questID) : isWorldQuest
GetNumQuestLogTasks()
GetTaskInfo(questID)
GetTaskPOIs()
GetTasksTable()

Adventure Map

The Scouting Map was added in Patch 7.0.3

C_AdventureMap.Close()
C_AdventureMap.GetMapID()
C_AdventureMap.GetMapInsetDetailTileInfo(insetIndex, tileIndex)
C_AdventureMap.GetMapInsetInfo(insetIndex)
C_AdventureMap.GetNumMapInsets()
C_AdventureMap.GetNumQuestOffers()
C_AdventureMap.GetNumZoneChoices()
C_AdventureMap.GetQuestInfo(questID)
C_AdventureMap.GetQuestOfferInfo(offerIndex)
C_AdventureMap.GetZoneChoiceInfo(choiceIndex)
C_AdventureMap.StartQuest(questID)
QuestIsFromAdventureMap()

War Campaigns

War Campaigns were added in Patch 8.0.1

C_CampaignInfo.GetAvailableCampaigns() : campaignIDs
C_CampaignInfo.GetCampaignChapterInfo(campaignChapterID) : campaignChapterInfo
C_CampaignInfo.GetCampaignID(questID) : campaignID
C_CampaignInfo.GetCampaignInfo(campaignID) : campaignInfo
C_CampaignInfo.GetChapterIDs(campaignID) : chapterIDs
C_CampaignInfo.GetCurrentChapterID(campaignID) : currentChapterID
C_CampaignInfo.GetFailureReason(campaignID) : failureReason
C_CampaignInfo.GetState(campaignID) : state
C_CampaignInfo.IsCampaignQuest(questID) : isCampaignQuest
C_CampaignInfo.UsesNormalQuestIcons(campaignID) : useNormalQuestIcons
C_LoreText.RequestLoreTextForCampaignID(campaignID)

Talking Head

These functions were added in Patch 7.0.3

C_TalkingHead.GetConversationsDeferred()
C_TalkingHead.GetCurrentLineAnimationInfo()
C_TalkingHead.GetCurrentLineInfo()
C_TalkingHead.IgnoreCurrentTalkingHead()
C_TalkingHead.IsCurrentTalkingHeadIgnored()
C_TalkingHead.SetConversationsDeferred(deferred)

Races

C_CreatureInfo.GetFactionInfo(raceID) : factionInfo - Returns the faction name for a race.
C_CreatureInfo.GetRaceInfo(raceID) : raceInfo - Returns both localized and locale-independent race names.
NeutralPlayerSelectFaction() - Allows a Pandaren to choose a faction.

Allied Races were added in Patch 7.3.5

C_AlliedRaces.ClearAlliedRaceDetailsGiver()
C_AlliedRaces.GetAllRacialAbilitiesFromID(raceID) : allDisplayInfo - Returns the racial spells from an allied race.
C_AlliedRaces.GetRaceInfoByID(raceID) : info - Returns allied race info.
UnitAlliedRaceInfo(unit) : isAlliedRace, hasHeritageArmorUnlocked

Realms

Relates to Realms.

GetAutoCompleteRealms()
GetCurrentRegion()
GetCurrentRegionName() : regionName
GetNormalizedRealmName() - Returns the name of the server, but omitting spaces and hyphens.
GetRealmID()
GetRealmName() - Returns the realm name.
IsOnTournamentRealm() - Returns true if currently on a tournament realm, nil otherwise.

Reputation

Relates to Reputation.

C_Reputation.GetFactionParagonInfo(factionID) : currentValue, threshold, rewardQuestID, hasRewardPending, ... - Returns Paragon info on a faction.
C_Reputation.IsFactionParagon(factionID) : hasParagon - True if a faction is a paragon reputation.
C_Reputation.RequestFactionParagonPreloadRewardData(factionID) - Queries the server to pre-load Paragon reward data.
CollapseFactionHeader(index) - Collapse a faction header row.
CollapseAllFactionHeaders() - Collapse all faction header rows.
ExpandFactionHeader(index) - Expand a faction header row.
ExpandAllFactionHeaders() - Expand all faction header rows.
FactionToggleAtWar(index) - Toggles the At War status for a faction.
GetFactionInfo(index) - Returns info for a faction.
GetFactionInfoByID(factionID) - Gets details for a specific faction by factionID.
GetFriendshipReputation(factionID) - Returns info for a friendship reputation.
GetFriendshipReputationRanks(factionID) - Returns the (max) rank for a friendship reputation.
GetNumFactions() - Returns the number of lines in the faction display.
GetSelectedFaction() - Returns the row index of the currently selected faction in reputation window.
GetWatchedFactionInfo() - Returns info for the currently watched faction.
IsFactionInactive(index) - True if the specified faction is marked inactive.
SetFactionActive(index) - Flags the specified faction as active in the reputation window.
SetFactionInactive(index) - Flags the specified faction as inactive in the reputation window.
SetSelectedFaction(index) - Sets the currently selected faction in reputation window.
SetWatchedFactionIndex(index) - Watches a faction in the reputation window.

Spells

C_Spell.DoesSpellExist(spellID) : spellExists
C_Spell.IsSpellDataCached(spellID) : isCached
C_Spell.RequestLoadSpellData(spellID)
C_ZoneAbility.GetActiveAbilities() : zoneAbilities
AcceptSpellConfirmationPrompt(spellID)
NOCOMBAT CancelSpellByName(name)
PROTECTED CastSpell(spellIndex, bookType) - Casts a spell from the spellbook.
PROTECTED CastSpellByID(spellID [, target])
PROTECTED CastSpellByName(name [, target]) - Casts a spell by name.
DeclineSpellConfirmationPrompt(spellID)
DoesSpellExist(spellName)
FindBaseSpellByID(spellID)
FindSpellOverrideByID(spellID)
GetMaxSpellStartRecoveryOffset()
GetSchoolString(schoolMask)
GetSpellAutocast(spellName | spellId, bookType) - True if a (pet) spell is autocastable.
GetSpellBaseCooldown(spellID)
GetSpellCharges(spellId | spellName) - Returns information about the charges of a charge-accumulating player ability.
GetSpellConfirmationPromptsInfo()
GetSpellCooldown(spellName | spellID, bookType) - Returns the cooldown info of a spell.
GetSpellCount()
GetSpellDescription(spellId) - Returns the spell description.
GetSpellInfo(spellId) : name, rank, icon, castTime, minRange, maxRange, spellID - Returns spell info.
GetSpellLink(spellName, spellRank) - Returns the hyperlink for a spell.
GetSpellPowerCost(spellId | spellName) - Returns resource cost info for a spell.
GetSpellQueueWindow()
GetSpellSubtext()
GetSpellTexture(spellId | spellName) - Returns the icon texture of a spell.
GetSpellTradeSkillLink()
IsAttackSpell(spell) - True if a spellbook item is the "Auto Attack" spell.
IsAutoRepeatSpell(spell)
IsConsumableSpell()
IsCurrentSpell(spellID) - True if the specified spell ID is currently being casted or queued.
IsHarmfulSpell(spellSlot) - Returns whether a spell can be used against hostile units
IsHelpfulSpell(spellSlot) - Returns whether an item can be used on the player or friendly units
IsPassiveSpell(spellID, bookType) - True if the specified spell is a passive ability.
IsPlayerSpell(spellID)
IsSpellInRange(spellName [, unit]) - True if the player is in range to use the specified spell on the target unit.
IsSpellKnown(spellID, isPetSpell) - Returns whether the player (or pet) knows the given spell.
IsSpellKnownOrOverridesKnown(spellID [, isPet])
IsSpellOverlayed(spellID) - True if the specified spell currently has a proc / spell activation alert (glowing border).
IsUsableSpell(spellName | spellID | spellIndex, bookType) - Determines whether a spell can be used by the player character.
SpellCancelQueuedSpell()
SpellCanTargetItem()
SpellCanTargetItemID()
SpellCanTargetQuest()
SpellCanTargetUnit(unit) - True if the spell awaiting target selection can be cast on the unit.
SpellGetVisibilityInfo(spellID, visType)
SpellHasRange(spell) - Returns true if the specified spell has a ranged effect (i.e. requires a target).
SpellIsAlwaysShown(spellID)
SpellIsPriorityAura(spellID)
SpellIsSelfBuff(spellID)
SpellIsTargeting() - True if a spell is about to be cast and is waiting for the player to select a target.
PROTECTED SpellStopCasting() - Stops the current spellcast.
PROTECTED SpellStopTargeting() - Cancels the spell awaiting target selection.
PROTECTED SpellTargetUnit(unit) - Casts the spell awaiting target selection on the unit.
PROTECTED SpellTargetItem(item)
UI QueryCastSequence(sequence) - Returns index, item, spell for the spell/item that will be used next if the cast sequence is executed.

Spell Book

C_SpellBook.ContainsAnyDisenchantSpell() : contains
C_SpellBook.GetCurrentLevelSpells(level) : spellIDs
C_SpellBook.GetSkillLineIndexByID(skillLineID) : skillIndex
C_SpellBook.GetSpellInfo(spellID) : spellInfo
C_SpellBook.GetSpellLinkFromSpellID(spellID) : spellLink
C_SpellBook.IsSpellDisabled(spellID) : disabled
FindSpellBookSlotBySpellID(spellID [, isPet])
GetNumSpellTabs() - Returns the number of tabs in the spellbook.
GetSpellAvailableLevel(spellSlot)
GetSpellBookItemInfo(spellName or index, bookType) - Returns info for a spellbook item.
GetSpellBookItemName(spellName or index, bookType) - Returns the name of a spellbook item.
GetSpellBookItemTexture(spellName or index, bookType) - Returns the icon texture of a spellbook item.
GetSpellLevelLearned()
GetSpellTabInfo(spellbookTabNum) - Returns info for the specified spellbook tab.
IsSelectedSpellBookItem(spellSlot)

Store

The In-Game Store was added in Patch 5.4.0

C_StorePublic.DoesGroupHavePurchaseableProducts(groupID) : hasPurchaseableProducts
C_StorePublic.IsDisabledByParentalControls() : disabled - Returns whether access to the in-game shop is disabled by parental controls.
C_StorePublic.IsEnabled() : enabled - Returns whether the In-Game Store is available for the player.

Character Boosts were added in Patch 5.4.7

PROTECTED C_CharacterServices.AssignPCTDistribution()
PROTECTED C_CharacterServices.AssignPFCDistribution()
PROTECTED C_CharacterServices.AssignUpgradeDistribution()
PROTECTED C_CharacterServices.GetActiveCharacterUpgradeBoostType()
PROTECTED C_CharacterServices.GetActiveClassTrialBoostType()
PROTECTED C_CharacterServices.GetAutomaticBoost()
PROTECTED C_CharacterServices.GetAutomaticBoostCharacter()
PROTECTED C_CharacterServices.GetCharacterServiceDisplayData()
PROTECTED C_CharacterServices.GetCharacterServiceDisplayDataByVASType()
PROTECTED C_CharacterServices.GetCharacterServiceDisplayInfo()
PROTECTED C_CharacterServices.GetVASDistributions()
PROTECTED C_CharacterServices.HasRequiredBoostForClassTrial()
PROTECTED C_CharacterServices.HasRequiredBoostForUnrevoke()
PROTECTED C_CharacterServices.SetAutomaticBoost()
PROTECTED C_CharacterServices.SetAutomaticBoostCharacter()
IsCharacterNewlyBoosted()

Class Trials were added in Patch 6.0.2

C_ClassTrial.GetClassTrialLogoutTimeSeconds()
C_ClassTrial.IsClassTrialCharacter()
C_CharacterServicesPublic.ShouldSeeControlPopup()
C_SharedCharacterServices.GetLastSeenCharacterUpgradePopup()
C_SharedCharacterServices.GetLastSeenExpansionTrialPopup()
C_SharedCharacterServices.GetUpgradeDistributions()
C_SharedCharacterServices.HasFreePromotionalUpgrade()
C_SharedCharacterServices.HasSeenFreePromotionalUpgradePopup()
C_SharedCharacterServices.IsPurchaseIDPendingUpgrade()
C_SharedCharacterServices.QueryClassTrialBoostResult()
C_SharedCharacterServices.SetCharacterUpgradePopupSeen(expansion_id)
C_SharedCharacterServices.SetExpansionTrialPopupSeen(expansion_id)
C_SharedCharacterServices.SetPromotionalPopupSeen(seen)

System

HW C_UI.Reload() - Reloads the User Interface.
C_System.GetFrameStack() : objects
CancelLogout() - Cancels the logout timer (from camping or quitting).
PROTECTED CopyToClipboard(text) - Copies text to the clipboard.
DetectWowMouse() - Attempts to detect the world of warcraft MMO mouse.
FlashClientIcon() - Flashes the game client icon in the Operating System.
PROTECTED ForceLogout()
PROTECTED ForceQuit() - Instantly quits the game, ignoring the 20 seconds timer.
GetBuildInfo() - Returns info for the current client build.
GetFramerate() - Returns the current framerate.
GetTickTime() - Returns the time in seconds since the end of the previous frame and the start of the current frame.
Is64BitClient()
IsDebugBuild()
IsGMClient()
IsLinuxClient() - True if on a Linux client.
IsLoggedIn() - Returns nil before the PLAYER_LOGIN event has fired, 1 afterwards.
IsMacClient() - True if on a Mac client.
IsOnGlueScreen()
IsPublicBuild()
IsTestBuild()
IsUsingFixedTimeStep() - Whether the UI is updating at a fixed rate independent of the framerate.
IsWindowsClient() - True if on a Windows client.
LoadURLIndex(index)
PROTECTED Logout() - Logs the player out of the game.
ProcessExceptionClient()
PROTECTED Quit() - Quits the game.
Screenshot() - Takes a screenshot.
SendSystemMessage(message) - Prints a yellow CHAT_MSG_SYSTEM message.
PROTECTED Stuck() - Notifies the game engine that the player is stuck.
UI ToggleFramerate() - Show/Hide the FPS.

Network

GetAvailableBandwidth()
GetBackgroundLoadingStatus()
GetDownloadedPercentage()
GetFileStreamingStatus()
GetNetIpTypes()
GetNetStats() - Returns bandwidth and latency network information.

Console

Relates to Console variables and commands.

C_CVar.GetCVar(name) : value - Returns the current value of a console variable.
C_CVar.GetCVarBitfield(name, index) : value - Returns the bitfield of a console variable.
C_CVar.GetCVarBool(name) : value - Returns the boolean value of a console variable.
C_CVar.GetCVarDefault(name) : defaultValue - Returns the default value of a console variable.
C_CVar.RegisterCVar(name [, value]) - Temporarily registers a custom console variable.
C_CVar.ResetTestCVars() - Resets the ActionCam cvars.
C_CVar.SetCVar(name [, value, scriptCVar]) : success - Sets a console variable.
C_CVar.SetCVarBitfield(name, index, value [, scriptCVar]) : success - Sets the bitfield of a console variable.
C_Console.GetAllCommands() : commands - Returns all console variables and commands.
C_Console.GetColorFromType(colorType) : color - Returns color info for a color type.
C_Console.GetFontHeight() : fontHeightInPixels - Returns the console's currently used font height.
C_Console.PrintAllMatchingCommands(partialCommandText) - Prints all matching console commands.
C_Console.SetFontHeight(fontHeightInPixels) - Sets the console's font height.
ConsoleAddMessage(message) - Prints a message to the console window.
ConsoleExec(command) - Execute a console command.
GetCVarInfo(name) - Returns information on a console variable.
SetConsoleKey(key) - Sets the console key (normally ~).

Date & Time

C_DateAndTime.AdjustTimeByDays(date, days) : newDate - Returns the date after a specified amount of days.
C_DateAndTime.AdjustTimeByMinutes(date, minutes) : newDate - Returns the date after a given amount of minutes.
C_DateAndTime.CompareCalendarTime(lhsCalendarTime, rhsCalendarTime) : comparison - Compares two dates with eachother.
C_DateAndTime.GetCalendarTimeFromEpoch(epoch) : date - Returns the date for a specified amount of time since the UNIX epoch for the OS time zone.
C_DateAndTime.GetCurrentCalendarTime() : date - Returns the realm's current date and time.
C_DateAndTime.GetSecondsUntilDailyReset() : seconds
C_DateAndTime.GetSecondsUntilWeeklyReset() : seconds
C_DateAndTime.GetServerTimeLocal() : serverTimeLocal - Returns the server's Unix time offset by the server's timezone.
GetGameTime() - Returns the realm's current time in hours and minutes.
GetLocalGameTime()
GetServerTime() - Returns the server's Unix time.
GetSessionTime() - Returns the time since you opened the game client.
GetTime() - Returns the system uptime of your computer in seconds, with millisecond precision.
GetTimePreciseSec() - Returns a monotonic timestamp in seconds, with millisecond precision.
RequestTimePlayed() - Requests a summary of time played.
Lua date(format, time) - Returns the current date according to the user's machine.
Lua time(table) - Returns a timestamp for the specified time or the current Unix time.

Timers

C_Timer.After(duration, callback) - Schedules a timer.
UI C_Timer.NewTimer(duration, callback) - Runs callback after given duration. (Cancelable)
UI C_Timer.NewTicker(duration, callback [, iterations]) - Runs callback multiple times iterating every given duration. (Cancelable)

Debugging

AreDangerousScriptsAllowed()
DumpMovementCapture() - Used in the protected Commentator UI.
FrameXML_Debug(flag) - Sets FrameXML logging state which is output to "/WoW Folder/Logs/FrameXML.log".
GetCurrentEventID()
GetEventTime(eventProfileIndex)
GetGameMessageInfo(gameMessageType) - Returns the error message for an id.
HandleAtlasMemberCommand()
RunScript(script) - Executes a string of Lua code.
ScriptsDisallowedForBeta()
SetAllowDangerousScripts()
ToggleAnimKitDisplay()
ToggleDebugAIDisplay()
addframetext(text)
debuglocals()
debugprofilestart() - Starts a timer for profiling during debugging.
debugprofilestop() - Returns the time in milliseconds since the last call to debugprofilestart().
debugstack(start, count1, count2) - Returns a string representation of the current calling stack.
geterrorhandler() - Returns the currently set error handler.
seterrorhandler(errFunc) - Sets the error handler to the given function.
UI DevTools_Dump(value [, startKey]) - Pretty prints a variable or value. Equivalent to the /dump macro.
UI print(...) - Calls the current print output handler with the provided values; by default printing the values to the default chat frame.
UI getprinthandler() - Returns the function currently handling print() output.
UI setprinthandler(func) - Changes the function handling print() output.
UI message(text) - Displays a message box with your text message and an "Okay" button.
PROTECTED C_Debug.DashboardIsEnabled()
PROTECTED C_Debug.GetAllPortLocsForMap(uiMapID)
PROTECTED C_Debug.GetMapDebugObjects(uiMapID)
PROTECTED C_Debug.TeleportToMapDebugObject(pinIndex)
PROTECTED C_Debug.TeleportToMapLocation(uiMapID, mapX, mapY)

Graphics

C_ScriptedAnimations.GetAllScriptedAnimationEffects() : scriptedAnimationEffects
C_VideoOptions.GetGxAdapterInfo() : adapters - Returns info about the system's graphics adapter.
AntiAliasingSupported()
AutoChooseCurrentGraphicsSetting()
GetCurrentGraphicsSetting()
GetCurrentResolution() - Returns the index of the current screen resolution.
GetCurrentScaledResolution()
GetCVarSettingValidity(cvar, settingsCount [, isRaid])
GetDefaultGraphicsQuality()
GetDefaultVideoOption()
GetDefaultVideoOptions()
GetDefaultVideoQualityOption()
GetGraphicsAPIs() - Returns the supported graphics APIs for the system, D3D11_LEGACY, D3D11, D3D12, etc.
GetGraphicsDropdownIndexByMasterIndex()
GetMaxRenderScale()
GetMinRenderScale()
GetMonitorAspectRatio()
GetMonitorCount()
GetMonitorName()
GetPhysicalScreenSize()
GetScreenDPIScale()
GetScreenHeight() - Returns the height of the window in pixels, affected by UI scale.
GetScreenResolutions()
GetScreenWidth() - Returns the width of the window in pixels, affected by UI scale.
GetToolTipInfo(1, size-1, cvar, validValue1, ...) - Returns validity info for a graphics cvar.
GetVideoCaps()
GetVideoOptions()
IsDesaturateSupported()
IsOutlineModeSupported()
MultiSampleAntiAliasingSupported()
RestartGx() - Restarts the graphics engine.
SetCurrentGraphicsSetting(setting{0=normal, 1=raid/BG})
SetDefaultVideoOptions(value)
SetScreenResolution(width, height, fullscreen)
SetSelectedScreenResolutionIndex(integerIndex)
SupportsClipCursor()
ToggleSelfHighlight()
ToggleWindowed()
UpdateWindow() - When in windowed mode, updates the window. This also aligns it to the top of the screen and increases the size to max widowed size.

Locales

BreakUpLargeNumbers(number [, natural]) - Divides digits into groups using a localized delimiter character.
DeclineName(name, gender, declensionSet) - Returns suggested declensions for a Russian name.
GetAvailableLocaleInfo(ignoreLocaleRestrictions)
GetAvailableLocales(ignoreLocaleRestrictions)
GetLocale() - Returns the game client locale.
GetNumDeclensionSets(name, gender) - Returns the number of suggested declension sets for a Russian name.
GetOSLocale()
GetText() - Returns localized text depending on the specified gender.
IsEuropeanNumbers()
SetEuropeanNumbers(flag) - Sets the decimal separator to a comma instead of a dot.

Script Profiling

Note: CPU profiling is disabled by default since it has some overhead. CPU profiling is controlled by the scriptProfile cvar, which persists across sessions, and takes effect after a UI reload. Memory profiling is always available. These functions have been added in Patch 2.1.

GetAddOnCPUUsage(index or name) - Returns the total time used for an addon.
GetAddOnMemoryUsage(index or name) - Query an addon's memory use (in K, precision to 1 byte) - This returns a cached value calculated by UpdateAddOnMemoryUsage().
GetEventCPUUsage([event]) - 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.
GetFrameCPUUsage(frame [, includeChildren]) - Returns the total time used by and number of calls of a frame's event handlers.
GetFunctionCPUUsage(func [, includeSubroutines]) - 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.
GetScriptCPUUsage() - Returns the total time used by the scripting system.
ResetCPUUsage() - Reset all CPU profiling statistics to zero.
UpdateAddOnCPUUsage() - Scan through the profiling data and update the per-addon statistics.
UpdateAddOnMemoryUsage() - Scan through memory profiling data and update the per-addon statistics.

Secure Execution

Relates to Secure Execution and Tainting.

forceinsecure() - Taints the current execution path.
hooksecurefunc([table,] funcName, hookfunc) - Securely posthooks the specified function. The hook will be called with the same arguments after the original call is performed.
InCombatLockdown() - True if the combat lockdown restrictions are active.
issecure() - True if the current execution path is secure.
issecurevariable([table,] name) - True if the specified variable is secure.
scrub(...) - Returns the argument list with non-number/boolean/string values changed to nil.
securecall(function or functionName, ...) - Calls the specified function without propagating taint to the caller.
securecallfunction()
secureexecuterange()
StoreSecureReference(name, obj)
UI CanAccessObject(obj) - Returns true if an object is secure and not forbidden.

Sound

MuteSoundFile(soundFile or fileDataID) - Mutes a sound file.
PlayMusic(musicfile or fileDataID) - Plays the specified sound file on loop to the "Music" sound channel.
PlaySound(soundKitID [, channel, forceNoDuplicates, runFinishCallback]) - Plays the specified sound by SoundKitID.
PlaySoundFile(soundFile or soundFileID [, channel]) - Plays the specified sound by FileDataID or addon file path.
PlayVocalErrorSoundID(vocalErrorSoundID)
StopMusic() - Stops the currently playing music.
StopSound(soundHandleID [, fadeoutTime])
UnmuteSoundFile(soundFile or fileDataID) - Unmutes a sound file.

Sound Drivers

Sound_ChatSystem_GetInputDriverNameByIndex(InputDriverIndex)
Sound_ChatSystem_GetNumInputDrivers()
Sound_ChatSystem_GetNumOutputDrivers()
Sound_ChatSystem_GetOutputDriverNameByIndex(OutputDriverIndex)
Sound_GameSystem_GetInputDriverNameByIndex(InputDriverIndex)
Sound_GameSystem_GetNumInputDrivers()
Sound_GameSystem_GetNumOutputDrivers()
Sound_GameSystem_GetOutputDriverNameByIndex(OutputDriverIndex)
Sound_GameSystem_RestartSoundSystem()

Util

CalculateStringEditDistance(firstString, secondString) - Returns Levenshtein distance.
CaseAccentInsensitiveParse(string) - Converts a string with accented letters to lowercase.

Spectator Mode

C_Commentator.AddPlayerOverrideName(playerName, overrideName)
C_Commentator.AddTrackedDefensiveAuras(spellIDs)
C_Commentator.AddTrackedOffensiveAuras(spellIDs)
C_Commentator.AreTeamsSwapped() : teamsAreSwapped
C_Commentator.AssignPlayersToTeam(playerName, teamName)
C_Commentator.AssignPlayersToTeamInCurrentInstance(teamIndex, teamName)
C_Commentator.AssignPlayerToTeam(playerName, teamName)
C_Commentator.CanUseCommentatorCheats() : canUseCommentatorCheats
C_Commentator.ClearCameraTarget()
C_Commentator.ClearFollowTarget()
C_Commentator.ClearLookAtTarget([lookAtIndex])
C_Commentator.EnterInstance()
C_Commentator.ExitInstance()
C_Commentator.FindSpectatedUnit(unitToken) : playerIndex, teamIndex, isPet
C_Commentator.FindTeamNameInCurrentInstance(teamIndex) : teamName
C_Commentator.FindTeamNameInDirectory(playerNames) : teamName
C_Commentator.FlushCommentatorHistory()
C_Commentator.FollowPlayer(factionIndex, playerIndex [, forceInstantTransition])
C_Commentator.FollowUnit(token)
C_Commentator.ForceFollowTransition()
C_Commentator.GetAdditionalCameraWeight() : teamIndex, playerIndex
C_Commentator.GetAdditionalCameraWeightByToken(unitToken) : weight
C_Commentator.GetAllPlayerOverrideNames() : nameEntries
C_Commentator.GetCamera() : xPos, yPos, zPos, yaw, pitch, roll, fov
C_Commentator.GetCameraCollision() : isColliding
C_Commentator.GetCameraPosition() : xPos, yPos, zPos
C_Commentator.GetCommentatorHistory() : history
C_Commentator.GetCurrentMapID() : mapID
C_Commentator.GetDampeningPercent() : percentage
C_Commentator.GetDistanceBeforeForcedHorizontalConvergence() : distance
C_Commentator.GetDurationToForceHorizontalConvergence() : ms
C_Commentator.GetExcludeDistance() : excludeDistance
C_Commentator.GetHardlockWeight() : weight
C_Commentator.GetHorizontalAngleThresholdToSmooth() : angle
C_Commentator.GetIndirectSpellID(trackedSpellID) : indirectSpellID
C_Commentator.GetInstanceInfo(mapIndex, instanceIndex) : mapID, mapName, status, instanceIDLow, instanceIDHigh
C_Commentator.GetLookAtLerpAmount() : amount
C_Commentator.GetMapInfo(mapIndex) : teamSize, minLevel, maxLevel, numInstances
C_Commentator.GetMatchDuration() : seconds
C_Commentator.GetMaxNumPlayersPerTeam() : maxNumPlayersPerTeam
C_Commentator.GetMaxNumTeams() : maxNumTeams
C_Commentator.GetMode() : commentatorMode
C_Commentator.GetMsToHoldForHorizontalMovement() : ms
C_Commentator.GetMsToHoldForVerticalMovement() : ms
C_Commentator.GetMsToSmoothHorizontalChange() : ms
C_Commentator.GetMsToSmoothVerticalChange() : ms
C_Commentator.GetNumMaps() : numMaps
C_Commentator.GetNumPlayers(factionIndex) : numPlayers
C_Commentator.GetOrCreateSeries(teamName1, teamName2) : data
C_Commentator.GetPlayerAuraInfo(teamIndex, playerIndex, spellID) : startTime, duration, enable
C_Commentator.GetPlayerAuraInfoByUnit(token, spellID) : startTime, duration, enable
C_Commentator.GetPlayerCooldownInfo(teamIndex, playerIndex, spellID) : startTime, duration, enable
C_Commentator.GetPlayerCooldownInfoByUnit(unitToken, spellID) : startTime, duration, enable
C_Commentator.GetPlayerCrowdControlInfo(teamIndex, playerIndex) : spellID, expiration, duration
C_Commentator.GetPlayerCrowdControlInfoByUnit(token) : spellID, expiration, duration
C_Commentator.GetPlayerData(teamIndex, playerIndex) : info
C_Commentator.GetPlayerFlagInfo(teamIndex, playerIndex) : hasFlag
C_Commentator.GetPlayerFlagInfoByUnit(unitToken) : hasFlag
C_Commentator.GetPlayerOverrideName(originalName) : overrideName
C_Commentator.GetPlayerSpellCharges(teamIndex, playerIndex, spellID) : charges, maxCharges, startTime, duration
C_Commentator.GetPlayerSpellChargesByUnit(unitToken, spellID) : charges, maxCharges, startTime, duration
C_Commentator.GetPositionLerpAmount() : amount
C_Commentator.GetSmoothFollowTransitioning() : enabled
C_Commentator.GetSoftlockWeight() : weight
C_Commentator.GetSpeedFactor() : factor
C_Commentator.GetStartLocation(mapID) : pos
C_Commentator.GetTeamColor(teamIndex) : color
C_Commentator.GetTeamColorByUnit(unitToken) : color
C_Commentator.GetTimeLeftInMatch() : timeLeft
C_Commentator.GetTrackedSpellID(indirectSpellID) : trackedSpellID
C_Commentator.GetTrackedSpells(teamIndex, playerIndex, category) : spells
C_Commentator.GetTrackedSpellsByUnit(unitToken, category) : spells
C_Commentator.GetUnitData(unitToken) : data
C_Commentator.GetWargameInfo(listID) : name, minPlayers, maxPlayers, isArena
C_Commentator.HasTrackedAuras(token) : hasOffensiveAura, hasDefensiveAura
C_Commentator.IsSmartCameraLocked() : isSmartCameraLocked
C_Commentator.IsSpectating() : isSpectating
C_Commentator.IsTrackedDefensiveAura(spellID) : isDefensiveTrigger
C_Commentator.IsTrackedOffensiveAura(spellID) : isOffensiveTrigger
C_Commentator.IsTrackedSpell(teamIndex, playerIndex, spellID, category) : isTracked
C_Commentator.IsTrackedSpellByUnit(unitToken, spellID, category) : isTracked
C_Commentator.IsUsingSmartCamera() : isUsingSmartCamera
C_Commentator.LookAtPlayer(factionIndex, playerIndex [, lookAtIndex])
C_Commentator.RemoveAllOverrideNames()
C_Commentator.RemovePlayerOverrideName(originalPlayerName)
C_Commentator.RequestPlayerCooldownInfo(teamIndex, playerIndex)
C_Commentator.ResetFoVTarget()
C_Commentator.ResetSeriesScores(teamName1, teamName2)
C_Commentator.ResetSettings()
C_Commentator.ResetTrackedAuras()
C_Commentator.SetAdditionalCameraWeight(teamIndex, playerIndex, weight)
C_Commentator.SetAdditionalCameraWeightByToken(unitToken, weight)
C_Commentator.SetBlocklistedAuras(spellIDs)
C_Commentator.SetBlocklistedCooldowns(specID, spellIDs)
C_Commentator.SetCamera(xPos, yPos, zPos, yaw, pitch, roll, fov)
C_Commentator.SetCameraCollision(collide)
C_Commentator.SetCameraPosition(xPos, yPos, zPos, snapToLocation)
C_Commentator.SetCheatsEnabled(enableCheats)
C_Commentator.SetCommentatorHistory(history)
C_Commentator.SetDistanceBeforeForcedHorizontalConvergence(distance)
C_Commentator.SetDurationToForceHorizontalConvergence(ms)
C_Commentator.SetExcludeDistance(excludeDistance)
C_Commentator.SetFollowCameraSpeeds(elasticSpeed, minSpeed)
C_Commentator.SetHardlockWeight(weight)
C_Commentator.SetHorizontalAngleThresholdToSmooth(angle)
C_Commentator.SetLookAtLerpAmount(amount)
C_Commentator.SetMapAndInstanceIndex(mapIndex, instanceIndex)
C_Commentator.SetMouseDisabled(disabled)
C_Commentator.SetMoveSpeed(newSpeed)
C_Commentator.SetMsToHoldForHorizontalMovement(ms)
C_Commentator.SetMsToHoldForVerticalMovement(ms)
C_Commentator.SetMsToSmoothHorizontalChange(ms)
C_Commentator.SetMsToSmoothVerticalChange(ms)
C_Commentator.SetPositionLerpAmount(amount)
C_Commentator.SetRequestedDebuffCooldowns(specID, spellIDs)
C_Commentator.SetRequestedDefensiveCooldowns(specID, spellIDs)
C_Commentator.SetRequestedOffensiveCooldowns(specID, spellIDs)
C_Commentator.SetSeriesScore(teamName1, teamName2, scoringTeamName, score)
C_Commentator.SetSeriesScores(teamName1, teamName2, score1, score2)
C_Commentator.SetSmartCameraLocked(locked)
C_Commentator.SetSmoothFollowTransitioning(enabled)
C_Commentator.SetSoftlockWeight(weight)
C_Commentator.SetSpeedFactor(factor)
C_Commentator.SetTargetHeightOffset(offset)
C_Commentator.SetUseSmartCamera(useSmartCamera)
C_Commentator.SnapCameraLookAtPoint()
C_Commentator.StartWargame(listID, teamSize, tournamentRules, teamOneCaptain, teamTwoCaptain)
C_Commentator.SwapTeamSides()
C_Commentator.ToggleCheats()
C_Commentator.UpdateMapInfo([targetPlayer])
C_Commentator.UpdatePlayerInfo()
C_Commentator.ZoomIn()
C_Commentator.ZoomOut()

Tutorials

C_PlayerInfo.IsPlayerEligibleForNPE() : isEligible, failureReason
C_PlayerInfo.IsPlayerEligibleForNPEv2() : isEligible, failureReason
C_PlayerInfo.IsPlayerNPERestricted() : isRestricted
C_SplashScreen.AcknowledgeSplash()
C_SplashScreen.CanViewSplashScreen() : canView
C_SplashScreen.RequestLatestSplashScreen(fromGameMenu)
C_Tutorial.AbandonTutorialArea()
C_Tutorial.ReturnToTutorialArea()
CanResetTutorials()
ClearTutorials()
ClosestGameObjectPosition(gameObjectID)
ClosestUnitPosition(creatureID) - Returns the unit position of the closest creature by ID. Only works for mobs in the starting zones.
FlagTutorial(tutorial)
GetNextCompleatedTutorial(tutorial)
GetPrevCompleatedTutorial(tutorial)
GetTutorialsEnabled()
IsSplashFramePrimaryFeatureUnlocked()
IsTutorialFlagged(tutorial)
RequestBottomLeftActionBar()
ResetTutorials()
ShouldShowSpecialSplashScreen()
SplashFrameCanBeShown()
TriggerTutorial(tutorial)

UI Objects

GetFileIDFromPath(filePath) - Returns the FileID for an Interface file path.
SetUIVisibility(visible) - Hides or shows the entire UI.
UI EasyMenu(menuList, menuFrame, anchor, x, y, displayMode, autoHideDelay)
UI ToggleDropDownMenu(level, value, dropDownFrame, anchorName, xOffset, yOffset)

Frame

C_FrameManager.GetFrameVisibilityState(frameType) : shouldShow
CreateFrame(frameType [, frameName, parentFrame, inheritsFrame, id]) - Creates a Frame object.
DoesTemplateExist(template) - Returns if a virtual frame template exists.
EnumerateFrames(currentFrame) - Returns the frame which follows the current frame.
GetClickFrame(name)
GetCurrentKeyBoardFocus() - Returns the [editbox] widget currently handling keyboard events.
GetDefaultScale()
GetFramesRegisteredForEvent(event) - Returns all frames registered for the specified event, in dispatch order.
GetMouseButtonName()
GetMouseClickFocus()
GetMouseFocus() - Returns the frame that currently has mouse focus.
GetMouseMotionFocus()
GetNumFrames() - Get the current number of Frame (and derivative) objects.
SetupFullscreenScale(frame) - Sizes a frame to take up the entire screen regardless of screen resolution.
UI MouseIsOver(region, topOffset, bottomOffset, leftOffset, rightOffset) - Checks whether the mouse is over the frame (or within specified offsets).
UI UIFrameFadeIn(frame, timeToFade, startAlpha, endAlpha) - Fades a frame in.
UI UIFrameFadeOut(frame, timeToFade, startAlpha, endAlpha) - Fades a frame out.

Font

CreateFont(name) - Creates a Font object.
GetFontInfo(font or name)
GetFonts() - Returns a list of available fonts.

Texture

C_Texture.GetAtlasInfo(atlas) : info - Returns atlas info.
GetObjectIconTextureCoords(textureIndex)
SetPortraitTexture(textureObject, unitToken) - Sets a texture to a unit's 2D portrait.
SetPortraitToTexture(textureObject, texturePath) - Applies a circular mask to a texture, making it resemble a portrait.
UI CreateAtlasMarkup(atlasName [, height, width, offsetX, offsetY]) - Returns a texture fontstring for an atlas.
UI CreateTextureMarkup(file, fileWidth, fileHeight, width, height, left, right, top, bottom [, xOffset, yOffset]) - Returns a texture fontstring.
UI GetTextureInfo(obj) - Returns the type and info of a texture.

ModelScene

C_ModelInfo.AddActiveModelScene(modelSceneFrame, modelSceneID)
C_ModelInfo.AddActiveModelSceneActor(modelSceneFrameActor, modelSceneActorID)
C_ModelInfo.ClearActiveModelScene(modelSceneFrame)
C_ModelInfo.ClearActiveModelSceneActor(modelSceneFrameActor)
C_ModelInfo.GetModelSceneActorDisplayInfoByID(modelActorDisplayID) : actorDisplayInfo
C_ModelInfo.GetModelSceneActorInfoByID(modelActorID) : actorInfo
C_ModelInfo.GetModelSceneCameraInfoByID(modelSceneCameraID) : modelSceneCameraInfo
C_ModelInfo.GetModelSceneInfoByID(modelSceneID) : modelSceneType, modelCameraIDs, modelActorsIDs
GetUICameraInfo(uiCameraID)

Blizzard

Used internally for the Blizzard_PrototypeDialog addon.

C_PrototypeDialog.EnsureRemoved(instanceID)
C_PrototypeDialog.SelectOption(instanceID, optionIndex)

Toasts

C_EventToastManager.GetLevelUpDisplayToastsFromLevel(level) : toastInfo
C_EventToastManager.GetNextToastToDisplay() : toastInfo
C_EventToastManager.RemoveCurrentToast()

Macbook Pro Notch

C_UI.DoesAnyDisplayHaveNotch() : notchPresent
C_UI.GetTopLeftNotchSafeRegion() : left, right, top, bottom
C_UI.GetTopRightNotchSafeRegion() : left, right, top, bottom
C_UI.ShouldUIParentAvoidNotch() : willAvoidNotch

UI Widget Manager

The UI widget system was added in Patch 8.0.1 to replace the WorldStateFrame. It renders the UI elements used for e.g. PvP objectives.

WidgetSet

C_UIWidgetManager.GetAllWidgetsBySetID(setID) : widgets - Returns all widgets for a widget set ID.
C_UIWidgetManager.GetBelowMinimapWidgetSetID() : setID
C_UIWidgetManager.GetObjectiveTrackerWidgetSetID() : setID
C_UIWidgetManager.GetPowerBarWidgetSetID() : setID
C_UIWidgetManager.GetTopCenterWidgetSetID() : setID - Returns the widget set ID for the top center part of the screen.
C_UIWidgetManager.GetWidgetSetInfo(widgetSetID) : widgetSetInfo
C_TaskQuest.GetUIWidgetSetIDFromQuestID(questID) : UiWidgetSetID
UnitWidgetSet(unit) : uiWidgetSet

Visualization

C_UIWidgetManager.GetBulletTextListWidgetVisualizationInfo(widgetID) : widgetInfo
C_UIWidgetManager.GetCaptureBarWidgetVisualizationInfo(widgetID) : widgetInfo
C_UIWidgetManager.GetCaptureZoneVisualizationInfo(widgetID) : widgetInfo
C_UIWidgetManager.GetDiscreteProgressStepsVisualizationInfo(widgetID) : widgetInfo
C_UIWidgetManager.GetDoubleIconAndTextWidgetVisualizationInfo(widgetID) : widgetInfo
C_UIWidgetManager.GetDoubleStateIconRowVisualizationInfo(widgetID) : widgetInfo
C_UIWidgetManager.GetDoubleStatusBarWidgetVisualizationInfo(widgetID) : widgetInfo
C_UIWidgetManager.GetHorizontalCurrenciesWidgetVisualizationInfo(widgetID) : widgetInfo
C_UIWidgetManager.GetIconAndTextWidgetVisualizationInfo(widgetID) : widgetInfo
C_UIWidgetManager.GetIconTextAndBackgroundWidgetVisualizationInfo(widgetID) : widgetInfo
C_UIWidgetManager.GetIconTextAndCurrenciesWidgetVisualizationInfo(widgetID) : widgetInfo
C_UIWidgetManager.GetScenarioHeaderCurrenciesAndBackgroundWidgetVisualizationInfo(widgetID) : widgetInfo
C_UIWidgetManager.GetScenarioHeaderTimerWidgetVisualizationInfo(widgetID) : widgetInfo
C_UIWidgetManager.GetSpacerVisualizationInfo(widgetID) : widgetInfo
C_UIWidgetManager.GetSpellDisplayVisualizationInfo(widgetID) : widgetInfo
C_UIWidgetManager.GetStackedResourceTrackerWidgetVisualizationInfo(widgetID) : widgetInfo
C_UIWidgetManager.GetStatusBarWidgetVisualizationInfo(widgetID) : widgetInfo
C_UIWidgetManager.GetTextColumnRowVisualizationInfo(widgetID) : widgetInfo
C_UIWidgetManager.GetTextureAndTextRowVisualizationInfo(widgetID) : widgetInfo
C_UIWidgetManager.GetTextureAndTextVisualizationInfo(widgetID) : widgetInfo
C_UIWidgetManager.GetTextureWithAnimationVisualizationInfo(widgetID) : widgetInfo
C_UIWidgetManager.GetTextWithStateWidgetVisualizationInfo(widgetID) : widgetInfo
C_UIWidgetManager.GetUnitPowerBarWidgetVisualizationInfo(widgetID) : widgetInfo
C_UIWidgetManager.GetZoneControlVisualizationInfo(widgetID) : widgetInfo
C_UIWidgetManager.RegisterUnitForWidgetUpdates(unitToken [, isGuid])
C_UIWidgetManager.SetProcessingUnit([unit])
C_UIWidgetManager.SetProcessingUnitGuid([unit])
C_UIWidgetManager.UnregisterUnitForWidgetUpdates(unitToken [, isGuid])
C_Widget.IsFrameWidget()
C_Widget.IsRenderableWidget()
C_Widget.IsWidget(object)

Units

These are functions which act on one or more units. Units are identified by UnitIds.

C_PlayerInfo.GetContentDifficultyCreatureForPlayer(unitToken) : difficulty
GetThreatStatusColor(status) - Returns the color for a threat status.
GetUnitChargedPowerPoints(unit) : pointIndices
GetUnitSpeed(unit) - Returns the movement speed of the unit.
UnitAffectingCombat(unit) - True if the unit is in combat.
UnitArmor(unit) - Returns the armor stats for the unit.
UnitAttackPower(unit) - Returns the unit's melee attack power and modifiers.
UnitAttackSpeed(unit) - Returns the unit's melee attack speed for each hand.
UnitCanAssist(unit, otherUnit) - Indicates whether the first unit can assist the second unit.
UnitCanAttack(unit, otherUnit) - Returns true if the first unit can attack the second, false otherwise.
UnitCanCooperate(unit, otherUnit) - Returns true if the first unit can cooperate with the second, false otherwise.
UnitCanPetBattle()
UnitCastingInfo(unit) - Returns information about the spell currently being cast by the specified unit.
UnitChannelInfo(unit) - Returns information about the spell currently being channeled by the specified unit.
UnitClass(unit) : className, classFilename, classID - Returns the class of the unit.
UnitClassBase(unit) : classFilename, classID
UnitClassification(unit) - Returns the classification of the specified unit (e.g., "elite" or "worldboss").
UnitCreatureFamily(unit) - Returns the creature type of the unit (e.g. Crab).
UnitCreatureType(unit) - Returns the creature classification type of the unit (e.g. Beast).
UnitDamage(unit) - Returns the damage stats for the unit.
UnitDetailedThreatSituation(unit, unitMob) - Returns detailed info for the threat status of one unit against another.
UnitEffectiveLevel(unit) - Returns the unit's effective (scaled) level.
UnitExists(unit) - True if the unit exists.
UnitFactionGroup(unit) - Returns the faction (Horde/Alliance) a unit belongs to.
UnitFullName(unit) - Returns the player's (unit's) name and server.
UnitGetAvailableRoles()
UnitGetIncomingHeals(unit [, healer]) - Returns the predicted heals cast on the specified unit.
UnitGetTotalAbsorbs(unit) - Returns the total amount of damage the unit can absorb before losing health.
UnitGetTotalHealAbsorbs(unit) - Returns the total amount of healing the unit can absorb without gaining health.
UnitGroupRolesAssigned(unit) - Returns the assigned role in a group formed via the Dungeon Finder Tool.
UnitGUID(unit) - Returns the GUID of the unit.
UnitHasIncomingResurrection(unit) - True if the unit is currently being resurrected.
UnitHasLFGDeserter(unit) - Returns whether the unit is currently unable to use the dungeon finder due to leaving a group prematurely.
UnitHasLFGRandomCooldown(unit) - Returns whether the unit is currently under the effects of the random dungeon cooldown.
UnitHasRelicSlot(unit)
UnitHealth(unit) - Returns the current health of the unit.
UnitHealthMax(unit) - Returns the maximum health of the unit.
UnitHPPerStamina()
UnitInOtherParty()
UnitInRange(unit) - True if the unit (party or raid only) is in 40 yards range.
UnitIsAFK(unit) - True if a friendly unit is AFK (Away from keyboard).
UnitIsCharmed(unit) - True if the unit is charmed.
UnitIsConnected(unit) : isConnected - True if the unit is connected to the game (i.e. not offline).
UnitIsControlling(unit) - Returns true if the local player is directly controlling the specified unit.
UnitIsCorpse(unit) - Returns true if the specified unit is a corpse, false otherwise.
UnitIsDead(unit) - True if the unit is dead.
UnitIsDeadOrGhost(unit) - True if the unit is dead or in ghost form.
UnitIsDND(unit) - True if a unit is DND (Do not disturb).
UnitIsEnemy(unit, otherUnit) - True if the specified units are hostile to each other.
UnitIsFeignDeath(unit) - True if the unit (must be a group member) is feigning death.
UnitIsFriend(unit, otherUnit) - True if the specified units are friendly to each other.
UnitIsGhost(unit) - True if the unit is in ghost form.
UnitIsGroupAssistant()
UnitIsInMyGuild(unit) - Returns whether the specified unit is in the same guild as the player's character.
UnitIsOtherPlayersPet()
UnitIsOwnerOrControllerOfUnit(controllingUnit, controlledUnit) : unitIsOwnerOrControllerOfUnit
UnitIsPlayer(unit) - True if the unit is a player character.
UnitIsPossessed(unit) - True if the unit is currently under control of another (e.g. Mind Control).
UnitIsQuestBoss(unit) - Returns true if the specified unit is the "boss" (objective) of a kill quest. If true, then the default UI displays a shield with a yellow "!" on it on the unit's unitframe.
UnitIsRaidOfficer(unit) - Returns whether the specified unit is an officer in your raid.
UnitIsSameServer(unit) - True if the unit is from the same (connected) realm.
UnitIsTapDenied()
UnitIsTrivial(unit) - Ttrue if the unit is trivial (i.e. "grey" to the player).
UnitIsUnconscious()
UnitIsUnit(unit, otherUnit) - True if the specified units are the same unit.
UnitIsVisible(unit) - True if the game client can see the unit.
UnitLeadsAnyGroup()
UnitLevel(unit) - Returns the level of the unit.
UnitName(unit) - Returns the name and realm of the unit.
UnitNameUnmodified()
UnitPlayerControlled(unit) - True if the unit is controlled by a player.
UnitPlayerOrPetInParty(unit) - True if a different unit or pet is a member of the party.
UnitPlayerOrPetInRaid(unit) - True if a different unit or pet is a member of the raid.
UnitPower(unitToken [, powerType, unmodified]) : power - Returns the current power resource of the unit.
UnitPowerDisplayMod(powerType) : displayMod
UnitPowerMax(unitToken [, powerType, unmodified]) : maxPower - Returns the maximum power resource of the unit.
UnitPowerType(unit) - Returns a number corresponding to the power type (e.g., mana, rage or energy) of the specified unit.
UnitQuestTrivialLevelRange(unit) : levelRange - Returns the difference between the units' current level and the level at which fixed-level quests are of trivial difficulty.
UnitRace(unit) - Returns the race of the unit.
UnitRangedAttackPower(unit) - Returns the ranged attack power of the unit.
UnitRangedDamage(unit) - Returns the ranged attack speed and damage of the unit.
UnitReaction(unit, otherUnit) - Returns the reaction of the specified unit to another unit.
UnitRealmRelationship()
UnitSelectionColor(unit [, useExtendedColors]) - Returns the color of the outline and circle underneath the unit.
UnitSelectionType(unit [, useExtendedColors]) - Returns the selection type of the outline and circle underneath the unit.
UnitSetRole()
UnitSex(unit) : sex - Returns the gender of the unit.
UnitShouldDisplayName()
UnitSpellHaste(unit) - Returns the current spell haste percentage for a unit.
UnitStagger()
UnitStat(unit, statIndex) - Returns the basic attributes for a unit (strength, agility, stamina, intellect).
UnitThreatPercentageOfLead()
UnitThreatSituation(unit, mobUnit) - Returns the threat status of the specified unit to another unit.
UnitTreatAsPlayerForDisplay(unit) : treatAsPlayer - Whether a unit should be treated as if it was an actual player.
UnitTrialBankedLevels(unit)
UnitTrialXP(unit)
UnitWeaponAttackPower(unit)
UnitXP(unit) - Returns the current XP of the unit; only works on the player.
UnitXPMax(unit) - Returns the maximum XP of the unit; only works on the player.
UI GetUnitName(unit [, showServerName]) - Returns the name and optionally the realm of the unit.

Buffs

NOCOMBAT CancelUnitBuff(unit, index or spell [, filter or rank]) - Removes a specific buff from the character.
GetPlayerAuraBySpellID(spellID) - Returns an active buff/debuff by spell ID on the player character.
UnitAura(unit, index [, filter]) - Returns the buffs/debuffs for the unit.
UnitAuraBySlot(unit, slot)
UnitAuraSlots(unit [, filter, maxSlots, continuationToken])
UnitBuff(unit, index [, raidFilter]) - Shorthand for UnitAura(unit, index, "HELPFUL")
UnitDebuff(unit, index [, raidFilter]) - Shorthand for UnitAura(unit, index, "HARMFUL")
UI AuraUtil.FindAura(predicate, unit, filter, predicateArg1, predicateArg2, predicateArg3)
UI AuraUtil.FindAuraByName(auraName, unit, filter) - Finds the first aura that matches the name.
UI AuraUtil.ForEachAura(unit, filter, maxCount, func)
UI AuraUtil.ShouldSkipAuraUpdate(isFullUpdate, updatedAuraInfos, isRelevantFunc, ...)

Weapon Enchants

PROTECTED CancelItemTempEnchantment(weaponHand) - Removes temporary weapon enchants (e.g. Rogue poisons and sharpening stones).
GetWeaponEnchantInfo() - Returns info for temporary weapon enchantments (e.g. sharpening stones).

Nameplates

Nameplates were reworked in Patch 7.0.3

C_NamePlate.GetNamePlateEnemyClickThrough()
C_NamePlate.GetNamePlateEnemyPreferredClickInsets()
C_NamePlate.GetNamePlateEnemySize()
C_NamePlate.GetNamePlateForUnit(unitToken [, includeForbidden])
C_NamePlate.GetNamePlateFriendlyClickThrough()
C_NamePlate.GetNamePlateFriendlyPreferredClickInsets()
C_NamePlate.GetNamePlateFriendlySize()
C_NamePlate.GetNamePlates([includeForbidden])
C_NamePlate.GetNamePlateSelfClickThrough()
C_NamePlate.GetNamePlateSelfPreferredClickInsets()
C_NamePlate.GetNamePlateSelfSize()
C_NamePlate.GetNumNamePlateMotionTypes()
C_NamePlate.GetTargetClampingInsets()
C_NamePlate.SetNamePlateEnemyClickThrough(clickthrough)
C_NamePlate.SetNamePlateEnemyPreferredClickInsets()
C_NamePlate.SetNamePlateEnemySize(width, height)
C_NamePlate.SetNamePlateFriendlyClickThrough()
C_NamePlate.SetNamePlateFriendlyPreferredClickInsets(left, right, top, bottom)
C_NamePlate.SetNamePlateFriendlySize(width, height)
C_NamePlate.SetNamePlateSelfClickThrough(clickthrough)
C_NamePlate.SetNamePlateSelfPreferredClickInsets(left, right, top, bottom)
C_NamePlate.SetNamePlateSelfSize(width, height)
C_NamePlate.SetTargetClampingInsets(clickthrough)
SetInWorldUIVisibility(visible) - Allows nameplates to be shown even while the UI is hidden (with Alt-Z)
UnitNameplateShowsWidgetsOnly(unit) : nameplateShowsWidgetsOnly

Loss of Control

C_LossOfControl.GetActiveLossOfControlData(index) : event - Returns info about an active loss-of-control effect.
C_LossOfControl.GetActiveLossOfControlDataByUnit(unitToken, index) : event
C_LossOfControl.GetActiveLossOfControlDataCount() : count - Returns the number of active loss-of-control effects.
C_LossOfControl.GetActiveLossOfControlDataCountByUnit(unitToken) : count
GetActionLossOfControlCooldown(slot)
GetSpellLossOfControlCooldown(spellSlot)

Phasing

Players in different Phases cannot see eachother.

UnitInPartyShard(unit) : inPartyShard
UnitPhaseReason(unit) : reason - Returns the reason if a unit is NOT in the same phase.

Power Bar

GetUnitPowerBarInfo(unitToken) : info
GetUnitPowerBarInfoByID(barID) : info
GetUnitPowerBarStrings(unitToken) : name, tooltip, cost
GetUnitPowerBarStringsByID(barID) : name, tooltip, cost
GetUnitPowerBarTextureInfo(unitToken, textureIndex [, timerIndex]) : texture, colorR, colorG, colorB, colorA
GetUnitPowerBarTextureInfoByID(barID, textureIndex) : texture, colorR, colorG, colorB, colorA
UnitNumPowerBarTimers()
UnitPowerBarID(unitToken) : barID
UnitPowerBarTimerInfo()

Vehicles

These functions were added in Patch 3.0.2

C_PvP.GetBattlefieldVehicleInfo(vehicleIndex, uiMapID) : info
C_PvP.GetBattlefieldVehicles(uiMapID) : vehicles
CanEjectPassengerFromSeat(seat) - Returns 1 if the player can eject a passenger from a seat.
CanExitVehicle() - Returns 1 if the player can be exit the Vehicle.
CanSwitchVehicleSeat()
CanSwitchVehicleSeats() - Returns 1 if the player can Switch Seats in the Vehicle.
EjectPassengerFromSeat(seat) - Ejects a passenger from a seat.
GetNumBattlefieldVehicles(index)
GetVehicleUIIndicator(indicatorID)
GetVehicleUIIndicatorSeat(indicatorID, indicatorSeatIndex)
IsUsingVehicleControls()
IsVehicleAimAngleAdjustable() - Returns 1 if the player can adjust the Aim Angle of the Vehicle.
IsVehicleAimPowerAdjustable() - Returns 1 if the player can adjust the Aim Power of the Vehicle.
PlayerVehicleHasComboPoints() : vehicleHasComboPoints
UnitControllingVehicle(unit)
UnitHasVehiclePlayerFrameUI()
UnitHasVehicleUI(unit)
UnitInVehicle(unit)
UnitInVehicleControlSeat(unit)
UnitInVehicleHidesPetFrame()
UnitSwitchToVehicleSeat(unit, seatId)
UnitTargetsVehicleInRaidUI(unit)
UnitUsingVehicle(unit) - True if the unit is currently in a vehicle.
UnitVehicleSeatCount(unit)
UnitVehicleSeatInfo(unit, seatId)
UnitVehicleSkin(unit)
VehicleAimDecrement()
VehicleAimDownStart()
VehicleAimDownStop()
VehicleAimGetAngle()
VehicleAimGetNormAngle()
VehicleAimGetNormPower()
VehicleAimIncrement()
VehicleAimRequestAngle()
VehicleAimRequestNormAngle()
VehicleAimSetNormPower()
VehicleAimUpStart()
VehicleAimUpStop()
VehicleExit() - Exit the current Vehicle.
VehicleNextSeat()
VehiclePrevSeat()

Warlords of Draenor

Garrison Tech

Garrisons were added in Patch 6.0.2 and also utilized in later expanions.

C_Garrison.CanUpgradeGarrison()
C_Garrison.ClearCompleteTalent(garrisonType)
C_Garrison.CloseArchitect()
C_Garrison.CloseGarrisonTradeskillNPC()
C_Garrison.CloseTalentNPC()
C_Garrison.CloseTradeskillCrafter()
C_Garrison.GetAllBonusAbilityEffects()
C_Garrison.GetCompleteTalent(garrisonType)
C_Garrison.GetCurrencyTypes(garrType)
C_Garrison.GetCurrentGarrTalentTreeFriendshipFactionID() : currentGarrTalentTreeFriendshipFactionID
C_Garrison.GetCurrentGarrTalentTreeID() : currentGarrTalentTreeID
C_Garrison.GetGarrisonInfo(garrisonType)
C_Garrison.GetGarrisonTalentTreeCurrencyTypes(garrTalentTreeID) : garrTalentTreeCurrencyType
C_Garrison.GetGarrisonTalentTreeType(garrTalentTreeID) : garrTalentTreeType
C_Garrison.GetGarrisonUpgradeCost(followerType)
C_Garrison.GetLandingPageGarrisonType()
C_Garrison.GetLandingPageItems(garrTypeID [, noSort])
C_Garrison.GetLandingPageShipmentCount()
C_Garrison.GetLandingPageShipmentInfoByContainerID(shipmentContainerID)
C_Garrison.GetLooseShipments(garrTypeID)
C_Garrison.GetNumPendingShipments()
C_Garrison.GetNumShipmentCurrencies()
C_Garrison.GetNumShipmentReagents()
C_Garrison.GetPendingShipmentInfo(index)
C_Garrison.GetShipmentContainerInfo()
C_Garrison.GetShipmentItemInfo()
C_Garrison.GetShipmentReagentCurrencyInfo(currencyIndex)
C_Garrison.GetShipmentReagentInfo(reagentIndex)
C_Garrison.GetShipmentReagentItemLink(reagentIndex)
C_Garrison.GetSpecChangeCost()
C_Garrison.GetTalentInfo(talentID) : info
C_Garrison.GetTalentPointsSpentInTalentTree(garrTalentTreeID) : talentPoints
C_Garrison.GetTalentTreeIDsByClassID(garrType, classID) : treeIDs
C_Garrison.GetTalentTreeInfo(treeID) : info
C_Garrison.GetTalentTreeResetInfo(garrTalentTreeID) : goldCost, currencyCosts
C_Garrison.GetTalentTreeTalentPointResearchInfo(garrTalentID, researchRank, garrTalentTreeID, talentPointIndex, isRespec) : goldCost, currencyCosts, durationSecs
C_Garrison.GetTalentUnlockWorldQuest(talentID) : worldQuestID
C_Garrison.HasAdventures() : hasAdventures
C_Garrison.HasGarrison(garrisonType)
C_Garrison.IsFollowerOnCompletedMission(followerID) : followerOnCompletedMission
C_Garrison.IsInvasionAvailable()
C_Garrison.IsOnGarrisonMap()
C_Garrison.IsOnShipmentQuestForNPC()
C_Garrison.IsPlayerInGarrison(garrType)
C_Garrison.IsTalentConditionMet(talentID) : isMet, failureString
C_Garrison.IsUsingPartyGarrison()
C_Garrison.IsVisitGarrisonAvailable()
C_Garrison.RequestGarrisonUpgradeable(followerType)
C_Garrison.RequestLandingPageShipmentInfo()
C_Garrison.RequestShipmentCreation()
C_Garrison.RequestShipmentInfo()
C_Garrison.ResearchTalent(garrTalentID)
C_Garrison.SetUsingPartyGarrison(enabled)
C_Garrison.ShouldShowMapTab(garrType)
C_Garrison.UpgradeGarrison(followerType)
GetEquipmentNameFromSpell() - returns a garrison equipment for a spell.
GetFollowerTypeIDFromSpell() - Returns the Garrison expansion type.
ReopenInteraction() - Reopens the order hall talents interaction.

Buildings

C_Garrison.CancelConstruction(plotInstanceID)
C_Garrison.GetBuildingInfo(buildingID)
C_Garrison.GetBuildingLockInfo()
C_Garrison.GetBuildingSizes()
C_Garrison.GetBuildingSpecInfo()
C_Garrison.GetBuildingTimeRemaining(plotInstanceID)
C_Garrison.GetBuildingTooltip(buildingID)
C_Garrison.GetBuildingUpgradeInfo(buildingID)
C_Garrison.GetBuildingsForPlot(plotInstanceID)
C_Garrison.GetBuildingsForSize(garrisonType, uiCategoryID)
C_Garrison.GetBuildings(garrisonType)
C_Garrison.GetGarrisonPlotsInstancesForMap(uiMapID) : garrisonPlotInstances
C_Garrison.GetLandingPageShipmentInfo(buildingID)
C_Garrison.GetOwnedBuildingInfoAbbrev(plotInstanceID)
C_Garrison.GetOwnedBuildingInfo(plotInstanceID)
C_Garrison.GetPlotsForBuilding(buildingID)
C_Garrison.GetPlots(followerType)
C_Garrison.GetShipDeathAnimInfo()
C_Garrison.GetTabForPlot(plotInstanceID)
C_Garrison.HasShipyard()
C_Garrison.IsOnShipyardMap()
C_Garrison.PlaceBuilding(plotInstanceID, buildingID)
C_Garrison.SetBuildingActive(plotInstanceID)
C_Garrison.SetBuildingSpecialization()
C_Garrison.SwapBuildings(plotInstanceID1, plotInstanceID2)
C_Garrison.UpgradeBuilding(plotInstanceID)

Trophies

C_Trophy.MonumentChangeAppearanceToTrophyID(trophyID)
C_Trophy.MonumentCloseMonumentUI()
C_Trophy.MonumentGetCount()
C_Trophy.MonumentGetSelectedTrophyID()
C_Trophy.MonumentGetTrophyInfoByIndex(index)
C_Trophy.MonumentLoadList()
C_Trophy.MonumentLoadSelectedTrophyID()
C_Trophy.MonumentRevertAppearanceToSaved()
C_Trophy.MonumentSaveSelection(trophyID)

Missions

Relates to Followers and Missions.

C_Garrison.AddFollowerToMission(missionID, followerID [, boardIndex]) : followerAdded
C_Garrison.AllowMissionStartAboveSoftCap(garrFollowerTypeID)
C_Garrison.AreMissionFollowerRequirementsMet(missionRecID)
C_Garrison.AssignFollowerToBuilding(plotInstanceID, followerID)
C_Garrison.CanGenerateRecruits()
C_Garrison.CanOpenMissionChest(missionID)
C_Garrison.CanSetRecruitmentPreference()
C_Garrison.CanSpellTargetFollowerIDWithAddAbility(followerID)
C_Garrison.CastItemSpellOnFollowerAbility(followerID, abilityID)
C_Garrison.CastSpellOnFollower(followerID)
C_Garrison.CastSpellOnFollowerAbility(followerID, abilityID)
C_Garrison.CastSpellOnMission(missionID)
C_Garrison.CloseMissionNPC()
C_Garrison.CloseRecruitmentNPC()
C_Garrison.GenerateRecruits(mechanicTypeID, traitID)
C_Garrison.GetAllEncounterThreats(garrFollowerTypeID)
C_Garrison.GetAvailableMissions([missionList,] garrFollowerTypeID)
C_Garrison.GetAvailableRecruits()
C_Garrison.GetBasicMissionInfo(missionID)
C_Garrison.GetBuffedFollowersForMission(missionID, displayingAbilities)
C_Garrison.GetClassSpecCategoryInfo(garrFollowerType)
C_Garrison.GetCombatAllyMission(garrFollowerTypeID)
C_Garrison.GetCompleteMissions([missionList,] garrFollowerTypeID)
C_Garrison.GetFollowerAbilities(guid|id)
C_Garrison.GetFollowerAbilityAtIndex(followerID, index)
C_Garrison.GetFollowerAbilityAtIndexByID(garrFollowerID, index)
C_Garrison.GetFollowerAbilityCounterMechanicInfo(garrAbilityID)
C_Garrison.GetFollowerAbilityCountersForMechanicTypes(garrFollowerTypeID)
C_Garrison.GetFollowerAbilityDescription(garrAbilityID)
C_Garrison.GetFollowerAbilityIcon(garrAbilityID)
C_Garrison.GetFollowerAbilityInfo(garrAbilityID)
C_Garrison.GetFollowerAbilityIsTrait(garrAbilityID)
C_Garrison.GetFollowerAbilityLink(abilityID)
C_Garrison.GetFollowerAbilityName(garrAbilityID)
C_Garrison.GetFollowerActivationCost()
C_Garrison.GetFollowerBiasForMission(missionID, followerID)
C_Garrison.GetFollowerClassSpec(followerID)
C_Garrison.GetFollowerClassSpecAtlas(garrSpecID)
C_Garrison.GetFollowerClassSpecByID(garrFollowerID)
C_Garrison.GetFollowerClassSpecName(garrFollowerID)
C_Garrison.GetFollowerDisplayID(followerID)
C_Garrison.GetFollowerInfo(guid|id)
C_Garrison.GetFollowerInfoForBuilding()
C_Garrison.GetFollowerIsTroop(guid|id)
C_Garrison.GetFollowerItemLevelAverage(followerID)
C_Garrison.GetFollowerItems(followerID)
C_Garrison.GetFollowerLevel(followerID)
C_Garrison.GetFollowerLevelXP(followerID)
C_Garrison.GetFollowerLink(followerID)
C_Garrison.GetFollowerLinkByID(garrFollowerID)
C_Garrison.GetFollowerMissionCompleteInfo(followerID) : followerMissionCompleteInfo
C_Garrison.GetFollowerMissionTimeLeft(followerID)
C_Garrison.GetFollowerMissionTimeLeftSeconds(followerID)
C_Garrison.GetFollowerModelItems(followerID)
C_Garrison.GetFollowerName(followerID)
C_Garrison.GetFollowerNameByID(garrFollowerID)
C_Garrison.GetFollowerPortraitIconID(followerID)
C_Garrison.GetFollowerPortraitIconIDByID(garrFollowerID)
C_Garrison.GetFollowerQuality(followerID)
C_Garrison.GetFollowerQualityTable(garrFollowerTypeID)
C_Garrison.GetFollowerRecentlyGainedAbilityIDs(followerID)
C_Garrison.GetFollowerRecentlyGainedTraitIDs(followerID)
C_Garrison.GetFollowers() - Returns a list of garrison tech followers.
C_Garrison.GetFollowerShipments(garrTypeID)
C_Garrison.GetFollowerSoftCap(garrFollowerTypeID)
C_Garrison.GetFollowerSourceTextByID(garrFollowerID)
C_Garrison.GetFollowerSpecializationAtIndex(followerID, index)
C_Garrison.GetFollowersSpellsForMission(missionID)
C_Garrison.GetFollowerStatus(followerID)
C_Garrison.GetFollowersTraitsForMission(missionID)
C_Garrison.GetFollowerTraitAtIndex(followerID, index)
C_Garrison.GetFollowerTraitAtIndexByID(garrFollowerID, index)
C_Garrison.GetFollowerTypeByID(garrFollowerID)
C_Garrison.GetFollowerTypeByMissionID(missionID)
C_Garrison.GetFollowerUnderBiasReason(missionID, followerID)
C_Garrison.GetFollowerXP(followerID)
C_Garrison.GetFollowerXPTable(garrFollowerTypeID)
C_Garrison.GetFollowerZoneSupportAbilities(guid|id)
C_Garrison.GetInProgressMissions([missionList,] garrFollowerTypeID)
C_Garrison.GetMissionBonusAbilityEffects(missionID)
C_Garrison.GetMissionCompleteEncounters(missionID) : encounters
C_Garrison.GetMissionCost(missionID)
C_Garrison.GetMissionDeploymentInfo(missionID) : missionDeploymentInfo
C_Garrison.GetMissionDisplayIDs(missionID)
C_Garrison.GetMissionEncounterIconInfo(missionID) : missionEncounterIconInfo
C_Garrison.GetMissionLink(missionID)
C_Garrison.GetMissionMaxFollowers(garrMissionID)
C_Garrison.GetMissionName(garrMissionID)
C_Garrison.GetMissionRewardInfo(garrMissionID [, missionDBID])
C_Garrison.GetMissionSuccessChance(missionID)
C_Garrison.GetMissionTexture(offeredGarrMissionTextureID)
C_Garrison.GetMissionTimes(missionID)
C_Garrison.GetMissionUncounteredMechanics(missionID)
C_Garrison.GetNumActiveFollowers()
C_Garrison.GetNumFollowerActivationsRemaining(garrTypeID)
C_Garrison.GetNumFollowerDailyActivations()
C_Garrison.GetNumFollowers()
C_Garrison.GetNumFollowersForMechanic(followerType, mechanicID)
C_Garrison.GetNumFollowersOnMission(missionID)
C_Garrison.GetPartyBuffs(missionID)
C_Garrison.GetPartyMentorLevels(missionID)
C_Garrison.GetPartyMissionInfo(missionID)
C_Garrison.GetPossibleFollowersForBuilding(followerType, plotInstanceID)
C_Garrison.GetRecruitAbilities(index)
C_Garrison.GetRecruiterAbilityCategories()
C_Garrison.GetRecruiterAbilityList(traits)
C_Garrison.GetRecruitmentPreferences()
C_Garrison.IsAboveFollowerSoftCap(garrFollowerTypeID)
C_Garrison.IsAtGarrisonMissionNPC() : atGarrisonMissionNPC
C_Garrison.IsEnvironmentCountered(missionID) : environmentCountered
C_Garrison.IsFollowerCollected(garrFollowerID)
C_Garrison.IsMechanicFullyCountered(missionID, followerID, mechanicID)
C_Garrison.MarkMissionComplete(missionID)
C_Garrison.MissionBonusRoll(missionID)
C_Garrison.RecruitFollower(followerIndex)
C_Garrison.RemoveFollower(dbID)
C_Garrison.RemoveFollowerFromBuilding()
C_Garrison.RemoveFollowerFromMission(missionID, followerID [, boardIndex])
C_Garrison.RenameFollower(followerID, name)
C_Garrison.RequestClassSpecCategoryInfo(garrFollowerTypeID)
C_Garrison.RushHealAllFollowers(followerType)
C_Garrison.RushHealFollower(garrFollowerID)
C_Garrison.SearchForFollower(guid|id, searchString)
C_Garrison.SetFollowerFavorite()
C_Garrison.SetFollowerInactive(followerID, inactive)
C_Garrison.SetRecruitmentPreferences(mechanicTypeID, traitID)
C_Garrison.ShowFollowerNameInErrorMessage(missionRecID)
C_Garrison.StartMission(missionID)
C_Garrison.TargetSpellHasFollowerItemLevelUpgrade()
C_Garrison.TargetSpellHasFollowerReroll()
C_Garrison.TargetSpellHasFollowerTemporaryAbility()
ItemCanTargetGarrisonFollowerAbility()
SpellCanTargetGarrisonFollowerAbility()
SpellCanTargetGarrisonFollower()
SpellCanTargetGarrisonMission()

Auto Missions

C_Garrison.GetAutoCombatDamageClassValues() : damageClassStrings
C_Garrison.GetAutoMissionBoardState(missionID) : targetInfo
C_Garrison.GetAutoMissionEnvironmentEffect(missionID) : autoMissionEnvEffect
C_Garrison.GetAutoMissionTargetingInfo(missionID, followerID, casterBoardIndex) : targetInfo
C_Garrison.GetAutoMissionTargetingInfoForSpell(missionID, autoCombatSpellID, casterBoardIndex) : targetInfo
C_Garrison.GetAutoTroops(followerType) : autoTroopInfo
C_Garrison.GetCombatLogSpellInfo(autoCombatSpellID) : spellInfo
C_Garrison.GetFollowerAutoCombatSpells(garrFollowerID, followerLevel) : autoCombatSpells, autoCombatAutoAttack
C_Garrison.GetFollowerAutoCombatStats(garrFollowerID) : autoCombatInfo
C_Garrison.RegenerateCombatLog(missionID) : success
C_Garrison.SetAutoCombatSpellFastForward(state)

Legion

Artifacts

Artifacts were added in Patch 7.0.3

C_ArtifactUI.AddPower(powerID) : success
C_ArtifactUI.ApplyCursorRelicToSlot(relicSlotIndex)
C_ArtifactUI.CanApplyArtifactRelic(relicItemID, onlyUnlocked) : canApply
C_ArtifactUI.CanApplyCursorRelicToSlot(relicSlotIndex) : canApply
C_ArtifactUI.CanApplyRelicItemIDToEquippedArtifactSlot(relicItemID, relicSlotIndex) : canApply
C_ArtifactUI.CanApplyRelicItemIDToSlot(relicItemID, relicSlotIndex) : canApply
C_ArtifactUI.CheckRespecNPC() : canRespec
C_ArtifactUI.Clear() - Clears data of the last opened artifact weapon.
C_ArtifactUI.ClearForgeCamera()
C_ArtifactUI.ConfirmRespec()
C_ArtifactUI.DoesEquippedArtifactHaveAnyRelicsSlotted() : hasAnyRelicsSlotted
C_ArtifactUI.GetAppearanceInfo(appearanceSetIndex, appearanceIndex) : artifactAppearanceID, appearanceName, displayIndex, unlocked, ... - Returns information about a selected artifact appearance.
C_ArtifactUI.GetAppearanceInfoByID(artifactAppearanceID) : artifactAppearanceSetID, artifactAppearanceID, appearanceName, ... - Returns information about a selected artifact appearance.
C_ArtifactUI.GetAppearanceSetInfo(appearanceSetIndex) : artifactAppearanceSetID, appearanceSetName, appearanceSetDescription, ...
C_ArtifactUI.GetArtifactArtInfo() : artifactArtInfo - Returns information about the currently equipped artifact weapon.
C_ArtifactUI.GetArtifactInfo() : itemID, altItemID, name, icon, xp, pointsSpent, quality, artifactAppearanceID, ...
C_ArtifactUI.GetArtifactItemID() : itemID
C_ArtifactUI.GetArtifactTier() : tier
C_ArtifactUI.GetArtifactXPRewardTargetInfo(artifactCategoryID) : name, icon
C_ArtifactUI.GetCostForPointAtRank(rank, tier) : cost
C_ArtifactUI.GetEquippedArtifactArtInfo() : artifactArtInfo
C_ArtifactUI.GetEquippedArtifactInfo() : itemID, altItemID, name, icon, xp, pointsSpent, quality, artifactAppearanceID, ...
C_ArtifactUI.GetEquippedArtifactItemID() : itemID
C_ArtifactUI.GetEquippedArtifactNumRelicSlots([onlyUnlocked]) : numRelicSlots
C_ArtifactUI.GetEquippedArtifactRelicInfo(relicSlotIndex) : name, icon, slotTypeName, link
C_ArtifactUI.GetEquippedRelicLockedReason(relicSlotIndex) : lockedReason
C_ArtifactUI.GetForgeRotation() : forgeRotationX, forgeRotationY, forgeRotationZ
C_ArtifactUI.GetItemLevelIncreaseProvidedByRelic(itemLinkOrID) : itemIevelIncrease
C_ArtifactUI.GetMetaPowerInfo() : spellID, powerCost, currentRank
C_ArtifactUI.GetNumAppearanceSets() : numAppearanceSets
C_ArtifactUI.GetNumObtainedArtifacts() : numObtainedArtifacts
C_ArtifactUI.GetNumRelicSlots([onlyUnlocked]) : numRelicSlots
C_ArtifactUI.GetPointsRemaining() : pointsRemaining
C_ArtifactUI.GetPowerHyperlink(powerID) : link
C_ArtifactUI.GetPowerInfo(powerID) : powerInfo
C_ArtifactUI.GetPowerLinks(powerID) : linkingPowerID
C_ArtifactUI.GetPowers() : powerID
C_ArtifactUI.GetPowersAffectedByRelic(relicSlotIndex) : powerIDs
C_ArtifactUI.GetPowersAffectedByRelicItemLink(relicItemInfo) : powerIDs
C_ArtifactUI.GetPreviewAppearance() : artifactAppearanceID
C_ArtifactUI.GetRelicInfo(relicSlotIndex) : name, icon, slotTypeName, link
C_ArtifactUI.GetRelicInfoByItemID(itemID) : name, icon, slotTypeName, link
C_ArtifactUI.GetRelicLockedReason(relicSlotIndex) : lockedReason
C_ArtifactUI.GetRelicSlotType(relicSlotIndex) : slotTypeName
C_ArtifactUI.GetRespecArtifactArtInfo() : artifactArtInfo
C_ArtifactUI.GetRespecArtifactInfo() : itemID, altItemID, name, icon, xp, pointsSpent, quality, artifactAppearanceID, ...
C_ArtifactUI.GetRespecCost() : cost
C_ArtifactUI.GetTotalPowerCost(startingTrait, numTraits, artifactTier) : totalArtifactPowerCost
C_ArtifactUI.GetTotalPurchasedRanks() : totalPurchasedRanks
C_ArtifactUI.IsArtifactDisabled() : artifactDisabled
C_ArtifactUI.IsAtForge() : isAtForge
C_ArtifactUI.IsEquippedArtifactDisabled() : artifactDisabled
C_ArtifactUI.IsEquippedArtifactMaxed() : artifactMaxed
C_ArtifactUI.IsMaxedByRulesOrEffect() : isEffectivelyMaxed
C_ArtifactUI.IsPowerKnown(powerID) : known
C_ArtifactUI.IsViewedArtifactEquipped() : isViewedArtifactEquipped
C_ArtifactUI.SetAppearance(artifactAppearanceID)
C_ArtifactUI.SetForgeCamera()
C_ArtifactUI.SetForgeRotation(forgeRotationX, forgeRotationY, forgeRotationZ)
C_ArtifactUI.SetPreviewAppearance([artifactAppearanceID])
C_ArtifactUI.ShouldSuppressForgeRotation() : shouldSuppressForgeRotation
HasArtifactEquipped()
IsArtifactPowerItem()
IsArtifactRelicItem(item)

Invasions

Invasions were added in Patch 7.0.3

C_InvasionInfo.AreInvasionsAvailable() : areInvasionsAvailable - Returns true if invasions are active in the same physical area as the player.
C_InvasionInfo.GetInvasionForUiMapID(uiMapID) : invasionID - Returns any invasion for a map.
C_InvasionInfo.GetInvasionInfo(invasionID) : invasionInfo - Returns invasion info.
C_InvasionInfo.GetInvasionTimeLeft(invasionID) : timeLeftMinutes - Returns the time left for an invasion.

Contribution

Relates to buildings on the Broken Shore or Warfronts; added in Patch 7.2.0.

C_ContributionCollector.Close() - Closes the contribution collector API state.
C_ContributionCollector.Contribute(contributionID) - Contributes resources to a building.
C_ContributionCollector.GetActive() : contributionID - Returns the currently active buildings.
C_ContributionCollector.GetAtlases(contributionID) : atlasName - Returns a table listing the possible states for a building.
C_ContributionCollector.GetBuffs(contributionID) : spellID - Returns the buffs provided by a building (e.g. in a Warfront).
C_ContributionCollector.GetContributionAppearance(contributionID, contributionState) : appearance - Returns contribution appearance info.
C_ContributionCollector.GetContributionCollectorsForMap(uiMapID) : contributionCollectors - Returns contribution buildings on a map.
C_ContributionCollector.GetContributionResult(contributionID) : result - Returns a value indicating the result of a contribution.
C_ContributionCollector.GetDescription(contributionID) : description - Returns the description of a building.
C_ContributionCollector.GetManagedContributionsForCreatureID(creatureID) : contributionID - Returns contributions for a creature.
C_ContributionCollector.GetName(contributionID) : name - Returns the name of a building.
C_ContributionCollector.GetOrderIndex(contributionID) : orderIndex - Returns the order in which buildings are displayed.
C_ContributionCollector.GetRequiredContributionCurrency(contributionID) : currencyID, currencyAmount - Returns the currencyID and amount needed to contribute to a building.
C_ContributionCollector.GetRequiredContributionItem(contributionID) : itemID, itemCount - Returns the itemID and amount needed to contribute to a building.
C_ContributionCollector.GetRewardQuestID(contributionID) : questID - Returns the hidden quest that is flagged completed when a contribution is made.
C_ContributionCollector.GetState(contributionID) : contributionState, contributionPercentageComplete, timeOfNextStateChange, ... - Returns the current state of a building, its completion percentage, and time until next state change.
C_ContributionCollector.HasPendingContribution(contributionID) : hasPending - Returns whether there is a pending contribution.
C_ContributionCollector.IsAwaitingRewardQuestData(contributionID) : awaitingData - True if the client is waiting for quest reward data.

Battle for Azeroth

Azerite

Azerite was added in Patch 8.0.1

C_AzeriteItem.FindActiveAzeriteItem() : activeAzeriteItemLocation
C_AzeriteItem.GetAzeriteItemXPInfo(azeriteItemLocation) : xp, totalLevelXP
C_AzeriteItem.GetPowerLevel(azeriteItemLocation) : powerLevel
C_AzeriteItem.GetUnlimitedPowerLevel(azeriteItemLocation) : powerLevel
C_AzeriteItem.HasActiveAzeriteItem() : hasActiveAzeriteItem
C_AzeriteItem.IsAzeriteItem(itemLocation) : isAzeriteItem
C_AzeriteItem.IsAzeriteItemAtMaxLevel() : isAtMax
C_AzeriteItem.IsAzeriteItemByID(itemInfo) : isAzeriteItem
C_AzeriteItem.IsAzeriteItemEnabled(azeriteItemLocation) : isEnabled
C_AzeriteEmpoweredItem.CanSelectPower(azeriteEmpoweredItemLocation, powerID) : canSelect
C_AzeriteEmpoweredItem.CloseAzeriteEmpoweredItemRespec()
C_AzeriteEmpoweredItem.ConfirmAzeriteEmpoweredItemRespec(azeriteEmpoweredItemLocation)
C_AzeriteEmpoweredItem.GetAllTierInfo(azeriteEmpoweredItemLocation) : tierInfo
C_AzeriteEmpoweredItem.GetAllTierInfoByItemID(itemInfo [, classID]) : tierInfo
C_AzeriteEmpoweredItem.GetAzeriteEmpoweredItemRespecCost() : cost
C_AzeriteEmpoweredItem.GetPowerInfo(powerID) : powerInfo
C_AzeriteEmpoweredItem.GetPowerText(azeriteEmpoweredItemLocation, powerID, level) : powerText
C_AzeriteEmpoweredItem.GetSpecsForPower(powerID) : specInfo
C_AzeriteEmpoweredItem.HasAnyUnselectedPowers(azeriteEmpoweredItemLocation) : hasAnyUnselectedPowers
C_AzeriteEmpoweredItem.HasBeenViewed(azeriteEmpoweredItemLocation) : hasBeenViewed
C_AzeriteEmpoweredItem.IsAzeriteEmpoweredItem(itemLocation) : isAzeriteEmpoweredItem
C_AzeriteEmpoweredItem.IsAzeriteEmpoweredItemByID(itemInfo) : isAzeriteEmpoweredItem
C_AzeriteEmpoweredItem.IsAzeritePreviewSourceDisplayable(itemInfo [, classID]) : isAzeritePreviewSourceDisplayable
C_AzeriteEmpoweredItem.IsHeartOfAzerothEquipped() : isHeartOfAzerothEquipped
C_AzeriteEmpoweredItem.IsPowerAvailableForSpec(powerID, specID) : isPowerAvailableForSpec
C_AzeriteEmpoweredItem.IsPowerSelected(azeriteEmpoweredItemLocation, powerID) : isSelected
C_AzeriteEmpoweredItem.SelectPower(azeriteEmpoweredItemLocation, powerID) : success
C_AzeriteEmpoweredItem.SetHasBeenViewed(azeriteEmpoweredItemLocation)
C_PaperDollInfo.GetInspectAzeriteItemEmpoweredChoices(unit, equipmentSlotIndex) : azeritePowerIDs

Azerite Essences were added in Patch 8.2.0

C_AzeriteEssence.ActivateEssence(essenceID, milestoneID)
C_AzeriteEssence.CanActivateEssence(essenceID, milestoneID) : canActivate
C_AzeriteEssence.CanDeactivateEssence(milestoneID) : canDeactivate
C_AzeriteEssence.CanOpenUI() : canOpen
C_AzeriteEssence.ClearPendingActivationEssence()
C_AzeriteEssence.CloseForge()
C_AzeriteEssence.GetEssenceHyperlink(essenceID, rank) : link
C_AzeriteEssence.GetEssenceInfo(essenceID) : info
C_AzeriteEssence.GetEssences() : essences
C_AzeriteEssence.GetMilestoneEssence(milestoneID) : essenceID
C_AzeriteEssence.GetMilestoneInfo(milestoneID) : info
C_AzeriteEssence.GetMilestones() : milestones
C_AzeriteEssence.GetMilestoneSpell(milestoneID) : spellID
C_AzeriteEssence.GetNumUnlockedEssences() : numUnlockedEssences
C_AzeriteEssence.GetNumUsableEssences() : numUsableEssences
C_AzeriteEssence.GetPendingActivationEssence() : essenceID
C_AzeriteEssence.HasNeverActivatedAnyEssences() : hasNeverActivatedAnyEssences
C_AzeriteEssence.HasPendingActivationEssence() : hasEssence
C_AzeriteEssence.IsAtForge() : isAtForge
C_AzeriteEssence.SetPendingActivationEssence(essenceID)
C_AzeriteEssence.UnlockMilestone(milestoneID)

Corruption

Corrupted items were added in Patch 8.3.0

C_Item.IsItemCorrupted(itemLoc) : isCorrupted
C_Item.IsItemCorruptionRelated(itemLoc) : isCorruptionRelated
C_Item.IsItemCorruptionResistant(itemLoc) : isCorruptionResistant
C_ItemInteraction.SetCorruptionReforgerItemTooltip()
GetCorruption()
GetCorruptionResistance()
GetNegativeCorruptionEffectInfo() : corruptionEffects
IsCorruptedItem(item)

Island Expeditions

Island Expeditions were added in Patch 8.0.1

C_IslandsQueue.CloseIslandsQueueScreen() - Closes the islands queue screen.
C_IslandsQueue.GetIslandDifficultyInfo() : islandDifficultyInfo - Returns the island expedition modes.
C_IslandsQueue.GetIslandsMaxGroupSize() : maxGroupSize - Returns the max group size for expeditions.
C_IslandsQueue.GetIslandsWeeklyQuestID() : questID - Returns the weekly island quest.
C_IslandsQueue.QueueForIsland(difficultyID) - Queues for an island expedition.
C_IslandsQueue.RequestPreloadRewardData(questId) - Preloads reward data for a quest id.
C_PartyPose.GetPartyPoseInfoByMapID(mapID) : info - Returns party pose info for an Island Expedition or Warfront.
ShouldShowIslandsWeeklyPOI()

Scrapping Machine

The Scrapper was added in Patch 8.0.1

C_Item.CanScrapItem(itemLoc) : canBeScrapped
C_ScrappingMachineUI.CloseScrappingMachine()
C_ScrappingMachineUI.DropPendingScrapItemFromCursor(index)
C_ScrappingMachineUI.GetCurrentPendingScrapItemLocationByIndex(index) : itemLoc
C_ScrappingMachineUI.GetScrapSpellID() : spellID
C_ScrappingMachineUI.GetScrappingMachineName() : name
C_ScrappingMachineUI.HasScrappableItems() : hasScrappableItems
C_ScrappingMachineUI.RemoveAllScrapItems()
C_ScrappingMachineUI.RemoveCurrentScrappingItem()
C_ScrappingMachineUI.RemoveItemToScrap(index)
C_ScrappingMachineUI.ScrapItems()
C_ScrappingMachineUI.SetScrappingMachine(gameObject)
C_ScrappingMachineUI.ValidateScrappingList()

Shadowlands

Ardenweald

C_ArdenwealdGardening.GetGardenData() : data
C_ArdenwealdGardening.IsGardenAccessible() : accessible

The Maw

C_Spell.GetMawPowerBorderAtlasBySpellID(spellID) : rarityBorderAtlas
GetMawPowerLinkBySpellID(spellID)

Torghast

C_PartyInfo.IsPartyInJailersTower() : isPartyInJailersTower
C_ScenarioInfo.GetJailersTowerTypeString(runType) : typeString
GetJailersTowerLevel()
IsInJailersTower()
IsJailersTowerLayerTimeLocked()
IsOnGroundFloorInJailersTower()

Anima

Anima was added in Patch 9.0.1

C_AnimaDiversion.CloseUI()
C_AnimaDiversion.GetAnimaDiversionNodes() : animaNodes
C_AnimaDiversion.GetOriginPosition() : normalizedPosition
C_AnimaDiversion.GetReinforceProgress() : progress
C_AnimaDiversion.GetTextureKit() : textureKit
C_AnimaDiversion.OpenAnimaDiversionUI()
C_AnimaDiversion.SelectAnimaNode(talentID, temporary)
C_Item.IsAnimaItemByID(itemInfo) : isAnimaItem

Covenants

Covenants were added in Patch 9.0.1

C_Covenants.GetActiveCovenantID() : covenantID
C_Covenants.GetCovenantData(covenantID) : data
C_Covenants.GetCovenantIDs() : covenantID
C_CovenantCallings.AreCallingsUnlocked() : unlocked
C_CovenantCallings.RequestCallings()
C_CovenantPreview.CloseFromUI()
C_CovenantPreview.GetCovenantInfoForPlayerChoiceResponseID(playerChoiceResponseID) : previewInfo
C_CovenantSanctumUI.CanAccessReservoir() : canAccess
C_CovenantSanctumUI.CanDepositAnima() : canDeposit
C_CovenantSanctumUI.DepositAnima()
C_CovenantSanctumUI.EndInteraction()
C_CovenantSanctumUI.GetAnimaInfo() : currencyID, maxDisplayableValue
C_CovenantSanctumUI.GetCurrentTalentTreeID() : currentTalentTreeID
C_CovenantSanctumUI.GetFeatures() : features
C_CovenantSanctumUI.GetRenownLevel() : level
C_CovenantSanctumUI.GetRenownLevels(covenantID) : levels
C_CovenantSanctumUI.GetRenownRewardsForLevel(covenantID, renownLevel) : rewards
C_CovenantSanctumUI.GetSanctumType() : sanctumType
C_CovenantSanctumUI.GetSoulCurrencies() : currencyIDs
C_CovenantSanctumUI.HasMaximumRenown() : hasMaxRenown
C_CovenantSanctumUI.IsPlayerInRenownCatchUpMode() : isInCatchUpMode
C_CovenantSanctumUI.IsWeeklyRenownCapped() : isWeeklyCapped
C_CovenantSanctumUI.RequestCatchUpState()

Legendary Crafting

Shadowlands legendaries can be crafted in the Forge of Domination.

C_LegendaryCrafting.CloseRuneforgeInteraction()
C_LegendaryCrafting.CraftRuneforgeLegendary(description)
C_LegendaryCrafting.GetRuneforgeItemPreviewInfo(baseItem [, runeforgePowerID, modifiers]) : info
C_LegendaryCrafting.GetRuneforgeLegendaryComponentInfo(runeforgeLegendary) : componentInfo
C_LegendaryCrafting.GetRuneforgeLegendaryCost(baseItem) : cost
C_LegendaryCrafting.GetRuneforgeLegendaryCraftSpellID() : spellID
C_LegendaryCrafting.GetRuneforgeLegendaryCurrencies() : currencies
C_LegendaryCrafting.GetRuneforgeLegendaryUpgradeCost(runeforgeLegendary, upgradeItem) : cost
C_LegendaryCrafting.GetRuneforgeModifierInfo(baseItem, [powerID], addedModifierIndex, modifiers) : name, description
C_LegendaryCrafting.GetRuneforgeModifiers() : modifiedReagentItemIDs
C_LegendaryCrafting.GetRuneforgePowerInfo(runeforgePowerID) : power
C_LegendaryCrafting.GetRuneforgePowers([baseItem, filter]) : primaryRuneforgePowerIDs, otherRuneforgePowerIDs
C_LegendaryCrafting.GetRuneforgePowersByClassSpecAndCovenant([classID, specID, covenantID, filter]) : runeforgePowerIDs
C_LegendaryCrafting.GetRuneforgePowerSlots(runeforgePowerID) : slotNames
C_LegendaryCrafting.IsRuneforgeLegendary(item) : isRuneforgeLegendary
C_LegendaryCrafting.IsRuneforgeLegendaryMaxLevel(runeforgeLegendary) : isMaxLevel
C_LegendaryCrafting.IsUpgradeItemValidForRuneforgeLegendary(runeforgeLegendary, upgradeItem) : isValid
C_LegendaryCrafting.IsValidRuneforgeBaseItem(baseItem) : isValid
C_LegendaryCrafting.MakeRuneforgeCraftDescription(baseItem, runeforgePowerID, modifiers) : description
C_LegendaryCrafting.UpgradeRuneforgeLegendary(runeforgeLegendary, upgradeItem)
DEPRECATED C_LegendaryCrafting.GetRuneforgePowersByClassAndSpec([classID, specID, filter]) : runeforgePowerIDs

Soulbinds

Relates to Soulbinding and Conduits.

C_Soulbinds.ActivateSoulbind(soulbindID)
C_Soulbinds.CanActivateSoulbind(soulbindID) : result, errorDescription
C_Soulbinds.CanModifySoulbind() : result
C_Soulbinds.CanResetConduitsInSoulbind(soulbindID) : result, errorDescription
C_Soulbinds.CanSwitchActiveSoulbindTreeBranch() : result
C_Soulbinds.CloseUI()
C_Soulbinds.CommitPendingConduitsInSoulbind(soulbindID)
C_Soulbinds.FindNodeIDActuallyInstalled(soulbindID, conduitID) : nodeID
C_Soulbinds.FindNodeIDAppearingInstalled(soulbindID, conduitID) : nodeID
C_Soulbinds.FindNodeIDPendingInstall(soulbindID, conduitID) : nodeID
C_Soulbinds.FindNodeIDPendingUninstall(soulbindID, conduitID) : nodeID
C_Soulbinds.GetActiveSoulbindID() : soulbindID
C_Soulbinds.GetConduitCollection(conduitType) : collectionData
C_Soulbinds.GetConduitCollectionCount() : count
C_Soulbinds.GetConduitCollectionData(conduitID) : collectionData
C_Soulbinds.GetConduitCollectionDataAtCursor() : collectionData
C_Soulbinds.GetConduitCollectionDataByVirtualID(virtualID) : collectionData
C_Soulbinds.GetConduitDisplayed(nodeID) : conduitID
C_Soulbinds.GetConduitHyperlink(conduitID, rank) : link
C_Soulbinds.GetConduitIDPendingInstall(nodeID) : conduitID
C_Soulbinds.GetConduitQuality(conduitID, rank) : quality
C_Soulbinds.GetConduitRank(conduitID) : conduitRank
C_Soulbinds.GetConduitSpellID(conduitID, conduitRank) : spellID
C_Soulbinds.GetInstalledConduitID(nodeID) : conduitID
C_Soulbinds.GetNode(nodeID) : node
C_Soulbinds.GetSoulbindData(soulbindID) : data
C_Soulbinds.GetSpecsAssignedToSoulbind(soulbindID) : specIDs
C_Soulbinds.GetTree(treeID) : tree
C_Soulbinds.HasAnyInstalledConduitInSoulbind(soulbindID) : result
C_Soulbinds.HasAnyPendingConduits() : result
C_Soulbinds.HasPendingConduitsInSoulbind(soulbindID) : result
C_Soulbinds.IsConduitInstalled(nodeID) : result
C_Soulbinds.IsConduitInstalledInSoulbind(soulbindID, conduitID) : result
C_Soulbinds.IsItemConduitByItemInfo(itemInfo) : result
C_Soulbinds.IsNodePendingModify(nodeID) : result
C_Soulbinds.IsUnselectedConduitPendingInSoulbind(soulbindID) : result
C_Soulbinds.ModifyNode(nodeID, conduitID, type)
C_Soulbinds.SelectNode(nodeID)
C_Soulbinds.UnmodifyNode(nodeID)
C_Item.IsItemConduit(itemLoc) : isConduit
SetCursorVirtualItem()
DEPRECATED C_Soulbinds.GetConduitItemLevel(conduitID, rank) : itemLevel

Cypher Equipment

C_Garrison.GetCurrentCypherEquipmentLevel() : equipmentLevel
C_Garrison.GetCyphersToNextEquipmentLevel() : cyphersToNext
C_Garrison.GetMaxCypherEquipmentLevel() : maxEquipmentLevel

Classic

WoW Icon update See Global functions/Classic for a complete list.

Note
Note: This incomplete list is up to date as of Patch 2.5.3 (41812) Jan 7 2022
C_LFGList.IsLookingForGroupEnabled()
C_StorePublic.HasPurchaseableProducts()
CastingInfo() - Returns the player's currently casting spell.
ChannelInfo() - Returns the player's currently channeling spell.
GetFirstBagBankSlotIndex() - Returns the index of the first bag slot within the bank container.
IsPlayerAttacking(unit) - Returns if the player is melee attacking the specified unit.
ShowCloak(flag) - Enables or disables display of your cloak.
ShowHelm(flag) - Enables or disables display of your helm.
ShowingCloak() - Returns if the player is showing his cloak.
ShowingHelm() - Returns if the player is showing his helm.
UnitResistance(unit [, resistanceIndex]) - Returns information about a unit's resistance.

Seasons

C_Seasons.GetActiveSeason()
C_Seasons.HasActiveSeason()

Auction House

CanCancelAuction(index) - Returns 1 if auction can be canceled.
CanSendAuctionQuery() - Returns 1 if auction search button would be active, nil otherwise.
CancelAuction(index) - Cancel the specified auction (on the "owner" list).
CancelSell() - Clears the auction house listing queue, not creating any additional auctions.
ClickAuctionSellItemButton() - Puts the currently 'picked up' item into the 'create auction' slot.
CloseAuctionHouse() - Will close the AuctionFrame if opened.
GetAuctionDeposit(runTime, minBid, buyoutPrice [, itemCount, numStacks]) - Calculate the deposit cost of posting the currently selected item.
GetAuctionHouseDepositRate() - Returns the deposit rate (percentage) for the currently open auction house.
GetAuctionItemBattlePetInfo(type, index) - Returns model details about the specified Battle Pet auction item.
GetAuctionItemInfo(type, index) - Returns details about the specified auction item.
GetAuctionItemLink(type, index) - Returns an itemLink for the specified auction item.
GetAuctionItemSubClasses(classID) - Returns subcategories for the item category.
GetAuctionItemTimeLeft(type, index) - Returns the time left status of the specified auction item.
GetAuctionSellItemInfo() - Returns information about the current selling item (or nil if none selected).
GetAuctionSort()
GetBidderAuctionItems([page]) - Query all auctions the player is bidding on (results accessed using GetAuctionItemInfo)
GetNumAuctionItems(type) - Returns the size of the specified auction item list.
GetOwnerAuctionItems([page]) - Query all the player's active posted auctions (results accessed using GetAuctionItemInfo)
GetSelectedAuctionItem(type) - Returns the index (1-50) of the selected auction item or 0 if none is selected (used by the vanilla UI).
IsAuctionSortReversed(type, sort) - Returns 1 if the specified auction list and sort is reversed, nil otherwise.
PlaceAuctionBid(type, index, bid) - Place a bid on the specified auction item.
PostAuction(minBid, buyoutPrice, runTime, stackSize, numStacks) - Post the currently selected item
QueryAuctionItems(text, minLevel, maxLevel, page, usable, rarity, getAll, exactMatch, filterData) - Performs a search of the auction house with the specified characteristics.
SetAuctionsTabShowing(showing) - Enables the right-click to select an item for posting from your bags shortcut.
SetSelectedAuctionItem(type, index) - Selects a specific item in the auction house (used by the vanilla UI).
SortAuctionApplySort(type)
SortAuctionClearSort(type)
SortAuctionItems(type, sort) - Toggles sorting the specific auction list by a specific column.
SortAuctionSetSort(type, sort [, reverse]) - Sorts the specific auction list by a specific column, optionally in reverse order. Requires SortAuctionApplySort() or another search query afterwards to update.

Hunter Pets

ConfirmPetUnlearn() - Confirms unlearning the current pet's skills.
GetPetHappiness() - Returns the pet's happiness, damage percentage, and loyalty gain rate.
GetPetLoyalty() - Returns pet loyalty flavor text.
GetPetTrainingPoints() - Gets the training point information about the current pet.

Stables

BuyStableSlot() - Buys the next stable slot if the stable window is open and you can afford it.
ClickStablePet(index) - Selects a stable pet.
GetNextStableSlotCost() - Returns the next stable slot's cost in copper.
GetNumStablePets() - Returns the amount of stable pets.
GetNumStableSlots() - Returns the amount of stable slots.
GetSelectedStablePet() - Gets the index of the currently selected pet in the stable.
StablePet() - Puts your current pet in the stable if there is room.
UnstablePet(index) - Unstables a pet.

Keyring

The Keyring was added again in Patch 1.13.3

HasKey() - Returns whether or not the player has a key ring.
KeyRingButtonIDToInvSlotID(buttonID) - Map a keyring button to an inventory slot button for use in inventory functions.

Professions

CloseTradeSkill()
CollapseTradeSkillSubClass(index)
DoTradeSkill(index [, repeat])
ExpandTradeSkillSubClass(index)
GetFirstTradeSkill()
GetNumPrimaryProfessions()
GetNumTradeSkills()
GetTradeSkillCooldown(index)
GetTradeSkillIcon(index)
GetTradeSkillInfo(index)
GetTradeSkillInvSlotFilter(index)
GetTradeSkillInvSlots()
GetTradeSkillItemLink(index)
GetTradeSkillItemStats()
GetTradeSkillLine()
GetTradeSkillNumMade(index)
GetTradeSkillNumReagents(index)
GetTradeSkillReagentInfo(index, reagentIndex)
GetTradeSkillReagentItemLink(index, reagentIndex)
GetTradeSkillSelectionIndex()
GetTradeSkillSubClassFilter(index)
GetTradeSkillSubClasses()
GetTradeSkillTools(index)
GetTradeskillRepeatCount()
SelectTradeSkill(index)
SetTradeSkillInvSlotFilter(index [, on\off, exclusive])
SetTradeSkillSubClassFilter(index [, on\off, exclusive])

Crafting

The Craft UI is used for Enchanting and Beast Training.

CloseCraft()
CollapseCraftSkillLine(index)
DoCraft(index)
ExpandCraftSkillLine(index)
GetCraftButtonToken()
GetCraftDescription(index)
GetCraftDisplaySkillLine()
GetCraftIcon(index)
GetCraftInfo(index)
GetCraftItemLink(index)
GetCraftName()
GetCraftNumReagents(index)
GetCraftReagentInfo(index, reagentIndex)
GetCraftReagentItemLink(index, reagentIndex)
GetCraftSelectionIndex()
GetCraftSkillLine(index)
GetCraftSpellFocus(index)
GetNumCrafts()
SelectCraft(index)

PvP

GetInspectPVPRankProgress() - Gets the inspected unit's progress towards the next PvP rank.
GetPVPLastWeekStats() - Gets the player's PVP contribution statistics for the previous week.
GetPVPRankInfo(rank [, unit]) - Returns information about a specific PvP rank.
GetPVPRankProgress() - Returns the player's progress to the next PvP rank.
GetPVPThisWeekStats() - Gets your PVP contribution statistics for the current week.
UnitIsCivilian(unit) - Determine whether a unit is a civilian (low level enemy faction NPC that counts as a dishonorable kill).
UnitPVPRank(unit) - Returns the specified unit's PvP rank ID.

Battlegrounds

GetBattlefieldInstanceInfo(index) - Returns the battlefield instance ID for an index in the battlemaster listing.
GetNumBattlefields() - Returns the number of available instances for the selected battleground at the battlemaster.
GetSelectedBattlefield() - Returns the currently selected battlefield at the battlemaster.
SetSelectedBattlefield(index) - Selects a battlefield instance at the battlemaster.

Arena

AcceptArenaTeam()
ArenaTeamDisband(index)
ArenaTeamInviteByName()
ArenaTeamLeave()
ArenaTeamRoster(index)
ArenaTeamSetLeaderByName()
ArenaTeamUninviteByName()
BuyArenaCharter()
CloseArenaTeamRoster()
DeclineArenaTeam()
GetArenaTeam(id)
GetArenaTeamGdfInfo()
GetArenaTeamIndexBySize(size)
GetArenaTeamRosterInfo(teamindex, playerid)
GetArenaTeamRosterSelection()
GetArenaTeamRosterShowOffline()
GetInspectArenaTeamData()
GetNumArenaTeamMembers()
IsArenaSeasonActive()
IsBattlefieldArena()
SetArenaTeamRosterSelection()
SetArenaTeamRosterShowOffline()
SetPendingReportArenaTeamName()
SortArenaTeamRoster()
TurnInArenaPetition()

Skills

Relates to player/trainer Skills.

CollapseSkillHeader(index) - Collapses a header in the skills window.
CollapseTrainerSkillLine(index) - Collapses a header in the trainer window, hiding all spells below it.
ExpandSkillHeader(index) - Expands a header in the skills window.
ExpandTrainerSkillLine(index) - Expands a header in the trainer window, showing all spells below it.
GetNumSkillLines() - Returns the number of skill lines in the skill window, including headers.
GetSelectedSkill() - Returns the currently selected skill line.
GetSkillLineInfo(index) - Returns information on a skill line/header.
IsTrainerServiceLearnSpell(index) - Returns the type of trainer spell in the trainer window.
SetSelectedSkill(index) - Selects a skill line in the skill window.

Talents

GetNumTalents(tabIndex) - Returns the amount of talents for a specialization.
GetNumTalentTabs() - Returns the total number of talent tabs for the player.
WoW Icon update GetTalentInfo(tabIndex, talentIndex) - Returns information about a talent.
GetTalentPrereqs(tabIndex, talentIndex) - Returns the tier and column of a talent's prerequisite, and if the talent is learnable.
GetTalentTabInfo(index) - Returns information for a talent tab (tree).
UnitCharacterPoints(unit) - Returns the number of unspent talent points of the player.

Tracking

CancelTrackingBuff() - Cancels your current tracking buff (skills like Find Minerals and Track Humanoids).
GetTrackingTexture() - Returns the texture of the active tracking buff.

FrameXML

MathUtil

UI Lerp(startValue, endValue, amount) : number - Linearly interpolates between two values for a parameter amount in the closed unit interval [0, 1]
UI Clamp(value, min, max) : number
UI Saturate(value) : number
UI Wrap(value, max) : number
UI ClampDegrees(value) : number
UI ClampMod(value, mod) : number
UI NegateIf(value, condition) : number
UI PercentageBetween(value, startValue, endValue) : number
UI ClampedPercentageBetween(value, startValue, endValue) : number
UI DeltaLerp(startValue, endValue, amount, timeSec) : number
UI FrameDeltaLerp(startValue, endValue, amount) : number
UI RandomFloatInRange(minValue, maxValue) : number
UI Round(value) : number - Rounds a value.
UI Square(value) : number - Squares a value.
UI CalculateDistanceSq(x1, y1, x2, y2) : number
UI CalculateDistance(x1, y1, x2, y2) : number
UI CalculateAngleBetween(x1, y1, x2, y2) : number

TableUtil

UI ripairs(tbl) : iter, invariant, init - Reverse iterates over a sequential table.
UI tDeleteItem(tbl, item) - Removes a value from a sequential table.
UI tIndexOf(tbl, item) : index - Returns the index for a value in a table.
UI tContains(tbl, item) : boolean - Returns true if a sequential table contains a value.
UI tCompare(lhsTable, rhsTable [, depth]) : boolean - Does a deep compare on the values of the table.
UI tInvert(tbl) : table - Returns an inverted table.
UI tFilter(tbl, pred, isIndexTable) : table
UI tAppendAll(table, addedArray) - Appends the contents of a sequential table to another table.
UI tUnorderedRemove(tbl, index)
UI CopyTable(settings) : table - Returns a deep copy of a table.
UI AccumulateIf(tbl, pred) : count
UI ContainsIf(tbl, pred) : boolean
UI FindInTableIf(tbl, pred) : key, value
UI SafePack(...) : table
UI SafeUnpack(tbl) : ...

CvarUtil

UI RegisterCVar(name, value)
UI ResetTestCvars()
UI SetCVar(name, value, eventName) : success
UI GetCVar(name) : value
UI SetCVarBitfield(name, index, value, scriptCVar) : success
UI GetCVarBitfield(name, index) : boolean
UI GetCVarBool(name) : boolean
UI GetCVarDefault(name) : value

Mixins

See also the Complete list of mixins

Mixins are similar to classes in OOP languages. An object can "inherit" from multiple mixins.

UI Mixin(object, ...) - Copies mixins into an existing object.
UI CreateFromMixins(...) - Copies mixins into a new object.
UI CreateColor(r, g, b, a) - Returns a ColorMixin object.
UI CreateRectangle(left, right, top, bottom) - Returns a RectangleMixin object.
UI CreateVector2D(x, y) - Returns a Vector2DMixin object.
UI CreateVector3D(x, y, z) - Returns a Vector3DMixin object.
UI SpellMixin:CreateFromSpellID(spellID) - Returns a SpellMixin object.
UI Item:CreateFromItemID(itemID) - Returns an ItemMixin object.
UI ItemLocation:CreateFromBagAndSlot() - Returns an ItemLocationMixin object.
UI PlayerLocation:CreateFromGUID(guid) - Returns a PlayerLocationMixin object.
UI TransmogUtil.CreateTransmogLocation(slotDescriptor, transmogType, modification) - Returns a TransmogLocationMixin object.
UI AnchorMixin
UI AnimatedNumericFontStringMixin
UI DoublyLinkedListMixin
UI GridLayoutMixin
UI LineMixin
UI SecondsFormatterMixin
UI SparseGridMixin
UI TextureLoadingGroupMixin
UI CreateObjectPool(creationFunc, resetterFunc) - Creates a ObjectPoolMixin object for widgets.
UI CreateFramePool(frameType [, parent, frameTemplate, resetterFunc, forbidden]) - Creates a FramePoolMixin for Frames.
UI CreateTexturePool(parent [, layer, subLayer, textureTemplate, resetterFunc]) - Creates a TexturePoolMixin for Textures.
UI CreateFontStringPool(parent [, layer, subLayer, fontStringTemplate, resetterFunc]) - Creates a FontStringPoolMixin for FontStrings.
UI CreateActorPool(parent [, actorTemplate, resetterFunc]) - Creates an ActorPoolMixin for Actors.
UI CreateFramePoolCollection() - Creates a FramePoolCollectionMixin object for frame pools.

UIParent

UI AbbreviateLargeNumbers(value)
UI AbbreviateNumbers(value)

These functions toggle the Interface Panels, but if they use ShowUIPanel() they cannot be called in combat.

UI ShowUIPanel(frame, force)
UI PVEFrame_ToggleFrame() - Toggles the Group Finder.
UI ToggleAchievementFrame() - Shows the Achievements frame.
UI ToggleCharacter(index) - Toggles the character pane to the specified frame.
UI ToggleCollectionsJournal(index) - Toggles the Collections window.
UI ToggleEncounterJournal() - Toggles the Adventure Guide.
UI ToggleFriendsFrame([tabNumber]) - Opens/closes the friends pane, optionally on a specific tab.
UI ToggleGameMenu() - Opens/closes the game menu.
UI ToggleGuildFrame() - Toggles the Guild & Communites frame.
UI ToggleHelpFrame() - Opens the Help Request frame.
UI ToggleMinimap() - Turns the minimap display on/off.
UI TogglePVPUI() - Opens/closes the PvP frame.
UI ToggleSpellBook(bookType) - Shows the spellbook. Can show your spells or your pet's.
UI ToggleTalentFrame() - Opens the Talent frame.


Interface/SharedXML

AccountUtil

UI GameLimitedMode_IsActive()
UI GetClampedCurrentExpansionLevel()

AnchorUtil

UI AnchorUtil.CreateAnchor(point, relativeTo, relativePoint, x, y)
UI AnchorUtil.CreateGridLayout(direction, rowSize, spacingX, spacingY)
UI AnchorUtil.CreateAnchorFromPoint(region, pointIndex)
UI AnchorUtil.GridLayout(frames, initialAnchor, layout)
UI AnchorUtil.GridLayoutFactoryByCount(factoryFunction, count, initialAnchor, layout)
UI AnchorUtil.GridLayoutFactory(factoryFunction, initialAnchor, totalWidth, totalHeight, overrideDirection, overridePaddingX, overridePaddingY)
UI AnchorUtil.MirrorRegionsAlongVerticalAxis(mirrorDescriptions)
UI AnchorUtil.MirrorRegionsAlongHorizontalAxis(mirrorDescriptions)

ColorUtil

UI CreateColorFromHexString(hexColor)
UI CreateColorFromBytes(r, g, b, a)
UI AreColorsEqual(left, right)
UI GetClassColor(classFilename)
UI GetClassColorObj(classFilename)
UI GetClassColoredTextForUnit(unit, text)
UI GetFactionColor(factionGroupTag)

EasingUtil

UI EasingUtil.InQuadratic(percent)
UI EasingUtil.OutQuadratic(percent)
UI EasingUtil.InOutQuadratic(percent)
UI EasingUtil.InCubic(percent)
UI EasingUtil.OutCubic(percent)
UI EasingUtil.InOutCubic(percent)
UI EasingUtil.InQuartic(percent)
UI EasingUtil.OutQuartic(percent)
UI EasingUtil.InOutQuartic(percent)
UI EasingUtil.InQuintic(percent)
UI EasingUtil.OutQuintic(percent)
UI EasingUtil.InOutQuintic(percent)

ErrorUtil

UI CallErrorHandler(...)

Flags

UI Flags_CreateMask(...) - Creates a bitmask.
UI Flags_CreateMaskFromTable(flagsTable)
UI FlagsUtil.IsSet(bitMask, flagOrMask)

FormattingUtil

UI SplitTextIntoLines(text, delimiter)
UI SplitTextIntoHeaderAndNonHeader(text)
UI FormatValueWithSign(value)
UI FormatLargeNumber(amount) - Formats a number with dot or comma number seperators.
UI GetMoneyString(money, separateThousands)
UI FormatPercentage(percentage, roundToNearestInteger)
UI FormatFraction(numerator, denominator)
UI GetHighlightedNumberDifferenceString(baseString, newString)
UI FormatUnreadMailTooltip(tooltip, headerText, senders)
UI GetCurrencyString(currencyID, overrideAmount, colorCode, abbreviate)
UI GetCurrenciesString(currencies)
UI ReplaceGenderTokens(string, gender)

FrameUtil

UI FrameUtil.RegisterFrameForEvents(frame, events)
UI FrameUtil.UnregisterFrameForEvents(frame, events)
UI FrameUtil.RegisterFrameForUnitEvents(frame, events, ...)
UI DoesAncestryInclude(ancestry, frame)
UI GetUnscaledFrameRect(frame, scale)
UI ApplyDefaultScale(frame, minScale, maxScale)
UI UpdateScaleForFit(frame)

FunctionUtil

UI ExecuteFrameScript(frame, scriptName, ...) - Manually calls the handler for a frame script.
UI CallMethodOnNearestAncestor(self, methodName, ...)
UI GetValueOrCallFunction(tbl, key, ...)
UI GenerateClosure(f, ...)

InterfaceUtil

UI ReloadUI()
UI StoreInterfaceUtil.OpenToSubscriptionProduct()

LinkUtil

UI ExtractHyperlinkString(linkString) - Gets the contents from a hyperlink.
UI ExtractLinkData(link)
UI ExtractQuestRewardID(linkString)
UI GetItemInfoFromHyperlink(link)
UI GetAchievementInfoFromHyperlink(link)
UI GetURLIndexAndLoadURL(self, link)

NineSlice

UI NineSliceUtil.ApplyUniqueCornersLayout(self, textureKit)
UI NineSliceUtil.ApplyIdenticalCornersLayout(self, textureKit)
UI NineSliceUtil.ApplyLayout(container, userLayout, textureKit)
UI NineSliceUtil.DisableSharpening(container)
UI NineSliceUtil.ApplyLayoutByName(container, userLayoutName, textureKit)
UI NineSliceUtil.GetLayout(layoutName)
UI NineSliceUtil.AddLayout(layoutName, layout)

PixelUtil

UI PixelUtil.GetPixelToUIUnitFactor()
UI PixelUtil.GetNearestPixelSize(uiUnitSize, layoutScale, minPixels)
UI PixelUtil.SetWidth(region, width, minPixels)
UI PixelUtil.SetHeight(region, height, minPixels)
UI PixelUtil.SetSize(region, width, height, minWidthPixels, minHeightPixels)
UI PixelUtil.SetPoint(region, point, relativeTo, relativePoint, offsetX, offsetY, minOffsetXPixels, minOffsetYPixels)
UI PixelUtil.SetStatusBarValue(statusBar, value)

RegionUtil

UI RegionUtil.IsDescendantOf(potentialDescendant, potentialAncestor)
UI RegionUtil.IsDescendantOfOrSame(potentialDescendant, potentialAncestorOrSame)
UI RegionUtil.CalculateDistanceSqBetween(region1, region2)
UI RegionUtil.CalculateDistanceBetween(region1, region2)
UI RegionUtil.CalculateAngleBetween(region1, region2)

RestrictedInfrastructure

UI tostringall(...)
UI IsFrameHandle(handle, protected)
UI GetFrameHandleFrame(handle, protected, onlyProtected)
UI GetFrameHandle(frame, protected)

ScriptAnimationUtil

UI ScriptAnimationUtil.GetScriptAnimationLock(region)
UI ScriptAnimationUtil.ReleaseScriptAnimationLock(region)
UI ScriptAnimationUtil.IsScriptAnimationLockActive(region)
UI ScriptAnimationUtil.ShakeFrameRandom(region, magnitude, duration, frequency)
UI ScriptAnimationUtil.ShakeFrame(region, shake, maximumDuration, frequency)
UI ScriptAnimationUtil.GenerateEasedVariationCallback(easingFunction, distanceX, distanceY, alpha, scale)
UI ScriptAnimationUtil.StartScriptAnimation(region, variationCallback, duration, onFinish)

ScriptedAnimationEffects

UI ScriptedAnimationEffectsUtil.GetEffectByID(effectID)
UI ScriptedAnimationEffectsUtil.ReloadDB()

TextureUtil

UI GetTextureInfo(obj)
UI SetClampedTextureRotation(texture, rotationDegrees)
UI ClearClampedTextureRotation(texture)
UI GetTexCoordsByGrid(xOffset, yOffset, textureWidth, textureHeight, gridWidth, gridHeight)
UI GetTexCoordsForRole(role)
UI CreateTextureMarkup(file, fileWidth, fileHeight, width, height, left, right, top, bottom, xOffset, yOffset)
UI CreateAtlasMarkup(atlasName, width, height, offsetX, offsetY)
UI SetupAtlasesOnRegions(frame, regionsToAtlases, useAtlasSize)
UI GetFinalNameFromTextureKit(fmt, textureKits)
UI SetupTextureKitOnFrame(textureKit, frame, fmt, setVisibility, useAtlasSize)
UI SetupTextureKitOnFrames(textureKit, frames, setVisibilityOfRegions, useAtlasSize)
UI SetupTextureKitOnRegions(textureKit, frame, regions, setVisibilityOfRegions, useAtlasSize)
UI SetupTextureKitsFromRegionInfo(textureKit, frame, regionInfoList)

TimeUtil

UI SecondsToMinutes(seconds)
UI MinutesToSeconds(minutes)
UI HasTimePassed(testTime, amountOfTime)
UI SecondsToClock(seconds, displayZeroHours)
UI SecondsToTime(seconds, noSeconds, notAbbreviated, maxCount, roundUp) - Converts a number of seconds into a readable formatted string.
UI SecondsToTimeAbbrev(seconds) - Converts a number of seconds into a readable and abbreviated formatted string.
UI FormatShortDate(day, month, year)

UnitUtil

UI GetPlayerGuid()
UI IsPlayerGuid(guid)
UI IsPlayerInitialSpec()


Interface/FrameXML

AchievementUtil

UI AchievementUtil.IsCriteriaAchievementEarned(achievementID, criteriaIndex)
UI AchievementUtil.IsCriteriaReputationGained(achievementID, criteriaIndex, checkCriteriaAchievement, countHiddenCriteria)
UI AchievementUtil.IsCategoryFeatOfStrength(category)
UI AchievementUtil.IsFeatOfStrength(achievementID)

ActionButtonUtil

UI ActionButtonUtil.ShowAllActionButtonGrids()
UI ActionButtonUtil.HideAllActionButtonGrids()
UI ActionButtonUtil.SetAllQuickKeybindButtonHighlights(show)
UI ActionButtonUtil.ShowAllQuickKeybindButtonHighlights()
UI ActionButtonUtil.HideAllQuickKeybindButtonHighlights()

AzeriteEssenceUtil

UI AzeriteEssenceUtil.HasAnyUnlockableMilestones()
UI AzeriteEssenceUtil.GetMilestoneAtPowerLevel(powerLevel)
UI AzeriteEssenceUtil.GetMilestoneSpellInfo(milestoneID)

AzeriteUtil

UI AzeriteUtil.EnumerateEquipedAzeriteEmpoweredItems()
UI AzeriteUtil.AreAnyAzeriteEmpoweredItemsEquipped()
UI AzeriteUtil.DoEquippedItemsHaveUnselectedPowers()
UI AzeriteUtil.GetEquippedItemsUnselectedPowersCount()
UI AzeriteUtil.GenerateRequiredSpecTooltipLine(powerID)
UI AzeriteUtil.FindAzeritePowerTier(azeriteEmpoweredItemSource, powerID)
UI AzeriteUtil.GetSelectedAzeritePowerInTier(azeriteEmpoweredItemSource, tierIndex)
UI AzeriteUtil.HasSelectedAnyAzeritePower(azeriteEmpoweredItemSource)
UI AzeriteUtil.DoesBagContainAnyAzeriteEmpoweredItems(bagID)
UI AzeriteUtil.IsAzeriteItemLocationBankBag(azeriteItemLocation)

CalendarUtil

UI CalendarUtil.GetCalendarInviteStatusInfo(inviteStatus)
UI CalendarUtil.GetEventBroadcastText(event)
UI CalendarUtil.GetOngoingEventBroadcastText(event)
UI CalendarUtil.FormatCalendarTimeWeekday(messageDate)
UI CalendarUtil.AreDatesEqual(firstCalendarTime, secondCalendarTime)

CampaignUtil

UI CampaignUtil.BuildChapterProgressText(campaign, formatString)
UI CampaignUtil.GetSingleChapterText(chapterID, lineSpacing)
UI CampaignUtil.BuildAllChaptersText(campaign, lineSpacing)

CommunitiesUtil

UI CommunitiesUtil.GetMemberRGB(memberInfo)
UI CommunitiesUtil.SortClubs(clubs)
UI CommunitiesUtil.SortStreams(streams)
UI CommunitiesUtil.SortMemberInfo(clubId, memberInfoArray)
UI CommunitiesUtil.GetMemberIdsSortedByName(clubId, streamId)
UI CommunitiesUtil.GetMemberInfo(clubId, memberIds)
UI CommunitiesUtil.GetMemberInfoLookup(memberInfoArray)
UI CommunitiesUtil.GetOnlineMembers(memberInfoArray)
UI CommunitiesUtil.SortMembersByList(memberInfoLookup, memberIds)
UI CommunitiesUtil.GetAndSortMemberInfo(clubId, streamId, filterOffline)
UI CommunitiesUtil.DoesAnyCommunityHaveUnreadMessages()
UI CommunitiesUtil.DoesOtherCommunityHaveUnreadMessages(ignoreClubId)
UI CommunitiesUtil.DoesCommunityHaveUnreadMessages(clubId)
UI CommunitiesUtil.DoesCommunityHaveOtherUnreadMessages(clubId, ignoreStreamId)
UI CommunitiesUtil.GetStreamNotificationSettingsLookup(clubId)
UI CommunitiesUtil.DoesCommunityStreamHaveUnreadMessages(clubId, streamId)
UI CommunitiesUtil.CanKickClubMember(clubPrivileges, memberInfo)
UI CommunitiesUtil.ClearAllUnreadNotifications(clubId)
UI CommunitiesUtil.OpenInviteDialog(clubId, streamId)
UI CommunitiesUtil.FindCommunityAndStreamByName(communityName, streamName)
UI CommunitiesUtil.FindGuildStreamByType(clubStreamType)
UI CommunitiesUtil.GetRoleSpecClassLine(classID, specID)
UI CommunitiesUtil.AddLookingForLines(tooltip, recruitingSpecIds, recruitingSpecIdMap, playerSpecs)

CovenantUtil

UI CovenantUtil.GetRenownRewardDisplayData(rewardInfo, onItemUpdateCallback)
UI CovenantUtil.GetUnformattedRenownRewardInfo(rewardInfo, onItemUpdateCallback)
UI CovenantUtil.GetRenownRewardInfo(rewardInfo, onItemUpdateCallback)

CurrencyContainer

UI CurrencyContainerUtil.GetCurrencyContainerInfo(currencyID, numItems, name, texture, quality)
UI CurrencyContainerUtil.GetCurrencyContainerInfoForAlert(currencyID, quantity, name, texture, quality)

DifficultyUtil

UI DifficultyUtil.GetDifficultyName(difficultyID)
UI DifficultyUtil.IsPrimaryRaid(difficultyID)
UI DifficultyUtil.GetNextPrimaryRaidDifficultyID(difficultyID)
UI DifficultyUtil.GetMaxPlayers(difficultyID)

ItemRef

UI SetItemRef(link, text, button, chatFrame) - Handles item link tooltips in chat.
UI GetFixedLink(text, quality)
UI GetBattlePetAbilityHyperlink(abilityID, maxHealth, power, speed)
UI GetPlayerLink(characterName, linkDisplayText, lineID, chatType, chatTarget)
UI GetBNPlayerLink(name, linkDisplayText, bnetIDAccount, lineID, chatType, chatTarget)
UI GetGMLink(gmName, linkDisplayText, lineID)
UI GetBNPlayerCommunityLink(playerName, linkDisplayText, bnetIDAccount, clubId, streamId, epoch, position)
UI GetPlayerCommunityLink(playerName, linkDisplayText, clubId, streamId, epoch, position)
UI GetClubTicketLink(ticketId, clubName, clubType)
UI GetClubFinderLink(clubFinderId, clubName)
UI GetCalendarEventLink(monthOffset, monthDay, index)
UI GetCommunityLink(clubId)
UI LinkUtil.SplitLink(link)
UI LinkUtil.ExtractLink(text)
UI LinkUtil.IsLinkType(link, matchLinkType)

ItemUtil

UI ItemButtonUtil.RegisterCallback(...)
UI ItemButtonUtil.UnregisterCallback(...)
UI ItemButtonUtil.TriggerEvent(...)
UI ItemButtonUtil.GetItemContext()
UI ItemButtonUtil.HasItemContext()
UI ItemButtonUtil.GetItemContextMatchResultForItem(itemLocation)
UI ItemButtonUtil.GetItemContextMatchResultForContainer(bagID)
UI ItemUtil.GetItemDetails(itemLink, quantity, isCurrency, lootSource)
UI ItemUtil.PickupBagItem(itemLocation)
UI ItemUtil.GetOptionalReagentCount(itemID)

MapUtil

UI MapUtil.IsMapTypeZone(mapID)
UI MapUtil.GetMapParentInfo(mapID, mapType, topMost)
UI MapUtil.ShouldMapTypeShowQuests(mapType)
UI MapUtil.ShouldShowTask(mapID, info)
UI MapUtil.MapHasUnlockedBounties(mapID)
UI MapUtil.MapHasEmissaries(mapID)
UI MapUtil.FindBestAreaNameAtMouse(mapID, normalizedCursorX, normalizedCursorY)
UI MapUtil.GetDisplayableMapForPlayer()
UI MapUtil.GetBountySetMaps(bountySetID)
UI MapUtil.GetMapCenterOnMap(mapID, topMapID)
UI MapUtil.IsChildMap(mapID, ancestorMapID)
UI MapUtil.IsOribosMap(mapID)
UI MapUtil.IsShadowlandsZoneMap(mapID)
UI MapUtil.MapShouldShowWorldQuestFilters(mapID)

PVPUtil

UI PVPUtil.GetTierName(tierEnum)
UI PVPUtil.ShouldShowLegacyRewards()

PartyUtil

UI PartyUtil.GetMinLevel()
UI PartyUtil.GetPhasedReasonString(phaseReason, unitToken)
UI GetGroupMemberCountsForDisplay()

QuestUtils

UI QuestUtil.GetWorldQuestAtlasInfo(worldQuestType, inProgress, tradeskillLineID)
UI QuestUtil.GetQuestIconOffer(isLegendary, frequency, isRepeatable, isCampaign, isCovenantCalling)
UI QuestUtil.ApplyQuestIconOfferToTexture(texture, ...)
UI QuestUtil.GetQuestIconActive(isComplete, isLegendary, frequency, isRepeatable, isCampaign, isCovenantCalling)
UI QuestUtil.ApplyQuestIconActiveToTexture(texture, ...)
UI QuestUtil.ShouldQuestIconsUseCampaignAppearance(questID)
UI QuestUtil.GetQuestIconOfferForQuestID(questID)
UI QuestUtil.ApplyQuestIconOfferToTextureForQuestID(texture, ...)
UI QuestUtil.GetQuestIconActiveForQuestID(questID)
UI QuestUtil.ApplyQuestIconActiveToTextureForQuestID(texture, ...)
UI QuestUtil.SetupWorldQuestButton(button, info, inProgress, selected, isCriteria, isSpellTarget, isEffectivelyTracked)

RuneforgeUtil

UI RuneforgeUtil.GetCostsString(costs)
UI RuneforgeUtil.IsUpgradeableRuneforgeLegendary(itemLocation)
UI RuneforgeUtil.GetRuneforgeFilterText(filter)
UI RuneforgeUtil.GetPreviewClassAndSpec()

TitleUtil

UI TitleUtil.GetNameFromTitleMaskID(titleMaskID)

TransmogUtil

UI TransmogUtil.GetInfoForEquippedSlot(transmogLocation)
UI TransmogUtil.CanEnchantSource(sourceID)
UI TransmogUtil.GetWeaponInfoForEnchant(transmogLocation)
UI TransmogUtil.GetBestWeaponInfoForIllusionDressup()
UI TransmogUtil.GetSlotID(slotName)
UI TransmogUtil.GetSlotName(slotID)
UI TransmogUtil.CreateTransmogLocation(slotDescriptor, transmogType, modification)
UI TransmogUtil.GetTransmogLocation(slotDescriptor, transmogType, modification)
UI TransmogUtil.GetTransmogLocationLookupKey(slotID, transmogType, modification)
UI TransmogUtil.GetSetIcon(setID)

See also

External links