m (formatting) Tag: WoW API docs |
Tags: WoW API docs Undo |
||
(523 intermediate revisions by 13 users not shown) | |||
Line 1: | Line 1: | ||
+ | :<span class="noexcerpt" data-nosnippet>[[File:Battlenet_2021_icon.svg|24px|link=]] ''For the Web API, see https://develop.battle.net/documentation/world-of-warcraft''</span> |
||
+ | :<span class="noexcerpt" data-nosnippet>{{Wow-inline}} ''For the Classic WoW API, see [[World of Warcraft API/Classic]]</span> |
||
{{wowapi|notitle=1}} {{tocright}} |
{{wowapi|notitle=1}} {{tocright}} |
||
+ | The '''WoW API''' is available to [[AddOn]]s and macro scripts. It's officially documented in [https://github.com/Gethe/wow-ui-source/tree/beta/Interface/AddOns/Blizzard_APIDocumentationGenerated Blizzard_APIDocumentation] which is accessible via the [[APILink|/api]] command. The [[Lua]] user interface code can be [[Viewing_Blizzard%27s_interface_code|exported]] from the game client. |
||
− | {{for|a complete and automatically generated list|Global functions}} |
||
− | {{for|{{Wow-inline}} Classic only functions|#Classic}} |
||
− | The '''WoW API''' is a set of functions to interact with and modify the World of Warcraft user interface available to [[addons]] and macro scripts. |
||
+ | <!-- https://github.com/Ketho/WowpediaDoc/tree/master/Pages/World_of_Warcraft_API --> |
||
− | Wowpedia [[Wowpedia:How to edit API pages|maintains]] the list below, newer API is also officially documented in [https://github.com/Gethe/wow-ui-source/tree/live/AddOns/Blizzard_APIDocumentation Blizzard_APIDocumentation] and accessible with the [[APILink|/api]] command. The user interface's code, also known as the [[Viewing_Blizzard%27s_interface_code|FrameXML]] can be exported from the game client. Functions are prefixed with the following tags: |
||
+ | {{i-note|This list is up to date as of PTR [[Patch_10.1.7/API_changes|Patch 10.1.7]] (50793) Aug 6 2023}} |
||
− | * '''PROTECTED''' - This can only be called from [[secure code]]. |
||
− | * '''NOCOMBAT''' - This cannot be called from insecure code while in combat. |
||
− | * '''HW''' - This may only be called in response to a hardware event (user input). |
||
− | * '''UI''' - This is implemented in FrameXML but was considered important enough to be listed. |
||
− | * '''DEPRECATED''' - This function has been (re)moved but is still [https://www.townlong-yak.com/framexml/8.3.0/Blizzard_Deprecated/Deprecated_8_3_0.lua available] until the next expansion. |
||
− | == |
+ | ==Patch 10.1.7== |
+ | : [[API C_CharacterServices.AssignNameChangeDistribution|C_CharacterServices.AssignNameChangeDistribution]]() |
||
− | {{i-note|This list is up to date as of [[Patch_9.0.1/API_changes|Patch 9.0.1]] (36230) Oct 13 2020}} |
||
+ | : [[API C_CharacterServices.CapitalizeCharName|C_CharacterServices.CapitalizeCharName]]() |
||
+ | : [[API C_Club.DoesAnyCommunityHaveUnreadMessages|C_Club.DoesAnyCommunityHaveUnreadMessages]]() |
||
+ | : [[API C_InterfaceFileManifest.GetInterfaceArtFiles|C_InterfaceFileManifest.GetInterfaceArtFiles]]() : <span class="apiret">images</span> |
||
+ | : [[API C_PartyInfo.GetRestrictRaidPings|C_PartyInfo.GetRestrictRaidPings]]() : <span class="apiret">restrictToAssistants</span> |
||
+ | : [[API C_PartyInfo.SetRestrictRaidPings|C_PartyInfo.SetRestrictRaidPings]](<span class="apiarg">restrictToAssistants</span>) |
||
+ | : <s>[[API C_Ping.ClearPendingPingInfo|C_Ping.ClearPendingPingInfo]]</s>() |
||
+ | : <s>[[API C_Ping.GetCooldownInfo|C_Ping.GetCooldownInfo]]</s>() : <span class="apiret">cooldownInfo</span> |
||
+ | : <s>[[API C_Ping.GetDefaultPingOptions|C_Ping.GetDefaultPingOptions]]</s>() : <span class="apiret">pingTypes</span> |
||
+ | : <s>[[API C_Ping.GetTargetWorldPingAndSend|C_Ping.GetTargetWorldPingAndSend]]</s>() : <span class="apiret">result</span> |
||
+ | : <s>[[API C_PingSecure.CreateFrame|C_PingSecure.CreateFrame]]</s>() {{apitag|protected}} |
||
+ | : <s>[[API C_PingSecure.GetTargetPingReceiver|C_PingSecure.GetTargetPingReceiver]]</s>(<span class="apiarg">mousePosX, mousePosY</span>) : <span class="apiret">frame</span> {{apitag|protected}} |
||
+ | : <s>[[API C_PingSecure.GetTargetWorldPing|C_PingSecure.GetTargetWorldPing]]</s>(<span class="apiarg">mousePosX, mousePosY</span>) : <span class="apiret">foundTarget</span> {{apitag|protected}} |
||
+ | : <s>[[API C_PingSecure.GetTextureKitForType|C_PingSecure.GetTextureKitForType]]</s>(<span class="apiarg">type</span>) : <span class="apiret">uiTextureKitID</span> {{apitag|protected}} |
||
+ | : <s>[[API C_PingSecure.SendPing|C_PingSecure.SendPing]]</s>(<span class="apiarg">type [, target]</span>) : <span class="apiret">result</span> {{apitag|protected}}</s> |
||
+ | : [[API C_TradeSkillUI.CanStoreEnchantInItem|C_TradeSkillUI.CanStoreEnchantInItem]](<span class="apiarg">itemGUID</span>) : <span class="apiret">canStore</span> |
||
+ | : [[API C_Traits.GenerateImportString|C_Traits.GenerateImportString]]() |
||
+ | : [[API C_UIWidgetManager.GetTugOfWarWidgetVisualizationInfo|C_UIWidgetManager.GetTugOfWarWidgetVisualizationInfo]](<span class="apiarg">widgetID</span>) : <span class="apiret">widgetInfo</span> |
||
− | == |
+ | ==Patch 10.1.5== |
+ | : [[API C_ActionBar.EnableActionRangeCheck|C_ActionBar.EnableActionRangeCheck]](<span class="apiarg">actionID, enable</span>) |
||
− | These functions relate to the World of Warcraft subscription [[Account]]. See also [[#Battle.net|Battle.net]] functions. |
||
+ | : [[API C_CharacterServices.RPEResetCharacter|C_CharacterServices.RPEResetCharacter]]() |
||
− | : [[API GetBillingTimeRested|GetBillingTimeRested]]() - Returns the account rested time left. This function is only relevant on Chinese realms. |
||
+ | : [[API C_Commentator.GetPlayerItemCooldownInfo|C_Commentator.GetPlayerItemCooldownInfo]](<span class="apiarg">teamIndex, playerIndex, itemID</span>) : <span class="apiret">startTime, duration, enable</span> |
||
+ | : [[API C_Commentator.GetPlayerItemCooldownInfoByUnit|C_Commentator.GetPlayerItemCooldownInfoByUnit]](<span class="apiarg">unitToken, itemID</span>) : <span class="apiret">startTime, duration, enable</span> |
||
+ | : [[API C_Commentator.SetBlocklistedItemCooldowns|C_Commentator.SetBlocklistedItemCooldowns]](<span class="apiarg">itemIDs</span>) |
||
+ | : [[API C_Commentator.SetRequestedItemCooldowns|C_Commentator.SetRequestedItemCooldowns]](<span class="apiarg">itemIDs</span>) |
||
+ | : [[API C_ContentTracking.GetBestMapForTrackable|C_ContentTracking.GetBestMapForTrackable]](<span class="apiarg">trackableType, trackableID [, ignoreWaypoint]</span>) : <span class="apiret">result, mapID</span> |
||
+ | : [[API C_ContentTracking.GetCollectableSourceTrackingEnabled|C_ContentTracking.GetCollectableSourceTrackingEnabled]]() : <span class="apiret">isEnabled</span> |
||
+ | : [[API C_ContentTracking.GetCollectableSourceTypes|C_ContentTracking.GetCollectableSourceTypes]]() : <span class="apiret">collectableSourceTypes</span> |
||
+ | : [[API C_ContentTracking.GetCurrentTrackingTarget|C_ContentTracking.GetCurrentTrackingTarget]](<span class="apiarg">type, id</span>) : <span class="apiret">targetType, targetID</span> |
||
+ | : [[API C_ContentTracking.GetEncounterTrackingInfo|C_ContentTracking.GetEncounterTrackingInfo]](<span class="apiarg">journalEncounterID</span>) : <span class="apiret">trackingInfo</span> |
||
+ | : [[API C_ContentTracking.GetNextWaypointForTrackable|C_ContentTracking.GetNextWaypointForTrackable]](<span class="apiarg">trackableType, trackableID, uiMapID</span>) : <span class="apiret">result, mapInfo</span> |
||
+ | : [[API C_ContentTracking.GetObjectiveText|C_ContentTracking.GetObjectiveText]](<span class="apiarg">targetType, targetID [, includeHyperlinks]</span>) : <span class="apiret">objectiveText</span> |
||
+ | : [[API C_ContentTracking.GetTitle|C_ContentTracking.GetTitle]](<span class="apiarg">trackableType, trackableID</span>) : <span class="apiret">title</span> |
||
+ | : [[API C_ContentTracking.GetTrackablesOnMap|C_ContentTracking.GetTrackablesOnMap]](<span class="apiarg">trackableType, uiMapID</span>) : <span class="apiret">result, trackableMapInfos</span> |
||
+ | : [[API C_ContentTracking.GetTrackedIDs|C_ContentTracking.GetTrackedIDs]](<span class="apiarg">trackableType</span>) : <span class="apiret">entryIDs</span> |
||
+ | : [[API C_ContentTracking.GetVendorTrackingInfo|C_ContentTracking.GetVendorTrackingInfo]](<span class="apiarg">collectableEntryID</span>) : <span class="apiret">vendorTrackingInfo</span> |
||
+ | : [[API C_ContentTracking.GetWaypointText|C_ContentTracking.GetWaypointText]](<span class="apiarg">trackableType, trackableID</span>) : <span class="apiret">waypointText</span> |
||
+ | : [[API C_ContentTracking.IsNavigable|C_ContentTracking.IsNavigable]](<span class="apiarg">trackableType, trackableID</span>) : <span class="apiret">result, isNavigable</span> |
||
+ | : [[API C_ContentTracking.IsTrackable|C_ContentTracking.IsTrackable]](<span class="apiarg">type, id</span>) : <span class="apiret">isTrackable</span> |
||
+ | : [[API C_ContentTracking.IsTracking|C_ContentTracking.IsTracking]](<span class="apiarg">type, id</span>) : <span class="apiret">isTracking</span> |
||
+ | : [[API C_ContentTracking.StartTracking|C_ContentTracking.StartTracking]](<span class="apiarg">type, id</span>) : <span class="apiret">error</span> |
||
+ | : [[API C_ContentTracking.StopTracking|C_ContentTracking.StopTracking]](<span class="apiarg">type, id</span>) |
||
+ | : [[API C_ContentTracking.ToggleTracking|C_ContentTracking.ToggleTracking]](<span class="apiarg">type, id</span>) : <span class="apiret">error</span> |
||
+ | : [[API C_EncounterJournal.GetEncounterJournalLink|C_EncounterJournal.GetEncounterJournalLink]](<span class="apiarg">linkType, ID, displayText, difficultyID</span>) : <span class="apiret">link</span> |
||
+ | : [[API C_EncounterJournal.GetInstanceForGameMap|C_EncounterJournal.GetInstanceForGameMap]](<span class="apiarg">mapID</span>) : <span class="apiret">journalInstanceID</span> |
||
+ | : [[API C_Item.GetItemIDForItemInfo|C_Item.GetItemIDForItemInfo]](<span class="apiarg">itemInfo</span>) : <span class="apiret">itemID</span> |
||
+ | : [[API C_Loot.GetLootRollDuration|C_Loot.GetLootRollDuration]](<span class="apiarg">rollID</span>) : <span class="apiret">duration</span> |
||
+ | : [[API C_MerchantFrame.GetNumJunkItems|C_MerchantFrame.GetNumJunkItems]]() : <span class="apiret">numJunkItems</span> |
||
+ | : [[API C_PetInfo.GetSpellForPetAction|C_PetInfo.GetSpellForPetAction]](<span class="apiarg">actionID</span>) : <span class="apiret">spellID</span> |
||
+ | : [[API C_PvP.IsMatchActive|C_PvP.IsMatchActive]]() : <span class="apiret">isActive</span> |
||
+ | : [[API C_PvP.IsMatchComplete|C_PvP.IsMatchComplete]]() : <span class="apiret">isComplete</span> |
||
+ | : [[API C_QuestLine.GetForceVisibleQuests|C_QuestLine.GetForceVisibleQuests]](<span class="apiarg">uiMapID</span>) : <span class="apiret">questIDs</span> |
||
+ | : [[API C_QuestLog.IsImportantQuest|C_QuestLog.IsImportantQuest]](<span class="apiarg">questID</span>) : <span class="apiret">isImportant</span> |
||
+ | : [[API C_SpecializationInfo.GetClassIDFromSpecID|C_SpecializationInfo.GetClassIDFromSpecID]](<span class="apiarg">specID</span>) : <span class="apiret">classID</span> |
||
+ | : [[API C_SuperTrack.ClearSuperTrackedContent|C_SuperTrack.ClearSuperTrackedContent]]() |
||
+ | : [[API C_SuperTrack.GetSuperTrackedContent|C_SuperTrack.GetSuperTrackedContent]]() : <span class="apiret">trackableType, trackableID</span> |
||
+ | : [[API C_SuperTrack.IsSuperTrackingContent|C_SuperTrack.IsSuperTrackingContent]]() : <span class="apiret">isSuperTracking</span> |
||
+ | : [[API C_SuperTrack.SetSuperTrackedContent|C_SuperTrack.SetSuperTrackedContent]](<span class="apiarg">trackableType, trackableID</span>) |
||
+ | : [[API UpdateUIParentPosition|UpdateUIParentPosition]]() |
||
+ | |||
+ | ==Patch 10.1.0== |
||
+ | : [[API C_AddOns.GetAddOnMetadata|C_AddOns.GetAddOnMetadata]](<span class="apiarg">name, variable</span>) : <span class="apiret">value</span> - Returns the TOC metadata of an addon. |
||
+ | : [[API C_ArrowCalloutManager.AcknowledgeCallout|C_ArrowCalloutManager.AcknowledgeCallout]]() |
||
+ | : [[API C_ArrowCalloutManager.HideCallout|C_ArrowCalloutManager.HideCallout]]() |
||
+ | : [[API C_ArrowCalloutManager.HideWorldLootObjectCallout|C_ArrowCalloutManager.HideWorldLootObjectCallout]]() |
||
+ | : [[API C_ArrowCalloutManager.SetWorldLootObjectCalloutFromGUID|C_ArrowCalloutManager.SetWorldLootObjectCalloutFromGUID]]() |
||
+ | : [[API C_ArrowCalloutManager.SwapWorldLootObjectCallout|C_ArrowCalloutManager.SwapWorldLootObjectCallout]]() |
||
+ | : [[API C_AzeriteItem.IsUnlimitedLevelingUnlocked|C_AzeriteItem.IsUnlimitedLevelingUnlocked]]() : <span class="apiret">isUnlimitedLevelingUnlocked</span> |
||
+ | : [[API C_CharacterServices.AssignRaceOrFactionChangeDistribution|C_CharacterServices.AssignRaceOrFactionChangeDistribution]]() |
||
+ | : [[API C_ChatInfo.GetColorForChatType|C_ChatInfo.GetColorForChatType]](<span class="apiarg">chatType</span>) : <span class="apiret">color</span> |
||
+ | : [[API C_ClassTalents.GetTraitTreeForSpec|C_ClassTalents.GetTraitTreeForSpec]](<span class="apiarg">specID</span>) : <span class="apiret">treeID</span> |
||
+ | : [[API C_ClassTalents.InitializeViewLoadout|C_ClassTalents.InitializeViewLoadout]](<span class="apiarg">specID, level</span>) |
||
+ | : [[API C_ClassTalents.ViewLoadout|C_ClassTalents.ViewLoadout]](<span class="apiarg">entries</span>) : <span class="apiret">success</span> |
||
+ | : [[API C_DateAndTime.AdjustTimeByMonths|C_DateAndTime.AdjustTimeByMonths]](<span class="apiarg">date, months</span>) : <span class="apiret">newDate</span> |
||
+ | : [[API C_Debug.ViewInDebugWindow|C_Debug.ViewInDebugWindow]]() |
||
+ | : [[API C_EncounterJournal.OnClose|C_EncounterJournal.OnClose]]() |
||
+ | : [[API C_EncounterJournal.OnOpen|C_EncounterJournal.OnOpen]]() |
||
+ | : [[API C_EncounterJournal.SetTab|C_EncounterJournal.SetTab]](<span class="apiarg">tabIdx</span>) |
||
+ | : [[API C_ExpansionTrial.OnTrialLevelUpDialogClicked|C_ExpansionTrial.OnTrialLevelUpDialogClicked]]() |
||
+ | : [[API C_ExpansionTrial.OnTrialLevelUpDialogShown|C_ExpansionTrial.OnTrialLevelUpDialogShown]]() |
||
+ | : [[API C_GenericWidgetDisplay.Acknowledge|C_GenericWidgetDisplay.Acknowledge]]() |
||
+ | : [[API C_GenericWidgetDisplay.Close|C_GenericWidgetDisplay.Close]]() |
||
+ | : [[API C_GuildInfo.MemberExistsByName|C_GuildInfo.MemberExistsByName]](<span class="apiarg">name</span>) : <span class="apiret">exists</span> |
||
+ | : [[API C_Item.DoesItemMatchTrackJump|C_Item.DoesItemMatchTrackJump]](<span class="apiarg">itemLoc</span>) : <span class="apiret">matchesTrackJump</span> |
||
+ | : [[API C_ItemUpgrade.GetHighWatermarkForItem|C_ItemUpgrade.GetHighWatermarkForItem]](<span class="apiarg">itemInfo</span>) : <span class="apiret">characterHighWatermark, accountHighWatermark</span> |
||
+ | : [[API C_ItemUpgrade.GetHighWatermarkForSlot|C_ItemUpgrade.GetHighWatermarkForSlot]](<span class="apiarg">itemRedundancySlot</span>) : <span class="apiret">characterHighWatermark, accountHighWatermark</span> |
||
+ | : [[API C_ItemUpgrade.GetHighWatermarkSlotForItem|C_ItemUpgrade.GetHighWatermarkSlotForItem]](<span class="apiarg">itemInfo</span>) : <span class="apiret">itemRedundancySlot</span> |
||
+ | : [[API C_ItemUpgrade.IsItemBound|C_ItemUpgrade.IsItemBound]]() : <span class="apiret">isBound</span> |
||
+ | : [[API C_LootHistory.GetAllEncounterInfos|C_LootHistory.GetAllEncounterInfos]]() : <span class="apiret">infos</span> |
||
+ | : [[API C_LootHistory.GetInfoForEncounter|C_LootHistory.GetInfoForEncounter]](<span class="apiarg">encounterID</span>) : <span class="apiret">info</span> |
||
+ | : [[API C_LootHistory.GetLootHistoryTime|C_LootHistory.GetLootHistoryTime]]() : <span class="apiret">time</span> |
||
+ | : [[API C_LootHistory.GetSortedDropsForEncounter|C_LootHistory.GetSortedDropsForEncounter]](<span class="apiarg">encounterID</span>) : <span class="apiret">drops</span> |
||
+ | : [[API C_LootHistory.GetSortedInfoForDrop|C_LootHistory.GetSortedInfoForDrop]](<span class="apiarg">encounterID, lootListID</span>) : <span class="apiret">info</span> |
||
+ | : [[API C_Map.GetMapHighlightPulseInfo|C_Map.GetMapHighlightPulseInfo]](<span class="apiarg">uiMapID</span>) : <span class="apiret">fileDataID, atlasID, texturePercentageX, texturePercentageY, textureX, textureY, scrollChildX, scrollChildY</span> |
||
+ | : [[API C_PartyPose.ExtraAction|C_PartyPose.ExtraAction]](<span class="apiarg">partyPoseID</span>) |
||
+ | : [[API C_PartyPose.GetPartyPoseInfoByID|C_PartyPose.GetPartyPoseInfoByID]](<span class="apiarg">mapID</span>) : <span class="apiret">info</span> |
||
+ | : [[API C_PartyPose.HasExtraAction|C_PartyPose.HasExtraAction]](<span class="apiarg">partyPoseID</span>) : <span class="apiret">hasExtraAction</span> |
||
+ | : [[API C_QuestInfoSystem.GetQuestRewardSpellInfo|C_QuestInfoSystem.GetQuestRewardSpellInfo]](<span class="apiarg">[questID], spellID</span>) : <span class="apiret">info</span> |
||
+ | : [[API C_QuestInfoSystem.GetQuestRewardSpells|C_QuestInfoSystem.GetQuestRewardSpells]](<span class="apiarg">[questID]</span>) : <span class="apiret">spellIDs</span> |
||
+ | : [[API C_QuestInfoSystem.GetQuestShouldToastCompletion|C_QuestInfoSystem.GetQuestShouldToastCompletion]](<span class="apiarg">[questID]</span>) : <span class="apiret">shouldToast</span> |
||
+ | : [[API C_QuestInfoSystem.HasQuestRewardSpells|C_QuestInfoSystem.HasQuestRewardSpells]](<span class="apiarg">[questID]</span>) : <span class="apiret">hasRewardSpells</span> |
||
+ | : [[API C_SpectatingUI.IsSpectating|C_SpectatingUI.IsSpectating]]() |
||
+ | : [[API C_Spell.TargetSpellJumpsUpgradeTrack|C_Spell.TargetSpellJumpsUpgradeTrack]]() : <span class="apiret">jumpsUpgradeTrack</span> |
||
+ | : [[API C_TooltipInfo.GetWorldLootObject|C_TooltipInfo.GetWorldLootObject]](<span class="apiarg">unitTokenString</span>) : <span class="apiret">data</span> |
||
+ | : [[API C_TradeSkillUI.GetProfessionInfoByRecipeID|C_TradeSkillUI.GetProfessionInfoByRecipeID]](<span class="apiarg">recipeID</span>) : <span class="apiret">info</span> |
||
+ | : [[API C_TradeSkillUI.GetReagentRequirementItemIDs|C_TradeSkillUI.GetReagentRequirementItemIDs]](<span class="apiarg">itemID</span>) : <span class="apiret">itemIDs</span> |
||
+ | : [[API C_TradeSkillUI.GetRecraftRemovalWarnings|C_TradeSkillUI.GetRecraftRemovalWarnings]](<span class="apiarg">itemGUID, replacedItemIDs</span>) : <span class="apiret">warnings</span> |
||
+ | : [[API C_TradeSkillUI.IsEnchantTargetValid|C_TradeSkillUI.IsEnchantTargetValid]](<span class="apiarg">recipeID, itemGUID [, craftingReagents]</span>) : <span class="apiret">valid</span> |
||
+ | : [[API C_TradeSkillUI.IsRecraftReagentValid|C_TradeSkillUI.IsRecraftReagentValid]](<span class="apiarg">itemGUID, itemID</span>) : <span class="apiret">valid</span> |
||
+ | : [[API C_UIWidgetManager.GetItemDisplayVisualizationInfo|C_UIWidgetManager.GetItemDisplayVisualizationInfo]](<span class="apiarg">widgetID</span>) : <span class="apiret">widgetInfo</span> |
||
+ | : [[API C_UnitAuras.AddPrivateAuraAnchor|C_UnitAuras.AddPrivateAuraAnchor]](<span class="apiarg">args</span>) : <span class="apiret">anchorID</span> |
||
+ | : [[API C_UnitAuras.AddPrivateAuraAppliedSound|C_UnitAuras.AddPrivateAuraAppliedSound]](<span class="apiarg">sound</span>) : <span class="apiret">privateAuraSoundID</span> |
||
+ | : [[API C_UnitAuras.AuraIsPrivate|C_UnitAuras.AuraIsPrivate]](<span class="apiarg">spellID</span>) : <span class="apiret">isPrivate</span> |
||
+ | : [[API C_UnitAuras.RemovePrivateAuraAnchor|C_UnitAuras.RemovePrivateAuraAnchor]](<span class="apiarg">anchorID</span>) |
||
+ | : [[API C_UnitAuras.RemovePrivateAuraAppliedSound|C_UnitAuras.RemovePrivateAuraAppliedSound]](<span class="apiarg">privateAuraSoundID</span>) |
||
+ | : [[API C_UnitAuras.SetPrivateWarningTextAnchor|C_UnitAuras.SetPrivateWarningTextAnchor]](<span class="apiarg">parent [, anchor]</span>) |
||
+ | : [[API GetButtonMetatable|GetButtonMetatable]]() |
||
+ | : [[API GetEditBoxMetatable|GetEditBoxMetatable]]() |
||
+ | : [[API GetFontStringMetatable|GetFontStringMetatable]]() |
||
+ | : [[API GetFrameMetatable|GetFrameMetatable]]() |
||
+ | : [[API GetSoundEntryCount|GetSoundEntryCount]]() |
||
+ | : [[API IsWorldLootObject|IsWorldLootObject]]() |
||
+ | : [[API StripHyperlinks|StripHyperlinks]](<span class="apiarg">text [, maintainColor, maintainBrackets, stripNewlines, maintainAtlases]</span>) : <span class="apiret">stripped</span> |
||
+ | : [[API pcallwithenv|pcallwithenv]]() |
||
+ | |||
+ | ==Patch 10.0.x== |
||
+ | : [[API C_AccountServices.IsAccountLockedPostSave|C_AccountServices.IsAccountLockedPostSave]]() |
||
+ | : [[API C_AccountServices.IsAccountSaveEnabled|C_AccountServices.IsAccountSaveEnabled]]() |
||
+ | : [[API C_AccountServices.IsAccountSaveInProgress|C_AccountServices.IsAccountSaveInProgress]]() |
||
+ | : [[API C_AccountServices.SaveAccountData|C_AccountServices.SaveAccountData]]() |
||
+ | : [[API C_AchievementInfo.IsGuildAchievement|C_AchievementInfo.IsGuildAchievement]](<span class="apiarg">achievementId</span>) : <span class="apiret">isGuild</span> |
||
+ | : [[API C_ActionBar.GetItemActionOnEquipSpellID|C_ActionBar.GetItemActionOnEquipSpellID]](<span class="apiarg">actionID</span>) : <span class="apiret">onEquipSpellID</span> |
||
+ | : [[API C_ActionBar.GetProfessionQuality|C_ActionBar.GetProfessionQuality]](<span class="apiarg">actionID</span>) : <span class="apiret">quality</span> |
||
+ | : [[API C_ArtifactUI.IsArtifactItem|C_ArtifactUI.IsArtifactItem]](<span class="apiarg">itemLocation</span>) : <span class="apiret">isArtifact</span> |
||
+ | : [[API C_BarberShop.GetCustomizationScope|C_BarberShop.GetCustomizationScope]]() : <span class="apiret">customizationScope</span> |
||
+ | : [[API C_BarberShop.GetViewingChrModel|C_BarberShop.GetViewingChrModel]]() : <span class="apiret">chrModelID</span> |
||
+ | : [[API C_BarberShop.SetViewingChrModel|C_BarberShop.SetViewingChrModel]](<span class="apiarg">[chrModelID]</span>) |
||
+ | : [[API C_CameraDefaults.GetCameraFOVDefaults|C_CameraDefaults.GetCameraFOVDefaults]]() : <span class="apiret">fieldOfViewDegreesDefault, fieldOfViewDegreesPlayerMin, fieldOfViewDegreesPlayerMax</span> |
||
+ | : [[API C_CampaignInfo.SortAsNormalQuest|C_CampaignInfo.SortAsNormalQuest]](<span class="apiarg">campaignID</span>) : <span class="apiret">sortAsNormalQuest</span> |
||
+ | : [[API C_ChatInfo.CanPlayerSpeakLanguage|C_ChatInfo.CanPlayerSpeakLanguage]](<span class="apiarg">languageId</span>) : <span class="apiret">canSpeakLanguage</span> |
||
+ | : [[API C_ChatInfo.GetChatLineSenderGUID|C_ChatInfo.GetChatLineSenderGUID]](<span class="apiarg">chatLine</span>) : <span class="apiret">guid</span> |
||
+ | : [[API C_ChatInfo.GetChatLineSenderName|C_ChatInfo.GetChatLineSenderName]](<span class="apiarg">chatLine</span>) : <span class="apiret">name</span> |
||
+ | : [[API C_ChatInfo.GetChatLineText|C_ChatInfo.GetChatLineText]](<span class="apiarg">chatLine</span>) : <span class="apiret">text</span> |
||
+ | : [[API C_ChatInfo.IsChatLineCensored|C_ChatInfo.IsChatLineCensored]](<span class="apiarg">chatLine</span>) : <span class="apiret">isCensored</span> |
||
+ | : [[API C_ChatInfo.RequestCanLocalWhisperTarget|C_ChatInfo.RequestCanLocalWhisperTarget]](<span class="apiarg">whisperTarget</span>) |
||
+ | : [[API C_ChatInfo.UncensorChatLine|C_ChatInfo.UncensorChatLine]](<span class="apiarg">chatLine</span>) |
||
+ | : [[API C_ConsoleScriptCollection.GetCollectionDataByID|C_ConsoleScriptCollection.GetCollectionDataByID]](<span class="apiarg">collectionID</span>) : <span class="apiret">data</span> |
||
+ | : [[API C_ConsoleScriptCollection.GetCollectionDataByTag|C_ConsoleScriptCollection.GetCollectionDataByTag]](<span class="apiarg">collectionTag</span>) : <span class="apiret">data</span> |
||
+ | : [[API C_ConsoleScriptCollection.GetElements|C_ConsoleScriptCollection.GetElements]](<span class="apiarg">collectionID</span>) : <span class="apiret">elementIDs</span> |
||
+ | : [[API C_ConsoleScriptCollection.GetScriptData|C_ConsoleScriptCollection.GetScriptData]](<span class="apiarg">consoleScriptID</span>) : <span class="apiret">data</span> |
||
+ | : [[API C_CraftingOrders.GetNumFavoriteCustomerOptions|C_CraftingOrders.GetNumFavoriteCustomerOptions]]() : <span class="apiret">numFavorites</span> |
||
+ | : [[API C_CraftingOrders.GetPersonalOrdersInfo|C_CraftingOrders.GetPersonalOrdersInfo]]() : <span class="apiret">infos</span> |
||
+ | : [[API C_EventUtils.IsEventValid|C_EventUtils.IsEventValid]](<span class="apiarg">eventName</span>) : <span class="apiret">valid</span> |
||
+ | : [[API C_EventUtils.NotifySettingsLoaded|C_EventUtils.NotifySettingsLoaded]]() |
||
+ | : [[API C_FunctionContainers.CreateCallback|C_FunctionContainers.CreateCallback]]() |
||
+ | : [[API C_GossipInfo.GetFriendshipReputationRanks|C_GossipInfo.GetFriendshipReputationRanks]](<span class="apiarg">friendshipFactionID</span>) : <span class="apiret">rankInfo</span> |
||
+ | : [[API C_GossipInfo.GetFriendshipReputation|C_GossipInfo.GetFriendshipReputation]](<span class="apiarg">friendshipFactionID</span>) : <span class="apiret">reputationInfo</span> |
||
+ | : [[API C_GossipInfo.SelectOptionByIndex|C_GossipInfo.SelectOptionByIndex]](<span class="apiarg">optionID [, text, confirmed]</span>) |
||
+ | : [[API C_Item.GetItemIDByGUID|C_Item.GetItemIDByGUID]](<span class="apiarg">itemGUID</span>) : <span class="apiret">itemID</span> |
||
+ | : [[API C_Item.GetItemLinkByGUID|C_Item.GetItemLinkByGUID]](<span class="apiarg">itemGUID</span>) : <span class="apiret">itemLink</span> |
||
+ | : [[API C_Item.GetItemLocation|C_Item.GetItemLocation]](<span class="apiarg">itemGUID</span>) : <span class="apiret">itemLocation</span> |
||
+ | : [[API C_Item.GetItemMaxStackSizeByID|C_Item.GetItemMaxStackSizeByID]](<span class="apiarg">itemInfo</span>) : <span class="apiret">stackSize</span> |
||
+ | : [[API C_Item.GetItemMaxStackSize|C_Item.GetItemMaxStackSize]](<span class="apiarg">itemLocation</span>) : <span class="apiret">stackSize</span> |
||
+ | : [[API C_Item.IsItemGUIDInInventory|C_Item.IsItemGUIDInInventory]](<span class="apiarg">itemGUID</span>) : <span class="apiret">valid</span> |
||
+ | : [[API C_KeyBindings.GetBindingIndex|C_KeyBindings.GetBindingIndex]](<span class="apiarg">action</span>) : <span class="apiret">bindingIndex</span> |
||
+ | : [[API C_Mail.GetCraftingOrderMailInfo|C_Mail.GetCraftingOrderMailInfo]](<span class="apiarg">inboxIndex</span>) : <span class="apiret">info</span> |
||
+ | : [[API C_Mail.SetOpeningAll|C_Mail.SetOpeningAll]](<span class="apiarg">openingAll</span>) |
||
+ | : [[API C_MajorFactions.GetCovenantIDForMajorFaction|C_MajorFactions.GetCovenantIDForMajorFaction]](<span class="apiarg">majorFactionID</span>) : <span class="apiret">covenantID</span> |
||
+ | : [[API C_MajorFactions.GetCurrentRenownLevel|C_MajorFactions.GetCurrentRenownLevel]](<span class="apiarg">majorFactionID</span>) : <span class="apiret">level</span> |
||
+ | : [[API C_MajorFactions.GetFeatureAbilities|C_MajorFactions.GetFeatureAbilities]]() : <span class="apiret">featureAbilities</span> |
||
+ | : [[API C_MajorFactions.GetMajorFactionData|C_MajorFactions.GetMajorFactionData]](<span class="apiarg">majorFactionID</span>) : <span class="apiret">data</span> |
||
+ | : [[API C_MajorFactions.GetMajorFactionIDs|C_MajorFactions.GetMajorFactionIDs]](<span class="apiarg">[expansionID]</span>) : <span class="apiret">majorFactionIDs</span> |
||
+ | : [[API C_MajorFactions.GetRenownLevels|C_MajorFactions.GetRenownLevels]](<span class="apiarg">majorFactionID</span>) : <span class="apiret">levels</span> |
||
+ | : [[API C_MajorFactions.GetRenownNPCFactionID|C_MajorFactions.GetRenownNPCFactionID]]() : <span class="apiret">renownNPCFactionID</span> |
||
+ | : [[API C_MajorFactions.GetRenownRewardsForLevel|C_MajorFactions.GetRenownRewardsForLevel]](<span class="apiarg">majorFactionID, renownLevel</span>) : <span class="apiret">rewards</span> |
||
+ | : [[API C_MajorFactions.HasMaximumRenown|C_MajorFactions.HasMaximumRenown]](<span class="apiarg">majorFactionID</span>) : <span class="apiret">hasMaxRenown</span> |
||
+ | : [[API C_MajorFactions.IsPlayerInRenownCatchUpMode|C_MajorFactions.IsPlayerInRenownCatchUpMode]]() : <span class="apiret">isInCatchUpMode</span> |
||
+ | : [[API C_MajorFactions.IsWeeklyRenownCapped|C_MajorFactions.IsWeeklyRenownCapped]](<span class="apiarg">majorFactionID</span>) : <span class="apiret">isWeeklyCapped</span> |
||
+ | : [[API C_MajorFactions.RequestCatchUpState|C_MajorFactions.RequestCatchUpState]]() |
||
+ | : [[API C_Minimap.CanTrackBattlePets|C_Minimap.CanTrackBattlePets]]() : <span class="apiret">CanTrackBattlePets</span> |
||
+ | : [[API C_Minimap.ClearAllTracking|C_Minimap.ClearAllTracking]]() |
||
+ | : [[API C_Minimap.GetNumQuestPOIWorldEffects|C_Minimap.GetNumQuestPOIWorldEffects]]() : <span class="apiret">worldEffectCount</span> |
||
+ | : [[API C_Minimap.GetNumTrackingTypes|C_Minimap.GetNumTrackingTypes]]() : <span class="apiret">numTrackingTypes</span> |
||
+ | : [[API C_Minimap.GetObjectIconTextureCoords|C_Minimap.GetObjectIconTextureCoords]](<span class="apiarg">[index]</span>) : <span class="apiret">textureCoordsX, textureCoordsY, textureCoordsZ, textureCoordsW</span> |
||
+ | : [[API C_Minimap.GetPOITextureCoords|C_Minimap.GetPOITextureCoords]](<span class="apiarg">[index]</span>) : <span class="apiret">textureCoordsX, textureCoordsY, textureCoordsZ, textureCoordsW</span> |
||
+ | : [[API C_Minimap.GetTrackingFilter|C_Minimap.GetTrackingFilter]](<span class="apiarg">spellIndex</span>) : <span class="apiret">trackingType</span> |
||
+ | : [[API C_Minimap.GetTrackingInfo|C_Minimap.GetTrackingInfo]](<span class="apiarg">spellIndex</span>) : <span class="apiret">name, textureFileID, active, type, subType, spellID</span> |
||
+ | : [[API C_Minimap.IsFilteredOut|C_Minimap.IsFilteredOut]](<span class="apiarg">filterType</span>) : <span class="apiret">isFiltered</span> |
||
+ | : [[API C_Minimap.IsTrackingBattlePets|C_Minimap.IsTrackingBattlePets]]() : <span class="apiret">isTrackingBattlePets</span> |
||
+ | : [[API C_Minimap.IsTrackingHiddenQuests|C_Minimap.IsTrackingHiddenQuests]]() : <span class="apiret">isTrackingHiddenQuests</span> |
||
+ | : [[API C_Minimap.SetTracking|C_Minimap.SetTracking]](<span class="apiarg">index, on</span>) |
||
+ | : [[API C_MountJournal.GetAllCreatureDisplayIDsForMountID|C_MountJournal.GetAllCreatureDisplayIDsForMountID]](<span class="apiarg">mountID</span>) : <span class="apiret">creatureDisplayIDs</span> |
||
+ | : [[API C_MountJournal.GetCollectedDragonridingMounts|C_MountJournal.GetCollectedDragonridingMounts]]() : <span class="apiret">mountIDs</span> |
||
+ | : [[API C_MountJournal.GetDisplayedMountID|C_MountJournal.GetDisplayedMountID]](<span class="apiarg">displayIndex</span>) : <span class="apiret">mountID</span> |
||
+ | : [[API C_MountJournal.GetMountLink|C_MountJournal.GetMountLink]](<span class="apiarg">spellID</span>) : <span class="apiret">mountCreatureDisplayInfoLink</span> |
||
+ | : [[API C_MythicPlus.GetCurrentUIDisplaySeason|C_MythicPlus.GetCurrentUIDisplaySeason]]() : <span class="apiret">seasonID</span> |
||
+ | : [[API C_MythicPlus.GetEndOfRunGearSequenceLevel|C_MythicPlus.GetEndOfRunGearSequenceLevel]](<span class="apiarg">keystoneLevel</span>) : <span class="apiret">sequenceLevel</span> |
||
+ | : [[API C_PaperDollInfo.CanAutoEquipCursorItem|C_PaperDollInfo.CanAutoEquipCursorItem]]() : <span class="apiret">canAutoEquip</span> |
||
+ | : [[API C_PaperDollInfo.CanCursorCanGoInSlot|C_PaperDollInfo.CanCursorCanGoInSlot]](<span class="apiarg">slotIndex</span>) : <span class="apiret">canOccupySlot</span> |
||
+ | : [[API C_PaperDollInfo.GetInspectRatedSoloShuffleData|C_PaperDollInfo.GetInspectRatedSoloShuffleData]]() : <span class="apiret">ratedSoloShuffleData</span> |
||
+ | : [[API C_PetJournal.GetNumPetsInJournal|C_PetJournal.GetNumPetsInJournal]](<span class="apiarg">creatureID</span>) : <span class="apiret">maxAllowed, numPets</span> |
||
+ | : [[API C_PetJournal.HasFavoritePets|C_PetJournal.HasFavoritePets]]() : <span class="apiret">hasFavorites</span> |
||
+ | : [[API C_PetJournal.SpellTargetBattlePet|C_PetJournal.SpellTargetBattlePet]](<span class="apiarg">battlePetGUID</span>) |
||
+ | : [[API C_PlayerInfo.CanUseItem|C_PlayerInfo.CanUseItem]](<span class="apiarg">itemID</span>) : <span class="apiret">isUseable</span> |
||
+ | : [[API C_PlayerInfo.GetDisplayID|C_PlayerInfo.GetDisplayID]]() : <span class="apiret">displayID</span> |
||
+ | : [[API C_PlayerInfo.GetGlidingInfo|C_PlayerInfo.GetGlidingInfo]]() : <span class="apiret">isGliding, canGlide, forwardSpeed</span> - Returns the [[Dragonriding]] gliding speed. |
||
+ | : [[API C_PlayerInfo.GetPlayerCharacterData|C_PlayerInfo.GetPlayerCharacterData]]() : <span class="apiret">characterData</span> |
||
+ | : [[API C_PlayerInfo.HasVisibleInvSlot|C_PlayerInfo.HasVisibleInvSlot]](<span class="apiarg">slot</span>) : <span class="apiret">isVisible</span> |
||
+ | : [[API C_PlayerInfo.IsExpansionLandingPageUnlockedForPlayer|C_PlayerInfo.IsExpansionLandingPageUnlockedForPlayer]](<span class="apiarg">expansionID</span>) : <span class="apiret">isUnlocked</span> |
||
+ | : [[API C_PlayerInfo.IsTradingPostAvailable|C_PlayerInfo.IsTradingPostAvailable]]() : <span class="apiret">isAvailable</span> |
||
+ | : [[API C_PlayerInfo.IsTravelersLogAvailable|C_PlayerInfo.IsTravelersLogAvailable]]() : <span class="apiret">isAvailable</span> |
||
+ | : [[API C_ProfSpecs.GetNewSpecReminderProfName|C_ProfSpecs.GetNewSpecReminderProfName]]() : <span class="apiret">profName</span> |
||
+ | : [[API C_PvP.ArePvpTalentsUnlocked|C_PvP.ArePvpTalentsUnlocked]]() : <span class="apiret">arePvpTalentsUnlocked</span> |
||
+ | : [[API C_PvP.GetAssignedSpecForBattlefieldQueue|C_PvP.GetAssignedSpecForBattlefieldQueue]](<span class="apiarg">queueID</span>) : <span class="apiret">specializationID</span> |
||
+ | : [[API C_PvP.GetPVPActiveRatedMatchDeserterPenalty|C_PvP.GetPVPActiveRatedMatchDeserterPenalty]]() : <span class="apiret">deserterPenalty</span> |
||
+ | : [[API C_PvP.GetPersonalRatedSoloShuffleSpecStats|C_PvP.GetPersonalRatedSoloShuffleSpecStats]]() : <span class="apiret">specStats</span> |
||
+ | : [[API C_PvP.GetPvpTalentsUnlockedLevel|C_PvP.GetPvpTalentsUnlockedLevel]]() : <span class="apiret">unlockLevel</span> |
||
+ | : [[API C_PvP.GetRatedSoloShuffleMinItemLevel|C_PvP.GetRatedSoloShuffleMinItemLevel]]() : <span class="apiret">minItemLevel</span> |
||
+ | : [[API C_PvP.GetRatedSoloShuffleRewards|C_PvP.GetRatedSoloShuffleRewards]]() : <span class="apiret">honor, experience, itemRewards, currencyRewards, roleShortageBonus</span> |
||
+ | : [[API C_PvP.GetUIDisplaySeason|C_PvP.GetUIDisplaySeason]]() : <span class="apiret">uiDisplaySeason</span> |
||
+ | : [[API C_PvP.IsBrawlSoloShuffle|C_PvP.IsBrawlSoloShuffle]]() : <span class="apiret">isBrawlSoloShuffle</span> |
||
+ | : [[API C_PvP.IsInRatedMatchWithDeserterPenalty|C_PvP.IsInRatedMatchWithDeserterPenalty]]() : <span class="apiret">isInRatedMatchWithDeserterPenalty</span> |
||
+ | : [[API C_PvP.IsRatedSoloShuffle|C_PvP.IsRatedSoloShuffle]]() : <span class="apiret">isRatedSoloShuffle</span> |
||
+ | : [[API C_QuestItemUse.CanUseQuestItemOnObject|C_QuestItemUse.CanUseQuestItemOnObject]](<span class="apiarg">item, unit [, checkRange]</span>) : <span class="apiret">canUse</span> |
||
+ | : [[API C_QuestLog.DoesQuestAwardReputationWithFaction|C_QuestLog.DoesQuestAwardReputationWithFaction]](<span class="apiarg">questID, factionID</span>) : <span class="apiret">awardsReputation</span> |
||
+ | : [[API C_QuestLog.GetQuestLogMajorFactionReputationRewards|C_QuestLog.GetQuestLogMajorFactionReputationRewards]](<span class="apiarg">questID</span>) : <span class="apiret">reputationRewards</span> |
||
+ | : [[API C_QuestLog.UnitIsRelatedToActiveQuest|C_QuestLog.UnitIsRelatedToActiveQuest]](<span class="apiarg">unit</span>) : <span class="apiret">isRelatedToActiveQuest</span> |
||
+ | : [[API C_QuestOffer.GetHideRequiredItems|C_QuestOffer.GetHideRequiredItems]]() : <span class="apiret">hideRequiredItems</span> |
||
+ | : [[API C_QuestOffer.GetQuestOfferMajorFactionReputationRewards|C_QuestOffer.GetQuestOfferMajorFactionReputationRewards]]() : <span class="apiret">reputationRewards</span> |
||
+ | : [[API C_Reputation.IsMajorFaction|C_Reputation.IsMajorFaction]](<span class="apiarg">factionID</span>) : <span class="apiret">isMajorFaction</span> |
||
+ | : [[API C_Reputation.SetWatchedFaction|C_Reputation.SetWatchedFaction]](<span class="apiarg">factionID</span>) |
||
+ | : [[API C_ReturningPlayerUI.AcceptPrompt|C_ReturningPlayerUI.AcceptPrompt]]() |
||
+ | : [[API C_ReturningPlayerUI.DeclinePrompt|C_ReturningPlayerUI.DeclinePrompt]]() |
||
+ | : [[API C_Sound.GetSoundScaledVolume|C_Sound.GetSoundScaledVolume]](<span class="apiarg">soundHandle</span>) : <span class="apiret">scaledVolume</span> |
||
+ | : [[API C_Sound.IsPlaying|C_Sound.IsPlaying]](<span class="apiarg">soundHandle</span>) : <span class="apiret">isPlaying</span> |
||
+ | : [[API C_Sound.PlayItemSound|C_Sound.PlayItemSound]](<span class="apiarg">soundType, itemLocation</span>) |
||
+ | : [[API C_SpecializationInfo.GetPvpTalentInfo|C_SpecializationInfo.GetPvpTalentInfo]](<span class="apiarg">talentID</span>) : <span class="apiret">talentInfo</span> |
||
+ | : [[API C_SpellBook.GetDeadlyDebuffInfo|C_SpellBook.GetDeadlyDebuffInfo]](<span class="apiarg">spellID</span>) : <span class="apiret">deadlyDebuffInfo</span> |
||
+ | : [[API C_SpellBook.GetOverrideSpell|C_SpellBook.GetOverrideSpell]](<span class="apiarg">spellID [, spec, onlyKnown, ignoreOverrideSpellID]</span>) : <span class="apiret">overrideSpellID</span> |
||
+ | : [[API C_SpellBook.GetTrackedNameplateCooldownSpells|C_SpellBook.GetTrackedNameplateCooldownSpells]]() : <span class="apiret">spellIDs</span> |
||
+ | : [[API C_SystemVisibilityManager.IsSystemVisible|C_SystemVisibilityManager.IsSystemVisible]](<span class="apiarg">system</span>) : <span class="apiret">visible</span> |
||
+ | : [[API C_Texture.ClearTitleIconTexture|C_Texture.ClearTitleIconTexture]](<span class="apiarg">texture</span>) |
||
+ | : [[API C_Texture.GetCraftingReagentQualityChatIcon|C_Texture.GetCraftingReagentQualityChatIcon]](<span class="apiarg">quality</span>) : <span class="apiret">textureMarkup</span> |
||
+ | : [[API C_Texture.GetFilenameFromFileDataID|C_Texture.GetFilenameFromFileDataID]](<span class="apiarg">fileDataID</span>) : <span class="apiret">filename</span> |
||
+ | : [[API C_Texture.GetTitleIconTexture|C_Texture.GetTitleIconTexture]](<span class="apiarg">titleID, version, callback</span>) |
||
+ | : [[API C_Texture.IsTitleIconTextureReady|C_Texture.IsTitleIconTextureReady]](<span class="apiarg">titleID, version</span>) : <span class="apiret">ready</span> |
||
+ | : [[API C_Texture.SetTitleIconTexture|C_Texture.SetTitleIconTexture]](<span class="apiarg">texture, titleID, version</span>) |
||
+ | : [[API C_TooltipComparison.GetItemComparisonDelta|C_TooltipComparison.GetItemComparisonDelta]](<span class="apiarg">comparisonItem, equippedItem [, pairedItem, addPairedStats]</span>) : <span class="apiret">lines</span> |
||
+ | : [[API C_TooltipComparison.GetItemComparisonInfo|C_TooltipComparison.GetItemComparisonInfo]](<span class="apiarg">comparisonItem</span>) : <span class="apiret">info</span> |
||
+ | : [[API C_TradeSkillUI.GetRemainingRecasts|C_TradeSkillUI.GetRemainingRecasts]]() : <span class="apiret">remaining</span> |
||
+ | : [[API C_TradeSkillUI.IsRecipeFirstCraft|C_TradeSkillUI.IsRecipeFirstCraft]](<span class="apiarg">recipeID</span>) : <span class="apiret">result</span> |
||
+ | : [[API C_TradeSkillUI.IsRecraftItemEquipped|C_TradeSkillUI.IsRecraftItemEquipped]](<span class="apiarg">recraftItemGUID</span>) : <span class="apiret">isEquipped</span> |
||
+ | : [[API C_TradeSkillUI.RecraftLimitCategoryValid|C_TradeSkillUI.RecraftLimitCategoryValid]](<span class="apiarg">reagentItemID</span>) : <span class="apiret">recraftValid</span> |
||
+ | : [[API C_UIColor.GetColors|C_UIColor.GetColors]]() : <span class="apiret">colors</span> |
||
+ | : [[API C_UIWidgetManager.GetFillUpFramesWidgetVisualizationInfo|C_UIWidgetManager.GetFillUpFramesWidgetVisualizationInfo]](<span class="apiarg">widgetID</span>) : <span class="apiret">widgetInfo</span> |
||
+ | : [[API C_UIWidgetManager.GetTextWithSubtextWidgetVisualizationInfo|C_UIWidgetManager.GetTextWithSubtextWidgetVisualizationInfo]](<span class="apiarg">widgetID</span>) : <span class="apiret">widgetInfo</span> |
||
+ | : [[API C_UnitAuras.GetAuraDataByAuraInstanceID|C_UnitAuras.GetAuraDataByAuraInstanceID]](<span class="apiarg">unitToken, auraInstanceID</span>) : <span class="apiret">aura</span> |
||
+ | : [[API C_UnitAuras.GetAuraDataBySlot|C_UnitAuras.GetAuraDataBySlot]](<span class="apiarg">unitToken, slot</span>) : <span class="apiret">aura</span> |
||
+ | : [[API C_UnitAuras.GetCooldownAuraBySpellID|C_UnitAuras.GetCooldownAuraBySpellID]](<span class="apiarg">spellID</span>) : <span class="apiret">cooldownSpellID</span> |
||
+ | : [[API C_UnitAuras.GetPlayerAuraBySpellID|C_UnitAuras.GetPlayerAuraBySpellID]](<span class="apiarg">spellID</span>) : <span class="apiret">aura</span> |
||
+ | : [[API C_UnitAuras.IsAuraFilteredOutByInstanceID|C_UnitAuras.IsAuraFilteredOutByInstanceID]](<span class="apiarg">unitToken, auraInstanceID, filterFlags</span>) : <span class="apiret">isFiltered</span> |
||
+ | : [[API C_UnitAuras.WantsAlteredForm|C_UnitAuras.WantsAlteredForm]](<span class="apiarg">unitToken</span>) : <span class="apiret">wantsAlteredForm</span> |
||
+ | : [[API C_VideoOptions.GetCurrentGameWindowSize|C_VideoOptions.GetCurrentGameWindowSize]]() : <span class="apiret">size</span> |
||
+ | : [[API C_VideoOptions.GetDefaultGameWindowSize|C_VideoOptions.GetDefaultGameWindowSize]](<span class="apiarg">monitor</span>) : <span class="apiret">size</span> |
||
+ | : [[API C_VideoOptions.GetGameWindowSizes|C_VideoOptions.GetGameWindowSizes]](<span class="apiarg">monitor, fullscreen</span>) : <span class="apiret">sizes</span> |
||
+ | : [[API C_VideoOptions.SetGameWindowSize|C_VideoOptions.SetGameWindowSize]](<span class="apiarg">x, y</span>) |
||
+ | : [[API C_VoiceChat.IsVoiceChatConnected|C_VoiceChat.IsVoiceChatConnected]]() : <span class="apiret">connected</span> |
||
+ | : [[API C_WeeklyRewards.GetWeeklyRewardTextureKit|C_WeeklyRewards.GetWeeklyRewardTextureKit]]() : <span class="apiret">uiTextureKit</span> |
||
+ | : [[API C_WeeklyRewards.IsWeeklyChestRetired|C_WeeklyRewards.IsWeeklyChestRetired]]() : <span class="apiret">isRetired</span> |
||
+ | : [[API C_WeeklyRewards.ShouldShowFinalRetirementMessage|C_WeeklyRewards.ShouldShowFinalRetirementMessage]]() : <span class="apiret">showRetirementMessage</span> |
||
+ | : [[API C_WeeklyRewards.ShouldShowRetirementMessage|C_WeeklyRewards.ShouldShowRetirementMessage]]() : <span class="apiret">showRetirementMessage</span> |
||
+ | : [[API C_XMLUtil.GetTemplateInfo|C_XMLUtil.GetTemplateInfo]](<span class="apiarg">name</span>) : <span class="apiret">info</span> |
||
+ | : [[API C_XMLUtil.GetTemplates|C_XMLUtil.GetTemplates]]() : <span class="apiret">templates</span> |
||
+ | : [[API CombatLogShowCurrentEntry|CombatLogShowCurrentEntry]]() |
||
+ | : [[API GetCurrentGraphicsAPI|GetCurrentGraphicsAPI]]() |
||
+ | : [[API GetGraphicsCVarValueForQualityLevel|GetGraphicsCVarValueForQualityLevel]]() |
||
+ | : [[API GetUnitEmpowerHoldAtMaxTime|GetUnitEmpowerHoldAtMaxTime]](<span class="apiarg">unit</span>) : <span class="apiret">holdAtMaxTime</span> |
||
+ | : [[API GetUnitEmpowerMinHoldTime|GetUnitEmpowerMinHoldTime]](<span class="apiarg">unit</span>) : <span class="apiret">minHoldTime</span> |
||
+ | : [[API GetUnitEmpowerStageDuration|GetUnitEmpowerStageDuration]](<span class="apiarg">unit, index</span>) : <span class="apiret">duration</span> |
||
+ | : [[API IsAdvancedFlyableArea|IsAdvancedFlyableArea]]() |
||
+ | : [[API IsGraphicsCVarValueSupported|IsGraphicsCVarValueSupported]]() |
||
+ | : [[API IsGraphicsSettingValueSupported|IsGraphicsSettingValueSupported]]() |
||
+ | : [[API IsPlayerInGuildFromGUID|IsPlayerInGuildFromGUID]](<span class="apiarg">playerGUID</span>) : <span class="apiret">IsInGuild</span> |
||
+ | : [[API IsPressHoldReleaseSpell|IsPressHoldReleaseSpell]]() |
||
+ | : [[API IsSpecializationActivateSpell|IsSpecializationActivateSpell]]() |
||
+ | : [[API IsTargetLoose|IsTargetLoose]]() |
||
+ | : [[API IsUsingGamepad|IsUsingGamepad]]() |
||
+ | : [[API IsUsingMouse|IsUsingMouse]]() |
||
+ | : [[API JoinRatedSoloShuffle|JoinRatedSoloShuffle]]() |
||
+ | : [[API ReleaseAction|ReleaseAction]]() |
||
+ | : [[API ReplaceTradeskillEnchant|ReplaceTradeskillEnchant]]() |
||
+ | : [[API SetUnitCursorTexture|SetUnitCursorTexture]](<span class="apiarg">textureObject, unit [, style, includeLowPriority]</span>) : <span class="apiret">hasCursor</span> |
||
+ | : [[API TargetToggle|TargetToggle]]() |
||
+ | : [[API UnitIsBossMob|UnitIsBossMob]]() |
||
+ | : [[API UnitIsGameObject|UnitIsGameObject]]() |
||
+ | : [[API UnitIsInteractable|UnitIsInteractable]]() |
||
+ | : [[API UnitPartialPower|UnitPartialPower]](<span class="apiarg">unitToken [, powerType, unmodified]</span>) : <span class="apiret">partialPower</span> |
||
+ | : [[API UnitPercentHealthFromGUID|UnitPercentHealthFromGUID]](<span class="apiarg">unitGUID</span>) : <span class="apiret">percentHealth</span> |
||
+ | : [[API UnitTokenFromGUID|UnitTokenFromGUID]](<span class="apiarg">unitGUID</span>) : <span class="apiret">unitToken</span> |
||
+ | : [[API WorldLootObjectExists|WorldLootObjectExists]]() |
||
+ | |||
+ | ===Class Talents=== |
||
+ | : [[API C_ClassTalents.CanChangeTalents|C_ClassTalents.CanChangeTalents]]() : <span class="apiret">canChange, canAdd, changeError</span> |
||
+ | : [[API C_ClassTalents.CanCreateNewConfig|C_ClassTalents.CanCreateNewConfig]]() : <span class="apiret">canCreate</span> |
||
+ | : [[API C_ClassTalents.CanEditTalents|C_ClassTalents.CanEditTalents]]() : <span class="apiret">canEdit, changeError</span> |
||
+ | : [[API C_ClassTalents.CommitConfig|C_ClassTalents.CommitConfig]](<span class="apiarg">[savedConfigID]</span>) : <span class="apiret">success</span> |
||
+ | : [[API C_ClassTalents.DeleteConfig|C_ClassTalents.DeleteConfig]](<span class="apiarg">configID</span>) : <span class="apiret">success</span> |
||
+ | : [[API C_ClassTalents.GetActiveConfigID|C_ClassTalents.GetActiveConfigID]]() : <span class="apiret">activeConfigID</span> |
||
+ | : [[API C_ClassTalents.GetConfigIDsBySpecID|C_ClassTalents.GetConfigIDsBySpecID]](<span class="apiarg">[specID]</span>) : <span class="apiret">configIDs</span> |
||
+ | : [[API C_ClassTalents.GetHasStarterBuild|C_ClassTalents.GetHasStarterBuild]]() : <span class="apiret">hasStarterBuild</span> |
||
+ | : [[API C_ClassTalents.GetLastSelectedSavedConfigID|C_ClassTalents.GetLastSelectedSavedConfigID]](<span class="apiarg">specID</span>) : <span class="apiret">configID</span> |
||
+ | : [[API C_ClassTalents.GetNextStarterBuildPurchase|C_ClassTalents.GetNextStarterBuildPurchase]]() : <span class="apiret">nodeID, entryID</span> |
||
+ | : [[API C_ClassTalents.GetStarterBuildActive|C_ClassTalents.GetStarterBuildActive]]() : <span class="apiret">isActive</span> |
||
+ | : [[API C_ClassTalents.HasUnspentTalentPoints|C_ClassTalents.HasUnspentTalentPoints]]() : <span class="apiret">hasUnspentPoints, numClassPoints, numSpecPoints</span> |
||
+ | : [[API C_ClassTalents.ImportLoadout|C_ClassTalents.ImportLoadout]](<span class="apiarg">configID, entries, name</span>) : <span class="apiret">success, importError</span> |
||
+ | : [[API C_ClassTalents.IsConfigPopulated|C_ClassTalents.IsConfigPopulated]](<span class="apiarg">configID</span>) : <span class="apiret">isPopulated</span> |
||
+ | : [[API C_ClassTalents.LoadConfig|C_ClassTalents.LoadConfig]](<span class="apiarg">configID, autoApply</span>) : <span class="apiret">result, changeError, newLearnedNodeIDs</span> |
||
+ | : [[API C_ClassTalents.RenameConfig|C_ClassTalents.RenameConfig]](<span class="apiarg">configID, name</span>) : <span class="apiret">success</span> |
||
+ | : [[API C_ClassTalents.RequestNewConfig|C_ClassTalents.RequestNewConfig]](<span class="apiarg">name</span>) : <span class="apiret">success</span> |
||
+ | : [[API C_ClassTalents.SaveConfig|C_ClassTalents.SaveConfig]](<span class="apiarg">configID</span>) : <span class="apiret">success</span> |
||
+ | : [[API C_ClassTalents.SetStarterBuildActive|C_ClassTalents.SetStarterBuildActive]](<span class="apiarg">active</span>) : <span class="apiret">result</span> |
||
+ | : [[API C_ClassTalents.SetUsesSharedActionBars|C_ClassTalents.SetUsesSharedActionBars]](<span class="apiarg">configID, usesShared</span>) |
||
+ | : [[API C_ClassTalents.UpdateLastSelectedSavedConfigID|C_ClassTalents.UpdateLastSelectedSavedConfigID]](<span class="apiarg">specID [, configID]</span>) |
||
+ | |||
+ | ===Container=== |
||
+ | : [[API C_Container.ContainerIDToInventoryID|C_Container.ContainerIDToInventoryID]](<span class="apiarg">containerID</span>) : <span class="apiret">inventoryID</span> |
||
+ | : [[API C_Container.ContainerRefundItemPurchase|C_Container.ContainerRefundItemPurchase]](<span class="apiarg">containerIndex, slotIndex [, isEquipped]</span>) |
||
+ | : [[API C_Container.GetBackpackAutosortDisabled|C_Container.GetBackpackAutosortDisabled]]() : <span class="apiret">isDisabled</span> |
||
+ | : [[API C_Container.GetBagName|C_Container.GetBagName]](<span class="apiarg">bagIndex</span>) : <span class="apiret">name</span> |
||
+ | : [[API C_Container.GetBagSlotFlag|C_Container.GetBagSlotFlag]](<span class="apiarg">bagIndex, flag</span>) : <span class="apiret">isSet</span> |
||
+ | : [[API C_Container.GetBankAutosortDisabled|C_Container.GetBankAutosortDisabled]]() : <span class="apiret">isDisabled</span> |
||
+ | : [[API C_Container.GetContainerFreeSlots|C_Container.GetContainerFreeSlots]](<span class="apiarg">containerIndex</span>) : <span class="apiret">freeSlots</span> |
||
+ | : [[API C_Container.GetContainerItemCooldown|C_Container.GetContainerItemCooldown]](<span class="apiarg">containerIndex, slotIndex</span>) : <span class="apiret">startTime, duration, enable</span> |
||
+ | : [[API C_Container.GetContainerItemDurability|C_Container.GetContainerItemDurability]](<span class="apiarg">containerIndex, slotIndex</span>) : <span class="apiret">durability, maxDurability</span> |
||
+ | : [[API C_Container.GetContainerItemEquipmentSetInfo|C_Container.GetContainerItemEquipmentSetInfo]](<span class="apiarg">containerIndex, slotIndex</span>) : <span class="apiret">inSet, setList</span> |
||
+ | : [[API C_Container.GetContainerItemID|C_Container.GetContainerItemID]](<span class="apiarg">containerIndex, slotIndex</span>) : <span class="apiret">containerID</span> |
||
+ | : [[API C_Container.GetContainerItemInfo|C_Container.GetContainerItemInfo]](<span class="apiarg">containerIndex, slotIndex</span>) : <span class="apiret">containerInfo</span> |
||
+ | : [[API C_Container.GetContainerItemLink|C_Container.GetContainerItemLink]](<span class="apiarg">containerIndex, slotIndex</span>) : <span class="apiret">itemLink</span> |
||
+ | : [[API C_Container.GetContainerItemPurchaseCurrency|C_Container.GetContainerItemPurchaseCurrency]](<span class="apiarg">containerIndex, slotIndex, itemIndex, isEquipped</span>) : <span class="apiret">currencyInfo</span> |
||
+ | : [[API C_Container.GetContainerItemPurchaseInfo|C_Container.GetContainerItemPurchaseInfo]](<span class="apiarg">containerIndex, slotIndex, isEquipped</span>) : <span class="apiret">info</span> |
||
+ | : [[API C_Container.GetContainerItemPurchaseItem|C_Container.GetContainerItemPurchaseItem]](<span class="apiarg">containerIndex, slotIndex, itemIndex, isEquipped</span>) : <span class="apiret">itemInfo</span> |
||
+ | : [[API C_Container.GetContainerItemQuestInfo|C_Container.GetContainerItemQuestInfo]](<span class="apiarg">containerIndex, slotIndex</span>) : <span class="apiret">questInfo</span> |
||
+ | : [[API C_Container.GetContainerNumFreeSlots|C_Container.GetContainerNumFreeSlots]](<span class="apiarg">bagIndex</span>) : <span class="apiret">numFreeSlots, bagFamily</span> |
||
+ | : [[API C_Container.GetContainerNumSlots|C_Container.GetContainerNumSlots]](<span class="apiarg">containerIndex</span>) : <span class="apiret">numSlots</span> |
||
+ | : [[API C_Container.GetInsertItemsLeftToRight|C_Container.GetInsertItemsLeftToRight]]() : <span class="apiret">isEnabled</span> |
||
+ | : [[API C_Container.GetItemCooldown|C_Container.GetItemCooldown]](<span class="apiarg">itemID</span>) : <span class="apiret">startTime, duration, enable</span> |
||
+ | : [[API C_Container.GetMaxArenaCurrency|C_Container.GetMaxArenaCurrency]]() : <span class="apiret">maxCurrency</span> |
||
+ | : [[API C_Container.GetSortBagsRightToLeft|C_Container.GetSortBagsRightToLeft]]() : <span class="apiret">isEnabled</span> |
||
+ | : [[API C_Container.IsBattlePayItem|C_Container.IsBattlePayItem]](<span class="apiarg">containerIndex, slotIndex</span>) : <span class="apiret">isBattlePayItem</span> |
||
+ | : [[API C_Container.IsContainerFiltered|C_Container.IsContainerFiltered]](<span class="apiarg">containerIndex</span>) : <span class="apiret">isFiltered</span> |
||
+ | : [[API C_Container.PickupContainerItem|C_Container.PickupContainerItem]](<span class="apiarg">containerIndex, slotIndex</span>) |
||
+ | : [[API C_Container.PlayerHasHearthstone|C_Container.PlayerHasHearthstone]]() : <span class="apiret">itemID</span> |
||
+ | : [[API C_Container.SetBackpackAutosortDisabled|C_Container.SetBackpackAutosortDisabled]](<span class="apiarg">disable</span>) |
||
+ | : [[API C_Container.SetBagPortraitTexture|C_Container.SetBagPortraitTexture]](<span class="apiarg">texture, bagIndex</span>) |
||
+ | : [[API C_Container.SetBagSlotFlag|C_Container.SetBagSlotFlag]](<span class="apiarg">bagIndex, flag, isSet</span>) |
||
+ | : [[API C_Container.SetBankAutosortDisabled|C_Container.SetBankAutosortDisabled]](<span class="apiarg">disable</span>) |
||
+ | : [[API C_Container.SetInsertItemsLeftToRight|C_Container.SetInsertItemsLeftToRight]](<span class="apiarg">enable</span>) |
||
+ | : [[API C_Container.SetItemSearch|C_Container.SetItemSearch]](<span class="apiarg">searchString</span>) |
||
+ | : [[API C_Container.SetSortBagsRightToLeft|C_Container.SetSortBagsRightToLeft]](<span class="apiarg">enable</span>) |
||
+ | : [[API C_Container.ShowContainerSellCursor|C_Container.ShowContainerSellCursor]](<span class="apiarg">containerIndex, slotIndex</span>) |
||
+ | : [[API C_Container.SocketContainerItem|C_Container.SocketContainerItem]](<span class="apiarg">containerIndex, slotIndex</span>) : <span class="apiret">success</span> |
||
+ | : [[API C_Container.SortBags|C_Container.SortBags]]() |
||
+ | : [[API C_Container.SortBankBags|C_Container.SortBankBags]]() |
||
+ | : [[API C_Container.SortReagentBankBags|C_Container.SortReagentBankBags]]() |
||
+ | : [[API C_Container.SplitContainerItem|C_Container.SplitContainerItem]](<span class="apiarg">containerIndex, slotIndex, amount</span>) |
||
+ | : [[API C_Container.UseContainerItem|C_Container.UseContainerItem]](<span class="apiarg">containerIndex, slotIndex, [unitToken], [reagentBankOpen]</span>) |
||
+ | : [[API C_Container.UseHearthstone|C_Container.UseHearthstone]]() : <span class="apiret">used</span> |
||
+ | |||
+ | ===Crafting Orders=== |
||
+ | : [[API C_CraftingOrders.AreOrderNotesDisabled|C_CraftingOrders.AreOrderNotesDisabled]]() : <span class="apiret">areNotesDisabled</span> |
||
+ | : [[API C_CraftingOrders.CalculateCraftingOrderPostingFee|C_CraftingOrders.CalculateCraftingOrderPostingFee]](<span class="apiarg">skillLineAbilityID, orderType, orderDuration</span>) : <span class="apiret">deposit</span> |
||
+ | : [[API C_CraftingOrders.CanOrderSkillAbility|C_CraftingOrders.CanOrderSkillAbility]](<span class="apiarg">skillLineAbilityID</span>) : <span class="apiret">canOrder</span> |
||
+ | : [[API C_CraftingOrders.CancelOrder|C_CraftingOrders.CancelOrder]](<span class="apiarg">orderID</span>) |
||
+ | : [[API C_CraftingOrders.ClaimOrder|C_CraftingOrders.ClaimOrder]](<span class="apiarg">orderID, profession</span>) |
||
+ | : [[API C_CraftingOrders.CloseCrafterCraftingOrders|C_CraftingOrders.CloseCrafterCraftingOrders]]() |
||
+ | : [[API C_CraftingOrders.CloseCustomerCraftingOrders|C_CraftingOrders.CloseCustomerCraftingOrders]]() |
||
+ | : [[API C_CraftingOrders.FulfillOrder|C_CraftingOrders.FulfillOrder]](<span class="apiarg">orderID, crafterNote, profession</span>) |
||
+ | : [[API C_CraftingOrders.GetClaimedOrder|C_CraftingOrders.GetClaimedOrder]]() : <span class="apiret">order</span> |
||
+ | : [[API C_CraftingOrders.GetCrafterBuckets|C_CraftingOrders.GetCrafterBuckets]]() : <span class="apiret">buckets</span> |
||
+ | : [[API C_CraftingOrders.GetCrafterOrders|C_CraftingOrders.GetCrafterOrders]]() : <span class="apiret">orders</span> |
||
+ | : [[API C_CraftingOrders.GetCraftingOrderTime|C_CraftingOrders.GetCraftingOrderTime]]() : <span class="apiret">time</span> |
||
+ | : [[API C_CraftingOrders.GetCustomerCategories|C_CraftingOrders.GetCustomerCategories]]() : <span class="apiret">categories</span> |
||
+ | : [[API C_CraftingOrders.GetCustomerOptions|C_CraftingOrders.GetCustomerOptions]](<span class="apiarg">params</span>) : <span class="apiret">results</span> |
||
+ | : [[API C_CraftingOrders.GetCustomerOrders|C_CraftingOrders.GetCustomerOrders]]() : <span class="apiret">customerOrders</span> |
||
+ | : [[API C_CraftingOrders.GetDefaultOrdersSkillLine|C_CraftingOrders.GetDefaultOrdersSkillLine]]() : <span class="apiret">skillLineID</span> |
||
+ | : [[API C_CraftingOrders.GetMyOrders|C_CraftingOrders.GetMyOrders]]() : <span class="apiret">myOrders</span> |
||
+ | : [[API C_CraftingOrders.GetOrderClaimInfo|C_CraftingOrders.GetOrderClaimInfo]](<span class="apiarg">profession</span>) : <span class="apiret">claimInfo</span> |
||
+ | : [[API C_CraftingOrders.HasFavoriteCustomerOptions|C_CraftingOrders.HasFavoriteCustomerOptions]]() : <span class="apiret">hasFavorites</span> |
||
+ | : [[API C_CraftingOrders.IsCustomerOptionFavorited|C_CraftingOrders.IsCustomerOptionFavorited]](<span class="apiarg">recipeID</span>) : <span class="apiret">favorited</span> |
||
+ | : [[API C_CraftingOrders.ListMyOrders|C_CraftingOrders.ListMyOrders]](<span class="apiarg">request</span>) |
||
+ | : [[API C_CraftingOrders.OpenCrafterCraftingOrders|C_CraftingOrders.OpenCrafterCraftingOrders]]() |
||
+ | : [[API C_CraftingOrders.OpenCustomerCraftingOrders|C_CraftingOrders.OpenCustomerCraftingOrders]]() |
||
+ | : [[API C_CraftingOrders.OrderCanBeRecrafted|C_CraftingOrders.OrderCanBeRecrafted]](<span class="apiarg">orderID</span>) : <span class="apiret">recraftable</span> |
||
+ | : [[API C_CraftingOrders.ParseCustomerOptions|C_CraftingOrders.ParseCustomerOptions]]() |
||
+ | : [[API C_CraftingOrders.PlaceNewOrder|C_CraftingOrders.PlaceNewOrder]](<span class="apiarg">orderInfo</span>) |
||
+ | : [[API C_CraftingOrders.RejectOrder|C_CraftingOrders.RejectOrder]](<span class="apiarg">orderID, crafterNote, profession</span>) |
||
+ | : [[API C_CraftingOrders.ReleaseOrder|C_CraftingOrders.ReleaseOrder]](<span class="apiarg">orderID, profession</span>) |
||
+ | : [[API C_CraftingOrders.RequestCrafterOrders|C_CraftingOrders.RequestCrafterOrders]](<span class="apiarg">request</span>) {{apitag|noscript}} |
||
+ | : [[API C_CraftingOrders.RequestCustomerOrders|C_CraftingOrders.RequestCustomerOrders]](<span class="apiarg">request</span>) |
||
+ | : [[API C_CraftingOrders.SetCustomerOptionFavorited|C_CraftingOrders.SetCustomerOptionFavorited]](<span class="apiarg">recipeID, favorited</span>) |
||
+ | : [[API C_CraftingOrders.ShouldShowCraftingOrderTab|C_CraftingOrders.ShouldShowCraftingOrderTab]]() : <span class="apiret">showTab</span> |
||
+ | : [[API C_CraftingOrders.SkillLineHasOrders|C_CraftingOrders.SkillLineHasOrders]](<span class="apiarg">skillLineID</span>) : <span class="apiret">hasOrders</span> |
||
+ | : [[API C_CraftingOrders.UpdateIgnoreList|C_CraftingOrders.UpdateIgnoreList]]() |
||
+ | : [[API C_CurrencyInfo.GetCurrencyDescription|C_CurrencyInfo.GetCurrencyDescription]](<span class="apiarg">type</span>) : <span class="apiret">description</span> |
||
+ | : [[API C_Debug.PrintToDebugWindow|C_Debug.PrintToDebugWindow]]() |
||
+ | |||
+ | ===Edit Mode=== |
||
+ | : [[API C_EditMode.ConvertLayoutInfoToString|C_EditMode.ConvertLayoutInfoToString]](<span class="apiarg">layoutInfo</span>) : <span class="apiret">layoutInfoAsString</span> |
||
+ | : [[API C_EditMode.ConvertStringToLayoutInfo|C_EditMode.ConvertStringToLayoutInfo]](<span class="apiarg">layoutInfoAsString</span>) : <span class="apiret">layoutInfo</span> |
||
+ | : [[API C_EditMode.GetAccountSettings|C_EditMode.GetAccountSettings]]() : <span class="apiret">accountSettings</span> |
||
+ | : [[API C_EditMode.GetLayouts|C_EditMode.GetLayouts]]() : <span class="apiret">layoutInfo</span> |
||
+ | : [[API C_EditMode.OnEditModeExit|C_EditMode.OnEditModeExit]]() |
||
+ | : [[API C_EditMode.OnLayoutAdded|C_EditMode.OnLayoutAdded]](<span class="apiarg">addedLayoutIndex, activateNewLayout, isLayoutImported</span>) |
||
+ | : [[API C_EditMode.OnLayoutDeleted|C_EditMode.OnLayoutDeleted]](<span class="apiarg">deletedLayoutIndex</span>) |
||
+ | : [[API C_EditMode.SaveLayouts|C_EditMode.SaveLayouts]](<span class="apiarg">saveInfo</span>) |
||
+ | : [[API C_EditMode.SetAccountSetting|C_EditMode.SetAccountSetting]](<span class="apiarg">setting, value</span>) |
||
+ | : [[API C_EditMode.SetActiveLayout|C_EditMode.SetActiveLayout]](<span class="apiarg">activeLayout</span>) |
||
+ | |||
+ | ===Player Interaction=== |
||
+ | : [[API C_PlayerInteractionManager.ClearInteraction|C_PlayerInteractionManager.ClearInteraction]](<span class="apiarg">[type]</span>) |
||
+ | : [[API C_PlayerInteractionManager.ConfirmationInteraction|C_PlayerInteractionManager.ConfirmationInteraction]](<span class="apiarg">[type]</span>) |
||
+ | : [[API C_PlayerInteractionManager.InteractUnit|C_PlayerInteractionManager.InteractUnit]](<span class="apiarg">unit [, exactMatch, looseTargeting]</span>) : <span class="apiret">success</span> |
||
+ | : [[API C_PlayerInteractionManager.IsInteractingWithNpcOfType|C_PlayerInteractionManager.IsInteractingWithNpcOfType]](<span class="apiarg">type</span>) : <span class="apiret">interacting</span> |
||
+ | : [[API C_PlayerInteractionManager.IsReplacingUnit|C_PlayerInteractionManager.IsReplacingUnit]]() : <span class="apiret">replacing</span> |
||
+ | : [[API C_PlayerInteractionManager.IsValidNPCInteraction|C_PlayerInteractionManager.IsValidNPCInteraction]](<span class="apiarg">type</span>) : <span class="apiret">isValidInteraction</span> |
||
+ | : [[API C_PlayerInteractionManager.ReopenInteraction|C_PlayerInteractionManager.ReopenInteraction]]() |
||
+ | |||
+ | ===Tooltips=== |
||
+ | : [[API C_TooltipInfo.GetAchievementByID|C_TooltipInfo.GetAchievementByID]](<span class="apiarg">achievementID</span>) : <span class="apiret">data</span> |
||
+ | : [[API C_TooltipInfo.GetAction|C_TooltipInfo.GetAction]](<span class="apiarg">actionID</span>) : <span class="apiret">data</span> |
||
+ | : [[API C_TooltipInfo.GetArtifactItem|C_TooltipInfo.GetArtifactItem]]() : <span class="apiret">data</span> |
||
+ | : [[API C_TooltipInfo.GetArtifactPowerByID|C_TooltipInfo.GetArtifactPowerByID]](<span class="apiarg">powerID</span>) : <span class="apiret">data</span> |
||
+ | : [[API C_TooltipInfo.GetAzeriteEssence|C_TooltipInfo.GetAzeriteEssence]](<span class="apiarg">essenceID [, rank]</span>) : <span class="apiret">data</span> |
||
+ | : [[API C_TooltipInfo.GetAzeriteEssenceSlot|C_TooltipInfo.GetAzeriteEssenceSlot]](<span class="apiarg">slot</span>) : <span class="apiret">data</span> |
||
+ | : [[API C_TooltipInfo.GetAzeritePower|C_TooltipInfo.GetAzeritePower]](<span class="apiarg">itemID, itemLevel, powerID [, owningItemLink]</span>) : <span class="apiret">data</span> |
||
+ | : [[API C_TooltipInfo.GetBackpackToken|C_TooltipInfo.GetBackpackToken]](<span class="apiarg">index</span>) : <span class="apiret">data</span> |
||
+ | : [[API C_TooltipInfo.GetBagItem|C_TooltipInfo.GetBagItem]](<span class="apiarg">bagIndex, slotIndex</span>) : <span class="apiret">data</span> |
||
+ | : [[API C_TooltipInfo.GetBagItemChild|C_TooltipInfo.GetBagItemChild]](<span class="apiarg">bagIndex, slotIndex, equipSlotIndex</span>) : <span class="apiret">data</span> |
||
+ | : [[API C_TooltipInfo.GetBuybackItem|C_TooltipInfo.GetBuybackItem]](<span class="apiarg">index</span>) : <span class="apiret">data</span> |
||
+ | : [[API C_TooltipInfo.GetCompanionPet|C_TooltipInfo.GetCompanionPet]](<span class="apiarg">petGUID</span>) : <span class="apiret">data</span> |
||
+ | : [[API C_TooltipInfo.GetConduit|C_TooltipInfo.GetConduit]](<span class="apiarg">conduitID, conduitRank</span>) : <span class="apiret">data</span> |
||
+ | : [[API C_TooltipInfo.GetCurrencyByID|C_TooltipInfo.GetCurrencyByID]](<span class="apiarg">currencyID [, amount]</span>) : <span class="apiret">data</span> |
||
+ | : [[API C_TooltipInfo.GetCurrencyToken|C_TooltipInfo.GetCurrencyToken]](<span class="apiarg">tokenIndex</span>) : <span class="apiret">data</span> |
||
+ | : [[API C_TooltipInfo.GetEnhancedConduit|C_TooltipInfo.GetEnhancedConduit]](<span class="apiarg">conduitID, rank</span>) : <span class="apiret">data</span> |
||
+ | : [[API C_TooltipInfo.GetEquipmentSet|C_TooltipInfo.GetEquipmentSet]](<span class="apiarg">setID</span>) : <span class="apiret">data</span> |
||
+ | : [[API C_TooltipInfo.GetExistingSocketGem|C_TooltipInfo.GetExistingSocketGem]](<span class="apiarg">index [, toDestroy]</span>) : <span class="apiret">data</span> |
||
+ | : [[API C_TooltipInfo.GetGuildBankItem|C_TooltipInfo.GetGuildBankItem]](<span class="apiarg">tab, slot</span>) : <span class="apiret">data</span> |
||
+ | : [[API C_TooltipInfo.GetHeirloomByItemID|C_TooltipInfo.GetHeirloomByItemID]](<span class="apiarg">itemID</span>) : <span class="apiret">data</span> |
||
+ | : [[API C_TooltipInfo.GetHyperlink|C_TooltipInfo.GetHyperlink]](<span class="apiarg">hyperlink [, optionalArg1, optionalArg2, hideVendorPrice]</span>) : <span class="apiret">data</span> |
||
+ | : [[API C_TooltipInfo.GetInboxItem|C_TooltipInfo.GetInboxItem]](<span class="apiarg">messageIndex [, attachmentIndex]</span>) : <span class="apiret">data</span> |
||
+ | : [[API C_TooltipInfo.GetInstanceLockEncountersComplete|C_TooltipInfo.GetInstanceLockEncountersComplete]](<span class="apiarg">index</span>) : <span class="apiret">data</span> |
||
+ | : [[API C_TooltipInfo.GetInventoryItem|C_TooltipInfo.GetInventoryItem]](<span class="apiarg">unit, slot [, hideUselessStats]</span>) : <span class="apiret">data</span> |
||
+ | : [[API C_TooltipInfo.GetInventoryItemByID|C_TooltipInfo.GetInventoryItemByID]](<span class="apiarg">itemID</span>) : <span class="apiret">data</span> |
||
+ | : [[API C_TooltipInfo.GetItemByGUID|C_TooltipInfo.GetItemByGUID]](<span class="apiarg">guid</span>) : <span class="apiret">data</span> |
||
+ | : [[API C_TooltipInfo.GetItemByID|C_TooltipInfo.GetItemByID]](<span class="apiarg">itemID [, quality]</span>) : <span class="apiret">data</span> |
||
+ | : [[API C_TooltipInfo.GetItemInteractionItem|C_TooltipInfo.GetItemInteractionItem]]() : <span class="apiret">data</span> |
||
+ | : [[API C_TooltipInfo.GetItemKey|C_TooltipInfo.GetItemKey]](<span class="apiarg">itemID, itemLevel, itemSuffix [, requiredLevel]</span>) : <span class="apiret">data</span> |
||
+ | : [[API C_TooltipInfo.GetLFGDungeonReward|C_TooltipInfo.GetLFGDungeonReward]](<span class="apiarg">dungeonID, lootIndex</span>) : <span class="apiret">data</span> |
||
+ | : [[API C_TooltipInfo.GetLFGDungeonShortageReward|C_TooltipInfo.GetLFGDungeonShortageReward]](<span class="apiarg">dungeonID, shortageSeverity, lootIndex</span>) : <span class="apiret">data</span> |
||
+ | : [[API C_TooltipInfo.GetLootCurrency|C_TooltipInfo.GetLootCurrency]](<span class="apiarg">slot</span>) : <span class="apiret">data</span> |
||
+ | : [[API C_TooltipInfo.GetLootItem|C_TooltipInfo.GetLootItem]](<span class="apiarg">slot</span>) : <span class="apiret">data</span> |
||
+ | : [[API C_TooltipInfo.GetLootRollItem|C_TooltipInfo.GetLootRollItem]](<span class="apiarg">id</span>) : <span class="apiret">data</span> |
||
+ | : [[API C_TooltipInfo.GetMerchantCostItem|C_TooltipInfo.GetMerchantCostItem]](<span class="apiarg">slot, costIndex</span>) : <span class="apiret">data</span> |
||
+ | : [[API C_TooltipInfo.GetMerchantItem|C_TooltipInfo.GetMerchantItem]](<span class="apiarg">slot</span>) : <span class="apiret">data</span> |
||
+ | : [[API C_TooltipInfo.GetMinimapMouseover|C_TooltipInfo.GetMinimapMouseover]]() : <span class="apiret">data</span> |
||
+ | : [[API C_TooltipInfo.GetMountBySpellID|C_TooltipInfo.GetMountBySpellID]](<span class="apiarg">spellID [, checkIndoors]</span>) : <span class="apiret">data</span> |
||
+ | : [[API C_TooltipInfo.GetOwnedItemByID|C_TooltipInfo.GetOwnedItemByID]](<span class="apiarg">itemID</span>) : <span class="apiret">data</span> |
||
+ | : [[API C_TooltipInfo.GetPetAction|C_TooltipInfo.GetPetAction]](<span class="apiarg">slot</span>) : <span class="apiret">data</span> |
||
+ | : [[API C_TooltipInfo.GetPossession|C_TooltipInfo.GetPossession]](<span class="apiarg">slot</span>) : <span class="apiret">data</span> |
||
+ | : [[API C_TooltipInfo.GetPvpBrawl|C_TooltipInfo.GetPvpBrawl]](<span class="apiarg">[isSpecial]</span>) : <span class="apiret">data</span> |
||
+ | : [[API C_TooltipInfo.GetPvpTalent|C_TooltipInfo.GetPvpTalent]](<span class="apiarg">talentID [, isInspect, groupIndex, talentIndex]</span>) : <span class="apiret">data</span> |
||
+ | : [[API C_TooltipInfo.GetQuestCurrency|C_TooltipInfo.GetQuestCurrency]](<span class="apiarg">type, currencyIndex</span>) : <span class="apiret">data</span> |
||
+ | : [[API C_TooltipInfo.GetQuestItem|C_TooltipInfo.GetQuestItem]](<span class="apiarg">type, itemIndex [, allowCollectionText]</span>) : <span class="apiret">data</span> |
||
+ | : [[API C_TooltipInfo.GetQuestLogCurrency|C_TooltipInfo.GetQuestLogCurrency]](<span class="apiarg">type, currencyIndex [, questID]</span>) : <span class="apiret">data</span> |
||
+ | : [[API C_TooltipInfo.GetQuestLogItem|C_TooltipInfo.GetQuestLogItem]](<span class="apiarg">type, itemIndex [, questID, allowCollectionText]</span>) : <span class="apiret">data</span> |
||
+ | : [[API C_TooltipInfo.GetQuestLogSpecialItem|C_TooltipInfo.GetQuestLogSpecialItem]](<span class="apiarg">questIndex</span>) : <span class="apiret">data</span> |
||
+ | : [[API C_TooltipInfo.GetQuestPartyProgress|C_TooltipInfo.GetQuestPartyProgress]](<span class="apiarg">questID [, omitTitle, ignoreActivePlayer]</span>) : <span class="apiret">data</span> |
||
+ | : [[API C_TooltipInfo.GetRecipeRankInfo|C_TooltipInfo.GetRecipeRankInfo]](<span class="apiarg">recipeID, rank</span>) : <span class="apiret">data</span> |
||
+ | : [[API C_TooltipInfo.GetRecipeReagentItem|C_TooltipInfo.GetRecipeReagentItem]](<span class="apiarg">recipeSpellID, dataSlotIndex</span>) : <span class="apiret">data</span> |
||
+ | : [[API C_TooltipInfo.GetRecipeResultItem|C_TooltipInfo.GetRecipeResultItem]](<span class="apiarg">recipeID [, craftingReagents, recraftItemGUID, recipeLevel, overrideQualityID]</span>) : <span class="apiret">data</span> |
||
+ | : [[API C_TooltipInfo.GetRecipeResultItemForOrder|C_TooltipInfo.GetRecipeResultItemForOrder]](<span class="apiarg">recipeID [, craftingReagents, orderID, recipeLevel, overrideQualityID]</span>) : <span class="apiret">data</span> |
||
+ | : [[API C_TooltipInfo.GetRuneforgeResultItem|C_TooltipInfo.GetRuneforgeResultItem]](<span class="apiarg">itemGUID, itemLevel [, powerID, modifiers]</span>) : <span class="apiret">data</span> |
||
+ | : [[API C_TooltipInfo.GetSendMailItem|C_TooltipInfo.GetSendMailItem]](<span class="apiarg">[attachmentIndex]</span>) : <span class="apiret">data</span> |
||
+ | : [[API C_TooltipInfo.GetShapeshift|C_TooltipInfo.GetShapeshift]](<span class="apiarg">slot</span>) : <span class="apiret">data</span> |
||
+ | : [[API C_TooltipInfo.GetSlottedKeystone|C_TooltipInfo.GetSlottedKeystone]]() : <span class="apiret">data</span> |
||
+ | : [[API C_TooltipInfo.GetSocketGem|C_TooltipInfo.GetSocketGem]](<span class="apiarg">index</span>) : <span class="apiret">data</span> |
||
+ | : [[API C_TooltipInfo.GetSocketedItem|C_TooltipInfo.GetSocketedItem]]() : <span class="apiret">data</span> |
||
+ | : [[API C_TooltipInfo.GetSocketedRelic|C_TooltipInfo.GetSocketedRelic]](<span class="apiarg">slotIndex</span>) : <span class="apiret">data</span> |
||
+ | : [[API C_TooltipInfo.GetSpellBookItem|C_TooltipInfo.GetSpellBookItem]](<span class="apiarg">slot, spellBookType</span>) : <span class="apiret">data</span> |
||
+ | : [[API C_TooltipInfo.GetSpellByID|C_TooltipInfo.GetSpellByID]](<span class="apiarg">spellID [, isPet, showSubtext, dontOverride, difficultyID, isLink]</span>) : <span class="apiret">data</span> |
||
+ | : [[API C_TooltipInfo.GetTalent|C_TooltipInfo.GetTalent]](<span class="apiarg">talentID [, isInspect, groupIndex]</span>) : <span class="apiret">data</span> |
||
+ | : [[API C_TooltipInfo.GetTotem|C_TooltipInfo.GetTotem]](<span class="apiarg">slot</span>) : <span class="apiret">data</span> |
||
+ | : [[API C_TooltipInfo.GetToyByItemID|C_TooltipInfo.GetToyByItemID]](<span class="apiarg">itemID</span>) : <span class="apiret">data</span> |
||
+ | : [[API C_TooltipInfo.GetTradePlayerItem|C_TooltipInfo.GetTradePlayerItem]](<span class="apiarg">slot</span>) : <span class="apiret">data</span> |
||
+ | : [[API C_TooltipInfo.GetTradeTargetItem|C_TooltipInfo.GetTradeTargetItem]](<span class="apiarg">slot</span>) : <span class="apiret">data</span> |
||
+ | : [[API C_TooltipInfo.GetTrainerService|C_TooltipInfo.GetTrainerService]](<span class="apiarg">serviceIndex</span>) : <span class="apiret">data</span> |
||
+ | : [[API C_TooltipInfo.GetTraitEntry|C_TooltipInfo.GetTraitEntry]](<span class="apiarg">entryID [, rank]</span>) : <span class="apiret">data</span> |
||
+ | : [[API C_TooltipInfo.GetTransmogrifyItem|C_TooltipInfo.GetTransmogrifyItem]](<span class="apiarg">transmogLocation</span>) : <span class="apiret">data</span> |
||
+ | : [[API C_TooltipInfo.GetUnit|C_TooltipInfo.GetUnit]](<span class="apiarg">unit [, hideStatus]</span>) : <span class="apiret">data</span> |
||
+ | : [[API C_TooltipInfo.GetUnitAura|C_TooltipInfo.GetUnitAura]](<span class="apiarg">unitToken, index [, filter]</span>) : <span class="apiret">data</span> |
||
+ | : [[API C_TooltipInfo.GetUnitBuff|C_TooltipInfo.GetUnitBuff]](<span class="apiarg">unitToken, index [, filter]</span>) : <span class="apiret">data</span> |
||
+ | : [[API C_TooltipInfo.GetUnitBuffByAuraInstanceID|C_TooltipInfo.GetUnitBuffByAuraInstanceID]](<span class="apiarg">unitTokenString, auraInstanceID [, filter]</span>) : <span class="apiret">data</span> |
||
+ | : [[API C_TooltipInfo.GetUnitDebuff|C_TooltipInfo.GetUnitDebuff]](<span class="apiarg">unitToken, index [, filter]</span>) : <span class="apiret">data</span> |
||
+ | : [[API C_TooltipInfo.GetUnitDebuffByAuraInstanceID|C_TooltipInfo.GetUnitDebuffByAuraInstanceID]](<span class="apiarg">unitTokenString, auraInstanceID [, filter]</span>) : <span class="apiret">data</span> |
||
+ | : [[API C_TooltipInfo.GetUpgradeItem|C_TooltipInfo.GetUpgradeItem]]() : <span class="apiret">data</span> |
||
+ | : [[API C_TooltipInfo.GetVoidDepositItem|C_TooltipInfo.GetVoidDepositItem]](<span class="apiarg">slot</span>) : <span class="apiret">data</span> |
||
+ | : [[API C_TooltipInfo.GetVoidItem|C_TooltipInfo.GetVoidItem]](<span class="apiarg">tab, slot</span>) : <span class="apiret">data</span> |
||
+ | : [[API C_TooltipInfo.GetVoidWithdrawalItem|C_TooltipInfo.GetVoidWithdrawalItem]](<span class="apiarg">slot</span>) : <span class="apiret">data</span> |
||
+ | : [[API C_TooltipInfo.GetWeeklyReward|C_TooltipInfo.GetWeeklyReward]](<span class="apiarg">itemDBID</span>) : <span class="apiret">data</span> |
||
+ | : [[API C_TooltipInfo.GetWorldCursor|C_TooltipInfo.GetWorldCursor]]() : <span class="apiret">data</span> |
||
+ | |||
+ | ===Tradeskill UI=== |
||
+ | : [[API C_TradeSkillUI.CraftEnchant|C_TradeSkillUI.CraftEnchant]](<span class="apiarg">recipeSpellID [, numCasts, craftingReagents, itemTarget]</span>) |
||
+ | : [[API C_TradeSkillUI.CraftSalvage|C_TradeSkillUI.CraftSalvage]](<span class="apiarg">recipeSpellID [, numCasts, itemTarget]</span>) |
||
+ | : [[API C_TradeSkillUI.DoesRecraftingRecipeAcceptItem|C_TradeSkillUI.DoesRecraftingRecipeAcceptItem]](<span class="apiarg">itemLocation, recipeID</span>) : <span class="apiret">result</span> |
||
+ | : [[API C_TradeSkillUI.GetAllFilterableInventorySlotsCount|C_TradeSkillUI.GetAllFilterableInventorySlotsCount]]() |
||
+ | : [[API C_TradeSkillUI.GetBaseProfessionInfo|C_TradeSkillUI.GetBaseProfessionInfo]]() : <span class="apiret">info</span> |
||
+ | : [[API C_TradeSkillUI.GetChildProfessionInfo|C_TradeSkillUI.GetChildProfessionInfo]]() : <span class="apiret">info</span> |
||
+ | : [[API C_TradeSkillUI.GetChildProfessionInfos|C_TradeSkillUI.GetChildProfessionInfos]]() : <span class="apiret">infos</span> |
||
+ | : [[API C_TradeSkillUI.GetCraftableCount|C_TradeSkillUI.GetCraftableCount]](<span class="apiarg">recipeSpellID [, recipeLevel]</span>) : <span class="apiret">numAvailable</span> |
||
+ | : [[API C_TradeSkillUI.GetCraftingOperationInfo|C_TradeSkillUI.GetCraftingOperationInfo]](<span class="apiarg">recipeID, craftingReagents [, allocationItemGUID]</span>) : <span class="apiret">info</span> |
||
+ | : [[API C_TradeSkillUI.GetCraftingOperationInfoForOrder|C_TradeSkillUI.GetCraftingOperationInfoForOrder]](<span class="apiarg">recipeID, craftingReagents, orderID</span>) : <span class="apiret">info</span> |
||
+ | : [[API C_TradeSkillUI.GetCraftingReagentBonusText|C_TradeSkillUI.GetCraftingReagentBonusText]](<span class="apiarg">recipeSpellID, craftingReagentIndex, craftingReagents [, allocationItemGUID]</span>) : <span class="apiret">bonusText</span> |
||
+ | : [[API C_TradeSkillUI.GetCraftingTargetItems|C_TradeSkillUI.GetCraftingTargetItems]](<span class="apiarg">itemIDs</span>) : <span class="apiret">items</span> |
||
+ | : [[API C_TradeSkillUI.GetEnchantItems|C_TradeSkillUI.GetEnchantItems]](<span class="apiarg">recipeID</span>) : <span class="apiret">items</span> |
||
+ | : [[API C_TradeSkillUI.GetFactionSpecificOutputItem|C_TradeSkillUI.GetFactionSpecificOutputItem]](<span class="apiarg">recipeSpellID</span>) : <span class="apiret">itemID</span> |
||
+ | : [[API C_TradeSkillUI.GetFilterableInventorySlotName|C_TradeSkillUI.GetFilterableInventorySlotName]]() |
||
+ | : [[API C_TradeSkillUI.GetGatheringOperationInfo|C_TradeSkillUI.GetGatheringOperationInfo]](<span class="apiarg">recipeID</span>) : <span class="apiret">info</span> |
||
+ | : [[API C_TradeSkillUI.GetHideUnownedFlags|C_TradeSkillUI.GetHideUnownedFlags]](<span class="apiarg">recipeID</span>) : <span class="apiret">cannotModifyHideUnowned, alwaysShowUnowned</span> |
||
+ | : [[API C_TradeSkillUI.GetItemCraftedQualityByItemInfo|C_TradeSkillUI.GetItemCraftedQualityByItemInfo]](<span class="apiarg">itemInfo</span>) : <span class="apiret">quality</span> |
||
+ | : [[API C_TradeSkillUI.GetItemReagentQualityByItemInfo|C_TradeSkillUI.GetItemReagentQualityByItemInfo]](<span class="apiarg">itemInfo</span>) : <span class="apiret">quality</span> |
||
+ | : [[API C_TradeSkillUI.GetItemSlotModifications|C_TradeSkillUI.GetItemSlotModifications]](<span class="apiarg">itemGUID</span>) : <span class="apiret">slotMods</span> |
||
+ | : [[API C_TradeSkillUI.GetItemSlotModificationsForOrder|C_TradeSkillUI.GetItemSlotModificationsForOrder]](<span class="apiarg">orderID</span>) : <span class="apiret">slotMods</span> |
||
+ | : [[API C_TradeSkillUI.GetOnlyShowFirstCraftRecipes|C_TradeSkillUI.GetOnlyShowFirstCraftRecipes]]() |
||
+ | : [[API C_TradeSkillUI.GetOriginalCraftRecipeID|C_TradeSkillUI.GetOriginalCraftRecipeID]](<span class="apiarg">itemGUID</span>) : <span class="apiret">recipeID, skillLineAbilityID</span> |
||
+ | : [[API C_TradeSkillUI.GetProfessionByInventorySlot|C_TradeSkillUI.GetProfessionByInventorySlot]](<span class="apiarg">slot</span>) : <span class="apiret">profession</span> |
||
+ | : [[API C_TradeSkillUI.GetProfessionChildSkillLineID|C_TradeSkillUI.GetProfessionChildSkillLineID]]() : <span class="apiret">skillLineID</span> |
||
+ | : [[API C_TradeSkillUI.GetProfessionForCursorItem|C_TradeSkillUI.GetProfessionForCursorItem]]() : <span class="apiret">profession</span> |
||
+ | : [[API C_TradeSkillUI.GetProfessionInfoBySkillLineID|C_TradeSkillUI.GetProfessionInfoBySkillLineID]](<span class="apiarg">skillLineID</span>) : <span class="apiret">info</span> |
||
+ | : [[API C_TradeSkillUI.GetProfessionInventorySlots|C_TradeSkillUI.GetProfessionInventorySlots]]() : <span class="apiret">invSlots</span> |
||
+ | : [[API C_TradeSkillUI.GetProfessionNameForSkillLineAbility|C_TradeSkillUI.GetProfessionNameForSkillLineAbility]](<span class="apiarg">skillLineAbilityID</span>) : <span class="apiret">professionNmae</span> |
||
+ | : [[API C_TradeSkillUI.GetProfessionSkillLineID|C_TradeSkillUI.GetProfessionSkillLineID]](<span class="apiarg">profession</span>) : <span class="apiret">skillLineID</span> |
||
+ | : [[API C_TradeSkillUI.GetProfessionSlots|C_TradeSkillUI.GetProfessionSlots]](<span class="apiarg">profession</span>) : <span class="apiret">slots</span> |
||
+ | : [[API C_TradeSkillUI.GetProfessionSpells|C_TradeSkillUI.GetProfessionSpells]](<span class="apiarg">professionID [, skillLineID]</span>) : <span class="apiret">knownSpells</span> |
||
+ | : [[API C_TradeSkillUI.GetQualitiesForRecipe|C_TradeSkillUI.GetQualitiesForRecipe]](<span class="apiarg">recipeID</span>) : <span class="apiret">qualityIDs</span> |
||
+ | : [[API C_TradeSkillUI.GetReagentDifficultyText|C_TradeSkillUI.GetReagentDifficultyText]](<span class="apiarg">craftingReagentIndex, craftingReagents</span>) : <span class="apiret">bonusText</span> |
||
+ | : [[API C_TradeSkillUI.GetReagentSlotStatus|C_TradeSkillUI.GetReagentSlotStatus]](<span class="apiarg">mcrSlotID, recipeSpellID, skillLineAbilityID</span>) : <span class="apiret">locked, lockedReason</span> |
||
+ | : [[API C_TradeSkillUI.GetRecipeFixedReagentItemLink|C_TradeSkillUI.GetRecipeFixedReagentItemLink]](<span class="apiarg">recipeID, dataSlotIndex</span>) : <span class="apiret">link</span> |
||
+ | : [[API C_TradeSkillUI.GetRecipeInfoForSkillLineAbility|C_TradeSkillUI.GetRecipeInfoForSkillLineAbility]](<span class="apiarg">skillLineAbilityID [, recipeLevel]</span>) : <span class="apiret">recipeInfo</span> |
||
+ | : [[API C_TradeSkillUI.GetRecipeOutputItemData|C_TradeSkillUI.GetRecipeOutputItemData]](<span class="apiarg">recipeSpellID [, reagents, allocationItemGUID, overrideQualityID, recraftOrderID]</span>) : <span class="apiret">outputInfo</span> |
||
+ | : [[API C_TradeSkillUI.GetRecipeQualityItemIDs|C_TradeSkillUI.GetRecipeQualityItemIDs]](<span class="apiarg">recipeSpellID</span>) : <span class="apiret">qualityItemIDs</span> |
||
+ | : [[API C_TradeSkillUI.GetRecipeQualityReagentItemLink|C_TradeSkillUI.GetRecipeQualityReagentItemLink]](<span class="apiarg">recipeID, dataSlotIndex, qualityIndex</span>) : <span class="apiret">link</span> |
||
+ | : [[API C_TradeSkillUI.GetRecipeRequirements|C_TradeSkillUI.GetRecipeRequirements]](<span class="apiarg">recipeID</span>) : <span class="apiret">requirements</span> |
||
+ | : [[API C_TradeSkillUI.GetRecipeSchematic|C_TradeSkillUI.GetRecipeSchematic]](<span class="apiarg">recipeSpellID, isRecraft [, recipeLevel]</span>) : <span class="apiret">schematic</span> |
||
+ | : [[API C_TradeSkillUI.GetRecipesTracked|C_TradeSkillUI.GetRecipesTracked]](<span class="apiarg">isRecraft</span>) : <span class="apiret">recipeIDs</span> |
||
+ | : [[API C_TradeSkillUI.GetRecraftItems|C_TradeSkillUI.GetRecraftItems]](<span class="apiarg">[recipeID]</span>) : <span class="apiret">items</span> |
||
+ | : [[API C_TradeSkillUI.GetSalvagableItemIDs|C_TradeSkillUI.GetSalvagableItemIDs]](<span class="apiarg">recipeID</span>) : <span class="apiret">itemIDs</span> |
||
+ | : [[API C_TradeSkillUI.GetShowLearned|C_TradeSkillUI.GetShowLearned]]() : <span class="apiret">flag</span> |
||
+ | : [[API C_TradeSkillUI.GetShowUnlearned|C_TradeSkillUI.GetShowUnlearned]]() : <span class="apiret">flag</span> |
||
+ | : [[API C_TradeSkillUI.GetSkillLineForGear|C_TradeSkillUI.GetSkillLineForGear]](<span class="apiarg">itemInfo</span>) : <span class="apiret">skillLineID</span> |
||
+ | : [[API C_TradeSkillUI.GetSourceTypeFilter|C_TradeSkillUI.GetSourceTypeFilter]]() : <span class="apiret">sourceTypeFilter</span> |
||
+ | : [[API C_TradeSkillUI.HasFavoriteOrderRecipes|C_TradeSkillUI.HasFavoriteOrderRecipes]]() : <span class="apiret">hasFavorites</span> |
||
+ | : [[API C_TradeSkillUI.IsNearProfessionSpellFocus|C_TradeSkillUI.IsNearProfessionSpellFocus]](<span class="apiarg">profession</span>) : <span class="apiret">nearFocus</span> |
||
+ | : [[API C_TradeSkillUI.IsOriginalCraftRecipeLearned|C_TradeSkillUI.IsOriginalCraftRecipeLearned]](<span class="apiarg">itemGUID</span>) : <span class="apiret">learned</span> |
||
+ | : [[API C_TradeSkillUI.IsRecipeInBaseSkillLine|C_TradeSkillUI.IsRecipeInBaseSkillLine]](<span class="apiarg">recipeID</span>) : <span class="apiret">result</span> |
||
+ | : [[API C_TradeSkillUI.IsRecipeInSkillLine|C_TradeSkillUI.IsRecipeInSkillLine]](<span class="apiarg">recipeID, skillLineID</span>) : <span class="apiret">result</span> |
||
+ | : [[API C_TradeSkillUI.IsRecipeProfessionLearned|C_TradeSkillUI.IsRecipeProfessionLearned]](<span class="apiarg">recipeID</span>) : <span class="apiret">recipeProfessionLearned</span> |
||
+ | : [[API C_TradeSkillUI.IsRecipeTracked|C_TradeSkillUI.IsRecipeTracked]](<span class="apiarg">recipeID, isRecraft</span>) : <span class="apiret">tracked</span> |
||
+ | : [[API C_TradeSkillUI.IsRuneforging|C_TradeSkillUI.IsRuneforging]]() : <span class="apiret">result</span> |
||
+ | : [[API C_TradeSkillUI.OpenRecipe|C_TradeSkillUI.OpenRecipe]](<span class="apiarg">recipeID</span>) |
||
+ | : [[API C_TradeSkillUI.RecraftRecipe|C_TradeSkillUI.RecraftRecipe]](<span class="apiarg">itemGUID [, craftingReagents, removedModifications]</span>) : <span class="apiret">result</span> |
||
+ | : [[API C_TradeSkillUI.RecraftRecipeForOrder|C_TradeSkillUI.RecraftRecipeForOrder]](<span class="apiarg">orderID, itemGUID [, craftingReagents, removedModifications]</span>) : <span class="apiret">result</span> |
||
+ | : [[API C_TradeSkillUI.SetOnlyShowAvailableForOrders|C_TradeSkillUI.SetOnlyShowAvailableForOrders]](<span class="apiarg">flag</span>) |
||
+ | : [[API C_TradeSkillUI.SetOnlyShowFirstCraftRecipes|C_TradeSkillUI.SetOnlyShowFirstCraftRecipes]]() |
||
+ | : [[API C_TradeSkillUI.SetProfessionChildSkillLineID|C_TradeSkillUI.SetProfessionChildSkillLineID]](<span class="apiarg">skillLineID</span>) |
||
+ | : [[API C_TradeSkillUI.SetRecipeTracked|C_TradeSkillUI.SetRecipeTracked]](<span class="apiarg">recipeID, tracked, isRecraft</span>) |
||
+ | : [[API C_TradeSkillUI.SetShowLearned|C_TradeSkillUI.SetShowLearned]](<span class="apiarg">flag</span>) |
||
+ | : [[API C_TradeSkillUI.SetShowUnlearned|C_TradeSkillUI.SetShowUnlearned]](<span class="apiarg">flag</span>) |
||
+ | : [[API C_TradeSkillUI.SetSourceTypeFilter|C_TradeSkillUI.SetSourceTypeFilter]](<span class="apiarg">sourceTypeFilter</span>) |
||
+ | |||
+ | ===Trading Post=== |
||
+ | The [[Trading Post]] was added in [[Patch 10.0.5]] |
||
+ | : [[API C_PerksActivities.AddTrackedPerksActivity|C_PerksActivities.AddTrackedPerksActivity]](<span class="apiarg">perksActivityID</span>) |
||
+ | : [[API C_PerksActivities.ClearPerksActivitiesPendingCompletion|C_PerksActivities.ClearPerksActivitiesPendingCompletion]]() |
||
+ | : [[API C_PerksActivities.GetAllPerksActivityTags|C_PerksActivities.GetAllPerksActivityTags]]() : <span class="apiret">tags</span> |
||
+ | : [[API C_PerksActivities.GetPerksActivitiesInfo|C_PerksActivities.GetPerksActivitiesInfo]]() : <span class="apiret">info</span> |
||
+ | : [[API C_PerksActivities.GetPerksActivitiesPendingCompletion|C_PerksActivities.GetPerksActivitiesPendingCompletion]]() : <span class="apiret">pending</span> |
||
+ | : [[API C_PerksActivities.GetPerksActivityChatLink|C_PerksActivities.GetPerksActivityChatLink]](<span class="apiarg">perksActivityID</span>) : <span class="apiret">link</span> |
||
+ | : [[API C_PerksActivities.GetPerksActivityInfo|C_PerksActivities.GetPerksActivityInfo]](<span class="apiarg">perksActivityID</span>) : <span class="apiret">info</span> |
||
+ | : [[API C_PerksActivities.GetTrackedPerksActivities|C_PerksActivities.GetTrackedPerksActivities]]() : <span class="apiret">trackedPerksActivities</span> |
||
+ | : [[API C_PerksActivities.RemoveTrackedPerksActivity|C_PerksActivities.RemoveTrackedPerksActivity]](<span class="apiarg">perksActivityID</span>) |
||
+ | : [[API C_PerksProgram.ClearFrozenPerksVendorItem|C_PerksProgram.ClearFrozenPerksVendorItem]]() |
||
+ | : [[API C_PerksProgram.CloseInteraction|C_PerksProgram.CloseInteraction]]() |
||
+ | : [[API C_PerksProgram.GetAvailableCategoryIDs|C_PerksProgram.GetAvailableCategoryIDs]]() : <span class="apiret">categoryIDs</span> |
||
+ | : [[API C_PerksProgram.GetAvailableVendorItemIDs|C_PerksProgram.GetAvailableVendorItemIDs]]() : <span class="apiret">vendorItemIDs</span> |
||
+ | : [[API C_PerksProgram.GetCategoryInfo|C_PerksProgram.GetCategoryInfo]](<span class="apiarg">categoryID</span>) : <span class="apiret">categoryInfo</span> |
||
+ | : [[API C_PerksProgram.GetCurrencyAmount|C_PerksProgram.GetCurrencyAmount]]() : <span class="apiret">currencyAmount</span> |
||
+ | : [[API C_PerksProgram.GetDraggedPerksVendorItem|C_PerksProgram.GetDraggedPerksVendorItem]]() : <span class="apiret">perksVendorItemID</span> |
||
+ | : [[API C_PerksProgram.GetFrozenPerksVendorItemInfo|C_PerksProgram.GetFrozenPerksVendorItemInfo]]() : <span class="apiret">vendorItemInfo</span> |
||
+ | : [[API C_PerksProgram.GetPendingChestRewards|C_PerksProgram.GetPendingChestRewards]]() : <span class="apiret">pendingRewards</span> |
||
+ | : [[API C_PerksProgram.GetPerksProgramItemDisplayInfo|C_PerksProgram.GetPerksProgramItemDisplayInfo]](<span class="apiarg">id</span>) : <span class="apiret">item</span> |
||
+ | : [[API C_PerksProgram.GetTimeRemaining|C_PerksProgram.GetTimeRemaining]](<span class="apiarg">vendorItemID</span>) : <span class="apiret">timeRemaining</span> |
||
+ | : [[API C_PerksProgram.GetVendorItemInfoRefundTimeLeft|C_PerksProgram.GetVendorItemInfoRefundTimeLeft]](<span class="apiarg">vendorItemID</span>) : <span class="apiret">refundTimeRemaining</span> |
||
+ | : [[API C_PerksProgram.GetVendorItemInfo|C_PerksProgram.GetVendorItemInfo]](<span class="apiarg">vendorItemID</span>) : <span class="apiret">vendorItemInfo</span> |
||
+ | : [[API C_PerksProgram.ItemSelectedTelemetry|C_PerksProgram.ItemSelectedTelemetry]](<span class="apiarg">perksVendorItemID</span>) |
||
+ | : [[API C_PerksProgram.PickupPerksVendorItem|C_PerksProgram.PickupPerksVendorItem]](<span class="apiarg">perksVendorItemID</span>) |
||
+ | : [[API C_PerksProgram.RequestPendingChestRewards|C_PerksProgram.RequestPendingChestRewards]]() |
||
+ | : [[API C_PerksProgram.RequestPurchase|C_PerksProgram.RequestPurchase]](<span class="apiarg">perksVendorItemID</span>) |
||
+ | : [[API C_PerksProgram.RequestRefund|C_PerksProgram.RequestRefund]](<span class="apiarg">perksVendorItemID</span>) |
||
+ | : [[API C_PerksProgram.ResetHeldItemDragAndDrop|C_PerksProgram.ResetHeldItemDragAndDrop]]() |
||
+ | : [[API C_PerksProgram.SetFrozenPerksVendorItem|C_PerksProgram.SetFrozenPerksVendorItem]]() |
||
+ | |||
+ | ===Traits=== |
||
+ | : [[API C_Traits.CanPurchaseRank|C_Traits.CanPurchaseRank]](<span class="apiarg">configID, nodeID, nodeEntryID</span>) : <span class="apiret">canPurchase</span> |
||
+ | : [[API C_Traits.CanRefundRank|C_Traits.CanRefundRank]](<span class="apiarg">configID, nodeID</span>) : <span class="apiret">canRefund</span> |
||
+ | : [[API C_Traits.CascadeRepurchaseRanks|C_Traits.CascadeRepurchaseRanks]](<span class="apiarg">configID, nodeID</span>) : <span class="apiret">success</span> |
||
+ | : [[API C_Traits.ClearCascadeRepurchaseHistory|C_Traits.ClearCascadeRepurchaseHistory]](<span class="apiarg">configID</span>) |
||
+ | : [[API C_Traits.CloseTraitSystemInteraction|C_Traits.CloseTraitSystemInteraction]]() |
||
+ | : [[API C_Traits.CommitConfig|C_Traits.CommitConfig]](<span class="apiarg">configID</span>) : <span class="apiret">success</span> |
||
+ | : [[API C_Traits.ConfigHasStagedChanges|C_Traits.ConfigHasStagedChanges]](<span class="apiarg">configID</span>) : <span class="apiret">hasChanges</span> |
||
+ | : [[API C_Traits.GenerateInspectImportString|C_Traits.GenerateInspectImportString]](<span class="apiarg">target</span>) : <span class="apiret">importString</span> |
||
+ | : [[API C_Traits.GetConditionInfo|C_Traits.GetConditionInfo]](<span class="apiarg">configID, condID</span>) : <span class="apiret">condInfo</span> |
||
+ | : [[API C_Traits.GetConfigIDBySystemID|C_Traits.GetConfigIDBySystemID]](<span class="apiarg">systemID</span>) : <span class="apiret">configID</span> |
||
+ | : [[API C_Traits.GetConfigIDByTreeID|C_Traits.GetConfigIDByTreeID]](<span class="apiarg">treeID</span>) : <span class="apiret">configID</span> |
||
+ | : [[API C_Traits.GetConfigInfo|C_Traits.GetConfigInfo]](<span class="apiarg">configID</span>) : <span class="apiret">configInfo</span> |
||
+ | : [[API C_Traits.GetConfigsByType|C_Traits.GetConfigsByType]](<span class="apiarg">configType</span>) : <span class="apiret">configIDs</span> |
||
+ | : [[API C_Traits.GetDefinitionInfo|C_Traits.GetDefinitionInfo]](<span class="apiarg">definitionID</span>) : <span class="apiret">definitionInfo</span> |
||
+ | : [[API C_Traits.GetEntryInfo|C_Traits.GetEntryInfo]](<span class="apiarg">configID, entryID</span>) : <span class="apiret">entryInfo</span> |
||
+ | : [[API C_Traits.GetLoadoutSerializationVersion|C_Traits.GetLoadoutSerializationVersion]]() : <span class="apiret">serializationVersion</span> |
||
+ | : [[API C_Traits.GetNodeCost|C_Traits.GetNodeCost]](<span class="apiarg">configID, nodeID</span>) : <span class="apiret">costs</span> |
||
+ | : [[API C_Traits.GetNodeInfo|C_Traits.GetNodeInfo]](<span class="apiarg">configID, nodeID</span>) : <span class="apiret">nodeInfo</span> |
||
+ | : [[API C_Traits.GetStagedChangesCost|C_Traits.GetStagedChangesCost]](<span class="apiarg">configID</span>) : <span class="apiret">costs</span> |
||
+ | : [[API C_Traits.GetStagedPurchases|C_Traits.GetStagedPurchases]](<span class="apiarg">configID</span>) : <span class="apiret">nodeIDsWithPurchases</span> |
||
+ | : [[API C_Traits.GetTraitCurrencyInfo|C_Traits.GetTraitCurrencyInfo]](<span class="apiarg">traitCurrencyID</span>) : <span class="apiret">flags, type, currencyTypesID, icon</span> |
||
+ | : [[API C_Traits.GetTraitDescription|C_Traits.GetTraitDescription]](<span class="apiarg">entryID, rank</span>) : <span class="apiret">description</span> |
||
+ | : [[API C_Traits.GetTraitSystemFlags|C_Traits.GetTraitSystemFlags]](<span class="apiarg">configID</span>) : <span class="apiret">flags</span> |
||
+ | : [[API C_Traits.GetTraitSystemWidgetSetID|C_Traits.GetTraitSystemWidgetSetID]](<span class="apiarg">configID</span>) : <span class="apiret">uiWidgetSetID</span> |
||
+ | : [[API C_Traits.GetTreeCurrencyInfo|C_Traits.GetTreeCurrencyInfo]](<span class="apiarg">configID, treeID, excludeStagedChanges</span>) : <span class="apiret">treeCurrencyInfo</span> |
||
+ | : [[API C_Traits.GetTreeHash|C_Traits.GetTreeHash]](<span class="apiarg">treeID</span>) : <span class="apiret">result</span> |
||
+ | : [[API C_Traits.GetTreeInfo|C_Traits.GetTreeInfo]](<span class="apiarg">configID, treeID</span>) : <span class="apiret">treeInfo</span> |
||
+ | : [[API C_Traits.GetTreeNodes|C_Traits.GetTreeNodes]](<span class="apiarg">treeID</span>) : <span class="apiret">nodeIDs</span> |
||
+ | : [[API C_Traits.HasValidInspectData|C_Traits.HasValidInspectData]]() : <span class="apiret">hasValidInspectData</span> |
||
+ | : [[API C_Traits.IsReadyForCommit|C_Traits.IsReadyForCommit]]() : <span class="apiret">isReadyForCommit</span> |
||
+ | : [[API C_Traits.PurchaseRank|C_Traits.PurchaseRank]](<span class="apiarg">configID, nodeID</span>) : <span class="apiret">success</span> |
||
+ | : [[API C_Traits.RefundAllRanks|C_Traits.RefundAllRanks]](<span class="apiarg">configID, nodeID</span>) : <span class="apiret">success</span> |
||
+ | : [[API C_Traits.RefundRank|C_Traits.RefundRank]](<span class="apiarg">configID, nodeID</span>) : <span class="apiret">success</span> |
||
+ | : [[API C_Traits.ResetTree|C_Traits.ResetTree]](<span class="apiarg">configID, treeID</span>) : <span class="apiret">success</span> |
||
+ | : [[API C_Traits.ResetTreeByCurrency|C_Traits.ResetTreeByCurrency]](<span class="apiarg">configID, treeID, traitCurrencyID</span>) : <span class="apiret">success</span> |
||
+ | : [[API C_Traits.RollbackConfig|C_Traits.RollbackConfig]](<span class="apiarg">configID</span>) : <span class="apiret">success</span> |
||
+ | : [[API C_Traits.SetSelection|C_Traits.SetSelection]](<span class="apiarg">configID, nodeID [, nodeEntryID]</span>) : <span class="apiret">success</span> |
||
+ | : [[API C_Traits.StageConfig|C_Traits.StageConfig]](<span class="apiarg">configID</span>) : <span class="apiret">success</span> |
||
+ | : [[API C_Traits.TalentTestUnlearnSpells|C_Traits.TalentTestUnlearnSpells]]() |
||
+ | |||
+ | ===Profession Specs=== |
||
+ | : [[API C_ProfSpecs.CanRefundPath|C_ProfSpecs.CanRefundPath]](<span class="apiarg">pathID, configID</span>) : <span class="apiret">canRefund</span> |
||
+ | : [[API C_ProfSpecs.CanUnlockTab|C_ProfSpecs.CanUnlockTab]](<span class="apiarg">tabTreeID, configID</span>) : <span class="apiret">canUnlock</span> |
||
+ | : [[API C_ProfSpecs.GetChildrenForPath|C_ProfSpecs.GetChildrenForPath]](<span class="apiarg">pathID</span>) : <span class="apiret">childIDs</span> |
||
+ | : [[API C_ProfSpecs.GetConfigIDForSkillLine|C_ProfSpecs.GetConfigIDForSkillLine]](<span class="apiarg">skillLineID</span>) : <span class="apiret">configID</span> |
||
+ | : [[API C_ProfSpecs.GetCurrencyInfoForSkillLine|C_ProfSpecs.GetCurrencyInfoForSkillLine]](<span class="apiarg">skillLineID</span>) : <span class="apiret">info</span> |
||
+ | : [[API C_ProfSpecs.GetDefaultSpecSkillLine|C_ProfSpecs.GetDefaultSpecSkillLine]]() : <span class="apiret">defaultSpecSkillLine</span> |
||
+ | : [[API C_ProfSpecs.GetDescriptionForPath|C_ProfSpecs.GetDescriptionForPath]](<span class="apiarg">pathID</span>) : <span class="apiret">description</span> |
||
+ | : [[API C_ProfSpecs.GetDescriptionForPerk|C_ProfSpecs.GetDescriptionForPerk]](<span class="apiarg">perkID</span>) : <span class="apiret">description</span> |
||
+ | : [[API C_ProfSpecs.GetEntryIDForPerk|C_ProfSpecs.GetEntryIDForPerk]](<span class="apiarg">perkID</span>) : <span class="apiret">entryID</span> |
||
+ | : [[API C_ProfSpecs.GetPerksForPath|C_ProfSpecs.GetPerksForPath]](<span class="apiarg">pathID</span>) : <span class="apiret">perkInfos</span> |
||
+ | : [[API C_ProfSpecs.GetRootPathForTab|C_ProfSpecs.GetRootPathForTab]](<span class="apiarg">tabTreeID</span>) : <span class="apiret">rootPathID</span> |
||
+ | : [[API C_ProfSpecs.GetSourceTextForPath|C_ProfSpecs.GetSourceTextForPath]](<span class="apiarg">pathID, configID</span>) : <span class="apiret">sourceText</span> |
||
+ | : [[API C_ProfSpecs.GetSpecTabIDsForSkillLine|C_ProfSpecs.GetSpecTabIDsForSkillLine]](<span class="apiarg">skillLineID</span>) : <span class="apiret">specTabIDs</span> |
||
+ | : [[API C_ProfSpecs.GetSpecTabInfo|C_ProfSpecs.GetSpecTabInfo]]() : <span class="apiret">specTabInfo</span> |
||
+ | : [[API C_ProfSpecs.GetSpendCurrencyForPath|C_ProfSpecs.GetSpendCurrencyForPath]](<span class="apiarg">pathID</span>) : <span class="apiret">currencyID</span> |
||
+ | : [[API C_ProfSpecs.GetSpendEntryForPath|C_ProfSpecs.GetSpendEntryForPath]](<span class="apiarg">pathID</span>) : <span class="apiret">entryID</span> |
||
+ | : [[API C_ProfSpecs.GetStateForPath|C_ProfSpecs.GetStateForPath]](<span class="apiarg">pathID, configID</span>) : <span class="apiret">state</span> |
||
+ | : [[API C_ProfSpecs.GetStateForPerk|C_ProfSpecs.GetStateForPerk]](<span class="apiarg">perkID, configID</span>) : <span class="apiret">state</span> |
||
+ | : [[API C_ProfSpecs.GetStateForTab|C_ProfSpecs.GetStateForTab]](<span class="apiarg">tabTreeID, configID</span>) : <span class="apiret">tabInfo</span> |
||
+ | : [[API C_ProfSpecs.GetTabInfo|C_ProfSpecs.GetTabInfo]](<span class="apiarg">tabTreeID</span>) : <span class="apiret">tabInfo</span> |
||
+ | : [[API C_ProfSpecs.GetUnlockEntryForPath|C_ProfSpecs.GetUnlockEntryForPath]](<span class="apiarg">pathID</span>) : <span class="apiret">entryID</span> |
||
+ | : [[API C_ProfSpecs.GetUnlockRankForPerk|C_ProfSpecs.GetUnlockRankForPerk]](<span class="apiarg">perkID</span>) : <span class="apiret">unlockRank</span> |
||
+ | : [[API C_ProfSpecs.ShouldShowPointsReminder|C_ProfSpecs.ShouldShowPointsReminder]]() : <span class="apiret">showReminder</span> |
||
+ | : [[API C_ProfSpecs.ShouldShowPointsReminderForSkillLine|C_ProfSpecs.ShouldShowPointsReminderForSkillLine]](<span class="apiarg">skillLineID</span>) : <span class="apiret">showReminder</span> |
||
+ | : [[API C_ProfSpecs.ShouldShowSpecTab|C_ProfSpecs.ShouldShowSpecTab]]() : <span class="apiret">showSpecTab</span> |
||
+ | : [[API C_ProfSpecs.SkillLineHasSpecialization|C_ProfSpecs.SkillLineHasSpecialization]](<span class="apiarg">skillLineID</span>) : <span class="apiret">hasSpecialization</span> |
||
+ | |||
+ | ==Account== |
||
+ | Relates to the subscription [[Account]]. See also [[#Battle.net|Battle.net]] functions. |
||
+ | : [[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]]() |
||
: [[API IsAccountSecured|IsAccountSecured]]() - Returns if the account has been secured with [[Blizzard Mobile Authenticator]]. |
: [[API IsAccountSecured|IsAccountSecured]]() - Returns if the account has been secured with [[Blizzard Mobile Authenticator]]. |
||
: [[API IsRestrictedAccount|IsRestrictedAccount]]() - Returns if the acount has trial account restrictions. |
: [[API IsRestrictedAccount|IsRestrictedAccount]]() - Returns if the acount has trial account restrictions. |
||
− | : [[API IsTrialAccount|IsTrialAccount]]() - 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]]() - 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 |
+ | : [[API NoPlayTime|NoPlayTime]]() - Returns true if the account is considered "unhealthy" for players on Chinese realms. |
− | : [[API PartialPlayTime|PartialPlayTime]]() - Returns |
+ | : [[API PartialPlayTime|PartialPlayTime]]() - Returns true if the account is considered "tired" for players on Chinese realms. |
− | : [[API SendSubscriptionInterstitialResponse|SendSubscriptionInterstitialResponse]](<span |
+ | : [[API SendSubscriptionInterstitialResponse|SendSubscriptionInterstitialResponse]](<span class="apiarg">response</span>) |
− | == |
+ | ==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 |
+ | : [[API C_AchievementInfo.GetRewardItemID|C_AchievementInfo.GetRewardItemID]](<span class="apiarg">achievementID</span>) : <span class="apiret">rewardItemID</span> |
− | : [[API C_AchievementInfo.GetSupercedingAchievements|C_AchievementInfo.GetSupercedingAchievements]](<span |
+ | : [[API C_AchievementInfo.GetSupercedingAchievements|C_AchievementInfo.GetSupercedingAchievements]](<span class="apiarg">achievementID</span>) : <span class="apiret">supercedingAchievements</span> - Returns the next achievement in a series. |
− | : [[API C_AchievementInfo.IsValidAchievement|C_AchievementInfo.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 |
+ | : [[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 style="font-size:smaller; color:#ecbc2a">achievementId</span>) - Add an achievement to tracking. |
||
: [[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. |
||
: [[API ClearAchievementComparisonUnit|ClearAchievementComparisonUnit]]() - Remove the unit being compared. |
: [[API ClearAchievementComparisonUnit|ClearAchievementComparisonUnit]]() - Remove the unit being compared. |
||
: [[API ClearAchievementSearchString|ClearAchievementSearchString]]() |
: [[API ClearAchievementSearchString|ClearAchievementSearchString]]() |
||
− | : [[API GetAchievementCategory|GetAchievementCategory]](<span |
+ | : [[API GetAchievementCategory|GetAchievementCategory]](<span class="apiarg">achievementID</span>) - Returns the category number the requested achievement belongs to. |
− | : [[API GetAchievementComparisonInfo|GetAchievementComparisonInfo]](<span |
+ | : [[API GetAchievementComparisonInfo|GetAchievementComparisonInfo]](<span class="apiarg">achievementID</span>) - Returns information about the comparison unit's achievements. |
− | : [[API GetAchievementCriteriaInfo|GetAchievementCriteriaInfo]](<span |
+ | : [[API GetAchievementCriteriaInfo|GetAchievementCriteriaInfo]](<span class="apiarg">achievementID, criteriaNum</span>) - Returns info for the specified achievement criteria. |
− | : [[API GetAchievementCriteriaInfoByID|GetAchievementCriteriaInfoByID]](<span |
+ | : [[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 |
+ | : [[API GetAchievementInfo|GetAchievementInfo]](<span class="apiarg">achievementID or categoryID, index</span>) - Returns info for an achievement. |
− | : [[API GetAchievementLink|GetAchievementLink]](<span |
+ | : [[API GetAchievementLink|GetAchievementLink]](<span class="apiarg">achievementID</span>) - Returns an achievement link. |
− | : [[API GetAchievementNumCriteria|GetAchievementNumCriteria]](<span |
+ | : [[API GetAchievementNumCriteria|GetAchievementNumCriteria]](<span class="apiarg">achievementID</span>) - Returns the number of criteria for an achievement. |
− | : [[API GetAchievementNumRewards|GetAchievementNumRewards]](<span |
+ | : [[API GetAchievementNumRewards|GetAchievementNumRewards]](<span class="apiarg">achievementID</span>) - Returns the number of rewards the requested achievement has. |
− | : [[API GetAchievementReward|GetAchievementReward]](<span |
+ | : [[API GetAchievementReward|GetAchievementReward]](<span class="apiarg">achievementID, rewardIndex</span>) - Returns information about a reward item by rewardIndex. |
: [[API GetAchievementSearchProgress|GetAchievementSearchProgress]]() |
: [[API GetAchievementSearchProgress|GetAchievementSearchProgress]]() |
||
: [[API GetAchievementSearchSize|GetAchievementSearchSize]]() |
: [[API GetAchievementSearchSize|GetAchievementSearchSize]]() |
||
− | : [[API GetCategoryAchievementPoints|GetCategoryAchievementPoints]](<span |
+ | : [[API GetCategoryAchievementPoints|GetCategoryAchievementPoints]](<span class="apiarg">categoryID, includeSubCategories</span>) |
− | : [[API GetCategoryInfo|GetCategoryInfo]](<span |
+ | : [[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 |
+ | : [[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 |
+ | : [[API GetComparisonCategoryNumAchievements|GetComparisonCategoryNumAchievements]](<span class="apiarg">achievementID</span>) - Returns a number of achievements in a category for the comparison player. |
− | : [[API GetFilteredAchievementID|GetFilteredAchievementID]](<span |
+ | : [[API GetFilteredAchievementID|GetFilteredAchievementID]](<span class="apiarg">index</span>) - Returns the ID of a filtered achievement by index. |
− | : [[API GetGuildAchievementMemberInfo|GetGuildAchievementMemberInfo]](<span |
+ | : [[API GetGuildAchievementMemberInfo|GetGuildAchievementMemberInfo]](<span class="apiarg">achievementID, index</span>) |
− | : [[API GetGuildAchievementMembers|GetGuildAchievementMembers]](<span |
+ | : [[API GetGuildAchievementMembers|GetGuildAchievementMembers]](<span class="apiarg">achievementID</span>) |
− | : [[API GetGuildAchievementNumMembers|GetGuildAchievementNumMembers]](<span |
+ | : [[API GetGuildAchievementNumMembers|GetGuildAchievementNumMembers]](<span class="apiarg">achievementID</span>) |
: [[API GetLatestCompletedAchievements|GetLatestCompletedAchievements]]() - Returns the ID's of the last 5 completed Achievements. |
: [[API GetLatestCompletedAchievements|GetLatestCompletedAchievements]]() - Returns the ID's of the last 5 completed Achievements. |
||
: [[API GetLatestCompletedComparisonAchievements|GetLatestCompletedComparisonAchievements]]() - Returns a list of the latest updated achievements for the comparison player. |
: [[API GetLatestCompletedComparisonAchievements|GetLatestCompletedComparisonAchievements]]() - Returns a list of the latest updated achievements for the comparison player. |
||
− | : [[API GetNextAchievement|GetNextAchievement]](<span |
+ | : [[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 |
+ | : [[API GetNumCompletedAchievements|GetNumCompletedAchievements]]() - Returns the total and completed number of achievements. |
− | : [[API GetNumFilteredAchievements|GetNumFilteredAchievements]]() - Returns the number of achievements |
+ | : [[API GetNumFilteredAchievements|GetNumFilteredAchievements]]() - Returns the number of achievements after filtering. |
+ | : [[API GetPreviousAchievement|GetPreviousAchievement]](<span class="apiarg">achievementID</span>) - Returns the previous achievement in a chain. |
||
− | : [[API GetNumTrackedAchievements|GetNumTrackedAchievements]]() - Returns the total number of the currently tracked achievements. |
||
− | : [[API GetPreviousAchievement|GetPreviousAchievement]](<span style="font-size:smaller; color:#ecbc2a">achievementID</span>) - Returns previous related achievements. |
||
: [[API GetTotalAchievementPoints|GetTotalAchievementPoints]]() - Returns the total number of achievement points earned. |
: [[API GetTotalAchievementPoints|GetTotalAchievementPoints]]() - Returns the total number of achievement points earned. |
||
+ | : [[API HasCompletedAnyAchievement|HasCompletedAnyAchievement]](<span class="apiarg">achievementID</span>) |
||
− | : [[API GetTrackedAchievements|GetTrackedAchievements]]() - Returns the achievementID of the currently tracked achievements. |
||
− | : [[API |
+ | : [[API IsAchievementEligible|IsAchievementEligible]](<span class="apiarg">achievementID</span>) |
+ | : [[API SetAchievementComparisonUnit|SetAchievementComparisonUnit]](<span class="apiarg">unitId</span>) - Sets the unit to be compared to. |
||
− | : [[API IsAchievementEligible|IsAchievementEligible]](<span style="font-size:smaller; color:#ecbc2a">achievementID</span>) |
||
+ | : [[API SetAchievementSearchString|SetAchievementSearchString]](<span class="apiarg">searchText</span>) - Starts a search for achievements containing the specified text. |
||
− | : [[API IsTrackedAchievement|IsTrackedAchievement]](<span style="font-size:smaller; color:#ecbc2a">achievementID</span>) |
||
− | : [[API |
+ | : [[API SetFocusedAchievement|SetFocusedAchievement]](<span class="apiarg">achievementID</span>) |
− | : [[API SetAchievementComparisonUnit|SetAchievementComparisonUnit]](<span style="font-size:smaller; color:#ecbc2a">unitId</span>) - Set the unit to be compared to. |
||
− | : [[API SetAchievementSearchString|SetAchievementSearchString]](<span style="font-size:smaller; color:#ecbc2a">searchText</span>) - Starts a search for achievements containing the specified text. |
||
− | : [[API SetFocusedAchievement|SetFocusedAchievement]](<span style="font-size:smaller; color:#ecbc2a">achievementID</span>) |
||
: [[API ShowAccountAchievements|ShowAccountAchievements]]() |
: [[API ShowAccountAchievements|ShowAccountAchievements]]() |
||
− | : [[API SwitchAchievementSearchTab|SwitchAchievementSearchTab]](<span |
+ | : [[API SwitchAchievementSearchTab|SwitchAchievementSearchTab]](<span class="apiarg">index</span>) |
+ | |||
− | These functions relate to Statistics. |
||
+ | ===Statistics=== |
||
− | : [[API GetComparisonStatistic|GetComparisonStatistic]](<span style="font-size:smaller; color:#ecbc2a">achievementID</span>) - Returns the value of the requested statistic for the comparison player. |
||
+ | : [[API GetComparisonStatistic|GetComparisonStatistic]](<span 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 |
+ | : [[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== |
+ | Relates to [[AddOn]]s. |
||
− | : [[API C_ActionBar.GetBonusBarIndexForSlot|C_ActionBar.GetBonusBarIndexForSlot]](<span style="font-size:smaller; color:#ecbc2a">slotID</span>) |
||
+ | : [[API DisableAddOn|DisableAddOn]](<span class="apiarg">indexOrName [, characterOrAll]</span>) - Disables an addon for subsequent sessions. |
||
− | : [[API C_ActionBar.IsHarmfulAction|C_ActionBar.IsHarmfulAction]](<span style="font-size:smaller; color:#ecbc2a">actionID, useNeutral</span>) |
||
+ | : [[API DisableAllAddOns|DisableAllAddOns]](<span class="apiarg">[character]</span>) - Disable all AddOns for subsequent sessions. |
||
− | : [[API C_ActionBar.IsHelpfulAction|C_ActionBar.IsHelpfulAction]](<span style="font-size:smaller; color:#ecbc2a">actionID, useNeutral</span>) |
||
+ | : [[API EnableAddOn|EnableAddOn]](<span class="apiarg">indexOrName [, characterOrAll]</span>) - Enables an addon for subsequent sessions. |
||
− | : [[API C_ActionBar.IsOnBarOrSpecialBar|C_ActionBar.IsOnBarOrSpecialBar]](<span style="font-size:smaller; color:#ecbc2a">spellID</span>) |
||
+ | : [[API EnableAllAddOns|EnableAllAddOns]](<span class="apiarg">[character]</span>) - Enable all AddOns for subsequent sessions. |
||
− | : [[API C_ActionBar.PutActionInSlot|C_ActionBar.PutActionInSlot]](<span style="font-size:smaller; color:#ecbc2a">slotID</span>) |
||
+ | : [[API GetAddOnDependencies|GetAddOnDependencies]](<span class="apiarg">addonIndex or AddOnName</span>) - Returns the TOC dependencies of an addon. |
||
− | : [[API C_ActionBar.ShouldOverrideBarShowHealthBar|C_ActionBar.ShouldOverrideBarShowHealthBar]]() |
||
+ | : [[API GetAddOnEnableState|GetAddOnEnableState]](<span class="apiarg">[character], addonIndex or AddOnName</span>) |
||
− | : [[API C_ActionBar.ShouldOverrideBarShowManaBar|C_ActionBar.ShouldOverrideBarShowManaBar]]() |
||
− | : |
+ | : [[API GetAddOnInfo|GetAddOnInfo]](<span class="apiarg">addonIndex or AddOnName</span>) - Get information about an AddOn. |
+ | : [[API GetAddOnOptionalDependencies|GetAddOnOptionalDependencies]](<span class="apiarg">addonIndex or AddOnName</span>) - Returns a list of optional dependencies. |
||
− | : [[API GetActionBarPage|GetActionBarPage]]() - Returns the current action bar page. CURRENT_ACTIONBAR_PAGE is obsolete. |
||
− | : [[API GetActionBarToggles|GetActionBarToggles]]() - Returns the toggles for each action bar. |
||
− | : [[API GetBonusBarIndex|GetBonusBarIndex]]() |
||
− | : [[API GetBonusBarOffset|GetBonusBarOffset]]() - Determine which page of bonus actions to show. |
||
− | : [[API GetExtraBarIndex|GetExtraBarIndex]]() |
||
− | : [[API GetMultiCastBarIndex|GetMultiCastBarIndex]]() |
||
− | : [[API GetOverrideBarIndex|GetOverrideBarIndex]]() |
||
− | : [[API GetOverrideBarSkin|GetOverrideBarSkin]]() |
||
− | : [[API GetTempShapeshiftBarIndex|GetTempShapeshiftBarIndex]]() |
||
− | : [[API GetVehicleBarIndex|GetVehicleBarIndex]]() |
||
− | : [[API HasBonusActionBar|HasBonusActionBar]]() |
||
− | : [[API HasExtraActionBar|HasExtraActionBar]]() |
||
− | : [[API HasOverrideActionBar|HasOverrideActionBar]]() |
||
− | : [[API HasTempShapeshiftActionBar|HasTempShapeshiftActionBar]]() |
||
− | : [[API HasVehicleActionBar|HasVehicleActionBar]]() |
||
− | : [[API IsPossessBarVisible|IsPossessBarVisible]]() |
||
− | : [[API PetHasActionBar|PetHasActionBar]]() - Determine if player has a pet with an action bar. |
||
− | : [[API SetActionBarToggles|SetActionBarToggles]](<span style="font-size:smaller; color:#ecbc2a">show1, show2, show3, show4 [, alwaysShow]</span>) - Set show toggle for each action bar. |
||
− | |||
− | ==== Action Buttons ==== |
||
− | : [[API C_ActionBar.FindPetActionButtons|C_ActionBar.FindPetActionButtons]](<span style="font-size:smaller; color:#ecbc2a">petActionID</span>) |
||
− | : [[API C_ActionBar.FindSpellActionButtons|C_ActionBar.FindSpellActionButtons]](<span style="font-size:smaller; color:#ecbc2a">spellID</span>) |
||
− | : [[API C_ActionBar.GetPetActionPetBarIndices|C_ActionBar.GetPetActionPetBarIndices]](<span style="font-size:smaller; color:#ecbc2a">petActionID</span>) |
||
− | : [[API C_ActionBar.HasPetActionButtons|C_ActionBar.HasPetActionButtons]](<span style="font-size:smaller; color:#ecbc2a">petActionID</span>) |
||
− | : [[API C_ActionBar.HasPetActionPetBarIndices|C_ActionBar.HasPetActionPetBarIndices]](<span style="font-size:smaller; color:#ecbc2a">petActionID</span>) |
||
− | : [[API C_ActionBar.HasSpellActionButtons|C_ActionBar.HasSpellActionButtons]](<span style="font-size:smaller; color:#ecbc2a">spellID</span>) |
||
− | : [[API C_ActionBar.IsAutoCastPetAction|C_ActionBar.IsAutoCastPetAction]](<span style="font-size:smaller; color:#ecbc2a">slotID</span>) |
||
− | : [[API C_ActionBar.IsEnabledAutoCastPetAction|C_ActionBar.IsEnabledAutoCastPetAction]](<span style="font-size:smaller; color:#ecbc2a">slotID</span>) |
||
− | : [[API C_ActionBar.ToggleAutoCastPetAction|C_ActionBar.ToggleAutoCastPetAction]](<span style="font-size:smaller; color:#ecbc2a">slotID</span>) |
||
− | : [[API ActionHasRange|ActionHasRange]](<span style="font-size:smaller; color:#ecbc2a">slot</span>) - Determine if the specified action is a range restriction (1 if yes, nil if no) |
||
− | : [[API ClickWorldMapActionButton|ClickWorldMapActionButton]]() |
||
− | : [[API GetActionAutocast|GetActionAutocast]](<span style="font-size:smaller; color:#ecbc2a">slot</span>) |
||
− | : [[API GetActionCharges|GetActionCharges]](<span style="font-size:smaller; color:#ecbc2a">slot</span>) - Returns information about the charges of a charge-accumulating player ability. |
||
− | : [[API GetActionCooldown|GetActionCooldown]](<span style="font-size:smaller; color:#ecbc2a">slot</span>) - This returns the cooldown values of the specified action. |
||
− | : [[API GetActionCount|GetActionCount]](<span style="font-size:smaller; color:#ecbc2a">slot</span>) - Get the count (bandage/potion/etc) for an action, returns 0 if none or not applicable. |
||
− | : [[API GetActionInfo|GetActionInfo]](<span style="font-size:smaller; color:#ecbc2a">slot</span>) - Returns type, id, subtype. |
||
− | : [[API GetActionTexture|GetActionTexture]](<span style="font-size:smaller; color:#ecbc2a">slot</span>) - Gets the texture path for the specified action. |
||
− | : [[API GetActionText|GetActionText]](<span style="font-size:smaller; color:#ecbc2a">slot</span>) - Get the text label (macros, etc) for an action, returns nil if none. |
||
− | : [[API GetPossessInfo|GetPossessInfo]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Returns texture, name, enabled. |
||
− | : [[API GetWorldMapActionButtonSpellInfo|GetWorldMapActionButtonSpellInfo]]() |
||
− | : [[API HasAction|HasAction]](<span style="font-size:smaller; color:#ecbc2a">slot</span>) - Returns 1 if the player has an action in the specified slot, nil otherwise. |
||
− | : [[API IsActionInRange|IsActionInRange]](<span style="font-size:smaller; color:#ecbc2a">slot</span>) - Test if an action is in range (1=yes, 0=no, nil=not applicable). |
||
− | : [[API IsAttackAction|IsAttackAction]](<span style="font-size:smaller; color:#ecbc2a">slot</span>) - Returns 1 if an action is an 'attack' action (flashes during combat), nil otherwise. |
||
− | : [[API IsAutoRepeatAction|IsAutoRepeatAction]](<span style="font-size:smaller; color:#ecbc2a">slot</span>) - Returns 1 if an action is auto-repeating, nil otherwise. |
||
− | : [[API IsConsumableAction|IsConsumableAction]](<span style="font-size:smaller; color:#ecbc2a">slot</span>) - Returns 1 if an action is consumable (i.e. has a count), nil otherwise. |
||
− | : [[API IsCurrentAction|IsCurrentAction]](<span style="font-size:smaller; color:#ecbc2a">slot</span>) - Returns 1 if an action is the one currently underway, nil otherwise. |
||
− | : [[API IsEquippedAction|IsEquippedAction]](<span style="font-size:smaller; color:#ecbc2a">slot</span>) - Returns 1 if an action is equipped (i.e. connected to an item that must be equipped), nil otherwise. |
||
− | : [[API IsItemAction|IsItemAction]](<span style="font-size:smaller; color:#ecbc2a">slot</span>) |
||
− | : [[API IsPetAttackAction|IsPetAttackAction]](<span style="font-size:smaller; color:#ecbc2a">index</span>) |
||
− | : [[API IsStackableAction|IsStackableAction]](<span style="font-size:smaller; color:#ecbc2a">slot</span>) |
||
− | : [[API IsUsableAction|IsUsableAction]](<span style="font-size:smaller; color:#ecbc2a">slot</span>) - Returns 1 if an action can be used at present, nil otherwise. |
||
− | : [[API SetActionUIButton|SetActionUIButton]](<span style="font-size:smaller; color:#ecbc2a">checkboxFrame, actionSlot, cooldownFrame</span>) |
||
− | : [[API SetSpellbookPetAction|SetSpellbookPetAction]](<span style="font-size:smaller; color:#ecbc2a">slot, target</span>) |
||
− | : PROTECTED [[API UseAction|UseAction]](<span style="font-size:smaller; color:#ecbc2a">slot [, checkCursor, onSelf]</span>) - This instructs the interface to use the action associated with the specified ID, optionally on the player (regardless of target). |
||
− | : [[API UseWorldMapActionButtonSpellOnQuest|UseWorldMapActionButtonSpellOnQuest]]() |
||
− | These functions relate to Flyout Buttons. |
||
− | : [[API C_ActionBar.FindFlyoutActionButtons|C_ActionBar.FindFlyoutActionButtons]](<span style="font-size:smaller; color:#ecbc2a">flyoutID</span>) |
||
− | : [[API C_ActionBar.HasFlyoutActionButtons|C_ActionBar.HasFlyoutActionButtons]](<span style="font-size:smaller; color:#ecbc2a">flyoutID</span>) |
||
− | : [[API FindFlyoutSlotBySpellID|FindFlyoutSlotBySpellID]](<span style="font-size:smaller; color:#ecbc2a">spellID</span>) |
||
− | : [[API FlyoutHasSpell|FlyoutHasSpell]](<span style="font-size:smaller; color:#ecbc2a">flyoutID, spellID</span>) |
||
− | : [[API GetFlyoutID|GetFlyoutID]](<span style="font-size:smaller; color:#ecbc2a">index</span>) |
||
− | : [[API GetFlyoutInfo|GetFlyoutInfo]](<span style="font-size:smaller; color:#ecbc2a">flyoutID</span>) |
||
− | : [[API GetFlyoutSlotInfo|GetFlyoutSlotInfo]](<span style="font-size:smaller; color:#ecbc2a">flyoutID, slot</span>) |
||
− | : [[API GetNumFlyouts|GetNumFlyouts]]() |
||
− | |||
− | === AddOns === |
||
− | These functions relate to [[AddOn]]s. |
||
− | : [[API DisableAddOn|DisableAddOn]](<span style="font-size:smaller; color:#ecbc2a">addonIndex or AddOnName [, character]</span>) - Disable the specified AddOn for subsequent sessions. |
||
− | : [[API DisableAllAddOns|DisableAllAddOns]](<span style="font-size:smaller; color:#ecbc2a">[character]</span>) - Disable all AddOns for subsequent sessions. |
||
− | : [[API EnableAddOn|EnableAddOn]](<span style="font-size:smaller; color:#ecbc2a">addonIndex or AddOnName [, character]</span>) - Enable the specified AddOn for subsequent sessions. |
||
− | : [[API EnableAllAddOns|EnableAllAddOns]](<span style="font-size:smaller; color:#ecbc2a">[character]</span>) - Enable all AddOns for subsequent sessions. |
||
− | : [[API GetAddOnDependencies|GetAddOnDependencies]](<span style="font-size:smaller; color:#ecbc2a">addonIndex or AddOnName</span>) - Get dependency list for an AddOn. |
||
− | : [[API GetAddOnEnableState|GetAddOnEnableState]](<span style="font-size:smaller; color:#ecbc2a">[character], addonIndex or AddOnName</span>) |
||
− | : [[API GetAddOnInfo|GetAddOnInfo]](<span style="font-size:smaller; color:#ecbc2a">addonIndex or AddOnName</span>) - Get information about an AddOn. |
||
− | : [[API GetAddOnMetadata|GetAddOnMetadata]](<span style="font-size:smaller; color:#ecbc2a">addonIndex or AddOnName, variable</span>) - Retrieve metadata from addon's TOC file. |
||
− | : [[API GetAddOnOptionalDependencies|GetAddOnOptionalDependencies]](<span style="font-size:smaller; color:#ecbc2a">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 |
+ | : [[API IsAddOnLoaded|IsAddOnLoaded]](<span class="apiarg">addonIndex or AddOnName</span>) - Returns true if the specified addon is loaded. |
− | : [[API IsAddOnLoadOnDemand|IsAddOnLoadOnDemand]](<span |
+ | : [[API IsAddOnLoadOnDemand|IsAddOnLoadOnDemand]](<span class="apiarg">addonIndex or AddOnName</span>) - Returns true if the specified addon is load-on-demand. |
: [[API IsAddonVersionCheckEnabled|IsAddonVersionCheckEnabled]]() |
: [[API IsAddonVersionCheckEnabled|IsAddonVersionCheckEnabled]]() |
||
− | : [[API LoadAddOn|LoadAddOn]](<span |
+ | : [[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 |
+ | : [[API SetAddonVersionCheck|SetAddonVersionCheck]](<span class="apiarg">boolean</span>) |
− | : |
+ | : [[API UIParentLoadAddOn|UIParentLoadAddOn]](<span class="apiarg">AddOnName</span>) {{apitag|framexml}} - 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]] |
+ | The [[Adventure Guide]] was added in [[Patch 6.2.0]] |
− | : [[API C_AdventureJournal.ActivateEntry|C_AdventureJournal.ActivateEntry]](<span |
+ | : [[API C_AdventureJournal.ActivateEntry|C_AdventureJournal.ActivateEntry]](<span class="apiarg">index</span>) |
: [[API C_AdventureJournal.CanBeShown|C_AdventureJournal.CanBeShown]]() |
: [[API C_AdventureJournal.CanBeShown|C_AdventureJournal.CanBeShown]]() |
||
: [[API C_AdventureJournal.GetNumAvailableSuggestions|C_AdventureJournal.GetNumAvailableSuggestions]]() |
: [[API C_AdventureJournal.GetNumAvailableSuggestions|C_AdventureJournal.GetNumAvailableSuggestions]]() |
||
: [[API C_AdventureJournal.GetPrimaryOffset|C_AdventureJournal.GetPrimaryOffset]]() |
: [[API C_AdventureJournal.GetPrimaryOffset|C_AdventureJournal.GetPrimaryOffset]]() |
||
: [[API C_AdventureJournal.GetReward|C_AdventureJournal.GetReward]]() |
: [[API C_AdventureJournal.GetReward|C_AdventureJournal.GetReward]]() |
||
− | : [[API C_AdventureJournal.GetSuggestions|C_AdventureJournal.GetSuggestions]](<span |
+ | : [[API C_AdventureJournal.GetSuggestions|C_AdventureJournal.GetSuggestions]](<span class="apiarg">[suggestions]</span>) |
− | : [[API C_AdventureJournal.SetPrimaryOffset|C_AdventureJournal.SetPrimaryOffset]](<span |
+ | : [[API C_AdventureJournal.SetPrimaryOffset|C_AdventureJournal.SetPrimaryOffset]](<span class="apiarg">offset</span>) |
− | : [[API C_AdventureJournal.UpdateSuggestions|C_AdventureJournal.UpdateSuggestions]](<span |
+ | : [[API C_AdventureJournal.UpdateSuggestions|C_AdventureJournal.UpdateSuggestions]](<span class="apiarg">[levelUp]</span>) |
− | === |
+ | ===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 |
+ | : [[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.GetEncountersOnMap|C_EncounterJournal.GetEncountersOnMap]](<span |
+ | : [[API C_EncounterJournal.GetEncountersOnMap|C_EncounterJournal.GetEncountersOnMap]](<span class="apiarg">uiMapID</span>) : <span class="apiret">encounters</span> - Returns boss pin locations for an instance map. |
− | : [[API C_EncounterJournal.GetSectionIconFlags|C_EncounterJournal.GetSectionIconFlags]](<span |
+ | : [[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 |
+ | : [[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 |
+ | : [[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.IsEncounterComplete|C_EncounterJournal.IsEncounterComplete]](<span |
+ | : [[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 |
+ | : [[API C_EncounterJournal.SetPreviewMythicPlusLevel|C_EncounterJournal.SetPreviewMythicPlusLevel]](<span class="apiarg">level</span>) |
− | : [[API C_EncounterJournal.SetPreviewPvpTier|C_EncounterJournal.SetPreviewPvpTier]](<span |
+ | : [[API C_EncounterJournal.SetPreviewPvpTier|C_EncounterJournal.SetPreviewPvpTier]](<span class="apiarg">tier</span>) |
− | : [[API C_RaidLocks.IsEncounterComplete|C_RaidLocks.IsEncounterComplete]](<span |
+ | : [[API C_RaidLocks.IsEncounterComplete|C_RaidLocks.IsEncounterComplete]](<span class="apiarg">mapID, encounterID [, difficultyID]</span>) : <span class="apiret">encounterIsComplete</span> |
: [[API EJ_ClearSearch|EJ_ClearSearch]]() - Clears the encounter journal search results. |
: [[API EJ_ClearSearch|EJ_ClearSearch]]() - Clears the encounter journal search results. |
||
: [[API EJ_EndSearch|EJ_EndSearch]]() - Ends any active encounter journal search. |
: [[API EJ_EndSearch|EJ_EndSearch]]() - Ends any active encounter journal search. |
||
: [[API EJ_GetContentTuningID|EJ_GetContentTuningID]]() - Returns the currently selected content tuning ID for BFA instances. |
: [[API EJ_GetContentTuningID|EJ_GetContentTuningID]]() - Returns the currently selected content tuning ID for BFA instances. |
||
− | : [[API EJ_GetCreatureInfo|EJ_GetCreatureInfo]](<span |
+ | : [[API EJ_GetCreatureInfo|EJ_GetCreatureInfo]](<span class="apiarg">index [, encounterID]</span>) - Returns encounter boss info. |
: [[API EJ_GetCurrentTier|EJ_GetCurrentTier]]() - Returns the currently active encounter journal tier index. |
: [[API EJ_GetCurrentTier|EJ_GetCurrentTier]]() - Returns the currently active encounter journal tier index. |
||
: [[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 |
+ | : [[API EJ_GetEncounterInfo|EJ_GetEncounterInfo]](<span class="apiarg">encounterID</span>) - Returns encounter info from the journal. |
− | : [[API EJ_GetEncounterInfoByIndex|EJ_GetEncounterInfoByIndex]](<span |
+ | : [[API EJ_GetEncounterInfoByIndex|EJ_GetEncounterInfoByIndex]](<span class="apiarg">index [, journalInstanceID]</span>) - idem |
− | : [[API EJ_GetInstanceByIndex|EJ_GetInstanceByIndex]](<span |
+ | : [[API EJ_GetInstanceByIndex|EJ_GetInstanceByIndex]](<span class="apiarg">index, isRaid</span>) - Returns instance info for the Encounter Journal. |
− | : [[API EJ_GetInstanceForMap|EJ_GetInstanceForMap]](<span |
+ | : [[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 |
+ | : [[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 |
+ | : [[API EJ_GetNumEncountersForLootByIndex|EJ_GetNumEncountersForLootByIndex]](<span class="apiarg">index</span>) - Returns the amount of encounters that drop the same loot item. |
: [[API EJ_GetNumSearchResults|EJ_GetNumSearchResults]]() - Returns the number of search results for the Encounter Journal. |
: [[API EJ_GetNumSearchResults|EJ_GetNumSearchResults]]() - Returns the number of search results for the Encounter Journal. |
||
: [[API EJ_GetNumTiers|EJ_GetNumTiers]]() - Returns the number of valid encounter journal tier indices. |
: [[API EJ_GetNumTiers|EJ_GetNumTiers]]() - Returns the number of valid encounter journal tier indices. |
||
: [[API EJ_GetSearchProgress|EJ_GetSearchProgress]]() - Returns the search bar's progress ratio. |
: [[API EJ_GetSearchProgress|EJ_GetSearchProgress]]() - Returns the search bar's progress ratio. |
||
− | : [[API EJ_GetSearchResult|EJ_GetSearchResult]](<span |
+ | : [[API EJ_GetSearchResult|EJ_GetSearchResult]](<span class="apiarg">index</span>) - Returns search results for the Encounter Journal. |
: [[API EJ_GetSearchSize|EJ_GetSearchSize]]() - Returns the amount of Encounter Journal objects to search through. |
: [[API EJ_GetSearchSize|EJ_GetSearchSize]]() - Returns the amount of Encounter Journal objects to search through. |
||
− | : [[API EJ_GetSectionPath|EJ_GetSectionPath]](<span |
+ | : [[API EJ_GetSectionPath|EJ_GetSectionPath]](<span class="apiarg">sectionID</span>) - Returns the parent Section ID if available. |
− | : [[API EJ_GetTierInfo|EJ_GetTierInfo]](<span |
+ | : [[API EJ_GetTierInfo|EJ_GetTierInfo]](<span class="apiarg">index</span>) - Get some information about the encounter journal tier for index. |
− | : [[API EJ_HandleLinkPath|EJ_HandleLinkPath]](<span |
+ | : [[API EJ_HandleLinkPath|EJ_HandleLinkPath]](<span class="apiarg">jtype, id</span>) - Returns the supplementary instance and encounter ID for an encounter or section ID. |
: [[API EJ_InstanceIsRaid|EJ_InstanceIsRaid]]() - Returns whether the selected instance is a raid. |
: [[API EJ_InstanceIsRaid|EJ_InstanceIsRaid]]() - Returns whether the selected instance is a raid. |
||
: [[API EJ_IsSearchFinished|EJ_IsSearchFinished]]() - Returns whether the current search has finished. |
: [[API EJ_IsSearchFinished|EJ_IsSearchFinished]]() - Returns whether the current search has finished. |
||
− | : [[API EJ_IsValidInstanceDifficulty|EJ_IsValidInstanceDifficulty]](<span |
+ | : [[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 |
+ | : [[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 |
+ | : [[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 |
+ | : [[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 |
+ | : [[API EJ_SetDifficulty|EJ_SetDifficulty]](<span class="apiarg">difficultyID</span>) - Sets the encounter difficulty shown in the Encounter Journal. |
− | : [[API EJ_SetSearch|EJ_SetSearch]](<span |
+ | : [[API EJ_SetSearch|EJ_SetSearch]](<span class="apiarg">text</span>) - Starts a search in the journal. |
− | : [[API GetJournalInfoForSpellConfirmation|GetJournalInfoForSpellConfirmation]](<span |
+ | : [[API GetJournalInfoForSpellConfirmation|GetJournalInfoForSpellConfirmation]](<span class="apiarg">spellID</span>) |
− | : [[API SetPortraitTextureFromCreatureDisplayID|SetPortraitTextureFromCreatureDisplayID]](<span |
+ | : [[API SetPortraitTextureFromCreatureDisplayID|SetPortraitTextureFromCreatureDisplayID]](<span class="apiarg">textureObject, creatureDisplayID</span>) |
− | + | Loot Journal |
|
+ | : [[API C_LootJournal.GetItemSetItems|C_LootJournal.GetItemSetItems]](<span class="apiarg">setID</span>) : <span class="apiret">items</span> |
||
− | : [[API C_EncounterJournal.GetLootInfo|C_EncounterJournal.GetLootInfo]](<span style="font-size:smaller; color:#ecbc2a">lootID</span>) - Returns loot info for an encounter or instance. |
||
+ | : [[API C_LootJournal.GetItemSets|C_LootJournal.GetItemSets]](<span class="apiarg">[classID, specID]</span>) : <span class="apiret">itemSets</span> |
||
− | : [[API C_EncounterJournal.GetLootInfoByIndex|C_EncounterJournal.GetLootInfoByIndex]](<span style="font-size:smaller; color:#ecbc2a">index [, encounterIndex]</span>) - Returns loot info for an encounter or instance. |
||
− | : [[API C_EncounterJournal. |
+ | : [[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. |
+ | : [[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. |
+ | : [[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 item slot filter for loot items. |
||
− | : [[API EJ_GetInvTypeSortOrder|EJ_GetInvTypeSortOrder]](<span style="font-size:smaller; color:#ecbc2a">invType</span>) - Returns the sort order for an inventory type. |
||
+ | : [[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_GetLootFilter|EJ_GetLootFilter]]() - Returns the currently used loot filter. |
: [[API EJ_GetLootFilter|EJ_GetLootFilter]]() - Returns the currently used loot filter. |
||
: [[API EJ_GetNumLoot|EJ_GetNumLoot]]() - Returns the amount of loot for the currently selected instance or encounter. |
: [[API EJ_GetNumLoot|EJ_GetNumLoot]]() - Returns the amount of loot for the currently selected instance or encounter. |
||
: [[API EJ_IsLootListOutOfDate|EJ_IsLootListOutOfDate]]() - Returns whether the loot list is out of date in relation to any filters when getting new loot data. |
: [[API EJ_IsLootListOutOfDate|EJ_IsLootListOutOfDate]]() - Returns whether the loot list is out of date in relation to any filters when getting new loot data. |
||
: [[API EJ_ResetLootFilter|EJ_ResetLootFilter]]() - Clears any current loot filter in the journal. |
: [[API EJ_ResetLootFilter|EJ_ResetLootFilter]]() - Clears any current loot filter in the journal. |
||
− | : [[API EJ_SetLootFilter|EJ_SetLootFilter]](<span |
+ | : [[API EJ_SetLootFilter|EJ_SetLootFilter]](<span class="apiarg">classID, specID</span>) - Sets the loot filter for a specialization. |
− | == |
+ | ==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]]() - Returns the amount of |
+ | : [[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 |
+ | : [[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 |
+ | : [[API C_AuctionHouse.GetReplicateItemInfo|C_AuctionHouse.GetReplicateItemInfo]](<span class="apiarg">index</span>) : <span class="apiret">name, texture, count, qualityID, usable, level, levelType, minBid, minIncrement, buyoutPrice, bidAmount, highBidder, bidderFullName, owner, ownerFullName, saleStatus, itemID, hasAllInfo</span> - Returns information about the specified auction. |
− | : [[API C_AuctionHouse.GetReplicateItemLink|C_AuctionHouse.GetReplicateItemLink]](<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 |
+ | : [[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 |
+ | : [[API C_AuctionHouse.ReplicateItems|C_AuctionHouse.ReplicateItems]]() - Queries all auctions listed on the Auction House. |
− | : [[API C_AuctionHouse.CalculateCommodityDeposit|C_AuctionHouse.CalculateCommodityDeposit]](<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 |
+ | : [[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 |
+ | : [[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]]. |
− | : [[API C_AuctionHouse.CancelAuction|C_AuctionHouse.CancelAuction]](<span |
+ | : [[API C_AuctionHouse.CancelAuction|C_AuctionHouse.CancelAuction]](<span class="apiarg">ownedAuctionID</span>) {{apitag|hwevent,noscript}} - 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 |
+ | : [[API C_AuctionHouse.ConfirmCommoditiesPurchase|C_AuctionHouse.ConfirmCommoditiesPurchase]](<span class="apiarg">itemID, quantity</span>) - Completes a commodity item purchase. |
− | : [[API C_AuctionHouse. |
+ | : [[API C_AuctionHouse.ConfirmPostCommodity|C_AuctionHouse.ConfirmPostCommodity]](<span class="apiarg">item, duration, quantity, unitPrice</span>) |
− | : [[API C_AuctionHouse. |
+ | : [[API C_AuctionHouse.ConfirmPostItem|C_AuctionHouse.ConfirmPostItem]](<span class="apiarg">item, duration, quantity [, bid, buyout]</span>) |
− | : [[API C_AuctionHouse. |
+ | : [[API C_AuctionHouse.FavoritesAreAvailable|C_AuctionHouse.FavoritesAreAvailable]]() : <span class="apiret">favoritesAreAvailable</span> |
− | : [[API C_AuctionHouse. |
+ | : [[API C_AuctionHouse.GetAuctionInfoByID|C_AuctionHouse.GetAuctionInfoByID]](<span class="apiarg">auctionID</span>) : <span class="apiret">priceInfo</span> |
− | : [[API C_AuctionHouse. |
+ | : [[API C_AuctionHouse.GetAuctionItemSubClasses|C_AuctionHouse.GetAuctionItemSubClasses]](<span class="apiarg">classID</span>) : <span class="apiret">subClasses</span> |
− | : [[API C_AuctionHouse. |
+ | : [[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. |
+ | : [[API C_AuctionHouse.GetBidInfo|C_AuctionHouse.GetBidInfo]](<span class="apiarg">bidIndex</span>) : <span class="apiret">bid</span> |
− | : [[API C_AuctionHouse. |
+ | : [[API C_AuctionHouse.GetBids|C_AuctionHouse.GetBids]]() : <span class="apiret">bids</span> |
− | : [[API C_AuctionHouse. |
+ | : [[API C_AuctionHouse.GetBidType|C_AuctionHouse.GetBidType]](<span class="apiarg">bidTypeIndex</span>) : <span class="apiret">typeItemKey</span> |
− | : [[API C_AuctionHouse. |
+ | : [[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> - Returns the cost for cancelling a specific owned auction. This is non-zero if it has a bid. |
||
− | : [[API C_AuctionHouse.GetFilterGroups|C_AuctionHouse.GetFilterGroups]]() |
||
− | : [[API C_AuctionHouse. |
+ | : [[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. |
+ | : [[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. |
+ | : [[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. |
+ | : [[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. |
+ | : [[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. |
+ | : [[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> - Returns more details about an item from its item key, including its name. |
||
− | : [[API C_AuctionHouse.GetMaxBidItemBid|C_AuctionHouse.GetMaxBidItemBid]]() |
||
+ | : [[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.GetMaxBidItemBuyout|C_AuctionHouse.GetMaxBidItemBuyout]]() |
||
− | : [[API C_AuctionHouse. |
+ | : [[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. |
+ | : [[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. |
+ | : [[API C_AuctionHouse.GetMaxBidItemBid|C_AuctionHouse.GetMaxBidItemBid]]() : <span class="apiret">maxBid</span> |
− | : [[API C_AuctionHouse. |
+ | : [[API C_AuctionHouse.GetMaxBidItemBuyout|C_AuctionHouse.GetMaxBidItemBuyout]]() : <span class="apiret">maxBuyout</span> |
− | : [[API C_AuctionHouse. |
+ | : [[API C_AuctionHouse.GetMaxCommoditySearchResultPrice|C_AuctionHouse.GetMaxCommoditySearchResultPrice]](<span class="apiarg">itemID</span>) : <span class="apiret">maxUnitPrice</span> |
− | : [[API C_AuctionHouse. |
+ | : [[API C_AuctionHouse.GetMaxItemSearchResultBid|C_AuctionHouse.GetMaxItemSearchResultBid]](<span class="apiarg">itemKey</span>) : <span class="apiret">maxBid</span> |
− | : [[API C_AuctionHouse. |
+ | : [[API C_AuctionHouse.GetMaxItemSearchResultBuyout|C_AuctionHouse.GetMaxItemSearchResultBuyout]](<span class="apiarg">itemKey</span>) : <span class="apiret">maxBuyout</span> |
− | : [[API C_AuctionHouse. |
+ | : [[API C_AuctionHouse.GetMaxOwnedAuctionBid|C_AuctionHouse.GetMaxOwnedAuctionBid]]() : <span class="apiret">maxBid</span> |
− | : [[API C_AuctionHouse. |
+ | : [[API C_AuctionHouse.GetMaxOwnedAuctionBuyout|C_AuctionHouse.GetMaxOwnedAuctionBuyout]]() : <span class="apiret">maxBuyout</span> |
− | : [[API C_AuctionHouse. |
+ | : [[API C_AuctionHouse.GetNumBids|C_AuctionHouse.GetNumBids]]() : <span class="apiret">numBids</span> |
− | : [[API C_AuctionHouse. |
+ | : [[API C_AuctionHouse.GetNumBidTypes|C_AuctionHouse.GetNumBidTypes]]() : <span class="apiret">numBidTypes</span> |
− | : [[API C_AuctionHouse. |
+ | : [[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. |
+ | : [[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> - Returns the number of auctions the player has active on the auction house. |
||
− | : [[API C_AuctionHouse.GetQuoteDurationRemaining|C_AuctionHouse.GetQuoteDurationRemaining]]() |
||
− | : [[API C_AuctionHouse. |
+ | : [[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> - Returns information for one of the player's active auctions. |
||
− | : [[API C_AuctionHouse.HasFavorites|C_AuctionHouse.HasFavorites]]() |
||
− | : [[API C_AuctionHouse. |
+ | : [[API C_AuctionHouse.GetOwnedAuctions|C_AuctionHouse.GetOwnedAuctions]]() : <span class="apiret">ownedAuctions</span> |
− | : [[API C_AuctionHouse. |
+ | : [[API C_AuctionHouse.GetOwnedAuctionType|C_AuctionHouse.GetOwnedAuctionType]](<span class="apiarg">ownedAuctionTypeIndex</span>) : <span class="apiret">typeItemKey</span> |
− | : [[API C_AuctionHouse. |
+ | : [[API C_AuctionHouse.GetQuoteDurationRemaining|C_AuctionHouse.GetQuoteDurationRemaining]]() : <span class="apiret">quoteDurationSeconds</span> |
− | : [[API C_AuctionHouse. |
+ | : [[API C_AuctionHouse.GetTimeLeftBandInfo|C_AuctionHouse.GetTimeLeftBandInfo]](<span class="apiarg">timeLeftBand</span>) : <span class="apiret">timeLeftMinSeconds, timeLeftMaxSeconds</span> |
− | : [[API C_AuctionHouse. |
+ | : [[API C_AuctionHouse.HasFavorites|C_AuctionHouse.HasFavorites]]() : <span class="apiret">hasFavorites</span> |
− | : [[API C_AuctionHouse. |
+ | : [[API C_AuctionHouse.HasFullBidResults|C_AuctionHouse.HasFullBidResults]]() : <span class="apiret">hasFullBidResults</span> |
− | : [[API C_AuctionHouse. |
+ | : [[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. |
+ | : [[API C_AuctionHouse.HasFullCommoditySearchResults|C_AuctionHouse.HasFullCommoditySearchResults]](<span class="apiarg">itemID</span>) : <span class="apiret">hasFullResults</span> |
− | : [[API C_AuctionHouse. |
+ | : [[API C_AuctionHouse.HasFullItemSearchResults|C_AuctionHouse.HasFullItemSearchResults]](<span class="apiarg">itemKey</span>) : <span class="apiret">hasFullResults</span> |
− | : [[API C_AuctionHouse. |
+ | : [[API C_AuctionHouse.HasFullOwnedAuctionResults|C_AuctionHouse.HasFullOwnedAuctionResults]]() : <span class="apiret">hasFullOwnedAuctionResults</span> |
− | : [[API C_AuctionHouse. |
+ | : [[API C_AuctionHouse.HasMaxFavorites|C_AuctionHouse.HasMaxFavorites]]() : <span class="apiret">hasMaxFavorites</span> |
− | : [[API C_AuctionHouse. |
+ | : [[API C_AuctionHouse.HasSearchResults|C_AuctionHouse.HasSearchResults]](<span class="apiarg">itemKey</span>) : <span class="apiret">hasSearchResults</span> |
− | : [[API C_AuctionHouse. |
+ | : [[API C_AuctionHouse.IsFavoriteItem|C_AuctionHouse.IsFavoriteItem]](<span class="apiarg">itemKey</span>) : <span class="apiret">isFavorite</span> |
− | : [[API C_AuctionHouse. |
+ | : [[API C_AuctionHouse.IsSellItemValid|C_AuctionHouse.IsSellItemValid]](<span class="apiarg">item [, displayError]</span>) : <span class="apiret">valid</span> - Returns true if an item from your bag can be posted on the auction house. |
− | : [[API C_AuctionHouse. |
+ | : [[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. |
+ | : [[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. |
− | : [[API C_AuctionHouse. |
+ | : [[API C_AuctionHouse.PlaceBid|C_AuctionHouse.PlaceBid]](<span class="apiarg">auctionID, bidAmount</span>) {{apitag|hwevent,noscript}} - Places a bid on a non-commodity item. |
− | : [[API C_AuctionHouse. |
+ | : [[API C_AuctionHouse.PostCommodity|C_AuctionHouse.PostCommodity]](<span class="apiarg">item, duration, quantity, unitPrice</span>) : <span class="apiret">needsConfirmation</span> {{apitag|hwevent,noscript}} - Posts a commodity item on the auction house. |
+ | : [[API C_AuctionHouse.PostItem|C_AuctionHouse.PostItem]](<span class="apiarg">item, duration, quantity [, bid, buyout]</span>) : <span class="apiret">needsConfirmation</span> {{apitag|hwevent,noscript}} - Posts an item on the auction house. |
||
− | : [[API C_AuctionHouse.RequestMoreBrowseResults|C_AuctionHouse.RequestMoreBrowseResults]]() |
||
− | : [[API C_AuctionHouse. |
+ | : [[API C_AuctionHouse.QueryBids|C_AuctionHouse.QueryBids]](<span class="apiarg">sorts, auctionIDs</span>) |
− | : [[API C_AuctionHouse. |
+ | : [[API C_AuctionHouse.QueryOwnedAuctions|C_AuctionHouse.QueryOwnedAuctions]](<span class="apiarg">sorts</span>) {{apitag|noscript}} - Queries the auction house for the player's active auctions. |
− | : [[API C_AuctionHouse. |
+ | : [[API C_AuctionHouse.RefreshCommoditySearchResults|C_AuctionHouse.RefreshCommoditySearchResults]](<span class="apiarg">itemID</span>) |
− | : [[API C_AuctionHouse. |
+ | : [[API C_AuctionHouse.RefreshItemSearchResults|C_AuctionHouse.RefreshItemSearchResults]](<span class="apiarg">itemKey [, minLevelFilter, maxLevelFilter]</span>) |
− | : [[API C_AuctionHouse. |
+ | : [[API C_AuctionHouse.RequestFavorites|C_AuctionHouse.RequestFavorites]]() |
− | : [[API C_AuctionHouse. |
+ | : [[API C_AuctionHouse.RequestMoreBrowseResults|C_AuctionHouse.RequestMoreBrowseResults]]() {{apitag|noscript}} |
− | : [[API C_AuctionHouse. |
+ | : [[API C_AuctionHouse.RequestMoreCommoditySearchResults|C_AuctionHouse.RequestMoreCommoditySearchResults]](<span class="apiarg">itemID</span>) : <span class="apiret">hasFullResults</span> |
− | : [[API C_AuctionHouse. |
+ | : [[API C_AuctionHouse.RequestMoreItemSearchResults|C_AuctionHouse.RequestMoreItemSearchResults]](<span class="apiarg">itemKey</span>) : <span class="apiret">hasFullResults</span> |
− | : [[API C_AuctionHouse. |
+ | : [[API C_AuctionHouse.RequestOwnedAuctionBidderInfo|C_AuctionHouse.RequestOwnedAuctionBidderInfo]](<span class="apiarg">auctionID</span>) : <span class="apiret">bidderName</span> |
− | : [[API C_AuctionHouse. |
+ | : [[API C_AuctionHouse.SearchForFavorites|C_AuctionHouse.SearchForFavorites]](<span class="apiarg">sorts</span>) {{apitag|noscript}} - Searches for favorited items. |
+ | : [[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. |
||
+ | : [[API C_AuctionHouse.SendBrowseQuery|C_AuctionHouse.SendBrowseQuery]](<span class="apiarg">query</span>) {{apitag|noscript}} - Queries the auction house using search parameters. |
||
+ | : [[API C_AuctionHouse.SendSearchQuery|C_AuctionHouse.SendSearchQuery]](<span class="apiarg">itemKey, sorts, separateOwnerItems [, minLevelFilter, maxLevelFilter]</span>) {{apitag|noscript}} - 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.SetFavoriteItem|C_AuctionHouse.SetFavoriteItem]](<span class="apiarg">itemKey, setFavorite</span>) |
||
+ | : [[API C_AuctionHouse.StartCommoditiesPurchase|C_AuctionHouse.StartCommoditiesPurchase]](<span class="apiarg">itemID, quantity</span>) {{apitag|hwevent,noscript}} - Starts a commodity item purchase. |
||
− | === |
+ | ===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]]() - |
+ | : [[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 |
+ | : [[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 |
+ | : [[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]]() |
||
− | : |
+ | : [[API C_BlackMarket.ItemPlaceBid|C_BlackMarket.ItemPlaceBid]](<span class="apiarg">marketID, bid</span>) {{apitag|hwevent}} - 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 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]]() |
||
: [[API C_WowTokenPublic.GetCommerceSystemStatus|C_WowTokenPublic.GetCommerceSystemStatus]]() |
: [[API C_WowTokenPublic.GetCommerceSystemStatus|C_WowTokenPublic.GetCommerceSystemStatus]]() |
||
: [[API C_WowTokenPublic.GetCurrentMarketPrice|C_WowTokenPublic.GetCurrentMarketPrice]]() |
: [[API C_WowTokenPublic.GetCurrentMarketPrice|C_WowTokenPublic.GetCurrentMarketPrice]]() |
||
: [[API C_WowTokenPublic.GetGuaranteedPrice|C_WowTokenPublic.GetGuaranteedPrice]]() |
: [[API C_WowTokenPublic.GetGuaranteedPrice|C_WowTokenPublic.GetGuaranteedPrice]]() |
||
− | : [[API C_WowTokenPublic.GetListedAuctionableTokenInfo|C_WowTokenPublic.GetListedAuctionableTokenInfo]](<span |
+ | : [[API C_WowTokenPublic.GetListedAuctionableTokenInfo|C_WowTokenPublic.GetListedAuctionableTokenInfo]](<span class="apiarg">index</span>) |
: [[API C_WowTokenPublic.GetNumListedAuctionableTokens|C_WowTokenPublic.GetNumListedAuctionableTokens]]() |
: [[API C_WowTokenPublic.GetNumListedAuctionableTokens|C_WowTokenPublic.GetNumListedAuctionableTokens]]() |
||
− | : [[API C_WowTokenPublic.IsAuctionableWowToken|C_WowTokenPublic.IsAuctionableWowToken]](<span |
+ | : [[API C_WowTokenPublic.IsAuctionableWowToken|C_WowTokenPublic.IsAuctionableWowToken]](<span class="apiarg">itemID</span>) |
: [[API C_WowTokenPublic.IsConsumableWowToken|C_WowTokenPublic.IsConsumableWowToken]]() |
: [[API C_WowTokenPublic.IsConsumableWowToken|C_WowTokenPublic.IsConsumableWowToken]]() |
||
: [[API C_WowTokenPublic.UpdateListedAuctionableTokens|C_WowTokenPublic.UpdateListedAuctionableTokens]]() |
: [[API C_WowTokenPublic.UpdateListedAuctionableTokens|C_WowTokenPublic.UpdateListedAuctionableTokens]]() |
||
: [[API C_WowTokenPublic.UpdateMarketPrice|C_WowTokenPublic.UpdateMarketPrice]]() |
: [[API C_WowTokenPublic.UpdateMarketPrice|C_WowTokenPublic.UpdateMarketPrice]]() |
||
: [[API C_WowTokenPublic.UpdateTokenCount|C_WowTokenPublic.UpdateTokenCount]]() |
: [[API C_WowTokenPublic.UpdateTokenCount|C_WowTokenPublic.UpdateTokenCount]]() |
||
− | : [[API C_WowTokenUI.StartTokenSell|C_WowTokenUI.StartTokenSell]](<span |
+ | : [[API C_WowTokenUI.StartTokenSell|C_WowTokenUI.StartTokenSell]](<span class="apiarg">tokenGUID</span>) |
− | == |
+ | ==Bags== |
+ | : [[API IsInventoryItemProfessionBag|IsInventoryItemProfessionBag]](<span class="apiarg">unit, slot</span>) |
||
− | : [[API GetBackpackAutosortDisabled|GetBackpackAutosortDisabled]]() |
||
− | : [[API |
+ | : [[API PutItemInBackpack|PutItemInBackpack]]() - Places the item on the cursor into the player's backpack. |
+ | : [[API PutItemInBag|PutItemInBag]](<span class="apiarg">inventoryId</span>) - Places the item on the cursor into the specified bag slot. |
||
− | : [[API GetBagSlotFlag|GetBagSlotFlag]](<span style="font-size:smaller; color:#ecbc2a">index, flagIndex</span>) |
||
+ | : [[API SetBarSlotFromIntro|SetBarSlotFromIntro]](<span class="apiarg">slot</span>) |
||
− | : [[API GetInsertItemsLeftToRight|GetInsertItemsLeftToRight]]() |
||
+ | : {{api|CloseAllBags}}(<span class="apiarg">callingFrame, forceUpdate</span>) {{apitag|framexml}} |
||
− | : [[API GetSortBagsRightToLeft|GetSortBagsRightToLeft]]() |
||
+ | : {{api|CloseBackpack}}() {{apitag|framexml}} |
||
− | : [[API IsBagSlotFlagEnabledOnOtherBags|IsBagSlotFlagEnabledOnOtherBags]](<span style="font-size:smaller; color:#ecbc2a">index, flagIndex</span>) |
||
+ | : {{api|CloseBag}}(<span class="apiarg">bagID</span>) {{apitag|framexml}} |
||
− | : [[API IsInventoryItemProfessionBag|IsInventoryItemProfessionBag]](<span style="font-size:smaller; color:#ecbc2a">unit, slot</span>) |
||
+ | : {{api|IsBagOpen}}(<span class="apiarg">bagID</span>) {{apitag|framexml}} |
||
− | : [[API PutItemInBackpack|PutItemInBackpack]]() - Attempts to place item in backpack (bag slot 0). |
||
+ | : {{api|OpenAllBags}}(<span class="apiarg">callingFrame, forceUpdate</span>) {{apitag|framexml}} |
||
− | : [[API PutItemInBag|PutItemInBag]](<span style="font-size:smaller; color:#ecbc2a">inventoryId</span>) - Attempts to place item in a specific bag. |
||
+ | : {{api|OpenBackpack}}() {{apitag|framexml}} |
||
− | : [[API SetBackpackAutosortDisabled|SetBackpackAutosortDisabled]](<span style="font-size:smaller; color:#ecbc2a">disable</span>) |
||
+ | : {{api|OpenBag}}(<span class="apiarg">bagID, force</span>) {{apitag|framexml}} |
||
− | : [[API SetBagPortraitTexture|SetBagPortraitTexture]](<span style="font-size:smaller; color:#ecbc2a">texture, slot</span>) |
||
+ | : {{api|ToggleAllBags}}() {{apitag|framexml}} |
||
− | : [[API SetBagSlotFlag|SetBagSlotFlag]](<span style="font-size:smaller; color:#ecbc2a">index, flagIndex, checked</span>) |
||
+ | : {{api|ToggleBackpack}}() {{apitag|framexml}} - Toggles your backpack open/closed. |
||
− | : [[API SetBarSlotFromIntro|SetBarSlotFromIntro]](<span style="font-size:smaller; color:#ecbc2a">slot</span>) |
||
+ | : {{api|ToggleBag|ToggleBag}}(<span class="apiarg">bagID</span>) {{apitag|framexml}} - Opens or closes the specified bag. |
||
− | : [[API SetInsertItemsLeftToRight|SetInsertItemsLeftToRight]](<span style="font-size:smaller; color:#ecbc2a">disable</span>) |
||
− | : [[API SetItemSearch|SetItemSearch]](<span style="font-size:smaller; color:#ecbc2a">search</span>) |
||
− | : [[API SetSortBagsRightToLeft|SetSortBagsRightToLeft]](<span style="font-size:smaller; color:#ecbc2a">disable</span>) |
||
− | : [[API SortBags|SortBags]]() |
||
− | : UI {{api|OpenBag}}(<span style="font-size:smaller; color:#ecbc2a">bagID, force</span>) |
||
− | : UI {{api|CloseBag}}(<span style="font-size:smaller; color:#ecbc2a">bagID</span>) |
||
− | : UI {{api|OpenAllBags}}(<span style="font-size:smaller; color:#ecbc2a">callingFrame, forceUpdate</span>) |
||
− | : UI {{api|CloseAllBags}}(<span style="font-size:smaller; color:#ecbc2a">callingFrame, forceUpdate</span>) |
||
− | : UI {{api|ToggleAllBags}}() |
||
− | : UI {{api|IsBagOpen}}(<span style="font-size:smaller; color:#ecbc2a">bagID</span>) |
||
− | === |
+ | ===Inventory=== |
− | : [[API GetContainerFreeSlots|GetContainerFreeSlots]](<span style="font-size:smaller; color:#ecbc2a">index [, returnTable]</span>) |
||
− | : [[API GetContainerItemCooldown|GetContainerItemCooldown]](<span style="font-size:smaller; color:#ecbc2a">bagID, slot</span>) |
||
− | : [[API GetContainerItemDurability|GetContainerItemDurability]](<span style="font-size:smaller; color:#ecbc2a">bag, slot</span>) - Get current and maximum durability of an item in the character's bags. |
||
− | : [[API GetContainerItemEquipmentSetInfo|GetContainerItemEquipmentSetInfo]](<span style="font-size:smaller; color:#ecbc2a">index, slot</span>) |
||
− | : [[API GetContainerItemID|GetContainerItemID]](<span style="font-size:smaller; color:#ecbc2a">bag, slot</span>) - Returns the item ID of the item in a particular container slot. |
||
− | : [[API GetContainerItemInfo|GetContainerItemInfo]](<span style="font-size:smaller; color:#ecbc2a">bagID, slot</span>) - Get the info for an item in one of the player's bags. |
||
− | : [[API GetContainerItemLink|GetContainerItemLink]](<span style="font-size:smaller; color:#ecbc2a">bagID, slot</span>) - Returns the [[itemLink]] of the item located in bag#, slot#. |
||
− | : [[API GetContainerItemPurchaseCurrency|GetContainerItemPurchaseCurrency]](<span style="font-size:smaller; color:#ecbc2a">bag, slot, itemIndex [, isEquipped]</span>) |
||
− | : [[API GetContainerItemPurchaseInfo|GetContainerItemPurchaseInfo]](<span style="font-size:smaller; color:#ecbc2a">index, slot [, isEquipped]</span>) |
||
− | : [[API GetContainerItemPurchaseItem|GetContainerItemPurchaseItem]](<span style="font-size:smaller; color:#ecbc2a">bag, slot, itemIndex [, isEquipped]</span>) |
||
− | : [[API GetContainerItemQuestInfo|GetContainerItemQuestInfo]](<span style="font-size:smaller; color:#ecbc2a">bag, slot</span>) - Returns information about quest and quest-starting items in your bags. |
||
− | : [[API GetContainerNumFreeSlots|GetContainerNumFreeSlots]](<span style="font-size:smaller; color:#ecbc2a">bagID</span>) - Returns the number of free slots and type of slots in the bag specified by the index. |
||
− | : [[API GetContainerNumSlots|GetContainerNumSlots]](<span style="font-size:smaller; color:#ecbc2a">bagID</span>) - Returns the total number of slots in the bag specified by the index. |
||
− | : [[API IsContainerFiltered|IsContainerFiltered]](<span style="font-size:smaller; color:#ecbc2a">index</span>) |
||
− | : [[API IsContainerItemAnUpgrade|IsContainerItemAnUpgrade]](<span style="font-size:smaller; color:#ecbc2a">index, slot</span>) |
||
− | : [[API SplitContainerItem|SplitContainerItem]](<span style="font-size:smaller; color:#ecbc2a">bagID, slot, amount</span>) - Picks up part of a stack. |
||
− | : PROTECTED (situational) [[API UseContainerItem|UseContainerItem]](<span style="font-size:smaller; color:#ecbc2a">bagID, slot [, target]</span>) - Performs a "right click" action on, or targeted use of, on an item in bags. |
||
− | |||
− | ==== 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>) - Cancels a pending equip confirmation. |
||
− | : [[API BankButtonIDToInvSlotID|BankButtonIDToInvSlotID]](<span style="font-size:smaller; color:#ecbc2a">buttonID, isBag</span>) - Returns the ID number of a bank button or bag in terms of inventory slot ID. |
||
+ | : [[API ConfirmBindOnUse|ConfirmBindOnUse]]() {{apitag|protected}} |
||
− | : [[API CancelPendingEquip|CancelPendingEquip]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - This function is used to cancel a pending equip. |
||
+ | : [[API ConfirmNoRefundOnUse|ConfirmNoRefundOnUse]]() {{apitag|protected}} |
||
− | : PROTECTED [[API ConfirmBindOnUse|ConfirmBindOnUse]]() |
||
+ | : [[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. |
||
− | : PROTECTED [[API ConfirmNoRefundOnUse|ConfirmNoRefundOnUse]]() |
||
+ | : [[API GetAverageItemLevel|GetAverageItemLevel]]() - Returns the character's average item level. |
||
− | : [[API ContainerIDToInventoryID|ContainerIDToInventoryID]](<span style="font-size:smaller; color:#ecbc2a">bagID</span>) |
||
− | : [[API |
+ | : [[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>) - Returns true if an inventory item has zero durability. |
||
− | : [[API GetAverageItemLevel|GetAverageItemLevel]]() - Returns the character's current average iLevel and current average iLevel equipped. |
||
− | : [[API |
+ | : [[API GetInventoryItemCooldown|GetInventoryItemCooldown]](<span class="apiarg">unit, invSlot</span>) - Get cooldown information for an inventory item. |
− | : [[API |
+ | : [[API GetInventoryItemCount|GetInventoryItemCount]](<span class="apiarg">unit, invSlot</span>) - Determine the quantity of an item in an inventory slot. |
− | : [[API |
+ | : [[API GetInventoryItemDurability|GetInventoryItemDurability]](<span class="apiarg">invSlot</span>) - Returns the durability of an equipped item. |
− | : [[API |
+ | : [[API GetInventoryItemID|GetInventoryItemID]](<span class="apiarg">unit, invSlot</span>) - Returns the item ID for an equipped item. |
− | : [[API |
+ | : [[API GetInventoryItemLink|GetInventoryItemLink]](<span class="apiarg">unit, invSlot</span>) - Returns the item link for an equipped item. |
− | : [[API |
+ | : [[API GetInventoryItemQuality|GetInventoryItemQuality]](<span class="apiarg">unit, invSlot</span>) - Returns the quality of an equipped item. |
− | : [[API |
+ | : [[API GetInventoryItemTexture|GetInventoryItemTexture]](<span class="apiarg">unit, invSlot</span>) - Returns the texture for an equipped item. |
− | : [[API |
+ | : [[API GetInventorySlotInfo|GetInventorySlotInfo]](<span class="apiarg">invSlotName</span>) - Returns info for an equipment slot. |
+ | : [[API HasWandEquipped|HasWandEquipped]]() - Returns true if a wand is equipped. |
||
− | : [[API GetInventoryItemTexture|GetInventoryItemTexture]](<span style="font-size:smaller; color:#ecbc2a">unit, invSlot</span>) - Returns the texture for an inventory item. |
||
− | : [[API |
+ | : [[API IsInventoryItemLocked|IsInventoryItemLocked]](<span class="apiarg">id</span>) - Returns whether an inventory item is locked, usually as it awaits pending action. |
− | : [[API HasWandEquipped|HasWandEquipped]]() - Returns 1 if a wand is equipped, false otherwise. |
||
− | : [[API IsInventoryItemLocked|IsInventoryItemLocked]](<span style="font-size:smaller; color:#ecbc2a">id</span>) - Returns whether an inventory item is locked, usually as it awaits pending action. |
||
− | : [[API SetInventoryPortraitTexture|SetInventoryPortraitTexture]](<span style="font-size:smaller; color:#ecbc2a">texture, unit, slot</span>) |
||
: [[API UpdateInventoryAlertStatus|UpdateInventoryAlertStatus]]() |
: [[API UpdateInventoryAlertStatus|UpdateInventoryAlertStatus]]() |
||
− | : |
+ | : [[API UseInventoryItem|UseInventoryItem]](<span class="apiarg">invSlot</span>) {{apitag|protected}} - Use an item in a specific inventory slot. |
− | == |
+ | ==Bank== |
− | + | Relates to the [[Bank]]. |
|
+ | : [[API BankButtonIDToInvSlotID|BankButtonIDToInvSlotID]](<span class="apiarg">buttonID, isBag</span>) - Maps a BankButtonID to InventorySlotID. |
||
: [[API BuyReagentBank|BuyReagentBank]]() |
: [[API BuyReagentBank|BuyReagentBank]]() |
||
− | : [[API CloseBankFrame|CloseBankFrame]]() - |
+ | : [[API CloseBankFrame|CloseBankFrame]]() - Closes the bank window. |
: [[API DepositReagentBank|DepositReagentBank]]() |
: [[API DepositReagentBank|DepositReagentBank]]() |
||
+ | : [[API GetBankSlotCost|GetBankSlotCost]](<span class="apiarg">numSlots</span>) - Returns the cost of the next bank bag slot. |
||
− | : [[API GetBankAutosortDisabled|GetBankAutosortDisabled]]() |
||
+ | : [[API GetNumBankSlots|GetNumBankSlots]]() - Returns the number of purchased bank bag slots. |
||
− | : [[API GetBankBagSlotFlag|GetBankBagSlotFlag]]() |
||
− | : [[API GetBankSlotCost|GetBankSlotCost]](<span style="font-size:smaller; color:#ecbc2a">numSlots</span>) - Returns the cost of the next bank slot. |
||
− | : [[API GetNumBankSlots|GetNumBankSlots]]() - Returns total purchased bank bag slots, and a flag indicating if it's full. |
||
: [[API GetReagentBankCost|GetReagentBankCost]]() |
: [[API GetReagentBankCost|GetReagentBankCost]]() |
||
− | : [[API IsBagSlotFlagEnabledOnOtherBankBags|IsBagSlotFlagEnabledOnOtherBankBags]]() |
||
: [[API IsReagentBankUnlocked|IsReagentBankUnlocked]]() |
: [[API IsReagentBankUnlocked|IsReagentBankUnlocked]]() |
||
: [[API PurchaseSlot|PurchaseSlot]]() - Buys another bank slot if available. |
: [[API PurchaseSlot|PurchaseSlot]]() - Buys another bank slot if available. |
||
: [[API ReagentBankButtonIDToInvSlotID|ReagentBankButtonIDToInvSlotID]]() |
: [[API ReagentBankButtonIDToInvSlotID|ReagentBankButtonIDToInvSlotID]]() |
||
− | : [[API SetBankAutosortDisabled|SetBankAutosortDisabled]]() |
||
− | : [[API SetBankBagSlotFlag|SetBankBagSlotFlag]]() |
||
− | : [[API SortBankBags|SortBankBags]]() |
||
− | : [[API SortReagentBankBags|SortReagentBankBags]]() |
||
− | === |
+ | ===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 |
+ | : [[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 451: | Line 1,019: | ||
: [[API CanWithdrawGuildBankMoney|CanWithdrawGuildBankMoney]]() - Boolean, true if player is permitted to withdraw funds. No bank proximity required. |
: [[API CanWithdrawGuildBankMoney|CanWithdrawGuildBankMoney]]() - Boolean, true if player is permitted to withdraw funds. No bank proximity required. |
||
: [[API CloseGuildBankFrame|CloseGuildBankFrame]]() - Closes the guild bank frame. |
: [[API CloseGuildBankFrame|CloseGuildBankFrame]]() - Closes the guild bank frame. |
||
− | : [[API DepositGuildBankMoney|DepositGuildBankMoney]](<span |
+ | : [[API DepositGuildBankMoney|DepositGuildBankMoney]](<span class="apiarg">money</span>) - Deposits "money" amount in copper. |
: [[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 |
+ | : [[API GetGuildBankItemInfo|GetGuildBankItemInfo]](<span class="apiarg">tab, slot</span>) - Returns item info for a guild bank slot. |
− | : [[API GetGuildBankItemLink|GetGuildBankItemLink]](<span |
+ | : [[API GetGuildBankItemLink|GetGuildBankItemLink]](<span class="apiarg">tab, slot</span>) - Returns the item link for a guild bank slot. |
− | : [[API GetGuildBankMoney|GetGuildBankMoney]]() - |
+ | : [[API GetGuildBankMoney|GetGuildBankMoney]]() - Returns the amount of money in the guild bank. |
− | : [[API GetGuildBankMoneyTransaction|GetGuildBankMoneyTransaction]](<span |
+ | : [[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 |
+ | : [[API GetGuildBankTabInfo|GetGuildBankTabInfo]](<span class="apiarg">tab</span>) - Returns info for a guild bank tab. |
− | : [[API GetGuildBankTabPermissions|GetGuildBankTabPermissions]](<span |
+ | : [[API GetGuildBankTabPermissions|GetGuildBankTabPermissions]](<span class="apiarg">tab</span>) - Gets display / player's access info. Limited data available without bank proximity. |
− | : [[API GetGuildBankText|GetGuildBankText]](<span |
+ | : [[API GetGuildBankText|GetGuildBankText]](<span class="apiarg">tab</span>) - Returns info text for a tab. |
− | : [[API GetGuildBankTransaction|GetGuildBankTransaction]](<span |
+ | : [[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]]() |
||
: [[API GetNumGuildBankMoneyTransactions|GetNumGuildBankMoneyTransactions]]() - Returns number of money log entries. |
: [[API GetNumGuildBankMoneyTransactions|GetNumGuildBankMoneyTransactions]]() - Returns number of money log entries. |
||
: [[API GetNumGuildBankTabs|GetNumGuildBankTabs]]() - Integer count of bought tabs, >= 0. No bank proximity required. |
: [[API GetNumGuildBankTabs|GetNumGuildBankTabs]]() - Integer count of bought tabs, >= 0. No bank proximity required. |
||
− | : [[API GetNumGuildBankTransactions|GetNumGuildBankTransactions]](<span |
+ | : [[API GetNumGuildBankTransactions|GetNumGuildBankTransactions]](<span class="apiarg">tab</span>) - Returns number of log transactions for tab "tab". |
− | : [[API QueryGuildBankLog|QueryGuildBankLog]](<span |
+ | : [[API QueryGuildBankLog|QueryGuildBankLog]](<span class="apiarg">tab</span>) - Updates bank log data from the server, called before all transaction functions. "Money tab" is MAX_GUILDBANK_TABS+1. |
− | : [[API QueryGuildBankTab|QueryGuildBankTab]](<span |
+ | : [[API QueryGuildBankTab|QueryGuildBankTab]](<span class="apiarg">tab</span>) - Updates bank tab data from the server, called before all item functions. |
: [[API QueryGuildBankText|QueryGuildBankText]]() |
: [[API QueryGuildBankText|QueryGuildBankText]]() |
||
− | : [[API SetCurrentGuildBankTab|SetCurrentGuildBankTab]](<span |
+ | : [[API SetCurrentGuildBankTab|SetCurrentGuildBankTab]](<span class="apiarg">tab</span>) - Select different bank tab in the UI. |
− | : [[API SetGuildBankTabInfo|SetGuildBankTabInfo]](<span |
+ | : [[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 |
+ | : [[API SetGuildBankTabPermissions|SetGuildBankTabPermissions]](<span class="apiarg">tab, index, enabled</span>) - Modifies the permissions for a guild bank tab. |
− | : [[API SetGuildBankText|SetGuildBankText]](<span |
+ | : [[API SetGuildBankText|SetGuildBankText]](<span class="apiarg">tab, infoText</span>) - Modifies info text for a tab. |
− | : [[API SetGuildBankWithdrawGoldLimit|SetGuildBankWithdrawGoldLimit]](<span |
+ | : [[API SetGuildBankWithdrawGoldLimit|SetGuildBankWithdrawGoldLimit]](<span class="apiarg">amount</span>) - Sets the gold withdraw limit for the guild bank. |
− | : [[API SplitGuildBankItem|SplitGuildBankItem]](<span |
+ | : [[API SplitGuildBankItem|SplitGuildBankItem]](<span class="apiarg">tab, slot, amount</span>) - Picks up part of a stack. |
− | : [[API WithdrawGuildBankMoney|WithdrawGuildBankMoney]](<span |
+ | : [[API WithdrawGuildBankMoney|WithdrawGuildBankMoney]](<span class="apiarg">money</span>) - Withdraws "money" copper from the guild bank. |
− | === |
+ | ===Void Storage=== |
− | + | [[Void Storage]] was added in [[Patch 4.3.0]] |
|
+ | : [[API CanUseVoidStorage|CanUseVoidStorage]]() - Returns if the player has access to the Void Storage. |
||
− | : [[API C_BarberShop.ApplyCustomizationChoices|C_BarberShop.ApplyCustomizationChoices]]() |
||
+ | : [[API ClearVoidTransferDepositSlot|ClearVoidTransferDepositSlot]](<span class="apiarg">slotIndex</span>) - Clears the specified Void Transfer deposit slot. |
||
− | : [[API C_BarberShop.Cancel|C_BarberShop.Cancel]]() |
||
+ | : [[API ClickVoidStorageSlot|ClickVoidStorageSlot]](<span class="apiarg">slotIndex [, isRightClick]</span>) - Clicks the specified Void Storage slot. |
||
− | : [[API C_BarberShop.ClearPreviewChoices|C_BarberShop.ClearPreviewChoices]]() |
||
+ | : [[API ClickVoidTransferDepositSlot|ClickVoidTransferDepositSlot]](<span class="apiarg">slotIndex [, isRightClick]</span>) - Clicks the specified Void Transfer deposit slot. |
||
− | : [[API C_BarberShop.GetAvailableCustomizations|C_BarberShop.GetAvailableCustomizations]]() |
||
+ | : [[API ClickVoidTransferWithdrawalSlot|ClickVoidTransferWithdrawalSlot]](<span class="apiarg">slotIndex [, isRightClick]</span>) - Clicks the specified Void Transfer withdrawal slot. |
||
− | : [[API C_BarberShop.GetCurrentCameraZoom|C_BarberShop.GetCurrentCameraZoom]]() |
||
+ | : [[API ExecuteVoidTransfer|ExecuteVoidTransfer]]() - Applies all pending void transfers (and pays for the cost of any deposited items). |
||
− | : [[API C_BarberShop.GetCurrentCharacterData|C_BarberShop.GetCurrentCharacterData]]() |
||
+ | : [[API GetNumVoidTransferDeposit|GetNumVoidTransferDeposit]]() - Returns the number of items being deposited into the Void Storage. |
||
− | : [[API C_BarberShop.GetCurrentCost|C_BarberShop.GetCurrentCost]]() |
||
+ | : [[API GetNumVoidTransferWithdrawal|GetNumVoidTransferWithdrawal]]() - Returns the number of items being withdrawed from the Void Storage. |
||
− | : [[API C_BarberShop.HasAnyChanges|C_BarberShop.HasAnyChanges]]() |
||
+ | : [[API GetVoidItemHyperlinkString|GetVoidItemHyperlinkString]](<span class="apiarg">slotIndex</span>) - Returns the item link of an item in void storage. |
||
− | : [[API C_BarberShop.IsViewingAlteredForm|C_BarberShop.IsViewingAlteredForm]]() |
||
+ | : [[API GetVoidItemInfo|GetVoidItemInfo]](<span class="apiarg">slotIndex</span>) - Returns info for a Void Storage slot. |
||
− | : [[API C_BarberShop.OldBarberShopLoaded|C_BarberShop.OldBarberShopLoaded]]() |
||
+ | : [[API GetVoidTransferCost|GetVoidTransferCost]]() - Returns the total Void Transfer cost. |
||
− | : [[API C_BarberShop.PreviewCustomizationChoice|C_BarberShop.PreviewCustomizationChoice]](<span style="font-size:smaller; color:#ecbc2a">optionID, choiceID</span>) |
||
+ | : [[API GetVoidTransferDepositInfo|GetVoidTransferDepositInfo]](<span class="apiarg">slotIndex</span>) - Returns info for the item being deposited into the Void Storage. |
||
− | : [[API C_BarberShop.ResetCameraRotation|C_BarberShop.ResetCameraRotation]]() |
||
+ | : [[API GetVoidTransferWithdrawalInfo|GetVoidTransferWithdrawalInfo]](<span class="apiarg">slotIndex</span>) - Returns info for the item being withdrawn from the Void Storage. |
||
− | : [[API C_BarberShop.ResetCustomizationChoices|C_BarberShop.ResetCustomizationChoices]]() |
||
+ | : [[API IsVoidStorageReady|IsVoidStorageReady]]() |
||
− | : [[API C_BarberShop.RotateCamera|C_BarberShop.RotateCamera]](<span style="font-size:smaller; color:#ecbc2a">diffDegrees</span>) |
||
+ | : [[API UnlockVoidStorage|UnlockVoidStorage]]() - Purchases the Void Storage. |
||
− | : [[API C_BarberShop.SetCameraDistanceOffset|C_BarberShop.SetCameraDistanceOffset]](<span style="font-size:smaller; color:#ecbc2a">offset</span>) |
||
+ | : [[API GetVoidStorageSlotPageIndex|GetVoidStorageSlotPageIndex]](<span class="apiarg">slot</span>) |
||
− | : [[API C_BarberShop.SetCameraZoomLevel|C_BarberShop.SetCameraZoomLevel]](<span style="font-size:smaller; color:#ecbc2a">zoomLevel [, keepCustomZoom]</span>) |
||
+ | : [[API GetVoidUnlockCost|GetVoidUnlockCost]]() |
||
− | : [[API C_BarberShop.SetCustomizationChoice|C_BarberShop.SetCustomizationChoice]](<span style="font-size:smaller; color:#ecbc2a">optionID, choiceID</span>) |
||
− | : [[API C_BarberShop.SetModelDressState|C_BarberShop.SetModelDressState]](<span style="font-size:smaller; color:#ecbc2a">dressedState</span>) |
||
− | : [[API C_BarberShop.SetSelectedSex|C_BarberShop.SetSelectedSex]](<span style="font-size:smaller; color:#ecbc2a">sex</span>) |
||
− | : [[API C_BarberShop.SetViewingAlteredForm|C_BarberShop.SetViewingAlteredForm]](<span style="font-size:smaller; color:#ecbc2a">isViewingAlteredForm</span>) |
||
− | : [[API C_BarberShop.SetViewingShapeshiftForm|C_BarberShop.SetViewingShapeshiftForm]](<span style="font-size:smaller; color:#ecbc2a">[shapeshiftFormID]</span>) |
||
− | : [[API C_BarberShop.ZoomCamera|C_BarberShop.ZoomCamera]](<span style="font-size:smaller; color:#ecbc2a">zoomAmount</span>) |
||
− | : [[API ApplyBarberShopStyle|ApplyBarberShopStyle]]() - Purchase and apply the cosmetic changes. |
||
− | : [[API BarberShopReset|BarberShopReset]]() - Reset any changes made in the Barber Shop. |
||
− | : [[API CancelBarberShop|CancelBarberShop]]() - Exit the Barber Shop chair. |
||
− | : [[API GetBarberShopStyleInfo|GetBarberShopStyleInfo]](<span style="font-size:smaller; color:#ecbc2a">id</span>) - Returns information about the currently selected style. |
||
− | : [[API GetBarberShopTotalCost|GetBarberShopTotalCost]]() - Returns the total costs of the cosmetic changes. |
||
− | : [[API GetCustomizationDetails|GetCustomizationDetails]](<span style="font-size:smaller; color:#ecbc2a">customizationIndex</span>) |
||
− | : [[API IsBarberShopStyleValid|IsBarberShopStyleValid]]() |
||
− | : [[API SetBarberShopAlternateFormFrame|SetBarberShopAlternateFormFrame]]() |
||
− | : [[API SetNextBarberShopStyle|SetNextBarberShopStyle]](<span style="font-size:smaller; color:#ecbc2a">id [, reverse]</span>) - Alters style selection in a particular category. |
||
− | == |
+ | ==Books== |
− | + | 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]]() - |
+ | : [[API ItemTextGetCreator|ItemTextGetCreator]]() - Returns the name of the character who created the item text. |
− | : [[API ItemTextGetItem|ItemTextGetItem]]() - |
+ | : [[API ItemTextGetItem|ItemTextGetItem]]() - Returns the item name that the item text belongs to. |
− | : [[API ItemTextGetMaterial|ItemTextGetMaterial]]() - |
+ | : [[API ItemTextGetMaterial|ItemTextGetMaterial]]() - Returns the material texture for the item text. |
− | : [[API ItemTextGetPage|ItemTextGetPage]]() - |
+ | : [[API ItemTextGetPage|ItemTextGetPage]]() - Returns the page number of the currently displayed page. |
− | : [[API ItemTextGetText|ItemTextGetText]]() - |
+ | : [[API ItemTextGetText|ItemTextGetText]]() - Returns the contents of the currently displayed page. |
− | : [[API ItemTextHasNextPage|ItemTextHasNextPage]]() - |
+ | : [[API ItemTextHasNextPage|ItemTextHasNextPage]]() - Returns true if there is a page after the current page. |
: [[API ItemTextIsFullPage|ItemTextIsFullPage]]() |
: [[API ItemTextIsFullPage|ItemTextIsFullPage]]() |
||
− | : [[API ItemTextNextPage|ItemTextNextPage]]() - |
+ | : [[API ItemTextNextPage|ItemTextNextPage]]() - Moves to the next page of the item text. |
− | : [[API ItemTextPrevPage|ItemTextPrevPage]]() - |
+ | : [[API ItemTextPrevPage|ItemTextPrevPage]]() - Moves to the previous page of the item text. |
− | == |
+ | ==Calendar== |
− | The [[Calendar]] was added in [[Patch 3.0.1]]. |
+ | The [[Calendar]] was added in [[Patch 3.0.1]] and reworked in [[Patch 8.0.1]] |
− | : |
+ | : [[API C_Calendar.AddEvent|C_Calendar.AddEvent]]() {{apitag|hwevent}} - Saves the new event currently being created to the server. |
− | : [[API C_Calendar.AreNamesReady|C_Calendar.AreNamesReady]]() |
+ | : [[API C_Calendar.AreNamesReady|C_Calendar.AreNamesReady]]() : <span class="apiret">ready</span> |
− | : [[API C_Calendar.CanAddEvent|C_Calendar.CanAddEvent]]() - 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. |
− | : [[API C_Calendar.CanSendInvite|C_Calendar.CanSendInvite]]() - Returns whether the player can send invites. |
+ | : [[API C_Calendar.CanSendInvite|C_Calendar.CanSendInvite]]() : <span class="apiret">canSendInvite</span> - Returns whether the player can send invites. |
: [[API C_Calendar.CloseEvent|C_Calendar.CloseEvent]]() - Closes the selected event without saving it. |
: [[API C_Calendar.CloseEvent|C_Calendar.CloseEvent]]() - Closes the selected event without saving it. |
||
− | : [[API C_Calendar.ContextMenuEventCanComplain|C_Calendar.ContextMenuEventCanComplain]](<span |
+ | : [[API C_Calendar.ContextMenuEventCanComplain|C_Calendar.ContextMenuEventCanComplain]](<span class="apiarg">offsetMonths, monthDay, eventIndex</span>) : <span class="apiret">canComplain</span> - Returns whether the player can report the event as spam. |
− | : [[API C_Calendar.ContextMenuEventCanEdit|C_Calendar.ContextMenuEventCanEdit]](<span |
+ | : [[API C_Calendar.ContextMenuEventCanEdit|C_Calendar.ContextMenuEventCanEdit]](<span class="apiarg">offsetMonths, monthDay, eventIndex</span>) : <span class="apiret">canEdit</span> - Returns whether the player can edit the event. |
− | : [[API C_Calendar.ContextMenuEventCanRemove|C_Calendar.ContextMenuEventCanRemove]](<span |
+ | : [[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]]() |
+ | : [[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]]() |
+ | : [[API C_Calendar.ContextMenuEventGetCalendarType|C_Calendar.ContextMenuEventGetCalendarType]]() : <span class="apiret">calendarType</span> |
− | : [[API C_Calendar.ContextMenuEventPaste|C_Calendar.ContextMenuEventPaste]](<span |
+ | : [[API C_Calendar.ContextMenuEventPaste|C_Calendar.ContextMenuEventPaste]](<span class="apiarg">offsetMonths, monthDay</span>) - Pastes the clipboard event to the date. |
: [[API C_Calendar.ContextMenuEventRemove|C_Calendar.ContextMenuEventRemove]]() - Deletes the event. |
: [[API C_Calendar.ContextMenuEventRemove|C_Calendar.ContextMenuEventRemove]]() - Deletes the event. |
||
: [[API C_Calendar.ContextMenuEventSignUp|C_Calendar.ContextMenuEventSignUp]]() |
: [[API C_Calendar.ContextMenuEventSignUp|C_Calendar.ContextMenuEventSignUp]]() |
||
− | : [[API C_Calendar.ContextMenuGetEventIndex|C_Calendar.ContextMenuGetEventIndex]]() |
+ | : [[API C_Calendar.ContextMenuGetEventIndex|C_Calendar.ContextMenuGetEventIndex]]() : <span class="apiret">info</span> |
: [[API C_Calendar.ContextMenuInviteAvailable|C_Calendar.ContextMenuInviteAvailable]]() - Accepts the invitation to the event. |
: [[API C_Calendar.ContextMenuInviteAvailable|C_Calendar.ContextMenuInviteAvailable]]() - Accepts the invitation to the event. |
||
: [[API C_Calendar.ContextMenuInviteDecline|C_Calendar.ContextMenuInviteDecline]]() - Declines the invitation to the event. |
: [[API C_Calendar.ContextMenuInviteDecline|C_Calendar.ContextMenuInviteDecline]]() - Declines the invitation to the event. |
||
: [[API C_Calendar.ContextMenuInviteRemove|C_Calendar.ContextMenuInviteRemove]]() - Removes the event from the calendar. |
: [[API C_Calendar.ContextMenuInviteRemove|C_Calendar.ContextMenuInviteRemove]]() - Removes the event from the calendar. |
||
: [[API C_Calendar.ContextMenuInviteTentative|C_Calendar.ContextMenuInviteTentative]]() |
: [[API C_Calendar.ContextMenuInviteTentative|C_Calendar.ContextMenuInviteTentative]]() |
||
− | : [[API C_Calendar.ContextMenuSelectEvent|C_Calendar.ContextMenuSelectEvent]](<span |
+ | : [[API C_Calendar.ContextMenuSelectEvent|C_Calendar.ContextMenuSelectEvent]](<span class="apiarg">offsetMonths, monthDay, eventIndex</span>) |
: [[API C_Calendar.CreateCommunitySignUpEvent|C_Calendar.CreateCommunitySignUpEvent]]() |
: [[API C_Calendar.CreateCommunitySignUpEvent|C_Calendar.CreateCommunitySignUpEvent]]() |
||
: [[API C_Calendar.CreateGuildAnnouncementEvent|C_Calendar.CreateGuildAnnouncementEvent]]() |
: [[API C_Calendar.CreateGuildAnnouncementEvent|C_Calendar.CreateGuildAnnouncementEvent]]() |
||
Line 555: | Line 1,108: | ||
: [[API C_Calendar.CreatePlayerEvent|C_Calendar.CreatePlayerEvent]]() - Creates a new calendar event candidate for the player. |
: [[API C_Calendar.CreatePlayerEvent|C_Calendar.CreatePlayerEvent]]() - Creates a new calendar event candidate for the player. |
||
: [[API C_Calendar.EventAvailable|C_Calendar.EventAvailable]]() - Accepts the invitation to the currently open event. |
: [[API C_Calendar.EventAvailable|C_Calendar.EventAvailable]]() - Accepts the invitation to the currently open event. |
||
− | : [[API C_Calendar.EventCanEdit|C_Calendar.EventCanEdit]]() - Returns whether the event can be edited. |
+ | : [[API C_Calendar.EventCanEdit|C_Calendar.EventCanEdit]]() : <span class="apiret">canEdit</span> - Returns whether the event can be edited. |
: [[API C_Calendar.EventClearAutoApprove|C_Calendar.EventClearAutoApprove]]() - Turns off automatic confirmations. |
: [[API C_Calendar.EventClearAutoApprove|C_Calendar.EventClearAutoApprove]]() - Turns off automatic confirmations. |
||
: [[API C_Calendar.EventClearLocked|C_Calendar.EventClearLocked]]() - Unlocks the event. |
: [[API C_Calendar.EventClearLocked|C_Calendar.EventClearLocked]]() - Unlocks the event. |
||
− | : [[API C_Calendar.EventClearModerator|C_Calendar.EventClearModerator]](<span |
+ | : [[API C_Calendar.EventClearModerator|C_Calendar.EventClearModerator]](<span class="apiarg">inviteIndex</span>) |
: [[API C_Calendar.EventDecline|C_Calendar.EventDecline]]() - Declines the invitation to the currently open event. |
: [[API C_Calendar.EventDecline|C_Calendar.EventDecline]]() - Declines the invitation to the currently open event. |
||
− | : [[API C_Calendar.EventGetCalendarType|C_Calendar.EventGetCalendarType]]() |
+ | : [[API C_Calendar.EventGetCalendarType|C_Calendar.EventGetCalendarType]]() : <span class="apiret">calendarType</span> |
− | : [[API C_Calendar.EventGetClubId|C_Calendar.EventGetClubId]]() |
+ | : [[API C_Calendar.EventGetClubId|C_Calendar.EventGetClubId]]() : <span class="apiret">info</span> |
− | : [[API C_Calendar.EventGetInvite|C_Calendar.EventGetInvite]](<span |
+ | : [[API C_Calendar.EventGetInvite|C_Calendar.EventGetInvite]](<span class="apiarg">eventIndex</span>) : <span class="apiret">info</span> - Returns status information for an invitee for the currently opened event. |
− | : [[API C_Calendar.EventGetInviteResponseTime|C_Calendar.EventGetInviteResponseTime]](<span |
+ | : [[API C_Calendar.EventGetInviteResponseTime|C_Calendar.EventGetInviteResponseTime]](<span class="apiarg">eventIndex</span>) : <span class="apiret">time</span> |
− | : [[API C_Calendar.EventGetInviteSortCriterion|C_Calendar.EventGetInviteSortCriterion]]() |
+ | : [[API C_Calendar.EventGetInviteSortCriterion|C_Calendar.EventGetInviteSortCriterion]]() : <span class="apiret">criterion, reverse</span> |
− | : [[API C_Calendar.EventGetSelectedInvite|C_Calendar.EventGetSelectedInvite]]() |
+ | : [[API C_Calendar.EventGetSelectedInvite|C_Calendar.EventGetSelectedInvite]]() : <span class="apiret">inviteIndex</span> |
− | : [[API C_Calendar.EventGetStatusOptions|C_Calendar.EventGetStatusOptions]](<span |
+ | : [[API C_Calendar.EventGetStatusOptions|C_Calendar.EventGetStatusOptions]](<span class="apiarg">eventIndex</span>) : <span class="apiret">options</span> |
− | : [[API C_Calendar.EventGetTextures|C_Calendar.EventGetTextures]](<span |
+ | : [[API C_Calendar.EventGetTextures|C_Calendar.EventGetTextures]](<span class="apiarg">eventType</span>) : <span class="apiret">textures</span> |
− | : [[API C_Calendar.EventGetTypes|C_Calendar.EventGetTypes]]() |
+ | : [[API C_Calendar.EventGetTypes|C_Calendar.EventGetTypes]]() : <span class="apiret">types</span> |
− | : [[API C_Calendar.EventGetTypesDisplayOrdered|C_Calendar.EventGetTypesDisplayOrdered]]() |
+ | : [[API C_Calendar.EventGetTypesDisplayOrdered|C_Calendar.EventGetTypesDisplayOrdered]]() : <span class="apiret">infos</span> |
− | : [[API C_Calendar.EventHasPendingInvite|C_Calendar.EventHasPendingInvite]]() - Returns whether the player has an unanswered invitation to the currently selected event. |
+ | : [[API C_Calendar.EventHasPendingInvite|C_Calendar.EventHasPendingInvite]]() : <span class="apiret">hasPendingInvite</span> - Returns whether the player has an unanswered invitation to the currently selected event. |
− | : [[API C_Calendar.EventHaveSettingsChanged|C_Calendar.EventHaveSettingsChanged]]() - Returns whether the currently opened event has been modified. |
+ | : [[API C_Calendar.EventHaveSettingsChanged|C_Calendar.EventHaveSettingsChanged]]() : <span class="apiret">haveSettingsChanged</span> - Returns whether the currently opened event has been modified. |
− | : [[API C_Calendar.EventInvite|C_Calendar.EventInvite]](<span |
+ | : [[API C_Calendar.EventInvite|C_Calendar.EventInvite]](<span class="apiarg">name</span>) - Invites a player to the currently selected event. |
− | : [[API C_Calendar.EventRemoveInvite|C_Calendar.EventRemoveInvite]](<span |
+ | : [[API C_Calendar.EventRemoveInvite|C_Calendar.EventRemoveInvite]](<span class="apiarg">inviteIndex</span>) |
− | : [[API C_Calendar. |
+ | : [[API C_Calendar.EventRemoveInviteByGuid|C_Calendar.EventRemoveInviteByGuid]](<span class="apiarg">guid</span>) |
+ | : [[API C_Calendar.EventSelectInvite|C_Calendar.EventSelectInvite]](<span class="apiarg">inviteIndex</span>) |
||
: [[API C_Calendar.EventSetAutoApprove|C_Calendar.EventSetAutoApprove]]() |
: [[API C_Calendar.EventSetAutoApprove|C_Calendar.EventSetAutoApprove]]() |
||
− | : [[API C_Calendar.EventSetClubId|C_Calendar.EventSetClubId]](<span |
+ | : [[API C_Calendar.EventSetClubId|C_Calendar.EventSetClubId]](<span class="apiarg">[clubId]</span>) |
− | : [[API C_Calendar.EventSetDate|C_Calendar.EventSetDate]](<span |
+ | : [[API C_Calendar.EventSetDate|C_Calendar.EventSetDate]](<span class="apiarg">month, monthDay, year</span>) - Sets the date for the currently opened event. |
− | : [[API C_Calendar.EventSetDescription|C_Calendar.EventSetDescription]](<span |
+ | : [[API C_Calendar.EventSetDescription|C_Calendar.EventSetDescription]](<span class="apiarg">description</span>) |
− | : [[API C_Calendar.EventSetInviteStatus|C_Calendar.EventSetInviteStatus]](<span |
+ | : [[API C_Calendar.EventSetInviteStatus|C_Calendar.EventSetInviteStatus]](<span class="apiarg">eventIndex, status</span>) - Sets the invitation status of a player to the current event. |
: [[API C_Calendar.EventSetLocked|C_Calendar.EventSetLocked]]() |
: [[API C_Calendar.EventSetLocked|C_Calendar.EventSetLocked]]() |
||
− | : [[API C_Calendar.EventSetModerator|C_Calendar.EventSetModerator]](<span |
+ | : [[API C_Calendar.EventSetModerator|C_Calendar.EventSetModerator]](<span class="apiarg">inviteIndex</span>) |
− | : [[API C_Calendar.EventSetTextureID|C_Calendar.EventSetTextureID]](<span |
+ | : [[API C_Calendar.EventSetTextureID|C_Calendar.EventSetTextureID]](<span class="apiarg">textureIndex</span>) |
− | : [[API C_Calendar.EventSetTime|C_Calendar.EventSetTime]](<span |
+ | : [[API C_Calendar.EventSetTime|C_Calendar.EventSetTime]](<span class="apiarg">hour, minute</span>) - Sets the time for the currently opened event. |
− | : [[API C_Calendar.EventSetTitle|C_Calendar.EventSetTitle]](<span |
+ | : [[API C_Calendar.EventSetTitle|C_Calendar.EventSetTitle]](<span class="apiarg">title</span>) - Sets the title for the currently opened event. |
− | : [[API C_Calendar.EventSetType|C_Calendar.EventSetType]](<span |
+ | : [[API C_Calendar.EventSetType|C_Calendar.EventSetType]](<span class="apiarg">typeIndex</span>) - Sets the event type for the current calendar event. |
: [[API C_Calendar.EventSignUp|C_Calendar.EventSignUp]]() |
: [[API C_Calendar.EventSignUp|C_Calendar.EventSignUp]]() |
||
− | : [[API C_Calendar.EventSortInvites|C_Calendar.EventSortInvites]](<span |
+ | : [[API C_Calendar.EventSortInvites|C_Calendar.EventSortInvites]](<span class="apiarg">criterion, reverse</span>) |
: [[API C_Calendar.EventTentative|C_Calendar.EventTentative]]() |
: [[API C_Calendar.EventTentative|C_Calendar.EventTentative]]() |
||
− | : [[API C_Calendar.GetClubCalendarEvents|C_Calendar.GetClubCalendarEvents]](<span |
+ | : [[API C_Calendar.GetClubCalendarEvents|C_Calendar.GetClubCalendarEvents]](<span class="apiarg">clubId, startTime, endTime</span>) : <span class="apiret">events</span> |
− | : [[API C_Calendar.GetDayEvent|C_Calendar.GetDayEvent]](<span |
+ | : [[API C_Calendar.GetDayEvent|C_Calendar.GetDayEvent]](<span class="apiarg">monthOffset, monthDay, index</span>) : <span class="apiret">event</span> - Retrieve information about the specified event. |
− | : [[API C_Calendar.GetDefaultGuildFilter|C_Calendar.GetDefaultGuildFilter]]() |
+ | : [[API C_Calendar.GetDefaultGuildFilter|C_Calendar.GetDefaultGuildFilter]]() : <span class="apiret">info</span> |
− | : [[API C_Calendar.GetEventIndex|C_Calendar.GetEventIndex]]() |
+ | : [[API C_Calendar.GetEventIndex|C_Calendar.GetEventIndex]]() : <span class="apiret">info</span> |
− | : [[API C_Calendar.GetEventIndexInfo|C_Calendar.GetEventIndexInfo]](<span |
+ | : [[API C_Calendar.GetEventIndexInfo|C_Calendar.GetEventIndexInfo]](<span class="apiarg">eventID [, monthOffset, monthDay]</span>) : <span class="apiret">eventIndexInfo</span> |
− | : [[API C_Calendar.GetEventInfo|C_Calendar.GetEventInfo]]() - Returns |
+ | : [[API C_Calendar.GetEventInfo|C_Calendar.GetEventInfo]]() : <span class="apiret">info</span> - Returns info for a calendar event. |
− | : [[API C_Calendar.GetFirstPendingInvite|C_Calendar.GetFirstPendingInvite]](<span |
+ | : [[API C_Calendar.GetFirstPendingInvite|C_Calendar.GetFirstPendingInvite]](<span class="apiarg">offsetMonths, monthDay</span>) : <span class="apiret">firstPendingInvite</span> |
− | : [[API C_Calendar.GetGuildEventInfo|C_Calendar.GetGuildEventInfo]](<span |
+ | : [[API C_Calendar.GetGuildEventInfo|C_Calendar.GetGuildEventInfo]](<span class="apiarg">index</span>) : <span class="apiret">info</span> |
− | : [[API C_Calendar.GetGuildEventSelectionInfo|C_Calendar.GetGuildEventSelectionInfo]](<span |
+ | : [[API C_Calendar.GetGuildEventSelectionInfo|C_Calendar.GetGuildEventSelectionInfo]](<span class="apiarg">index</span>) : <span class="apiret">info</span> |
− | : [[API C_Calendar.GetHolidayInfo|C_Calendar.GetHolidayInfo]](<span |
+ | : [[API C_Calendar.GetHolidayInfo|C_Calendar.GetHolidayInfo]](<span class="apiarg">monthOffset, monthDay, index</span>) : <span class="apiret">event</span> - Returns seasonal holiday info. |
− | : [[API C_Calendar.GetMaxCreateDate|C_Calendar.GetMaxCreateDate]]() - Returns the last day supported by the Calendar API. |
+ | : [[API C_Calendar.GetMaxCreateDate|C_Calendar.GetMaxCreateDate]]() : <span class="apiret">maxCreateDate</span> - Returns the last day supported by the Calendar API. |
− | : [[API C_Calendar.GetMinDate|C_Calendar.GetMinDate]]() - Returns the first day supported by the Calendar API. |
+ | : [[API C_Calendar.GetMinDate|C_Calendar.GetMinDate]]() : <span class="apiret">minDate</span> - Returns the first day supported by the Calendar API. |
− | : [[API C_Calendar.GetMonthInfo|C_Calendar.GetMonthInfo]](<span |
+ | : [[API C_Calendar.GetMonthInfo|C_Calendar.GetMonthInfo]](<span class="apiarg">[offsetMonths]</span>) : <span class="apiret">monthInfo</span> - Returns information about the calendar month by offset. |
− | : [[API C_Calendar.GetNextClubId|C_Calendar.GetNextClubId]]() |
+ | : [[API C_Calendar.GetNextClubId|C_Calendar.GetNextClubId]]() : <span class="apiret">clubId</span> |
− | : [[API C_Calendar.GetNumDayEvents|C_Calendar.GetNumDayEvents]](<span |
+ | : [[API C_Calendar.GetNumDayEvents|C_Calendar.GetNumDayEvents]](<span class="apiarg">offsetMonths, monthDay</span>) : <span class="apiret">numDayEvents</span> - Returns the number of events for a given day/month offset. |
− | : [[API C_Calendar.GetNumGuildEvents|C_Calendar.GetNumGuildEvents]]() |
+ | : [[API C_Calendar.GetNumGuildEvents|C_Calendar.GetNumGuildEvents]]() : <span class="apiret">numGuildEvents</span> |
− | : [[API C_Calendar.GetNumInvites|C_Calendar.GetNumInvites]]() - Returns the number of invitees for the currently opened event. |
+ | : [[API C_Calendar.GetNumInvites|C_Calendar.GetNumInvites]]() : <span class="apiret">num</span> - Returns the number of invitees for the currently opened event. |
− | : [[API C_Calendar.GetNumPendingInvites|C_Calendar.GetNumPendingInvites]]() |
+ | : [[API C_Calendar.GetNumPendingInvites|C_Calendar.GetNumPendingInvites]]() : <span class="apiret">num</span> |
− | : [[API C_Calendar.GetRaidInfo|C_Calendar.GetRaidInfo]](<span |
+ | : [[API C_Calendar.GetRaidInfo|C_Calendar.GetRaidInfo]](<span class="apiarg">offsetMonths, monthDay, eventIndex</span>) : <span class="apiret">info</span> |
− | : [[API C_Calendar.IsActionPending|C_Calendar.IsActionPending]]() |
+ | : [[API C_Calendar.IsActionPending|C_Calendar.IsActionPending]]() : <span class="apiret">actionPending</span> |
− | : [[API C_Calendar.IsEventOpen|C_Calendar.IsEventOpen]]() |
+ | : [[API C_Calendar.IsEventOpen|C_Calendar.IsEventOpen]]() : <span class="apiret">isOpen</span> |
− | : [[API C_Calendar.MassInviteCommunity|C_Calendar.MassInviteCommunity]](<span |
+ | : [[API C_Calendar.MassInviteCommunity|C_Calendar.MassInviteCommunity]](<span class="apiarg">clubId, minLevel, maxLevel [, maxRankOrder]</span>) |
− | : [[API C_Calendar.MassInviteGuild|C_Calendar.MassInviteGuild]](<span |
+ | : [[API C_Calendar.MassInviteGuild|C_Calendar.MassInviteGuild]](<span class="apiarg">minLevel, maxLevel, maxRankOrder</span>) |
: [[API C_Calendar.OpenCalendar|C_Calendar.OpenCalendar]]() - Requests calendar information from the server. Does not open the calendar frame. |
: [[API C_Calendar.OpenCalendar|C_Calendar.OpenCalendar]]() - Requests calendar information from the server. Does not open the calendar frame. |
||
− | : [[API C_Calendar.OpenEvent|C_Calendar.OpenEvent]](<span |
+ | : [[API C_Calendar.OpenEvent|C_Calendar.OpenEvent]](<span class="apiarg">offsetMonths, monthDay, index</span>) : <span class="apiret">success</span> - Establishes an event for future calendar API calls |
: [[API C_Calendar.RemoveEvent|C_Calendar.RemoveEvent]]() - Removes the selected event from the calendar (invitees only). |
: [[API C_Calendar.RemoveEvent|C_Calendar.RemoveEvent]]() - Removes the selected event from the calendar (invitees only). |
||
− | : [[API C_Calendar.SetAbsMonth|C_Calendar.SetAbsMonth]](<span |
+ | : [[API C_Calendar.SetAbsMonth|C_Calendar.SetAbsMonth]](<span class="apiarg">month, year</span>) - Sets the reference month and year for functions which use a month offset. |
− | : [[API C_Calendar.SetMonth|C_Calendar.SetMonth]](<span |
+ | : [[API C_Calendar.SetMonth|C_Calendar.SetMonth]](<span class="apiarg">offsetMonths</span>) |
− | : [[API C_Calendar.SetNextClubId|C_Calendar.SetNextClubId]](<span |
+ | : [[API C_Calendar.SetNextClubId|C_Calendar.SetNextClubId]](<span class="apiarg">[clubId]</span>) |
− | : |
+ | : [[API C_Calendar.UpdateEvent|C_Calendar.UpdateEvent]]() {{apitag|hwevent}} - Saves the selected event. |
− | : DEPRECATED (8.1.0) [[API C_Calendar.GetDate|C_Calendar.GetDate]]() |
||
− | |||
− | === Camera === |
||
− | : PROTECTED [[API CameraOrSelectOrMoveStart|CameraOrSelectOrMoveStart]]() - Begin "Left click" in the 3D world. |
||
− | : PROTECTED [[API CameraOrSelectOrMoveStop|CameraOrSelectOrMoveStop]](<span style="font-size:smaller; color:#ecbc2a">[stickyFlag]</span>) - End "Left click" in the 3D world. |
||
− | : [[API CameraZoomIn|CameraZoomIn]](<span style="font-size:smaller; color:#ecbc2a">increment</span>) - Zooms the camera into the viewplane by increment. |
||
− | : [[API CameraZoomOut|CameraZoomOut]](<span style="font-size:smaller; color:#ecbc2a">increment</span>) - Zooms the camera out of the viewplane by increment. |
||
− | : [[API CenterCamera|CenterCamera]]() |
||
− | : [[API FlipCameraYaw|FlipCameraYaw]](<span style="font-size:smaller; color:#ecbc2a">degrees</span>) - Rotates the camera about the Z-axis by the angle amount specified in degrees. |
||
− | : [[API GetCameraZoom|GetCameraZoom]]() - Returns the current zoom level, ignoring camera collisions. |
||
− | : [[API IsMouselooking|IsMouselooking]]() - Returns 1 if mouselook is currently active, nil otherwise. |
||
− | : [[API MouselookStart|MouselookStart]]() - Enters mouse look mode; mouse movement is used to adjust movement/facing direction. |
||
− | : [[API MouselookStop|MouselookStop]]() - Exits mouse look mode; mouse movement is used to move the mouse cursor. |
||
− | : [[API MoveViewDownStart|MoveViewDownStart]]() - Begins rotating the camera downward. |
||
− | : [[API MoveViewDownStop|MoveViewDownStop]]() - Stops rotating the camera after [[API MoveViewDownStart|MoveViewDownStart]]() is called. |
||
− | : [[API MoveViewInStart|MoveViewInStart]]() - Begins zooming the camera in. |
||
− | : [[API MoveViewInStop|MoveViewInStop]]() - Stops zooming the camera in after [[API MoveViewInStart|MoveViewInStart]]() is called. |
||
− | : [[API MoveViewLeftStart|MoveViewLeftStart]]() - Begins rotating the camera to the Left. |
||
− | : [[API MoveViewLeftStop|MoveViewLeftStop]]() - Stops rotating the camera after [[API MoveViewLeftStart|MoveViewLeftStart]]() is called. |
||
− | : [[API MoveViewOutStart|MoveViewOutStart]]() - Begins zooming the camera out. |
||
− | : [[API MoveViewOutStop|MoveViewOutStop]]() - Stops zooming the camera out after [[API MoveViewOutStart|MoveViewOutStart]]() is called. |
||
− | : [[API MoveViewRightStart|MoveViewRightStart]]() - Begins rotating the camera to the Right. |
||
− | : [[API MoveViewRightStop|MoveViewRightStop]]() - Stops rotating the camera after [[API MoveViewRightStart|MoveViewRightStart]]() is called. |
||
− | : [[API MoveViewUpStart|MoveViewUpStart]]() - Begins rotating the camera upward. |
||
− | : [[API MoveViewUpStop|MoveViewUpStop]]() - Stops rotating the camera after [[API MoveViewUpStart|MoveViewUpStart]]() is called. |
||
− | : PROTECTED [[API PitchDownStart|PitchDownStart]]() - Begins pitching the camera Downward. |
||
− | : PROTECTED [[API PitchDownStop|PitchDownStop]]() - Stops pitching the camera after [[API PitchDownStart|PitchDownStart]]() is called. |
||
− | : PROTECTED [[API PitchUpStart|PitchUpStart]]() - Begins pitching the camera Upward. |
||
− | : PROTECTED [[API PitchUpStop|PitchUpStop]]() - Stops pitching the camera after [[API PitchUpStart|PitchUpStart]]() is called. |
||
− | : [[API NextView|NextView]]() - Cycles forward through the five predefined camera positions. |
||
− | : [[API PrevView|PrevView]]() - Cycles backward through the five predefined camera positions. |
||
− | : [[API ResetView|ResetView]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Resets the specified (1-5) predefined camera position to it's default if it was changed using [[API SaveView|SaveView]](index). |
||
− | : [[API SaveView|SaveView]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Replaces the specified (1-5) predefined camera positions with the current camera position. |
||
− | : [[API SetView|SetView]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Sets camera position to a specified (1-5) predefined camera position. |
||
− | == |
+ | ==Chat== |
− | These are |
+ | These are specific to chat messages and channels. |
− | : [[API C_ChatInfo. |
+ | : [[API C_ChatInfo.GetChannelInfoFromIdentifier|C_ChatInfo.GetChannelInfoFromIdentifier]](<span class="apiarg">channelIdentifier</span>) : <span class="apiret">info</span> |
− | : [[API C_ChatInfo. |
+ | : [[API C_ChatInfo.GetChannelRosterInfo|C_ChatInfo.GetChannelRosterInfo]](<span class="apiarg">channelIndex, rosterIndex</span>) : <span class="apiret">name, owner, moderator, guid</span> |
− | : [[API C_ChatInfo. |
+ | : [[API C_ChatInfo.GetChannelRuleset|C_ChatInfo.GetChannelRuleset]](<span class="apiarg">channelIndex</span>) : <span class="apiret">ruleset</span> |
− | : [[API C_ChatInfo. |
+ | : [[API C_ChatInfo.GetChannelRulesetForChannelID|C_ChatInfo.GetChannelRulesetForChannelID]](<span class="apiarg">channelID</span>) : <span class="apiret">ruleset</span> |
− | : [[API C_ChatInfo. |
+ | : [[API C_ChatInfo.GetChannelShortcut|C_ChatInfo.GetChannelShortcut]](<span class="apiarg">channelIndex</span>) : <span class="apiret">shortcut</span> |
− | : [[API C_ChatInfo. |
+ | : [[API C_ChatInfo.GetChannelShortcutForChannelID|C_ChatInfo.GetChannelShortcutForChannelID]](<span class="apiarg">channelID</span>) : <span class="apiret">shortcut</span> |
− | : [[API C_ChatInfo. |
+ | : [[API C_ChatInfo.GetChatTypeName|C_ChatInfo.GetChatTypeName]](<span class="apiarg">typeID</span>) : <span class="apiret">name</span> |
− | : [[API C_ChatInfo. |
+ | : [[API C_ChatInfo.GetClubStreamIDs|C_ChatInfo.GetClubStreamIDs]](<span class="apiarg">clubID</span>) : <span class="apiret">ids</span> |
− | : [[API C_ChatInfo. |
+ | : [[API C_ChatInfo.GetGeneralChannelID|C_ChatInfo.GetGeneralChannelID]]() : <span class="apiret">channelID</span> |
− | : [[API C_ChatInfo. |
+ | : [[API C_ChatInfo.GetGeneralChannelLocalID|C_ChatInfo.GetGeneralChannelLocalID]]() : <span class="apiret">localID</span> |
− | : [[API C_ChatInfo. |
+ | : [[API C_ChatInfo.GetMentorChannelID|C_ChatInfo.GetMentorChannelID]]() : <span class="apiret">channelID</span> |
− | : [[API C_ChatInfo. |
+ | : [[API C_ChatInfo.GetNumActiveChannels|C_ChatInfo.GetNumActiveChannels]]() : <span class="apiret">numChannels</span> |
− | : [[API C_ChatInfo. |
+ | : [[API C_ChatInfo.GetNumReservedChatWindows|C_ChatInfo.GetNumReservedChatWindows]]() : <span class="apiret">numReserved</span> |
− | : [[API C_ChatInfo. |
+ | : [[API C_ChatInfo.IsChannelRegional|C_ChatInfo.IsChannelRegional]](<span class="apiarg">channelIndex</span>) : <span class="apiret">isRegional</span> |
− | : [[API C_ChatInfo. |
+ | : [[API C_ChatInfo.IsChannelRegionalForChannelID|C_ChatInfo.IsChannelRegionalForChannelID]](<span class="apiarg">channelID</span>) : <span class="apiret">isRegional</span> |
+ | : [[API C_ChatInfo.IsPartyChannelType|C_ChatInfo.IsPartyChannelType]](<span class="apiarg">channelType</span>) : <span class="apiret">isPartyChannelType</span> |
||
− | : [[API C_ChatInfo.IsRegionalServiceAvailable|C_ChatInfo.IsRegionalServiceAvailable]]() |
||
− | : [[API C_ChatInfo. |
+ | : [[API C_ChatInfo.IsRegionalServiceAvailable|C_ChatInfo.IsRegionalServiceAvailable]]() : <span class="apiret">available</span> |
− | : [[API C_ChatInfo. |
+ | : [[API C_ChatInfo.IsValidChatLine|C_ChatInfo.IsValidChatLine]](<span class="apiarg">[chatLine]</span>) : <span class="apiret">isValid</span> |
− | : [[API C_ChatInfo.ReplaceIconAndGroupExpressions|C_ChatInfo.ReplaceIconAndGroupExpressions]](<span |
+ | : [[API C_ChatInfo.ReplaceIconAndGroupExpressions|C_ChatInfo.ReplaceIconAndGroupExpressions]](<span class="apiarg">input [, noIconReplacement, noGroupReplacement]</span>) : <span class="apiret">output</span> - Replaces icon and group tags like {rt4}, {diamond} and {g1}. |
: [[API C_ChatInfo.ResetDefaultZoneChannels|C_ChatInfo.ResetDefaultZoneChannels]]() |
: [[API C_ChatInfo.ResetDefaultZoneChannels|C_ChatInfo.ResetDefaultZoneChannels]]() |
||
− | : [[API C_ChatInfo. |
+ | : [[API C_ChatInfo.SwapChatChannelsByChannelIndex|C_ChatInfo.SwapChatChannelsByChannelIndex]](<span class="apiarg">firstChannelIndex, secondChannelIndex</span>) |
+ | : [[API C_ChatBubbles.GetAllChatBubbles|C_ChatBubbles.GetAllChatBubbles]](<span class="apiarg">[includeForbidden]</span>) : <span class="apiret">chatBubbles</span> - Returns all active chat bubbles. |
||
− | : [[API C_ChatInfo.SendAddonMessageLogged|C_ChatInfo.SendAddonMessageLogged]](<span style="font-size:smaller; color:#ecbc2a">prefix, message [, chatType, target]</span>) - Sends a message to the hidden addon channel, the messages are logged server side. |
||
− | : [[API C_ChatInfo.SwapChatChannelsByChannelIndex|C_ChatInfo.SwapChatChannelsByChannelIndex]](<span style="font-size:smaller; color:#ecbc2a">firstChannelIndex, secondChannelIndex</span>) |
||
− | : [[API C_ChatBubbles.GetAllChatBubbles|C_ChatBubbles.GetAllChatBubbles]](<span style="font-size:smaller; color:#ecbc2a">[includeForbidden]</span>) - Returns all active chat bubbles. |
||
: [[API CancelEmote|CancelEmote]]() - Stops an active emote, e.g. when closing the map. |
: [[API CancelEmote|CancelEmote]]() - Stops an active emote, e.g. when closing the map. |
||
− | : [[API ChannelBan|ChannelBan]](<span |
+ | : [[API ChannelBan|ChannelBan]](<span class="apiarg">channel, name</span>) - Bans a player from the specified channel. |
− | : [[API ChannelInvite|ChannelInvite]](<span |
+ | : [[API ChannelInvite|ChannelInvite]](<span class="apiarg">channel, name</span>) - Invites the specified user to the channel. |
− | : [[API ChannelKick|ChannelKick]](<span |
+ | : [[API ChannelKick|ChannelKick]](<span class="apiarg">channel, name</span>) - Kicks a player from the specified channel. |
− | : [[API ChannelModerator|ChannelModerator]](<span |
+ | : [[API ChannelModerator|ChannelModerator]](<span class="apiarg">channel, name</span>) - Sets the specified player as the channel moderator. |
− | : [[API ChannelToggleAnnouncements|ChannelToggleAnnouncements]](<span |
+ | : [[API ChannelToggleAnnouncements|ChannelToggleAnnouncements]](<span class="apiarg">channel</span>) - Toggles the channel to display announcements either on or off. |
− | : [[API ChannelUnban|ChannelUnban]](<span |
+ | : [[API ChannelUnban|ChannelUnban]](<span class="apiarg">channel, name</span>) - Unbans a player from the specified channel. |
− | : [[API ChannelUnmoderator|ChannelUnmoderator]](<span |
+ | : [[API ChannelUnmoderator|ChannelUnmoderator]](<span class="apiarg">channel, name</span>) - Takes the specified user away from the moderator status. |
− | : [[API DeclineChannelInvite|DeclineChannelInvite]](<span |
+ | : [[API DeclineChannelInvite|DeclineChannelInvite]](<span class="apiarg">channel</span>) |
− | : [[API DisplayChannelOwner|DisplayChannelOwner]](<span |
+ | : [[API DisplayChannelOwner|DisplayChannelOwner]](<span class="apiarg">channel</span>) - Prints the name of the owner of the specified channel. |
− | : [[API DoEmote|DoEmote]](<span |
+ | : [[API DoEmote|DoEmote]](<span class="apiarg">emote [, target]</span>) - Performs an emote. |
− | : [[API EnumerateServerChannels|EnumerateServerChannels]]() - |
+ | : [[API EnumerateServerChannels|EnumerateServerChannels]]() - Returns all available server channels (zone dependent). |
: [[API GetAlternativeDefaultLanguage|GetAlternativeDefaultLanguage]]() |
: [[API GetAlternativeDefaultLanguage|GetAlternativeDefaultLanguage]]() |
||
− | : [[API GetChannelDisplayInfo|GetChannelDisplayInfo]](<span |
+ | : [[API GetChannelDisplayInfo|GetChannelDisplayInfo]](<span class="apiarg">channelID</span>) - Returns info for chat channels and headers in the Chat Pane. |
− | : [[API GetChannelList|GetChannelList]]() - |
+ | : [[API GetChannelList|GetChannelList]]() - Returns the list of joined chat channels. |
− | : [[API GetChannelName|GetChannelName]](<span |
+ | : [[API GetChannelName|GetChannelName]](<span class="apiarg">channel or index</span>) - Returns info for a chat channel. |
− | : [[API GetDefaultLanguage|GetDefaultLanguage]](<span |
+ | : [[API GetDefaultLanguage|GetDefaultLanguage]](<span class="apiarg">unit</span>) - Returns the character's default language. |
− | : [[API GetLanguageByIndex|GetLanguageByIndex]](<span |
+ | : [[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 705: | Line 1,223: | ||
: [[API IsDisplayChannelModerator|IsDisplayChannelModerator]]() |
: [[API IsDisplayChannelModerator|IsDisplayChannelModerator]]() |
||
: [[API IsDisplayChannelOwner|IsDisplayChannelOwner]]() |
: [[API IsDisplayChannelOwner|IsDisplayChannelOwner]]() |
||
− | : [[API JoinChannelByName|JoinChannelByName]](<span |
+ | : [[API JoinChannelByName|JoinChannelByName]](<span class="apiarg">channelName [, password, frameID, hasVoice]</span>) - Joins the specified chat channel. |
− | : [[API JoinPermanentChannel|JoinPermanentChannel]](<span |
+ | : [[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 |
+ | : [[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 |
+ | : [[API LeaveChannelByLocalID|LeaveChannelByLocalID]](<span class="apiarg">localID</span>) |
− | : [[API LeaveChannelByName|LeaveChannelByName]](<span |
+ | : [[API LeaveChannelByName|LeaveChannelByName]](<span class="apiarg">channel</span>) - Leaves the channel with the specified name. |
− | : [[API ListChannelByName|ListChannelByName]](<span |
+ | : [[API ListChannelByName|ListChannelByName]](<span class="apiarg">channelMatch</span>) - Prints the list of members in the specified channel. |
− | : [[API ListChannels|ListChannels]]() - |
+ | : [[API ListChannels|ListChannels]]() - Prints the list of currently joined chat channel. |
− | : [[API LoggingChat|LoggingChat]](<span |
+ | : [[API LoggingChat|LoggingChat]](<span class="apiarg">newState</span>) - Gets or sets whether logging chat to Logs\WoWChatLog.txt is enabled. |
− | : [[API LoggingCombat|LoggingCombat]](<span |
+ | : [[API LoggingCombat|LoggingCombat]](<span class="apiarg">newState</span>) - Gets or sets whether logging combat to Logs\WoWCombatLog.txt is enabled. |
− | : [[API SendChatMessage|SendChatMessage]](<span |
+ | : [[API SendChatMessage|SendChatMessage]](<span class="apiarg">msg [, chatType, languageID, target]</span>) - Sends a chat message. |
− | : [[API SetChannelOwner|SetChannelOwner]](<span |
+ | : [[API SetChannelOwner|SetChannelOwner]](<span class="apiarg">channel, name</span>) - Sets the channel owner. |
− | : [[API SetChannelPassword|SetChannelPassword]](<span |
+ | : [[API SetChannelPassword|SetChannelPassword]](<span class="apiarg">channel, password</span>) - Changes the password of the current channel. |
− | : [[API SetSelectedDisplayChannel|SetSelectedDisplayChannel]](<span |
+ | : [[API SetSelectedDisplayChannel|SetSelectedDisplayChannel]](<span class="apiarg">channelID</span>) |
− | : DEPRECATED (8.1.0) [[API C_ChatInfo.ReportPlayer|C_ChatInfo.ReportPlayer]](<span style="font-size:smaller; color:#ecbc2a">complaintType, playerLocation, comment</span>) |
||
− | : DEPRECATED (8.1.0) [[API C_ChatInfo.CanReportPlayer|C_ChatInfo.CanReportPlayer]](<span style="font-size:smaller; color:#ecbc2a">playerLocation</span>) - Moved to C_ReportSystem. |
||
− | === |
+ | ===Chat Window=== |
− | These |
+ | These are specific to chat ''window'' management. |
− | : [[API AddChatWindowChannel|AddChatWindowChannel]](<span |
+ | : [[API AddChatWindowChannel|AddChatWindowChannel]](<span class="apiarg">chatFrameIndex, channel</span>) - Enables messages from a chat channel index for a chat window. |
− | : [[API AddChatWindowMessages|AddChatWindowMessages]]() - |
+ | : [[API AddChatWindowMessages|AddChatWindowMessages]]() - Enables messages from the chat message type (e.g. "SAY") for a chat window. |
− | : [[API ChangeChatColor|ChangeChatColor]](<span |
+ | : [[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>) - Returns the index for a chat type. |
||
− | : [[API GetAutoCompleteResults|GetAutoCompleteResults]](<span style="font-size:smaller; color:#ecbc2a">text, include, exclude, maxResults [, cursorPosition]</span>) - Returns possible player names matching a given prefix string and specified requirements. |
||
− | : [[API |
+ | : [[API GetChatWindowChannels|GetChatWindowChannels]](<span class="apiarg">index</span>) - Returns subscribed channels for a chat window. |
− | : [[API |
+ | : [[API GetChatWindowInfo|GetChatWindowInfo]](<span class="apiarg">index</span>) - Returns info for a chat window. |
− | : [[API |
+ | : [[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 GetChatWindowMessages|GetChatWindowMessages]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Get the chat message types received by a chat window. |
||
− | : [[API |
+ | : [[API GetChatWindowSavedPosition|GetChatWindowSavedPosition]](<span class="apiarg">index</span>) |
− | : [[API GetChatWindowSavedPosition|GetChatWindowSavedPosition]](<span style="font-size:smaller; color:#ecbc2a">index</span>) |
||
: [[API RedockChatWindows|RedockChatWindows]]() |
: [[API RedockChatWindows|RedockChatWindows]]() |
||
− | : [[API RemoveChatWindowChannel|RemoveChatWindowChannel]](<span |
+ | : [[API RemoveChatWindowChannel|RemoveChatWindowChannel]](<span class="apiarg">chatFrameIndex, channel</span>) - Removes the specified chat channel from a chat window. |
− | : [[API RemoveChatWindowMessages|RemoveChatWindowMessages]](<span |
+ | : [[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]]() |
||
− | : [[API SetChatColorNameByClass|SetChatColorNameByClass]](<span |
+ | : [[API SetChatColorNameByClass|SetChatColorNameByClass]](<span class="apiarg">chatType, colorNameByClass</span>) |
− | : [[API SetChatWindowAlpha|SetChatWindowAlpha]](<span |
+ | : [[API SetChatWindowAlpha|SetChatWindowAlpha]](<span class="apiarg">index, alpha</span>) - Sets the Alpha value(transparency) of ChatFrame<index> (alpha - 0-100) |
− | : [[API SetChatWindowColor|SetChatWindowColor]](<span |
+ | : [[API SetChatWindowColor|SetChatWindowColor]](<span class="apiarg">index, r, g, b</span>) - Sets the background color of a a chat window. (r/g/b - 0-255) |
− | : [[API SetChatWindowDocked|SetChatWindowDocked]](<span |
+ | : [[API SetChatWindowDocked|SetChatWindowDocked]](<span class="apiarg">index, docked</span>) - Set whether a chat window is docked. (docked - 0/1) |
− | : [[API SetChatWindowLocked|SetChatWindowLocked]](<span |
+ | : [[API SetChatWindowLocked|SetChatWindowLocked]](<span class="apiarg">index, locked</span>) - Sets ChatFrame<index> so that it is or is not movable. (locked - 0/1) |
− | : [[API SetChatWindowName|SetChatWindowName]](<span |
+ | : [[API SetChatWindowName|SetChatWindowName]](<span class="apiarg">index, name</span>) - Sets the alpha value of ChatFrame. |
− | : [[API SetChatWindowSavedDimensions|SetChatWindowSavedDimensions]](<span |
+ | : [[API SetChatWindowSavedDimensions|SetChatWindowSavedDimensions]](<span class="apiarg">index, width, height</span>) |
− | : [[API SetChatWindowSavedPosition|SetChatWindowSavedPosition]](<span |
+ | : [[API SetChatWindowSavedPosition|SetChatWindowSavedPosition]](<span class="apiarg">index, point, xOffsetRatio, yOffsetRatio</span>) |
− | : [[API SetChatWindowShown|SetChatWindowShown]](<span |
+ | : [[API SetChatWindowShown|SetChatWindowShown]](<span class="apiarg">index, shown</span>) - Shows or Hides ChatFrame<index> depending on value of <shown> (shown - 0/1) |
− | : [[API SetChatWindowSize|SetChatWindowSize]](<span |
+ | : [[API SetChatWindowSize|SetChatWindowSize]](<span class="apiarg">index, size</span>) - Sets the font size of a chat window. (size - default 14) |
− | : [[API SetChatWindowUninteractable|SetChatWindowUninteractable]](<span |
+ | : [[API SetChatWindowUninteractable|SetChatWindowUninteractable]](<span class="apiarg">id, isUninteractable</span>) |
− | : |
+ | : [[API ChatFrame_AddChannel|ChatFrame_AddChannel]](<span class="apiarg">chatFrame, channelName</span>) {{apitag|framexml}} - Activate channel in chatFrame. |
− | : |
+ | : [[API ChatFrame_AddMessageEventFilter|ChatFrame_AddMessageEventFilter]](<span class="apiarg">event, filterFunc</span>) {{apitag|framexml}} - Add a chat message filtering function. |
− | : |
+ | : [[API ChatFrame_GetMessageEventFilters|ChatFrame_GetMessageEventFilters]](<span class="apiarg">event</span>) {{apitag|framexml}} - Retreive the list of chat message filtering functions. |
− | : |
+ | : [[API ChatFrame_OnHyperlinkShow|ChatFrame_OnHyperlinkShow]](<span class="apiarg">reference, link, button</span>) {{apitag|framexml}} - Called when the user clicks on a chatlink. |
− | : |
+ | : [[API ChatFrame_RemoveMessageEventFilter|ChatFrame_RemoveMessageEventFilter]](<span class="apiarg">event, filterFunc</span>) {{apitag|framexml}} - Unregister a chat message filtering function. |
− | === |
+ | ===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. |
||
− | [[Guild_%26_Communities|Communities]] were added in [[Patch 8.0.1]]. |
||
+ | : [[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_Club.AcceptInvitation|C_Club.AcceptInvitation]](<span style="font-size:smaller; color:#ecbc2a">clubId</span>) |
||
+ | : [[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_Club.AddClubStreamChatChannel|C_Club.AddClubStreamChatChannel]](<span style="font-size:smaller; color:#ecbc2a">clubId, streamId</span>) |
||
+ | : [[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_Club.AdvanceStreamViewMarker|C_Club.AdvanceStreamViewMarker]](<span style="font-size:smaller; color:#ecbc2a">clubId, streamId</span>) |
||
+ | : [[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_Club.AssignMemberRole|C_Club.AssignMemberRole]](<span style="font-size:smaller; color:#ecbc2a">clubId, memberId, roleId</span>) |
||
+ | |||
− | : [[API C_Club.CanResolvePlayerLocationFromClubMessageData|C_Club.CanResolvePlayerLocationFromClubMessageData]](<span style="font-size:smaller; color:#ecbc2a">clubId, streamId, epoch, position</span>) |
||
+ | ===Communities=== |
||
+ | [[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.AddClubStreamChatChannel|C_Club.AddClubStreamChatChannel]](<span class="apiarg">clubId, streamId</span>) |
||
+ | : [[API C_Club.AdvanceStreamViewMarker|C_Club.AdvanceStreamViewMarker]](<span class="apiarg">clubId, streamId</span>) |
||
+ | : [[API C_Club.AssignMemberRole|C_Club.AssignMemberRole]](<span class="apiarg">clubId, memberId, roleId</span>) |
||
+ | : [[API C_Club.CanResolvePlayerLocationFromClubMessageData|C_Club.CanResolvePlayerLocationFromClubMessageData]](<span class="apiarg">clubId, streamId, epoch, position</span>) : <span class="apiret">canResolve</span> |
||
: [[API C_Club.ClearAutoAdvanceStreamViewMarker|C_Club.ClearAutoAdvanceStreamViewMarker]]() |
: [[API C_Club.ClearAutoAdvanceStreamViewMarker|C_Club.ClearAutoAdvanceStreamViewMarker]]() |
||
: [[API C_Club.ClearClubPresenceSubscription|C_Club.ClearClubPresenceSubscription]]() |
: [[API C_Club.ClearClubPresenceSubscription|C_Club.ClearClubPresenceSubscription]]() |
||
− | : [[API C_Club.CompareBattleNetDisplayName|C_Club.CompareBattleNetDisplayName]](<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 |
+ | : [[API C_Club.CreateClub|C_Club.CreateClub]](<span class="apiarg">name, [shortName], description, clubType, avatarId, [isCrossFaction]</span>) {{apitag|protected}} |
− | : [[API C_Club.CreateStream|C_Club.CreateStream]](<span |
+ | : [[API C_Club.CreateStream|C_Club.CreateStream]](<span class="apiarg">clubId, name, subject, leadersAndModeratorsOnly</span>) |
− | : [[API C_Club.CreateTicket|C_Club.CreateTicket]](<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 |
+ | : [[API C_Club.DeclineInvitation|C_Club.DeclineInvitation]](<span class="apiarg">clubId</span>) |
− | : [[API C_Club.DestroyClub|C_Club.DestroyClub]](<span |
+ | : [[API C_Club.DestroyClub|C_Club.DestroyClub]](<span class="apiarg">clubId</span>) |
− | : [[API C_Club.DestroyMessage|C_Club.DestroyMessage]](<span |
+ | : [[API C_Club.DestroyMessage|C_Club.DestroyMessage]](<span class="apiarg">clubId, streamId, messageId</span>) |
− | : [[API C_Club.DestroyStream|C_Club.DestroyStream]](<span |
+ | : [[API C_Club.DestroyStream|C_Club.DestroyStream]](<span class="apiarg">clubId, streamId</span>) |
− | : [[API C_Club.DestroyTicket|C_Club.DestroyTicket]](<span |
+ | : [[API C_Club.DestroyTicket|C_Club.DestroyTicket]](<span class="apiarg">clubId, ticketId</span>) |
− | : [[API C_Club. |
+ | : [[API C_Club.DoesCommunityHaveMembersOfTheOppositeFaction|C_Club.DoesCommunityHaveMembersOfTheOppositeFaction]](<span class="apiarg">clubId</span>) : <span class="apiret">hasMembersOfOppositeFaction</span> |
− | : [[API C_Club. |
+ | : [[API C_Club.EditClub|C_Club.EditClub]](<span class="apiarg">clubId [, name, shortName, description, avatarId, broadcast, crossFaction]</span>) |
− | : [[API C_Club. |
+ | : [[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.Flush|C_Club.Flush]]() |
: [[API C_Club.Flush|C_Club.Flush]]() |
||
+ | : [[API C_Club.FocusCommunityStreams|C_Club.FocusCommunityStreams]]() |
||
− | : [[API C_Club.FocusStream|C_Club.FocusStream]](<span style="font-size:smaller; color:#ecbc2a">clubId, streamId</span>) |
||
− | : [[API C_Club. |
+ | : [[API C_Club.FocusStream|C_Club.FocusStream]](<span class="apiarg">clubId, streamId</span>) : <span class="apiret">focused</span> |
− | : [[API C_Club. |
+ | : [[API C_Club.GetAssignableRoles|C_Club.GetAssignableRoles]](<span class="apiarg">clubId, memberId</span>) : <span class="apiret">assignableRoles</span> |
− | : [[API C_Club. |
+ | : [[API C_Club.GetAvatarIdList|C_Club.GetAvatarIdList]](<span class="apiarg">clubType</span>) : <span class="apiret">avatarIds</span> |
− | : [[API C_Club. |
+ | : [[API C_Club.GetClubCapacity|C_Club.GetClubCapacity]]() : <span class="apiret">capacity</span> |
− | : [[API C_Club. |
+ | : [[API C_Club.GetClubInfo|C_Club.GetClubInfo]](<span class="apiarg">clubId</span>) : <span class="apiret">info</span> |
− | : [[API C_Club. |
+ | : [[API C_Club.GetClubLimits|C_Club.GetClubLimits]](<span class="apiarg">clubType</span>) : <span class="apiret">clubLimits</span> |
− | : [[API C_Club. |
+ | : [[API C_Club.GetClubMembers|C_Club.GetClubMembers]](<span class="apiarg">clubId [, streamId]</span>) : <span class="apiret">members</span> |
− | : [[API C_Club. |
+ | : [[API C_Club.GetClubPrivileges|C_Club.GetClubPrivileges]](<span class="apiarg">clubId</span>) : <span class="apiret">privilegeInfo</span> |
− | : [[API C_Club. |
+ | : [[API C_Club.GetClubStreamNotificationSettings|C_Club.GetClubStreamNotificationSettings]](<span class="apiarg">clubId</span>) : <span class="apiret">settings</span> |
+ | : [[API C_Club.GetCommunityNameResultText|C_Club.GetCommunityNameResultText]](<span class="apiarg">result</span>) : <span class="apiret">errorCode</span> |
||
− | : [[API C_Club.GetGuildClubId|C_Club.GetGuildClubId]]() |
||
− | : [[API C_Club. |
+ | : [[API C_Club.GetGuildClubId|C_Club.GetGuildClubId]]() : <span class="apiret">guildClubId</span> |
− | : [[API C_Club. |
+ | : [[API C_Club.GetInfoFromLastCommunityChatLine|C_Club.GetInfoFromLastCommunityChatLine]]() : <span class="apiret">messageInfo, clubId, streamId, clubType</span> |
− | : [[API C_Club. |
+ | : [[API C_Club.GetInvitationCandidates|C_Club.GetInvitationCandidates]](<span class="apiarg">[filter], [maxResults], [cursorPosition], [allowFullMatch], clubId</span>) : <span class="apiret">candidates</span> |
− | : [[API C_Club. |
+ | : [[API C_Club.GetInvitationInfo|C_Club.GetInvitationInfo]](<span class="apiarg">clubId</span>) : <span class="apiret">invitation</span> |
+ | : [[API C_Club.GetInvitationsForClub|C_Club.GetInvitationsForClub]](<span class="apiarg">clubId</span>) : <span class="apiret">invitations</span> |
||
− | : [[API C_Club.GetInvitationsForSelf|C_Club.GetInvitationsForSelf]]() |
||
− | : [[API C_Club. |
+ | : [[API C_Club.GetInvitationsForSelf|C_Club.GetInvitationsForSelf]]() : <span class="apiret">invitations</span> |
− | : [[API C_Club. |
+ | : [[API C_Club.GetLastTicketResponse|C_Club.GetLastTicketResponse]](<span class="apiarg">ticket</span>) : <span class="apiret">error, info, showError</span> |
− | : [[API C_Club. |
+ | : [[API C_Club.GetMemberInfo|C_Club.GetMemberInfo]](<span class="apiarg">clubId, memberId</span>) : <span class="apiret">info</span> |
− | : [[API C_Club. |
+ | : [[API C_Club.GetMemberInfoForSelf|C_Club.GetMemberInfoForSelf]](<span class="apiarg">clubId</span>) : <span class="apiret">info</span> |
− | : [[API C_Club. |
+ | : [[API C_Club.GetMessageInfo|C_Club.GetMessageInfo]](<span class="apiarg">clubId, streamId, messageId</span>) : <span class="apiret">message</span> |
− | : [[API C_Club. |
+ | : [[API C_Club.GetMessageRanges|C_Club.GetMessageRanges]](<span class="apiarg">clubId, streamId</span>) : <span class="apiret">ranges</span> |
− | : [[API C_Club. |
+ | : [[API C_Club.GetMessagesBefore|C_Club.GetMessagesBefore]](<span class="apiarg">clubId, streamId, newest, count</span>) : <span class="apiret">messages</span> |
− | : [[API C_Club. |
+ | : [[API C_Club.GetMessagesInRange|C_Club.GetMessagesInRange]](<span class="apiarg">clubId, streamId, oldest, newest</span>) : <span class="apiret">messages</span> |
− | : [[API C_Club. |
+ | : [[API C_Club.GetStreamInfo|C_Club.GetStreamInfo]](<span class="apiarg">clubId, streamId</span>) : <span class="apiret">streamInfo</span> |
− | : [[API C_Club.GetStreams|C_Club.GetStreams]](<span |
+ | : [[API C_Club.GetStreams|C_Club.GetStreams]](<span class="apiarg">clubId</span>) : <span class="apiret">streams</span> |
+ | : [[API C_Club.GetStreamViewMarker|C_Club.GetStreamViewMarker]](<span class="apiarg">clubId, streamId</span>) : <span class="apiret">lastReadTime</span> |
||
− | : [[API C_Club.GetSubscribedClubs|C_Club.GetSubscribedClubs]]() |
||
− | : [[API C_Club. |
+ | : [[API C_Club.GetSubscribedClubs|C_Club.GetSubscribedClubs]]() : <span class="apiret">clubs</span> |
− | : [[API C_Club. |
+ | : [[API C_Club.GetTickets|C_Club.GetTickets]](<span class="apiarg">clubId</span>) : <span class="apiret">tickets</span> |
− | : [[API C_Club. |
+ | : [[API C_Club.IsAccountMuted|C_Club.IsAccountMuted]](<span class="apiarg">clubId</span>) : <span class="apiret">accountMuted</span> |
+ | : [[API C_Club.IsBeginningOfStream|C_Club.IsBeginningOfStream]](<span class="apiarg">clubId, streamId, messageId</span>) : <span class="apiret">isBeginningOfStream</span> |
||
− | : [[API C_Club.IsEnabled|C_Club.IsEnabled]]() |
||
− | : [[API C_Club. |
+ | : [[API C_Club.IsEnabled|C_Club.IsEnabled]]() : <span class="apiret">clubsEnabled</span> |
− | : [[API C_Club. |
+ | : [[API C_Club.IsRestricted|C_Club.IsRestricted]]() : <span class="apiret">restrictionReason</span> |
− | : [[API C_Club. |
+ | : [[API C_Club.IsSubscribedToStream|C_Club.IsSubscribedToStream]](<span class="apiarg">clubId, streamId</span>) : <span class="apiret">subscribed</span> |
− | : [[API C_Club. |
+ | : [[API C_Club.KickMember|C_Club.KickMember]](<span class="apiarg">clubId, memberId</span>) {{apitag|protected}} |
− | : [[API C_Club. |
+ | : [[API C_Club.LeaveClub|C_Club.LeaveClub]](<span class="apiarg">clubId</span>) |
− | : [[API C_Club. |
+ | : [[API C_Club.RedeemTicket|C_Club.RedeemTicket]](<span class="apiarg">ticketId</span>) |
− | : [[API C_Club. |
+ | : [[API C_Club.RequestInvitationsForClub|C_Club.RequestInvitationsForClub]](<span class="apiarg">clubId</span>) |
− | : [[API C_Club. |
+ | : [[API C_Club.RequestMoreMessagesBefore|C_Club.RequestMoreMessagesBefore]](<span class="apiarg">clubId, streamId [, messageId, count]</span>) : <span class="apiret">alreadyHasMessages</span> |
− | : [[API C_Club. |
+ | : [[API C_Club.RequestTicket|C_Club.RequestTicket]](<span class="apiarg">ticketId</span>) |
− | : [[API C_Club. |
+ | : [[API C_Club.RequestTickets|C_Club.RequestTickets]](<span class="apiarg">clubId</span>) |
− | : [[API C_Club. |
+ | : [[API C_Club.RevokeInvitation|C_Club.RevokeInvitation]](<span class="apiarg">clubId, memberId</span>) |
− | : [[API C_Club. |
+ | : [[API C_Club.SendBattleTagFriendRequest|C_Club.SendBattleTagFriendRequest]](<span class="apiarg">guildClubId, memberId</span>) |
− | : [[API C_Club. |
+ | : [[API C_Club.SendCharacterInvitation|C_Club.SendCharacterInvitation]](<span class="apiarg">clubId, character</span>) |
− | : [[API C_Club. |
+ | : [[API C_Club.SendInvitation|C_Club.SendInvitation]](<span class="apiarg">clubId, memberId</span>) |
− | : [[API C_Club. |
+ | : [[API C_Club.SendMessage|C_Club.SendMessage]](<span class="apiarg">clubId, streamId, message</span>) |
− | : [[API C_Club. |
+ | : [[API C_Club.SetAutoAdvanceStreamViewMarker|C_Club.SetAutoAdvanceStreamViewMarker]](<span class="apiarg">clubId, streamId</span>) |
− | : [[API C_Club. |
+ | : [[API C_Club.SetAvatarTexture|C_Club.SetAvatarTexture]](<span class="apiarg">texture, avatarId, clubType</span>) |
− | : [[API C_Club. |
+ | : [[API C_Club.SetClubMemberNote|C_Club.SetClubMemberNote]](<span class="apiarg">clubId, memberId, note</span>) {{apitag|protected}} |
− | : [[API C_Club. |
+ | : [[API C_Club.SetClubPresenceSubscription|C_Club.SetClubPresenceSubscription]](<span class="apiarg">clubId</span>) |
− | : [[API C_Club. |
+ | : [[API C_Club.SetClubStreamNotificationSettings|C_Club.SetClubStreamNotificationSettings]](<span class="apiarg">clubId, settings</span>) |
− | : [[API C_Club. |
+ | : [[API C_Club.SetFavorite|C_Club.SetFavorite]](<span class="apiarg">clubId, isFavorite</span>) |
− | : [[API C_Club. |
+ | : [[API C_Club.SetSocialQueueingEnabled|C_Club.SetSocialQueueingEnabled]](<span class="apiarg">clubId, enabled</span>) |
− | : [[API C_Club. |
+ | : [[API C_Club.ShouldAllowClubType|C_Club.ShouldAllowClubType]](<span class="apiarg">clubType</span>) : <span class="apiret">clubTypeIsAllowed</span> |
− | : [[API C_Club. |
+ | : [[API C_Club.UnfocusAllStreams|C_Club.UnfocusAllStreams]](<span class="apiarg">unsubscribe</span>) |
+ | : [[API C_Club.UnfocusStream|C_Club.UnfocusStream]](<span class="apiarg">clubId, streamId</span>) |
||
− | : [[API C_Cursor.DropCursorCommunitiesStream|C_Cursor.DropCursorCommunitiesStream]]() |
||
+ | : [[API C_Club.ValidateText|C_Club.ValidateText]](<span class="apiarg">clubType, text, clubFieldType</span>) : <span class="apiret">result</span> |
||
− | : [[API C_Cursor.GetCursorCommunitiesStream|C_Cursor.GetCursorCommunitiesStream]]() |
||
− | : [[API C_Cursor.GetCursorItem|C_Cursor.GetCursorItem]]() |
+ | : [[API C_Cursor.GetCursorItem|C_Cursor.GetCursorItem]]() : <span class="apiret">item</span> |
+ | The Club Finder was added in [[Patch 8.2.0]] and enabled in [[Patch 8.2.5]] |
||
− | : [[API C_Cursor.SetCursorCommunitiesStream|C_Cursor.SetCursorCommunitiesStream]](<span style="font-size:smaller; color:#ecbc2a">clubId, streamId</span>) |
||
+ | : [[API C_ClubFinder.ApplicantAcceptClubInvite|C_ClubFinder.ApplicantAcceptClubInvite]](<span class="apiarg">clubFinderGUID</span>) |
||
− | : DEPRECATED (8.1.0) [[API C_Club.AddClubStreamToChatWindow|C_Club.AddClubStreamToChatWindow]](<span style="font-size:smaller; color:#ecbc2a">clubId, streamId, chatWindowIndex</span>) |
||
+ | : [[API C_ClubFinder.ApplicantDeclineClubInvite|C_ClubFinder.ApplicantDeclineClubInvite]](<span class="apiarg">clubFinderGUID</span>) |
||
− | : REMOVED (8.1.5) [[API C_Club.SetCommunityID|C_Club.SetCommunityID]]() |
||
+ | : [[API C_ClubFinder.CancelMembershipRequest|C_ClubFinder.CancelMembershipRequest]](<span class="apiarg">clubFinderGUID</span>) |
||
− | The Club Finder was added in [[Patch 8.2.0]] and enabled in [[Patch 8.2.5]]. |
||
− | : [[API C_LFGuildInfo.GetRecruitingGuildTabardInfo|C_LFGuildInfo.GetRecruitingGuildTabardInfo]](<span style="font-size:smaller; color:#ecbc2a">index</span>) |
||
− | : [[API C_ClubFinder.ApplicantAcceptClubInvite|C_ClubFinder.ApplicantAcceptClubInvite]](<span style="font-size:smaller; color:#ecbc2a">clubFinderGUID</span>) |
||
− | : [[API C_ClubFinder.ApplicantDeclineClubInvite|C_ClubFinder.ApplicantDeclineClubInvite]](<span style="font-size:smaller; color:#ecbc2a">clubFinderGUID</span>) |
||
− | : [[API C_ClubFinder.CancelMembershipRequest|C_ClubFinder.CancelMembershipRequest]](<span style="font-size:smaller; color:#ecbc2a">clubFinderGUID</span>) |
||
: [[API C_ClubFinder.CheckAllPlayerApplicantSettings|C_ClubFinder.CheckAllPlayerApplicantSettings]]() |
: [[API C_ClubFinder.CheckAllPlayerApplicantSettings|C_ClubFinder.CheckAllPlayerApplicantSettings]]() |
||
: [[API C_ClubFinder.ClearAllFinderCache|C_ClubFinder.ClearAllFinderCache]]() |
: [[API C_ClubFinder.ClearAllFinderCache|C_ClubFinder.ClearAllFinderCache]]() |
||
: [[API C_ClubFinder.ClearClubApplicantsCache|C_ClubFinder.ClearClubApplicantsCache]]() |
: [[API C_ClubFinder.ClearClubApplicantsCache|C_ClubFinder.ClearClubApplicantsCache]]() |
||
: [[API C_ClubFinder.ClearClubFinderPostingsCache|C_ClubFinder.ClearClubFinderPostingsCache]]() |
: [[API C_ClubFinder.ClearClubFinderPostingsCache|C_ClubFinder.ClearClubFinderPostingsCache]]() |
||
− | : [[API C_ClubFinder. |
+ | : [[API C_ClubFinder.DoesPlayerBelongToClubFromClubGUID|C_ClubFinder.DoesPlayerBelongToClubFromClubGUID]](<span class="apiarg">clubFinderGUID</span>) : <span class="apiret">belongsToClub</span> |
− | : [[API C_ClubFinder. |
+ | : [[API C_ClubFinder.GetClubFinderDisableReason|C_ClubFinder.GetClubFinderDisableReason]]() : <span class="apiret">disableReason</span> |
− | : [[API C_ClubFinder. |
+ | : [[API C_ClubFinder.GetClubRecruitmentSettings|C_ClubFinder.GetClubRecruitmentSettings]]() : <span class="apiret">settings</span> |
− | : [[API C_ClubFinder. |
+ | : [[API C_ClubFinder.GetClubTypeFromFinderGUID|C_ClubFinder.GetClubTypeFromFinderGUID]](<span class="apiarg">clubFinderGUID</span>) : <span class="apiret">clubType</span> |
− | : [[API C_ClubFinder. |
+ | : [[API C_ClubFinder.GetFocusIndexFromFlag|C_ClubFinder.GetFocusIndexFromFlag]](<span class="apiarg">flags</span>) : <span class="apiret">index</span> |
− | : [[API C_ClubFinder. |
+ | : [[API C_ClubFinder.GetPlayerApplicantLocaleFlags|C_ClubFinder.GetPlayerApplicantLocaleFlags]]() : <span class="apiret">localeFlags</span> |
− | : [[API C_ClubFinder. |
+ | : [[API C_ClubFinder.GetPlayerApplicantSettings|C_ClubFinder.GetPlayerApplicantSettings]]() : <span class="apiret">settings</span> |
− | : [[API C_ClubFinder. |
+ | : [[API C_ClubFinder.GetPlayerClubApplicationStatus|C_ClubFinder.GetPlayerClubApplicationStatus]](<span class="apiarg">clubFinderGUID</span>) : <span class="apiret">clubStatus</span> |
− | : [[API C_ClubFinder. |
+ | : [[API C_ClubFinder.GetPlayerSettingsFocusFlagsSelectedCount|C_ClubFinder.GetPlayerSettingsFocusFlagsSelectedCount]]() : <span class="apiret">focusCount</span> |
+ | : [[API C_ClubFinder.GetPostingIDFromClubFinderGUID|C_ClubFinder.GetPostingIDFromClubFinderGUID]](<span class="apiarg">clubFinderGUID</span>) : <span class="apiret">postingID</span> |
||
− | : [[API C_ClubFinder.GetPlayerSettingsFocusFlagsSelectedCount|C_ClubFinder.GetPlayerSettingsFocusFlagsSelectedCount]]() |
||
− | : [[API C_ClubFinder.GetRecruitingClubInfoFromClubID|C_ClubFinder.GetRecruitingClubInfoFromClubID]](<span |
+ | : [[API C_ClubFinder.GetRecruitingClubInfoFromClubID|C_ClubFinder.GetRecruitingClubInfoFromClubID]](<span class="apiarg">clubId</span>) : <span class="apiret">clubInfo</span> |
− | : [[API C_ClubFinder.GetRecruitingClubInfoFromFinderGUID|C_ClubFinder.GetRecruitingClubInfoFromFinderGUID]](<span |
+ | : [[API C_ClubFinder.GetRecruitingClubInfoFromFinderGUID|C_ClubFinder.GetRecruitingClubInfoFromFinderGUID]](<span class="apiarg">clubFinderGUID</span>) : <span class="apiret">clubInfo</span> |
− | : [[API C_ClubFinder. |
+ | : [[API C_ClubFinder.GetStatusOfPostingFromClubId|C_ClubFinder.GetStatusOfPostingFromClubId]](<span class="apiarg">postingID</span>) : <span class="apiret">postingFlags</span> |
− | : [[API C_ClubFinder. |
+ | : [[API C_ClubFinder.GetTotalMatchingCommunityListSize|C_ClubFinder.GetTotalMatchingCommunityListSize]]() : <span class="apiret">totalSize</span> |
− | : [[API C_ClubFinder. |
+ | : [[API C_ClubFinder.GetTotalMatchingGuildListSize|C_ClubFinder.GetTotalMatchingGuildListSize]]() : <span class="apiret">totalSize</span> |
− | : [[API C_ClubFinder. |
+ | : [[API C_ClubFinder.HasAlreadyAppliedToLinkedPosting|C_ClubFinder.HasAlreadyAppliedToLinkedPosting]](<span class="apiarg">clubFinderGUID</span>) : <span class="apiret">hasAlreadyApplied</span> |
− | : [[API C_ClubFinder. |
+ | : [[API C_ClubFinder.HasPostingBeenDelisted|C_ClubFinder.HasPostingBeenDelisted]](<span class="apiarg">postingID</span>) : <span class="apiret">postingDelisted</span> |
− | : [[API C_ClubFinder. |
+ | : [[API C_ClubFinder.IsEnabled|C_ClubFinder.IsEnabled]]() : <span class="apiret">isEnabled</span> |
− | : [[API C_ClubFinder. |
+ | : [[API C_ClubFinder.IsListingEnabledFromFlags|C_ClubFinder.IsListingEnabledFromFlags]](<span class="apiarg">flags</span>) : <span class="apiret">isListed</span> |
− | : [[API C_ClubFinder. |
+ | : [[API C_ClubFinder.IsPostingBanned|C_ClubFinder.IsPostingBanned]](<span class="apiarg">postingID</span>) : <span class="apiret">postingBanned</span> |
− | : [[API C_ClubFinder. |
+ | : [[API C_ClubFinder.LookupClubPostingFromClubFinderGUID|C_ClubFinder.LookupClubPostingFromClubFinderGUID]](<span class="apiarg">clubFinderGUID, isLinkedPosting</span>) |
− | : [[API C_ClubFinder. |
+ | : [[API C_ClubFinder.PlayerGetClubInvitationList|C_ClubFinder.PlayerGetClubInvitationList]]() : <span class="apiret">inviteList</span> |
− | : [[API C_ClubFinder. |
+ | : [[API C_ClubFinder.PlayerRequestPendingClubsList|C_ClubFinder.PlayerRequestPendingClubsList]](<span class="apiarg">type</span>) |
− | : [[API C_ClubFinder. |
+ | : [[API C_ClubFinder.PlayerReturnPendingCommunitiesList|C_ClubFinder.PlayerReturnPendingCommunitiesList]]() : <span class="apiret">info</span> |
− | : [[API C_ClubFinder. |
+ | : [[API C_ClubFinder.PlayerReturnPendingGuildsList|C_ClubFinder.PlayerReturnPendingGuildsList]]() : <span class="apiret">info</span> |
− | : [[API C_ClubFinder. |
+ | : [[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. |
+ | : [[API C_ClubFinder.RequestApplicantList|C_ClubFinder.RequestApplicantList]](<span class="apiarg">type</span>) |
− | : [[API C_ClubFinder. |
+ | : [[API C_ClubFinder.RequestClubsList|C_ClubFinder.RequestClubsList]](<span class="apiarg">guildListRequested, searchString, specIDs</span>) |
− | : [[API C_ClubFinder. |
+ | : [[API C_ClubFinder.RequestMembershipToClub|C_ClubFinder.RequestMembershipToClub]](<span class="apiarg">clubFinderGUID, comment, specIDs</span>) |
− | : [[API C_ClubFinder. |
+ | : [[API C_ClubFinder.RequestNextCommunityPage|C_ClubFinder.RequestNextCommunityPage]](<span class="apiarg">startingIndex, pageSize</span>) |
+ | : [[API C_ClubFinder.RequestNextGuildPage|C_ClubFinder.RequestNextGuildPage]](<span class="apiarg">startingIndex, pageSize</span>) |
||
+ | : [[API C_ClubFinder.RequestPostingInformationFromClubId|C_ClubFinder.RequestPostingInformationFromClubId]](<span class="apiarg">clubId</span>) : <span class="apiret">success</span> |
||
: [[API C_ClubFinder.RequestSubscribedClubPostingIDs|C_ClubFinder.RequestSubscribedClubPostingIDs]]() |
: [[API C_ClubFinder.RequestSubscribedClubPostingIDs|C_ClubFinder.RequestSubscribedClubPostingIDs]]() |
||
: [[API C_ClubFinder.ResetClubPostingMapCache|C_ClubFinder.ResetClubPostingMapCache]]() |
: [[API C_ClubFinder.ResetClubPostingMapCache|C_ClubFinder.ResetClubPostingMapCache]]() |
||
− | : [[API C_ClubFinder.RespondToApplicant|C_ClubFinder.RespondToApplicant]](<span |
+ | : [[API C_ClubFinder.RespondToApplicant|C_ClubFinder.RespondToApplicant]](<span class="apiarg">clubFinderGUID, playerGUID, shouldAccept, requestType, playerName, forceAccept [, reported]</span>) |
− | : [[API C_ClubFinder.ReturnClubApplicantList|C_ClubFinder.ReturnClubApplicantList]](<span |
+ | : [[API C_ClubFinder.ReturnClubApplicantList|C_ClubFinder.ReturnClubApplicantList]](<span class="apiarg">clubId</span>) : <span class="apiret">info</span> |
− | : [[API C_ClubFinder.ReturnMatchingCommunityList|C_ClubFinder.ReturnMatchingCommunityList]]() |
+ | : [[API C_ClubFinder.ReturnMatchingCommunityList|C_ClubFinder.ReturnMatchingCommunityList]]() : <span class="apiret">recruitingClubs</span> |
− | : [[API C_ClubFinder.ReturnMatchingGuildList|C_ClubFinder.ReturnMatchingGuildList]]() |
+ | : [[API C_ClubFinder.ReturnMatchingGuildList|C_ClubFinder.ReturnMatchingGuildList]]() : <span class="apiret">recruitingClubs</span> |
− | : [[API C_ClubFinder.ReturnPendingClubApplicantList|C_ClubFinder.ReturnPendingClubApplicantList]](<span |
+ | : [[API C_ClubFinder.ReturnPendingClubApplicantList|C_ClubFinder.ReturnPendingClubApplicantList]](<span class="apiarg">clubId</span>) : <span class="apiret">info</span> |
− | : [[API C_ClubFinder. |
+ | : [[API C_ClubFinder.SendChatWhisper|C_ClubFinder.SendChatWhisper]](<span class="apiarg">clubFinderGUID, playerGUID, applicantType, name</span>) |
− | : [[API C_ClubFinder. |
+ | : [[API C_ClubFinder.SetAllRecruitmentSettings|C_ClubFinder.SetAllRecruitmentSettings]](<span class="apiarg">value</span>) |
− | : [[API C_ClubFinder. |
+ | : [[API C_ClubFinder.SetPlayerApplicantLocaleFlags|C_ClubFinder.SetPlayerApplicantLocaleFlags]](<span class="apiarg">localeFlags</span>) |
− | : [[API C_ClubFinder. |
+ | : [[API C_ClubFinder.SetPlayerApplicantSettings|C_ClubFinder.SetPlayerApplicantSettings]](<span class="apiarg">index, checked</span>) |
− | : [[API C_ClubFinder. |
+ | : [[API C_ClubFinder.SetRecruitmentLocale|C_ClubFinder.SetRecruitmentLocale]](<span class="apiarg">locale</span>) |
− | : [[API C_ClubFinder. |
+ | : [[API C_ClubFinder.SetRecruitmentSettings|C_ClubFinder.SetRecruitmentSettings]](<span class="apiarg">index, checked</span>) |
+ | : [[API C_ClubFinder.ShouldShowClubFinder|C_ClubFinder.ShouldShowClubFinder]]() : <span class="apiret">shouldShow</span> |
||
+ | |||
+ | ===Reporting=== |
||
+ | : [[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.CanReportPlayerForLanguage|C_ReportSystem.CanReportPlayerForLanguage]](<span class="apiarg">playerLocation</span>) : <span class="apiret">canReport</span> |
||
+ | : [[API C_ReportSystem.GetMajorCategoriesForReportType|C_ReportSystem.GetMajorCategoriesForReportType]](<span class="apiarg">reportType</span>) : <span class="apiret">majorCategories</span> |
||
+ | : [[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.ReportStuckInCombat|C_ReportSystem.ReportStuckInCombat]]() |
||
+ | : [[API C_ReportSystem.SendReport|C_ReportSystem.SendReport]](<span class="apiarg">reportInfo [, playerLocation]</span>) {{apitag|protected}} |
||
+ | Restrictions |
||
+ | : [[API C_SocialRestrictions.AcknowledgeRegionalChatDisabled|C_SocialRestrictions.AcknowledgeRegionalChatDisabled]]() |
||
+ | : [[API C_SocialRestrictions.IsChatDisabled|C_SocialRestrictions.IsChatDisabled]]() : <span class="apiret">disabled</span> |
||
+ | : [[API C_SocialRestrictions.IsMuted|C_SocialRestrictions.IsMuted]]() : <span class="apiret">isMuted</span> |
||
+ | : [[API C_SocialRestrictions.IsSilenced|C_SocialRestrictions.IsSilenced]]() : <span class="apiret">isSilenced</span> |
||
+ | : [[API C_SocialRestrictions.IsSquelched|C_SocialRestrictions.IsSquelched]]() : <span class="apiret">isSquelched</span> |
||
+ | : [[API C_SocialRestrictions.SetChatDisabled|C_SocialRestrictions.SetChatDisabled]](<span class="apiarg">disabled</span>) |
||
− | === |
+ | ===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 |
+ | : [[API C_VoiceChat.ActivateChannel|C_VoiceChat.ActivateChannel]](<span class="apiarg">channelID</span>) |
− | : [[API C_VoiceChat.BeginLocalCapture|C_VoiceChat.BeginLocalCapture]](<span |
+ | : [[API C_VoiceChat.BeginLocalCapture|C_VoiceChat.BeginLocalCapture]](<span class="apiarg">listenToLocalUser</span>) |
− | : [[API C_VoiceChat.CanPlayerUseVoiceChat|C_VoiceChat.CanPlayerUseVoiceChat]]() |
+ | : [[API C_VoiceChat.CanPlayerUseVoiceChat|C_VoiceChat.CanPlayerUseVoiceChat]]() : <span class="apiret">canUseVoiceChat</span> |
− | : [[API C_VoiceChat.CreateChannel|C_VoiceChat.CreateChannel]](<span |
+ | : [[API C_VoiceChat.CreateChannel|C_VoiceChat.CreateChannel]](<span class="apiarg">channelDisplayName</span>) : <span class="apiret">status</span> |
− | : [[API C_VoiceChat.DeactivateChannel|C_VoiceChat.DeactivateChannel]](<span |
+ | : [[API C_VoiceChat.DeactivateChannel|C_VoiceChat.DeactivateChannel]](<span class="apiarg">channelID</span>) |
: [[API C_VoiceChat.EndLocalCapture|C_VoiceChat.EndLocalCapture]]() |
: [[API C_VoiceChat.EndLocalCapture|C_VoiceChat.EndLocalCapture]]() |
||
− | : [[API C_VoiceChat.GetActiveChannelID|C_VoiceChat.GetActiveChannelID]]() |
+ | : [[API C_VoiceChat.GetActiveChannelID|C_VoiceChat.GetActiveChannelID]]() : <span class="apiret">channelID</span> |
− | : [[API C_VoiceChat.GetActiveChannelType|C_VoiceChat.GetActiveChannelType]]() |
+ | : [[API C_VoiceChat.GetActiveChannelType|C_VoiceChat.GetActiveChannelType]]() : <span class="apiret">channelType</span> |
− | : [[API C_VoiceChat.GetAvailableInputDevices|C_VoiceChat.GetAvailableInputDevices]]() |
+ | : [[API C_VoiceChat.GetAvailableInputDevices|C_VoiceChat.GetAvailableInputDevices]]() : <span class="apiret">inputDevices</span> |
− | : [[API C_VoiceChat.GetAvailableOutputDevices|C_VoiceChat.GetAvailableOutputDevices]]() |
+ | : [[API C_VoiceChat.GetAvailableOutputDevices|C_VoiceChat.GetAvailableOutputDevices]]() : <span class="apiret">outputDevices</span> |
− | : [[API C_VoiceChat.GetChannel|C_VoiceChat.GetChannel]](<span |
+ | : [[API C_VoiceChat.GetChannel|C_VoiceChat.GetChannel]](<span class="apiarg">channelID</span>) : <span class="apiret">channel</span> |
− | : [[API C_VoiceChat.GetChannelForChannelType|C_VoiceChat.GetChannelForChannelType]](<span |
+ | : [[API C_VoiceChat.GetChannelForChannelType|C_VoiceChat.GetChannelForChannelType]](<span class="apiarg">channelType</span>) : <span class="apiret">channel</span> |
− | : [[API C_VoiceChat.GetChannelForCommunityStream|C_VoiceChat.GetChannelForCommunityStream]](<span |
+ | : [[API C_VoiceChat.GetChannelForCommunityStream|C_VoiceChat.GetChannelForCommunityStream]](<span class="apiarg">clubId, streamId</span>) : <span class="apiret">channel</span> |
− | : [[API C_VoiceChat.GetCommunicationMode|C_VoiceChat.GetCommunicationMode]]() |
+ | : [[API C_VoiceChat.GetCommunicationMode|C_VoiceChat.GetCommunicationMode]]() : <span class="apiret">communicationMode</span> |
− | : [[API C_VoiceChat.GetCurrentVoiceChatConnectionStatusCode|C_VoiceChat.GetCurrentVoiceChatConnectionStatusCode]]() |
+ | : [[API C_VoiceChat.GetCurrentVoiceChatConnectionStatusCode|C_VoiceChat.GetCurrentVoiceChatConnectionStatusCode]]() : <span class="apiret">statusCode</span> |
− | : [[API C_VoiceChat.GetInputVolume|C_VoiceChat.GetInputVolume]]() |
+ | : [[API C_VoiceChat.GetInputVolume|C_VoiceChat.GetInputVolume]]() : <span class="apiret">volume</span> |
− | : [[API C_VoiceChat.GetJoinClubVoiceChannelError|C_VoiceChat.GetJoinClubVoiceChannelError]](<span |
+ | : [[API C_VoiceChat.GetJoinClubVoiceChannelError|C_VoiceChat.GetJoinClubVoiceChannelError]](<span class="apiarg">clubId</span>) : <span class="apiret">errorReason</span> |
− | : [[API C_VoiceChat.GetLocalPlayerActiveChannelMemberInfo|C_VoiceChat.GetLocalPlayerActiveChannelMemberInfo]]() |
+ | : [[API C_VoiceChat.GetLocalPlayerActiveChannelMemberInfo|C_VoiceChat.GetLocalPlayerActiveChannelMemberInfo]]() : <span class="apiret">memberInfo</span> |
− | : [[API C_VoiceChat.GetLocalPlayerMemberID|C_VoiceChat.GetLocalPlayerMemberID]](<span |
+ | : [[API C_VoiceChat.GetLocalPlayerMemberID|C_VoiceChat.GetLocalPlayerMemberID]](<span class="apiarg">channelID</span>) : <span class="apiret">memberID</span> |
− | : [[API C_VoiceChat.GetMasterVolumeScale|C_VoiceChat.GetMasterVolumeScale]]() |
+ | : [[API C_VoiceChat.GetMasterVolumeScale|C_VoiceChat.GetMasterVolumeScale]]() : <span class="apiret">scale</span> |
− | : [[API C_VoiceChat.GetMemberGUID|C_VoiceChat.GetMemberGUID]](<span |
+ | : [[API C_VoiceChat.GetMemberGUID|C_VoiceChat.GetMemberGUID]](<span class="apiarg">memberID, channelID</span>) : <span class="apiret">memberGUID</span> |
− | : [[API C_VoiceChat.GetMemberID|C_VoiceChat.GetMemberID]](<span |
+ | : [[API C_VoiceChat.GetMemberID|C_VoiceChat.GetMemberID]](<span class="apiarg">channelID, memberGUID</span>) : <span class="apiret">memberID</span> |
− | : [[API C_VoiceChat.GetMemberInfo|C_VoiceChat.GetMemberInfo]](<span |
+ | : [[API C_VoiceChat.GetMemberInfo|C_VoiceChat.GetMemberInfo]](<span class="apiarg">memberID, channelID</span>) : <span class="apiret">memberInfo</span> |
− | : [[API C_VoiceChat.GetMemberName|C_VoiceChat.GetMemberName]](<span |
+ | : [[API C_VoiceChat.GetMemberName|C_VoiceChat.GetMemberName]](<span class="apiarg">memberID, channelID</span>) : <span class="apiret">memberName</span> |
− | : [[API C_VoiceChat.GetMemberVolume|C_VoiceChat.GetMemberVolume]](<span |
+ | : [[API C_VoiceChat.GetMemberVolume|C_VoiceChat.GetMemberVolume]](<span class="apiarg">playerLocation</span>) : <span class="apiret">volume</span> |
− | : [[API C_VoiceChat.GetOutputVolume|C_VoiceChat.GetOutputVolume]]() |
+ | : [[API C_VoiceChat.GetOutputVolume|C_VoiceChat.GetOutputVolume]]() : <span class="apiret">volume</span> |
− | : [[API C_VoiceChat.GetProcesses|C_VoiceChat.GetProcesses]]() |
+ | : [[API C_VoiceChat.GetProcesses|C_VoiceChat.GetProcesses]]() : <span class="apiret">processes</span> |
− | : [[API C_VoiceChat.GetPTTButtonPressedState|C_VoiceChat.GetPTTButtonPressedState]]() |
+ | : [[API C_VoiceChat.GetPTTButtonPressedState|C_VoiceChat.GetPTTButtonPressedState]]() : <span class="apiret">isPressed</span> |
− | : [[API C_VoiceChat.GetPushToTalkBinding|C_VoiceChat.GetPushToTalkBinding]]() |
+ | : [[API C_VoiceChat.GetPushToTalkBinding|C_VoiceChat.GetPushToTalkBinding]]() : <span class="apiret">keys</span> |
− | : [[API C_VoiceChat.GetVADSensitivity|C_VoiceChat.GetVADSensitivity]]() |
+ | : [[API C_VoiceChat.GetVADSensitivity|C_VoiceChat.GetVADSensitivity]]() : <span class="apiret">sensitivity</span> |
− | : [[API C_VoiceChat.IsChannelJoinPending|C_VoiceChat.IsChannelJoinPending]](<span |
+ | : [[API C_VoiceChat.IsChannelJoinPending|C_VoiceChat.IsChannelJoinPending]](<span class="apiarg">channelType [, clubId, streamId]</span>) : <span class="apiret">isPending</span> |
− | : [[API C_VoiceChat.IsDeafened|C_VoiceChat.IsDeafened]]() |
+ | : [[API C_VoiceChat.IsDeafened|C_VoiceChat.IsDeafened]]() : <span class="apiret">isDeafened</span> |
− | : [[API C_VoiceChat.IsEnabled|C_VoiceChat.IsEnabled]]() |
+ | : [[API C_VoiceChat.IsEnabled|C_VoiceChat.IsEnabled]]() : <span class="apiret">isEnabled</span> |
− | : [[API C_VoiceChat.IsLoggedIn|C_VoiceChat.IsLoggedIn]]() |
+ | : [[API C_VoiceChat.IsLoggedIn|C_VoiceChat.IsLoggedIn]]() : <span class="apiret">isLoggedIn</span> |
− | : [[API C_VoiceChat.IsMemberLocalPlayer|C_VoiceChat.IsMemberLocalPlayer]](<span |
+ | : [[API C_VoiceChat.IsMemberLocalPlayer|C_VoiceChat.IsMemberLocalPlayer]](<span class="apiarg">memberID, channelID</span>) : <span class="apiret">isLocalPlayer</span> |
− | : [[API C_VoiceChat.IsMemberMuted|C_VoiceChat.IsMemberMuted]](<span |
+ | : [[API C_VoiceChat.IsMemberMuted|C_VoiceChat.IsMemberMuted]](<span class="apiarg">playerLocation</span>) : <span class="apiret">mutedForMe</span> |
− | : [[API C_VoiceChat.IsMemberMutedForAll|C_VoiceChat.IsMemberMutedForAll]](<span |
+ | : [[API C_VoiceChat.IsMemberMutedForAll|C_VoiceChat.IsMemberMutedForAll]](<span class="apiarg">memberID, channelID</span>) : <span class="apiret">mutedForAll</span> |
− | : [[API C_VoiceChat.IsMemberSilenced|C_VoiceChat.IsMemberSilenced]](<span |
+ | : [[API C_VoiceChat.IsMemberSilenced|C_VoiceChat.IsMemberSilenced]](<span class="apiarg">memberID, channelID</span>) : <span class="apiret">silenced</span> |
− | : [[API C_VoiceChat.IsMuted|C_VoiceChat.IsMuted]]() |
+ | : [[API C_VoiceChat.IsMuted|C_VoiceChat.IsMuted]]() : <span class="apiret">isMuted</span> |
− | : [[API C_VoiceChat.IsParentalDisabled|C_VoiceChat.IsParentalDisabled]]() |
+ | : [[API C_VoiceChat.IsParentalDisabled|C_VoiceChat.IsParentalDisabled]]() : <span class="apiret">isParentalDisabled</span> |
− | : [[API C_VoiceChat.IsParentalMuted|C_VoiceChat.IsParentalMuted]]() |
+ | : [[API C_VoiceChat.IsParentalMuted|C_VoiceChat.IsParentalMuted]]() : <span class="apiret">isParentalMuted</span> |
− | : [[API C_VoiceChat.IsPlayerUsingVoice|C_VoiceChat.IsPlayerUsingVoice]](<span |
+ | : [[API C_VoiceChat.IsPlayerUsingVoice|C_VoiceChat.IsPlayerUsingVoice]](<span class="apiarg">playerLocation</span>) : <span class="apiret">isUsingVoice</span> |
− | : [[API C_VoiceChat.IsSilenced|C_VoiceChat.IsSilenced]]() |
+ | : [[API C_VoiceChat.IsSilenced|C_VoiceChat.IsSilenced]]() : <span class="apiret">isSilenced</span> |
− | : [[API C_VoiceChat.LeaveChannel|C_VoiceChat.LeaveChannel]](<span |
+ | : [[API C_VoiceChat.LeaveChannel|C_VoiceChat.LeaveChannel]](<span class="apiarg">channelID</span>) |
− | : [[API C_VoiceChat.Login|C_VoiceChat.Login]]() |
+ | : [[API C_VoiceChat.Login|C_VoiceChat.Login]]() : <span class="apiret">status</span> |
− | : [[API C_VoiceChat.Logout|C_VoiceChat.Logout]]() |
+ | : [[API C_VoiceChat.Logout|C_VoiceChat.Logout]]() : <span class="apiret">status</span> |
: [[API C_VoiceChat.MarkChannelsDiscovered|C_VoiceChat.MarkChannelsDiscovered]]() |
: [[API C_VoiceChat.MarkChannelsDiscovered|C_VoiceChat.MarkChannelsDiscovered]]() |
||
− | : [[API C_VoiceChat.RequestJoinAndActivateCommunityStreamChannel|C_VoiceChat.RequestJoinAndActivateCommunityStreamChannel]](<span |
+ | : [[API C_VoiceChat.RequestJoinAndActivateCommunityStreamChannel|C_VoiceChat.RequestJoinAndActivateCommunityStreamChannel]](<span class="apiarg">clubId, streamId</span>) |
− | : [[API C_VoiceChat.RequestJoinChannelByChannelType|C_VoiceChat.RequestJoinChannelByChannelType]](<span |
+ | : [[API C_VoiceChat.RequestJoinChannelByChannelType|C_VoiceChat.RequestJoinChannelByChannelType]](<span class="apiarg">channelType [, autoActivate]</span>) |
− | : [[API C_VoiceChat.SetCommunicationMode|C_VoiceChat.SetCommunicationMode]](<span |
+ | : [[API C_VoiceChat.SetCommunicationMode|C_VoiceChat.SetCommunicationMode]](<span class="apiarg">communicationMode</span>) |
− | : [[API C_VoiceChat.SetDeafened|C_VoiceChat.SetDeafened]](<span |
+ | : [[API C_VoiceChat.SetDeafened|C_VoiceChat.SetDeafened]](<span class="apiarg">isDeafened</span>) |
− | : [[API C_VoiceChat.SetInputDevice|C_VoiceChat.SetInputDevice]](<span |
+ | : [[API C_VoiceChat.SetInputDevice|C_VoiceChat.SetInputDevice]](<span class="apiarg">deviceID</span>) |
− | : [[API C_VoiceChat.SetInputVolume|C_VoiceChat.SetInputVolume]](<span |
+ | : [[API C_VoiceChat.SetInputVolume|C_VoiceChat.SetInputVolume]](<span class="apiarg">volume</span>) |
− | : [[API C_VoiceChat.SetMasterVolumeScale|C_VoiceChat.SetMasterVolumeScale]](<span |
+ | : [[API C_VoiceChat.SetMasterVolumeScale|C_VoiceChat.SetMasterVolumeScale]](<span class="apiarg">scale</span>) |
− | : [[API C_VoiceChat.SetMemberMuted|C_VoiceChat.SetMemberMuted]](<span |
+ | : [[API C_VoiceChat.SetMemberMuted|C_VoiceChat.SetMemberMuted]](<span class="apiarg">playerLocation, muted</span>) |
− | : [[API C_VoiceChat.SetMemberVolume|C_VoiceChat.SetMemberVolume]](<span |
+ | : [[API C_VoiceChat.SetMemberVolume|C_VoiceChat.SetMemberVolume]](<span class="apiarg">playerLocation, volume</span>) |
− | : [[API C_VoiceChat.SetMuted|C_VoiceChat.SetMuted]](<span |
+ | : [[API C_VoiceChat.SetMuted|C_VoiceChat.SetMuted]](<span class="apiarg">isMuted</span>) |
− | : [[API C_VoiceChat.SetOutputDevice|C_VoiceChat.SetOutputDevice]](<span |
+ | : [[API C_VoiceChat.SetOutputDevice|C_VoiceChat.SetOutputDevice]](<span class="apiarg">deviceID</span>) |
− | : [[API C_VoiceChat.SetOutputVolume|C_VoiceChat.SetOutputVolume]](<span |
+ | : [[API C_VoiceChat.SetOutputVolume|C_VoiceChat.SetOutputVolume]](<span class="apiarg">volume</span>) |
− | : [[API C_VoiceChat.SetPortraitTexture|C_VoiceChat.SetPortraitTexture]](<span |
+ | : [[API C_VoiceChat.SetPortraitTexture|C_VoiceChat.SetPortraitTexture]](<span class="apiarg">textureObject, memberID, channelID</span>) |
− | : [[API C_VoiceChat.SetPushToTalkBinding|C_VoiceChat.SetPushToTalkBinding]](<span |
+ | : [[API C_VoiceChat.SetPushToTalkBinding|C_VoiceChat.SetPushToTalkBinding]](<span class="apiarg">keys</span>) |
− | : [[API C_VoiceChat.SetVADSensitivity|C_VoiceChat.SetVADSensitivity]](<span |
+ | : [[API C_VoiceChat.SetVADSensitivity|C_VoiceChat.SetVADSensitivity]](<span class="apiarg">sensitivity</span>) |
− | : [[API C_VoiceChat.ShouldDiscoverChannels|C_VoiceChat.ShouldDiscoverChannels]]() |
+ | : [[API C_VoiceChat.ShouldDiscoverChannels|C_VoiceChat.ShouldDiscoverChannels]]() : <span class="apiret">shouldDiscoverChannels</span> |
: [[API C_VoiceChat.ToggleDeafened|C_VoiceChat.ToggleDeafened]]() |
: [[API C_VoiceChat.ToggleDeafened|C_VoiceChat.ToggleDeafened]]() |
||
− | : [[API C_VoiceChat.ToggleMemberMuted|C_VoiceChat.ToggleMemberMuted]](<span |
+ | : [[API C_VoiceChat.ToggleMemberMuted|C_VoiceChat.ToggleMemberMuted]](<span class="apiarg">playerLocation</span>) |
: [[API C_VoiceChat.ToggleMuted|C_VoiceChat.ToggleMuted]]() |
: [[API C_VoiceChat.ToggleMuted|C_VoiceChat.ToggleMuted]]() |
||
− | : [[API ChannelSetAllSilent|ChannelSetAllSilent]](<span |
+ | : [[API ChannelSetAllSilent|ChannelSetAllSilent]](<span class="apiarg">[channelNumber | channelName], memberName, silenceOn</span>) |
− | : [[API ChannelSetPartyMemberSilent|ChannelSetPartyMemberSilent]](<span |
+ | : [[API ChannelSetPartyMemberSilent|ChannelSetPartyMemberSilent]](<span class="apiarg">partyMemberName, silenceOn</span>) |
: [[API IsChatChannelRaid|IsChatChannelRaid]]() |
: [[API IsChatChannelRaid|IsChatChannelRaid]]() |
||
− | === |
+ | ===Text-to-Speech=== |
− | + | [[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_Social.GetLastAchievement|C_Social.GetLastAchievement]]() |
||
+ | : [[API C_VoiceChat.DeactivateChannelTranscription|C_VoiceChat.DeactivateChannelTranscription]](<span class="apiarg">channelID</span>) |
||
− | : [[API C_Social.GetLastItem|C_Social.GetLastItem]]() |
||
+ | : [[API C_VoiceChat.GetRemoteTtsVoices|C_VoiceChat.GetRemoteTtsVoices]]() : <span class="apiret">ttsVoices</span> |
||
− | : [[API C_Social.GetLastScreenshotIndex|C_Social.GetLastScreenshotIndex]]() - Returns the index of the last screenshot. |
||
+ | : [[API C_VoiceChat.GetTtsVoices|C_VoiceChat.GetTtsVoices]]() : <span class="apiret">ttsVoices</span> |
||
− | : [[API C_Social.GetMaxTweetLength|C_Social.GetMaxTweetLength]]() - Returns the max character length of a tweet. |
||
+ | : [[API C_VoiceChat.IsSpeakForMeActive|C_VoiceChat.IsSpeakForMeActive]]() : <span class="apiret">isActive</span> |
||
− | : [[API C_Social.GetScreenshotInfoByIndex|C_Social.GetScreenshotInfoByIndex]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Returns the display resolution of a screenshot. |
||
− | : [[API |
+ | : [[API C_VoiceChat.IsSpeakForMeAllowed|C_VoiceChat.IsSpeakForMeAllowed]]() : <span class="apiret">isAllowed</span> |
+ | : [[API C_VoiceChat.IsTranscriptionAllowed|C_VoiceChat.IsTranscriptionAllowed]]() : <span class="apiret">isAllowed</span> |
||
− | : [[API C_Social.IsSocialEnabled|C_Social.IsSocialEnabled]]() |
||
+ | : [[API C_VoiceChat.SpeakRemoteTextSample|C_VoiceChat.SpeakRemoteTextSample]](<span class="apiarg">text</span>) |
||
− | : PROTECTED [[API C_Social.RegisterSocialBrowser|C_Social.RegisterSocialBrowser]]() |
||
+ | : [[API C_VoiceChat.SpeakText|C_VoiceChat.SpeakText]](<span class="apiarg">voiceID, text, destination, rate, volume</span>) |
||
− | : [[API C_Social.SetTextureToScreenshot|C_Social.SetTextureToScreenshot]](<span style="font-size:smaller; color:#ecbc2a">texture, index</span>) |
||
+ | : [[API C_VoiceChat.StopSpeakingText|C_VoiceChat.StopSpeakingText]]() |
||
− | : PROTECTED [[API C_Social.TwitterCheckStatus|C_Social.TwitterCheckStatus]]() |
||
+ | : [[API C_TTSSettings.GetChannelEnabled|C_TTSSettings.GetChannelEnabled]](<span class="apiarg">channelInfo</span>) : <span class="apiret">enabled</span> |
||
− | : PROTECTED [[API C_Social.TwitterConnect|C_Social.TwitterConnect]]() |
||
+ | : [[API C_TTSSettings.GetCharacterSettingsSaved|C_TTSSettings.GetCharacterSettingsSaved]]() : <span class="apiret">settingsBeenSaved</span> |
||
− | : PROTECTED [[API C_Social.TwitterDisconnect|C_Social.TwitterDisconnect]]() |
||
+ | : [[API C_TTSSettings.GetChatTypeEnabled|C_TTSSettings.GetChatTypeEnabled]](<span class="apiarg">chatName</span>) : <span class="apiret">enabled</span> |
||
− | : [[API C_Social.TwitterGetMSTillCanPost|C_Social.TwitterGetMSTillCanPost]]() |
||
+ | : [[API C_TTSSettings.GetSetting|C_TTSSettings.GetSetting]](<span class="apiarg">setting</span>) : <span class="apiret">enabled</span> |
||
− | : PROTECTED [[API C_Social.TwitterPostAchievement|C_Social.TwitterPostAchievement]](<span style="font-size:smaller; color:#ecbc2a">text, width, height, snapshotId, offScreenFrame, lastAchievementID, usedCustomText</span>) |
||
+ | : [[API C_TTSSettings.GetSpeechRate|C_TTSSettings.GetSpeechRate]]() : <span class="apiret">rate</span> |
||
− | : PROTECTED [[API C_Social.TwitterPostItem|C_Social.TwitterPostItem]](<span style="font-size:smaller; color:#ecbc2a">text, width, height, snapshotId, offScreenFrame, lastItemID, usedCustomText</span>) |
||
− | : |
+ | : [[API C_TTSSettings.GetSpeechVolume|C_TTSSettings.GetSpeechVolume]]() : <span class="apiret">volume</span> |
+ | : [[API C_TTSSettings.GetVoiceOptionID|C_TTSSettings.GetVoiceOptionID]](<span class="apiarg">voiceType</span>) : <span class="apiret">voiceID</span> |
||
− | : PROTECTED [[API C_Social.TwitterPostScreenshot|C_Social.TwitterPostScreenshot]](<span style="font-size:smaller; color:#ecbc2a">text, screenshotIndex, texture, usedCustomText</span>) |
||
+ | : [[API C_TTSSettings.GetVoiceOptionName|C_TTSSettings.GetVoiceOptionName]](<span class="apiarg">voiceType</span>) : <span class="apiret">voiceName</span> |
||
− | : DEPRECATED (8.1.5) [[API C_Social.GetLastScreenshot|C_Social.GetLastScreenshot]]() |
||
+ | : [[API C_TTSSettings.MarkCharacterSettingsSaved|C_TTSSettings.MarkCharacterSettingsSaved]]() |
||
− | : DEPRECATED (8.1.5) [[API C_Social.GetScreenshotByIndex|C_Social.GetScreenshotByIndex]]() |
||
+ | : [[API C_TTSSettings.SetChannelEnabled|C_TTSSettings.SetChannelEnabled]](<span class="apiarg">channelInfo [, newVal]</span>) |
||
− | : DEPRECATED (8.1.5) [[API C_Social.GetNumCharactersPerMedia|C_Social.GetNumCharactersPerMedia]]() |
||
+ | : [[API C_TTSSettings.SetChannelKeyEnabled|C_TTSSettings.SetChannelKeyEnabled]](<span class="apiarg">channelKey [, newVal]</span>) |
||
+ | : [[API C_TTSSettings.SetChatTypeEnabled|C_TTSSettings.SetChatTypeEnabled]](<span class="apiarg">chatName [, newVal]</span>) |
||
+ | : [[API C_TTSSettings.SetDefaultSettings|C_TTSSettings.SetDefaultSettings]]() |
||
+ | : [[API C_TTSSettings.SetSetting|C_TTSSettings.SetSetting]](<span class="apiarg">setting [, newVal]</span>) |
||
+ | : [[API C_TTSSettings.SetSpeechRate|C_TTSSettings.SetSpeechRate]](<span class="apiarg">newVal</span>) |
||
+ | : [[API C_TTSSettings.SetSpeechVolume|C_TTSSettings.SetSpeechVolume]](<span class="apiarg">newVal</span>) |
||
+ | : [[API C_TTSSettings.SetVoiceOption|C_TTSSettings.SetVoiceOption]](<span class="apiarg">voiceType, voiceID</span>) |
||
+ | : [[API C_TTSSettings.SetVoiceOptionName|C_TTSSettings.SetVoiceOptionName]](<span class="apiarg">voiceType, voiceName</span>) |
||
+ | : [[API C_TTSSettings.ShouldOverrideMessage|C_TTSSettings.ShouldOverrideMessage]](<span class="apiarg">language, messageText</span>) : <span class="apiret">overrideMessage</span> |
||
− | == |
+ | ==Character== |
+ | : [[API Dismount|Dismount]]() - Dismounts the character. |
||
− | : [[API CheckBinderDist|CheckBinderDist]]() - Check whether the player is close enough to interact with the Hearthstone binder. |
||
− | : [[API |
+ | : [[API GetBindLocation|GetBindLocation]]() - Returns the subzone the character's Hearthstone is set to. |
− | : [[API |
+ | : [[API GetComboPoints|GetComboPoints]]() - Returns the amount of current combo points. |
+ | : [[API GetCurrentLevelFeatures|GetCurrentLevelFeatures]](<span class="apiarg">level</span>) - For Level Up Display |
||
− | : [[API GetBindLocation|GetBindLocation]]() - Get the name of the location for your Hearthstone. |
||
− | : [[API |
+ | : [[API GetCurrentTitle|GetCurrentTitle]]() - Returns the current [[title]]. |
+ | : [[API GetMirrorTimerInfo|GetMirrorTimerInfo]](<span class="apiarg">id</span>) - Returns info for the mirror timer, e.g. fatigue, breath and feign death. |
||
− | : [[API GetCurrentLevelFeatures|GetCurrentLevelFeatures]](<span style="font-size:smaller; color:#ecbc2a">level</span>) - For Level Up Display |
||
− | : [[API |
+ | : [[API GetMirrorTimerProgress|GetMirrorTimerProgress]](<span class="apiarg">id</span>) - Returns the current value of the mirror timer. |
− | : [[API |
+ | : [[API GetMoney|GetMoney]]() - Returns the amount of money the player character owns. |
+ | : [[API GetNumTitles|GetNumTitles]]() - Returns the number of titles, specifically the highest title ID. |
||
− | : [[API GetLevelUpInstances|GetLevelUpInstances]](<span style="font-size:smaller; color:#ecbc2a">level, isRaid</span>) - For Level Up Display |
||
+ | : [[API GetRestState|GetRestState]]() - Returns if the character is in a [[Rest|rested]] or normal state. |
||
− | : [[API GetMirrorTimerInfo|GetMirrorTimerInfo]](<span style="font-size:smaller; color:#ecbc2a">id</span>) - Returns information about a mirror timer (exhaustion, breath and feign death timers) |
||
− | : [[API |
+ | : [[API GetRuneCooldown|GetRuneCooldown]](<span class="apiarg">id</span>) - Returns the Death Knight's cooldown info for the specified rune. |
− | : [[API |
+ | : [[API GetRuneCount|GetRuneCount]](<span class="apiarg">slot</span>) - Returns the Death Knight's number of runes for a slot. |
− | : [[API |
+ | : [[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 GetRestState|GetRestState]]() - Returns information about a player's rest state. (saved up experience bonus) |
||
− | : [[API GetRuneCooldown|GetRuneCooldown]](<span style="font-size:smaller; color:#ecbc2a">id</span>) - Returns cooldown information about a given rune. |
||
− | : [[API GetRuneCount|GetRuneCount]](<span style="font-size:smaller; color:#ecbc2a">slot</span>) - Returns the number of Runes in the given slot. (Death Knight) |
||
− | : [[API GetSheathState|GetSheathState]]() - Returns the sheath state of the player's weapons. |
||
− | : [[API GetSpellsForCharacterUpgradeTier|GetSpellsForCharacterUpgradeTier]](<span style="font-size:smaller; color:#ecbc2a">tierIndex</span>) - For Level Up Display |
||
: [[API GetTimeToWellRested|GetTimeToWellRested]]() |
: [[API GetTimeToWellRested|GetTimeToWellRested]]() |
||
− | : [[API GetTitleName|GetTitleName]](<span |
+ | : [[API GetTitleName|GetTitleName]](<span class="apiarg">titleId</span>) - Returns the name of a player title. |
− | : [[API GetXPExhaustion|GetXPExhaustion]]() - Returns |
+ | : [[API GetXPExhaustion|GetXPExhaustion]]() - Returns the amount of current rested XP for the character. |
− | : [[API HasAlternateForm|HasAlternateForm]]() |
||
: [[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 |
+ | : [[API IsFalling|IsFalling]]() - Returns true if the character is currently falling. |
− | : [[API IsFlyableArea|IsFlyableArea]]() - Returns |
+ | : [[API IsFlyableArea|IsFlyableArea]]() - Returns true if the current zone is a flyable area. |
− | : [[API IsFlying|IsFlying]]() - Returns |
+ | : [[API IsFlying|IsFlying]]() - Returns true if the character is currently on a flying mount. |
− | : [[API IsIndoors|IsIndoors]]() - Returns |
+ | : [[API IsIndoors|IsIndoors]]() - Returns 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 |
+ | : [[API IsMounted|IsMounted]]() - Returns true if the character is currently mounted. |
− | : [[API IsOutOfBounds|IsOutOfBounds]]() - Returns |
+ | : [[API IsOutOfBounds|IsOutOfBounds]]() - Returns true if the player is currently outside of map boundaries. |
− | : [[API IsOutdoors|IsOutdoors]]() - Returns |
+ | : [[API IsOutdoors|IsOutdoors]]() - Returns true if the character is currently outdoors. |
: [[API IsPlayerInWorld|IsPlayerInWorld]]() |
: [[API IsPlayerInWorld|IsPlayerInWorld]]() |
||
: [[API IsPlayerNeutral|IsPlayerNeutral]]() |
: [[API IsPlayerNeutral|IsPlayerNeutral]]() |
||
− | : [[API IsResting|IsResting]]() - Returns |
+ | : [[API IsResting|IsResting]]() - Returns true if the character is currently resting. |
− | : [[API IsStealthed|IsStealthed]]() - Returns |
+ | : [[API IsStealthed|IsStealthed]]() - Returns true if the character is currently stealthed. |
: [[API IsSubmerged|IsSubmerged]]() |
: [[API IsSubmerged|IsSubmerged]]() |
||
− | : [[API IsSwimming|IsSwimming]]() - Returns |
+ | : [[API IsSwimming|IsSwimming]]() - Returns true if the character is currently swimming. |
− | : [[API IsThreatWarningEnabled|IsThreatWarningEnabled]]() - Returns |
+ | : [[API IsThreatWarningEnabled|IsThreatWarningEnabled]]() - Returns true if threat warnings are currently enabled. |
− | : [[API IsTitleKnown|IsTitleKnown]](<span |
+ | : [[API IsTitleKnown|IsTitleKnown]](<span class="apiarg">index</span>) - Returns 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 RandomRoll|RandomRoll]](<span class="apiarg">min, max</span>) - Performs a random roll between two values. |
||
− | : [[API PlayerHasHearthstone|PlayerHasHearthstone]]() - Returns the hearthstone ID |
||
− | : [[API |
+ | : [[API SetCurrentTitle|SetCurrentTitle]](<span class="apiarg">titleId</span>) {{apitag|hwevent}} - Sets the player's displayed title. |
− | : HW [[API SetCurrentTitle|SetCurrentTitle]](<span style="font-size:smaller; color:#ecbc2a">[[titleId]]</span>) - Sets the player's current title by id. |
||
: [[API ToggleSheath|ToggleSheath]]() - Toggles sheathed or unsheathed weapons. |
: [[API ToggleSheath|ToggleSheath]]() - Toggles sheathed or unsheathed weapons. |
||
− | : PROTECTED [[API UseHearthstone|UseHearthstone]]() |
||
− | === |
+ | ===Paper Doll=== |
− | + | Relates to the [[Paper doll]] (also known as Character sheet). |
|
− | : [[API C_PaperDollInfo.GetArmorEffectiveness|C_PaperDollInfo.GetArmorEffectiveness]](<span |
+ | : [[API C_PaperDollInfo.GetArmorEffectiveness|C_PaperDollInfo.GetArmorEffectiveness]](<span class="apiarg">armor, attackerLevel</span>) : <span class="apiret">effectiveness</span> |
− | : [[API C_PaperDollInfo.GetArmorEffectivenessAgainstTarget|C_PaperDollInfo.GetArmorEffectivenessAgainstTarget]](<span |
+ | : [[API C_PaperDollInfo.GetArmorEffectivenessAgainstTarget|C_PaperDollInfo.GetArmorEffectivenessAgainstTarget]](<span class="apiarg">armor</span>) : <span class="apiret">effectiveness</span> |
− | : [[API C_PaperDollInfo.GetInspectItemLevel|C_PaperDollInfo.GetInspectItemLevel]](<span |
+ | : [[API C_PaperDollInfo.GetInspectItemLevel|C_PaperDollInfo.GetInspectItemLevel]](<span class="apiarg">unit</span>) : <span class="apiret">equippedItemLevel</span> - Returns the average item level for the unit being inspected. |
− | : [[API C_PaperDollInfo.GetMinItemLevel|C_PaperDollInfo.GetMinItemLevel]]() |
+ | : [[API C_PaperDollInfo.GetMinItemLevel|C_PaperDollInfo.GetMinItemLevel]]() : <span class="apiret">minItemLevel</span> |
− | : [[API C_PaperDollInfo.GetStaggerPercentage|C_PaperDollInfo.GetStaggerPercentage]](<span |
+ | : [[API C_PaperDollInfo.GetStaggerPercentage|C_PaperDollInfo.GetStaggerPercentage]](<span class="apiarg">unit</span>) : <span class="apiret">stagger, staggerAgainstTarget</span> |
− | : [[API C_PaperDollInfo.OffhandHasShield|C_PaperDollInfo.OffhandHasShield]]() |
+ | : [[API C_PaperDollInfo.OffhandHasShield|C_PaperDollInfo.OffhandHasShield]]() : <span class="apiret">offhandHasShield</span> |
− | : [[API C_PaperDollInfo.OffhandHasWeapon|C_PaperDollInfo.OffhandHasWeapon]]() |
+ | : [[API C_PaperDollInfo.OffhandHasWeapon|C_PaperDollInfo.OffhandHasWeapon]]() : <span class="apiret">offhandHasWeapon</span> |
: [[API CanDualWield|CanDualWield]]() |
: [[API CanDualWield|CanDualWield]]() |
||
− | : [[API GetAttackPowerForStat|GetAttackPowerForStat]](<span |
+ | : [[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 |
+ | : [[API GetBlockChance|GetBlockChance]]() - Returns the block chance percentage. |
+ | : [[API GetCombatRating|GetCombatRating]](<span class="apiarg">ratingID</span>) - Returns a specific combat rating. |
||
− | : [[API GetCombatRatingBonusForCombatRatingValue|GetCombatRatingBonusForCombatRatingValue]](<span style="font-size:smaller; color:#ecbc2a">ratingIndex, value</span>) |
||
− | : [[API GetCombatRatingBonus|GetCombatRatingBonus]](<span |
+ | : [[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 GetCombatRating|GetCombatRating]](<span style="font-size:smaller; color:#ecbc2a">ratingID</span>) - Returns the player's combat rating for a particular combat rating. |
||
+ | : [[API GetCritChance|GetCritChance]]() - Returns the melee critical hit chance percentage. |
||
: [[API GetCritChanceProvidesParryEffect|GetCritChanceProvidesParryEffect]]() |
: [[API GetCritChanceProvidesParryEffect|GetCritChanceProvidesParryEffect]]() |
||
− | : [[API |
+ | : [[API GetDodgeChance|GetDodgeChance]]() - Returns the dodge chance percentage. |
: [[API GetDodgeChanceFromAttribute|GetDodgeChanceFromAttribute]]() |
: [[API GetDodgeChanceFromAttribute|GetDodgeChanceFromAttribute]]() |
||
− | : [[API GetDodgeChance|GetDodgeChance]]() - Returns the player's percentage dodge chance. |
||
: [[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. |
||
: [[API GetHaste|GetHaste]]() - Returns the player's haste percentage. |
: [[API GetHaste|GetHaste]]() - Returns the player's haste percentage. |
||
: [[API GetHitModifier|GetHitModifier]]() |
: [[API GetHitModifier|GetHitModifier]]() |
||
: [[API GetLifesteal|GetLifesteal]]() |
: [[API GetLifesteal|GetLifesteal]]() |
||
− | : [[API GetManaRegen|GetManaRegen]]() - Returns the |
+ | : [[API GetManaRegen|GetManaRegen]]() - Returns the mana regeneration per second. |
− | : [[API |
+ | : [[API GetMastery|GetMastery]]() - Returns the base mastery percentage. |
− | : [[API |
+ | : [[API GetMasteryEffect|GetMasteryEffect]]() - Returns the effective mastery percentage. |
− | : [[API GetMaxCombatRatingBonus|GetMaxCombatRatingBonus]](<span |
+ | : [[API GetMaxCombatRatingBonus|GetMaxCombatRatingBonus]](<span class="apiarg">ratingIndex</span>) |
− | : [[API GetMeleeHaste|GetMeleeHaste]]() - Returns player's |
+ | : [[API GetMeleeHaste|GetMeleeHaste]]() - Returns the player's melee haste percentage. |
: [[API GetModResilienceDamageReduction|GetModResilienceDamageReduction]]() |
: [[API GetModResilienceDamageReduction|GetModResilienceDamageReduction]]() |
||
: [[API GetOverrideAPBySpellPower|GetOverrideAPBySpellPower]]() |
: [[API GetOverrideAPBySpellPower|GetOverrideAPBySpellPower]]() |
||
: [[API GetOverrideSpellPowerByAP|GetOverrideSpellPowerByAP]]() |
: [[API GetOverrideSpellPowerByAP|GetOverrideSpellPowerByAP]]() |
||
+ | : [[API GetParryChance|GetParryChance]]() - Returns the parry chance percentage. |
||
− | : [[API GetPVPGearStatRules|GetPVPGearStatRules]]() |
||
: [[API GetParryChanceFromAttribute|GetParryChanceFromAttribute]]() |
: [[API GetParryChanceFromAttribute|GetParryChanceFromAttribute]]() |
||
− | : [[API GetParryChance|GetParryChance]]() - Returns the player's percentage parry chance. |
||
: [[API GetPetMeleeHaste|GetPetMeleeHaste]]() |
: [[API GetPetMeleeHaste|GetPetMeleeHaste]]() |
||
: [[API GetPetSpellBonusDamage|GetPetSpellBonusDamage]]() |
: [[API GetPetSpellBonusDamage|GetPetSpellBonusDamage]]() |
||
− | : [[API GetPowerRegenForPowerType|GetPowerRegenForPowerType]](<span style="font-size:smaller; color:#ecbc2a">POWER_TYPE</span>) |
||
: [[API GetPowerRegen|GetPowerRegen]]() - Returns normal and combat power regeneration rates. |
: [[API GetPowerRegen|GetPowerRegen]]() - Returns normal and combat power regeneration rates. |
||
+ | : [[API GetPowerRegenForPowerType|GetPowerRegenForPowerType]](<span class="apiarg">POWER_TYPE</span>) |
||
+ | : [[API GetPVPGearStatRules|GetPVPGearStatRules]]() |
||
: [[API GetPvpPowerDamage|GetPvpPowerDamage]]() |
: [[API GetPvpPowerDamage|GetPvpPowerDamage]]() |
||
: [[API GetPvpPowerHealing|GetPvpPowerHealing]]() |
: [[API GetPvpPowerHealing|GetPvpPowerHealing]]() |
||
− | : [[API GetRangedCritChance|GetRangedCritChance]]() - Returns the |
+ | : [[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 |
+ | : [[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 |
+ | : [[API GetSpellBonusHealing|GetSpellBonusHealing]]() - Returns the raw spell healing bonus. |
− | : [[API GetSpellCritChance|GetSpellCritChance]](<span |
+ | : [[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]]() |
||
: [[API GetSturdiness|GetSturdiness]]() |
: [[API GetSturdiness|GetSturdiness]]() |
||
− | : [[API GetUnitHealthModifier|GetUnitHealthModifier]](<span |
+ | : [[API GetUnitHealthModifier|GetUnitHealthModifier]](<span class="apiarg">unit</span>) |
− | : [[API GetUnitMaxHealthModifier|GetUnitMaxHealthModifier]](<span |
+ | : [[API GetUnitMaxHealthModifier|GetUnitMaxHealthModifier]](<span class="apiarg">unit</span>) |
− | : [[API GetUnitPowerModifier|GetUnitPowerModifier]](<span |
+ | : [[API GetUnitPowerModifier|GetUnitPowerModifier]](<span class="apiarg">unit</span>) |
− | : [[API GetVersatilityBonus|GetVersatilityBonus]](<span |
+ | : [[API GetVersatilityBonus|GetVersatilityBonus]](<span class="apiarg">COMBAT_RATING</span>) |
: [[API HasAPEffectsSpellPower|HasAPEffectsSpellPower]]() |
: [[API HasAPEffectsSpellPower|HasAPEffectsSpellPower]]() |
||
: [[API HasDualWieldPenalty|HasDualWieldPenalty]]() |
: [[API HasDualWieldPenalty|HasDualWieldPenalty]]() |
||
Line 1,098: | Line 1,641: | ||
: [[API IsRangedWeapon|IsRangedWeapon]]() |
: [[API IsRangedWeapon|IsRangedWeapon]]() |
||
: [[API PlayerEffectiveAttackPower|PlayerEffectiveAttackPower]]() |
: [[API PlayerEffectiveAttackPower|PlayerEffectiveAttackPower]]() |
||
− | : [[API ResistancePercent|ResistancePercent]](<span |
+ | : [[API ResistancePercent|ResistancePercent]](<span class="apiarg">resistance, casterLevel</span>) |
− | === |
+ | ===Equipment Manager=== |
− | The [[ |
+ | 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. |
||
− | : UI [https://www.townlong-yak.com/framexml/go/DressUpItemLink DressUpItemLink](<span style="font-size:smaller; color:#ecbc2a">itemLink</span>) - Shows the Dressing Room with the given item equipped. |
||
+ | : [[API C_EquipmentSet.CanUseEquipmentSets|C_EquipmentSet.CanUseEquipmentSets]]() : <span class="apiret">canUseEquipmentSets</span> - Returns whether any equipment sets can be used. |
||
− | : UI [https://www.townlong-yak.com/framexml/go/DressUpMountLink DressUpMountLink](<span style="font-size:smaller; color:#ecbc2a">itemLink | spellLink</span>) - Shows the Dressing Room for the mount. |
||
+ | : [[API C_EquipmentSet.ClearIgnoredSlotsForSave|C_EquipmentSet.ClearIgnoredSlotsForSave]]() - Clears ignored slots for saving. |
||
− | : UI [https://www.townlong-yak.com/framexml/go/DressUpTransmogLink DressUpTransmogLink](<span style="font-size:smaller; color:#ecbc2a">transmogLink</span>) - Shows the Dressing Room for transmog appearance or illusion. |
||
+ | : [[API C_EquipmentSet.CreateEquipmentSet|C_EquipmentSet.CreateEquipmentSet]](<span class="apiarg">equipmentSetName [, icon]</span>) - Creates an equipment set. |
||
− | : UI [https://www.townlong-yak.com/framexml/go/SetDressUpBackground SetDressUpBackground](<span style="font-size:smaller; color:#ecbc2a">frame, fileName, atlasPostfix</span>) |
||
+ | : [[API C_EquipmentSet.DeleteEquipmentSet|C_EquipmentSet.DeleteEquipmentSet]](<span class="apiarg">equipmentSetID</span>) - Deletes an equipment set. |
||
+ | : [[API C_EquipmentSet.EquipmentSetContainsLockedItems|C_EquipmentSet.EquipmentSetContainsLockedItems]](<span class="apiarg">equipmentSetID</span>) : <span class="apiret">hasLockedItems</span> - Returns whether an equipment set has locked items |
||
+ | : [[API C_EquipmentSet.GetEquipmentSetAssignedSpec|C_EquipmentSet.GetEquipmentSetAssignedSpec]](<span class="apiarg">equipmentSetID</span>) : <span class="apiret">specIndex</span> - Returns the specialization assigned to an equipment set. |
||
+ | : [[API C_EquipmentSet.GetEquipmentSetForSpec|C_EquipmentSet.GetEquipmentSetForSpec]](<span class="apiarg">specIndex</span>) : <span class="apiret">equipmentSetID</span> - Returns the equipment set currently assigned to a specific specialization. |
||
+ | : [[API C_EquipmentSet.GetEquipmentSetID|C_EquipmentSet.GetEquipmentSetID]](<span class="apiarg">equipmentSetName</span>) : <span class="apiret">equipmentSetID</span> - Returns the set ID of an equipment set with the specified name. |
||
+ | : [[API C_EquipmentSet.GetEquipmentSetIDs|C_EquipmentSet.GetEquipmentSetIDs]]() : <span class="apiret">equipmentSetIDs</span> - Returns an array containing all currently saved equipment set IDs. |
||
+ | : [[API C_EquipmentSet.GetEquipmentSetInfo|C_EquipmentSet.GetEquipmentSetInfo]](<span class="apiarg">equipmentSetID</span>) : <span class="apiret">name, iconFileID, setID, isEquipped, numItems, numEquipped, numInInventory, numLost, numIgnored</span> - Returns information about a saved equipment set. |
||
+ | : [[API C_EquipmentSet.GetIgnoredSlots|C_EquipmentSet.GetIgnoredSlots]](<span class="apiarg">equipmentSetID</span>) : <span class="apiret">slotIgnored</span> - Returns ignored slots of an equipment set. |
||
+ | : [[API C_EquipmentSet.GetItemIDs|C_EquipmentSet.GetItemIDs]](<span class="apiarg">equipmentSetID</span>) : <span class="apiret">itemIDs</span> - Returns the item IDs of an equipment set. |
||
+ | : [[API C_EquipmentSet.GetItemLocations|C_EquipmentSet.GetItemLocations]](<span class="apiarg">equipmentSetID</span>) : <span class="apiret">locations</span> - Returns the location of all items in an equipment set. |
||
+ | : [[API C_EquipmentSet.GetNumEquipmentSets|C_EquipmentSet.GetNumEquipmentSets]]() : <span class="apiret">numEquipmentSets</span> - Returns the number of saved equipment sets. |
||
+ | : [[API C_EquipmentSet.IgnoreSlotForSave|C_EquipmentSet.IgnoreSlotForSave]](<span class="apiarg">slot</span>) - Ignores an equipment slot for saving. |
||
+ | : [[API C_EquipmentSet.IsSlotIgnoredForSave|C_EquipmentSet.IsSlotIgnoredForSave]](<span class="apiarg">slot</span>) : <span class="apiret">isSlotIgnored</span> - Returns whether a slot is ignored for saving. |
||
+ | : [[API C_EquipmentSet.ModifyEquipmentSet|C_EquipmentSet.ModifyEquipmentSet]](<span class="apiarg">equipmentSetID, newName [, newIcon]</span>) - Modifies an equipment set. |
||
+ | : [[API C_EquipmentSet.PickupEquipmentSet|C_EquipmentSet.PickupEquipmentSet]](<span class="apiarg">equipmentSetID</span>) - Picks up an equipment set, placing it on the cursor. |
||
+ | : [[API C_EquipmentSet.SaveEquipmentSet|C_EquipmentSet.SaveEquipmentSet]](<span class="apiarg">equipmentSetID [, icon]</span>) - Saves your currently equipped items into an equipment set. |
||
+ | : [[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.UseEquipmentSet|C_EquipmentSet.UseEquipmentSet]](<span class="apiarg">equipmentSetID</span>) : <span class="apiret">setWasEquipped</span> {{apitag|nocombat}} - Equips items from a specified equipment set. |
||
+ | : [[API GetInventoryItemEquippedUnusable|GetInventoryItemEquippedUnusable]](<span class="apiarg">unit, slot</span>) |
||
+ | : [[API GetInventoryItemsForSlot|GetInventoryItemsForSlot]](<span class="apiarg">slot, returnTable [, transmogrify]</span>) |
||
+ | : [[API EquipmentManager_UnpackLocation|EquipmentManager_UnpackLocation]]() {{apitag|framexml}} - Unpacks a location integer to determine the actual inventory location. |
||
− | === |
+ | ===Dressing Room=== |
+ | The [[Dressing room]] was added in [[Patch 1.7.0]] |
||
− | Most of these functions may only be called on a hardware event from '''secure''' code. |
||
+ | : [https://www.townlong-yak.com/framexml/go/DressUpItemLink DressUpItemLink](<span class="apiarg">itemLink</span>) {{apitag|framexml}} - Shows the Dressing Room with the given item equipped. |
||
− | : PROTECTED [[API AscendStop|AscendStop]]() - Called when you release the jump key. |
||
+ | : [https://www.townlong-yak.com/framexml/go/DressUpMountLink DressUpMountLink](<span class="apiarg">itemLink | spellLink</span>) {{apitag|framexml}} - Shows the Dressing Room for the mount. |
||
− | : PROTECTED [[API AttackTarget|AttackTarget]]() - Attacks the targetted unit. |
||
+ | : [https://www.townlong-yak.com/framexml/go/DressUpTransmogLink DressUpTransmogLink](<span class="apiarg">transmogLink</span>) {{apitag|framexml}} - Shows the Dressing Room for transmog appearance or illusion. |
||
− | : PROTECTED [[API DescendStop|DescendStop]]() - The player stops descending (while swimming or flying) |
||
+ | : [https://www.townlong-yak.com/framexml/go/SetDressUpBackground SetDressUpBackground](<span class="apiarg">frame, fileName, atlasPostfix</span>) {{apitag|framexml}} |
||
− | : PROTECTED [[API InteractUnit|InteractUnit]](<span style="font-size:smaller; color:#ecbc2a">unitToken [, exactMatch]</span>) |
||
− | : [[API FollowUnit|FollowUnit]](<span style="font-size:smaller; color:#ecbc2a">unit</span>) - Follow an ally with the specified UnitID. |
||
− | : [[API IsPlayerMoving|IsPlayerMoving]]() |
||
− | : PROTECTED [[API JumpOrAscendStart|JumpOrAscendStart]]() - Makes the player jump. |
||
− | : PROTECTED [[API MoveAndSteerStart|MoveAndSteerStart]]() |
||
− | : PROTECTED [[API MoveAndSteerStop|MoveAndSteerStop]]() |
||
− | : PROTECTED [[API MoveBackwardStart|MoveBackwardStart]]() - The player begins moving backward at the specified time. |
||
− | : PROTECTED [[API MoveBackwardStop|MoveBackwardStop]]() - The player stops moving backward at the specified time. |
||
− | : PROTECTED [[API MoveForwardStart|MoveForwardStart]]() - The player begins moving forward at the specified time. |
||
− | : PROTECTED [[API MoveForwardStop|MoveForwardStop]]() - The player stops moving forward at the specified time. |
||
− | : PROTECTED [[API SetMoveEnabled|SetMoveEnabled]]() |
||
− | : PROTECTED [[API SetTurnEnabled|SetTurnEnabled]]() |
||
− | : PROTECTED [[API SitStandOrDescendStart|SitStandOrDescendStart]]() - The player sits, stands, or descends. |
||
− | : PROTECTED [[API StartAttack|StartAttack]]() |
||
− | : [[API StopAttack|StopAttack]]() - Turns off auto-attack, if currently active. |
||
− | : PROTECTED [[API StartAutoRun|StartAutoRun]]() |
||
− | : PROTECTED [[API StopAutoRun|StopAutoRun]]() |
||
− | : PROTECTED [[API StrafeLeftStart|StrafeLeftStart]]() - The player begins strafing left at the specified time. |
||
− | : PROTECTED [[API StrafeLeftStop|StrafeLeftStop]]() - The player stops strafing left at the specified time. |
||
− | : PROTECTED [[API StrafeRightStart|StrafeRightStart]]() - The player begins strafing right at the specified time. |
||
− | : PROTECTED [[API StrafeRightStop|StrafeRightStop]]() - The player stops strafing right at the specified time. |
||
− | : PROTECTED [[API ToggleAutoRun|ToggleAutoRun]]() - Turns auto-run on or off. |
||
− | : PROTECTED [[API ToggleRun|ToggleRun]]() - Toggle between running and walking. |
||
− | : PROTECTED [[API TurnLeftStart|TurnLeftStart]]() - The player starts turning left at the specified time. |
||
− | : PROTECTED [[API TurnLeftStop|TurnLeftStop]]() - The player stops turning left at the specified time. |
||
− | : PROTECTED [[API TurnOrActionStart|TurnOrActionStart]]() - Begin "Right Click" in the 3D world. |
||
− | : PROTECTED [[API TurnOrActionStop|TurnOrActionStop]]() - End "Right Click" in the 3D world. |
||
− | : PROTECTED [[API TurnRightStart|TurnRightStart]]() - The player starts turning right at the specified time. |
||
− | : PROTECTED [[API TurnRightStop|TurnRightStop]]() - The player stops turning right at the specified time. |
||
− | === |
+ | ===Transmogrification=== |
+ | [[Transmogrification]] was added in [[Patch 4.3.0]]. See also [[#Appearances|Appearances]] functions. |
||
− | : [[API C_DeathInfo.GetCorpseMapPosition|C_DeathInfo.GetCorpseMapPosition]](<span style="font-size:smaller; color:#ecbc2a">uiMapID</span>) - Returns the location of the player's corpse on the map. |
||
+ | : [[API C_Transmog.ApplyAllPending|C_Transmog.ApplyAllPending]](<span class="apiarg">[currentSpecOnly]</span>) : <span class="apiret">requestSent</span> - Confirms all pending transmogs. |
||
− | : [[API C_DeathInfo.GetDeathReleasePosition|C_DeathInfo.GetDeathReleasePosition]](<span style="font-size:smaller; color:#ecbc2a">uiMapID</span>) - Returns the death release location. |
||
+ | : [[API C_Transmog.CanHaveSecondaryAppearanceForSlotID|C_Transmog.CanHaveSecondaryAppearanceForSlotID]](<span class="apiarg">slotID</span>) : <span class="apiret">canHaveSecondaryAppearance</span> |
||
− | : [[API C_DeathInfo.GetGraveyardsForMap|C_DeathInfo.GetGraveyardsForMap]](<span style="font-size:smaller; color:#ecbc2a">uiMapID</span>) - Returns graveyard info and location for a map. |
||
+ | : [[API C_Transmog.CanTransmogItem|C_Transmog.CanTransmogItem]](<span class="apiarg">itemInfo</span>) : <span class="apiret">canBeTransmogged, selfFailureReason, canTransmogOthers, othersFailureReason</span> |
||
− | : [[API C_DeathInfo.GetSelfResurrectOptions|C_DeathInfo.GetSelfResurrectOptions]]() - Returns self resurrect options for your character, including from soulstones. |
||
+ | : [[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_DeathInfo.UseSelfResurrectOption|C_DeathInfo.UseSelfResurrectOption]](<span style="font-size:smaller; color:#ecbc2a">optionType, id</span>) - Uses a soulstone or similar means of self resurrection. |
||
+ | : [[API C_Transmog.ClearAllPending|C_Transmog.ClearAllPending]]() |
||
− | : [[API AcceptResurrect|AcceptResurrect]]() - The player accepts the request from another player to resurrect him/herself. |
||
+ | : [[API C_Transmog.ClearPending|C_Transmog.ClearPending]](<span class="apiarg">transmogLocation</span>) - Clears an equipment slot of pending transmogs. |
||
− | : [[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 |
+ | : [[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 DeathRecap_GetEvents|DeathRecap_GetEvents]]() |
||
+ | : [[API C_Transmog.GetApplyCost|C_Transmog.GetApplyCost]]() : <span class="apiret">cost</span> |
||
− | : [[API DeathRecap_HasEvents|DeathRecap_HasEvents]]() |
||
+ | : [[API C_Transmog.GetApplyWarnings|C_Transmog.GetApplyWarnings]]() : <span class="apiret">warnings</span> |
||
− | : [[API DeclineResurrect|DeclineResurrect]]() - Decline the request from another player to resurrect him/herself. |
||
+ | : [[API C_Transmog.GetBaseCategory|C_Transmog.GetBaseCategory]](<span class="apiarg">transmogID</span>) : <span class="apiret">categoryID</span> |
||
− | : [[API GetCemeteryPreference|GetCemeteryPreference]]() |
||
+ | : [[API C_Transmog.GetCreatureDisplayIDForSource|C_Transmog.GetCreatureDisplayIDForSource]](<span class="apiarg">itemModifiedAppearanceID</span>) : <span class="apiret">creatureDisplayID</span> |
||
− | : [[API GetCorpseRecoveryDelay|GetCorpseRecoveryDelay]]() - Time left before a player can accept a resurrection. |
||
+ | : [[API C_Transmog.GetItemIDForSource|C_Transmog.GetItemIDForSource]](<span class="apiarg">itemModifiedAppearanceID</span>) : <span class="apiret">itemID</span> |
||
− | : [[API GetDeathRecapLink|GetDeathRecapLink]](<span style="font-size:smaller; color:#ecbc2a">recapID</span>) |
||
+ | : [[API C_Transmog.GetPending|C_Transmog.GetPending]](<span class="apiarg">transmogLocation</span>) : <span class="apiret">pendingInfo</span> |
||
− | : [[API GetReleaseTimeRemaining|GetReleaseTimeRemaining]]() - Returns the amount of time left before your ghost is pulled from your body. |
||
+ | : [[API C_Transmog.GetSlotEffectiveCategory|C_Transmog.GetSlotEffectiveCategory]](<span class="apiarg">transmogLocation</span>) : <span class="apiret">categoryID</span> |
||
− | : [[API GetResSicknessDuration|GetResSicknessDuration]]() |
||
+ | : [[API C_Transmog.GetSlotForInventoryType|C_Transmog.GetSlotForInventoryType]](<span class="apiarg">inventoryType</span>) : <span class="apiret">slot</span> - Returns the equipment slot for an inventory type. |
||
− | : [[API HasNoReleaseAura|HasNoReleaseAura]]() |
||
+ | : [[API C_Transmog.GetSlotInfo|C_Transmog.GetSlotInfo]](<span class="apiarg">transmogLocation</span>) : <span class="apiret">isTransmogrified, hasPending, isPendingCollected, canTransmogrify, cannotTransmogrifyReason, hasUndo, isHideVisual, texture</span> |
||
− | : [[API IsCemeterySelectionAvailable|IsCemeterySelectionAvailable]]() |
||
+ | : [[API C_Transmog.GetSlotUseError|C_Transmog.GetSlotUseError]](<span class="apiarg">transmogLocation</span>) : <span class="apiret">errorCode, errorString</span> |
||
− | : [[API IsEncounterLimitingResurrections|IsEncounterLimitingResurrections]]() |
||
+ | : [[API C_Transmog.GetSlotVisualInfo|C_Transmog.GetSlotVisualInfo]](<span class="apiarg">transmogLocation</span>) : <span class="apiret">baseSourceID, baseVisualID, appliedSourceID, appliedVisualID, pendingSourceID, pendingVisualID, hasUndo, isHideVisual, itemSubclass</span> |
||
− | : [[API IsEncounterSuppressingRelease|IsEncounterSuppressingRelease]]() |
||
+ | : [[API C_Transmog.IsAtTransmogNPC|C_Transmog.IsAtTransmogNPC]]() : <span class="apiret">isAtNPC</span> |
||
− | : [[API NotWhileDeadError|NotWhileDeadError]]() - Generates an error message saying you cannot do that while dead. |
||
+ | : [[API C_Transmog.IsSlotBeingCollapsed|C_Transmog.IsSlotBeingCollapsed]](<span class="apiarg">transmogLocation</span>) : <span class="apiret">isBeingCollapsed</span> |
||
− | : [[API PortGraveyard|PortGraveyard]]() |
||
+ | : [[API C_Transmog.LoadOutfit|C_Transmog.LoadOutfit]](<span class="apiarg">outfitID</span>) |
||
− | : [[API RepopMe|RepopMe]]() - The "Release Spirit" button. Sends you to the graveyard when dead. |
||
+ | : [[API C_Transmog.SetPending|C_Transmog.SetPending]](<span class="apiarg">transmogLocation, pendingInfo</span>) |
||
− | : [[API ResurrectGetOfferer|ResurrectGetOfferer]]() - Returns the name of the person offering to resurrect you. |
||
+ | : [[API C_Item.CanItemTransmogAppearance|C_Item.CanItemTransmogAppearance]](<span class="apiarg">itemLoc</span>) : <span class="apiret">canTransmog, errorCode</span> |
||
− | : [[API ResurrectHasSickness|ResurrectHasSickness]]() - Appears to be used when accepting a resurrection will give you resurrection sickessness. |
||
+ | : [[API C_Item.GetAppliedItemTransmogInfo|C_Item.GetAppliedItemTransmogInfo]](<span class="apiarg">itemLoc</span>) : <span class="apiret">info</span> |
||
− | : [[API ResurrectHasTimer|ResurrectHasTimer]]() - Does the player have to wait before accepting a resurrection. |
||
+ | : [[API C_Item.GetBaseItemTransmogInfo|C_Item.GetBaseItemTransmogInfo]](<span class="apiarg">itemLoc</span>) : <span class="apiret">info</span> |
||
− | : [[API RetrieveCorpse|RetrieveCorpse]]() - Resurrects when near corpse. e.g., The "Accept" button one sees after running back to your body. |
||
+ | : [[API C_Item.GetCurrentItemTransmogInfo|C_Item.GetCurrentItemTransmogInfo]](<span class="apiarg">itemLoc</span>) : <span class="apiret">info</span> |
||
− | : [[API SetCemeteryPreference|SetCemeteryPreference]](<span style="font-size:smaller; color:#ecbc2a">cemeteryID</span>) |
||
+ | : [[API C_Item.IsDressableItemByID|C_Item.IsDressableItemByID]](<span class="apiarg">itemInfo</span>) : <span class="apiret">isDressableItem</span> |
||
− | : [[API TimeoutResurrect|TimeoutResurrect]]() |
||
+ | : [[API IsCosmeticItem|IsCosmeticItem]]() |
||
+ | |||
+ | ===Barber Shop=== |
||
+ | 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.Cancel|C_BarberShop.Cancel]]() |
||
+ | : [[API C_BarberShop.ClearPreviewChoices|C_BarberShop.ClearPreviewChoices]](<span class="apiarg">[clearSavedChoices]</span>) |
||
+ | : [[API C_BarberShop.GetAvailableCustomizations|C_BarberShop.GetAvailableCustomizations]]() : <span class="apiret">categories</span> |
||
+ | : [[API C_BarberShop.GetCurrentCameraZoom|C_BarberShop.GetCurrentCameraZoom]]() : <span class="apiret">zoomLevel</span> |
||
+ | : [[API C_BarberShop.GetCurrentCharacterData|C_BarberShop.GetCurrentCharacterData]]() : <span class="apiret">characterData</span> |
||
+ | : [[API C_BarberShop.GetCurrentCost|C_BarberShop.GetCurrentCost]]() : <span class="apiret">cost</span> |
||
+ | : [[API C_BarberShop.HasAnyChanges|C_BarberShop.HasAnyChanges]]() : <span class="apiret">hasChanges</span> |
||
+ | : [[API C_BarberShop.IsViewingAlteredForm|C_BarberShop.IsViewingAlteredForm]]() : <span class="apiret">isViewingAlteredForm</span> |
||
+ | : [[API C_BarberShop.MarkCustomizationChoiceAsSeen|C_BarberShop.MarkCustomizationChoiceAsSeen]](<span class="apiarg">choiceID</span>) |
||
+ | : [[API C_BarberShop.MarkCustomizationOptionAsSeen|C_BarberShop.MarkCustomizationOptionAsSeen]](<span class="apiarg">optionID</span>) |
||
+ | : [[API C_BarberShop.PreviewCustomizationChoice|C_BarberShop.PreviewCustomizationChoice]](<span class="apiarg">optionID, choiceID</span>) |
||
+ | : [[API C_BarberShop.RandomizeCustomizationChoices|C_BarberShop.RandomizeCustomizationChoices]]() |
||
+ | : [[API C_BarberShop.ResetCameraRotation|C_BarberShop.ResetCameraRotation]]() |
||
+ | : [[API C_BarberShop.ResetCustomizationChoices|C_BarberShop.ResetCustomizationChoices]]() |
||
+ | : [[API C_BarberShop.RotateCamera|C_BarberShop.RotateCamera]](<span class="apiarg">diffDegrees</span>) |
||
+ | : [[API C_BarberShop.SaveSeenChoices|C_BarberShop.SaveSeenChoices]]() |
||
+ | : [[API C_BarberShop.SetCameraDistanceOffset|C_BarberShop.SetCameraDistanceOffset]](<span class="apiarg">offset</span>) |
||
+ | : [[API C_BarberShop.SetCameraZoomLevel|C_BarberShop.SetCameraZoomLevel]](<span class="apiarg">zoomLevel [, keepCustomZoom]</span>) |
||
+ | : [[API C_BarberShop.SetCustomizationChoice|C_BarberShop.SetCustomizationChoice]](<span class="apiarg">optionID, choiceID</span>) |
||
+ | : [[API C_BarberShop.SetModelDressState|C_BarberShop.SetModelDressState]](<span class="apiarg">dressedState</span>) |
||
+ | : [[API C_BarberShop.SetSelectedSex|C_BarberShop.SetSelectedSex]](<span class="apiarg">sex</span>) |
||
+ | : [[API C_BarberShop.SetViewingAlteredForm|C_BarberShop.SetViewingAlteredForm]](<span class="apiarg">isViewingAlteredForm</span>) |
||
+ | : [[API C_BarberShop.SetViewingShapeshiftForm|C_BarberShop.SetViewingShapeshiftForm]](<span class="apiarg">[shapeshiftFormID]</span>) |
||
+ | : [[API C_BarberShop.ZoomCamera|C_BarberShop.ZoomCamera]](<span class="apiarg">zoomAmount</span>) |
||
− | == |
+ | ==Cinematics== |
− | + | Relates to in-game cinematics/cutscenes. |
|
: [[API CanCancelScene|CanCancelScene]]() |
: [[API CanCancelScene|CanCancelScene]]() |
||
: [[API CancelScene|CancelScene]]() |
: [[API CancelScene|CancelScene]]() |
||
Line 1,182: | Line 1,748: | ||
: [[API OpeningCinematic|OpeningCinematic]]() - Shows the opening cinematic for a player's race. Only works as long as the player has earned zero exp. |
: [[API OpeningCinematic|OpeningCinematic]]() - Shows the opening cinematic for a player's race. Only works as long as the player has earned zero exp. |
||
: [[API StopCinematic|StopCinematic]]() |
: [[API StopCinematic|StopCinematic]]() |
||
− | + | Relates to pre-rendered movies. |
|
− | : [[API CancelPreloadingMovie|CancelPreloadingMovie]](<span |
+ | : [[API CancelPreloadingMovie|CancelPreloadingMovie]](<span class="apiarg">movieId</span>) |
− | : [[API GetMovieDownloadProgress|GetMovieDownloadProgress]](<span |
+ | : [[API GetMovieDownloadProgress|GetMovieDownloadProgress]](<span class="apiarg">movieId</span>) |
: [[API GameMovieFinished|GameMovieFinished]]() - Ends the movie. |
: [[API GameMovieFinished|GameMovieFinished]]() - Ends the movie. |
||
− | : [[API IsMovieLocal|IsMovieLocal]](<span |
+ | : [[API IsMovieLocal|IsMovieLocal]](<span class="apiarg">movieId</span>) |
− | : [[API IsMoviePlayable|IsMoviePlayable]](<span |
+ | : [[API IsMoviePlayable|IsMoviePlayable]](<span class="apiarg">movieId</span>) - Returns true if the specified movie exists and can be played. |
− | : [[API PreloadMovie|PreloadMovie]](<span |
+ | : [[API PreloadMovie|PreloadMovie]](<span class="apiarg">movieId</span>) |
− | : |
+ | : [[API MovieFrame_PlayMovie|MovieFrame_PlayMovie]](<span class="apiarg">MovieFrame, movieID</span>) {{apitag|framexml}} - Plays a movie. |
− | == |
+ | ==Class== |
− | : [[API C_ClassColor.GetClassColor|C_ClassColor.GetClassColor]](<span |
+ | : [[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 |
+ | : [[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 |
+ | : [[API FillLocalizedClassList|FillLocalizedClassList]](<span class="apiarg">classTable [, isFemale]</span>) - Fills a table with localized male or female class names. |
− | : [[API GetClassInfo|GetClassInfo]](<span |
+ | : [[API GetClassInfo|GetClassInfo]](<span class="apiarg">index</span>) - Returns information about a class. |
− | : [[API GetNumClasses|GetNumClasses]]() - Returns the |
+ | : [[API GetNumClasses|GetNumClasses]]() - Returns the number of player classes in the game. |
: [[API IsDemonHunterAvailable|IsDemonHunterAvailable]]() |
: [[API IsDemonHunterAvailable|IsDemonHunterAvailable]]() |
||
− | : |
+ | : [[API GetClassColor|GetClassColor]](<span class="apiarg">classFilename</span>) {{apitag|framexml}} - Returns a class color from RAID_CLASS_COLORS. |
− | [[Shaman totem]]s |
||
− | : PROTECTED [[API DestroyTotem|DestroyTotem]](<span style="font-size:smaller; color:#ecbc2a">slot</span>) - Destroys a totem/minion. |
||
− | : [[API GetMultiCastTotemSpells|GetMultiCastTotemSpells]](<span style="font-size:smaller; color:#ecbc2a">totemslot</span>) - Returns a list of spellIDs that are applicable for the specified totem slot (1-4) |
||
− | : [[API GetTotemCannotDismiss|GetTotemCannotDismiss]](<span style="font-size:smaller; color:#ecbc2a">slot</span>) |
||
− | : [[API GetTotemInfo|GetTotemInfo]](<span style="font-size:smaller; color:#ecbc2a">slot</span>) - Returns information about a totem. |
||
− | : [[API GetTotemTimeLeft|GetTotemTimeLeft]](<span style="font-size:smaller; color:#ecbc2a">slot</span>) |
||
− | : [[API TargetTotem|TargetTotem]](<span style="font-size:smaller; color:#ecbc2a">slot</span>) |
||
− | : PROTECTED [[API SetMultiCastSpell|SetMultiCastSpell]](<span style="font-size:smaller; color:#ecbc2a">actionID, spellID</span>) - Assigns a spellID to a multicast (totem bar) actionID. |
||
− | [[Druid shapeshift forms]] |
||
− | : PROTECTED [[API CancelShapeshiftForm|CancelShapeshiftForm]]() - Cancels a druid's shapeshift form buff. |
||
− | : PROTECTED [[API CastShapeshiftForm|CastShapeshiftForm]](<span style="font-size:smaller; color:#ecbc2a">index</span>) |
||
− | : [[API GetNumShapeshiftForms|GetNumShapeshiftForms]]() |
||
− | : [[API GetShapeshiftForm|GetShapeshiftForm]](<span style="font-size:smaller; color:#ecbc2a">unknown</span>) - Returns zero-based index of current form/stance. |
||
− | : [[API GetShapeshiftFormCooldown|GetShapeshiftFormCooldown]](<span style="font-size:smaller; color:#ecbc2a">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 style="font-size:smaller; color:#ecbc2a">index</span>) - Retrieves information about an available ShapeshiftForm or Stance. |
||
− | === |
+ | ===Talents=== |
− | + | Relates to [[Specialization|Specializations]]. |
|
− | : [[API C_SpecializationInfo.CanPlayerUsePVPTalentUI|C_SpecializationInfo.CanPlayerUsePVPTalentUI]]() |
+ | : [[API C_SpecializationInfo.CanPlayerUsePVPTalentUI|C_SpecializationInfo.CanPlayerUsePVPTalentUI]]() : <span class="apiret">canUse, failureReason</span> |
− | : [[API C_SpecializationInfo.CanPlayerUseTalentSpecUI|C_SpecializationInfo.CanPlayerUseTalentSpecUI]]() |
+ | : [[API C_SpecializationInfo.CanPlayerUseTalentSpecUI|C_SpecializationInfo.CanPlayerUseTalentSpecUI]]() : <span class="apiret">canUse, failureReason</span> |
− | : [[API C_SpecializationInfo.CanPlayerUseTalentUI|C_SpecializationInfo.CanPlayerUseTalentUI]]() |
+ | : [[API C_SpecializationInfo.CanPlayerUseTalentUI|C_SpecializationInfo.CanPlayerUseTalentUI]]() : <span class="apiret">canUse, failureReason</span> |
− | : [[API C_SpecializationInfo.GetAllSelectedPvpTalentIDs|C_SpecializationInfo.GetAllSelectedPvpTalentIDs]]() |
+ | : [[API C_SpecializationInfo.GetAllSelectedPvpTalentIDs|C_SpecializationInfo.GetAllSelectedPvpTalentIDs]]() : <span class="apiret">selectedPvpTalentIDs</span> |
− | : [[API C_SpecializationInfo.GetInspectSelectedPvpTalent|C_SpecializationInfo.GetInspectSelectedPvpTalent]](<span |
+ | : [[API C_SpecializationInfo.GetInspectSelectedPvpTalent|C_SpecializationInfo.GetInspectSelectedPvpTalent]](<span class="apiarg">inspectedUnit, talentIndex</span>) : <span class="apiret">selectedTalentID</span> |
− | : [[API C_SpecializationInfo.GetPvpTalentAlertStatus|C_SpecializationInfo.GetPvpTalentAlertStatus]]() |
+ | : [[API C_SpecializationInfo.GetPvpTalentAlertStatus|C_SpecializationInfo.GetPvpTalentAlertStatus]]() : <span class="apiret">hasUnspentSlot, hasNewTalent</span> |
− | : [[API C_SpecializationInfo.GetPvpTalentSlotInfo|C_SpecializationInfo.GetPvpTalentSlotInfo]](<span |
+ | : [[API C_SpecializationInfo.GetPvpTalentSlotInfo|C_SpecializationInfo.GetPvpTalentSlotInfo]](<span class="apiarg">talentIndex</span>) : <span class="apiret">slotInfo</span> |
− | : [[API C_SpecializationInfo.GetPvpTalentSlotUnlockLevel|C_SpecializationInfo.GetPvpTalentSlotUnlockLevel]](<span |
+ | : [[API C_SpecializationInfo.GetPvpTalentSlotUnlockLevel|C_SpecializationInfo.GetPvpTalentSlotUnlockLevel]](<span class="apiarg">talentIndex</span>) : <span class="apiret">requiredLevel</span> |
− | : [[API C_SpecializationInfo.GetPvpTalentUnlockLevel|C_SpecializationInfo.GetPvpTalentUnlockLevel]](<span |
+ | : [[API C_SpecializationInfo.GetPvpTalentUnlockLevel|C_SpecializationInfo.GetPvpTalentUnlockLevel]](<span class="apiarg">talentID</span>) : <span class="apiret">requiredLevel</span> |
− | : [[API C_SpecializationInfo. |
+ | : [[API C_SpecializationInfo.GetSpecIDs|C_SpecializationInfo.GetSpecIDs]](<span class="apiarg">specSetID</span>) : <span class="apiret">specIDs</span> |
− | : [[API C_SpecializationInfo. |
+ | : [[API C_SpecializationInfo.GetSpellsDisplay|C_SpecializationInfo.GetSpellsDisplay]](<span class="apiarg">specializationID</span>) : <span class="apiret">spellID</span> |
− | : [[API C_SpecializationInfo. |
+ | : [[API C_SpecializationInfo.IsInitialized|C_SpecializationInfo.IsInitialized]]() : <span class="apiret">isSpecializationDataInitialized</span> |
− | : [[API C_SpecializationInfo. |
+ | : [[API C_SpecializationInfo.IsPvpTalentLocked|C_SpecializationInfo.IsPvpTalentLocked]](<span class="apiarg">talentID</span>) : <span class="apiret">locked</span> |
+ | : [[API C_SpecializationInfo.MatchesCurrentSpecSet|C_SpecializationInfo.MatchesCurrentSpecSet]](<span class="apiarg">specSetID</span>) : <span class="apiret">matches</span> |
||
+ | : [[API C_SpecializationInfo.SetPvpTalentLocked|C_SpecializationInfo.SetPvpTalentLocked]](<span class="apiarg">talentID, locked</span>) |
||
: [[API AreTalentsLocked|AreTalentsLocked]]() |
: [[API AreTalentsLocked|AreTalentsLocked]]() |
||
− | : [[API CheckTalentMasterDist|CheckTalentMasterDist]]() - Returns nil if the player is too far away from the talent master to use the talent methods. |
||
: [[API ClearFailedPVPTalentIDs|ClearFailedPVPTalentIDs]]() |
: [[API ClearFailedPVPTalentIDs|ClearFailedPVPTalentIDs]]() |
||
: [[API ClearFailedTalentIDs|ClearFailedTalentIDs]]() |
: [[API ClearFailedTalentIDs|ClearFailedTalentIDs]]() |
||
: [[API ConfirmTalentWipe|ConfirmTalentWipe]]() - Confirms freeing all talent points. |
: [[API ConfirmTalentWipe|ConfirmTalentWipe]]() - Confirms freeing all talent points. |
||
− | : [[API GetActiveSpecGroup|GetActiveSpecGroup]](<span |
+ | : [[API GetActiveSpecGroup|GetActiveSpecGroup]](<span class="apiarg">[isInspect]</span>) - Returns the index of the current active specialization/talent/glyph group. |
− | : [[API GetArenaOpponentSpec|GetArenaOpponentSpec]]() |
||
: [[API GetFailedPVPTalentIDs|GetFailedPVPTalentIDs]]() |
: [[API GetFailedPVPTalentIDs|GetFailedPVPTalentIDs]]() |
||
: [[API GetFailedTalentIDs|GetFailedTalentIDs]]() |
: [[API GetFailedTalentIDs|GetFailedTalentIDs]]() |
||
: [[API GetMaxTalentTier|GetMaxTalentTier]]() - Returns the number of available talent tiers. |
: [[API GetMaxTalentTier|GetMaxTalentTier]]() - Returns the number of available talent tiers. |
||
+ | : [[API GetNumSpecGroups|GetNumSpecGroups]](<span class="apiarg">[isInspect]</span>) - Returns the number of specialization group (dual specs) the player has. |
||
− | : [[API GetNumArenaOpponentSpecs|GetNumArenaOpponentSpecs]]() |
||
− | : [[API |
+ | : [[API GetNumSpecializations|GetNumSpecializations]](<span class="apiarg">[isInspect, isPet]</span>) - Returns the number of available specializations. |
− | : [[API |
+ | : [[API GetNumSpecializationsForClassID|GetNumSpecializationsForClassID]](<span class="apiarg">classID</span>) - Returns the number of specializations available to a particular class. |
− | : [[API GetNumSpecializationsForClassID|GetNumSpecializationsForClassID]](<span style="font-size:smaller; color:#ecbc2a">classID</span>) - Returns the number of specializations available to a particular class. |
||
: [[API GetNumUnspentPvpTalents|GetNumUnspentPvpTalents]]() |
: [[API GetNumUnspentPvpTalents|GetNumUnspentPvpTalents]]() |
||
: [[API GetNumUnspentTalents|GetNumUnspentTalents]]() - Returns the number of unspent talents. |
: [[API GetNumUnspentTalents|GetNumUnspentTalents]]() - Returns the number of unspent talents. |
||
: [[API GetPetTalentTree|GetPetTalentTree]]() |
: [[API GetPetTalentTree|GetPetTalentTree]]() |
||
: [[API GetPrimarySpecialization|GetPrimarySpecialization]]() |
: [[API GetPrimarySpecialization|GetPrimarySpecialization]]() |
||
− | : [[API GetPvpTalentInfoByID|GetPvpTalentInfoByID]]() |
+ | : [[API GetPvpTalentInfoByID|GetPvpTalentInfoByID]](<span class="apiarg">talentID [, specGroupIndex, isInspect, inspectUnit]</span>) |
: [[API GetPvpTalentInfoBySpecialization|GetPvpTalentInfoBySpecialization]]() |
: [[API GetPvpTalentInfoBySpecialization|GetPvpTalentInfoBySpecialization]]() |
||
: [[API GetPvpTalentLink|GetPvpTalentLink]]() |
: [[API GetPvpTalentLink|GetPvpTalentLink]]() |
||
− | : [[API GetSetBonusesForSpecializationByItemID|GetSetBonusesForSpecializationByItemID]](<span |
+ | : [[API GetSetBonusesForSpecializationByItemID|GetSetBonusesForSpecializationByItemID]](<span class="apiarg">specID, itemID</span>) |
: [[API GetSpecChangeCost|GetSpecChangeCost]]() |
: [[API GetSpecChangeCost|GetSpecChangeCost]]() |
||
− | : [[API GetSpecialization|GetSpecialization]](<span |
+ | : [[API GetSpecialization|GetSpecialization]](<span class="apiarg">[isInspect, isPet, specGroup]</span>) - Returns the index of the player's current specialization. |
− | : [[API GetSpecializationInfo|GetSpecializationInfo]](<span |
+ | : [[API GetSpecializationInfo|GetSpecializationInfo]](<span class="apiarg">specIndex [, isInspect, isPet, inspectTarget, sex]</span>) - Returns info for a specialization. |
− | : [[API GetSpecializationInfoByID|GetSpecializationInfoByID]](<span |
+ | : [[API GetSpecializationInfoByID|GetSpecializationInfoByID]](<span class="apiarg">specID</span>) - Returns information about the specified specialization. |
− | : [[API GetSpecializationInfoForClassID|GetSpecializationInfoForClassID]](<span |
+ | : [[API GetSpecializationInfoForClassID|GetSpecializationInfoForClassID]](<span class="apiarg">classID, specIndex</span>) - Returns information about the specified specialization. |
− | : [[API GetSpecializationInfoForSpecID|GetSpecializationInfoForSpecID]](<span |
+ | : [[API GetSpecializationInfoForSpecID|GetSpecializationInfoForSpecID]](<span class="apiarg">specID [, sex]</span>) |
− | : [[API GetSpecializationMasterySpells|GetSpecializationMasterySpells]](<span |
+ | : [[API GetSpecializationMasterySpells|GetSpecializationMasterySpells]](<span class="apiarg">specIndex [, isInspect, isPet]</span>) - Returns the mastery spell ID of the specified specialization. |
− | : [[API GetSpecializationNameForSpecID|GetSpecializationNameForSpecID]](<span |
+ | : [[API GetSpecializationNameForSpecID|GetSpecializationNameForSpecID]](<span class="apiarg">specID [, sex]</span>) |
− | : [[API GetSpecializationRole|GetSpecializationRole]](<span |
+ | : [[API GetSpecializationRole|GetSpecializationRole]](<span class="apiarg">specIndex [, isInspect, isPet]</span>) - Returns the role a specialization is intended to perform. |
− | : [[API GetSpecializationRoleByID|GetSpecializationRoleByID]](<span |
+ | : [[API GetSpecializationRoleByID|GetSpecializationRoleByID]](<span class="apiarg">specID</span>) - Returns the role a specialization is intended to perform. |
− | : [[API GetSpecializationSpells|GetSpecializationSpells]](<span |
+ | : [[API GetSpecializationSpells|GetSpecializationSpells]](<span class="apiarg">specIndex [, isInspect, isPet]</span>) - Returns the spells learned as part of the specified specialization. |
− | : [[API GetSpecsForSpell|GetSpecsForSpell]](<span |
+ | : [[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 |
+ | : [[API GetTalentInfo|GetTalentInfo]](<span class="apiarg">tier, column, specGroupIndex [, isInspect, inspectUnit]</span>) - Returns info for the specified talent. |
− | : [[API GetTalentInfoByID|GetTalentInfoByID]](<span |
+ | : [[API GetTalentInfoByID|GetTalentInfoByID]](<span class="apiarg">talentID, specGroupIndex [, isInspect, inspectUnit]</span>) - Returns information about a talent. |
− | : [[API GetTalentInfoBySpecialization|GetTalentInfoBySpecialization]](<span |
+ | : [[API GetTalentInfoBySpecialization|GetTalentInfoBySpecialization]](<span class="apiarg">specGroupIndex, tier, column</span>) |
− | : [[API GetTalentLink|GetTalentLink]](<span |
+ | : [[API GetTalentLink|GetTalentLink]](<span class="apiarg">talentID [, isInspect, specGroup, inspectID, classID]</span>) - Returns the talent link. |
− | : [[API GetTalentTierInfo|GetTalentTierInfo]](<span |
+ | : [[API GetTalentTierInfo|GetTalentTierInfo]](<span class="apiarg">tier</span>) |
: [[API IsPvpTalentSpell|IsPvpTalentSpell]]() |
: [[API IsPvpTalentSpell|IsPvpTalentSpell]]() |
||
− | : [[API IsSpellClassOrSpec|IsSpellClassOrSpec]](<span |
+ | : [[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 |
+ | : [[API IsTalentSpell|IsTalentSpell]](<span class="apiarg">slot, bookType</span>) - Returns 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]]() |
+ | : [[API LearnTalent|LearnTalent]](<span class="apiarg">talentID</span>) |
− | : |
+ | : [[API LearnTalents|LearnTalents]](<span class="apiarg">talentID1, talentID2, ...</span>) {{apitag|nocombat}} - Learns the talents listed. |
: [[API RemovePvpTalent|RemovePvpTalent]]() |
: [[API RemovePvpTalent|RemovePvpTalent]]() |
||
− | : |
+ | : [[API RemoveTalent|RemoveTalent]](<span class="apiarg">talentID</span>) {{apitag|nocombat}} - Removes the specified talent. |
− | : |
+ | : [[API SetSpecialization|SetSpecialization]](<span class="apiarg">specIndex [, isPet]</span>) {{apitag|nocombat}} - Selects a specialization. |
− | : |
+ | : [[API UnlearnSpecialization|UnlearnSpecialization]](<span class="apiarg">specIndex [, isPet]</span>) {{apitag|nocombat}} |
− | === |
+ | ===[[Shaman totem]]s=== |
+ | : [[API DestroyTotem|DestroyTotem]](<span class="apiarg">slot</span>) {{apitag|protected}} - Destroys a totem/minion. |
||
− | The [[Collections]] window was added in [[Patch 5.0.4]]. |
||
+ | : [[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>) |
||
+ | : [[API SetMultiCastSpell|SetMultiCastSpell]](<span class="apiarg">actionID, spellID</span>) {{apitag|protected}} - Sets the totem spell for a specific totem bar slot. |
||
− | === |
+ | ===[[Druid shapeshift forms]]=== |
+ | : [[API CancelShapeshiftForm|CancelShapeshiftForm]]() {{apitag|protected}} - Cancels a shapeshift form. |
||
− | The [[Mounts_tab|Mount Journal]] was added in [[Patch 6.0.2]]. |
||
− | : [[API |
+ | : [[API CastShapeshiftForm|CastShapeshiftForm]](<span class="apiarg">index</span>) {{apitag|protected}} |
+ | : [[API GetNumShapeshiftForms|GetNumShapeshiftForms]]() |
||
+ | : [[API GetShapeshiftForm|GetShapeshiftForm]](<span class="apiarg">unknown</span>) - Returns the 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== |
||
+ | The [[Collections]] window was added in [[Patch 5.0.4]] |
||
+ | |||
+ | ===Mount Journal=== |
||
+ | 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.ClearRecentFanfares|C_MountJournal.ClearRecentFanfares]]() |
: [[API C_MountJournal.ClearRecentFanfares|C_MountJournal.ClearRecentFanfares]]() |
||
: [[API C_MountJournal.Dismiss|C_MountJournal.Dismiss]]() - Dismisses the currently summoned mount. |
: [[API C_MountJournal.Dismiss|C_MountJournal.Dismiss]]() - Dismisses the currently summoned mount. |
||
− | : [[API C_MountJournal.GetCollectedFilterSetting|C_MountJournal.GetCollectedFilterSetting]](<span |
+ | : [[API C_MountJournal.GetCollectedFilterSetting|C_MountJournal.GetCollectedFilterSetting]](<span class="apiarg">filterIndex</span>) : <span class="apiret">isChecked</span> - Indicates whether the specified mount journal filter is enabled. |
− | : [[API C_MountJournal.GetDisplayedMountAllCreatureDisplayInfo|C_MountJournal.GetDisplayedMountAllCreatureDisplayInfo]](<span |
+ | : [[API C_MountJournal.GetDisplayedMountAllCreatureDisplayInfo|C_MountJournal.GetDisplayedMountAllCreatureDisplayInfo]](<span class="apiarg">mountIndex</span>) : <span class="apiret">allDisplayInfo</span> - Returns all display IDs for a mount by index. |
− | : [[API C_MountJournal.GetDisplayedMountInfo|C_MountJournal.GetDisplayedMountInfo]](<span |
+ | : [[API C_MountJournal.GetDisplayedMountInfo|C_MountJournal.GetDisplayedMountInfo]](<span class="apiarg">displayIndex</span>) : <span class="apiret">name, spellID, icon, isActive, isUsable, sourceType, isFavorite, isFactionSpecific, faction, shouldHideOnChar, isCollected, mountID, isForDragonriding</span> - Returns information about the specified mount. |
− | : [[API C_MountJournal.GetDisplayedMountInfoExtra|C_MountJournal.GetDisplayedMountInfoExtra]] |
+ | : [[API C_MountJournal.GetDisplayedMountInfoExtra|C_MountJournal.GetDisplayedMountInfoExtra]](<span class="apiarg">mountIndex</span>) : <span class="apiret">creatureDisplayInfoID, description, source, isSelfMount, mountTypeID, uiModelSceneID, animID, spellVisualKitID, disablePlayerMountPreview</span> - Returns extra information about the specified mount. |
− | : [[API C_MountJournal.GetIsFavorite|C_MountJournal.GetIsFavorite]](<span |
+ | : [[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 |
+ | : [[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 |
+ | : [[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 |
+ | : [[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.GetMountIDs|C_MountJournal.GetMountIDs]]() - Returns the IDs of mounts listed in the mount journal. |
+ | : [[API C_MountJournal.GetMountIDs|C_MountJournal.GetMountIDs]]() : <span class="apiret">mountIDs</span> - Returns the IDs of mounts listed in the mount journal. |
− | : [[API C_MountJournal.GetMountInfoByID|C_MountJournal.GetMountInfoByID]] |
+ | : [[API C_MountJournal.GetMountInfoByID|C_MountJournal.GetMountInfoByID]](<span class="apiarg">mountID</span>) : <span class="apiret">name, spellID, icon, isActive, isUsable, sourceType, isFavorite, isFactionSpecific, faction, shouldHideOnChar, isCollected, mountID, isForDragonriding</span> - Returns information about the specified mount. |
− | : [[API C_MountJournal.GetMountInfoExtraByID|C_MountJournal.GetMountInfoExtraByID]](<span |
+ | : [[API C_MountJournal.GetMountInfoExtraByID|C_MountJournal.GetMountInfoExtraByID]](<span class="apiarg">mountID</span>) : <span class="apiret">creatureDisplayInfoID, description, source, isSelfMount, mountTypeID, uiModelSceneID, animID, spellVisualKitID, disablePlayerMountPreview</span> - Returns extra information about the specified mount. |
− | : [[API C_MountJournal.GetMountUsabilityByID|C_MountJournal.GetMountUsabilityByID]]() - 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]]() - 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]]() - 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]]() |
+ | : [[API C_MountJournal.GetNumMountsNeedingFanfare|C_MountJournal.GetNumMountsNeedingFanfare]]() : <span class="apiret">numMountsNeedingFanfare</span> |
− | : [[API C_MountJournal.IsSourceChecked|C_MountJournal.IsSourceChecked]](<span |
+ | : [[API C_MountJournal.IsSourceChecked|C_MountJournal.IsSourceChecked]](<span class="apiarg">filterIndex</span>) : <span class="apiret">isChecked</span> |
− | : [[API C_MountJournal. |
+ | : [[API C_MountJournal.IsTypeChecked|C_MountJournal.IsTypeChecked]](<span class="apiarg">filterIndex</span>) : <span class="apiret">isChecked</span> |
− | : [[API C_MountJournal. |
+ | : [[API C_MountJournal.IsUsingDefaultFilters|C_MountJournal.IsUsingDefaultFilters]]() : <span class="apiret">isUsingDefaultFilters</span> |
− | : [[API C_MountJournal. |
+ | : [[API C_MountJournal.IsValidSourceFilter|C_MountJournal.IsValidSourceFilter]](<span class="apiarg">filterIndex</span>) : <span class="apiret">isValid</span> |
− | : [[API C_MountJournal. |
+ | : [[API C_MountJournal.IsValidTypeFilter|C_MountJournal.IsValidTypeFilter]](<span class="apiarg">filterIndex</span>) : <span class="apiret">isValid</span> |
− | : [[API C_MountJournal. |
+ | : [[API C_MountJournal.NeedsFanfare|C_MountJournal.NeedsFanfare]](<span class="apiarg">mountID</span>) : <span class="apiret">needsFanfare</span> |
− | : [[API C_MountJournal. |
+ | : [[API C_MountJournal.Pickup|C_MountJournal.Pickup]](<span class="apiarg">displayIndex</span>) - Picks up the specified mount onto the cursor, usually in preparation for placing it on an action button. |
− | : [[API C_MountJournal. |
+ | : [[API C_MountJournal.SetAllSourceFilters|C_MountJournal.SetAllSourceFilters]](<span class="apiarg">isChecked</span>) |
− | : [[API C_MountJournal. |
+ | : [[API C_MountJournal.SetAllTypeFilters|C_MountJournal.SetAllTypeFilters]](<span class="apiarg">isChecked</span>) |
− | : [[API C_MountJournal. |
+ | : [[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]]() |
||
− | [[Mount equipment]] was added in [[Patch 8.2.0]]. |
||
− | : [[API C_MountJournal. |
+ | : [[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. |
+ | : [[API C_MountJournal.SetSearch|C_MountJournal.SetSearch]](<span class="apiarg">searchValue</span>) |
− | : [[API C_MountJournal. |
+ | : [[API C_MountJournal.SetSourceFilter|C_MountJournal.SetSourceFilter]](<span class="apiarg">filterIndex, isChecked</span>) |
− | : [[API C_MountJournal. |
+ | : [[API C_MountJournal.SetTypeFilter|C_MountJournal.SetTypeFilter]](<span class="apiarg">filterIndex, isChecked</span>) |
− | : [[API C_MountJournal. |
+ | : [[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]] |
||
− | : [[API C_MountJournal.IsMountEquipmentApplied|C_MountJournal.IsMountEquipmentApplied]]() |
||
+ | : [[API C_MountJournal.ApplyMountEquipment|C_MountJournal.ApplyMountEquipment]](<span class="apiarg">itemLocation</span>) : <span class="apiret">canContinue</span> {{apitag|protected}} |
||
− | : [[API C_PlayerInfo.CanPlayerUseMountEquipment|C_PlayerInfo.CanPlayerUseMountEquipment]]() - Returns true if the player can use mount equipment. |
||
+ | : [[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.GetMountEquipmentUnlockLevel|C_MountJournal.GetMountEquipmentUnlockLevel]]() : <span class="apiret">level</span> |
||
+ | : [[API C_MountJournal.IsItemMountEquipment|C_MountJournal.IsItemMountEquipment]](<span class="apiarg">itemLocation</span>) : <span class="apiret">isMountEquipment</span> |
||
+ | : [[API C_MountJournal.IsMountEquipmentApplied|C_MountJournal.IsMountEquipmentApplied]]() : <span class="apiret">isApplied</span> |
||
+ | : [[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]] |
||
+ | : [[API CallCompanion|CallCompanion]](<span class="apiarg">type, slotid</span>) {{apitag|deprecated}} - Summons a companion. |
||
+ | : [[API DismissCompanion|DismissCompanion]](<span class="apiarg">type</span>) {{apitag|deprecated}} - Dismisses the current companion. |
||
+ | : [[API GetCompanionInfo|GetCompanionInfo]](<span class="apiarg">type, slotid</span>) {{apitag|deprecated}} - Returns info for a companion. |
||
+ | : [[API GetNumCompanions|GetNumCompanions]](<span class="apiarg">type</span>) {{apitag|deprecated}} - Returns the number of mounts. |
||
+ | : [[API SummonRandomCritter|SummonRandomCritter]]() {{apitag|deprecated}} - No longer does anything. |
||
− | === |
+ | ===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 |
+ | : [[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_PetJournal.CagePetByID|C_PetJournal.CagePetByID]](<span |
+ | : [[API C_PetJournal.CagePetByID|C_PetJournal.CagePetByID]](<span class="apiarg">petID</span>) - Puts the pet into a cage. |
: [[API C_PetJournal.ClearFanfare|C_PetJournal.ClearFanfare]]() |
: [[API C_PetJournal.ClearFanfare|C_PetJournal.ClearFanfare]]() |
||
: [[API C_PetJournal.ClearRecentFanfares|C_PetJournal.ClearRecentFanfares]]() |
: [[API C_PetJournal.ClearRecentFanfares|C_PetJournal.ClearRecentFanfares]]() |
||
: [[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 |
+ | : [[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 |
+ | : [[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 |
+ | : [[API C_PetJournal.GetDisplayProbabilityByIndex|C_PetJournal.GetDisplayProbabilityByIndex]](<span class="apiarg">speciesID, index</span>) : <span class="apiret">displayProbability</span> |
− | : [[API C_PetJournal.GetNumCollectedInfo|C_PetJournal.GetNumCollectedInfo]]() |
+ | : [[API C_PetJournal.GetNumCollectedInfo|C_PetJournal.GetNumCollectedInfo]](<span class="apiarg">speciesID</span>) : <span class="apiret">numCollected, limit </span> |
− | : [[API C_PetJournal.GetNumDisplays|C_PetJournal.GetNumDisplays]](<span |
+ | : [[API C_PetJournal.GetNumDisplays|C_PetJournal.GetNumDisplays]](<span class="apiarg">speciesID</span>) : <span class="apiret">numDisplays</span> |
− | : [[API C_PetJournal. |
+ | : [[API C_PetJournal.GetNumPets|C_PetJournal.GetNumPets]]() - Returns information about the number of battle pets. |
+ | : [[API C_PetJournal.GetNumPetsNeedingFanfare|C_PetJournal.GetNumPetsNeedingFanfare]]() |
||
: [[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 a formatted string how many of a battle pet species the player has collected. |
||
− | : [[API C_PetJournal.GetNumPetsNeedingFanfare|C_PetJournal.GetNumPetsNeedingFanfare]]() |
||
− | : [[API C_PetJournal. |
+ | : [[API C_PetJournal.GetPetAbilityInfo|C_PetJournal.GetPetAbilityInfo]](<span class="apiarg">abilityID</span>) : <span class="apiret">name, icon, petType</span> |
− | : [[API C_PetJournal. |
+ | : [[API C_PetJournal.GetPetAbilityList|C_PetJournal.GetPetAbilityList]](<span class="apiarg">speciesID [, idTable, levelTable]</span>) |
− | : [[API C_PetJournal. |
+ | : [[API C_PetJournal.GetPetAbilityListTable|C_PetJournal.GetPetAbilityListTable]](<span class="apiarg">speciesID</span>) : <span class="apiret">info</span> |
− | : [[API C_PetJournal.GetPetAbilityList|C_PetJournal.GetPetAbilityList]](<span style="font-size:smaller; color:#ecbc2a">speciesID [, idTable, levelTable]</span>) |
||
: [[API C_PetJournal.GetPetCooldownByGUID|C_PetJournal.GetPetCooldownByGUID]]() |
: [[API C_PetJournal.GetPetCooldownByGUID|C_PetJournal.GetPetCooldownByGUID]]() |
||
− | : [[API C_PetJournal.GetPetInfoByIndex|C_PetJournal.GetPetInfoByIndex]](<span |
+ | : [[API C_PetJournal.GetPetInfoByIndex|C_PetJournal.GetPetInfoByIndex]](<span class="apiarg">index</span>) - Returns information about a battle pet. |
− | : [[API C_PetJournal.GetPetInfoByItemID|C_PetJournal.GetPetInfoByItemID]](<span |
+ | : [[API C_PetJournal.GetPetInfoByItemID|C_PetJournal.GetPetInfoByItemID]](<span class="apiarg">itemID</span>) |
− | : [[API C_PetJournal.GetPetInfoByPetID|C_PetJournal.GetPetInfoByPetID]](<span |
+ | : [[API C_PetJournal.GetPetInfoByPetID|C_PetJournal.GetPetInfoByPetID]](<span class="apiarg">petID</span>) - Returns information about a battle pet. |
− | : [[API C_PetJournal.GetPetInfoBySpeciesID|C_PetJournal.GetPetInfoBySpeciesID]](<span |
+ | : [[API C_PetJournal.GetPetInfoBySpeciesID|C_PetJournal.GetPetInfoBySpeciesID]](<span class="apiarg">speciesID</span>) - Returns information about a pet species. |
− | : [[API C_PetJournal. |
+ | : [[API C_PetJournal.GetPetInfoTableByPetID|C_PetJournal.GetPetInfoTableByPetID]](<span class="apiarg">petID</span>) : <span class="apiret">info</span> |
− | : [[API C_PetJournal. |
+ | : [[API C_PetJournal.GetPetLoadOutInfo|C_PetJournal.GetPetLoadOutInfo]](<span class="apiarg">slot</span>) : <span class="apiret">petID, ability1ID, ability2ID, ability3ID, locked</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 |
+ | : [[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 |
+ | : [[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]]() |
||
: [[API C_PetJournal.GetSummonBattlePetCooldown|C_PetJournal.GetSummonBattlePetCooldown]]() |
: [[API C_PetJournal.GetSummonBattlePetCooldown|C_PetJournal.GetSummonBattlePetCooldown]]() |
||
− | : [[API C_PetJournal.GetSummonRandomFavoritePetGUID|C_PetJournal.GetSummonRandomFavoritePetGUID]]() |
||
: [[API C_PetJournal.GetSummonedPetGUID|C_PetJournal.GetSummonedPetGUID]]() - Returns information about a battle pet. |
: [[API C_PetJournal.GetSummonedPetGUID|C_PetJournal.GetSummonedPetGUID]]() - Returns information about a battle pet. |
||
+ | : [[API C_PetJournal.GetSummonRandomFavoritePetGUID|C_PetJournal.GetSummonRandomFavoritePetGUID]]() |
||
: [[API C_PetJournal.IsFilterChecked|C_PetJournal.IsFilterChecked]]() |
: [[API C_PetJournal.IsFilterChecked|C_PetJournal.IsFilterChecked]]() |
||
: [[API C_PetJournal.IsFindBattleEnabled|C_PetJournal.IsFindBattleEnabled]]() |
: [[API C_PetJournal.IsFindBattleEnabled|C_PetJournal.IsFindBattleEnabled]]() |
||
Line 1,365: | Line 1,949: | ||
: [[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. |
+ | : [[API C_PetJournal.IsUsingDefaultFilters|C_PetJournal.IsUsingDefaultFilters]]() : <span class="apiret">isUsingDefaultFilters</span> |
− | : [[API C_PetJournal. |
+ | : [[API C_PetJournal.PetCanBeReleased|C_PetJournal.PetCanBeReleased]](<span class="apiarg">petID</span>) - Returns true if you can release the pet. |
− | : [[API C_PetJournal. |
+ | : [[API C_PetJournal.PetIsCapturable|C_PetJournal.PetIsCapturable]](<span class="apiarg">petID</span>) |
− | : [[API C_PetJournal. |
+ | : [[API C_PetJournal.PetIsFavorite|C_PetJournal.PetIsFavorite]](<span class="apiarg">petID</span>) - Returns true if the collected battle pet is favorited. |
− | : [[API C_PetJournal. |
+ | : [[API C_PetJournal.PetIsHurt|C_PetJournal.PetIsHurt]](<span class="apiarg">petID</span>) |
− | : [[API C_PetJournal. |
+ | : [[API C_PetJournal.PetIsLockedForConvert|C_PetJournal.PetIsLockedForConvert]](<span class="apiarg">petID</span>) |
− | : [[API C_PetJournal. |
+ | : [[API C_PetJournal.PetIsRevoked|C_PetJournal.PetIsRevoked]](<span class="apiarg">petID</span>) |
− | : [[API C_PetJournal. |
+ | : [[API C_PetJournal.PetIsSlotted|C_PetJournal.PetIsSlotted]](<span class="apiarg">petID</span>) |
− | : [[API C_PetJournal. |
+ | : [[API C_PetJournal.PetIsSummonable|C_PetJournal.PetIsSummonable]](<span class="apiarg">battlePetGUID</span>) : <span class="apiret">isSummonable</span> - Returns true if you can summon this pet. |
− | : [[API C_PetJournal. |
+ | : [[API C_PetJournal.PetIsTradable|C_PetJournal.PetIsTradable]](<span class="apiarg">petID</span>) - Returns whether or not a pet from the Pet Journal is tradable. |
+ | : [[API C_PetJournal.PetIsUsable|C_PetJournal.PetIsUsable]](<span class="apiarg">petID</span>) |
||
: [[API C_PetJournal.PetNeedsFanfare|C_PetJournal.PetNeedsFanfare]]() |
: [[API C_PetJournal.PetNeedsFanfare|C_PetJournal.PetNeedsFanfare]]() |
||
− | : [[API C_PetJournal.PetUsesRandomDisplay|C_PetJournal.PetUsesRandomDisplay]](<span |
+ | : [[API C_PetJournal.PetUsesRandomDisplay|C_PetJournal.PetUsesRandomDisplay]](<span class="apiarg">speciesID</span>) : <span class="apiret">usesRandomDisplay</span> |
− | : [[API C_PetJournal.PickupPet|C_PetJournal.PickupPet]](<span |
+ | : [[API C_PetJournal.PickupPet|C_PetJournal.PickupPet]](<span class="apiarg">petID</span>) |
: [[API C_PetJournal.PickupSummonRandomPet|C_PetJournal.PickupSummonRandomPet]]() |
: [[API C_PetJournal.PickupSummonRandomPet|C_PetJournal.PickupSummonRandomPet]]() |
||
− | : [[API C_PetJournal.ReleasePetByID|C_PetJournal.ReleasePetByID]](<span |
+ | : [[API C_PetJournal.ReleasePetByID|C_PetJournal.ReleasePetByID]](<span class="apiarg">petID</span>) - Releases the pet. |
− | : [[API C_PetJournal.SetAbility|C_PetJournal.SetAbility]](<span |
+ | : [[API C_PetJournal.SetAbility|C_PetJournal.SetAbility]](<span class="apiarg">slotIndex, spellIndex, petSpellID</span>) |
: [[API C_PetJournal.SetAllPetSourcesChecked|C_PetJournal.SetAllPetSourcesChecked]]() |
: [[API C_PetJournal.SetAllPetSourcesChecked|C_PetJournal.SetAllPetSourcesChecked]]() |
||
: [[API C_PetJournal.SetAllPetTypesChecked|C_PetJournal.SetAllPetTypesChecked]]() |
: [[API C_PetJournal.SetAllPetTypesChecked|C_PetJournal.SetAllPetTypesChecked]]() |
||
− | : [[API C_PetJournal.SetCustomName|C_PetJournal.SetCustomName]](<span |
+ | : [[API C_PetJournal.SetCustomName|C_PetJournal.SetCustomName]](<span class="apiarg">petID, customName</span>) - Sets a custom name for the pet. |
− | : [[API C_PetJournal. |
+ | : [[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.SetFilterChecked|C_PetJournal.SetFilterChecked]]() |
: [[API C_PetJournal.SetFilterChecked|C_PetJournal.SetFilterChecked]]() |
||
− | : [[API C_PetJournal.SetPetLoadOutInfo|C_PetJournal.SetPetLoadOutInfo]](<span |
+ | : [[API C_PetJournal.SetPetLoadOutInfo|C_PetJournal.SetPetLoadOutInfo]](<span class="apiarg">slotIndex, petID</span>) |
: [[API C_PetJournal.SetPetSortParameter|C_PetJournal.SetPetSortParameter]]() |
: [[API C_PetJournal.SetPetSortParameter|C_PetJournal.SetPetSortParameter]]() |
||
: [[API C_PetJournal.SetPetSourceChecked|C_PetJournal.SetPetSourceChecked]]() |
: [[API C_PetJournal.SetPetSourceChecked|C_PetJournal.SetPetSourceChecked]]() |
||
− | : [[API C_PetJournal.SetPetTypeFilter|C_PetJournal.SetPetTypeFilter]](<span |
+ | : [[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 |
+ | : [[API C_PetJournal.SetSearchFilter|C_PetJournal.SetSearchFilter]](<span class="apiarg">text</span>) - Sets the search filter in the pet journal. |
− | : |
+ | : [[API C_PetJournal.SummonPetByGUID|C_PetJournal.SummonPetByGUID]](<span class="apiarg">petID</span>) {{apitag|nocombat}} - Summons (or dismisses) a pet. |
− | : |
+ | : [[API C_PetJournal.SummonRandomPet|C_PetJournal.SummonRandomPet]](<span class="apiarg">allPets</span>) {{apitag|nocombat}} - Summons a random battle pet companion. |
− | === |
+ | ===Toy Box=== |
+ | The [[Toy Box]] was added in [[Patch 6.0.2]] |
||
− | These functions relate to [[Companion]]s (non-combat pets) and mounts and were added in [[Patch 3.0]]. They are deprecated (but still partially work). See also [[#Pet Journal|Pet Journal]] and [[#Mount Journal|Mount Journal]] functions. |
||
− | : [[API CallCompanion|CallCompanion]](<span style="font-size:smaller; color:#ecbc2a">type, slotid</span>) - Summons a companion. |
||
− | : [[API DismissCompanion|DismissCompanion]](<span style="font-size:smaller; color:#ecbc2a">type</span>) - Dismisses an active companion. |
||
− | : [[API GetCompanionInfo|GetCompanionInfo]](<span style="font-size:smaller; color:#ecbc2a">type, slotid</span>) - Returns info about a selected companion. |
||
− | : [[API GetNumCompanions|GetNumCompanions]](<span style="font-size:smaller; color:#ecbc2a">type</span>) - Get the number of companions of the specified type. |
||
− | : [[API SummonRandomCritter|SummonRandomCritter]]() - Summons a random critter companion. |
||
− | |||
− | ==== Toy Box ==== |
||
− | The [[Toy Box]] was added in [[Patch 6.0.2]]. |
||
: [[API C_ToyBox.ForceToyRefilter|C_ToyBox.ForceToyRefilter]]() |
: [[API C_ToyBox.ForceToyRefilter|C_ToyBox.ForceToyRefilter]]() |
||
: [[API C_ToyBox.GetCollectedShown|C_ToyBox.GetCollectedShown]]() |
: [[API C_ToyBox.GetCollectedShown|C_ToyBox.GetCollectedShown]]() |
||
− | : [[API C_ToyBox.GetIsFavorite|C_ToyBox.GetIsFavorite]](<span |
+ | : [[API C_ToyBox.GetIsFavorite|C_ToyBox.GetIsFavorite]](<span class="apiarg">itemID</span>) |
: [[API C_ToyBox.GetNumFilteredToys|C_ToyBox.GetNumFilteredToys]]() |
: [[API C_ToyBox.GetNumFilteredToys|C_ToyBox.GetNumFilteredToys]]() |
||
: [[API C_ToyBox.GetNumLearnedDisplayedToys|C_ToyBox.GetNumLearnedDisplayedToys]]() |
: [[API C_ToyBox.GetNumLearnedDisplayedToys|C_ToyBox.GetNumLearnedDisplayedToys]]() |
||
: [[API C_ToyBox.GetNumTotalDisplayedToys|C_ToyBox.GetNumTotalDisplayedToys]]() |
: [[API C_ToyBox.GetNumTotalDisplayedToys|C_ToyBox.GetNumTotalDisplayedToys]]() |
||
: [[API C_ToyBox.GetNumToys|C_ToyBox.GetNumToys]]() |
: [[API C_ToyBox.GetNumToys|C_ToyBox.GetNumToys]]() |
||
− | : [[API C_ToyBox.GetToyFromIndex|C_ToyBox.GetToyFromIndex]](<span |
+ | : [[API C_ToyBox.GetToyFromIndex|C_ToyBox.GetToyFromIndex]](<span class="apiarg">index</span>) |
− | : [[API C_ToyBox.GetToyInfo|C_ToyBox.GetToyInfo]](<span |
+ | : [[API C_ToyBox.GetToyInfo|C_ToyBox.GetToyInfo]](<span class="apiarg">itemID</span>) - Returns toy info. |
− | : [[API C_ToyBox.GetToyLink|C_ToyBox.GetToyLink]](<span |
+ | : [[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]]() |
||
: [[API C_ToyBox.HasFavorites|C_ToyBox.HasFavorites]]() |
: [[API C_ToyBox.HasFavorites|C_ToyBox.HasFavorites]]() |
||
− | : [[API C_ToyBox.IsExpansionTypeFilterChecked|C_ToyBox.IsExpansionTypeFilterChecked]](<span |
+ | : [[API C_ToyBox.IsExpansionTypeFilterChecked|C_ToyBox.IsExpansionTypeFilterChecked]](<span class="apiarg">expansionIndex</span>) |
− | : [[API C_ToyBox.IsSourceTypeFilterChecked|C_ToyBox.IsSourceTypeFilterChecked]](<span |
+ | : [[API C_ToyBox.IsSourceTypeFilterChecked|C_ToyBox.IsSourceTypeFilterChecked]](<span class="apiarg">sourceIndex</span>) |
− | : [[API C_ToyBox.IsToyUsable|C_ToyBox.IsToyUsable]](<span |
+ | : [[API C_ToyBox.IsToyUsable|C_ToyBox.IsToyUsable]](<span class="apiarg">itemID</span>) |
− | : [[API C_ToyBox.PickupToyBoxItem|C_ToyBox.PickupToyBoxItem]](<span |
+ | : [[API C_ToyBox.PickupToyBoxItem|C_ToyBox.PickupToyBoxItem]](<span class="apiarg">itemID</span>) |
− | : [[API C_ToyBox.SetAllExpansionTypeFilters|C_ToyBox.SetAllExpansionTypeFilters]](<span |
+ | : [[API C_ToyBox.SetAllExpansionTypeFilters|C_ToyBox.SetAllExpansionTypeFilters]](<span class="apiarg">[checked]</span>) |
− | : [[API C_ToyBox.SetAllSourceTypeFilters|C_ToyBox.SetAllSourceTypeFilters]](<span |
+ | : [[API C_ToyBox.SetAllSourceTypeFilters|C_ToyBox.SetAllSourceTypeFilters]](<span class="apiarg">checked</span>) |
− | : [[API C_ToyBox.SetCollectedShown|C_ToyBox.SetCollectedShown]](<span |
+ | : [[API C_ToyBox.SetCollectedShown|C_ToyBox.SetCollectedShown]](<span class="apiarg">checked</span>) |
− | : [[API C_ToyBox.SetExpansionTypeFilter|C_ToyBox.SetExpansionTypeFilter]](<span |
+ | : [[API C_ToyBox.SetExpansionTypeFilter|C_ToyBox.SetExpansionTypeFilter]](<span class="apiarg">expansionIndex, checked</span>) |
− | : [[API C_ToyBox.SetFilterString|C_ToyBox.SetFilterString]](<span |
+ | : [[API C_ToyBox.SetFilterString|C_ToyBox.SetFilterString]](<span class="apiarg">searchString</span>) |
− | : [[API C_ToyBox.SetIsFavorite|C_ToyBox.SetIsFavorite]](<span |
+ | : [[API C_ToyBox.SetIsFavorite|C_ToyBox.SetIsFavorite]](<span class="apiarg">itemID, value</span>) |
− | : [[API C_ToyBox.SetSourceTypeFilter|C_ToyBox.SetSourceTypeFilter]](<span |
+ | : [[API C_ToyBox.SetSourceTypeFilter|C_ToyBox.SetSourceTypeFilter]](<span class="apiarg">sourceIndex, checked</span>) |
− | : [[API C_ToyBox.SetUncollectedShown|C_ToyBox.SetUncollectedShown]](<span |
+ | : [[API C_ToyBox.SetUncollectedShown|C_ToyBox.SetUncollectedShown]](<span class="apiarg">checked</span>) |
− | : [[API C_ToyBox.SetUnusableShown|C_ToyBox.SetUnusableShown]](<span |
+ | : [[API C_ToyBox.SetUnusableShown|C_ToyBox.SetUnusableShown]](<span class="apiarg">checked</span>) |
− | : [[API C_ToyBoxInfo.ClearFanfare|C_ToyBoxInfo.ClearFanfare]](<span |
+ | : [[API C_ToyBoxInfo.ClearFanfare|C_ToyBoxInfo.ClearFanfare]](<span class="apiarg">itemID</span>) |
− | : [[API C_ToyBoxInfo. |
+ | : [[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 PlayerHasToy|PlayerHasToy]](<span style="font-size:smaller; color:#ecbc2a">itemID</span>) |
||
− | : [[API |
+ | : [[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 UseToyByName|UseToyByName]](<span style="font-size:smaller; color:#ecbc2a">toyName</span>) |
||
+ | : [[API PlayerHasToy|PlayerHasToy]](<span class="apiarg">itemID</span>) |
||
+ | : [[API UseToy|UseToy]](<span class="apiarg">itemID</span>) |
||
+ | : [[API UseToyByName|UseToyByName]](<span class="apiarg">toyName</span>) |
||
− | === |
+ | ===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 |
+ | : [[API C_Heirloom.CanHeirloomUpgradeFromPending|C_Heirloom.CanHeirloomUpgradeFromPending]](<span class="apiarg">itemID</span>) |
− | : [[API C_Heirloom.CreateHeirloom|C_Heirloom.CreateHeirloom]](<span |
+ | : [[API C_Heirloom.CreateHeirloom|C_Heirloom.CreateHeirloom]](<span class="apiarg">itemID</span>) |
: [[API C_Heirloom.GetClassAndSpecFilters|C_Heirloom.GetClassAndSpecFilters]]() |
: [[API C_Heirloom.GetClassAndSpecFilters|C_Heirloom.GetClassAndSpecFilters]]() |
||
: [[API C_Heirloom.GetCollectedHeirloomFilter|C_Heirloom.GetCollectedHeirloomFilter]]() |
: [[API C_Heirloom.GetCollectedHeirloomFilter|C_Heirloom.GetCollectedHeirloomFilter]]() |
||
− | : [[API C_Heirloom.GetHeirloomInfo|C_Heirloom.GetHeirloomInfo]](<span |
+ | : [[API C_Heirloom.GetHeirloomInfo|C_Heirloom.GetHeirloomInfo]](<span class="apiarg">itemID</span>) |
− | : [[API C_Heirloom.GetHeirloomItemIDFromDisplayedIndex|C_Heirloom.GetHeirloomItemIDFromDisplayedIndex]](<span |
+ | : [[API C_Heirloom.GetHeirloomItemIDFromDisplayedIndex|C_Heirloom.GetHeirloomItemIDFromDisplayedIndex]](<span class="apiarg">heirloomIndex</span>) |
: [[API C_Heirloom.GetHeirloomItemIDs|C_Heirloom.GetHeirloomItemIDs]]() |
: [[API C_Heirloom.GetHeirloomItemIDs|C_Heirloom.GetHeirloomItemIDs]]() |
||
− | : [[API C_Heirloom.GetHeirloomLink|C_Heirloom.GetHeirloomLink]](<span |
+ | : [[API C_Heirloom.GetHeirloomLink|C_Heirloom.GetHeirloomLink]](<span class="apiarg">itemID</span>) |
− | : [[API C_Heirloom.GetHeirloomMaxUpgradeLevel|C_Heirloom.GetHeirloomMaxUpgradeLevel]](<span |
+ | : [[API C_Heirloom.GetHeirloomMaxUpgradeLevel|C_Heirloom.GetHeirloomMaxUpgradeLevel]](<span class="apiarg">itemID</span>) |
− | : [[API C_Heirloom.GetHeirloomSourceFilter|C_Heirloom.GetHeirloomSourceFilter]](<span |
+ | : [[API C_Heirloom.GetHeirloomSourceFilter|C_Heirloom.GetHeirloomSourceFilter]](<span class="apiarg">source</span>) |
: [[API C_Heirloom.GetNumDisplayedHeirlooms|C_Heirloom.GetNumDisplayedHeirlooms]]() |
: [[API C_Heirloom.GetNumDisplayedHeirlooms|C_Heirloom.GetNumDisplayedHeirlooms]]() |
||
: [[API C_Heirloom.GetNumHeirlooms|C_Heirloom.GetNumHeirlooms]]() |
: [[API C_Heirloom.GetNumHeirlooms|C_Heirloom.GetNumHeirlooms]]() |
||
: [[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. |
+ | : [[API C_Heirloom.IsItemHeirloom|C_Heirloom.IsItemHeirloom]](<span class="apiarg">itemID</span>) |
− | : [[API C_Heirloom.IsItemHeirloom|C_Heirloom.IsItemHeirloom]](<span style="font-size:smaller; color:#ecbc2a">itemID</span>) |
||
: [[API C_Heirloom.IsPendingHeirloomUpgrade|C_Heirloom.IsPendingHeirloomUpgrade]]() |
: [[API C_Heirloom.IsPendingHeirloomUpgrade|C_Heirloom.IsPendingHeirloomUpgrade]]() |
||
− | : [[API C_Heirloom.PlayerHasHeirloom|C_Heirloom.PlayerHasHeirloom]](<span |
+ | : [[API C_Heirloom.PlayerHasHeirloom|C_Heirloom.PlayerHasHeirloom]](<span class="apiarg">itemID</span>) |
− | : [[API C_Heirloom.SetClassAndSpecFilters|C_Heirloom.SetClassAndSpecFilters]](<span |
+ | : [[API C_Heirloom.SetClassAndSpecFilters|C_Heirloom.SetClassAndSpecFilters]](<span class="apiarg">classID, specID</span>) |
− | : [[API C_Heirloom.SetCollectedHeirloomFilter|C_Heirloom.SetCollectedHeirloomFilter]](<span |
+ | : [[API C_Heirloom.SetCollectedHeirloomFilter|C_Heirloom.SetCollectedHeirloomFilter]](<span class="apiarg">boolean</span>) |
− | : [[API C_Heirloom.SetHeirloomSourceFilter|C_Heirloom.SetHeirloomSourceFilter]](<span |
+ | : [[API C_Heirloom.SetHeirloomSourceFilter|C_Heirloom.SetHeirloomSourceFilter]](<span class="apiarg">source, filtered</span>) |
− | : [[API C_Heirloom.SetSearch|C_Heirloom.SetSearch]](<span |
+ | : [[API C_Heirloom.SetSearch|C_Heirloom.SetSearch]](<span class="apiarg">searchValue</span>) |
− | : [[API C_Heirloom.SetUncollectedHeirloomFilter|C_Heirloom.SetUncollectedHeirloomFilter]](<span |
+ | : [[API C_Heirloom.SetUncollectedHeirloomFilter|C_Heirloom.SetUncollectedHeirloomFilter]](<span class="apiarg">boolean</span>) |
: [[API C_Heirloom.ShouldShowHeirloomHelp|C_Heirloom.ShouldShowHeirloomHelp]]() |
: [[API C_Heirloom.ShouldShowHeirloomHelp|C_Heirloom.ShouldShowHeirloomHelp]]() |
||
− | : [[API C_Heirloom.UpgradeHeirloom|C_Heirloom.UpgradeHeirloom]](<span |
+ | : [[API C_Heirloom.UpgradeHeirloom|C_Heirloom.UpgradeHeirloom]](<span class="apiarg">itemID</span>) |
− | : [[API DoesItemContainSpec|DoesItemContainSpec]](<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=== |
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. |
+ | : [[API C_TransmogCollection.AccountCanCollectSource|C_TransmogCollection.AccountCanCollectSource]](<span class="apiarg">sourceID</span>) : <span class="apiret">hasItemData, canCollect</span> |
− | : [[API C_TransmogCollection. |
+ | : [[API C_TransmogCollection.AreAllCollectionTypeFiltersChecked|C_TransmogCollection.AreAllCollectionTypeFiltersChecked]]() : <span class="apiret">areAllCollectionTypeFiltersChecked</span> |
− | : [[API C_TransmogCollection. |
+ | : [[API C_TransmogCollection.AreAllSourceTypeFiltersChecked|C_TransmogCollection.AreAllSourceTypeFiltersChecked]]() : <span class="apiret">areAllSourceTypeFiltersChecked</span> |
− | : [[API C_TransmogCollection. |
+ | : [[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.ClearSearch|C_TransmogCollection.ClearSearch]](<span class="apiarg">searchType</span>) : <span class="apiret">completed</span> |
||
+ | : [[API C_TransmogCollection.DeleteOutfit|C_TransmogCollection.DeleteOutfit]](<span class="apiarg">outfitID</span>) |
||
: [[API C_TransmogCollection.EndSearch|C_TransmogCollection.EndSearch]]() |
: [[API C_TransmogCollection.EndSearch|C_TransmogCollection.EndSearch]]() |
||
− | : [[API C_TransmogCollection.GetAllAppearanceSources|C_TransmogCollection.GetAllAppearanceSources]](<span |
+ | : [[API C_TransmogCollection.GetAllAppearanceSources|C_TransmogCollection.GetAllAppearanceSources]](<span class="apiarg">itemAppearanceID</span>) : <span class="apiret">itemModifiedAppearanceIDs</span> |
− | : [[API C_TransmogCollection.GetAppearanceCameraID|C_TransmogCollection.GetAppearanceCameraID]](<span |
+ | : [[API C_TransmogCollection.GetAppearanceCameraID|C_TransmogCollection.GetAppearanceCameraID]](<span class="apiarg">itemAppearanceID [, variation]</span>) : <span class="apiret">cameraID</span> |
− | : [[API C_TransmogCollection.GetAppearanceCameraIDBySource|C_TransmogCollection.GetAppearanceCameraIDBySource]](<span |
+ | : [[API C_TransmogCollection.GetAppearanceCameraIDBySource|C_TransmogCollection.GetAppearanceCameraIDBySource]](<span class="apiarg">itemModifiedAppearanceID [, variation]</span>) : <span class="apiret">cameraID</span> |
− | : [[API C_TransmogCollection.GetAppearanceInfoBySource|C_TransmogCollection.GetAppearanceInfoBySource]](<span |
+ | : [[API C_TransmogCollection.GetAppearanceInfoBySource|C_TransmogCollection.GetAppearanceInfoBySource]](<span class="apiarg">itemModifiedAppearanceID</span>) : <span class="apiret">info</span> |
− | : [[API C_TransmogCollection.GetAppearanceSourceDrops|C_TransmogCollection.GetAppearanceSourceDrops]](<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 |
+ | : [[API C_TransmogCollection.GetAppearanceSourceInfo|C_TransmogCollection.GetAppearanceSourceInfo]](<span class="apiarg">itemModifiedAppearanceID</span>) : <span class="apiret">category, itemAppearanceID, canHaveIllusion, icon, isCollected, itemLink, transmoglink, sourceType, itemSubClass</span> |
− | : [[API C_TransmogCollection.GetAppearanceSources|C_TransmogCollection.GetAppearanceSources]](<span |
+ | : [[API C_TransmogCollection.GetAppearanceSources|C_TransmogCollection.GetAppearanceSources]](<span class="apiarg">appearanceID [, categoryType, transmogLocation]</span>) : <span class="apiret">sources</span> |
− | : [[API C_TransmogCollection. |
+ | : [[API C_TransmogCollection.GetArtifactAppearanceStrings|C_TransmogCollection.GetArtifactAppearanceStrings]](<span class="apiarg">appearanceID</span>) : <span class="apiret">name, hyperlink</span> |
− | : [[API C_TransmogCollection. |
+ | : [[API C_TransmogCollection.GetCategoryAppearances|C_TransmogCollection.GetCategoryAppearances]](<span class="apiarg">category [, transmogLocation]</span>) : <span class="apiret">appearances</span> |
− | : [[API C_TransmogCollection. |
+ | : [[API C_TransmogCollection.GetCategoryCollectedCount|C_TransmogCollection.GetCategoryCollectedCount]](<span class="apiarg">category</span>) : <span class="apiret">count</span> |
− | : [[API C_TransmogCollection. |
+ | : [[API C_TransmogCollection.GetCategoryForItem|C_TransmogCollection.GetCategoryForItem]](<span class="apiarg">itemModifiedAppearanceID</span>) : <span class="apiret">collectionCategory</span> |
− | : [[API C_TransmogCollection. |
+ | : [[API C_TransmogCollection.GetCategoryInfo|C_TransmogCollection.GetCategoryInfo]](<span class="apiarg">category</span>) : <span class="apiret">name, isWeapon, canHaveIllusions, canMainHand, canOffHand</span> |
− | : [[API C_TransmogCollection. |
+ | : [[API C_TransmogCollection.GetCategoryTotal|C_TransmogCollection.GetCategoryTotal]](<span class="apiarg">category</span>) : <span class="apiret">total</span> |
− | : [[API C_TransmogCollection. |
+ | : [[API C_TransmogCollection.GetCollectedShown|C_TransmogCollection.GetCollectedShown]]() : <span class="apiret">shown</span> |
− | : [[API C_TransmogCollection. |
+ | : [[API C_TransmogCollection.GetFallbackWeaponAppearance|C_TransmogCollection.GetFallbackWeaponAppearance]]() : <span class="apiret">appearanceID</span> |
− | : [[API C_TransmogCollection. |
+ | : [[API C_TransmogCollection.GetIllusionInfo|C_TransmogCollection.GetIllusionInfo]](<span class="apiarg">illusionID</span>) : <span class="apiret">info</span> |
− | : [[API C_TransmogCollection. |
+ | : [[API C_TransmogCollection.GetIllusions|C_TransmogCollection.GetIllusions]]() : <span class="apiret">illusions</span> |
− | : [[API C_TransmogCollection. |
+ | : [[API C_TransmogCollection.GetIllusionStrings|C_TransmogCollection.GetIllusionStrings]](<span class="apiarg">illusionID</span>) : <span class="apiret">name, hyperlink, sourceText</span> |
− | : [[API C_TransmogCollection. |
+ | : [[API C_TransmogCollection.GetInspectItemTransmogInfoList|C_TransmogCollection.GetInspectItemTransmogInfoList]]() : <span class="apiret">list</span> |
− | : [[API C_TransmogCollection. |
+ | : [[API C_TransmogCollection.GetIsAppearanceFavorite|C_TransmogCollection.GetIsAppearanceFavorite]](<span class="apiarg">itemAppearanceID</span>) : <span class="apiret">isFavorite</span> |
− | : [[API C_TransmogCollection. |
+ | : [[API C_TransmogCollection.GetItemInfo|C_TransmogCollection.GetItemInfo]](<span class="apiarg">itemInfo</span>) : <span class="apiret">itemAppearanceID, itemModifiedAppearanceID</span> |
− | : [[API C_TransmogCollection. |
+ | : [[API C_TransmogCollection.GetItemTransmogInfoListFromOutfitHyperlink|C_TransmogCollection.GetItemTransmogInfoListFromOutfitHyperlink]](<span class="apiarg">hyperlink</span>) : <span class="apiret">list</span> |
− | : [[API C_TransmogCollection. |
+ | : [[API C_TransmogCollection.GetLatestAppearance|C_TransmogCollection.GetLatestAppearance]]() : <span class="apiret">visualID, category</span> |
− | : [[API C_TransmogCollection. |
+ | : [[API C_TransmogCollection.GetNumMaxOutfits|C_TransmogCollection.GetNumMaxOutfits]]() : <span class="apiret">maxOutfits</span> |
− | : [[API C_TransmogCollection. |
+ | : [[API C_TransmogCollection.GetNumTransmogSources|C_TransmogCollection.GetNumTransmogSources]]() : <span class="apiret">count</span> |
− | : [[API C_TransmogCollection. |
+ | : [[API C_TransmogCollection.GetOutfitHyperlinkFromItemTransmogInfoList|C_TransmogCollection.GetOutfitHyperlinkFromItemTransmogInfoList]](<span class="apiarg">itemTransmogInfoList</span>) : <span class="apiret">hyperlink</span> |
− | : [[API C_TransmogCollection. |
+ | : [[API C_TransmogCollection.GetOutfitInfo|C_TransmogCollection.GetOutfitInfo]](<span class="apiarg">outfitID</span>) : <span class="apiret">name, icon</span> |
− | : [[API C_TransmogCollection. |
+ | : [[API C_TransmogCollection.GetOutfitItemTransmogInfoList|C_TransmogCollection.GetOutfitItemTransmogInfoList]](<span class="apiarg">outfitID</span>) : <span class="apiret">list</span> |
− | : [[API C_TransmogCollection. |
+ | : [[API C_TransmogCollection.GetOutfits|C_TransmogCollection.GetOutfits]]() : <span class="apiret">outfitID</span> |
− | : [[API C_TransmogCollection. |
+ | : [[API C_TransmogCollection.GetPairedArtifactAppearance|C_TransmogCollection.GetPairedArtifactAppearance]](<span class="apiarg">itemModifiedAppearanceID</span>) : <span class="apiret">pairedItemModifiedAppearanceID</span> |
− | : [[API C_TransmogCollection. |
+ | : [[API C_TransmogCollection.GetSourceIcon|C_TransmogCollection.GetSourceIcon]](<span class="apiarg">itemModifiedAppearanceID</span>) : <span class="apiret">icon</span> |
− | : [[API C_TransmogCollection. |
+ | : [[API C_TransmogCollection.GetSourceInfo|C_TransmogCollection.GetSourceInfo]](<span class="apiarg">sourceID</span>) : <span class="apiret">sourceInfo</span> |
− | : [[API C_TransmogCollection. |
+ | : [[API C_TransmogCollection.GetSourceItemID|C_TransmogCollection.GetSourceItemID]](<span class="apiarg">itemModifiedAppearanceID</span>) : <span class="apiret">itemID</span> |
− | : [[API C_TransmogCollection. |
+ | : [[API C_TransmogCollection.GetSourceRequiredHoliday|C_TransmogCollection.GetSourceRequiredHoliday]](<span class="apiarg">itemModifiedAppearanceID</span>) : <span class="apiret">holidayName</span> |
− | : [[API C_TransmogCollection. |
+ | : [[API C_TransmogCollection.GetUncollectedShown|C_TransmogCollection.GetUncollectedShown]]() : <span class="apiret">shown</span> |
− | : [[API C_TransmogCollection. |
+ | : [[API C_TransmogCollection.HasFavorites|C_TransmogCollection.HasFavorites]]() : <span class="apiret">hasFavorites</span> |
− | : [[API C_TransmogCollection. |
+ | : [[API C_TransmogCollection.IsAppearanceHiddenVisual|C_TransmogCollection.IsAppearanceHiddenVisual]](<span class="apiarg">appearanceID</span>) : <span class="apiret">isHiddenVisual</span> |
− | : [[API C_TransmogCollection. |
+ | : [[API C_TransmogCollection.IsCategoryValidForItem|C_TransmogCollection.IsCategoryValidForItem]](<span class="apiarg">category, itemInfo</span>) : <span class="apiret">isValid</span> |
− | : [[API C_TransmogCollection. |
+ | : [[API C_TransmogCollection.IsNewAppearance|C_TransmogCollection.IsNewAppearance]](<span class="apiarg">visualID</span>) : <span class="apiret">isNew</span> |
− | : [[API C_TransmogCollection. |
+ | : [[API C_TransmogCollection.IsSearchDBLoading|C_TransmogCollection.IsSearchDBLoading]]() : <span class="apiret">isLoading</span> |
− | : [[API C_TransmogCollection. |
+ | : [[API C_TransmogCollection.IsSearchInProgress|C_TransmogCollection.IsSearchInProgress]](<span class="apiarg">searchType</span>) : <span class="apiret">inProgress</span> |
− | : [[API C_TransmogCollection. |
+ | : [[API C_TransmogCollection.IsSourceTypeFilterChecked|C_TransmogCollection.IsSourceTypeFilterChecked]](<span class="apiarg">index</span>) : <span class="apiret">checked</span> |
− | : [[API C_TransmogCollection. |
+ | : [[API C_TransmogCollection.IsUsingDefaultFilters|C_TransmogCollection.IsUsingDefaultFilters]]() : <span class="apiret">isUsingDefaultFilters</span> |
− | : [[API C_TransmogCollection. |
+ | : [[API C_TransmogCollection.ModifyOutfit|C_TransmogCollection.ModifyOutfit]](<span class="apiarg">outfitID, itemTransmogInfoList</span>) |
− | : [[API C_TransmogCollection. |
+ | : [[API C_TransmogCollection.NewOutfit|C_TransmogCollection.NewOutfit]](<span class="apiarg">name, icon, itemTransmogInfoList</span>) : <span class="apiret">outfitID</span> |
− | : [[API C_TransmogCollection. |
+ | : [[API C_TransmogCollection.PlayerCanCollectSource|C_TransmogCollection.PlayerCanCollectSource]](<span class="apiarg">sourceID</span>) : <span class="apiret">hasItemData, canCollect</span> |
− | : [[API C_TransmogCollection. |
+ | : [[API C_TransmogCollection.PlayerHasTransmog|C_TransmogCollection.PlayerHasTransmog]](<span class="apiarg">itemID [, itemAppearanceModID]</span>) : <span class="apiret">hasTransmog</span> |
− | : [[API C_TransmogCollection. |
+ | : [[API C_TransmogCollection.PlayerHasTransmogByItemInfo|C_TransmogCollection.PlayerHasTransmogByItemInfo]](<span class="apiarg">itemInfo</span>) : <span class="apiret">hasTransmog</span> |
− | : [[API C_TransmogCollection. |
+ | : [[API C_TransmogCollection.PlayerHasTransmogItemModifiedAppearance|C_TransmogCollection.PlayerHasTransmogItemModifiedAppearance]](<span class="apiarg">itemModifiedAppearanceID</span>) : <span class="apiret">hasTransmog</span> |
− | : [[API C_TransmogCollection. |
+ | : [[API C_TransmogCollection.PlayerKnowsSource|C_TransmogCollection.PlayerKnowsSource]](<span class="apiarg">sourceID</span>) : <span class="apiret">isKnown</span> |
− | : [[API C_TransmogCollection. |
+ | : [[API C_TransmogCollection.RenameOutfit|C_TransmogCollection.RenameOutfit]](<span class="apiarg">outfitID, name</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.SetAllCollectionTypeFilters|C_TransmogCollection.SetAllCollectionTypeFilters]](<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.SetDefaultFilters|C_TransmogCollection.SetDefaultFilters]]() |
||
+ | : [[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.SetSearchAndFilterCategory|C_TransmogCollection.SetSearchAndFilterCategory]](<span class="apiarg">category</span>) |
||
+ | : [[API C_TransmogCollection.SetSourceTypeFilter|C_TransmogCollection.SetSourceTypeFilter]](<span class="apiarg">index, checked</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]]() |
||
: [[API C_TransmogSets.ClearLatestSource|C_TransmogSets.ClearLatestSource]]() |
: [[API C_TransmogSets.ClearLatestSource|C_TransmogSets.ClearLatestSource]]() |
||
− | : [[API C_TransmogSets.ClearNewSource|C_TransmogSets.ClearNewSource]](<span |
+ | : [[API C_TransmogSets.ClearNewSource|C_TransmogSets.ClearNewSource]](<span class="apiarg">sourceID</span>) |
− | : [[API C_TransmogSets.ClearSetNewSourcesForSlot|C_TransmogSets.ClearSetNewSourcesForSlot]](<span |
+ | : [[API C_TransmogSets.ClearSetNewSourcesForSlot|C_TransmogSets.ClearSetNewSourcesForSlot]](<span class="apiarg">transmogSetID, slot</span>) |
− | : [[API C_TransmogSets.GetAllSets|C_TransmogSets.GetAllSets]]() |
+ | : [[API C_TransmogSets.GetAllSets|C_TransmogSets.GetAllSets]]() : <span class="apiret">sets</span> |
− | : [[API C_TransmogSets.GetAllSourceIDs|C_TransmogSets.GetAllSourceIDs]](<span |
+ | : [[API C_TransmogSets.GetAllSourceIDs|C_TransmogSets.GetAllSourceIDs]](<span class="apiarg">transmogSetID</span>) : <span class="apiret">sources</span> |
− | : [[API C_TransmogSets.GetBaseSetID|C_TransmogSets.GetBaseSetID]](<span |
+ | : [[API C_TransmogSets.GetBaseSetID|C_TransmogSets.GetBaseSetID]](<span class="apiarg">transmogSetID</span>) : <span class="apiret">baseTransmogSetID</span> |
− | : [[API C_TransmogSets.GetBaseSets|C_TransmogSets.GetBaseSets]]() |
+ | : [[API C_TransmogSets.GetBaseSets|C_TransmogSets.GetBaseSets]]() : <span class="apiret">sets</span> |
− | : [[API C_TransmogSets.GetBaseSetsCounts|C_TransmogSets.GetBaseSetsCounts]]() |
+ | : [[API C_TransmogSets.GetBaseSetsCounts|C_TransmogSets.GetBaseSetsCounts]]() : <span class="apiret">numCollected, numTotal</span> |
− | : [[API C_TransmogSets.GetBaseSetsFilter|C_TransmogSets.GetBaseSetsFilter]](<span |
+ | : [[API C_TransmogSets.GetBaseSetsFilter|C_TransmogSets.GetBaseSetsFilter]](<span class="apiarg">index</span>) : <span class="apiret">isChecked</span> |
− | : [[API C_TransmogSets.GetCameraIDs|C_TransmogSets.GetCameraIDs]]() |
+ | : [[API C_TransmogSets.GetCameraIDs|C_TransmogSets.GetCameraIDs]]() : <span class="apiret">detailsCameraID, vendorCameraID</span> |
− | : [[API C_TransmogSets.GetIsFavorite|C_TransmogSets.GetIsFavorite]](<span |
+ | : [[API C_TransmogSets.GetIsFavorite|C_TransmogSets.GetIsFavorite]](<span class="apiarg">transmogSetID</span>) : <span class="apiret">isFavorite, isGroupFavorite</span> |
− | : [[API C_TransmogSets.GetLatestSource|C_TransmogSets.GetLatestSource]]() |
+ | : [[API C_TransmogSets.GetLatestSource|C_TransmogSets.GetLatestSource]]() : <span class="apiret">sourceID</span> |
− | : [[API C_TransmogSets.GetSetInfo|C_TransmogSets.GetSetInfo]](<span |
+ | : [[API C_TransmogSets.GetSetInfo|C_TransmogSets.GetSetInfo]](<span class="apiarg">transmogSetID</span>) : <span class="apiret">set</span> |
− | : [[API C_TransmogSets.GetSetNewSources|C_TransmogSets.GetSetNewSources]](<span |
+ | : [[API C_TransmogSets.GetSetNewSources|C_TransmogSets.GetSetNewSources]](<span class="apiarg">transmogSetID</span>) : <span class="apiret">sourceIDs</span> |
− | : [[API C_TransmogSets. |
+ | : [[API C_TransmogSets.GetSetPrimaryAppearances|C_TransmogSets.GetSetPrimaryAppearances]](<span class="apiarg">transmogSetID</span>) : <span class="apiret">apppearances</span> |
− | : [[API C_TransmogSets.GetSetsContainingSourceID|C_TransmogSets.GetSetsContainingSourceID]](<span |
+ | : [[API C_TransmogSets.GetSetsContainingSourceID|C_TransmogSets.GetSetsContainingSourceID]](<span class="apiarg">sourceID</span>) : <span class="apiret">setIDs</span> |
− | : [[API C_TransmogSets.GetSourceIDsForSlot|C_TransmogSets.GetSourceIDsForSlot]](<span |
+ | : [[API C_TransmogSets.GetSourceIDsForSlot|C_TransmogSets.GetSourceIDsForSlot]](<span class="apiarg">transmogSetID, slot</span>) : <span class="apiret">sources</span> |
− | : [[API C_TransmogSets.GetSourcesForSlot|C_TransmogSets.GetSourcesForSlot]](<span |
+ | : [[API C_TransmogSets.GetSourcesForSlot|C_TransmogSets.GetSourcesForSlot]](<span class="apiarg">transmogSetID, slot</span>) : <span class="apiret">sources</span> |
− | : [[API C_TransmogSets.GetUsableSets|C_TransmogSets.GetUsableSets]]() |
+ | : [[API C_TransmogSets.GetUsableSets|C_TransmogSets.GetUsableSets]]() : <span class="apiret">sets</span> |
− | : [[API C_TransmogSets.GetVariantSets|C_TransmogSets.GetVariantSets]](<span |
+ | : [[API C_TransmogSets.GetVariantSets|C_TransmogSets.GetVariantSets]](<span class="apiarg">transmogSetID</span>) : <span class="apiret">sets</span> |
− | : [[API C_TransmogSets.HasUsableSets|C_TransmogSets.HasUsableSets]]() |
+ | : [[API C_TransmogSets.HasUsableSets|C_TransmogSets.HasUsableSets]]() : <span class="apiret">hasUsableSets</span> |
− | : [[API C_TransmogSets.IsBaseSetCollected|C_TransmogSets.IsBaseSetCollected]](<span |
+ | : [[API C_TransmogSets.IsBaseSetCollected|C_TransmogSets.IsBaseSetCollected]](<span class="apiarg">transmogSetID</span>) : <span class="apiret">isCollected</span> |
− | : [[API C_TransmogSets.IsNewSource|C_TransmogSets.IsNewSource]](<span |
+ | : [[API C_TransmogSets.IsNewSource|C_TransmogSets.IsNewSource]](<span class="apiarg">sourceID</span>) : <span class="apiret">isNew</span> |
− | : [[API C_TransmogSets. |
+ | : [[API C_TransmogSets.IsSetVisible|C_TransmogSets.IsSetVisible]](<span class="apiarg">transmogSetID</span>) : <span class="apiret">isVisible</span> |
− | : [[API C_TransmogSets. |
+ | : [[API C_TransmogSets.IsUsingDefaultBaseSetsFilters|C_TransmogSets.IsUsingDefaultBaseSetsFilters]]() : <span class="apiret">isUsingDefaultBaseSetsFilters</span> |
− | : [[API C_TransmogSets.SetBaseSetsFilter|C_TransmogSets.SetBaseSetsFilter]](<span |
+ | : [[API C_TransmogSets.SetBaseSetsFilter|C_TransmogSets.SetBaseSetsFilter]](<span class="apiarg">index, isChecked</span>) |
− | : [[API C_TransmogSets. |
+ | : [[API C_TransmogSets.SetDefaultBaseSetsFilters|C_TransmogSets.SetDefaultBaseSetsFilters]]() |
− | : [[API C_TransmogSets. |
+ | : [[API C_TransmogSets.SetHasNewSources|C_TransmogSets.SetHasNewSources]](<span class="apiarg">transmogSetID</span>) : <span class="apiret">hasNewSources</span> |
− | : [[API C_TransmogSets. |
+ | : [[API C_TransmogSets.SetHasNewSourcesForSlot|C_TransmogSets.SetHasNewSourcesForSlot]](<span class="apiarg">transmogSetID, slot</span>) : <span class="apiret">hasNewSources</span> |
− | : [[API |
+ | : [[API C_TransmogSets.SetIsFavorite|C_TransmogSets.SetIsFavorite]](<span class="apiarg">transmogSetID, isFavorite</span>) |
+ | : [[API IsUnitModelReadyForUI|IsUnitModelReadyForUI]](<span class="apiarg">unitToken</span>) : <span class="apiret">isReady</span> |
||
− | == |
+ | ==Combat Log== |
− | + | Relates to the [[Combat Log]]. |
|
− | : [[API CombatLogAddFilter|CombatLogAddFilter]](<span |
+ | : [[API CombatLogAddFilter|CombatLogAddFilter]](<span class="apiarg">[eList, sourceFlags, destFlags]</span>) |
− | : [[API CombatLogAdvanceEntry|CombatLogAdvanceEntry]](<span |
+ | : [[API CombatLogAdvanceEntry|CombatLogAdvanceEntry]](<span class="apiarg">count [, ignoreFilter]</span>) |
: [[API CombatLogClearEntries|CombatLogClearEntries]]() |
: [[API CombatLogClearEntries|CombatLogClearEntries]]() |
||
: [[API CombatLogGetCurrentEntry|CombatLogGetCurrentEntry]]() |
: [[API CombatLogGetCurrentEntry|CombatLogGetCurrentEntry]]() |
||
− | : [[API CombatLogGetCurrentEventInfo|CombatLogGetCurrentEventInfo]]() - Returns the current {{api|t=e|COMBAT_LOG_EVENT}} |
+ | : [[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]]() |
||
: [[API CombatLogResetFilter|CombatLogResetFilter]]() |
: [[API CombatLogResetFilter|CombatLogResetFilter]]() |
||
− | : [[API CombatLogSetCurrentEntry|CombatLogSetCurrentEntry]](<span |
+ | : [[API CombatLogSetCurrentEntry|CombatLogSetCurrentEntry]](<span class="apiarg">index [, ignoreFilter]</span>) |
− | : [[API CombatLogSetRetentionTime|CombatLogSetRetentionTime]](<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 |
+ | : [[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== |
− | + | Relates to [[Combat pet|Combat Pet]]s. |
|
: [[API CancelPetPossess|CancelPetPossess]]() |
: [[API CancelPetPossess|CancelPetPossess]]() |
||
− | : |
+ | : [[API CastPetAction|CastPetAction]](<span class="apiarg">index</span>) {{apitag|protected}} - 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 |
+ | : [[API GetCallPetSpellInfo|GetCallPetSpellInfo]](<span class="apiarg">spellID</span>) |
− | : [[API GetPetActionCooldown|GetPetActionCooldown]](<span |
+ | : [[API GetPetActionCooldown|GetPetActionCooldown]](<span class="apiarg">index</span>) - Returns cooldown info for an action on the pet action bar. |
− | : [[API GetPetActionInfo|GetPetActionInfo]](<span |
+ | : [[API GetPetActionInfo|GetPetActionInfo]](<span class="apiarg">index</span>) - Returns info for an action on the pet action bar. |
− | : [[API GetPetActionSlotUsable|GetPetActionSlotUsable]](<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 |
+ | : [[API GetPetExperience|GetPetExperience]]() - Returns the pet's current and total XP required for the next level. |
− | : [[API GetPetFoodTypes|GetPetFoodTypes]]() - Returns |
+ | : [[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 |
+ | : [[API HasPetSpells|HasPetSpells]]() - Returns the number of available abilities for the player's combat pet. |
− | : [[API HasPetUI|HasPetUI]]() - Returns |
+ | : [[API HasPetUI|HasPetUI]]() - Returns 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]]() - Returns true if the pet is currently auto attacking. |
: [[API PetAbandon|PetAbandon]]() - Permanently abandons your pet. |
: [[API PetAbandon|PetAbandon]]() - Permanently abandons your pet. |
||
− | : |
+ | : [[API PetAggressiveMode|PetAggressiveMode]]() {{apitag|protected}} |
− | : |
+ | : [[API PetAssistMode|PetAssistMode]]() {{apitag|protected}} - Set your pet to Assist mode. |
− | : |
+ | : [[API PetAttack|PetAttack]]() {{apitag|protected}} - Instruct your pet to attack your target. |
− | : [[API PetCanBeAbandoned|PetCanBeAbandoned]]() - Returns true if the pet |
+ | : [[API PetCanBeAbandoned|PetCanBeAbandoned]]() - Returns true if the pet can be abandoned. |
− | : |
+ | : [[API PetMoveTo|PetMoveTo]](<span class="apiarg">target</span>) {{apitag|protected}} |
: [[API PetCanBeDismissed|PetCanBeDismissed]]() |
: [[API PetCanBeDismissed|PetCanBeDismissed]]() |
||
: [[API PetCanBeRenamed|PetCanBeRenamed]]() - Returns true if the pet can be renamed. |
: [[API PetCanBeRenamed|PetCanBeRenamed]]() - Returns true if the pet can be renamed. |
||
− | : |
+ | : [[API PetDefensiveMode|PetDefensiveMode]]() {{apitag|protected}} - Set your pet in defensive mode. |
: [[API PetDefensiveAssistMode|PetDefensiveAssistMode]]() |
: [[API PetDefensiveAssistMode|PetDefensiveAssistMode]]() |
||
: [[API PetDismiss|PetDismiss]]() - Dismiss your pet. |
: [[API PetDismiss|PetDismiss]]() - Dismiss your pet. |
||
− | : |
+ | : [[API PetFollow|PetFollow]]() {{apitag|protected}} - Instruct your pet to follow you. |
: [[API PetHasSpellbook|PetHasSpellbook]]() |
: [[API PetHasSpellbook|PetHasSpellbook]]() |
||
− | : |
+ | : [[API PetPassiveMode|PetPassiveMode]]() {{apitag|protected}} - Set your pet into passive mode. |
− | : [[API PetRename|PetRename]](<span |
+ | : [[API PetRename|PetRename]](<span class="apiarg">name</span>) - Renames your pet. |
− | : [[API PetStopAttack|PetStopAttack]]() - |
+ | : [[API PetStopAttack|PetStopAttack]]() - Stops the pet from attacking. |
: [[API PetUsesPetFrame|PetUsesPetFrame]]() |
: [[API PetUsesPetFrame|PetUsesPetFrame]]() |
||
− | : |
+ | : [[API PetWait|PetWait]]() {{apitag|protected}} - Instruct your pet to remain still. |
− | : |
+ | : [[API TogglePetAutocast|TogglePetAutocast]](<span class="apiarg">index</span>) {{apitag|protected}} - Toggles whether the specified pet ability should autocast or not. |
− | : |
+ | : [[API ToggleSpellAutocast|ToggleSpellAutocast]](<span class="apiarg">spellName | spellId, bookType</span>) {{apitag|protected}} - Toggles whether the specified Pet spell should autocast or not. |
− | + | Relates to the [[Stable Master]]. |
|
− | : [[API ClosePetStables|ClosePetStables]]() - |
+ | : [[API ClosePetStables|ClosePetStables]]() - Closes the pet stable window. |
− | : [[API GetStablePetFoodTypes|GetStablePetFoodTypes]](<span |
+ | : [[API GetStablePetFoodTypes|GetStablePetFoodTypes]](<span class="apiarg">index</span>) - Returns the food types the specified stabled pet can eat. |
− | : [[API GetStablePetInfo|GetStablePetInfo]](<span |
+ | : [[API GetStablePetInfo|GetStablePetInfo]](<span class="apiarg">index</span>) - Returns info for a specific stabled pet. |
: [[API IsAtStableMaster|IsAtStableMaster]]() |
: [[API IsAtStableMaster|IsAtStableMaster]]() |
||
− | : [[API SetPetSlot|SetPetSlot]](<span |
+ | : [[API SetPetSlot|SetPetSlot]](<span class="apiarg">index, slot</span>) |
− | : [[API SetPetStablePaperdoll|SetPetStablePaperdoll]](<span |
+ | : [[API SetPetStablePaperdoll|SetPetStablePaperdoll]](<span class="apiarg">modelObject</span>) |
− | == |
+ | ==Controls== |
+ | ===Action Bars=== |
||
− | : [[API C_Commentator.AssignPlayersToTeam|C_Commentator.AssignPlayersToTeam]](<span style="font-size:smaller; color:#ecbc2a">playerName, teamName</span>) |
||
+ | : [[API C_ActionBar.GetBonusBarIndexForSlot|C_ActionBar.GetBonusBarIndexForSlot]](<span class="apiarg">slotID</span>) : <span class="apiret">bonusBarIndex</span> |
||
− | : [[API C_Commentator.AssignPlayersToTeamInCurrentInstance|C_Commentator.AssignPlayersToTeamInCurrentInstance]](<span style="font-size:smaller; color:#ecbc2a">teamIndex, teamName</span>) |
||
+ | : [[API C_ActionBar.IsHarmfulAction|C_ActionBar.IsHarmfulAction]](<span class="apiarg">actionID, useNeutral</span>) : <span class="apiret">isHarmful</span> |
||
− | : [[API C_Commentator.AssignPlayerToTeam|C_Commentator.AssignPlayerToTeam]](<span style="font-size:smaller; color:#ecbc2a">playerName, teamName</span>) |
||
+ | : [[API C_ActionBar.IsHelpfulAction|C_ActionBar.IsHelpfulAction]](<span class="apiarg">actionID, useNeutral</span>) : <span class="apiret">isHelpful</span> |
||
− | : [[API C_Commentator.FindSpectatedUnit|C_Commentator.FindSpectatedUnit]](<span style="font-size:smaller; color:#ecbc2a">unitToken</span>) |
||
+ | : [[API C_ActionBar.IsOnBarOrSpecialBar|C_ActionBar.IsOnBarOrSpecialBar]](<span class="apiarg">spellID</span>) : <span class="apiret">isOnBarOrSpecialBar</span> |
||
− | : [[API C_Commentator.FindTeamNameInCurrentInstance|C_Commentator.FindTeamNameInCurrentInstance]](<span style="font-size:smaller; color:#ecbc2a">teamIndex</span>) |
||
− | : [[API |
+ | : [[API C_ActionBar.PutActionInSlot|C_ActionBar.PutActionInSlot]](<span class="apiarg">slotID</span>) |
+ | : [[API C_ActionBar.ShouldOverrideBarShowHealthBar|C_ActionBar.ShouldOverrideBarShowHealthBar]]() : <span class="apiret">showHealthBar</span> |
||
− | : [[API C_Commentator.FlushCommentatorHistory|C_Commentator.FlushCommentatorHistory]]() |
||
+ | : [[API C_ActionBar.ShouldOverrideBarShowManaBar|C_ActionBar.ShouldOverrideBarShowManaBar]]() : <span class="apiret">showManaBar</span> |
||
− | : [[API C_Commentator.GetCommentatorHistory|C_Commentator.GetCommentatorHistory]]() |
||
+ | : [[API ChangeActionBarPage|ChangeActionBarPage]](<span class="apiarg">page</span>) {{apitag|nocombat}} - Changes the current action bar page. |
||
− | : [[API C_Commentator.GetOrCreateSeries|C_Commentator.GetOrCreateSeries]](<span style="font-size:smaller; color:#ecbc2a">teamName1, teamName2</span>) |
||
+ | : [[API GetActionBarPage|GetActionBarPage]]() - Returns the current action bar page. |
||
− | : [[API C_Commentator.GetPlayerAuraInfoByUnit|C_Commentator.GetPlayerAuraInfoByUnit]](<span style="font-size:smaller; color:#ecbc2a">token, spellID</span>) |
||
+ | : [[API GetActionBarToggles|GetActionBarToggles]]() - Returns the enabled states for the extra action bars. |
||
− | : [[API C_Commentator.GetPlayerCooldownInfoByUnit|C_Commentator.GetPlayerCooldownInfoByUnit]](<span style="font-size:smaller; color:#ecbc2a">unitToken, spellID</span>) |
||
+ | : [[API GetBonusBarIndex|GetBonusBarIndex]]() |
||
− | : [[API C_Commentator.GetPlayerData|C_Commentator.GetPlayerData]](<span style="font-size:smaller; color:#ecbc2a">teamIndex, playerIndex</span>) |
||
+ | : [[API GetBonusBarOffset|GetBonusBarOffset]]() - Returns the current bonus action bar index (e.g. for the Rogue stealth bar). |
||
− | : [[API C_Commentator.GetPlayerFlagInfoByUnit|C_Commentator.GetPlayerFlagInfoByUnit]](<span style="font-size:smaller; color:#ecbc2a">unitToken</span>) |
||
+ | : [[API GetExtraBarIndex|GetExtraBarIndex]]() |
||
− | : [[API C_Commentator.GetPlayerSpellChargesByUnit|C_Commentator.GetPlayerSpellChargesByUnit]](<span style="font-size:smaller; color:#ecbc2a">unitToken, spellID</span>) |
||
+ | : [[API GetMultiCastBarIndex|GetMultiCastBarIndex]]() |
||
− | : [[API C_Commentator.GetTeamColor|C_Commentator.GetTeamColor]](<span style="font-size:smaller; color:#ecbc2a">teamIndex</span>) |
||
+ | : [[API GetOverrideBarIndex|GetOverrideBarIndex]]() |
||
− | : [[API C_Commentator.GetTeamColorByUnit|C_Commentator.GetTeamColorByUnit]](<span style="font-size:smaller; color:#ecbc2a">unitToken</span>) |
||
+ | : [[API GetOverrideBarSkin|GetOverrideBarSkin]]() |
||
− | : [[API C_Commentator.GetTrackedSpellsByUnit|C_Commentator.GetTrackedSpellsByUnit]](<span style="font-size:smaller; color:#ecbc2a">unitToken, category</span>) |
||
+ | : [[API GetTempShapeshiftBarIndex|GetTempShapeshiftBarIndex]]() |
||
− | : [[API C_Commentator.GetUnitData|C_Commentator.GetUnitData]](<span style="font-size:smaller; color:#ecbc2a">unitToken</span>) |
||
+ | : [[API GetVehicleBarIndex|GetVehicleBarIndex]]() |
||
− | : [[API C_Commentator.IsTrackedSpellByUnit|C_Commentator.IsTrackedSpellByUnit]](<span style="font-size:smaller; color:#ecbc2a">unitToken, spellID, category</span>) |
||
+ | : [[API HasBonusActionBar|HasBonusActionBar]]() |
||
− | : [[API C_Commentator.ResetSeriesScores|C_Commentator.ResetSeriesScores]](<span style="font-size:smaller; color:#ecbc2a">teamName1, teamName2</span>) |
||
+ | : [[API HasExtraActionBar|HasExtraActionBar]]() |
||
− | : [[API C_Commentator.ResetSettings|C_Commentator.ResetSettings]]() |
||
+ | : [[API HasOverrideActionBar|HasOverrideActionBar]]() |
||
− | : [[API C_Commentator.SetCommentatorHistory|C_Commentator.SetCommentatorHistory]](<span style="font-size:smaller; color:#ecbc2a">history</span>) |
||
+ | : [[API HasTempShapeshiftActionBar|HasTempShapeshiftActionBar]]() |
||
− | : [[API C_Commentator.SetSeriesScore|C_Commentator.SetSeriesScore]](<span style="font-size:smaller; color:#ecbc2a">teamName1, teamName2, scoringTeamName, score</span>) |
||
+ | : [[API HasVehicleActionBar|HasVehicleActionBar]]() |
||
− | : [[API C_Commentator.SetSeriesScores|C_Commentator.SetSeriesScores]](<span style="font-size:smaller; color:#ecbc2a">teamName1, teamName2, score1, score2</span>) |
||
+ | : [[API IsPossessBarVisible|IsPossessBarVisible]]() |
||
+ | : [[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>) - Sets the visible state for each action bar. |
||
+ | ===Action Buttons=== |
||
− | === Contribution Collection === |
||
+ | : [[API C_ActionBar.FindPetActionButtons|C_ActionBar.FindPetActionButtons]](<span class="apiarg">petActionID</span>) : <span class="apiret">slots</span> |
||
− | These functions were added in [[Patch 7.2.0]]. They refer to buildings on the [[Broken Shore]] or [[Warfront|Warfronts]]. |
||
+ | : [[API C_ActionBar.FindSpellActionButtons|C_ActionBar.FindSpellActionButtons]](<span class="apiarg">spellID</span>) : <span class="apiret">slots</span> |
||
− | : [[API C_ContributionCollector.Close|C_ContributionCollector.Close]]() - Closes the contribution collector API state. |
||
+ | : [[API C_ActionBar.GetPetActionPetBarIndices|C_ActionBar.GetPetActionPetBarIndices]](<span class="apiarg">petActionID</span>) : <span class="apiret">slots</span> |
||
− | : [[API C_ContributionCollector.Contribute|C_ContributionCollector.Contribute]](<span style="font-size:smaller; color:#ecbc2a">contributionID</span>) - Contributes resources to a building. |
||
+ | : [[API C_ActionBar.HasPetActionButtons|C_ActionBar.HasPetActionButtons]](<span class="apiarg">petActionID</span>) : <span class="apiret">hasPetActionButtons</span> |
||
− | : [[API C_ContributionCollector.GetActive|C_ContributionCollector.GetActive]]() - Returns the currently active buildings. |
||
+ | : [[API C_ActionBar.HasPetActionPetBarIndices|C_ActionBar.HasPetActionPetBarIndices]](<span class="apiarg">petActionID</span>) : <span class="apiret">hasPetActionPetBarIndices</span> |
||
− | : [[API C_ContributionCollector.GetAtlases|C_ContributionCollector.GetAtlases]](<span style="font-size:smaller; color:#ecbc2a">contributionID</span>) - Returns a table listing the possible states for a building. |
||
+ | : [[API C_ActionBar.HasSpellActionButtons|C_ActionBar.HasSpellActionButtons]](<span class="apiarg">spellID</span>) : <span class="apiret">hasSpellActionButtons</span> |
||
− | : [[API C_ContributionCollector.GetBuffs|C_ContributionCollector.GetBuffs]](<span style="font-size:smaller; color:#ecbc2a">contributionID</span>) - Returns the buffs provided when a building is active. |
||
+ | : [[API C_ActionBar.IsAutoCastPetAction|C_ActionBar.IsAutoCastPetAction]](<span class="apiarg">slotID</span>) : <span class="apiret">isAutoCastPetAction</span> |
||
− | : [[API C_ContributionCollector.GetContributionAppearance|C_ContributionCollector.GetContributionAppearance]](<span style="font-size:smaller; color:#ecbc2a">contributionID, contributionState</span>) - Returns contribution appearance info. |
||
+ | : [[API C_ActionBar.IsEnabledAutoCastPetAction|C_ActionBar.IsEnabledAutoCastPetAction]](<span class="apiarg">slotID</span>) : <span class="apiret">isEnabledAutoCastPetAction</span> |
||
− | : [[API C_ContributionCollector.GetContributionCollectorsForMap|C_ContributionCollector.GetContributionCollectorsForMap]](<span style="font-size:smaller; color:#ecbc2a">uiMapID</span>) - Returns contribution buildings on a map. |
||
+ | : [[API C_ActionBar.ToggleAutoCastPetAction|C_ActionBar.ToggleAutoCastPetAction]](<span class="apiarg">slotID</span>) |
||
− | : [[API C_ContributionCollector.GetContributionResult|C_ContributionCollector.GetContributionResult]](<span style="font-size:smaller; color:#ecbc2a">contributionID</span>) - Returns a value indicating the result of a contribution. |
||
− | : [[API |
+ | : [[API ActionHasRange|ActionHasRange]](<span class="apiarg">slot</span>) - Returns true if the action has has a range requirement. |
+ | : [[API ClickWorldMapActionButton|ClickWorldMapActionButton]]() |
||
− | : [[API C_ContributionCollector.GetManagedContributionsForCreatureID|C_ContributionCollector.GetManagedContributionsForCreatureID]](<span style="font-size:smaller; color:#ecbc2a">creatureID</span>) - Returns contributions for a creature. |
||
+ | : [[API GetActionAutocast|GetActionAutocast]](<span class="apiarg">slot</span>) |
||
− | : [[API C_ContributionCollector.GetName|C_ContributionCollector.GetName]](<span style="font-size:smaller; color:#ecbc2a">contributionID</span>) - Returns the name of a building. |
||
− | : [[API |
+ | : [[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>) - Returns cooldown info for the specified action slot. |
||
− | : [[API C_ContributionCollector.GetRequiredContributionCurrency|C_ContributionCollector.GetRequiredContributionCurrency]](<span style="font-size:smaller; color:#ecbc2a">contributionID</span>) - Returns the currencyID and amount needed to contribute to a building. |
||
− | : [[API |
+ | : [[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 info for an action. |
||
− | : [[API C_ContributionCollector.GetRewardQuestID|C_ContributionCollector.GetRewardQuestID]](<span style="font-size:smaller; color:#ecbc2a">contributionID</span>) - Returns the hidden quest that is flagged completed when a contribution is made. |
||
− | : [[API |
+ | : [[API GetActionText|GetActionText]](<span class="apiarg">slot</span>) - Returns the label text for an action. |
− | : [[API |
+ | : [[API GetActionTexture|GetActionTexture]](<span class="apiarg">slot</span>) - Returns the icon texture for an action. |
+ | : [[API GetPossessInfo|GetPossessInfo]](<span class="apiarg">index</span>) - Returns info for an action on the possession bar. |
||
− | : [[API C_ContributionCollector.IsAwaitingRewardQuestData|C_ContributionCollector.IsAwaitingRewardQuestData]](<span style="font-size:smaller; color:#ecbc2a">contributionID</span>) - Returns whether the contribution API is waiting for quest data. |
||
+ | : [[API GetWorldMapActionButtonSpellInfo|GetWorldMapActionButtonSpellInfo]]() |
||
+ | : [[API HasAction|HasAction]](<span class="apiarg">slot</span>) - Returns true if an action slot is occupied. |
||
+ | : [[API IsActionInRange|IsActionInRange]](<span class="apiarg">slot</span>) - Returns true if the specified action is in range. |
||
+ | : [[API IsAttackAction|IsAttackAction]](<span class="apiarg">slot</span>) - Returns true if an action is the "Auto Attack" action. |
||
+ | : [[API IsAutoRepeatAction|IsAutoRepeatAction]](<span class="apiarg">slot</span>) - Returns 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 true if an action is a consumable, i.e. it has a count. |
||
+ | : [[API IsCurrentAction|IsCurrentAction]](<span class="apiarg">slot</span>) - Returns true if the specified action is currently being used. |
||
+ | : [[API IsEquippedAction|IsEquippedAction]](<span class="apiarg">slot</span>) - Returns true if the specified action slot is an equipped item. |
||
+ | : [[API IsItemAction|IsItemAction]](<span class="apiarg">slot</span>) |
||
+ | : [[API IsPetAttackAction|IsPetAttackAction]](<span class="apiarg">index</span>) |
||
+ | : [[API IsStackableAction|IsStackableAction]](<span class="apiarg">slot</span>) |
||
+ | : [[API IsUsableAction|IsUsableAction]](<span class="apiarg">slot</span>) - Returns 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 SetSpellbookPetAction|SetSpellbookPetAction]](<span class="apiarg">slot, target</span>) |
||
+ | : [[API UseAction|UseAction]](<span class="apiarg">slot [, checkCursor, onSelf]</span>) {{apitag|protected}} - Perform the action in the specified action slot. |
||
+ | : [[API UseWorldMapActionButtonSpellOnQuest|UseWorldMapActionButtonSpellOnQuest]]() |
||
+ | Flyout Buttons |
||
+ | : [[API C_ActionBar.FindFlyoutActionButtons|C_ActionBar.FindFlyoutActionButtons]](<span class="apiarg">flyoutID</span>) : <span class="apiret">slots</span> |
||
+ | : [[API C_ActionBar.HasFlyoutActionButtons|C_ActionBar.HasFlyoutActionButtons]](<span class="apiarg">flyoutID</span>) : <span class="apiret">hasFlyoutActionButtons</span> |
||
+ | : [[API FindFlyoutSlotBySpellID|FindFlyoutSlotBySpellID]](<span class="apiarg">spellID</span>) |
||
+ | : [[API FlyoutHasSpell|FlyoutHasSpell]](<span class="apiarg">flyoutID, spellID</span>) |
||
+ | : [[API GetFlyoutID|GetFlyoutID]](<span class="apiarg">index</span>) |
||
+ | : [[API GetFlyoutInfo|GetFlyoutInfo]](<span class="apiarg">flyoutID</span>) |
||
+ | : [[API GetFlyoutSlotInfo|GetFlyoutSlotInfo]](<span class="apiarg">flyoutID, slot</span>) |
||
+ | : [[API GetNumFlyouts|GetNumFlyouts]]() |
||
− | === |
+ | ===Key Bindings=== |
+ | Relates to [[Key Bindings]]. |
||
− | [[Currencies]] were added in [[Patch 3.0.2]]. |
||
+ | : [[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_CurrencyInfo.DoesWarModeBonusApply|C_CurrencyInfo.DoesWarModeBonusApply]](<span style="font-size:smaller; color:#ecbc2a">currencyID</span>) |
||
− | : [[API |
+ | : [[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>) - Returns the binding name for a key (combination). |
||
− | : [[API C_CurrencyInfo.GetAzeriteCurrencyID|C_CurrencyInfo.GetAzeriteCurrencyID]]() |
||
+ | : [[API GetBindingByKey|GetBindingByKey]](<span class="apiarg">action [, mode]</span>) - Returns the binding action performed when the specified key combination is triggered. |
||
− | : [[API C_CurrencyInfo.GetBackpackCurrencyInfo|C_CurrencyInfo.GetBackpackCurrencyInfo]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Returns information about a watched currency. |
||
+ | : [[API GetBindingKey|GetBindingKey]](<span class="apiarg">command</span>) - Returns the keys bound to the given command. |
||
− | : [[API C_CurrencyInfo.GetBasicCurrencyInfo|C_CurrencyInfo.GetBasicCurrencyInfo]](<span style="font-size:smaller; color:#ecbc2a">currencyType [, quantity]</span>) |
||
+ | : [[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 C_CurrencyInfo.GetCurrencyContainerInfo|C_CurrencyInfo.GetCurrencyContainerInfo]](<span style="font-size:smaller; color:#ecbc2a">currencyType, quantity</span>) |
||
+ | : [[API GetCurrentBindingSet|GetCurrentBindingSet]]() - Returns if either account or character-specific bindings are active. |
||
− | : [[API C_CurrencyInfo.GetCurrencyIDFromLink|C_CurrencyInfo.GetCurrencyIDFromLink]](<span style="font-size:smaller; color:#ecbc2a">currencyLink</span>) |
||
+ | : [[API GetNumBindings|GetNumBindings]]() - Returns the number of bindings and headers in the key bindings window. |
||
− | : [[API C_CurrencyInfo.GetCurrencyInfo|C_CurrencyInfo.GetCurrencyInfo]](<span style="font-size:smaller; color:#ecbc2a">type</span>) - Returns information about currencies. |
||
+ | : [[API LoadBindings|LoadBindings]](<span class="apiarg">which</span>) - Loads default, account or character specific key bindings. |
||
− | : [[API C_CurrencyInfo.GetCurrencyInfoFromLink|C_CurrencyInfo.GetCurrencyInfoFromLink]](<span style="font-size:smaller; color:#ecbc2a">link</span>) - Returns information about currencies from a link. |
||
+ | : [[API RunBinding|RunBinding]](<span class="apiarg">command [, up]</span>) - Executes a key binding. |
||
− | : [[API C_CurrencyInfo.GetCurrencyLink|C_CurrencyInfo.GetCurrencyLink]](<span style="font-size:smaller; color:#ecbc2a">type, amount</span>) - Returns the currencyLink for the specified currencyID. |
||
+ | : [[API SaveBindings|SaveBindings]](<span class="apiarg">which</span>) - Saves account or character specific key bindings. |
||
− | : [[API C_CurrencyInfo.GetCurrencyListInfo|C_CurrencyInfo.GetCurrencyListInfo]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Returns information about an element in the currency list. |
||
+ | : [[API SetBinding|SetBinding]](<span class="apiarg">key [, command, mode]</span>) {{apitag|nocombat}} - Sets a key binding to an action. |
||
− | : [[API C_CurrencyInfo.GetCurrencyListLink|C_CurrencyInfo.GetCurrencyListLink]](<span style="font-size:smaller; color:#ecbc2a">index</span>) |
||
+ | : [[API SetBindingSpell|SetBindingSpell]](<span class="apiarg">key, spellName</span>) {{apitag|nocombat}} - Sets a binding to cast the specified spell. |
||
− | : [[API C_CurrencyInfo.GetCurrencyListSize|C_CurrencyInfo.GetCurrencyListSize]]() - Returns the number of elements (both headers and currencies) in the currency list. |
||
+ | : [[API SetBindingClick|SetBindingClick]](<span class="apiarg">key, ButtonName [, mouseButton]</span>) {{apitag|nocombat}} - Sets a binding to click the specified Button widget. |
||
− | : [[API C_CurrencyInfo.GetFactionGrantedByCurrency|C_CurrencyInfo.GetFactionGrantedByCurrency]](<span style="font-size:smaller; color:#ecbc2a">currencyID</span>) - Gets the faction ID for currency that is immediately converted into reputation with that faction instead. |
||
+ | : [[API SetBindingItem|SetBindingItem]](<span class="apiarg">key, itemname</span>) {{apitag|nocombat}} |
||
− | : [[API C_CurrencyInfo.GetWarResourcesCurrencyID|C_CurrencyInfo.GetWarResourcesCurrencyID]]() |
||
+ | : [[API SetBindingMacro|SetBindingMacro]](<span class="apiarg">key, macroname or macroId</span>) {{apitag|nocombat}} |
||
− | : [[API C_CurrencyInfo.IsCurrencyContainer|C_CurrencyInfo.IsCurrencyContainer]](<span style="font-size:smaller; color:#ecbc2a">currencyID, quantity</span>) |
||
+ | : [[API SetOverrideBinding|SetOverrideBinding]](<span class="apiarg">owner, isPriority, key [, command]</span>) {{apitag|nocombat}} - Sets an override key binding. |
||
− | : [[API C_CurrencyInfo.SetCurrencyBackpack|C_CurrencyInfo.SetCurrencyBackpack]](<span style="font-size:smaller; color:#ecbc2a">index, backpack</span>) - Alters whether a currency is tracked. |
||
+ | : [[API SetOverrideBindingSpell|SetOverrideBindingSpell]](<span class="apiarg">owner, isPriority, key, spellname</span>) {{apitag|nocombat}} |
||
− | : [[API C_CurrencyInfo.SetCurrencyUnused|C_CurrencyInfo.SetCurrencyUnused]](<span style="font-size:smaller; color:#ecbc2a">index, unused</span>) - Alters whether a currency is marked as unused. |
||
+ | : [[API SetOverrideBindingClick|SetOverrideBindingClick]](<span class="apiarg">owner, isPriority, key, buttonName [, mouseClick]</span>) {{apitag|nocombat}} - Sets an override binding that performs a button click. |
||
− | : [[API GetCoinText|GetCoinText]](<span style="font-size:smaller; color:#ecbc2a">amount, separator</span>) - Breaks down money and inserts separator strings. |
||
+ | : [[API SetOverrideBindingItem|SetOverrideBindingItem]](<span class="apiarg">owner, isPriority, key, itemname</span>) {{apitag|nocombat}} |
||
− | : [[API GetCoinTextureString|GetCoinTextureString]](<span style="font-size:smaller; color:#ecbc2a">amount [, fontHeight]</span>) - Breaks down money and inserts texture strings. |
||
+ | : [[API SetOverrideBindingMacro|SetOverrideBindingMacro]](<span class="apiarg">owner, isPriority, key, macroname or macroId</span>) {{apitag|nocombat}} |
||
− | : [[API GetPlayerTradeCurrency|GetPlayerTradeCurrency]]() |
||
+ | : [[API ClearOverrideBindings|ClearOverrideBindings]](<span class="apiarg">owner</span>) {{apitag|nocombat}} - Removes all override bindings owned by a specific frame. |
||
− | : [[API GetTargetTradeCurrency|GetTargetTradeCurrency]]() |
||
− | : [[API |
+ | : [[API SetMouselookOverrideBinding|SetMouselookOverrideBinding]](<span class="apiarg">key [, command]</span>) |
+ | |||
− | : UI [[API GetNumWatchedTokens|GetNumWatchedTokens]]() - Returns the number of currently watched currencies. |
||
+ | ===Click Bindings=== |
||
+ | : [[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.GetBindingType|C_ClickBindings.GetBindingType]](<span class="apiarg">button, modifiers</span>) : <span class="apiret">type</span> |
||
+ | : [[API C_ClickBindings.GetEffectiveInteractionButton|C_ClickBindings.GetEffectiveInteractionButton]](<span class="apiarg">button, modifiers</span>) : <span class="apiret">effectiveButton</span> |
||
+ | : [[API C_ClickBindings.GetProfileInfo|C_ClickBindings.GetProfileInfo]]() : <span class="apiret">infoVec</span> |
||
+ | : [[API C_ClickBindings.GetStringFromModifiers|C_ClickBindings.GetStringFromModifiers]](<span class="apiarg">modifiers</span>) : <span class="apiret">modifierString</span> |
||
+ | : [[API C_ClickBindings.GetTutorialShown|C_ClickBindings.GetTutorialShown]]() : <span class="apiret">tutorialShown</span> |
||
+ | : [[API C_ClickBindings.MakeModifiers|C_ClickBindings.MakeModifiers]]() : <span class="apiret">modifiers</span> |
||
+ | : [[API C_ClickBindings.ResetCurrentProfile|C_ClickBindings.ResetCurrentProfile]]() |
||
+ | : [[API C_ClickBindings.SetProfileByInfo|C_ClickBindings.SetProfileByInfo]](<span class="apiarg">infoVec</span>) |
||
+ | : [[API C_ClickBindings.SetTutorialShown|C_ClickBindings.SetTutorialShown]]() |
||
+ | |||
+ | ===Key Modifiers=== |
||
+ | : [[API GetModifiedClick|GetModifiedClick]](<span class="apiarg">action</span>) |
||
+ | : [[API GetModifiedClickAction|GetModifiedClickAction]](<span class="apiarg">index</span>) |
||
+ | : [[API GetMouseButtonClicked|GetMouseButtonClicked]]() - Returns the mouse button responsible during an OnClick event (e.g. "RightButton"). |
||
+ | : [[API GetNumModifiedClickActions|GetNumModifiedClickActions]]() |
||
+ | : [[API IsAltKeyDown|IsAltKeyDown]]() - Returns true if the alt key is currently depressed. |
||
+ | : [[API IsControlKeyDown|IsControlKeyDown]]() - Returns true if the control key is currently depressed. |
||
+ | : [[API IsKeyDown|IsKeyDown]](<span class="apiarg">keyOrMouseName [, excludeCurrentBindingState]</span>) |
||
+ | : [[API IsLeftAltKeyDown|IsLeftAltKeyDown]]() - Returns true if the left alt key is currently depressed. |
||
+ | : [[API IsLeftControlKeyDown|IsLeftControlKeyDown]]() - Returns true if the left control key is currently depressed. |
||
+ | : [[API IsLeftMetaKeyDown|IsLeftMetaKeyDown]]() |
||
+ | : [[API IsLeftShiftKeyDown|IsLeftShiftKeyDown]]() - Returns true if the left shift key is currently depressed. |
||
+ | : [[API IsMetaKeyDown|IsMetaKeyDown]]() |
||
+ | : [[API IsModifiedClick|IsModifiedClick]](<span class="apiarg">action</span>) - Returns true if the modifier key needed for an an action is pressed. |
||
+ | : [[API IsModifierKeyDown|IsModifierKeyDown]]() - Returns true if a modifier key is currently pressed down. |
||
+ | : [[API IsMouseButtonDown|IsMouseButtonDown]](<span class="apiarg">[button]</span>) |
||
+ | : [[API IsRightAltKeyDown|IsRightAltKeyDown]]() - Returns true if the right alt key is currently depressed. |
||
+ | : [[API IsRightControlKeyDown|IsRightControlKeyDown]]() - Returns true if the right control key is currently depressed. |
||
+ | : [[API IsRightMetaKeyDown|IsRightMetaKeyDown]]() |
||
+ | : [[API IsRightShiftKeyDown|IsRightShiftKeyDown]]() - Returns true if the right shift key is currently depressed. |
||
+ | : [[API IsShiftKeyDown|IsShiftKeyDown]]() - Returns true if the shift key is currently depressed. |
||
+ | : [[API SetModifiedClick|SetModifiedClick]](<span class="apiarg">action, binding</span>) |
||
− | === |
+ | ===Cursor=== |
− | + | Relates to the [[Cursor]]. |
|
+ | : [[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 |
+ | : [[API AutoEquipCursorItem|AutoEquipCursorItem]]() - Equips the item currently held by the cursor. |
+ | : [[API ClearCursor|ClearCursor]]() - Clears any objects from the cursor. |
||
− | : [[API ClickSocketButton|ClickSocketButton]](<span style="font-size:smaller; color:#ecbc2a">id</span>) - If the cursor is currently holding a gem, tentatively insert it into the socket. |
||
− | : [[API |
+ | : [[API ClickSocketButton|ClickSocketButton]](<span class="apiarg">id</span>) - If the cursor is currently holding a gem, tentatively insert it into the socket. |
: [[API CursorHasItem|CursorHasItem]]() - Returns true if the cursor currently holds an item. |
: [[API CursorHasItem|CursorHasItem]]() - Returns 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. |
||
− | : [[API DeleteCursorItem|DeleteCursorItem]]() - Destroys the item |
+ | : [[API DeleteCursorItem|DeleteCursorItem]]() {{apitag|hwevent,noscript}} - Destroys the item held by the cursor. |
− | : [[API DropCursorMoney|DropCursorMoney]]() - Drops |
+ | : [[API DropCursorMoney|DropCursorMoney]]() - Drops money held by the cursor back into your bag. |
− | : [[API DropItemOnUnit|DropItemOnUnit]](<span |
+ | : [[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 |
+ | : [[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 |
+ | : [[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]]() - |
+ | : [[API HideRepairCursor|HideRepairCursor]]() - Takes the cursor out of repair mode. |
− | : [[API InRepairMode|InRepairMode]]() - Returns true if |
+ | : [[API InRepairMode|InRepairMode]]() - Returns true if the cursor is in repair mode. |
− | : [[API PickupAction|PickupAction]](<span |
+ | : [[API PickupAction|PickupAction]](<span class="apiarg">slot</span>) - Places an action onto the cursor. |
− | : [[API PickupBagFromSlot|PickupBagFromSlot]](<span |
+ | : [[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 |
+ | : [[API PickupCompanion|PickupCompanion]](<span class="apiarg">type, index</span>) - Places a mount onto the cursor. |
− | : [[API |
+ | : [[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 C_CurrencyInfo.PickupCurrency|C_CurrencyInfo.PickupCurrency]](<span style="font-size:smaller; color:#ecbc2a">type</span>) |
||
− | : [[API |
+ | : [[API PickupInventoryItem|PickupInventoryItem]](<span class="apiarg">invSlot</span>) - Picks up / interacts with an equipment slot. |
+ | : [[API PickupItem|PickupItem]](<span class="apiarg">item</span>) |
||
− | : [[API PickupGuildBankMoney|PickupGuildBankMoney]](<span style="font-size:smaller; color:#ecbc2a">money</span>) - Picks up "money" copper from the guild bank. |
||
− | : [[API |
+ | : [[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 a merchant item onto the cursor. If the cursor already has an item, it will be sold. |
||
− | : [[API PickupItem|PickupItem]](<span style="font-size:smaller; color:#ecbc2a">item</span>) |
||
− | : [[API |
+ | : [[API PickupPetAction|PickupPetAction]](<span class="apiarg">slot</span>) - Places a pet action onto the cursor. |
+ | : [[API PickupPetSpell|PickupPetSpell]](<span class="apiarg">spellID</span>) |
||
− | : [[API PickupMerchantItem|PickupMerchantItem]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Places the item onto the cursor. If the cursor already has an item, the item in the cursor will be sold. |
||
− | : [[API |
+ | : [[API PickupPlayerMoney|PickupPlayerMoney]](<span class="apiarg">copper</span>) - Picks up an amount of money from the player onto the cursor. |
− | : [[API PickupPetSpell|PickupPetSpell]](<span style="font-size:smaller; color:#ecbc2a">spellID</span>) |
||
− | : [[API PickupPlayerMoney|PickupPlayerMoney]](<span style="font-size:smaller; color:#ecbc2a">copper</span>) - Picks up an amount of money from the player. |
||
: [[API PickupPvpTalent|PickupPvpTalent]]() |
: [[API PickupPvpTalent|PickupPvpTalent]]() |
||
− | : [[API |
+ | : [[API PickupSpell|PickupSpell]](<span class="apiarg">spellID</span>) - Places a spell onto the cursor. |
+ | : [[API PickupSpellBookItem|PickupSpellBookItem]](<span class="apiarg">spellSlot</span>) |
||
− | : [[API PickupSpell|PickupSpell]](<span style="font-size:smaller; color:#ecbc2a">spellName | spellID, bookType</span>) - Places the specified spell onto the cursor. |
||
− | : [[API PickupStablePet|PickupStablePet]](<span |
+ | : [[API PickupStablePet|PickupStablePet]](<span class="apiarg">index</span>) |
− | : [[API PickupTalent|PickupTalent]](<span |
+ | : [[API PickupTalent|PickupTalent]](<span class="apiarg">talentID</span>) - Grabs the selected talent spell for placement on an action bar. |
− | : [[API PickupTradeMoney|PickupTradeMoney]](<span |
+ | : [[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 |
+ | : [[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 |
+ | : [[API SetCursor|SetCursor]](<span class="apiarg">cursor</span>) - Sets the current cursor texture. |
+ | : [[API ShowBuybackSellCursor|ShowBuybackSellCursor]](<span class="apiarg">index</span>) |
||
− | : [[API SetItemUpgradeFromCursorItem|SetItemUpgradeFromCursorItem]]() |
||
− | : [[API ShowBuybackSellCursor|ShowBuybackSellCursor]](<span style="font-size:smaller; color:#ecbc2a">index</span>) |
||
− | : [[API ShowContainerSellCursor|ShowContainerSellCursor]](<span style="font-size:smaller; color:#ecbc2a">index, slot</span>) |
||
− | : [[API ShowInventorySellCursor|ShowInventorySellCursor]]() |
||
: [[API ShowRepairCursor|ShowRepairCursor]]() |
: [[API ShowRepairCursor|ShowRepairCursor]]() |
||
− | === |
+ | ===Camera=== |
+ | : [[API CameraOrSelectOrMoveStart|CameraOrSelectOrMoveStart]]() {{apitag|protected}} - Begin "Left click" in the 3D world. |
||
− | These functions relate to [[Customer Support]]. |
||
+ | : [[API CameraOrSelectOrMoveStop|CameraOrSelectOrMoveStop]](<span class="apiarg">[stickyFlag]</span>) {{apitag|protected}} - Called when you release the "Left-Click" mouse button. |
||
− | : [[API AcknowledgeSurvey|AcknowledgeSurvey]](<span style="font-size:smaller; color:#ecbc2a">caseIndex</span>) |
||
+ | : [[API CameraZoomIn|CameraZoomIn]](<span class="apiarg">increment</span>) - Zooms the camera in. |
||
− | : PROTECTED [[API DeleteGMTicket|DeleteGMTicket]]() |
||
+ | : [[API CameraZoomOut|CameraZoomOut]](<span class="apiarg">increment</span>) - Zooms the camera out. |
||
+ | : [[API CenterCamera|CenterCamera]]() |
||
+ | : [[API FlipCameraYaw|FlipCameraYaw]](<span class="apiarg">degrees</span>) - Rotates the camera around the Z-axis. |
||
+ | : [[API GetCameraZoom|GetCameraZoom]]() - Returns the current zoom level of the camera. |
||
+ | : [[API IsMouselooking|IsMouselooking]]() - Returns true if the player is currently in mouselook mode. |
||
+ | : [[API MouselookStart|MouselookStart]]() - Enters mouse look mode; alters the character's movement/facing direction. |
||
+ | : [[API MouselookStop|MouselookStop]]() - Exits mouse look mode. |
||
+ | : [[API MoveViewDownStart|MoveViewDownStart]]() - Starts rotating the camera downward. |
||
+ | : [[API MoveViewDownStop|MoveViewDownStop]]() - Stops rotating the camera downward. |
||
+ | : [[API MoveViewInStart|MoveViewInStart]]() - Begins zooming the camera in. |
||
+ | : [[API MoveViewInStop|MoveViewInStop]]() - Stops zooming the camera in. |
||
+ | : [[API MoveViewLeftStart|MoveViewLeftStart]]() - Starts rotating the camera to the left. |
||
+ | : [[API MoveViewLeftStop|MoveViewLeftStop]]() - Stops rotating the camera to the left. |
||
+ | : [[API MoveViewOutStart|MoveViewOutStart]]() - Begins zooming the camera out. |
||
+ | : [[API MoveViewOutStop|MoveViewOutStop]]() - Stops zooming the camera out. |
||
+ | : [[API MoveViewRightStart|MoveViewRightStart]]() - Starts rotating the camera to the right. |
||
+ | : [[API MoveViewRightStop|MoveViewRightStop]]() - Stops rotating the camera to the right. |
||
+ | : [[API MoveViewUpStart|MoveViewUpStart]]() - Starts rotating the camera upward. |
||
+ | : [[API MoveViewUpStop|MoveViewUpStop]]() - Stops rotating the camera upward. |
||
+ | : [[API PitchDownStart|PitchDownStart]]() {{apitag|protected}} - Begins pitching the camera Downward. |
||
+ | : [[API PitchDownStop|PitchDownStop]]() {{apitag|protected}} - Stops pitching the camera after [[API PitchDownStart|PitchDownStart]]() is called. |
||
+ | : [[API PitchUpStart|PitchUpStart]]() {{apitag|protected}} - Begins pitching the camera Upward. |
||
+ | : [[API PitchUpStop|PitchUpStop]]() {{apitag|protected}} - Stops pitching the camera after [[API PitchUpStart|PitchUpStart]]() is called. |
||
+ | : [[API NextView|NextView]]() - Cycles forward through the five predefined camera positions. |
||
+ | : [[API PrevView|PrevView]]() - Cycles backward through the five predefined camera positions. |
||
+ | : [[API ResetView|ResetView]](<span 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>) - Saves a camera angle. The last position loaded is stored in the [[CVar cameraView]]. |
||
+ | : [[API SetView|SetView]](<span class="apiarg">index</span>) - Sets the camera to a predefined camera position (1-5). |
||
+ | |||
+ | ===Targeting=== |
||
+ | Relates to [[Target]]s. |
||
+ | : [[API AssistUnit|AssistUnit]](<span class="apiarg">unit</span>) {{apitag|protected}} - Assists the unit by targeting the same target. |
||
+ | : [[API ClearFocus|ClearFocus]]() {{apitag|protected}} - Clears the focus target. |
||
+ | : [[API ClearTarget|ClearTarget]]() {{apitag|protected}} - Clears the selected target. |
||
+ | : [[API FocusUnit|FocusUnit]](<span class="apiarg">unit</span>) {{apitag|protected}} - Sets the [[focus target]]. |
||
+ | : [[API TargetDirectionEnemy|TargetDirectionEnemy]](<span class="apiarg">facing</span>) {{apitag|protected}} |
||
+ | : [[API TargetDirectionFinished|TargetDirectionFinished]]() {{apitag|protected}} |
||
+ | : [[API TargetDirectionFriend|TargetDirectionFriend]](<span class="apiarg">facing</span>) {{apitag|protected}} |
||
+ | : [[API TargetLastEnemy|TargetLastEnemy]]() {{apitag|protected}} - Targets the previously targeted enemy. |
||
+ | : [[API TargetLastFriend|TargetLastFriend]]() {{apitag|protected}} |
||
+ | : [[API TargetLastTarget|TargetLastTarget]]() {{apitag|protected}} - Selects the last target as the current target. |
||
+ | : [[API TargetNearestEnemy|TargetNearestEnemy]](<span class="apiarg">[reverseFlag]</span>) {{apitag|protected}} - Selects the nearest enemy as the current target. |
||
+ | : [[API TargetNearestEnemyPlayer|TargetNearestEnemyPlayer]](<span class="apiarg">[reverseFlag]</span>) {{apitag|protected}} - Selects the nearest enemy player as the current target. |
||
+ | : [[API TargetNearestFriend|TargetNearestFriend]](<span class="apiarg">[reverseFlag]</span>) {{apitag|protected}} - Targets the nearest friendly unit. |
||
+ | : [[API TargetNearestFriendPlayer|TargetNearestFriendPlayer]](<span class="apiarg">[reverseFlag]</span>) {{apitag|protected}} - Selects the nearest friendly player as the current target. |
||
+ | : [[API TargetNearest|TargetNearest]]() {{apitag|protected}} |
||
+ | : [[API TargetNearestPartyMember|TargetNearestPartyMember]]() {{apitag|protected}} - Selects the nearest Party member as the current target. |
||
+ | : [[API TargetNearestRaidMember|TargetNearestRaidMember]]() {{apitag|protected}} - Selects the nearest Raid member as the current target. |
||
+ | : [[API TargetPriorityHighlightEnd|TargetPriorityHighlightEnd]]() {{apitag|protected}} |
||
+ | : [[API TargetPriorityHighlightStart|TargetPriorityHighlightStart]]() {{apitag|protected}} |
||
+ | : [[API TargetUnit|TargetUnit]](<span class="apiarg">unit [, exactMatch]</span>) {{apitag|protected}} - Targets the specified unit. |
||
+ | |||
+ | ===Movement=== |
||
+ | Most of these functions may only be called on a hardware event from '''secure''' code. |
||
+ | : [[API AscendStop|AscendStop]]() {{apitag|protected}} - Called when the player releases the jump key. |
||
+ | : [[API AttackTarget|AttackTarget]]() {{apitag|protected}} - Toggles auto-attacking of the current target. |
||
+ | : [[API DescendStop|DescendStop]]() {{apitag|protected}} - Stops descending while flying or swimming. |
||
+ | : [[API FollowUnit|FollowUnit]](<span class="apiarg">unit</span>) {{apitag|hwevent}} - Follows a friendly player unit. |
||
+ | : [[API IsPlayerMoving|IsPlayerMoving]]() |
||
+ | : [[API JumpOrAscendStart|JumpOrAscendStart]]() {{apitag|protected}} - Makes the character jump or swim/fly upwards. |
||
+ | : [[API MoveAndSteerStart|MoveAndSteerStart]]() {{apitag|protected}} |
||
+ | : [[API MoveAndSteerStop|MoveAndSteerStop]]() {{apitag|protected}} |
||
+ | : [[API MoveBackwardStart|MoveBackwardStart]]() {{apitag|protected}} - The player begins moving backward at the specified time. |
||
+ | : [[API MoveBackwardStop|MoveBackwardStop]]() {{apitag|protected}} - The player stops moving backward at the specified time. |
||
+ | : [[API MoveForwardStart|MoveForwardStart]]() {{apitag|protected}} - The player begins moving forward at the specified time. |
||
+ | : [[API MoveForwardStop|MoveForwardStop]]() {{apitag|protected}} - The player stops moving forward at the specified time. |
||
+ | : [[API SetMoveEnabled|SetMoveEnabled]]() {{apitag|protected}} |
||
+ | : [[API SetTurnEnabled|SetTurnEnabled]]() {{apitag|protected}} |
||
+ | : [[API SitStandOrDescendStart|SitStandOrDescendStart]]() {{apitag|protected}} - Makes the player sit, stand, or descend (while swimming or flying). |
||
+ | : [[API StartAttack|StartAttack]]() {{apitag|protected}} |
||
+ | : [[API StopAttack|StopAttack]]() - Turns off auto-attack, if currently active. |
||
+ | : [[API StartAutoRun|StartAutoRun]]() {{apitag|protected}} |
||
+ | : [[API StopAutoRun|StopAutoRun]]() {{apitag|protected}} |
||
+ | : [[API StrafeLeftStart|StrafeLeftStart]]() {{apitag|protected}} - The player begins strafing left at the specified time. |
||
+ | : [[API StrafeLeftStop|StrafeLeftStop]]() {{apitag|protected}} - The player stops strafing left at the specified time. |
||
+ | : [[API StrafeRightStart|StrafeRightStart]]() {{apitag|protected}} - The player begins strafing right at the specified time. |
||
+ | : [[API StrafeRightStop|StrafeRightStop]]() {{apitag|protected}} - The player stops strafing right at the specified time. |
||
+ | : [[API ToggleAutoRun|ToggleAutoRun]]() {{apitag|protected}} - Turns auto-run on or off. |
||
+ | : [[API ToggleRun|ToggleRun]]() {{apitag|protected}} - Toggle between running and walking. |
||
+ | : [[API TurnLeftStart|TurnLeftStart]]() {{apitag|protected}} - Turns the player left at the specified time. |
||
+ | : [[API TurnLeftStop|TurnLeftStop]]() {{apitag|protected}} - The player stops turning left at the specified time. |
||
+ | : [[API TurnOrActionStart|TurnOrActionStart]]() {{apitag|protected}} - Starts a "right click" in the 3D game world. |
||
+ | : [[API TurnOrActionStop|TurnOrActionStop]]() {{apitag|protected}} - Stops a "right click" in the 3D game world. |
||
+ | : [[API TurnRightStart|TurnRightStart]]() {{apitag|protected}} - Turns the player right at the specified time. |
||
+ | : [[API TurnRightStop|TurnRightStop]]() {{apitag|protected}} - The player stops turning right at the specified time. |
||
+ | |||
+ | ===Gamepad=== |
||
+ | Native gamepad support was added in [[Patch 9.0.1]], where previously [https://github.com/topher-au/WoWmapper WoWmapper] was needed. |
||
+ | : [[API C_GamePad.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.AxisIndexToConfigName|C_GamePad.AxisIndexToConfigName]](<span class="apiarg">axisIndex</span>) : <span class="apiret">configName</span> |
||
+ | : [[API C_GamePad.ButtonBindingToIndex|C_GamePad.ButtonBindingToIndex]](<span class="apiarg">bindingName</span>) : <span class="apiret">buttonIndex</span> |
||
+ | : [[API C_GamePad.ButtonIndexToBinding|C_GamePad.ButtonIndexToBinding]](<span class="apiarg">buttonIndex</span>) : <span class="apiret">bindingName</span> |
||
+ | : [[API C_GamePad.ButtonIndexToConfigName|C_GamePad.ButtonIndexToConfigName]](<span class="apiarg">buttonIndex</span>) : <span class="apiret">configName</span> |
||
+ | : [[API C_GamePad.ClearLedColor|C_GamePad.ClearLedColor]]() |
||
+ | : [[API C_GamePad.DeleteConfig|C_GamePad.DeleteConfig]](<span class="apiarg">configID</span>) |
||
+ | : [[API C_GamePad.GetActiveDeviceID|C_GamePad.GetActiveDeviceID]]() : <span class="apiret">deviceID</span> |
||
+ | : [[API C_GamePad.GetAllConfigIDs|C_GamePad.GetAllConfigIDs]]() : <span class="apiret">configIDs</span> |
||
+ | : [[API C_GamePad.GetAllDeviceIDs|C_GamePad.GetAllDeviceIDs]]() : <span class="apiret">deviceIDs</span> |
||
+ | : [[API C_GamePad.GetCombinedDeviceID|C_GamePad.GetCombinedDeviceID]]() : <span class="apiret">deviceID</span> |
||
+ | : [[API C_GamePad.GetConfig|C_GamePad.GetConfig]](<span class="apiarg">configID</span>) : <span class="apiret">config</span> |
||
+ | : [[API C_GamePad.GetDeviceMappedState|C_GamePad.GetDeviceMappedState]](<span class="apiarg">[deviceID]</span>) : <span class="apiret">state</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.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.SetConfig|C_GamePad.SetConfig]](<span class="apiarg">config</span>) |
||
+ | : [[API C_GamePad.SetLedColor|C_GamePad.SetLedColor]](<span class="apiarg">color</span>) |
||
+ | : [[API C_GamePad.SetVibration|C_GamePad.SetVibration]](<span class="apiarg">vibrationType, intensity</span>) |
||
+ | : [[API C_GamePad.StickIndexToConfigName|C_GamePad.StickIndexToConfigName]](<span class="apiarg">stickIndex</span>) : <span class="apiret">configName</span> |
||
+ | : [[API C_GamePad.StopVibration|C_GamePad.StopVibration]]() |
||
+ | : [[API CanAutoSetGamePadCursorControl|CanAutoSetGamePadCursorControl]]() |
||
+ | : [[API CanGamePadControlCursor|CanGamePadControlCursor]]() |
||
+ | : [[API IsBindingForGamePad|IsBindingForGamePad]](<span class="apiarg">KEY</span>) |
||
+ | : [[API IsGamePadCursorControlEnabled|IsGamePadCursorControlEnabled]]() |
||
+ | : [[API IsGamePadFreelookEnabled|IsGamePadFreelookEnabled]]() |
||
+ | : [[API SetGamePadCursorControl|SetGamePadCursorControl]]() |
||
+ | : [[API SetGamePadFreeLook|SetGamePadFreeLook]]() |
||
+ | |||
+ | ==Currency== |
||
+ | [[Currencies]] were added in [[Patch 3.0.2]]. |
||
+ | : [[API C_CurrencyInfo.DoesWarModeBonusApply|C_CurrencyInfo.DoesWarModeBonusApply]](<span class="apiarg">currencyID</span>) : <span class="apiret">warModeApplies, limitOncePerTooltip</span> |
||
+ | : [[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.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.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.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.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 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.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.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.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>) - Marks a currency as unused in the currency tab. |
||
+ | : [[API C_Item.GetLimitedCurrencyItemInfo|C_Item.GetLimitedCurrencyItemInfo]](<span class="apiarg">itemInfo</span>) : <span class="apiret">name, icon, quantity, maxQuantity, totalEarned</span> |
||
+ | : [[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 GetTargetTradeCurrency|GetTargetTradeCurrency]]() |
||
+ | : [[API SetTradeCurrency|SetTradeCurrency]](<span class="apiarg">type, amount</span>) |
||
+ | : [[API GetNumWatchedTokens|GetNumWatchedTokens]]() {{apitag|framexml}} - Returns the number of currently watched currencies. |
||
+ | |||
+ | ==Customer Support== |
||
+ | Relates to [[Customer Support]]. |
||
+ | : [[API AcknowledgeSurvey|AcknowledgeSurvey]](<span class="apiarg">caseIndex</span>) |
||
+ | : [[API DeleteGMTicket|DeleteGMTicket]]() {{apitag|protected}} |
||
: [[API GetWebTicket|GetWebTicket]]() |
: [[API GetWebTicket|GetWebTicket]]() |
||
: [[API GMEuropaBugsEnabled|GMEuropaBugsEnabled]]() |
: [[API GMEuropaBugsEnabled|GMEuropaBugsEnabled]]() |
||
Line 1,757: | Line 2,568: | ||
: [[API GMRequestPlayerInfo|GMRequestPlayerInfo]]() |
: [[API GMRequestPlayerInfo|GMRequestPlayerInfo]]() |
||
: [[API GMResponseResolve|GMResponseResolve]]() |
: [[API GMResponseResolve|GMResponseResolve]]() |
||
− | : [[API C_UserFeedback.SubmitBug|C_UserFeedback.SubmitBug]](<span |
+ | : [[API C_UserFeedback.SubmitBug|C_UserFeedback.SubmitBug]](<span class="apiarg">bugInfo [, suppressNotification]</span>) : <span class="apiret">success</span> |
− | : [[API C_UserFeedback.SubmitSuggestion|C_UserFeedback.SubmitSuggestion]](<span |
+ | : [[API C_UserFeedback.SubmitSuggestion|C_UserFeedback.SubmitSuggestion]](<span class="apiarg">suggestion</span>) : <span class="apiret">success</span> |
− | : [[API GMSurveyAnswerSubmit|GMSurveyAnswerSubmit]](<span |
+ | : [[API GMSurveyAnswerSubmit|GMSurveyAnswerSubmit]](<span class="apiarg">question, rank, comment</span>) |
: [[API GMSurveyAnswer|GMSurveyAnswer]]() |
: [[API GMSurveyAnswer|GMSurveyAnswer]]() |
||
− | : [[API GMSurveyCommentSubmit|GMSurveyCommentSubmit]](<span |
+ | : [[API GMSurveyCommentSubmit|GMSurveyCommentSubmit]](<span class="apiarg">comment</span>) |
: [[API GMSurveyNumAnswers|GMSurveyNumAnswers]]() |
: [[API GMSurveyNumAnswers|GMSurveyNumAnswers]]() |
||
: [[API GMSurveyQuestion|GMSurveyQuestion]]() |
: [[API GMSurveyQuestion|GMSurveyQuestion]]() |
||
Line 1,767: | Line 2,578: | ||
: [[API GetGMStatus|GetGMStatus]]() |
: [[API GetGMStatus|GetGMStatus]]() |
||
: [[API GetGMTicket|GetGMTicket]]() |
: [[API GetGMTicket|GetGMTicket]]() |
||
− | : [[API RegisterStaticConstants|RegisterStaticConstants]](<span |
+ | : [[API RegisterStaticConstants|RegisterStaticConstants]](<span class="apiarg">table</span>) - Populates the STATIC_CONSTANTS table for [[API GetGMTicketCategories|GetGMTicketCategories]]. |
− | : [[API ReportBug|ReportBug]](<span |
+ | : [[API ReportBug|ReportBug]](<span class="apiarg">description</span>) |
− | : [[API ReportSuggestion|ReportSuggestion]](<span |
+ | : [[API ReportSuggestion|ReportSuggestion]](<span class="apiarg">description</span>) |
Knowledge Base |
Knowledge Base |
||
− | : [[API KBArticle_BeginLoading|KBArticle_BeginLoading]](<span |
+ | : [[API KBArticle_BeginLoading|KBArticle_BeginLoading]](<span class="apiarg">articleId, searchType</span>) - Starts the article loading process. |
: [[API KBArticle_GetData|KBArticle_GetData]]() - Returns information about the current article. |
: [[API KBArticle_GetData|KBArticle_GetData]]() - Returns information about the current article. |
||
: [[API KBArticle_IsLoaded|KBArticle_IsLoaded]]() - Returns true if an article is loaded. |
: [[API KBArticle_IsLoaded|KBArticle_IsLoaded]]() - Returns true if an article is loaded. |
||
− | : [[API KBQuery_BeginLoading|KBQuery_BeginLoading]](<span |
+ | : [[API KBQuery_BeginLoading|KBQuery_BeginLoading]](<span class="apiarg">searchText, categoryIndex, subcategoryIndex, articlesPerPage, curPage</span>) - Starts a query for articles. |
: [[API KBQuery_GetArticleHeaderCount|KBQuery_GetArticleHeaderCount]]() - Returns the number of article headers in the current query. |
: [[API KBQuery_GetArticleHeaderCount|KBQuery_GetArticleHeaderCount]]() - Returns the number of article headers in the current query. |
||
− | : [[API KBQuery_GetArticleHeaderData|KBQuery_GetArticleHeaderData]](<span |
+ | : [[API KBQuery_GetArticleHeaderData|KBQuery_GetArticleHeaderData]](<span class="apiarg">index</span>) - Returns information about an article header of the current query. |
: [[API KBQuery_GetTotalArticleCount|KBQuery_GetTotalArticleCount]]() - Returns the total number of articles that matches the current query. |
: [[API KBQuery_GetTotalArticleCount|KBQuery_GetTotalArticleCount]]() - Returns the total number of articles that matches the current query. |
||
: [[API KBQuery_IsLoaded|KBQuery_IsLoaded]]() - Returns true if a query loaded successfuly. |
: [[API KBQuery_IsLoaded|KBQuery_IsLoaded]]() - Returns true if a query loaded successfuly. |
||
− | : [[API KBSetup_BeginLoading|KBSetup_BeginLoading]](<span |
+ | : [[API KBSetup_BeginLoading|KBSetup_BeginLoading]](<span class="apiarg">articlesPerPage, curPage</span>) - Starts the loading process for the KB start page. |
: [[API KBSetup_GetArticleHeaderCount|KBSetup_GetArticleHeaderCount]]() - Returns the number of articles for the current page. |
: [[API KBSetup_GetArticleHeaderCount|KBSetup_GetArticleHeaderCount]]() - Returns the number of articles for the current page. |
||
− | : [[API KBSetup_GetArticleHeaderData|KBSetup_GetArticleHeaderData]](<span |
+ | : [[API KBSetup_GetArticleHeaderData|KBSetup_GetArticleHeaderData]](<span class="apiarg">index</span>) - Returns information for an article header. |
: [[API KBSetup_GetCategoryCount|KBSetup_GetCategoryCount]]() - Returns the number of categories in the knowledge base. |
: [[API KBSetup_GetCategoryCount|KBSetup_GetCategoryCount]]() - Returns the number of categories in the knowledge base. |
||
− | : [[API KBSetup_GetCategoryData|KBSetup_GetCategoryData]](<span |
+ | : [[API KBSetup_GetCategoryData|KBSetup_GetCategoryData]](<span class="apiarg">index</span>) - Returns information about a category. |
: [[API KBSetup_GetLanguageCount|KBSetup_GetLanguageCount]]() - Returns the number of languages in the knowledge base. |
: [[API KBSetup_GetLanguageCount|KBSetup_GetLanguageCount]]() - Returns the number of languages in the knowledge base. |
||
− | : [[API KBSetup_GetLanguageData|KBSetup_GetLanguageData]](<span |
+ | : [[API KBSetup_GetLanguageData|KBSetup_GetLanguageData]](<span class="apiarg">index</span>) - Returns information about a language. |
− | : [[API KBSetup_GetSubCategoryCount|KBSetup_GetSubCategoryCount]](<span |
+ | : [[API KBSetup_GetSubCategoryCount|KBSetup_GetSubCategoryCount]](<span class="apiarg">category</span>) - Returns the number of subcategories for a category. |
− | : [[API KBSetup_GetSubCategoryData|KBSetup_GetSubCategoryData]](<span |
+ | : [[API KBSetup_GetSubCategoryData|KBSetup_GetSubCategoryData]](<span class="apiarg">category, index</span>) - Returns information about a subcategory. |
: [[API KBSetup_GetTotalArticleCount|KBSetup_GetTotalArticleCount]]() - Returns the total number of articles in the knowlege base. |
: [[API KBSetup_GetTotalArticleCount|KBSetup_GetTotalArticleCount]]() - Returns the total number of articles in the knowlege base. |
||
: [[API KBSetup_IsLoaded|KBSetup_IsLoaded]]() - Returns true if the knowledge base is loaded successfuly. |
: [[API KBSetup_IsLoaded|KBSetup_IsLoaded]]() - Returns true if the knowledge base is loaded successfuly. |
||
Line 1,794: | Line 2,605: | ||
: [[API KBSystem_GetServerStatus|KBSystem_GetServerStatus]]() - Returns the server status text. |
: [[API KBSystem_GetServerStatus|KBSystem_GetServerStatus]]() - Returns the server status text. |
||
+ | ==Expansions== |
||
− | === Equipment Manager === |
||
+ | Relates to [[Expansion]]s. |
||
− | The [[Equipment Manager]] was added in [[Patch 3.1.2]]. |
||
+ | : [[API CanUpgradeExpansion|CanUpgradeExpansion]]() : <span class="apiret">canUpgradeExpansion</span> |
||
− | : [[API C_EquipmentSet.AssignSpecToEquipmentSet|C_EquipmentSet.AssignSpecToEquipmentSet]](<span style="font-size:smaller; color:#ecbc2a">equipmentSetID, specIndex</span>) - Assigns an equipment set to a specialization. |
||
+ | : [[API DoesCurrentLocaleSellExpansionLevels|DoesCurrentLocaleSellExpansionLevels]]() : <span class="apiret">regionSellsExpansions</span> |
||
− | : [[API C_EquipmentSet.CanUseEquipmentSets|C_EquipmentSet.CanUseEquipmentSets]]() - Returns whether any equipment sets can be used. |
||
+ | : [[API GetAccountExpansionLevel|GetAccountExpansionLevel]]() : <span class="apiret">expansionLevel</span> - Returns the expansion level the account has been flagged for. |
||
− | : [[API C_EquipmentSet.ClearIgnoredSlotsForSave|C_EquipmentSet.ClearIgnoredSlotsForSave]]() - Clears ignored slots for saving. |
||
+ | : [[API GetClientDisplayExpansionLevel|GetClientDisplayExpansionLevel]]() : <span class="apiret">expansionLevel</span> - Returns the expansion level of the game client. |
||
− | : [[API C_EquipmentSet.CreateEquipmentSet|C_EquipmentSet.CreateEquipmentSet]](<span style="font-size:smaller; color:#ecbc2a">equipmentSetName [, icon]</span>) - Creates an equipment set. |
||
+ | : [[API GetExpansionDisplayInfo|GetExpansionDisplayInfo]](<span class="apiarg">expansionLevel</span>) : <span class="apiret">info</span> |
||
− | : [[API C_EquipmentSet.DeleteEquipmentSet|C_EquipmentSet.DeleteEquipmentSet]](<span style="font-size:smaller; color:#ecbc2a">equipmentSetID</span>) - Deletes an equipment set. |
||
+ | : [[API GetExpansionForLevel|GetExpansionForLevel]](<span class="apiarg">playerLevel</span>) : <span class="apiret">expansionLevel</span> |
||
− | : [[API C_EquipmentSet.EquipmentSetContainsLockedItems|C_EquipmentSet.EquipmentSetContainsLockedItems]](<span style="font-size:smaller; color:#ecbc2a">equipmentSetID</span>) - Returns whether an equipment set has locked items |
||
− | : [[API |
+ | : [[API GetExpansionLevel|GetExpansionLevel]]() : <span class="apiret">expansionLevel</span> - Returns the expansion level currently accessible by the player. |
+ | : [[API GetExpansionTrialInfo|GetExpansionTrialInfo]]() : <span class="apiret">isExpansionTrialAccount, expansionTrialRemainingSeconds</span> |
||
− | : [[API C_EquipmentSet.GetEquipmentSetForSpec|C_EquipmentSet.GetEquipmentSetForSpec]](<span style="font-size:smaller; color:#ecbc2a">specIndex</span>) - Returns the equipment set currently assigned to a specific specialization. |
||
+ | : [[API GetMaximumExpansionLevel|GetMaximumExpansionLevel]]() : <span class="apiret">expansionLevel</span> |
||
− | : [[API C_EquipmentSet.GetEquipmentSetID|C_EquipmentSet.GetEquipmentSetID]](<span style="font-size:smaller; color:#ecbc2a">equipmentSetName</span>) - Returns the set ID of an equipment set with the specified name. |
||
+ | : [[API GetMaxLevelForExpansionLevel|GetMaxLevelForExpansionLevel]](<span class="apiarg">expansionLevel</span>) : <span class="apiret">maxLevel</span> |
||
− | : [[API C_EquipmentSet.GetEquipmentSetIDs|C_EquipmentSet.GetEquipmentSetIDs]]() - Returns an array containing all currently saved equipment set IDs. |
||
+ | : [[API GetMaxLevelForLatestExpansion|GetMaxLevelForLatestExpansion]]() : <span class="apiret">maxLevel</span> |
||
− | : [[API C_EquipmentSet.GetEquipmentSetInfo|C_EquipmentSet.GetEquipmentSetInfo]](<span style="font-size:smaller; color:#ecbc2a">equipmentSetID</span>) - Returns information about a saved equipment set. |
||
+ | : [[API GetMaxLevelForPlayerExpansion|GetMaxLevelForPlayerExpansion]]() : <span class="apiret">maxLevel</span> |
||
− | : [[API C_EquipmentSet.GetIgnoredSlots|C_EquipmentSet.GetIgnoredSlots]](<span style="font-size:smaller; color:#ecbc2a">equipmentSetID</span>) - Returns ignored slots of an equipment set. |
||
− | : [[API C_EquipmentSet.GetItemIDs|C_EquipmentSet.GetItemIDs]](<span style="font-size:smaller; color:#ecbc2a">equipmentSetID</span>) - Returns the item IDs of an equipment set. |
||
− | : [[API C_EquipmentSet.GetItemLocations|C_EquipmentSet.GetItemLocations]](<span style="font-size:smaller; color:#ecbc2a">equipmentSetID</span>) - Returns the location of all items in an equipment set. |
||
− | : [[API C_EquipmentSet.GetNumEquipmentSets|C_EquipmentSet.GetNumEquipmentSets]]() - Returns the number of saved equipment sets. |
||
− | : [[API C_EquipmentSet.IgnoreSlotForSave|C_EquipmentSet.IgnoreSlotForSave]](<span style="font-size:smaller; color:#ecbc2a">slot</span>) - Ignores an equipment slot for saving. |
||
− | : [[API C_EquipmentSet.IsSlotIgnoredForSave|C_EquipmentSet.IsSlotIgnoredForSave]](<span style="font-size:smaller; color:#ecbc2a">slot</span>) - Returns whether a slot is ignored for saving. |
||
− | : [[API C_EquipmentSet.ModifyEquipmentSet|C_EquipmentSet.ModifyEquipmentSet]](<span style="font-size:smaller; color:#ecbc2a">equipmentSetID, newName [, newIcon]</span>) - Modifies an equipment set. |
||
− | : [[API C_EquipmentSet.PickupEquipmentSet|C_EquipmentSet.PickupEquipmentSet]](<span style="font-size:smaller; color:#ecbc2a">equipmentSetID</span>) - Picks up an equipment set, placing it on the cursor. |
||
− | : [[API C_EquipmentSet.SaveEquipmentSet|C_EquipmentSet.SaveEquipmentSet]](<span style="font-size:smaller; color:#ecbc2a">equipmentSetID [, icon]</span>) - Saves your currently equipped items into an equipment set. |
||
− | : [[API C_EquipmentSet.UnassignEquipmentSetSpec|C_EquipmentSet.UnassignEquipmentSetSpec]](<span style="font-size:smaller; color:#ecbc2a">equipmentSetID</span>) - Unassigns an equipment set from a specialization. |
||
− | : [[API C_EquipmentSet.UnignoreSlotForSave|C_EquipmentSet.UnignoreSlotForSave]](<span style="font-size:smaller; color:#ecbc2a">slot</span>) - Unignores a slot for saving. |
||
− | : NOCOMBAT [[API C_EquipmentSet.UseEquipmentSet|C_EquipmentSet.UseEquipmentSet]](<span style="font-size:smaller; color:#ecbc2a">equipmentSetID</span>) - Equips items from a specified equipment set. |
||
− | : [[API GetInventoryItemEquippedUnusable|GetInventoryItemEquippedUnusable]](<span style="font-size:smaller; color:#ecbc2a">unit, slot</span>) |
||
− | : [[API GetInventoryItemsForSlot|GetInventoryItemsForSlot]](<span style="font-size:smaller; color:#ecbc2a">slot, returnTable [, transmogrify]</span>) |
||
− | : [[API IsInventoryItemAnUpgrade|IsInventoryItemAnUpgrade]](<span style="font-size:smaller; color:#ecbc2a">unit, slot</span>) |
||
− | : UI [[API EquipmentManager_UnpackLocation|EquipmentManager_UnpackLocation]]() - Unpacks a location integer to determine the actual inventory location. |
||
− | |||
− | === Expansions === |
||
− | These functions relate to [[Expansion]]s. |
||
− | : [[API CanUpgradeExpansion|CanUpgradeExpansion]]() |
||
− | : [[API DoesCurrentLocaleSellExpansionLevels|DoesCurrentLocaleSellExpansionLevels]]() |
||
− | : [[API GetAccountExpansionLevel|GetAccountExpansionLevel]]() - Returns the highest expansion id the current account has been flagged for. |
||
− | : [[API GetClientDisplayExpansionLevel|GetClientDisplayExpansionLevel]]() |
||
− | : [[API GetExpansionDisplayInfo|GetExpansionDisplayInfo]](<span style="font-size:smaller; color:#ecbc2a">expansionLevel</span>) |
||
− | : [[API GetExpansionForLevel|GetExpansionForLevel]](<span style="font-size:smaller; color:#ecbc2a">playerLevel [, useLegacy]</span>) |
||
− | : [[API GetExpansionLevel|GetExpansionLevel]]() - Returns level of expansion currently accessible by the player. |
||
− | : [[API GetExpansionTrialInfo|GetExpansionTrialInfo]]() |
||
− | : [[API GetMaximumExpansionLevel|GetMaximumExpansionLevel]]() |
||
− | : [[API GetMaxLevelForExpansionLevel|GetMaxLevelForExpansionLevel]](<span style="font-size:smaller; color:#ecbc2a">expansionLevel</span>) |
||
− | : [[API GetMaxLevelForLatestExpansion|GetMaxLevelForLatestExpansion]]() |
||
− | : [[API GetMaxLevelForPlayerExpansion|GetMaxLevelForPlayerExpansion]]() |
||
: [[API GetMaxPlayerLevel|GetMaxPlayerLevel]]() |
: [[API GetMaxPlayerLevel|GetMaxPlayerLevel]]() |
||
− | : [[API GetMinimumExpansionLevel|GetMinimumExpansionLevel]]() |
+ | : [[API GetMinimumExpansionLevel|GetMinimumExpansionLevel]]() : <span class="apiret">expansionLevel</span> |
− | : [[API GetNumExpansions|GetNumExpansions]]() |
+ | : [[API GetNumExpansions|GetNumExpansions]]() : <span class="apiret">numExpansions</span> |
− | : [[API GetServerExpansionLevel|GetServerExpansionLevel]]() |
+ | : [[API GetServerExpansionLevel|GetServerExpansionLevel]]() : <span class="apiret">serverExpansionLevel</span> - Returns the expansion level currently active on the server. |
− | : [[API IsExpansionTrial|IsExpansionTrial]]() |
+ | : [[API IsExpansionTrial|IsExpansionTrial]]() : <span class="apiret">isExpansionTrialAccount</span> |
+ | : [[API C_LevelSquish.ConvertFollowerLevel|C_LevelSquish.ConvertFollowerLevel]](<span class="apiarg">level, maxFollowerLevel</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=== |
+ | [[Timewalking Campaigns]] scale older expansion zones up to level 50. |
||
− | : UI [[API EasyMenu|EasyMenu]](<span style="font-size:smaller; color:#ecbc2a">menuList, menuFrame, anchor, x, y, displayMode, autoHideDelay</span>) |
||
+ | : [[API C_ChromieTime.CloseUI|C_ChromieTime.CloseUI]]() |
||
− | These functions toggle the Interface Panels, but if they use {{api|ShowUIPanel}}() they can not be called in combat. |
||
+ | : [[API C_ChromieTime.GetChromieTimeExpansionOption|C_ChromieTime.GetChromieTimeExpansionOption]](<span class="apiarg">expansionRecID</span>) : <span class="apiret">info</span> |
||
− | : UI [https://www.townlong-yak.com/framexml/go/PVEFrame_ToggleFrame PVEFrame_ToggleFrame]() - Toggles the Group Finder. |
||
+ | : [[API C_ChromieTime.GetChromieTimeExpansionOptions|C_ChromieTime.GetChromieTimeExpansionOptions]]() : <span class="apiret">expansionOptions</span> |
||
− | : UI [https://www.townlong-yak.com/framexml/go/ToggleAchievementFrame ToggleAchievementFrame]() - Shows the Achievements frame. |
||
+ | : [[API C_ChromieTime.SelectChromieTimeOption|C_ChromieTime.SelectChromieTimeOption]](<span class="apiarg">chromieTimeExpansionInfoId</span>) |
||
− | : UI [[API ToggleBackpack|ToggleBackpack]]() - Toggles your backpack open/closed. |
||
+ | : [[API C_PlayerInfo.CanPlayerEnterChromieTime|C_PlayerInfo.CanPlayerEnterChromieTime]]() : <span class="apiret">canEnter</span> |
||
− | : UI [[API ToggleBag|ToggleBag]](<span style="font-size:smaller; color:#ecbc2a">bagID</span>) - Opens or closes the specified bag. |
||
+ | : [[API C_PlayerInfo.IsPlayerInChromieTime|C_PlayerInfo.IsPlayerInChromieTime]]() : <span class="apiret">inChromieTime</span> |
||
− | : UI [[API ToggleCharacter|ToggleCharacter]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Toggles the character pane to the specified frame. |
||
+ | : [[API UnitChromieTimeID|UnitChromieTimeID]](<span class="apiarg">unit</span>) : <span class="apiret">ID</span> |
||
− | : UI [https://www.townlong-yak.com/framexml/go/ToggleCollectionsJournal ToggleCollectionsJournal](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Toggles the Collections window. |
||
− | : UI [[API ToggleDropDownMenu|ToggleDropDownMenu]](<span style="font-size:smaller; color:#ecbc2a">level, value, dropDownFrame, anchorName, xOffset, yOffset</span>) |
||
− | : UI [https://www.townlong-yak.com/framexml/go/ToggleEncounterJournal ToggleEncounterJournal]() - Toggles the Adventure Guide. |
||
− | : UI [[API ToggleFriendsFrame|ToggleFriendsFrame]](<span style="font-size:smaller; color:#ecbc2a">[tabNumber]</span>) - Opens/closes the friends pane, optionally on a specific tab. |
||
− | : UI [[API ToggleGameMenu|ToggleGameMenu]]() - Opens/closes the game menu. |
||
− | : UI [https://www.townlong-yak.com/framexml/go/ToggleGuildFrame ToggleGuildFrame]() - Toggles the Guild & Communites frame. |
||
− | : UI [https://www.townlong-yak.com/framexml/go/ToggleHelpFrame ToggleHelpFrame]() - Opens the Help Request frame. |
||
− | : UI [[API ToggleMinimap|ToggleMinimap]]() - Turns the minimap display on/off. |
||
− | : UI [[API TogglePVPUI|TogglePVPUI]]() - Opens/closes the PvP frame. |
||
− | : UI [[API ToggleSpellBook|ToggleSpellBook]](<span style="font-size:smaller; color:#ecbc2a">bookType</span>) - Shows the spellbook. Can show your spells or your pet's. |
||
− | : UI [[API ToggleTalentFrame|ToggleTalentFrame]]() - Opens the Talent frame. |
||
− | == |
+ | ==Friends== |
− | + | Relates to the [[Friends list]]. |
|
− | : [[API C_FriendList.AddFriend|C_FriendList.AddFriend]](<span |
+ | : [[API C_FriendList.AddFriend|C_FriendList.AddFriend]](<span class="apiarg">name [, notes]</span>) {{apitag|noscript}} - Adds a friend to your friend list. |
− | : [[API C_FriendList.AddIgnore|C_FriendList.AddIgnore]](<span |
+ | : [[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 |
+ | : [[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.AddOrRemoveFriend|C_FriendList.AddOrRemoveFriend]](<span |
+ | : [[API C_FriendList.AddOrRemoveFriend|C_FriendList.AddOrRemoveFriend]](<span class="apiarg">name, notes</span>) - Adds or removes a player to or from the friends list. |
− | : [[API C_FriendList.DelIgnore|C_FriendList.DelIgnore]](<span |
+ | : [[API C_FriendList.DelIgnore|C_FriendList.DelIgnore]](<span class="apiarg">name</span>) : <span class="apiret">removed</span> - Removes a player from your ignore list. |
− | : [[API C_FriendList.DelIgnoreByIndex|C_FriendList.DelIgnoreByIndex]](<span |
+ | : [[API C_FriendList.DelIgnoreByIndex|C_FriendList.DelIgnoreByIndex]](<span class="apiarg">index</span>) - Removes a player from your ignore list. |
− | : [[API C_FriendList.GetFriendInfo|C_FriendList.GetFriendInfo]](<span |
+ | : [[API C_FriendList.GetFriendInfo|C_FriendList.GetFriendInfo]](<span class="apiarg">name</span>) : <span class="apiret">info</span> - Retrieves information about a person on your friends list. |
− | : [[API C_FriendList.GetFriendInfoByIndex|C_FriendList.GetFriendInfoByIndex]](<span |
+ | : [[API C_FriendList.GetFriendInfoByIndex|C_FriendList.GetFriendInfoByIndex]](<span class="apiarg">index</span>) : <span class="apiret">info</span> - Retrieves information about a person on your friends list. |
− | : [[API C_FriendList.GetIgnoreName|C_FriendList.GetIgnoreName]](<span |
+ | : [[API C_FriendList.GetIgnoreName|C_FriendList.GetIgnoreName]](<span class="apiarg">index</span>) : <span class="apiret">name</span> - Returns the name of a currently ignored player. |
− | : [[API C_FriendList.GetNumFriends|C_FriendList.GetNumFriends]]() - Returns how many friends you have. |
+ | : [[API C_FriendList.GetNumFriends|C_FriendList.GetNumFriends]]() : <span class="apiret">numFriends</span> - Returns how many friends you have. |
− | : [[API C_FriendList.GetNumIgnores|C_FriendList.GetNumIgnores]]() - Returns the number of entries on your ignore list. |
+ | : [[API C_FriendList.GetNumIgnores|C_FriendList.GetNumIgnores]]() : <span class="apiret">numIgnores</span> - Returns the number of entries on your ignore list. |
− | : [[API C_FriendList.GetNumOnlineFriends|C_FriendList.GetNumOnlineFriends]]() - Returns the number of online friends. |
+ | : [[API C_FriendList.GetNumOnlineFriends|C_FriendList.GetNumOnlineFriends]]() : <span class="apiret">numOnline</span> - Returns the number of online friends. |
− | : [[API C_FriendList.GetSelectedFriend|C_FriendList.GetSelectedFriend]]() - Returns the index of the currently selected friend. |
+ | : [[API C_FriendList.GetSelectedFriend|C_FriendList.GetSelectedFriend]]() : <span class="apiret">index</span> - Returns the index of the currently selected friend. |
− | : [[API C_FriendList.GetSelectedIgnore|C_FriendList.GetSelectedIgnore]]() - Returns the currently selected index in the ignore listing. |
+ | : [[API C_FriendList.GetSelectedIgnore|C_FriendList.GetSelectedIgnore]]() : <span class="apiret">index</span> - Returns the currently selected index in the ignore listing. |
− | : [[API C_FriendList.IsFriend|C_FriendList.IsFriend]](<span |
+ | : [[API C_FriendList.IsFriend|C_FriendList.IsFriend]](<span class="apiarg">guid</span>) : <span class="apiret">isFriend</span> - Returns whether a character is your friend. |
− | : [[API C_FriendList.IsIgnored|C_FriendList.IsIgnored]](<span |
+ | : [[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 |
+ | : [[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. |
+ | : [[API C_FriendList.IsOnIgnoredList|C_FriendList.IsOnIgnoredList]](<span class="apiarg">token</span>) : <span class="apiret">isIgnored</span> |
− | : [[API C_FriendList. |
+ | : [[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. |
+ | : [[API C_FriendList.RemoveFriendByIndex|C_FriendList.RemoveFriendByIndex]](<span class="apiarg">index</span>) - Removes a friend from the friends list. |
− | : [[API C_FriendList. |
+ | : [[API C_FriendList.SetFriendNotes|C_FriendList.SetFriendNotes]](<span class="apiarg">name, notes</span>) : <span class="apiret">found</span> - Sets the note text for a friend. |
− | : [[API C_FriendList. |
+ | : [[API C_FriendList.SetFriendNotesByIndex|C_FriendList.SetFriendNotesByIndex]](<span class="apiarg">index, notes</span>) - Sets the note text for a friend. |
− | : [[API C_FriendList. |
+ | : [[API C_FriendList.SetSelectedFriend|C_FriendList.SetSelectedFriend]](<span class="apiarg">index</span>) - Updates the current selected friend. |
+ | : [[API C_FriendList.SetSelectedIgnore|C_FriendList.SetSelectedIgnore]](<span class="apiarg">index</span>) - Sets the currently selected ignore entry. |
||
: [[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=== |
− | + | Relates to the [[Who List]]. |
|
− | : [[API C_FriendList.GetNumWhoResults|C_FriendList.GetNumWhoResults]]() - 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 |
+ | : [[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.SendWho|C_FriendList.SendWho]](<span class="apiarg">filter</span>) {{apitag|hwevent}} - Requests a list of other online players. |
− | : [[API C_FriendList.SetWhoToUi|C_FriendList.SetWhoToUi]](<span |
+ | : [[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 |
+ | : [[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=== |
− | [[Real ID]] friends were added in [[Patch 3.3.5]] |
+ | [[Real ID]] friends were added in [[Patch 3.3.5]] |
+ | : [[API C_BattleNet.GetFriendAccountInfo|C_BattleNet.GetFriendAccountInfo]](<span class="apiarg">friendIndex [, wowAccountGUID]</span>) : <span class="apiret">accountInfo</span> - Returns information about a Battle.net friend account. |
||
− | : [[API C_AccountInfo.GetIDFromBattleNetAccountGUID|C_AccountInfo.GetIDFromBattleNetAccountGUID]](<span style="font-size:smaller; color:#ecbc2a">battleNetAccountGUID</span>) - Converts a battle.net account GUID to battle.net ID. |
||
+ | : [[API C_BattleNet.GetAccountInfoByID|C_BattleNet.GetAccountInfoByID]](<span class="apiarg">id [, wowAccountGUID]</span>) : <span class="apiret">accountInfo</span> |
||
− | : [[API C_AccountInfo.IsGUIDBattleNetAccountType|C_AccountInfo.IsGUIDBattleNetAccountType]](<span style="font-size:smaller; color:#ecbc2a">guid</span>) - Returns whether a GUID is a batle.net account type. |
||
+ | : [[API C_BattleNet.GetAccountInfoByGUID|C_BattleNet.GetAccountInfoByGUID]](<span class="apiarg">guid</span>) : <span class="apiret">accountInfo</span> |
||
− | : [[API C_AccountInfo.IsGUIDRelatedToLocalAccount|C_AccountInfo.IsGUIDRelatedToLocalAccount]](<span style="font-size:smaller; color:#ecbc2a">guid</span>) - Returns whether a GUID is related to the local (self) account. |
||
− | : [[API C_BattleNet. |
+ | : [[API C_BattleNet.GetFriendGameAccountInfo|C_BattleNet.GetFriendGameAccountInfo]](<span class="apiarg">friendIndex, accountIndex</span>) : <span class="apiret">gameAccountInfo</span> - Returns information on the game the Battle.net friend is playing. |
− | : [[API C_BattleNet. |
+ | : [[API C_BattleNet.GetGameAccountInfoByID|C_BattleNet.GetGameAccountInfoByID]](<span class="apiarg">id</span>) : <span class="apiret">gameAccountInfo</span> |
− | : [[API C_BattleNet. |
+ | : [[API C_BattleNet.GetGameAccountInfoByGUID|C_BattleNet.GetGameAccountInfoByGUID]](<span class="apiarg">guid</span>) : <span class="apiret">gameAccountInfo</span> |
− | : [[API C_BattleNet. |
+ | : [[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_BattleNet.GetFriendNumGameAccounts|C_BattleNet.GetFriendNumGameAccounts]](<span style="font-size:smaller; color:#ecbc2a">friendIndex</span>) - Returns the Battle.net friend's number of toons. |
||
+ | : [[API C_AccountInfo.IsGUIDBattleNetAccountType|C_AccountInfo.IsGUIDBattleNetAccountType]](<span class="apiarg">guid</span>) : <span class="apiret">isBNet</span> |
||
− | : [[API C_BattleNet.GetGameAccountInfoByID|C_BattleNet.GetGameAccountInfoByID]](<span style="font-size:smaller; color:#ecbc2a">id</span>) - Returns information about the toon of a Battle.net friend. |
||
+ | : [[API C_AccountInfo.IsGUIDRelatedToLocalAccount|C_AccountInfo.IsGUIDRelatedToLocalAccount]](<span class="apiarg">guid</span>) : <span class="apiret">isLocalUser</span> |
||
− | : [[API C_BattleNet.GetGameAccountInfoByGUID|C_BattleNet.GetGameAccountInfoByGUID]](<span style="font-size:smaller; color:#ecbc2a">guid</span>) |
||
+ | : [[API BNAcceptFriendInvite|BNAcceptFriendInvite]](<span class="apiarg">ID</span>) |
||
− | : DEPRECATED (8.2.5) [[API BNGetFriendGameAccountInfo|BNGetFriendGameAccountInfo]](<span style="font-size:smaller; color:#ecbc2a">bnetIDGameAccount</span>) |
||
+ | : [[API BNCheckBattleTagInviteToGuildMember|BNCheckBattleTagInviteToGuildMember]](<span class="apiarg">fullname</span>) |
||
− | : DEPRECATED (8.2.5) [[API BNGetFriendInfo|BNGetFriendInfo]](<span style="font-size:smaller; color:#ecbc2a">friendIndex</span>) |
||
+ | : [[API BNCheckBattleTagInviteToUnit|BNCheckBattleTagInviteToUnit]](<span class="apiarg">unit</span>) |
||
− | : DEPRECATED (8.2.5) [[API BNGetFriendInfoByID|BNGetFriendInfoByID]](<span style="font-size:smaller; color:#ecbc2a">presenceID</span>) |
||
+ | : [[API BNConnected|BNConnected]]() - Returns true if the WoW Client is connected to Battle.net. |
||
− | : DEPRECATED (8.2.5) [[API BNGetGameAccountInfo|BNGetGameAccountInfo]](<span style="font-size:smaller; color:#ecbc2a">bnetIDGameAccount</span>) |
||
− | : |
+ | : [[API BNDeclineFriendInvite|BNDeclineFriendInvite]](<span class="apiarg">ID</span>) |
− | : DEPRECATED (8.2.5) [[API BNGetNumFriendGameAccounts|BNGetNumFriendGameAccounts]](<span style="font-size:smaller; color:#ecbc2a">friendIndex</span>) |
||
− | : [[API BNAcceptFriendInvite|BNAcceptFriendInvite]](<span style="font-size:smaller; color:#ecbc2a">ID</span>) |
||
− | : [[API BNCheckBattleTagInviteToGuildMember|BNCheckBattleTagInviteToGuildMember]](<span style="font-size:smaller; color:#ecbc2a">fullname</span>) |
||
− | : [[API BNCheckBattleTagInviteToUnit|BNCheckBattleTagInviteToUnit]](<span style="font-size:smaller; color:#ecbc2a">unit</span>) |
||
− | : [[API BNConnected|BNConnected]]() - Returns whether your battle.net state is connected. |
||
− | : [[API BNDeclineFriendInvite|BNDeclineFriendInvite]](<span style="font-size:smaller; color:#ecbc2a">ID</span>) |
||
: [[API BNFeaturesEnabledAndConnected|BNFeaturesEnabledAndConnected]]() |
: [[API BNFeaturesEnabledAndConnected|BNFeaturesEnabledAndConnected]]() |
||
: [[API BNFeaturesEnabled|BNFeaturesEnabled]]() |
: [[API BNFeaturesEnabled|BNFeaturesEnabled]]() |
||
− | : [[API BNGetBlockedInfo|BNGetBlockedInfo]](<span |
+ | : [[API BNGetBlockedInfo|BNGetBlockedInfo]](<span class="apiarg">index</span>) |
− | : [[API BNGetDisplayName|BNGetDisplayName]](<span |
+ | : [[API BNGetDisplayName|BNGetDisplayName]](<span class="apiarg">bnetIdAccount</span>) |
− | : [[API BNGetFOFInfo|BNGetFOFInfo]](<span |
+ | : [[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 |
+ | : [[API BNGetFriendIndex|BNGetFriendIndex]](<span class="apiarg">presenceID</span>) |
− | : [[API BNGetFriendInviteInfo|BNGetFriendInviteInfo]](<span |
+ | : [[API BNGetFriendInviteInfo|BNGetFriendInviteInfo]](<span class="apiarg">menuValue</span>) - Returns info for a Battle.net friend invite. |
− | : [[API BNGetInfo|BNGetInfo]]() - Returns own |
+ | : [[API BNGetInfo|BNGetInfo]]() - Returns the player's own Battle.net info. |
: [[API BNGetNumBlocked|BNGetNumBlocked]]() |
: [[API BNGetNumBlocked|BNGetNumBlocked]]() |
||
− | : [[API BNGetNumFOF|BNGetNumFOF]](<span |
+ | : [[API BNGetNumFOF|BNGetNumFOF]](<span class="apiarg">ID, mutual, non</span>) |
: [[API BNGetNumFriendInvites|BNGetNumFriendInvites]]() |
: [[API BNGetNumFriendInvites|BNGetNumFriendInvites]]() |
||
− | : [[API BNGetNumFriends|BNGetNumFriends]]() - Returns |
+ | : [[API BNGetNumFriends|BNGetNumFriends]]() - Returns the amount of (online) Battle.net friends. |
: [[API BNGetSelectedBlock|BNGetSelectedBlock]]() |
: [[API BNGetSelectedBlock|BNGetSelectedBlock]]() |
||
: [[API BNGetSelectedFriend|BNGetSelectedFriend]]() |
: [[API BNGetSelectedFriend|BNGetSelectedFriend]]() |
||
− | : [[API BNInviteFriend|BNInviteFriend]](<span |
+ | : [[API BNInviteFriend|BNInviteFriend]](<span class="apiarg">bnetIDGameAccount</span>) |
− | : [[API BNIsBlocked|BNIsBlocked]](<span |
+ | : [[API BNIsBlocked|BNIsBlocked]](<span class="apiarg">ID</span>) |
− | : [[API BNIsFriend|BNIsFriend]](<span |
+ | : [[API BNIsFriend|BNIsFriend]](<span class="apiarg">presenceID</span>) |
− | : [[API BNIsSelf|BNIsSelf]](<span |
+ | : [[API BNIsSelf|BNIsSelf]](<span class="apiarg">presenceID</span>) - Returns true if the specified presenceID is your own, false otherwise. |
− | : [[API BNRemoveFriend|BNRemoveFriend]](<span |
+ | : [[API BNRemoveFriend|BNRemoveFriend]](<span class="apiarg">ID</span>) |
− | : [[API BNRequestFOFInfo|BNRequestFOFInfo]](<span |
+ | : [[API BNRequestFOFInfo|BNRequestFOFInfo]](<span class="apiarg">bnetIDAccount</span>) |
− | : [[API BNRequestInviteFriend|BNRequestInviteFriend]](<span |
+ | : [[API BNRequestInviteFriend|BNRequestInviteFriend]](<span class="apiarg">presenceID [, tank, heal, dps]</span>) |
− | : [[API BNSendFriendInviteByID|BNSendFriendInviteByID]](<span |
+ | : [[API BNSendFriendInviteByID|BNSendFriendInviteByID]](<span class="apiarg">ID, noteText</span>) |
− | : [[API BNSendFriendInvite|BNSendFriendInvite]](<span |
+ | : [[API BNSendFriendInvite|BNSendFriendInvite]](<span class="apiarg">text, noteText</span>) |
− | : [[API BNSendGameData|BNSendGameData]](<span |
+ | : [[API BNSendGameData|BNSendGameData]](<span class="apiarg">id, addonPrefix, text</span>) - Sends an addon comm message to a Battle.net friend. |
− | : [[API BNSendSoR|BNSendSoR]](<span style="font-size:smaller; color:#ecbc2a">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 |
+ | : [[API BNSendWhisper|BNSendWhisper]](<span class="apiarg">id, text</span>) |
− | : [[API BNSetAFK|BNSetAFK]](<span |
+ | : [[API BNSetAFK|BNSetAFK]](<span class="apiarg">bool</span>) - Sets the player's online AFK status. |
− | : [[API BNSetBlocked|BNSetBlocked]](<span |
+ | : [[API BNSetBlocked|BNSetBlocked]](<span class="apiarg">ID, bool</span>) |
− | : [[API BNSetCustomMessage|BNSetCustomMessage]](<span |
+ | : [[API BNSetCustomMessage|BNSetCustomMessage]](<span class="apiarg">text</span>) |
− | : [[API BNSetDND|BNSetDND]](<span |
+ | : [[API BNSetDND|BNSetDND]](<span class="apiarg">bool</span>) - Sets the player's online DND status. |
− | : [[API BNSetFriendFavoriteFlag|BNSetFriendFavoriteFlag]](<span |
+ | : [[API BNSetFriendFavoriteFlag|BNSetFriendFavoriteFlag]](<span class="apiarg">id, isFavorite</span>) - Favorites a Battle.net friend. |
− | : [[API BNSetFriendNote|BNSetFriendNote]](<span |
+ | : [[API BNSetFriendNote|BNSetFriendNote]](<span class="apiarg">ID, noteText</span>) |
− | : [[API BNSetSelectedBlock|BNSetSelectedBlock]](<span |
+ | : [[API BNSetSelectedBlock|BNSetSelectedBlock]](<span class="apiarg">index</span>) |
− | : [[API BNSetSelectedFriend|BNSetSelectedFriend]](<span |
+ | : [[API BNSetSelectedFriend|BNSetSelectedFriend]](<span class="apiarg">index</span>) |
− | : [[API BNSummonFriendByIndex|BNSummonFriendByIndex]](<span |
+ | : [[API BNSummonFriendByIndex|BNSummonFriendByIndex]](<span class="apiarg">id</span>) |
− | : [[API BNTokenFindName|BNTokenFindName]](<span |
+ | : [[API BNTokenFindName|BNTokenFindName]](<span class="apiarg">target</span>) |
− | : [[API GetAutoCompletePresenceID|GetAutoCompletePresenceID]](<span |
+ | : [[API GetAutoCompletePresenceID|GetAutoCompletePresenceID]](<span class="apiarg">name</span>) |
: [[API IsBNLogin|IsBNLogin]]() |
: [[API IsBNLogin|IsBNLogin]]() |
||
− | === |
+ | ===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 |
+ | : [[API C_RecruitAFriend.ClaimActivityReward|C_RecruitAFriend.ClaimActivityReward]](<span class="apiarg">activityID, acceptanceID</span>) : <span class="apiret">success</span> |
− | : [[API C_RecruitAFriend.ClaimNextReward|C_RecruitAFriend.ClaimNextReward]]() |
+ | : [[API C_RecruitAFriend.ClaimNextReward|C_RecruitAFriend.ClaimNextReward]](<span class="apiarg">[rafVersion]</span>) : <span class="apiret">success</span> |
− | : [[API C_RecruitAFriend.GenerateRecruitmentLink|C_RecruitAFriend.GenerateRecruitmentLink]]() |
+ | : [[API C_RecruitAFriend.GenerateRecruitmentLink|C_RecruitAFriend.GenerateRecruitmentLink]]() : <span class="apiret">success</span> |
− | : [[API C_RecruitAFriend.GetRAFInfo|C_RecruitAFriend.GetRAFInfo]]() |
+ | : [[API C_RecruitAFriend.GetRAFInfo|C_RecruitAFriend.GetRAFInfo]]() : <span class="apiret">info</span> |
− | : [[API C_RecruitAFriend.GetRAFSystemInfo|C_RecruitAFriend.GetRAFSystemInfo]]() |
+ | : [[API C_RecruitAFriend.GetRAFSystemInfo|C_RecruitAFriend.GetRAFSystemInfo]]() : <span class="apiret">systemInfo</span> |
− | : [[API C_RecruitAFriend.GetRecruitActivityRequirementsText|C_RecruitAFriend.GetRecruitActivityRequirementsText]](<span |
+ | : [[API C_RecruitAFriend.GetRecruitActivityRequirementsText|C_RecruitAFriend.GetRecruitActivityRequirementsText]](<span class="apiarg">activityID, acceptanceID</span>) : <span class="apiret">requirementsText</span> |
− | : [[API C_RecruitAFriend.GetRecruitInfo|C_RecruitAFriend.GetRecruitInfo]]() |
+ | : [[API C_RecruitAFriend.GetRecruitInfo|C_RecruitAFriend.GetRecruitInfo]]() : <span class="apiret">active, faction</span> |
− | : [[API C_RecruitAFriend.IsEnabled|C_RecruitAFriend.IsEnabled]]() |
+ | : [[API C_RecruitAFriend.IsEnabled|C_RecruitAFriend.IsEnabled]]() : <span class="apiret">enabled</span> |
− | : [[API C_RecruitAFriend.IsRecruitingEnabled|C_RecruitAFriend.IsRecruitingEnabled]]() |
+ | : [[API C_RecruitAFriend.IsRecruitingEnabled|C_RecruitAFriend.IsRecruitingEnabled]]() : <span class="apiret">enabled</span> |
− | : [[API C_RecruitAFriend.RemoveRAFRecruit|C_RecruitAFriend.RemoveRAFRecruit]](<span |
+ | : [[API C_RecruitAFriend.RemoveRAFRecruit|C_RecruitAFriend.RemoveRAFRecruit]](<span class="apiarg">wowAccountGUID</span>) : <span class="apiret">success</span> |
− | : [[API C_RecruitAFriend.RequestUpdatedRecruitmentInfo|C_RecruitAFriend.RequestUpdatedRecruitmentInfo]]() |
+ | : [[API C_RecruitAFriend.RequestUpdatedRecruitmentInfo|C_RecruitAFriend.RequestUpdatedRecruitmentInfo]]() : <span class="apiret">success</span> |
− | : [[API CanSummonFriend|CanSummonFriend]](<span |
+ | : [[API CanSummonFriend|CanSummonFriend]](<span class="apiarg">unit</span>) - Returns whether you can RaF summon a particular unit. |
− | : [[API GetSummonFriendCooldown|GetSummonFriendCooldown]]() - Returns the cooldown |
+ | : [[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 |
+ | : [[API SummonFriend|SummonFriend]](<span class="apiarg">unit</span>) - Summons a player using the RaF 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]]() |
+ | : [[API C_PlayerMentorship.GetMentorLevelRequirement|C_PlayerMentorship.GetMentorLevelRequirement]]() : <span class="apiret">level</span> |
− | : [[API C_PlayerMentorship. |
+ | : [[API C_PlayerMentorship.GetMentorRequirements|C_PlayerMentorship.GetMentorRequirements]]() : <span class="apiret">achievementIDs, optionalAchievementIDs, optionalCompleteAtLeastCount</span> |
− | : [[API C_PlayerMentorship.GetMentorshipStatus|C_PlayerMentorship.GetMentorshipStatus]](<span |
+ | : [[API C_PlayerMentorship.GetMentorshipStatus|C_PlayerMentorship.GetMentorshipStatus]](<span class="apiarg">playerLocation</span>) : <span class="apiret">status</span> |
− | : [[API C_PlayerMentorship.IsActivePlayerConsideredNewcomer|C_PlayerMentorship.IsActivePlayerConsideredNewcomer]]() |
+ | : [[API C_PlayerMentorship.IsActivePlayerConsideredNewcomer|C_PlayerMentorship.IsActivePlayerConsideredNewcomer]]() : <span class="apiret">isConsideredNewcomer</span> |
− | : [[API C_PlayerMentorship.IsMentorRestricted|C_PlayerMentorship.IsMentorRestricted]]() |
+ | : [[API C_PlayerMentorship.IsMentorRestricted|C_PlayerMentorship.IsMentorRestricted]]() : <span class="apiret">isRestricted</span> |
− | |||
− | === Gamepad === |
||
− | The Gamepad API was added in [[Patch 9.0.1]], where previously [https://github.com/topher-au/WoWmapper WoWmapper] was needed. |
||
− | : [[API C_GamePad.ApplyConfigs|C_GamePad.ApplyConfigs]]() |
||
− | : [[API C_GamePad.AxisIndexToConfigName|C_GamePad.AxisIndexToConfigName]](<span style="font-size:smaller; color:#ecbc2a">axisIndex</span>) |
||
− | : [[API C_GamePad.ButtonBindingToIndex|C_GamePad.ButtonBindingToIndex]](<span style="font-size:smaller; color:#ecbc2a">bindingName</span>) |
||
− | : [[API C_GamePad.ButtonIndexToBinding|C_GamePad.ButtonIndexToBinding]](<span style="font-size:smaller; color:#ecbc2a">buttonIndex</span>) |
||
− | : [[API C_GamePad.ButtonIndexToConfigName|C_GamePad.ButtonIndexToConfigName]](<span style="font-size:smaller; color:#ecbc2a">buttonIndex</span>) |
||
− | : [[API C_GamePad.DeleteConfig|C_GamePad.DeleteConfig]](<span style="font-size:smaller; color:#ecbc2a">configID</span>) |
||
− | : [[API C_GamePad.GetActiveDeviceID|C_GamePad.GetActiveDeviceID]]() |
||
− | : [[API C_GamePad.GetAllConfigIDs|C_GamePad.GetAllConfigIDs]]() |
||
− | : [[API C_GamePad.GetAllDeviceIDs|C_GamePad.GetAllDeviceIDs]]() |
||
− | : [[API C_GamePad.GetCombinedDeviceID|C_GamePad.GetCombinedDeviceID]]() |
||
− | : [[API C_GamePad.GetConfig|C_GamePad.GetConfig]](<span style="font-size:smaller; color:#ecbc2a">configID</span>) |
||
− | : [[API C_GamePad.GetDeviceMappedState|C_GamePad.GetDeviceMappedState]](<span style="font-size:smaller; color:#ecbc2a">[deviceID]</span>) |
||
− | : [[API C_GamePad.GetDeviceRawState|C_GamePad.GetDeviceRawState]](<span style="font-size:smaller; color:#ecbc2a">deviceID</span>) |
||
− | : [[API C_GamePad.IsEnabled|C_GamePad.IsEnabled]]() |
||
− | : [[API C_GamePad.SetConfig|C_GamePad.SetConfig]](<span style="font-size:smaller; color:#ecbc2a">config</span>) |
||
− | : [[API C_GamePad.StickIndexToConfigName|C_GamePad.StickIndexToConfigName]](<span style="font-size:smaller; color:#ecbc2a">stickIndex</span>) |
||
− | : [[API CanAutoSetGamePadCursorControl|CanAutoSetGamePadCursorControl]]() |
||
− | : [[API CanGamePadControlCursor|CanGamePadControlCursor]]() |
||
− | : [[API IsBindingForGamePad|IsBindingForGamePad]](<span style="font-size:smaller; color:#ecbc2a">KEY</span>) |
||
− | : [[API IsGamePadCursorControlEnabled|IsGamePadCursorControlEnabled]]() |
||
− | : [[API IsGamePadFreelookEnabled|IsGamePadFreelookEnabled]]() |
||
− | : [[API SetGamePadCursorControl|SetGamePadCursorControl]]() |
||
− | : [[API SetGamePadFreeLook|SetGamePadFreeLook]]() |
||
− | == |
+ | ==Groups== |
− | : [[API C_PartyInfo.AllowedToDoPartyConversion|C_PartyInfo.AllowedToDoPartyConversion]](<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]]() |
+ | : [[API C_PartyInfo.CanInvite|C_PartyInfo.CanInvite]]() : <span class="apiret">allowedToInvite</span> |
: [[API C_PartyInfo.ConfirmConvertToRaid|C_PartyInfo.ConfirmConvertToRaid]]() |
: [[API C_PartyInfo.ConfirmConvertToRaid|C_PartyInfo.ConfirmConvertToRaid]]() |
||
− | : [[API C_PartyInfo.ConfirmInviteTravelPass|C_PartyInfo.ConfirmInviteTravelPass]](<span |
+ | : [[API C_PartyInfo.ConfirmInviteTravelPass|C_PartyInfo.ConfirmInviteTravelPass]](<span class="apiarg">targetName, targetGUID</span>) |
− | : [[API C_PartyInfo.ConfirmInviteUnit|C_PartyInfo.ConfirmInviteUnit]](<span |
+ | : [[API C_PartyInfo.ConfirmInviteUnit|C_PartyInfo.ConfirmInviteUnit]](<span class="apiarg">targetName</span>) |
− | : [[API C_PartyInfo.ConfirmLeaveParty|C_PartyInfo.ConfirmLeaveParty]](<span |
+ | : [[API C_PartyInfo.ConfirmLeaveParty|C_PartyInfo.ConfirmLeaveParty]](<span class="apiarg">[category]</span>) |
: [[API C_PartyInfo.ConvertToParty|C_PartyInfo.ConvertToParty]]() - Converts a raid group with 5 or less members to a party. |
: [[API C_PartyInfo.ConvertToParty|C_PartyInfo.ConvertToParty]]() - Converts a raid group with 5 or less members to a party. |
||
: [[API C_PartyInfo.ConvertToRaid|C_PartyInfo.ConvertToRaid]]() - Converts a party to a raid. |
: [[API C_PartyInfo.ConvertToRaid|C_PartyInfo.ConvertToRaid]]() - Converts a party to a raid. |
||
− | : [[API C_PartyInfo.DoCountdown|C_PartyInfo.DoCountdown]](<span |
+ | : [[API C_PartyInfo.DoCountdown|C_PartyInfo.DoCountdown]](<span class="apiarg">seconds</span>) |
− | : [[API C_PartyInfo.GetMinLevel|C_PartyInfo.GetMinLevel]](<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 |
+ | : [[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 |
+ | : [[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 |
+ | : [[API C_PartyInfo.LeaveParty|C_PartyInfo.LeaveParty]](<span class="apiarg">[category]</span>) - Leaves the group. |
− | : [[API AcceptGroup|AcceptGroup]]() - |
+ | : [[API AcceptGroup|AcceptGroup]]() - Accepts the invitation from a group. |
− | : [[API ConfirmReadyCheck|ConfirmReadyCheck]](<span |
+ | : [[API ConfirmReadyCheck|ConfirmReadyCheck]](<span class="apiarg">isReady</span>) - Responds to a ready check. |
− | : [[API DeclineGroup|DeclineGroup]]() - |
+ | : [[API DeclineGroup|DeclineGroup]]() - Declines an invitation to a group. |
− | : [[API DoReadyCheck|DoReadyCheck]]() - |
+ | : [[API DoReadyCheck|DoReadyCheck]]() - Initiates a ready check. |
: [[API GetHomePartyInfo|GetHomePartyInfo]]() |
: [[API GetHomePartyInfo|GetHomePartyInfo]]() |
||
− | : [[API GetInviteConfirmationInfo|GetInviteConfirmationInfo]](<span |
+ | : [[API GetInviteConfirmationInfo|GetInviteConfirmationInfo]](<span class="apiarg">guid</span>) |
: [[API GetNextPendingInviteConfirmation|GetNextPendingInviteConfirmation]]() |
: [[API GetNextPendingInviteConfirmation|GetNextPendingInviteConfirmation]]() |
||
− | : [[API GetNumGroupMembers|GetNumGroupMembers]](<span |
+ | : [[API GetNumGroupMembers|GetNumGroupMembers]](<span class="apiarg">[groupType]</span>) - Returns the number of players in the group. |
− | : [[API GetNumSubgroupMembers|GetNumSubgroupMembers]](<span |
+ | : [[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 |
+ | : [[API GetReadyCheckStatus|GetReadyCheckStatus]](<span class="apiarg">unit</span>) - Returns a group member's response to the current ready check. |
: [[API GetReadyCheckTimeLeft|GetReadyCheckTimeLeft]]() |
: [[API GetReadyCheckTimeLeft|GetReadyCheckTimeLeft]]() |
||
: [[API InGuildParty|InGuildParty]]() |
: [[API InGuildParty|InGuildParty]]() |
||
− | : [[API IsGUIDInGroup|IsGUIDInGroup]](<span |
+ | : [[API IsGUIDInGroup|IsGUIDInGroup]](<span class="apiarg">guid [, groupType]</span>) |
− | : [[API IsInGroup|IsInGroup]](<span |
+ | : [[API IsInGroup|IsInGroup]](<span class="apiarg">[groupType]</span>) - Returns true if the player is in a group. |
: [[API IsInGuildGroup|IsInGuildGroup]]() |
: [[API IsInGuildGroup|IsInGuildGroup]]() |
||
− | : [[API IsInRaid|IsInRaid]](<span |
+ | : [[API IsInRaid|IsInRaid]](<span class="apiarg">[groupType]</span>) - Returns true if the player is in a raid. |
− | : [[API PromoteToLeader|PromoteToLeader]](<span |
+ | : [[API PromoteToLeader|PromoteToLeader]](<span class="apiarg">unit</span>) - Promotes a unit to group leader. |
− | : [[API RespondToInviteConfirmation|RespondToInviteConfirmation]](<span |
+ | : [[API RespondToInviteConfirmation|RespondToInviteConfirmation]](<span class="apiarg">guid, accept</span>) |
− | : |
+ | : [[API UninviteUnit|UninviteUnit]](<span class="apiarg">name [, reason]</span>) {{apitag|hwevent}} - Removes a player from the group if you're the leader, or initiates a vote to kick. |
− | : [[API UnitInAnyGroup|UnitInAnyGroup]]() |
+ | : [[API UnitInAnyGroup|UnitInAnyGroup]](unit) |
− | : [[API UnitInParty|UnitInParty]](<span |
+ | : [[API UnitInParty|UnitInParty]](<span class="apiarg">unit</span>) - Returns true if the unit is a member of your party. |
− | : [[API UnitIsGroupLeader|UnitIsGroupLeader]](<span |
+ | : [[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=== |
: [[API ClearPartyAssignment|ClearPartyAssignment]]() |
: [[API ClearPartyAssignment|ClearPartyAssignment]]() |
||
− | : [[API DemoteAssistant|DemoteAssistant]](<span |
+ | : [[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 |
+ | : [[API GetPartyAssignment|GetPartyAssignment]](<span class="apiarg">assignment [, unit, exactMatch]</span>) - Returns true if a group member is assigned the main tank/assist role. |
− | : [[API GetRaidRosterInfo|GetRaidRosterInfo]](<span |
+ | : [[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]]() |
||
− | : [[API PromoteToAssistant|PromoteToAssistant]](<span |
+ | : [[API PromoteToAssistant|PromoteToAssistant]](<span class="apiarg">unit</span>) - Promotes player to assistant status. Requires raid leadership. |
− | : [[API SetAllowLowLevelRaid|SetAllowLowLevelRaid]](<span |
+ | : [[API SetAllowLowLevelRaid|SetAllowLowLevelRaid]](<span class="apiarg">allowed</span>) - Controls whether the current character can join low-level raids. |
: [[API SetEveryoneIsAssistant|SetEveryoneIsAssistant]]() |
: [[API SetEveryoneIsAssistant|SetEveryoneIsAssistant]]() |
||
− | : |
+ | : [[API SetPartyAssignment|SetPartyAssignment]](<span class="apiarg">assignment, player</span>) {{apitag|protected}} |
− | : [[API SetRaidSubgroup|SetRaidSubgroup]](<span |
+ | : [[API SetRaidSubgroup|SetRaidSubgroup]](<span class="apiarg">index, subgroup</span>) {{apitag|nocombat}} - Move a raid member from his current subgroup into a different (non-full) subgroup. |
− | : |
+ | : [[API SwapRaidSubgroup|SwapRaidSubgroup]](<span class="apiarg">index1, index2</span>) {{apitag|nocombat}} - Swaps two raid members into different groups. |
− | : [[API UnitInRaid|UnitInRaid]](<span |
+ | : [[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. |
|
− | : [[API CanBeRaidTarget|CanBeRaidTarget]](<span |
+ | : [[API CanBeRaidTarget|CanBeRaidTarget]](<span class="apiarg">unit</span>) - Returns true if the unit can be marked with a raid target icon. |
− | : [[API ClearRaidMarker|ClearRaidMarker]](<span |
+ | : [[API ClearRaidMarker|ClearRaidMarker]](<span class="apiarg">index</span>) - Removes a raid marker from the world. |
− | : [[API GetRaidTargetIndex|GetRaidTargetIndex]](<span |
+ | : [[API GetRaidTargetIndex|GetRaidTargetIndex]](<span class="apiarg">unit</span>) - Returns the [[Target marker|raid target]] of a unit. |
− | : [[API IsRaidMarkerActive|IsRaidMarkerActive]](<span |
+ | : [[API IsRaidMarkerActive|IsRaidMarkerActive]](<span class="apiarg">index</span>) - Returns whether or not the raid marker specified by index is active. |
− | : |
+ | : [[API PlaceRaidMarker|PlaceRaidMarker]](<span class="apiarg">index</span>) {{apitag|protected}} - Brings up a targeting circle to place a raid marker in the world. |
− | : [[API SetRaidTarget|SetRaidTarget]](<span |
+ | : [[API SetRaidTarget|SetRaidTarget]](<span class="apiarg">unit, index</span>) - Assigns a [[Target marker|raid target]] icon to a unit. |
− | : [[API SetRaidTargetProtected|SetRaidTargetProtected]](<span |
+ | : [[API SetRaidTargetProtected|SetRaidTargetProtected]](<span class="apiarg">unit, index</span>) |
− | : |
+ | : [[API SetRaidTargetIcon|SetRaidTargetIcon]](<span class="apiarg">unit, index</span>) {{apitag|framexml}} - Sets or resets a raid icon on a unit. |
Raid Profiles |
Raid Profiles |
||
− | : [[API CreateNewRaidProfile|CreateNewRaidProfile]](<span |
+ | : [[API CreateNewRaidProfile|CreateNewRaidProfile]](<span class="apiarg">name [, baseOnProfile]</span>) |
− | : [[API DeleteRaidProfile|DeleteRaidProfile]](<span |
+ | : [[API DeleteRaidProfile|DeleteRaidProfile]](<span class="apiarg">profile</span>) |
: [[API GetMaxNumCUFProfiles|GetMaxNumCUFProfiles]]() |
: [[API GetMaxNumCUFProfiles|GetMaxNumCUFProfiles]]() |
||
: [[API GetNumRaidProfiles|GetNumRaidProfiles]]() |
: [[API GetNumRaidProfiles|GetNumRaidProfiles]]() |
||
− | : [[API GetRaidProfileFlattenedOptions|GetRaidProfileFlattenedOptions]](<span |
+ | : [[API GetRaidProfileFlattenedOptions|GetRaidProfileFlattenedOptions]](<span class="apiarg">profile</span>) |
− | : [[API GetRaidProfileName|GetRaidProfileName]](<span |
+ | : [[API GetRaidProfileName|GetRaidProfileName]](<span class="apiarg">index</span>) |
− | : [[API GetRaidProfileOption|GetRaidProfileOption]](<span |
+ | : [[API GetRaidProfileOption|GetRaidProfileOption]](<span class="apiarg">profile, optionName</span>) |
− | : [[API GetRaidProfileSavedPosition|GetRaidProfileSavedPosition]](<span |
+ | : [[API GetRaidProfileSavedPosition|GetRaidProfileSavedPosition]](<span class="apiarg">profile</span>) |
: [[API HasLoadedCUFProfiles|HasLoadedCUFProfiles]]() |
: [[API HasLoadedCUFProfiles|HasLoadedCUFProfiles]]() |
||
− | : [[API RaidProfileExists|RaidProfileExists]](<span |
+ | : [[API RaidProfileExists|RaidProfileExists]](<span class="apiarg">profile</span>) |
: [[API RaidProfileHasUnsavedChanges|RaidProfileHasUnsavedChanges]]() |
: [[API RaidProfileHasUnsavedChanges|RaidProfileHasUnsavedChanges]]() |
||
: [[API RestoreRaidProfileFromCopy|RestoreRaidProfileFromCopy]]() |
: [[API RestoreRaidProfileFromCopy|RestoreRaidProfileFromCopy]]() |
||
− | : [[API SaveRaidProfileCopy|SaveRaidProfileCopy]](<span |
+ | : [[API SaveRaidProfileCopy|SaveRaidProfileCopy]](<span class="apiarg">profile</span>) |
− | : [[API SetRaidProfileOption|SetRaidProfileOption]](<span |
+ | : [[API SetRaidProfileOption|SetRaidProfileOption]](<span class="apiarg">profile, optionName, value</span>) |
− | : [[API SetRaidProfileSavedPosition|SetRaidProfileSavedPosition]](<span |
+ | : [[API SetRaidProfileSavedPosition|SetRaidProfileSavedPosition]](<span class="apiarg">profile, isDynamic, topPoint, topOffset, bottomPoint, bottomOffset, leftPoint, leftOffset</span>) |
− | === |
+ | ===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 |
+ | : [[API C_LevelLink.IsActionLocked|C_LevelLink.IsActionLocked]](<span class="apiarg">actionID</span>) : <span class="apiret">isLocked</span> |
− | : [[API C_LevelLink.IsSpellLocked|C_LevelLink.IsSpellLocked]](<span |
+ | : [[API C_LevelLink.IsSpellLocked|C_LevelLink.IsSpellLocked]](<span class="apiarg">spellID</span>) : <span class="apiret">isLocked</span> |
− | : [[API C_QuestLog. |
+ | : [[API C_QuestLog.IsQuestDisabledForSession|C_QuestLog.IsQuestDisabledForSession]](<span class="apiarg">questID</span>) : <span class="apiret">isDisabled</span> |
− | : [[API C_QuestLog. |
+ | : [[API C_QuestLog.IsQuestReplayable|C_QuestLog.IsQuestReplayable]](<span class="apiarg">questID</span>) : <span class="apiret">isReplayable</span> |
− | : [[API C_QuestLog. |
+ | : [[API C_QuestLog.IsQuestReplayedRecently|C_QuestLog.IsQuestReplayedRecently]](<span class="apiarg">questID</span>) : <span class="apiret">recentlyReplayed</span> |
− | : [[API C_QuestLog. |
+ | : [[API C_QuestLog.QuestHasQuestSessionBonus|C_QuestLog.QuestHasQuestSessionBonus]](<span class="apiarg">questID</span>) : <span class="apiret">hasBonus</span> |
− | : [[API |
+ | : [[API C_QuestSession.CanStart|C_QuestSession.CanStart]]() : <span class="apiret">allowed</span> |
− | : [[API |
+ | : [[API C_QuestSession.CanStop|C_QuestSession.CanStop]]() : <span class="apiret">allowed</span> |
− | : [[API |
+ | : [[API C_QuestSession.Exists|C_QuestSession.Exists]]() : <span class="apiret">exists</span> |
+ | : [[API C_QuestSession.GetAvailableSessionCommand|C_QuestSession.GetAvailableSessionCommand]]() : <span class="apiret">command</span> |
||
− | : [[API C_QuestLog.QuestHasQuestSessionBonus|C_QuestLog.QuestHasQuestSessionBonus]](<span style="font-size:smaller; color:#ecbc2a">questID</span>) |
||
− | : [[API C_QuestSession. |
+ | : [[API C_QuestSession.GetPendingCommand|C_QuestSession.GetPendingCommand]]() : <span class="apiret">command</span> |
− | : [[API C_QuestSession. |
+ | : [[API C_QuestSession.GetProposedMaxLevelForSession|C_QuestSession.GetProposedMaxLevelForSession]]() : <span class="apiret">proposedMaxLevel</span> |
− | : [[API C_QuestSession. |
+ | : [[API C_QuestSession.GetSessionBeginDetails|C_QuestSession.GetSessionBeginDetails]]() : <span class="apiret">details</span> |
− | : [[API C_QuestSession. |
+ | : [[API C_QuestSession.GetSuperTrackedQuest|C_QuestSession.GetSuperTrackedQuest]]() : <span class="apiret">questID</span> |
− | : [[API C_QuestSession. |
+ | : [[API C_QuestSession.HasJoined|C_QuestSession.HasJoined]]() : <span class="apiret">hasJoined</span> |
− | : [[API C_QuestSession. |
+ | : [[API C_QuestSession.HasPendingCommand|C_QuestSession.HasPendingCommand]]() : <span class="apiret">hasPendingCommand</span> |
− | : [[API C_QuestSession.GetSessionBeginDetails|C_QuestSession.GetSessionBeginDetails]]() |
||
− | : [[API C_QuestSession.GetSuperTrackedQuest|C_QuestSession.GetSuperTrackedQuest]]() |
||
− | : [[API C_QuestSession.HasJoined|C_QuestSession.HasJoined]]() |
||
− | : [[API C_QuestSession.HasPendingCommand|C_QuestSession.HasPendingCommand]]() |
||
: [[API C_QuestSession.RequestSessionStart|C_QuestSession.RequestSessionStart]]() |
: [[API C_QuestSession.RequestSessionStart|C_QuestSession.RequestSessionStart]]() |
||
: [[API C_QuestSession.RequestSessionStop|C_QuestSession.RequestSessionStop]]() |
: [[API C_QuestSession.RequestSessionStop|C_QuestSession.RequestSessionStop]]() |
||
− | : [[API C_QuestSession.SendSessionBeginResponse|C_QuestSession.SendSessionBeginResponse]](<span |
+ | : [[API C_QuestSession.SendSessionBeginResponse|C_QuestSession.SendSessionBeginResponse]](<span class="apiarg">beginSession</span>) |
− | : [[API C_QuestSession.SetQuestIsSuperTracked|C_QuestSession.SetQuestIsSuperTracked]](<span |
+ | : [[API C_QuestSession.SetQuestIsSuperTracked|C_QuestSession.SetQuestIsSuperTracked]](<span class="apiarg">questID, superTrack</span>) |
− | : [[API ConfirmBNRequestInviteFriend|ConfirmBNRequestInviteFriend]](<span |
+ | : [[API ConfirmBNRequestInviteFriend|ConfirmBNRequestInviteFriend]](<span class="apiarg">presenceID [, tank, heal, dps]</span>) |
− | == |
+ | ==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]]() |
+ | : [[API C_LFGInfo.CanPlayerUseGroupFinder|C_LFGInfo.CanPlayerUseGroupFinder]]() : <span class="apiret">canUse, failureReason</span> |
− | : [[API C_LFGInfo.CanPlayerUseLFD|C_LFGInfo.CanPlayerUseLFD]]() |
+ | : [[API C_LFGInfo.CanPlayerUseLFD|C_LFGInfo.CanPlayerUseLFD]]() : <span class="apiret">canUse, failureReason</span> |
− | : [[API C_LFGInfo.CanPlayerUseLFR|C_LFGInfo.CanPlayerUseLFR]]() |
+ | : [[API C_LFGInfo.CanPlayerUseLFR|C_LFGInfo.CanPlayerUseLFR]]() : <span class="apiret">canUse, failureReason</span> |
− | : [[API C_LFGInfo.CanPlayerUsePremadeGroup|C_LFGInfo.CanPlayerUsePremadeGroup]]() |
+ | : [[API C_LFGInfo.CanPlayerUsePremadeGroup|C_LFGInfo.CanPlayerUsePremadeGroup]]() : <span class="apiret">canUse, failureReason</span> |
− | : [[API C_LFGInfo.CanPlayerUsePVP|C_LFGInfo.CanPlayerUsePVP]]() |
+ | : [[API C_LFGInfo.CanPlayerUsePVP|C_LFGInfo.CanPlayerUsePVP]]() : <span class="apiret">canUse, failureReason</span> |
: [[API C_LFGInfo.ConfirmLfgExpandSearch|C_LFGInfo.ConfirmLfgExpandSearch]]() |
: [[API C_LFGInfo.ConfirmLfgExpandSearch|C_LFGInfo.ConfirmLfgExpandSearch]]() |
||
− | : [[API C_LFGInfo.GetAllEntriesForCategory|C_LFGInfo.GetAllEntriesForCategory]]() |
+ | : [[API C_LFGInfo.GetAllEntriesForCategory|C_LFGInfo.GetAllEntriesForCategory]](<span class="apiarg">category</span>) : <span class="apiret">lfgDungeonIDs</span> |
− | : [[API C_LFGInfo. |
+ | : [[API C_LFGInfo.GetDungeonInfo|C_LFGInfo.GetDungeonInfo]](<span class="apiarg">lfgDungeonID</span>) : <span class="apiret">dungeonInfo</span> |
− | : [[API C_LFGInfo. |
+ | : [[API C_LFGInfo.GetLFDLockStates|C_LFGInfo.GetLFDLockStates]]() : <span class="apiret">lockInfo</span> |
− | : [[API C_LFGInfo. |
+ | : [[API C_LFGInfo.GetRoleCheckDifficultyDetails|C_LFGInfo.GetRoleCheckDifficultyDetails]]() : <span class="apiret">maxLevel, isLevelReduced</span> |
− | : [[API |
+ | : [[API C_LFGInfo.HideNameFromUI|C_LFGInfo.HideNameFromUI]](<span class="apiarg">dungeonID</span>) : <span class="apiret">shouldHide</span> |
+ | : [[API AcceptProposal|AcceptProposal]]() - Enters the Dungeon if the LFG queue is ready. |
||
− | : [[API C_LFGList.ApplyToGroup|C_LFGList.ApplyToGroup]](<span style="font-size:smaller; color:#ecbc2a">resultID, comment, tank, healer, dps</span>) |
||
+ | : [[API GetDungeonForRandomSlot|GetDungeonForRandomSlot]](<span class="apiarg">randomID, index</span>) |
||
− | : [[API C_LFGList.CanActiveEntryUseAutoAccept|C_LFGList.CanActiveEntryUseAutoAccept]]() |
||
+ | : [[API GetGroupMemberCounts|GetGroupMemberCounts]]() |
||
− | : [[API C_LFGList.CanCreateQuestGroup|C_LFGList.CanCreateQuestGroup]](<span style="font-size:smaller; color:#ecbc2a">questID</span>) |
||
− | : [[API |
+ | : [[API GetNumDungeonForRandomSlot|GetNumDungeonForRandomSlot]](<span class="apiarg">randomID</span>) |
+ | : [[API GetNumRandomDungeons|GetNumRandomDungeons]]() - Returns the number of specific dungeons that can be queued for. |
||
+ | : [[API GetRandomDungeonBestChoice|GetRandomDungeonBestChoice]]() - Returns the suggested random dungeon ID. |
||
+ | : [[API GroupHasOfflineMember|GroupHasOfflineMember]]() |
||
+ | : [[API IsAllowedToUserTeleport|IsAllowedToUserTeleport]]() |
||
+ | : [[API IsServerControlledBackfill|IsServerControlledBackfill]]() |
||
+ | : [[API RejectProposal|RejectProposal]]() - Declines a LFG invite and leaves the queue. |
||
+ | : [[API RequestBattlegroundInstanceInfo|RequestBattlegroundInstanceInfo]](<span class="apiarg">index</span>) - Requests the available instances of a battleground. |
||
+ | |||
+ | ===LFGList=== |
||
+ | : [[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.CanActiveEntryUseAutoAccept|C_LFGList.CanActiveEntryUseAutoAccept]]() : <span class="apiret">canUseAutoAccept</span> |
||
+ | : [[API C_LFGList.CancelApplication|C_LFGList.CancelApplication]](<span class="apiarg">resultID</span>) {{apitag|hwevent}} |
||
+ | : [[API C_LFGList.CanCreateQuestGroup|C_LFGList.CanCreateQuestGroup]](<span class="apiarg">questID</span>) : <span class="apiret">canCreate</span> |
||
: [[API C_LFGList.ClearApplicationTextFields|C_LFGList.ClearApplicationTextFields]]() |
: [[API C_LFGList.ClearApplicationTextFields|C_LFGList.ClearApplicationTextFields]]() |
||
: [[API C_LFGList.ClearCreationTextFields|C_LFGList.ClearCreationTextFields]]() |
: [[API C_LFGList.ClearCreationTextFields|C_LFGList.ClearCreationTextFields]]() |
||
Line 2,145: | Line 2,899: | ||
: [[API C_LFGList.ClearSearchTextFields|C_LFGList.ClearSearchTextFields]]() |
: [[API C_LFGList.ClearSearchTextFields|C_LFGList.ClearSearchTextFields]]() |
||
: [[API C_LFGList.CopyActiveEntryInfoToCreationFields|C_LFGList.CopyActiveEntryInfoToCreationFields]]() |
: [[API C_LFGList.CopyActiveEntryInfoToCreationFields|C_LFGList.CopyActiveEntryInfoToCreationFields]]() |
||
− | : [[API C_LFGList.CreateListing|C_LFGList.CreateListing]](<span |
+ | : [[API C_LFGList.CreateListing|C_LFGList.CreateListing]](<span class="apiarg">activityID, itemLevel, honorLevel [, autoAccept, privateGroup, questID]</span>) {{apitag|hwevent}} - Creates a group finder listing. |
− | : [[API C_LFGList.DeclineApplicant|C_LFGList.DeclineApplicant]](<span |
+ | : [[API C_LFGList.DeclineApplicant|C_LFGList.DeclineApplicant]](<span class="apiarg">applicantID</span>) |
− | : [[API C_LFGList.DeclineInvite|C_LFGList.DeclineInvite]](<span |
+ | : [[API C_LFGList.DeclineInvite|C_LFGList.DeclineInvite]](<span class="apiarg">searchResultID</span>) |
+ | : [[API C_LFGList.DoesEntryTitleMatchPrebuiltTitle|C_LFGList.DoesEntryTitleMatchPrebuiltTitle]](<span class="apiarg">activityID, groupID [, playstyle]</span>) : <span class="apiret">matches</span> |
||
− | : [[API C_LFGList.GetActiveEntryInfo|C_LFGList.GetActiveEntryInfo]]() - Returns information about your currently listed group. |
||
− | : [[API C_LFGList. |
+ | : [[API C_LFGList.GetActiveEntryInfo|C_LFGList.GetActiveEntryInfo]]() : <span class="apiret">entryData</span> - Returns information about your currently listed group. |
− | : [[API C_LFGList. |
+ | : [[API C_LFGList.GetActivityFullName|C_LFGList.GetActivityFullName]](<span class="apiarg">activityID [, questID, showWarmode]</span>) : <span class="apiret">fullName</span> |
− | : [[API C_LFGList. |
+ | : [[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. |
+ | : [[API C_LFGList.GetActivityIDForQuestID|C_LFGList.GetActivityIDForQuestID]](<span class="apiarg">questID</span>) |
− | : [[API C_LFGList. |
+ | : [[API C_LFGList.GetActivityInfoExpensive|C_LFGList.GetActivityInfoExpensive]](<span class="apiarg">activityID</span>) - Returns the zone associated with an activity. |
− | : [[API C_LFGList. |
+ | : [[API C_LFGList.GetActivityInfoTable|C_LFGList.GetActivityInfoTable]](<span class="apiarg">activityID [, questID, showWarmode]</span>) : <span class="apiret">activityInfo</span> |
− | : [[API C_LFGList. |
+ | : [[API C_LFGList.GetApplicantDungeonScoreForListing|C_LFGList.GetApplicantDungeonScoreForListing]](<span class="apiarg">localID, applicantIndex, activityID</span>) : <span class="apiret">bestDungeonScoreForListing</span> |
− | : [[API C_LFGList. |
+ | : [[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. |
+ | : [[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 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.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.GetApplications|C_LFGList.GetApplications]]() |
: [[API C_LFGList.GetApplications|C_LFGList.GetApplications]]() |
||
− | : [[API C_LFGList.GetAvailableActivities|C_LFGList.GetAvailableActivities]](<span |
+ | : [[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 |
+ | : [[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 |
+ | : [[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]]() |
||
− | : [[API C_LFGList.GetCategoryInfo|C_LFGList.GetCategoryInfo]](<span style="font-size:smaller; color:#ecbc2a">categoryID</span>) - Returns information about a specific category. |
||
: [[API C_LFGList.GetDefaultLanguageSearchFilter|C_LFGList.GetDefaultLanguageSearchFilter]]() |
: [[API C_LFGList.GetDefaultLanguageSearchFilter|C_LFGList.GetDefaultLanguageSearchFilter]]() |
||
+ | : [[API C_LFGList.GetFilteredSearchResults|C_LFGList.GetFilteredSearchResults]]() : <span class="apiret">totalResultsFound, filteredResults</span> |
||
+ | : [[API C_LFGList.GetKeystoneForActivity|C_LFGList.GetKeystoneForActivity]](<span class="apiarg">activityID</span>) : <span class="apiret">level</span> |
||
: [[API C_LFGList.GetLanguageSearchFilter|C_LFGList.GetLanguageSearchFilter]]() |
: [[API C_LFGList.GetLanguageSearchFilter|C_LFGList.GetLanguageSearchFilter]]() |
||
+ | : [[API C_LFGList.GetLfgCategoryInfo|C_LFGList.GetLfgCategoryInfo]](<span class="apiarg">categoryID</span>) : <span class="apiret">categoryData</span> |
||
: [[API C_LFGList.GetNumApplicants|C_LFGList.GetNumApplicants]]() |
: [[API C_LFGList.GetNumApplicants|C_LFGList.GetNumApplicants]]() |
||
: [[API C_LFGList.GetNumApplications|C_LFGList.GetNumApplications]]() |
: [[API C_LFGList.GetNumApplications|C_LFGList.GetNumApplications]]() |
||
: [[API C_LFGList.GetNumInvitedApplicantMembers|C_LFGList.GetNumInvitedApplicantMembers]]() |
: [[API C_LFGList.GetNumInvitedApplicantMembers|C_LFGList.GetNumInvitedApplicantMembers]]() |
||
: [[API C_LFGList.GetNumPendingApplicantMembers|C_LFGList.GetNumPendingApplicantMembers]]() |
: [[API C_LFGList.GetNumPendingApplicantMembers|C_LFGList.GetNumPendingApplicantMembers]]() |
||
+ | : [[API C_LFGList.GetOwnedKeystoneActivityAndGroupAndLevel|C_LFGList.GetOwnedKeystoneActivityAndGroupAndLevel]](<span class="apiarg">[getTimewalking]</span>) : <span class="apiret">activityID, groupID, keystoneLevel</span> |
||
+ | : [[API C_LFGList.GetPlaystyleString|C_LFGList.GetPlaystyleString]](<span class="apiarg">playstyle, activityInfo</span>) : <span class="apiret">playstyleString</span> |
||
: [[API C_LFGList.GetRoleCheckInfo|C_LFGList.GetRoleCheckInfo]]() |
: [[API C_LFGList.GetRoleCheckInfo|C_LFGList.GetRoleCheckInfo]]() |
||
− | : [[API C_LFGList.GetSearchResultEncounterInfo|C_LFGList.GetSearchResultEncounterInfo]](<span |
+ | : [[API C_LFGList.GetSearchResultEncounterInfo|C_LFGList.GetSearchResultEncounterInfo]](<span class="apiarg">searchResultID</span>) |
− | : [[API C_LFGList.GetSearchResultFriends|C_LFGList.GetSearchResultFriends]](<span |
+ | : [[API C_LFGList.GetSearchResultFriends|C_LFGList.GetSearchResultFriends]](<span class="apiarg">searchResultID</span>) |
− | : [[API C_LFGList.GetSearchResultInfo|C_LFGList.GetSearchResultInfo]](<span |
+ | : [[API C_LFGList.GetSearchResultInfo|C_LFGList.GetSearchResultInfo]](<span class="apiarg">searchResultID</span>) : <span class="apiret">searchResultData</span> |
− | : [[API C_LFGList.GetSearchResultMemberCounts|C_LFGList.GetSearchResultMemberCounts]](<span |
+ | : [[API C_LFGList.GetSearchResultMemberCounts|C_LFGList.GetSearchResultMemberCounts]](<span class="apiarg">searchResultID</span>) |
− | : [[API C_LFGList.GetSearchResultMemberInfo|C_LFGList.GetSearchResultMemberInfo]](<span |
+ | : [[API C_LFGList.GetSearchResultMemberInfo|C_LFGList.GetSearchResultMemberInfo]](<span class="apiarg">searchResultID, memberIndex</span>) |
− | : [[API C_LFGList.GetSearchResults|C_LFGList.GetSearchResults]]() |
+ | : [[API C_LFGList.GetSearchResults|C_LFGList.GetSearchResults]]() : <span class="apiret">totalResultsFound, results</span> |
− | : [[API C_LFGList.HasActiveEntryInfo|C_LFGList.HasActiveEntryInfo]]() |
+ | : [[API C_LFGList.HasActiveEntryInfo|C_LFGList.HasActiveEntryInfo]]() : <span class="apiret">hasActiveEntryInfo</span> |
: [[API C_LFGList.HasActivityList|C_LFGList.HasActivityList]]() |
: [[API C_LFGList.HasActivityList|C_LFGList.HasActivityList]]() |
||
− | : [[API C_LFGList.HasSearchResultInfo|C_LFGList.HasSearchResultInfo]](<span |
+ | : [[API C_LFGList.HasSearchResultInfo|C_LFGList.HasSearchResultInfo]](<span class="apiarg">searchResultID</span>) : <span class="apiret">hasSearchResultInfo</span> |
− | : [[API C_LFGList.InviteApplicant|C_LFGList.InviteApplicant]](<span |
+ | : [[API C_LFGList.InviteApplicant|C_LFGList.InviteApplicant]](<span class="apiarg">applicantID</span>) |
: [[API C_LFGList.IsCurrentlyApplying|C_LFGList.IsCurrentlyApplying]]() |
: [[API C_LFGList.IsCurrentlyApplying|C_LFGList.IsCurrentlyApplying]]() |
||
+ | : [[API C_LFGList.IsPlayerAuthenticatedForLFG|C_LFGList.IsPlayerAuthenticatedForLFG]](<span class="apiarg">[activityID]</span>) : <span class="apiret">isAuthenticated</span> |
||
: [[API C_LFGList.RefreshApplicants|C_LFGList.RefreshApplicants]]() |
: [[API C_LFGList.RefreshApplicants|C_LFGList.RefreshApplicants]]() |
||
− | : [[API C_LFGList.RemoveApplicant|C_LFGList.RemoveApplicant]](<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 style="font-size:smaller; color:#ecbc2a">applicantID</span>) |
||
− | : [[API C_LFGList.ReportSearchResult|C_LFGList.ReportSearchResult]](<span style="font-size:smaller; color:#ecbc2a">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 |
+ | : [[API C_LFGList.SaveLanguageSearchFilter|C_LFGList.SaveLanguageSearchFilter]](<span class="apiarg">enabled</span>) |
− | : [[API C_LFGList.Search|C_LFGList.Search]](<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 |
+ | : [[API C_LFGList.SetApplicantMemberRole|C_LFGList.SetApplicantMemberRole]](<span class="apiarg">applicantID, memberIndex, role</span>) |
− | : [[API C_LFGList. |
+ | : [[API C_LFGList.SetEntryTitle|C_LFGList.SetEntryTitle]](<span class="apiarg">activityID, groupID [, playstyle]</span>) |
− | : [[API C_LFGList. |
+ | : [[API C_LFGList.SetSearchToActivity|C_LFGList.SetSearchToActivity]](<span class="apiarg">activityID</span>) |
− | : [[API C_LFGList. |
+ | : [[API C_LFGList.SetSearchToQuestID|C_LFGList.SetSearchToQuestID]](<span class="apiarg">questID</span>) |
+ | : [[API C_LFGList.UpdateListing|C_LFGList.UpdateListing]](<span class="apiarg">lfgID, itemLevel, honorLevel, autoAccept, private [, questID]</span>) |
||
− | : [[API AcceptProposal|AcceptProposal]]() - Accept an LFD group invite and enter the dungeon. |
||
+ | : [[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> |
||
+ | |||
+ | ===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> |
||
: [[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. |
||
− | : [[API ClearAllLFGDungeons|ClearAllLFGDungeons]](<span |
+ | : [[API ClearAllLFGDungeons|ClearAllLFGDungeons]](<span class="apiarg">category</span>) |
− | : [[API CompleteLFGReadyCheck|CompleteLFGReadyCheck]](<span |
+ | : [[API CompleteLFGReadyCheck|CompleteLFGReadyCheck]](<span class="apiarg">isReady</span>) |
− | : [[API CompleteLFGRoleCheck|CompleteLFGRoleCheck]](<span |
+ | : [[API CompleteLFGRoleCheck|CompleteLFGRoleCheck]](<span class="apiarg">isReady</span>) - Returns true if the role check was successful. |
+ | : [[API GetLFGBootProposal|GetLFGBootProposal]]() - Returns info for a LFG votekick in progress. |
||
− | : [[API DungeonAppearsInRandomLFD|DungeonAppearsInRandomLFD]](<span style="font-size:smaller; color:#ecbc2a">dungeonID</span>) |
||
− | : [[API |
+ | : [[API GetLFGCategoryForID|GetLFGCategoryForID]](<span class="apiarg">partySlot</span>) |
− | : [[API GetDungeonInfo|GetDungeonInfo]]() |
||
− | : [[API GetGroupMemberCounts|GetGroupMemberCounts]]() |
||
− | : [[API GetLFDChoiceCollapseState|GetLFDChoiceCollapseState]](<span style="font-size:smaller; color:#ecbc2a">[LFGCollapseList]</span>) |
||
− | : [[API GetLFDChoiceEnabledState|GetLFDChoiceEnabledState]](<span style="font-size:smaller; color:#ecbc2a">[LFGEnabledList]</span>) |
||
− | : [[API GetLFDChoiceOrder|GetLFDChoiceOrder]](<span style="font-size:smaller; color:#ecbc2a">[LFDDungeonList]</span>) |
||
− | : [[API GetLFDLockInfo|GetLFDLockInfo]](<span style="font-size:smaller; color:#ecbc2a">dungeonID, playerIndex</span>) |
||
− | : [[API GetLFDLockPlayerCount|GetLFDLockPlayerCount]]() |
||
− | : [[API GetLFDRoleLockInfo|GetLFDRoleLockInfo]](<span style="font-size:smaller; color:#ecbc2a">dungeonID, roleID</span>) |
||
− | : [[API GetLFDRoleRestrictions|GetLFDRoleRestrictions]](<span style="font-size:smaller; color:#ecbc2a">dungeonID</span>) |
||
− | : [[API GetLFGBootProposal|GetLFGBootProposal]]() - Returns info about a LFG Kick vote in progress. |
||
− | : [[API GetLFGCategoryForID|GetLFGCategoryForID]](<span style="font-size:smaller; color:#ecbc2a">partySlot</span>) |
||
− | : [[API GetLFGCompletionRewardItemLink|GetLFGCompletionRewardItemLink]](<span style="font-size:smaller; color:#ecbc2a">rewardIndex</span>) |
||
− | : [[API GetLFGCompletionRewardItem|GetLFGCompletionRewardItem]](<span style="font-size:smaller; color:#ecbc2a">rewardIndex</span>) |
||
: [[API GetLFGCompletionReward|GetLFGCompletionReward]]() |
: [[API GetLFGCompletionReward|GetLFGCompletionReward]]() |
||
+ | : [[API GetLFGCompletionRewardItem|GetLFGCompletionRewardItem]](<span class="apiarg">rewardIndex</span>) |
||
+ | : [[API GetLFGCompletionRewardItemLink|GetLFGCompletionRewardItemLink]](<span class="apiarg">rewardIndex</span>) |
||
: [[API GetLFGDeserterExpiration|GetLFGDeserterExpiration]]() - Returns the time at which you may once again use the dungeon finder after prematurely leaving a group. |
: [[API GetLFGDeserterExpiration|GetLFGDeserterExpiration]]() - Returns the time at which you may once again use the dungeon finder after prematurely leaving a group. |
||
− | : [[API GetLFGDungeonEncounterInfo|GetLFGDungeonEncounterInfo]](<span |
+ | : [[API GetLFGDungeonEncounterInfo|GetLFGDungeonEncounterInfo]](<span class="apiarg">dungeonID, encounterIndex</span>) |
− | : [[API GetLFGDungeonInfo|GetLFGDungeonInfo]](<span |
+ | : [[API GetLFGDungeonInfo|GetLFGDungeonInfo]](<span class="apiarg">dungeonID</span>) - Returns info for a LFG dungeon. |
− | : [[API GetLFGDungeonNumEncounters|GetLFGDungeonNumEncounters]](<span |
+ | : [[API GetLFGDungeonNumEncounters|GetLFGDungeonNumEncounters]](<span class="apiarg">dungeonID</span>) |
− | : [[API GetLFGDungeonRewardCapBarInfo|GetLFGDungeonRewardCapBarInfo]](<span |
+ | : [[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 |
+ | : [[API GetLFGDungeonRewardCapInfo|GetLFGDungeonRewardCapInfo]](<span class="apiarg">dungeonID</span>) |
− | : [[API GetLFGDungeonRewardInfo|GetLFGDungeonRewardInfo]](<span |
+ | : [[API GetLFGDungeonRewardInfo|GetLFGDungeonRewardInfo]](<span class="apiarg">dungeonID, rewardIndex</span>) |
− | : [[API GetLFGDungeonRewardLink|GetLFGDungeonRewardLink]](<span |
+ | : [[API GetLFGDungeonRewardLink|GetLFGDungeonRewardLink]](<span class="apiarg">dungeonID, rewardIndex</span>) |
− | : [[API GetLFGDungeonRewards|GetLFGDungeonRewards]](<span |
+ | : [[API GetLFGDungeonRewards|GetLFGDungeonRewards]](<span class="apiarg">dungeonID</span>) |
− | : [[API GetLFGDungeonShortageRewardInfo|GetLFGDungeonShortageRewardInfo]](<span |
+ | : [[API GetLFGDungeonShortageRewardInfo|GetLFGDungeonShortageRewardInfo]](<span class="apiarg">dungeonID, shortageIndex, rewardIndex</span>) |
− | : [[API GetLFGDungeonShortageRewardLink|GetLFGDungeonShortageRewardLink]](<span |
+ | : [[API GetLFGDungeonShortageRewardLink|GetLFGDungeonShortageRewardLink]](<span class="apiarg">dungeonID, shortageIndex, rewardIndex</span>) |
− | : [[API GetLFGInfoServer|GetLFGInfoServer]](<span |
+ | : [[API GetLFGInfoServer|GetLFGInfoServer]](<span class="apiarg">category [, lfgID]</span>) |
− | : [[API GetLFGInviteRoleAvailability|GetLFGInviteRoleAvailability]](<span |
+ | : [[API GetLFGInviteRoleAvailability|GetLFGInviteRoleAvailability]](<span class="apiarg">roleID</span>) |
− | : [[API GetLFGInviteRoleRestrictions|GetLFGInviteRoleRestrictions]](<span |
+ | : [[API GetLFGInviteRoleRestrictions|GetLFGInviteRoleRestrictions]](<span class="apiarg">roleID</span>) |
− | : [[API GetLFGProposalEncounter|GetLFGProposalEncounter]](<span style="font-size:smaller; color:#ecbc2a">encounterIndex</span>) |
||
− | : [[API GetLFGProposalMember|GetLFGProposalMember]](<span style="font-size:smaller; color:#ecbc2a">memberIndex</span>) - Returns info about the players in the LFG proposal. |
||
: [[API GetLFGProposal|GetLFGProposal]]() |
: [[API GetLFGProposal|GetLFGProposal]]() |
||
+ | : [[API GetLFGProposalEncounter|GetLFGProposalEncounter]](<span class="apiarg">encounterIndex</span>) |
||
− | : [[API GetLFGQueueStats|GetLFGQueueStats]](<span style="font-size:smaller; color:#ecbc2a">category [, lfgID]</span>) - Returns current state and wait times for being in queue. |
||
+ | : [[API GetLFGProposalMember|GetLFGProposalMember]](<span class="apiarg">memberIndex</span>) - Returns info about the players in the LFG proposal. |
||
− | : [[API GetLFGQueuedList|GetLFGQueuedList]](<span style="font-size:smaller; color:#ecbc2a">category [, table]</span>) |
||
+ | : [[API GetLFGQueuedList|GetLFGQueuedList]](<span class="apiarg">category [, table]</span>) |
||
+ | : [[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 |
+ | : [[API GetLFGRandomDungeonInfo|GetLFGRandomDungeonInfo]](<span class="apiarg">index</span>) - Returns information about a random dungeon queue. |
+ | : [[API GetLFGReadyCheckUpdate|GetLFGReadyCheckUpdate]]() |
||
: [[API GetLFGReadyCheckUpdateBattlegroundInfo|GetLFGReadyCheckUpdateBattlegroundInfo]]() |
: [[API GetLFGReadyCheckUpdateBattlegroundInfo|GetLFGReadyCheckUpdateBattlegroundInfo]]() |
||
+ | : [[API GetLFGRoles|GetLFGRoles]]() - Returns the roles the player signed up for in the Dungeon Finder. |
||
− | : [[API GetLFGReadyCheckUpdate|GetLFGReadyCheckUpdate]]() |
||
− | : [[API GetLFGRoleShortageRewards|GetLFGRoleShortageRewards]](<span |
+ | : [[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 GetLFGRoleUpdateBattlegroundInfo|GetLFGRoleUpdateBattlegroundInfo]]() |
: [[API GetLFGRoleUpdateBattlegroundInfo|GetLFGRoleUpdateBattlegroundInfo]]() |
||
− | : [[API GetLFGRoleUpdateMember|GetLFGRoleUpdateMember]](<span |
+ | : [[API GetLFGRoleUpdateMember|GetLFGRoleUpdateMember]](<span class="apiarg">memberIndex</span>) |
− | : [[API GetLFGRoleUpdateSlot|GetLFGRoleUpdateSlot]](<span |
+ | : [[API GetLFGRoleUpdateSlot|GetLFGRoleUpdateSlot]](<span class="apiarg">slotIndex</span>) |
+ | : [[API GetLFGSuspendedPlayers|GetLFGSuspendedPlayers]](<span class="apiarg">category</span>) |
||
− | : [[API GetLFGRoleUpdate|GetLFGRoleUpdate]]() |
||
− | : [[API GetLFGRoles|GetLFGRoles]]() - Returns the roles you signed up as, not the role you were assigned. |
||
− | : [[API GetLFGSuspendedPlayers|GetLFGSuspendedPlayers]](<span style="font-size:smaller; color:#ecbc2a">category</span>) |
||
− | : [[API GetLFGTypes|GetLFGTypes]]() - Returns all available LFG categories. |
||
− | : [[API GetNumDungeonForRandomSlot|GetNumDungeonForRandomSlot]](<span style="font-size:smaller; color:#ecbc2a">randomID</span>) |
||
− | : [[API GetNumRandomDungeons|GetNumRandomDungeons]]() - Returns the number of specific dungeons that can be queued for. |
||
: [[API GetPartyLFGBackfillInfo|GetPartyLFGBackfillInfo]]() - Returns information about the dungeon for which you may currently recruit additional members from the LFG pool. |
: [[API GetPartyLFGBackfillInfo|GetPartyLFGBackfillInfo]]() - Returns information about the dungeon for which you may currently recruit additional members from the LFG pool. |
||
: [[API GetPartyLFGID|GetPartyLFGID]]() |
: [[API GetPartyLFGID|GetPartyLFGID]]() |
||
− | : [[API GetRandomDungeonBestChoice|GetRandomDungeonBestChoice]]() - Returns the suggested random dungeon ID. |
||
− | : [[API GroupHasOfflineMember|GroupHasOfflineMember]]() |
||
: [[API HasLFGRestrictions|HasLFGRestrictions]]() - Returns whether the player is in a random party formed by the dungeon finder system. |
: [[API HasLFGRestrictions|HasLFGRestrictions]]() - Returns whether the player is in a random party formed by the dungeon finder system. |
||
− | : [[API IsAllowedToUserTeleport|IsAllowedToUserTeleport]]() |
||
: [[API IsInLFGDungeon|IsInLFGDungeon]]() |
: [[API IsInLFGDungeon|IsInLFGDungeon]]() |
||
: [[API IsLFGComplete|IsLFGComplete]]() - Returns whether you have currently finished a Dungeon Finder instance. |
: [[API IsLFGComplete|IsLFGComplete]]() - Returns whether you have currently finished a Dungeon Finder instance. |
||
: [[API IsLFGDungeonJoinable|IsLFGDungeonJoinable]]() - Returns whether you can queue for a particular dungeon |
: [[API IsLFGDungeonJoinable|IsLFGDungeonJoinable]]() - Returns whether you can queue for a particular dungeon |
||
: [[API IsPartyLFG|IsPartyLFG]]() |
: [[API IsPartyLFG|IsPartyLFG]]() |
||
+ | : [[API JoinLFG|JoinLFG]](<span class="apiarg">category</span>) |
||
− | : [[API IsServerControlledBackfill|IsServerControlledBackfill]]() |
||
− | : [[API |
+ | : [[API JoinSingleLFG|JoinSingleLFG]](<span class="apiarg">category, lfgID</span>) |
− | : [[API |
+ | : [[API LeaveLFG|LeaveLFG]](<span class="apiarg">category</span>) |
+ | : [[API LeaveSingleLFG|LeaveSingleLFG]](<span class="apiarg">category, lfgID</span>) |
||
− | : [[API LFGTeleport|LFGTeleport]](<span style="font-size:smaller; color:#ecbc2a">[toSafety]</span>) - Teleports the player to or from a dungeon. |
||
− | : [[API |
+ | : [[API LFGTeleport|LFGTeleport]](<span class="apiarg">[toSafety]</span>) - Teleports the player to or from a LFG dungeon. |
− | : [[API LeaveSingleLFG|LeaveSingleLFG]](<span style="font-size:smaller; color:#ecbc2a">category, lfgID</span>) |
||
: [[API PartyLFGStartBackfill|PartyLFGStartBackfill]]() |
: [[API PartyLFGStartBackfill|PartyLFGStartBackfill]]() |
||
: [[API RefreshLFGList|RefreshLFGList]]() |
: [[API RefreshLFGList|RefreshLFGList]]() |
||
+ | : [[API SearchLFGGetEncounterResults|SearchLFGGetEncounterResults]](<span class="apiarg">index, encounterIndex</span>) |
||
− | : [[API RejectProposal|RejectProposal]]() - Rejects an LFG group invite and exits the queue. |
||
− | : [[API RequestBattlegroundInstanceInfo|RequestBattlegroundInstanceInfo]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Requests data about the available instances of a battleground. |
||
− | : [[API RequestLFDPartyLockInfo|RequestLFDPartyLockInfo]]() |
||
− | : [[API RequestLFDPlayerLockInfo|RequestLFDPlayerLockInfo]]() |
||
− | : [[API SearchLFGGetEncounterResults|SearchLFGGetEncounterResults]](<span style="font-size:smaller; color:#ecbc2a">index, encounterIndex</span>) |
||
: [[API SearchLFGGetJoinedID|SearchLFGGetJoinedID]]() - Returns the currently selected raid ID. |
: [[API SearchLFGGetJoinedID|SearchLFGGetJoinedID]]() - Returns the currently selected raid ID. |
||
: [[API SearchLFGGetNumResults|SearchLFGGetNumResults]]() |
: [[API SearchLFGGetNumResults|SearchLFGGetNumResults]]() |
||
− | : [[API SearchLFGGetPartyResults|SearchLFGGetPartyResults]](<span |
+ | : [[API SearchLFGGetPartyResults|SearchLFGGetPartyResults]](<span class="apiarg">[index, memberIndex]</span>) |
− | : [[API SearchLFGGetResults|SearchLFGGetResults]](<span |
+ | : [[API SearchLFGGetResults|SearchLFGGetResults]](<span class="apiarg">[index]</span>) |
− | : HW [[API SearchLFGJoin|SearchLFGJoin]](<span style="font-size:smaller; color:#ecbc2a">typeID, lfgID</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. |
||
− | : [[API |
+ | : [[API SearchLFGJoin|SearchLFGJoin]](<span class="apiarg">typeID, lfgID</span>) {{apitag|hwevent}} |
− | : [[API |
+ | : [[API SearchLFGSort|SearchLFGSort]](<span class="apiarg">type</span>) |
− | : [[API |
+ | : [[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 LFG browser. |
||
− | : [[API SetLFGDungeon|SetLFGDungeon]](<span style="font-size:smaller; color:#ecbc2a">LE_LFG_CATEGORY, type</span>) |
||
− | : [[API |
+ | : [[API SetLFGDungeon|SetLFGDungeon]](<span class="apiarg">LE_LFG_CATEGORY, type</span>) |
− | : [[API |
+ | : [[API SetLFGDungeonEnabled|SetLFGDungeonEnabled]](<span class="apiarg">dungeonID, isEnabled</span>) |
+ | : [[API SetLFGHeaderCollapsed|SetLFGHeaderCollapsed]](<span class="apiarg">headerID, isCollapsed</span>) |
||
− | : [[API SetLFGRoles|SetLFGRoles]](<span style="font-size:smaller; color:#ecbc2a">[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 is used for Dungeon-specific functions and values |
||
+ | : [[API DungeonAppearsInRandomLFD|DungeonAppearsInRandomLFD]](<span class="apiarg">dungeonID</span>) |
||
+ | : [[API GetLFDChoiceCollapseState|GetLFDChoiceCollapseState]](<span class="apiarg">[LFGCollapseList]</span>) |
||
+ | : [[API GetLFDChoiceEnabledState|GetLFDChoiceEnabledState]](<span class="apiarg">[LFGEnabledList]</span>) |
||
+ | : [[API GetLFDChoiceOrder|GetLFDChoiceOrder]](<span class="apiarg">[LFDDungeonList]</span>) |
||
+ | : [[API GetLFDLockInfo|GetLFDLockInfo]](<span class="apiarg">dungeonID, playerIndex</span>) |
||
+ | : [[API GetLFDLockPlayerCount|GetLFDLockPlayerCount]]() |
||
+ | : [[API GetLFDRoleLockInfo|GetLFDRoleLockInfo]](<span class="apiarg">dungeonID, roleID</span>) |
||
+ | : [[API GetLFDRoleRestrictions|GetLFDRoleRestrictions]](<span class="apiarg">dungeonID</span>) |
||
+ | : [[API RequestLFDPartyLockInfo|RequestLFDPartyLockInfo]]() |
||
+ | : [[API RequestLFDPlayerLockInfo|RequestLFDPlayerLockInfo]]() |
||
+ | |||
+ | ===Flex Raid=== |
||
: [[API GetBestFlexRaidChoice|GetBestFlexRaidChoice]]() |
: [[API GetBestFlexRaidChoice|GetBestFlexRaidChoice]]() |
||
+ | : [[API GetFlexRaidDungeonInfo|GetFlexRaidDungeonInfo]](<span class="apiarg">index</span>) |
||
− | : [[API GetBestRFChoice|GetBestRFChoice]]() - Returns the suggested/default dungeonId for the Raid Finder. |
||
− | : [[API GetFlexRaidDungeonInfo|GetFlexRaidDungeonInfo]](<span style="font-size:smaller; color:#ecbc2a">index</span>) |
||
− | : [[API GetLFRChoiceOrder|GetLFRChoiceOrder]](<span style="font-size:smaller; color:#ecbc2a">[LFRRaidList]</span>) |
||
: [[API GetNumFlexRaidDungeons|GetNumFlexRaidDungeons]]() |
: [[API GetNumFlexRaidDungeons|GetNumFlexRaidDungeons]]() |
||
+ | |||
+ | ===Raid Finder=== |
||
+ | : [[API GetBestRFChoice|GetBestRFChoice]]() - Returns the suggested raid for the Raid Finder. |
||
+ | : [[API GetLFRChoiceOrder|GetLFRChoiceOrder]](<span class="apiarg">[LFRRaidList]</span>) |
||
: [[API GetNumRFDungeons|GetNumRFDungeons]]() |
: [[API GetNumRFDungeons|GetNumRFDungeons]]() |
||
− | : [[API GetRFDungeonInfo|GetRFDungeonInfo]](<span |
+ | : [[API GetRFDungeonInfo|GetRFDungeonInfo]](<span class="apiarg">index</span>) |
− | === |
+ | ===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 |
+ | : [[API C_PartyInfo.ConfirmRequestInviteFromUnit|C_PartyInfo.ConfirmRequestInviteFromUnit]](<span class="apiarg">targetName [, tank, healer, dps]</span>) |
− | : [[API C_PartyInfo.GetActiveCategories|C_PartyInfo.GetActiveCategories]]() |
+ | : [[API C_PartyInfo.GetActiveCategories|C_PartyInfo.GetActiveCategories]]() : <span class="apiret">categories</span> |
− | : [[API C_PartyInfo.GetInviteConfirmationInvalidQueues|C_PartyInfo.GetInviteConfirmationInvalidQueues]](<span |
+ | : [[API C_PartyInfo.GetInviteConfirmationInvalidQueues|C_PartyInfo.GetInviteConfirmationInvalidQueues]](<span class="apiarg">inviteGUID</span>) : <span class="apiret">invalidQueues</span> |
− | : [[API C_PartyInfo.GetInviteReferralInfo|C_PartyInfo.GetInviteReferralInfo]](<span |
+ | : [[API C_PartyInfo.GetInviteReferralInfo|C_PartyInfo.GetInviteReferralInfo]](<span class="apiarg">inviteGUID</span>) : <span class="apiret">outReferredByGuid, outReferredByName, outRelationType, outIsQuickJoin, outClubId</span> - Returns info for Quick join invites. |
− | : [[API C_PartyInfo.RequestInviteFromUnit|C_PartyInfo.RequestInviteFromUnit]](<span |
+ | : [[API C_PartyInfo.RequestInviteFromUnit|C_PartyInfo.RequestInviteFromUnit]](<span class="apiarg">targetName [, tank, healer, dps]</span>) |
− | : [[API C_SocialQueue.GetAllGroups|C_SocialQueue.GetAllGroups]](<span |
+ | : [[API C_SocialQueue.GetAllGroups|C_SocialQueue.GetAllGroups]](<span class="apiarg">[allowNonJoinable, allowNonQueuedGroups]</span>) : <span class="apiret">groupGUIDs</span> |
− | : [[API C_SocialQueue.GetConfig|C_SocialQueue.GetConfig]]() |
+ | : [[API C_SocialQueue.GetConfig|C_SocialQueue.GetConfig]]() : <span class="apiret">config</span> |
− | : [[API C_SocialQueue.GetGroupForPlayer|C_SocialQueue.GetGroupForPlayer]](<span |
+ | : [[API C_SocialQueue.GetGroupForPlayer|C_SocialQueue.GetGroupForPlayer]](<span class="apiarg">playerGUID</span>) : <span class="apiret">groupGUID, isSoloQueueParty</span> |
− | : [[API C_SocialQueue.GetGroupInfo|C_SocialQueue.GetGroupInfo]](<span |
+ | : [[API C_SocialQueue.GetGroupInfo|C_SocialQueue.GetGroupInfo]](<span class="apiarg">groupGUID</span>) : <span class="apiret">canJoin, numQueues, needTank, needHealer, needDamage, isSoloQueueParty, questSessionActive, leaderGUID</span> |
− | : [[API C_SocialQueue.GetGroupMembers|C_SocialQueue.GetGroupMembers]](<span |
+ | : [[API C_SocialQueue.GetGroupMembers|C_SocialQueue.GetGroupMembers]](<span class="apiarg">groupGUID</span>) : <span class="apiret">groupMembers</span> |
− | : [[API C_SocialQueue.GetGroupQueues|C_SocialQueue.GetGroupQueues]](<span |
+ | : [[API C_SocialQueue.GetGroupQueues|C_SocialQueue.GetGroupQueues]](<span class="apiarg">groupGUID</span>) : <span class="apiret">queues</span> |
− | : [[API C_SocialQueue.RequestToJoin|C_SocialQueue.RequestToJoin]](<span |
+ | : [[API C_SocialQueue.RequestToJoin|C_SocialQueue.RequestToJoin]](<span class="apiarg">groupGUID [, applyAsTank, applyAsHealer, applyAsDamage]</span>) : <span class="apiret">requestSuccessful</span> |
− | : [[API C_SocialQueue.SignalToastDisplayed|C_SocialQueue.SignalToastDisplayed]](<span |
+ | : [[API C_SocialQueue.SignalToastDisplayed|C_SocialQueue.SignalToastDisplayed]](<span class="apiarg">groupGUID, priority</span>) |
− | == |
+ | ==Guild== |
− | : [[API C_GuildInfo.CanEditOfficerNote|C_GuildInfo.CanEditOfficerNote]]() - Returns if the player |
+ | : [[API C_GuildInfo.CanEditOfficerNote|C_GuildInfo.CanEditOfficerNote]]() : <span class="apiret">canEditOfficerNote</span> - Returns true if the player can edit guild officer notes. |
− | : [[API C_GuildInfo.CanSpeakInGuildChat|C_GuildInfo.CanSpeakInGuildChat]]() - Returns if the player |
+ | : [[API C_GuildInfo.CanSpeakInGuildChat|C_GuildInfo.CanSpeakInGuildChat]]() : <span class="apiret">canSpeakInGuildChat</span> - Returns true if the player can use guild chat. |
− | : [[API C_GuildInfo.CanViewOfficerNote|C_GuildInfo.CanViewOfficerNote]]() - Returns if the player |
+ | : [[API C_GuildInfo.CanViewOfficerNote|C_GuildInfo.CanViewOfficerNote]]() : <span class="apiret">canViewOfficerNote</span> - Returns true if the player can view guild officer notes. |
− | : [[API C_GuildInfo.GetGuildNewsInfo|C_GuildInfo.GetGuildNewsInfo]](<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 |
+ | : [[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.GetGuildTabardInfo|C_GuildInfo.GetGuildTabardInfo]](<span |
+ | : [[API C_GuildInfo.GetGuildTabardInfo|C_GuildInfo.GetGuildTabardInfo]](<span class="apiarg">[unit]</span>) : <span class="apiret">tabardInfo</span> |
− | : [[API C_GuildInfo.GuildControlGetRankFlags|C_GuildInfo.GuildControlGetRankFlags]](<span |
+ | : [[API C_GuildInfo.GuildControlGetRankFlags|C_GuildInfo.GuildControlGetRankFlags]](<span class="apiarg">rankOrder</span>) : <span class="apiret">permissions</span> - Returns the permission flags for a rank index. |
: [[API C_GuildInfo.GuildRoster|C_GuildInfo.GuildRoster]]() - Requests updated guild roster information from the server. |
: [[API C_GuildInfo.GuildRoster|C_GuildInfo.GuildRoster]]() - Requests updated guild roster information from the server. |
||
− | : [[API C_GuildInfo.IsGuildOfficer|C_GuildInfo.IsGuildOfficer]]() |
+ | : [[API C_GuildInfo.IsGuildOfficer|C_GuildInfo.IsGuildOfficer]]() : <span class="apiret">isOfficer</span> |
− | : [[API C_GuildInfo.IsGuildRankAssignmentAllowed|C_GuildInfo.IsGuildRankAssignmentAllowed]](<span |
+ | : [[API C_GuildInfo.IsGuildRankAssignmentAllowed|C_GuildInfo.IsGuildRankAssignmentAllowed]](<span class="apiarg">guid, rankOrder</span>) : <span class="apiret">isGuildRankAssignmentAllowed</span> |
− | : [[API C_GuildInfo.QueryGuildMemberRecipes|C_GuildInfo.QueryGuildMemberRecipes]](<span |
+ | : [[API C_GuildInfo.QueryGuildMemberRecipes|C_GuildInfo.QueryGuildMemberRecipes]](<span class="apiarg">guildMemberGUID, skillLineID</span>) - Shows the guild member recipes for a profession. |
− | : [[API C_GuildInfo. |
+ | : [[API C_GuildInfo.QueryGuildMembersForRecipe|C_GuildInfo.QueryGuildMembersForRecipe]](<span class="apiarg">skillLineID, recipeSpellID [, recipeLevel]</span>) : <span class="apiret">updatedRecipeSpellID</span> |
− | : [[API C_GuildInfo. |
+ | : [[API C_GuildInfo.RemoveFromGuild|C_GuildInfo.RemoveFromGuild]](<span class="apiarg">guid</span>) - Removes a member from the guild. |
− | : [[API C_GuildInfo. |
+ | : [[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 AcceptGuild|AcceptGuild]]() - The player accepts the invitation to join a guild. |
||
+ | : [[API AcceptGuild|AcceptGuild]]() - Accepts a guild invite. |
||
− | : [[API BuyGuildCharter|BuyGuildCharter]](<span style="font-size:smaller; color:#ecbc2a">guildName</span>) - Purchases a guild charter for ''guildName''. |
||
+ | : [[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 |
+ | : [[API CanEditGuildTabInfo|CanEditGuildTabInfo]](<span class="apiarg">tab</span>) |
− | : [[API CanEditMOTD|CanEditMOTD]]() - Returns true if |
+ | : [[API CanEditMOTD|CanEditMOTD]]() - Returns 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 |
+ | : [[API CanGuildDemote|CanGuildDemote]]() - Returns true if the player can demote guild members. |
− | : [[API CanGuildInvite|CanGuildInvite]]() - Returns true if |
+ | : [[API CanGuildInvite|CanGuildInvite]]() - Returns true if the player can invite new members to the guild. |
− | : [[API CanGuildPromote|CanGuildPromote]]() - Returns true if |
+ | : [[API CanGuildPromote|CanGuildPromote]]() - Returns 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. |
||
− | : [[API CanViewGuildRecipes|CanViewGuildRecipes]](<span |
+ | : [[API CanViewGuildRecipes|CanViewGuildRecipes]](<span class="apiarg">skillLineID</span>) |
: [[API CloseGuildRegistrar|CloseGuildRegistrar]]() |
: [[API CloseGuildRegistrar|CloseGuildRegistrar]]() |
||
: [[API CloseGuildRoster|CloseGuildRoster]]() |
: [[API CloseGuildRoster|CloseGuildRoster]]() |
||
: [[API CloseTabardCreation|CloseTabardCreation]]() |
: [[API CloseTabardCreation|CloseTabardCreation]]() |
||
− | : [[API CollapseGuildTradeSkillHeader|CollapseGuildTradeSkillHeader]](<span |
+ | : [[API CollapseGuildTradeSkillHeader|CollapseGuildTradeSkillHeader]](<span class="apiarg">tradeSkillID</span>) |
− | : [[API DeclineGuild|DeclineGuild]]() - |
+ | : [[API DeclineGuild|DeclineGuild]]() - Declines a guild invite. |
− | : [[API ExpandGuildTradeSkillHeader|ExpandGuildTradeSkillHeader]](<span |
+ | : [[API ExpandGuildTradeSkillHeader|ExpandGuildTradeSkillHeader]](<span class="apiarg">tradeSkillID</span>) |
− | : [[API GetAutoDeclineGuildInvites|GetAutoDeclineGuildInvites]]() - Returns if guild invites are |
+ | : [[API GetAutoDeclineGuildInvites|GetAutoDeclineGuildInvites]]() - Returns true if guild invites are being automatically declined. |
− | : [[API GetDemotionRank|GetDemotionRank]](<span |
+ | : [[API GetDemotionRank|GetDemotionRank]](<span class="apiarg">index</span>) |
: [[API GetGuildCategoryList|GetGuildCategoryList]]() |
: [[API GetGuildCategoryList|GetGuildCategoryList]]() |
||
− | : [[API GetGuildChallengeInfo|GetGuildChallengeInfo]](<span |
+ | : [[API GetGuildChallengeInfo|GetGuildChallengeInfo]](<span class="apiarg">index</span>) |
: [[API GetGuildCharterCost|GetGuildCharterCost]]() - Returns the cost of purchasing a guild charter. |
: [[API GetGuildCharterCost|GetGuildCharterCost]]() - Returns the cost of purchasing a guild charter. |
||
− | : [[API GetGuildEventInfo|GetGuildEventInfo]](<span |
+ | : [[API GetGuildEventInfo|GetGuildEventInfo]](<span class="apiarg">index</span>) - Returns the event information. |
: [[API GetGuildExpirationTime|GetGuildExpirationTime]]() |
: [[API GetGuildExpirationTime|GetGuildExpirationTime]]() |
||
: [[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 style="font-size:smaller; color:#ecbc2a">unit</span>) - This function returns the name of the guild ''unit'' belongs to. |
||
: [[API GetGuildLogoInfo|GetGuildLogoInfo]]() |
: [[API GetGuildLogoInfo|GetGuildLogoInfo]]() |
||
− | : [[API GetGuildMemberRecipes|GetGuildMemberRecipes]](<span |
+ | : [[API GetGuildMemberRecipes|GetGuildMemberRecipes]](<span class="apiarg">name, skillLineID</span>) |
: [[API GetGuildNewsFilters|GetGuildNewsFilters]]() |
: [[API GetGuildNewsFilters|GetGuildNewsFilters]]() |
||
− | : [[API GetGuildNewsMemberName|GetGuildNewsMemberName]](<span |
+ | : [[API GetGuildNewsMemberName|GetGuildNewsMemberName]](<span class="apiarg">index, nameIndex</span>) |
: [[API GetGuildNewsSort|GetGuildNewsSort]]() |
: [[API GetGuildNewsSort|GetGuildNewsSort]]() |
||
: [[API GetGuildPerkInfo|GetGuildPerkInfo]]() |
: [[API GetGuildPerkInfo|GetGuildPerkInfo]]() |
||
: [[API GetGuildRecipeInfoPostQuery|GetGuildRecipeInfoPostQuery]]() |
: [[API GetGuildRecipeInfoPostQuery|GetGuildRecipeInfoPostQuery]]() |
||
− | : [[API GetGuildRecipeMember|GetGuildRecipeMember]](<span |
+ | : [[API GetGuildRecipeMember|GetGuildRecipeMember]](<span class="apiarg">index</span>) |
: [[API GetGuildRenameRequired|GetGuildRenameRequired]]() |
: [[API GetGuildRenameRequired|GetGuildRenameRequired]]() |
||
− | : [[API GetGuildRewardInfo|GetGuildRewardInfo]](<span |
+ | : [[API GetGuildRewardInfo|GetGuildRewardInfo]](<span class="apiarg">index</span>) |
− | : [[API GetGuildRosterInfo|GetGuildRosterInfo]](<span |
+ | : [[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 |
+ | : [[API GetGuildRosterLastOnline|GetGuildRosterLastOnline]](<span class="apiarg">index</span>) - Returns time since the guild member was last online. |
− | : [[API GetGuildRosterMOTD|GetGuildRosterMOTD]]() - Returns guild |
+ | : [[API GetGuildRosterMOTD|GetGuildRosterMOTD]]() - Returns the guild message of the day. |
− | : [[API GetGuildRosterSelection|GetGuildRosterSelection]]() - Returns the index of the |
+ | : [[API GetGuildRosterSelection|GetGuildRosterSelection]]() - Returns the index of the selected guild member in the roster. |
− | : [[API GetGuildRosterShowOffline|GetGuildRosterShowOffline]]() - Returns true if |
+ | : [[API GetGuildRosterShowOffline|GetGuildRosterShowOffline]]() - Returns 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 |
+ | : [[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,381: | Line 3,141: | ||
: [[API GetNumGuildRewards|GetNumGuildRewards]]() |
: [[API GetNumGuildRewards|GetNumGuildRewards]]() |
||
: [[API GetNumGuildTradeSkill|GetNumGuildTradeSkill]]() - Returns the number of tradeskills available to the guild UI. |
: [[API GetNumGuildTradeSkill|GetNumGuildTradeSkill]]() - Returns the number of tradeskills available to the guild UI. |
||
− | : [[API GetNumMembersInRank|GetNumMembersInRank]](<span |
+ | : [[API GetNumMembersInRank|GetNumMembersInRank]](<span class="apiarg">index</span>) |
− | : [[API GetPromotionRank|GetPromotionRank]](<span |
+ | : [[API GetPromotionRank|GetPromotionRank]](<span class="apiarg">index</span>) |
: [[API GetTabardCreationCost|GetTabardCreationCost]]() - Returns cost in coppers. |
: [[API GetTabardCreationCost|GetTabardCreationCost]]() - Returns cost in coppers. |
||
: [[API GetTabardInfo|GetTabardInfo]]() |
: [[API GetTabardInfo|GetTabardInfo]]() |
||
− | : [[API GuildControlAddRank|GuildControlAddRank]](<span |
+ | : [[API GuildControlAddRank|GuildControlAddRank]](<span class="apiarg">name</span>) - Add another rank called "name". Only Guildmaster. |
− | : [[API GuildControlDelRank|GuildControlDelRank]](<span |
+ | : [[API GuildControlDelRank|GuildControlDelRank]](<span class="apiarg">name</span>) - Deletes a guild rank. |
− | : [[API GuildControlGetAllowedShifts|GuildControlGetAllowedShifts]](<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 |
+ | : [[API GuildControlGetRankName|GuildControlGetRankName]](<span class="apiarg">index</span>) - Returns a guild rank name by index. |
− | : [[API GuildControlSaveRank|GuildControlSaveRank]](<span |
+ | : [[API GuildControlSaveRank|GuildControlSaveRank]](<span class="apiarg">name</span>) - Saves the current rank name. |
+ | : [[API GuildControlSetRank|GuildControlSetRank]](<span class="apiarg">rank</span>) {{apitag|protected}} - Selects a guild rank. |
||
− | : [[API GuildControlSetRankFlag|GuildControlSetRankFlag]](<span style="font-size:smaller; color:#ecbc2a">index, enabled</span>) - Enable/disable permission for an action at index. Only Guildmaster. |
||
− | : [[API |
+ | : [[API GuildControlSetRankFlag|GuildControlSetRankFlag]](<span class="apiarg">index, enabled</span>) {{apitag|protected}} - Sets guild rank permissions. |
− | : [[API GuildControlShiftRankDown|GuildControlShiftRankDown]](<span |
+ | : [[API GuildControlShiftRankDown|GuildControlShiftRankDown]](<span class="apiarg">rankOrder</span>) |
− | : [[API GuildControlShiftRankUp|GuildControlShiftRankUp]](<span |
+ | : [[API GuildControlShiftRankUp|GuildControlShiftRankUp]](<span class="apiarg">rankOrder</span>) |
− | : |
+ | : [[API GuildDemote|GuildDemote]](<span class="apiarg">name</span>) {{apitag|protected}} - Demotes the specified player in the guild. |
− | : [[API GuildDisband|GuildDisband]]() - Disbands |
+ | : [[API GuildDisband|GuildDisband]]() - Disbands the guild; no warning is given. |
− | : [[API GuildInfo|GuildInfo]]() - |
+ | : [[API GuildInfo|GuildInfo]]() - Prints info for the guild the player belongs to. |
− | : [[API GuildInvite|GuildInvite]](<span |
+ | : [[API GuildInvite|GuildInvite]](<span class="apiarg">name</span>) {{apitag|hwevent}} - 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 |
+ | : [[API GuildNewsSetSticky|GuildNewsSetSticky]](<span class="apiarg">index, bool</span>) |
− | : [[API GuildNewsSort|GuildNewsSort]](<span |
+ | : [[API GuildNewsSort|GuildNewsSort]](<span class="apiarg">byDate</span>) |
− | : |
+ | : [[API GuildPromote|GuildPromote]](<span class="apiarg">name</span>) {{apitag|protected}} - Promotes the specified player in the guild. |
− | : [[API GuildRosterSetOfficerNote|GuildRosterSetOfficerNote]](<span |
+ | : [[API GuildRosterSetOfficerNote|GuildRosterSetOfficerNote]](<span class="apiarg">index, note</span>) - Sets the officer note of a guild member. |
− | : [[API GuildRosterSetPublicNote|GuildRosterSetPublicNote]](<span |
+ | : [[API GuildRosterSetPublicNote|GuildRosterSetPublicNote]](<span class="apiarg">index, note</span>) - Sets the public note of a guild member. |
− | : [[API GuildSetLeader|GuildSetLeader]](<span |
+ | : [[API GuildSetLeader|GuildSetLeader]](<span class="apiarg">name</span>) - Transfers guild leadership to another player. |
− | : [[API GuildSetMOTD|GuildSetMOTD]](<span |
+ | : [[API GuildSetMOTD|GuildSetMOTD]](<span class="apiarg">note</span>) - Sets the guild message of the day. |
− | : |
+ | : [[API GuildUninvite|GuildUninvite]](<span class="apiarg">name</span>) {{apitag|protected}} - Removes a player from the guild. |
− | : [[API IsGuildLeader|IsGuildLeader]](<span |
+ | : [[API IsGuildLeader|IsGuildLeader]](<span class="apiarg">name</span>) - Returns true if the player is the guild master. |
− | : [[API IsGuildMember|IsGuildMember]](<span |
+ | : [[API IsGuildMember|IsGuildMember]](<span class="apiarg">guid or unitToken</span>) |
− | : [[API IsGuildRankAssignmentAllowed|IsGuildRankAssignmentAllowed]](<span |
+ | : [[API IsGuildRankAssignmentAllowed|IsGuildRankAssignmentAllowed]](<span class="apiarg">playerIndex, rankIndex</span>) |
: [[API IsInAuthenticatedRank|IsInAuthenticatedRank]]() |
: [[API IsInAuthenticatedRank|IsInAuthenticatedRank]]() |
||
: [[API IsInGuild|IsInGuild]]() - Lets you know whether you are in a guild. |
: [[API IsInGuild|IsInGuild]]() - Lets you know whether you are in a guild. |
||
: [[API QueryGuildEventLog|QueryGuildEventLog]]() - Fetches the guild event list and fires a GUILD_EVENT_LOG_UPDATE event. |
: [[API QueryGuildEventLog|QueryGuildEventLog]]() - Fetches the guild event list and fires a GUILD_EVENT_LOG_UPDATE event. |
||
− | : [[API QueryGuildMembersForRecipe|QueryGuildMembersForRecipe]](<span style="font-size:smaller; color:#ecbc2a">skillLineID, recipeID</span>) |
||
: [[API QueryGuildNews|QueryGuildNews]]() |
: [[API QueryGuildNews|QueryGuildNews]]() |
||
: [[API QueryGuildRecipes|QueryGuildRecipes]]() |
: [[API QueryGuildRecipes|QueryGuildRecipes]]() |
||
Line 2,422: | Line 3,181: | ||
: [[API RequestGuildPartyState|RequestGuildPartyState]]() |
: [[API RequestGuildPartyState|RequestGuildPartyState]]() |
||
: [[API RequestGuildRewards|RequestGuildRewards]]() |
: [[API RequestGuildRewards|RequestGuildRewards]]() |
||
− | : [[API SetAutoDeclineGuildInvites|SetAutoDeclineGuildInvites]](<span |
+ | : [[API SetAutoDeclineGuildInvites|SetAutoDeclineGuildInvites]](<span class="apiarg">checked</span>) - Sets whether guild invites should be automatically declined. |
− | : [[API SetGuildInfoText|SetGuildInfoText]]() - Sets the |
+ | : [[API SetGuildInfoText|SetGuildInfoText]]() - Sets the guild info text. |
− | : [[API SetGuildMemberRank|SetGuildMemberRank]](<span |
+ | : [[API SetGuildMemberRank|SetGuildMemberRank]](<span class="apiarg">playerIndex, rankIndex</span>) |
− | : [[API SetGuildNewsFilter|SetGuildNewsFilter]](<span |
+ | : [[API SetGuildNewsFilter|SetGuildNewsFilter]](<span class="apiarg">index, bool</span>) |
− | : [[API SetGuildRosterSelection|SetGuildRosterSelection]](<span |
+ | : [[API SetGuildRosterSelection|SetGuildRosterSelection]](<span class="apiarg">index</span>) - Selects a guild member in the roster. |
− | : [[API SetGuildRosterShowOffline|SetGuildRosterShowOffline]](<span |
+ | : [[API SetGuildRosterShowOffline|SetGuildRosterShowOffline]](<span class="apiarg">enabled</span>) - Sets the show offline guild members flag. |
− | : [[API SetGuildTradeSkillCategoryFilter|SetGuildTradeSkillCategoryFilter]](<span |
+ | : [[API SetGuildTradeSkillCategoryFilter|SetGuildTradeSkillCategoryFilter]](<span class="apiarg">tradeSkillID</span>) |
− | : [[API SetGuildTradeSkillItemNameFilter|SetGuildTradeSkillItemNameFilter]](<span |
+ | : [[API SetGuildTradeSkillItemNameFilter|SetGuildTradeSkillItemNameFilter]](<span class="apiarg">itemName</span>) |
− | : [[API SortGuildRoster|SortGuildRoster]](<span |
+ | : [[API SortGuildRoster|SortGuildRoster]](<span class="apiarg">sort</span>) - Sorts the guild roster on a certain column. |
− | : [[API SortGuildTradeSkill|SortGuildTradeSkill]](<span |
+ | : [[API SortGuildTradeSkill|SortGuildTradeSkill]](<span class="apiarg">type</span>) |
: [[API SubmitRequiredGuildRename|SubmitRequiredGuildRename]]() |
: [[API SubmitRequiredGuildRename|SubmitRequiredGuildRename]]() |
||
− | : [[API ViewGuildRecipes|ViewGuildRecipes]](<span |
+ | : [[API ViewGuildRecipes|ViewGuildRecipes]](<span class="apiarg">skillLineID</span>) |
− | The [[Guild Finder]] was added in [[Patch 4.1.0]]. |
||
− | : [[API CancelGuildMembershipRequest|CancelGuildMembershipRequest]]() |
||
− | : [[API DeclineGuildApplicant|DeclineGuildApplicant]]() |
||
− | : [[API GetGuildApplicantInfo|GetGuildApplicantInfo]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Returns information about a guild applicant. |
||
− | : [[API GetGuildApplicantSelection|GetGuildApplicantSelection]]() |
||
− | : [[API GetGuildMembershipRequestInfo|GetGuildMembershipRequestInfo]]() |
||
− | : [[API GetGuildMembershipRequestSettings|GetGuildMembershipRequestSettings]]() |
||
− | : [[API GetGuildRecruitmentComment|GetGuildRecruitmentComment]]() |
||
− | : [[API GetGuildRecruitmentSettings|GetGuildRecruitmentSettings]]() |
||
− | : [[API GetLookingForGuildComment|GetLookingForGuildComment]]() |
||
− | : [[API GetLookingForGuildSettings|GetLookingForGuildSettings]]() |
||
− | : [[API GetNumGuildApplicants|GetNumGuildApplicants]]() - Returns the total number of guild applicants. |
||
− | : [[API GetNumGuildMembershipRequests|GetNumGuildMembershipRequests]]() |
||
− | : [[API GetNumRecruitingGuilds|GetNumRecruitingGuilds]]() |
||
− | : [[API GetRecruitingGuildInfo|GetRecruitingGuildInfo]]() |
||
− | : [[API GetRecruitingGuildSelection|GetRecruitingGuildSelection]]() |
||
− | : [[API GetRecruitingGuildSettings|GetRecruitingGuildSettings]]() |
||
− | : [[API RequestGuildApplicantsList|RequestGuildApplicantsList]]() - Requests information about guild applicants. |
||
− | : [[API RequestGuildMembershipList|RequestGuildMembershipList]]() |
||
− | : [[API RequestGuildMembership|RequestGuildMembership]]() |
||
− | : [[API RequestGuildRecruitmentSettings|RequestGuildRecruitmentSettings]]() |
||
− | : [[API RequestRecruitingGuildsList|RequestRecruitingGuildsList]]() |
||
− | : [[API SetGuildApplicantSelection|SetGuildApplicantSelection]]() |
||
− | : [[API SetGuildRecruitmentComment|SetGuildRecruitmentComment]](<span style="font-size:smaller; color:#ecbc2a">text</span>) |
||
− | : [[API SetGuildRecruitmentSettings|SetGuildRecruitmentSettings]](<span style="font-size:smaller; color:#ecbc2a">index, true/false</span>) |
||
− | : [[API SetLookingForGuildComment|SetLookingForGuildComment]]() |
||
− | : [[API SetLookingForGuildSettings|SetLookingForGuildSettings]](<span style="font-size:smaller; color:#ecbc2a">index, true/false</span>) |
||
− | : [[API SetRecruitingGuildSelection|SetRecruitingGuildSelection]]() |
||
− | === |
+ | ===Petitions=== |
+ | Petitions are signup documents for guilds and arena teams. Some functions below only apply to a particular petition type |
||
− | : [[API CanInspect|CanInspect]](<span style="font-size:smaller; color:#ecbc2a">unit [, showError]</span>) - Returns whether you can inspect the specified unit. |
||
+ | : [[API CanSignPetition|CanSignPetition]]() - Returns nil if the player cannot sign the current petition. |
||
− | : [[API CheckInteractDistance|CheckInteractDistance]](<span style="font-size:smaller; color:#ecbc2a">unit, interaction</span>) - Returns whether you're in range to perform various interactions with the specified unit. |
||
− | : [[API |
+ | : [[API ClosePetition|ClosePetition]]() - Closes the current petition. |
+ | : [[API GetNumPetitionNames|GetNumPetitionNames]]() - Returns the number of signatures on the current petition. |
||
− | : [[API GetInspectArenaData|GetInspectArenaData]](<span style="font-size:smaller; color:#ecbc2a">bracketIndex</span>) |
||
+ | : [[API GetPetitionInfo|GetPetitionInfo]]() - Returns info for the petition being viewed. |
||
− | : [[API GetInspectGuildInfo|GetInspectGuildInfo]](<span style="font-size:smaller; color:#ecbc2a">unit</span>) |
||
− | : [[API |
+ | : [[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. |
||
− | : [[API GetInspectRatedBGData|GetInspectRatedBGData]]() |
||
− | : [[API |
+ | : [[API RenamePetition|RenamePetition]](<span class="apiarg">name</span>) - Renames the current petition. |
+ | : [[API SignPetition|SignPetition]]() - Signs the currently viewed petition. |
||
− | : [[API GetInspectTalent|GetInspectTalent]]() |
||
+ | : [[API TurnInGuildCharter|TurnInGuildCharter]]() - Founds a guild. |
||
− | : [[API NotifyInspect|NotifyInspect]](<span style="font-size:smaller; color:#ecbc2a">unit</span>) - Requests information about a unit's inventory and talents from the server. |
||
− | : UI [[API InspectUnit|InspectUnit]](<span style="font-size:smaller; color:#ecbc2a">unit</span>) - Instructs FrameXML to inspect a particular unit (query server; show UI). |
||
− | : DEPRECATED (8.1.5) [[API HasInspectHonorData|HasInspectHonorData]]() |
||
− | : DEPRECATED (8.1.5) [[API RequestInspectHonorData|RequestInspectHonorData]]() |
||
− | : REMOVED (8.1.5) [[API GetInspectGlyph|GetInspectGlyph]]() |
||
− | == |
+ | ==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 CanChangePlayerDifficulty|CanChangePlayerDifficulty]]() |
: [[API CanChangePlayerDifficulty|CanChangePlayerDifficulty]]() |
||
: [[API CanMapChangeDifficulty|CanMapChangeDifficulty]]() |
: [[API CanMapChangeDifficulty|CanMapChangeDifficulty]]() |
||
− | : [[API CanShowResetInstances|CanShowResetInstances]]() - |
+ | : [[API CanShowResetInstances|CanShowResetInstances]]() - Returns 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 |
+ | : [[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]]() - |
+ | : [[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 |
+ | : [[API GetRaidDifficultyID|GetRaidDifficultyID]]() - Returns the player's currently selected raid difficulty. |
− | : [[API IsInInstance|IsInInstance]]() - Returns |
+ | : [[API IsInInstance|IsInInstance]]() - Returns true if the player is in an instance, and the type of instance. |
− | : [[API IsLegacyDifficulty|IsLegacyDifficulty]](<span |
+ | : [[API IsLegacyDifficulty|IsLegacyDifficulty]](<span class="apiarg">difficultyID</span>) |
− | : [[API ResetInstances|ResetInstances]]() - |
+ | : [[API ResetInstances|ResetInstances]]() - Resets all instances for the character. |
− | : [[API SetDungeonDifficultyID|SetDungeonDifficultyID]](<span |
+ | : [[API SetDungeonDifficultyID|SetDungeonDifficultyID]](<span class="apiarg">difficultyID</span>) - Sets the player's dungeon difficulty. |
− | : [[API SetLegacyRaidDifficultyID|SetLegacyRaidDifficultyID]](<span |
+ | : [[API SetLegacyRaidDifficultyID|SetLegacyRaidDifficultyID]](<span class="apiarg">difficultyID [, force]</span>) |
− | : [[API SetRaidDifficultyID|SetRaidDifficultyID]](<span |
+ | : [[API SetRaidDifficultyID|SetRaidDifficultyID]](<span class="apiarg">difficultyID</span>) - Sets the raid difficulty. |
− | : [[API ShowBossFrameWhenUninteractable|ShowBossFrameWhenUninteractable]](<span |
+ | : [[API ShowBossFrameWhenUninteractable|ShowBossFrameWhenUninteractable]](<span class="apiarg">unit</span>) |
− | + | Relates to [[Raid lockout|Instance Locks]] |
|
+ | : [[API GetInstanceLockTimeRemaining|GetInstanceLockTimeRemaining]]() - Returns info for the instance lock timer for the current instance. |
||
− | : [[API GetInstanceLockTimeRemainingEncounter|GetInstanceLockTimeRemainingEncounter]](<span style="font-size:smaller; color:#ecbc2a">id</span>) - Returns information about bosses in the instance the player is about to be saved to. |
||
− | : [[API |
+ | : [[API GetInstanceLockTimeRemainingEncounter|GetInstanceLockTimeRemainingEncounter]](<span class="apiarg">id</span>) - Returns information about bosses in the instance the player is about to be saved to. |
− | : [[API GetNumSavedInstances|GetNumSavedInstances]]() - |
+ | : [[API GetNumSavedInstances|GetNumSavedInstances]]() - Returns the number of instances for which the character is locked out. |
: [[API GetNumSavedWorldBosses|GetNumSavedWorldBosses]]() |
: [[API GetNumSavedWorldBosses|GetNumSavedWorldBosses]]() |
||
− | : [[API GetSavedInstanceChatLink|GetSavedInstanceChatLink]](<span |
+ | : [[API GetSavedInstanceChatLink|GetSavedInstanceChatLink]](<span class="apiarg">index</span>) |
− | : [[API GetSavedInstanceEncounterInfo|GetSavedInstanceEncounterInfo]](<span |
+ | : [[API GetSavedInstanceEncounterInfo|GetSavedInstanceEncounterInfo]](<span class="apiarg">instanceIndex, encounterIndex</span>) |
− | : [[API GetSavedInstanceInfo|GetSavedInstanceInfo]](<span |
+ | : [[API GetSavedInstanceInfo|GetSavedInstanceInfo]](<span class="apiarg">index</span>) - Returns instance lock info. |
− | : [[API GetSavedWorldBossInfo|GetSavedWorldBossInfo]](<span |
+ | : [[API GetSavedWorldBossInfo|GetSavedWorldBossInfo]](<span class="apiarg">index</span>) |
− | : [[API RequestRaidInfo|RequestRaidInfo]]() - |
+ | : [[API RequestRaidInfo|RequestRaidInfo]]() - Requests which instances the player is saved to. |
: [[API RespondInstanceLock|RespondInstanceLock]]() |
: [[API RespondInstanceLock|RespondInstanceLock]]() |
||
− | : [[API SetSavedInstanceExtend|SetSavedInstanceExtend]](<span |
+ | : [[API SetSavedInstanceExtend|SetSavedInstanceExtend]](<span class="apiarg">index, extend</span>) |
− | === |
+ | ===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 |
+ | : [[API C_Scenario.GetBonusStepRewardQuestID|C_Scenario.GetBonusStepRewardQuestID]](<span class="apiarg">stepIndex</span>) |
: [[API C_Scenario.GetBonusSteps|C_Scenario.GetBonusSteps]]() |
: [[API C_Scenario.GetBonusSteps|C_Scenario.GetBonusSteps]]() |
||
− | : [[API C_Scenario.GetCriteriaInfo|C_Scenario.GetCriteriaInfo]](<span |
+ | : [[API C_Scenario.GetCriteriaInfo|C_Scenario.GetCriteriaInfo]](<span class="apiarg">criteriaIndex</span>) |
− | : [[API C_Scenario.GetCriteriaInfoByStep|C_Scenario.GetCriteriaInfoByStep]](<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 |
+ | : [[API C_Scenario.GetProvingGroundsInfo|C_Scenario.GetProvingGroundsInfo]]() - Returns info for the current [[Proving Grounds]] trial. |
− | : [[API C_Scenario.GetScenarioIconInfo|C_Scenario.GetScenarioIconInfo]](<span |
+ | : [[API C_Scenario.GetScenarioIconInfo|C_Scenario.GetScenarioIconInfo]](<span class="apiarg">uiMapID</span>) |
− | : [[API C_Scenario.GetStepInfo|C_Scenario.GetStepInfo]](<span |
+ | : [[API C_Scenario.GetStepInfo|C_Scenario.GetStepInfo]](<span class="apiarg">[bonusStepIndex]</span>) |
: [[API C_Scenario.GetSupersededObjectives|C_Scenario.GetSupersededObjectives]]() |
: [[API C_Scenario.GetSupersededObjectives|C_Scenario.GetSupersededObjectives]]() |
||
: [[API C_Scenario.IsInScenario|C_Scenario.IsInScenario]]() |
: [[API C_Scenario.IsInScenario|C_Scenario.IsInScenario]]() |
||
: [[API C_Scenario.ShouldShowCriteria|C_Scenario.ShouldShowCriteria]]() |
: [[API C_Scenario.ShouldShowCriteria|C_Scenario.ShouldShowCriteria]]() |
||
: [[API C_Scenario.TreatScenarioAsDungeon|C_Scenario.TreatScenarioAsDungeon]]() |
: [[API C_Scenario.TreatScenarioAsDungeon|C_Scenario.TreatScenarioAsDungeon]]() |
||
+ | : [[API C_ScenarioInfo.GetScenarioInfo|C_ScenarioInfo.GetScenarioInfo]]() : <span class="apiret">scenarioInfo</span> |
||
+ | : [[API C_ScenarioInfo.GetScenarioStepInfo|C_ScenarioInfo.GetScenarioStepInfo]](<span class="apiarg">[scenarioStepID]</span>) : <span class="apiret">scenarioStepInfo</span> |
||
: [[API GetNumRandomScenarios|GetNumRandomScenarios]]() |
: [[API GetNumRandomScenarios|GetNumRandomScenarios]]() |
||
: [[API GetNumScenarios|GetNumScenarios]]() |
: [[API GetNumScenarios|GetNumScenarios]]() |
||
: [[API GetRandomScenarioBestChoice|GetRandomScenarioBestChoice]]() |
: [[API GetRandomScenarioBestChoice|GetRandomScenarioBestChoice]]() |
||
− | : [[API GetRandomScenarioInfo|GetRandomScenarioInfo]](<span |
+ | : [[API GetRandomScenarioInfo|GetRandomScenarioInfo]](<span class="apiarg">index</span>) |
: [[API GetScenariosChoiceOrder|GetScenariosChoiceOrder]]() |
: [[API GetScenariosChoiceOrder|GetScenariosChoiceOrder]]() |
||
: [[API GetWorldElapsedTimers|GetWorldElapsedTimers]]() |
: [[API GetWorldElapsedTimers|GetWorldElapsedTimers]]() |
||
− | : [[API GetWorldElapsedTime|GetWorldElapsedTime]](<span |
+ | : [[API GetWorldElapsedTime|GetWorldElapsedTime]](<span class="apiarg">timerID</span>) |
: [[API IsInScenarioGroup|IsInScenarioGroup]]() |
: [[API IsInScenarioGroup|IsInScenarioGroup]]() |
||
− | === |
+ | ===Mythic+=== |
− | [[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]]() |
+ | : [[API C_MythicPlus.GetCurrentAffixes|C_MythicPlus.GetCurrentAffixes]]() : <span class="apiret">affixIDs</span> |
− | : [[API C_MythicPlus.GetCurrentSeason|C_MythicPlus.GetCurrentSeason]]() |
+ | : [[API C_MythicPlus.GetCurrentSeason|C_MythicPlus.GetCurrentSeason]]() : <span class="apiret">seasonID</span> |
− | : [[API C_MythicPlus. |
+ | : [[API C_MythicPlus.GetCurrentSeasonValues|C_MythicPlus.GetCurrentSeasonValues]]() : <span class="apiret">displaySeasonID, milestoneSeasonID, rewardSeasonID</span> |
− | : [[API C_MythicPlus. |
+ | : [[API C_MythicPlus.GetLastWeeklyBestInformation|C_MythicPlus.GetLastWeeklyBestInformation]]() : <span class="apiret">challengeMapId, level</span> |
− | : [[API C_MythicPlus. |
+ | : [[API C_MythicPlus.GetOwnedKeystoneChallengeMapID|C_MythicPlus.GetOwnedKeystoneChallengeMapID]]() : <span class="apiret">challengeMapID</span> |
− | : [[API C_MythicPlus. |
+ | : [[API C_MythicPlus.GetOwnedKeystoneLevel|C_MythicPlus.GetOwnedKeystoneLevel]]() : <span class="apiret">keyStoneLevel</span> |
− | : [[API C_MythicPlus. |
+ | : [[API C_MythicPlus.GetOwnedKeystoneMapID|C_MythicPlus.GetOwnedKeystoneMapID]]() : <span class="apiret">mapID</span> |
− | : [[API C_MythicPlus. |
+ | : [[API C_MythicPlus.GetRewardLevelForDifficultyLevel|C_MythicPlus.GetRewardLevelForDifficultyLevel]](<span class="apiarg">difficultyLevel</span>) : <span class="apiret">weeklyRewardLevel, endOfRunRewardLevel</span> |
− | : [[API C_MythicPlus. |
+ | : [[API C_MythicPlus.GetRewardLevelFromKeystoneLevel|C_MythicPlus.GetRewardLevelFromKeystoneLevel]](<span class="apiarg">keystoneLevel</span>) : <span class="apiret">rewardLevel</span> |
− | : [[API C_MythicPlus. |
+ | : [[API C_MythicPlus.GetRunHistory|C_MythicPlus.GetRunHistory]](<span class="apiarg">[includePreviousWeeks, includeIncompleteRuns]</span>) : <span class="apiret">runs</span> |
+ | : [[API C_MythicPlus.GetSeasonBestAffixScoreInfoForMap|C_MythicPlus.GetSeasonBestAffixScoreInfoForMap]](<span class="apiarg">mapChallengeModeID</span>) : <span class="apiret">affixScores, bestOverAllScore</span> |
||
− | : [[API C_MythicPlus.GetWeeklyChestRewardLevel|C_MythicPlus.GetWeeklyChestRewardLevel]]() |
||
− | : [[API C_MythicPlus. |
+ | : [[API C_MythicPlus.GetSeasonBestForMap|C_MythicPlus.GetSeasonBestForMap]](<span class="apiarg">mapChallengeModeID</span>) : <span class="apiret">intimeInfo, overtimeInfo</span> |
− | : [[API C_MythicPlus. |
+ | : [[API C_MythicPlus.GetSeasonBestMythicRatingFromThisExpansion|C_MythicPlus.GetSeasonBestMythicRatingFromThisExpansion]]() : <span class="apiret">bestSeasonScore, bestSeason</span> |
+ | : [[API C_MythicPlus.GetWeeklyBestForMap|C_MythicPlus.GetWeeklyBestForMap]](<span class="apiarg">mapChallengeModeID</span>) : <span class="apiret">durationSec, level, completionDate, affixIDs, members, dungeonScore</span> |
||
+ | : [[API C_MythicPlus.GetWeeklyChestRewardLevel|C_MythicPlus.GetWeeklyChestRewardLevel]]() : <span class="apiret">currentWeekBestLevel, weeklyRewardLevel, nextDifficultyWeeklyRewardLevel, nextBestLevel</span> |
||
+ | : [[API C_MythicPlus.IsMythicPlusActive|C_MythicPlus.IsMythicPlusActive]]() : <span class="apiret">isMythicPlusActive</span> |
||
+ | : [[API C_MythicPlus.IsWeeklyRewardAvailable|C_MythicPlus.IsWeeklyRewardAvailable]]() : <span class="apiret">weeklyRewardAvailable</span> |
||
: [[API C_MythicPlus.RequestCurrentAffixes|C_MythicPlus.RequestCurrentAffixes]]() |
: [[API C_MythicPlus.RequestCurrentAffixes|C_MythicPlus.RequestCurrentAffixes]]() |
||
: [[API C_MythicPlus.RequestMapInfo|C_MythicPlus.RequestMapInfo]]() |
: [[API C_MythicPlus.RequestMapInfo|C_MythicPlus.RequestMapInfo]]() |
||
: [[API C_MythicPlus.RequestRewards|C_MythicPlus.RequestRewards]]() |
: [[API C_MythicPlus.RequestRewards|C_MythicPlus.RequestRewards]]() |
||
+ | : [[API C_PlayerInfo.GetPlayerMythicPlusRatingSummary|C_PlayerInfo.GetPlayerMythicPlusRatingSummary]](<span class="apiarg">playerToken</span>) : <span class="apiret">ratingSummary</span> |
||
− | [[Challenge Mode]] was added in [[Patch 5.0.4]]. |
||
+ | [[Challenge Mode]] was added in [[Patch 5.0.4]] |
||
+ | : [[API C_ChallengeMode.CanUseKeystoneInCurrentMap|C_ChallengeMode.CanUseKeystoneInCurrentMap]](<span class="apiarg">itemLocation</span>) : <span class="apiret">canUse</span> |
||
: [[API C_ChallengeMode.ClearKeystone|C_ChallengeMode.ClearKeystone]]() |
: [[API C_ChallengeMode.ClearKeystone|C_ChallengeMode.ClearKeystone]]() |
||
: [[API C_ChallengeMode.CloseKeystoneFrame|C_ChallengeMode.CloseKeystoneFrame]]() |
: [[API C_ChallengeMode.CloseKeystoneFrame|C_ChallengeMode.CloseKeystoneFrame]]() |
||
− | : [[API C_ChallengeMode.GetActiveChallengeMapID|C_ChallengeMode.GetActiveChallengeMapID]]() |
+ | : [[API C_ChallengeMode.GetActiveChallengeMapID|C_ChallengeMode.GetActiveChallengeMapID]]() : <span class="apiret">mapChallengeModeID</span> |
− | : [[API C_ChallengeMode.GetActiveKeystoneInfo|C_ChallengeMode.GetActiveKeystoneInfo]]() |
+ | : [[API C_ChallengeMode.GetActiveKeystoneInfo|C_ChallengeMode.GetActiveKeystoneInfo]]() : <span class="apiret">activeKeystoneLevel, activeAffixIDs, wasActiveKeystoneCharged</span> |
− | : [[API C_ChallengeMode.GetAffixInfo|C_ChallengeMode.GetAffixInfo]](<span |
+ | : [[API C_ChallengeMode.GetAffixInfo|C_ChallengeMode.GetAffixInfo]](<span class="apiarg">affixID</span>) : <span class="apiret">name, description, filedataid</span> |
− | : [[API C_ChallengeMode.GetCompletionInfo|C_ChallengeMode.GetCompletionInfo]]() |
+ | : [[API C_ChallengeMode.GetCompletionInfo|C_ChallengeMode.GetCompletionInfo]]() : <span class="apiret">mapChallengeModeID, level, time, onTime, keystoneUpgradeLevels, practiceRun, oldOverallDungeonScore, newOverallDungeonScore, IsMapRecord, IsAffixRecord, PrimaryAffix, isEligibleForScore, members</span> |
− | : [[API C_ChallengeMode.GetDeathCount|C_ChallengeMode.GetDeathCount]]() |
+ | : [[API C_ChallengeMode.GetDeathCount|C_ChallengeMode.GetDeathCount]]() : <span class="apiret">numDeaths, timeLost</span> |
− | : [[API C_ChallengeMode. |
+ | : [[API C_ChallengeMode.GetDungeonScoreRarityColor|C_ChallengeMode.GetDungeonScoreRarityColor]](<span class="apiarg">dungeonScore</span>) : <span class="apiret">scoreColor</span> |
− | : [[API C_ChallengeMode. |
+ | : [[API C_ChallengeMode.GetGuildLeaders|C_ChallengeMode.GetGuildLeaders]]() : <span class="apiret">topAttempt</span> |
− | : [[API C_ChallengeMode. |
+ | : [[API C_ChallengeMode.GetKeystoneLevelRarityColor|C_ChallengeMode.GetKeystoneLevelRarityColor]](<span class="apiarg">level</span>) : <span class="apiret">levelScore</span> |
− | : [[API C_ChallengeMode. |
+ | : [[API C_ChallengeMode.GetMapScoreInfo|C_ChallengeMode.GetMapScoreInfo]]() : <span class="apiret">displayScores</span> |
− | : [[API C_ChallengeMode. |
+ | : [[API C_ChallengeMode.GetMapTable|C_ChallengeMode.GetMapTable]]() : <span class="apiret">mapChallengeModeIDs</span> |
− | : [[API C_ChallengeMode. |
+ | : [[API C_ChallengeMode.GetMapUIInfo|C_ChallengeMode.GetMapUIInfo]](<span class="apiarg">mapChallengeModeID</span>) : <span class="apiret">name, id, timeLimit, texture, backgroundTexture</span> |
− | : [[API C_ChallengeMode. |
+ | : [[API C_ChallengeMode.GetOverallDungeonScore|C_ChallengeMode.GetOverallDungeonScore]]() : <span class="apiret">overallDungeonScore</span> |
− | : [[API C_ChallengeMode. |
+ | : [[API C_ChallengeMode.GetPowerLevelDamageHealthMod|C_ChallengeMode.GetPowerLevelDamageHealthMod]](<span class="apiarg">powerLevel</span>) : <span class="apiret">damageMod, healthMod</span> |
− | : [[API C_ChallengeMode. |
+ | : [[API C_ChallengeMode.GetSlottedKeystoneInfo|C_ChallengeMode.GetSlottedKeystoneInfo]]() : <span class="apiret">mapChallengeModeID, affixIDs, keystoneLevel</span> |
+ | : [[API C_ChallengeMode.GetSpecificDungeonOverallScoreRarityColor|C_ChallengeMode.GetSpecificDungeonOverallScoreRarityColor]](<span class="apiarg">specificDungeonOverallScore</span>) : <span class="apiret">specificDungeonOverallScoreColor</span> |
||
+ | : [[API C_ChallengeMode.GetSpecificDungeonScoreRarityColor|C_ChallengeMode.GetSpecificDungeonScoreRarityColor]](<span class="apiarg">specificDungeonScore</span>) : <span class="apiret">specificDungeonScoreColor</span> |
||
+ | : [[API C_ChallengeMode.HasSlottedKeystone|C_ChallengeMode.HasSlottedKeystone]]() : <span class="apiret">hasSlottedKeystone</span> |
||
+ | : [[API C_ChallengeMode.IsChallengeModeActive|C_ChallengeMode.IsChallengeModeActive]]() : <span class="apiret">challengeModeActive</span> |
||
+ | : [[API C_ChallengeMode.RemoveKeystone|C_ChallengeMode.RemoveKeystone]]() : <span class="apiret">removalSuccessful</span> |
||
+ | : [[API C_ChallengeMode.RequestLeaders|C_ChallengeMode.RequestLeaders]](<span class="apiarg">mapChallengeModeID</span>) |
||
: [[API C_ChallengeMode.Reset|C_ChallengeMode.Reset]]() |
: [[API C_ChallengeMode.Reset|C_ChallengeMode.Reset]]() |
||
− | : [[API C_ChallengeMode.SetKeystoneTooltip|C_ChallengeMode.SetKeystoneTooltip]]() |
||
: [[API C_ChallengeMode.SlotKeystone|C_ChallengeMode.SlotKeystone]]() |
: [[API C_ChallengeMode.SlotKeystone|C_ChallengeMode.SlotKeystone]]() |
||
− | : [[API C_ChallengeMode.StartChallengeMode|C_ChallengeMode.StartChallengeMode]]() |
+ | : [[API C_ChallengeMode.StartChallengeMode|C_ChallengeMode.StartChallengeMode]]() : <span class="apiret">success</span> |
+ | |||
+ | ===Weekly Rewards=== |
||
+ | : [[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.ClaimReward|C_WeeklyRewards.ClaimReward]](<span class="apiarg">id</span>) |
||
+ | : [[API C_WeeklyRewards.CloseInteraction|C_WeeklyRewards.CloseInteraction]]() |
||
+ | : [[API C_WeeklyRewards.GetActivities|C_WeeklyRewards.GetActivities]](<span class="apiarg">[type]</span>) : <span class="apiret">activities</span> |
||
+ | : [[API C_WeeklyRewards.GetActivityEncounterInfo|C_WeeklyRewards.GetActivityEncounterInfo]](<span class="apiarg">type, index</span>) : <span class="apiret">info</span> |
||
+ | : [[API C_WeeklyRewards.GetConquestWeeklyProgress|C_WeeklyRewards.GetConquestWeeklyProgress]]() : <span class="apiret">weeklyProgress</span> |
||
+ | : [[API C_WeeklyRewards.GetExampleRewardItemHyperlinks|C_WeeklyRewards.GetExampleRewardItemHyperlinks]](<span class="apiarg">id</span>) : <span class="apiret">hyperlink, upgradeHyperlink</span> |
||
+ | : [[API C_WeeklyRewards.GetItemHyperlink|C_WeeklyRewards.GetItemHyperlink]](<span class="apiarg">itemDBID</span>) : <span class="apiret">hyperlink</span> |
||
+ | : [[API C_WeeklyRewards.GetNextMythicPlusIncrease|C_WeeklyRewards.GetNextMythicPlusIncrease]](<span class="apiarg">mythicPlusLevel</span>) : <span class="apiret">hasSeasonData, nextMythicPlusLevel, itemLevel</span> |
||
+ | : [[API C_WeeklyRewards.HasAvailableRewards|C_WeeklyRewards.HasAvailableRewards]]() : <span class="apiret">hasAvailableRewards</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.OnUIInteract|C_WeeklyRewards.OnUIInteract]]() |
||
− | == |
+ | ==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 |
+ | : [[API C_Item.CanViewItemPowers|C_Item.CanViewItemPowers]](<span class="apiarg">itemLoc</span>) : <span class="apiret">isItemViewable</span> |
− | : [[API C_Item.DoesItemExist|C_Item.DoesItemExist]](<span |
+ | : [[API C_Item.DoesItemExist|C_Item.DoesItemExist]](<span class="apiarg">emptiableItemLocation</span>) : <span class="apiret">itemExists</span> |
− | : [[API C_Item.DoesItemExistByID|C_Item.DoesItemExistByID]](<span |
+ | : [[API C_Item.DoesItemExistByID|C_Item.DoesItemExistByID]](<span class="apiarg">itemInfo</span>) : <span class="apiret">itemExists</span> |
− | : [[API C_Item.DoesItemMatchBonusTreeReplacement|C_Item.DoesItemMatchBonusTreeReplacement]](<span |
+ | : [[API C_Item.DoesItemMatchBonusTreeReplacement|C_Item.DoesItemMatchBonusTreeReplacement]](<span class="apiarg">itemLoc</span>) : <span class="apiret">matchesBonusTree</span> |
− | : [[API C_Item.GetCurrentItemLevel|C_Item.GetCurrentItemLevel]](<span |
+ | : [[API C_Item.GetCurrentItemLevel|C_Item.GetCurrentItemLevel]](<span class="apiarg">itemLocation</span>) : <span class="apiret">currentItemLevel</span> |
− | : [[API C_Item. |
+ | : [[API C_Item.GetItemConversionOutputIcon|C_Item.GetItemConversionOutputIcon]](<span class="apiarg">itemLoc</span>) : <span class="apiret">icon</span> |
− | : [[API C_Item. |
+ | : [[API C_Item.GetItemGUID|C_Item.GetItemGUID]](<span class="apiarg">itemLocation</span>) : <span class="apiret">itemGUID</span> |
− | : [[API C_Item. |
+ | : [[API C_Item.GetItemIcon|C_Item.GetItemIcon]](<span class="apiarg">itemLocation</span>) : <span class="apiret">icon</span> |
− | : [[API C_Item. |
+ | : [[API C_Item.GetItemIconByID|C_Item.GetItemIconByID]](<span class="apiarg">itemInfo</span>) : <span class="apiret">icon</span> |
− | : [[API C_Item. |
+ | : [[API C_Item.GetItemID|C_Item.GetItemID]](<span class="apiarg">itemLocation</span>) : <span class="apiret">itemID</span> |
− | : [[API C_Item. |
+ | : [[API C_Item.GetItemInventoryType|C_Item.GetItemInventoryType]](<span class="apiarg">itemLocation</span>) : <span class="apiret">inventoryType</span> |
− | : [[API C_Item. |
+ | : [[API C_Item.GetItemInventoryTypeByID|C_Item.GetItemInventoryTypeByID]](<span class="apiarg">itemInfo</span>) : <span class="apiret">inventoryType</span> |
− | : [[API C_Item. |
+ | : [[API C_Item.GetItemLink|C_Item.GetItemLink]](<span class="apiarg">itemLocation</span>) : <span class="apiret">itemLink</span> |
− | : [[API C_Item. |
+ | : [[API C_Item.GetItemName|C_Item.GetItemName]](<span class="apiarg">itemLocation</span>) : <span class="apiret">itemName</span> |
− | : [[API C_Item. |
+ | : [[API C_Item.GetItemNameByID|C_Item.GetItemNameByID]](<span class="apiarg">itemInfo</span>) : <span class="apiret">itemName</span> |
− | : [[API C_Item. |
+ | : [[API C_Item.GetItemQuality|C_Item.GetItemQuality]](<span class="apiarg">itemLocation</span>) : <span class="apiret">itemQuality</span> |
− | : [[API C_Item. |
+ | : [[API C_Item.GetItemQualityByID|C_Item.GetItemQualityByID]](<span class="apiarg">itemInfo</span>) : <span class="apiret">itemQuality</span> |
− | : [[API C_Item. |
+ | : [[API C_Item.GetItemUniquenessByID|C_Item.GetItemUniquenessByID]](<span class="apiarg">itemInfo</span>) : <span class="apiret">isUnique, limitCategoryName, limitCategoryCount, limitCategoryID</span> |
− | : [[API C_Item. |
+ | : [[API C_Item.GetStackCount|C_Item.GetStackCount]](<span class="apiarg">itemLocation</span>) : <span class="apiret">stackCount</span> |
− | : [[API C_Item. |
+ | : [[API C_Item.IsBound|C_Item.IsBound]](<span class="apiarg">itemLocation</span>) : <span class="apiret">isBound</span> |
− | : [[API C_Item. |
+ | : [[API C_Item.IsItemConvertibleAndValidForPlayer|C_Item.IsItemConvertibleAndValidForPlayer]](<span class="apiarg">itemLoc</span>) : <span class="apiret">isItemConvertibleAndValidForPlayer</span> |
− | : [[API C_Item. |
+ | : [[API C_Item.IsItemDataCached|C_Item.IsItemDataCached]](<span class="apiarg">itemLocation</span>) : <span class="apiret">isCached</span> |
− | : [[API C_Item. |
+ | : [[API C_Item.IsItemDataCachedByID|C_Item.IsItemDataCachedByID]](<span class="apiarg">itemInfo</span>) : <span class="apiret">isCached</span> |
− | : [[API C_Item. |
+ | : [[API C_Item.IsItemKeystoneByID|C_Item.IsItemKeystoneByID]](<span class="apiarg">itemInfo</span>) : <span class="apiret">isKeystone</span> |
− | : [[API C_Item. |
+ | : [[API C_Item.IsItemSpecificToPlayerClass|C_Item.IsItemSpecificToPlayerClass]](<span class="apiarg">itemInfo</span>) : <span class="apiret">isItemSpecificToPlayerClass</span> |
− | : [[API C_Item. |
+ | : [[API C_Item.IsLocked|C_Item.IsLocked]](<span class="apiarg">itemLocation</span>) : <span class="apiret">isLocked</span> |
− | : [[API C_Item. |
+ | : [[API C_Item.LockItem|C_Item.LockItem]](<span class="apiarg">itemLocation</span>) |
− | : [[API C_Item. |
+ | : [[API C_Item.LockItemByGUID|C_Item.LockItemByGUID]](<span class="apiarg">itemGUID</span>) |
+ | : [[API C_Item.RequestLoadItemData|C_Item.RequestLoadItemData]](<span class="apiarg">itemLocation</span>) |
||
+ | : [[API C_Item.RequestLoadItemDataByID|C_Item.RequestLoadItemDataByID]](<span class="apiarg">itemInfo</span>) |
||
+ | : [[API C_Item.UnlockItem|C_Item.UnlockItem]](<span class="apiarg">itemLocation</span>) |
||
+ | : [[API C_Item.UnlockItemByGUID|C_Item.UnlockItemByGUID]](<span class="apiarg">itemGUID</span>) |
||
: [[API C_ItemInteraction.ClearPendingItem|C_ItemInteraction.ClearPendingItem]]() |
: [[API C_ItemInteraction.ClearPendingItem|C_ItemInteraction.ClearPendingItem]]() |
||
: [[API C_ItemInteraction.CloseUI|C_ItemInteraction.CloseUI]]() |
: [[API C_ItemInteraction.CloseUI|C_ItemInteraction.CloseUI]]() |
||
− | : [[API C_ItemInteraction. |
+ | : [[API C_ItemInteraction.GetChargeInfo|C_ItemInteraction.GetChargeInfo]]() : <span class="apiret">chargeInfo</span> |
− | : [[API C_ItemInteraction. |
+ | : [[API C_ItemInteraction.GetItemConversionCurrencyCost|C_ItemInteraction.GetItemConversionCurrencyCost]](<span class="apiarg">item</span>) : <span class="apiret">conversionCost</span> |
+ | : [[API C_ItemInteraction.GetItemInteractionInfo|C_ItemInteraction.GetItemInteractionInfo]]() : <span class="apiret">info</span> |
||
+ | : [[API C_ItemInteraction.GetItemInteractionSpellId|C_ItemInteraction.GetItemInteractionSpellId]]() : <span class="apiret">spellId</span> |
||
: [[API C_ItemInteraction.InitializeFrame|C_ItemInteraction.InitializeFrame]]() |
: [[API C_ItemInteraction.InitializeFrame|C_ItemInteraction.InitializeFrame]]() |
||
: [[API C_ItemInteraction.PerformItemInteraction|C_ItemInteraction.PerformItemInteraction]]() |
: [[API C_ItemInteraction.PerformItemInteraction|C_ItemInteraction.PerformItemInteraction]]() |
||
: [[API C_ItemInteraction.Reset|C_ItemInteraction.Reset]]() |
: [[API C_ItemInteraction.Reset|C_ItemInteraction.Reset]]() |
||
− | : [[API C_ItemInteraction.SetPendingItem|C_ItemInteraction.SetPendingItem]](<span |
+ | : [[API C_ItemInteraction.SetPendingItem|C_ItemInteraction.SetPendingItem]](<span class="apiarg">[item]</span>) : <span class="apiret">success</span> |
− | : [[API C_ItemUpgrade.GetItemHyperlink|C_ItemUpgrade.GetItemHyperlink]]() |
||
: [[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 |
+ | : [[API C_NewItems.IsNewItem|C_NewItems.IsNewItem]](<span class="apiarg">containerIndex, slotIndex</span>) : <span class="apiret">isNew</span> - Returns true if the item in the inventory slot is flagged as new. |
− | : [[API C_NewItems.RemoveNewItem|C_NewItems.RemoveNewItem]](<span |
+ | : [[API C_NewItems.RemoveNewItem|C_NewItems.RemoveNewItem]](<span class="apiarg">containerIndex, slotIndex</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. |
||
− | : [[API ClearItemUpgrade|ClearItemUpgrade]]() |
||
− | : [[API CloseItemUpgrade|CloseItemUpgrade]]() |
||
: [[API ConfirmOnUse|ConfirmOnUse]]() - Confirms you want to use the item. |
: [[API ConfirmOnUse|ConfirmOnUse]]() - Confirms you want to use the item. |
||
− | : [[API EndBoundTradeable|EndBoundTradeable]](<span |
+ | : [[API EndBoundTradeable|EndBoundTradeable]](<span class="apiarg">type</span>) - Confirms this will make this item non-tradeable. |
: [[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 |
+ | : [[API EquipItemByName|EquipItemByName]](<span class="apiarg">item [, invSlot]</span>) - Equips an item, optionally into a specified slot. |
− | : [[API GetDetailedItemLevelInfo|GetDetailedItemLevelInfo]](<span |
+ | : [[API GetDetailedItemLevelInfo|GetDetailedItemLevelInfo]](<span class="apiarg">item</span>) - Returns detailed item level info. |
− | : [[API GetItemChildInfo|GetItemChildInfo]](<span |
+ | : [[API GetItemChildInfo|GetItemChildInfo]](<span class="apiarg">item [, slotID]</span>) |
− | : [[API GetItemClassInfo|GetItemClassInfo]](<span |
+ | : [[API GetItemClassInfo|GetItemClassInfo]](<span class="apiarg">itemClassID</span>) - Returns the name of the item type. |
− | : [[API GetItemCooldown|GetItemCooldown]](<span |
+ | : [[API GetItemCooldown|GetItemCooldown]](<span class="apiarg">itemId</span>) - Returns cooldown info for an item ID. |
− | : [[API GetItemCount|GetItemCount]](<span |
+ | : [[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 |
+ | : [[API GetItemCreationContext|GetItemCreationContext]](<span class="apiarg">itemlink</span>) |
− | : [[API GetItemFamily|GetItemFamily]](<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 GetItemGem|GetItemGem]](<span |
+ | : [[API GetItemGem|GetItemGem]](<span class="apiarg">item, index</span>) |
− | : [[API GetItemIcon|GetItemIcon]](<span |
+ | : [[API GetItemIcon|GetItemIcon]](<span class="apiarg">itemId</span>) - Returns the icon texture for an item. |
− | : [[API GetItemInfo|GetItemInfo]](<span |
+ | : [[API GetItemInfo|GetItemInfo]](<span class="apiarg">item</span>) - Returns info for an item. |
− | : [[API GetItemInfoInstant|GetItemInfoInstant]](<span |
+ | : [[API GetItemInfoInstant|GetItemInfoInstant]](<span class="apiarg">item</span>) - Returns readily available info for an item. |
− | : [[API GetItemInventorySlotInfo|GetItemInventorySlotInfo]](<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 color for an item quality. |
||
− | : [[API GetItemLevelIncrement|GetItemLevelIncrement]]() |
||
+ | : [[API GetItemSetInfo|GetItemSetInfo]](<span class="apiarg">setID</span>) |
||
− | : [[API GetItemQualityColor|GetItemQualityColor]](<span style="font-size:smaller; color:#ecbc2a">quality</span>) - Returns the RGB color codes for a quality. |
||
− | : [[API |
+ | : [[API GetItemSpecInfo|GetItemSpecInfo]](<span class="apiarg">item [, specTable]</span>) |
− | : [[API |
+ | : [[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 GetItemSpell|GetItemSpell]](<span style="font-size:smaller; color:#ecbc2a">item</span>) - Returns name, rank. |
||
− | : [[API |
+ | : [[API GetItemStats|GetItemStats]](<span class="apiarg">itemLink, statTable</span>) - Returns a table of stats for an item. |
− | : [[API |
+ | : [[API GetItemSubClassInfo|GetItemSubClassInfo]](<span class="apiarg">itemClassID, itemSubClassID</span>) - Returns the name of the item subtype. |
+ | : [[API GetItemUniqueness|GetItemUniqueness]](<span class="apiarg">item</span>) |
||
− | : [[API GetItemSubClassInfo|GetItemSubClassInfo]](<span style="font-size:smaller; color:#ecbc2a">itemClassID, itemSubClassID</span>) - Returns the name of the item subtype. |
||
− | : [[API |
+ | : [[API IsConsumableItem|IsConsumableItem]](<span class="apiarg">item</span>) |
+ | : [[API IsCurrentItem|IsCurrentItem]](<span class="apiarg">item</span>) |
||
− | : [[API GetItemUpdateLevel|GetItemUpdateLevel]]() |
||
+ | : [[API IsEquippableItem|IsEquippableItem]](<span class="apiarg">item</span>) - Returns true if an item is equipable by the player. |
||
− | : [[API GetItemUpgradeEffect|GetItemUpgradeEffect]](<span style="font-size:smaller; color:#ecbc2a">index</span>) |
||
+ | : [[API IsEquippedItem|IsEquippedItem]](<span class="apiarg">item</span>) |
||
− | : [[API GetItemUpgradeItemInfo|GetItemUpgradeItemInfo]]() |
||
+ | : [[API IsEquippedItemType|IsEquippedItemType]](<span class="apiarg">type</span>) - Returns true if an item of a given type is equipped. |
||
− | : [[API GetItemUpgradeStats|GetItemUpgradeStats]](<span style="font-size:smaller; color:#ecbc2a">upgraded</span>) |
||
+ | : [[API IsHarmfulItem|IsHarmfulItem]](<span class="apiarg">item</span>) - Returns whether an item can be used against hostile units |
||
− | : [[API GetNumItemUpgradeEffects|GetNumItemUpgradeEffects]]() |
||
+ | : [[API IsHelpfulItem|IsHelpfulItem]](<span class="apiarg">item</span>) - Returns whether an item can be used on the player or friendly units |
||
− | : [[API IsBattlePayItem|IsBattlePayItem]](<span style="font-size:smaller; color:#ecbc2a">bag, slot</span>) |
||
+ | : [[API IsItemInRange|IsItemInRange]](<span class="apiarg">item [, unit]</span>) - Returns whether the item is in usable range of the unit. |
||
− | : [[API IsConsumableItem|IsConsumableItem]](<span style="font-size:smaller; color:#ecbc2a">item</span>) |
||
− | : [[API |
+ | : [[API IsUsableItem|IsUsableItem]](<span class="apiarg">item</span>) - Returns usable, noMana. |
− | : [[API |
+ | : [[API ItemHasRange|ItemHasRange]](<span class="apiarg">item</span>) |
− | : [[API IsEquippableItem|IsEquippableItem]](<span style="font-size:smaller; color:#ecbc2a">item</span>) - Returns whether an item can be equipped. |
||
− | : [[API IsEquippedItem|IsEquippedItem]](<span style="font-size:smaller; color:#ecbc2a">item</span>) |
||
− | : [[API IsEquippedItemType|IsEquippedItemType]](<span style="font-size:smaller; color:#ecbc2a">type</span>) - Where "type" is any valid inventory type, item class, or item subclass. |
||
− | : [[API IsHarmfulItem|IsHarmfulItem]](<span style="font-size:smaller; color:#ecbc2a">item</span>) - Returns whether an item can be used against hostile units |
||
− | : [[API IsHelpfulItem|IsHelpfulItem]](<span style="font-size:smaller; color:#ecbc2a">item</span>) - Returns whether an item can be used on the player or friendly units |
||
− | : [[API IsItemInRange|IsItemInRange]](<span style="font-size:smaller; color:#ecbc2a">itemName or itemLink, unit</span>) - Nil for invalid target, false for out of range, true for in range. |
||
− | : [[API IsUsableItem|IsUsableItem]](<span style="font-size:smaller; color:#ecbc2a">item</span>) - Returns usable, noMana. |
||
− | : [[API ItemHasRange|ItemHasRange]](<span style="font-size:smaller; color:#ecbc2a">item</span>) |
||
: [[API TargetSpellReplacesBonusTree|TargetSpellReplacesBonusTree]]() |
: [[API TargetSpellReplacesBonusTree|TargetSpellReplacesBonusTree]]() |
||
+ | : [[API UseItemByName|UseItemByName]](<span class="apiarg">itemName, unit</span>) {{apitag|protected}} - Uses the specified item. |
||
− | : [[API UpgradeItem|UpgradeItem]]() |
||
+ | Item Enchants |
||
− | : PROTECTED [[API UseItemByName|UseItemByName]](<span style="font-size:smaller; color:#ecbc2a">itemName, unit</span>) - Use an item on the unit specified. |
||
+ | : [[API BindEnchant|BindEnchant]]() - Confirms that enchanting an item will make it soulbound. |
||
+ | : [[API ReplaceEnchant|ReplaceEnchant]]() - Confirms the "Replace Enchant" dialog. |
||
+ | : [[API ReplaceTradeEnchant|ReplaceTradeEnchant]]() - Confirms that an enchant applied to the trade frame should replace an existing enchant. |
||
− | == |
+ | ==Item Upgrade== |
+ | : [[API C_ItemUpgrade.CanUpgradeItem|C_ItemUpgrade.CanUpgradeItem]](<span class="apiarg">baseItem</span>) : <span class="apiret">isValid</span> |
||
− | These functions relate to [[Key Bindings]]. |
||
+ | : [[API C_ItemUpgrade.ClearItemUpgrade|C_ItemUpgrade.ClearItemUpgrade]]() |
||
− | : [[API C_KeyBindings.GetCustomBindingType|C_KeyBindings.GetCustomBindingType]](<span style="font-size:smaller; color:#ecbc2a">bindingIndex</span>) - Returns the type of a custom binding. |
||
+ | : [[API C_ItemUpgrade.CloseItemUpgrade|C_ItemUpgrade.CloseItemUpgrade]]() |
||
− | : [[API GetBinding|GetBinding]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Get action and key bindings for that index. |
||
+ | : [[API C_ItemUpgrade.GetItemHyperlink|C_ItemUpgrade.GetItemHyperlink]]() : <span class="apiret">link</span> |
||
− | : [[API GetBindingAction|GetBindingAction]](<span style="font-size:smaller; color:#ecbc2a">key [, checkOverride]</span>) - Get the action bound to that key. |
||
+ | : [[API C_ItemUpgrade.GetItemUpgradeCurrentLevel|C_ItemUpgrade.GetItemUpgradeCurrentLevel]]() : <span class="apiret">itemLevel, isPvpItemLevel</span> |
||
− | : [[API GetBindingByKey|GetBindingByKey]](<span style="font-size:smaller; color:#ecbc2a">action [, mode]</span>) |
||
+ | : [[API C_ItemUpgrade.GetItemUpgradeEffect|C_ItemUpgrade.GetItemUpgradeEffect]](<span class="apiarg">effectIndex [, numUpgradeLevels]</span>) : <span class="apiret">outBaseEffect, outUpgradedEffect</span> |
||
− | : [[API GetBindingKey|GetBindingKey]](<span style="font-size:smaller; color:#ecbc2a">command</span>) - Get the key(s) bound to that action. |
||
+ | : [[API C_ItemUpgrade.GetItemUpgradeItemInfo|C_ItemUpgrade.GetItemUpgradeItemInfo]]() : <span class="apiret">itemInfo</span> |
||
− | : [[API GetCurrentBindingSet|GetCurrentBindingSet]]() - Queries if current set of key bindings is character or account specific. |
||
+ | : [[API C_ItemUpgrade.GetItemUpgradePvpItemLevelDeltaValues|C_ItemUpgrade.GetItemUpgradePvpItemLevelDeltaValues]](<span class="apiarg">numUpgradeLevels</span>) : <span class="apiret">currentPvPItemLevel, upgradedPvPItemLevel</span> |
||
− | : [[API GetNumBindings|GetNumBindings]]() - Get total number key bindings and headers. |
||
+ | : [[API C_ItemUpgrade.GetNumItemUpgradeEffects|C_ItemUpgrade.GetNumItemUpgradeEffects]]() : <span class="apiret">numItemUpgradeEffects</span> |
||
− | : [[API LoadBindings|LoadBindings]](<span style="font-size:smaller; color:#ecbc2a">which</span>) - Loads default, account or character specific key binding set into memory from disk. |
||
+ | : [[API C_ItemUpgrade.SetItemUpgradeFromCursorItem|C_ItemUpgrade.SetItemUpgradeFromCursorItem]]() |
||
− | : [[API RunBinding|RunBinding]](<span style="font-size:smaller; color:#ecbc2a">command [, up]</span>) - Executes the key binding named "command". |
||
+ | : [[API C_ItemUpgrade.SetItemUpgradeFromLocation|C_ItemUpgrade.SetItemUpgradeFromLocation]](<span class="apiarg">itemToSet</span>) |
||
− | : [[API SaveBindings|SaveBindings]](<span style="font-size:smaller; color:#ecbc2a">which</span>) - Saves account or character specific key bindings from memory to disk. |
||
+ | : [[API C_ItemUpgrade.UpgradeItem|C_ItemUpgrade.UpgradeItem]](<span class="apiarg">[numUpgrades]</span>) |
||
− | : NOCOMBAT [[API SetBinding|SetBinding]](<span style="font-size:smaller; color:#ecbc2a">key [, command, mode]</span>) - Sets or unsets key bindings. (Can not be used in combat.) |
||
− | : NOCOMBAT [[API SetBindingSpell|SetBindingSpell]](<span style="font-size:smaller; color:#ecbc2a">key, Spell Name</span>) - Set a key binding directly to a spell, uses the same spell name syntax as /cast. |
||
− | : NOCOMBAT [[API SetBindingClick|SetBindingClick]](<span style="font-size:smaller; color:#ecbc2a">key, ButtonName [, mouseButton]</span>) - Set a key binding directly to a Button object. The click sends a mouse down when the key is pressed, and a mouse up when it is released. |
||
− | : NOCOMBAT [[API SetBindingItem|SetBindingItem]](<span style="font-size:smaller; color:#ecbc2a">key, itemname</span>) |
||
− | : NOCOMBAT [[API SetBindingMacro|SetBindingMacro]](<span style="font-size:smaller; color:#ecbc2a">key, macroname or macroId</span>) |
||
− | : NOCOMBAT [[API SetOverrideBinding|SetOverrideBinding]](<span style="font-size:smaller; color:#ecbc2a">owner, isPriority, key [, command]</span>) - Set (or clear) an override key binding. |
||
− | : NOCOMBAT [[API SetOverrideBindingSpell|SetOverrideBindingSpell]](<span style="font-size:smaller; color:#ecbc2a">owner, isPriority, key, spellname</span>) |
||
− | : NOCOMBAT [[API SetOverrideBindingClick|SetOverrideBindingClick]](<span style="font-size:smaller; color:#ecbc2a">owner, isPriority, key, buttonName [, mouseClick]</span>) - Sets an override binding that acts like a mouse click on a button. |
||
− | : NOCOMBAT [[API SetOverrideBindingItem|SetOverrideBindingItem]](<span style="font-size:smaller; color:#ecbc2a">owner, isPriority, key, itemname</span>) |
||
− | : NOCOMBAT [[API SetOverrideBindingMacro|SetOverrideBindingMacro]](<span style="font-size:smaller; color:#ecbc2a">owner, isPriority, key, macroname or macroId</span>) |
||
− | : NOCOMBAT [[API ClearOverrideBindings|ClearOverrideBindings]](<span style="font-size:smaller; color:#ecbc2a">owner</span>) - Reset all overrides belonging to an owner. |
||
− | : [[API SetMouselookOverrideBinding|SetMouselookOverrideBinding]](<span style="font-size:smaller; color:#ecbc2a">key [, command]</span>) |
||
− | : UI [[API GetBindingText|GetBindingText]](<span style="font-size:smaller; color:#ecbc2a">key, prefix, returnAbbr</span>) - Gets the string value for the key. |
||
− | == |
+ | ==Looting== |
+ | Relates to [[Loot]]. |
||
− | : [[API GetModifiedClick|GetModifiedClick]](<span style="font-size:smaller; color:#ecbc2a">action</span>) |
||
+ | : [[API C_Loot.IsLegacyLootModeEnabled|C_Loot.IsLegacyLootModeEnabled]]() : <span class="apiret">isLegacyLootModeEnabled</span> |
||
− | : [[API GetModifiedClickAction|GetModifiedClickAction]](<span style="font-size:smaller; color:#ecbc2a">index</span>) |
||
+ | : [[API C_PlayerInfo.CanPlayerUseAreaLoot|C_PlayerInfo.CanPlayerUseAreaLoot]]() : <span class="apiret">canUseAreaLoot</span> |
||
− | : [[API GetMouseButtonClicked|GetMouseButtonClicked]]() - Returns the name of the button that triggered a mouse down/up/click/doubleclick event. |
||
+ | : [[API CanLootUnit|CanLootUnit]](<span class="apiarg">unitGUID</span>) |
||
− | : [[API GetNumModifiedClickActions|GetNumModifiedClickActions]]() |
||
+ | : [[API CancelMasterLootRoll|CancelMasterLootRoll]](<span class="apiarg">slot</span>) |
||
− | : [[API IsAltKeyDown|IsAltKeyDown]]() - Returns true if the alt key is currently depressed. |
||
+ | : [[API CloseLoot|CloseLoot]](<span class="apiarg">[uiFailedFlag]</span>) |
||
− | : [[API IsControlKeyDown|IsControlKeyDown]]() - Returns true if the control key is currently depressed. |
||
− | : [[API |
+ | : [[API ConfirmLootRoll|ConfirmLootRoll]](<span class="apiarg">rollId [, roll]</span>) - Confirms a loot roll. |
+ | : [[API ConfirmLootSlot|ConfirmLootSlot]](<span class="apiarg">slot</span>) - Confirms looting of a BoP item. |
||
− | : [[API IsLeftAltKeyDown|IsLeftAltKeyDown]]() - Returns true if the left alt key is currently depressed. |
||
+ | : [[API DoMasterLootRoll|DoMasterLootRoll]](<span class="apiarg">slot</span>) |
||
− | : [[API IsLeftControlKeyDown|IsLeftControlKeyDown]]() - Returns true if the left control key is currently depressed. |
||
− | : [[API IsLeftMetaKeyDown|IsLeftMetaKeyDown]]() |
||
− | : [[API IsLeftShiftKeyDown|IsLeftShiftKeyDown]]() - Returns true if the left shift key is currently depressed. |
||
− | : [[API IsMetaKeyDown|IsMetaKeyDown]]() |
||
− | : [[API IsModifiedClick|IsModifiedClick]](<span style="font-size:smaller; color:#ecbc2a">action</span>) - Returns 1 if the keys for the specified action are down, nil otherwise. |
||
− | : [[API IsModifierKeyDown|IsModifierKeyDown]]() - Equivalent to (IsShiftKeyDown() or IsControlKeyDown() or IsAltKeyDown()). |
||
− | : [[API IsMouseButtonDown|IsMouseButtonDown]](<span style="font-size:smaller; color:#ecbc2a">[button or button]</span>) |
||
− | : [[API IsRightAltKeyDown|IsRightAltKeyDown]]() - Returns true if the right alt key is currently depressed. |
||
− | : [[API IsRightControlKeyDown|IsRightControlKeyDown]]() - Returns true if the right control key is currently depressed. |
||
− | : [[API IsRightMetaKeyDown|IsRightMetaKeyDown]]() |
||
− | : [[API IsRightShiftKeyDown|IsRightShiftKeyDown]]() - Returns true if the right shift key is currently depressed. |
||
− | : [[API IsShiftKeyDown|IsShiftKeyDown]]() - Returns true if the shift key is currently depressed. |
||
− | : [[API SetModifiedClick|SetModifiedClick]](<span style="font-size:smaller; color:#ecbc2a">action, binding</span>) |
||
− | |||
− | === Looting === |
||
− | These functions relate to [[Loot]]. |
||
− | : [[API C_Loot.IsLegacyLootModeEnabled|C_Loot.IsLegacyLootModeEnabled]]() |
||
− | : [[API C_LootHistory.CanMasterLoot|C_LootHistory.CanMasterLoot]](<span style="font-size:smaller; color:#ecbc2a">itemIndex, playerIndex</span>) |
||
− | : [[API C_LootHistory.GetExpiration|C_LootHistory.GetExpiration]]() |
||
− | : [[API C_LootHistory.GetItem|C_LootHistory.GetItem]](<span style="font-size:smaller; color:#ecbc2a">itemIndex</span>) |
||
− | : [[API C_LootHistory.GetNumItems|C_LootHistory.GetNumItems]]() |
||
− | : [[API C_LootHistory.GetPlayerInfo|C_LootHistory.GetPlayerInfo]](<span style="font-size:smaller; color:#ecbc2a">itemIndex, playerIndex</span>) |
||
− | : [[API C_LootHistory.GiveMasterLoot|C_LootHistory.GiveMasterLoot]](<span style="font-size:smaller; color:#ecbc2a">itemIndex, playerIndex</span>) |
||
− | : [[API C_LootHistory.SetExpiration|C_LootHistory.SetExpiration]](<span style="font-size:smaller; color:#ecbc2a">numItemsToSave, secondsToSave</span>) |
||
− | : [[API C_PlayerInfo.CanPlayerUseAreaLoot|C_PlayerInfo.CanPlayerUseAreaLoot]]() |
||
− | : [[API CanLootUnit|CanLootUnit]](<span style="font-size:smaller; color:#ecbc2a">unitGUID</span>) |
||
− | : [[API CancelMasterLootRoll|CancelMasterLootRoll]](<span style="font-size:smaller; color:#ecbc2a">slot</span>) |
||
− | : [[API CloseLoot|CloseLoot]](<span style="font-size:smaller; color:#ecbc2a">[uiFailedFlag]</span>) |
||
− | : [[API ConfirmLootRoll|ConfirmLootRoll]](<span style="font-size:smaller; color:#ecbc2a">rollId [, roll]</span>) - Confirm a loot roll. |
||
− | : [[API ConfirmLootSlot|ConfirmLootSlot]](<span style="font-size:smaller; color:#ecbc2a">slot</span>) - Confirm looting of a BoP item. |
||
− | : [[API DoMasterLootRoll|DoMasterLootRoll]](<span style="font-size:smaller; color:#ecbc2a">slot</span>) |
||
: [[API GetActiveLootRollIDs|GetActiveLootRollIDs]]() |
: [[API GetActiveLootRollIDs|GetActiveLootRollIDs]]() |
||
: [[API GetLootInfo|GetLootInfo]]() |
: [[API GetLootInfo|GetLootInfo]]() |
||
− | : [[API GetLootMethod|GetLootMethod]]() - Returns the |
+ | : [[API GetLootMethod|GetLootMethod]]() - Returns the current loot method. |
− | : [[API GetLootRollItemInfo|GetLootRollItemInfo]](<span |
+ | : [[API GetLootRollItemInfo|GetLootRollItemInfo]](<span class="apiarg">rollId</span>) |
− | : [[API GetLootRollItemLink|GetLootRollItemLink]](<span |
+ | : [[API GetLootRollItemLink|GetLootRollItemLink]](<span class="apiarg">id</span>) |
− | : [[API GetLootRollTimeLeft|GetLootRollTimeLeft]](<span |
+ | : [[API GetLootRollTimeLeft|GetLootRollTimeLeft]](<span class="apiarg">rollid</span>) |
− | : [[API GetLootSlotInfo|GetLootSlotInfo]](<span |
+ | : [[API GetLootSlotInfo|GetLootSlotInfo]](<span class="apiarg">slot</span>) - Returns info for a loot slot. |
− | : [[API GetLootSlotLink|GetLootSlotLink]](<span |
+ | : [[API GetLootSlotLink|GetLootSlotLink]](<span class="apiarg">slot</span>) - Returns the item link for a loot slot. |
− | : [[API GetLootSlotType|GetLootSlotType]](<span |
+ | : [[API GetLootSlotType|GetLootSlotType]](<span class="apiarg">slot</span>) |
− | : [[API GetLootSourceInfo|GetLootSourceInfo]](<span |
+ | : [[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 |
+ | : [[API GetLootThreshold|GetLootThreshold]]() - Returns the loot threshold quality for e.g. master loot. |
− | : [[API GetMasterLootCandidate|GetMasterLootCandidate]](<span |
+ | : [[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 |
+ | : [[API GetNumLootItems|GetNumLootItems]]() - Returns the number of items in the loot window. |
− | : [[API GetOptOutOfLoot|GetOptOutOfLoot]]() - Returns |
+ | : [[API GetOptOutOfLoot|GetOptOutOfLoot]]() - Returns true if the player is automatically passing on all loot. |
− | : [[API GiveMasterLoot|GiveMasterLoot]](<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 |
+ | : [[API LootMoneyNotify|LootMoneyNotify]](<span class="apiarg">money, soleLooter</span>) |
+ | : [[API LootSlot|LootSlot]](<span class="apiarg">slot</span>) - Loots the specified slot; can require confirmation with [[API ConfirmLootSlot|ConfirmLootSlot]]. |
||
− | : [[API LootSlotHasItem|LootSlotHasItem]](<span style="font-size:smaller; color:#ecbc2a">slot</span>) |
||
− | : [[API |
+ | : [[API LootSlotHasItem|LootSlotHasItem]](<span class="apiarg">slot</span>) |
− | : [[API RollOnLoot|RollOnLoot]](<span |
+ | : [[API RollOnLoot|RollOnLoot]](<span class="apiarg">rollId [, roll]</span>) - Rolls or passes on loot. |
− | : [[API SetLootMethod|SetLootMethod]](<span |
+ | : [[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 |
+ | : [[API SetLootSpecialization|SetLootSpecialization]](<span class="apiarg">specilizationID</span>) |
− | : [[API SetLootThreshold|SetLootThreshold]](<span |
+ | : [[API SetLootThreshold|SetLootThreshold]](<span class="apiarg">itemQuality</span>) - Sets the loot quality threshold for group/master loot. |
− | : [[API SetOptOutOfLoot|SetOptOutOfLoot]](<span |
+ | : [[API SetOptOutOfLoot|SetOptOutOfLoot]](<span class="apiarg">optOut</span>) - Sets whether to automatically pass on all loot. |
+ | ==Macros== |
||
− | === Loss of Control === |
||
+ | Relates to [[Macro]]s. |
||
− | : [[API C_LossOfControl.GetActiveLossOfControlData|C_LossOfControl.GetActiveLossOfControlData]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Returns information about a loss-of-control event. |
||
+ | : [[API CreateMacro|CreateMacro]](<span class="apiarg">name, icon, body, perCharacter, isLocal</span>) {{apitag|nocombat}} - Creates a macro. |
||
− | : [[API C_LossOfControl.GetActiveLossOfControlDataByUnit|C_LossOfControl.GetActiveLossOfControlDataByUnit]](<span style="font-size:smaller; color:#ecbc2a">unitToken, index</span>) - Returns information about a loss-of-control event. |
||
+ | : [[API DeleteMacro|DeleteMacro]](<span class="apiarg">id or name</span>) - Deletes a macro. |
||
− | : [[API C_LossOfControl.GetActiveLossOfControlDataCount|C_LossOfControl.GetActiveLossOfControlDataCount]]() - Returns the number of loss-of-control effects your character is currently affected by. |
||
+ | : [[API EditMacro|EditMacro]](<span class="apiarg">index, name, iconIndex, body, isLocal, perCharacter</span>) {{apitag|nocombat}} - Modifies an existing macro. |
||
− | : [[API C_LossOfControl.GetActiveLossOfControlDataCountByUnit|C_LossOfControl.GetActiveLossOfControlDataCountByUnit]](unitToken) - Returns the number of loss-of-control effects your character is currently affected by. |
||
− | : [[API GetActionLossOfControlCooldown|GetActionLossOfControlCooldown]](<span style="font-size:smaller; color:#ecbc2a">slot</span>) |
||
− | : [[API GetSpellLossOfControlCooldown|GetSpellLossOfControlCooldown]](<span style="font-size:smaller; color:#ecbc2a">spellSlot</span>) |
||
− | |||
− | === Macros === |
||
− | These functions relate to [[Macro]]s. |
||
− | : NOCOMBAT [[API CreateMacro|CreateMacro]](<span style="font-size:smaller; color:#ecbc2a">name, icon, body, perCharacter, isLocal</span>) - Create a new macro. |
||
− | : [[API DeleteMacro|DeleteMacro]](<span style="font-size:smaller; color:#ecbc2a">id or name</span>) - Deletes a macro. |
||
− | : NOCOMBAT [[API EditMacro|EditMacro]](<span style="font-size:smaller; color:#ecbc2a">index, name, iconIndex, body, isLocal, perCharacter</span>) - Saves a macro. |
||
: [[API GetLooseMacroIcons|GetLooseMacroIcons]]() |
: [[API GetLooseMacroIcons|GetLooseMacroIcons]]() |
||
: [[API GetLooseMacroItemIcons|GetLooseMacroItemIcons]]() |
: [[API GetLooseMacroItemIcons|GetLooseMacroItemIcons]]() |
||
− | : [[API GetMacroBody|GetMacroBody]](<span |
+ | : [[API GetMacroBody|GetMacroBody]](<span class="apiarg">id or name</span>) - Returns the body (macro text) of a macro. |
− | : [[API GetMacroIcons|GetMacroIcons]](<span |
+ | : [[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 |
+ | : [[API GetMacroIndexByName|GetMacroIndexByName]](<span class="apiarg">name</span>) - Returns the index for a macro by name. |
− | : [[API GetMacroInfo|GetMacroInfo]](<span |
+ | : [[API GetMacroInfo|GetMacroInfo]](<span class="apiarg">id or name</span>) - Returns info for a macro. |
− | : [[API GetMacroItemIcons|GetMacroItemIcons]](<span |
+ | : [[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 |
+ | : [[API GetNumMacros|GetNumMacros]]() - Returns the number of account and character macros. |
: [[API GetRunningMacroButton|GetRunningMacroButton]]() |
: [[API GetRunningMacroButton|GetRunningMacroButton]]() |
||
: [[API GetRunningMacro|GetRunningMacro]]() |
: [[API GetRunningMacro|GetRunningMacro]]() |
||
− | : |
+ | : [[API RunMacro|RunMacro]](<span class="apiarg">id or name</span>) {{apitag|protected}} - Executes a macro. |
− | : |
+ | : [[API RunMacroText|RunMacroText]](<span class="apiarg">macro</span>) {{apitag|protected}} - Executes a string as if it was a macro. |
− | : [[API SecureCmdOptionParse|SecureCmdOptionParse]](<span |
+ | : [[API SecureCmdOptionParse|SecureCmdOptionParse]](<span class="apiarg">command</span>) - Evaluates macro conditionals without the need of a macro. |
− | : [[API SetMacroItem|SetMacroItem]](<span |
+ | : [[API SetMacroItem|SetMacroItem]](<span class="apiarg">macro, item [, target]</span>) |
− | : [[API SetMacroSpell|SetMacroSpell]](<span |
+ | : [[API SetMacroSpell|SetMacroSpell]](<span class="apiarg">macro, spell [, target]</span>) |
− | : |
+ | : [[API StopMacro|StopMacro]]() {{apitag|protected}} - Stops the currently executing macro. |
− | == |
+ | ==Mail== |
− | + | Relates to [[Mail]]. |
|
− | : [[API C_Mail.CanCheckInbox|C_Mail.CanCheckInbox]]() |
+ | : [[API C_Mail.CanCheckInbox|C_Mail.CanCheckInbox]]() : <span class="apiret">canCheckInbox, secondsUntilAllowed</span> |
− | : [[API C_Mail.HasInboxMoney|C_Mail.HasInboxMoney]](<span |
+ | : [[API C_Mail.HasInboxMoney|C_Mail.HasInboxMoney]](<span class="apiarg">inboxIndex</span>) : <span class="apiret">inboxItemHasMoneyAttached</span> - Returns true if a mail has money attached. |
− | : [[API C_Mail.IsCommandPending|C_Mail.IsCommandPending]]() - Returns true if the current mail command is still processing. |
+ | : [[API C_Mail.IsCommandPending|C_Mail.IsCommandPending]]() : <span class="apiret">isCommandPending</span> - Returns true if the current mail command is still processing. |
− | : [[API AutoLootMailItem|AutoLootMailItem]](<span |
+ | : [[API AutoLootMailItem|AutoLootMailItem]](<span class="apiarg">index</span>) - Loot all items from mail message. |
− | : [[API CanComplainInboxItem|CanComplainInboxItem]](<span |
+ | : [[API CanComplainInboxItem|CanComplainInboxItem]](<span class="apiarg">index</span>) - Determines if we should show the “report spam” button on a mail item. |
− | : [[API CheckInbox|CheckInbox]]() - |
+ | : [[API CheckInbox|CheckInbox]]() - Queries the server for mail. |
− | : [[API ClearSendMail|ClearSendMail]]() - |
+ | : [[API ClearSendMail|ClearSendMail]]() - Clears the text and item attachments in the Send Mail tab. |
− | : [[API ClickSendMailItemButton|ClickSendMailItemButton]](<span |
+ | : [[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 |
+ | : [[API DeleteInboxItem|DeleteInboxItem]](<span class="apiarg">index</span>) - Requests the server to remove a mailbox message. |
+ | : [[API GetCoinIcon|GetCoinIcon]](<span class="apiarg">amount</span>) |
||
− | : [[API DeleteInboxItem|DeleteInboxItem]](<span style="font-size:smaller; color:#ecbc2a">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 GetInboxHeaderInfo|GetInboxHeaderInfo]](<span class="apiarg">index</span>) - Returns info for a message in the mailbox. |
||
− | : [[API GetCoinIcon|GetCoinIcon]](<span style="font-size:smaller; color:#ecbc2a">amount</span>) |
||
− | : [[API |
+ | : [[API GetInboxItem|GetInboxItem]](<span class="apiarg">index, itemIndex</span>) - Returns info for an item attached to a message in the mailbox. |
− | : [[API |
+ | : [[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 the mailbox. |
||
− | : [[API GetInboxItemLink|GetInboxItemLink]](<span style="font-size:smaller; color:#ecbc2a">index, itemIndex</span>) - Returns link of the attachment attached to message at (index). |
||
− | : [[API |
+ | : [[API GetInboxText|GetInboxText]](<span class="apiarg">index</span>) - Returns the text of a message in the mailbox. |
− | : [[API |
+ | : [[API GetInboxInvoiceInfo|GetInboxInvoiceInfo]](<span class="apiarg">index</span>) - Returns info for an auction house invoice. |
+ | : [[API GetLatestThreeSenders|GetLatestThreeSenders]]() - Returns up to three senders of unread mail. |
||
− | : [[API GetInboxInvoiceInfo|GetInboxInvoiceInfo]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Returns informations about an auction house invoice. |
||
− | : [[API |
+ | : [[API GetSendMailCOD|GetSendMailCOD]]() - Returns the Cash-On-Delivery cost of the outgoing message. |
+ | : [[API GetSendMailItem|GetSendMailItem]](<span class="apiarg">index</span>) - Returns info for an item attached in the outgoing message. |
||
− | : [[API GetSendMailCOD|GetSendMailCOD]]() - Determine amount of gold entered in COD box in mail frame when mail is sent. |
||
− | : [[API |
+ | : [[API GetSendMailItemLink|GetSendMailItemLink]](<span class="apiarg">index</span>) - Returns the item link of an item attached in the outgoing message. |
− | : [[API GetSendMailItemLink|GetSendMailItemLink]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Get link for an item attached on the send mail frame. |
||
: [[API GetSendMailMoney|GetSendMailMoney]]() |
: [[API GetSendMailMoney|GetSendMailMoney]]() |
||
: [[API GetSendMailPrice|GetSendMailPrice]]() - Gets the cost for sending mail. |
: [[API GetSendMailPrice|GetSendMailPrice]]() - Gets the cost for sending mail. |
||
: [[API HasInboxItem|HasInboxItem]]() |
: [[API HasInboxItem|HasInboxItem]]() |
||
: [[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 |
+ | : [[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 |
+ | : [[API InboxItemCanDelete|InboxItemCanDelete]](<span class="apiarg">index</span>) - Returns true if a message can be deleted, false if it can be returned to sender. |
− | : [[API RespondMailLockSendItem|RespondMailLockSendItem]](<span |
+ | : [[API RespondMailLockSendItem|RespondMailLockSendItem]](<span class="apiarg">slot, keepItem</span>) - Confirm item wont be refunded, keepItem boolean. |
− | : [[API ReturnInboxItem|ReturnInboxItem]](<span |
+ | : [[API ReturnInboxItem|ReturnInboxItem]](<span class="apiarg">index</span>) - Returns to the sender the attached item in the mail message at the specified index. |
− | : [[API SendMail|SendMail]](<span |
+ | : [[API SendMail|SendMail]](<span class="apiarg">target, subject, body</span>) {{apitag|noscript}} - Sends in-game mail. |
− | : |
+ | : [[API SetSendMailCOD|SetSendMailCOD]](<span class="apiarg">amount</span>) {{apitag|protected}} - Make next mail sent using SendMail() COD target for amount. |
− | : |
+ | : [[API SetSendMailMoney|SetSendMailMoney]](<span class="apiarg">amount</span>) {{apitag|protected}} - Add money to next mail sent using SendMail(). |
: [[API SetSendMailShowing|SetSendMailShowing]]() |
: [[API SetSendMailShowing|SetSendMailShowing]]() |
||
− | : [[API TakeInboxItem|TakeInboxItem]](<span |
+ | : [[API TakeInboxItem|TakeInboxItem]](<span class="apiarg">index, itemIndex</span>) - Takes the attached item from the mailbox message. |
− | : [[API TakeInboxMoney|TakeInboxMoney]](<span |
+ | : [[API TakeInboxMoney|TakeInboxMoney]](<span class="apiarg">index</span>) - Take the attached money from the mailbox message at index. |
− | : [[API TakeInboxTextItem|TakeInboxTextItem]](<span |
+ | : [[API TakeInboxTextItem|TakeInboxTextItem]](<span class="apiarg">index</span>) - Creates a permanent copy of letter (readable "Plain Letter"). |
− | == |
+ | ==Maps== |
− | + | The [[Map]] API was reworked in [[Patch 8.0.1]]. See also [[#MapUtil|MapUtil]] functions. |
|
− | : [[API C_Map.CanSetUserWaypointOnMap|C_Map.CanSetUserWaypointOnMap]](<span style="font-size:smaller; color:#ecbc2a">uiMapID</span>) |
||
− | : [[API C_Map.ClearUserWaypoint|C_Map.ClearUserWaypoint]]() |
||
: [[API C_Map.CloseWorldMapInteraction|C_Map.CloseWorldMapInteraction]]() |
: [[API C_Map.CloseWorldMapInteraction|C_Map.CloseWorldMapInteraction]]() |
||
− | : [[API C_Map.GetAreaInfo|C_Map.GetAreaInfo]](<span |
+ | : [[API C_Map.GetAreaInfo|C_Map.GetAreaInfo]](<span class="apiarg">areaID</span>) : <span class="apiret">name</span> - Returns a map subzone name. |
− | : [[API C_Map.GetBestMapForUnit|C_Map.GetBestMapForUnit]](<span |
+ | : [[API C_Map.GetBestMapForUnit|C_Map.GetBestMapForUnit]](<span class="apiarg">unitToken</span>) : <span class="apiret">uiMapID</span> - Returns the current UI map for the given unit. Only works for the player and group members. |
− | : [[API C_Map.GetBountySetMaps|C_Map.GetBountySetMaps]](<span |
+ | : [[API C_Map.GetBountySetMaps|C_Map.GetBountySetMaps]](<span class="apiarg">bountySetID</span>) : <span class="apiret">mapIDs</span> - Returns the maps for a bounty. |
− | : [[API C_Map.GetFallbackWorldMapID|C_Map.GetFallbackWorldMapID]]() - Returns the world map id. |
+ | : [[API C_Map.GetFallbackWorldMapID|C_Map.GetFallbackWorldMapID]]() : <span class="apiret">uiMapID</span> - Returns the world map id. |
− | : [[API C_Map.GetMapArtBackgroundAtlas|C_Map.GetMapArtBackgroundAtlas]](<span |
+ | : [[API C_Map.GetMapArtBackgroundAtlas|C_Map.GetMapArtBackgroundAtlas]](<span class="apiarg">uiMapID</span>) : <span class="apiret">atlasName</span> - Returns the background atlas for a map. |
− | : [[API C_Map.GetMapArtHelpTextPosition|C_Map.GetMapArtHelpTextPosition]](<span |
+ | : [[API C_Map.GetMapArtHelpTextPosition|C_Map.GetMapArtHelpTextPosition]](<span class="apiarg">uiMapID</span>) : <span class="apiret">position</span> - Returns the position for the "Click to Zoom In" hint text on flight maps. |
− | : [[API C_Map.GetMapArtID|C_Map.GetMapArtID]](<span |
+ | : [[API C_Map.GetMapArtID|C_Map.GetMapArtID]](<span class="apiarg">uiMapID</span>) : <span class="apiret">uiMapArtID</span> - Returns the art for a (phased) map. |
− | : [[API C_Map.GetMapArtLayers|C_Map.GetMapArtLayers]](<span |
+ | : [[API C_Map.GetMapArtLayers|C_Map.GetMapArtLayers]](<span class="apiarg">uiMapID</span>) : <span class="apiret">layerInfo</span> - Returns the art layers for a map. |
− | : [[API C_Map.GetMapArtLayerTextures|C_Map.GetMapArtLayerTextures]](<span |
+ | : [[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 |
+ | : [[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 |
+ | : [[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 |
+ | : [[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 |
+ | : [[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.GetMapGroupMembersInfo|C_Map.GetMapGroupMembersInfo]](<span |
+ | : [[API C_Map.GetMapGroupMembersInfo|C_Map.GetMapGroupMembersInfo]](<span class="apiarg">uiMapGroupID</span>) : <span class="apiret">info</span> - Returns the floors for a map group. |
− | : [[API C_Map.GetMapHighlightInfoAtPosition|C_Map.GetMapHighlightInfoAtPosition]](<span |
+ | : [[API C_Map.GetMapHighlightInfoAtPosition|C_Map.GetMapHighlightInfoAtPosition]](<span class="apiarg">uiMapID, x, y</span>) : <span class="apiret">fileDataID, atlasID, texturePercentageX, texturePercentageY, textureX, textureY, scrollChildX, scrollChildY</span> - Returns a map highlight pin for a location. |
− | : [[API C_Map.GetMapInfo|C_Map.GetMapInfo]](<span |
+ | : [[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 |
+ | : [[API C_Map.GetMapInfoAtPosition|C_Map.GetMapInfoAtPosition]](<span class="apiarg">uiMapID, x, y [, ignoreZoneMapPositionData]</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 |
+ | : [[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 |
+ | : [[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.GetMapPosFromWorldPos|C_Map.GetMapPosFromWorldPos]](<span |
+ | : [[API C_Map.GetMapPosFromWorldPos|C_Map.GetMapPosFromWorldPos]](<span class="apiarg">continentID, worldPosition [, overrideUiMapID]</span>) : <span class="apiret">uiMapID, mapPosition</span> - Translates a world map position to a map position. |
− | : [[API C_Map.GetMapRectOnMap|C_Map.GetMapRectOnMap]](<span |
+ | : [[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 |
+ | : [[API C_Map.GetMapWorldSize|C_Map.GetMapWorldSize]](<span class="apiarg">uiMapID</span>) : <span class="apiret">width, height</span> |
− | : [[API C_Map.GetPlayerMapPosition|C_Map.GetPlayerMapPosition]](<span |
+ | : [[API C_Map.GetPlayerMapPosition|C_Map.GetPlayerMapPosition]](<span class="apiarg">uiMapID, unitToken</span>) : <span class="apiret">position</span> {{apitag|noinstance}} - 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 map position to a world map position. |
||
− | : [[API C_Map.GetUserWaypoint|C_Map.GetUserWaypoint]]() |
||
− | : [[API C_Map. |
+ | : [[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.GetUserWaypointHyperlink|C_Map.GetUserWaypointHyperlink]]() |
||
− | : [[API C_Map. |
+ | : [[API C_Map.RequestPreloadMap|C_Map.RequestPreloadMap]](<span class="apiarg">uiMapID</span>) - Preloads textures for 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_Map.GetWorldPosFromMapPos|C_Map.GetWorldPosFromMapPos]](<span style="font-size:smaller; color:#ecbc2a">uiMapID, mapPosition</span>) - Translates a world map position to a map position. |
||
+ | : [[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_Map.HasUserWaypoint|C_Map.HasUserWaypoint]]() |
||
+ | : [[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_Map.IsMapValidForNavBarDropDown|C_Map.IsMapValidForNavBarDropDown]](<span style="font-size:smaller; color:#ecbc2a">uiMapID</span>) |
||
− | : [[API |
+ | : [[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 C_Map.RequestPreloadMap|C_Map.RequestPreloadMap]](<span style="font-size:smaller; color:#ecbc2a">uiMapID</span>) - Preloads textures for a map. |
||
+ | : [[API GetMinimapZoneText|GetMinimapZoneText]]() - Returns the zone text that is displayed over the minimap. |
||
− | : [[API C_Map.SetUserWaypoint|C_Map.SetUserWaypoint]](<span style="font-size:smaller; color:#ecbc2a">point</span>) |
||
+ | : [[API GetPlayerFacing|GetPlayerFacing]]() {{apitag|noinstance}} - Returns the direction the character is facing in radians. |
||
− | : [[API C_MapExplorationInfo.GetExploredAreaIDsAtPosition|C_MapExplorationInfo.GetExploredAreaIDsAtPosition]](<span style="font-size:smaller; color:#ecbc2a">uiMapID, normalizedPosition</span>) - Returns the explored areas for the location on a map. |
||
− | : [[API |
+ | : [[API GetRealZoneText|GetRealZoneText]](<span class="apiarg">[mapID]</span>) - Returns the map instance name. |
+ | : [[API GetSubZoneText|GetSubZoneText]]() - Returns the subzone name. |
||
− | : [[API C_FogOfWar.GetFogOfWarForMap|C_FogOfWar.GetFogOfWarForMap]](<span style="font-size:smaller; color:#ecbc2a">uiMapID</span>) - Returns the fog of war ID for an (Island Expedition) map. |
||
− | : [[API C_FogOfWar.GetFogOfWarInfo|C_FogOfWar.GetFogOfWarInfo]](<span style="font-size:smaller; color:#ecbc2a">fogOfWarID</span>) - Returns fog of war info for an (Island Expedition) map. |
||
− | : [[API GetMinimapZoneText|GetMinimapZoneText]]() - Returns the zone text, that is displayed over the minimap. |
||
− | : [[API GetPlayerFacing|GetPlayerFacing]]() - Returns the direction the player is facing. |
||
− | : [[API GetRealZoneText|GetRealZoneText]](<span style="font-size:smaller; color:#ecbc2a">[mapID]</span>) - Returns either instance name or zone name. |
||
− | : [[API GetSubZoneText|GetSubZoneText]]() - Returns the subzone text (e.g. "The Canals"). |
||
: [[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 |
+ | : [[API GetZoneText|GetZoneText]]() - Returns the name of the zone the player is in. |
− | : [[API |
+ | : [[API UnitDistanceSquared|UnitDistanceSquared]](<span class="apiarg">unit</span>) : <span class="apiret">distance, checkedDistance</span> {{apitag|noinstance}} - Returns the squared distance to a unit in your group. |
+ | : [[API UnitPosition|UnitPosition]](<span class="apiarg">unit</span>) {{apitag|noinstance}} - Returns the position of a unit in the current world area. |
||
− | : UI [https://www.townlong-yak.com/framexml/live/go/MapCanvasMixin:AddDataProvider WorldMapFrame:AddDataProvider](<span style="font-size:smaller; color:#ecbc2a">dataProvider</span>) - Adds a map data provider. |
||
− | : |
+ | : [https://www.townlong-yak.com/framexml/go/MapCanvasMixin:AddDataProvider WorldMapFrame:AddDataProvider](<span class="apiarg">dataProvider</span>) {{apitag|framexml}} - Adds a map data provider. |
− | : |
+ | : [https://www.townlong-yak.com/framexml/go/MapCanvasMixin:GetMapID WorldMapFrame:GetMapID]() {{apitag|framexml}} - Returns the currently viewed world map. |
− | : |
+ | : [https://www.townlong-yak.com/framexml/go/MapCanvasMixin:SetMapID WorldMapFrame:SetMapID](<span class="apiarg">uiMapID</span>) {{apitag|framexml}} - Sets the world map. |
− | : |
+ | : [https://www.townlong-yak.com/framexml/go/MapCanvasMixin:EnumerateAllPins WorldMapFrame:EnumerateAllPins]() {{apitag|framexml}} - Enumerates through all map pins. |
− | : UI [https://www.townlong-yak.com/framexml/8.1.5/MapUtil.lua#56 MapUtil.GetDisplayableMapForPlayer]() - Returns the lowest map for a player that has valid map art. |
||
− | Points of Interest |
||
− | : [[API C_AreaPoiInfo.GetAreaPOIForMap|C_AreaPoiInfo.GetAreaPOIForMap]](<span style="font-size:smaller; color:#ecbc2a">uiMapID</span>) - Returns area points of interest for a map. |
||
− | : [[API C_AreaPoiInfo.GetAreaPOIInfo|C_AreaPoiInfo.GetAreaPOIInfo]](<span style="font-size:smaller; color:#ecbc2a">uiMapID, areaPoiID</span>) - Returns area point of interest info. |
||
− | : [[API C_AreaPoiInfo.GetAreaPOISecondsLeft|C_AreaPoiInfo.GetAreaPOISecondsLeft]](<span style="font-size:smaller; color:#ecbc2a">areaPoiID</span>) - Returns the time left for an area poi. |
||
− | : [[API C_AreaPoiInfo.IsAreaPOITimed|C_AreaPoiInfo.IsAreaPOITimed]](<span style="font-size:smaller; color:#ecbc2a">areaPoiID</span>) - Returns whether an area poi is timed. |
||
− | : [[API GetPOITextureCoords|GetPOITextureCoords]](<span style="font-size:smaller; color:#ecbc2a">textureIndex</span>) |
||
− | : [[API SetPOIIconOverlapDistance|SetPOIIconOverlapDistance]](<span style="font-size:smaller; color:#ecbc2a">index</span>) |
||
− | : [[API SetPOIIconOverlapPushDistance|SetPOIIconOverlapPushDistance]](<span style="font-size:smaller; color:#ecbc2a">index</span>) |
||
− | : DEPRECATED (8.1.0) [[API C_AreaPoiInfo.GetAreaPOITimeLeft|C_AreaPoiInfo.GetAreaPOITimeLeft]](<span style="font-size:smaller; color:#ecbc2a">areaPoiID</span>) |
||
− | These functions relate to [[Vignette]]s. |
||
− | : [[API C_VignetteInfo.FindBestUniqueVignette|C_VignetteInfo.FindBestUniqueVignette]](<span style="font-size:smaller; color:#ecbc2a">vignetteGUIDs</span>) |
||
− | : [[API C_VignetteInfo.GetVignetteInfo|C_VignetteInfo.GetVignetteInfo]](<span style="font-size:smaller; color:#ecbc2a">vignetteGUID</span>) |
||
− | : [[API C_VignetteInfo.GetVignettePosition|C_VignetteInfo.GetVignettePosition]](<span style="font-size:smaller; color:#ecbc2a">vignetteGUID, uiMapID</span>) |
||
− | : [[API C_VignetteInfo.GetVignettes|C_VignetteInfo.GetVignettes]]() |
||
− | === |
+ | ===Minimap=== |
− | The [[Minimap]] |
+ | The [[Widget_API#Minimap|Minimap]] was reworked in [[Patch 9.0.1]] |
− | : [[API C_Minimap.GetDrawGroundTextures|C_Minimap.GetDrawGroundTextures]]() |
+ | : [[API C_Minimap.GetDrawGroundTextures|C_Minimap.GetDrawGroundTextures]]() : <span class="apiret">draw</span> |
− | : [[API C_Minimap.GetUiMapID|C_Minimap.GetUiMapID]]() |
+ | : [[API C_Minimap.GetUiMapID|C_Minimap.GetUiMapID]]() : <span class="apiret">uiMapID</span> |
− | : [[API C_Minimap.GetViewRadius|C_Minimap.GetViewRadius]]() |
+ | : [[API C_Minimap.GetViewRadius|C_Minimap.GetViewRadius]]() : <span class="apiret">yards</span> |
− | : [[API C_Minimap.IsRotateMinimapIgnored|C_Minimap.IsRotateMinimapIgnored]]() |
+ | : [[API C_Minimap.IsRotateMinimapIgnored|C_Minimap.IsRotateMinimapIgnored]]() : <span class="apiret">isIgnored</span> |
− | : [[API C_Minimap.SetDrawGroundTextures|C_Minimap.SetDrawGroundTextures]](<span |
+ | : [[API C_Minimap.SetDrawGroundTextures|C_Minimap.SetDrawGroundTextures]](<span class="apiarg">draw</span>) |
− | : [[API C_Minimap.SetIgnoreRotateMinimap|C_Minimap.SetIgnoreRotateMinimap]](<span |
+ | : [[API C_Minimap.SetIgnoreRotateMinimap|C_Minimap.SetIgnoreRotateMinimap]](<span class="apiarg">ignore</span>) |
− | : [[API C_Minimap.ShouldUseHybridMinimap|C_Minimap.ShouldUseHybridMinimap]]() |
+ | : [[API C_Minimap.ShouldUseHybridMinimap|C_Minimap.ShouldUseHybridMinimap]]() : <span class="apiret">shouldUse</span> |
− | === |
+ | ===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. |
||
− | These functions relate to [[Flight master]] taxi services. |
||
+ | : [[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_TaxiMap.GetAllTaxiNodes|C_TaxiMap.GetAllTaxiNodes]](<span style="font-size:smaller; color:#ecbc2a">uiMapID</span>) |
||
+ | : [[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_TaxiMap.GetTaxiNodesForMap|C_TaxiMap.GetTaxiNodesForMap]](<span style="font-size:smaller; color:#ecbc2a">uiMapID</span>) |
||
+ | : [[API C_AreaPoiInfo.IsAreaPOITimed|C_AreaPoiInfo.IsAreaPOITimed]](<span class="apiarg">areaPoiID</span>) : <span class="apiret">isTimed, hideTimerInTooltip</span> - Returns whether an area poi is timed. |
||
− | : [[API C_TaxiMap.ShouldMapShowTaxiNodes|C_TaxiMap.ShouldMapShowTaxiNodes]](<span style="font-size:smaller; color:#ecbc2a">uiMapID</span>) |
||
+ | : [[API SetPOIIconOverlapDistance|SetPOIIconOverlapDistance]](<span class="apiarg">index</span>) |
||
− | : [[API CloseTaxiMap|CloseTaxiMap]]() - Closes the Flightpath Map. |
||
+ | : [[API SetPOIIconOverlapPushDistance|SetPOIIconOverlapPushDistance]](<span class="apiarg">index</span>) |
||
− | : [[API GetNumRoutes|GetNumRoutes]](<span style="font-size:smaller; color:#ecbc2a">slot</span>) - Gets the number of hops between current-slot and slot. |
||
+ | [[Vignette]]s are used for one-time rare mobs and treasure chests. |
||
+ | : [[API C_VignetteInfo.FindBestUniqueVignette|C_VignetteInfo.FindBestUniqueVignette]](<span class="apiarg">vignetteGUIDs</span>) : <span class="apiret">bestUniqueVignetteIndex</span> |
||
+ | : [[API C_VignetteInfo.GetVignetteInfo|C_VignetteInfo.GetVignetteInfo]](<span class="apiarg">vignetteGUID</span>) : <span class="apiret">vignetteInfo</span> |
||
+ | : [[API C_VignetteInfo.GetVignettePosition|C_VignetteInfo.GetVignettePosition]](<span class="apiarg">vignetteGUID, uiMapID</span>) : <span class="apiret">vignettePosition, vignetteFacing</span> |
||
+ | : [[API C_VignetteInfo.GetVignettes|C_VignetteInfo.GetVignettes]]() : <span class="apiret">vignetteGUIDs</span> |
||
+ | |||
+ | ===Waypoints=== |
||
+ | 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.ClearUserWaypoint|C_Map.ClearUserWaypoint]]() |
||
+ | : [[API C_Map.GetUserWaypoint|C_Map.GetUserWaypoint]]() : <span class="apiret">point</span> |
||
+ | : [[API C_Map.GetUserWaypointFromHyperlink|C_Map.GetUserWaypointFromHyperlink]](<span class="apiarg">hyperlink</span>) : <span class="apiret">point</span> |
||
+ | : [[API C_Map.GetUserWaypointHyperlink|C_Map.GetUserWaypointHyperlink]]() : <span class="apiret">hyperlink</span> |
||
+ | : [[API C_Map.GetUserWaypointPositionForMap|C_Map.GetUserWaypointPositionForMap]](<span class="apiarg">uiMapID</span>) : <span class="apiret">mapPosition</span> |
||
+ | : [[API C_Map.HasUserWaypoint|C_Map.HasUserWaypoint]]() : <span class="apiret">hasUserWaypoint</span> |
||
+ | : [[API C_Map.SetUserWaypoint|C_Map.SetUserWaypoint]](<span class="apiarg">point</span>) |
||
+ | : [[API C_Navigation.GetDistance|C_Navigation.GetDistance]]() : <span class="apiret">distance</span> |
||
+ | : [[API C_Navigation.GetFrame|C_Navigation.GetFrame]]() : <span class="apiret">frame</span> |
||
+ | : [[API C_Navigation.GetTargetState|C_Navigation.GetTargetState]]() : <span class="apiret">state</span> |
||
+ | : [[API C_Navigation.HasValidScreenPosition|C_Navigation.HasValidScreenPosition]]() : <span class="apiret">hasValidScreenPosition</span> |
||
+ | : [[API C_Navigation.WasClampedToScreen|C_Navigation.WasClampedToScreen]]() : <span class="apiret">wasClamped</span> |
||
+ | Controls what's actively being tracked. |
||
+ | : [[API C_SuperTrack.GetHighestPrioritySuperTrackingType|C_SuperTrack.GetHighestPrioritySuperTrackingType]]() : <span class="apiret">type</span> |
||
+ | : [[API C_SuperTrack.GetSuperTrackedQuestID|C_SuperTrack.GetSuperTrackedQuestID]]() : <span class="apiret">questID</span> |
||
+ | : [[API C_SuperTrack.IsSuperTrackingAnything|C_SuperTrack.IsSuperTrackingAnything]]() : <span class="apiret">isSuperTracking</span> |
||
+ | : [[API C_SuperTrack.IsSuperTrackingCorpse|C_SuperTrack.IsSuperTrackingCorpse]]() : <span class="apiret">isSuperTracking</span> |
||
+ | : [[API C_SuperTrack.IsSuperTrackingQuest|C_SuperTrack.IsSuperTrackingQuest]]() : <span class="apiret">isSuperTracking</span> |
||
+ | : [[API C_SuperTrack.IsSuperTrackingUserWaypoint|C_SuperTrack.IsSuperTrackingUserWaypoint]]() : <span class="apiret">isSuperTracking</span> |
||
+ | : [[API C_SuperTrack.SetSuperTrackedQuestID|C_SuperTrack.SetSuperTrackedQuestID]](<span class="apiarg">questID</span>) |
||
+ | : [[API C_SuperTrack.SetSuperTrackedUserWaypoint|C_SuperTrack.SetSuperTrackedUserWaypoint]](<span class="apiarg">superTracked</span>) |
||
+ | : [[API C_QuestLog.GetNextWaypoint|C_QuestLog.GetNextWaypoint]](<span class="apiarg">questID</span>) : <span class="apiret">mapID, x, y</span> |
||
+ | : [[API C_QuestLog.GetNextWaypointForMap|C_QuestLog.GetNextWaypointForMap]](<span class="apiarg">questID, uiMapID</span>) : <span class="apiret">x, y</span> |
||
+ | : [[API C_QuestLog.GetNextWaypointText|C_QuestLog.GetNextWaypointText]](<span class="apiarg">questID</span>) : <span class="apiret">waypointText</span> |
||
+ | |||
+ | ===Flight Master=== |
||
+ | 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.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 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 GetTaxiBenchmarkMode|GetTaxiBenchmarkMode]]() |
: [[API GetTaxiBenchmarkMode|GetTaxiBenchmarkMode]]() |
||
: [[API GetTaxiMapID|GetTaxiMapID]]() |
: [[API GetTaxiMapID|GetTaxiMapID]]() |
||
− | : [[API NumTaxiNodes|NumTaxiNodes]]() - Returns the number of |
+ | : [[API NumTaxiNodes|NumTaxiNodes]]() - Returns the number of flight paths on the taxi map. |
: [[API SetTaxiBenchmarkMode|SetTaxiBenchmarkMode]]() |
: [[API SetTaxiBenchmarkMode|SetTaxiBenchmarkMode]]() |
||
− | : [[API SetTaxiMap|SetTaxiMap]](<span |
+ | : [[API SetTaxiMap|SetTaxiMap]](<span class="apiarg">frame</span>) |
− | : [[API TakeTaxiNode|TakeTaxiNode]](<span |
+ | : [[API TakeTaxiNode|TakeTaxiNode]](<span class="apiarg">slot</span>) - Travels to the specified flight path node. |
− | : [[API TaxiGetDestX|TaxiGetDestX]](<span |
+ | : [[API TaxiGetDestX|TaxiGetDestX]](<span class="apiarg">slot, hop</span>) |
− | : [[API TaxiGetDestY|TaxiGetDestY]](<span |
+ | : [[API TaxiGetDestY|TaxiGetDestY]](<span class="apiarg">slot, hop</span>) |
: [[API TaxiGetNodeSlot|TaxiGetNodeSlot]]() |
: [[API TaxiGetNodeSlot|TaxiGetNodeSlot]]() |
||
− | : [[API TaxiGetSrcX|TaxiGetSrcX]](<span |
+ | : [[API TaxiGetSrcX|TaxiGetSrcX]](<span class="apiarg">slot, hop</span>) |
− | : [[API TaxiGetSrcY|TaxiGetSrcY]](<span |
+ | : [[API TaxiGetSrcY|TaxiGetSrcY]](<span class="apiarg">slot, hop</span>) |
: [[API TaxiIsDirectFlight|TaxiIsDirectFlight]]() |
: [[API TaxiIsDirectFlight|TaxiIsDirectFlight]]() |
||
− | : [[API TaxiNodeCost|TaxiNodeCost]](<span |
+ | : [[API TaxiNodeCost|TaxiNodeCost]](<span class="apiarg">slot</span>) - Returns the cost of the flight path in copper. |
− | : [[API TaxiNodeGetType|TaxiNodeGetType]](<span |
+ | : [[API TaxiNodeGetType|TaxiNodeGetType]](<span class="apiarg">slot</span>) - Returns the type of a flight path node. |
− | : [[API TaxiNodeName|TaxiNodeName]](<span |
+ | : [[API TaxiNodeName|TaxiNodeName]](<span class="apiarg">slot</span>) - Returns the name of a flight path node. |
− | : [[API TaxiNodePosition|TaxiNodePosition]](<span |
+ | : [[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 |
+ | : [[API UnitOnTaxi|UnitOnTaxi]](<span class="apiarg">unit</span>) - Returns true if the unit is on a flight path. |
− | |||
− | ==== Tracking ==== |
||
− | These functions relate to [[Tracking]]. |
||
− | : [[API ClearAllTracking|ClearAllTracking]]() |
||
− | : [[API GetNumTrackingTypes|GetNumTrackingTypes]]() - Returns number of available tracking methods. |
||
− | : [[API GetTrackingInfo|GetTrackingInfo]](<span style="font-size:smaller; color:#ecbc2a">id</span>) - Retrieves tracking information from specified id. |
||
− | : [[API SetTracking|SetTracking]](<span style="font-size:smaller; color:#ecbc2a">id, enabled</span>) - Enables or disables a tracking method. |
||
− | |||
− | ==== Navigation ==== |
||
− | : [[API C_Navigation.GetDistance|C_Navigation.GetDistance]]() |
||
− | : [[API C_Navigation.GetFrame|C_Navigation.GetFrame]]() |
||
− | : [[API C_Navigation.GetTargetState|C_Navigation.GetTargetState]]() |
||
− | : [[API C_Navigation.HasValidScreenPosition|C_Navigation.HasValidScreenPosition]]() |
||
− | : [[API C_Navigation.WasClampedToScreen|C_Navigation.WasClampedToScreen]]() |
||
− | == |
+ | ==Merchants== |
+ | ===Vendor=== |
||
− | : [[API C_MerchantFrame.GetBuybackItemID|C_MerchantFrame.GetBuybackItemID]](<span style="font-size:smaller; color:#ecbc2a">buybackSlotIndex</span>) |
||
+ | Relates to [[Vendor]]s. |
||
− | : [[API C_MerchantFrame.IsMerchantItemRefundable|C_MerchantFrame.IsMerchantItemRefundable]](<span style="font-size:smaller; color:#ecbc2a">index</span>) |
||
+ | : [[API C_MerchantFrame.GetBuybackItemID|C_MerchantFrame.GetBuybackItemID]](<span class="apiarg">buybackSlotIndex</span>) : <span class="apiret">buybackItemID</span> |
||
− | : [[API BuyMerchantItem|BuyMerchantItem]](<span style="font-size:smaller; color:#ecbc2a">index [, qty]</span>) - Buys an item from a merchant. |
||
+ | : [[API C_MerchantFrame.IsMerchantItemRefundable|C_MerchantFrame.IsMerchantItemRefundable]](<span class="apiarg">index</span>) : <span class="apiret">refundable</span> |
||
− | : [[API BuybackItem|BuybackItem]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Buys back a sold item. |
||
− | : [[API |
+ | : [[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 an item from the merchant. |
||
+ | : [[API CanAffordMerchantItem|CanAffordMerchantItem]](<span class="apiarg">index</span>) |
||
: [[API CanMerchantRepair|CanMerchantRepair]]() - Returns true if the merchant can repair items. |
: [[API CanMerchantRepair|CanMerchantRepair]]() - Returns true if the merchant can repair items. |
||
: [[API CloseMerchant|CloseMerchant]]() - Closes the merchant window. |
: [[API CloseMerchant|CloseMerchant]]() - Closes the merchant window. |
||
+ | : [[API GetBuybackItemInfo|GetBuybackItemInfo]](<span class="apiarg">index</span>) - Returns info for an item that can be bought back from a merchant. |
||
− | : [[API ContainerRefundItemPurchase|ContainerRefundItemPurchase]](<span style="font-size:smaller; color:#ecbc2a">index, slot [, isEquipped]</span>) |
||
− | : [[API |
+ | : [[API GetBuybackItemLink|GetBuybackItemLink]](<span class="apiarg">index</span>) - Returns an [[itemLink]] for the buyback item. |
− | : [[API GetBuybackItemLink|GetBuybackItemLink]](<span style="font-size:smaller; color:#ecbc2a">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 |
+ | : [[API GetMerchantItemCostInfo|GetMerchantItemCostInfo]](<span class="apiarg">index</span>) - Returns "alternative currency" information about an item. |
− | : [[API GetMerchantItemCostItem|GetMerchantItemCostItem]](<span |
+ | : [[API GetMerchantItemCostItem|GetMerchantItemCostItem]](<span class="apiarg">index, itemIndex</span>) - Returns info for the currency cost for a merchant item. |
− | : [[API GetMerchantItemID|GetMerchantItemID]](<span |
+ | : [[API GetMerchantItemID|GetMerchantItemID]](<span class="apiarg">index</span>) |
− | : [[API GetMerchantItemInfo|GetMerchantItemInfo]](<span |
+ | : [[API GetMerchantItemInfo|GetMerchantItemInfo]](<span class="apiarg">index</span>) - Returns info for a merchant item. |
− | : [[API GetMerchantItemLink|GetMerchantItemLink]](<span |
+ | : [[API GetMerchantItemLink|GetMerchantItemLink]](<span class="apiarg">index</span>) - Returns the item link for a merchant item. |
− | : [[API GetMerchantItemMaxStack|GetMerchantItemMaxStack]](<span |
+ | : [[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 |
+ | : [[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 the number of items available for buyback. |
: [[API GetRepairAllCost|GetRepairAllCost]]() |
: [[API GetRepairAllCost|GetRepairAllCost]]() |
||
− | : [[API RepairAllItems|RepairAllItems]](<span |
+ | : [[API RepairAllItems|RepairAllItems]](<span class="apiarg">[guildBankRepair]</span>) - Repairs all equipped and inventory items. |
: [[API ResetSetMerchantFilter|ResetSetMerchantFilter]]() |
: [[API ResetSetMerchantFilter|ResetSetMerchantFilter]]() |
||
: [[API SetMerchantFilter|SetMerchantFilter]]() |
: [[API SetMerchantFilter|SetMerchantFilter]]() |
||
− | === |
+ | ===Trainer=== |
+ | Relates to [[Trainer]]s. |
||
− | Nameplates were reworked in [[Patch 7.0.3]]. |
||
+ | : [[API BuyTrainerService|BuyTrainerService]](<span class="apiarg">index</span>) - Buys a trainer service (e.g. class skills and profession recipes). |
||
− | : [[API C_NamePlate.GetNamePlateEnemyClickThrough|C_NamePlate.GetNamePlateEnemyClickThrough]]() |
||
+ | : [[API CloseTrainer|CloseTrainer]]() - Closes the trainer window. |
||
− | : [[API C_NamePlate.GetNamePlateEnemyPreferredClickInsets|C_NamePlate.GetNamePlateEnemyPreferredClickInsets]]() |
||
+ | : [[API GetNumTrainerServices|GetNumTrainerServices]]() - Returns the number of trainer services. |
||
− | : [[API C_NamePlate.GetNamePlateEnemySize|C_NamePlate.GetNamePlateEnemySize]]() |
||
+ | : [[API GetTrainerGreetingText|GetTrainerGreetingText]]() - Returns the trainer's greeting text. |
||
− | : [[API C_NamePlate.GetNamePlateForUnit|C_NamePlate.GetNamePlateForUnit]](<span style="font-size:smaller; color:#ecbc2a">unitToken [, includeForbidden]</span>) |
||
+ | : [[API GetTrainerSelectionIndex|GetTrainerSelectionIndex]]() - Returns the index of the selected trainer service. |
||
− | : [[API C_NamePlate.GetNamePlateFriendlyClickThrough|C_NamePlate.GetNamePlateFriendlyClickThrough]]() |
||
+ | : [[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 C_NamePlate.GetNamePlateFriendlyPreferredClickInsets|C_NamePlate.GetNamePlateFriendlyPreferredClickInsets]]() |
||
+ | : [[API GetTrainerServiceCost|GetTrainerServiceCost]](<span class="apiarg">index</span>) - Returns the cost of the specified trainer service. |
||
− | : [[API C_NamePlate.GetNamePlateFriendlySize|C_NamePlate.GetNamePlateFriendlySize]]() |
||
+ | : [[API GetTrainerServiceDescription|GetTrainerServiceDescription]](<span class="apiarg">index</span>) - Returns the description of a specific trainer service. |
||
− | : [[API C_NamePlate.GetNamePlateSelfClickThrough|C_NamePlate.GetNamePlateSelfClickThrough]]() |
||
+ | : [[API GetTrainerServiceIcon|GetTrainerServiceIcon]](<span class="apiarg">index</span>) - Returns the icon texture for a specific trainer service. |
||
− | : [[API C_NamePlate.GetNamePlateSelfPreferredClickInsets|C_NamePlate.GetNamePlateSelfPreferredClickInsets]]() |
||
+ | : [[API GetTrainerServiceInfo|GetTrainerServiceInfo]](<span class="apiarg">index</span>) - Returns information about a trainer service. |
||
− | : [[API C_NamePlate.GetNamePlateSelfSize|C_NamePlate.GetNamePlateSelfSize]]() |
||
+ | : [[API GetTrainerServiceItemLink|GetTrainerServiceItemLink]](<span class="apiarg">index</span>) - Returns an item link for a trainer service. |
||
− | : [[API C_NamePlate.GetNamePlates|C_NamePlate.GetNamePlates]](<span style="font-size:smaller; color:#ecbc2a">[includeForbidden]</span>) |
||
+ | : [[API GetTrainerServiceLevelReq|GetTrainerServiceLevelReq]](<span class="apiarg">index</span>) - Returns the required level to learn a skill from the trainer. |
||
− | : [[API C_NamePlate.GetNumNamePlateMotionTypes|C_NamePlate.GetNumNamePlateMotionTypes]]() |
||
+ | : [[API GetTrainerServiceNumAbilityReq|GetTrainerServiceNumAbilityReq]]() - Get the maximum number of requirements that [[API GetTrainerServiceAbilityReq|GetTrainerServiceAbilityReq]] has. |
||
− | : [[API C_NamePlate.GetTargetClampingInsets|C_NamePlate.GetTargetClampingInsets]]() |
||
+ | : [[API GetTrainerServiceSkillLine|GetTrainerServiceSkillLine]](<span class="apiarg">index</span>) |
||
− | : [[API C_NamePlate.SetNamePlateEnemyClickThrough|C_NamePlate.SetNamePlateEnemyClickThrough]](<span style="font-size:smaller; color:#ecbc2a">clickthrough</span>) |
||
+ | : [[API GetTrainerServiceSkillReq|GetTrainerServiceSkillReq]](<span class="apiarg">index</span>) - Returns the name of the required skill and the amount needed in that skill. |
||
− | : [[API C_NamePlate.SetNamePlateEnemyPreferredClickInsets|C_NamePlate.SetNamePlateEnemyPreferredClickInsets]]() |
||
+ | : [[API GetTrainerServiceStepIndex|GetTrainerServiceStepIndex]]() |
||
− | : [[API C_NamePlate.SetNamePlateEnemySize|C_NamePlate.SetNamePlateEnemySize]](<span style="font-size:smaller; color:#ecbc2a">width, height</span>) |
||
+ | : [[API GetTrainerServiceTypeFilter|GetTrainerServiceTypeFilter]](<span class="apiarg">filter</span>) - Returns the status of a skill filter in the trainer window. |
||
− | : [[API C_NamePlate.SetNamePlateFriendlyClickThrough|C_NamePlate.SetNamePlateFriendlyClickThrough]]() |
||
+ | : [[API GetTrainerTradeskillRankValues|GetTrainerTradeskillRankValues]]() |
||
− | : [[API C_NamePlate.SetNamePlateFriendlyPreferredClickInsets|C_NamePlate.SetNamePlateFriendlyPreferredClickInsets]](<span style="font-size:smaller; color:#ecbc2a">left, right, top, bottom</span>) |
||
+ | : [[API IsTradeskillTrainer|IsTradeskillTrainer]]() - Returns true if the training window is used for a profession trainer. |
||
− | : [[API C_NamePlate.SetNamePlateFriendlySize|C_NamePlate.SetNamePlateFriendlySize]](<span style="font-size:smaller; color:#ecbc2a">width, height</span>) |
||
+ | : [[API OpenTrainer|OpenTrainer]]() |
||
− | : [[API C_NamePlate.SetNamePlateSelfClickThrough|C_NamePlate.SetNamePlateSelfClickThrough]](<span style="font-size:smaller; color:#ecbc2a">clickthrough</span>) |
||
+ | : [[API SelectTrainerService|SelectTrainerService]]() |
||
− | : [[API C_NamePlate.SetNamePlateSelfPreferredClickInsets|C_NamePlate.SetNamePlateSelfPreferredClickInsets]](<span style="font-size:smaller; color:#ecbc2a">left, right, top, bottom</span>) |
||
+ | : [[API SetTrainerServiceTypeFilter|SetTrainerServiceTypeFilter]](<span class="apiarg">filter, state</span>) - Sets the status of a skill filter in the trainer window. |
||
− | : [[API C_NamePlate.SetNamePlateSelfSize|C_NamePlate.SetNamePlateSelfSize]](<span style="font-size:smaller; color:#ecbc2a">width, height</span>) |
||
− | : [[API C_NamePlate.SetTargetClampingInsets|C_NamePlate.SetTargetClampingInsets]](<span style="font-size:smaller; color:#ecbc2a">clickthrough</span>) |
||
− | : [[API SetInWorldUIVisibility|SetInWorldUIVisibility]](<span style="font-size:smaller; color:#ecbc2a">visible</span>) - Allows nameplates to be shown even while the UI is hidden (with Alt-Z) |
||
− | : [[API UnitNameplateShowsWidgetsOnly|UnitNameplateShowsWidgetsOnly]](<span style="font-size:smaller; color:#ecbc2a">unit</span>) |
||
− | == |
+ | ==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,010: | Line 3,718: | ||
: [[API C_PetBattles.CanAcceptQueuedPVPMatch|C_PetBattles.CanAcceptQueuedPVPMatch]]() |
: [[API C_PetBattles.CanAcceptQueuedPVPMatch|C_PetBattles.CanAcceptQueuedPVPMatch]]() |
||
: [[API C_PetBattles.CanActivePetSwapOut|C_PetBattles.CanActivePetSwapOut]]() |
: [[API C_PetBattles.CanActivePetSwapOut|C_PetBattles.CanActivePetSwapOut]]() |
||
− | : [[API C_PetBattles.CanPetSwapIn|C_PetBattles.CanPetSwapIn]](<span |
+ | : [[API C_PetBattles.CanPetSwapIn|C_PetBattles.CanPetSwapIn]](<span class="apiarg">petIndex</span>) |
: [[API C_PetBattles.CancelPVPDuel|C_PetBattles.CancelPVPDuel]]() |
: [[API C_PetBattles.CancelPVPDuel|C_PetBattles.CancelPVPDuel]]() |
||
− | : [[API C_PetBattles.ChangePet|C_PetBattles.ChangePet]](<span |
+ | : [[API C_PetBattles.ChangePet|C_PetBattles.ChangePet]](<span class="apiarg">petIndex</span>) |
: [[API C_PetBattles.DeclineQueuedPVPMatch|C_PetBattles.DeclineQueuedPVPMatch]]() |
: [[API C_PetBattles.DeclineQueuedPVPMatch|C_PetBattles.DeclineQueuedPVPMatch]]() |
||
: [[API C_PetBattles.ForfeitGame|C_PetBattles.ForfeitGame]]() |
: [[API C_PetBattles.ForfeitGame|C_PetBattles.ForfeitGame]]() |
||
− | : [[API C_PetBattles.GetAbilityEffectInfo|C_PetBattles.GetAbilityEffectInfo]](<span |
+ | : [[API C_PetBattles.GetAbilityEffectInfo|C_PetBattles.GetAbilityEffectInfo]](<span class="apiarg">abilityID, turnIndex, effectIndex, effectName</span>) |
− | : [[API C_PetBattles.GetAbilityInfoByID|C_PetBattles.GetAbilityInfoByID]](<span |
+ | : [[API C_PetBattles.GetAbilityInfoByID|C_PetBattles.GetAbilityInfoByID]](<span class="apiarg">abilityID</span>) |
− | : [[API C_PetBattles.GetAbilityInfo|C_PetBattles.GetAbilityInfo]](<span |
+ | : [[API C_PetBattles.GetAbilityInfo|C_PetBattles.GetAbilityInfo]](<span class="apiarg">petOwner, petIndex, abilityIndex</span>) |
− | : [[API C_PetBattles.GetAbilityProcTurnIndex|C_PetBattles.GetAbilityProcTurnIndex]](<span |
+ | : [[API C_PetBattles.GetAbilityProcTurnIndex|C_PetBattles.GetAbilityProcTurnIndex]](<span class="apiarg">abilityID, procType</span>) |
− | : [[API C_PetBattles.GetAbilityStateModification|C_PetBattles.GetAbilityStateModification]](<span |
+ | : [[API C_PetBattles.GetAbilityStateModification|C_PetBattles.GetAbilityStateModification]](<span class="apiarg">abilityID, stateID</span>) |
− | : [[API C_PetBattles.GetAbilityState|C_PetBattles.GetAbilityState]](<span |
+ | : [[API C_PetBattles.GetAbilityState|C_PetBattles.GetAbilityState]](<span class="apiarg">petOwner, petIndex, actionIndex</span>) |
− | : [[API C_PetBattles.GetActivePet|C_PetBattles.GetActivePet]](<span |
+ | : [[API C_PetBattles.GetActivePet|C_PetBattles.GetActivePet]](<span class="apiarg">petOwner</span>) |
: [[API C_PetBattles.GetAllEffectNames|C_PetBattles.GetAllEffectNames]]() |
: [[API C_PetBattles.GetAllEffectNames|C_PetBattles.GetAllEffectNames]]() |
||
: [[API C_PetBattles.GetAllStates|C_PetBattles.GetAllStates]]() |
: [[API C_PetBattles.GetAllStates|C_PetBattles.GetAllStates]]() |
||
− | : [[API C_PetBattles.GetAttackModifier|C_PetBattles.GetAttackModifier]](<span |
+ | : [[API C_PetBattles.GetAttackModifier|C_PetBattles.GetAttackModifier]](<span class="apiarg">petType, enemyPetType</span>) |
− | : [[API C_PetBattles.GetAuraInfo|C_PetBattles.GetAuraInfo]](<span |
+ | : [[API C_PetBattles.GetAuraInfo|C_PetBattles.GetAuraInfo]](<span class="apiarg">petOwner, petIndex, auraIndex</span>) |
: [[API C_PetBattles.GetBattleState|C_PetBattles.GetBattleState]]() |
: [[API C_PetBattles.GetBattleState|C_PetBattles.GetBattleState]]() |
||
− | : [[API C_PetBattles.GetBreedQuality|C_PetBattles.GetBreedQuality]](<span |
+ | : [[API C_PetBattles.GetBreedQuality|C_PetBattles.GetBreedQuality]](<span class="apiarg">petOwner, slot</span>) : <span class="apiret">quality</span> |
− | : [[API C_PetBattles.GetDisplayID|C_PetBattles.GetDisplayID]](<span |
+ | : [[API C_PetBattles.GetDisplayID|C_PetBattles.GetDisplayID]](<span class="apiarg">petOwner, petIndex</span>) |
: [[API C_PetBattles.GetForfeitPenalty|C_PetBattles.GetForfeitPenalty]]() |
: [[API C_PetBattles.GetForfeitPenalty|C_PetBattles.GetForfeitPenalty]]() |
||
− | : [[API C_PetBattles.GetHealth|C_PetBattles.GetHealth]](<span |
+ | : [[API C_PetBattles.GetHealth|C_PetBattles.GetHealth]](<span class="apiarg">petOwner, petIndex</span>) |
− | : [[API C_PetBattles.GetIcon|C_PetBattles.GetIcon]](<span |
+ | : [[API C_PetBattles.GetIcon|C_PetBattles.GetIcon]](<span class="apiarg">petOwner, slot</span>) : <span class="apiret">iconFileID</span> |
− | : [[API C_PetBattles.GetLevel|C_PetBattles.GetLevel]](<span |
+ | : [[API C_PetBattles.GetLevel|C_PetBattles.GetLevel]](<span class="apiarg">petOwner, petIndex</span>) |
− | : [[API C_PetBattles.GetMaxHealth|C_PetBattles.GetMaxHealth]](<span |
+ | : [[API C_PetBattles.GetMaxHealth|C_PetBattles.GetMaxHealth]](<span class="apiarg">petOwner, petIndex</span>) |
− | : [[API C_PetBattles.GetName|C_PetBattles.GetName]](<span |
+ | : [[API C_PetBattles.GetName|C_PetBattles.GetName]](<span class="apiarg">petOwner, slot</span>) : <span class="apiret">customName, speciesName</span> |
− | : [[API C_PetBattles.GetNumAuras|C_PetBattles.GetNumAuras]](<span |
+ | : [[API C_PetBattles.GetNumAuras|C_PetBattles.GetNumAuras]](<span class="apiarg">petOwner, petIndex</span>) |
− | : [[API C_PetBattles.GetNumPets|C_PetBattles.GetNumPets]](<span |
+ | : [[API C_PetBattles.GetNumPets|C_PetBattles.GetNumPets]](<span class="apiarg">petOwner</span>) |
: [[API C_PetBattles.GetPVPMatchmakingInfo|C_PetBattles.GetPVPMatchmakingInfo]]() |
: [[API C_PetBattles.GetPVPMatchmakingInfo|C_PetBattles.GetPVPMatchmakingInfo]]() |
||
− | : [[API C_PetBattles.GetPetSpeciesID|C_PetBattles.GetPetSpeciesID]](<span |
+ | : [[API C_PetBattles.GetPetSpeciesID|C_PetBattles.GetPetSpeciesID]](<span class="apiarg">petOwner, petIndex</span>) |
− | : [[API C_PetBattles.GetPetType|C_PetBattles.GetPetType]](<span |
+ | : [[API C_PetBattles.GetPetType|C_PetBattles.GetPetType]](<span class="apiarg">petOwner, petIndex</span>) |
: [[API C_PetBattles.GetPlayerTrapAbility|C_PetBattles.GetPlayerTrapAbility]]() |
: [[API C_PetBattles.GetPlayerTrapAbility|C_PetBattles.GetPlayerTrapAbility]]() |
||
− | : [[API C_PetBattles.GetPower|C_PetBattles.GetPower]](<span |
+ | : [[API C_PetBattles.GetPower|C_PetBattles.GetPower]](<span class="apiarg">petOwner, petIndex</span>) |
: [[API C_PetBattles.GetSelectedAction|C_PetBattles.GetSelectedAction]]() |
: [[API C_PetBattles.GetSelectedAction|C_PetBattles.GetSelectedAction]]() |
||
− | : [[API C_PetBattles.GetSpeed|C_PetBattles.GetSpeed]](<span |
+ | : [[API C_PetBattles.GetSpeed|C_PetBattles.GetSpeed]](<span class="apiarg">petOwner, petIndex</span>) |
− | : [[API C_PetBattles.GetStateValue|C_PetBattles.GetStateValue]](<span |
+ | : [[API C_PetBattles.GetStateValue|C_PetBattles.GetStateValue]](<span class="apiarg">petOwner, petIndex, stateID</span>) |
: [[API C_PetBattles.GetTurnTimeInfo|C_PetBattles.GetTurnTimeInfo]]() |
: [[API C_PetBattles.GetTurnTimeInfo|C_PetBattles.GetTurnTimeInfo]]() |
||
− | : [[API C_PetBattles.GetXP|C_PetBattles.GetXP]](<span |
+ | : [[API C_PetBattles.GetXP|C_PetBattles.GetXP]](<span class="apiarg">petOwner, petIndex</span>) |
: [[API C_PetBattles.IsInBattle|C_PetBattles.IsInBattle]]() |
: [[API C_PetBattles.IsInBattle|C_PetBattles.IsInBattle]]() |
||
− | : [[API C_PetBattles.IsPlayerNPC|C_PetBattles.IsPlayerNPC]](<span |
+ | : [[API C_PetBattles.IsPlayerNPC|C_PetBattles.IsPlayerNPC]]() : <span class="apiret">isPlayerNPC</span> |
: [[API C_PetBattles.IsSkipAvailable|C_PetBattles.IsSkipAvailable]]() |
: [[API C_PetBattles.IsSkipAvailable|C_PetBattles.IsSkipAvailable]]() |
||
: [[API C_PetBattles.IsTrapAvailable|C_PetBattles.IsTrapAvailable]]() |
: [[API C_PetBattles.IsTrapAvailable|C_PetBattles.IsTrapAvailable]]() |
||
: [[API C_PetBattles.IsWaitingOnOpponent|C_PetBattles.IsWaitingOnOpponent]]() |
: [[API C_PetBattles.IsWaitingOnOpponent|C_PetBattles.IsWaitingOnOpponent]]() |
||
− | : [[API C_PetBattles.IsWildBattle|C_PetBattles.IsWildBattle]]() |
+ | : [[API C_PetBattles.IsWildBattle|C_PetBattles.IsWildBattle]]() : <span class="apiret">isWildBattle</span> |
− | : [[API C_PetBattles.SetPendingReportBattlePetTarget|C_PetBattles.SetPendingReportBattlePetTarget]](<span |
+ | : [[API C_PetBattles.SetPendingReportBattlePetTarget|C_PetBattles.SetPendingReportBattlePetTarget]](<span class="apiarg">petIndex</span>) |
− | : [[API C_PetBattles.SetPendingReportTargetFromUnit|C_PetBattles.SetPendingReportTargetFromUnit]](<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]]() |
||
− | : |
+ | : [[API C_PetBattles.SkipTurn|C_PetBattles.SkipTurn]]() {{apitag|hwevent}} |
: [[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]]() |
||
− | : |
+ | : [[API C_PetBattles.UseAbility|C_PetBattles.UseAbility]](<span class="apiarg">actionIndex</span>) {{apitag|hwevent}} |
− | : |
+ | : [[API C_PetBattles.UseTrap|C_PetBattles.UseTrap]]() {{apitag|hwevent}} |
− | : [[API CanTrackBattlePets|CanTrackBattlePets]]() - Returns whether the player can track battle pets. |
||
− | : [[API IsTrackingBattlePets|IsTrackingBattlePets]]() - Returns whether the player is currently tracking battle pets. |
||
: [[API UnitBattlePetLevel|UnitBattlePetLevel]]() |
: [[API UnitBattlePetLevel|UnitBattlePetLevel]]() |
||
: [[API UnitBattlePetSpeciesID|UnitBattlePetSpeciesID]]() |
: [[API UnitBattlePetSpeciesID|UnitBattlePetSpeciesID]]() |
||
: [[API UnitBattlePetType|UnitBattlePetType]]() |
: [[API UnitBattlePetType|UnitBattlePetType]]() |
||
+ | : [[API UnitIsBattlePet|UnitIsBattlePet]](<span class="apiarg">unit</span>) |
||
− | : [[API UnitIsBattlePetCompanion|UnitIsBattlePetCompanion]]() |
||
+ | : [[API UnitIsBattlePetCompanion|UnitIsBattlePetCompanion]](<span class="apiarg">unit</span>) |
||
− | : [[API UnitIsBattlePet|UnitIsBattlePet]]() |
||
− | : [[API UnitIsOtherPlayersBattlePet|UnitIsOtherPlayersBattlePet]]() |
+ | : [[API UnitIsOtherPlayersBattlePet|UnitIsOtherPlayersBattlePet]](<span class="apiarg">unit</span>) |
− | : [[API UnitIsWildBattlePet|UnitIsWildBattlePet]]() |
+ | : [[API UnitIsWildBattlePet|UnitIsWildBattlePet]](<span class="apiarg">unit</span>) |
− | == |
+ | ==Players== |
+ | : [[API C_PlayerInfo.GetAlternateFormInfo|C_PlayerInfo.GetAlternateFormInfo]]() : <span class="apiret">hasAlternateForm, inAlternateForm</span> |
||
− | Petitions are signup documents for guilds and arena teams. Some functions below only apply to a particular petition type |
||
+ | : [[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 CanSignPetition|CanSignPetition]]() - Returns nil if the player cannot sign the current petition. |
||
+ | : [[API C_PlayerInfo.GetName|C_PlayerInfo.GetName]](<span class="apiarg">playerLocation</span>) : <span class="apiret">name</span> - Returns the name of a player. |
||
− | : [[API ClosePetition|ClosePetition]]() - Closes the current petition. |
||
+ | : [[API C_PlayerInfo.GetRace|C_PlayerInfo.GetRace]](<span class="apiarg">playerLocation</span>) : <span class="apiret">raceID</span> - Returns the race of a player. |
||
− | : [[API GetNumPetitionNames|GetNumPetitionNames]]() - Gets the number of signatures on the current petition. |
||
+ | : [[API C_PlayerInfo.GetSex|C_PlayerInfo.GetSex]](<span class="apiarg">playerLocation</span>) : <span class="apiret">sex</span> - Returns the sex of a player. |
||
− | : [[API GetPetitionInfo|GetPetitionInfo]]() - Retrieves information about the current petition. |
||
− | : [[API |
+ | : [[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.IsConnected|C_PlayerInfo.IsConnected]](<span class="apiarg">[playerLocation]</span>) : <span class="apiret">isConnected</span> - Returns true if the player is connected. |
||
− | : [[API OfferPetition|OfferPetition]]() - Offers a petition to your target, inviting them to join your would-be guild/arena team. |
||
+ | : [[API C_PlayerInfo.UnitIsSameServer|C_PlayerInfo.UnitIsSameServer]](<span class="apiarg">playerLocation</span>) : <span class="apiret">unitIsSameServer</span> - Returns true if a player is from the same or [[Connected Realm|connected]] realm. |
||
− | : [[API RenamePetition|RenamePetition]](<span style="font-size:smaller; color:#ecbc2a">name</span>) - Renames the current petition. |
||
+ | : [[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 SignPetition|SignPetition]]() - Signs the current petition. |
||
+ | : [[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 TurnInGuildCharter|TurnInGuildCharter]]() - Founds a guild. |
||
+ | : [[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. |
||
+ | |||
+ | ===Inspection=== |
||
+ | : [[API CanInspect|CanInspect]](<span class="apiarg">unit [, showError]</span>) - Returns true if the player can inspect the unit. |
||
+ | : [[API CheckInteractDistance|CheckInteractDistance]](<span class="apiarg">unit, interaction</span>) - Returns 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 GetInspectArenaData|GetInspectArenaData]](<span class="apiarg">bracketIndex</span>) |
||
+ | : [[API GetInspectGuildInfo|GetInspectGuildInfo]](<span class="apiarg">unit</span>) |
||
+ | : [[API GetInspectHonorData|GetInspectHonorData]]() - Returns honor info for the inspected player unit. |
||
+ | : [[API GetInspectRatedBGData|GetInspectRatedBGData]]() |
||
+ | : [[API GetInspectSpecialization|GetInspectSpecialization]](<span class="apiarg">unit</span>) - Returns the specialization for the inspected player unit. |
||
+ | : [[API GetInspectTalent|GetInspectTalent]]() |
||
+ | : [[API NotifyInspect|NotifyInspect]](<span class="apiarg">unit</span>) - Requests another player's inventory and talent info before inspecting. |
||
+ | : [[API InspectUnit|InspectUnit]](<span class="apiarg">unit</span>) {{apitag|framexml}} - Instructs FrameXML to inspect a particular unit (query server; show UI). |
||
+ | |||
+ | ===Trading=== |
||
+ | Relates to [[Trade|Trading]]. |
||
+ | : [[API AcceptTrade|AcceptTrade]]() {{apitag|hwevent}} - Accepts the current trade offer. |
||
+ | : [[API AddTradeMoney|AddTradeMoney]]() - Adds money currently held by the cursor to the trade offer. |
||
+ | : [[API BeginTrade|BeginTrade]]() |
||
+ | : [[API CancelTrade|CancelTrade]]() - Declines the current trade offer. |
||
+ | : [[API CancelTradeAccept|CancelTradeAccept]]() - Cancels the trade attempt which required an accept. |
||
+ | : [[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 CloseTrade|CloseTrade]]() - Closes 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 window for the other player. |
||
+ | : [[API GetTradePlayerItemInfo|GetTradePlayerItemInfo]](<span class="apiarg">id</span>) - Returns information about a trade item. |
||
+ | : [[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 item info for the other player in the trade window. |
||
+ | : [[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>) - 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. |
||
+ | |||
+ | ===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.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]]() - Declines 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 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.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.IsSummonSkippingStartExperience|C_SummonInfo.IsSummonSkippingStartExperience]]() : <span class="apiret">isSummonSkippingStartExperience</span> |
||
+ | : [[API PlayerCanTeleport|PlayerCanTeleport]]() |
||
+ | |||
+ | ===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.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.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 AcceptResurrect|AcceptResurrect]]() - Accepts a resurrection offer. |
||
+ | : [[API CannotBeResurrected|CannotBeResurrected]]() |
||
+ | : [[API DeathRecap_GetEvents|DeathRecap_GetEvents]]() |
||
+ | : [[API DeathRecap_HasEvents|DeathRecap_HasEvents]]() |
||
+ | : [[API DeclineResurrect|DeclineResurrect]]() - Declines a resurrection offer. |
||
+ | : [[API GetCemeteryPreference|GetCemeteryPreference]]() |
||
+ | : [[API GetCorpseRecoveryDelay|GetCorpseRecoveryDelay]]() - Time left before a player can accept a resurrection. |
||
+ | : [[API GetDeathRecapLink|GetDeathRecapLink]](<span class="apiarg">recapID</span>) |
||
+ | : [[API GetReleaseTimeRemaining|GetReleaseTimeRemaining]]() - Returns the amount of time left before your ghost is pulled from your body. |
||
+ | : [[API GetResSicknessDuration|GetResSicknessDuration]]() |
||
+ | : [[API HasNoReleaseAura|HasNoReleaseAura]]() |
||
+ | : [[API IsCemeterySelectionAvailable|IsCemeterySelectionAvailable]]() |
||
+ | : [[API IsEncounterLimitingResurrections|IsEncounterLimitingResurrections]]() |
||
+ | : [[API IsEncounterSuppressingRelease|IsEncounterSuppressingRelease]]() |
||
+ | : [[API NotWhileDeadError|NotWhileDeadError]]() - Generates an error message saying you cannot do that while dead. |
||
+ | : [[API PortGraveyard|PortGraveyard]]() {{apitag|protected}} |
||
+ | : [[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 ResurrectHasSickness|ResurrectHasSickness]]() - Appears to be used when accepting a resurrection will give you resurrection sickessness. |
||
+ | : [[API ResurrectHasTimer|ResurrectHasTimer]]() - Does the player have to wait before accepting a resurrection. |
||
+ | : [[API RetrieveCorpse|RetrieveCorpse]]() - Resurrects when the player is standing near its corpse. |
||
+ | : [[API SetCemeteryPreference|SetCemeteryPreference]](<span class="apiarg">cemeteryID</span>) |
||
+ | : [[API TimeoutResurrect|TimeoutResurrect]]() |
||
− | == |
+ | ==Professions== |
− | + | Relates to [[Profession]]s. |
|
: [[API C_TradeSkillUI.AnyRecipeCategoriesFiltered|C_TradeSkillUI.AnyRecipeCategoriesFiltered]]() |
: [[API C_TradeSkillUI.AnyRecipeCategoriesFiltered|C_TradeSkillUI.AnyRecipeCategoriesFiltered]]() |
||
: [[API C_TradeSkillUI.AreAnyInventorySlotsFiltered|C_TradeSkillUI.AreAnyInventorySlotsFiltered]]() |
: [[API C_TradeSkillUI.AreAnyInventorySlotsFiltered|C_TradeSkillUI.AreAnyInventorySlotsFiltered]]() |
||
Line 3,096: | Line 3,878: | ||
: [[API C_TradeSkillUI.CloseObliterumForge|C_TradeSkillUI.CloseObliterumForge]]() |
: [[API C_TradeSkillUI.CloseObliterumForge|C_TradeSkillUI.CloseObliterumForge]]() |
||
: [[API C_TradeSkillUI.CloseTradeSkill|C_TradeSkillUI.CloseTradeSkill]]() - Closes an open trade skill window. |
: [[API C_TradeSkillUI.CloseTradeSkill|C_TradeSkillUI.CloseTradeSkill]]() - Closes an open trade skill window. |
||
− | : [[API C_TradeSkillUI.CraftRecipe|C_TradeSkillUI.CraftRecipe]](<span |
+ | : [[API C_TradeSkillUI.CraftRecipe|C_TradeSkillUI.CraftRecipe]](<span class="apiarg">recipeSpellID [, numCasts, craftingReagents, recipeLevel, orderID]</span>) - Performs the tradeskill a specified number of times. |
: [[API C_TradeSkillUI.DropPendingObliterateItemFromCursor|C_TradeSkillUI.DropPendingObliterateItemFromCursor]]() |
: [[API C_TradeSkillUI.DropPendingObliterateItemFromCursor|C_TradeSkillUI.DropPendingObliterateItemFromCursor]]() |
||
: [[API C_TradeSkillUI.GetAllFilterableInventorySlots|C_TradeSkillUI.GetAllFilterableInventorySlots]]() |
: [[API C_TradeSkillUI.GetAllFilterableInventorySlots|C_TradeSkillUI.GetAllFilterableInventorySlots]]() |
||
− | : [[API C_TradeSkillUI.GetAllProfessionTradeSkillLines|C_TradeSkillUI.GetAllProfessionTradeSkillLines]]() |
+ | : [[API C_TradeSkillUI.GetAllProfessionTradeSkillLines|C_TradeSkillUI.GetAllProfessionTradeSkillLines]]() : <span class="apiret">skillLineID</span> |
− | : [[API C_TradeSkillUI.GetAllRecipeIDs|C_TradeSkillUI.GetAllRecipeIDs]]() - Returns |
+ | : [[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 |
+ | : [[API C_TradeSkillUI.GetCategoryInfo|C_TradeSkillUI.GetCategoryInfo]](<span class="apiarg">categoryID [, returnTable]</span>) |
: [[API C_TradeSkillUI.GetFilterableInventorySlots|C_TradeSkillUI.GetFilterableInventorySlots]]() |
: [[API C_TradeSkillUI.GetFilterableInventorySlots|C_TradeSkillUI.GetFilterableInventorySlots]]() |
||
: [[API C_TradeSkillUI.GetFilteredRecipeIDs|C_TradeSkillUI.GetFilteredRecipeIDs]]() |
: [[API C_TradeSkillUI.GetFilteredRecipeIDs|C_TradeSkillUI.GetFilteredRecipeIDs]]() |
||
: [[API C_TradeSkillUI.GetObliterateSpellID|C_TradeSkillUI.GetObliterateSpellID]]() |
: [[API C_TradeSkillUI.GetObliterateSpellID|C_TradeSkillUI.GetObliterateSpellID]]() |
||
− | : [[API C_TradeSkillUI.GetOnlyShowLearnedRecipes|C_TradeSkillUI.GetOnlyShowLearnedRecipes]]() |
||
: [[API C_TradeSkillUI.GetOnlyShowMakeableRecipes|C_TradeSkillUI.GetOnlyShowMakeableRecipes]]() |
: [[API C_TradeSkillUI.GetOnlyShowMakeableRecipes|C_TradeSkillUI.GetOnlyShowMakeableRecipes]]() |
||
: [[API C_TradeSkillUI.GetOnlyShowSkillUpRecipes|C_TradeSkillUI.GetOnlyShowSkillUpRecipes]]() |
: [[API C_TradeSkillUI.GetOnlyShowSkillUpRecipes|C_TradeSkillUI.GetOnlyShowSkillUpRecipes]]() |
||
− | : [[API C_TradeSkillUI.GetOnlyShowUnlearnedRecipes|C_TradeSkillUI.GetOnlyShowUnlearnedRecipes]]() |
||
− | : [[API C_TradeSkillUI.GetOptionalReagentBonusText|C_TradeSkillUI.GetOptionalReagentBonusText]](<span style="font-size:smaller; color:#ecbc2a">recipeSpellID, optionalReagentIndex, optionalReagents</span>) |
||
− | : [[API C_TradeSkillUI.GetOptionalReagentInfo|C_TradeSkillUI.GetOptionalReagentInfo]](<span style="font-size:smaller; color:#ecbc2a">recipeSpellID</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 |
+ | : [[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 |
+ | : [[API C_TradeSkillUI.GetRecipeDescription|C_TradeSkillUI.GetRecipeDescription]](<span class="apiarg">recipeID, craftingReagents [, allocationItemGUID]</span>) : <span class="apiret">description</span> - Returns the description for a recipe. |
− | : [[API C_TradeSkillUI.GetRecipeInfo|C_TradeSkillUI.GetRecipeInfo]](<span |
+ | : [[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 |
+ | : [[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 |
+ | : [[API C_TradeSkillUI.GetRecipeLink|C_TradeSkillUI.GetRecipeLink]](<span class="apiarg">recipeID</span>) |
− | : [[API C_TradeSkillUI. |
+ | : [[API C_TradeSkillUI.GetRecipeSourceText|C_TradeSkillUI.GetRecipeSourceText]](<span class="apiarg">recipeID</span>) |
− | : [[API C_TradeSkillUI. |
+ | : [[API C_TradeSkillUI.GetSubCategories|C_TradeSkillUI.GetSubCategories]](<span class="apiarg">categoryID</span>) |
− | : [[API C_TradeSkillUI. |
+ | : [[API C_TradeSkillUI.GetTradeSkillDisplayName|C_TradeSkillUI.GetTradeSkillDisplayName]](<span class="apiarg">skillLineID</span>) : <span class="apiret">professionDisplayName</span> |
− | : [[API C_TradeSkillUI. |
+ | : [[API C_TradeSkillUI.GetTradeSkillLineForRecipe|C_TradeSkillUI.GetTradeSkillLineForRecipe]](<span class="apiarg">recipeID</span>) : <span class="apiret">tradeSkillID, skillLineName, parentTradeSkillID </span> - Get the associated profession information for a recipe. |
− | : [[API C_TradeSkillUI. |
+ | : [[API C_TradeSkillUI.GetTradeSkillListLink|C_TradeSkillUI.GetTradeSkillListLink]]() - Returns a link for the currently displayed profession. |
− | : [[API C_TradeSkillUI. |
+ | : [[API C_TradeSkillUI.GetTradeSkillTexture|C_TradeSkillUI.GetTradeSkillTexture]](<span class="apiarg">tradeSkillID</span>) |
− | : [[API C_TradeSkillUI. |
+ | : [[API C_TradeSkillUI.IsAnyRecipeFromSource|C_TradeSkillUI.IsAnyRecipeFromSource]](<span class="apiarg">sourceType</span>) |
− | : [[API C_TradeSkillUI.GetSubCategories|C_TradeSkillUI.GetSubCategories]](<span style="font-size:smaller; color:#ecbc2a">categoryID</span>) |
||
− | : [[API C_TradeSkillUI.GetTradeSkillDisplayName|C_TradeSkillUI.GetTradeSkillDisplayName]](<span style="font-size:smaller; color:#ecbc2a">skillLineID</span>) |
||
− | : [[API C_TradeSkillUI.GetTradeSkillLine|C_TradeSkillUI.GetTradeSkillLine]]() - Returns information about the selected skill line. |
||
− | : [[API C_TradeSkillUI.GetTradeSkillLineForRecipe|C_TradeSkillUI.GetTradeSkillLineForRecipe]](<span style="font-size:smaller; color:#ecbc2a">recipeID</span>) |
||
− | : [[API C_TradeSkillUI.GetTradeSkillLineInfoByID|C_TradeSkillUI.GetTradeSkillLineInfoByID]](<span style="font-size:smaller; color:#ecbc2a">skillLineID</span>) |
||
− | : [[API C_TradeSkillUI.GetTradeSkillListLink|C_TradeSkillUI.GetTradeSkillListLink]]() - Returns the [[TradeSkillLink]] for a trade skill. |
||
− | : [[API C_TradeSkillUI.GetTradeSkillTexture|C_TradeSkillUI.GetTradeSkillTexture]](<span style="font-size:smaller; color:#ecbc2a">tradeSkillID</span>) |
||
− | : [[API C_TradeSkillUI.IsAnyRecipeFromSource|C_TradeSkillUI.IsAnyRecipeFromSource]](<span style="font-size:smaller; color:#ecbc2a">sourceType</span>) |
||
: [[API C_TradeSkillUI.IsDataSourceChanging|C_TradeSkillUI.IsDataSourceChanging]]() |
: [[API C_TradeSkillUI.IsDataSourceChanging|C_TradeSkillUI.IsDataSourceChanging]]() |
||
− | : [[API C_TradeSkillUI. |
+ | : [[API C_TradeSkillUI.IsInventorySlotFiltered|C_TradeSkillUI.IsInventorySlotFiltered]](<span class="apiarg">index</span>) |
− | : [[API C_TradeSkillUI. |
+ | : [[API C_TradeSkillUI.IsNPCCrafting|C_TradeSkillUI.IsNPCCrafting]]() : <span class="apiret">result</span> - Returns true if the trade skill window is displayed for an NPC. |
− | : [[API C_TradeSkillUI. |
+ | : [[API C_TradeSkillUI.IsRecipeCategoryFiltered|C_TradeSkillUI.IsRecipeCategoryFiltered]](<span class="apiarg">categoryID [, subCategoryID]</span>) |
− | : [[API C_TradeSkillUI. |
+ | : [[API C_TradeSkillUI.IsRecipeFavorite|C_TradeSkillUI.IsRecipeFavorite]](<span class="apiarg">recipeID</span>) |
− | : [[API C_TradeSkillUI.IsRecipeFavorite|C_TradeSkillUI.IsRecipeFavorite]](<span style="font-size:smaller; color:#ecbc2a">recipeID</span>) |
||
: [[API C_TradeSkillUI.IsRecipeRepeating|C_TradeSkillUI.IsRecipeRepeating]]() |
: [[API C_TradeSkillUI.IsRecipeRepeating|C_TradeSkillUI.IsRecipeRepeating]]() |
||
: [[API C_TradeSkillUI.IsRecipeSearchInProgress|C_TradeSkillUI.IsRecipeSearchInProgress]]() |
: [[API C_TradeSkillUI.IsRecipeSearchInProgress|C_TradeSkillUI.IsRecipeSearchInProgress]]() |
||
− | : [[API C_TradeSkillUI.IsRecipeSourceTypeFiltered|C_TradeSkillUI.IsRecipeSourceTypeFiltered]](<span |
+ | : [[API C_TradeSkillUI.IsRecipeSourceTypeFiltered|C_TradeSkillUI.IsRecipeSourceTypeFiltered]](<span class="apiarg">sourceType</span>) |
: [[API C_TradeSkillUI.IsTradeSkillGuild|C_TradeSkillUI.IsTradeSkillGuild]]() - Checks if the Trade Skill UI is open for a profession in the guild. |
: [[API C_TradeSkillUI.IsTradeSkillGuild|C_TradeSkillUI.IsTradeSkillGuild]]() - Checks if the Trade Skill UI is open for a profession in the guild. |
||
: [[API C_TradeSkillUI.IsTradeSkillGuildMember|C_TradeSkillUI.IsTradeSkillGuildMember]]() |
: [[API C_TradeSkillUI.IsTradeSkillGuildMember|C_TradeSkillUI.IsTradeSkillGuildMember]]() |
||
Line 3,150: | Line 3,919: | ||
: [[API C_TradeSkillUI.IsTradeSkillReady|C_TradeSkillUI.IsTradeSkillReady]]() |
: [[API C_TradeSkillUI.IsTradeSkillReady|C_TradeSkillUI.IsTradeSkillReady]]() |
||
: [[API C_TradeSkillUI.ObliterateItem|C_TradeSkillUI.ObliterateItem]]() |
: [[API C_TradeSkillUI.ObliterateItem|C_TradeSkillUI.ObliterateItem]]() |
||
− | : [[API C_TradeSkillUI.OpenTradeSkill|C_TradeSkillUI.OpenTradeSkill]](<span |
+ | : [[API C_TradeSkillUI.OpenTradeSkill|C_TradeSkillUI.OpenTradeSkill]](<span class="apiarg">skillLineID</span>) : <span class="apiret">opened</span> |
− | : [[API C_TradeSkillUI.SetInventorySlotFilter|C_TradeSkillUI.SetInventorySlotFilter]](<span |
+ | : [[API C_TradeSkillUI.SetInventorySlotFilter|C_TradeSkillUI.SetInventorySlotFilter]](<span class="apiarg">index [, enable, exclusive]</span>) |
− | : [[API C_TradeSkillUI. |
+ | : [[API C_TradeSkillUI.SetOnlyShowMakeableRecipes|C_TradeSkillUI.SetOnlyShowMakeableRecipes]](<span class="apiarg">onlyMakable</span>) - Controls whether only recipes you have the reagents to craft are shown. |
− | : [[API C_TradeSkillUI.SetOnlyShowMakeableRecipes|C_TradeSkillUI.SetOnlyShowMakeableRecipes]](<span style="font-size:smaller; color:#ecbc2a">onlyMakable</span>) - Controls whether only recipes you have the reagents to craft are shown. |
||
: [[API C_TradeSkillUI.SetOnlyShowSkillUpRecipes|C_TradeSkillUI.SetOnlyShowSkillUpRecipes]]() |
: [[API C_TradeSkillUI.SetOnlyShowSkillUpRecipes|C_TradeSkillUI.SetOnlyShowSkillUpRecipes]]() |
||
− | : [[API C_TradeSkillUI. |
+ | : [[API C_TradeSkillUI.SetRecipeCategoryFilter|C_TradeSkillUI.SetRecipeCategoryFilter]](<span class="apiarg">categoryID [, subCategoryID]</span>) |
− | : [[API C_TradeSkillUI. |
+ | : [[API C_TradeSkillUI.SetRecipeFavorite|C_TradeSkillUI.SetRecipeFavorite]](<span class="apiarg">recipeID, favorite</span>) |
− | : [[API C_TradeSkillUI. |
+ | : [[API C_TradeSkillUI.SetRecipeItemLevelFilter|C_TradeSkillUI.SetRecipeItemLevelFilter]](<span class="apiarg">minLevel, maxLevel</span>) |
− | : [[API C_TradeSkillUI.SetRecipeItemLevelFilter|C_TradeSkillUI.SetRecipeItemLevelFilter]](<span style="font-size:smaller; color:#ecbc2a">minLevel, maxLevel</span>) |
||
: [[API C_TradeSkillUI.SetRecipeItemNameFilter|C_TradeSkillUI.SetRecipeItemNameFilter]]() |
: [[API C_TradeSkillUI.SetRecipeItemNameFilter|C_TradeSkillUI.SetRecipeItemNameFilter]]() |
||
− | : [[API C_TradeSkillUI. |
+ | : [[API C_TradeSkillUI.SetRecipeSourceTypeFilter|C_TradeSkillUI.SetRecipeSourceTypeFilter]](<span class="apiarg">sourceType, filtered</span>) |
− | : [[API C_TradeSkillUI.SetRecipeSourceTypeFilter|C_TradeSkillUI.SetRecipeSourceTypeFilter]](<span style="font-size:smaller; color:#ecbc2a">sourceType, filtered</span>) |
||
: [[API C_TradeSkillUI.StopRecipeRepeat|C_TradeSkillUI.StopRecipeRepeat]]() - Stops creating additional queued items. |
: [[API C_TradeSkillUI.StopRecipeRepeat|C_TradeSkillUI.StopRecipeRepeat]]() - Stops creating additional queued items. |
||
− | : [[API AbandonSkill|AbandonSkill]](<span |
+ | : [[API AbandonSkill|AbandonSkill]](<span class="apiarg">index</span>) - The player abandons a skill. |
− | : [[API GetProfessionInfo|GetProfessionInfo]](<span |
+ | : [[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]]() - |
+ | : [[API GetProfessions|GetProfessions]]() - Returns the spell tab indices of the character's current professions. |
− | : [[API GetSpellRank|GetSpellRank]](<span |
+ | : [[API GetSpellRank|GetSpellRank]](<span class="apiarg">recipeID</span>) - Returns recipe rank. |
− | === |
+ | ===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 |
+ | : [[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 |
+ | : [[API ArchaeologyMapUpdateAll|ArchaeologyMapUpdateAll]]() - Updates and returns the amount of [[digsite]]s in a zone. |
− | : [[API ArchaeologyGetIconInfo|ArchaeologyGetIconInfo]](<span |
+ | : [[API ArchaeologyGetIconInfo|ArchaeologyGetIconInfo]](<span class="apiarg">index</span>) |
− | : [[API ArcheologyGetVisibleBlobID|ArcheologyGetVisibleBlobID]](<span |
+ | : [[API ArcheologyGetVisibleBlobID|ArcheologyGetVisibleBlobID]](<span class="apiarg">index</span>) - Returns BlobID of a digsite in the current map-zone. |
− | : [[API CanItemBeSocketedToArtifact|CanItemBeSocketedToArtifact]](<span |
+ | : [[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 |
+ | : [[API CanScanResearchSite|CanScanResearchSite]]() - Returns 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 |
+ | : [[API GetActiveArtifactByRace|GetActiveArtifactByRace]](<span class="apiarg">raceIndex</span>) - Returns the active Archaeology artifact for a race. |
− | : [[API GetArchaeologyInfo|GetArchaeologyInfo]]() - Returns localized name |
+ | : [[API GetArchaeologyInfo|GetArchaeologyInfo]]() - Returns the localized name for the Archaeology profession. |
− | : [[API GetArchaeologyRaceInfo|GetArchaeologyRaceInfo]](<span |
+ | : [[API GetArchaeologyRaceInfo|GetArchaeologyRaceInfo]](<span class="apiarg">raceIndex</span>) - Returns the information for a specific race used in Archaeology. |
− | : [[API GetArchaeologyRaceInfoByID|GetArchaeologyRaceInfoByID]](<span |
+ | : [[API GetArchaeologyRaceInfoByID|GetArchaeologyRaceInfoByID]](<span class="apiarg">researchBranchID</span>) - Returns info for an Archaeology race. |
− | : [[API GetArtifactInfoByRace|GetArtifactInfoByRace]](<span |
+ | : [[API GetArtifactInfoByRace|GetArtifactInfoByRace]](<span class="apiarg">raceIndex, artifactIndex</span>) - Returns the information for a specific race's artifact. |
− | : [[API GetNumArchaeologyRaces|GetNumArchaeologyRaces]]() - Returns the |
+ | : [[API GetNumArchaeologyRaces|GetNumArchaeologyRaces]]() - Returns the number of Archaeology races in the game. |
− | : [[API GetNumArtifactsByRace|GetNumArtifactsByRace]](<span |
+ | : [[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 |
+ | : [[API GetSelectedArtifactInfo|GetSelectedArtifactInfo]]() - Returns info for the selected race's Archaeology artifact. |
− | : [[API GetArtifactProgress|GetArtifactProgress]]() - Returns |
+ | : [[API GetArtifactProgress|GetArtifactProgress]]() - Returns progress info for the selected Archaeology artifact. |
: [[API IsArtifactCompletionHistoryAvailable|IsArtifactCompletionHistoryAvailable]]() |
: [[API IsArtifactCompletionHistoryAvailable|IsArtifactCompletionHistoryAvailable]]() |
||
− | : [[API ItemAddedToArtifact|ItemAddedToArtifact]](<span |
+ | : [[API ItemAddedToArtifact|ItemAddedToArtifact]](<span class="apiarg">keystoneindex</span>) - Returns if there is a keystone in the artifact. |
− | : [[API SetSelectedArtifact|SetSelectedArtifact]](<span |
+ | : [[API SetSelectedArtifact|SetSelectedArtifact]](<span class="apiarg">raceIndex</span>) - Sets the selected artifact to an archaeology race. |
− | : [[API RemoveItemFromArtifact|RemoveItemFromArtifact]]() - |
+ | : [[API RemoveItemFromArtifact|RemoveItemFromArtifact]]() - Removes a [[Keystone]] from the selected artifact. |
+ | : [[API SocketItemToArtifact|SocketItemToArtifact]]() - Adds a [[keystone]] to the selected archaeology artifact. |
||
− | : [[API RequestArtifactCompletionHistory|RequestArtifactCompletionHistory]]() |
||
− | : [[API SocketItemToArtifact|SocketItemToArtifact]]() - Add a keystone to the [[API SetSelectedArtifact|selected]] artifact. |
||
: [[API SolveArtifact|SolveArtifact]]() - Solve the [[API SetSelectedArtifact|selected]] artifact. |
: [[API SolveArtifact|SolveArtifact]]() - Solve the [[API SetSelectedArtifact|selected]] artifact. |
||
− | === |
+ | ===Glyphs=== |
− | : PROTECTED [[API CancelItemTempEnchantment|CancelItemTempEnchantment]](<span style="font-size:smaller; color:#ecbc2a">weaponHand</span>) - Cancels a temporary weapon enchant on ''weaponHand'' (1 for Main hand, 2 for Off hand). |
||
− | : [[API BindEnchant|BindEnchant]]() - Confirm the binding of the item when enchanting it. |
||
− | : [[API GetWeaponEnchantInfo|GetWeaponEnchantInfo]]() - Returns information about main and offhand weapon enchantments. |
||
− | : [[API ReplaceEnchant|ReplaceEnchant]]() - Confirm the replacement of an enchantment. |
||
− | : [[API ReplaceTradeEnchant|ReplaceTradeEnchant]]() - Confirm the replacement of an enchantment via trade. |
||
− | |||
− | ==== 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 |
+ | : [[API AttachGlyphToSpell|AttachGlyphToSpell]](<span class="apiarg">spellID</span>) |
− | : [[API GetCurrentGlyphNameForSpell|GetCurrentGlyphNameForSpell]](<span |
+ | : [[API GetCurrentGlyphNameForSpell|GetCurrentGlyphNameForSpell]](<span class="apiarg">spellID</span>) |
: [[API GetPendingGlyphName|GetPendingGlyphName]]() |
: [[API GetPendingGlyphName|GetPendingGlyphName]]() |
||
− | : [[API HasAttachedGlyph|HasAttachedGlyph]](<span |
+ | : [[API HasAttachedGlyph|HasAttachedGlyph]](<span class="apiarg">spellID</span>) |
: [[API HasPendingGlyphCast|HasPendingGlyphCast]]() |
: [[API HasPendingGlyphCast|HasPendingGlyphCast]]() |
||
: [[API IsCastingGlyph|IsCastingGlyph]]() |
: [[API IsCastingGlyph|IsCastingGlyph]]() |
||
: [[API IsPendingGlyphRemoval|IsPendingGlyphRemoval]]() |
: [[API IsPendingGlyphRemoval|IsPendingGlyphRemoval]]() |
||
− | : [[API IsSpellValidForPendingGlyph|IsSpellValidForPendingGlyph]](<span |
+ | : [[API IsSpellValidForPendingGlyph|IsSpellValidForPendingGlyph]](<span class="apiarg">spellID</span>) |
− | === |
+ | ===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]]() - |
+ | : [[API AcceptSockets|AcceptSockets]]() - Confirms pending gems for socketing. |
− | : [[API CloseSocketInfo|CloseSocketInfo]]() - |
+ | : [[API CloseSocketInfo|CloseSocketInfo]]() - Cancels pending gems for socketing. |
− | : [[API GetExistingSocketInfo|GetExistingSocketInfo]](<span |
+ | : [[API GetExistingSocketInfo|GetExistingSocketInfo]](<span class="apiarg">id</span>) - Returns information about the existing gem in the socket. |
− | : [[API GetExistingSocketLink|GetExistingSocketLink]](<span |
+ | : [[API GetExistingSocketLink|GetExistingSocketLink]](<span class="apiarg">id</span>) - Returns an item link for the existing gem in the socket. |
− | : [[API GetNewSocketInfo|GetNewSocketInfo]](<span |
+ | : [[API GetNewSocketInfo|GetNewSocketInfo]](<span class="apiarg">id</span>) - Returns information about the new (tentative) gem in the socket. |
− | : [[API GetNewSocketLink|GetNewSocketLink]](<span |
+ | : [[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 |
+ | : [[API GetNumSockets|GetNumSockets]]() - Returns the number of sockets for an item in the socketing window. |
− | : [[API GetSocketItemBoundTradeable|GetSocketItemBoundTradeable]]() - Returns |
+ | : [[API GetSocketItemBoundTradeable|GetSocketItemBoundTradeable]]() - Returns true if the item currently being socketed can be traded to other eligible players (BoP boss loot). |
− | : [[API GetSocketItemInfo|GetSocketItemInfo]]() - Returns |
+ | : [[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 |
+ | : [[API GetSocketTypes|GetSocketTypes]](<span class="apiarg">id</span>) - Returns the type (color) of a socket in the item. |
: [[API HasBoundGemProposed|HasBoundGemProposed]]() |
: [[API HasBoundGemProposed|HasBoundGemProposed]]() |
||
− | : [[API |
+ | : [[API SocketInventoryItem|SocketInventoryItem]](<span class="apiarg">slot</span>) - Considers the item in the inventory slot for socketing. |
− | : [[API SocketInventoryItem|SocketInventoryItem]](<span style="font-size:smaller; color:#ecbc2a">slot</span>) - Considers the item in the inventory slot for socketing. |
||
− | == |
+ | ==PvP== |
− | + | Relates to [[Player vs. Player]]. |
|
− | : [[API C_PvP. |
+ | : [[API C_PvP.CanDisplayDamage|C_PvP.CanDisplayDamage]]() : <span class="apiret">canDisplay</span> |
− | : [[API C_PvP. |
+ | : [[API C_PvP.CanDisplayDeaths|C_PvP.CanDisplayDeaths]]() : <span class="apiret">canDisplay</span> |
− | : [[API C_PvP. |
+ | : [[API C_PvP.CanDisplayHealing|C_PvP.CanDisplayHealing]]() : <span class="apiret">canDisplay</span> |
− | : [[API C_PvP. |
+ | : [[API C_PvP.CanDisplayHonorableKills|C_PvP.CanDisplayHonorableKills]]() : <span class="apiret">canDisplay</span> |
− | : [[API C_PvP. |
+ | : [[API C_PvP.CanDisplayKillingBlows|C_PvP.CanDisplayKillingBlows]]() : <span class="apiret">canDisplay</span> |
− | : [[API C_PvP. |
+ | : [[API C_PvP.CanPlayerUseRatedPVPUI|C_PvP.CanPlayerUseRatedPVPUI]]() : <span class="apiret">canUse, failureReason</span> |
− | : [[API C_PvP. |
+ | : [[API C_PvP.DoesMatchOutcomeAffectRating|C_PvP.DoesMatchOutcomeAffectRating]]() : <span class="apiret">doesAffect</span> |
− | : [[API C_PvP. |
+ | : [[API C_PvP.GetActiveMatchBracket|C_PvP.GetActiveMatchBracket]]() : <span class="apiret">bracket</span> |
− | : [[API C_PvP. |
+ | : [[API C_PvP.GetActiveMatchDuration|C_PvP.GetActiveMatchDuration]]() : <span class="apiret">seconds</span> |
− | : [[API C_PvP. |
+ | : [[API C_PvP.GetActiveMatchState|C_PvP.GetActiveMatchState]]() : <span class="apiret">state</span> |
− | : [[API C_PvP. |
+ | : [[API C_PvP.GetActiveMatchWinner|C_PvP.GetActiveMatchWinner]]() : <span class="apiret">winner</span> |
− | : [[API C_PvP. |
+ | : [[API C_PvP.GetCustomVictoryStatID|C_PvP.GetCustomVictoryStatID]]() : <span class="apiret">statID</span> |
− | : [[API C_PvP. |
+ | : [[API C_PvP.GetGlobalPvpScalingInfoForSpecID|C_PvP.GetGlobalPvpScalingInfoForSpecID]](<span class="apiarg">specializationID</span>) : <span class="apiret">pvpScalingData</span> |
− | : [[API C_PvP. |
+ | : [[API C_PvP.GetHonorRewardInfo|C_PvP.GetHonorRewardInfo]](<span class="apiarg">honorLevel</span>) : <span class="apiret">info</span> |
+ | : [[API C_PvP.GetMatchPVPStatColumn|C_PvP.GetMatchPVPStatColumn]](<span class="apiarg">pvpStatID</span>) : <span class="apiret">info</span> |
||
− | : [[API C_PvP.GetPostMatchCurrencyRewards|C_PvP.GetPostMatchCurrencyRewards]]() |
||
− | : [[API C_PvP. |
+ | : [[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.GetPVPActiveMatchPersonalRatedInfo|C_PvP.GetPVPActiveMatchPersonalRatedInfo]]() |
||
+ | : [[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.GetPvpTierID|C_PvP.GetPvpTierID]](<span style="font-size:smaller; color:#ecbc2a">tierEnum, bracketEnum</span>) |
||
− | : [[API C_PvP. |
+ | : [[API C_PvP.GetPostMatchCurrencyRewards|C_PvP.GetPostMatchCurrencyRewards]]() : <span class="apiret">rewards</span> |
− | : [[API C_PvP. |
+ | : [[API C_PvP.GetPostMatchItemRewards|C_PvP.GetPostMatchItemRewards]]() : <span class="apiret">rewards</span> |
− | : [[API C_PvP. |
+ | : [[API C_PvP.GetPVPActiveMatchPersonalRatedInfo|C_PvP.GetPVPActiveMatchPersonalRatedInfo]]() : <span class="apiret">info</span> |
− | : [[API C_PvP. |
+ | : [[API C_PvP.GetPVPSeasonRewardAchievementID|C_PvP.GetPVPSeasonRewardAchievementID]]() : <span class="apiret">achievementID</span> |
+ | : [[API C_PvP.GetPvpTierID|C_PvP.GetPvpTierID]](<span class="apiarg">tierEnum, bracketEnum</span>) : <span class="apiret">id</span> |
||
− | : [[API C_PvP.GetSeasonBestInfo|C_PvP.GetSeasonBestInfo]]() |
||
− | : [[API C_PvP. |
+ | : [[API C_PvP.GetPvpTierInfo|C_PvP.GetPvpTierInfo]](<span class="apiarg">tierID</span>) : <span class="apiret">pvpTierInfo</span> |
+ | : [[API C_PvP.GetRewardItemLevelsByTierEnum|C_PvP.GetRewardItemLevelsByTierEnum]](<span class="apiarg">pvpTierEnum</span>) : <span class="apiret">activityItemLevel, weeklyItemLevel</span> |
||
− | : [[API C_PvP.GetSpecialEventDetails|C_PvP.GetSpecialEventDetails]]() |
||
+ | : [[API C_PvP.GetScoreInfo|C_PvP.GetScoreInfo]](<span class="apiarg">offsetIndex</span>) : <span class="apiret">info</span> |
||
− | : [[API C_PvP.GetSpecialEventInfo|C_PvP.GetSpecialEventInfo]]() |
||
− | : [[API C_PvP. |
+ | : [[API C_PvP.GetScoreInfoByPlayerGuid|C_PvP.GetScoreInfoByPlayerGuid]](<span class="apiarg">guid</span>) : <span class="apiret">info</span> |
− | : [[API C_PvP. |
+ | : [[API C_PvP.GetSeasonBestInfo|C_PvP.GetSeasonBestInfo]]() : <span class="apiret">tierID, nextTierID</span> |
+ | : [[API C_PvP.GetSkirmishInfo|C_PvP.GetSkirmishInfo]](<span class="apiarg">pvpBracket</span>) : <span class="apiret">battlemasterListInfo</span> |
||
− | : [[API C_PvP.IsActiveMatchRegistered|C_PvP.IsActiveMatchRegistered]]() |
||
+ | : [[API C_PvP.GetTeamInfo|C_PvP.GetTeamInfo]](<span class="apiarg">factionIndex</span>) : <span class="apiret">info</span> |
||
− | : [[API C_PvP.IsMatchFactional|C_PvP.IsMatchFactional]]() |
||
+ | : [[API C_PvP.GetWeeklyChestInfo|C_PvP.GetWeeklyChestInfo]]() : <span class="apiret">rewardAchieved, lastWeekRewardAchieved, lastWeekRewardClaimed, pvpTierMaxFromWins</span> |
||
− | : [[API C_PvP.IsPVPMap|C_PvP.IsPVPMap]]() |
||
− | : [[API C_PvP. |
+ | : [[API C_PvP.IsActiveMatchRegistered|C_PvP.IsActiveMatchRegistered]]() : <span class="apiret">registered</span> |
− | : [[API C_PvP. |
+ | : [[API C_PvP.IsMatchFactional|C_PvP.IsMatchFactional]]() : <span class="apiret">isFactional</span> |
− | : |
+ | : [[API C_PvP.IsPVPMap|C_PvP.IsPVPMap]]() : <span class="apiret">isPVPMap</span> |
+ | : [[API C_PvP.IsRatedMap|C_PvP.IsRatedMap]]() : <span class="apiret">isRatedMap</span> |
||
− | : [[API AcceptDuel|AcceptDuel]]() - The player accepts the challenge to duel. |
||
+ | : [[API C_PvP.RequestCrowdControlSpell|C_PvP.RequestCrowdControlSpell]](<span class="apiarg">playerToken</span>) |
||
− | : [[API CancelDuel|CancelDuel]]() - Refuse the invitation to fight a duel. |
||
+ | : [[API AcceptDuel|AcceptDuel]]() - Accepts a duel challenge. |
||
+ | : [[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 |
+ | : [[API GetPVPDesired|GetPVPDesired]]() - Returns true if the player has enabled their PvP flag. |
− | : [[API GetPVPLifetimeStats|GetPVPLifetimeStats]]() - |
+ | : [[API GetPVPLifetimeStats|GetPVPLifetimeStats]]() - Returns the character's lifetime PvP statistics. |
: [[API GetPVPRoles|GetPVPRoles]]() |
: [[API GetPVPRoles|GetPVPRoles]]() |
||
− | : [[API GetPVPSessionStats|GetPVPSessionStats]]() - |
+ | : [[API GetPVPSessionStats|GetPVPSessionStats]]() - Returns the character's Honor statistics for this session. |
− | : [[API GetPVPTimer|GetPVPTimer]]() - Returns the |
+ | : [[API GetPVPTimer|GetPVPTimer]]() - Returns the time left in milliseconds until the player is unflagged for PvP. |
− | : [[API GetPVPYesterdayStats|GetPVPYesterdayStats]]() - |
+ | : [[API GetPVPYesterdayStats|GetPVPYesterdayStats]]() - Returns the character's Honor statistics for yesterday. |
− | : [[API GetRewardPackArtifactPower|GetRewardPackArtifactPower]](<span |
+ | : [[API GetRewardPackArtifactPower|GetRewardPackArtifactPower]](<span class="apiarg">rewardPackID</span>) |
− | : [[API GetRewardPackCurrencies|GetRewardPackCurrencies]](<span |
+ | : [[API GetRewardPackCurrencies|GetRewardPackCurrencies]](<span class="apiarg">rewardPackID</span>) |
− | : [[API GetRewardPackItems|GetRewardPackItems]](<span |
+ | : [[API GetRewardPackItems|GetRewardPackItems]](<span class="apiarg">rewardPackID</span>) |
− | : [[API GetRewardPackMoney|GetRewardPackMoney]](<span |
+ | : [[API GetRewardPackMoney|GetRewardPackMoney]](<span class="apiarg">rewardPackID</span>) |
− | : [[API GetRewardPackTitleName|GetRewardPackTitleName]](<span |
+ | : [[API GetRewardPackTitleName|GetRewardPackTitleName]](<span class="apiarg">titleID</span>) |
− | : [[API GetRewardPackTitle|GetRewardPackTitle]](<span |
+ | : [[API GetRewardPackTitle|GetRewardPackTitle]](<span class="apiarg">rewardPackID</span>) |
: [[API IsCompetitiveModeEnabled|IsCompetitiveModeEnabled]]() |
: [[API IsCompetitiveModeEnabled|IsCompetitiveModeEnabled]]() |
||
: [[API IsInActiveWorldPVP|IsInActiveWorldPVP]]() |
: [[API IsInActiveWorldPVP|IsInActiveWorldPVP]]() |
||
: [[API IsPartyWorldPVP|IsPartyWorldPVP]]() |
: [[API IsPartyWorldPVP|IsPartyWorldPVP]]() |
||
: [[API IsSubZonePVPPOI|IsSubZonePVPPOI]]() |
: [[API IsSubZonePVPPOI|IsSubZonePVPPOI]]() |
||
− | : [[API PlayerIsPVPInactive|PlayerIsPVPInactive]](<span |
+ | : [[API PlayerIsPVPInactive|PlayerIsPVPInactive]](<span class="apiarg">unit</span>) |
: [[API RequestPVPOptionsEnabled|RequestPVPOptionsEnabled]]() |
: [[API RequestPVPOptionsEnabled|RequestPVPOptionsEnabled]]() |
||
: [[API RequestPVPRewards|RequestPVPRewards]]() |
: [[API RequestPVPRewards|RequestPVPRewards]]() |
||
+ | : [[API SetPVP|SetPVP]](<span class="apiarg">enable</span>) - Sets the player's PvP flag. |
||
: [[API SetPVPRoles|SetPVPRoles]]() |
: [[API SetPVPRoles|SetPVPRoles]]() |
||
− | : [[API SetPVP|SetPVP]](<span style="font-size:smaller; color:#ecbc2a">enable</span>) - Sets the players PVP mode (1 to enable, nil to toggle off eventually). |
||
: [[API SortBGList|SortBGList]]() |
: [[API SortBGList|SortBGList]]() |
||
− | : [[API StartDuel|StartDuel]](<span |
+ | : [[API StartDuel|StartDuel]](<span class="apiarg">name</span>) - Challenges the specified player to a duel. |
− | : [[API TogglePVP|TogglePVP]]() - Toggles |
+ | : [[API TogglePVP|TogglePVP]]() - Toggles the player's PvP flag on or off. |
− | : [[API UnitHonor|UnitHonor]](<span |
+ | : [[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 |
+ | : [[API UnitHonorLevel|UnitHonorLevel]](<span class="apiarg">unit</span>) - Returns the current honor rank of the unit. |
− | : [[API UnitHonorMax|UnitHonorMax]](<span |
+ | : [[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 |
+ | : [[API UnitIsPVPFreeForAll|UnitIsPVPFreeForAll]](<span class="apiarg">unit</span>) - Returns true if the unit is flagged for free-for-all PVP (e.g. in a world arena). |
− | : [[API UnitIsPVPSanctuary|UnitIsPVPSanctuary]](<span |
+ | : [[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 |
+ | : [[API UnitIsPVP|UnitIsPVP]](<span class="apiarg">unit</span>) - Returns true if the unit is flagged for PVP. |
− | : [[API UnitPVPName|UnitPVPName]](<span |
+ | : [[API UnitPVPName|UnitPVPName]](<span class="apiarg">unit</span>) - Returns the unit's name with title (e.g. "Bob the Explorer"). |
− | : [[API UnitPvpClassification|UnitPvpClassification]](<span |
+ | : [[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=== |
− | : [[API C_PvP.GetArenaCrowdControlInfo|C_PvP.GetArenaCrowdControlInfo]](<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 |
+ | : [[API C_PvP.GetArenaRewards|C_PvP.GetArenaRewards]](<span class="apiarg">teamSize</span>) : <span class="apiret">honor, experience, itemRewards, currencyRewards, roleShortageBonus</span> |
− | : [[API C_PvP.GetArenaSkirmishRewards|C_PvP.GetArenaSkirmishRewards]]() |
+ | : [[API C_PvP.GetArenaSkirmishRewards|C_PvP.GetArenaSkirmishRewards]]() : <span class="apiret">honor, experience, itemRewards, currencyRewards, roleShortageBonus</span> |
− | : [[API C_PvP.HasArenaSkirmishWinToday|C_PvP.HasArenaSkirmishWinToday]]() |
+ | : [[API C_PvP.HasArenaSkirmishWinToday|C_PvP.HasArenaSkirmishWinToday]]() : <span class="apiret">hasArenaSkirmishWinToday</span> |
− | : [[API C_PvP.IsArena|C_PvP.IsArena]]() |
+ | : [[API C_PvP.IsArena|C_PvP.IsArena]]() : <span class="apiret">isArena</span> |
− | : [[API C_PvP.IsMatchConsideredArena|C_PvP.IsMatchConsideredArena]]() |
+ | : [[API C_PvP.IsMatchConsideredArena|C_PvP.IsMatchConsideredArena]]() : <span class="apiret">asArena</span> |
− | : [[API C_PvP.IsRatedArena|C_PvP.IsRatedArena]]() |
+ | : [[API C_PvP.IsRatedArena|C_PvP.IsRatedArena]]() : <span class="apiret">isRatedArena</span> |
: [[API CanSurrenderArena|CanSurrenderArena]]() |
: [[API CanSurrenderArena|CanSurrenderArena]]() |
||
+ | : [[API GetArenaOpponentSpec|GetArenaOpponentSpec]]() |
||
: [[API GetBattlefieldArenaFaction|GetBattlefieldArenaFaction]]() |
: [[API GetBattlefieldArenaFaction|GetBattlefieldArenaFaction]]() |
||
− | : [[API GetBattlefieldTeamInfo|GetBattlefieldTeamInfo]](<span |
+ | : [[API GetBattlefieldTeamInfo|GetBattlefieldTeamInfo]](<span class="apiarg">index</span>) - Returns info for an Arena team at the end of the match. |
− | : [[API GetCurrentArenaSeason|GetCurrentArenaSeason]]() - |
+ | : [[API GetCurrentArenaSeason|GetCurrentArenaSeason]]() - Returns the current arena season. |
− | : [[API GetMaxArenaCurrency|GetMaxArenaCurrency]]() |
||
: [[API GetNumArenaOpponents|GetNumArenaOpponents]]() |
: [[API GetNumArenaOpponents|GetNumArenaOpponents]]() |
||
+ | : [[API GetNumArenaOpponentSpecs|GetNumArenaOpponentSpecs]]() |
||
: [[API GetPreviousArenaSeason|GetPreviousArenaSeason]]() - Gets the previous Arena season. |
: [[API GetPreviousArenaSeason|GetPreviousArenaSeason]]() - Gets the previous Arena season. |
||
− | : [[API IsActiveBattlefieldArena|IsActiveBattlefieldArena]]() - Returns true if |
+ | : [[API IsActiveBattlefieldArena|IsActiveBattlefieldArena]]() - Returns true if the player is inside a (rated) arena. |
: [[API IsArenaSkirmish|IsArenaSkirmish]]() |
: [[API IsArenaSkirmish|IsArenaSkirmish]]() |
||
− | : [[API IsArenaTeamCaptain|IsArenaTeamCaptain]](<span |
+ | : [[API IsArenaTeamCaptain|IsArenaTeamCaptain]](<span class="apiarg">teamIndex</span>) - Returns a value based on whether the player is the arena team captain. |
: [[API IsInArenaTeam|IsInArenaTeam]]() - Returns true if you are a member of an arena team. |
: [[API IsInArenaTeam|IsInArenaTeam]]() - Returns true if you are a member of an arena team. |
||
: [[API JoinArena|JoinArena]]() |
: [[API JoinArena|JoinArena]]() |
||
− | : [[API JoinSkirmish|JoinSkirmish]](<span |
+ | : [[API JoinSkirmish|JoinSkirmish]](<span class="apiarg">arenaID, joinAsGroup</span>) - Queue for a arena either solo or as a group. |
: [[API RequeueSkirmish|RequeueSkirmish]]() - Requeues for an arena skirmish. |
: [[API RequeueSkirmish|RequeueSkirmish]]() - Requeues for an arena skirmish. |
||
: [[API SurrenderArena|SurrenderArena]]() |
: [[API SurrenderArena|SurrenderArena]]() |
||
− | === |
+ | ===Solo Shuffle=== |
− | : [[API C_PvP. |
+ | : [[API C_PvP.IsSoloShuffle|C_PvP.IsSoloShuffle]]() : <span class="apiret">isSoloShuffle</span> |
+ | : [[API StartSoloShuffleWarGameByName|StartSoloShuffleWarGameByName]]() |
||
− | : [[API C_PvP.GetRandomBGInfo|C_PvP.GetRandomBGInfo]]() |
||
+ | : [[API StartSpectatorSoloShuffleWarGame|StartSpectatorSoloShuffleWarGame]]() |
||
− | : [[API C_PvP.GetRandomBGRewards|C_PvP.GetRandomBGRewards]]() |
||
+ | |||
− | : [[API C_PvP.GetRandomEpicBGInfo|C_PvP.GetRandomEpicBGInfo]]() |
||
+ | ===Battlegrounds=== |
||
− | : [[API C_PvP.GetRandomEpicBGRewards|C_PvP.GetRandomEpicBGRewards]]() |
||
+ | : [[API C_PvP.GetBattlefieldFlagPosition|C_PvP.GetBattlefieldFlagPosition]](<span class="apiarg">flagIndex, uiMapId</span>) : <span class="apiret">uiPosx, uiPosy, flagTexture</span> |
||
− | : [[API C_PvP.GetRatedBGRewards|C_PvP.GetRatedBGRewards]]() |
||
+ | : [[API C_PvP.GetLevelUpBattlegrounds|C_PvP.GetLevelUpBattlegrounds]](<span class="apiarg">level</span>) : <span class="apiret">battlefields</span> |
||
− | : [[API C_PvP.IsBattleground|C_PvP.IsBattleground]]() |
||
+ | : [[API C_PvP.GetRandomBGInfo|C_PvP.GetRandomBGInfo]]() : <span class="apiret">info</span> |
||
− | : [[API C_PvP.IsBattlegroundEnlistmentBonusActive|C_PvP.IsBattlegroundEnlistmentBonusActive]]() |
||
+ | : [[API C_PvP.GetRandomBGRewards|C_PvP.GetRandomBGRewards]]() : <span class="apiret">honor, experience, itemRewards, currencyRewards, roleShortageBonus</span> |
||
− | : [[API C_PvP.IsRatedBattleground|C_PvP.IsRatedBattleground]]() |
||
+ | : [[API C_PvP.GetRandomEpicBGInfo|C_PvP.GetRandomEpicBGInfo]]() : <span class="apiret">info</span> |
||
− | : [[API AcceptAreaSpiritHeal|AcceptAreaSpiritHeal]]() - Accept a spirit heal. |
||
+ | : [[API C_PvP.GetRandomEpicBGRewards|C_PvP.GetRandomEpicBGRewards]]() : <span class="apiret">honor, experience, itemRewards, currencyRewards, roleShortageBonus</span> |
||
− | : [[API AcceptBattlefieldPort|AcceptBattlefieldPort]](<span style="font-size:smaller; color:#ecbc2a">index [, acceptFlag]</span>) - Accept or reject an offered battlefield port. |
||
+ | : [[API C_PvP.GetRatedBGRewards|C_PvP.GetRatedBGRewards]]() : <span class="apiret">honor, experience, itemRewards, currencyRewards, roleShortageBonus</span> |
||
− | : [[API BattlefieldSetPendingReportTarget|BattlefieldSetPendingReportTarget]](<span style="font-size:smaller; color:#ecbc2a">index</span>) |
||
+ | : [[API C_PvP.IsBattleground|C_PvP.IsBattleground]]() : <span class="apiret">isBattleground</span> |
||
− | : [[API CanJoinBattlefieldAsGroup|CanJoinBattlefieldAsGroup]]() - Returns nil if the player can not do a group join for a battlefield. |
||
+ | : [[API C_PvP.IsBattlegroundEnlistmentBonusActive|C_PvP.IsBattlegroundEnlistmentBonusActive]]() : <span class="apiret">battlegroundActive, brawlActive</span> |
||
− | : [[API CancelAreaSpiritHeal|CancelAreaSpiritHeal]]() - Cancel a spirit heal. |
||
+ | : [[API C_PvP.IsRatedBattleground|C_PvP.IsRatedBattleground]]() : <span class="apiret">isRatedBattleground</span> |
||
− | : [[API CheckSpiritHealerDist|CheckSpiritHealerDist]]() - Returns true if you are in range with spirit healer while dead. |
||
+ | : [[API AcceptAreaSpiritHeal|AcceptAreaSpiritHeal]]() - Signs up for the Spirit Healer's resurrection timer in battlegrounds when in range. |
||
− | : [[API GetAreaSpiritHealerTime|GetAreaSpiritHealerTime]]() - Returns the time left until the next resurrection by the Sprit Guide. |
||
− | : [[API |
+ | : [[API AcceptBattlefieldPort|AcceptBattlefieldPort]](<span class="apiarg">index [, acceptFlag]</span>) - Enters the Battleground if the queue is ready. |
+ | : [[API CanJoinBattlefieldAsGroup|CanJoinBattlefieldAsGroup]]() - Returns true if the player can join a battlefield with a group. |
||
− | : [[API GetBattlefieldFlagPosition|GetBattlefieldFlagPosition]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Get the map position and texture of the flag. |
||
+ | : [[API CancelAreaSpiritHeal|CancelAreaSpiritHeal]]() - Cancels the Spirit Healer's resurrection in battlegrounds. |
||
+ | : [[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>) - 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]]() - |
+ | : [[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 |
+ | : [[API GetBattlefieldPortExpiration|GetBattlefieldPortExpiration]](<span class="apiarg">index</span>) - Returns the remaining seconds before the battlefield port expires. |
− | : [[API GetBattlefieldScore|GetBattlefieldScore]](<span |
+ | : [[API GetBattlefieldScore|GetBattlefieldScore]](<span class="apiarg">index</span>) {{apitag|deprecated}} - Returns info for a player's score in battlefields. |
− | : [[API GetBattlefieldStatData|GetBattlefieldStatData]](<span |
+ | : [[API GetBattlefieldStatData|GetBattlefieldStatData]](<span class="apiarg">playerIndex, slotIndex</span>) {{apitag|deprecated}} - Returns battlefield-specific info for a player (e.g. Warsong Gulch flag captures). |
− | : [[API GetBattlefieldStatus|GetBattlefieldStatus]](<span |
+ | : [[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 |
+ | : [[API GetBattlefieldTimeWaited|GetBattlefieldTimeWaited]](<span class="apiarg">index</span>) - Returns the time the player has waited in the queue. |
− | : [[API GetBattlefieldWinner|GetBattlefieldWinner]]() - |
+ | : [[API GetBattlefieldWinner|GetBattlefieldWinner]]() - Returns the winner of the battlefield. |
− | : [[API GetBattlegroundInfo|GetBattlegroundInfo]](<span |
+ | : [[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 |
+ | : [[API GetNumBattlefieldScores|GetNumBattlefieldScores]]() - Returns the number of players listed in the battlefield scoreboard. |
: [[API GetNumBattlegroundTypes|GetNumBattlegroundTypes]]() |
: [[API GetNumBattlegroundTypes|GetNumBattlegroundTypes]]() |
||
− | : [[API GetPersonalRatedInfo|GetPersonalRatedInfo]](<span |
+ | : [[API GetPersonalRatedInfo|GetPersonalRatedInfo]](<span class="apiarg">bracketIndex</span>) |
: [[API GetRatedBattleGroundInfo|GetRatedBattleGroundInfo]]() |
: [[API GetRatedBattleGroundInfo|GetRatedBattleGroundInfo]]() |
||
: [[API IsPVPTimerRunning|IsPVPTimerRunning]]() |
: [[API IsPVPTimerRunning|IsPVPTimerRunning]]() |
||
− | : |
+ | : [[API JoinBattlefield|JoinBattlefield]](<span class="apiarg">index [, joinAs]</span>) {{apitag|protected}} - Joins the battleground queue solo or as a group. |
− | : |
+ | : [[API JoinRatedBattlefield|JoinRatedBattlefield]]() {{apitag|protected}} |
− | : [[API LeaveBattlefield|LeaveBattlefield]]() - |
+ | : [[API LeaveBattlefield|LeaveBattlefield]]() - Leaves the current battleground. |
− | : [[API ReportPlayerIsPVPAFK|ReportPlayerIsPVPAFK]](<span |
+ | : [[API ReportPlayerIsPVPAFK|ReportPlayerIsPVPAFK]](<span class="apiarg">unit</span>) - Reports the specified player as AFK in a battleground. |
− | : [[API RequestBattlefieldScoreData|RequestBattlefieldScoreData]]() - |
+ | : [[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 |
+ | : [[API SetBattlefieldScoreFaction|SetBattlefieldScoreFaction]](<span class="apiarg">[faction]</span>) - Sets the faction to show on the battlefield scoreboard. |
− | : [[API SortBattlefieldScoreData|SortBattlefieldScoreData]](<span |
+ | : [[API SortBattlefieldScoreData|SortBattlefieldScoreData]](<span class="apiarg">type</span>) |
− | : [[API UnitInBattleground|UnitInBattleground]](<span |
+ | : [[API UnitInBattleground|UnitInBattleground]](<span class="apiarg">unit</span>) - Returns the unit index if the unit is in your battleground. |
− | : DEPRECATED (8.2.0) [[API GetBattlefieldStatInfo|GetBattlefieldStatInfo]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Get the battleground specific column for the score board. |
||
− | : DEPRECATED (8.2.0) [[API GetNumBattlefieldStats|GetNumBattlefieldStats]]() - Get the number of battleground specific columns. |
||
− | : DEPRECATED (8.1.5) [[API InActiveBattlefield|InActiveBattlefield]]() |
||
− | === |
+ | ===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]]() |
+ | : [[API C_PvP.IsActiveBattlefield|C_PvP.IsActiveBattlefield]]() : <span class="apiret">isActiveBattlefield</span> |
− | : [[API BattlefieldMgrEntryInviteResponse|BattlefieldMgrEntryInviteResponse]](<span |
+ | : [[API BattlefieldMgrEntryInviteResponse|BattlefieldMgrEntryInviteResponse]](<span class="apiarg">queueId, accept</span>) |
− | : [[API BattlefieldMgrExitRequest|BattlefieldMgrExitRequest]](<span |
+ | : [[API BattlefieldMgrExitRequest|BattlefieldMgrExitRequest]](<span class="apiarg">queueId</span>) |
− | : [[API BattlefieldMgrQueueInviteResponse|BattlefieldMgrQueueInviteResponse]](<span |
+ | : [[API BattlefieldMgrQueueInviteResponse|BattlefieldMgrQueueInviteResponse]](<span class="apiarg">queueId, accept</span>) |
: [[API BattlefieldMgrQueueRequest|BattlefieldMgrQueueRequest]]() |
: [[API BattlefieldMgrQueueRequest|BattlefieldMgrQueueRequest]]() |
||
: [[API CanHearthAndResurrectFromArea|CanHearthAndResurrectFromArea]]() - Returns whether you can currently be resurrected and teleported out of the world PvP zone. |
: [[API CanHearthAndResurrectFromArea|CanHearthAndResurrectFromArea]]() - Returns whether you can currently be resurrected and teleported out of the world PvP zone. |
||
: [[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 |
+ | : [[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 |
+ | : [[API GetWorldPVPQueueStatus|GetWorldPVPQueueStatus]](<span class="apiarg">queueId</span>) |
− | === |
+ | ===Brawl=== |
− | : [[API C_PvP.GetActiveBrawlInfo|C_PvP.GetActiveBrawlInfo]]() |
+ | : [[API C_PvP.GetActiveBrawlInfo|C_PvP.GetActiveBrawlInfo]]() : <span class="apiret">brawlInfo</span> |
− | : [[API C_PvP.GetAvailableBrawlInfo|C_PvP.GetAvailableBrawlInfo]]() |
+ | : [[API C_PvP.GetAvailableBrawlInfo|C_PvP.GetAvailableBrawlInfo]]() : <span class="apiret">brawlInfo</span> |
− | : [[API C_PvP.GetBrawlRewards|C_PvP.GetBrawlRewards]](<span |
+ | : [[API C_PvP.GetBrawlRewards|C_PvP.GetBrawlRewards]](<span class="apiarg">brawlType</span>) : <span class="apiret">honor, experience, itemRewards, currencyRewards, roleShortageBonus, hasWon</span> |
− | : [[API C_PvP. |
+ | : [[API C_PvP.GetSpecialEventBrawlInfo|C_PvP.GetSpecialEventBrawlInfo]]() : <span class="apiret">brawlInfo</span> |
− | : [[API C_PvP. |
+ | : [[API C_PvP.IsInBrawl|C_PvP.IsInBrawl]]() : <span class="apiret">isInBrawl</span> |
− | : |
+ | : [[API C_PvP.JoinBrawl|C_PvP.JoinBrawl]](<span class="apiarg">[isSpecialBrawl]</span>) |
− | === |
+ | ===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]]() |
||
− | : [[API CollapseWarGameHeader|CollapseWarGameHeader]](<span |
+ | : [[API CollapseWarGameHeader|CollapseWarGameHeader]](<span class="apiarg">index</span>) |
− | : [[API ExpandWarGameHeader|ExpandWarGameHeader]](<span |
+ | : [[API ExpandWarGameHeader|ExpandWarGameHeader]](<span class="apiarg">index</span>) |
: [[API GetNumWarGameTypes|GetNumWarGameTypes]]() |
: [[API GetNumWarGameTypes|GetNumWarGameTypes]]() |
||
: [[API GetSelectedWarGameType|GetSelectedWarGameType]]() |
: [[API GetSelectedWarGameType|GetSelectedWarGameType]]() |
||
: [[API GetWarGameQueueStatus|GetWarGameQueueStatus]]() |
: [[API GetWarGameQueueStatus|GetWarGameQueueStatus]]() |
||
− | : [[API GetWarGameTypeInfo|GetWarGameTypeInfo]](<span |
+ | : [[API GetWarGameTypeInfo|GetWarGameTypeInfo]](<span class="apiarg">index</span>) |
: [[API IsWargame|IsWargame]]() |
: [[API IsWargame|IsWargame]]() |
||
− | : [[API SetSelectedWarGameType|SetSelectedWarGameType]](<span |
+ | : [[API SetSelectedWarGameType|SetSelectedWarGameType]](<span class="apiarg">index</span>) |
− | : [[API StartSpectatorWarGame|StartSpectatorWarGame]](<span |
+ | : [[API StartSpectatorWarGame|StartSpectatorWarGame]](<span class="apiarg">target1, target2, size, area, isTournamentMode</span>) |
− | : [[API StartWarGameByName|StartWarGameByName]](<span |
+ | : [[API StartWarGameByName|StartWarGameByName]](<span class="apiarg">msg</span>) - Starts a [[War Game]]. Parameters are <code>playername, area, isTournamentMode</code> but passed as a whitespace delimited string. |
− | : [[API StartWarGame|StartWarGame]](<span |
+ | : [[API StartWarGame|StartWarGame]](<span class="apiarg">target, name [, isTournament]</span>) |
: [[API UpdateWarGamesList|UpdateWarGamesList]]() |
: [[API UpdateWarGamesList|UpdateWarGamesList]]() |
||
− | : [[API WarGameRespond|WarGameRespond]](<span |
+ | : [[API WarGameRespond|WarGameRespond]](<span class="apiarg">accept</span>) |
− | === |
+ | ===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 |
+ | : [[API C_PvP.CanToggleWarMode|C_PvP.CanToggleWarMode]](<span class="apiarg">toggle</span>) : <span class="apiret">canTogglePvP</span> |
− | : [[API C_PvP.CanToggleWarModeInArea|C_PvP.CanToggleWarModeInArea]]() |
+ | : [[API C_PvP.CanToggleWarModeInArea|C_PvP.CanToggleWarModeInArea]]() : <span class="apiret">canTogglePvPInArea</span> |
− | : [[API C_PvP.GetWarModeRewardBonus|C_PvP.GetWarModeRewardBonus]]() |
+ | : [[API C_PvP.GetWarModeRewardBonus|C_PvP.GetWarModeRewardBonus]]() : <span class="apiret">rewardBonus</span> |
− | : [[API C_PvP.GetWarModeRewardBonusDefault|C_PvP.GetWarModeRewardBonusDefault]]() |
+ | : [[API C_PvP.GetWarModeRewardBonusDefault|C_PvP.GetWarModeRewardBonusDefault]]() : <span class="apiret">defaultBonus</span> |
− | : [[API C_PvP.IsWarModeActive|C_PvP.IsWarModeActive]]() |
+ | : [[API C_PvP.IsWarModeActive|C_PvP.IsWarModeActive]]() : <span class="apiret">warModeActive</span> |
− | : [[API C_PvP.IsWarModeDesired|C_PvP.IsWarModeDesired]]() |
+ | : [[API C_PvP.IsWarModeDesired|C_PvP.IsWarModeDesired]]() : <span class="apiret">warModeDesired</span> |
− | : [[API C_PvP.IsWarModeFeatureEnabled|C_PvP.IsWarModeFeatureEnabled]]() |
+ | : [[API C_PvP.IsWarModeFeatureEnabled|C_PvP.IsWarModeFeatureEnabled]]() : <span class="apiret">warModeEnabled</span> |
− | : [[API C_PvP.SetWarModeDesired|C_PvP.SetWarModeDesired]](<span |
+ | : [[API C_PvP.SetWarModeDesired|C_PvP.SetWarModeDesired]](<span class="apiarg">warModeDesired</span>) |
: [[API C_PvP.ToggleWarMode|C_PvP.ToggleWarMode]]() |
: [[API C_PvP.ToggleWarMode|C_PvP.ToggleWarMode]]() |
||
− | == |
+ | ==Quests== |
− | + | Relates to [[Quest]]s. |
|
+ | : [[API C_QuestLine.GetAvailableQuestLines|C_QuestLine.GetAvailableQuestLines]](<span class="apiarg">uiMapID</span>) : <span class="apiret">questLines</span> |
||
− | : [[API AcceptQuest|AcceptQuest]]() - Accept the specified quest. |
||
+ | : [[API C_QuestLine.GetQuestLineInfo|C_QuestLine.GetQuestLineInfo]](<span class="apiarg">questID, uiMapID</span>) : <span class="apiret">questLineInfo</span> |
||
+ | : [[API C_QuestLine.GetQuestLineQuests|C_QuestLine.GetQuestLineQuests]](<span class="apiarg">questLineID</span>) : <span class="apiret">questIDs</span> |
||
+ | : [[API C_QuestLine.IsComplete|C_QuestLine.IsComplete]](<span class="apiarg">questLineID</span>) : <span class="apiret">isComplete</span> |
||
+ | : [[API C_QuestLine.RequestQuestLinesForMap|C_QuestLine.RequestQuestLinesForMap]](<span class="apiarg">uiMapID</span>) |
||
: [[API AcknowledgeAutoAcceptQuest|AcknowledgeAutoAcceptQuest]]() |
: [[API AcknowledgeAutoAcceptQuest|AcknowledgeAutoAcceptQuest]]() |
||
− | : [[API AddAutoQuestPopUp|AddAutoQuestPopUp]](<span |
+ | : [[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 CloseQuest|CloseQuest]]() - Closes the shown quest. |
||
: [[API CollapseQuestHeader|CollapseQuestHeader]]() - Collapses a quest header. |
: [[API CollapseQuestHeader|CollapseQuestHeader]]() - Collapses a quest header. |
||
+ | : [[API ConfirmAcceptQuest|ConfirmAcceptQuest]]() - Accepts a quest started by a group member (e.g. escort quests). |
||
− | : [[API CompleteQuest|CompleteQuest]]() - Complete the specified quest. |
||
+ | : [[API ExpandQuestHeader|ExpandQuestHeader]]() - Expands/collapses a quest log 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 GetAutoQuestPopUp|GetAutoQuestPopUp]](<span class="apiarg">Index</span>) - Returns info for a popup quest notification. |
||
− | : [[API DeclineQuest|DeclineQuest]]() - Declines the currently offered quest. |
||
− | : [[API ExpandQuestHeader|ExpandQuestHeader]]() - Expands a quest header. |
||
− | : [[API GetActiveLevel|GetActiveLevel]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Gets the level of an active quest (only available after QUEST_GREETING event). |
||
− | : [[API GetActiveQuestID|GetActiveQuestID]](<span style="font-size:smaller; color:#ecbc2a">index</span>) |
||
− | : [[API GetActiveTitle|GetActiveTitle]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Gets the title of an active quest (only available after QUEST_GREETING event). |
||
− | : [[API GetAutoQuestPopUp|GetAutoQuestPopUp]](<span style="font-size:smaller; color:#ecbc2a">Index</span>) - Retrieves quest info by index that added using [[API AddAutoQuestPopUp|AddAutoQuestPopUp]]. |
||
− | : [[API GetAvailableLevel|GetAvailableLevel]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Gets the level of an available quest (only available after QUEST_GREETING event). |
||
− | : [[API GetAvailableQuestInfo|GetAvailableQuestInfo]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Returns metadata (quest type) about an available quest. |
||
− | : [[API GetAvailableTitle|GetAvailableTitle]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Gets the title of an available quest (only available after QUEST_GREETING event). |
||
: [[API 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 GetGreetingText|GetGreetingText]]() |
||
: [[API GetMaxRewardCurrencies|GetMaxRewardCurrencies]]() |
: [[API GetMaxRewardCurrencies|GetMaxRewardCurrencies]]() |
||
− | : [[API |
+ | : [[API GetNumAutoQuestPopUps|GetNumAutoQuestPopUps]]() - Returns the number of displayed popup quest notifications. |
− | : [[API GetNumAutoQuestPopUps|GetNumAutoQuestPopUps]]() - Retrieves number of quests added via [[API AddAutoQuestPopUp|AddAutoQuestPopUp]]. |
||
− | : [[API GetNumAvailableQuests|GetNumAvailableQuests]]() - Gets the number of currently available quests from this NPC (only available after QUEST_GREETING event). |
||
: [[API GetNumQuestCurrencies|GetNumQuestCurrencies]]() |
: [[API GetNumQuestCurrencies|GetNumQuestCurrencies]]() |
||
: [[API GetNumQuestItemDrops|GetNumQuestItemDrops]]() |
: [[API GetNumQuestItemDrops|GetNumQuestItemDrops]]() |
||
− | : [[API GetNumQuestItems|GetNumQuestItems]]() - Returns the number of |
+ | : [[API GetNumQuestItems|GetNumQuestItems]]() - Returns the number of required items to complete the current quest. |
− | : [[API GetNumQuestLeaderBoards|GetNumQuestLeaderBoards]](<span |
+ | : [[API GetNumQuestLeaderBoards|GetNumQuestLeaderBoards]](<span class="apiarg">[questIndex]</span>) - Returns the number of objectives for a quest. |
+ | : [[API GetQuestBackgroundMaterial|GetQuestBackgroundMaterial]]() - Returns the background texture for the displayed quest. |
||
− | : [[API GetNumQuestPOIWorldEffects|GetNumQuestPOIWorldEffects]]() |
||
+ | : [[API GetQuestCurrencyID|GetQuestCurrencyID]](<span class="apiarg">type, index</span>) |
||
− | : [[API GetNumQuestRewards|GetNumQuestRewards]]() - Returns number of reward items (those that you always get) for quest currently in gossip window. |
||
+ | : [[API GetQuestCurrencyInfo|GetQuestCurrencyInfo]](<span class="apiarg">type, index</span>) |
||
− | : [[API GetNumRewardCurrencies|GetNumRewardCurrencies]]() |
||
+ | : [[API GetQuestExpansion|GetQuestExpansion]](<span class="apiarg">questID</span>) |
||
− | : [[API GetNumRewardSpells|GetNumRewardSpells]]() |
||
+ | : [[API GetQuestFactionGroup|GetQuestFactionGroup]](<span class="apiarg">questID</span>) |
||
− | : [[API GetObjectiveText|GetObjectiveText]]() - Gets the objective of the current quest. |
||
+ | : [[API GetQuestLink|GetQuestLink]](<span class="apiarg">index</span>) - Returns a [[QuestLink]] for a quest. |
||
− | : [[API GetProgressText|GetProgressText]]() - Returns quest progress text, displayed by the NPC before the player pressed "Continue". |
||
+ | : [[API GetQuestObjectiveInfo|GetQuestObjectiveInfo]](<span class="apiarg">questID, index, displayComplete</span>) |
||
− | : [[API GetQuestBackgroundMaterial|GetQuestBackgroundMaterial]]() - Returns the material string associated with the particular quest. |
||
− | : [[API |
+ | : [[API GetQuestPOIBlobCount|GetQuestPOIBlobCount]](<span class="apiarg">questID</span>) |
− | : [[API |
+ | : [[API GetQuestPOILeaderBoard|GetQuestPOILeaderBoard]](<span class="apiarg">index</span>) |
− | : [[API GetQuestCurrencyInfo|GetQuestCurrencyInfo]](<span style="font-size:smaller; color:#ecbc2a">type, index</span>) |
||
− | : [[API GetQuestExpansion|GetQuestExpansion]](<span style="font-size:smaller; color:#ecbc2a">questID</span>) |
||
− | : [[API GetQuestFactionGroup|GetQuestFactionGroup]](<span style="font-size:smaller; color:#ecbc2a">questID</span>) |
||
− | : [[API GetQuestID|GetQuestID]]() - Returns the ID of the quest most recently displayed in a gossip frame, even after that frame is closed. |
||
− | : [[API GetQuestItemInfo|GetQuestItemInfo]]() - Returns basic information about the reward/choice/required item for quest currently in gossip window. |
||
− | : [[API GetQuestItemInfoLootType|GetQuestItemInfoLootType]](<span style="font-size:smaller; color:#ecbc2a">type, index</span>) |
||
− | : [[API GetQuestItemLink|GetQuestItemLink]](<span style="font-size:smaller; color:#ecbc2a">type, index</span>) - Returns an [[itemLink]] for a selected quest reward/choice/required item for quest currently in gossip window. |
||
− | : [[API GetQuestLink|GetQuestLink]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Returns a [[QuestLink]] for a quest. |
||
− | : [[API GetQuestMoneyToGet|GetQuestMoneyToGet]]() - Returns amount of money required for quest currently displayed in gossip. |
||
− | : [[API GetQuestObjectiveInfo|GetQuestObjectiveInfo]](<span style="font-size:smaller; color:#ecbc2a">questID, index, displayComplete</span>) |
||
− | : [[API GetQuestPOIBlobCount|GetQuestPOIBlobCount]](<span style="font-size:smaller; color:#ecbc2a">questID</span>) |
||
− | : [[API GetQuestPOILeaderBoard|GetQuestPOILeaderBoard]](<span style="font-size:smaller; color:#ecbc2a">index</span>) |
||
: [[API GetQuestPOIs|GetQuestPOIs]]() |
: [[API GetQuestPOIs|GetQuestPOIs]]() |
||
+ | : [[API GetQuestProgressBarPercent|GetQuestProgressBarPercent]](<span class="apiarg">questID</span>) |
||
− | : [[API GetQuestPortraitGiver|GetQuestPortraitGiver]]() |
||
+ | : [[API GetQuestResetTime|GetQuestResetTime]]() - Returns the number of seconds until daily quests reset. |
||
− | : [[API GetQuestPortraitTurnIn|GetQuestPortraitTurnIn]]() |
||
+ | : [[API GetQuestReward|GetQuestReward]](<span class="apiarg">rewardIndex</span>) - Completes the quest and chooses a quest reward, if applicable. |
||
− | : [[API GetQuestProgressBarPercent|GetQuestProgressBarPercent]](<span style="font-size:smaller; color:#ecbc2a">questID</span>) |
||
+ | : [[API GetQuestSortIndex|GetQuestSortIndex]](<span class="apiarg">questIndex</span>) |
||
− | : [[API GetQuestResetTime|GetQuestResetTime]]() - Returns number of seconds until quest reset. |
||
+ | : [[API GetQuestUiMapID|GetQuestUiMapID]](<span class="apiarg">questID</span>) |
||
− | : [[API GetQuestReward|GetQuestReward]](<span style="font-size:smaller; color:#ecbc2a">rewardIndex</span>) - Completes the quest with the specified quest reward. |
||
− | : [[API GetQuestSortIndex|GetQuestSortIndex]](<span style="font-size:smaller; color:#ecbc2a">questIndex</span>) |
||
− | : [[API GetQuestSpellLink|GetQuestSpellLink]](<span style="font-size:smaller; color:#ecbc2a">rewardSpellIndex</span>) |
||
− | : [[API GetQuestText|GetQuestText]]() - Gets the description of the current quest. |
||
− | : [[API GetQuestUiMapID|GetQuestUiMapID]](<span style="font-size:smaller; color:#ecbc2a">questID</span>) |
||
− | : [[API GetRewardArtifactXP|GetRewardArtifactXP]]() |
||
− | : [[API GetRewardHonor|GetRewardHonor]]() |
||
− | : [[API GetRewardMoney|GetRewardMoney]]() - Returns a amount of copper rewarded for completion of quest displayed in gossip. |
||
− | : [[API GetRewardNumSkillUps|GetRewardNumSkillUps]]() |
||
− | : [[API GetRewardSkillLineID|GetRewardSkillLineID]]() |
||
− | : [[API GetRewardSkillPoints|GetRewardSkillPoints]]() |
||
− | : [[API GetRewardSpell|GetRewardSpell]]() - Returns name and texture of spell awarded for quest completion for quest currently in gossip window. |
||
− | : [[API GetRewardText|GetRewardText]]() - Returns quest reward text, displayed by the NPC before the player hits "Complete Quest". |
||
− | : [[API GetRewardTitle|GetRewardTitle]]() - Returns the title awarded by the currently displayed quest. |
||
− | : [[API GetRewardXP|GetRewardXP]]() - Returns the amount of experience awarded by the currently displayed text. |
||
: [[API GetSuggestedGroupSize|GetSuggestedGroupSize]]() |
: [[API GetSuggestedGroupSize|GetSuggestedGroupSize]]() |
||
+ | : [[API HaveQuestData|HaveQuestData]](<span class="apiarg">questID</span>) |
||
− | : [[API GetTitleText|GetTitleText]]() - Retrieves the title of the quest while talking to the NPC about it. |
||
− | : [[API |
+ | : [[API HaveQuestRewardData|HaveQuestRewardData]](<span class="apiarg">questID</span>) |
− | : [[API |
+ | : [[API IsBreadcrumbQuest|IsBreadcrumbQuest]](<span class="apiarg">questID</span>) |
− | : [[API IsActiveQuestLegendary|IsActiveQuestLegendary]](<span style="font-size:smaller; color:#ecbc2a">index</span>) |
||
− | : [[API IsActiveQuestTrivial|IsActiveQuestTrivial]](<span style="font-size:smaller; color:#ecbc2a">index</span>) |
||
− | : [[API IsAvailableQuestTrivial|IsAvailableQuestTrivial]](<span style="font-size:smaller; color:#ecbc2a">index</span>) |
||
− | : [[API IsBreadcrumbQuest|IsBreadcrumbQuest]](<span style="font-size:smaller; color:#ecbc2a">questID</span>) |
||
: [[API IsCurrentQuestFailed|IsCurrentQuestFailed]]() |
: [[API IsCurrentQuestFailed|IsCurrentQuestFailed]]() |
||
− | : [[API IsQuestCompletable|IsQuestCompletable]]() - Returns true if a quest |
+ | : [[API IsQuestCompletable|IsQuestCompletable]]() - Returns true if the displayed quest at a quest giver can be completed. |
− | : [[API |
+ | : [[API IsQuestIDValidSpellTarget|IsQuestIDValidSpellTarget]](<span class="apiarg">questID</span>) |
− | : [[API |
+ | : [[API IsQuestItemHidden|IsQuestItemHidden]](<span class="apiarg">index</span>) |
− | : [[API |
+ | : [[API IsQuestSequenced|IsQuestSequenced]](<span class="apiarg">questID</span>) |
− | : [[API |
+ | : [[API IsStoryQuest|IsStoryQuest]](<span class="apiarg">questID</span>) |
− | : [[API IsStoryQuest|IsStoryQuest]](<span style="font-size:smaller; color:#ecbc2a">questID</span>) |
||
− | : [[API IsTrackingHiddenQuests|IsTrackingHiddenQuests]]() |
||
: [[API PlayAutoAcceptQuestSound|PlayAutoAcceptQuestSound]]() |
: [[API PlayAutoAcceptQuestSound|PlayAutoAcceptQuestSound]]() |
||
− | : [[API QuestChooseRewardError|QuestChooseRewardError]]() - Throws an error when the quest |
+ | : [[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 |
+ | : [[API QuestHasPOIInfo|QuestHasPOIInfo]](<span class="apiarg">questID</span>) |
− | : [[API QuestIsDaily|QuestIsDaily]]() - Returns |
+ | : [[API QuestIsDaily|QuestIsDaily]]() - Returns true if the offered quest is a daily quest. |
: [[API QuestIsFromAreaTrigger|QuestIsFromAreaTrigger]]() |
: [[API QuestIsFromAreaTrigger|QuestIsFromAreaTrigger]]() |
||
− | : [[API QuestIsWeekly|QuestIsWeekly]]() - Returns |
+ | : [[API QuestIsWeekly|QuestIsWeekly]]() - Returns true if the offered quest is a weekly quest. |
: [[API QuestMapUpdateAllQuests|QuestMapUpdateAllQuests]]() |
: [[API QuestMapUpdateAllQuests|QuestMapUpdateAllQuests]]() |
||
− | : [[API QuestPOIGetIconInfo|QuestPOIGetIconInfo]](<span |
+ | : [[API QuestPOIGetIconInfo|QuestPOIGetIconInfo]](<span class="apiarg">questID</span>) |
− | : [[API QuestPOIGetSecondaryLocations|QuestPOIGetSecondaryLocations]](<span |
+ | : [[API QuestPOIGetSecondaryLocations|QuestPOIGetSecondaryLocations]](<span class="apiarg">questID [, table]</span>) |
: [[API QuestPOIUpdateIcons|QuestPOIUpdateIcons]]() |
: [[API QuestPOIUpdateIcons|QuestPOIUpdateIcons]]() |
||
: [[API RemoveAutoQuestPopUp|RemoveAutoQuestPopUp]]() |
: [[API RemoveAutoQuestPopUp|RemoveAutoQuestPopUp]]() |
||
+ | : [[API ShowQuestComplete|ShowQuestComplete]](<span class="apiarg">index</span>) |
||
− | : [[API SelectActiveQuest|SelectActiveQuest]]() - Selects an active quest from the NPC (only available after QUEST_GREETING event). |
||
+ | : [[API ShowQuestOffer|ShowQuestOffer]](<span class="apiarg">index</span>) |
||
− | : [[API SelectAvailableQuest|SelectAvailableQuest]]() - Selects an available quest from the NPC (only available after QUEST_GREETING event). |
||
− | : [[API ShowQuestComplete|ShowQuestComplete]](<span style="font-size:smaller; color:#ecbc2a">index</span>) |
||
− | : [[API ShowQuestOffer|ShowQuestOffer]](<span style="font-size:smaller; color:#ecbc2a">index</span>) |
||
: [[API SortQuests|SortQuests]]() |
: [[API SortQuests|SortQuests]]() |
||
: [[API SortQuestSortTypes|SortQuestSortTypes]]() |
: [[API SortQuestSortTypes|SortQuestSortTypes]]() |
||
− | : [[API UnitQuestTrivialLevelRangeScaling|UnitQuestTrivialLevelRangeScaling]]() |
+ | : [[API UnitQuestTrivialLevelRangeScaling|UnitQuestTrivialLevelRangeScaling]](<span class="apiarg">unit</span>) : <span class="apiret">levelRange</span> |
− | : |
+ | : [https://www.townlong-yak.com/framexml/go/PVPGetConquestLevelInfo PVPGetConquestLevelInfo]() {{apitag|framexml}} |
− | : |
+ | : [https://www.townlong-yak.com/framexml/go/QuestUtils_GetQuestName QuestUtils_GetQuestName]() {{apitag|framexml}} - Returns the name for a quest ID. |
− | === |
+ | ===Quest Log=== |
− | : [[API C_QuestLog.AbandonQuest|C_QuestLog.AbandonQuest]]() - |
+ | : [[API C_QuestLog.AbandonQuest|C_QuestLog.AbandonQuest]]() - Abandons the quest specified by {{api|C_QuestLog.SetAbandonQuest}}. |
− | : [[API C_QuestLog.AddQuestWatch|C_QuestLog.AddQuestWatch]](<span |
+ | : [[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 |
+ | : [[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 |
+ | : [[API C_QuestLog.CanAbandonQuest|C_QuestLog.CanAbandonQuest]](<span class="apiarg">questID</span>) : <span class="apiret">canAbandon</span> |
− | : [[API C_QuestLog.GetAbandonQuest|C_QuestLog.GetAbandonQuest]]() |
+ | : [[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]]() |
+ | : [[API C_QuestLog.GetAbandonQuestItems|C_QuestLog.GetAbandonQuestItems]]() : <span class="apiret">itemIDs</span> |
− | : [[API C_QuestLog. |
+ | : [[API C_QuestLog.GetActiveThreatMaps|C_QuestLog.GetActiveThreatMaps]]() : <span class="apiret">uiMapIDs</span> |
− | : [[API C_QuestLog. |
+ | : [[API C_QuestLog.GetAllCompletedQuestIDs|C_QuestLog.GetAllCompletedQuestIDs]]() : <span class="apiret">quests</span> - Returns all completed quests for the character. |
− | : [[API C_QuestLog. |
+ | : [[API C_QuestLog.GetBountiesForMapID|C_QuestLog.GetBountiesForMapID]](<span class="apiarg">uiMapID</span>) : <span class="apiret">bounties</span> |
− | : [[API C_QuestLog. |
+ | : [[API C_QuestLog.GetBountySetInfoForMapID|C_QuestLog.GetBountySetInfoForMapID]](<span class="apiarg">uiMapID</span>) : <span class="apiret">displayLocation, lockQuestID, bountySetID, isActivitySet</span> |
− | : [[API C_QuestLog. |
+ | : [[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.GetMapForQuestPOIs|C_QuestLog.GetMapForQuestPOIs]]() |
||
+ | : [[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.GetMaxNumQuests|C_QuestLog.GetMaxNumQuests]]() - This is the maximum number of quests a player can be on, including hidden quests, world quests, emissaries etc |
||
+ | : [[API C_QuestLog.GetMapForQuestPOIs|C_QuestLog.GetMapForQuestPOIs]]() : <span class="apiret">uiMapID</span> |
||
− | : [[API C_QuestLog.GetMaxNumQuestsCanAccept|C_QuestLog.GetMaxNumQuestsCanAccept]]() - This is the maximum number of standard quests a player can accept. These are quests that are normally visible in the quest log. |
||
− | : [[API C_QuestLog. |
+ | : [[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.GetMaxNumQuestsCanAccept|C_QuestLog.GetMaxNumQuestsCanAccept]]() : <span class="apiret">maxNumQuestsCanAccept</span> - This is the maximum number of standard quests a player can accept. These are quests that are normally visible in the quest log. |
||
− | : [[API C_QuestLog.GetNextWaypointForMap|C_QuestLog.GetNextWaypointForMap]](<span style="font-size:smaller; color:#ecbc2a">questID, uiMapID</span>) |
||
− | : [[API C_QuestLog. |
+ | : [[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. |
+ | : [[API C_QuestLog.GetNumQuestObjectives|C_QuestLog.GetNumQuestObjectives]](<span class="apiarg">questID</span>) : <span class="apiret">leaderboardCount</span> |
− | : [[API C_QuestLog. |
+ | : [[API C_QuestLog.GetNumQuestWatches|C_QuestLog.GetNumQuestWatches]]() : <span class="apiret">numQuestWatches</span> - Returns the number of tracked quests. |
− | : [[API C_QuestLog. |
+ | : [[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.GetNumWorldQuestWatches|C_QuestLog.GetNumWorldQuestWatches]]() |
||
− | : [[API C_QuestLog. |
+ | : [[API C_QuestLog.GetQuestDetailsTheme|C_QuestLog.GetQuestDetailsTheme]](<span class="apiarg">questID</span>) : <span class="apiret">theme</span> |
− | : [[API C_QuestLog. |
+ | : [[API C_QuestLog.GetQuestDifficultyLevel|C_QuestLog.GetQuestDifficultyLevel]](<span class="apiarg">questID</span>) : <span class="apiret">level</span> |
− | : [[API C_QuestLog. |
+ | : [[API C_QuestLog.GetQuestIDForLogIndex|C_QuestLog.GetQuestIDForLogIndex]](<span class="apiarg">questLogIndex</span>) : <span class="apiret">questID</span> |
− | : [[API C_QuestLog. |
+ | : [[API C_QuestLog.GetQuestIDForQuestWatchIndex|C_QuestLog.GetQuestIDForQuestWatchIndex]](<span class="apiarg">questWatchIndex</span>) : <span class="apiret">questID</span> |
− | : [[API C_QuestLog. |
+ | : [[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, portraitGiverModelSceneID</span> |
||
− | : [[API C_QuestLog.GetQuestIDForWorldQuestWatchIndex|C_QuestLog.GetQuestIDForWorldQuestWatchIndex]](<span style="font-size:smaller; color:#ecbc2a">questWatchIndex</span>) |
||
− | : [[API C_QuestLog.GetQuestObjectives|C_QuestLog.GetQuestObjectives]](<span |
+ | : [[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 |
+ | : [[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 |
+ | : [[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. |
+ | : [[API C_QuestLog.GetQuestType|C_QuestLog.GetQuestType]](<span class="apiarg">questID</span>) : <span class="apiret">questType</span> |
− | : [[API C_QuestLog. |
+ | : [[API C_QuestLog.GetQuestWatchType|C_QuestLog.GetQuestWatchType]](<span class="apiarg">questID</span>) : <span class="apiret">watchType</span> |
− | : [[API C_QuestLog. |
+ | : [[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. |
+ | : [[API C_QuestLog.GetSelectedQuest|C_QuestLog.GetSelectedQuest]]() : <span class="apiret">questID</span> - Returns the quest specified by {{api|C_QuestLog.SetSelectedQuest}}. |
− | : [[API C_QuestLog. |
+ | : [[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. |
+ | : [[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. |
+ | : [[API C_QuestLog.GetTitleForLogIndex|C_QuestLog.GetTitleForLogIndex]](<span class="apiarg">questLogIndex</span>) : <span class="apiret">title</span> |
− | : [[API C_QuestLog. |
+ | : [[API C_QuestLog.GetTitleForQuestID|C_QuestLog.GetTitleForQuestID]](<span class="apiarg">questID</span>) : <span class="apiret">title</span> - Returns the name for a Quest ID. |
− | : [[API C_QuestLog. |
+ | : [[API C_QuestLog.GetZoneStoryInfo|C_QuestLog.GetZoneStoryInfo]](<span class="apiarg">uiMapID</span>) : <span class="apiret">achievementID, storyMapID</span> |
− | : [[API C_QuestLog. |
+ | : [[API C_QuestLog.HasActiveThreats|C_QuestLog.HasActiveThreats]]() : <span class="apiret">hasActiveThreats</span> |
− | : [[API C_QuestLog. |
+ | : [[API C_QuestLog.IsAccountQuest|C_QuestLog.IsAccountQuest]](<span class="apiarg">questID</span>) : <span class="apiret">isAccountQuest</span> |
− | : [[API C_QuestLog. |
+ | : [[API C_QuestLog.IsComplete|C_QuestLog.IsComplete]](<span class="apiarg">questID</span>) : <span class="apiret">isComplete</span> |
− | : [[API C_QuestLog. |
+ | : [[API C_QuestLog.IsFailed|C_QuestLog.IsFailed]](<span class="apiarg">questID</span>) : <span class="apiret">isFailed</span> |
− | : [[API C_QuestLog. |
+ | : [[API C_QuestLog.IsLegendaryQuest|C_QuestLog.IsLegendaryQuest]](<span class="apiarg">questID</span>) : <span class="apiret">isLegendaryQuest</span> |
+ | : [[API C_QuestLog.IsOnMap|C_QuestLog.IsOnMap]](<span class="apiarg">questID</span>) : <span class="apiret">onMap, hasLocalPOI</span> |
||
− | : [[API C_QuestLog.IsPushableQuest|C_QuestLog.IsPushableQuest]]() - Returns true if the currently loaded quest in the quest window can be shared. |
||
− | : [[API C_QuestLog. |
+ | : [[API C_QuestLog.IsOnQuest|C_QuestLog.IsOnQuest]](<span class="apiarg">questID</span>) : <span class="apiret">isOnQuest</span> |
− | : [[API C_QuestLog. |
+ | : [[API C_QuestLog.IsPushableQuest|C_QuestLog.IsPushableQuest]](<span class="apiarg">questID</span>) : <span class="apiret">isPushable</span> - Returns true if the quest can be shared with other players. |
− | : [[API C_QuestLog. |
+ | : [[API C_QuestLog.IsQuestBounty|C_QuestLog.IsQuestBounty]](<span class="apiarg">questID</span>) : <span class="apiret">isBounty</span> |
− | : [[API C_QuestLog. |
+ | : [[API C_QuestLog.IsQuestCalling|C_QuestLog.IsQuestCalling]](<span class="apiarg">questID</span>) : <span class="apiret">isCalling</span> |
− | : [[API C_QuestLog. |
+ | : [[API C_QuestLog.IsQuestCriteriaForBounty|C_QuestLog.IsQuestCriteriaForBounty]](<span class="apiarg">questID, bountyQuestID</span>) : <span class="apiret">isCriteriaForBounty</span> |
− | : [[API C_QuestLog. |
+ | : [[API C_QuestLog.IsQuestFlaggedCompleted|C_QuestLog.IsQuestFlaggedCompleted]](<span class="apiarg">questID</span>) : <span class="apiret">isCompleted</span> - Returns if a quest has been completed. |
− | : [[API C_QuestLog. |
+ | : [[API C_QuestLog.IsQuestInvasion|C_QuestLog.IsQuestInvasion]](<span class="apiarg">questID</span>) : <span class="apiret">isInvasion</span> |
− | : [[API C_QuestLog. |
+ | : [[API C_QuestLog.IsQuestTrivial|C_QuestLog.IsQuestTrivial]](<span class="apiarg">questID</span>) : <span class="apiret">isTrivial</span> |
− | : [[API C_QuestLog. |
+ | : [[API C_QuestLog.IsRepeatableQuest|C_QuestLog.IsRepeatableQuest]](<span class="apiarg">questID</span>) : <span class="apiret">isRepeatable</span> |
− | : [[API C_QuestLog. |
+ | : [[API C_QuestLog.IsThreatQuest|C_QuestLog.IsThreatQuest]](<span class="apiarg">questID</span>) : <span class="apiret">isThreat</span> |
− | : [[API C_QuestLog. |
+ | : [[API C_QuestLog.IsUnitOnQuest|C_QuestLog.IsUnitOnQuest]](<span class="apiarg">unit, questID</span>) : <span class="apiret">isOnQuest</span> - Returns true if the unit is on the specified quest. |
− | : [[API C_QuestLog. |
+ | : [[API C_QuestLog.QuestCanHaveWarModeBonus|C_QuestLog.QuestCanHaveWarModeBonus]](<span class="apiarg">questID</span>) : <span class="apiret">hasBonus</span> |
− | : [[API C_QuestLog. |
+ | : [[API C_QuestLog.QuestHasWarModeBonus|C_QuestLog.QuestHasWarModeBonus]](<span class="apiarg">questID</span>) : <span class="apiret">hasBonus</span> |
− | : [[API C_QuestLog. |
+ | : [[API C_QuestLog.ReadyForTurnIn|C_QuestLog.ReadyForTurnIn]](<span class="apiarg">questID</span>) : <span class="apiret">readyForTurnIn</span> |
− | : [[API C_QuestLog. |
+ | : [[API C_QuestLog.RemoveQuestWatch|C_QuestLog.RemoveQuestWatch]](<span class="apiarg">questID</span>) : <span class="apiret">wasRemoved</span> - Untracks a quest. |
− | : [[API C_QuestLog. |
+ | : [[API C_QuestLog.RemoveWorldQuestWatch|C_QuestLog.RemoveWorldQuestWatch]](<span class="apiarg">questID</span>) : <span class="apiret">wasRemoved</span> - Untracks a world quest. |
− | : [[API C_QuestLog. |
+ | : [[API C_QuestLog.RequestLoadQuestByID|C_QuestLog.RequestLoadQuestByID]](<span class="apiarg">questID</span>) |
− | : [[API C_QuestLog. |
+ | : [[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.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.ShouldShowQuestRewards|C_QuestLog.ShouldShowQuestRewards]](<span class="apiarg">questID</span>) : <span class="apiret">shouldShow</span> |
||
: [[API C_QuestLog.SortQuestWatches|C_QuestLog.SortQuestWatches]]() - Sorts watched quests by proximity to the player character. |
: [[API C_QuestLog.SortQuestWatches|C_QuestLog.SortQuestWatches]]() - Sorts watched quests by proximity to the player character. |
||
+ | : [[API C_PlayerInfo.GetContentDifficultyQuestForPlayer|C_PlayerInfo.GetContentDifficultyQuestForPlayer]](<span class="apiarg">questID</span>) : <span class="apiret">difficulty</span> |
||
: [[API GetNumQuestLogChoices|GetNumQuestLogChoices]]() - Returns the number of options someone has when getting a quest item. |
: [[API GetNumQuestLogChoices|GetNumQuestLogChoices]]() - Returns the number of options someone has when getting a quest item. |
||
: [[API GetNumQuestLogRewardCurrencies|GetNumQuestLogRewardCurrencies]]() |
: [[API GetNumQuestLogRewardCurrencies|GetNumQuestLogRewardCurrencies]]() |
||
: [[API GetNumQuestLogRewardFactions|GetNumQuestLogRewardFactions]]() |
: [[API GetNumQuestLogRewardFactions|GetNumQuestLogRewardFactions]]() |
||
− | : [[API GetNumQuestLogRewards|GetNumQuestLogRewards]]() - Returns the |
+ | : [[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 GetNumTreasurePickerItems|GetNumTreasurePickerItems]]() |
: [[API GetNumTreasurePickerItems|GetNumTreasurePickerItems]]() |
||
− | : [[API GetQuestLogChoiceInfoLootType|GetQuestLogChoiceInfoLootType]](<span |
+ | : [[API GetQuestLogChoiceInfoLootType|GetQuestLogChoiceInfoLootType]](<span class="apiarg">index</span>) |
: [[API GetQuestLogCompletionText|GetQuestLogCompletionText]]() |
: [[API GetQuestLogCompletionText|GetQuestLogCompletionText]]() |
||
: [[API GetQuestLogCriteriaSpell|GetQuestLogCriteriaSpell]]() |
: [[API GetQuestLogCriteriaSpell|GetQuestLogCriteriaSpell]]() |
||
− | : [[API GetQuestLogItemDrop|GetQuestLogItemDrop]](<span |
+ | : [[API GetQuestLogItemDrop|GetQuestLogItemDrop]](<span class="apiarg">index</span>) |
− | : [[API GetQuestLogItemLink|GetQuestLogItemLink]](<span |
+ | : [[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 |
+ | : [[API GetQuestLogLeaderBoard|GetQuestLogLeaderBoard]](<span class="apiarg">ldrIndex [, questIndex]</span>) - Returns info for a quest objective in the quest log. |
− | : [[API GetQuestLogPortraitGiver|GetQuestLogPortraitGiver]]() |
||
: [[API GetQuestLogPortraitTurnIn|GetQuestLogPortraitTurnIn]]() |
: [[API GetQuestLogPortraitTurnIn|GetQuestLogPortraitTurnIn]]() |
||
− | : [[API GetQuestLogQuestText|GetQuestLogQuestText]]() - Returns the description and |
+ | : [[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]]() |
||
− | : [[API GetQuestLogRewardCurrencyInfo|GetQuestLogRewardCurrencyInfo]](<span |
+ | : [[API GetQuestLogRewardCurrencyInfo|GetQuestLogRewardCurrencyInfo]](<span class="apiarg">index [, questID]</span>) |
− | : [[API GetQuestLogRewardFactionInfo|GetQuestLogRewardFactionInfo]](<span |
+ | : [[API GetQuestLogRewardFactionInfo|GetQuestLogRewardFactionInfo]](<span class="apiarg">questIndex</span>) |
: [[API GetQuestLogRewardHonor|GetQuestLogRewardHonor]]() |
: [[API GetQuestLogRewardHonor|GetQuestLogRewardHonor]]() |
||
− | : [[API GetQuestLogRewardInfo|GetQuestLogRewardInfo]]() - Returns |
+ | : [[API GetQuestLogRewardInfo|GetQuestLogRewardInfo]]() - Returns info for an unconditional quest reward item in the quest log. |
− | : [[API GetQuestLogRewardMoney|GetQuestLogRewardMoney]]() - Returns |
+ | : [[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 GetQuestLogRewardTitle|GetQuestLogRewardTitle]]() |
: [[API GetQuestLogRewardTitle|GetQuestLogRewardTitle]]() |
||
: [[API GetQuestLogRewardXP|GetQuestLogRewardXP]]() |
: [[API GetQuestLogRewardXP|GetQuestLogRewardXP]]() |
||
− | : [[API GetQuestLogSpecialItemCooldown|GetQuestLogSpecialItemCooldown]](<span |
+ | : [[API GetQuestLogSpecialItemCooldown|GetQuestLogSpecialItemCooldown]](<span class="apiarg">index</span>) |
− | : [[API GetQuestLogSpecialItemInfo|GetQuestLogSpecialItemInfo]](<span |
+ | : [[API GetQuestLogSpecialItemInfo|GetQuestLogSpecialItemInfo]](<span class="apiarg">index</span>) |
+ | : [[API GetQuestLogTimeLeft|GetQuestLogTimeLeft]]() - Returns the time left in seconds for the current quest. |
||
− | : [[API GetQuestLogSpellLink|GetQuestLogSpellLink]](<span style="font-size:smaller; color:#ecbc2a">rewardSpellIndex</span>) |
||
+ | : [[API GetTreasurePickerItemInfo|GetTreasurePickerItemInfo]](<span class="apiarg">index [, questID]</span>) |
||
− | : [[API GetQuestLogTimeLeft|GetQuestLogTimeLeft]]() - Returns the seconds remaining on the current quest timer. |
||
− | : [[API |
+ | : [[API IsQuestLogSpecialItemInRange|IsQuestLogSpecialItemInRange]](<span class="apiarg">index [, target]</span>) |
− | : [[API IsQuestLogSpecialItemInRange|IsQuestLogSpecialItemInRange]](<span style="font-size:smaller; color:#ecbc2a">index [, target]</span>) |
||
: [[API ProcessQuestLogRewardFactions|ProcessQuestLogRewardFactions]]() |
: [[API ProcessQuestLogRewardFactions|ProcessQuestLogRewardFactions]]() |
||
− | : [[API QuestLogPushQuest|QuestLogPushQuest]]() - |
+ | : [[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 |
+ | : [[API UseQuestLogSpecialItem|UseQuestLogSpecialItem]](<span class="apiarg">index</span>) |
− | === |
+ | ===Gossip=== |
+ | Gossip refers to interaction with an NPC. |
||
− | These functions relate to multiple quest choices, for instance at the [[Hero's Call Board]] and [[Warchief's Command Board]]. |
||
+ | : [[API C_GossipInfo.CloseGossip|C_GossipInfo.CloseGossip]]() - Closes the gossip window. |
||
− | : [[API C_PlayerChoice.GetPlayerChoiceInfo|C_PlayerChoice.GetPlayerChoiceInfo]]() - Returns information about a quest choice fork. |
||
+ | : [[API C_GossipInfo.ForceGossip|C_GossipInfo.ForceGossip]]() : <span class="apiret">forceGossip</span> - Returns true if gossip text must be displayed. For example making this return true shows the Banker gossip. |
||
− | : [[API C_PlayerChoice.GetPlayerChoiceOptionInfo|C_PlayerChoice.GetPlayerChoiceOptionInfo]](<span style="font-size:smaller; color:#ecbc2a">optionIndex</span>) - Returns information about an offered quest choice option. |
||
− | : [[API |
+ | : [[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> - Returns the available quests at a quest giver. |
||
− | : [[API C_PlayerChoice.IsWaitingForPlayerChoiceResponse|C_PlayerChoice.IsWaitingForPlayerChoiceResponse]]() |
||
+ | : [[API C_GossipInfo.GetCompletedOptionDescriptionString|C_GossipInfo.GetCompletedOptionDescriptionString]]() : <span class="apiret">description</span> |
||
− | : [[API ClosePlayerChoice|ClosePlayerChoice]]() |
||
+ | : [[API C_GossipInfo.GetCustomGossipDescriptionString|C_GossipInfo.GetCustomGossipDescriptionString]]() : <span class="apiret">description</span> |
||
− | : [[API GetNumQuestChoices|GetNumQuestChoices]]() - Returns the number of rewards available for choice for quest currently in gossip window. |
||
+ | : [[API C_GossipInfo.GetNumActiveQuests|C_GossipInfo.GetNumActiveQuests]]() : <span class="apiret">numQuests</span> - Returns the number of active quests that you should eventually turn in to this NPC. |
||
+ | : [[API C_GossipInfo.GetNumAvailableQuests|C_GossipInfo.GetNumAvailableQuests]]() : <span class="apiret">numQuests</span> - Returns the number of quests (that you are not already on) offered by this NPC. |
||
+ | : [[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 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 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> - Returns the gossip text. |
||
+ | : [[API C_GossipInfo.RefreshOptions|C_GossipInfo.RefreshOptions]]() |
||
+ | : [[API C_GossipInfo.SelectActiveQuest|C_GossipInfo.SelectActiveQuest]](<span class="apiarg">optionID</span>) - Selects an active quest from the gossip window. |
||
+ | : [[API C_GossipInfo.SelectAvailableQuest|C_GossipInfo.SelectAvailableQuest]](<span class="apiarg">optionID</span>) - Selects an available quest from the gossip window. |
||
+ | : [[API C_GossipInfo.SelectOption|C_GossipInfo.SelectOption]](<span class="apiarg">optionID [, text, confirmed]</span>) - Selects a gossip (conversation) option. |
||
+ | : [[API AcceptQuest|AcceptQuest]]() - Accepts the currently offered quest. |
||
+ | : [[API CloseQuest|CloseQuest]]() - Closes the shown quest. |
||
+ | : [[API CompleteQuest|CompleteQuest]]() - Continues the quest dialog to the reward selection step. |
||
+ | : [[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 GetActiveQuestID|GetActiveQuestID]](<span class="apiarg">index</span>) |
||
+ | : [[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 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 GetGreetingText|GetGreetingText]]() |
||
+ | : [[API GetNumActiveQuests|GetNumActiveQuests]]() - Returns the number of quests which can be turned in at a non-gossip quest giver. |
||
+ | : [[API GetNumAvailableQuests|GetNumAvailableQuests]]() - Returns the number of available quests at a non-gossip quest giver. |
||
+ | : [[API GetNumQuestRewards|GetNumQuestRewards]]() - Returns the number of unconditional rewards at a quest giver. |
||
+ | : [[API GetNumRewardCurrencies|GetNumRewardCurrencies]]() |
||
+ | : [[API GetObjectiveText|GetObjectiveText]]() - Gets the objective of the current quest. |
||
+ | : [[API GetProgressText|GetProgressText]]() - Returns quest progress text at a quest giver. |
||
+ | : [[API GetQuestID|GetQuestID]]() - Returns the ID of the displayed quest at a quest giver. |
||
+ | : [[API GetQuestItemInfo|GetQuestItemInfo]]() - Returns info for a required/reward/choice quest item. |
||
+ | : [[API GetQuestItemInfoLootType|GetQuestItemInfoLootType]](<span class="apiarg">type, index</span>) |
||
+ | : [[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 GetQuestPortraitGiver|GetQuestPortraitGiver]]() |
||
+ | : [[API GetQuestPortraitTurnIn|GetQuestPortraitTurnIn]]() |
||
+ | : [[API GetQuestText|GetQuestText]]() - Gets the description of the current quest. |
||
+ | : [[API GetRewardArtifactXP|GetRewardArtifactXP]]() |
||
+ | : [[API GetRewardHonor|GetRewardHonor]]() |
||
+ | : [[API GetRewardMoney|GetRewardMoney]]() - Returns a amount of copper rewarded for completion of quest displayed in gossip. |
||
+ | : [[API GetRewardNumSkillUps|GetRewardNumSkillUps]]() |
||
+ | : [[API GetRewardSkillLineID|GetRewardSkillLineID]]() |
||
+ | : [[API GetRewardSkillPoints|GetRewardSkillPoints]]() |
||
+ | : [[API GetRewardText|GetRewardText]]() - Returns quest reward text, displayed by the NPC before the player hits "Complete Quest". |
||
+ | : [[API GetRewardTitle|GetRewardTitle]]() - Returns the title awarded by the currently displayed quest. |
||
+ | : [[API GetRewardXP|GetRewardXP]]() - Returns the [[experience]] reward for the quest in the gossip window. |
||
+ | : [[API GetTitleText|GetTitleText]]() - Returns the name of the quest at the quest giver. |
||
+ | : [[API IsActiveQuestLegendary|IsActiveQuestLegendary]](<span class="apiarg">index</span>) |
||
+ | : [[API IsActiveQuestTrivial|IsActiveQuestTrivial]](<span class="apiarg">index</span>) |
||
+ | : [[API IsAvailableQuestTrivial|IsAvailableQuestTrivial]](<span class="apiarg">index</span>) |
||
+ | : [[API SelectActiveQuest|SelectActiveQuest]]() - Selects an active quest from the NPC (only available after QUEST_GREETING event). |
||
+ | : [[API SelectAvailableQuest|SelectAvailableQuest]]() - Selects an available quest from the NPC (only available after QUEST_GREETING event). |
||
+ | |||
+ | ===Quest Choices=== |
||
+ | 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.GetNumRerolls|C_PlayerChoice.GetNumRerolls]]() : <span class="apiret">numRerolls</span> |
||
+ | : [[API C_PlayerChoice.GetRemainingTime|C_PlayerChoice.GetRemainingTime]]() : <span class="apiret">remainingTime</span> |
||
+ | : [[API C_PlayerChoice.IsWaitingForPlayerChoiceResponse|C_PlayerChoice.IsWaitingForPlayerChoiceResponse]]() : <span class="apiret">isWaitingForResponse</span> |
||
+ | : [[API C_PlayerChoice.OnUIClosed|C_PlayerChoice.OnUIClosed]]() |
||
+ | : [[API C_PlayerChoice.RequestRerollPlayerChoice|C_PlayerChoice.RequestRerollPlayerChoice]]() |
||
+ | : [[API C_PlayerChoice.SendPlayerChoiceResponse|C_PlayerChoice.SendPlayerChoiceResponse]](<span class="apiarg">responseID</span>) |
||
+ | : [[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. |
||
− | : [[API SendPlayerChoiceResponse|SendPlayerChoiceResponse]](<span style="font-size:smaller; color:#ecbc2a">responseID</span>) |
||
− | === |
+ | ===World Quests=== |
− | : [[API C_QuestLine.GetAvailableQuestLines|C_QuestLine.GetAvailableQuestLines]](<span style="font-size:smaller; color:#ecbc2a">uiMapID</span>) |
||
− | : [[API C_QuestLine.GetQuestLineInfo|C_QuestLine.GetQuestLineInfo]](<span style="font-size:smaller; color:#ecbc2a">questID, uiMapID</span>) |
||
− | : [[API C_QuestLine.GetQuestLineQuests|C_QuestLine.GetQuestLineQuests]](<span style="font-size:smaller; color:#ecbc2a">questLineID</span>) |
||
− | : [[API C_QuestLine.IsComplete|C_QuestLine.IsComplete]](<span style="font-size:smaller; color:#ecbc2a">questID</span>) |
||
− | : [[API C_QuestLine.RequestQuestLinesForMap|C_QuestLine.RequestQuestLinesForMap]](<span style="font-size:smaller; color:#ecbc2a">uiMapID</span>) |
||
− | |||
− | ==== 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 |
+ | : [[API C_TaskQuest.DoesMapShowTaskQuestObjectives|C_TaskQuest.DoesMapShowTaskQuestObjectives]](<span class="apiarg">uiMapID</span>) : <span class="apiret">showsTaskQuestObjectives</span> |
− | : [[API C_TaskQuest.GetQuestInfoByQuestID|C_TaskQuest.GetQuestInfoByQuestID]](<span |
+ | : [[API C_TaskQuest.GetQuestInfoByQuestID|C_TaskQuest.GetQuestInfoByQuestID]](<span class="apiarg">questID</span>) : <span class="apiret">questTitle, factionID, capped, displayAsObjective</span> |
− | : [[API C_TaskQuest.GetQuestLocation|C_TaskQuest.GetQuestLocation]](<span |
+ | : [[API C_TaskQuest.GetQuestLocation|C_TaskQuest.GetQuestLocation]](<span class="apiarg">questID, uiMapID</span>) : <span class="apiret">locationX, locationY</span> |
− | : [[API C_TaskQuest.GetQuestProgressBarInfo|C_TaskQuest.GetQuestProgressBarInfo]](<span |
+ | : [[API C_TaskQuest.GetQuestProgressBarInfo|C_TaskQuest.GetQuestProgressBarInfo]](<span class="apiarg">questID</span>) : <span class="apiret">progress</span> |
− | : [[API C_TaskQuest.GetQuestTimeLeftMinutes|C_TaskQuest.GetQuestTimeLeftMinutes]](<span |
+ | : [[API C_TaskQuest.GetQuestTimeLeftMinutes|C_TaskQuest.GetQuestTimeLeftMinutes]](<span class="apiarg">questID</span>) : <span class="apiret">minutesLeft</span> |
− | : [[API C_TaskQuest.GetQuestTimeLeftSeconds|C_TaskQuest.GetQuestTimeLeftSeconds]](<span |
+ | : [[API C_TaskQuest.GetQuestTimeLeftSeconds|C_TaskQuest.GetQuestTimeLeftSeconds]](<span class="apiarg">questID</span>) : <span class="apiret">secondsLeft</span> |
− | : [[API C_TaskQuest.GetQuestZoneID|C_TaskQuest.GetQuestZoneID]](<span |
+ | : [[API C_TaskQuest.GetQuestZoneID|C_TaskQuest.GetQuestZoneID]](<span class="apiarg">questID</span>) : <span class="apiret">uiMapID</span> |
− | : [[API C_TaskQuest.GetQuestsForPlayerByMapID|C_TaskQuest.GetQuestsForPlayerByMapID]](<span |
+ | : [[API C_TaskQuest.GetQuestsForPlayerByMapID|C_TaskQuest.GetQuestsForPlayerByMapID]](<span class="apiarg">uiMapID</span>) : <span class="apiret">taskPOIs</span> |
− | : [[API C_TaskQuest.GetThreatQuests|C_TaskQuest.GetThreatQuests]]() |
+ | : [[API C_TaskQuest.GetThreatQuests|C_TaskQuest.GetThreatQuests]]() : <span class="apiret">quests</span> |
− | : [[API C_TaskQuest.IsActive|C_TaskQuest.IsActive]](<span |
+ | : [[API C_TaskQuest.IsActive|C_TaskQuest.IsActive]](<span class="apiarg">questID</span>) : <span class="apiret">active</span> |
− | : [[API C_TaskQuest.RequestPreloadRewardData|C_TaskQuest.RequestPreloadRewardData]](<span |
+ | : [[API C_TaskQuest.RequestPreloadRewardData|C_TaskQuest.RequestPreloadRewardData]](<span class="apiarg">questID</span>) |
+ | : [[API C_QuestLog.IsQuestTask|C_QuestLog.IsQuestTask]](<span class="apiarg">questID</span>) : <span class="apiret">isTask</span> |
||
+ | : [[API C_QuestLog.IsWorldQuest|C_QuestLog.IsWorldQuest]](<span class="apiarg">questID</span>) : <span class="apiret">isWorldQuest</span> |
||
: [[API GetNumQuestLogTasks|GetNumQuestLogTasks]]() |
: [[API GetNumQuestLogTasks|GetNumQuestLogTasks]]() |
||
− | : [[API GetTaskInfo|GetTaskInfo]](<span |
+ | : [[API GetTaskInfo|GetTaskInfo]](<span class="apiarg">questID</span>) |
: [[API GetTaskPOIs|GetTaskPOIs]]() |
: [[API GetTaskPOIs|GetTaskPOIs]]() |
||
: [[API GetTasksTable|GetTasksTable]]() |
: [[API GetTasksTable|GetTasksTable]]() |
||
− | : [[API C_QuestLog.IsQuestTask|C_QuestLog.IsQuestTask]](<span style="font-size:smaller; color:#ecbc2a">questID</span>) |
||
− | |||
− | ==== Gossip ==== |
||
− | : [[API C_GossipInfo.CloseGossip|C_GossipInfo.CloseGossip]]() - Dismiss the gossip window. |
||
− | : [[API C_GossipInfo.ForceGossip|C_GossipInfo.ForceGossip]]() - Returns whether the gossip text ''must'' be displayed. |
||
− | : [[API C_GossipInfo.GetActiveQuests|C_GossipInfo.GetActiveQuests]]() - Retrieves a list of quests which can be turned in on the NPC you are talking to. |
||
− | : [[API C_GossipInfo.GetAvailableQuests|C_GossipInfo.GetAvailableQuests]]() - Retrieves a list of the available quests on the NPC you are talking to. |
||
− | : [[API C_GossipInfo.GetNumActiveQuests|C_GossipInfo.GetNumActiveQuests]]() - Returns the number of active quests that you should eventually turn in to this NPC. |
||
− | : [[API C_GossipInfo.GetNumAvailableQuests|C_GossipInfo.GetNumAvailableQuests]]() - Returns the number of quests (that you are not already on) offered by this NPC. |
||
− | : [[API C_GossipInfo.GetNumOptions|C_GossipInfo.GetNumOptions]]() - Returns the number of conversation options available with this NPC. |
||
− | : [[API C_GossipInfo.GetOptions|C_GossipInfo.GetOptions]]() - Retrieves a list of the available gossip items on the NPC you are talking to. |
||
− | : [[API C_GossipInfo.GetPoiForUiMapID|C_GossipInfo.GetPoiForUiMapID]](uiMapID - Returns gossip poi for a map. |
||
− | : [[API C_GossipInfo.GetPoiInfo|C_GossipInfo.GetPoiInfo]](<span style="font-size:smaller; color:#ecbc2a">uiMapID, gossipPoiID</span>) - Returns gossip poi info. |
||
− | : [[API C_GossipInfo.GetText|C_GossipInfo.GetText]]() - Retrieves the gossip text. |
||
− | : [[API C_GossipInfo.SelectAvailableQuest|C_GossipInfo.SelectAvailableQuest]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Selects an active quest. |
||
− | : [[API C_GossipInfo.SelectAvailableQuest|C_GossipInfo.SelectAvailableQuest]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Selects an available quest. |
||
− | : [[API C_GossipInfo.SelectOption|C_GossipInfo.SelectOption]](<span style="font-size:smaller; color:#ecbc2a">index [, text, confirmed]</span>) - Selects a gossip (conversation) option. |
||
− | |||
− | ==== Super Tracking ==== |
||
− | : [[API C_SuperTrack.GetHighestPrioritySuperTrackingType|C_SuperTrack.GetHighestPrioritySuperTrackingType]]() |
||
− | : [[API C_SuperTrack.GetSuperTrackedQuestID|C_SuperTrack.GetSuperTrackedQuestID]]() |
||
− | : [[API C_SuperTrack.IsSuperTrackingAnything|C_SuperTrack.IsSuperTrackingAnything]]() |
||
− | : [[API C_SuperTrack.IsSuperTrackingCorpse|C_SuperTrack.IsSuperTrackingCorpse]]() |
||
− | : [[API C_SuperTrack.IsSuperTrackingQuest|C_SuperTrack.IsSuperTrackingQuest]]() |
||
− | : [[API C_SuperTrack.IsSuperTrackingUserWaypoint|C_SuperTrack.IsSuperTrackingUserWaypoint]]() |
||
− | : [[API C_SuperTrack.SetSuperTrackedQuestID|C_SuperTrack.SetSuperTrackedQuestID]](<span style="font-size:smaller; color:#ecbc2a">questID</span>) - Changes the quest ID actively being tracked. |
||
− | : [[API C_SuperTrack.SetSuperTrackedUserWaypoint|C_SuperTrack.SetSuperTrackedUserWaypoint]](<span style="font-size:smaller; color:#ecbc2a">superTracked</span>) |
||
− | === |
+ | ===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]]() |
||
: [[API C_AdventureMap.GetMapID|C_AdventureMap.GetMapID]]() |
: [[API C_AdventureMap.GetMapID|C_AdventureMap.GetMapID]]() |
||
− | : [[API C_AdventureMap.GetMapInsetDetailTileInfo|C_AdventureMap.GetMapInsetDetailTileInfo]](<span |
+ | : [[API C_AdventureMap.GetMapInsetDetailTileInfo|C_AdventureMap.GetMapInsetDetailTileInfo]](<span class="apiarg">insetIndex, tileIndex</span>) |
− | : [[API C_AdventureMap.GetMapInsetInfo|C_AdventureMap.GetMapInsetInfo]](<span |
+ | : [[API C_AdventureMap.GetMapInsetInfo|C_AdventureMap.GetMapInsetInfo]](<span class="apiarg">insetIndex</span>) |
: [[API C_AdventureMap.GetNumMapInsets|C_AdventureMap.GetNumMapInsets]]() |
: [[API C_AdventureMap.GetNumMapInsets|C_AdventureMap.GetNumMapInsets]]() |
||
: [[API C_AdventureMap.GetNumQuestOffers|C_AdventureMap.GetNumQuestOffers]]() |
: [[API C_AdventureMap.GetNumQuestOffers|C_AdventureMap.GetNumQuestOffers]]() |
||
: [[API C_AdventureMap.GetNumZoneChoices|C_AdventureMap.GetNumZoneChoices]]() |
: [[API C_AdventureMap.GetNumZoneChoices|C_AdventureMap.GetNumZoneChoices]]() |
||
− | : [[API C_AdventureMap.GetQuestInfo|C_AdventureMap.GetQuestInfo]](<span |
+ | : [[API C_AdventureMap.GetQuestInfo|C_AdventureMap.GetQuestInfo]](<span class="apiarg">questID</span>) |
− | : [[API C_AdventureMap.GetQuestOfferInfo|C_AdventureMap.GetQuestOfferInfo]](<span |
+ | : [[API C_AdventureMap.GetQuestOfferInfo|C_AdventureMap.GetQuestOfferInfo]](<span class="apiarg">offerIndex</span>) |
− | : [[API C_AdventureMap.GetZoneChoiceInfo|C_AdventureMap.GetZoneChoiceInfo]](<span |
+ | : [[API C_AdventureMap.GetZoneChoiceInfo|C_AdventureMap.GetZoneChoiceInfo]](<span class="apiarg">choiceIndex</span>) |
− | : [[API C_AdventureMap.StartQuest|C_AdventureMap.StartQuest]](<span |
+ | : [[API C_AdventureMap.StartQuest|C_AdventureMap.StartQuest]](<span class="apiarg">questID</span>) |
: [[API QuestIsFromAdventureMap|QuestIsFromAdventureMap]]() |
: [[API QuestIsFromAdventureMap|QuestIsFromAdventureMap]]() |
||
− | === |
+ | ===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]]() |
+ | : [[API C_CampaignInfo.GetAvailableCampaigns|C_CampaignInfo.GetAvailableCampaigns]]() : <span class="apiret">campaignIDs</span> |
− | : [[API C_CampaignInfo.GetCampaignChapterInfo|C_CampaignInfo.GetCampaignChapterInfo]](<span |
+ | : [[API C_CampaignInfo.GetCampaignChapterInfo|C_CampaignInfo.GetCampaignChapterInfo]](<span class="apiarg">campaignChapterID</span>) : <span class="apiret">campaignChapterInfo</span> |
− | : [[API C_CampaignInfo.GetCampaignID|C_CampaignInfo.GetCampaignID]](<span |
+ | : [[API C_CampaignInfo.GetCampaignID|C_CampaignInfo.GetCampaignID]](<span class="apiarg">questID</span>) : <span class="apiret">campaignID</span> |
− | : [[API C_CampaignInfo.GetCampaignInfo|C_CampaignInfo.GetCampaignInfo]](<span |
+ | : [[API C_CampaignInfo.GetCampaignInfo|C_CampaignInfo.GetCampaignInfo]](<span class="apiarg">campaignID</span>) : <span class="apiret">campaignInfo</span> |
− | : [[API C_CampaignInfo.GetChapterIDs|C_CampaignInfo.GetChapterIDs]](<span |
+ | : [[API C_CampaignInfo.GetChapterIDs|C_CampaignInfo.GetChapterIDs]](<span class="apiarg">campaignID</span>) : <span class="apiret">chapterIDs</span> |
− | : [[API C_CampaignInfo.GetCurrentChapterID|C_CampaignInfo.GetCurrentChapterID]](<span |
+ | : [[API C_CampaignInfo.GetCurrentChapterID|C_CampaignInfo.GetCurrentChapterID]](<span class="apiarg">campaignID</span>) : <span class="apiret">currentChapterID</span> |
− | : [[API C_CampaignInfo.GetFailureReason|C_CampaignInfo.GetFailureReason]](<span |
+ | : [[API C_CampaignInfo.GetFailureReason|C_CampaignInfo.GetFailureReason]](<span class="apiarg">campaignID</span>) : <span class="apiret">failureReason</span> |
− | : [[API C_CampaignInfo.GetState|C_CampaignInfo.GetState]](<span |
+ | : [[API C_CampaignInfo.GetState|C_CampaignInfo.GetState]](<span class="apiarg">campaignID</span>) : <span class="apiret">state</span> |
− | : [[API C_CampaignInfo.IsCampaignQuest|C_CampaignInfo.IsCampaignQuest]](<span |
+ | : [[API C_CampaignInfo.IsCampaignQuest|C_CampaignInfo.IsCampaignQuest]](<span class="apiarg">questID</span>) : <span class="apiret">isCampaignQuest</span> |
− | : [[API |
+ | : [[API C_LoreText.RequestLoreTextForCampaignID|C_LoreText.RequestLoreTextForCampaignID]](<span class="apiarg">campaignID</span>) |
− | : [[API C_LoreText.RequestLoreTextForCampaignID|C_LoreText.RequestLoreTextForCampaignID]](<span style="font-size:smaller; color:#ecbc2a">campaignID</span>) |
||
− | === |
+ | ===Talking Head=== |
+ | These functions were added in [[Patch 7.0.3]] |
||
− | : [[API C_CreatureInfo.GetFactionInfo|C_CreatureInfo.GetFactionInfo]](<span style="font-size:smaller; color:#ecbc2a">raceID</span>) - Returns the faction name for a race. |
||
+ | : [[API C_TalkingHead.GetConversationsDeferred|C_TalkingHead.GetConversationsDeferred]]() |
||
− | : [[API C_CreatureInfo.GetRaceInfo|C_CreatureInfo.GetRaceInfo]](<span style="font-size:smaller; color:#ecbc2a">raceID</span>) - Returns both localized and locale-independent race names. |
||
+ | : [[API C_TalkingHead.GetCurrentLineAnimationInfo|C_TalkingHead.GetCurrentLineAnimationInfo]]() |
||
− | : [[API NeutralPlayerSelectFaction|NeutralPlayerSelectFaction]]() - Allows Pandaren to choose a faction. |
||
+ | : [[API C_TalkingHead.GetCurrentLineInfo|C_TalkingHead.GetCurrentLineInfo]]() |
||
− | [[Allied Races]] were added in [[Patch 7.3.5]]. |
||
+ | : [[API C_TalkingHead.IgnoreCurrentTalkingHead|C_TalkingHead.IgnoreCurrentTalkingHead]]() |
||
− | : [[API C_AlliedRaces.ClearAlliedRaceDetailsGiver|C_AlliedRaces.ClearAlliedRaceDetailsGiver]]() |
||
+ | : [[API C_TalkingHead.IsCurrentTalkingHeadIgnored|C_TalkingHead.IsCurrentTalkingHeadIgnored]]() |
||
− | : [[API C_AlliedRaces.GetAllRacialAbilitiesFromID|C_AlliedRaces.GetAllRacialAbilitiesFromID]](<span style="font-size:smaller; color:#ecbc2a">raceID</span>) - Returns the racial spells from an allied race. |
||
+ | : [[API C_TalkingHead.SetConversationsDeferred|C_TalkingHead.SetConversationsDeferred]](<span class="apiarg">deferred</span>) |
||
− | : [[API C_AlliedRaces.GetRaceInfoByID|C_AlliedRaces.GetRaceInfoByID]](<span style="font-size:smaller; color:#ecbc2a">raceID</span>) - Returns allied race info. |
||
+ | |||
− | : [[API UnitAlliedRaceInfo|UnitAlliedRaceInfo]](<span style="font-size:smaller; color:#ecbc2a">unit</span>) |
||
+ | ==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.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 a Pandaren to choose a faction. |
||
+ | [[Allied Races]] were added in [[Patch 7.3.5]] |
||
+ | : [[API C_AlliedRaces.GetAllRacialAbilitiesFromID|C_AlliedRaces.GetAllRacialAbilitiesFromID]](<span class="apiarg">raceID</span>) : <span class="apiret">allDisplayInfo</span> - Returns the racial spells from an allied race. |
||
+ | : [[API C_AlliedRaces.GetRaceInfoByID|C_AlliedRaces.GetRaceInfoByID]](<span class="apiarg">raceID</span>) : <span class="apiret">info</span> - Returns allied race info. |
||
+ | : [[API UnitAlliedRaceInfo|UnitAlliedRaceInfo]](<span class="apiarg">unit</span>) : <span class="apiret">isAlliedRace, hasHeritageArmorUnlocked</span> |
||
− | == |
+ | ==Realms== |
− | + | Relates to [[Realm]]s. |
|
: [[API GetAutoCompleteRealms|GetAutoCompleteRealms]]() |
: [[API GetAutoCompleteRealms|GetAutoCompleteRealms]]() |
||
: [[API GetCurrentRegion|GetCurrentRegion]]() |
: [[API GetCurrentRegion|GetCurrentRegion]]() |
||
− | : [[API GetCurrentRegionName|GetCurrentRegionName]]() |
+ | : [[API GetCurrentRegionName|GetCurrentRegionName]]() : <span class="apiret">regionName</span> |
− | : [[API GetNormalizedRealmName|GetNormalizedRealmName]]() - Returns the name of the server, but omitting spaces. |
+ | : [[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 |
+ | : [[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== |
+ | Relates to [[Reputation]]. |
||
− | : [[API C_ReportSystem.CanReportPlayer|C_ReportSystem.CanReportPlayer]](<span style="font-size:smaller; color:#ecbc2a">playerLocation</span>) - Returns if a player can be reported. |
||
+ | : [[API C_Reputation.GetFactionParagonInfo|C_Reputation.GetFactionParagonInfo]](<span class="apiarg">factionID</span>) : <span class="apiret">currentValue, threshold, rewardQuestID, hasRewardPending, tooLowLevelForParagon</span> - Returns [[Paragon reputation|Paragon]] info on a faction. |
||
− | : [[API C_ReportSystem.CanReportPlayerForLanguage|C_ReportSystem.CanReportPlayerForLanguage]](<span style="font-size:smaller; color:#ecbc2a">playerLocation</span>) |
||
+ | : [[API C_Reputation.IsFactionParagon|C_Reputation.IsFactionParagon]](<span class="apiarg">factionID</span>) : <span class="apiret">hasParagon</span> - Returns true if a faction is a paragon reputation. |
||
− | : PROTECTED [[API C_ReportSystem.InitiateReportPlayer|C_ReportSystem.InitiateReportPlayer]](<span style="font-size:smaller; color:#ecbc2a">complaintType [, playerLocation]</span>) - Initiates a report against a player. |
||
+ | : [[API C_Reputation.RequestFactionParagonPreloadRewardData|C_Reputation.RequestFactionParagonPreloadRewardData]](<span class="apiarg">factionID</span>) - Queries the server to pre-load Paragon reward data. |
||
− | : [[API C_ReportSystem.OpenReportPlayerDialog|C_ReportSystem.OpenReportPlayerDialog]](<span style="font-size:smaller; color:#ecbc2a">reportType, playerName [, playerLocation]</span>) - Opens a dialog for reporting a player. |
||
+ | : [[API CollapseFactionHeader|CollapseFactionHeader]](<span class="apiarg">index</span>) - Collapse a faction header row. |
||
− | : [[API C_ReportSystem.ReportServerLag|C_ReportSystem.ReportServerLag]]() |
||
− | : [[API C_ReportSystem.ReportStuckInCombat|C_ReportSystem.ReportStuckInCombat]]() |
||
− | : PROTECTED [[API C_ReportSystem.SendReportPlayer|C_ReportSystem.SendReportPlayer]](<span style="font-size:smaller; color:#ecbc2a">token [, comment]</span>) - Sends an initiated report against a player. |
||
− | : [[API C_ReportSystem.SetPendingReportPetTarget|C_ReportSystem.SetPendingReportPetTarget]](<span style="font-size:smaller; color:#ecbc2a">[target]</span>) - Report a pet for an inappropriate name. |
||
− | : [[API C_ReportSystem.SetPendingReportTarget|C_ReportSystem.SetPendingReportTarget]](<span style="font-size:smaller; color:#ecbc2a">[target]</span>) |
||
− | : [[API C_ReportSystem.SetPendingReportTargetByGuid|C_ReportSystem.SetPendingReportTargetByGuid]](<span style="font-size:smaller; color:#ecbc2a">[guid]</span>) |
||
− | : REMOVED (8.1.5) [[API C_ReportSystem.ReportPlayer|C_ReportSystem.ReportPlayer]]() |
||
− | Restrictions |
||
− | : [[API C_SocialRestrictions.IsMuted|C_SocialRestrictions.IsMuted]]() |
||
− | : [[API C_SocialRestrictions.IsSilenced|C_SocialRestrictions.IsSilenced]]() |
||
− | : [[API C_SocialRestrictions.IsSquelched|C_SocialRestrictions.IsSquelched]]() |
||
− | |||
− | === Reputation === |
||
− | These functions relate to [[Reputation]]. |
||
− | : [[API C_Reputation.GetFactionParagonInfo|C_Reputation.GetFactionParagonInfo]](<span style="font-size:smaller; color:#ecbc2a">factionID</span>) - Gets Paragon information. |
||
− | : [[API C_Reputation.IsFactionParagon|C_Reputation.IsFactionParagon]](<span style="font-size:smaller; color:#ecbc2a">factionID</span>) - Returns true/false if a factionID is a Paragon. |
||
− | : [[API C_Reputation.RequestFactionParagonPreloadRewardData|C_Reputation.RequestFactionParagonPreloadRewardData]](<span style="font-size:smaller; color:#ecbc2a">factionID</span>) - Queries the server to pre-load Paragon reward data. |
||
− | : [[API CollapseFactionHeader|CollapseFactionHeader]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Collapse a faction header row. |
||
: [[API CollapseAllFactionHeaders|CollapseAllFactionHeaders]]() - Collapse all faction header rows. |
: [[API CollapseAllFactionHeaders|CollapseAllFactionHeaders]]() - Collapse all faction header rows. |
||
− | : [[API ExpandFactionHeader|ExpandFactionHeader]](<span |
+ | : [[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 |
+ | : [[API FactionToggleAtWar|FactionToggleAtWar]](<span class="apiarg">index</span>) - Toggles the [[At War]] status for a faction. |
− | : [[API GetFactionInfo|GetFactionInfo]](<span |
+ | : [[API GetFactionInfo|GetFactionInfo]](<span class="apiarg">index</span>) - Returns info for a faction. |
− | : [[API GetFactionInfoByID|GetFactionInfoByID]](<span |
+ | : [[API GetFactionInfoByID|GetFactionInfoByID]](<span class="apiarg">factionID</span>) - Gets details for a specific faction by factionID. |
− | : [[API GetFriendshipReputation|GetFriendshipReputation]](<span style="font-size:smaller; color:#ecbc2a">factionID</span>) - Gets details about an NPC friend. |
||
− | : [[API GetFriendshipReputationRanks|GetFriendshipReputationRanks]](<span style="font-size:smaller; color:#ecbc2a">factionID</span>) - Gets rank data about an NPC friend. |
||
: [[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 |
+ | : [[API GetWatchedFactionInfo|GetWatchedFactionInfo]]() - Returns info for the currently watched faction. |
− | : [[API IsFactionInactive|IsFactionInactive]](<span |
+ | : [[API IsFactionInactive|IsFactionInactive]](<span class="apiarg">index</span>) - Returns true if the specified faction is marked inactive. |
− | : [[API SetFactionActive|SetFactionActive]](<span |
+ | : [[API SetFactionActive|SetFactionActive]](<span class="apiarg">index</span>) - Flags the specified faction as active in the reputation window. |
− | : [[API SetFactionInactive|SetFactionInactive]](<span |
+ | : [[API SetFactionInactive|SetFactionInactive]](<span class="apiarg">index</span>) - Flags the specified faction as inactive in the reputation window. |
− | : [[API SetSelectedFaction|SetSelectedFaction]](<span |
+ | : [[API SetSelectedFaction|SetSelectedFaction]](<span class="apiarg">index</span>) - Sets the currently selected faction in reputation window. |
− | : [[API SetWatchedFactionIndex|SetWatchedFactionIndex]](<span |
+ | : [[API SetWatchedFactionIndex|SetWatchedFactionIndex]](<span class="apiarg">index</span>) - Watches a faction in the reputation window. |
− | == |
+ | ==Spells== |
− | : [[API C_Spell.DoesSpellExist|C_Spell.DoesSpellExist]](<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 |
+ | : [[API C_Spell.IsSpellDataCached|C_Spell.IsSpellDataCached]](<span class="apiarg">spellID</span>) : <span class="apiret">isCached</span> |
− | : [[API C_Spell.RequestLoadSpellData|C_Spell.RequestLoadSpellData]](<span |
+ | : [[API C_Spell.RequestLoadSpellData|C_Spell.RequestLoadSpellData]](<span class="apiarg">spellID</span>) |
− | : [[API C_ZoneAbility.GetActiveAbilities|C_ZoneAbility.GetActiveAbilities]]() |
+ | : [[API C_ZoneAbility.GetActiveAbilities|C_ZoneAbility.GetActiveAbilities]]() : <span class="apiret">zoneAbilities</span> |
− | : [[API AcceptSpellConfirmationPrompt|AcceptSpellConfirmationPrompt]](<span |
+ | : [[API AcceptSpellConfirmationPrompt|AcceptSpellConfirmationPrompt]](<span class="apiarg">spellID</span>) |
− | : |
+ | : [[API CancelSpellByName|CancelSpellByName]](<span class="apiarg">name</span>) {{apitag|nocombat}} |
+ | : [[API CastSpell|CastSpell]](<span class="apiarg">spellIndex, bookType</span>) {{apitag|protected}} - Casts a spell from the spellbook. |
||
− | : PROTECTED [[API CastSpellByID|CastSpellByID]](<span style="font-size:smaller; color:#ecbc2a">spellID [, target]</span>) |
||
− | : |
+ | : [[API CastSpellByID|CastSpellByID]](<span class="apiarg">spellID [, target]</span>) {{apitag|protected}} |
− | : |
+ | : [[API CastSpellByName|CastSpellByName]](<span class="apiarg">name [, target]</span>) {{apitag|protected}} - Casts a spell by name. |
− | : [[API DeclineSpellConfirmationPrompt|DeclineSpellConfirmationPrompt]](<span |
+ | : [[API DeclineSpellConfirmationPrompt|DeclineSpellConfirmationPrompt]](<span class="apiarg">spellID</span>) |
− | : [[API DoesSpellExist|DoesSpellExist]](<span |
+ | : [[API DoesSpellExist|DoesSpellExist]](<span class="apiarg">spellName</span>) |
− | : [[API FindBaseSpellByID|FindBaseSpellByID]](<span |
+ | : [[API FindBaseSpellByID|FindBaseSpellByID]](<span class="apiarg">spellID</span>) |
− | : [[API FindSpellOverrideByID|FindSpellOverrideByID]](<span |
+ | : [[API FindSpellOverrideByID|FindSpellOverrideByID]](<span class="apiarg">spellID</span>) |
: [[API GetMaxSpellStartRecoveryOffset|GetMaxSpellStartRecoveryOffset]]() |
: [[API GetMaxSpellStartRecoveryOffset|GetMaxSpellStartRecoveryOffset]]() |
||
− | : [[API GetSchoolString|GetSchoolString]](<span |
+ | : [[API GetSchoolString|GetSchoolString]](<span class="apiarg">schoolMask</span>) |
− | : [[API GetSpellAutocast|GetSpellAutocast]](<span |
+ | : [[API GetSpellAutocast|GetSpellAutocast]](<span class="apiarg">spellName | spellId, bookType</span>) - Returns true if a (pet) spell is autocastable. |
− | : [[API GetSpellBaseCooldown|GetSpellBaseCooldown]](<span |
+ | : [[API GetSpellBaseCooldown|GetSpellBaseCooldown]](<span class="apiarg">spellID</span>) |
− | : [[API GetSpellCharges|GetSpellCharges]](<span |
+ | : [[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 |
+ | : [[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 |
+ | : [[API GetSpellDescription|GetSpellDescription]](<span class="apiarg">spellId</span>) - Returns the spell description. |
− | : [[API GetSpellInfo|GetSpellInfo]](<span |
+ | : [[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 |
+ | : [[API GetSpellLink|GetSpellLink]](<span class="apiarg">spellName, spellRank</span>) - Returns the hyperlink for a spell. |
− | : [[API GetSpellPowerCost|GetSpellPowerCost]](<span |
+ | : [[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 |
+ | : [[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 |
+ | : [[API IsAttackSpell|IsAttackSpell]](<span class="apiarg">spell</span>) - Returns true if a spellbook item is the "Auto Attack" spell. |
− | : [[API IsAutoRepeatSpell|IsAutoRepeatSpell]](<span |
+ | : [[API IsAutoRepeatSpell|IsAutoRepeatSpell]](<span class="apiarg">spell</span>) |
: [[API IsConsumableSpell|IsConsumableSpell]]() |
: [[API IsConsumableSpell|IsConsumableSpell]]() |
||
− | : [[API IsCurrentSpell|IsCurrentSpell]](<span |
+ | : [[API IsCurrentSpell|IsCurrentSpell]](<span class="apiarg">spellID</span>) - Returns true if the specified spell ID is currently being casted or queued. |
− | : [[API IsHarmfulSpell|IsHarmfulSpell]](<span |
+ | : [[API IsHarmfulSpell|IsHarmfulSpell]](<span class="apiarg">spellSlot</span>) - Returns whether a spell can be used against hostile units |
− | : [[API IsHelpfulSpell|IsHelpfulSpell]](<span |
+ | : [[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 |
+ | : [[API IsPassiveSpell|IsPassiveSpell]](<span class="apiarg">spellID, bookType</span>) - Returns true if the specified spell is a passive ability. |
− | : [[API IsPlayerSpell|IsPlayerSpell]](<span |
+ | : [[API IsPlayerSpell|IsPlayerSpell]](<span class="apiarg">spellID</span>) |
− | : [[API IsSpellInRange|IsSpellInRange]](<span |
+ | : [[API IsSpellInRange|IsSpellInRange]](<span class="apiarg">spellName [, unit]</span>) - Returns 1 if the player is in range to use the specified spell on the target unit, 0 otherwise. |
+ | : [[API IsSpellKnown|IsSpellKnown]](<span class="apiarg">spellID, isPetSpell</span>) - Returns whether the player (or pet) knows the given spell. |
||
− | : [[API IsSpellKnownOrOverridesKnown|IsSpellKnownOrOverridesKnown]](<span style="font-size:smaller; color:#ecbc2a">spellID [, isPet]</span>) |
||
+ | : [[API IsSpellKnownOrOverridesKnown|IsSpellKnownOrOverridesKnown]](<span class="apiarg">spellID [, isPet]</span>) |
||
− | : [[API IsSpellKnown|IsSpellKnown]](<span style="font-size:smaller; color:#ecbc2a">spellID, isPetSpell</span>) - Returns whether the player (or pet) knows the given spell. |
||
− | : [[API IsSpellOverlayed|IsSpellOverlayed]](<span |
+ | : [[API IsSpellOverlayed|IsSpellOverlayed]](<span class="apiarg">spellID</span>) - Returns true if the specified spell currently has a proc / spell activation alert (glowing border). |
− | : [[API IsUsableSpell|IsUsableSpell]](<span |
+ | : [[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 SpellCanTargetItem|SpellCanTargetItem]]() |
||
: [[API SpellCanTargetItemID|SpellCanTargetItemID]]() |
: [[API SpellCanTargetItemID|SpellCanTargetItemID]]() |
||
− | : [[API SpellCanTargetItem|SpellCanTargetItem]]() |
||
: [[API SpellCanTargetQuest|SpellCanTargetQuest]]() |
: [[API SpellCanTargetQuest|SpellCanTargetQuest]]() |
||
− | : [[API SpellCanTargetUnit|SpellCanTargetUnit]](<span |
+ | : [[API SpellCanTargetUnit|SpellCanTargetUnit]](<span class="apiarg">unit</span>) - Returns true if the spell awaiting target selection can be cast on the unit. |
+ | : [[API SpellGetVisibilityInfo|SpellGetVisibilityInfo]](<span class="apiarg">spellID, visType</span>) |
||
− | : [[API SpellCancelQueuedSpell|SpellCancelQueuedSpell]]() |
||
+ | : [[API SpellHasRange|SpellHasRange]](<span class="apiarg">spell</span>) - Returns true if the specified spell has a ranged effect (i.e. requires a target). |
||
− | : [[API SpellGetVisibilityInfo|SpellGetVisibilityInfo]](<span style="font-size:smaller; color:#ecbc2a">spellID, visType</span>) |
||
+ | : [[API SpellIsAlwaysShown|SpellIsAlwaysShown]](<span class="apiarg">spellID</span>) |
||
− | : [[API SpellHasRange|SpellHasRange]](<span style="font-size:smaller; color:#ecbc2a">spell</span>) - Returns true if the specified spell has a ranged effect (i.e. requires a target). |
||
− | : [[API |
+ | : [[API SpellIsPriorityAura|SpellIsPriorityAura]](<span class="apiarg">spellID</span>) |
− | : [[API SpellIsSelfBuff|SpellIsSelfBuff]](<span |
+ | : [[API SpellIsSelfBuff|SpellIsSelfBuff]](<span class="apiarg">spellID</span>) |
− | : [[API SpellIsTargeting|SpellIsTargeting]]() - Returns true if a spell |
+ | : [[API SpellIsTargeting|SpellIsTargeting]]() - Returns true if a spell is about to be cast and is waiting for the player to select a target. |
− | : |
+ | : [[API SpellStopCasting|SpellStopCasting]]() {{apitag|protected}} - Stops the current spellcast. |
− | : |
+ | : [[API SpellStopTargeting|SpellStopTargeting]]() {{apitag|protected}} - Cancels the spell awaiting target selection. |
− | : |
+ | : [[API SpellTargetUnit|SpellTargetUnit]](<span class="apiarg">unit</span>) {{apitag|protected}} - Casts the spell awaiting target selection on the unit. |
− | : |
+ | : [[API SpellTargetItem|SpellTargetItem]](<span class="apiarg">item</span>) {{apitag|protected}} |
+ | : [[API QueryCastSequence|QueryCastSequence]](<span class="apiarg">sequence</span>) {{apitag|framexml}} - Returns index, item, spell for the spell/item that will be used next if the cast sequence is executed. |
||
− | : UI [[API AuraUtil.FindAuraByName|AuraUtil.FindAuraByName]](<span style="font-size:smaller; color:#ecbc2a">auraName, unit, filter</span>) - Finds the first aura that matches the name. |
||
− | : UI [[API QueryCastSequence|QueryCastSequence]](<span style="font-size:smaller; color:#ecbc2a">sequence</span>) - Returns index, item, spell for the spell/item that will be used next if the cast sequence is executed. |
||
− | === |
+ | ===Spell Book=== |
− | : [[API C_SpellBook.ContainsAnyDisenchantSpell|C_SpellBook.ContainsAnyDisenchantSpell]]() |
+ | : [[API C_SpellBook.ContainsAnyDisenchantSpell|C_SpellBook.ContainsAnyDisenchantSpell]]() : <span class="apiret">contains</span> |
− | : [[API C_SpellBook. |
+ | : [[API C_SpellBook.GetCurrentLevelSpells|C_SpellBook.GetCurrentLevelSpells]](<span class="apiarg">level</span>) : <span class="apiret">spellIDs</span> |
− | : [[API C_SpellBook. |
+ | : [[API C_SpellBook.GetSkillLineIndexByID|C_SpellBook.GetSkillLineIndexByID]](<span class="apiarg">skillLineID</span>) : <span class="apiret">skillIndex</span> |
− | : [[API |
+ | : [[API C_SpellBook.GetSpellInfo|C_SpellBook.GetSpellInfo]](<span class="apiarg">spellID</span>) : <span class="apiret">spellInfo</span> |
+ | : [[API C_SpellBook.GetSpellLinkFromSpellID|C_SpellBook.GetSpellLinkFromSpellID]](<span class="apiarg">spellID [, glyphID]</span>) : <span class="apiret">spellLink</span> |
||
− | : [[API GetNumSpellTabs|GetNumSpellTabs]]() - Returns the total number of tabs in the user's spellbook. |
||
− | : [[API |
+ | : [[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 GetSpellBookItemInfo|GetSpellBookItemInfo]](<span style="font-size:smaller; color:#ecbc2a">spellName [or index, bookType]</span>) - Returns the spell's type and spellID for a spell in the player's spellbook. |
||
− | : [[API |
+ | : [[API GetNumSpellTabs|GetNumSpellTabs]]() - Returns the number of tabs in the spellbook. |
+ | : [[API GetSpellAvailableLevel|GetSpellAvailableLevel]](<span class="apiarg">spellSlot</span>) |
||
− | : [[API GetSpellBookItemTexture|GetSpellBookItemTexture]](<span style="font-size:smaller; color:#ecbc2a">spellName [or index, bookType]</span>) - Returns the spell icon fileId for a spell in the player's spellbook. |
||
+ | : [[API 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 name of a [[spellbook]] item. |
||
+ | : [[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 |
+ | : [[API GetSpellTabInfo|GetSpellTabInfo]](<span class="apiarg">spellbookTabNum</span>) - Returns info for the specified spellbook tab. |
− | : [[API IsSelectedSpellBookItem|IsSelectedSpellBookItem]](<span |
+ | : [[API IsSelectedSpellBookItem|IsSelectedSpellBookItem]](<span class="apiarg">spellSlot</span>) |
− | == |
+ | ==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 |
+ | : [[API C_StorePublic.DoesGroupHavePurchaseableProducts|C_StorePublic.DoesGroupHavePurchaseableProducts]](<span class="apiarg">groupID</span>) : <span class="apiret">hasPurchaseableProducts</span> |
− | : [[API C_StorePublic.IsDisabledByParentalControls|C_StorePublic.IsDisabledByParentalControls]]() - Returns whether access to the in-game shop is disabled by parental controls. |
+ | : [[API C_StorePublic.IsDisabledByParentalControls|C_StorePublic.IsDisabledByParentalControls]]() : <span class="apiret">disabled</span> - Returns whether access to the in-game shop is disabled by parental controls. |
− | : [[API C_StorePublic.IsEnabled|C_StorePublic.IsEnabled]]() - 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 |
+ | [[Character Boost]]s were added in [[Patch 5.4.7]] |
+ | : [[API C_CharacterServices.AssignPCTDistribution|C_CharacterServices.AssignPCTDistribution]]() {{apitag|protected}} |
||
− | [[Character Boost]]s were added in [[Patch 5.4.7]]. |
||
− | : |
+ | : [[API C_CharacterServices.AssignUpgradeDistribution|C_CharacterServices.AssignUpgradeDistribution]]() {{apitag|protected}} |
− | : |
+ | : [[API C_CharacterServices.GetActiveCharacterUpgradeBoostType|C_CharacterServices.GetActiveCharacterUpgradeBoostType]]() {{apitag|protected}} |
− | : |
+ | : [[API C_CharacterServices.GetActiveClassTrialBoostType|C_CharacterServices.GetActiveClassTrialBoostType]]() {{apitag|protected}} |
− | : |
+ | : [[API C_CharacterServices.GetAutomaticBoost|C_CharacterServices.GetAutomaticBoost]]() {{apitag|protected}} |
− | : |
+ | : [[API C_CharacterServices.GetAutomaticBoostCharacter|C_CharacterServices.GetAutomaticBoostCharacter]]() {{apitag|protected}} |
− | : |
+ | : [[API C_CharacterServices.GetCharacterServiceDisplayData|C_CharacterServices.GetCharacterServiceDisplayData]]() {{apitag|protected}} |
− | : |
+ | : [[API C_CharacterServices.GetCharacterServiceDisplayDataByVASType|C_CharacterServices.GetCharacterServiceDisplayDataByVASType]]() {{apitag|protected}} |
− | : |
+ | : [[API C_CharacterServices.GetCharacterServiceDisplayInfo|C_CharacterServices.GetCharacterServiceDisplayInfo]]() {{apitag|protected}} |
− | : |
+ | : [[API C_CharacterServices.GetVASDistributions|C_CharacterServices.GetVASDistributions]]() {{apitag|protected}} |
− | : |
+ | : [[API C_CharacterServices.HasRequiredBoostForClassTrial|C_CharacterServices.HasRequiredBoostForClassTrial]]() {{apitag|protected}} |
− | : |
+ | : [[API C_CharacterServices.HasRequiredBoostForUnrevoke|C_CharacterServices.HasRequiredBoostForUnrevoke]]() {{apitag|protected}} |
+ | : [[API C_CharacterServices.SetAutomaticBoost|C_CharacterServices.SetAutomaticBoost]]() {{apitag|protected}} |
||
+ | : [[API C_CharacterServices.SetAutomaticBoostCharacter|C_CharacterServices.SetAutomaticBoostCharacter]]() {{apitag|protected}} |
||
: [[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]] |
: [[API C_ClassTrial.GetClassTrialLogoutTimeSeconds|C_ClassTrial.GetClassTrialLogoutTimeSeconds]]() |
: [[API C_ClassTrial.GetClassTrialLogoutTimeSeconds|C_ClassTrial.GetClassTrialLogoutTimeSeconds]]() |
||
: [[API C_ClassTrial.IsClassTrialCharacter|C_ClassTrial.IsClassTrialCharacter]]() |
: [[API C_ClassTrial.IsClassTrialCharacter|C_ClassTrial.IsClassTrialCharacter]]() |
||
Line 3,900: | Line 4,640: | ||
: [[API C_SharedCharacterServices.IsPurchaseIDPendingUpgrade|C_SharedCharacterServices.IsPurchaseIDPendingUpgrade]]() |
: [[API C_SharedCharacterServices.IsPurchaseIDPendingUpgrade|C_SharedCharacterServices.IsPurchaseIDPendingUpgrade]]() |
||
: [[API C_SharedCharacterServices.QueryClassTrialBoostResult|C_SharedCharacterServices.QueryClassTrialBoostResult]]() |
: [[API C_SharedCharacterServices.QueryClassTrialBoostResult|C_SharedCharacterServices.QueryClassTrialBoostResult]]() |
||
− | : [[API C_SharedCharacterServices.SetCharacterUpgradePopupSeen|C_SharedCharacterServices.SetCharacterUpgradePopupSeen]](<span |
+ | : [[API C_SharedCharacterServices.SetCharacterUpgradePopupSeen|C_SharedCharacterServices.SetCharacterUpgradePopupSeen]](<span class="apiarg">expansion_id</span>) |
− | : [[API C_SharedCharacterServices.SetExpansionTrialPopupSeen|C_SharedCharacterServices.SetExpansionTrialPopupSeen]](<span |
+ | : [[API C_SharedCharacterServices.SetExpansionTrialPopupSeen|C_SharedCharacterServices.SetExpansionTrialPopupSeen]](<span class="apiarg">expansion_id</span>) |
− | : [[API C_SharedCharacterServices.SetPromotionalPopupSeen|C_SharedCharacterServices.SetPromotionalPopupSeen]](<span |
+ | : [[API C_SharedCharacterServices.SetPromotionalPopupSeen|C_SharedCharacterServices.SetPromotionalPopupSeen]](<span class="apiarg">seen</span>) |
− | == |
+ | ==System== |
+ | : [[API C_UI.Reload|C_UI.Reload]]() {{apitag|hwevent}} - Reloads the User Interface. |
||
− | : [[API C_IncomingSummon.HasIncomingSummon|C_IncomingSummon.HasIncomingSummon]](<span style="font-size:smaller; color:#ecbc2a">unit</span>) - Returns whether a group member has an incoming summon. |
||
+ | : [[API C_System.GetFrameStack|C_System.GetFrameStack]]() : <span class="apiret">objects</span> |
||
− | : [[API C_IncomingSummon.IncomingSummonStatus|C_IncomingSummon.IncomingSummonStatus]](<span style="font-size:smaller; color:#ecbc2a">unit</span>) - Returns the status of an group member's incoming summon. |
||
− | : [[API C_SummonInfo.CancelSummon|C_SummonInfo.CancelSummon]]() - Rejects a summon request. |
||
− | : [[API C_SummonInfo.ConfirmSummon|C_SummonInfo.ConfirmSummon]]() - Accepts a summon request. |
||
− | : [[API C_SummonInfo.GetSummonConfirmAreaName|C_SummonInfo.GetSummonConfirmAreaName]]() - Returns the name of the area you're being summoned to. |
||
− | : [[API C_SummonInfo.GetSummonConfirmSummoner|C_SummonInfo.GetSummonConfirmSummoner]]() - Returns the name of the player summoning you. |
||
− | : [[API C_SummonInfo.GetSummonConfirmTimeLeft|C_SummonInfo.GetSummonConfirmTimeLeft]]() - Returns the amount of time left before the pending summon expires. |
||
− | : [[API C_SummonInfo.GetSummonReason|C_SummonInfo.GetSummonReason]]() |
||
− | : [[API C_SummonInfo.IsSummonSkippingStartExperience|C_SummonInfo.IsSummonSkippingStartExperience]]() |
||
− | : [[API PlayerCanTeleport|PlayerCanTeleport]]() |
||
− | |||
− | === System === |
||
− | : HW [[API C_UI.Reload|C_UI.Reload]]() - Reloads the UI from source files. |
||
− | : [[API C_System.GetFrameStack|C_System.GetFrameStack]]() |
||
: [[API CancelLogout|CancelLogout]]() - Cancels the logout timer (from camping or quitting). |
: [[API CancelLogout|CancelLogout]]() - Cancels the logout timer (from camping or quitting). |
||
− | : |
+ | : [[API CopyToClipboard|CopyToClipboard]](<span class="apiarg">text</span>) {{apitag|protected}} - 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. |
||
− | : |
+ | : [[API ForceLogout|ForceLogout]]() {{apitag|protected}} |
− | : |
+ | : [[API ForceQuit|ForceQuit]]() {{apitag|protected}} - Instantly quits the game, ignoring the 20 seconds timer. |
− | : [[API GetBuildInfo|GetBuildInfo]]() - Returns |
+ | : [[API GetBuildInfo|GetBuildInfo]]() - Returns info for the current client build. |
− | : [[API GetFramerate|GetFramerate]]() - Returns the current framerate |
+ | : [[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 Is64BitClient|Is64BitClient]]() |
: [[API Is64BitClient|Is64BitClient]]() |
||
: [[API IsDebugBuild|IsDebugBuild]]() |
: [[API IsDebugBuild|IsDebugBuild]]() |
||
: [[API IsGMClient|IsGMClient]]() |
: [[API IsGMClient|IsGMClient]]() |
||
− | : [[API IsLinuxClient|IsLinuxClient]]() |
+ | : [[API IsLinuxClient|IsLinuxClient]]() - Returns 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 |
+ | : [[API IsMacClient|IsMacClient]]() - Returns 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 IsWindowsClient|IsWindowsClient]]() - Returns true if WoW is being run on Windows. |
||
+ | : [[API IsWindowsClient|IsWindowsClient]]() - Returns true if on a Windows client. |
||
− | : [[API LoadURLIndex|LoadURLIndex]](<span style="font-size:smaller; color:#ecbc2a">index</span>) |
||
+ | : [[API LoadURLIndex|LoadURLIndex]](<span class="apiarg">index</span>) |
||
− | : PROTECTED [[API Logout|Logout]]() - Logs the user out of the game. |
||
+ | : [[API Logout|Logout]]() {{apitag|protected}} - Logs the player out of the game. |
||
: [[API ProcessExceptionClient|ProcessExceptionClient]]() |
: [[API ProcessExceptionClient|ProcessExceptionClient]]() |
||
− | : |
+ | : [[API Quit|Quit]]() {{apitag|protected}} - Quits the game. |
: [[API Screenshot|Screenshot]]() - Takes a screenshot. |
: [[API Screenshot|Screenshot]]() - Takes a screenshot. |
||
− | : [[API SendSystemMessage|SendSystemMessage]](<span |
+ | : [[API SendSystemMessage|SendSystemMessage]](<span class="apiarg">message</span>) - Prints a yellow CHAT_MSG_SYSTEM message. |
− | : |
+ | : [[API Stuck|Stuck]]() {{apitag|protected}} - Notifies the game engine that the player is stuck. |
− | : |
+ | : [[API ToggleFramerate|ToggleFramerate]]() {{apitag|framexml}} - Show/Hide the FPS. |
− | === |
+ | ===Network=== |
: [[API GetAvailableBandwidth|GetAvailableBandwidth]]() |
: [[API GetAvailableBandwidth|GetAvailableBandwidth]]() |
||
: [[API GetBackgroundLoadingStatus|GetBackgroundLoadingStatus]]() |
: [[API GetBackgroundLoadingStatus|GetBackgroundLoadingStatus]]() |
||
Line 3,952: | Line 4,682: | ||
: [[API GetFileStreamingStatus|GetFileStreamingStatus]]() |
: [[API GetFileStreamingStatus|GetFileStreamingStatus]]() |
||
: [[API GetNetIpTypes|GetNetIpTypes]]() |
: [[API GetNetIpTypes|GetNetIpTypes]]() |
||
− | : [[API GetNetStats|GetNetStats]]() - |
+ | : [[API GetNetStats|GetNetStats]]() - Returns bandwidth and latency network information. |
− | : [[API GetTickTime|GetTickTime]]() |
||
− | === |
+ | ===Console=== |
− | + | Relates to [[Console variables]] and commands. |
|
− | : [[API C_CVar.GetCVar|C_CVar.GetCVar]](<span |
+ | : [[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.GetCVarBitfield|C_CVar.GetCVarBitfield]](<span |
+ | : [[API C_CVar.GetCVarBitfield|C_CVar.GetCVarBitfield]](<span class="apiarg">name, index</span>) : <span class="apiret">value</span> - Returns the bitfield of a console variable. |
− | : [[API C_CVar.GetCVarBool|C_CVar.GetCVarBool]](<span |
+ | : [[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 |
+ | : [[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 |
+ | : [[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 |
+ | : [[API C_CVar.SetCVar|C_CVar.SetCVar]](<span class="apiarg">name [, value]</span>) : <span class="apiret">success</span> - Sets a console variable. |
− | : [[API C_CVar.SetCVarBitfield|C_CVar.SetCVarBitfield]](<span |
+ | : [[API C_CVar.SetCVarBitfield|C_CVar.SetCVarBitfield]](<span class="apiarg">name, index, value</span>) : <span class="apiret">success</span> - Sets the bitfield of a console variable. |
− | : [[API C_Console.GetAllCommands|C_Console.GetAllCommands]]() - Returns all console variables and commands. |
+ | : [[API C_Console.GetAllCommands|C_Console.GetAllCommands]]() : <span class="apiret">commands</span> - Returns all console variables and commands. |
− | : [[API C_Console.GetColorFromType|C_Console.GetColorFromType]](<span |
+ | : [[API C_Console.GetColorFromType|C_Console.GetColorFromType]](<span class="apiarg">colorType</span>) : <span class="apiret">color</span> - Returns color info for a color type. |
− | : [[API C_Console.GetFontHeight|C_Console.GetFontHeight]]() - Returns the console's currently used font height. |
+ | : [[API C_Console.GetFontHeight|C_Console.GetFontHeight]]() : <span class="apiret">fontHeightInPixels</span> - Returns the console's currently used font height. |
− | : [[API C_Console.PrintAllMatchingCommands|C_Console.PrintAllMatchingCommands]](<span |
+ | : [[API C_Console.PrintAllMatchingCommands|C_Console.PrintAllMatchingCommands]](<span class="apiarg">partialCommandText</span>) - Prints all matching console commands. |
− | : [[API C_Console.SetFontHeight|C_Console.SetFontHeight]](<span |
+ | : [[API C_Console.SetFontHeight|C_Console.SetFontHeight]](<span class="apiarg">fontHeightInPixels</span>) - Sets the console's font height. |
− | : [[API ConsoleAddMessage|ConsoleAddMessage]](<span |
+ | : [[API ConsoleAddMessage|ConsoleAddMessage]](<span class="apiarg">message</span>) - Prints a message to the console window. |
− | : [[API ConsoleExec|ConsoleExec]](<span |
+ | : [[API ConsoleExec|ConsoleExec]](<span class="apiarg">command</span>) - Execute a console command. |
− | : [[API GetCVarInfo|GetCVarInfo]](<span |
+ | : [[API GetCVarInfo|GetCVarInfo]](<span class="apiarg">name</span>) - Returns information on a console variable. |
− | : [[API SetConsoleKey|SetConsoleKey]](<span |
+ | : [[API SetConsoleKey|SetConsoleKey]](<span class="apiarg">key</span>) - Sets the console key (normally ~). |
− | === |
+ | ===Date & Time=== |
− | : [[API C_DateAndTime.AdjustTimeByDays|C_DateAndTime.AdjustTimeByDays]](<span |
+ | : [[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 |
+ | : [[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 |
+ | : [[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 |
+ | : [[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]]() - 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. |
+ | : [[API C_DateAndTime.GetSecondsUntilDailyReset|C_DateAndTime.GetSecondsUntilDailyReset]]() : <span class="apiret">seconds</span> |
− | : [[API C_DateAndTime. |
+ | : [[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 [[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 |
+ | : [[API GetTime|GetTime]]() - Returns the system uptime of your computer in seconds, with millisecond precision. |
− | : [[API GetTimePreciseSec|GetTimePreciseSec]]() |
+ | : [[API GetTimePreciseSec|GetTimePreciseSec]]() - Returns a monotonic timestamp in seconds, with millisecond precision. |
− | : [[API RequestTimePlayed|RequestTimePlayed]]() - |
+ | : [[API RequestTimePlayed|RequestTimePlayed]]() - Requests a summary of time played. |
+ | : [[API date|date]](<span class="apiarg">format, time</span>) {{apitag|lua}} - Returns the current date according to the user's machine. |
||
− | : UI [[API SecondsToTime|SecondsToTime]](<span style="font-size:smaller; color:#ecbc2a">seconds [, noSeconds, notAbbreviated, maxCount, roundUp]</span>) - Converts a number of seconds into a readable formatted string. |
||
− | : |
+ | : [[API time|time]](<span class="apiarg">table</span>) {{apitag|lua}} - Returns a timestamp for the specified time or the current Unix time. |
− | : DEPRECATED (8.1.0) [[API C_DateAndTime.GetDateFromEpoch|C_DateAndTime.GetDateFromEpoch]](<span style="font-size:smaller; color:#ecbc2a">epoch</span>) |
||
− | : DEPRECATED (8.1.0) [[API C_DateAndTime.GetTodaysDate|C_DateAndTime.GetTodaysDate]]() |
||
− | : DEPRECATED (8.1.0) [[API C_DateAndTime.GetYesterdaysDate|C_DateAndTime.GetYesterdaysDate]]() |
||
+ | ===Timers=== |
||
− | : [[API date|date]](<span style="font-size:smaller; color:#ecbc2a">format, time</span>) - Returns the current date according to the user's machine. |
||
− | : [[API |
+ | : [[API C_Timer.After|C_Timer.After]](<span class="apiarg">seconds, callback</span>) - Schedules a timer. |
+ | : [[API C_Timer.NewTimer|C_Timer.NewTimer]](<span class="apiarg">seconds, callback</span>) : <span class="apiret">cbObject</span> - Schedules a timer that can be canceled. |
||
+ | : [[API C_Timer.NewTicker|C_Timer.NewTicker]](<span class="apiarg">seconds, callback [, iterations]</span>) : <span class="apiret">cbObject</span> - Schedules a repeating timer that can be canceled. |
||
− | === |
+ | ===Debugging=== |
− | : [[API C_Timer.After|C_Timer.After]](<span style="font-size:smaller; color:#ecbc2a">duration, callback</span>) - Runs callback after given duration. |
||
− | : UI [[API C_Timer.NewTimer|C_Timer.NewTimer]](<span style="font-size:smaller; color:#ecbc2a">duration, callback</span>) - Runs callback after given duration. (Cancelable) |
||
− | : UI [[API C_Timer.NewTicker|C_Timer.NewTicker]](<span style="font-size:smaller; color:#ecbc2a">duration, callback [, iterations]</span>) - Runs callback multiple times iterating every given duration. (Cancelable) |
||
− | |||
− | ==== 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. |
||
− | : [[API FrameXML_Debug|FrameXML_Debug]](<span |
+ | : [[API FrameXML_Debug|FrameXML_Debug]](<span class="apiarg">flag</span>) - Sets FrameXML logging state which is output to "/WoW Folder/Logs/FrameXML.log". |
: [[API GetCurrentEventID|GetCurrentEventID]]() |
: [[API GetCurrentEventID|GetCurrentEventID]]() |
||
− | : [[API GetEventTime|GetEventTime]](<span |
+ | : [[API GetEventTime|GetEventTime]](<span class="apiarg">eventProfileIndex</span>) |
− | : [[API GetGameMessageInfo|GetGameMessageInfo]](<span |
+ | : [[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 |
+ | : [[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]]() |
||
: [[API ToggleAnimKitDisplay|ToggleAnimKitDisplay]]() |
: [[API ToggleAnimKitDisplay|ToggleAnimKitDisplay]]() |
||
: [[API ToggleDebugAIDisplay|ToggleDebugAIDisplay]]() |
: [[API ToggleDebugAIDisplay|ToggleDebugAIDisplay]]() |
||
− | : [[API addframetext|addframetext]](<span |
+ | : [[API addframetext|addframetext]](<span class="apiarg">text</span>) |
: [[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 |
+ | : [[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 |
+ | : [[API seterrorhandler|seterrorhandler]](<span class="apiarg">errFunc</span>) - Sets the error handler to the given function. |
+ | : [https://www.townlong-yak.com/framexml/go/DevTools_Dump DevTools_Dump](<span class="apiarg">value [, startKey]</span>) {{apitag|framexml}} - Pretty prints a variable or value. Equivalent to the [[MACRO dump|<code>/dump</code> macro]]. |
||
− | : UI [[API print|print]](<span style="font-size:smaller; color:#ecbc2a">...</span>) - Calls the current print output handler with the provided values; by default printing the values to the default chat frame. |
||
+ | : [[API print|print]](<span class="apiarg">...</span>) {{apitag|framexml}} - Calls the current print output handler with the provided values; by default printing the values to the default chat frame. |
||
− | : UI [[API getprinthandler|getprinthandler]]() - Returns the function currently handling print() output. |
||
− | : |
+ | : [[API getprinthandler|getprinthandler]]() {{apitag|framexml}} - Returns the function currently handling print() output. |
+ | : [[API setprinthandler|setprinthandler]](<span class="apiarg">func</span>) {{apitag|framexml}} - Changes the function handling print() output. |
||
− | : UI [[API message|message]](<span style="font-size:smaller; color:#ecbc2a">text</span>) - Displays a message box with your text message and an "Okay" button. |
||
+ | : [[API message|message]](<span class="apiarg">text</span>) {{apitag|framexml}} - Displays a message box with your text message and an "Okay" button. |
||
− | : PROTECTED [[API C_Debug.DashboardIsEnabled|C_Debug.DashboardIsEnabled]]() |
||
− | : |
+ | : [[API C_Debug.DashboardIsEnabled|C_Debug.DashboardIsEnabled]]() {{apitag|protected}} |
− | : |
+ | : [[API C_Debug.GetAllPortLocsForMap|C_Debug.GetAllPortLocsForMap]](<span class="apiarg">uiMapID</span>) {{apitag|protected}} |
− | : |
+ | : [[API C_Debug.GetMapDebugObjects|C_Debug.GetMapDebugObjects]](<span class="apiarg">uiMapID</span>) {{apitag|protected}} |
− | : |
+ | : [[API C_Debug.TeleportToMapDebugObject|C_Debug.TeleportToMapDebugObject]](<span class="apiarg">pinIndex</span>) {{apitag|protected}} |
+ | : [[API C_Debug.TeleportToMapLocation|C_Debug.TeleportToMapLocation]](<span class="apiarg">uiMapID, mapX, mapY</span>) {{apitag|protected}} |
||
− | === |
+ | ===Graphics=== |
+ | : [[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 AntiAliasingSupported|AntiAliasingSupported]]() |
: [[API AntiAliasingSupported|AntiAliasingSupported]]() |
||
: [[API AutoChooseCurrentGraphicsSetting|AutoChooseCurrentGraphicsSetting]]() |
: [[API AutoChooseCurrentGraphicsSetting|AutoChooseCurrentGraphicsSetting]]() |
||
− | : [[API C_ScriptedAnimations.GetAllScriptedAnimationEffects|C_ScriptedAnimations.GetAllScriptedAnimationEffects]]() |
||
− | : [[API C_VideoOptions.GetGxAdapterInfo|C_VideoOptions.GetGxAdapterInfo]]() - Returns info about the system's graphics adapter. |
||
: [[API GetCurrentGraphicsSetting|GetCurrentGraphicsSetting]]() |
: [[API GetCurrentGraphicsSetting|GetCurrentGraphicsSetting]]() |
||
− | : [[API GetCurrentResolution|GetCurrentResolution]]() - Get the index of the current screen resolution. |
||
: [[API GetCurrentScaledResolution|GetCurrentScaledResolution]]() |
: [[API GetCurrentScaledResolution|GetCurrentScaledResolution]]() |
||
− | : [[API GetCVarSettingValidity|GetCVarSettingValidity]](<span style="font-size:smaller; color:#ecbc2a">cvar, settingsCount [, isRaid]</span>) |
||
− | : [[API GetDefaultGraphicsQuality|GetDefaultGraphicsQuality]]() |
||
− | : [[API GetDefaultVideoOption|GetDefaultVideoOption]]() |
||
− | : [[API GetDefaultVideoOptions|GetDefaultVideoOptions]]() |
||
− | : [[API GetDefaultVideoQualityOption|GetDefaultVideoQualityOption]]() |
||
: [[API GetGraphicsAPIs|GetGraphicsAPIs]]() - Returns the supported graphics APIs for the system, D3D11_LEGACY, D3D11, D3D12, etc. |
: [[API GetGraphicsAPIs|GetGraphicsAPIs]]() - Returns the supported graphics APIs for the system, D3D11_LEGACY, D3D11, D3D12, etc. |
||
− | : [[API GetGraphicsDropdownIndexByMasterIndex|GetGraphicsDropdownIndexByMasterIndex]]() |
||
: [[API GetMaxRenderScale|GetMaxRenderScale]]() |
: [[API GetMaxRenderScale|GetMaxRenderScale]]() |
||
: [[API GetMinRenderScale|GetMinRenderScale]]() |
: [[API GetMinRenderScale|GetMinRenderScale]]() |
||
Line 4,056: | Line 4,774: | ||
: [[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 GetScreenWidth|GetScreenWidth]]() - Returns the width of the window in pixels, affected by UI scale. |
||
− | : [[API GetScreenResolutions|GetScreenResolutions]]() |
||
− | : [[API GetScreenWidth|GetScreenWidth]]() - Returns the width of the window in pixels. |
||
− | : [[API GetToolTipInfo|GetToolTipInfo]](<span style="font-size:smaller; color:#ecbc2a">1, size-1, cvar, validValue1, ...</span>) - Returns validity info for a graphics cvar. |
||
: [[API GetVideoCaps|GetVideoCaps]]() |
: [[API GetVideoCaps|GetVideoCaps]]() |
||
− | : [[API GetVideoOptions|GetVideoOptions]]() |
||
: [[API IsDesaturateSupported|IsDesaturateSupported]]() |
: [[API IsDesaturateSupported|IsDesaturateSupported]]() |
||
: [[API IsOutlineModeSupported|IsOutlineModeSupported]]() |
: [[API IsOutlineModeSupported|IsOutlineModeSupported]]() |
||
: [[API MultiSampleAntiAliasingSupported|MultiSampleAntiAliasingSupported]]() |
: [[API MultiSampleAntiAliasingSupported|MultiSampleAntiAliasingSupported]]() |
||
− | : [[API RestartGx|RestartGx]]() - Restarts the |
+ | : [[API RestartGx|RestartGx]]() - Restarts the graphics engine. |
− | : [[API SetCurrentGraphicsSetting|SetCurrentGraphicsSetting]](<span |
+ | : [[API SetCurrentGraphicsSetting|SetCurrentGraphicsSetting]](<span class="apiarg">setting{0=normal, 1=raid/BG}</span>) |
− | : [[API |
+ | : [[API SetSelectedScreenResolutionIndex|SetSelectedScreenResolutionIndex]](<span class="apiarg">integerIndex</span>) |
− | : [[API SetScreenResolution|SetScreenResolution]](<span style="font-size:smaller; color:#ecbc2a">width, height, fullscreen</span>) |
||
− | : [[API SetSelectedScreenResolutionIndex|SetSelectedScreenResolutionIndex]](<span style="font-size:smaller; color:#ecbc2a">integer index</span>) |
||
: [[API SupportsClipCursor|SupportsClipCursor]]() |
: [[API SupportsClipCursor|SupportsClipCursor]]() |
||
: [[API ToggleSelfHighlight|ToggleSelfHighlight]]() |
: [[API ToggleSelfHighlight|ToggleSelfHighlight]]() |
||
Line 4,075: | Line 4,788: | ||
: [[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=== |
− | : [[API |
+ | : [[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 [[wikipedia:Russian_declension#Nouns|declensions]] for a Russian name. |
||
− | : [[API GetAvailableLocales|GetAvailableLocales]]() |
||
− | : [[API GetAvailableLocaleInfo|GetAvailableLocaleInfo]](<span |
+ | : [[API GetAvailableLocaleInfo|GetAvailableLocaleInfo]](<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 style="font-size:smaller; color:#ecbc2a">name, gender</span>) - Returns the number of suggested declension sets for a German or Russian name. |
||
+ | : [[API GetNumDeclensionSets|GetNumDeclensionSets]](<span 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]]() - |
+ | : [[API GetText|GetText]]() - Returns localized text depending on the specified gender. |
: [[API IsEuropeanNumbers|IsEuropeanNumbers]]() |
: [[API IsEuropeanNumbers|IsEuropeanNumbers]]() |
||
− | : [[API SetEuropeanNumbers|SetEuropeanNumbers]](<span |
+ | : [[API SetEuropeanNumbers|SetEuropeanNumbers]](<span class="apiarg">flag</span>) - 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 [[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 |
+ | : [[API GetAddOnCPUUsage|GetAddOnCPUUsage]](<span class="apiarg">index or name</span>) - Returns the total time used for an addon. |
− | : [[API GetAddOnMemoryUsage|GetAddOnMemoryUsage]](<span |
+ | : [[API GetAddOnMemoryUsage|GetAddOnMemoryUsage]](<span class="apiarg">index or name</span>) - Returns the memory used for an addon. |
− | : [[API |
+ | : [[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 GetFrameCPUUsage|GetFrameCPUUsage]](<span style="font-size:smaller; color:#ecbc2a">frame [, includeChildren]</span>) - Returns the time used and number of function calls of any of the frame's script handlers. If 'includeChildren' is true or omitted, the time and call count will include the handlers for all of the frame's children as well. |
||
− | : [[API GetFunctionCPUUsage|GetFunctionCPUUsage]](<span style="font-size:smaller; color:#ecbc2a">function [, includeSubroutines]</span>) - Returns the time used and number of times the specified function was called. If 'includeSubroutines' is true or omitted, the time includes both the time spent in the function and subroutines called by the function. If it is false, then time is only the time actually spent by the code in the function itself. |
||
− | : [[API GetScriptCPUUsage|GetScriptCPUUsage]]() - Returns the total time used by the scripting system. |
||
: [[API ResetCPUUsage|ResetCPUUsage]]() - Reset all CPU profiling statistics to zero. |
: [[API ResetCPUUsage|ResetCPUUsage]]() - Reset all CPU profiling statistics to zero. |
||
: [[API UpdateAddOnCPUUsage|UpdateAddOnCPUUsage]]() - Scan through the profiling data and update the per-addon statistics. |
: [[API UpdateAddOnCPUUsage|UpdateAddOnCPUUsage]]() - Scan through the profiling data and update the per-addon statistics. |
||
: [[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=== |
− | + | Relates to [[Secure Execution and Tainting]]. |
|
− | : [[API |
+ | : [[API forceinsecure|forceinsecure]]() - Taints the current execution path. |
+ | : [[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 StoreSecureReference|StoreSecureReference]](<span style="font-size:smaller; color:#ecbc2a">name, obj</span>) |
||
− | : [[API |
+ | : [[API InCombatLockdown|InCombatLockdown]]() - Returns true if the combat lockdown restrictions are active. |
+ | : [[API issecure|issecure]]() - Returns true if the current execution path is secure. |
||
− | : [[API hooksecurefunc|hooksecurefunc]](<span style="font-size:smaller; color:#ecbc2a">[table,] functionName, hookfunc</span>) - Creates a secure 'post hook' for the named function. The hookfunc is invoked after the original function, and receives the same parameters. Return values from hookfunc are discarded. This is the only safe way to hook functions that execute protected functionality. |
||
− | : [[API |
+ | : [[API issecurevariable|issecurevariable]](<span class="apiarg">[table,] name</span>) - Returns true if the specified variable is secure. |
− | : [[API |
+ | : [[API scrub|scrub]](<span class="apiarg">...</span>) - Returns the argument list with non-number/boolean/string values changed to nil. |
− | : [[API |
+ | : [[API securecall|securecall]](<span class="apiarg">function or functionName, ...</span>) - Calls the specified function without propagating taint to the caller. |
+ | : [[API securecallfunction|securecallfunction]]() |
||
− | : [[API securecall|securecall]](<span style="font-size:smaller; color:#ecbc2a">function or functionName, ...</span>) - Call a function from a secure environment without risking secure status. |
||
+ | : [[API secureexecuterange|secureexecuterange]]() |
||
− | : UI [https://www.townlong-yak.com/framexml/go/CanAccessObject CanAccessObject](<span style="font-size:smaller; color:#ecbc2a">obj</span>) - Returns true if an object is secure and not forbidden. |
||
+ | : [[API StoreSecureReference|StoreSecureReference]](<span class="apiarg">name, obj</span>) |
||
+ | : [https://www.townlong-yak.com/framexml/go/CanAccessObject CanAccessObject](<span class="apiarg">obj</span>) {{apitag|framexml}} - Returns true if an object is secure and not forbidden. |
||
− | === |
+ | ===Sound=== |
− | : [[API MuteSoundFile|MuteSoundFile]](<span |
+ | : [[API MuteSoundFile|MuteSoundFile]](<span class="apiarg">soundFile or fileDataID</span>) - Mutes a sound file. |
− | : [[API PlayMusic|PlayMusic]](<span |
+ | : [[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 |
+ | : [[API PlaySound|PlaySound]](<span class="apiarg">soundKitID [, channel, forceNoDuplicates, runFinishCallback]</span>) - Plays the specified sound by SoundKitID. |
− | : [[API PlaySoundFile|PlaySoundFile]](<span |
+ | : [[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 |
+ | : [[API PlayVocalErrorSoundID|PlayVocalErrorSoundID]](<span class="apiarg">vocalErrorSoundID</span>) |
: [[API StopMusic|StopMusic]]() - Stops the currently playing music. |
: [[API StopMusic|StopMusic]]() - Stops the currently playing music. |
||
− | : [[API StopSound|StopSound]](<span |
+ | : [[API StopSound|StopSound]](<span class="apiarg">soundHandleID [, fadeoutTime]</span>) |
− | : [[API UnmuteSoundFile|UnmuteSoundFile]](<span |
+ | : [[API UnmuteSoundFile|UnmuteSoundFile]](<span class="apiarg">soundFile or fileDataID</span>) - Unmutes a sound file. |
Sound Drivers |
Sound Drivers |
||
− | : [[API Sound_ChatSystem_GetInputDriverNameByIndex|Sound_ChatSystem_GetInputDriverNameByIndex]](<span |
+ | : [[API Sound_ChatSystem_GetInputDriverNameByIndex|Sound_ChatSystem_GetInputDriverNameByIndex]](<span class="apiarg">InputDriverIndex</span>) |
: [[API Sound_ChatSystem_GetNumInputDrivers|Sound_ChatSystem_GetNumInputDrivers]]() |
: [[API Sound_ChatSystem_GetNumInputDrivers|Sound_ChatSystem_GetNumInputDrivers]]() |
||
: [[API Sound_ChatSystem_GetNumOutputDrivers|Sound_ChatSystem_GetNumOutputDrivers]]() |
: [[API Sound_ChatSystem_GetNumOutputDrivers|Sound_ChatSystem_GetNumOutputDrivers]]() |
||
− | : [[API Sound_ChatSystem_GetOutputDriverNameByIndex|Sound_ChatSystem_GetOutputDriverNameByIndex]](<span |
+ | : [[API Sound_ChatSystem_GetOutputDriverNameByIndex|Sound_ChatSystem_GetOutputDriverNameByIndex]](<span class="apiarg">OutputDriverIndex</span>) |
− | : [[API Sound_GameSystem_GetInputDriverNameByIndex|Sound_GameSystem_GetInputDriverNameByIndex]](<span |
+ | : [[API Sound_GameSystem_GetInputDriverNameByIndex|Sound_GameSystem_GetInputDriverNameByIndex]](<span class="apiarg">InputDriverIndex</span>) |
: [[API Sound_GameSystem_GetNumInputDrivers|Sound_GameSystem_GetNumInputDrivers]]() |
: [[API Sound_GameSystem_GetNumInputDrivers|Sound_GameSystem_GetNumInputDrivers]]() |
||
: [[API Sound_GameSystem_GetNumOutputDrivers|Sound_GameSystem_GetNumOutputDrivers]]() |
: [[API Sound_GameSystem_GetNumOutputDrivers|Sound_GameSystem_GetNumOutputDrivers]]() |
||
− | : [[API Sound_GameSystem_GetOutputDriverNameByIndex|Sound_GameSystem_GetOutputDriverNameByIndex]](<span |
+ | : [[API Sound_GameSystem_GetOutputDriverNameByIndex|Sound_GameSystem_GetOutputDriverNameByIndex]](<span class="apiarg">OutputDriverIndex</span>) |
: [[API Sound_GameSystem_RestartSoundSystem|Sound_GameSystem_RestartSoundSystem]]() |
: [[API Sound_GameSystem_RestartSoundSystem|Sound_GameSystem_RestartSoundSystem]]() |
||
− | === |
+ | ===Util=== |
+ | : [[API CalculateStringEditDistance|CalculateStringEditDistance]](<span class="apiarg">firstString, secondString</span>) - Returns [https://en.wikipedia.org/wiki/Levenshtein_distance Levenshtein] distance. |
||
− | These functions were added in [[Patch 7.0.3]]. |
||
+ | : [[API CaseAccentInsensitiveParse|CaseAccentInsensitiveParse]](<span class="apiarg">string</span>) - Converts a string with accented letters to lowercase. |
||
− | : [[API C_TalkingHead.GetConversationsDeferred|C_TalkingHead.GetConversationsDeferred]]() |
||
− | : [[API C_TalkingHead.GetCurrentLineAnimationInfo|C_TalkingHead.GetCurrentLineAnimationInfo]]() |
||
− | : [[API C_TalkingHead.GetCurrentLineInfo|C_TalkingHead.GetCurrentLineInfo]]() |
||
− | : [[API C_TalkingHead.IgnoreCurrentTalkingHead|C_TalkingHead.IgnoreCurrentTalkingHead]]() |
||
− | : [[API C_TalkingHead.IsCurrentTalkingHeadIgnored|C_TalkingHead.IsCurrentTalkingHeadIgnored]]() |
||
− | : [[API C_TalkingHead.SetConversationsDeferred|C_TalkingHead.SetConversationsDeferred]](<span style="font-size:smaller; color:#ecbc2a">deferred</span>) |
||
− | == |
+ | ==Spectator Mode== |
+ | : [[API C_Commentator.AddPlayerOverrideName|C_Commentator.AddPlayerOverrideName]](<span class="apiarg">playerName, overrideName</span>) |
||
− | These functions relate to [[Trade|Trading]]. |
||
+ | : [[API C_Commentator.AddTrackedDefensiveAuras|C_Commentator.AddTrackedDefensiveAuras]](<span class="apiarg">spellIDs</span>) |
||
− | : HW [[API AcceptTrade|AcceptTrade]]() - A pending trade will be accepted. |
||
+ | : [[API C_Commentator.AddTrackedOffensiveAuras|C_Commentator.AddTrackedOffensiveAuras]](<span class="apiarg">spellIDs</span>) |
||
− | : [[API AddTradeMoney|AddTradeMoney]]() - Adds the money dropped into the player's trade frame. |
||
+ | : [[API C_Commentator.AreTeamsSwapped|C_Commentator.AreTeamsSwapped]]() : <span class="apiret">teamsAreSwapped</span> |
||
− | : [[API BeginTrade|BeginTrade]]() |
||
+ | : [[API C_Commentator.AssignPlayersToTeam|C_Commentator.AssignPlayersToTeam]](<span class="apiarg">playerName, teamName</span>) |
||
− | : [[API CancelTrade|CancelTrade]]() - Declines the offer to trade with the other player. |
||
+ | : [[API C_Commentator.AssignPlayersToTeamInCurrentInstance|C_Commentator.AssignPlayersToTeamInCurrentInstance]](<span class="apiarg">teamIndex, teamName</span>) |
||
− | : [[API CancelTradeAccept|CancelTradeAccept]]() - Cancels the trade attempt which required an accept. |
||
+ | : [[API C_Commentator.AssignPlayerToTeam|C_Commentator.AssignPlayerToTeam]](<span class="apiarg">playerName, teamName</span>) |
||
− | : [[API ClickTargetTradeButton|ClickTargetTradeButton]](<span style="font-size:smaller; color:#ecbc2a">index</span>) |
||
+ | : [[API C_Commentator.CanUseCommentatorCheats|C_Commentator.CanUseCommentatorCheats]]() : <span class="apiret">canUseCommentatorCheats</span> |
||
− | : [[API ClickTradeButton|ClickTradeButton]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Equivalent of a mouseclick on the trade window buttons [1-7]. |
||
+ | : [[API C_Commentator.ClearCameraTarget|C_Commentator.ClearCameraTarget]]() |
||
− | : [[API CloseTrade|CloseTrade]]() - Closes the trade. |
||
+ | : [[API C_Commentator.ClearFollowTarget|C_Commentator.ClearFollowTarget]]() |
||
− | : [[API GetPlayerTradeMoney|GetPlayerTradeMoney]]() - Returns the amount of money the player has in the trade window. |
||
+ | : [[API C_Commentator.ClearLookAtTarget|C_Commentator.ClearLookAtTarget]](<span class="apiarg">[lookAtIndex]</span>) |
||
− | : [[API GetTargetTradeMoney|GetTargetTradeMoney]]() - Returns the amount of money in the trade frame of the target player. |
||
+ | : [[API C_Commentator.EnterInstance|C_Commentator.EnterInstance]]() |
||
− | : [[API GetTradePlayerItemInfo|GetTradePlayerItemInfo]](<span style="font-size:smaller; color:#ecbc2a">id</span>) - Returns information about a trade item. |
||
+ | : [[API C_Commentator.ExitInstance|C_Commentator.ExitInstance]]() |
||
− | : [[API GetTradePlayerItemLink|GetTradePlayerItemLink]](<span style="font-size:smaller; color:#ecbc2a">id</span>) - Returns an [[itemLink]] for the given item in your side of the trade window (if open) |
||
+ | : [[API C_Commentator.FindSpectatedUnit|C_Commentator.FindSpectatedUnit]](<span class="apiarg">unitToken</span>) : <span class="apiret">playerIndex, teamIndex, isPet</span> |
||
− | : [[API GetTradeTargetItemInfo|GetTradeTargetItemInfo]](<span style="font-size:smaller; color:#ecbc2a">id</span>) - Returns information about a trade item. |
||
+ | : [[API C_Commentator.FindTeamNameInCurrentInstance|C_Commentator.FindTeamNameInCurrentInstance]](<span class="apiarg">teamIndex</span>) : <span class="apiret">teamName</span> |
||
− | : [[API GetTradeTargetItemLink|GetTradeTargetItemLink]](<span style="font-size:smaller; color:#ecbc2a">id</span>) - Returns an [[itemLink]] for the given item in the other player's side of the trade window (if open) |
||
+ | : [[API C_Commentator.FindTeamNameInDirectory|C_Commentator.FindTeamNameInDirectory]](<span class="apiarg">playerNames</span>) : <span class="apiret">teamName</span> |
||
− | : [[API InitiateTrade|InitiateTrade]](<span style="font-size:smaller; color:#ecbc2a">UnitId</span>) - Asks the specified unit to trade. |
||
+ | : [[API C_Commentator.FlushCommentatorHistory|C_Commentator.FlushCommentatorHistory]]() |
||
− | : [[API SetTradeMoney|SetTradeMoney]](<span style="font-size:smaller; color:#ecbc2a">copper</span>) - Sets the amount of money offered as part of the player's trade offer. |
||
+ | : [[API C_Commentator.FollowPlayer|C_Commentator.FollowPlayer]](<span class="apiarg">factionIndex, playerIndex [, forceInstantTransition]</span>) |
||
− | |||
+ | : [[API C_Commentator.FollowUnit|C_Commentator.FollowUnit]](<span class="apiarg">token</span>) |
||
− | === Trainer === |
||
+ | : [[API C_Commentator.ForceFollowTransition|C_Commentator.ForceFollowTransition]]() |
||
− | These functions relate to [[Trainer]]s. |
||
+ | : [[API C_Commentator.GetAdditionalCameraWeight|C_Commentator.GetAdditionalCameraWeight]]() : <span class="apiret">teamIndex, playerIndex</span> |
||
− | : [[API BuyTrainerService|BuyTrainerService]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Used for buying new/upgrading professions, profession items and class skills. |
||
+ | : [[API C_Commentator.GetAdditionalCameraWeightByToken|C_Commentator.GetAdditionalCameraWeightByToken]](<span class="apiarg">unitToken</span>) : <span class="apiret">weight</span> |
||
− | : [[API CloseTrainer|CloseTrainer]]() - Closes the trainer window. |
||
+ | : [[API C_Commentator.GetAllPlayerOverrideNames|C_Commentator.GetAllPlayerOverrideNames]]() : <span class="apiret">nameEntries</span> |
||
− | : [[API GetNumTrainerServices|GetNumTrainerServices]]() - Get the number of the trainer services. |
||
+ | : [[API C_Commentator.GetCamera|C_Commentator.GetCamera]]() : <span class="apiret">xPos, yPos, zPos, yaw, pitch, roll, fov</span> |
||
− | : [[API GetTrainerGreetingText|GetTrainerGreetingText]]() - Get the trainer's greeting text. |
||
+ | : [[API C_Commentator.GetCameraCollision|C_Commentator.GetCameraCollision]]() : <span class="apiret">isColliding</span> |
||
− | : [[API GetTrainerSelectionIndex|GetTrainerSelectionIndex]]() - Get the index of the selected trainer service. |
||
+ | : [[API C_Commentator.GetCameraPosition|C_Commentator.GetCameraPosition]]() : <span class="apiret">xPos, yPos, zPos</span> |
||
− | : [[API GetTrainerServiceAbilityReq|GetTrainerServiceAbilityReq]](<span style="font-size:smaller; color:#ecbc2a">trainerIndex, reqIndex</span>) - Used for displaying the requirements to learn a new profession, profession skill or class skill. |
||
+ | : [[API C_Commentator.GetCommentatorHistory|C_Commentator.GetCommentatorHistory]]() : <span class="apiret">history</span> |
||
− | : [[API GetTrainerServiceCost|GetTrainerServiceCost]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Returns the cost of a specific trainer service. |
||
+ | : [[API C_Commentator.GetCurrentMapID|C_Commentator.GetCurrentMapID]]() : <span class="apiret">mapID</span> |
||
− | : [[API GetTrainerServiceDescription|GetTrainerServiceDescription]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Returns the description of a specific trainer service. |
||
+ | : [[API C_Commentator.GetDampeningPercent|C_Commentator.GetDampeningPercent]]() : <span class="apiret">percentage</span> |
||
− | : [[API GetTrainerServiceIcon|GetTrainerServiceIcon]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Returns icon texture for a trainer service. |
||
+ | : [[API C_Commentator.GetDistanceBeforeForcedHorizontalConvergence|C_Commentator.GetDistanceBeforeForcedHorizontalConvergence]]() : <span class="apiret">distance</span> |
||
− | : [[API GetTrainerServiceInfo|GetTrainerServiceInfo]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Returns information about a trainer service. |
||
+ | : [[API C_Commentator.GetDurationToForceHorizontalConvergence|C_Commentator.GetDurationToForceHorizontalConvergence]]() : <span class="apiret">ms</span> |
||
− | : [[API GetTrainerServiceItemLink|GetTrainerServiceItemLink]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Returns an item link for a trainer service. |
||
+ | : [[API C_Commentator.GetExcludeDistance|C_Commentator.GetExcludeDistance]]() : <span class="apiret">excludeDistance</span> |
||
− | : [[API GetTrainerServiceLevelReq|GetTrainerServiceLevelReq]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Get the required level to learn the skill. |
||
+ | : [[API C_Commentator.GetHardlockWeight|C_Commentator.GetHardlockWeight]]() : <span class="apiret">weight</span> |
||
− | : [[API GetTrainerServiceNumAbilityReq|GetTrainerServiceNumAbilityReq]]() - Get the maximum number of requirements that [[API GetTrainerServiceAbilityReq|GetTrainerServiceAbilityReq]] has. |
||
+ | : [[API C_Commentator.GetHorizontalAngleThresholdToSmooth|C_Commentator.GetHorizontalAngleThresholdToSmooth]]() : <span class="apiret">angle</span> |
||
− | : [[API GetTrainerServiceSkillLine|GetTrainerServiceSkillLine]](<span style="font-size:smaller; color:#ecbc2a">index</span>) |
||
+ | : [[API C_Commentator.GetIndirectSpellID|C_Commentator.GetIndirectSpellID]](<span class="apiarg">trackedSpellID</span>) : <span class="apiret">indirectSpellID</span> |
||
− | : [[API GetTrainerServiceSkillReq|GetTrainerServiceSkillReq]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Returns a String and Variable for the requirements of a specific trainer service. |
||
+ | : [[API C_Commentator.GetInstanceInfo|C_Commentator.GetInstanceInfo]](<span class="apiarg">mapIndex, instanceIndex</span>) : <span class="apiret">mapID, mapName, status, instanceIDLow, instanceIDHigh</span> |
||
− | : [[API GetTrainerServiceStepIndex|GetTrainerServiceStepIndex]]() |
||
+ | : [[API C_Commentator.GetLookAtLerpAmount|C_Commentator.GetLookAtLerpAmount]]() : <span class="apiret">amount</span> |
||
− | : [[API GetTrainerServiceTypeFilter|GetTrainerServiceTypeFilter]](<span style="font-size:smaller; color:#ecbc2a">filter</span>) - Returns the status of a skill filter in the trainer window. |
||
+ | : [[API C_Commentator.GetMapInfo|C_Commentator.GetMapInfo]](<span class="apiarg">mapIndex</span>) : <span class="apiret">teamSize, minLevel, maxLevel, numInstances</span> |
||
− | : [[API GetTrainerTradeskillRankValues|GetTrainerTradeskillRankValues]]() |
||
+ | : [[API C_Commentator.GetMatchDuration|C_Commentator.GetMatchDuration]]() : <span class="apiret">seconds</span> |
||
− | : [[API IsTradeskillTrainer|IsTradeskillTrainer]]() - Returns 1 if trainer is for a tradeskill. |
||
+ | : [[API C_Commentator.GetMaxNumPlayersPerTeam|C_Commentator.GetMaxNumPlayersPerTeam]]() : <span class="apiret">maxNumPlayersPerTeam</span> |
||
− | : [[API OpenTrainer|OpenTrainer]]() |
||
+ | : [[API C_Commentator.GetMaxNumTeams|C_Commentator.GetMaxNumTeams]]() : <span class="apiret">maxNumTeams</span> |
||
− | : [[API SelectTrainerService|SelectTrainerService]]() |
||
+ | : [[API C_Commentator.GetMode|C_Commentator.GetMode]]() : <span class="apiret">commentatorMode</span> |
||
− | : [[API SetTrainerServiceTypeFilter|SetTrainerServiceTypeFilter]](<span style="font-size:smaller; color:#ecbc2a">filter, state</span>) - Sets the status of a skill filter in the trainer window. |
||
+ | : [[API C_Commentator.GetMsToHoldForHorizontalMovement|C_Commentator.GetMsToHoldForHorizontalMovement]]() : <span class="apiret">ms</span> |
||
− | |||
+ | : [[API C_Commentator.GetMsToHoldForVerticalMovement|C_Commentator.GetMsToHoldForVerticalMovement]]() : <span class="apiret">ms</span> |
||
− | === Transmogrification === |
||
+ | : [[API C_Commentator.GetMsToSmoothHorizontalChange|C_Commentator.GetMsToSmoothHorizontalChange]]() : <span class="apiret">ms</span> |
||
− | [[Transmogrification]] was added in [[Patch 4.3.0]]. See also [[#Appearances|Appearances]] functions. |
||
+ | : [[API C_Commentator.GetMsToSmoothVerticalChange|C_Commentator.GetMsToSmoothVerticalChange]]() : <span class="apiret">ms</span> |
||
− | : [[API C_Transmog.ApplyAllPending|C_Transmog.ApplyAllPending]]() - Applies all pending transmogrifications, and pays for the cost. |
||
+ | : [[API C_Commentator.GetNumMaps|C_Commentator.GetNumMaps]]() : <span class="apiret">numMaps</span> |
||
− | : [[API C_Transmog.CanTransmogItemWithItem|C_Transmog.CanTransmogItemWithItem]](<span style="font-size:smaller; color:#ecbc2a">targetItemLink, sourceItemLink</span>) - Returns whether an item can be transmogrified to look like another item. |
||
+ | : [[API C_Commentator.GetNumPlayers|C_Commentator.GetNumPlayers]](<span class="apiarg">factionIndex</span>) : <span class="apiret">numPlayers</span> |
||
− | : [[API C_Transmog.ClearAllPending|C_Transmog.ClearAllPending]]() |
||
+ | : [[API C_Commentator.GetOrCreateSeries|C_Commentator.GetOrCreateSeries]](<span class="apiarg">teamName1, teamName2</span>) : <span class="apiret">data</span> |
||
− | : [[API C_Transmog.ClearPending|C_Transmog.ClearPending]](<span style="font-size:smaller; color:#ecbc2a">[slotId, transmogType]</span>) - Clears the specified transmogrify slot. |
||
+ | : [[API C_Commentator.GetPlayerAuraInfo|C_Commentator.GetPlayerAuraInfo]](<span class="apiarg">teamIndex, playerIndex, spellID</span>) : <span class="apiret">startTime, duration, enable</span> |
||
− | : [[API C_Transmog.Close|C_Transmog.Close]]() |
||
+ | : [[API C_Commentator.GetPlayerAuraInfoByUnit|C_Commentator.GetPlayerAuraInfoByUnit]](<span class="apiarg">token, spellID</span>) : <span class="apiret">startTime, duration, enable</span> |
||
− | : [[API C_Transmog.GetApplyWarnings|C_Transmog.GetApplyWarnings]]() |
||
+ | : [[API C_Commentator.GetPlayerCooldownInfo|C_Commentator.GetPlayerCooldownInfo]](<span class="apiarg">teamIndex, playerIndex, spellID</span>) : <span class="apiret">startTime, duration, enable</span> |
||
− | : [[API C_Transmog.GetBaseCategory|C_Transmog.GetBaseCategory]](<span style="font-size:smaller; color:#ecbc2a">transmogID</span>) |
||
+ | : [[API C_Commentator.GetPlayerCooldownInfoByUnit|C_Commentator.GetPlayerCooldownInfoByUnit]](<span class="apiarg">unitToken, spellID</span>) : <span class="apiret">startTime, duration, enable</span> |
||
− | : [[API C_Transmog.GetCost|C_Transmog.GetCost]]() |
||
+ | : [[API C_Commentator.GetPlayerCrowdControlInfo|C_Commentator.GetPlayerCrowdControlInfo]](<span class="apiarg">teamIndex, playerIndex</span>) : <span class="apiret">spellID, expiration, duration</span> |
||
− | : [[API C_Transmog.GetCreatureDisplayIDForSource|C_Transmog.GetCreatureDisplayIDForSource]](<span style="font-size:smaller; color:#ecbc2a">itemModifiedAppearanceID</span>) |
||
+ | : [[API C_Commentator.GetPlayerCrowdControlInfoByUnit|C_Commentator.GetPlayerCrowdControlInfoByUnit]](<span class="apiarg">token</span>) : <span class="apiret">spellID, expiration, duration</span> |
||
− | : [[API C_Transmog.GetItemIDForSource|C_Transmog.GetItemIDForSource]](<span style="font-size:smaller; color:#ecbc2a">itemModifiedAppearanceID</span>) |
||
+ | : [[API C_Commentator.GetPlayerData|C_Commentator.GetPlayerData]](<span class="apiarg">teamIndex, playerIndex</span>) : <span class="apiret">info</span> |
||
− | : [[API C_Transmog.GetItemInfo|C_Transmog.GetItemInfo]](<span style="font-size:smaller; color:#ecbc2a">item</span>) - Returns how an item can interact with transmogrification. |
||
+ | : [[API C_Commentator.GetPlayerFlagInfo|C_Commentator.GetPlayerFlagInfo]](<span class="apiarg">teamIndex, playerIndex</span>) : <span class="apiret">hasFlag</span> |
||
− | : [[API C_Transmog.GetSlotForInventoryType|C_Transmog.GetSlotForInventoryType]](<span style="font-size:smaller; color:#ecbc2a">inventoryType</span>) - Returns the equipment slot for an inventory type. |
||
+ | : [[API C_Commentator.GetPlayerFlagInfoByUnit|C_Commentator.GetPlayerFlagInfoByUnit]](<span class="apiarg">unitToken</span>) : <span class="apiret">hasFlag</span> |
||
− | : [[API C_Transmog.GetSlotInfo|C_Transmog.GetSlotInfo]](<span style="font-size:smaller; color:#ecbc2a">slot, type</span>) |
||
+ | : [[API C_Commentator.GetPlayerOverrideName|C_Commentator.GetPlayerOverrideName]](<span class="apiarg">originalName</span>) : <span class="apiret">overrideName</span> |
||
− | : [[API C_Transmog.GetSlotUseError|C_Transmog.GetSlotUseError]](<span style="font-size:smaller; color:#ecbc2a">slot, type</span>) |
||
+ | : [[API C_Commentator.GetPlayerSpellCharges|C_Commentator.GetPlayerSpellCharges]](<span class="apiarg">teamIndex, playerIndex, spellID</span>) : <span class="apiret">charges, maxCharges, startTime, duration</span> |
||
− | : [[API C_Transmog.GetSlotVisualInfo|C_Transmog.GetSlotVisualInfo]](<span style="font-size:smaller; color:#ecbc2a">slot, type</span>) |
||
+ | : [[API C_Commentator.GetPlayerSpellChargesByUnit|C_Commentator.GetPlayerSpellChargesByUnit]](<span class="apiarg">unitToken, spellID</span>) : <span class="apiret">charges, maxCharges, startTime, duration</span> |
||
− | : [[API C_Transmog.LoadOutfit|C_Transmog.LoadOutfit]](<span style="font-size:smaller; color:#ecbc2a">outfitID</span>) |
||
+ | : [[API C_Commentator.GetPositionLerpAmount|C_Commentator.GetPositionLerpAmount]]() : <span class="apiret">amount</span> |
||
− | : [[API C_Transmog.LoadSources|C_Transmog.LoadSources]](<span style="font-size:smaller; color:#ecbc2a">sourceIDTable [, mainHandEnchant, offHandEnchant]</span>) |
||
+ | : [[API C_Commentator.GetSmoothFollowTransitioning|C_Commentator.GetSmoothFollowTransitioning]]() : <span class="apiret">enabled</span> |
||
− | : [[API C_Transmog.SetPending|C_Transmog.SetPending]](<span style="font-size:smaller; color:#ecbc2a">slot, type, sourceID</span>) |
||
+ | : [[API C_Commentator.GetSoftlockWeight|C_Commentator.GetSoftlockWeight]]() : <span class="apiret">weight</span> |
||
− | : [[API C_Transmog.ValidateAllPending|C_Transmog.ValidateAllPending]]() |
||
+ | : [[API C_Commentator.GetSpeedFactor|C_Commentator.GetSpeedFactor]]() : <span class="apiret">factor</span> |
||
− | |||
+ | : [[API C_Commentator.GetStartLocation|C_Commentator.GetStartLocation]](<span class="apiarg">mapID</span>) : <span class="apiret">pos</span> |
||
− | ===== Void Storage ===== |
||
+ | : [[API C_Commentator.GetTeamColor|C_Commentator.GetTeamColor]](<span class="apiarg">teamIndex</span>) : <span class="apiret">color</span> |
||
− | [[Void Storage]] was added in [[Patch 4.3.0]]. |
||
+ | : [[API C_Commentator.GetTeamColorByUnit|C_Commentator.GetTeamColorByUnit]](<span class="apiarg">unitToken</span>) : <span class="apiret">color</span> |
||
− | : [[API CanUseVoidStorage|CanUseVoidStorage]]() - Returns if the player has access to the Void Storage. |
||
+ | : [[API C_Commentator.GetTimeLeftInMatch|C_Commentator.GetTimeLeftInMatch]]() : <span class="apiret">timeLeft</span> |
||
− | : [[API ClearVoidTransferDepositSlot|ClearVoidTransferDepositSlot]](<span style="font-size:smaller; color:#ecbc2a">slotIndex</span>) - Clears the specified Void Transfer deposit slot. |
||
+ | : [[API C_Commentator.GetTrackedSpellID|C_Commentator.GetTrackedSpellID]](<span class="apiarg">indirectSpellID</span>) : <span class="apiret">trackedSpellID</span> |
||
− | : [[API ClickVoidStorageSlot|ClickVoidStorageSlot]](<span style="font-size:smaller; color:#ecbc2a">slotIndex [, isRightClick]</span>) - Clicks the specified Void Storage slot. |
||
+ | : [[API C_Commentator.GetTrackedSpells|C_Commentator.GetTrackedSpells]](<span class="apiarg">teamIndex, playerIndex, category</span>) : <span class="apiret">spells</span> |
||
− | : [[API ClickVoidTransferDepositSlot|ClickVoidTransferDepositSlot]](<span style="font-size:smaller; color:#ecbc2a">slotIndex [, isRightClick]</span>) - Clicks the specified Void Transfer deposit slot. |
||
+ | : [[API C_Commentator.GetTrackedSpellsByUnit|C_Commentator.GetTrackedSpellsByUnit]](<span class="apiarg">unitToken, category</span>) : <span class="apiret">spells</span> |
||
− | : [[API ClickVoidTransferWithdrawalSlot|ClickVoidTransferWithdrawalSlot]](<span style="font-size:smaller; color:#ecbc2a">slotIndex [, isRightClick]</span>) - Clicks the specified Void Transfer withdrawal slot. |
||
+ | : [[API C_Commentator.GetUnitData|C_Commentator.GetUnitData]](<span class="apiarg">unitToken</span>) : <span class="apiret">data</span> |
||
− | : [[API CloseVoidStorageFrame|CloseVoidStorageFrame]]() |
||
+ | : [[API C_Commentator.GetWargameInfo|C_Commentator.GetWargameInfo]](<span class="apiarg">listID</span>) : <span class="apiret">name, minPlayers, maxPlayers, isArena</span> |
||
− | : [[API ExecuteVoidTransfer|ExecuteVoidTransfer]]() - Applies all pending void transfers (and pays for the cost of any deposited items). |
||
+ | : [[API C_Commentator.HasTrackedAuras|C_Commentator.HasTrackedAuras]](<span class="apiarg">token</span>) : <span class="apiret">hasOffensiveAura, hasDefensiveAura</span> |
||
− | : [[API GetNumVoidTransferDeposit|GetNumVoidTransferDeposit]]() - Returns the number of items being deposited into the Void Storage. |
||
+ | : [[API C_Commentator.IsSmartCameraLocked|C_Commentator.IsSmartCameraLocked]]() : <span class="apiret">isSmartCameraLocked</span> |
||
− | : [[API GetNumVoidTransferWithdrawal|GetNumVoidTransferWithdrawal]]() - Returns the number of items being withdrawed from the Void Storage. |
||
+ | : [[API C_Commentator.IsSpectating|C_Commentator.IsSpectating]]() : <span class="apiret">isSpectating</span> |
||
− | : [[API GetVoidItemHyperlinkString|GetVoidItemHyperlinkString]](<span style="font-size:smaller; color:#ecbc2a">slotIndex</span>) - Returns the item link of an item in void storage. |
||
+ | : [[API C_Commentator.IsTrackedDefensiveAura|C_Commentator.IsTrackedDefensiveAura]](<span class="apiarg">spellID</span>) : <span class="apiret">isDefensiveTrigger</span> |
||
− | : [[API GetVoidItemInfo|GetVoidItemInfo]](<span style="font-size:smaller; color:#ecbc2a">slotIndex</span>) - Returns <code>itemID, textureName, locked, recentDeposit, isFiltered</code>. |
||
+ | : [[API C_Commentator.IsTrackedOffensiveAura|C_Commentator.IsTrackedOffensiveAura]](<span class="apiarg">spellID</span>) : <span class="apiret">isOffensiveTrigger</span> |
||
− | : [[API GetVoidTransferCost|GetVoidTransferCost]]() - Returns the total Void Transfer cost. |
||
+ | : [[API C_Commentator.IsTrackedSpell|C_Commentator.IsTrackedSpell]](<span class="apiarg">teamIndex, playerIndex, spellID, category</span>) : <span class="apiret">isTracked</span> |
||
− | : [[API GetVoidTransferDepositInfo|GetVoidTransferDepositInfo]](<span style="font-size:smaller; color:#ecbc2a">slotIndex</span>) - Returns <code>itemID, textureName</code>. |
||
+ | : [[API C_Commentator.IsTrackedSpellByUnit|C_Commentator.IsTrackedSpellByUnit]](<span class="apiarg">unitToken, spellID, category</span>) : <span class="apiret">isTracked</span> |
||
− | : [[API GetVoidTransferWithdrawalInfo|GetVoidTransferWithdrawalInfo]](<span style="font-size:smaller; color:#ecbc2a">slotIndex</span>) - Returns <code>itemID, textureName</code>. |
||
+ | : [[API C_Commentator.IsUsingSmartCamera|C_Commentator.IsUsingSmartCamera]]() : <span class="apiret">isUsingSmartCamera</span> |
||
− | : [[API IsVoidStorageReady|IsVoidStorageReady]]() |
||
+ | : [[API C_Commentator.LookAtPlayer|C_Commentator.LookAtPlayer]](<span class="apiarg">factionIndex, playerIndex [, lookAtIndex]</span>) |
||
− | : [[API UnlockVoidStorage|UnlockVoidStorage]]() - Pays for and activates the Void Storage. |
||
+ | : [[API C_Commentator.RemoveAllOverrideNames|C_Commentator.RemoveAllOverrideNames]]() |
||
− | : [[API GetVoidStorageSlotPageIndex|GetVoidStorageSlotPageIndex]](<span style="font-size:smaller; color:#ecbc2a">slot</span>) |
||
+ | : [[API C_Commentator.RemovePlayerOverrideName|C_Commentator.RemovePlayerOverrideName]](<span class="apiarg">originalPlayerName</span>) |
||
− | : [[API GetVoidUnlockCost|GetVoidUnlockCost]]() |
||
+ | : [[API C_Commentator.RequestPlayerCooldownInfo|C_Commentator.RequestPlayerCooldownInfo]](<span class="apiarg">teamIndex, playerIndex</span>) |
||
+ | : [[API C_Commentator.ResetFoVTarget|C_Commentator.ResetFoVTarget]]() |
||
+ | : [[API C_Commentator.ResetSeriesScores|C_Commentator.ResetSeriesScores]](<span class="apiarg">teamName1, teamName2</span>) |
||
+ | : [[API C_Commentator.ResetSettings|C_Commentator.ResetSettings]]() |
||
+ | : [[API C_Commentator.ResetTrackedAuras|C_Commentator.ResetTrackedAuras]]() |
||
+ | : [[API C_Commentator.SetAdditionalCameraWeight|C_Commentator.SetAdditionalCameraWeight]](<span class="apiarg">teamIndex, playerIndex, weight</span>) |
||
+ | : [[API C_Commentator.SetAdditionalCameraWeightByToken|C_Commentator.SetAdditionalCameraWeightByToken]](<span class="apiarg">unitToken, weight</span>) |
||
+ | : [[API C_Commentator.SetBlocklistedAuras|C_Commentator.SetBlocklistedAuras]](<span class="apiarg">spellIDs</span>) |
||
+ | : [[API C_Commentator.SetBlocklistedCooldowns|C_Commentator.SetBlocklistedCooldowns]](<span class="apiarg">specID, spellIDs</span>) |
||
+ | : [[API C_Commentator.SetCamera|C_Commentator.SetCamera]](<span class="apiarg">xPos, yPos, zPos, yaw, pitch, roll, fov</span>) |
||
+ | : [[API C_Commentator.SetCameraCollision|C_Commentator.SetCameraCollision]](<span class="apiarg">collide</span>) |
||
+ | : [[API C_Commentator.SetCameraPosition|C_Commentator.SetCameraPosition]](<span class="apiarg">xPos, yPos, zPos, snapToLocation</span>) |
||
+ | : [[API C_Commentator.SetCheatsEnabled|C_Commentator.SetCheatsEnabled]](<span class="apiarg">enableCheats</span>) |
||
+ | : [[API C_Commentator.SetCommentatorHistory|C_Commentator.SetCommentatorHistory]](<span class="apiarg">history</span>) |
||
+ | : [[API C_Commentator.SetDistanceBeforeForcedHorizontalConvergence|C_Commentator.SetDistanceBeforeForcedHorizontalConvergence]](<span class="apiarg">distance</span>) |
||
+ | : [[API C_Commentator.SetDurationToForceHorizontalConvergence|C_Commentator.SetDurationToForceHorizontalConvergence]](<span class="apiarg">ms</span>) |
||
+ | : [[API C_Commentator.SetExcludeDistance|C_Commentator.SetExcludeDistance]](<span class="apiarg">excludeDistance</span>) |
||
+ | : [[API C_Commentator.SetFollowCameraSpeeds|C_Commentator.SetFollowCameraSpeeds]](<span class="apiarg">elasticSpeed, minSpeed</span>) |
||
+ | : [[API C_Commentator.SetHardlockWeight|C_Commentator.SetHardlockWeight]](<span class="apiarg">weight</span>) |
||
+ | : [[API C_Commentator.SetHorizontalAngleThresholdToSmooth|C_Commentator.SetHorizontalAngleThresholdToSmooth]](<span class="apiarg">angle</span>) |
||
+ | : [[API C_Commentator.SetLookAtLerpAmount|C_Commentator.SetLookAtLerpAmount]](<span class="apiarg">amount</span>) |
||
+ | : [[API C_Commentator.SetMapAndInstanceIndex|C_Commentator.SetMapAndInstanceIndex]](<span class="apiarg">mapIndex, instanceIndex</span>) |
||
+ | : [[API C_Commentator.SetMouseDisabled|C_Commentator.SetMouseDisabled]](<span class="apiarg">disabled</span>) |
||
+ | : [[API C_Commentator.SetMoveSpeed|C_Commentator.SetMoveSpeed]](<span class="apiarg">newSpeed</span>) |
||
+ | : [[API C_Commentator.SetMsToHoldForHorizontalMovement|C_Commentator.SetMsToHoldForHorizontalMovement]](<span class="apiarg">ms</span>) |
||
+ | : [[API C_Commentator.SetMsToHoldForVerticalMovement|C_Commentator.SetMsToHoldForVerticalMovement]](<span class="apiarg">ms</span>) |
||
+ | : [[API C_Commentator.SetMsToSmoothHorizontalChange|C_Commentator.SetMsToSmoothHorizontalChange]](<span class="apiarg">ms</span>) |
||
+ | : [[API C_Commentator.SetMsToSmoothVerticalChange|C_Commentator.SetMsToSmoothVerticalChange]](<span class="apiarg">ms</span>) |
||
+ | : [[API C_Commentator.SetPositionLerpAmount|C_Commentator.SetPositionLerpAmount]](<span class="apiarg">amount</span>) |
||
+ | : [[API C_Commentator.SetRequestedDebuffCooldowns|C_Commentator.SetRequestedDebuffCooldowns]](<span class="apiarg">specID, spellIDs</span>) |
||
+ | : [[API C_Commentator.SetRequestedDefensiveCooldowns|C_Commentator.SetRequestedDefensiveCooldowns]](<span class="apiarg">specID, spellIDs</span>) |
||
+ | : [[API C_Commentator.SetRequestedOffensiveCooldowns|C_Commentator.SetRequestedOffensiveCooldowns]](<span class="apiarg">specID, spellIDs</span>) |
||
+ | : [[API C_Commentator.SetSeriesScore|C_Commentator.SetSeriesScore]](<span class="apiarg">teamName1, teamName2, scoringTeamName, score</span>) |
||
+ | : [[API C_Commentator.SetSeriesScores|C_Commentator.SetSeriesScores]](<span class="apiarg">teamName1, teamName2, score1, score2</span>) |
||
+ | : [[API C_Commentator.SetSmartCameraLocked|C_Commentator.SetSmartCameraLocked]](<span class="apiarg">locked</span>) |
||
+ | : [[API C_Commentator.SetSmoothFollowTransitioning|C_Commentator.SetSmoothFollowTransitioning]](<span class="apiarg">enabled</span>) |
||
+ | : [[API C_Commentator.SetSoftlockWeight|C_Commentator.SetSoftlockWeight]](<span class="apiarg">weight</span>) |
||
+ | : [[API C_Commentator.SetSpeedFactor|C_Commentator.SetSpeedFactor]](<span class="apiarg">factor</span>) |
||
+ | : [[API C_Commentator.SetTargetHeightOffset|C_Commentator.SetTargetHeightOffset]](<span class="apiarg">offset</span>) |
||
+ | : [[API C_Commentator.SetUseSmartCamera|C_Commentator.SetUseSmartCamera]](<span class="apiarg">useSmartCamera</span>) |
||
+ | : [[API C_Commentator.SnapCameraLookAtPoint|C_Commentator.SnapCameraLookAtPoint]]() |
||
+ | : [[API C_Commentator.StartWargame|C_Commentator.StartWargame]](<span class="apiarg">listID, teamSize, tournamentRules, teamOneCaptain, teamTwoCaptain</span>) |
||
+ | : [[API C_Commentator.SwapTeamSides|C_Commentator.SwapTeamSides]]() |
||
+ | : [[API C_Commentator.ToggleCheats|C_Commentator.ToggleCheats]]() |
||
+ | : [[API C_Commentator.UpdateMapInfo|C_Commentator.UpdateMapInfo]](<span class="apiarg">[targetPlayer]</span>) |
||
+ | : [[API C_Commentator.UpdatePlayerInfo|C_Commentator.UpdatePlayerInfo]]() |
||
+ | : [[API C_Commentator.ZoomIn|C_Commentator.ZoomIn]]() |
||
+ | : [[API C_Commentator.ZoomOut|C_Commentator.ZoomOut]]() |
||
− | == |
+ | ==Tutorials== |
− | : [[API C_PlayerInfo.IsPlayerEligibleForNPE|C_PlayerInfo.IsPlayerEligibleForNPE]]() |
+ | : [[API C_PlayerInfo.IsPlayerEligibleForNPE|C_PlayerInfo.IsPlayerEligibleForNPE]]() : <span class="apiret">isEligible, failureReason</span> |
− | : [[API C_PlayerInfo.IsPlayerEligibleForNPEv2|C_PlayerInfo.IsPlayerEligibleForNPEv2]]() |
+ | : [[API C_PlayerInfo.IsPlayerEligibleForNPEv2|C_PlayerInfo.IsPlayerEligibleForNPEv2]]() : <span class="apiret">isEligible, failureReason</span> |
− | : [[API C_PlayerInfo. |
+ | : [[API C_PlayerInfo.IsPlayerNPERestricted|C_PlayerInfo.IsPlayerNPERestricted]]() : <span class="apiret">isRestricted</span> |
: [[API C_SplashScreen.AcknowledgeSplash|C_SplashScreen.AcknowledgeSplash]]() |
: [[API C_SplashScreen.AcknowledgeSplash|C_SplashScreen.AcknowledgeSplash]]() |
||
− | : [[API C_SplashScreen.CanViewSplashScreen|C_SplashScreen.CanViewSplashScreen]]() |
+ | : [[API C_SplashScreen.CanViewSplashScreen|C_SplashScreen.CanViewSplashScreen]]() : <span class="apiret">canView</span> |
− | : [[API C_SplashScreen.RequestLatestSplashScreen|C_SplashScreen.RequestLatestSplashScreen]](<span |
+ | : [[API C_SplashScreen.RequestLatestSplashScreen|C_SplashScreen.RequestLatestSplashScreen]](<span class="apiarg">fromGameMenu</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]]() |
||
: [[API CanResetTutorials|CanResetTutorials]]() |
: [[API CanResetTutorials|CanResetTutorials]]() |
||
: [[API ClearTutorials|ClearTutorials]]() |
: [[API ClearTutorials|ClearTutorials]]() |
||
− | : [[API ClosestGameObjectPosition|ClosestGameObjectPosition]](<span |
+ | : [[API ClosestGameObjectPosition|ClosestGameObjectPosition]](<span class="apiarg">gameObjectID</span>) |
− | : [[API ClosestUnitPosition|ClosestUnitPosition]](<span |
+ | : [[API ClosestUnitPosition|ClosestUnitPosition]](<span class="apiarg">creatureID</span>) - Returns the unit position of the closest creature by ID. Only works for mobs in the starting zones. |
− | : [[API FlagTutorial|FlagTutorial]](<span |
+ | : [[API FlagTutorial|FlagTutorial]](<span class="apiarg">tutorial</span>) |
− | : [[API GetNextCompleatedTutorial|GetNextCompleatedTutorial]](<span |
+ | : [[API GetNextCompleatedTutorial|GetNextCompleatedTutorial]](<span class="apiarg">tutorial</span>) |
− | : [[API GetPrevCompleatedTutorial|GetPrevCompleatedTutorial]](<span |
+ | : [[API GetPrevCompleatedTutorial|GetPrevCompleatedTutorial]](<span class="apiarg">tutorial</span>) |
: [[API GetTutorialsEnabled|GetTutorialsEnabled]]() |
: [[API GetTutorialsEnabled|GetTutorialsEnabled]]() |
||
: [[API IsSplashFramePrimaryFeatureUnlocked|IsSplashFramePrimaryFeatureUnlocked]]() |
: [[API IsSplashFramePrimaryFeatureUnlocked|IsSplashFramePrimaryFeatureUnlocked]]() |
||
− | : [[API IsTutorialFlagged|IsTutorialFlagged]](<span |
+ | : [[API IsTutorialFlagged|IsTutorialFlagged]](<span class="apiarg">tutorial</span>) |
: [[API RequestBottomLeftActionBar|RequestBottomLeftActionBar]]() |
: [[API RequestBottomLeftActionBar|RequestBottomLeftActionBar]]() |
||
: [[API ResetTutorials|ResetTutorials]]() |
: [[API ResetTutorials|ResetTutorials]]() |
||
: [[API ShouldShowSpecialSplashScreen|ShouldShowSpecialSplashScreen]]() |
: [[API ShouldShowSpecialSplashScreen|ShouldShowSpecialSplashScreen]]() |
||
: [[API SplashFrameCanBeShown|SplashFrameCanBeShown]]() |
: [[API SplashFrameCanBeShown|SplashFrameCanBeShown]]() |
||
− | : [[API TriggerTutorial|TriggerTutorial]](<span |
+ | : [[API TriggerTutorial|TriggerTutorial]](<span class="apiarg">tutorial</span>) |
− | == |
+ | ==UI Objects== |
− | : [[API GetFileIDFromPath|GetFileIDFromPath]](<span |
+ | : [[API GetFileIDFromPath|GetFileIDFromPath]](<span class="apiarg">filePath</span>) - Returns the FileID for an Interface file path. |
− | : [[API SetUIVisibility|SetUIVisibility]](<span |
+ | : [[API SetUIVisibility|SetUIVisibility]](<span class="apiarg">visible</span>) - Hides or shows the entire UI. |
+ | : [[API EasyMenu|EasyMenu]](<span class="apiarg">menuList, menuFrame, anchor, x, y, displayMode, autoHideDelay</span>) {{apitag|framexml}} |
||
+ | : [[API ToggleDropDownMenu|ToggleDropDownMenu]](<span class="apiarg">level, value, dropDownFrame, anchorName, xOffset, yOffset</span>) {{apitag|framexml}} |
||
− | === |
+ | ===Frame=== |
+ | : [[API C_FrameManager.GetFrameVisibilityState|C_FrameManager.GetFrameVisibilityState]](<span class="apiarg">frameType</span>) : <span class="apiret">shouldShow</span> |
||
− | : [[API CreateFrame|CreateFrame]](<span style="font-size:smaller; color:#ecbc2a">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 style="font-size:smaller; color:#ecbc2a">template</span>) - Returns if a virtual frame template exists. |
||
− | : [[API |
+ | : [[API DoesTemplateExist|DoesTemplateExist]](<span class="apiarg">template</span>) - Returns if a virtual frame template exists. |
+ | : [[API EnumerateFrames|EnumerateFrames]](<span class="apiarg">currentFrame</span>) - Returns the frame which follows the current frame. |
||
− | : [[API GetClickFrame|GetClickFrame]](<span style="font-size:smaller; color:#ecbc2a">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 GetFramesRegisteredForEvent|GetFramesRegisteredForEvent]](<span style="font-size:smaller; color:#ecbc2a">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 GetMouseFocus|GetMouseFocus]]() - Returns the frame that currently has mouse focus. |
||
− | : [[API GetMouseClickFocus|GetMouseClickFocus]]() |
||
+ | : [[API SetupFullscreenScale|SetupFullscreenScale]](<span class="apiarg">frame</span>) - Sizes a frame to take up the entire screen regardless of screen resolution. |
||
− | : [[API GetMouseFocus|GetMouseFocus]]() - Returns the frame that currently has the mouse focus. |
||
+ | : [[API MouseIsOver|MouseIsOver]](<span class="apiarg">region, topOffset, bottomOffset, leftOffset, rightOffset</span>) {{apitag|framexml}} - Checks whether the mouse is over the frame (or within specified offsets). |
||
− | : [[API GetMouseMotionFocus|GetMouseMotionFocus]]() |
||
+ | : [[API UIFrameFadeIn|UIFrameFadeIn]](<span class="apiarg">frame, timeToFade, startAlpha, endAlpha</span>) {{apitag|framexml}} - Fades a frame in. |
||
− | : [[API GetNumFrames|GetNumFrames]]() - Get the current number of Frame (and derivative) objects. |
||
+ | : [[API UIFrameFadeOut|UIFrameFadeOut]](<span class="apiarg">frame, timeToFade, startAlpha, endAlpha</span>) {{apitag|framexml}} - Fades a frame out. |
||
− | : [[API SetupFullscreenScale|SetupFullscreenScale]](<span style="font-size:smaller; color:#ecbc2a">frame</span>) - Configures scale of full-screen views, such as the world map, to best fill screen. |
||
− | : UI [[API MouseIsOver|MouseIsOver]](<span style="font-size:smaller; color:#ecbc2a">region, topOffset, bottomOffset, leftOffset, rightOffset</span>) - Checks whether the mouse is over the frame (or within specified offsets). |
||
− | : UI [[API UIFrameFadeIn|UIFrameFadeIn]](<span style="font-size:smaller; color:#ecbc2a">frame, timeToFade, startAlpha, endAlpha</span>) - Fades a frame in. |
||
− | : UI [[API UIFrameFadeOut|UIFrameFadeOut]](<span style="font-size:smaller; color:#ecbc2a">frame, timeToFade, startAlpha, endAlpha</span>) - Fades a frame out. |
||
− | : UI [[API UIFrameFlash|UIFrameFlash]](<span style="font-size:smaller; color:#ecbc2a">frame, fadeInTime, fadeOutTime, flashDuration [, showWhenDone, flashInHoldTime, flashOutHoldTime, syncId]</span>) - Flashes a frame. |
||
− | === |
+ | ===Font=== |
− | : [[API CreateFont|CreateFont]](<span |
+ | : [[API CreateFont|CreateFont]](<span class="apiarg">name</span>) - Creates a {{api|t=o|Font}} object. |
− | : [[API GetFontInfo|GetFontInfo]](<span |
+ | : [[API GetFontInfo|GetFontInfo]](<span class="apiarg">font or name</span>) |
− | : [[API GetFonts|GetFonts]]() - Returns |
+ | : [[API GetFonts|GetFonts]]() - Returns a list of available fonts. |
− | === |
+ | ===Texture=== |
− | : [[API C_Texture.GetAtlasInfo|C_Texture.GetAtlasInfo]](<span |
+ | : [[API C_Texture.GetAtlasInfo|C_Texture.GetAtlasInfo]](<span class="apiarg">atlas</span>) : <span class="apiret">info</span> - Returns atlas info. |
+ | : [[API SetPortraitTexture|SetPortraitTexture]](<span class="apiarg">textureObject, unitToken [, disableMasking]</span>) - Sets a texture to a unit's 2D portrait. |
||
− | : [[API GetObjectIconTextureCoords|GetObjectIconTextureCoords]](<span style="font-size:smaller; color:#ecbc2a">textureIndex</span>) |
||
− | : [[API |
+ | : [[API SetPortraitToTexture|SetPortraitToTexture]](<span class="apiarg">textureObject, texturePath</span>) - Applies a circular mask to a texture, making it resemble a portrait. |
+ | : [https://www.townlong-yak.com/framexml/go/CreateAtlasMarkup CreateAtlasMarkup](<span class="apiarg">atlasName [, height, width, offsetX, offsetY]</span>) {{apitag|framexml}} - Returns a texture fontstring for an atlas. |
||
− | : [[API SetPortraitToTexture|SetPortraitToTexture]](<span style="font-size:smaller; color:#ecbc2a">texture, texturePath</span>) - Sets the texture to be displayed from a file applying a circular opacity mask making it look round like portraits. |
||
− | : |
+ | : [https://www.townlong-yak.com/framexml/go/CreateTextureMarkup CreateTextureMarkup](<span class="apiarg">file, fileWidth, fileHeight, width, height, left, right, top, bottom [, xOffset, yOffset]</span>) {{apitag|framexml}} - Returns a texture fontstring. |
− | : |
+ | : [https://www.townlong-yak.com/framexml/go/GetTextureInfo GetTextureInfo](<span class="apiarg">obj</span>) {{apitag|framexml}} - Returns the type and info of a texture. |
− | : UI [https://www.townlong-yak.com/framexml/go/GetTextureInfo GetTextureInfo](<span style="font-size:smaller; color:#ecbc2a">obj</span>) - Returns the type and info of a texture. |
||
− | === |
+ | ===ModelScene=== |
− | : [[API C_ModelInfo.AddActiveModelScene|C_ModelInfo.AddActiveModelScene]](<span |
+ | : [[API C_ModelInfo.AddActiveModelScene|C_ModelInfo.AddActiveModelScene]](<span class="apiarg">modelSceneFrame, modelSceneID</span>) |
− | : [[API C_ModelInfo.AddActiveModelSceneActor|C_ModelInfo.AddActiveModelSceneActor]](<span |
+ | : [[API C_ModelInfo.AddActiveModelSceneActor|C_ModelInfo.AddActiveModelSceneActor]](<span class="apiarg">modelSceneFrameActor, modelSceneActorID</span>) |
− | : [[API C_ModelInfo.ClearActiveModelScene|C_ModelInfo.ClearActiveModelScene]](<span |
+ | : [[API C_ModelInfo.ClearActiveModelScene|C_ModelInfo.ClearActiveModelScene]](<span class="apiarg">modelSceneFrame</span>) |
− | : [[API C_ModelInfo.ClearActiveModelSceneActor|C_ModelInfo.ClearActiveModelSceneActor]](<span |
+ | : [[API C_ModelInfo.ClearActiveModelSceneActor|C_ModelInfo.ClearActiveModelSceneActor]](<span class="apiarg">modelSceneFrameActor</span>) |
− | : [[API C_ModelInfo.GetModelSceneActorDisplayInfoByID|C_ModelInfo.GetModelSceneActorDisplayInfoByID]](<span |
+ | : [[API C_ModelInfo.GetModelSceneActorDisplayInfoByID|C_ModelInfo.GetModelSceneActorDisplayInfoByID]](<span class="apiarg">modelActorDisplayID</span>) : <span class="apiret">actorDisplayInfo</span> |
− | : [[API C_ModelInfo.GetModelSceneActorInfoByID|C_ModelInfo.GetModelSceneActorInfoByID]](<span |
+ | : [[API C_ModelInfo.GetModelSceneActorInfoByID|C_ModelInfo.GetModelSceneActorInfoByID]](<span class="apiarg">modelActorID</span>) : <span class="apiret">actorInfo</span> |
− | : [[API C_ModelInfo.GetModelSceneCameraInfoByID|C_ModelInfo.GetModelSceneCameraInfoByID]](<span |
+ | : [[API C_ModelInfo.GetModelSceneCameraInfoByID|C_ModelInfo.GetModelSceneCameraInfoByID]](<span class="apiarg">modelSceneCameraID</span>) : <span class="apiret">modelSceneCameraInfo</span> |
− | : [[API C_ModelInfo.GetModelSceneInfoByID|C_ModelInfo.GetModelSceneInfoByID]](<span |
+ | : [[API C_ModelInfo.GetModelSceneInfoByID|C_ModelInfo.GetModelSceneInfoByID]](<span class="apiarg">modelSceneID</span>) : <span class="apiret">modelSceneType, modelCameraIDs, modelActorsIDs, flags</span> |
− | : [[API GetUICameraInfo|GetUICameraInfo]](<span |
+ | : [[API GetUICameraInfo|GetUICameraInfo]](<span class="apiarg">uiCameraID</span>) |
− | === |
+ | ===Widget objects=== |
+ | : [[API C_Widget.IsFrameWidget|C_Widget.IsFrameWidget]]() |
||
− | : [[API C_PrototypeDialog.EnsureRemoved|C_PrototypeDialog.EnsureRemoved]](<span style="font-size:smaller; color:#ecbc2a">instanceID</span>) |
||
+ | : [[API C_Widget.IsRenderableWidget|C_Widget.IsRenderableWidget]]() |
||
− | : [[API C_PrototypeDialog.SelectOption|C_PrototypeDialog.SelectOption]](<span style="font-size:smaller; color:#ecbc2a">instanceID, optionIndex</span>) |
||
+ | : [[API C_Widget.IsWidget|C_Widget.IsWidget]](<span class="apiarg">object</span>) |
||
− | : [[API IsUsingFixedTimeStep|IsUsingFixedTimeStep]]() |
||
− | === |
+ | ===Blizzard=== |
+ | Used internally for the Blizzard_PrototypeDialog addon. |
||
− | 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. |
||
+ | : [[API C_PrototypeDialog.EnsureRemoved|C_PrototypeDialog.EnsureRemoved]](<span class="apiarg">instanceID</span>) |
||
− | : [[API C_UIWidgetManager.RegisterUnitForWidgetUpdates|C_UIWidgetManager.RegisterUnitForWidgetUpdates]](<span style="font-size:smaller; color:#ecbc2a">unitToken</span>) |
||
+ | : [[API C_PrototypeDialog.SelectOption|C_PrototypeDialog.SelectOption]](<span class="apiarg">instanceID, optionIndex</span>) |
||
− | : [[API C_UIWidgetManager.SetProcessingUnit|C_UIWidgetManager.SetProcessingUnit]](<span style="font-size:smaller; color:#ecbc2a">[unit]</span>) |
||
+ | |||
− | : [[API C_UIWidgetManager.UnregisterUnitForWidgetUpdates|C_UIWidgetManager.UnregisterUnitForWidgetUpdates]](<span style="font-size:smaller; color:#ecbc2a">unitToken</span>) |
||
+ | ===Toasts=== |
||
− | Position |
||
+ | : [[API C_EventToastManager.GetLevelUpDisplayToastsFromLevel|C_EventToastManager.GetLevelUpDisplayToastsFromLevel]](<span class="apiarg">level</span>) : <span class="apiret">toastInfo</span> |
||
− | : [[API C_UIWidgetManager.GetAllWidgetsBySetID|C_UIWidgetManager.GetAllWidgetsBySetID]](<span style="font-size:smaller; color:#ecbc2a">setID</span>) - Returns all widgets for a widget set ID. |
||
+ | : [[API C_EventToastManager.GetNextToastToDisplay|C_EventToastManager.GetNextToastToDisplay]]() : <span class="apiret">toastInfo</span> |
||
− | : [[API C_UIWidgetManager.GetBelowMinimapWidgetSetID|C_UIWidgetManager.GetBelowMinimapWidgetSetID]]() |
||
+ | : [[API C_EventToastManager.RemoveCurrentToast|C_EventToastManager.RemoveCurrentToast]]() |
||
− | : [[API C_UIWidgetManager.GetObjectiveTrackerWidgetSetID|C_UIWidgetManager.GetObjectiveTrackerWidgetSetID]]() |
||
+ | |||
− | : [[API C_UIWidgetManager.GetPowerBarWidgetSetID|C_UIWidgetManager.GetPowerBarWidgetSetID]]() |
||
+ | ===Macbook Pro Notch=== |
||
− | : [[API C_UIWidgetManager.GetTopCenterWidgetSetID|C_UIWidgetManager.GetTopCenterWidgetSetID]]() - Returns the widget set ID for the top center part of the screen. |
||
+ | : [[API C_UI.DoesAnyDisplayHaveNotch|C_UI.DoesAnyDisplayHaveNotch]]() : <span class="apiret">notchPresent</span> |
||
− | : [[API C_UIWidgetManager.GetWidgetLayoutDirectionFromWidgetSetID|C_UIWidgetManager.GetWidgetLayoutDirectionFromWidgetSetID]](<span style="font-size:smaller; color:#ecbc2a">widgetSetID</span>) |
||
+ | : [[API C_UI.GetTopLeftNotchSafeRegion|C_UI.GetTopLeftNotchSafeRegion]]() : <span class="apiret">left, right, top, bottom</span> |
||
+ | : [[API C_UI.GetTopRightNotchSafeRegion|C_UI.GetTopRightNotchSafeRegion]]() : <span class="apiret">left, right, top, bottom</span> |
||
+ | : [[API C_UI.ShouldUIParentAvoidNotch|C_UI.ShouldUIParentAvoidNotch]]() : <span class="apiret">willAvoidNotch</span> |
||
+ | |||
+ | ==UI Widget Manager== |
||
+ | The UI widget system was added in [[Patch_8.0.1/API_changes|Patch 8.0.1]] to replace the WorldStateFrame; see [[UPDATE_UI_WIDGET]] for usage information. |
||
+ | |||
+ | WidgetSet |
||
+ | : [[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.GetObjectiveTrackerWidgetSetID|C_UIWidgetManager.GetObjectiveTrackerWidgetSetID]]() : <span class="apiret">setID</span> |
||
+ | : [[API C_UIWidgetManager.GetPowerBarWidgetSetID|C_UIWidgetManager.GetPowerBarWidgetSetID]]() : <span class="apiret">setID</span> |
||
+ | : [[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_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 |
+ | : [[API C_UIWidgetManager.GetBulletTextListWidgetVisualizationInfo|C_UIWidgetManager.GetBulletTextListWidgetVisualizationInfo]](<span class="apiarg">widgetID</span>) : <span class="apiret">widgetInfo</span> |
− | : [[API C_UIWidgetManager.GetCaptureBarWidgetVisualizationInfo|C_UIWidgetManager.GetCaptureBarWidgetVisualizationInfo]](<span |
+ | : [[API C_UIWidgetManager.GetCaptureBarWidgetVisualizationInfo|C_UIWidgetManager.GetCaptureBarWidgetVisualizationInfo]](<span class="apiarg">widgetID</span>) : <span class="apiret">widgetInfo</span> |
− | : [[API C_UIWidgetManager.GetCaptureZoneVisualizationInfo|C_UIWidgetManager.GetCaptureZoneVisualizationInfo]](<span |
+ | : [[API C_UIWidgetManager.GetCaptureZoneVisualizationInfo|C_UIWidgetManager.GetCaptureZoneVisualizationInfo]](<span class="apiarg">widgetID</span>) : <span class="apiret">widgetInfo</span> |
− | : [[API C_UIWidgetManager.GetDiscreteProgressStepsVisualizationInfo|C_UIWidgetManager.GetDiscreteProgressStepsVisualizationInfo]](<span |
+ | : [[API C_UIWidgetManager.GetDiscreteProgressStepsVisualizationInfo|C_UIWidgetManager.GetDiscreteProgressStepsVisualizationInfo]](<span class="apiarg">widgetID</span>) : <span class="apiret">widgetInfo</span> |
− | : [[API C_UIWidgetManager.GetDoubleIconAndTextWidgetVisualizationInfo|C_UIWidgetManager.GetDoubleIconAndTextWidgetVisualizationInfo]](<span |
+ | : [[API C_UIWidgetManager.GetDoubleIconAndTextWidgetVisualizationInfo|C_UIWidgetManager.GetDoubleIconAndTextWidgetVisualizationInfo]](<span class="apiarg">widgetID</span>) : <span class="apiret">widgetInfo</span> |
− | : [[API C_UIWidgetManager.GetDoubleStateIconRowVisualizationInfo|C_UIWidgetManager.GetDoubleStateIconRowVisualizationInfo]](<span |
+ | : [[API C_UIWidgetManager.GetDoubleStateIconRowVisualizationInfo|C_UIWidgetManager.GetDoubleStateIconRowVisualizationInfo]](<span class="apiarg">widgetID</span>) : <span class="apiret">widgetInfo</span> |
− | : [[API C_UIWidgetManager.GetDoubleStatusBarWidgetVisualizationInfo|C_UIWidgetManager.GetDoubleStatusBarWidgetVisualizationInfo]](<span |
+ | : [[API C_UIWidgetManager.GetDoubleStatusBarWidgetVisualizationInfo|C_UIWidgetManager.GetDoubleStatusBarWidgetVisualizationInfo]](<span class="apiarg">widgetID</span>) : <span class="apiret">widgetInfo</span> |
− | : [[API C_UIWidgetManager.GetHorizontalCurrenciesWidgetVisualizationInfo|C_UIWidgetManager.GetHorizontalCurrenciesWidgetVisualizationInfo]](<span |
+ | : [[API C_UIWidgetManager.GetHorizontalCurrenciesWidgetVisualizationInfo|C_UIWidgetManager.GetHorizontalCurrenciesWidgetVisualizationInfo]](<span class="apiarg">widgetID</span>) : <span class="apiret">widgetInfo</span> |
− | : [[API C_UIWidgetManager.GetIconAndTextWidgetVisualizationInfo|C_UIWidgetManager.GetIconAndTextWidgetVisualizationInfo]](<span |
+ | : [[API C_UIWidgetManager.GetIconAndTextWidgetVisualizationInfo|C_UIWidgetManager.GetIconAndTextWidgetVisualizationInfo]](<span class="apiarg">widgetID</span>) : <span class="apiret">widgetInfo</span> |
− | : [[API C_UIWidgetManager.GetIconTextAndBackgroundWidgetVisualizationInfo|C_UIWidgetManager.GetIconTextAndBackgroundWidgetVisualizationInfo]](<span |
+ | : [[API C_UIWidgetManager.GetIconTextAndBackgroundWidgetVisualizationInfo|C_UIWidgetManager.GetIconTextAndBackgroundWidgetVisualizationInfo]](<span class="apiarg">widgetID</span>) : <span class="apiret">widgetInfo</span> |
− | : [[API C_UIWidgetManager.GetIconTextAndCurrenciesWidgetVisualizationInfo|C_UIWidgetManager.GetIconTextAndCurrenciesWidgetVisualizationInfo]](<span |
+ | : [[API C_UIWidgetManager.GetIconTextAndCurrenciesWidgetVisualizationInfo|C_UIWidgetManager.GetIconTextAndCurrenciesWidgetVisualizationInfo]](<span class="apiarg">widgetID</span>) : <span class="apiret">widgetInfo</span> |
− | : [[API C_UIWidgetManager.GetScenarioHeaderCurrenciesAndBackgroundWidgetVisualizationInfo|C_UIWidgetManager.GetScenarioHeaderCurrenciesAndBackgroundWidgetVisualizationInfo]](<span |
+ | : [[API C_UIWidgetManager.GetScenarioHeaderCurrenciesAndBackgroundWidgetVisualizationInfo|C_UIWidgetManager.GetScenarioHeaderCurrenciesAndBackgroundWidgetVisualizationInfo]](<span class="apiarg">widgetID</span>) : <span class="apiret">widgetInfo</span> |
− | : [[API C_UIWidgetManager.GetScenarioHeaderTimerWidgetVisualizationInfo|C_UIWidgetManager.GetScenarioHeaderTimerWidgetVisualizationInfo]](<span |
+ | : [[API C_UIWidgetManager.GetScenarioHeaderTimerWidgetVisualizationInfo|C_UIWidgetManager.GetScenarioHeaderTimerWidgetVisualizationInfo]](<span class="apiarg">widgetID</span>) : <span class="apiret">widgetInfo</span> |
− | : [[API C_UIWidgetManager. |
+ | : [[API C_UIWidgetManager.GetSpacerVisualizationInfo|C_UIWidgetManager.GetSpacerVisualizationInfo]](<span class="apiarg">widgetID</span>) : <span class="apiret">widgetInfo</span> |
− | : [[API C_UIWidgetManager. |
+ | : [[API C_UIWidgetManager.GetSpellDisplayVisualizationInfo|C_UIWidgetManager.GetSpellDisplayVisualizationInfo]](<span class="apiarg">widgetID</span>) : <span class="apiret">widgetInfo</span> |
− | : [[API C_UIWidgetManager. |
+ | : [[API C_UIWidgetManager.GetStackedResourceTrackerWidgetVisualizationInfo|C_UIWidgetManager.GetStackedResourceTrackerWidgetVisualizationInfo]](<span class="apiarg">widgetID</span>) : <span class="apiret">widgetInfo</span> |
− | : [[API C_UIWidgetManager. |
+ | : [[API C_UIWidgetManager.GetStatusBarWidgetVisualizationInfo|C_UIWidgetManager.GetStatusBarWidgetVisualizationInfo]](<span class="apiarg">widgetID</span>) : <span class="apiret">widgetInfo</span> |
− | : [[API C_UIWidgetManager. |
+ | : [[API C_UIWidgetManager.GetTextColumnRowVisualizationInfo|C_UIWidgetManager.GetTextColumnRowVisualizationInfo]](<span class="apiarg">widgetID</span>) : <span class="apiret">widgetInfo</span> |
− | : [[API C_UIWidgetManager. |
+ | : [[API C_UIWidgetManager.GetTextureAndTextRowVisualizationInfo|C_UIWidgetManager.GetTextureAndTextRowVisualizationInfo]](<span class="apiarg">widgetID</span>) : <span class="apiret">widgetInfo</span> |
− | : [[API C_UIWidgetManager. |
+ | : [[API C_UIWidgetManager.GetTextureAndTextVisualizationInfo|C_UIWidgetManager.GetTextureAndTextVisualizationInfo]](<span class="apiarg">widgetID</span>) : <span class="apiret">widgetInfo</span> |
− | : [[API C_UIWidgetManager. |
+ | : [[API C_UIWidgetManager.GetTextureWithAnimationVisualizationInfo|C_UIWidgetManager.GetTextureWithAnimationVisualizationInfo]](<span class="apiarg">widgetID</span>) : <span class="apiret">widgetInfo</span> |
+ | : [[API C_UIWidgetManager.GetTextWithStateWidgetVisualizationInfo|C_UIWidgetManager.GetTextWithStateWidgetVisualizationInfo]](<span class="apiarg">widgetID</span>) : <span class="apiret">widgetInfo</span> |
||
+ | : [[API C_UIWidgetManager.GetUnitPowerBarWidgetVisualizationInfo|C_UIWidgetManager.GetUnitPowerBarWidgetVisualizationInfo]](<span class="apiarg">widgetID</span>) : <span class="apiret">widgetInfo</span> |
||
+ | : [[API C_UIWidgetManager.GetZoneControlVisualizationInfo|C_UIWidgetManager.GetZoneControlVisualizationInfo]](<span class="apiarg">widgetID</span>) : <span class="apiret">widgetInfo</span> |
||
+ | : [[API C_UIWidgetManager.RegisterUnitForWidgetUpdates|C_UIWidgetManager.RegisterUnitForWidgetUpdates]](<span class="apiarg">unitToken [, isGuid]</span>) |
||
− | : [[API C_Widget.IsFrameWidget|C_Widget.IsFrameWidget]]() |
||
+ | : [[API C_UIWidgetManager.SetProcessingUnit|C_UIWidgetManager.SetProcessingUnit]](<span class="apiarg">[unit]</span>) |
||
− | : [[API C_Widget.IsRenderableWidget|C_Widget.IsRenderableWidget]]() |
||
− | : [[API |
+ | : [[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 UnitWidgetSet|UnitWidgetSet]](<span style="font-size:smaller; color:#ecbc2a">unit</span>) |
||
− | : REMOVED (8.2.0) [[API C_UIWidgetManager.GetTextureWithStateVisualizationInfo|C_UIWidgetManager.GetTextureWithStateVisualizationInfo]](<span style="font-size:smaller; color:#ecbc2a">widgetID</span>) |
||
− | == |
+ | ==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 GetThreatStatusColor|GetThreatStatusColor]](<span style="font-size:smaller; color:#ecbc2a">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 style="font-size:smaller; color:#ecbc2a">unit</span>) |
||
− | : [[API |
+ | : [[API GetUnitChargedPowerPoints|GetUnitChargedPowerPoints]](<span class="apiarg">unit</span>) : <span class="apiret">pointIndices</span> |
− | : [[API |
+ | : [[API GetUnitSpeed|GetUnitSpeed]](<span class="apiarg">unit</span>) - Returns the movement speed of the unit. |
− | : [[API |
+ | : [[API UnitAffectingCombat|UnitAffectingCombat]](<span class="apiarg">unit</span>) - Returns true if the unit is in combat. |
− | : [[API |
+ | : [[API UnitArmor|UnitArmor]](<span class="apiarg">unit</span>) - Returns the armor stats for the unit. |
− | : [[API |
+ | : [[API UnitAttackPower|UnitAttackPower]](<span class="apiarg">unit</span>) - Returns the unit's melee attack power and modifiers. |
− | : [[API |
+ | : [[API UnitAttackSpeed|UnitAttackSpeed]](<span class="apiarg">unit</span>) - Returns the unit's melee attack speed for each hand. |
− | : [[API |
+ | : [[API UnitCanAssist|UnitCanAssist]](<span class="apiarg">unit, otherUnit</span>) - Indicates whether the first unit can assist the second unit. |
− | : [[API |
+ | : [[API UnitCanAttack|UnitCanAttack]](<span class="apiarg">unit, otherUnit</span>) - Returns true if the first unit can attack the second. |
+ | : [[API UnitCanCooperate|UnitCanCooperate]](<span class="apiarg">unit, otherUnit</span>) - Returns true if the first unit can cooperate with the second. |
||
: [[API UnitCanPetBattle|UnitCanPetBattle]]() |
: [[API UnitCanPetBattle|UnitCanPetBattle]]() |
||
− | : [[API UnitCastingInfo|UnitCastingInfo]](<span |
+ | : [[API UnitCastingInfo|UnitCastingInfo]](<span class="apiarg">unit</span>) - Returns information about the spell currently being cast by the specified unit. |
− | : [[API UnitChannelInfo|UnitChannelInfo]](<span |
+ | : [[API UnitChannelInfo|UnitChannelInfo]](<span class="apiarg">unit</span>) - Returns information about the spell currently being channeled by the specified unit. |
− | : [[API UnitClass|UnitClass]](<span |
+ | : [[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 |
+ | : [[API UnitClassBase|UnitClassBase]](<span class="apiarg">unit</span>) : <span class="apiret">classFilename, classID</span> |
− | : [[API UnitClassification|UnitClassification]](<span |
+ | : [[API UnitClassification|UnitClassification]](<span class="apiarg">unit</span>) - Returns the classification of the specified unit (e.g., "elite" or "worldboss"). |
− | : [[API UnitCreatureFamily|UnitCreatureFamily]](<span |
+ | : [[API UnitCreatureFamily|UnitCreatureFamily]](<span class="apiarg">unit</span>) - Returns the creature type of the unit (e.g. Crab). |
− | : [[API UnitCreatureType|UnitCreatureType]](<span |
+ | : [[API UnitCreatureType|UnitCreatureType]](<span class="apiarg">unit</span>) - Returns the creature classification type of the unit (e.g. Beast). |
− | : [[API UnitDamage|UnitDamage]](<span |
+ | : [[API UnitDamage|UnitDamage]](<span class="apiarg">unit</span>) - Returns the damage stats for the unit. |
− | : [[API UnitDetailedThreatSituation|UnitDetailedThreatSituation]](<span |
+ | : [[API UnitDetailedThreatSituation|UnitDetailedThreatSituation]](<span class="apiarg">unit, unitMob</span>) - Returns detailed info for the threat status of one unit against another. |
− | : [[API |
+ | : [[API UnitEffectiveLevel|UnitEffectiveLevel]](<span class="apiarg">unit</span>) - Returns the unit's effective (scaled) level. |
− | : [[API |
+ | : [[API UnitExists|UnitExists]](<span class="apiarg">unit</span>) - Returns true if the unit exists. |
− | : [[API |
+ | : [[API UnitFactionGroup|UnitFactionGroup]](<span class="apiarg">unit</span>) - Returns the faction (Horde/Alliance) a unit belongs to. |
− | : [[API |
+ | : [[API UnitFullName|UnitFullName]](<span class="apiarg">unit</span>) - Returns the player's (unit's) name and server. |
− | : [[API UnitFullName|UnitFullName]](<span style="font-size:smaller; color:#ecbc2a">unit</span>) - Returns the player's (unit's) name and server. |
||
: [[API UnitGetAvailableRoles|UnitGetAvailableRoles]]() |
: [[API UnitGetAvailableRoles|UnitGetAvailableRoles]]() |
||
− | : [[API UnitGetIncomingHeals|UnitGetIncomingHeals]](<span |
+ | : [[API UnitGetIncomingHeals|UnitGetIncomingHeals]](<span class="apiarg">unit [, healer]</span>) - Returns the predicted heals cast on the specified unit. |
− | : [[API UnitGetTotalAbsorbs|UnitGetTotalAbsorbs]](<span |
+ | : [[API UnitGetTotalAbsorbs|UnitGetTotalAbsorbs]](<span class="apiarg">unit</span>) - Returns the total amount of damage the unit can absorb before losing health. |
− | : [[API UnitGetTotalHealAbsorbs|UnitGetTotalHealAbsorbs]](<span |
+ | : [[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 |
+ | : [[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 |
+ | : [[API UnitGUID|UnitGUID]](<span class="apiarg">unit</span>) - Returns the GUID of the unit. |
− | : [[API UnitHasIncomingResurrection|UnitHasIncomingResurrection]](<span |
+ | : [[API UnitHasIncomingResurrection|UnitHasIncomingResurrection]](<span class="apiarg">unit</span>) - Returns true if the unit is currently being resurrected. |
− | : [[API UnitHasLFGDeserter|UnitHasLFGDeserter]](<span |
+ | : [[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 |
+ | : [[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 |
+ | : [[API UnitHasRelicSlot|UnitHasRelicSlot]](<span class="apiarg">unit</span>) |
− | : [[API UnitHealth|UnitHealth]](<span |
+ | : [[API UnitHealth|UnitHealth]](<span class="apiarg">unit</span>) - Returns the current health of the unit. |
− | : [[API UnitHealthMax|UnitHealthMax]](<span |
+ | : [[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 |
+ | : [[API UnitInRange|UnitInRange]](<span class="apiarg">unit</span>) : <span class="apiret">inRange, checkedRange</span> {{apitag|grouponly}} - Returns true if the unit is within 40 yards range (25 yards for Evokers). |
− | : [[API UnitIsAFK|UnitIsAFK]](<span |
+ | : [[API UnitIsAFK|UnitIsAFK]](<span class="apiarg">unit</span>) - Returns true if a friendly unit is AFK (Away from keyboard). |
− | : [[API UnitIsCharmed|UnitIsCharmed]](<span |
+ | : [[API UnitIsCharmed|UnitIsCharmed]](<span class="apiarg">unit</span>) - Returns true if the unit is charmed. |
− | : [[API UnitIsConnected|UnitIsConnected]](<span |
+ | : [[API UnitIsConnected|UnitIsConnected]](<span class="apiarg">unit</span>) : <span class="apiret">isConnected</span> - Returns true if the unit is connected to the game (i.e. not offline). |
− | : [[API UnitIsControlling|UnitIsControlling]]() |
+ | : [[API UnitIsControlling|UnitIsControlling]](<span class="apiarg">unit</span>) - Returns true if the local player is directly controlling the specified unit. |
− | : [[API UnitIsCorpse|UnitIsCorpse]](<span |
+ | : [[API UnitIsCorpse|UnitIsCorpse]](<span class="apiarg">unit</span>) - Returns true if the specified unit is a corpse, false otherwise. |
− | : [[API UnitIsDead|UnitIsDead]](<span |
+ | : [[API UnitIsDead|UnitIsDead]](<span class="apiarg">unit</span>) - Returns true if the unit is dead. |
− | : [[API UnitIsDeadOrGhost|UnitIsDeadOrGhost]](<span |
+ | : [[API UnitIsDeadOrGhost|UnitIsDeadOrGhost]](<span class="apiarg">unit</span>) - Returns true if the unit is dead or in ghost form. |
− | : [[API UnitIsDND|UnitIsDND]](<span |
+ | : [[API UnitIsDND|UnitIsDND]](<span class="apiarg">unit</span>) - Returns true if a unit is DND (Do not disturb). |
− | : [[API UnitIsEnemy|UnitIsEnemy]](<span |
+ | : [[API UnitIsEnemy|UnitIsEnemy]](<span class="apiarg">unit, otherUnit</span>) - Returns true if the specified units are hostile to each other. |
− | : [[API UnitIsFeignDeath|UnitIsFeignDeath]](<span |
+ | : [[API UnitIsFeignDeath|UnitIsFeignDeath]](<span class="apiarg">unit</span>) - Returns true if the unit (must be a group member) is feigning death. |
− | : [[API UnitIsFriend|UnitIsFriend]](<span |
+ | : [[API UnitIsFriend|UnitIsFriend]](<span class="apiarg">unit, otherUnit</span>) - Returns true if the specified units are friendly to each other. |
− | : [[API UnitIsGhost|UnitIsGhost]](<span |
+ | : [[API UnitIsGhost|UnitIsGhost]](<span class="apiarg">unit</span>) - Returns true if the unit is in ghost form. |
: [[API UnitIsGroupAssistant|UnitIsGroupAssistant]]() |
: [[API UnitIsGroupAssistant|UnitIsGroupAssistant]]() |
||
− | : [[API UnitIsInMyGuild|UnitIsInMyGuild]](<span |
+ | : [[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 |
+ | : [[API UnitIsOwnerOrControllerOfUnit|UnitIsOwnerOrControllerOfUnit]](<span class="apiarg">controllingUnit, controlledUnit</span>) : <span class="apiret">unitIsOwnerOrControllerOfUnit</span> |
− | : [[API UnitIsPlayer|UnitIsPlayer]](<span |
+ | : [[API UnitIsPlayer|UnitIsPlayer]](<span class="apiarg">unit</span>) - Returns true if the unit is a player character. |
− | : [[API UnitIsPossessed|UnitIsPossessed]](<span |
+ | : [[API UnitIsPossessed|UnitIsPossessed]](<span class="apiarg">unit</span>) - Returns true if the unit is currently under control of another (e.g. Mind Control). |
− | : [[API UnitIsQuestBoss|UnitIsQuestBoss]](<span |
+ | : [[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 |
+ | : [[API UnitIsRaidOfficer|UnitIsRaidOfficer]](<span class="apiarg">unit</span>) - Returns whether the specified unit is an officer in your raid. |
− | : [[API UnitIsSameServer|UnitIsSameServer]](<span |
+ | : [[API UnitIsSameServer|UnitIsSameServer]](<span class="apiarg">unit</span>) - Returns true if the unit is from the same (connected) realm. |
: [[API UnitIsTapDenied|UnitIsTapDenied]]() |
: [[API UnitIsTapDenied|UnitIsTapDenied]]() |
||
− | : [[API UnitIsTrivial|UnitIsTrivial]](<span |
+ | : [[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 |
+ | : [[API UnitIsUnit|UnitIsUnit]](<span class="apiarg">unit, otherUnit</span>) - Returns true if the specified units are the same unit. |
− | : [[API UnitIsVisible|UnitIsVisible]](<span |
+ | : [[API UnitIsVisible|UnitIsVisible]](<span class="apiarg">unit</span>) - Returns true if the game client can see the unit. |
: [[API UnitLeadsAnyGroup|UnitLeadsAnyGroup]]() |
: [[API UnitLeadsAnyGroup|UnitLeadsAnyGroup]]() |
||
− | : [[API UnitLevel|UnitLevel]](<span |
+ | : [[API UnitLevel|UnitLevel]](<span class="apiarg">unit</span>) - Returns the level of the unit. |
− | : [[API UnitName|UnitName]](<span |
+ | : [[API UnitName|UnitName]](<span class="apiarg">unit</span>) - Returns the name and realm of the unit. |
+ | : [[API UnitNameUnmodified|UnitNameUnmodified]](<span class="apiarg">unit</span>) |
||
− | : [[API UnitPlayerControlled|UnitPlayerControlled]](<span style="font-size:smaller; color:#ecbc2a">unit</span>) - Returns true if the specified unit is controlled by a player, false otherwise. |
||
− | : [[API |
+ | : [[API UnitPlayerControlled|UnitPlayerControlled]](<span class="apiarg">unit</span>) - Returns true if the unit is controlled by a player. |
− | : [[API |
+ | : [[API UnitPlayerOrPetInParty|UnitPlayerOrPetInParty]](<span class="apiarg">unit</span>) - Returns true if a different unit or pet is a member of the party. |
− | : [[API |
+ | : [[API UnitPlayerOrPetInRaid|UnitPlayerOrPetInRaid]](<span class="apiarg">unit</span>) - Returns 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 the current power resource of the unit. |
||
− | : [[API UnitPowerDisplayMod|UnitPowerDisplayMod]](<span style="font-size:smaller; color:#ecbc2a">powerType</span>) |
||
+ | : [[API UnitPowerDisplayMod|UnitPowerDisplayMod]](<span class="apiarg">powerType</span>) : <span class="apiret">displayMod</span> |
||
− | : [[API UnitPowerMax|UnitPowerMax]](<span style="font-size:smaller; color:#ecbc2a">unit [, type]</span>) - Returns max power of the specified unit (Replaces [[API UnitManaMax|UnitManaMax]]) |
||
− | : [[API |
+ | : [[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 UnitQuestTrivialLevelRange|UnitQuestTrivialLevelRange]]() - Returns the difference between the units' current level and the level at which fixed-level quests are of trivial difficulty. |
||
− | : [[API |
+ | : [[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 |
+ | : [[API UnitRace|UnitRace]](<span class="apiarg">unit</span>) - Returns the race of the unit. |
− | : [[API |
+ | : [[API UnitRangedAttackPower|UnitRangedAttackPower]](<span class="apiarg">unit</span>) - Returns the ranged attack power of the unit. |
− | : [[API |
+ | : [[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 the reaction of the specified unit to another unit. |
||
− | : [[API UnitRealmRelationship|UnitRealmRelationship]]() |
||
+ | : [[API UnitRealmRelationship|UnitRealmRelationship]](<span class="apiarg">unit</span>) |
||
− | : [[API UnitSelectionColor|UnitSelectionColor]](<span style="font-size:smaller; color:#ecbc2a">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 |
+ | : [[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 the selection type of the outline and circle underneath the unit. |
||
: [[API UnitSetRole|UnitSetRole]]() |
: [[API UnitSetRole|UnitSetRole]]() |
||
− | : [[API UnitSex|UnitSex]](<span |
+ | : [[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 |
+ | : [[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 |
+ | : [[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]](<span class="apiarg">unit, mobUnit</span>) |
− | : [[API UnitThreatSituation|UnitThreatSituation]](<span |
+ | : [[API UnitThreatSituation|UnitThreatSituation]](<span class="apiarg">unit, mobUnit</span>) - Returns the threat status of the specified unit to another unit. |
− | : [[API UnitTreatAsPlayerForDisplay|UnitTreatAsPlayerForDisplay]](<span |
+ | : [[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 |
+ | : [[API UnitTrialBankedLevels|UnitTrialBankedLevels]](<span class="apiarg">unit</span>) : <span class="apiret">bankedLevels, xpIntoCurrentLevel, xpForNextLevel</span> |
− | : [[API UnitTrialXP|UnitTrialXP]](<span |
+ | : [[API UnitTrialXP|UnitTrialXP]](<span class="apiarg">unit</span>) |
− | : [[API UnitWeaponAttackPower|UnitWeaponAttackPower]](<span |
+ | : [[API UnitWeaponAttackPower|UnitWeaponAttackPower]](<span class="apiarg">unit</span>) |
− | : [[API UnitXP|UnitXP]](<span |
+ | : [[API UnitXP|UnitXP]](<span class="apiarg">unit</span>) - Returns the current XP of the unit; only works on the player. |
− | : [[API UnitXPMax|UnitXPMax]](<span |
+ | : [[API UnitXPMax|UnitXPMax]](<span class="apiarg">unit</span>) - Returns the maximum XP of the unit; only works on the player. |
− | : |
+ | : [[API GetUnitName|GetUnitName]](<span class="apiarg">unit [, showServerName]</span>) {{apitag|framexml}} - Returns the name and optionally the realm of the unit. |
− | === |
+ | ===Buffs=== |
+ | : [[API CancelUnitBuff|CancelUnitBuff]](<span class="apiarg">unit, index or spell [, filter or rank]</span>) {{apitag|nocombat}} - Removes a specific buff from the character. |
||
− | Players in different [[Phasing|Phases]] cannot see eachother. |
||
− | : [[API |
+ | : [[API UnitAura|UnitAura]](<span class="apiarg">unit, index [, filter]</span>) - Returns the buffs/debuffs for the unit. |
− | : [[API |
+ | : [[API UnitAuraBySlot|UnitAuraBySlot]](<span class="apiarg">unit, slot</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 UnitDebuff|UnitDebuff]](<span class="apiarg">unit, index [, raidFilter]</span>) - Shorthand for <code>UnitAura(unit, index, "HARMFUL")</code> |
||
+ | : [https://github.com/Gethe/wow-ui-source/search?q=FindAura AuraUtil.FindAura](<span class="apiarg">predicate, unit, filter, predicateArg1, predicateArg2, predicateArg3</span>) {{apitag|framexml}} |
||
+ | : [https://github.com/Gethe/wow-ui-source/search?q=FindAuraByName AuraUtil.FindAuraByName](<span class="apiarg">auraName, unit, filter</span>) {{apitag|framexml}} - Finds the first aura that matches the name. |
||
+ | : [https://github.com/Gethe/wow-ui-source/search?q=ForEachAura AuraUtil.ForEachAura](<span class="apiarg">unit, filter, maxCount, func</span>) {{apitag|framexml}} |
||
+ | : [https://github.com/Gethe/wow-ui-source/search?q=ShouldSkipAuraUpdate AuraUtil.ShouldSkipAuraUpdate](<span class="apiarg">isFullUpdate, updatedAuraInfos, isRelevantFunc, ...</span>) {{apitag|framexml}} |
||
+ | Weapon Enchants |
||
+ | : [[API CancelItemTempEnchantment|CancelItemTempEnchantment]](<span class="apiarg">weaponHand</span>) {{apitag|protected}} - Removes temporary weapon enchants (e.g. Rogue poisons and sharpening stones). |
||
+ | : [[API GetWeaponEnchantInfo|GetWeaponEnchantInfo]]() - Returns info for temporary weapon enchantments (e.g. sharpening stones). |
||
− | === |
+ | ===Nameplates=== |
+ | Nameplates were reworked in [[Patch 7.0.3]] |
||
− | : NOCOMBAT [[API CancelUnitBuff|CancelUnitBuff]](<span style="font-size:smaller; color:#ecbc2a">unit, index or spell [, filter or rank]</span>) - Removes a specific buff from the player. |
||
+ | : [[API C_NamePlate.GetNamePlateEnemyClickThrough|C_NamePlate.GetNamePlateEnemyClickThrough]]() |
||
− | : [[API GetPlayerAuraBySpellID|GetPlayerAuraBySpellID]](<span style="font-size:smaller; color:#ecbc2a">spellID</span>) |
||
+ | : [[API C_NamePlate.GetNamePlateEnemyPreferredClickInsets|C_NamePlate.GetNamePlateEnemyPreferredClickInsets]]() |
||
− | : [[API UnitAura|UnitAura]](<span style="font-size:smaller; color:#ecbc2a">unit, index [, filter]</span>) - Returns info about buffs and debuffs of a unit. |
||
+ | : [[API C_NamePlate.GetNamePlateEnemySize|C_NamePlate.GetNamePlateEnemySize]]() |
||
− | : [[API UnitAuraBySlot|UnitAuraBySlot]](<span style="font-size:smaller; color:#ecbc2a">unit, slot</span>) |
||
+ | : [[API C_NamePlate.GetNamePlateForUnit|C_NamePlate.GetNamePlateForUnit]](<span class="apiarg">unitToken [, includeForbidden]</span>) |
||
− | : [[API UnitAuraSlots|UnitAuraSlots]](<span style="font-size:smaller; color:#ecbc2a">unit [, filter, maxSlots, continuationToken]</span>) |
||
+ | : [[API C_NamePlate.GetNamePlateFriendlyClickThrough|C_NamePlate.GetNamePlateFriendlyClickThrough]]() |
||
− | : [[API UnitBuff|UnitBuff]](<span style="font-size:smaller; color:#ecbc2a">unit, index [, raidFilter]</span>) - Shorthand for UnitAura(__, __, "HELPFUL [...]") |
||
+ | : [[API C_NamePlate.GetNamePlateFriendlyPreferredClickInsets|C_NamePlate.GetNamePlateFriendlyPreferredClickInsets]]() |
||
− | : [[API UnitDebuff|UnitDebuff]](<span style="font-size:smaller; color:#ecbc2a">unit, index [, raidFilter]</span>) - Shorthand for UnitAura(__, __, "HARMFUL [...]") |
||
+ | : [[API C_NamePlate.GetNamePlateFriendlySize|C_NamePlate.GetNamePlateFriendlySize]]() |
||
+ | : [[API C_NamePlate.GetNamePlates|C_NamePlate.GetNamePlates]](<span class="apiarg">[includeForbidden]</span>) |
||
+ | : [[API C_NamePlate.GetNamePlateSelfClickThrough|C_NamePlate.GetNamePlateSelfClickThrough]]() |
||
+ | : [[API C_NamePlate.GetNamePlateSelfPreferredClickInsets|C_NamePlate.GetNamePlateSelfPreferredClickInsets]]() |
||
+ | : [[API C_NamePlate.GetNamePlateSelfSize|C_NamePlate.GetNamePlateSelfSize]]() |
||
+ | : [[API C_NamePlate.GetNumNamePlateMotionTypes|C_NamePlate.GetNumNamePlateMotionTypes]]() |
||
+ | : [[API C_NamePlate.GetTargetClampingInsets|C_NamePlate.GetTargetClampingInsets]]() |
||
+ | : [[API C_NamePlate.SetNamePlateEnemyClickThrough|C_NamePlate.SetNamePlateEnemyClickThrough]](<span class="apiarg">clickthrough</span>) |
||
+ | : [[API C_NamePlate.SetNamePlateEnemyPreferredClickInsets|C_NamePlate.SetNamePlateEnemyPreferredClickInsets]]() |
||
+ | : [[API C_NamePlate.SetNamePlateEnemySize|C_NamePlate.SetNamePlateEnemySize]](<span class="apiarg">width, height</span>) |
||
+ | : [[API C_NamePlate.SetNamePlateFriendlyClickThrough|C_NamePlate.SetNamePlateFriendlyClickThrough]]() |
||
+ | : [[API C_NamePlate.SetNamePlateFriendlyPreferredClickInsets|C_NamePlate.SetNamePlateFriendlyPreferredClickInsets]](<span class="apiarg">left, right, top, bottom</span>) |
||
+ | : [[API C_NamePlate.SetNamePlateFriendlySize|C_NamePlate.SetNamePlateFriendlySize]](<span class="apiarg">width, height</span>) |
||
+ | : [[API C_NamePlate.SetNamePlateSelfClickThrough|C_NamePlate.SetNamePlateSelfClickThrough]](<span class="apiarg">clickthrough</span>) |
||
+ | : [[API C_NamePlate.SetNamePlateSelfPreferredClickInsets|C_NamePlate.SetNamePlateSelfPreferredClickInsets]](<span class="apiarg">left, right, top, bottom</span>) |
||
+ | : [[API C_NamePlate.SetNamePlateSelfSize|C_NamePlate.SetNamePlateSelfSize]](<span class="apiarg">width, height</span>) |
||
+ | : [[API C_NamePlate.SetTargetClampingInsets|C_NamePlate.SetTargetClampingInsets]](<span class="apiarg">clickthrough</span>) |
||
+ | : [[API SetInWorldUIVisibility|SetInWorldUIVisibility]](<span class="apiarg">visible</span>) - Allows nameplates to be shown even while the UI is hidden (with Alt-Z) |
||
+ | : [[API UnitNameplateShowsWidgetsOnly|UnitNameplateShowsWidgetsOnly]](<span class="apiarg">unit</span>) : <span class="apiret">nameplateShowsWidgetsOnly</span> |
||
− | === |
+ | ===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. |
||
− | These functions relate to [[Target]]s. |
||
+ | : [[API C_LossOfControl.GetActiveLossOfControlDataByUnit|C_LossOfControl.GetActiveLossOfControlDataByUnit]](<span class="apiarg">unitToken, index</span>) : <span class="apiret">event</span> |
||
− | : PROTECTED [[API AssistUnit|AssistUnit]](<span style="font-size:smaller; color:#ecbc2a">unit</span>) - Instructs your character to assist the specified unit. |
||
+ | : [[API C_LossOfControl.GetActiveLossOfControlDataCount|C_LossOfControl.GetActiveLossOfControlDataCount]]() : <span class="apiret">count</span> - Returns the number of active loss-of-control effects. |
||
− | : PROTECTED [[API ClearFocus|ClearFocus]]() - Removes any focus you may have set. |
||
+ | : [[API C_LossOfControl.GetActiveLossOfControlDataCountByUnit|C_LossOfControl.GetActiveLossOfControlDataCountByUnit]](<span class="apiarg">unitToken</span>) : <span class="apiret">count</span> |
||
− | : PROTECTED [[API ClearTarget|ClearTarget]]() - Clears the selected target. |
||
+ | : [[API GetActionLossOfControlCooldown|GetActionLossOfControlCooldown]](<span class="apiarg">slot</span>) |
||
− | : PROTECTED [[API FocusUnit|FocusUnit]](<span style="font-size:smaller; color:#ecbc2a">unit</span>) - Sets your unit for focus. |
||
+ | : [[API GetSpellLossOfControlCooldown|GetSpellLossOfControlCooldown]](<span class="apiarg">spellSlot</span>) |
||
− | : [[API IsReplacingUnit|IsReplacingUnit]]() |
||
− | : PROTECTED [[API TargetDirectionEnemy|TargetDirectionEnemy]](<span style="font-size:smaller; color:#ecbc2a">facing</span>) |
||
− | : PROTECTED [[API TargetDirectionFinished|TargetDirectionFinished]]() |
||
− | : PROTECTED [[API TargetDirectionFriend|TargetDirectionFriend]](<span style="font-size:smaller; color:#ecbc2a">facing</span>) |
||
− | : PROTECTED [[API TargetLastEnemy|TargetLastEnemy]]() - Selects the last targetted enemy as the current target. |
||
− | : PROTECTED [[API TargetLastFriend|TargetLastFriend]]() |
||
− | : PROTECTED [[API TargetLastTarget|TargetLastTarget]]() - Selects the last target as the current target. |
||
− | : PROTECTED [[API TargetNearestEnemy|TargetNearestEnemy]](<span style="font-size:smaller; color:#ecbc2a">[reverseFlag]</span>) - Selects the nearest enemy as the current target. |
||
− | : PROTECTED [[API TargetNearestEnemyPlayer|TargetNearestEnemyPlayer]](<span style="font-size:smaller; color:#ecbc2a">[reverseFlag]</span>) - Selects the nearest enemy player as the current target. |
||
− | : PROTECTED [[API TargetNearestFriend|TargetNearestFriend]](<span style="font-size:smaller; color:#ecbc2a">[reverseFlag]</span>) - Selects the nearest friendly unit as the current target. |
||
− | : PROTECTED [[API TargetNearestFriendPlayer|TargetNearestFriendPlayer]](<span style="font-size:smaller; color:#ecbc2a">[reverseFlag]</span>) - Selects the nearest friendly player as the current target. |
||
− | : PROTECTED [[API TargetNearest|TargetNearest]]() |
||
− | : PROTECTED [[API TargetNearestPartyMember|TargetNearestPartyMember]]() - Selects the nearest Party member as the current target. |
||
− | : PROTECTED [[API TargetNearestRaidMember|TargetNearestRaidMember]]() - Selects the nearest Raid member as the current target. |
||
− | : PROTECTED [[API TargetPriorityHighlightEnd|TargetPriorityHighlightEnd]]() |
||
− | : PROTECTED [[API TargetPriorityHighlightStart|TargetPriorityHighlightStart]]() |
||
− | : PROTECTED [[API TargetUnit|TargetUnit]](<span style="font-size:smaller; color:#ecbc2a">unit [, exactMatch]</span>) - Selects the specified unit as the current target. |
||
− | === |
+ | ===Phasing=== |
+ | Players in different [[Phasing|Phases]] cannot see eachother. |
||
− | Player information can also be queried with [[#Mixin|PlayerLocation]] objects. |
||
− | : [[API |
+ | : [[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 C_PlayerInfo.GetContentDifficultyCreatureForPlayer|C_PlayerInfo.GetContentDifficultyCreatureForPlayer]](<span style="font-size:smaller; color:#ecbc2a">unitToken</span>) |
||
− | : [[API C_PlayerInfo.GetContentDifficultyQuestForPlayer|C_PlayerInfo.GetContentDifficultyQuestForPlayer]](<span style="font-size:smaller; color:#ecbc2a">questID</span>) |
||
− | : [[API C_PlayerInfo.GetName|C_PlayerInfo.GetName]](<span style="font-size:smaller; color:#ecbc2a">playerLocation</span>) - Returns the name of a player. |
||
− | : [[API C_PlayerInfo.GetRace|C_PlayerInfo.GetRace]](<span style="font-size:smaller; color:#ecbc2a">playerLocation</span>) - Returns the race of a player. |
||
− | : [[API C_PlayerInfo.GetSex|C_PlayerInfo.GetSex]](<span style="font-size:smaller; color:#ecbc2a">playerLocation</span>) - Returns the sex of a player. |
||
− | : [[API C_PlayerInfo.GUIDIsPlayer|C_PlayerInfo.GUIDIsPlayer]](<span style="font-size:smaller; color:#ecbc2a">guid</span>) - Returns true if the guid belongs to a player. |
||
− | : [[API C_PlayerInfo.IsConnected|C_PlayerInfo.IsConnected]](<span style="font-size:smaller; color:#ecbc2a">[playerLocation]</span>) - Returns true if a player is connected. |
||
− | : [[API C_PlayerInfo.UnitIsSameServer|C_PlayerInfo.UnitIsSameServer]](<span style="font-size:smaller; color:#ecbc2a">playerLocation</span>) - Returns true if another player is from your own or connected realm. |
||
− | : [[API C_LevelSquish.ConvertFollowerLevel|C_LevelSquish.ConvertFollowerLevel]](<span style="font-size:smaller; color:#ecbc2a">level, maxFollowerLevel</span>) |
||
− | : [[API C_LevelSquish.ConvertPlayerLevel|C_LevelSquish.ConvertPlayerLevel]](<span style="font-size:smaller; color:#ecbc2a">level</span>) |
||
− | : [[API GetPlayerInfoByGUID|GetPlayerInfoByGUID]](<span style="font-size:smaller; color:#ecbc2a">guid</span>) - Returns race, class, sex about the guid (client must have seen the guid) |
||
− | === |
+ | ===Power Bar=== |
− | : [[API GetUnitPowerBarInfo|GetUnitPowerBarInfo]](<span |
+ | : [[API GetUnitPowerBarInfo|GetUnitPowerBarInfo]](<span class="apiarg">unitToken</span>) : <span class="apiret">info</span> |
− | : [[API GetUnitPowerBarInfoByID|GetUnitPowerBarInfoByID]](<span |
+ | : [[API GetUnitPowerBarInfoByID|GetUnitPowerBarInfoByID]](<span class="apiarg">barID</span>) : <span class="apiret">info</span> |
− | : [[API GetUnitPowerBarStrings|GetUnitPowerBarStrings]](<span |
+ | : [[API GetUnitPowerBarStrings|GetUnitPowerBarStrings]](<span class="apiarg">unitToken</span>) : <span class="apiret">name, tooltip, cost</span> |
− | : [[API GetUnitPowerBarStringsByID|GetUnitPowerBarStringsByID]](<span |
+ | : [[API GetUnitPowerBarStringsByID|GetUnitPowerBarStringsByID]](<span class="apiarg">barID</span>) : <span class="apiret">name, tooltip, cost</span> |
− | : [[API GetUnitPowerBarTextureInfo|GetUnitPowerBarTextureInfo]](<span |
+ | : [[API GetUnitPowerBarTextureInfo|GetUnitPowerBarTextureInfo]](<span class="apiarg">unitToken, textureIndex [, timerIndex]</span>) : <span class="apiret">texture, colorR, colorG, colorB, colorA</span> |
− | : [[API GetUnitPowerBarTextureInfoByID|GetUnitPowerBarTextureInfoByID]](<span |
+ | : [[API GetUnitPowerBarTextureInfoByID|GetUnitPowerBarTextureInfoByID]](<span class="apiarg">barID, textureIndex</span>) : <span class="apiret">texture, colorR, colorG, colorB, colorA</span> |
: [[API UnitNumPowerBarTimers|UnitNumPowerBarTimers]]() |
: [[API UnitNumPowerBarTimers|UnitNumPowerBarTimers]]() |
||
− | : [[API UnitPowerBarID|UnitPowerBarID]](<span |
+ | : [[API UnitPowerBarID|UnitPowerBarID]](<span class="apiarg">unitToken</span>) : <span class="apiret">barID</span> |
: [[API UnitPowerBarTimerInfo|UnitPowerBarTimerInfo]]() |
: [[API UnitPowerBarTimerInfo|UnitPowerBarTimerInfo]]() |
||
− | : DEPRECATED (8.3.0) [[API GetAlternatePowerInfoByID|GetAlternatePowerInfoByID]](<span style="font-size:smaller; color:#ecbc2a">id</span>) |
||
− | : DEPRECATED (8.3.0) [[API UnitAlternatePowerCounterInfo|UnitAlternatePowerCounterInfo]](<span style="font-size:smaller; color:#ecbc2a">unit</span>) |
||
− | : DEPRECATED (8.3.0) [[API UnitAlternatePowerInfo|UnitAlternatePowerInfo]](<span style="font-size:smaller; color:#ecbc2a">unit</span>) |
||
− | : DEPRECATED (8.3.0) [[API UnitAlternatePowerTextureInfo|UnitAlternatePowerTextureInfo]](<span style="font-size:smaller; color:#ecbc2a">unit, textureIndex [, timerIndex]</span>) |
||
− | == |
+ | ==Vehicles== |
+ | These functions were added in [[Patch 3.0.2]] |
||
− | : [[API Ambiguate|Ambiguate]](<span style="font-size:smaller; color:#ecbc2a">fullName, context</span>) - Returns a version of a character-realm string suitable for use in a given context. |
||
+ | : [[API C_PvP.GetBattlefieldVehicleInfo|C_PvP.GetBattlefieldVehicleInfo]](<span class="apiarg">vehicleIndex, uiMapID</span>) : <span class="apiret">info</span> |
||
− | : [[API BreakUpLargeNumbers|BreakUpLargeNumbers]](<span style="font-size:smaller; color:#ecbc2a">number [, natural]</span>) - Converts a number into a localized string, grouping digits as required. |
||
+ | : [[API C_PvP.GetBattlefieldVehicles|C_PvP.GetBattlefieldVehicles]](<span class="apiarg">uiMapID</span>) : <span class="apiret">vehicles</span> |
||
− | : [[API CalculateStringEditDistance|CalculateStringEditDistance]](<span style="font-size:smaller; color:#ecbc2a">firstString, secondString</span>) - Returns [https://en.wikipedia.org/wiki/Levenshtein_distance Levenshtein] distance. |
||
+ | : [[API CanEjectPassengerFromSeat|CanEjectPassengerFromSeat]](<span class="apiarg">seat</span>) - Returns 1 if the player can eject a passenger from a seat. |
||
− | : [[API CaseAccentInsensitiveParse|CaseAccentInsensitiveParse]](<span style="font-size:smaller; color:#ecbc2a">string</span>) |
||
− | : [[API IsRecognizedName|IsRecognizedName]](<span style="font-size:smaller; color:#ecbc2a">text, includeBitField, excludeBitField</span>) - Not used in FrameXML. |
||
− | : UI [https://www.townlong-yak.com/framexml/go/ExecuteFrameScript ExecuteFrameScript](<span style="font-size:smaller; color:#ecbc2a">frame, scriptName, ...</span>) - Manually calls the handler for a frame script. |
||
− | : UI [https://www.townlong-yak.com/framexml/go/ExtractHyperlinkString ExtractHyperlinkString](<span style="font-size:smaller; color:#ecbc2a">linkString</span>) - Strips any color coding from a [[UI_escape_sequences#Hyperlinks|hyperlink]]. |
||
− | : UI [https://www.townlong-yak.com/framexml/go/Flags_CreateMask Flags_CreateMask](<span style="font-size:smaller; color:#ecbc2a">...</span>) - Creates a bitmask. |
||
− | : UI [https://www.townlong-yak.com/framexml/go/FormatLargeNumber FormatLargeNumber](<span style="font-size:smaller; color:#ecbc2a">amount</span>) - Formats a number with dot or comma number seperators. |
||
− | : UI [[API GetRandomArgument|GetRandomArgument]](<span style="font-size:smaller; color:#ecbc2a">...</span>) |
||
− | : UI [https://www.townlong-yak.com/framexml/go/Lerp Lerp](<span style="font-size:smaller; color:#ecbc2a">startValue, endValue, amount</span>) - Linearly interpolation between two values for a parameter in the closed unit interval [0, 1] |
||
− | : UI [https://www.townlong-yak.com/framexml/go/Round Round](<span style="font-size:smaller; color:#ecbc2a">value</span>) - Rounds a value. |
||
− | : UI [[API SetItemRef|SetItemRef]](<span style="font-size:smaller; color:#ecbc2a">link, text, button</span>) - Handles item link tooltips in chat. |
||
− | : UI [https://www.townlong-yak.com/framexml/go/CopyTable CopyTable](<span style="font-size:smaller; color:#ecbc2a">tbl</span>) - Returns a deep copy of a table. |
||
− | : UI [https://www.townlong-yak.com/framexml/go/tAppendAll tAppendAll](<span style="font-size:smaller; color:#ecbc2a">tbl, addedArray</span>) - Appends the contents of a sequential table to another table. |
||
− | : UI [https://www.townlong-yak.com/framexml/go/tCompare tCompare](<span style="font-size:smaller; color:#ecbc2a">lhsTable, rhsTable, depth</span>) - Does a deep compare on the values of the table. |
||
− | : UI [https://www.townlong-yak.com/framexml/go/tInvert tInvert](<span style="font-size:smaller; color:#ecbc2a">tbl</span>) - Returns an inverted table. |
||
− | : UI [https://www.townlong-yak.com/framexml/go/tIndexOf tIndexOf](<span style="font-size:smaller; color:#ecbc2a">tbl, item</span>) - Returns the index for a value in a table. |
||
− | : UI [[API tContains|tContains]](<span style="font-size:smaller; color:#ecbc2a">tbl, item</span>) - Returns true if a (sequential) table contains a value. |
||
− | : UI [https://www.townlong-yak.com/framexml/go/tDeleteItem tDeleteItem](<span style="font-size:smaller; color:#ecbc2a">tbl, item</span>) - Removes a value from a sequential table. |
||
− | : UI [https://www.townlong-yak.com/framexml/go/tostringall tostringall](<span style="font-size:smaller; color:#ecbc2a">...</span>) - Converts and returns the passed arguments to string. |
||
− | |||
− | ==== Mixin ==== |
||
− | These interfaces are defined in FrameXML. |
||
− | : UI [[API Mixin|Mixin]](<span style="font-size:smaller; color:#ecbc2a">object, ...</span>) - Mixins mixins into an existing object and returns that. |
||
− | : UI [[API CreateFromMixins|CreateFromMixins]](<span style="font-size:smaller; color:#ecbc2a">...</span>) - Mixins mixins into a new object and returns that. |
||
− | |||
− | : UI [https://www.townlong-yak.com/framexml/go/CreateColor CreateColor](<span style="font-size:smaller; color:#ecbc2a">r, g, b, a</span>) - Returns a [[ColorMixin]] object. |
||
− | : UI [https://www.townlong-yak.com/framexml/go/CreateRectangle CreateRectangle](<span style="font-size:smaller; color:#ecbc2a">left, right, top, bottom</span>) - Returns a [[RectangleMixin]] object. |
||
− | : UI [[API CreateVector2D|CreateVector2D]](<span style="font-size:smaller; color:#ecbc2a">x, y</span>) - Returns a [[Vector2DMixin]] object. |
||
− | : UI [[API CreateVector3D|CreateVector3D]](<span style="font-size:smaller; color:#ecbc2a">x, y, z</span>) - Returns a [[Vector3DMixin]] object. |
||
− | SpellMixin |
||
− | : UI [https://www.townlong-yak.com/framexml/8.1.5/ObjectAPI/Spell.lua#6 SpellMixin:CreateFromSpellID](<span style="font-size:smaller; color:#ecbc2a">spellID</span>) - Returns a [[SpellMixin]] object for a spell id |
||
− | : UI [https://www.townlong-yak.com/framexml/8.1.5/ObjectAPI/Spell.lua#50 SpellMixin:ContinueOnSpellLoad](<span style="font-size:smaller; color:#ecbc2a">callback</span>) - Allows querying spell data asynchronously. |
||
− | ItemMixin |
||
− | : UI [https://www.townlong-yak.com/framexml/8.1.5/ObjectAPI/Item.lua#42 Item:CreateFromItemID](<span style="font-size:smaller; color:#ecbc2a">itemID</span>) - Returns an [[ItemMixin]] object for an item id. |
||
− | : UI [https://www.townlong-yak.com/framexml/8.1.5/ObjectAPI/Item.lua#33 Item:CreateFromItemLink](<span style="font-size:smaller; color:#ecbc2a">itemLink</span>) - Returns an ItemMixin object for an item link. |
||
− | : UI [https://www.townlong-yak.com/framexml/8.1.5/ObjectAPI/Item.lua#6 Item:CreateFromItemLocation](<span style="font-size:smaller; color:#ecbc2a">itemLocation</span>) - Returns an ItemMixin object for an ItemLocationMixin object. |
||
− | : UI [https://www.townlong-yak.com/framexml/8.1.5/ObjectAPI/Item.lua#232 Item:ContinueOnItemLoad](<span style="font-size:smaller; color:#ecbc2a">callback</span>) - Allows querying item data asynchronously. |
||
− | ItemLocationMixin |
||
− | : UI [https://www.townlong-yak.com/framexml/8.1.5/ObjectAPI/ItemLocation.lua#4 ItemLocation:CreateEmpty]() - Returns an [[ItemLocationMixin]] object. |
||
− | : UI [https://www.townlong-yak.com/framexml/8.1.5/ObjectAPI/ItemLocation.lua#9 ItemLocation:CreateFromBagAndSlot](<span style="font-size:smaller; color:#ecbc2a">bagID, slotIndex</span>) - Returns an ItemLocationMixin object for a bag slot. |
||
− | : UI [https://www.townlong-yak.com/framexml/8.1.5/ObjectAPI/ItemLocation.lua#15 ItemLocation:CreateFromEquipmentSlot](<span style="font-size:smaller; color:#ecbc2a">equipmentSlotIndex</span>) - Returns an ItemLocationMixin object for an equipment slot. |
||
− | PlayerLocationMixin |
||
− | : UI [https://www.townlong-yak.com/framexml/8.1.5/ObjectAPI/PlayerLocation.lua#4 PlayerLocation:CreateFromGUID](<span style="font-size:smaller; color:#ecbc2a">guid</span>) - Returns a [[PlayerLocationMixin]] object for a guid. |
||
− | : UI [https://www.townlong-yak.com/framexml/8.1.5/ObjectAPI/PlayerLocation.lua#16 PlayerLocation:CreateFromChatLineID](<span style="font-size:smaller; color:#ecbc2a">lineID</span>) - Returns a PlayerLocationMixin object for a chat message. |
||
− | : UI [https://www.townlong-yak.com/framexml/8.1.5/ObjectAPI/PlayerLocation.lua#10 PlayerLocation:CreateFromUnit](<span style="font-size:smaller; color:#ecbc2a">unit</span>) - Returns a PlayerLocationMixin object for a unit. |
||
− | ObjectPoolMixin |
||
− | : UI [[API CreateObjectPool|CreateObjectPool]](<span style="font-size:smaller; color:#ecbc2a">creationFunc, resetterFunc</span>) - Creates a [[ObjectPoolMixin]] to construct reusable [[UIOBJECT UIObject|widgets]]. |
||
− | : UI [[API ObjectPoolMixin Acquire|ObjectPoolMixin:Acquire]]() - Furnishes a [[UIOBJECT UIObject|widget]] from the pool. |
||
− | : UI [[API ObjectPoolMixin Release|ObjectPoolMixin:Release]](<span style="font-size:smaller; color:#ecbc2a">widget</span>) - Returns a [[UIOBJECT UIObject|widget]] back to the pool for reuse. |
||
− | : UI [[API CreateFramePool|CreateFramePool]](<span style="font-size:smaller; color:#ecbc2a">frameType [, parent, frameTemplate, resetterFunc, forbidden]</span>) - Creates a [[FramePoolMixin]] to construct reusable [[UIOBJECT Frame|Frames]]. |
||
− | : UI [[API CreateTexturePool|CreateTexturePool]](<span style="font-size:smaller; color:#ecbc2a">parent [, layer, subLayer, textureTemplate, resetterFunc]</span>) - Creates a [[TexturePoolMixin]] to construct reusable [[UIOBJECT Texture|Textures]]. |
||
− | : UI [[API CreateFontStringPool|CreateFontStringPool]](<span style="font-size:smaller; color:#ecbc2a">parent [, layer, subLayer, fontStringTemplate, resetterFunc]</span>) - Creates a [[FontStringPoolMixin]] to construct reusable [[UIOBJECT FontString|FontStrings]]. |
||
− | : UI [[API CreateActorPool|CreateActorPool]](<span style="font-size:smaller; color:#ecbc2a">parent [, actorTemplate, resetterFunc]</span>) - Creates an [[ActorPoolMixin]] to construct reusable [[UIOBJECT Actor|Actors]]. |
||
− | : UI [https://www.townlong-yak.com/framexml/go/CreateFramePoolCollection CreateFramePoolCollection]() - Creates a [[FramePoolCollectionMixin]] object to manage several [[FramePoolMixin|frame pools]]. |
||
− | |||
− | === Vehicles === |
||
− | These functions were added in [[Patch 3.0.2]]. |
||
− | : [[API C_PvP.GetBattlefieldVehicleInfo|C_PvP.GetBattlefieldVehicleInfo]](<span style="font-size:smaller; color:#ecbc2a">index</span>) |
||
− | : [[API C_PvP.GetBattlefieldVehicles|C_PvP.GetBattlefieldVehicles]](<span style="font-size:smaller; color:#ecbc2a">uiMapID</span>) |
||
− | : [[API CanEjectPassengerFromSeat|CanEjectPassengerFromSeat]](<span style="font-size:smaller; color:#ecbc2a">seat</span>) - Returns 1 if the player can eject a passenger from a seat. |
||
: [[API CanExitVehicle|CanExitVehicle]]() - Returns 1 if the player can be exit the Vehicle. |
: [[API CanExitVehicle|CanExitVehicle]]() - Returns 1 if the player can be exit the Vehicle. |
||
: [[API CanSwitchVehicleSeat|CanSwitchVehicleSeat]]() |
: [[API CanSwitchVehicleSeat|CanSwitchVehicleSeat]]() |
||
: [[API CanSwitchVehicleSeats|CanSwitchVehicleSeats]]() - Returns 1 if the player can Switch Seats in the Vehicle. |
: [[API CanSwitchVehicleSeats|CanSwitchVehicleSeats]]() - Returns 1 if the player can Switch Seats in the Vehicle. |
||
− | : [[API EjectPassengerFromSeat|EjectPassengerFromSeat]](<span |
+ | : [[API EjectPassengerFromSeat|EjectPassengerFromSeat]](<span class="apiarg">seat</span>) - Ejects a passenger from a seat. |
− | : [[API GetNumBattlefieldVehicles|GetNumBattlefieldVehicles]](<span |
+ | : [[API GetNumBattlefieldVehicles|GetNumBattlefieldVehicles]](<span class="apiarg">index</span>) |
− | : [[API GetVehicleUIIndicator|GetVehicleUIIndicator]](<span |
+ | : [[API GetVehicleUIIndicator|GetVehicleUIIndicator]](<span class="apiarg">indicatorID</span>) |
− | : [[API GetVehicleUIIndicatorSeat|GetVehicleUIIndicatorSeat]](<span |
+ | : [[API GetVehicleUIIndicatorSeat|GetVehicleUIIndicatorSeat]](<span class="apiarg">indicatorID, indicatorSeatIndex</span>) |
: [[API IsUsingVehicleControls|IsUsingVehicleControls]]() |
: [[API IsUsingVehicleControls|IsUsingVehicleControls]]() |
||
: [[API IsVehicleAimAngleAdjustable|IsVehicleAimAngleAdjustable]]() - Returns 1 if the player can adjust the Aim Angle of the Vehicle. |
: [[API IsVehicleAimAngleAdjustable|IsVehicleAimAngleAdjustable]]() - Returns 1 if the player can adjust the Aim Angle of the Vehicle. |
||
: [[API IsVehicleAimPowerAdjustable|IsVehicleAimPowerAdjustable]]() - Returns 1 if the player can adjust the Aim Power of the Vehicle. |
: [[API IsVehicleAimPowerAdjustable|IsVehicleAimPowerAdjustable]]() - Returns 1 if the player can adjust the Aim Power of the Vehicle. |
||
− | : [[API PlayerVehicleHasComboPoints|PlayerVehicleHasComboPoints]]() |
+ | : [[API PlayerVehicleHasComboPoints|PlayerVehicleHasComboPoints]]() : <span class="apiret">vehicleHasComboPoints</span> |
− | : [[API UnitControllingVehicle|UnitControllingVehicle]](<span |
+ | : [[API UnitControllingVehicle|UnitControllingVehicle]](<span class="apiarg">unit</span>) |
: [[API UnitHasVehiclePlayerFrameUI|UnitHasVehiclePlayerFrameUI]]() |
: [[API UnitHasVehiclePlayerFrameUI|UnitHasVehiclePlayerFrameUI]]() |
||
− | : [[API UnitHasVehicleUI|UnitHasVehicleUI]](<span |
+ | : [[API UnitHasVehicleUI|UnitHasVehicleUI]](<span class="apiarg">unit</span>) |
− | : [[API UnitInVehicle|UnitInVehicle]](<span |
+ | : [[API UnitInVehicle|UnitInVehicle]](<span class="apiarg">unit</span>) |
− | : [[API UnitInVehicleControlSeat|UnitInVehicleControlSeat]](<span |
+ | : [[API UnitInVehicleControlSeat|UnitInVehicleControlSeat]](<span class="apiarg">unit</span>) |
: [[API UnitInVehicleHidesPetFrame|UnitInVehicleHidesPetFrame]]() |
: [[API UnitInVehicleHidesPetFrame|UnitInVehicleHidesPetFrame]]() |
||
− | : [[API UnitSwitchToVehicleSeat|UnitSwitchToVehicleSeat]](<span |
+ | : [[API UnitSwitchToVehicleSeat|UnitSwitchToVehicleSeat]](<span class="apiarg">unit, seatId</span>) |
− | : [[API UnitTargetsVehicleInRaidUI|UnitTargetsVehicleInRaidUI]](<span |
+ | : [[API UnitTargetsVehicleInRaidUI|UnitTargetsVehicleInRaidUI]](<span class="apiarg">unit</span>) |
− | : [[API UnitUsingVehicle|UnitUsingVehicle]](<span |
+ | : [[API UnitUsingVehicle|UnitUsingVehicle]](<span class="apiarg">unit</span>) - Returns true if the unit is currently in a vehicle. |
− | : [[API UnitVehicleSeatCount|UnitVehicleSeatCount]](<span |
+ | : [[API UnitVehicleSeatCount|UnitVehicleSeatCount]](<span class="apiarg">unit</span>) |
− | : [[API UnitVehicleSeatInfo|UnitVehicleSeatInfo]](<span |
+ | : [[API UnitVehicleSeatInfo|UnitVehicleSeatInfo]](<span class="apiarg">unit, seatId</span>) |
− | : [[API UnitVehicleSkin|UnitVehicleSkin]](<span |
+ | : [[API UnitVehicleSkin|UnitVehicleSkin]](<span class="apiarg">unit</span>) |
: [[API VehicleAimDecrement|VehicleAimDecrement]]() |
: [[API VehicleAimDecrement|VehicleAimDecrement]]() |
||
: [[API VehicleAimDownStart|VehicleAimDownStart]]() |
: [[API VehicleAimDownStart|VehicleAimDownStart]]() |
||
: [[API VehicleAimDownStop|VehicleAimDownStop]]() |
: [[API VehicleAimDownStop|VehicleAimDownStop]]() |
||
− | : [[API VehicleAimGetAngle|VehicleAimGetAngle]]() |
||
− | : [[API VehicleAimGetNormAngle|VehicleAimGetNormAngle]]() |
||
: [[API VehicleAimGetNormPower|VehicleAimGetNormPower]]() |
: [[API VehicleAimGetNormPower|VehicleAimGetNormPower]]() |
||
: [[API VehicleAimIncrement|VehicleAimIncrement]]() |
: [[API VehicleAimIncrement|VehicleAimIncrement]]() |
||
: [[API VehicleAimRequestAngle|VehicleAimRequestAngle]]() |
: [[API VehicleAimRequestAngle|VehicleAimRequestAngle]]() |
||
− | : [[API VehicleAimRequestNormAngle|VehicleAimRequestNormAngle]]() |
||
: [[API VehicleAimSetNormPower|VehicleAimSetNormPower]]() |
: [[API VehicleAimSetNormPower|VehicleAimSetNormPower]]() |
||
: [[API VehicleAimUpStart|VehicleAimUpStart]]() |
: [[API VehicleAimUpStart|VehicleAimUpStart]]() |
||
Line 4,617: | Line 5,328: | ||
: [[API VehiclePrevSeat|VehiclePrevSeat]]() |
: [[API VehiclePrevSeat|VehiclePrevSeat]]() |
||
+ | ==Warlords of Draenor== |
||
− | ==== Weekly Rewards ==== |
||
+ | ===Garrison Tech=== |
||
− | : [[API C_WeeklyRewards.CanClaimRewards|C_WeeklyRewards.CanClaimRewards]]() |
||
+ | [[Garrison]]s were added in [[Patch 6.0.2]] and also utilized in later expanions. |
||
− | : [[API C_WeeklyRewards.ClaimReward|C_WeeklyRewards.ClaimReward]](<span style="font-size:smaller; color:#ecbc2a">id</span>) |
||
− | : [[API C_WeeklyRewards.CloseInteraction|C_WeeklyRewards.CloseInteraction]]() |
||
− | : [[API C_WeeklyRewards.GetActivities|C_WeeklyRewards.GetActivities]](<span style="font-size:smaller; color:#ecbc2a">[type]</span>) |
||
− | : [[API C_WeeklyRewards.GetConquestWeeklyProgress|C_WeeklyRewards.GetConquestWeeklyProgress]]() |
||
− | : [[API C_WeeklyRewards.GetExampleRewardItemHyperlinks|C_WeeklyRewards.GetExampleRewardItemHyperlinks]](<span style="font-size:smaller; color:#ecbc2a">id</span>) |
||
− | : [[API C_WeeklyRewards.GetItemHyperlink|C_WeeklyRewards.GetItemHyperlink]](<span style="font-size:smaller; color:#ecbc2a">itemDBID</span>) |
||
− | : [[API C_WeeklyRewards.HasAvailableRewards|C_WeeklyRewards.HasAvailableRewards]]() |
||
− | : [[API C_WeeklyRewards.HasGeneratedRewards|C_WeeklyRewards.HasGeneratedRewards]]() |
||
− | |||
− | === Warlords of Draenor === |
||
− | ==== Garrison Tech ==== |
||
− | [[Garrison]]s were added in [[Patch 6.0.2]]. Also used for [[Class Hall]]s and [[War Campaign]]s. |
||
− | : [[API C_Garrison.CanGenerateRecruits|C_Garrison.CanGenerateRecruits]]() |
||
− | : [[API C_Garrison.CanSetRecruitmentPreference|C_Garrison.CanSetRecruitmentPreference]]() |
||
: [[API C_Garrison.CanUpgradeGarrison|C_Garrison.CanUpgradeGarrison]]() |
: [[API C_Garrison.CanUpgradeGarrison|C_Garrison.CanUpgradeGarrison]]() |
||
− | : [[API C_Garrison.ClearCompleteTalent|C_Garrison.ClearCompleteTalent]](<span |
+ | : [[API C_Garrison.ClearCompleteTalent|C_Garrison.ClearCompleteTalent]](<span class="apiarg">garrisonType</span>) |
: [[API C_Garrison.CloseArchitect|C_Garrison.CloseArchitect]]() |
: [[API C_Garrison.CloseArchitect|C_Garrison.CloseArchitect]]() |
||
: [[API C_Garrison.CloseGarrisonTradeskillNPC|C_Garrison.CloseGarrisonTradeskillNPC]]() |
: [[API C_Garrison.CloseGarrisonTradeskillNPC|C_Garrison.CloseGarrisonTradeskillNPC]]() |
||
− | : [[API C_Garrison.CloseRecruitmentNPC|C_Garrison.CloseRecruitmentNPC]]() |
||
: [[API C_Garrison.CloseTalentNPC|C_Garrison.CloseTalentNPC]]() |
: [[API C_Garrison.CloseTalentNPC|C_Garrison.CloseTalentNPC]]() |
||
: [[API C_Garrison.CloseTradeskillCrafter|C_Garrison.CloseTradeskillCrafter]]() |
: [[API C_Garrison.CloseTradeskillCrafter|C_Garrison.CloseTradeskillCrafter]]() |
||
− | : [[API C_Garrison.GenerateRecruits|C_Garrison.GenerateRecruits]](<span style="font-size:smaller; color:#ecbc2a">mechanicTypeID, traitID</span>) |
||
: [[API C_Garrison.GetAllBonusAbilityEffects|C_Garrison.GetAllBonusAbilityEffects]]() |
: [[API C_Garrison.GetAllBonusAbilityEffects|C_Garrison.GetAllBonusAbilityEffects]]() |
||
− | : [[API C_Garrison. |
+ | : [[API C_Garrison.GetCompleteTalent|C_Garrison.GetCompleteTalent]](<span class="apiarg">garrisonType</span>) |
− | : [[API C_Garrison. |
+ | : [[API C_Garrison.GetCurrencyTypes|C_Garrison.GetCurrencyTypes]](<span class="apiarg">garrType</span>) |
− | : [[API C_Garrison. |
+ | : [[API C_Garrison.GetCurrentGarrTalentTreeFriendshipFactionID|C_Garrison.GetCurrentGarrTalentTreeFriendshipFactionID]]() : <span class="apiret">currentGarrTalentTreeFriendshipFactionID</span> |
− | : [[API C_Garrison. |
+ | : [[API C_Garrison.GetCurrentGarrTalentTreeID|C_Garrison.GetCurrentGarrTalentTreeID]]() : <span class="apiret">currentGarrTalentTreeID</span> |
− | : [[API C_Garrison. |
+ | : [[API C_Garrison.GetGarrisonInfo|C_Garrison.GetGarrisonInfo]](<span class="apiarg">garrisonType</span>) |
− | : [[API C_Garrison. |
+ | : [[API C_Garrison.GetGarrisonTalentTreeCurrencyTypes|C_Garrison.GetGarrisonTalentTreeCurrencyTypes]](<span class="apiarg">garrTalentTreeID</span>) : <span class="apiret">garrTalentTreeCurrencyType</span> |
− | : [[API C_Garrison. |
+ | : [[API C_Garrison.GetGarrisonTalentTreeType|C_Garrison.GetGarrisonTalentTreeType]](<span class="apiarg">garrTalentTreeID</span>) : <span class="apiret">garrTalentTreeType</span> |
− | : [[API C_Garrison. |
+ | : [[API C_Garrison.GetGarrisonUpgradeCost|C_Garrison.GetGarrisonUpgradeCost]](<span class="apiarg">followerType</span>) |
− | : [[API C_Garrison.GetCurrentGarrTalentTreeFriendshipFactionID|C_Garrison.GetCurrentGarrTalentTreeFriendshipFactionID]]() |
||
− | : [[API C_Garrison.GetCurrentGarrTalentTreeID|C_Garrison.GetCurrentGarrTalentTreeID]]() |
||
− | : [[API C_Garrison.GetFollowerAutoCombatSpells|C_Garrison.GetFollowerAutoCombatSpells]](<span style="font-size:smaller; color:#ecbc2a">garrFollowerID, followerLevel</span>) |
||
− | : [[API C_Garrison.GetFollowerAutoCombatStats|C_Garrison.GetFollowerAutoCombatStats]](<span style="font-size:smaller; color:#ecbc2a">garrFollowerID</span>) |
||
− | : [[API C_Garrison.GetGarrisonInfo|C_Garrison.GetGarrisonInfo]](<span style="font-size:smaller; color:#ecbc2a">garrisonType</span>) |
||
− | : [[API C_Garrison.GetGarrisonTalentTreeCurrencyTypes|C_Garrison.GetGarrisonTalentTreeCurrencyTypes]](<span style="font-size:smaller; color:#ecbc2a">garrTalentTreeID</span>) |
||
− | : [[API C_Garrison.GetGarrisonTalentTreeType|C_Garrison.GetGarrisonTalentTreeType]](<span style="font-size:smaller; color:#ecbc2a">garrTalentTreeID</span>) |
||
− | : [[API C_Garrison.GetGarrisonUpgradeCost|C_Garrison.GetGarrisonUpgradeCost]](<span style="font-size:smaller; color:#ecbc2a">followerType</span>) |
||
: [[API C_Garrison.GetLandingPageGarrisonType|C_Garrison.GetLandingPageGarrisonType]]() |
: [[API C_Garrison.GetLandingPageGarrisonType|C_Garrison.GetLandingPageGarrisonType]]() |
||
− | : [[API C_Garrison.GetLandingPageItems|C_Garrison.GetLandingPageItems]](<span |
+ | : [[API C_Garrison.GetLandingPageItems|C_Garrison.GetLandingPageItems]](<span class="apiarg">garrTypeID [, noSort]</span>) |
: [[API C_Garrison.GetLandingPageShipmentCount|C_Garrison.GetLandingPageShipmentCount]]() |
: [[API C_Garrison.GetLandingPageShipmentCount|C_Garrison.GetLandingPageShipmentCount]]() |
||
− | : [[API C_Garrison.GetLandingPageShipmentInfoByContainerID|C_Garrison.GetLandingPageShipmentInfoByContainerID]](<span |
+ | : [[API C_Garrison.GetLandingPageShipmentInfoByContainerID|C_Garrison.GetLandingPageShipmentInfoByContainerID]](<span class="apiarg">shipmentContainerID</span>) |
− | : [[API C_Garrison.GetLooseShipments|C_Garrison.GetLooseShipments]](<span |
+ | : [[API C_Garrison.GetLooseShipments|C_Garrison.GetLooseShipments]](<span class="apiarg">garrTypeID</span>) |
− | : [[API C_Garrison.GetMissionEncounterIconInfo|C_Garrison.GetMissionEncounterIconInfo]](<span style="font-size:smaller; color:#ecbc2a">missionID</span>) |
||
: [[API C_Garrison.GetNumPendingShipments|C_Garrison.GetNumPendingShipments]]() |
: [[API C_Garrison.GetNumPendingShipments|C_Garrison.GetNumPendingShipments]]() |
||
: [[API C_Garrison.GetNumShipmentCurrencies|C_Garrison.GetNumShipmentCurrencies]]() |
: [[API C_Garrison.GetNumShipmentCurrencies|C_Garrison.GetNumShipmentCurrencies]]() |
||
: [[API C_Garrison.GetNumShipmentReagents|C_Garrison.GetNumShipmentReagents]]() |
: [[API C_Garrison.GetNumShipmentReagents|C_Garrison.GetNumShipmentReagents]]() |
||
− | : [[API C_Garrison.GetPendingShipmentInfo|C_Garrison.GetPendingShipmentInfo]](<span |
+ | : [[API C_Garrison.GetPendingShipmentInfo|C_Garrison.GetPendingShipmentInfo]](<span class="apiarg">index</span>) |
− | : [[API C_Garrison.GetRecruitAbilities|C_Garrison.GetRecruitAbilities]](<span style="font-size:smaller; color:#ecbc2a">index</span>) |
||
− | : [[API C_Garrison.GetRecruiterAbilityCategories|C_Garrison.GetRecruiterAbilityCategories]]() |
||
− | : [[API C_Garrison.GetRecruiterAbilityList|C_Garrison.GetRecruiterAbilityList]](<span style="font-size:smaller; color:#ecbc2a">traits</span>) |
||
− | : [[API C_Garrison.GetRecruitmentPreferences|C_Garrison.GetRecruitmentPreferences]]() |
||
: [[API C_Garrison.GetShipmentContainerInfo|C_Garrison.GetShipmentContainerInfo]]() |
: [[API C_Garrison.GetShipmentContainerInfo|C_Garrison.GetShipmentContainerInfo]]() |
||
: [[API C_Garrison.GetShipmentItemInfo|C_Garrison.GetShipmentItemInfo]]() |
: [[API C_Garrison.GetShipmentItemInfo|C_Garrison.GetShipmentItemInfo]]() |
||
− | : [[API C_Garrison.GetShipmentReagentCurrencyInfo|C_Garrison.GetShipmentReagentCurrencyInfo]](<span |
+ | : [[API C_Garrison.GetShipmentReagentCurrencyInfo|C_Garrison.GetShipmentReagentCurrencyInfo]](<span class="apiarg">currencyIndex</span>) |
− | : [[API C_Garrison.GetShipmentReagentInfo|C_Garrison.GetShipmentReagentInfo]](<span |
+ | : [[API C_Garrison.GetShipmentReagentInfo|C_Garrison.GetShipmentReagentInfo]](<span class="apiarg">reagentIndex</span>) |
− | : [[API C_Garrison.GetShipmentReagentItemLink|C_Garrison.GetShipmentReagentItemLink]](<span |
+ | : [[API C_Garrison.GetShipmentReagentItemLink|C_Garrison.GetShipmentReagentItemLink]](<span class="apiarg">reagentIndex</span>) |
: [[API C_Garrison.GetSpecChangeCost|C_Garrison.GetSpecChangeCost]]() |
: [[API C_Garrison.GetSpecChangeCost|C_Garrison.GetSpecChangeCost]]() |
||
− | : [[API C_Garrison.GetTalentInfo|C_Garrison.GetTalentInfo]](<span |
+ | : [[API C_Garrison.GetTalentInfo|C_Garrison.GetTalentInfo]](<span class="apiarg">talentID</span>) : <span class="apiret">info</span> |
− | : [[API C_Garrison.GetTalentPointsSpentInTalentTree|C_Garrison.GetTalentPointsSpentInTalentTree]](<span |
+ | : [[API C_Garrison.GetTalentPointsSpentInTalentTree|C_Garrison.GetTalentPointsSpentInTalentTree]](<span class="apiarg">garrTalentTreeID</span>) : <span class="apiret">talentPoints</span> |
− | : [[API C_Garrison.GetTalentTreeIDsByClassID|C_Garrison.GetTalentTreeIDsByClassID]](<span |
+ | : [[API C_Garrison.GetTalentTreeIDsByClassID|C_Garrison.GetTalentTreeIDsByClassID]](<span class="apiarg">garrType, classID</span>) : <span class="apiret">treeIDs</span> |
− | : [[API C_Garrison.GetTalentTreeInfo|C_Garrison.GetTalentTreeInfo]](<span |
+ | : [[API C_Garrison.GetTalentTreeInfo|C_Garrison.GetTalentTreeInfo]](<span class="apiarg">treeID</span>) : <span class="apiret">info</span> |
− | : [[API C_Garrison.GetTalentTreeResetInfo|C_Garrison.GetTalentTreeResetInfo]](<span |
+ | : [[API C_Garrison.GetTalentTreeResetInfo|C_Garrison.GetTalentTreeResetInfo]](<span class="apiarg">garrTalentTreeID</span>) : <span class="apiret">goldCost, currencyCosts</span> |
− | : [[API C_Garrison.GetTalentTreeTalentPointResearchInfo|C_Garrison.GetTalentTreeTalentPointResearchInfo]](<span |
+ | : [[API C_Garrison.GetTalentTreeTalentPointResearchInfo|C_Garrison.GetTalentTreeTalentPointResearchInfo]](<span class="apiarg">garrTalentID, researchRank, garrTalentTreeID, talentPointIndex, isRespec</span>) : <span class="apiret">goldCost, currencyCosts, durationSecs</span> |
− | : [[API C_Garrison. |
+ | : [[API C_Garrison.GetTalentUnlockWorldQuest|C_Garrison.GetTalentUnlockWorldQuest]](<span class="apiarg">talentID</span>) : <span class="apiret">worldQuestID</span> |
+ | : [[API C_Garrison.HasAdventures|C_Garrison.HasAdventures]]() : <span class="apiret">hasAdventures</span> |
||
+ | : [[API C_Garrison.HasGarrison|C_Garrison.HasGarrison]](<span class="apiarg">garrisonType</span>) |
||
+ | : [[API C_Garrison.IsFollowerOnCompletedMission|C_Garrison.IsFollowerOnCompletedMission]](<span class="apiarg">followerID</span>) : <span class="apiret">followerOnCompletedMission</span> |
||
: [[API C_Garrison.IsInvasionAvailable|C_Garrison.IsInvasionAvailable]]() |
: [[API C_Garrison.IsInvasionAvailable|C_Garrison.IsInvasionAvailable]]() |
||
: [[API C_Garrison.IsOnGarrisonMap|C_Garrison.IsOnGarrisonMap]]() |
: [[API C_Garrison.IsOnGarrisonMap|C_Garrison.IsOnGarrisonMap]]() |
||
: [[API C_Garrison.IsOnShipmentQuestForNPC|C_Garrison.IsOnShipmentQuestForNPC]]() |
: [[API C_Garrison.IsOnShipmentQuestForNPC|C_Garrison.IsOnShipmentQuestForNPC]]() |
||
− | : [[API C_Garrison.IsPlayerInGarrison|C_Garrison.IsPlayerInGarrison]](<span |
+ | : [[API C_Garrison.IsPlayerInGarrison|C_Garrison.IsPlayerInGarrison]](<span class="apiarg">garrType</span>) |
− | : [[API C_Garrison.IsTalentConditionMet|C_Garrison.IsTalentConditionMet]](<span |
+ | : [[API C_Garrison.IsTalentConditionMet|C_Garrison.IsTalentConditionMet]](<span class="apiarg">talentID</span>) : <span class="apiret">isMet, failureString</span> |
: [[API C_Garrison.IsUsingPartyGarrison|C_Garrison.IsUsingPartyGarrison]]() |
: [[API C_Garrison.IsUsingPartyGarrison|C_Garrison.IsUsingPartyGarrison]]() |
||
: [[API C_Garrison.IsVisitGarrisonAvailable|C_Garrison.IsVisitGarrisonAvailable]]() |
: [[API C_Garrison.IsVisitGarrisonAvailable|C_Garrison.IsVisitGarrisonAvailable]]() |
||
− | : [[API C_Garrison. |
+ | : [[API C_Garrison.RequestGarrisonUpgradeable|C_Garrison.RequestGarrisonUpgradeable]](<span class="apiarg">followerType</span>) |
− | : [[API C_Garrison.RequestGarrisonUpgradeable|C_Garrison.RequestGarrisonUpgradeable]](<span style="font-size:smaller; color:#ecbc2a">followerType</span>) |
||
: [[API C_Garrison.RequestLandingPageShipmentInfo|C_Garrison.RequestLandingPageShipmentInfo]]() |
: [[API C_Garrison.RequestLandingPageShipmentInfo|C_Garrison.RequestLandingPageShipmentInfo]]() |
||
: [[API C_Garrison.RequestShipmentCreation|C_Garrison.RequestShipmentCreation]]() |
: [[API C_Garrison.RequestShipmentCreation|C_Garrison.RequestShipmentCreation]]() |
||
: [[API C_Garrison.RequestShipmentInfo|C_Garrison.RequestShipmentInfo]]() |
: [[API C_Garrison.RequestShipmentInfo|C_Garrison.RequestShipmentInfo]]() |
||
− | : [[API C_Garrison.ResearchTalent|C_Garrison.ResearchTalent]](<span |
+ | : [[API C_Garrison.ResearchTalent|C_Garrison.ResearchTalent]](<span class="apiarg">garrTalentID</span>) |
− | : [[API C_Garrison. |
+ | : [[API C_Garrison.SetUsingPartyGarrison|C_Garrison.SetUsingPartyGarrison]](<span class="apiarg">enabled</span>) |
− | : [[API C_Garrison. |
+ | : [[API C_Garrison.ShouldShowMapTab|C_Garrison.ShouldShowMapTab]](<span class="apiarg">garrType</span>) |
− | : [[API C_Garrison. |
+ | : [[API C_Garrison.UpgradeGarrison|C_Garrison.UpgradeGarrison]](<span class="apiarg">followerType</span>) |
− | : [[API C_Garrison.SetUsingPartyGarrison|C_Garrison.SetUsingPartyGarrison]](<span style="font-size:smaller; color:#ecbc2a">enabled</span>) |
||
− | : [[API C_Garrison.ShouldShowMapTab|C_Garrison.ShouldShowMapTab]](<span style="font-size:smaller; color:#ecbc2a">garrType</span>) |
||
− | : [[API C_Garrison.UpgradeGarrison|C_Garrison.UpgradeGarrison]](<span style="font-size:smaller; color:#ecbc2a">followerType</span>) |
||
: [[API GetEquipmentNameFromSpell|GetEquipmentNameFromSpell]]() - returns a garrison equipment for a spell. |
: [[API GetEquipmentNameFromSpell|GetEquipmentNameFromSpell]]() - returns a garrison equipment for a spell. |
||
: [[API GetFollowerTypeIDFromSpell|GetFollowerTypeIDFromSpell]]() - Returns the Garrison expansion type. |
: [[API GetFollowerTypeIDFromSpell|GetFollowerTypeIDFromSpell]]() - Returns the Garrison expansion type. |
||
− | : [[API ReopenInteraction|ReopenInteraction]]() - Reopens the order hall talents interaction. |
||
− | === |
+ | ===Buildings=== |
− | : [[API C_Garrison.CancelConstruction|C_Garrison.CancelConstruction]](<span |
+ | : [[API C_Garrison.CancelConstruction|C_Garrison.CancelConstruction]](<span class="apiarg">plotInstanceID</span>) |
− | : [[API C_Garrison.GetBuildingInfo|C_Garrison.GetBuildingInfo]](<span |
+ | : [[API C_Garrison.GetBuildingInfo|C_Garrison.GetBuildingInfo]](<span class="apiarg">buildingID</span>) |
: [[API C_Garrison.GetBuildingLockInfo|C_Garrison.GetBuildingLockInfo]]() |
: [[API C_Garrison.GetBuildingLockInfo|C_Garrison.GetBuildingLockInfo]]() |
||
: [[API C_Garrison.GetBuildingSizes|C_Garrison.GetBuildingSizes]]() |
: [[API C_Garrison.GetBuildingSizes|C_Garrison.GetBuildingSizes]]() |
||
: [[API C_Garrison.GetBuildingSpecInfo|C_Garrison.GetBuildingSpecInfo]]() |
: [[API C_Garrison.GetBuildingSpecInfo|C_Garrison.GetBuildingSpecInfo]]() |
||
− | : [[API C_Garrison.GetBuildingTimeRemaining|C_Garrison.GetBuildingTimeRemaining]](<span |
+ | : [[API C_Garrison.GetBuildingTimeRemaining|C_Garrison.GetBuildingTimeRemaining]](<span class="apiarg">plotInstanceID</span>) |
− | : [[API C_Garrison.GetBuildingTooltip|C_Garrison.GetBuildingTooltip]](<span |
+ | : [[API C_Garrison.GetBuildingTooltip|C_Garrison.GetBuildingTooltip]](<span class="apiarg">buildingID</span>) |
− | : [[API C_Garrison.GetBuildingUpgradeInfo|C_Garrison.GetBuildingUpgradeInfo]](<span |
+ | : [[API C_Garrison.GetBuildingUpgradeInfo|C_Garrison.GetBuildingUpgradeInfo]](<span class="apiarg">buildingID</span>) |
− | : [[API C_Garrison.GetBuildingsForPlot|C_Garrison.GetBuildingsForPlot]](<span |
+ | : [[API C_Garrison.GetBuildingsForPlot|C_Garrison.GetBuildingsForPlot]](<span class="apiarg">plotInstanceID</span>) |
− | : [[API C_Garrison.GetBuildingsForSize|C_Garrison.GetBuildingsForSize]](<span |
+ | : [[API C_Garrison.GetBuildingsForSize|C_Garrison.GetBuildingsForSize]](<span class="apiarg">garrisonType, uiCategoryID</span>) |
− | : [[API C_Garrison.GetBuildings|C_Garrison.GetBuildings]](<span |
+ | : [[API C_Garrison.GetBuildings|C_Garrison.GetBuildings]](<span class="apiarg">garrisonType</span>) |
− | : [[API C_Garrison.GetGarrisonPlotsInstancesForMap|C_Garrison.GetGarrisonPlotsInstancesForMap]](<span |
+ | : [[API C_Garrison.GetGarrisonPlotsInstancesForMap|C_Garrison.GetGarrisonPlotsInstancesForMap]](<span class="apiarg">uiMapID</span>) : <span class="apiret">garrisonPlotInstances</span> |
− | : [[API C_Garrison.GetLandingPageShipmentInfo|C_Garrison.GetLandingPageShipmentInfo]](<span |
+ | : [[API C_Garrison.GetLandingPageShipmentInfo|C_Garrison.GetLandingPageShipmentInfo]](<span class="apiarg">buildingID</span>) |
− | : [[API C_Garrison.GetOwnedBuildingInfoAbbrev|C_Garrison.GetOwnedBuildingInfoAbbrev]](<span |
+ | : [[API C_Garrison.GetOwnedBuildingInfoAbbrev|C_Garrison.GetOwnedBuildingInfoAbbrev]](<span class="apiarg">plotInstanceID</span>) |
− | : [[API C_Garrison.GetOwnedBuildingInfo|C_Garrison.GetOwnedBuildingInfo]](<span |
+ | : [[API C_Garrison.GetOwnedBuildingInfo|C_Garrison.GetOwnedBuildingInfo]](<span class="apiarg">plotInstanceID</span>) |
− | : [[API C_Garrison.GetPlotsForBuilding|C_Garrison.GetPlotsForBuilding]](<span |
+ | : [[API C_Garrison.GetPlotsForBuilding|C_Garrison.GetPlotsForBuilding]](<span class="apiarg">buildingID</span>) |
− | : [[API C_Garrison.GetPlots|C_Garrison.GetPlots]](<span |
+ | : [[API C_Garrison.GetPlots|C_Garrison.GetPlots]](<span class="apiarg">followerType</span>) |
: [[API C_Garrison.GetShipDeathAnimInfo|C_Garrison.GetShipDeathAnimInfo]]() |
: [[API C_Garrison.GetShipDeathAnimInfo|C_Garrison.GetShipDeathAnimInfo]]() |
||
− | : [[API C_Garrison.GetTabForPlot|C_Garrison.GetTabForPlot]](<span |
+ | : [[API C_Garrison.GetTabForPlot|C_Garrison.GetTabForPlot]](<span class="apiarg">plotInstanceID</span>) |
: [[API C_Garrison.HasShipyard|C_Garrison.HasShipyard]]() |
: [[API C_Garrison.HasShipyard|C_Garrison.HasShipyard]]() |
||
: [[API C_Garrison.IsOnShipyardMap|C_Garrison.IsOnShipyardMap]]() |
: [[API C_Garrison.IsOnShipyardMap|C_Garrison.IsOnShipyardMap]]() |
||
− | : [[API C_Garrison.PlaceBuilding|C_Garrison.PlaceBuilding]](<span |
+ | : [[API C_Garrison.PlaceBuilding|C_Garrison.PlaceBuilding]](<span class="apiarg">plotInstanceID, buildingID</span>) |
− | : [[API C_Garrison.SetBuildingActive|C_Garrison.SetBuildingActive]](<span |
+ | : [[API C_Garrison.SetBuildingActive|C_Garrison.SetBuildingActive]](<span class="apiarg">plotInstanceID</span>) |
: [[API C_Garrison.SetBuildingSpecialization|C_Garrison.SetBuildingSpecialization]]() |
: [[API C_Garrison.SetBuildingSpecialization|C_Garrison.SetBuildingSpecialization]]() |
||
− | : [[API C_Garrison.SwapBuildings|C_Garrison.SwapBuildings]](<span |
+ | : [[API C_Garrison.SwapBuildings|C_Garrison.SwapBuildings]](<span class="apiarg">plotInstanceID1, plotInstanceID2</span>) |
− | : [[API C_Garrison.UpgradeBuilding|C_Garrison.UpgradeBuilding]](<span |
+ | : [[API C_Garrison.UpgradeBuilding|C_Garrison.UpgradeBuilding]](<span class="apiarg">plotInstanceID</span>) |
Trophies |
Trophies |
||
− | : [[API C_Trophy.MonumentChangeAppearanceToTrophyID|C_Trophy.MonumentChangeAppearanceToTrophyID]](<span |
+ | : [[API C_Trophy.MonumentChangeAppearanceToTrophyID|C_Trophy.MonumentChangeAppearanceToTrophyID]](<span class="apiarg">trophyID</span>) |
: [[API C_Trophy.MonumentCloseMonumentUI|C_Trophy.MonumentCloseMonumentUI]]() |
: [[API C_Trophy.MonumentCloseMonumentUI|C_Trophy.MonumentCloseMonumentUI]]() |
||
: [[API C_Trophy.MonumentGetCount|C_Trophy.MonumentGetCount]]() |
: [[API C_Trophy.MonumentGetCount|C_Trophy.MonumentGetCount]]() |
||
: [[API C_Trophy.MonumentGetSelectedTrophyID|C_Trophy.MonumentGetSelectedTrophyID]]() |
: [[API C_Trophy.MonumentGetSelectedTrophyID|C_Trophy.MonumentGetSelectedTrophyID]]() |
||
− | : [[API C_Trophy.MonumentGetTrophyInfoByIndex|C_Trophy.MonumentGetTrophyInfoByIndex]](<span |
+ | : [[API C_Trophy.MonumentGetTrophyInfoByIndex|C_Trophy.MonumentGetTrophyInfoByIndex]](<span class="apiarg">index</span>) |
: [[API C_Trophy.MonumentLoadList|C_Trophy.MonumentLoadList]]() |
: [[API C_Trophy.MonumentLoadList|C_Trophy.MonumentLoadList]]() |
||
: [[API C_Trophy.MonumentLoadSelectedTrophyID|C_Trophy.MonumentLoadSelectedTrophyID]]() |
: [[API C_Trophy.MonumentLoadSelectedTrophyID|C_Trophy.MonumentLoadSelectedTrophyID]]() |
||
: [[API C_Trophy.MonumentRevertAppearanceToSaved|C_Trophy.MonumentRevertAppearanceToSaved]]() |
: [[API C_Trophy.MonumentRevertAppearanceToSaved|C_Trophy.MonumentRevertAppearanceToSaved]]() |
||
− | : [[API C_Trophy.MonumentSaveSelection|C_Trophy.MonumentSaveSelection]](<span |
+ | : [[API C_Trophy.MonumentSaveSelection|C_Trophy.MonumentSaveSelection]](<span class="apiarg">trophyID</span>) |
− | === |
+ | ===Missions=== |
− | + | Relates to [[Follower]]s and [[Mission]]s. |
|
− | : [[API C_Garrison.AddFollowerToMission|C_Garrison.AddFollowerToMission]](<span |
+ | : [[API C_Garrison.AddFollowerToMission|C_Garrison.AddFollowerToMission]](<span class="apiarg">missionID, followerID [, boardIndex]</span>) : <span class="apiret">followerAdded</span> |
− | : [[API C_Garrison.AllowMissionStartAboveSoftCap|C_Garrison.AllowMissionStartAboveSoftCap]](<span |
+ | : [[API C_Garrison.AllowMissionStartAboveSoftCap|C_Garrison.AllowMissionStartAboveSoftCap]](<span class="apiarg">garrFollowerTypeID</span>) |
− | : [[API C_Garrison.AreMissionFollowerRequirementsMet|C_Garrison.AreMissionFollowerRequirementsMet]](<span |
+ | : [[API C_Garrison.AreMissionFollowerRequirementsMet|C_Garrison.AreMissionFollowerRequirementsMet]](<span class="apiarg">missionRecID</span>) |
− | : [[API C_Garrison.AssignFollowerToBuilding|C_Garrison.AssignFollowerToBuilding]](<span |
+ | : [[API C_Garrison.AssignFollowerToBuilding|C_Garrison.AssignFollowerToBuilding]](<span class="apiarg">plotInstanceID, followerID</span>) |
− | : [[API C_Garrison. |
+ | : [[API C_Garrison.CanGenerateRecruits|C_Garrison.CanGenerateRecruits]]() |
− | : [[API C_Garrison. |
+ | : [[API C_Garrison.CanOpenMissionChest|C_Garrison.CanOpenMissionChest]](<span class="apiarg">missionID</span>) |
− | : [[API C_Garrison. |
+ | : [[API C_Garrison.CanSetRecruitmentPreference|C_Garrison.CanSetRecruitmentPreference]]() |
− | : [[API C_Garrison. |
+ | : [[API C_Garrison.CanSpellTargetFollowerIDWithAddAbility|C_Garrison.CanSpellTargetFollowerIDWithAddAbility]](<span class="apiarg">followerID</span>) |
− | : [[API C_Garrison. |
+ | : [[API C_Garrison.CastItemSpellOnFollowerAbility|C_Garrison.CastItemSpellOnFollowerAbility]](<span class="apiarg">followerID, abilityID</span>) |
− | : [[API C_Garrison. |
+ | : [[API C_Garrison.CastSpellOnFollower|C_Garrison.CastSpellOnFollower]](<span class="apiarg">followerID</span>) |
+ | : [[API C_Garrison.CastSpellOnFollowerAbility|C_Garrison.CastSpellOnFollowerAbility]](<span class="apiarg">followerID, abilityID</span>) |
||
+ | : [[API C_Garrison.CastSpellOnMission|C_Garrison.CastSpellOnMission]](<span class="apiarg">missionID</span>) |
||
: [[API C_Garrison.CloseMissionNPC|C_Garrison.CloseMissionNPC]]() |
: [[API C_Garrison.CloseMissionNPC|C_Garrison.CloseMissionNPC]]() |
||
− | : [[API C_Garrison. |
+ | : [[API C_Garrison.CloseRecruitmentNPC|C_Garrison.CloseRecruitmentNPC]]() |
− | : [[API C_Garrison. |
+ | : [[API C_Garrison.GenerateRecruits|C_Garrison.GenerateRecruits]](<span class="apiarg">mechanicTypeID, traitID</span>) |
− | : [[API C_Garrison. |
+ | : [[API C_Garrison.GetAllEncounterThreats|C_Garrison.GetAllEncounterThreats]](<span class="apiarg">garrFollowerTypeID</span>) |
− | : [[API C_Garrison. |
+ | : [[API C_Garrison.GetAvailableMissions|C_Garrison.GetAvailableMissions]](<span class="apiarg">[missionList,] garrFollowerTypeID</span>) |
− | : [[API C_Garrison. |
+ | : [[API C_Garrison.GetAvailableRecruits|C_Garrison.GetAvailableRecruits]]() |
− | : [[API C_Garrison. |
+ | : [[API C_Garrison.GetBasicMissionInfo|C_Garrison.GetBasicMissionInfo]](<span class="apiarg">missionID</span>) |
− | : [[API C_Garrison. |
+ | : [[API C_Garrison.GetBuffedFollowersForMission|C_Garrison.GetBuffedFollowersForMission]](<span class="apiarg">missionID, displayingAbilities</span>) |
− | : [[API C_Garrison. |
+ | : [[API C_Garrison.GetClassSpecCategoryInfo|C_Garrison.GetClassSpecCategoryInfo]](<span class="apiarg">garrFollowerType</span>) |
− | : [[API C_Garrison. |
+ | : [[API C_Garrison.GetCombatAllyMission|C_Garrison.GetCombatAllyMission]](<span class="apiarg">garrFollowerTypeID</span>) |
− | : [[API C_Garrison. |
+ | : [[API C_Garrison.GetCompleteMissions|C_Garrison.GetCompleteMissions]](<span class="apiarg">[missionList,] garrFollowerTypeID</span>) |
− | : [[API C_Garrison. |
+ | : [[API C_Garrison.GetFollowerAbilities|C_Garrison.GetFollowerAbilities]](<span class="apiarg">guid|id</span>) |
− | : [[API C_Garrison. |
+ | : [[API C_Garrison.GetFollowerAbilityAtIndex|C_Garrison.GetFollowerAbilityAtIndex]](<span class="apiarg">followerID, index</span>) |
− | : [[API C_Garrison. |
+ | : [[API C_Garrison.GetFollowerAbilityAtIndexByID|C_Garrison.GetFollowerAbilityAtIndexByID]](<span class="apiarg">garrFollowerID, index</span>) |
− | : [[API C_Garrison. |
+ | : [[API C_Garrison.GetFollowerAbilityCounterMechanicInfo|C_Garrison.GetFollowerAbilityCounterMechanicInfo]](<span class="apiarg">garrAbilityID</span>) |
− | : [[API C_Garrison. |
+ | : [[API C_Garrison.GetFollowerAbilityCountersForMechanicTypes|C_Garrison.GetFollowerAbilityCountersForMechanicTypes]](<span class="apiarg">garrFollowerTypeID</span>) |
− | : [[API C_Garrison. |
+ | : [[API C_Garrison.GetFollowerAbilityDescription|C_Garrison.GetFollowerAbilityDescription]](<span class="apiarg">garrAbilityID</span>) |
− | : [[API C_Garrison. |
+ | : [[API C_Garrison.GetFollowerAbilityIcon|C_Garrison.GetFollowerAbilityIcon]](<span class="apiarg">garrAbilityID</span>) |
− | : [[API C_Garrison. |
+ | : [[API C_Garrison.GetFollowerAbilityInfo|C_Garrison.GetFollowerAbilityInfo]](<span class="apiarg">garrAbilityID</span>) |
+ | : [[API C_Garrison.GetFollowerAbilityIsTrait|C_Garrison.GetFollowerAbilityIsTrait]](<span class="apiarg">garrAbilityID</span>) |
||
+ | : [[API C_Garrison.GetFollowerAbilityLink|C_Garrison.GetFollowerAbilityLink]](<span class="apiarg">abilityID</span>) |
||
+ | : [[API C_Garrison.GetFollowerAbilityName|C_Garrison.GetFollowerAbilityName]](<span class="apiarg">garrAbilityID</span>) |
||
: [[API C_Garrison.GetFollowerActivationCost|C_Garrison.GetFollowerActivationCost]]() |
: [[API C_Garrison.GetFollowerActivationCost|C_Garrison.GetFollowerActivationCost]]() |
||
− | : [[API C_Garrison.GetFollowerBiasForMission|C_Garrison.GetFollowerBiasForMission]](<span |
+ | : [[API C_Garrison.GetFollowerBiasForMission|C_Garrison.GetFollowerBiasForMission]](<span class="apiarg">missionID, followerID</span>) |
− | : [[API C_Garrison. |
+ | : [[API C_Garrison.GetFollowerClassSpec|C_Garrison.GetFollowerClassSpec]](<span class="apiarg">followerID</span>) |
− | : [[API C_Garrison. |
+ | : [[API C_Garrison.GetFollowerClassSpecAtlas|C_Garrison.GetFollowerClassSpecAtlas]](<span class="apiarg">garrSpecID</span>) |
− | : [[API C_Garrison. |
+ | : [[API C_Garrison.GetFollowerClassSpecByID|C_Garrison.GetFollowerClassSpecByID]](<span class="apiarg">garrFollowerID</span>) |
− | : [[API C_Garrison. |
+ | : [[API C_Garrison.GetFollowerClassSpecName|C_Garrison.GetFollowerClassSpecName]](<span class="apiarg">garrFollowerID</span>) |
− | : [[API C_Garrison.GetFollowerDisplayID|C_Garrison.GetFollowerDisplayID]](<span |
+ | : [[API C_Garrison.GetFollowerDisplayID|C_Garrison.GetFollowerDisplayID]](<span class="apiarg">followerID</span>) |
+ | : [[API C_Garrison.GetFollowerInfo|C_Garrison.GetFollowerInfo]](<span class="apiarg">guid|id</span>) |
||
: [[API C_Garrison.GetFollowerInfoForBuilding|C_Garrison.GetFollowerInfoForBuilding]]() |
: [[API C_Garrison.GetFollowerInfoForBuilding|C_Garrison.GetFollowerInfoForBuilding]]() |
||
− | : [[API C_Garrison. |
+ | : [[API C_Garrison.GetFollowerIsTroop|C_Garrison.GetFollowerIsTroop]](<span class="apiarg">guid|id</span>) |
− | : [[API C_Garrison. |
+ | : [[API C_Garrison.GetFollowerItemLevelAverage|C_Garrison.GetFollowerItemLevelAverage]](<span class="apiarg">followerID</span>) |
− | : [[API C_Garrison. |
+ | : [[API C_Garrison.GetFollowerItems|C_Garrison.GetFollowerItems]](<span class="apiarg">followerID</span>) |
− | : [[API C_Garrison. |
+ | : [[API C_Garrison.GetFollowerLevel|C_Garrison.GetFollowerLevel]](<span class="apiarg">followerID</span>) |
− | : [[API C_Garrison.GetFollowerLevelXP|C_Garrison.GetFollowerLevelXP]](<span |
+ | : [[API C_Garrison.GetFollowerLevelXP|C_Garrison.GetFollowerLevelXP]](<span class="apiarg">followerID</span>) |
− | : [[API C_Garrison. |
+ | : [[API C_Garrison.GetFollowerLink|C_Garrison.GetFollowerLink]](<span class="apiarg">followerID</span>) |
− | : [[API C_Garrison.GetFollowerLinkByID|C_Garrison.GetFollowerLinkByID]](<span |
+ | : [[API C_Garrison.GetFollowerLinkByID|C_Garrison.GetFollowerLinkByID]](<span class="apiarg">garrFollowerID</span>) |
− | : [[API C_Garrison. |
+ | : [[API C_Garrison.GetFollowerMissionCompleteInfo|C_Garrison.GetFollowerMissionCompleteInfo]](<span class="apiarg">followerID</span>) : <span class="apiret">followerMissionCompleteInfo</span> |
− | : [[API C_Garrison. |
+ | : [[API C_Garrison.GetFollowerMissionTimeLeft|C_Garrison.GetFollowerMissionTimeLeft]](<span class="apiarg">followerID</span>) |
− | : [[API C_Garrison.GetFollowerMissionTimeLeftSeconds|C_Garrison.GetFollowerMissionTimeLeftSeconds]](<span |
+ | : [[API C_Garrison.GetFollowerMissionTimeLeftSeconds|C_Garrison.GetFollowerMissionTimeLeftSeconds]](<span class="apiarg">followerID</span>) |
− | : [[API C_Garrison. |
+ | : [[API C_Garrison.GetFollowerModelItems|C_Garrison.GetFollowerModelItems]](<span class="apiarg">followerID</span>) |
− | : [[API C_Garrison. |
+ | : [[API C_Garrison.GetFollowerName|C_Garrison.GetFollowerName]](<span class="apiarg">followerID</span>) |
− | : [[API C_Garrison. |
+ | : [[API C_Garrison.GetFollowerNameByID|C_Garrison.GetFollowerNameByID]](<span class="apiarg">garrFollowerID</span>) |
− | : [[API C_Garrison. |
+ | : [[API C_Garrison.GetFollowerPortraitIconID|C_Garrison.GetFollowerPortraitIconID]](<span class="apiarg">followerID</span>) |
− | : [[API C_Garrison. |
+ | : [[API C_Garrison.GetFollowerPortraitIconIDByID|C_Garrison.GetFollowerPortraitIconIDByID]](<span class="apiarg">garrFollowerID</span>) |
− | : [[API C_Garrison. |
+ | : [[API C_Garrison.GetFollowerQuality|C_Garrison.GetFollowerQuality]](<span class="apiarg">followerID</span>) |
− | : [[API C_Garrison.GetFollowerQualityTable|C_Garrison.GetFollowerQualityTable]](<span |
+ | : [[API C_Garrison.GetFollowerQualityTable|C_Garrison.GetFollowerQualityTable]](<span class="apiarg">garrFollowerTypeID</span>) |
− | : [[API C_Garrison. |
+ | : [[API C_Garrison.GetFollowerRecentlyGainedAbilityIDs|C_Garrison.GetFollowerRecentlyGainedAbilityIDs]](<span class="apiarg">followerID</span>) |
− | : [[API C_Garrison. |
+ | : [[API C_Garrison.GetFollowerRecentlyGainedTraitIDs|C_Garrison.GetFollowerRecentlyGainedTraitIDs]](<span class="apiarg">followerID</span>) |
− | : [[API C_Garrison. |
+ | : [[API C_Garrison.GetFollowers|C_Garrison.GetFollowers]]() - Returns a list of garrison tech followers. |
− | : [[API C_Garrison.GetFollowerShipments|C_Garrison.GetFollowerShipments]](<span |
+ | : [[API C_Garrison.GetFollowerShipments|C_Garrison.GetFollowerShipments]](<span class="apiarg">garrTypeID</span>) |
− | : [[API C_Garrison.GetFollowerSoftCap|C_Garrison.GetFollowerSoftCap]](<span |
+ | : [[API C_Garrison.GetFollowerSoftCap|C_Garrison.GetFollowerSoftCap]](<span class="apiarg">garrFollowerTypeID</span>) |
− | : [[API C_Garrison.GetFollowerSourceTextByID|C_Garrison.GetFollowerSourceTextByID]](<span |
+ | : [[API C_Garrison.GetFollowerSourceTextByID|C_Garrison.GetFollowerSourceTextByID]](<span class="apiarg">garrFollowerID</span>) |
− | : [[API C_Garrison.GetFollowerSpecializationAtIndex|C_Garrison.GetFollowerSpecializationAtIndex]](<span |
+ | : [[API C_Garrison.GetFollowerSpecializationAtIndex|C_Garrison.GetFollowerSpecializationAtIndex]](<span class="apiarg">followerID, index</span>) |
− | : [[API C_Garrison. |
+ | : [[API C_Garrison.GetFollowersSpellsForMission|C_Garrison.GetFollowersSpellsForMission]](<span class="apiarg">missionID</span>) |
− | : [[API C_Garrison. |
+ | : [[API C_Garrison.GetFollowerStatus|C_Garrison.GetFollowerStatus]](<span class="apiarg">followerID</span>) |
− | : [[API C_Garrison. |
+ | : [[API C_Garrison.GetFollowersTraitsForMission|C_Garrison.GetFollowersTraitsForMission]](<span class="apiarg">missionID</span>) |
− | : [[API C_Garrison. |
+ | : [[API C_Garrison.GetFollowerTraitAtIndex|C_Garrison.GetFollowerTraitAtIndex]](<span class="apiarg">followerID, index</span>) |
− | : [[API C_Garrison. |
+ | : [[API C_Garrison.GetFollowerTraitAtIndexByID|C_Garrison.GetFollowerTraitAtIndexByID]](<span class="apiarg">garrFollowerID, index</span>) |
− | : [[API C_Garrison. |
+ | : [[API C_Garrison.GetFollowerTypeByID|C_Garrison.GetFollowerTypeByID]](<span class="apiarg">garrFollowerID</span>) |
− | : [[API C_Garrison. |
+ | : [[API C_Garrison.GetFollowerTypeByMissionID|C_Garrison.GetFollowerTypeByMissionID]](<span class="apiarg">missionID</span>) |
− | : [[API C_Garrison. |
+ | : [[API C_Garrison.GetFollowerUnderBiasReason|C_Garrison.GetFollowerUnderBiasReason]](<span class="apiarg">missionID, followerID</span>) |
− | : [[API C_Garrison. |
+ | : [[API C_Garrison.GetFollowerXP|C_Garrison.GetFollowerXP]](<span class="apiarg">followerID</span>) |
− | : [[API C_Garrison. |
+ | : [[API C_Garrison.GetFollowerXPTable|C_Garrison.GetFollowerXPTable]](<span class="apiarg">garrFollowerTypeID</span>) |
− | : [[API C_Garrison. |
+ | : [[API C_Garrison.GetFollowerZoneSupportAbilities|C_Garrison.GetFollowerZoneSupportAbilities]](<span class="apiarg">guid|id</span>) |
− | : [[API C_Garrison. |
+ | : [[API C_Garrison.GetInProgressMissions|C_Garrison.GetInProgressMissions]](<span class="apiarg">[missionList,] garrFollowerTypeID</span>) |
− | : [[API C_Garrison. |
+ | : [[API C_Garrison.GetMissionBonusAbilityEffects|C_Garrison.GetMissionBonusAbilityEffects]](<span class="apiarg">missionID</span>) |
− | : [[API C_Garrison. |
+ | : [[API C_Garrison.GetMissionCompleteEncounters|C_Garrison.GetMissionCompleteEncounters]](<span class="apiarg">missionID</span>) : <span class="apiret">encounters</span> |
− | : [[API C_Garrison. |
+ | : [[API C_Garrison.GetMissionCost|C_Garrison.GetMissionCost]](<span class="apiarg">missionID</span>) |
− | : [[API C_Garrison. |
+ | : [[API C_Garrison.GetMissionDeploymentInfo|C_Garrison.GetMissionDeploymentInfo]](<span class="apiarg">missionID</span>) : <span class="apiret">missionDeploymentInfo</span> |
− | : [[API C_Garrison. |
+ | : [[API C_Garrison.GetMissionDisplayIDs|C_Garrison.GetMissionDisplayIDs]](<span class="apiarg">missionID</span>) |
− | : [[API C_Garrison. |
+ | : [[API C_Garrison.GetMissionEncounterIconInfo|C_Garrison.GetMissionEncounterIconInfo]](<span class="apiarg">missionID</span>) : <span class="apiret">missionEncounterIconInfo</span> |
− | : [[API C_Garrison.GetMissionLink|C_Garrison.GetMissionLink]](<span |
+ | : [[API C_Garrison.GetMissionLink|C_Garrison.GetMissionLink]](<span class="apiarg">missionID</span>) |
− | : [[API C_Garrison.GetMissionMaxFollowers|C_Garrison.GetMissionMaxFollowers]](<span |
+ | : [[API C_Garrison.GetMissionMaxFollowers|C_Garrison.GetMissionMaxFollowers]](<span class="apiarg">garrMissionID</span>) |
− | : [[API C_Garrison.GetMissionName|C_Garrison.GetMissionName]](<span |
+ | : [[API C_Garrison.GetMissionName|C_Garrison.GetMissionName]](<span class="apiarg">garrMissionID</span>) |
− | : [[API C_Garrison.GetMissionRewardInfo|C_Garrison.GetMissionRewardInfo]](<span |
+ | : [[API C_Garrison.GetMissionRewardInfo|C_Garrison.GetMissionRewardInfo]](<span class="apiarg">garrMissionID [, missionDBID]</span>) |
− | : [[API C_Garrison.GetMissionSuccessChance|C_Garrison.GetMissionSuccessChance]](<span |
+ | : [[API C_Garrison.GetMissionSuccessChance|C_Garrison.GetMissionSuccessChance]](<span class="apiarg">missionID</span>) |
− | : [[API C_Garrison.GetMissionTexture|C_Garrison.GetMissionTexture]](<span |
+ | : [[API C_Garrison.GetMissionTexture|C_Garrison.GetMissionTexture]](<span class="apiarg">offeredGarrMissionTextureID</span>) |
− | : [[API C_Garrison.GetMissionTimes|C_Garrison.GetMissionTimes]](<span |
+ | : [[API C_Garrison.GetMissionTimes|C_Garrison.GetMissionTimes]](<span class="apiarg">missionID</span>) |
− | : [[API C_Garrison.GetMissionUncounteredMechanics|C_Garrison.GetMissionUncounteredMechanics]](<span |
+ | : [[API C_Garrison.GetMissionUncounteredMechanics|C_Garrison.GetMissionUncounteredMechanics]](<span class="apiarg">missionID</span>) |
: [[API C_Garrison.GetNumActiveFollowers|C_Garrison.GetNumActiveFollowers]]() |
: [[API C_Garrison.GetNumActiveFollowers|C_Garrison.GetNumActiveFollowers]]() |
||
− | : [[API C_Garrison.GetNumFollowerActivationsRemaining|C_Garrison.GetNumFollowerActivationsRemaining]](<span |
+ | : [[API C_Garrison.GetNumFollowerActivationsRemaining|C_Garrison.GetNumFollowerActivationsRemaining]](<span class="apiarg">garrTypeID</span>) |
: [[API C_Garrison.GetNumFollowerDailyActivations|C_Garrison.GetNumFollowerDailyActivations]]() |
: [[API C_Garrison.GetNumFollowerDailyActivations|C_Garrison.GetNumFollowerDailyActivations]]() |
||
− | : [[API C_Garrison.GetNumFollowersForMechanic|C_Garrison.GetNumFollowersForMechanic]](<span style="font-size:smaller; color:#ecbc2a">followerType, mechanicID</span>) |
||
− | : [[API C_Garrison.GetNumFollowersOnMission|C_Garrison.GetNumFollowersOnMission]](<span style="font-size:smaller; color:#ecbc2a">missionID</span>) |
||
: [[API C_Garrison.GetNumFollowers|C_Garrison.GetNumFollowers]]() |
: [[API C_Garrison.GetNumFollowers|C_Garrison.GetNumFollowers]]() |
||
− | : [[API C_Garrison. |
+ | : [[API C_Garrison.GetNumFollowersForMechanic|C_Garrison.GetNumFollowersForMechanic]](<span class="apiarg">followerType, mechanicID</span>) |
− | : [[API C_Garrison. |
+ | : [[API C_Garrison.GetNumFollowersOnMission|C_Garrison.GetNumFollowersOnMission]](<span class="apiarg">missionID</span>) |
− | : [[API C_Garrison. |
+ | : [[API C_Garrison.GetPartyBuffs|C_Garrison.GetPartyBuffs]](<span class="apiarg">missionID</span>) |
− | : [[API C_Garrison. |
+ | : [[API C_Garrison.GetPartyMentorLevels|C_Garrison.GetPartyMentorLevels]](<span class="apiarg">missionID</span>) |
− | : [[API C_Garrison. |
+ | : [[API C_Garrison.GetPartyMissionInfo|C_Garrison.GetPartyMissionInfo]](<span class="apiarg">missionID</span>) |
− | : [[API C_Garrison. |
+ | : [[API C_Garrison.GetPossibleFollowersForBuilding|C_Garrison.GetPossibleFollowersForBuilding]](<span class="apiarg">followerType, plotInstanceID</span>) |
− | : [[API C_Garrison. |
+ | : [[API C_Garrison.GetRecruitAbilities|C_Garrison.GetRecruitAbilities]](<span class="apiarg">index</span>) |
− | : [[API C_Garrison. |
+ | : [[API C_Garrison.GetRecruiterAbilityCategories|C_Garrison.GetRecruiterAbilityCategories]]() |
− | : [[API C_Garrison. |
+ | : [[API C_Garrison.GetRecruiterAbilityList|C_Garrison.GetRecruiterAbilityList]](<span class="apiarg">traits</span>) |
− | : [[API C_Garrison. |
+ | : [[API C_Garrison.GetRecruitmentPreferences|C_Garrison.GetRecruitmentPreferences]]() |
− | : [[API C_Garrison. |
+ | : [[API C_Garrison.IsAboveFollowerSoftCap|C_Garrison.IsAboveFollowerSoftCap]](<span class="apiarg">garrFollowerTypeID</span>) |
− | : [[API C_Garrison. |
+ | : [[API C_Garrison.IsAtGarrisonMissionNPC|C_Garrison.IsAtGarrisonMissionNPC]]() : <span class="apiret">atGarrisonMissionNPC</span> |
+ | : [[API C_Garrison.IsEnvironmentCountered|C_Garrison.IsEnvironmentCountered]](<span class="apiarg">missionID</span>) : <span class="apiret">environmentCountered</span> |
||
+ | : [[API C_Garrison.IsFollowerCollected|C_Garrison.IsFollowerCollected]](<span class="apiarg">garrFollowerID</span>) |
||
+ | : [[API C_Garrison.IsMechanicFullyCountered|C_Garrison.IsMechanicFullyCountered]](<span class="apiarg">missionID, followerID, mechanicID</span>) |
||
+ | : [[API C_Garrison.MarkMissionComplete|C_Garrison.MarkMissionComplete]](<span class="apiarg">missionID</span>) |
||
+ | : [[API C_Garrison.MissionBonusRoll|C_Garrison.MissionBonusRoll]](<span class="apiarg">missionID</span>) |
||
+ | : [[API C_Garrison.RecruitFollower|C_Garrison.RecruitFollower]](<span class="apiarg">followerIndex</span>) |
||
+ | : [[API C_Garrison.RemoveFollower|C_Garrison.RemoveFollower]](<span class="apiarg">dbID</span>) |
||
: [[API C_Garrison.RemoveFollowerFromBuilding|C_Garrison.RemoveFollowerFromBuilding]]() |
: [[API C_Garrison.RemoveFollowerFromBuilding|C_Garrison.RemoveFollowerFromBuilding]]() |
||
− | : [[API C_Garrison.RemoveFollowerFromMission|C_Garrison.RemoveFollowerFromMission]](<span |
+ | : [[API C_Garrison.RemoveFollowerFromMission|C_Garrison.RemoveFollowerFromMission]](<span class="apiarg">missionID, followerID [, boardIndex]</span>) |
− | : [[API C_Garrison. |
+ | : [[API C_Garrison.RenameFollower|C_Garrison.RenameFollower]](<span class="apiarg">followerID, name</span>) |
− | : [[API C_Garrison. |
+ | : [[API C_Garrison.RequestClassSpecCategoryInfo|C_Garrison.RequestClassSpecCategoryInfo]](<span class="apiarg">garrFollowerTypeID</span>) |
− | : [[API C_Garrison. |
+ | : [[API C_Garrison.RushHealAllFollowers|C_Garrison.RushHealAllFollowers]](<span class="apiarg">followerType</span>) |
− | : [[API C_Garrison. |
+ | : [[API C_Garrison.RushHealFollower|C_Garrison.RushHealFollower]](<span class="apiarg">garrFollowerID</span>) |
+ | : [[API C_Garrison.SearchForFollower|C_Garrison.SearchForFollower]](<span class="apiarg">guid|id, searchString</span>) |
||
: [[API C_Garrison.SetFollowerFavorite|C_Garrison.SetFollowerFavorite]]() |
: [[API C_Garrison.SetFollowerFavorite|C_Garrison.SetFollowerFavorite]]() |
||
− | : [[API C_Garrison.SetFollowerInactive|C_Garrison.SetFollowerInactive]](<span |
+ | : [[API C_Garrison.SetFollowerInactive|C_Garrison.SetFollowerInactive]](<span class="apiarg">followerID, inactive</span>) |
− | : [[API C_Garrison. |
+ | : [[API C_Garrison.SetRecruitmentPreferences|C_Garrison.SetRecruitmentPreferences]](<span class="apiarg">mechanicTypeID, traitID</span>) |
− | : [[API C_Garrison. |
+ | : [[API C_Garrison.ShowFollowerNameInErrorMessage|C_Garrison.ShowFollowerNameInErrorMessage]](<span class="apiarg">missionRecID</span>) |
+ | : [[API C_Garrison.StartMission|C_Garrison.StartMission]](<span class="apiarg">missionID</span>) |
||
: [[API C_Garrison.TargetSpellHasFollowerItemLevelUpgrade|C_Garrison.TargetSpellHasFollowerItemLevelUpgrade]]() |
: [[API C_Garrison.TargetSpellHasFollowerItemLevelUpgrade|C_Garrison.TargetSpellHasFollowerItemLevelUpgrade]]() |
||
: [[API C_Garrison.TargetSpellHasFollowerReroll|C_Garrison.TargetSpellHasFollowerReroll]]() |
: [[API C_Garrison.TargetSpellHasFollowerReroll|C_Garrison.TargetSpellHasFollowerReroll]]() |
||
Line 4,871: | Line 5,565: | ||
: [[API SpellCanTargetGarrisonMission|SpellCanTargetGarrisonMission]]() |
: [[API SpellCanTargetGarrisonMission|SpellCanTargetGarrisonMission]]() |
||
− | === |
+ | ===Auto Missions=== |
+ | : [[API C_Garrison.GetAutoCombatDamageClassValues|C_Garrison.GetAutoCombatDamageClassValues]]() : <span class="apiret">damageClassStrings</span> |
||
− | ==== Artifacts ==== |
||
+ | : [[API C_Garrison.GetAutoMissionBoardState|C_Garrison.GetAutoMissionBoardState]](<span class="apiarg">missionID</span>) : <span class="apiret">targetInfo</span> |
||
− | [[Artifact]]s were added in [[Patch 7.0.3]]. |
||
+ | : [[API C_Garrison.GetAutoMissionEnvironmentEffect|C_Garrison.GetAutoMissionEnvironmentEffect]](<span class="apiarg">missionID</span>) : <span class="apiret">autoMissionEnvEffect</span> |
||
− | : [[API C_ArtifactUI.AddPower|C_ArtifactUI.AddPower]](<span style="font-size:smaller; color:#ecbc2a">powerID</span>) |
||
+ | : [[API C_Garrison.GetAutoMissionTargetingInfo|C_Garrison.GetAutoMissionTargetingInfo]](<span class="apiarg">missionID, followerID, casterBoardIndex</span>) : <span class="apiret">targetInfo</span> |
||
− | : [[API C_ArtifactUI.ApplyCursorRelicToSlot|C_ArtifactUI.ApplyCursorRelicToSlot]](<span style="font-size:smaller; color:#ecbc2a">relicSlotIndex</span>) |
||
+ | : [[API C_Garrison.GetAutoMissionTargetingInfoForSpell|C_Garrison.GetAutoMissionTargetingInfoForSpell]](<span class="apiarg">missionID, autoCombatSpellID, casterBoardIndex</span>) : <span class="apiret">targetInfo</span> |
||
− | : [[API C_ArtifactUI.CanApplyArtifactRelic|C_ArtifactUI.CanApplyArtifactRelic]](<span style="font-size:smaller; color:#ecbc2a">relicItemID, onlyUnlocked</span>) |
||
+ | : [[API C_Garrison.GetAutoTroops|C_Garrison.GetAutoTroops]](<span class="apiarg">followerType</span>) : <span class="apiret">autoTroopInfo</span> |
||
− | : [[API C_ArtifactUI.CanApplyCursorRelicToSlot|C_ArtifactUI.CanApplyCursorRelicToSlot]](<span style="font-size:smaller; color:#ecbc2a">relicSlotIndex</span>) |
||
+ | : [[API C_Garrison.GetCombatLogSpellInfo|C_Garrison.GetCombatLogSpellInfo]](<span class="apiarg">autoCombatSpellID</span>) : <span class="apiret">spellInfo</span> |
||
− | : [[API C_ArtifactUI.CanApplyRelicItemIDToEquippedArtifactSlot|C_ArtifactUI.CanApplyRelicItemIDToEquippedArtifactSlot]](<span style="font-size:smaller; color:#ecbc2a">relicItemID, relicSlotIndex</span>) |
||
+ | : [[API C_Garrison.GetFollowerAutoCombatSpells|C_Garrison.GetFollowerAutoCombatSpells]](<span class="apiarg">garrFollowerID, followerLevel</span>) : <span class="apiret">autoCombatSpells, autoCombatAutoAttack</span> |
||
− | : [[API C_ArtifactUI.CanApplyRelicItemIDToSlot|C_ArtifactUI.CanApplyRelicItemIDToSlot]](<span style="font-size:smaller; color:#ecbc2a">relicItemID, relicSlotIndex</span>) |
||
+ | : [[API C_Garrison.GetFollowerAutoCombatStats|C_Garrison.GetFollowerAutoCombatStats]](<span class="apiarg">garrFollowerID</span>) : <span class="apiret">autoCombatInfo</span> |
||
− | : [[API C_ArtifactUI.CheckRespecNPC|C_ArtifactUI.CheckRespecNPC]]() |
||
+ | : [[API C_Garrison.RegenerateCombatLog|C_Garrison.RegenerateCombatLog]](<span class="apiarg">missionID</span>) : <span class="apiret">success</span> |
||
− | : [[API C_ArtifactUI.Clear|C_ArtifactUI.Clear]]() - Clear artifact data of last opened artifact weapon. |
||
+ | : [[API C_Garrison.SetAutoCombatSpellFastForward|C_Garrison.SetAutoCombatSpellFastForward]](<span class="apiarg">state</span>) |
||
+ | |||
+ | ==Legion== |
||
+ | ===Artifacts=== |
||
+ | [[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.ApplyCursorRelicToSlot|C_ArtifactUI.ApplyCursorRelicToSlot]](<span class="apiarg">relicSlotIndex</span>) |
||
+ | : [[API C_ArtifactUI.CanApplyArtifactRelic|C_ArtifactUI.CanApplyArtifactRelic]](<span class="apiarg">relicItemID, onlyUnlocked</span>) : <span class="apiret">canApply</span> |
||
+ | : [[API C_ArtifactUI.CanApplyCursorRelicToSlot|C_ArtifactUI.CanApplyCursorRelicToSlot]](<span class="apiarg">relicSlotIndex</span>) : <span class="apiret">canApply</span> |
||
+ | : [[API C_ArtifactUI.CanApplyRelicItemIDToEquippedArtifactSlot|C_ArtifactUI.CanApplyRelicItemIDToEquippedArtifactSlot]](<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.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]]() |
||
− | : [[API C_ArtifactUI.DoesEquippedArtifactHaveAnyRelicsSlotted|C_ArtifactUI.DoesEquippedArtifactHaveAnyRelicsSlotted]]() |
+ | : [[API C_ArtifactUI.DoesEquippedArtifactHaveAnyRelicsSlotted|C_ArtifactUI.DoesEquippedArtifactHaveAnyRelicsSlotted]]() : <span class="apiret">hasAnyRelicsSlotted</span> |
− | : [[API C_ArtifactUI.GetAppearanceInfo|C_ArtifactUI.GetAppearanceInfo]](<span |
+ | : [[API C_ArtifactUI.GetAppearanceInfo|C_ArtifactUI.GetAppearanceInfo]](<span class="apiarg">appearanceSetIndex, appearanceIndex</span>) : <span class="apiret">artifactAppearanceID, appearanceName, displayIndex, unlocked, failureDescription, uiCameraID, altHandCameraID, swatchColorR, swatchColorG, swatchColorB, modelOpacity, modelSaturation, obtainable</span> - Returns information about a selected artifact appearance. |
− | : [[API C_ArtifactUI.GetAppearanceInfoByID|C_ArtifactUI.GetAppearanceInfoByID]](<span |
+ | : [[API C_ArtifactUI.GetAppearanceInfoByID|C_ArtifactUI.GetAppearanceInfoByID]](<span class="apiarg">artifactAppearanceID</span>) : <span class="apiret">artifactAppearanceSetID, artifactAppearanceID, appearanceName, displayIndex, unlocked, failureDescription, uiCameraID, altHandCameraID, swatchColorR, swatchColorG, swatchColorB, modelOpacity, modelSaturation, obtainable</span> - Returns information about a selected artifact appearance. |
− | : [[API C_ArtifactUI.GetAppearanceSetInfo|C_ArtifactUI.GetAppearanceSetInfo]](<span |
+ | : [[API C_ArtifactUI.GetAppearanceSetInfo|C_ArtifactUI.GetAppearanceSetInfo]](<span class="apiarg">appearanceSetIndex</span>) : <span class="apiret">artifactAppearanceSetID, appearanceSetName, appearanceSetDescription, numAppearances</span> |
− | : [[API C_ArtifactUI.GetArtifactArtInfo|C_ArtifactUI.GetArtifactArtInfo]]() - Returns information about the currently equipped artifact weapon. |
+ | : [[API C_ArtifactUI.GetArtifactArtInfo|C_ArtifactUI.GetArtifactArtInfo]]() : <span class="apiret">artifactArtInfo</span> - Returns information about the currently equipped artifact weapon. |
− | : [[API C_ArtifactUI.GetArtifactInfo|C_ArtifactUI.GetArtifactInfo]]() |
+ | : [[API C_ArtifactUI.GetArtifactInfo|C_ArtifactUI.GetArtifactInfo]]() : <span class="apiret">itemID, altItemID, name, icon, xp, pointsSpent, quality, artifactAppearanceID, appearanceModID, itemAppearanceID, altItemAppearanceID, altOnTop, tier</span> |
− | : [[API C_ArtifactUI.GetArtifactItemID|C_ArtifactUI.GetArtifactItemID]]() |
+ | : [[API C_ArtifactUI.GetArtifactItemID|C_ArtifactUI.GetArtifactItemID]]() : <span class="apiret">itemID</span> |
− | : [[API C_ArtifactUI.GetArtifactTier|C_ArtifactUI.GetArtifactTier]]() |
+ | : [[API C_ArtifactUI.GetArtifactTier|C_ArtifactUI.GetArtifactTier]]() : <span class="apiret">tier</span> |
− | : [[API C_ArtifactUI.GetArtifactXPRewardTargetInfo|C_ArtifactUI.GetArtifactXPRewardTargetInfo]](<span |
+ | : [[API C_ArtifactUI.GetArtifactXPRewardTargetInfo|C_ArtifactUI.GetArtifactXPRewardTargetInfo]](<span class="apiarg">artifactCategoryID</span>) : <span class="apiret">name, icon</span> |
− | : [[API C_ArtifactUI.GetCostForPointAtRank|C_ArtifactUI.GetCostForPointAtRank]](<span |
+ | : [[API C_ArtifactUI.GetCostForPointAtRank|C_ArtifactUI.GetCostForPointAtRank]](<span class="apiarg">rank, tier</span>) : <span class="apiret">cost</span> |
− | : [[API C_ArtifactUI.GetEquippedArtifactArtInfo|C_ArtifactUI.GetEquippedArtifactArtInfo]]() |
+ | : [[API C_ArtifactUI.GetEquippedArtifactArtInfo|C_ArtifactUI.GetEquippedArtifactArtInfo]]() : <span class="apiret">artifactArtInfo</span> |
− | : [[API C_ArtifactUI.GetEquippedArtifactInfo|C_ArtifactUI.GetEquippedArtifactInfo]]() |
+ | : [[API C_ArtifactUI.GetEquippedArtifactInfo|C_ArtifactUI.GetEquippedArtifactInfo]]() : <span class="apiret">itemID, altItemID, name, icon, xp, pointsSpent, quality, artifactAppearanceID, appearanceModID, itemAppearanceID, altItemAppearanceID, altOnTop, tier</span> |
− | : [[API C_ArtifactUI.GetEquippedArtifactItemID|C_ArtifactUI.GetEquippedArtifactItemID]]() |
+ | : [[API C_ArtifactUI.GetEquippedArtifactItemID|C_ArtifactUI.GetEquippedArtifactItemID]]() : <span class="apiret">itemID</span> |
− | : [[API C_ArtifactUI.GetEquippedArtifactNumRelicSlots|C_ArtifactUI.GetEquippedArtifactNumRelicSlots]](<span |
+ | : [[API C_ArtifactUI.GetEquippedArtifactNumRelicSlots|C_ArtifactUI.GetEquippedArtifactNumRelicSlots]](<span class="apiarg">[onlyUnlocked]</span>) : <span class="apiret">numRelicSlots</span> |
− | : [[API C_ArtifactUI.GetEquippedArtifactRelicInfo|C_ArtifactUI.GetEquippedArtifactRelicInfo]](<span |
+ | : [[API C_ArtifactUI.GetEquippedArtifactRelicInfo|C_ArtifactUI.GetEquippedArtifactRelicInfo]](<span class="apiarg">relicSlotIndex</span>) : <span class="apiret">name, icon, slotTypeName, link</span> |
− | : [[API C_ArtifactUI.GetEquippedRelicLockedReason|C_ArtifactUI.GetEquippedRelicLockedReason]](<span |
+ | : [[API C_ArtifactUI.GetEquippedRelicLockedReason|C_ArtifactUI.GetEquippedRelicLockedReason]](<span class="apiarg">relicSlotIndex</span>) : <span class="apiret">lockedReason</span> |
− | : [[API C_ArtifactUI.GetForgeRotation|C_ArtifactUI.GetForgeRotation]]() |
+ | : [[API C_ArtifactUI.GetForgeRotation|C_ArtifactUI.GetForgeRotation]]() : <span class="apiret">forgeRotationX, forgeRotationY, forgeRotationZ</span> |
− | : [[API C_ArtifactUI.GetItemLevelIncreaseProvidedByRelic|C_ArtifactUI.GetItemLevelIncreaseProvidedByRelic]](<span |
+ | : [[API C_ArtifactUI.GetItemLevelIncreaseProvidedByRelic|C_ArtifactUI.GetItemLevelIncreaseProvidedByRelic]](<span class="apiarg">itemLinkOrID</span>) : <span class="apiret">itemIevelIncrease</span> |
− | : [[API C_ArtifactUI.GetMetaPowerInfo|C_ArtifactUI.GetMetaPowerInfo]]() |
+ | : [[API C_ArtifactUI.GetMetaPowerInfo|C_ArtifactUI.GetMetaPowerInfo]]() : <span class="apiret">spellID, powerCost, currentRank</span> |
− | : [[API C_ArtifactUI.GetNumAppearanceSets|C_ArtifactUI.GetNumAppearanceSets]]() |
+ | : [[API C_ArtifactUI.GetNumAppearanceSets|C_ArtifactUI.GetNumAppearanceSets]]() : <span class="apiret">numAppearanceSets</span> |
− | : [[API C_ArtifactUI.GetNumObtainedArtifacts|C_ArtifactUI.GetNumObtainedArtifacts]]() |
+ | : [[API C_ArtifactUI.GetNumObtainedArtifacts|C_ArtifactUI.GetNumObtainedArtifacts]]() : <span class="apiret">numObtainedArtifacts</span> |
− | : [[API C_ArtifactUI.GetNumRelicSlots|C_ArtifactUI.GetNumRelicSlots]](<span |
+ | : [[API C_ArtifactUI.GetNumRelicSlots|C_ArtifactUI.GetNumRelicSlots]](<span class="apiarg">[onlyUnlocked]</span>) : <span class="apiret">numRelicSlots</span> |
− | : [[API C_ArtifactUI.GetPointsRemaining|C_ArtifactUI.GetPointsRemaining]]() |
+ | : [[API C_ArtifactUI.GetPointsRemaining|C_ArtifactUI.GetPointsRemaining]]() : <span class="apiret">pointsRemaining</span> |
− | : [[API C_ArtifactUI.GetPowerHyperlink|C_ArtifactUI.GetPowerHyperlink]](<span |
+ | : [[API C_ArtifactUI.GetPowerHyperlink|C_ArtifactUI.GetPowerHyperlink]](<span class="apiarg">powerID</span>) : <span class="apiret">link</span> |
− | : [[API C_ArtifactUI.GetPowerInfo|C_ArtifactUI.GetPowerInfo]](<span |
+ | : [[API C_ArtifactUI.GetPowerInfo|C_ArtifactUI.GetPowerInfo]](<span class="apiarg">powerID</span>) : <span class="apiret">powerInfo</span> |
− | : [[API C_ArtifactUI.GetPowerLinks|C_ArtifactUI.GetPowerLinks]](<span |
+ | : [[API C_ArtifactUI.GetPowerLinks|C_ArtifactUI.GetPowerLinks]](<span class="apiarg">powerID</span>) : <span class="apiret">linkingPowerID</span> |
− | : [[API C_ArtifactUI.GetPowers|C_ArtifactUI.GetPowers]]() |
+ | : [[API C_ArtifactUI.GetPowers|C_ArtifactUI.GetPowers]]() : <span class="apiret">powerID</span> |
− | : [[API C_ArtifactUI.GetPowersAffectedByRelic|C_ArtifactUI.GetPowersAffectedByRelic]](<span |
+ | : [[API C_ArtifactUI.GetPowersAffectedByRelic|C_ArtifactUI.GetPowersAffectedByRelic]](<span class="apiarg">relicSlotIndex</span>) : <span class="apiret">powerIDs</span> |
− | : [[API C_ArtifactUI.GetPowersAffectedByRelicItemLink|C_ArtifactUI.GetPowersAffectedByRelicItemLink]](<span |
+ | : [[API C_ArtifactUI.GetPowersAffectedByRelicItemLink|C_ArtifactUI.GetPowersAffectedByRelicItemLink]](<span class="apiarg">relicItemInfo</span>) : <span class="apiret">powerIDs</span> |
− | : [[API C_ArtifactUI.GetPreviewAppearance|C_ArtifactUI.GetPreviewAppearance]]() |
+ | : [[API C_ArtifactUI.GetPreviewAppearance|C_ArtifactUI.GetPreviewAppearance]]() : <span class="apiret">artifactAppearanceID</span> |
− | : [[API C_ArtifactUI.GetRelicInfo|C_ArtifactUI.GetRelicInfo]](<span |
+ | : [[API C_ArtifactUI.GetRelicInfo|C_ArtifactUI.GetRelicInfo]](<span class="apiarg">relicSlotIndex</span>) : <span class="apiret">name, icon, slotTypeName, link</span> |
− | : [[API C_ArtifactUI.GetRelicInfoByItemID|C_ArtifactUI.GetRelicInfoByItemID]](<span |
+ | : [[API C_ArtifactUI.GetRelicInfoByItemID|C_ArtifactUI.GetRelicInfoByItemID]](<span class="apiarg">itemID</span>) : <span class="apiret">name, icon, slotTypeName, link</span> |
− | : [[API C_ArtifactUI.GetRelicLockedReason|C_ArtifactUI.GetRelicLockedReason]](<span |
+ | : [[API C_ArtifactUI.GetRelicLockedReason|C_ArtifactUI.GetRelicLockedReason]](<span class="apiarg">relicSlotIndex</span>) : <span class="apiret">lockedReason</span> |
− | : [[API C_ArtifactUI.GetRelicSlotType|C_ArtifactUI.GetRelicSlotType]](<span |
+ | : [[API C_ArtifactUI.GetRelicSlotType|C_ArtifactUI.GetRelicSlotType]](<span class="apiarg">relicSlotIndex</span>) : <span class="apiret">slotTypeName</span> |
− | : [[API C_ArtifactUI.GetRespecArtifactArtInfo|C_ArtifactUI.GetRespecArtifactArtInfo]]() |
+ | : [[API C_ArtifactUI.GetRespecArtifactArtInfo|C_ArtifactUI.GetRespecArtifactArtInfo]]() : <span class="apiret">artifactArtInfo</span> |
− | : [[API C_ArtifactUI.GetRespecArtifactInfo|C_ArtifactUI.GetRespecArtifactInfo]]() |
+ | : [[API C_ArtifactUI.GetRespecArtifactInfo|C_ArtifactUI.GetRespecArtifactInfo]]() : <span class="apiret">itemID, altItemID, name, icon, xp, pointsSpent, quality, artifactAppearanceID, appearanceModID, itemAppearanceID, altItemAppearanceID, altOnTop, tier</span> |
− | : [[API C_ArtifactUI.GetRespecCost|C_ArtifactUI.GetRespecCost]]() |
+ | : [[API C_ArtifactUI.GetRespecCost|C_ArtifactUI.GetRespecCost]]() : <span class="apiret">cost</span> |
− | : [[API C_ArtifactUI.GetTotalPowerCost|C_ArtifactUI.GetTotalPowerCost]](<span |
+ | : [[API C_ArtifactUI.GetTotalPowerCost|C_ArtifactUI.GetTotalPowerCost]](<span class="apiarg">startingTrait, numTraits, artifactTier</span>) : <span class="apiret">totalArtifactPowerCost</span> |
− | : [[API C_ArtifactUI.GetTotalPurchasedRanks|C_ArtifactUI.GetTotalPurchasedRanks]]() |
+ | : [[API C_ArtifactUI.GetTotalPurchasedRanks|C_ArtifactUI.GetTotalPurchasedRanks]]() : <span class="apiret">totalPurchasedRanks</span> |
− | : [[API C_ArtifactUI.IsArtifactDisabled|C_ArtifactUI.IsArtifactDisabled]]() |
+ | : [[API C_ArtifactUI.IsArtifactDisabled|C_ArtifactUI.IsArtifactDisabled]]() : <span class="apiret">artifactDisabled</span> |
− | : [[API C_ArtifactUI.IsAtForge|C_ArtifactUI.IsAtForge]]() |
+ | : [[API C_ArtifactUI.IsAtForge|C_ArtifactUI.IsAtForge]]() : <span class="apiret">isAtForge</span> |
− | : [[API C_ArtifactUI.IsEquippedArtifactDisabled|C_ArtifactUI.IsEquippedArtifactDisabled]]() |
+ | : [[API C_ArtifactUI.IsEquippedArtifactDisabled|C_ArtifactUI.IsEquippedArtifactDisabled]]() : <span class="apiret">artifactDisabled</span> |
− | : [[API C_ArtifactUI.IsEquippedArtifactMaxed|C_ArtifactUI.IsEquippedArtifactMaxed]]() |
+ | : [[API C_ArtifactUI.IsEquippedArtifactMaxed|C_ArtifactUI.IsEquippedArtifactMaxed]]() : <span class="apiret">artifactMaxed</span> |
− | : [[API C_ArtifactUI.IsMaxedByRulesOrEffect|C_ArtifactUI.IsMaxedByRulesOrEffect]]() |
+ | : [[API C_ArtifactUI.IsMaxedByRulesOrEffect|C_ArtifactUI.IsMaxedByRulesOrEffect]]() : <span class="apiret">isEffectivelyMaxed</span> |
− | : [[API C_ArtifactUI.IsPowerKnown|C_ArtifactUI.IsPowerKnown]](<span |
+ | : [[API C_ArtifactUI.IsPowerKnown|C_ArtifactUI.IsPowerKnown]](<span class="apiarg">powerID</span>) : <span class="apiret">known</span> |
− | : [[API C_ArtifactUI.IsViewedArtifactEquipped|C_ArtifactUI.IsViewedArtifactEquipped]]() |
+ | : [[API C_ArtifactUI.IsViewedArtifactEquipped|C_ArtifactUI.IsViewedArtifactEquipped]]() : <span class="apiret">isViewedArtifactEquipped</span> |
− | : [[API C_ArtifactUI.SetAppearance|C_ArtifactUI.SetAppearance]](<span |
+ | : [[API C_ArtifactUI.SetAppearance|C_ArtifactUI.SetAppearance]](<span class="apiarg">artifactAppearanceID</span>) |
: [[API C_ArtifactUI.SetForgeCamera|C_ArtifactUI.SetForgeCamera]]() |
: [[API C_ArtifactUI.SetForgeCamera|C_ArtifactUI.SetForgeCamera]]() |
||
− | : [[API C_ArtifactUI.SetForgeRotation|C_ArtifactUI.SetForgeRotation]](<span |
+ | : [[API C_ArtifactUI.SetForgeRotation|C_ArtifactUI.SetForgeRotation]](<span class="apiarg">forgeRotationX, forgeRotationY, forgeRotationZ</span>) |
− | : [[API C_ArtifactUI.SetPreviewAppearance|C_ArtifactUI.SetPreviewAppearance]](<span |
+ | : [[API C_ArtifactUI.SetPreviewAppearance|C_ArtifactUI.SetPreviewAppearance]](<span class="apiarg">[artifactAppearanceID]</span>) |
− | : [[API C_ArtifactUI.ShouldSuppressForgeRotation|C_ArtifactUI.ShouldSuppressForgeRotation]]() |
+ | : [[API C_ArtifactUI.ShouldSuppressForgeRotation|C_ArtifactUI.ShouldSuppressForgeRotation]]() : <span class="apiret">shouldSuppressForgeRotation</span> |
: [[API HasArtifactEquipped|HasArtifactEquipped]]() |
: [[API HasArtifactEquipped|HasArtifactEquipped]]() |
||
: [[API IsArtifactPowerItem|IsArtifactPowerItem]]() |
: [[API IsArtifactPowerItem|IsArtifactPowerItem]]() |
||
− | : [[API IsArtifactRelicItem|IsArtifactRelicItem]](<span |
+ | : [[API IsArtifactRelicItem|IsArtifactRelicItem]](<span class="apiarg">item</span>) |
− | === |
+ | ===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]]() - 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. |
− | : [[API C_InvasionInfo.GetInvasionForUiMapID|C_InvasionInfo.GetInvasionForUiMapID]](<span |
+ | : [[API C_InvasionInfo.GetInvasionForUiMapID|C_InvasionInfo.GetInvasionForUiMapID]](<span class="apiarg">uiMapID</span>) : <span class="apiret">invasionID</span> - Returns any invasion for a map. |
− | : [[API C_InvasionInfo.GetInvasionInfo|C_InvasionInfo.GetInvasionInfo]](<span |
+ | : [[API C_InvasionInfo.GetInvasionInfo|C_InvasionInfo.GetInvasionInfo]](<span class="apiarg">invasionID</span>) : <span class="apiret">invasionInfo</span> - Returns invasion info. |
− | : [[API C_InvasionInfo.GetInvasionTimeLeft|C_InvasionInfo.GetInvasionTimeLeft]](<span |
+ | : [[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=== |
+ | Relates to buildings on the [[Broken Shore]] or [[Warfront|Warfronts]]; added in [[Patch 7.2.0]]. |
||
− | ==== Azerite ==== |
||
+ | : [[API C_ContributionCollector.Close|C_ContributionCollector.Close]]() - Closes the contribution collector API state. |
||
− | [[:Azerite]] was added in [[Patch 8.0.1]]. |
||
+ | : [[API C_ContributionCollector.Contribute|C_ContributionCollector.Contribute]](<span class="apiarg">contributionID</span>) - Contributes resources to a building. |
||
− | : [[API C_AzeriteItem.FindActiveAzeriteItem|C_AzeriteItem.FindActiveAzeriteItem]]() |
||
+ | : [[API C_ContributionCollector.GetActive|C_ContributionCollector.GetActive]]() : <span class="apiret">contributionID</span> - Returns the currently active buildings. |
||
− | : [[API C_AzeriteItem.GetAzeriteItemXPInfo|C_AzeriteItem.GetAzeriteItemXPInfo]](<span style="font-size:smaller; color:#ecbc2a">azeriteItemLocation</span>) |
||
+ | : [[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_AzeriteItem.GetPowerLevel|C_AzeriteItem.GetPowerLevel]](<span style="font-size:smaller; color:#ecbc2a">azeriteItemLocation</span>) |
||
+ | : [[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_AzeriteItem.GetUnlimitedPowerLevel|C_AzeriteItem.GetUnlimitedPowerLevel]](<span style="font-size:smaller; color:#ecbc2a">azeriteItemLocation</span>) |
||
+ | : [[API C_ContributionCollector.GetContributionAppearance|C_ContributionCollector.GetContributionAppearance]](<span class="apiarg">contributionID, contributionState</span>) : <span class="apiret">appearance</span> - Returns contribution appearance info. |
||
− | : [[API C_AzeriteItem.HasActiveAzeriteItem|C_AzeriteItem.HasActiveAzeriteItem]]() |
||
+ | : [[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_AzeriteItem.IsAzeriteItem|C_AzeriteItem.IsAzeriteItem]](<span style="font-size:smaller; color:#ecbc2a">itemLocation</span>) |
||
+ | : [[API C_ContributionCollector.GetContributionResult|C_ContributionCollector.GetContributionResult]](<span class="apiarg">contributionID</span>) : <span class="apiret">result</span> - Returns a value indicating the result of a contribution. |
||
− | : [[API C_AzeriteItem.IsAzeriteItemAtMaxLevel|C_AzeriteItem.IsAzeriteItemAtMaxLevel]]() |
||
+ | : [[API C_ContributionCollector.GetDescription|C_ContributionCollector.GetDescription]](<span class="apiarg">contributionID</span>) : <span class="apiret">description</span> - Returns the description of a building. |
||
− | : [[API C_AzeriteItem.IsAzeriteItemByID|C_AzeriteItem.IsAzeriteItemByID]](<span style="font-size:smaller; color:#ecbc2a">itemInfo</span>) |
||
+ | : [[API C_ContributionCollector.GetManagedContributionsForCreatureID|C_ContributionCollector.GetManagedContributionsForCreatureID]](<span class="apiarg">creatureID</span>) : <span class="apiret">contributionID</span> - Returns contributions for a creature. |
||
− | : [[API C_AzeriteItem.IsAzeriteItemEnabled|C_AzeriteItem.IsAzeriteItemEnabled]](<span style="font-size:smaller; color:#ecbc2a">azeriteItemLocation</span>) |
||
+ | : [[API C_ContributionCollector.GetName|C_ContributionCollector.GetName]](<span class="apiarg">contributionID</span>) : <span class="apiret">name</span> - Returns the name of a building. |
||
− | : [[API C_AzeriteEmpoweredItem.CanSelectPower|C_AzeriteEmpoweredItem.CanSelectPower]](<span style="font-size:smaller; color:#ecbc2a">azeriteEmpoweredItemLocation, powerID</span>) |
||
+ | : [[API C_ContributionCollector.GetOrderIndex|C_ContributionCollector.GetOrderIndex]](<span class="apiarg">contributionID</span>) : <span class="apiret">orderIndex</span> - Returns the order in which buildings are displayed. |
||
− | : [[API C_AzeriteEmpoweredItem.CloseAzeriteEmpoweredItemRespec|C_AzeriteEmpoweredItem.CloseAzeriteEmpoweredItemRespec]](<span style="font-size:smaller; color:#ecbc2a">azeriteEmpoweredItemLocation</span>)) |
||
+ | : [[API C_ContributionCollector.GetRequiredContributionCurrency|C_ContributionCollector.GetRequiredContributionCurrency]](<span class="apiarg">contributionID</span>) : <span class="apiret">currencyID, currencyAmount</span> - Returns the currencyID and amount needed to contribute to a building. |
||
− | : [[API C_AzeriteEmpoweredItem.ConfirmAzeriteEmpoweredItemRespec|C_AzeriteEmpoweredItem.ConfirmAzeriteEmpoweredItemRespec]](<span style="font-size:smaller; color:#ecbc2a">azeriteEmpoweredItemLocation</span>) |
||
+ | : [[API C_ContributionCollector.GetRequiredContributionItem|C_ContributionCollector.GetRequiredContributionItem]](<span class="apiarg">contributionID</span>) : <span class="apiret">itemID, itemCount</span> - Returns the itemID and amount needed to contribute to a building. |
||
− | : [[API C_AzeriteEmpoweredItem.GetAllTierInfo|C_AzeriteEmpoweredItem.GetAllTierInfo]](<span style="font-size:smaller; color:#ecbc2a">azeriteEmpoweredItemLocation</span>) |
||
+ | : [[API C_ContributionCollector.GetRewardQuestID|C_ContributionCollector.GetRewardQuestID]](<span class="apiarg">contributionID</span>) : <span class="apiret">questID</span> - Returns the hidden quest that is flagged completed when a contribution is made. |
||
− | : [[API C_AzeriteEmpoweredItem.GetAllTierInfoByItemID|C_AzeriteEmpoweredItem.GetAllTierInfoByItemID]](<span style="font-size:smaller; color:#ecbc2a">itemInfo [, classID]</span>) |
||
+ | : [[API C_ContributionCollector.GetState|C_ContributionCollector.GetState]](<span class="apiarg">contributionID</span>) : <span class="apiret">contributionState, contributionPercentageComplete, timeOfNextStateChange, startTime</span> - Returns the current state of a building, its completion percentage, and time until next state change. |
||
− | : [[API C_AzeriteEmpoweredItem.GetAzeriteEmpoweredItemRespecCost|C_AzeriteEmpoweredItem.GetAzeriteEmpoweredItemRespecCost]]() |
||
+ | : [[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_AzeriteEmpoweredItem.GetPowerInfo|C_AzeriteEmpoweredItem.GetPowerInfo]](<span style="font-size:smaller; color:#ecbc2a">powerID</span>) |
||
+ | : [[API C_ContributionCollector.IsAwaitingRewardQuestData|C_ContributionCollector.IsAwaitingRewardQuestData]](<span class="apiarg">contributionID</span>) : <span class="apiret">awaitingData</span> - Returns true if the client is waiting for quest reward data. |
||
− | : [[API C_AzeriteEmpoweredItem.GetPowerText|C_AzeriteEmpoweredItem.GetPowerText]](<span style="font-size:smaller; color:#ecbc2a">azeriteEmpoweredItemLocation, powerID, level</span>) |
||
+ | |||
− | : [[API C_AzeriteEmpoweredItem.GetSpecsForPower|C_AzeriteEmpoweredItem.GetSpecsForPower]](<span style="font-size:smaller; color:#ecbc2a">powerID</span>) |
||
+ | ==Battle for Azeroth== |
||
− | : [[API C_AzeriteEmpoweredItem.HasAnyUnselectedPowers|C_AzeriteEmpoweredItem.HasAnyUnselectedPowers]](<span style="font-size:smaller; color:#ecbc2a">azeriteEmpoweredItemLocation</span>) |
||
+ | ===Azerite=== |
||
− | : [[API C_AzeriteEmpoweredItem.HasBeenViewed|C_AzeriteEmpoweredItem.HasBeenViewed]](<span style="font-size:smaller; color:#ecbc2a">azeriteEmpoweredItemLocation</span>) |
||
+ | [[:Azerite]] was added in [[Patch 8.0.1]] |
||
− | : [[API C_AzeriteEmpoweredItem.IsAzeriteEmpoweredItem|C_AzeriteEmpoweredItem.IsAzeriteEmpoweredItem]](<span style="font-size:smaller; color:#ecbc2a">itemLocation</span>) |
||
+ | : [[API C_AzeriteItem.FindActiveAzeriteItem|C_AzeriteItem.FindActiveAzeriteItem]]() : <span class="apiret">activeAzeriteItemLocation</span> |
||
− | : [[API C_AzeriteEmpoweredItem.IsAzeriteEmpoweredItemByID|C_AzeriteEmpoweredItem.IsAzeriteEmpoweredItemByID]](<span style="font-size:smaller; color:#ecbc2a">itemInfo</span>) |
||
+ | : [[API C_AzeriteItem.GetAzeriteItemXPInfo|C_AzeriteItem.GetAzeriteItemXPInfo]](<span class="apiarg">azeriteItemLocation</span>) : <span class="apiret">xp, totalLevelXP</span> |
||
− | : [[API C_AzeriteEmpoweredItem.IsAzeritePreviewSourceDisplayable|C_AzeriteEmpoweredItem.IsAzeritePreviewSourceDisplayable]](<span style="font-size:smaller; color:#ecbc2a">itemInfo [, classID]</span>) |
||
+ | : [[API C_AzeriteItem.GetPowerLevel|C_AzeriteItem.GetPowerLevel]](<span class="apiarg">azeriteItemLocation</span>) : <span class="apiret">powerLevel</span> |
||
− | : [[API C_AzeriteEmpoweredItem.IsHeartOfAzerothEquipped|C_AzeriteEmpoweredItem.IsHeartOfAzerothEquipped]](<span style="font-size:smaller; color:#ecbc2a">powerID, specID</span>) |
||
+ | : [[API C_AzeriteItem.GetUnlimitedPowerLevel|C_AzeriteItem.GetUnlimitedPowerLevel]](<span class="apiarg">azeriteItemLocation</span>) : <span class="apiret">powerLevel</span> |
||
− | : [[API C_AzeriteEmpoweredItem.IsPowerAvailableForSpec|C_AzeriteEmpoweredItem.IsPowerAvailableForSpec]](<span style="font-size:smaller; color:#ecbc2a">azeriteEmpoweredItemLocation, powerID</span>) |
||
+ | : [[API C_AzeriteItem.HasActiveAzeriteItem|C_AzeriteItem.HasActiveAzeriteItem]]() : <span class="apiret">hasActiveAzeriteItem</span> |
||
− | : [[API C_AzeriteEmpoweredItem.IsPowerSelected|C_AzeriteEmpoweredItem.IsPowerSelected]](<span style="font-size:smaller; color:#ecbc2a">azeriteEmpoweredItemLocation, powerID</span>) |
||
+ | : [[API C_AzeriteItem.IsAzeriteItem|C_AzeriteItem.IsAzeriteItem]](<span class="apiarg">itemLocation</span>) : <span class="apiret">isAzeriteItem</span> |
||
− | : [[API C_AzeriteEmpoweredItem.SelectPower|C_AzeriteEmpoweredItem.SelectPower]](<span style="font-size:smaller; color:#ecbc2a">azeriteEmpoweredItemLocation, powerID</span>) |
||
+ | : [[API C_AzeriteItem.IsAzeriteItemAtMaxLevel|C_AzeriteItem.IsAzeriteItemAtMaxLevel]]() : <span class="apiret">isAtMax</span> |
||
− | : [[API C_AzeriteEmpoweredItem.SetHasBeenViewed|C_AzeriteEmpoweredItem.SetHasBeenViewed]](<span style="font-size:smaller; color:#ecbc2a">azeriteEmpoweredItemLocation</span>) |
||
+ | : [[API C_AzeriteItem.IsAzeriteItemByID|C_AzeriteItem.IsAzeriteItemByID]](<span class="apiarg">itemInfo</span>) : <span class="apiret">isAzeriteItem</span> |
||
− | : [[API C_PaperDollInfo.GetInspectAzeriteItemEmpoweredChoices|C_PaperDollInfo.GetInspectAzeriteItemEmpoweredChoices]](<span style="font-size:smaller; color:#ecbc2a">unit, equipmentSlotIndex</span>) |
||
+ | : [[API C_AzeriteItem.IsAzeriteItemEnabled|C_AzeriteItem.IsAzeriteItemEnabled]](<span class="apiarg">azeriteItemLocation</span>) : <span class="apiret">isEnabled</span> |
||
− | Azerite Essences were added in [[Patch 8.2.0]]. |
||
+ | : [[API C_AzeriteEmpoweredItem.CanSelectPower|C_AzeriteEmpoweredItem.CanSelectPower]](<span class="apiarg">azeriteEmpoweredItemLocation, powerID</span>) : <span class="apiret">canSelect</span> |
||
− | : [[API C_AzeriteEssence.ActivateEssence|C_AzeriteEssence.ActivateEssence]](<span style="font-size:smaller; color:#ecbc2a">essenceID, milestoneID</span>) |
||
+ | : [[API C_AzeriteEmpoweredItem.ConfirmAzeriteEmpoweredItemRespec|C_AzeriteEmpoweredItem.ConfirmAzeriteEmpoweredItemRespec]](<span class="apiarg">azeriteEmpoweredItemLocation</span>) |
||
− | : [[API C_AzeriteEssence.CanActivateEssence|C_AzeriteEssence.CanActivateEssence]](<span style="font-size:smaller; color:#ecbc2a">essenceID, milestoneID</span>) |
||
+ | : [[API C_AzeriteEmpoweredItem.GetAllTierInfo|C_AzeriteEmpoweredItem.GetAllTierInfo]](<span class="apiarg">azeriteEmpoweredItemLocation</span>) : <span class="apiret">tierInfo</span> |
||
− | : [[API C_AzeriteEssence.CanDeactivateEssence|C_AzeriteEssence.CanDeactivateEssence]](<span style="font-size:smaller; color:#ecbc2a">milestoneID</span>) |
||
+ | : [[API C_AzeriteEmpoweredItem.GetAllTierInfoByItemID|C_AzeriteEmpoweredItem.GetAllTierInfoByItemID]](<span class="apiarg">itemInfo [, classID]</span>) : <span class="apiret">tierInfo</span> |
||
− | : [[API C_AzeriteEssence.CanOpenUI|C_AzeriteEssence.CanOpenUI]]() |
||
+ | : [[API C_AzeriteEmpoweredItem.GetAzeriteEmpoweredItemRespecCost|C_AzeriteEmpoweredItem.GetAzeriteEmpoweredItemRespecCost]]() : <span class="apiret">cost</span> |
||
+ | : [[API C_AzeriteEmpoweredItem.GetPowerInfo|C_AzeriteEmpoweredItem.GetPowerInfo]](<span class="apiarg">powerID</span>) : <span class="apiret">powerInfo</span> |
||
+ | : [[API C_AzeriteEmpoweredItem.GetPowerText|C_AzeriteEmpoweredItem.GetPowerText]](<span class="apiarg">azeriteEmpoweredItemLocation, powerID, level</span>) : <span class="apiret">powerText</span> |
||
+ | : [[API C_AzeriteEmpoweredItem.GetSpecsForPower|C_AzeriteEmpoweredItem.GetSpecsForPower]](<span class="apiarg">powerID</span>) : <span class="apiret">specInfo</span> |
||
+ | : [[API C_AzeriteEmpoweredItem.HasAnyUnselectedPowers|C_AzeriteEmpoweredItem.HasAnyUnselectedPowers]](<span class="apiarg">azeriteEmpoweredItemLocation</span>) : <span class="apiret">hasAnyUnselectedPowers</span> |
||
+ | : [[API C_AzeriteEmpoweredItem.HasBeenViewed|C_AzeriteEmpoweredItem.HasBeenViewed]](<span class="apiarg">azeriteEmpoweredItemLocation</span>) : <span class="apiret">hasBeenViewed</span> |
||
+ | : [[API C_AzeriteEmpoweredItem.IsAzeriteEmpoweredItem|C_AzeriteEmpoweredItem.IsAzeriteEmpoweredItem]](<span class="apiarg">itemLocation</span>) : <span class="apiret">isAzeriteEmpoweredItem</span> |
||
+ | : [[API C_AzeriteEmpoweredItem.IsAzeriteEmpoweredItemByID|C_AzeriteEmpoweredItem.IsAzeriteEmpoweredItemByID]](<span class="apiarg">itemInfo</span>) : <span class="apiret">isAzeriteEmpoweredItem</span> |
||
+ | : [[API C_AzeriteEmpoweredItem.IsAzeritePreviewSourceDisplayable|C_AzeriteEmpoweredItem.IsAzeritePreviewSourceDisplayable]](<span class="apiarg">itemInfo [, classID]</span>) : <span class="apiret">isAzeritePreviewSourceDisplayable</span> |
||
+ | : [[API C_AzeriteEmpoweredItem.IsHeartOfAzerothEquipped|C_AzeriteEmpoweredItem.IsHeartOfAzerothEquipped]]() : <span class="apiret">isHeartOfAzerothEquipped</span> |
||
+ | : [[API C_AzeriteEmpoweredItem.IsPowerAvailableForSpec|C_AzeriteEmpoweredItem.IsPowerAvailableForSpec]](<span class="apiarg">powerID, specID</span>) : <span class="apiret">isPowerAvailableForSpec</span> |
||
+ | : [[API C_AzeriteEmpoweredItem.IsPowerSelected|C_AzeriteEmpoweredItem.IsPowerSelected]](<span class="apiarg">azeriteEmpoweredItemLocation, powerID</span>) : <span class="apiret">isSelected</span> |
||
+ | : [[API C_AzeriteEmpoweredItem.SelectPower|C_AzeriteEmpoweredItem.SelectPower]](<span class="apiarg">azeriteEmpoweredItemLocation, powerID</span>) : <span class="apiret">success</span> |
||
+ | : [[API C_AzeriteEmpoweredItem.SetHasBeenViewed|C_AzeriteEmpoweredItem.SetHasBeenViewed]](<span class="apiarg">azeriteEmpoweredItemLocation</span>) |
||
+ | : [[API C_PaperDollInfo.GetInspectAzeriteItemEmpoweredChoices|C_PaperDollInfo.GetInspectAzeriteItemEmpoweredChoices]](<span class="apiarg">unit, equipmentSlotIndex</span>) : <span class="apiret">azeritePowerIDs</span> |
||
+ | Azerite Essences were added in [[Patch 8.2.0]] |
||
+ | : [[API C_AzeriteEssence.ActivateEssence|C_AzeriteEssence.ActivateEssence]](<span class="apiarg">essenceID, milestoneID</span>) |
||
+ | : [[API C_AzeriteEssence.CanActivateEssence|C_AzeriteEssence.CanActivateEssence]](<span class="apiarg">essenceID, milestoneID</span>) : <span class="apiret">canActivate</span> |
||
+ | : [[API C_AzeriteEssence.CanDeactivateEssence|C_AzeriteEssence.CanDeactivateEssence]](<span class="apiarg">milestoneID</span>) : <span class="apiret">canDeactivate</span> |
||
+ | : [[API C_AzeriteEssence.CanOpenUI|C_AzeriteEssence.CanOpenUI]]() : <span class="apiret">canOpen</span> |
||
: [[API C_AzeriteEssence.ClearPendingActivationEssence|C_AzeriteEssence.ClearPendingActivationEssence]]() |
: [[API C_AzeriteEssence.ClearPendingActivationEssence|C_AzeriteEssence.ClearPendingActivationEssence]]() |
||
: [[API C_AzeriteEssence.CloseForge|C_AzeriteEssence.CloseForge]]() |
: [[API C_AzeriteEssence.CloseForge|C_AzeriteEssence.CloseForge]]() |
||
− | : [[API C_AzeriteEssence.GetEssenceHyperlink|C_AzeriteEssence.GetEssenceHyperlink]](<span |
+ | : [[API C_AzeriteEssence.GetEssenceHyperlink|C_AzeriteEssence.GetEssenceHyperlink]](<span class="apiarg">essenceID, rank</span>) : <span class="apiret">link</span> |
− | : [[API C_AzeriteEssence.GetEssenceInfo|C_AzeriteEssence.GetEssenceInfo]](<span |
+ | : [[API C_AzeriteEssence.GetEssenceInfo|C_AzeriteEssence.GetEssenceInfo]](<span class="apiarg">essenceID</span>) : <span class="apiret">info</span> |
− | : [[API C_AzeriteEssence.GetEssences|C_AzeriteEssence.GetEssences]]() |
+ | : [[API C_AzeriteEssence.GetEssences|C_AzeriteEssence.GetEssences]]() : <span class="apiret">essences</span> |
− | : [[API C_AzeriteEssence.GetMilestoneEssence|C_AzeriteEssence.GetMilestoneEssence]](<span |
+ | : [[API C_AzeriteEssence.GetMilestoneEssence|C_AzeriteEssence.GetMilestoneEssence]](<span class="apiarg">milestoneID</span>) : <span class="apiret">essenceID</span> |
− | : [[API C_AzeriteEssence.GetMilestoneInfo|C_AzeriteEssence.GetMilestoneInfo]](<span |
+ | : [[API C_AzeriteEssence.GetMilestoneInfo|C_AzeriteEssence.GetMilestoneInfo]](<span class="apiarg">milestoneID</span>) : <span class="apiret">info</span> |
− | : [[API C_AzeriteEssence.GetMilestones|C_AzeriteEssence.GetMilestones]]() |
+ | : [[API C_AzeriteEssence.GetMilestones|C_AzeriteEssence.GetMilestones]]() : <span class="apiret">milestones</span> |
− | : [[API C_AzeriteEssence.GetMilestoneSpell|C_AzeriteEssence.GetMilestoneSpell]](<span |
+ | : [[API C_AzeriteEssence.GetMilestoneSpell|C_AzeriteEssence.GetMilestoneSpell]](<span class="apiarg">milestoneID</span>) : <span class="apiret">spellID</span> |
− | : [[API C_AzeriteEssence.GetNumUnlockedEssences|C_AzeriteEssence.GetNumUnlockedEssences]]() |
+ | : [[API C_AzeriteEssence.GetNumUnlockedEssences|C_AzeriteEssence.GetNumUnlockedEssences]]() : <span class="apiret">numUnlockedEssences</span> |
− | : [[API C_AzeriteEssence.GetNumUsableEssences|C_AzeriteEssence.GetNumUsableEssences]]() |
+ | : [[API C_AzeriteEssence.GetNumUsableEssences|C_AzeriteEssence.GetNumUsableEssences]]() : <span class="apiret">numUsableEssences</span> |
− | : [[API C_AzeriteEssence.GetPendingActivationEssence|C_AzeriteEssence.GetPendingActivationEssence]]() |
+ | : [[API C_AzeriteEssence.GetPendingActivationEssence|C_AzeriteEssence.GetPendingActivationEssence]]() : <span class="apiret">essenceID</span> |
− | : [[API C_AzeriteEssence.HasNeverActivatedAnyEssences|C_AzeriteEssence.HasNeverActivatedAnyEssences]]() |
+ | : [[API C_AzeriteEssence.HasNeverActivatedAnyEssences|C_AzeriteEssence.HasNeverActivatedAnyEssences]]() : <span class="apiret">hasNeverActivatedAnyEssences</span> |
− | : [[API C_AzeriteEssence.HasPendingActivationEssence|C_AzeriteEssence.HasPendingActivationEssence]]() |
+ | : [[API C_AzeriteEssence.HasPendingActivationEssence|C_AzeriteEssence.HasPendingActivationEssence]]() : <span class="apiret">hasEssence</span> |
− | : [[API C_AzeriteEssence.IsAtForge|C_AzeriteEssence.IsAtForge]]() |
+ | : [[API C_AzeriteEssence.IsAtForge|C_AzeriteEssence.IsAtForge]]() : <span class="apiret">isAtForge</span> |
− | : [[API C_AzeriteEssence.SetPendingActivationEssence|C_AzeriteEssence.SetPendingActivationEssence]](<span |
+ | : [[API C_AzeriteEssence.SetPendingActivationEssence|C_AzeriteEssence.SetPendingActivationEssence]](<span class="apiarg">essenceID</span>) |
− | : [[API C_AzeriteEssence.UnlockMilestone|C_AzeriteEssence.UnlockMilestone]](<span |
+ | : [[API C_AzeriteEssence.UnlockMilestone|C_AzeriteEssence.UnlockMilestone]](<span class="apiarg">milestoneID</span>) |
− | === |
+ | ===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 |
+ | : [[API C_Item.IsItemCorrupted|C_Item.IsItemCorrupted]](<span class="apiarg">itemLoc</span>) : <span class="apiret">isCorrupted</span> |
− | : [[API C_Item.IsItemCorruptionRelated|C_Item.IsItemCorruptionRelated]](<span |
+ | : [[API C_Item.IsItemCorruptionRelated|C_Item.IsItemCorruptionRelated]](<span class="apiarg">itemLoc</span>) : <span class="apiret">isCorruptionRelated</span> |
− | : [[API C_Item.IsItemCorruptionResistant|C_Item.IsItemCorruptionResistant]](<span |
+ | : [[API C_Item.IsItemCorruptionResistant|C_Item.IsItemCorruptionResistant]](<span class="apiarg">itemLoc</span>) : <span class="apiret">isCorruptionResistant</span> |
− | : [[API C_ItemInteraction.SetCorruptionReforgerItemTooltip|C_ItemInteraction.SetCorruptionReforgerItemTooltip]]() |
||
: [[API GetCorruption|GetCorruption]]() |
: [[API GetCorruption|GetCorruption]]() |
||
: [[API GetCorruptionResistance|GetCorruptionResistance]]() |
: [[API GetCorruptionResistance|GetCorruptionResistance]]() |
||
− | : [[API GetNegativeCorruptionEffectInfo|GetNegativeCorruptionEffectInfo]]() |
+ | : [[API GetNegativeCorruptionEffectInfo|GetNegativeCorruptionEffectInfo]]() : <span class="apiret">corruptionEffects</span> |
− | : [[API IsCorruptedItem|IsCorruptedItem]](<span |
+ | : [[API IsCorruptedItem|IsCorruptedItem]](<span class="apiarg">item</span>) |
− | === |
+ | ===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. |
||
− | : [[API C_IslandsQueue.GetIslandDifficultyInfo|C_IslandsQueue.GetIslandDifficultyInfo]]() - Returns the island expedition modes. |
+ | : [[API C_IslandsQueue.GetIslandDifficultyInfo|C_IslandsQueue.GetIslandDifficultyInfo]]() : <span class="apiret">islandDifficultyInfo</span> - Returns the island expedition modes. |
− | : [[API C_IslandsQueue.GetIslandsMaxGroupSize|C_IslandsQueue.GetIslandsMaxGroupSize]]() - Returns the max group size for expeditions. |
+ | : [[API C_IslandsQueue.GetIslandsMaxGroupSize|C_IslandsQueue.GetIslandsMaxGroupSize]]() : <span class="apiret">maxGroupSize</span> - Returns the max group size for expeditions. |
− | : [[API C_IslandsQueue.GetIslandsWeeklyQuestID|C_IslandsQueue.GetIslandsWeeklyQuestID]]() - Returns the weekly island quest. |
+ | : [[API C_IslandsQueue.GetIslandsWeeklyQuestID|C_IslandsQueue.GetIslandsWeeklyQuestID]]() : <span class="apiret">questID</span> - Returns the weekly island quest. |
− | : [[API C_IslandsQueue.QueueForIsland|C_IslandsQueue.QueueForIsland]](<span |
+ | : [[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 |
+ | : [[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 |
+ | : [[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=== |
− | 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 |
+ | : [[API C_Item.CanScrapItem|C_Item.CanScrapItem]](<span class="apiarg">itemLoc</span>) : <span class="apiret">canBeScrapped</span> |
: [[API C_ScrappingMachineUI.CloseScrappingMachine|C_ScrappingMachineUI.CloseScrappingMachine]]() |
: [[API C_ScrappingMachineUI.CloseScrappingMachine|C_ScrappingMachineUI.CloseScrappingMachine]]() |
||
− | : [[API C_ScrappingMachineUI.DropPendingScrapItemFromCursor|C_ScrappingMachineUI.DropPendingScrapItemFromCursor]](<span |
+ | : [[API C_ScrappingMachineUI.DropPendingScrapItemFromCursor|C_ScrappingMachineUI.DropPendingScrapItemFromCursor]](<span class="apiarg">index</span>) |
− | : [[API C_ScrappingMachineUI.GetCurrentPendingScrapItemLocationByIndex|C_ScrappingMachineUI.GetCurrentPendingScrapItemLocationByIndex]](<span |
+ | : [[API C_ScrappingMachineUI.GetCurrentPendingScrapItemLocationByIndex|C_ScrappingMachineUI.GetCurrentPendingScrapItemLocationByIndex]](<span class="apiarg">index</span>) : <span class="apiret">itemLoc</span> |
− | : [[API C_ScrappingMachineUI.GetScrapSpellID|C_ScrappingMachineUI.GetScrapSpellID]]() |
+ | : [[API C_ScrappingMachineUI.GetScrapSpellID|C_ScrappingMachineUI.GetScrapSpellID]]() : <span class="apiret">spellID</span> |
− | : [[API C_ScrappingMachineUI.GetScrappingMachineName|C_ScrappingMachineUI.GetScrappingMachineName]]() |
+ | : [[API C_ScrappingMachineUI.GetScrappingMachineName|C_ScrappingMachineUI.GetScrappingMachineName]]() : <span class="apiret">name</span> |
− | : [[API C_ScrappingMachineUI.HasScrappableItems|C_ScrappingMachineUI.HasScrappableItems]]() |
+ | : [[API C_ScrappingMachineUI.HasScrappableItems|C_ScrappingMachineUI.HasScrappableItems]]() : <span class="apiret">hasScrappableItems</span> |
: [[API C_ScrappingMachineUI.RemoveAllScrapItems|C_ScrappingMachineUI.RemoveAllScrapItems]]() |
: [[API C_ScrappingMachineUI.RemoveAllScrapItems|C_ScrappingMachineUI.RemoveAllScrapItems]]() |
||
: [[API C_ScrappingMachineUI.RemoveCurrentScrappingItem|C_ScrappingMachineUI.RemoveCurrentScrappingItem]]() |
: [[API C_ScrappingMachineUI.RemoveCurrentScrappingItem|C_ScrappingMachineUI.RemoveCurrentScrappingItem]]() |
||
− | : [[API C_ScrappingMachineUI.RemoveItemToScrap|C_ScrappingMachineUI.RemoveItemToScrap]](<span |
+ | : [[API C_ScrappingMachineUI.RemoveItemToScrap|C_ScrappingMachineUI.RemoveItemToScrap]](<span class="apiarg">index</span>) |
: [[API C_ScrappingMachineUI.ScrapItems|C_ScrappingMachineUI.ScrapItems]]() |
: [[API C_ScrappingMachineUI.ScrapItems|C_ScrappingMachineUI.ScrapItems]]() |
||
− | : [[API C_ScrappingMachineUI.SetScrappingMachine|C_ScrappingMachineUI.SetScrappingMachine]](<span style="font-size:smaller; color:#ecbc2a">gameObject</span>) |
||
: [[API C_ScrappingMachineUI.ValidateScrappingList|C_ScrappingMachineUI.ValidateScrappingList]]() |
: [[API C_ScrappingMachineUI.ValidateScrappingList|C_ScrappingMachineUI.ValidateScrappingList]]() |
||
− | == |
+ | ==Shadowlands== |
+ | Ardenweald |
||
− | ==== Anima ==== |
||
+ | : [[API C_ArdenwealdGardening.GetGardenData|C_ArdenwealdGardening.GetGardenData]]() : <span class="apiret">data</span> |
||
+ | : [[API C_ArdenwealdGardening.IsGardenAccessible|C_ArdenwealdGardening.IsGardenAccessible]]() : <span class="apiret">accessible</span> |
||
+ | The Maw |
||
+ | : [[API C_Spell.GetMawPowerBorderAtlasBySpellID|C_Spell.GetMawPowerBorderAtlasBySpellID]](<span class="apiarg">spellID</span>) : <span class="apiret">rarityBorderAtlas</span> |
||
+ | : [[API GetMawPowerLinkBySpellID|GetMawPowerLinkBySpellID]](<span class="apiarg">spellID</span>) |
||
+ | Torghast |
||
+ | : [[API C_PartyInfo.IsPartyInJailersTower|C_PartyInfo.IsPartyInJailersTower]]() : <span class="apiret">isPartyInJailersTower</span> |
||
+ | : [[API C_ScenarioInfo.GetJailersTowerTypeString|C_ScenarioInfo.GetJailersTowerTypeString]](<span class="apiarg">runType</span>) : <span class="apiret">typeString</span> |
||
+ | : [[API GetJailersTowerLevel|GetJailersTowerLevel]]() |
||
+ | : [[API IsInJailersTower|IsInJailersTower]]() |
||
+ | : [[API IsJailersTowerLayerTimeLocked|IsJailersTowerLayerTimeLocked]]() |
||
+ | : [[API IsOnGroundFloorInJailersTower|IsOnGroundFloorInJailersTower]]() |
||
+ | |||
+ | ===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]]() |
||
− | : [[API C_AnimaDiversion.GetAnimaDiversionNodes|C_AnimaDiversion.GetAnimaDiversionNodes]]() |
+ | : [[API C_AnimaDiversion.GetAnimaDiversionNodes|C_AnimaDiversion.GetAnimaDiversionNodes]]() : <span class="apiret">animaNodes</span> |
− | : [[API C_AnimaDiversion.GetOriginPosition|C_AnimaDiversion.GetOriginPosition]]() |
+ | : [[API C_AnimaDiversion.GetOriginPosition|C_AnimaDiversion.GetOriginPosition]]() : <span class="apiret">normalizedPosition</span> |
− | : [[API C_AnimaDiversion.GetReinforceProgress|C_AnimaDiversion.GetReinforceProgress]]() |
+ | : [[API C_AnimaDiversion.GetReinforceProgress|C_AnimaDiversion.GetReinforceProgress]]() : <span class="apiret">progress</span> |
− | : [[API C_AnimaDiversion.GetTextureKit|C_AnimaDiversion.GetTextureKit]]() |
+ | : [[API C_AnimaDiversion.GetTextureKit|C_AnimaDiversion.GetTextureKit]]() : <span class="apiret">textureKit</span> |
: [[API C_AnimaDiversion.OpenAnimaDiversionUI|C_AnimaDiversion.OpenAnimaDiversionUI]]() |
: [[API C_AnimaDiversion.OpenAnimaDiversionUI|C_AnimaDiversion.OpenAnimaDiversionUI]]() |
||
− | : [[API C_AnimaDiversion.SelectAnimaNode|C_AnimaDiversion.SelectAnimaNode]](<span |
+ | : [[API C_AnimaDiversion.SelectAnimaNode|C_AnimaDiversion.SelectAnimaNode]](<span class="apiarg">talentID, temporary</span>) |
+ | : [[API C_Item.IsAnimaItemByID|C_Item.IsAnimaItemByID]](<span class="apiarg">itemInfo</span>) : <span class="apiret">isAnimaItem</span> |
||
− | === |
+ | ===Covenants=== |
− | [https://www.wowhead.com/guides/chromie-time-leveling-zone-expansion-scaling Timewalking Campaigns] scales older expansion zones up to level 50. |
||
− | : [[API C_ChromieTime.CloseUI|C_ChromieTime.CloseUI]]() |
||
− | : [[API C_ChromieTime.GetChromieTimeExpansionOption|C_ChromieTime.GetChromieTimeExpansionOption]](<span style="font-size:smaller; color:#ecbc2a">expansionRecID</span>) |
||
− | : [[API C_ChromieTime.GetChromieTimeExpansionOptions|C_ChromieTime.GetChromieTimeExpansionOptions]]() |
||
− | : [[API C_ChromieTime.SelectChromieTimeOption|C_ChromieTime.SelectChromieTimeOption]](<span style="font-size:smaller; color:#ecbc2a">chromieTimeExpansionInfoId</span>) |
||
− | : [[API C_PlayerInfo.CanPlayerEnterChromieTime|C_PlayerInfo.CanPlayerEnterChromieTime]]() |
||
− | : [[API C_PlayerInfo.IsPlayerInChromieTime|C_PlayerInfo.IsPlayerInChromieTime]]() |
||
− | : [[API UnitChromieTimeID|UnitChromieTimeID]](<span style="font-size:smaller; color:#ecbc2a">unit</span>) |
||
− | |||
− | ==== 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_CovenantCallings.AreCallingsUnlocked|C_CovenantCallings.AreCallingsUnlocked]]() |
||
+ | : [[API C_Covenants.GetCovenantData|C_Covenants.GetCovenantData]](<span class="apiarg">covenantID</span>) : <span class="apiret">data</span> |
||
+ | : [[API C_Covenants.GetCovenantIDs|C_Covenants.GetCovenantIDs]]() : <span class="apiret">covenantID</span> |
||
+ | : [[API C_CovenantCallings.AreCallingsUnlocked|C_CovenantCallings.AreCallingsUnlocked]]() : <span class="apiret">unlocked</span> |
||
: [[API C_CovenantCallings.RequestCallings|C_CovenantCallings.RequestCallings]]() |
: [[API C_CovenantCallings.RequestCallings|C_CovenantCallings.RequestCallings]]() |
||
: [[API C_CovenantPreview.CloseFromUI|C_CovenantPreview.CloseFromUI]]() |
: [[API C_CovenantPreview.CloseFromUI|C_CovenantPreview.CloseFromUI]]() |
||
− | : [[API C_CovenantPreview.GetCovenantInfoForPlayerChoiceResponseID|C_CovenantPreview.GetCovenantInfoForPlayerChoiceResponseID]](<span |
+ | : [[API C_CovenantPreview.GetCovenantInfoForPlayerChoiceResponseID|C_CovenantPreview.GetCovenantInfoForPlayerChoiceResponseID]](<span class="apiarg">playerChoiceResponseID</span>) : <span class="apiret">previewInfo</span> |
+ | : [[API C_CovenantSanctumUI.CanAccessReservoir|C_CovenantSanctumUI.CanAccessReservoir]]() : <span class="apiret">canAccess</span> |
||
− | : [[API C_Covenants.GetActiveCovenantID|C_Covenants.GetActiveCovenantID]]() |
||
− | : [[API |
+ | : [[API C_CovenantSanctumUI.CanDepositAnima|C_CovenantSanctumUI.CanDepositAnima]]() : <span class="apiret">canDeposit</span> |
+ | : [[API C_CovenantSanctumUI.DepositAnima|C_CovenantSanctumUI.DepositAnima]]() {{apitag|protected}} |
||
− | : [[API C_Covenants.GetCovenantIDs|C_Covenants.GetCovenantIDs]]() |
||
− | : [[API C_CovenantSanctumUI.DepositAnima|C_CovenantSanctumUI.DepositAnima]]() |
||
: [[API C_CovenantSanctumUI.EndInteraction|C_CovenantSanctumUI.EndInteraction]]() |
: [[API C_CovenantSanctumUI.EndInteraction|C_CovenantSanctumUI.EndInteraction]]() |
||
− | : [[API C_CovenantSanctumUI.GetAnimaInfo|C_CovenantSanctumUI.GetAnimaInfo]]() |
+ | : [[API C_CovenantSanctumUI.GetAnimaInfo|C_CovenantSanctumUI.GetAnimaInfo]]() : <span class="apiret">currencyID, maxDisplayableValue</span> |
− | : [[API C_CovenantSanctumUI. |
+ | : [[API C_CovenantSanctumUI.GetCurrentTalentTreeID|C_CovenantSanctumUI.GetCurrentTalentTreeID]]() : <span class="apiret">currentTalentTreeID</span> |
− | : [[API C_CovenantSanctumUI. |
+ | : [[API C_CovenantSanctumUI.GetFeatures|C_CovenantSanctumUI.GetFeatures]]() : <span class="apiret">features</span> |
− | : [[API C_CovenantSanctumUI. |
+ | : [[API C_CovenantSanctumUI.GetRenownLevel|C_CovenantSanctumUI.GetRenownLevel]]() : <span class="apiret">level</span> |
− | : [[API C_CovenantSanctumUI. |
+ | : [[API C_CovenantSanctumUI.GetRenownLevels|C_CovenantSanctumUI.GetRenownLevels]](<span class="apiarg">covenantID</span>) : <span class="apiret">levels</span> |
− | : [[API C_CovenantSanctumUI. |
+ | : [[API C_CovenantSanctumUI.GetRenownRewardsForLevel|C_CovenantSanctumUI.GetRenownRewardsForLevel]](<span class="apiarg">covenantID, renownLevel</span>) : <span class="apiret">rewards</span> |
− | : [[API C_CovenantSanctumUI. |
+ | : [[API C_CovenantSanctumUI.GetSanctumType|C_CovenantSanctumUI.GetSanctumType]]() : <span class="apiret">sanctumType</span> |
+ | : [[API C_CovenantSanctumUI.GetSoulCurrencies|C_CovenantSanctumUI.GetSoulCurrencies]]() : <span class="apiret">currencyIDs</span> |
||
+ | : [[API C_CovenantSanctumUI.HasMaximumRenown|C_CovenantSanctumUI.HasMaximumRenown]]() : <span class="apiret">hasMaxRenown</span> |
||
+ | : [[API C_CovenantSanctumUI.IsPlayerInRenownCatchUpMode|C_CovenantSanctumUI.IsPlayerInRenownCatchUpMode]]() : <span class="apiret">isInCatchUpMode</span> |
||
+ | : [[API C_CovenantSanctumUI.IsWeeklyRenownCapped|C_CovenantSanctumUI.IsWeeklyRenownCapped]]() : <span class="apiret">isWeeklyCapped</span> |
||
+ | : [[API C_CovenantSanctumUI.RequestCatchUpState|C_CovenantSanctumUI.RequestCatchUpState]]() |
||
− | === |
+ | ===Legendary Crafting=== |
− | Soulbinding is the act of joining a [[Covenant]]. |
||
− | : [[API C_Soulbinds.ActivateSoulbind|C_Soulbinds.ActivateSoulbind]](<span style="font-size:smaller; color:#ecbc2a">soulbindID</span>) |
||
− | : [[API C_Soulbinds.AddPendingConduit|C_Soulbinds.AddPendingConduit]](<span style="font-size:smaller; color:#ecbc2a">nodeID, conduitID</span>) |
||
− | : [[API C_Soulbinds.CanActivateSoulbind|C_Soulbinds.CanActivateSoulbind]](<span style="font-size:smaller; color:#ecbc2a">soulbindID</span>) |
||
− | : [[API C_Soulbinds.CanModifySoulbind|C_Soulbinds.CanModifySoulbind]]() |
||
− | : [[API C_Soulbinds.CanResetConduitsInSoulbind|C_Soulbinds.CanResetConduitsInSoulbind]](<span style="font-size:smaller; color:#ecbc2a">soulbindID</span>) |
||
− | : [[API C_Soulbinds.CloseUI|C_Soulbinds.CloseUI]]() |
||
− | : [[API C_Soulbinds.CommitPendingConduitsInSoulbind|C_Soulbinds.CommitPendingConduitsInSoulbind]](<span style="font-size:smaller; color:#ecbc2a">soulbindID</span>) |
||
− | : [[API C_Soulbinds.GetActiveSoulbindID|C_Soulbinds.GetActiveSoulbindID]]() |
||
− | : [[API C_Soulbinds.GetConduitCollection|C_Soulbinds.GetConduitCollection]](<span style="font-size:smaller; color:#ecbc2a">conduitType</span>) |
||
− | : [[API C_Soulbinds.GetConduitCollectionData|C_Soulbinds.GetConduitCollectionData]](<span style="font-size:smaller; color:#ecbc2a">conduitID</span>) |
||
− | : [[API C_Soulbinds.GetConduitCollectionDataAtCursor|C_Soulbinds.GetConduitCollectionDataAtCursor]]() |
||
− | : [[API C_Soulbinds.GetConduitHyperlink|C_Soulbinds.GetConduitHyperlink]](<span style="font-size:smaller; color:#ecbc2a">conduitID, rank</span>) |
||
− | : [[API C_Soulbinds.GetConduitItemLevel|C_Soulbinds.GetConduitItemLevel]](<span style="font-size:smaller; color:#ecbc2a">conduitID, rank</span>) |
||
− | : [[API C_Soulbinds.GetConduitQuality|C_Soulbinds.GetConduitQuality]](<span style="font-size:smaller; color:#ecbc2a">conduitID, rank</span>) |
||
− | : [[API C_Soulbinds.GetConduitSpellID|C_Soulbinds.GetConduitSpellID]](<span style="font-size:smaller; color:#ecbc2a">conduitID, conduitRank</span>) |
||
− | : [[API C_Soulbinds.GetNode|C_Soulbinds.GetNode]](<span style="font-size:smaller; color:#ecbc2a">nodeID</span>) |
||
− | : [[API C_Soulbinds.GetPendingConduitID|C_Soulbinds.GetPendingConduitID]](<span style="font-size:smaller; color:#ecbc2a">nodeID</span>) |
||
− | : [[API C_Soulbinds.GetPendingNodeIDInSoulbind|C_Soulbinds.GetPendingNodeIDInSoulbind]](<span style="font-size:smaller; color:#ecbc2a">soulbindID, conduitID</span>) |
||
− | : [[API C_Soulbinds.GetSoulbindData|C_Soulbinds.GetSoulbindData]](<span style="font-size:smaller; color:#ecbc2a">soulbindID</span>) |
||
− | : [[API C_Soulbinds.GetTree|C_Soulbinds.GetTree]](<span style="font-size:smaller; color:#ecbc2a">treeID</span>) |
||
− | : [[API C_Soulbinds.HasAnyInstalledConduitInSoulbind|C_Soulbinds.HasAnyInstalledConduitInSoulbind]](<span style="font-size:smaller; color:#ecbc2a">soulbindID</span>) |
||
− | : [[API C_Soulbinds.HasAnyPendingConduits|C_Soulbinds.HasAnyPendingConduits]]() |
||
− | : [[API C_Soulbinds.HasPendingConduitInSoulbind|C_Soulbinds.HasPendingConduitInSoulbind]](<span style="font-size:smaller; color:#ecbc2a">soulbindID, conduitID</span>) |
||
− | : [[API C_Soulbinds.HasPendingConduitsInSoulbind|C_Soulbinds.HasPendingConduitsInSoulbind]](<span style="font-size:smaller; color:#ecbc2a">soulbindID</span>) |
||
− | : [[API C_Soulbinds.IsConduitInstalled|C_Soulbinds.IsConduitInstalled]](<span style="font-size:smaller; color:#ecbc2a">nodeID</span>) |
||
− | : [[API C_Soulbinds.IsConduitInstalledInSoulbind|C_Soulbinds.IsConduitInstalledInSoulbind]](<span style="font-size:smaller; color:#ecbc2a">soulbindID, conduitID</span>) |
||
− | : [[API C_Soulbinds.IsItemConduitByItemInfo|C_Soulbinds.IsItemConduitByItemInfo]](<span style="font-size:smaller; color:#ecbc2a">itemInfo</span>) |
||
− | : [[API C_Soulbinds.IsUnselectedConduitPendingInSoulbind|C_Soulbinds.IsUnselectedConduitPendingInSoulbind]](<span style="font-size:smaller; color:#ecbc2a">soulbindID</span>) |
||
− | : [[API C_Soulbinds.MatchesCurrentSpecSet|C_Soulbinds.MatchesCurrentSpecSet]](<span style="font-size:smaller; color:#ecbc2a">specSetID</span>) |
||
− | : [[API C_Soulbinds.RemovePendingConduit|C_Soulbinds.RemovePendingConduit]](<span style="font-size:smaller; color:#ecbc2a">nodeID</span>) |
||
− | : [[API C_Soulbinds.ResetSoulbindConduits|C_Soulbinds.ResetSoulbindConduits]](<span style="font-size:smaller; color:#ecbc2a">soulbindID</span>) |
||
− | : [[API C_Soulbinds.SelectNode|C_Soulbinds.SelectNode]](<span style="font-size:smaller; color:#ecbc2a">nodeID</span>) |
||
− | : [[API SetCursorVirtualItem|SetCursorVirtualItem]]() |
||
− | |||
− | ==== 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]]() |
||
− | : [[API C_LegendaryCrafting.CraftRuneforgeLegendary|C_LegendaryCrafting.CraftRuneforgeLegendary]](<span |
+ | : [[API C_LegendaryCrafting.CraftRuneforgeLegendary|C_LegendaryCrafting.CraftRuneforgeLegendary]](<span class="apiarg">description</span>) |
− | : [[API C_LegendaryCrafting.GetRuneforgeItemPreviewInfo|C_LegendaryCrafting.GetRuneforgeItemPreviewInfo]](<span |
+ | : [[API C_LegendaryCrafting.GetRuneforgeItemPreviewInfo|C_LegendaryCrafting.GetRuneforgeItemPreviewInfo]](<span class="apiarg">baseItem [, runeforgePowerID, modifiers]</span>) : <span class="apiret">info</span> |
− | : [[API C_LegendaryCrafting.GetRuneforgeLegendaryComponentInfo|C_LegendaryCrafting.GetRuneforgeLegendaryComponentInfo]](<span |
+ | : [[API C_LegendaryCrafting.GetRuneforgeLegendaryComponentInfo|C_LegendaryCrafting.GetRuneforgeLegendaryComponentInfo]](<span class="apiarg">runeforgeLegendary</span>) : <span class="apiret">componentInfo</span> |
− | : [[API C_LegendaryCrafting.GetRuneforgeLegendaryCost|C_LegendaryCrafting.GetRuneforgeLegendaryCost]](<span |
+ | : [[API C_LegendaryCrafting.GetRuneforgeLegendaryCost|C_LegendaryCrafting.GetRuneforgeLegendaryCost]](<span class="apiarg">baseItem</span>) : <span class="apiret">cost</span> |
− | : [[API C_LegendaryCrafting.GetRuneforgeLegendaryCraftSpellID|C_LegendaryCrafting.GetRuneforgeLegendaryCraftSpellID]]() |
+ | : [[API C_LegendaryCrafting.GetRuneforgeLegendaryCraftSpellID|C_LegendaryCrafting.GetRuneforgeLegendaryCraftSpellID]]() : <span class="apiret">spellID</span> |
− | : [[API C_LegendaryCrafting.GetRuneforgeLegendaryCurrencies|C_LegendaryCrafting.GetRuneforgeLegendaryCurrencies]]() |
+ | : [[API C_LegendaryCrafting.GetRuneforgeLegendaryCurrencies|C_LegendaryCrafting.GetRuneforgeLegendaryCurrencies]]() : <span class="apiret">currencies</span> |
− | : [[API C_LegendaryCrafting.GetRuneforgeLegendaryUpgradeCost|C_LegendaryCrafting.GetRuneforgeLegendaryUpgradeCost]](<span |
+ | : [[API C_LegendaryCrafting.GetRuneforgeLegendaryUpgradeCost|C_LegendaryCrafting.GetRuneforgeLegendaryUpgradeCost]](<span class="apiarg">runeforgeLegendary, upgradeItem</span>) : <span class="apiret">cost</span> |
− | : [[API C_LegendaryCrafting.GetRuneforgeModifierInfo|C_LegendaryCrafting.GetRuneforgeModifierInfo]](<span |
+ | : [[API C_LegendaryCrafting.GetRuneforgeModifierInfo|C_LegendaryCrafting.GetRuneforgeModifierInfo]](<span class="apiarg">baseItem, [powerID], addedModifierIndex, modifiers</span>) : <span class="apiret">name, description</span> |
− | : [[API C_LegendaryCrafting.GetRuneforgeModifiers|C_LegendaryCrafting.GetRuneforgeModifiers]]() |
+ | : [[API C_LegendaryCrafting.GetRuneforgeModifiers|C_LegendaryCrafting.GetRuneforgeModifiers]]() : <span class="apiret">modifiedReagentItemIDs</span> |
− | : [[API C_LegendaryCrafting.GetRuneforgePowerInfo|C_LegendaryCrafting.GetRuneforgePowerInfo]](<span |
+ | : [[API C_LegendaryCrafting.GetRuneforgePowerInfo|C_LegendaryCrafting.GetRuneforgePowerInfo]](<span class="apiarg">runeforgePowerID</span>) : <span class="apiret">power</span> |
− | : [[API C_LegendaryCrafting.GetRuneforgePowers|C_LegendaryCrafting.GetRuneforgePowers]](<span |
+ | : [[API C_LegendaryCrafting.GetRuneforgePowers|C_LegendaryCrafting.GetRuneforgePowers]](<span class="apiarg">[baseItem, filter]</span>) : <span class="apiret">primaryRuneforgePowerIDs, otherRuneforgePowerIDs</span> |
− | : [[API C_LegendaryCrafting. |
+ | : [[API C_LegendaryCrafting.GetRuneforgePowersByClassSpecAndCovenant|C_LegendaryCrafting.GetRuneforgePowersByClassSpecAndCovenant]](<span class="apiarg">[classID, specID, covenantID, filter]</span>) : <span class="apiret">runeforgePowerIDs</span> |
− | : [[API C_LegendaryCrafting.GetRuneforgePowerSlots|C_LegendaryCrafting.GetRuneforgePowerSlots]](<span |
+ | : [[API C_LegendaryCrafting.GetRuneforgePowerSlots|C_LegendaryCrafting.GetRuneforgePowerSlots]](<span class="apiarg">runeforgePowerID</span>) : <span class="apiret">slotNames</span> |
− | : [[API C_LegendaryCrafting.IsRuneforgeLegendary|C_LegendaryCrafting.IsRuneforgeLegendary]](<span |
+ | : [[API C_LegendaryCrafting.IsRuneforgeLegendary|C_LegendaryCrafting.IsRuneforgeLegendary]](<span class="apiarg">item</span>) : <span class="apiret">isRuneforgeLegendary</span> |
− | : [[API C_LegendaryCrafting.IsRuneforgeLegendaryMaxLevel|C_LegendaryCrafting.IsRuneforgeLegendaryMaxLevel]](<span |
+ | : [[API C_LegendaryCrafting.IsRuneforgeLegendaryMaxLevel|C_LegendaryCrafting.IsRuneforgeLegendaryMaxLevel]](<span class="apiarg">runeforgeLegendary</span>) : <span class="apiret">isMaxLevel</span> |
− | : [[API C_LegendaryCrafting.IsUpgradeItemValidForRuneforgeLegendary|C_LegendaryCrafting.IsUpgradeItemValidForRuneforgeLegendary]](<span |
+ | : [[API C_LegendaryCrafting.IsUpgradeItemValidForRuneforgeLegendary|C_LegendaryCrafting.IsUpgradeItemValidForRuneforgeLegendary]](<span class="apiarg">runeforgeLegendary, upgradeItem</span>) : <span class="apiret">isValid</span> |
− | : [[API C_LegendaryCrafting.IsValidRuneforgeBaseItem| |
+ | : [[API C_LegendaryCrafting.IsValidRuneforgeBaseItem|C_LegendaryCrafting.IsValidRuneforgeBaseItem]](<span class="apiarg">baseItem</span>) : <span class="apiret">isValid</span> |
− | : [[API C_LegendaryCrafting.MakeRuneforgeCraftDescription|C_LegendaryCrafting.MakeRuneforgeCraftDescription]](<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 |
+ | : [[API C_LegendaryCrafting.UpgradeRuneforgeLegendary|C_LegendaryCrafting.UpgradeRuneforgeLegendary]](<span class="apiarg">runeforgeLegendary, upgradeItem</span>) |
− | === |
+ | ===Soulbinds=== |
+ | Relates to [[Soulbinding]] and [[Conduit]]s. |
||
− | [[Torghast, Tower of the Damned]] is an infinite dungeon. |
||
+ | : [[API C_Soulbinds.ActivateSoulbind|C_Soulbinds.ActivateSoulbind]](<span class="apiarg">soulbindID</span>) |
||
− | : [[API C_Spell.GetMawPowerRarityStringAndBorderAtlasBySpellID|C_Spell.GetMawPowerRarityStringAndBorderAtlasBySpellID]](<span style="font-size:smaller; color:#ecbc2a">spellID</span>) |
||
+ | : [[API C_Soulbinds.CanActivateSoulbind|C_Soulbinds.CanActivateSoulbind]](<span class="apiarg">soulbindID</span>) : <span class="apiret">result, errorDescription</span> |
||
− | : [[API GetJailersTowerLevel|GetJailersTowerLevel]]() |
||
− | : [[API |
+ | : [[API C_Soulbinds.CanModifySoulbind|C_Soulbinds.CanModifySoulbind]]() : <span class="apiret">result</span> |
+ | : [[API C_Soulbinds.CanResetConduitsInSoulbind|C_Soulbinds.CanResetConduitsInSoulbind]](<span class="apiarg">soulbindID</span>) : <span class="apiret">result, errorDescription</span> |
||
− | : [[API IsInJailersTower|IsInJailersTower]]() |
||
+ | : [[API C_Soulbinds.CanSwitchActiveSoulbindTreeBranch|C_Soulbinds.CanSwitchActiveSoulbindTreeBranch]]() : <span class="apiret">result</span> |
||
− | : [[API IsOnGroundFloorInJailersTower|IsOnGroundFloorInJailersTower]]() |
||
+ | : [[API C_Soulbinds.CloseUI|C_Soulbinds.CloseUI]]() |
||
− | |||
+ | : [[API C_Soulbinds.CommitPendingConduitsInSoulbind|C_Soulbinds.CommitPendingConduitsInSoulbind]](<span class="apiarg">soulbindID</span>) |
||
− | == Classic == |
||
+ | : [[API C_Soulbinds.FindNodeIDActuallyInstalled|C_Soulbinds.FindNodeIDActuallyInstalled]](<span class="apiarg">soulbindID, conduitID</span>) : <span class="apiret">nodeID</span> |
||
− | {{Wow-inline}} See [[Global functions/Classic]] for a complete list (with 8.x specific API) and [[Patch 1.13.2/API changes]] |
||
+ | : [[API C_Soulbinds.FindNodeIDAppearingInstalled|C_Soulbinds.FindNodeIDAppearingInstalled]](<span class="apiarg">soulbindID, conduitID</span>) : <span class="apiret">nodeID</span> |
||
− | {{i-note|This list is up to date as of classic-ptr 1.13.4 (33491) Feb 25 2020}} |
||
+ | : [[API C_Soulbinds.FindNodeIDPendingInstall|C_Soulbinds.FindNodeIDPendingInstall]](<span class="apiarg">soulbindID, conduitID</span>) : <span class="apiret">nodeID</span> |
||
− | : [[API C_StorePublic.HasPurchaseableProducts|C_StorePublic.HasPurchaseableProducts]]() |
||
+ | : [[API C_Soulbinds.FindNodeIDPendingUninstall|C_Soulbinds.FindNodeIDPendingUninstall]](<span class="apiarg">soulbindID, conduitID</span>) : <span class="apiret">nodeID</span> |
||
− | : [[API AttemptToSaveBindings|AttemptToSaveBindings]](<span style="font-size:smaller; color:#ecbc2a">which</span>) - Writes the current in-memory key bindings to disk. |
||
+ | : [[API C_Soulbinds.GetActiveSoulbindID|C_Soulbinds.GetActiveSoulbindID]]() : <span class="apiret">soulbindID</span> |
||
− | : [[API CastingInfo|CastingInfo]]() - Returns the player's currently casting spell. |
||
+ | : [[API C_Soulbinds.GetConduitCollection|C_Soulbinds.GetConduitCollection]](<span class="apiarg">conduitType</span>) : <span class="apiret">collectionData</span> |
||
− | : [[API ChannelInfo|ChannelInfo]]() - Returns the player's currently channeling spell. |
||
+ | : [[API C_Soulbinds.GetConduitCollectionCount|C_Soulbinds.GetConduitCollectionCount]]() : <span class="apiret">count</span> |
||
− | : [[API IsPlayerAttacking|IsPlayerAttacking]](<span style="font-size:smaller; color:#ecbc2a">unit</span>) - Returns if the player is melee attacking the specified unit. |
||
+ | : [[API C_Soulbinds.GetConduitCollectionData|C_Soulbinds.GetConduitCollectionData]](<span class="apiarg">conduitID</span>) : <span class="apiret">collectionData</span> |
||
− | : [[API ShowCloak|ShowCloak]](<span style="font-size:smaller; color:#ecbc2a">flag</span>) - Enables or disables display of your cloak. |
||
+ | : [[API C_Soulbinds.GetConduitCollectionDataAtCursor|C_Soulbinds.GetConduitCollectionDataAtCursor]]() : <span class="apiret">collectionData</span> |
||
− | : [[API ShowHelm|ShowHelm]](<span style="font-size:smaller; color:#ecbc2a">flag</span>) - Enables or disables display of your helm. |
||
+ | : [[API C_Soulbinds.GetConduitCollectionDataByVirtualID|C_Soulbinds.GetConduitCollectionDataByVirtualID]](<span class="apiarg">virtualID</span>) : <span class="apiret">collectionData</span> |
||
− | : [[API ShowingCloak|ShowingCloak]]() - Returns if the player is showing his cloak. |
||
+ | : [[API C_Soulbinds.GetConduitDisplayed|C_Soulbinds.GetConduitDisplayed]](<span class="apiarg">nodeID</span>) : <span class="apiret">conduitID</span> |
||
− | : [[API ShowingHelm|ShowingHelm]]() - Returns if the player is showing his helm. |
||
+ | : [[API C_Soulbinds.GetConduitHyperlink|C_Soulbinds.GetConduitHyperlink]](<span class="apiarg">conduitID, rank</span>) : <span class="apiret">link</span> |
||
− | |||
+ | : [[API C_Soulbinds.GetConduitIDPendingInstall|C_Soulbinds.GetConduitIDPendingInstall]](<span class="apiarg">nodeID</span>) : <span class="apiret">conduitID</span> |
||
− | === Auction House === |
||
+ | : [[API C_Soulbinds.GetConduitQuality|C_Soulbinds.GetConduitQuality]](<span class="apiarg">conduitID, rank</span>) : <span class="apiret">quality</span> |
||
− | : [[API CalculateAuctionDeposit|CalculateAuctionDeposit]](<span style="font-size:smaller; color:#ecbc2a">runTime, stackSize, numStacks</span>) - Returns the required deposit for the current selling item given the specified duration (1=12h, 2=24h, 3=48h). |
||
+ | : [[API C_Soulbinds.GetConduitRank|C_Soulbinds.GetConduitRank]](<span class="apiarg">conduitID</span>) : <span class="apiret">conduitRank</span> |
||
− | : [[API CanCancelAuction|CanCancelAuction]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Returns 1 if auction can be canceled. |
||
+ | : [[API C_Soulbinds.GetConduitSpellID|C_Soulbinds.GetConduitSpellID]](<span class="apiarg">conduitID, conduitRank</span>) : <span class="apiret">spellID</span> |
||
− | : [[API CanSendAuctionQuery|CanSendAuctionQuery]]() - Returns 1 if auction search button would be active, nil otherwise. |
||
+ | : [[API C_Soulbinds.GetInstalledConduitID|C_Soulbinds.GetInstalledConduitID]](<span class="apiarg">nodeID</span>) : <span class="apiret">conduitID</span> |
||
− | : [[API CancelAuction|CancelAuction]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Cancel the specified auction (on the "owner" list). |
||
+ | : [[API C_Soulbinds.GetNode|C_Soulbinds.GetNode]](<span class="apiarg">nodeID</span>) : <span class="apiret">node</span> |
||
− | : [[API CancelSell|CancelSell]]() - Clears the auction house listing queue, not creating any additional auctions. |
||
+ | : [[API C_Soulbinds.GetSoulbindData|C_Soulbinds.GetSoulbindData]](<span class="apiarg">soulbindID</span>) : <span class="apiret">data</span> |
||
− | : [[API ClickAuctionSellItemButton|ClickAuctionSellItemButton]]() - Puts the currently 'picked up' item into the 'create auction' slot. |
||
+ | : [[API C_Soulbinds.GetSpecsAssignedToSoulbind|C_Soulbinds.GetSpecsAssignedToSoulbind]](<span class="apiarg">soulbindID</span>) : <span class="apiret">specIDs</span> |
||
− | : [[API CloseAuctionHouse|CloseAuctionHouse]]() - Will close the AuctionFrame if opened. |
||
+ | : [[API C_Soulbinds.GetTree|C_Soulbinds.GetTree]](<span class="apiarg">treeID</span>) : <span class="apiret">tree</span> |
||
− | : [[API GetAuctionDeposit|GetAuctionDeposit]](<span style="font-size:smaller; color:#ecbc2a">runTime, minBid, buyoutPrice [, itemCount, numStacks]</span>) |
||
+ | : [[API C_Soulbinds.HasAnyInstalledConduitInSoulbind|C_Soulbinds.HasAnyInstalledConduitInSoulbind]](<span class="apiarg">soulbindID</span>) : <span class="apiret">result</span> |
||
− | : [[API GetAuctionHouseDepositRate|GetAuctionHouseDepositRate]]() - Returns the deposit rate (percentage) for the currently open auction house (Possibly out-dated by [[API CalculateAuctionDeposit|CalculateAuctionDeposit]]). |
||
+ | : [[API C_Soulbinds.HasAnyPendingConduits|C_Soulbinds.HasAnyPendingConduits]]() : <span class="apiret">result</span> |
||
− | : [[API GetAuctionItemBattlePetInfo|GetAuctionItemBattlePetInfo]](<span style="font-size:smaller; color:#ecbc2a">type, index</span>) - Returns model details about the specified Battle Pet auction item. |
||
+ | : [[API C_Soulbinds.HasPendingConduitsInSoulbind|C_Soulbinds.HasPendingConduitsInSoulbind]](<span class="apiarg">soulbindID</span>) : <span class="apiret">result</span> |
||
− | : [[API GetAuctionItemInfo|GetAuctionItemInfo]](<span style="font-size:smaller; color:#ecbc2a">type, index</span>) - Returns details about the specified auction item. |
||
+ | : [[API C_Soulbinds.IsConduitInstalled|C_Soulbinds.IsConduitInstalled]](<span class="apiarg">nodeID</span>) : <span class="apiret">result</span> |
||
− | : [[API GetAuctionItemLink|GetAuctionItemLink]](<span style="font-size:smaller; color:#ecbc2a">type, index</span>) - Returns an [[itemLink]] for the specified auction item. |
||
+ | : [[API C_Soulbinds.IsConduitInstalledInSoulbind|C_Soulbinds.IsConduitInstalledInSoulbind]](<span class="apiarg">soulbindID, conduitID</span>) : <span class="apiret">result</span> |
||
− | : [[API GetAuctionItemSubClasses|GetAuctionItemSubClasses]](<span style="font-size:smaller; color:#ecbc2a">classID</span>) - Returns subcategories for the item category. |
||
+ | : [[API C_Soulbinds.IsItemConduitByItemInfo|C_Soulbinds.IsItemConduitByItemInfo]](<span class="apiarg">itemInfo</span>) : <span class="apiret">result</span> |
||
− | : [[API GetAuctionItemTimeLeft|GetAuctionItemTimeLeft]](<span style="font-size:smaller; color:#ecbc2a">type, index</span>) - Returns the time left status of the specified auction item. |
||
+ | : [[API C_Soulbinds.IsNodePendingModify|C_Soulbinds.IsNodePendingModify]](<span class="apiarg">nodeID</span>) : <span class="apiret">result</span> |
||
− | : [[API GetAuctionSellItemInfo|GetAuctionSellItemInfo]]() - Returns information about the current selling item (or nil if none selected). |
||
+ | : [[API C_Soulbinds.IsUnselectedConduitPendingInSoulbind|C_Soulbinds.IsUnselectedConduitPendingInSoulbind]](<span class="apiarg">soulbindID</span>) : <span class="apiret">result</span> |
||
− | : [[API GetAuctionSort|GetAuctionSort]]() |
||
+ | : [[API C_Soulbinds.ModifyNode|C_Soulbinds.ModifyNode]](<span class="apiarg">nodeID, conduitID, type</span>) |
||
− | : [[API GetBidderAuctionItems|GetBidderAuctionItems]](<span style="font-size:smaller; color:#ecbc2a">[page]</span>) - Returns details about an auction item on which the user is bidding (possibly out-dated by [[API GetAuctionItemInfo|GetAuctionItemInfo]]</small>) |
||
+ | : [[API C_Soulbinds.SelectNode|C_Soulbinds.SelectNode]](<span class="apiarg">nodeID</span>) |
||
− | : [[API GetNumAuctionItems|GetNumAuctionItems]](<span style="font-size:smaller; color:#ecbc2a">type</span>) - Returns the size of the specified auction item list. |
||
+ | : [[API C_Soulbinds.UnmodifyNode|C_Soulbinds.UnmodifyNode]](<span class="apiarg">nodeID</span>) |
||
− | : [[API GetOwnerAuctionItems|GetOwnerAuctionItems]](<span style="font-size:smaller; color:#ecbc2a">[page]</span>) - Returns details about an auction item of which the user is the owner (possibly out-dated by [[API GetAuctionItemInfo|GetAuctionItemInfo]]</small>) |
||
+ | : [[API C_Item.IsItemConduit|C_Item.IsItemConduit]](<span class="apiarg">itemLoc</span>) : <span class="apiret">isConduit</span> |
||
− | : [[API GetSelectedAuctionItem|GetSelectedAuctionItem]](<span style="font-size:smaller; color:#ecbc2a">type</span>) - Returns the index (1-50) of the selected auction item or 0 if none is selected. |
||
+ | : [[API SetCursorVirtualItem|SetCursorVirtualItem]]() |
||
− | : [[API IsAuctionSortReversed|IsAuctionSortReversed]](<span style="font-size:smaller; color:#ecbc2a">type, sort</span>) - Returns 1 if the specified auction list and sort is reversed, nil otherwise. |
||
− | : [[API PlaceAuctionBid|PlaceAuctionBid]](<span style="font-size:smaller; color:#ecbc2a">type, index, bid</span>) - Place a bid on the selected auction item. |
||
− | : [[API PostAuction|PostAuction]](<span style="font-size:smaller; color:#ecbc2a">minBid, buyoutPrice, runTime, count</span>) |
||
− | : [[API QueryAuctionItems|QueryAuctionItems]](<span style="font-size:smaller; color:#ecbc2a">name, minLevel, maxLevel, invTypeIndex, classIndex, subclassIndex, page, isUsable, qualityIndex</span>) - Performs a search of the auction house with the specified characteristics. |
||
− | : [[API SetAuctionsTabShowing|SetAuctionsTabShowing]](<span style="font-size:smaller; color:#ecbc2a">showing</span>) - Sets whether auction-related events should be delivered to the client. |
||
− | : [[API SetSelectedAuctionItem|SetSelectedAuctionItem]](<span style="font-size:smaller; color:#ecbc2a">type, index</span>) - Selects a specific item in the auction house. |
||
− | : [[API SortAuctionApplySort|SortAuctionApplySort]](<span style="font-size:smaller; color:#ecbc2a">type</span>) |
||
− | : [[API SortAuctionClearSort|SortAuctionClearSort]](<span style="font-size:smaller; color:#ecbc2a">type</span>) |
||
− | : [[API SortAuctionItems|SortAuctionItems]](<span style="font-size:smaller; color:#ecbc2a">type, sort</span>) - Toggles sorting the specific auction list by a specific column. (deprecated around Patch 2.0) |
||
− | : [[API SortAuctionSetSort|SortAuctionSetSort]](<span style="font-size:smaller; color:#ecbc2a">type, sort [, reverse]</span>) - Sorts the specific auction list by a specific column, optionally in reverse order. Requires SortAuctionApplySort() afterwards to update. |
||
− | : [[API StartAuction|StartAuction]](<span style="font-size:smaller; color:#ecbc2a">minBid, buyoutPrice, runTime, stackSize, numStacks</span>) - Starts the auction you have created in the Create Auction panel. |
||
− | |||
− | === Hunter Pets === |
||
− | : [[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 GetPetLoyalty|GetPetLoyalty]]() - Returns pet loyalty flavor text. |
||
− | : [[API GetPetTrainingPoints|GetPetTrainingPoints]]() - Gets the training point information about the current pet. |
||
− | |||
− | ==== Stables ==== |
||
− | : [[API C_StableInfo.GetNumActivePets|C_StableInfo.GetNumActivePets]]() |
||
− | : [[API C_StableInfo.GetNumStablePets|C_StableInfo.GetNumStablePets]]() |
||
− | : [[API BuyStableSlot|BuyStableSlot]]() - Buys the next stable slot if the stable window is open and you can afford it. |
||
− | : [[API ClickStablePet|ClickStablePet]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Selects a stable pet. |
||
− | : [[API GetNextStableSlotCost|GetNextStableSlotCost]]() - Returns the next stable slot's cost in copper. |
||
− | : [[API GetNumStablePets|GetNumStablePets]]() - Returns the amount of stable pets. |
||
− | : [[API GetNumStableSlots|GetNumStableSlots]]() - Returns the amount of stable slots. |
||
− | : [[API GetSelectedStablePet|GetSelectedStablePet]]() - Gets the index of the currently selected pet in the stable. |
||
− | : [[API StablePet|StablePet]]() - Puts your current pet in the stable if there is room. |
||
− | : [[API UnstablePet|UnstablePet]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Unstables a pet. |
||
− | |||
− | === Keyring === |
||
− | The [[Keyring]] was added again in [[Patch 1.13.3]] |
||
− | : [[API HasKey|HasKey]]() - Returns whether or not the player has a key ring. |
||
− | : [[API KeyRingButtonIDToInvSlotID|KeyRingButtonIDToInvSlotID]](<span style="font-size:smaller; color:#ecbc2a">buttonID</span>) - Map a keyring button to an inventory slot button for use in inventory functions. |
||
− | |||
− | === Professions === |
||
− | : [[API CloseTradeSkill|CloseTradeSkill]]() |
||
− | : [[API CollapseTradeSkillSubClass|CollapseTradeSkillSubClass]](<span style="font-size:smaller; color:#ecbc2a">index</span>) |
||
− | : [[API DoTradeSkill|DoTradeSkill]](<span style="font-size:smaller; color:#ecbc2a">index [, repeat]</span>) |
||
− | : [[API ExpandTradeSkillSubClass|ExpandTradeSkillSubClass]](<span style="font-size:smaller; color:#ecbc2a">index</span>) |
||
− | : [[API GetFirstTradeSkill|GetFirstTradeSkill]]() |
||
− | : [[API GetNumPrimaryProfessions|GetNumPrimaryProfessions]]() |
||
− | : [[API GetNumTradeSkills|GetNumTradeSkills]]() |
||
− | : [[API GetTradeSkillCooldown|GetTradeSkillCooldown]](<span style="font-size:smaller; color:#ecbc2a">index</span>) |
||
− | : [[API GetTradeSkillIcon|GetTradeSkillIcon]](<span style="font-size:smaller; color:#ecbc2a">index</span>) |
||
− | : [[API GetTradeSkillInfo|GetTradeSkillInfo]](<span style="font-size:smaller; color:#ecbc2a">index</span>) |
||
− | : [[API GetTradeSkillInvSlotFilter|GetTradeSkillInvSlotFilter]](<span style="font-size:smaller; color:#ecbc2a">index</span>) |
||
− | : [[API GetTradeSkillInvSlots|GetTradeSkillInvSlots]]() |
||
− | : [[API GetTradeSkillItemLink|GetTradeSkillItemLink]](<span style="font-size:smaller; color:#ecbc2a">index</span>) |
||
− | : [[API GetTradeSkillItemStats|GetTradeSkillItemStats]]() |
||
− | : [[API GetTradeSkillLine|GetTradeSkillLine]]() |
||
− | : [[API GetTradeSkillNumMade|GetTradeSkillNumMade]](<span style="font-size:smaller; color:#ecbc2a">index</span>) |
||
− | : [[API GetTradeSkillNumReagents|GetTradeSkillNumReagents]](<span style="font-size:smaller; color:#ecbc2a">index</span>) |
||
− | : [[API GetTradeSkillReagentInfo|GetTradeSkillReagentInfo]](<span style="font-size:smaller; color:#ecbc2a">index, reagentIndex</span>) |
||
− | : [[API GetTradeSkillReagentItemLink|GetTradeSkillReagentItemLink]](<span style="font-size:smaller; color:#ecbc2a">index, reagentIndex</span>) |
||
− | : [[API GetTradeSkillSelectionIndex|GetTradeSkillSelectionIndex]]() |
||
− | : [[API GetTradeSkillSubClassFilter|GetTradeSkillSubClassFilter]](<span style="font-size:smaller; color:#ecbc2a">index</span>) |
||
− | : [[API GetTradeSkillSubClasses|GetTradeSkillSubClasses]]() |
||
− | : [[API GetTradeSkillTools|GetTradeSkillTools]](<span style="font-size:smaller; color:#ecbc2a">index</span>) |
||
− | : [[API GetTradeskillRepeatCount|GetTradeskillRepeatCount]]() |
||
− | : [[API SelectTradeSkill|SelectTradeSkill]](<span style="font-size:smaller; color:#ecbc2a">index</span>) |
||
− | : [[API SetTradeSkillInvSlotFilter|SetTradeSkillInvSlotFilter]](<span style="font-size:smaller; color:#ecbc2a">index [, on\off, exclusive]</span>) |
||
− | : [[API SetTradeSkillSubClassFilter|SetTradeSkillSubClassFilter]](<span style="font-size:smaller; color:#ecbc2a">index [, on\off, exclusive]</span>) |
||
− | |||
− | ==== Crafting ==== |
||
− | The Craft UI is used for Enchanting and [[:Beast Training]]. |
||
− | : [[API CloseCraft|CloseCraft]]() |
||
− | : [[API CollapseCraftSkillLine|CollapseCraftSkillLine]](<span style="font-size:smaller; color:#ecbc2a">index</span>) |
||
− | : [[API DoCraft|DoCraft]](<span style="font-size:smaller; color:#ecbc2a">index</span>) |
||
− | : [[API ExpandCraftSkillLine|ExpandCraftSkillLine]](<span style="font-size:smaller; color:#ecbc2a">index</span>) |
||
− | : [[API GetCraftButtonToken|GetCraftButtonToken]]() |
||
− | : [[API GetCraftDescription|GetCraftDescription]](<span style="font-size:smaller; color:#ecbc2a">index</span>) |
||
− | : [[API GetCraftDisplaySkillLine|GetCraftDisplaySkillLine]]() |
||
− | : [[API GetCraftIcon|GetCraftIcon]](<span style="font-size:smaller; color:#ecbc2a">index</span>) |
||
− | : [[API GetCraftInfo|GetCraftInfo]](<span style="font-size:smaller; color:#ecbc2a">index</span>) |
||
− | : [[API GetCraftItemLink|GetCraftItemLink]](<span style="font-size:smaller; color:#ecbc2a">index</span>) |
||
− | : [[API GetCraftName|GetCraftName]]() |
||
− | : [[API GetCraftNumReagents|GetCraftNumReagents]](<span style="font-size:smaller; color:#ecbc2a">index</span>) |
||
− | : [[API GetCraftReagentInfo|GetCraftReagentInfo]](<span style="font-size:smaller; color:#ecbc2a">index, reagentIndex</span>) |
||
− | : [[API GetCraftReagentItemLink|GetCraftReagentItemLink]](<span style="font-size:smaller; color:#ecbc2a">index, reagentIndex</span>) |
||
− | : [[API GetCraftSelectionIndex|GetCraftSelectionIndex]]() |
||
− | : [[API GetCraftSkillLine|GetCraftSkillLine]](<span style="font-size:smaller; color:#ecbc2a">index</span>) |
||
− | : [[API GetCraftSpellFocus|GetCraftSpellFocus]](<span style="font-size:smaller; color:#ecbc2a">index</span>) |
||
− | : [[API GetNumCrafts|GetNumCrafts]]() |
||
− | : [[API SelectCraft|SelectCraft]](<span style="font-size:smaller; color:#ecbc2a">index</span>) |
||
− | |||
− | === PvP === |
||
− | : [[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 GetPVPRankInfo|GetPVPRankInfo]](<span style="font-size:smaller; color:#ecbc2a">rank [, unit]</span>) - Returns information about a specific PvP rank. |
||
− | : [[API GetPVPRankProgress|GetPVPRankProgress]]() - Returns the player's progress to the next PvP rank. |
||
− | : [[API GetPVPThisWeekStats|GetPVPThisWeekStats]]() - Gets your PVP contribution statistics for the current week. |
||
− | : [[API UnitIsCivilian|UnitIsCivilian]](<span style="font-size:smaller; color:#ecbc2a">unit</span>) - Determine whether a unit is a civilian (low level enemy faction NPC that counts as a dishonorable kill). |
||
− | : [[API UnitPVPRank|UnitPVPRank]](<span style="font-size:smaller; color:#ecbc2a">unit</span>) - Returns the specified unit's PvP rank ID. |
||
− | |||
− | ==== Battlegrounds ==== |
||
− | : [[API GetBattlefieldInstanceInfo|GetBattlefieldInstanceInfo]](<span style="font-size:smaller; color:#ecbc2a">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 GetSelectedBattlefield|GetSelectedBattlefield]]() - Returns the currently selected battlefield at the battlemaster. |
||
− | : [[API SetSelectedBattlefield|SetSelectedBattlefield]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Selects a battlefield instance at the battlemaster. |
||
− | |||
− | === Skills === |
||
− | These functions relate to player/trainer [[Skill]]s. |
||
− | : [[API CollapseSkillHeader|CollapseSkillHeader]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Collapses a header in the skills window. |
||
− | : [[API CollapseTrainerSkillLine|CollapseTrainerSkillLine]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Collapses a header in the trainer window, hiding all spells below it. |
||
− | : [[API ExpandSkillHeader|ExpandSkillHeader]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Expands a header in the skills window. |
||
− | : [[API ExpandTrainerSkillLine|ExpandTrainerSkillLine]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Expands a header in the trainer window, showing all spells below it. |
||
− | : [[API GetNumSkillLines|GetNumSkillLines]]() - Returns the number of skill lines in the skill window, including headers. |
||
− | : [[API GetSelectedSkill|GetSelectedSkill]]() - Returns the currently selected skill line. |
||
− | : [[API GetSkillLineInfo|GetSkillLineInfo]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Returns information on a skill line/header. |
||
− | : [[API IsTrainerServiceLearnSpell|IsTrainerServiceLearnSpell]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Returns the type of trainer spell in the trainer window. |
||
− | : [[API SetSelectedSkill|SetSelectedSkill]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Selects a skill line in the skill window. |
||
− | |||
− | === Talents === |
||
− | : [[API GetNumTalents|GetNumTalents]](<span style="font-size:smaller; color:#ecbc2a">tabIndex</span>) - Returns the amount of talents for a specialization. |
||
− | : [[API GetNumTalentTabs|GetNumTalentTabs]]() - Returns the total number of talent tabs for the player. |
||
− | : {{Wow-inline}} [[API_GetTalentInfo/Classic|GetTalentInfo]](<span style="font-size:smaller; color:#ecbc2a">tabIndex, talentIndex</span>) - Returns information about a talent. |
||
− | : [[API GetTalentPrereqs|GetTalentPrereqs]](<span style="font-size:smaller; color:#ecbc2a">tabIndex, talentIndex</span>) - Returns the tier and column of a talent's prerequisite, and if the talent is learnable. |
||
− | : [[API GetTalentTabInfo|GetTalentTabInfo]](<span style="font-size:smaller; color:#ecbc2a">index</span>) - Returns information for a talent tab (tree). |
||
− | : [[API UnitCharacterPoints|UnitCharacterPoints]](<span style="font-size:smaller; color:#ecbc2a">unit</span>) - Returns the number of unspent talent points of the player. |
||
− | === |
+ | ===Cypher Equipment=== |
+ | : [[API C_Garrison.GetCurrentCypherEquipmentLevel|C_Garrison.GetCurrentCypherEquipmentLevel]]() : <span class="apiret">equipmentLevel</span> |
||
− | : [[API CancelTrackingBuff|CancelTrackingBuff]]() - Cancels your current tracking buff (skills like Find Minerals and Track Humanoids). |
||
+ | : [[API C_Garrison.GetCyphersToNextEquipmentLevel|C_Garrison.GetCyphersToNextEquipmentLevel]]() : <span class="apiret">cyphersToNext</span> |
||
− | : [[API GetTrackingTexture|GetTrackingTexture]]() - Returns the texture of the active tracking buff. |
||
+ | : [[API C_Garrison.GetMaxCypherEquipmentLevel|C_Garrison.GetMaxCypherEquipmentLevel]]() : <span class="apiret">maxEquipmentLevel</span> |
||
− | == |
+ | ==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,313: | Line 5,896: | ||
* [[:Category:World of Warcraft API/Protected Functions|Protected Functions]] for functions unusable by addons. |
* [[:Category:World of Warcraft API/Protected Functions|Protected Functions]] for functions unusable by addons. |
||
* [[:Category:World of Warcraft API/Removed Functions|Removed Functions]] for no longer available functions. |
* [[:Category:World of Warcraft API/Removed Functions|Removed Functions]] for no longer available functions. |
||
− | * [[World of Warcraft Non-Public API]] for |
+ | * [[World of Warcraft Non-Public API]] for functions not used in FrameXML. |
− | == |
+ | ===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}} |
||
Line 5,321: | Line 5,904: | ||
[[Category:Macros]] |
[[Category:Macros]] |
||
[[Category:Interface customization]] |
[[Category:Interface customization]] |
||
− | [[Category:API functions| |
+ | [[Category:API functions|World of Warcraft API]] |
[[Category:UI]] |
[[Category:UI]] |
Latest revision as of 15:43, 14 October 2023
- For the Web API, see https://develop.battle.net/documentation/world-of-warcraft
- For the Classic WoW API, see World of Warcraft API/Classic
Main Menu |
---|
|
Automated updating of API pages at this location, to reflect patch changes, has ceased from 10.1.7 onwards. |
The WoW API is available to AddOns and macro scripts. It's officially documented in Blizzard_APIDocumentation which is accessible via the /api command. The Lua user interface code can be exported from the game client.
Patch 10.1.7
- C_CharacterServices.AssignNameChangeDistribution()
- C_CharacterServices.CapitalizeCharName()
- C_Club.DoesAnyCommunityHaveUnreadMessages()
- C_InterfaceFileManifest.GetInterfaceArtFiles() : images
- C_PartyInfo.GetRestrictRaidPings() : restrictToAssistants
- C_PartyInfo.SetRestrictRaidPings(restrictToAssistants)
C_Ping.ClearPendingPingInfo()C_Ping.GetCooldownInfo() : cooldownInfoC_Ping.GetDefaultPingOptions() : pingTypesC_Ping.GetTargetWorldPingAndSend() : resultC_PingSecure.CreateFrame()#protected
C_PingSecure.GetTargetPingReceiver(mousePosX, mousePosY) : frame#protected
C_PingSecure.GetTargetWorldPing(mousePosX, mousePosY) : foundTarget#protected
C_PingSecure.GetTextureKitForType(type) : uiTextureKitID#protected
C_PingSecure.SendPing(type [, target]) : result#protected
- C_TradeSkillUI.CanStoreEnchantInItem(itemGUID) : canStore
- C_Traits.GenerateImportString()
- C_UIWidgetManager.GetTugOfWarWidgetVisualizationInfo(widgetID) : widgetInfo
Patch 10.1.5
- C_ActionBar.EnableActionRangeCheck(actionID, enable)
- C_CharacterServices.RPEResetCharacter()
- C_Commentator.GetPlayerItemCooldownInfo(teamIndex, playerIndex, itemID) : startTime, duration, enable
- C_Commentator.GetPlayerItemCooldownInfoByUnit(unitToken, itemID) : startTime, duration, enable
- C_Commentator.SetBlocklistedItemCooldowns(itemIDs)
- C_Commentator.SetRequestedItemCooldowns(itemIDs)
- C_ContentTracking.GetBestMapForTrackable(trackableType, trackableID [, ignoreWaypoint]) : result, mapID
- C_ContentTracking.GetCollectableSourceTrackingEnabled() : isEnabled
- C_ContentTracking.GetCollectableSourceTypes() : collectableSourceTypes
- C_ContentTracking.GetCurrentTrackingTarget(type, id) : targetType, targetID
- C_ContentTracking.GetEncounterTrackingInfo(journalEncounterID) : trackingInfo
- C_ContentTracking.GetNextWaypointForTrackable(trackableType, trackableID, uiMapID) : result, mapInfo
- C_ContentTracking.GetObjectiveText(targetType, targetID [, includeHyperlinks]) : objectiveText
- C_ContentTracking.GetTitle(trackableType, trackableID) : title
- C_ContentTracking.GetTrackablesOnMap(trackableType, uiMapID) : result, trackableMapInfos
- C_ContentTracking.GetTrackedIDs(trackableType) : entryIDs
- C_ContentTracking.GetVendorTrackingInfo(collectableEntryID) : vendorTrackingInfo
- C_ContentTracking.GetWaypointText(trackableType, trackableID) : waypointText
- C_ContentTracking.IsNavigable(trackableType, trackableID) : result, isNavigable
- C_ContentTracking.IsTrackable(type, id) : isTrackable
- C_ContentTracking.IsTracking(type, id) : isTracking
- C_ContentTracking.StartTracking(type, id) : error
- C_ContentTracking.StopTracking(type, id)
- C_ContentTracking.ToggleTracking(type, id) : error
- C_EncounterJournal.GetEncounterJournalLink(linkType, ID, displayText, difficultyID) : link
- C_EncounterJournal.GetInstanceForGameMap(mapID) : journalInstanceID
- C_Item.GetItemIDForItemInfo(itemInfo) : itemID
- C_Loot.GetLootRollDuration(rollID) : duration
- C_MerchantFrame.GetNumJunkItems() : numJunkItems
- C_PetInfo.GetSpellForPetAction(actionID) : spellID
- C_PvP.IsMatchActive() : isActive
- C_PvP.IsMatchComplete() : isComplete
- C_QuestLine.GetForceVisibleQuests(uiMapID) : questIDs
- C_QuestLog.IsImportantQuest(questID) : isImportant
- C_SpecializationInfo.GetClassIDFromSpecID(specID) : classID
- C_SuperTrack.ClearSuperTrackedContent()
- C_SuperTrack.GetSuperTrackedContent() : trackableType, trackableID
- C_SuperTrack.IsSuperTrackingContent() : isSuperTracking
- C_SuperTrack.SetSuperTrackedContent(trackableType, trackableID)
- UpdateUIParentPosition()
Patch 10.1.0
- C_AddOns.GetAddOnMetadata(name, variable) : value - Returns the TOC metadata of an addon.
- C_ArrowCalloutManager.AcknowledgeCallout()
- C_ArrowCalloutManager.HideCallout()
- C_ArrowCalloutManager.HideWorldLootObjectCallout()
- C_ArrowCalloutManager.SetWorldLootObjectCalloutFromGUID()
- C_ArrowCalloutManager.SwapWorldLootObjectCallout()
- C_AzeriteItem.IsUnlimitedLevelingUnlocked() : isUnlimitedLevelingUnlocked
- C_CharacterServices.AssignRaceOrFactionChangeDistribution()
- C_ChatInfo.GetColorForChatType(chatType) : color
- C_ClassTalents.GetTraitTreeForSpec(specID) : treeID
- C_ClassTalents.InitializeViewLoadout(specID, level)
- C_ClassTalents.ViewLoadout(entries) : success
- C_DateAndTime.AdjustTimeByMonths(date, months) : newDate
- C_Debug.ViewInDebugWindow()
- C_EncounterJournal.OnClose()
- C_EncounterJournal.OnOpen()
- C_EncounterJournal.SetTab(tabIdx)
- C_ExpansionTrial.OnTrialLevelUpDialogClicked()
- C_ExpansionTrial.OnTrialLevelUpDialogShown()
- C_GenericWidgetDisplay.Acknowledge()
- C_GenericWidgetDisplay.Close()
- C_GuildInfo.MemberExistsByName(name) : exists
- C_Item.DoesItemMatchTrackJump(itemLoc) : matchesTrackJump
- C_ItemUpgrade.GetHighWatermarkForItem(itemInfo) : characterHighWatermark, accountHighWatermark
- C_ItemUpgrade.GetHighWatermarkForSlot(itemRedundancySlot) : characterHighWatermark, accountHighWatermark
- C_ItemUpgrade.GetHighWatermarkSlotForItem(itemInfo) : itemRedundancySlot
- C_ItemUpgrade.IsItemBound() : isBound
- C_LootHistory.GetAllEncounterInfos() : infos
- C_LootHistory.GetInfoForEncounter(encounterID) : info
- C_LootHistory.GetLootHistoryTime() : time
- C_LootHistory.GetSortedDropsForEncounter(encounterID) : drops
- C_LootHistory.GetSortedInfoForDrop(encounterID, lootListID) : info
- C_Map.GetMapHighlightPulseInfo(uiMapID) : fileDataID, atlasID, texturePercentageX, texturePercentageY, textureX, textureY, scrollChildX, scrollChildY
- C_PartyPose.ExtraAction(partyPoseID)
- C_PartyPose.GetPartyPoseInfoByID(mapID) : info
- C_PartyPose.HasExtraAction(partyPoseID) : hasExtraAction
- C_QuestInfoSystem.GetQuestRewardSpellInfo([questID], spellID) : info
- C_QuestInfoSystem.GetQuestRewardSpells([questID]) : spellIDs
- C_QuestInfoSystem.GetQuestShouldToastCompletion([questID]) : shouldToast
- C_QuestInfoSystem.HasQuestRewardSpells([questID]) : hasRewardSpells
- C_SpectatingUI.IsSpectating()
- C_Spell.TargetSpellJumpsUpgradeTrack() : jumpsUpgradeTrack
- C_TooltipInfo.GetWorldLootObject(unitTokenString) : data
- C_TradeSkillUI.GetProfessionInfoByRecipeID(recipeID) : info
- C_TradeSkillUI.GetReagentRequirementItemIDs(itemID) : itemIDs
- C_TradeSkillUI.GetRecraftRemovalWarnings(itemGUID, replacedItemIDs) : warnings
- C_TradeSkillUI.IsEnchantTargetValid(recipeID, itemGUID [, craftingReagents]) : valid
- C_TradeSkillUI.IsRecraftReagentValid(itemGUID, itemID) : valid
- C_UIWidgetManager.GetItemDisplayVisualizationInfo(widgetID) : widgetInfo
- C_UnitAuras.AddPrivateAuraAnchor(args) : anchorID
- C_UnitAuras.AddPrivateAuraAppliedSound(sound) : privateAuraSoundID
- C_UnitAuras.AuraIsPrivate(spellID) : isPrivate
- C_UnitAuras.RemovePrivateAuraAnchor(anchorID)
- C_UnitAuras.RemovePrivateAuraAppliedSound(privateAuraSoundID)
- C_UnitAuras.SetPrivateWarningTextAnchor(parent [, anchor])
- GetButtonMetatable()
- GetEditBoxMetatable()
- GetFontStringMetatable()
- GetFrameMetatable()
- GetSoundEntryCount()
- IsWorldLootObject()
- StripHyperlinks(text [, maintainColor, maintainBrackets, stripNewlines, maintainAtlases]) : stripped
- pcallwithenv()
Patch 10.0.x
- C_AccountServices.IsAccountLockedPostSave()
- C_AccountServices.IsAccountSaveEnabled()
- C_AccountServices.IsAccountSaveInProgress()
- C_AccountServices.SaveAccountData()
- C_AchievementInfo.IsGuildAchievement(achievementId) : isGuild
- C_ActionBar.GetItemActionOnEquipSpellID(actionID) : onEquipSpellID
- C_ActionBar.GetProfessionQuality(actionID) : quality
- C_ArtifactUI.IsArtifactItem(itemLocation) : isArtifact
- C_BarberShop.GetCustomizationScope() : customizationScope
- C_BarberShop.GetViewingChrModel() : chrModelID
- C_BarberShop.SetViewingChrModel([chrModelID])
- C_CameraDefaults.GetCameraFOVDefaults() : fieldOfViewDegreesDefault, fieldOfViewDegreesPlayerMin, fieldOfViewDegreesPlayerMax
- C_CampaignInfo.SortAsNormalQuest(campaignID) : sortAsNormalQuest
- C_ChatInfo.CanPlayerSpeakLanguage(languageId) : canSpeakLanguage
- C_ChatInfo.GetChatLineSenderGUID(chatLine) : guid
- C_ChatInfo.GetChatLineSenderName(chatLine) : name
- C_ChatInfo.GetChatLineText(chatLine) : text
- C_ChatInfo.IsChatLineCensored(chatLine) : isCensored
- C_ChatInfo.RequestCanLocalWhisperTarget(whisperTarget)
- C_ChatInfo.UncensorChatLine(chatLine)
- C_ConsoleScriptCollection.GetCollectionDataByID(collectionID) : data
- C_ConsoleScriptCollection.GetCollectionDataByTag(collectionTag) : data
- C_ConsoleScriptCollection.GetElements(collectionID) : elementIDs
- C_ConsoleScriptCollection.GetScriptData(consoleScriptID) : data
- C_CraftingOrders.GetNumFavoriteCustomerOptions() : numFavorites
- C_CraftingOrders.GetPersonalOrdersInfo() : infos
- C_EventUtils.IsEventValid(eventName) : valid
- C_EventUtils.NotifySettingsLoaded()
- C_FunctionContainers.CreateCallback()
- C_GossipInfo.GetFriendshipReputationRanks(friendshipFactionID) : rankInfo
- C_GossipInfo.GetFriendshipReputation(friendshipFactionID) : reputationInfo
- C_GossipInfo.SelectOptionByIndex(optionID [, text, confirmed])
- C_Item.GetItemIDByGUID(itemGUID) : itemID
- C_Item.GetItemLinkByGUID(itemGUID) : itemLink
- C_Item.GetItemLocation(itemGUID) : itemLocation
- C_Item.GetItemMaxStackSizeByID(itemInfo) : stackSize
- C_Item.GetItemMaxStackSize(itemLocation) : stackSize
- C_Item.IsItemGUIDInInventory(itemGUID) : valid
- C_KeyBindings.GetBindingIndex(action) : bindingIndex
- C_Mail.GetCraftingOrderMailInfo(inboxIndex) : info
- C_Mail.SetOpeningAll(openingAll)
- C_MajorFactions.GetCovenantIDForMajorFaction(majorFactionID) : covenantID
- C_MajorFactions.GetCurrentRenownLevel(majorFactionID) : level
- C_MajorFactions.GetFeatureAbilities() : featureAbilities
- C_MajorFactions.GetMajorFactionData(majorFactionID) : data
- C_MajorFactions.GetMajorFactionIDs([expansionID]) : majorFactionIDs
- C_MajorFactions.GetRenownLevels(majorFactionID) : levels
- C_MajorFactions.GetRenownNPCFactionID() : renownNPCFactionID
- C_MajorFactions.GetRenownRewardsForLevel(majorFactionID, renownLevel) : rewards
- C_MajorFactions.HasMaximumRenown(majorFactionID) : hasMaxRenown
- C_MajorFactions.IsPlayerInRenownCatchUpMode() : isInCatchUpMode
- C_MajorFactions.IsWeeklyRenownCapped(majorFactionID) : isWeeklyCapped
- C_MajorFactions.RequestCatchUpState()
- C_Minimap.CanTrackBattlePets() : CanTrackBattlePets
- C_Minimap.ClearAllTracking()
- C_Minimap.GetNumQuestPOIWorldEffects() : worldEffectCount
- C_Minimap.GetNumTrackingTypes() : numTrackingTypes
- C_Minimap.GetObjectIconTextureCoords([index]) : textureCoordsX, textureCoordsY, textureCoordsZ, textureCoordsW
- C_Minimap.GetPOITextureCoords([index]) : textureCoordsX, textureCoordsY, textureCoordsZ, textureCoordsW
- C_Minimap.GetTrackingFilter(spellIndex) : trackingType
- C_Minimap.GetTrackingInfo(spellIndex) : name, textureFileID, active, type, subType, spellID
- C_Minimap.IsFilteredOut(filterType) : isFiltered
- C_Minimap.IsTrackingBattlePets() : isTrackingBattlePets
- C_Minimap.IsTrackingHiddenQuests() : isTrackingHiddenQuests
- C_Minimap.SetTracking(index, on)
- C_MountJournal.GetAllCreatureDisplayIDsForMountID(mountID) : creatureDisplayIDs
- C_MountJournal.GetCollectedDragonridingMounts() : mountIDs
- C_MountJournal.GetDisplayedMountID(displayIndex) : mountID
- C_MountJournal.GetMountLink(spellID) : mountCreatureDisplayInfoLink
- C_MythicPlus.GetCurrentUIDisplaySeason() : seasonID
- C_MythicPlus.GetEndOfRunGearSequenceLevel(keystoneLevel) : sequenceLevel
- C_PaperDollInfo.CanAutoEquipCursorItem() : canAutoEquip
- C_PaperDollInfo.CanCursorCanGoInSlot(slotIndex) : canOccupySlot
- C_PaperDollInfo.GetInspectRatedSoloShuffleData() : ratedSoloShuffleData
- C_PetJournal.GetNumPetsInJournal(creatureID) : maxAllowed, numPets
- C_PetJournal.HasFavoritePets() : hasFavorites
- C_PetJournal.SpellTargetBattlePet(battlePetGUID)
- C_PlayerInfo.CanUseItem(itemID) : isUseable
- C_PlayerInfo.GetDisplayID() : displayID
- C_PlayerInfo.GetGlidingInfo() : isGliding, canGlide, forwardSpeed - Returns the Dragonriding gliding speed.
- C_PlayerInfo.GetPlayerCharacterData() : characterData
- C_PlayerInfo.HasVisibleInvSlot(slot) : isVisible
- C_PlayerInfo.IsExpansionLandingPageUnlockedForPlayer(expansionID) : isUnlocked
- C_PlayerInfo.IsTradingPostAvailable() : isAvailable
- C_PlayerInfo.IsTravelersLogAvailable() : isAvailable
- C_ProfSpecs.GetNewSpecReminderProfName() : profName
- C_PvP.ArePvpTalentsUnlocked() : arePvpTalentsUnlocked
- C_PvP.GetAssignedSpecForBattlefieldQueue(queueID) : specializationID
- C_PvP.GetPVPActiveRatedMatchDeserterPenalty() : deserterPenalty
- C_PvP.GetPersonalRatedSoloShuffleSpecStats() : specStats
- C_PvP.GetPvpTalentsUnlockedLevel() : unlockLevel
- C_PvP.GetRatedSoloShuffleMinItemLevel() : minItemLevel
- C_PvP.GetRatedSoloShuffleRewards() : honor, experience, itemRewards, currencyRewards, roleShortageBonus
- C_PvP.GetUIDisplaySeason() : uiDisplaySeason
- C_PvP.IsBrawlSoloShuffle() : isBrawlSoloShuffle
- C_PvP.IsInRatedMatchWithDeserterPenalty() : isInRatedMatchWithDeserterPenalty
- C_PvP.IsRatedSoloShuffle() : isRatedSoloShuffle
- C_QuestItemUse.CanUseQuestItemOnObject(item, unit [, checkRange]) : canUse
- C_QuestLog.DoesQuestAwardReputationWithFaction(questID, factionID) : awardsReputation
- C_QuestLog.GetQuestLogMajorFactionReputationRewards(questID) : reputationRewards
- C_QuestLog.UnitIsRelatedToActiveQuest(unit) : isRelatedToActiveQuest
- C_QuestOffer.GetHideRequiredItems() : hideRequiredItems
- C_QuestOffer.GetQuestOfferMajorFactionReputationRewards() : reputationRewards
- C_Reputation.IsMajorFaction(factionID) : isMajorFaction
- C_Reputation.SetWatchedFaction(factionID)
- C_ReturningPlayerUI.AcceptPrompt()
- C_ReturningPlayerUI.DeclinePrompt()
- C_Sound.GetSoundScaledVolume(soundHandle) : scaledVolume
- C_Sound.IsPlaying(soundHandle) : isPlaying
- C_Sound.PlayItemSound(soundType, itemLocation)
- C_SpecializationInfo.GetPvpTalentInfo(talentID) : talentInfo
- C_SpellBook.GetDeadlyDebuffInfo(spellID) : deadlyDebuffInfo
- C_SpellBook.GetOverrideSpell(spellID [, spec, onlyKnown, ignoreOverrideSpellID]) : overrideSpellID
- C_SpellBook.GetTrackedNameplateCooldownSpells() : spellIDs
- C_SystemVisibilityManager.IsSystemVisible(system) : visible
- C_Texture.ClearTitleIconTexture(texture)
- C_Texture.GetCraftingReagentQualityChatIcon(quality) : textureMarkup
- C_Texture.GetFilenameFromFileDataID(fileDataID) : filename
- C_Texture.GetTitleIconTexture(titleID, version, callback)
- C_Texture.IsTitleIconTextureReady(titleID, version) : ready
- C_Texture.SetTitleIconTexture(texture, titleID, version)
- C_TooltipComparison.GetItemComparisonDelta(comparisonItem, equippedItem [, pairedItem, addPairedStats]) : lines
- C_TooltipComparison.GetItemComparisonInfo(comparisonItem) : info
- C_TradeSkillUI.GetRemainingRecasts() : remaining
- C_TradeSkillUI.IsRecipeFirstCraft(recipeID) : result
- C_TradeSkillUI.IsRecraftItemEquipped(recraftItemGUID) : isEquipped
- C_TradeSkillUI.RecraftLimitCategoryValid(reagentItemID) : recraftValid
- C_UIColor.GetColors() : colors
- C_UIWidgetManager.GetFillUpFramesWidgetVisualizationInfo(widgetID) : widgetInfo
- C_UIWidgetManager.GetTextWithSubtextWidgetVisualizationInfo(widgetID) : widgetInfo
- C_UnitAuras.GetAuraDataByAuraInstanceID(unitToken, auraInstanceID) : aura
- C_UnitAuras.GetAuraDataBySlot(unitToken, slot) : aura
- C_UnitAuras.GetCooldownAuraBySpellID(spellID) : cooldownSpellID
- C_UnitAuras.GetPlayerAuraBySpellID(spellID) : aura
- C_UnitAuras.IsAuraFilteredOutByInstanceID(unitToken, auraInstanceID, filterFlags) : isFiltered
- C_UnitAuras.WantsAlteredForm(unitToken) : wantsAlteredForm
- C_VideoOptions.GetCurrentGameWindowSize() : size
- C_VideoOptions.GetDefaultGameWindowSize(monitor) : size
- C_VideoOptions.GetGameWindowSizes(monitor, fullscreen) : sizes
- C_VideoOptions.SetGameWindowSize(x, y)
- C_VoiceChat.IsVoiceChatConnected() : connected
- C_WeeklyRewards.GetWeeklyRewardTextureKit() : uiTextureKit
- C_WeeklyRewards.IsWeeklyChestRetired() : isRetired
- C_WeeklyRewards.ShouldShowFinalRetirementMessage() : showRetirementMessage
- C_WeeklyRewards.ShouldShowRetirementMessage() : showRetirementMessage
- C_XMLUtil.GetTemplateInfo(name) : info
- C_XMLUtil.GetTemplates() : templates
- CombatLogShowCurrentEntry()
- GetCurrentGraphicsAPI()
- GetGraphicsCVarValueForQualityLevel()
- GetUnitEmpowerHoldAtMaxTime(unit) : holdAtMaxTime
- GetUnitEmpowerMinHoldTime(unit) : minHoldTime
- GetUnitEmpowerStageDuration(unit, index) : duration
- IsAdvancedFlyableArea()
- IsGraphicsCVarValueSupported()
- IsGraphicsSettingValueSupported()
- IsPlayerInGuildFromGUID(playerGUID) : IsInGuild
- IsPressHoldReleaseSpell()
- IsSpecializationActivateSpell()
- IsTargetLoose()
- IsUsingGamepad()
- IsUsingMouse()
- JoinRatedSoloShuffle()
- ReleaseAction()
- ReplaceTradeskillEnchant()
- SetUnitCursorTexture(textureObject, unit [, style, includeLowPriority]) : hasCursor
- TargetToggle()
- UnitIsBossMob()
- UnitIsGameObject()
- UnitIsInteractable()
- UnitPartialPower(unitToken [, powerType, unmodified]) : partialPower
- UnitPercentHealthFromGUID(unitGUID) : percentHealth
- UnitTokenFromGUID(unitGUID) : unitToken
- WorldLootObjectExists()
Class Talents
- C_ClassTalents.CanChangeTalents() : canChange, canAdd, changeError
- C_ClassTalents.CanCreateNewConfig() : canCreate
- C_ClassTalents.CanEditTalents() : canEdit, changeError
- C_ClassTalents.CommitConfig([savedConfigID]) : success
- C_ClassTalents.DeleteConfig(configID) : success
- C_ClassTalents.GetActiveConfigID() : activeConfigID
- C_ClassTalents.GetConfigIDsBySpecID([specID]) : configIDs
- C_ClassTalents.GetHasStarterBuild() : hasStarterBuild
- C_ClassTalents.GetLastSelectedSavedConfigID(specID) : configID
- C_ClassTalents.GetNextStarterBuildPurchase() : nodeID, entryID
- C_ClassTalents.GetStarterBuildActive() : isActive
- C_ClassTalents.HasUnspentTalentPoints() : hasUnspentPoints, numClassPoints, numSpecPoints
- C_ClassTalents.ImportLoadout(configID, entries, name) : success, importError
- C_ClassTalents.IsConfigPopulated(configID) : isPopulated
- C_ClassTalents.LoadConfig(configID, autoApply) : result, changeError, newLearnedNodeIDs
- C_ClassTalents.RenameConfig(configID, name) : success
- C_ClassTalents.RequestNewConfig(name) : success
- C_ClassTalents.SaveConfig(configID) : success
- C_ClassTalents.SetStarterBuildActive(active) : result
- C_ClassTalents.SetUsesSharedActionBars(configID, usesShared)
- C_ClassTalents.UpdateLastSelectedSavedConfigID(specID [, configID])
Container
- C_Container.ContainerIDToInventoryID(containerID) : inventoryID
- C_Container.ContainerRefundItemPurchase(containerIndex, slotIndex [, isEquipped])
- C_Container.GetBackpackAutosortDisabled() : isDisabled
- C_Container.GetBagName(bagIndex) : name
- C_Container.GetBagSlotFlag(bagIndex, flag) : isSet
- C_Container.GetBankAutosortDisabled() : isDisabled
- C_Container.GetContainerFreeSlots(containerIndex) : freeSlots
- C_Container.GetContainerItemCooldown(containerIndex, slotIndex) : startTime, duration, enable
- C_Container.GetContainerItemDurability(containerIndex, slotIndex) : durability, maxDurability
- C_Container.GetContainerItemEquipmentSetInfo(containerIndex, slotIndex) : inSet, setList
- C_Container.GetContainerItemID(containerIndex, slotIndex) : containerID
- C_Container.GetContainerItemInfo(containerIndex, slotIndex) : containerInfo
- C_Container.GetContainerItemLink(containerIndex, slotIndex) : itemLink
- C_Container.GetContainerItemPurchaseCurrency(containerIndex, slotIndex, itemIndex, isEquipped) : currencyInfo
- C_Container.GetContainerItemPurchaseInfo(containerIndex, slotIndex, isEquipped) : info
- C_Container.GetContainerItemPurchaseItem(containerIndex, slotIndex, itemIndex, isEquipped) : itemInfo
- C_Container.GetContainerItemQuestInfo(containerIndex, slotIndex) : questInfo
- C_Container.GetContainerNumFreeSlots(bagIndex) : numFreeSlots, bagFamily
- C_Container.GetContainerNumSlots(containerIndex) : numSlots
- C_Container.GetInsertItemsLeftToRight() : isEnabled
- C_Container.GetItemCooldown(itemID) : startTime, duration, enable
- C_Container.GetMaxArenaCurrency() : maxCurrency
- C_Container.GetSortBagsRightToLeft() : isEnabled
- C_Container.IsBattlePayItem(containerIndex, slotIndex) : isBattlePayItem
- C_Container.IsContainerFiltered(containerIndex) : isFiltered
- C_Container.PickupContainerItem(containerIndex, slotIndex)
- C_Container.PlayerHasHearthstone() : itemID
- C_Container.SetBackpackAutosortDisabled(disable)
- C_Container.SetBagPortraitTexture(texture, bagIndex)
- C_Container.SetBagSlotFlag(bagIndex, flag, isSet)
- C_Container.SetBankAutosortDisabled(disable)
- C_Container.SetInsertItemsLeftToRight(enable)
- C_Container.SetItemSearch(searchString)
- C_Container.SetSortBagsRightToLeft(enable)
- C_Container.ShowContainerSellCursor(containerIndex, slotIndex)
- C_Container.SocketContainerItem(containerIndex, slotIndex) : success
- C_Container.SortBags()
- C_Container.SortBankBags()
- C_Container.SortReagentBankBags()
- C_Container.SplitContainerItem(containerIndex, slotIndex, amount)
- C_Container.UseContainerItem(containerIndex, slotIndex, [unitToken], [reagentBankOpen])
- C_Container.UseHearthstone() : used
Crafting Orders
- C_CraftingOrders.AreOrderNotesDisabled() : areNotesDisabled
- C_CraftingOrders.CalculateCraftingOrderPostingFee(skillLineAbilityID, orderType, orderDuration) : deposit
- C_CraftingOrders.CanOrderSkillAbility(skillLineAbilityID) : canOrder
- C_CraftingOrders.CancelOrder(orderID)
- C_CraftingOrders.ClaimOrder(orderID, profession)
- C_CraftingOrders.CloseCrafterCraftingOrders()
- C_CraftingOrders.CloseCustomerCraftingOrders()
- C_CraftingOrders.FulfillOrder(orderID, crafterNote, profession)
- C_CraftingOrders.GetClaimedOrder() : order
- C_CraftingOrders.GetCrafterBuckets() : buckets
- C_CraftingOrders.GetCrafterOrders() : orders
- C_CraftingOrders.GetCraftingOrderTime() : time
- C_CraftingOrders.GetCustomerCategories() : categories
- C_CraftingOrders.GetCustomerOptions(params) : results
- C_CraftingOrders.GetCustomerOrders() : customerOrders
- C_CraftingOrders.GetDefaultOrdersSkillLine() : skillLineID
- C_CraftingOrders.GetMyOrders() : myOrders
- C_CraftingOrders.GetOrderClaimInfo(profession) : claimInfo
- C_CraftingOrders.HasFavoriteCustomerOptions() : hasFavorites
- C_CraftingOrders.IsCustomerOptionFavorited(recipeID) : favorited
- C_CraftingOrders.ListMyOrders(request)
- C_CraftingOrders.OpenCrafterCraftingOrders()
- C_CraftingOrders.OpenCustomerCraftingOrders()
- C_CraftingOrders.OrderCanBeRecrafted(orderID) : recraftable
- C_CraftingOrders.ParseCustomerOptions()
- C_CraftingOrders.PlaceNewOrder(orderInfo)
- C_CraftingOrders.RejectOrder(orderID, crafterNote, profession)
- C_CraftingOrders.ReleaseOrder(orderID, profession)
- C_CraftingOrders.RequestCrafterOrders(request)
#noscript
- C_CraftingOrders.RequestCustomerOrders(request)
- C_CraftingOrders.SetCustomerOptionFavorited(recipeID, favorited)
- C_CraftingOrders.ShouldShowCraftingOrderTab() : showTab
- C_CraftingOrders.SkillLineHasOrders(skillLineID) : hasOrders
- C_CraftingOrders.UpdateIgnoreList()
- C_CurrencyInfo.GetCurrencyDescription(type) : description
- C_Debug.PrintToDebugWindow()
Edit Mode
- C_EditMode.ConvertLayoutInfoToString(layoutInfo) : layoutInfoAsString
- C_EditMode.ConvertStringToLayoutInfo(layoutInfoAsString) : layoutInfo
- C_EditMode.GetAccountSettings() : accountSettings
- C_EditMode.GetLayouts() : layoutInfo
- C_EditMode.OnEditModeExit()
- C_EditMode.OnLayoutAdded(addedLayoutIndex, activateNewLayout, isLayoutImported)
- C_EditMode.OnLayoutDeleted(deletedLayoutIndex)
- C_EditMode.SaveLayouts(saveInfo)
- C_EditMode.SetAccountSetting(setting, value)
- C_EditMode.SetActiveLayout(activeLayout)
Player Interaction
- C_PlayerInteractionManager.ClearInteraction([type])
- C_PlayerInteractionManager.ConfirmationInteraction([type])
- C_PlayerInteractionManager.InteractUnit(unit [, exactMatch, looseTargeting]) : success
- C_PlayerInteractionManager.IsInteractingWithNpcOfType(type) : interacting
- C_PlayerInteractionManager.IsReplacingUnit() : replacing
- C_PlayerInteractionManager.IsValidNPCInteraction(type) : isValidInteraction
- C_PlayerInteractionManager.ReopenInteraction()
Tooltips
- C_TooltipInfo.GetAchievementByID(achievementID) : data
- C_TooltipInfo.GetAction(actionID) : data
- C_TooltipInfo.GetArtifactItem() : data
- C_TooltipInfo.GetArtifactPowerByID(powerID) : data
- C_TooltipInfo.GetAzeriteEssence(essenceID [, rank]) : data
- C_TooltipInfo.GetAzeriteEssenceSlot(slot) : data
- C_TooltipInfo.GetAzeritePower(itemID, itemLevel, powerID [, owningItemLink]) : data
- C_TooltipInfo.GetBackpackToken(index) : data
- C_TooltipInfo.GetBagItem(bagIndex, slotIndex) : data
- C_TooltipInfo.GetBagItemChild(bagIndex, slotIndex, equipSlotIndex) : data
- C_TooltipInfo.GetBuybackItem(index) : data
- C_TooltipInfo.GetCompanionPet(petGUID) : data
- C_TooltipInfo.GetConduit(conduitID, conduitRank) : data
- C_TooltipInfo.GetCurrencyByID(currencyID [, amount]) : data
- C_TooltipInfo.GetCurrencyToken(tokenIndex) : data
- C_TooltipInfo.GetEnhancedConduit(conduitID, rank) : data
- C_TooltipInfo.GetEquipmentSet(setID) : data
- C_TooltipInfo.GetExistingSocketGem(index [, toDestroy]) : data
- C_TooltipInfo.GetGuildBankItem(tab, slot) : data
- C_TooltipInfo.GetHeirloomByItemID(itemID) : data
- C_TooltipInfo.GetHyperlink(hyperlink [, optionalArg1, optionalArg2, hideVendorPrice]) : data
- C_TooltipInfo.GetInboxItem(messageIndex [, attachmentIndex]) : data
- C_TooltipInfo.GetInstanceLockEncountersComplete(index) : data
- C_TooltipInfo.GetInventoryItem(unit, slot [, hideUselessStats]) : data
- C_TooltipInfo.GetInventoryItemByID(itemID) : data
- C_TooltipInfo.GetItemByGUID(guid) : data
- C_TooltipInfo.GetItemByID(itemID [, quality]) : data
- C_TooltipInfo.GetItemInteractionItem() : data
- C_TooltipInfo.GetItemKey(itemID, itemLevel, itemSuffix [, requiredLevel]) : data
- C_TooltipInfo.GetLFGDungeonReward(dungeonID, lootIndex) : data
- C_TooltipInfo.GetLFGDungeonShortageReward(dungeonID, shortageSeverity, lootIndex) : data
- C_TooltipInfo.GetLootCurrency(slot) : data
- C_TooltipInfo.GetLootItem(slot) : data
- C_TooltipInfo.GetLootRollItem(id) : data
- C_TooltipInfo.GetMerchantCostItem(slot, costIndex) : data
- C_TooltipInfo.GetMerchantItem(slot) : data
- C_TooltipInfo.GetMinimapMouseover() : data
- C_TooltipInfo.GetMountBySpellID(spellID [, checkIndoors]) : data
- C_TooltipInfo.GetOwnedItemByID(itemID) : data
- C_TooltipInfo.GetPetAction(slot) : data
- C_TooltipInfo.GetPossession(slot) : data
- C_TooltipInfo.GetPvpBrawl([isSpecial]) : data
- C_TooltipInfo.GetPvpTalent(talentID [, isInspect, groupIndex, talentIndex]) : data
- C_TooltipInfo.GetQuestCurrency(type, currencyIndex) : data
- C_TooltipInfo.GetQuestItem(type, itemIndex [, allowCollectionText]) : data
- C_TooltipInfo.GetQuestLogCurrency(type, currencyIndex [, questID]) : data
- C_TooltipInfo.GetQuestLogItem(type, itemIndex [, questID, allowCollectionText]) : data
- C_TooltipInfo.GetQuestLogSpecialItem(questIndex) : data
- C_TooltipInfo.GetQuestPartyProgress(questID [, omitTitle, ignoreActivePlayer]) : data
- C_TooltipInfo.GetRecipeRankInfo(recipeID, rank) : data
- C_TooltipInfo.GetRecipeReagentItem(recipeSpellID, dataSlotIndex) : data
- C_TooltipInfo.GetRecipeResultItem(recipeID [, craftingReagents, recraftItemGUID, recipeLevel, overrideQualityID]) : data
- C_TooltipInfo.GetRecipeResultItemForOrder(recipeID [, craftingReagents, orderID, recipeLevel, overrideQualityID]) : data
- C_TooltipInfo.GetRuneforgeResultItem(itemGUID, itemLevel [, powerID, modifiers]) : data
- C_TooltipInfo.GetSendMailItem([attachmentIndex]) : data
- C_TooltipInfo.GetShapeshift(slot) : data
- C_TooltipInfo.GetSlottedKeystone() : data
- C_TooltipInfo.GetSocketGem(index) : data
- C_TooltipInfo.GetSocketedItem() : data
- C_TooltipInfo.GetSocketedRelic(slotIndex) : data
- C_TooltipInfo.GetSpellBookItem(slot, spellBookType) : data
- C_TooltipInfo.GetSpellByID(spellID [, isPet, showSubtext, dontOverride, difficultyID, isLink]) : data
- C_TooltipInfo.GetTalent(talentID [, isInspect, groupIndex]) : data
- C_TooltipInfo.GetTotem(slot) : data
- C_TooltipInfo.GetToyByItemID(itemID) : data
- C_TooltipInfo.GetTradePlayerItem(slot) : data
- C_TooltipInfo.GetTradeTargetItem(slot) : data
- C_TooltipInfo.GetTrainerService(serviceIndex) : data
- C_TooltipInfo.GetTraitEntry(entryID [, rank]) : data
- C_TooltipInfo.GetTransmogrifyItem(transmogLocation) : data
- C_TooltipInfo.GetUnit(unit [, hideStatus]) : data
- C_TooltipInfo.GetUnitAura(unitToken, index [, filter]) : data
- C_TooltipInfo.GetUnitBuff(unitToken, index [, filter]) : data
- C_TooltipInfo.GetUnitBuffByAuraInstanceID(unitTokenString, auraInstanceID [, filter]) : data
- C_TooltipInfo.GetUnitDebuff(unitToken, index [, filter]) : data
- C_TooltipInfo.GetUnitDebuffByAuraInstanceID(unitTokenString, auraInstanceID [, filter]) : data
- C_TooltipInfo.GetUpgradeItem() : data
- C_TooltipInfo.GetVoidDepositItem(slot) : data
- C_TooltipInfo.GetVoidItem(tab, slot) : data
- C_TooltipInfo.GetVoidWithdrawalItem(slot) : data
- C_TooltipInfo.GetWeeklyReward(itemDBID) : data
- C_TooltipInfo.GetWorldCursor() : data
Tradeskill UI
- C_TradeSkillUI.CraftEnchant(recipeSpellID [, numCasts, craftingReagents, itemTarget])
- C_TradeSkillUI.CraftSalvage(recipeSpellID [, numCasts, itemTarget])
- C_TradeSkillUI.DoesRecraftingRecipeAcceptItem(itemLocation, recipeID) : result
- C_TradeSkillUI.GetAllFilterableInventorySlotsCount()
- C_TradeSkillUI.GetBaseProfessionInfo() : info
- C_TradeSkillUI.GetChildProfessionInfo() : info
- C_TradeSkillUI.GetChildProfessionInfos() : infos
- C_TradeSkillUI.GetCraftableCount(recipeSpellID [, recipeLevel]) : numAvailable
- C_TradeSkillUI.GetCraftingOperationInfo(recipeID, craftingReagents [, allocationItemGUID]) : info
- C_TradeSkillUI.GetCraftingOperationInfoForOrder(recipeID, craftingReagents, orderID) : info
- C_TradeSkillUI.GetCraftingReagentBonusText(recipeSpellID, craftingReagentIndex, craftingReagents [, allocationItemGUID]) : bonusText
- C_TradeSkillUI.GetCraftingTargetItems(itemIDs) : items
- C_TradeSkillUI.GetEnchantItems(recipeID) : items
- C_TradeSkillUI.GetFactionSpecificOutputItem(recipeSpellID) : itemID
- C_TradeSkillUI.GetFilterableInventorySlotName()
- C_TradeSkillUI.GetGatheringOperationInfo(recipeID) : info
- C_TradeSkillUI.GetHideUnownedFlags(recipeID) : cannotModifyHideUnowned, alwaysShowUnowned
- C_TradeSkillUI.GetItemCraftedQualityByItemInfo(itemInfo) : quality
- C_TradeSkillUI.GetItemReagentQualityByItemInfo(itemInfo) : quality
- C_TradeSkillUI.GetItemSlotModifications(itemGUID) : slotMods
- C_TradeSkillUI.GetItemSlotModificationsForOrder(orderID) : slotMods
- C_TradeSkillUI.GetOnlyShowFirstCraftRecipes()
- C_TradeSkillUI.GetOriginalCraftRecipeID(itemGUID) : recipeID, skillLineAbilityID
- C_TradeSkillUI.GetProfessionByInventorySlot(slot) : profession
- C_TradeSkillUI.GetProfessionChildSkillLineID() : skillLineID
- C_TradeSkillUI.GetProfessionForCursorItem() : profession
- C_TradeSkillUI.GetProfessionInfoBySkillLineID(skillLineID) : info
- C_TradeSkillUI.GetProfessionInventorySlots() : invSlots
- C_TradeSkillUI.GetProfessionNameForSkillLineAbility(skillLineAbilityID) : professionNmae
- C_TradeSkillUI.GetProfessionSkillLineID(profession) : skillLineID
- C_TradeSkillUI.GetProfessionSlots(profession) : slots
- C_TradeSkillUI.GetProfessionSpells(professionID [, skillLineID]) : knownSpells
- C_TradeSkillUI.GetQualitiesForRecipe(recipeID) : qualityIDs
- C_TradeSkillUI.GetReagentDifficultyText(craftingReagentIndex, craftingReagents) : bonusText
- C_TradeSkillUI.GetReagentSlotStatus(mcrSlotID, recipeSpellID, skillLineAbilityID) : locked, lockedReason
- C_TradeSkillUI.GetRecipeFixedReagentItemLink(recipeID, dataSlotIndex) : link
- C_TradeSkillUI.GetRecipeInfoForSkillLineAbility(skillLineAbilityID [, recipeLevel]) : recipeInfo
- C_TradeSkillUI.GetRecipeOutputItemData(recipeSpellID [, reagents, allocationItemGUID, overrideQualityID, recraftOrderID]) : outputInfo
- C_TradeSkillUI.GetRecipeQualityItemIDs(recipeSpellID) : qualityItemIDs
- C_TradeSkillUI.GetRecipeQualityReagentItemLink(recipeID, dataSlotIndex, qualityIndex) : link
- C_TradeSkillUI.GetRecipeRequirements(recipeID) : requirements
- C_TradeSkillUI.GetRecipeSchematic(recipeSpellID, isRecraft [, recipeLevel]) : schematic
- C_TradeSkillUI.GetRecipesTracked(isRecraft) : recipeIDs
- C_TradeSkillUI.GetRecraftItems([recipeID]) : items
- C_TradeSkillUI.GetSalvagableItemIDs(recipeID) : itemIDs
- C_TradeSkillUI.GetShowLearned() : flag
- C_TradeSkillUI.GetShowUnlearned() : flag
- C_TradeSkillUI.GetSkillLineForGear(itemInfo) : skillLineID
- C_TradeSkillUI.GetSourceTypeFilter() : sourceTypeFilter
- C_TradeSkillUI.HasFavoriteOrderRecipes() : hasFavorites
- C_TradeSkillUI.IsNearProfessionSpellFocus(profession) : nearFocus
- C_TradeSkillUI.IsOriginalCraftRecipeLearned(itemGUID) : learned
- C_TradeSkillUI.IsRecipeInBaseSkillLine(recipeID) : result
- C_TradeSkillUI.IsRecipeInSkillLine(recipeID, skillLineID) : result
- C_TradeSkillUI.IsRecipeProfessionLearned(recipeID) : recipeProfessionLearned
- C_TradeSkillUI.IsRecipeTracked(recipeID, isRecraft) : tracked
- C_TradeSkillUI.IsRuneforging() : result
- C_TradeSkillUI.OpenRecipe(recipeID)
- C_TradeSkillUI.RecraftRecipe(itemGUID [, craftingReagents, removedModifications]) : result
- C_TradeSkillUI.RecraftRecipeForOrder(orderID, itemGUID [, craftingReagents, removedModifications]) : result
- C_TradeSkillUI.SetOnlyShowAvailableForOrders(flag)
- C_TradeSkillUI.SetOnlyShowFirstCraftRecipes()
- C_TradeSkillUI.SetProfessionChildSkillLineID(skillLineID)
- C_TradeSkillUI.SetRecipeTracked(recipeID, tracked, isRecraft)
- C_TradeSkillUI.SetShowLearned(flag)
- C_TradeSkillUI.SetShowUnlearned(flag)
- C_TradeSkillUI.SetSourceTypeFilter(sourceTypeFilter)
Trading Post
The Trading Post was added in Patch 10.0.5
- C_PerksActivities.AddTrackedPerksActivity(perksActivityID)
- C_PerksActivities.ClearPerksActivitiesPendingCompletion()
- C_PerksActivities.GetAllPerksActivityTags() : tags
- C_PerksActivities.GetPerksActivitiesInfo() : info
- C_PerksActivities.GetPerksActivitiesPendingCompletion() : pending
- C_PerksActivities.GetPerksActivityChatLink(perksActivityID) : link
- C_PerksActivities.GetPerksActivityInfo(perksActivityID) : info
- C_PerksActivities.GetTrackedPerksActivities() : trackedPerksActivities
- C_PerksActivities.RemoveTrackedPerksActivity(perksActivityID)
- C_PerksProgram.ClearFrozenPerksVendorItem()
- C_PerksProgram.CloseInteraction()
- C_PerksProgram.GetAvailableCategoryIDs() : categoryIDs
- C_PerksProgram.GetAvailableVendorItemIDs() : vendorItemIDs
- C_PerksProgram.GetCategoryInfo(categoryID) : categoryInfo
- C_PerksProgram.GetCurrencyAmount() : currencyAmount
- C_PerksProgram.GetDraggedPerksVendorItem() : perksVendorItemID
- C_PerksProgram.GetFrozenPerksVendorItemInfo() : vendorItemInfo
- C_PerksProgram.GetPendingChestRewards() : pendingRewards
- C_PerksProgram.GetPerksProgramItemDisplayInfo(id) : item
- C_PerksProgram.GetTimeRemaining(vendorItemID) : timeRemaining
- C_PerksProgram.GetVendorItemInfoRefundTimeLeft(vendorItemID) : refundTimeRemaining
- C_PerksProgram.GetVendorItemInfo(vendorItemID) : vendorItemInfo
- C_PerksProgram.ItemSelectedTelemetry(perksVendorItemID)
- C_PerksProgram.PickupPerksVendorItem(perksVendorItemID)
- C_PerksProgram.RequestPendingChestRewards()
- C_PerksProgram.RequestPurchase(perksVendorItemID)
- C_PerksProgram.RequestRefund(perksVendorItemID)
- C_PerksProgram.ResetHeldItemDragAndDrop()
- C_PerksProgram.SetFrozenPerksVendorItem()
Traits
- C_Traits.CanPurchaseRank(configID, nodeID, nodeEntryID) : canPurchase
- C_Traits.CanRefundRank(configID, nodeID) : canRefund
- C_Traits.CascadeRepurchaseRanks(configID, nodeID) : success
- C_Traits.ClearCascadeRepurchaseHistory(configID)
- C_Traits.CloseTraitSystemInteraction()
- C_Traits.CommitConfig(configID) : success
- C_Traits.ConfigHasStagedChanges(configID) : hasChanges
- C_Traits.GenerateInspectImportString(target) : importString
- C_Traits.GetConditionInfo(configID, condID) : condInfo
- C_Traits.GetConfigIDBySystemID(systemID) : configID
- C_Traits.GetConfigIDByTreeID(treeID) : configID
- C_Traits.GetConfigInfo(configID) : configInfo
- C_Traits.GetConfigsByType(configType) : configIDs
- C_Traits.GetDefinitionInfo(definitionID) : definitionInfo
- C_Traits.GetEntryInfo(configID, entryID) : entryInfo
- C_Traits.GetLoadoutSerializationVersion() : serializationVersion
- C_Traits.GetNodeCost(configID, nodeID) : costs
- C_Traits.GetNodeInfo(configID, nodeID) : nodeInfo
- C_Traits.GetStagedChangesCost(configID) : costs
- C_Traits.GetStagedPurchases(configID) : nodeIDsWithPurchases
- C_Traits.GetTraitCurrencyInfo(traitCurrencyID) : flags, type, currencyTypesID, icon
- C_Traits.GetTraitDescription(entryID, rank) : description
- C_Traits.GetTraitSystemFlags(configID) : flags
- C_Traits.GetTraitSystemWidgetSetID(configID) : uiWidgetSetID
- C_Traits.GetTreeCurrencyInfo(configID, treeID, excludeStagedChanges) : treeCurrencyInfo
- C_Traits.GetTreeHash(treeID) : result
- C_Traits.GetTreeInfo(configID, treeID) : treeInfo
- C_Traits.GetTreeNodes(treeID) : nodeIDs
- C_Traits.HasValidInspectData() : hasValidInspectData
- C_Traits.IsReadyForCommit() : isReadyForCommit
- C_Traits.PurchaseRank(configID, nodeID) : success
- C_Traits.RefundAllRanks(configID, nodeID) : success
- C_Traits.RefundRank(configID, nodeID) : success
- C_Traits.ResetTree(configID, treeID) : success
- C_Traits.ResetTreeByCurrency(configID, treeID, traitCurrencyID) : success
- C_Traits.RollbackConfig(configID) : success
- C_Traits.SetSelection(configID, nodeID [, nodeEntryID]) : success
- C_Traits.StageConfig(configID) : success
- C_Traits.TalentTestUnlearnSpells()
Profession Specs
- C_ProfSpecs.CanRefundPath(pathID, configID) : canRefund
- C_ProfSpecs.CanUnlockTab(tabTreeID, configID) : canUnlock
- C_ProfSpecs.GetChildrenForPath(pathID) : childIDs
- C_ProfSpecs.GetConfigIDForSkillLine(skillLineID) : configID
- C_ProfSpecs.GetCurrencyInfoForSkillLine(skillLineID) : info
- C_ProfSpecs.GetDefaultSpecSkillLine() : defaultSpecSkillLine
- C_ProfSpecs.GetDescriptionForPath(pathID) : description
- C_ProfSpecs.GetDescriptionForPerk(perkID) : description
- C_ProfSpecs.GetEntryIDForPerk(perkID) : entryID
- C_ProfSpecs.GetPerksForPath(pathID) : perkInfos
- C_ProfSpecs.GetRootPathForTab(tabTreeID) : rootPathID
- C_ProfSpecs.GetSourceTextForPath(pathID, configID) : sourceText
- C_ProfSpecs.GetSpecTabIDsForSkillLine(skillLineID) : specTabIDs
- C_ProfSpecs.GetSpecTabInfo() : specTabInfo
- C_ProfSpecs.GetSpendCurrencyForPath(pathID) : currencyID
- C_ProfSpecs.GetSpendEntryForPath(pathID) : entryID
- C_ProfSpecs.GetStateForPath(pathID, configID) : state
- C_ProfSpecs.GetStateForPerk(perkID, configID) : state
- C_ProfSpecs.GetStateForTab(tabTreeID, configID) : tabInfo
- C_ProfSpecs.GetTabInfo(tabTreeID) : tabInfo
- C_ProfSpecs.GetUnlockEntryForPath(pathID) : entryID
- C_ProfSpecs.GetUnlockRankForPerk(perkID) : unlockRank
- C_ProfSpecs.ShouldShowPointsReminder() : showReminder
- C_ProfSpecs.ShouldShowPointsReminderForSkillLine(skillLineID) : showReminder
- C_ProfSpecs.ShouldShowSpecTab() : showSpecTab
- C_ProfSpecs.SkillLineHasSpecialization(skillLineID) : hasSpecialization
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() - Returns true if the account is considered "unhealthy" for players on Chinese realms.
- PartialPlayTime() - Returns 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.
- 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.
- GetPreviousAchievement(achievementID) - Returns the previous achievement in a chain.
- GetTotalAchievementPoints() - Returns the total number of achievement points earned.
- HasCompletedAnyAchievement(achievementID)
- IsAchievementEligible(achievementID)
- 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.
- GetAddOnOptionalDependencies(addonIndex or AddOnName) - Returns a list of optional dependencies.
- GetNumAddOns() - Get the number of user supplied AddOns.
- IsAddOnLoaded(addonIndex or AddOnName) - Returns true if the specified addon is loaded.
- IsAddOnLoadOnDemand(addonIndex or AddOnName) - Returns true if the specified addon is load-on-demand.
- IsAddonVersionCheckEnabled()
- LoadAddOn(addonIndex or AddOnName) - Loads the specified LoadOnDemand addon.
- ResetAddOns()
- ResetDisabledAddOns()
- SaveAddOns()
- SetAddonVersionCheck(boolean)
- UIParentLoadAddOn(AddOnName)
#framexml
- Loads or Reloads the specified AddOn, and pops up an error message if it fails to load for any reason.
Adventure Guide
The Adventure Guide was added in Patch 6.2.0
- C_AdventureJournal.ActivateEntry(index)
- C_AdventureJournal.CanBeShown()
- C_AdventureJournal.GetNumAvailableSuggestions()
- C_AdventureJournal.GetPrimaryOffset()
- C_AdventureJournal.GetReward()
- C_AdventureJournal.GetSuggestions([suggestions])
- C_AdventureJournal.SetPrimaryOffset(offset)
- C_AdventureJournal.UpdateSuggestions([levelUp])
Encounter Journal
The Encounter Journal was added in Patch 4.2.0
- C_EncounterJournal.GetDungeonEntrancesForMap(uiMapID) : dungeonEntrances - Returns the instance entrances for a map.
- C_EncounterJournal.GetEncountersOnMap(uiMapID) : encounters - Returns boss pin locations for an instance map.
- C_EncounterJournal.GetSectionIconFlags(sectionID) : iconFlags - Returns the icon flags for a section, such as Magic Effect and Heroic Difficulty
- C_EncounterJournal.GetSectionInfo(sectionID) : info - Returns information about an entry in the Abilities section of the Encounter Journal.
- C_EncounterJournal.InstanceHasLoot([instanceID]) : hasLoot - Returns whether an instance has a loot table in the journal.
- C_EncounterJournal.IsEncounterComplete(journalEncounterID) : isEncounterComplete - Returns if a boss encounter has been completed.
- C_EncounterJournal.SetPreviewMythicPlusLevel(level)
- C_EncounterJournal.SetPreviewPvpTier(tier)
- C_RaidLocks.IsEncounterComplete(mapID, encounterID [, difficultyID]) : encounterIsComplete
- EJ_ClearSearch() - Clears the encounter journal search results.
- EJ_EndSearch() - Ends any active encounter journal search.
- EJ_GetContentTuningID() - Returns the currently selected content tuning ID for BFA instances.
- EJ_GetCreatureInfo(index [, encounterID]) - Returns encounter boss info.
- EJ_GetCurrentTier() - Returns the currently active encounter journal tier index.
- EJ_GetDifficulty() - Returns the currently viewed difficulty in the journal.
- EJ_GetEncounterInfo(encounterID) - Returns encounter info from the journal.
- EJ_GetEncounterInfoByIndex(index [, 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, minIncrement, buyoutPrice, bidAmount, highBidder, bidderFullName, owner, ownerFullName, saleStatus, itemID, hasAllInfo - 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.
- C_AuctionHouse.CancelAuction(ownedAuctionID)
#hwevent
#noscript
- 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.ConfirmPostCommodity(item, duration, quantity, unitPrice)
- C_AuctionHouse.ConfirmPostItem(item, duration, quantity [, bid, buyout])
- 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 true 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.
- C_AuctionHouse.PlaceBid(auctionID, bidAmount)
#hwevent
#noscript
- Places a bid on a non-commodity item. - C_AuctionHouse.PostCommodity(item, duration, quantity, unitPrice) : needsConfirmation
#hwevent
#noscript
- Posts a commodity item on the auction house. - C_AuctionHouse.PostItem(item, duration, quantity [, bid, buyout]) : needsConfirmation
#hwevent
#noscript
- Posts an item on the auction house. - C_AuctionHouse.QueryBids(sorts, auctionIDs)
- C_AuctionHouse.QueryOwnedAuctions(sorts)
#noscript
- Queries the auction house for the player's active auctions. - C_AuctionHouse.RefreshCommoditySearchResults(itemID)
- C_AuctionHouse.RefreshItemSearchResults(itemKey [, minLevelFilter, maxLevelFilter])
- C_AuctionHouse.RequestFavorites()
- C_AuctionHouse.RequestMoreBrowseResults()
#noscript
- C_AuctionHouse.RequestMoreCommoditySearchResults(itemID) : hasFullResults
- C_AuctionHouse.RequestMoreItemSearchResults(itemKey) : hasFullResults
- C_AuctionHouse.RequestOwnedAuctionBidderInfo(auctionID) : bidderName
- C_AuctionHouse.SearchForFavorites(sorts)
#noscript
- Searches for favorited items. - C_AuctionHouse.SearchForItemKeys(itemKeys, sorts) - Queries the auction house for summary results of up to 100 specific items.
- C_AuctionHouse.SendBrowseQuery(query)
#noscript
- Queries the auction house using search parameters. - C_AuctionHouse.SendSearchQuery(itemKey, sorts, separateOwnerItems [, minLevelFilter, maxLevelFilter])
#noscript
- 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)
- C_AuctionHouse.StartCommoditiesPurchase(itemID, quantity)
#hwevent
#noscript
- 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()
- C_BlackMarket.ItemPlaceBid(marketID, bid)
#hwevent
- 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
- 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.
- SetBarSlotFromIntro(slot)
- CloseAllBags(callingFrame, forceUpdate)
#framexml
- CloseBackpack()
#framexml
- CloseBag(bagID)
#framexml
- IsBagOpen(bagID)
#framexml
- OpenAllBags(callingFrame, forceUpdate)
#framexml
- OpenBackpack()
#framexml
- OpenBag(bagID, force)
#framexml
- ToggleAllBags()
#framexml
- ToggleBackpack()
#framexml
- Toggles your backpack open/closed. - ToggleBag(bagID)
#framexml
- Opens or closes the specified bag.
Inventory
These functions manage your inventory, specifically equipped items.
- CancelPendingEquip(index) - Cancels a pending equip confirmation.
- ConfirmBindOnUse()
#protected
- ConfirmNoRefundOnUse()
#protected
- 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) - Returns 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() - Returns true if a wand is equipped.
- IsInventoryItemLocked(id) - Returns whether an inventory item is locked, usually as it awaits pending action.
- UpdateInventoryAlertStatus()
- UseInventoryItem(invSlot)
#protected
- 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()
- GetBankSlotCost(numSlots) - Returns the cost of the next bank bag slot.
- GetNumBankSlots() - Returns the number of purchased bank bag slots.
- GetReagentBankCost()
- IsReagentBankUnlocked()
- PurchaseSlot() - Buys another bank slot if available.
- ReagentBankButtonIDToInvSlotID()
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.
- 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() - Returns 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
- C_Calendar.AddEvent()
#hwevent
- 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 info for a calendar 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])
- C_Calendar.UpdateEvent()
#hwevent
- 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)
- ChatFrame_AddChannel(chatFrame, channelName)
#framexml
- Activate channel in chatFrame. - ChatFrame_AddMessageEventFilter(event, filterFunc)
#framexml
- Add a chat message filtering function. - ChatFrame_GetMessageEventFilters(event)
#framexml
- Retreive the list of chat message filtering functions. - ChatFrame_OnHyperlinkShow(reference, link, button)
#framexml
- Called when the user clicks on a chatlink. - ChatFrame_RemoveMessageEventFilter(event, filterFunc)
#framexml
- 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])
#protected
- 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
- C_Club.KickMember(clubId, memberId)
#protected
- 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)
- C_Club.SetClubMemberNote(clubId, memberId, note)
#protected
- 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()
- C_ReportSystem.SendReport(reportInfo [, playerLocation])
#protected
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, messageText) : overrideMessage
Character
- 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() - Returns true if the character is currently falling.
- IsFlyableArea() - Returns true if the current zone is a flyable area.
- IsFlying() - Returns true if the character is currently on a flying mount.
- IsIndoors() - Returns true if the character is currently indoors.
- IsInsane() - Used for the Insanity bar
- IsMounted() - Returns true if the character is currently mounted.
- IsOutOfBounds() - Returns true if the player is currently outside of map boundaries.
- IsOutdoors() - Returns true if the character is currently outdoors.
- IsPlayerInWorld()
- IsPlayerNeutral()
- IsResting() - Returns true if the character is currently resting.
- IsStealthed() - Returns true if the character is currently stealthed.
- IsSubmerged()
- IsSwimming() - Returns true if the character is currently swimming.
- IsThreatWarningEnabled() - Returns true if threat warnings are currently enabled.
- IsTitleKnown(index) - Returns true if the character can use a player title.
- IsXPUserDisabled() - Returns 1 if the character has disabled experience gain.
- RandomRoll(min, max) - Performs a random roll between two values.
- SetCurrentTitle(titleId)
#hwevent
- Sets the player's displayed title. - ToggleSheath() - Toggles sheathed or unsheathed weapons.
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 the player's melee haste percentage.
- 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, numLost, numIgnored - 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.
- C_EquipmentSet.UseEquipmentSet(equipmentSetID) : setWasEquipped
#nocombat
- Equips items from a specified equipment set. - GetInventoryItemEquippedUnusable(unit, slot)
- GetInventoryItemsForSlot(slot, returnTable [, transmogrify])
- EquipmentManager_UnpackLocation()
#framexml
- Unpacks a location integer to determine the actual inventory location.
Dressing Room
The Dressing room was added in Patch 1.7.0
- DressUpItemLink(itemLink)
#framexml
- Shows the Dressing Room with the given item equipped. - DressUpMountLink(itemLink | spellLink)
#framexml
- Shows the Dressing Room for the mount. - DressUpTransmogLink(transmogLink)
#framexml
- Shows the Dressing Room for transmog appearance or illusion. - SetDressUpBackground(frame, fileName, atlasPostfix)
#framexml
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, othersFailureReason
- 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, cannotTransmogrifyReason, hasUndo, isHideVisual, texture
- C_Transmog.GetSlotUseError(transmogLocation) : errorCode, errorString
- C_Transmog.GetSlotVisualInfo(transmogLocation) : baseSourceID, baseVisualID, appliedSourceID, appliedVisualID, pendingSourceID, pendingVisualID, hasUndo, isHideVisual, itemSubclass
- 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()
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) - Returns true if the specified movie exists and can be played.
- PreloadMovie(movieId)
- MovieFrame_PlayMovie(MovieFrame, movieID)
#framexml
- 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 male or female class names.
- GetClassInfo(index) - Returns information about a class.
- GetNumClasses() - Returns the number of player classes in the game.
- IsDemonHunterAvailable()
- GetClassColor(classFilename)
#framexml
- 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()
- 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) - Returns true if the specified spell is learned from a talent.
- LearnPvpTalent()
- LearnPvpTalents()
- LearnTalent(talentID)
- LearnTalents(talentID1, talentID2, ...)
#nocombat
- Learns the talents listed. - RemovePvpTalent()
- RemoveTalent(talentID)
#nocombat
- Removes the specified talent. - SetSpecialization(specIndex [, isPet])
#nocombat
- Selects a specialization. - UnlearnSpecialization(specIndex [, isPet])
#nocombat
Shaman totems
- DestroyTotem(slot)
#protected
- 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)
- SetMultiCastSpell(actionID, spellID)
#protected
- Sets the totem spell for a specific totem bar slot.
Druid shapeshift forms
- CancelShapeshiftForm()
#protected
- Cancels a shapeshift form. - CastShapeshiftForm(index)
#protected
- GetNumShapeshiftForms()
- GetShapeshiftForm(unknown) - Returns the 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, isFactionSpecific, faction, shouldHideOnChar, isCollected, mountID, isForDragonriding - Returns information about the specified mount.
- C_MountJournal.GetDisplayedMountInfoExtra(mountIndex) : creatureDisplayInfoID, description, source, isSelfMount, mountTypeID, uiModelSceneID, animID, spellVisualKitID, disablePlayerMountPreview - 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, isFactionSpecific, faction, shouldHideOnChar, isCollected, mountID, isForDragonriding - Returns information about the specified mount.
- C_MountJournal.GetMountInfoExtraByID(mountID) : creatureDisplayInfoID, description, source, isSelfMount, mountTypeID, uiModelSceneID, animID, spellVisualKitID, disablePlayerMountPreview - 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
- C_MountJournal.ApplyMountEquipment(itemLocation) : canContinue
#protected
- 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
- CallCompanion(type, slotid)
#deprecated
- Summons a companion. - DismissCompanion(type)
#deprecated
- Dismisses the current companion. - GetCompanionInfo(type, slotid)
#deprecated
- Returns info for a companion. - GetNumCompanions(type)
#deprecated
- Returns the number of mounts. - SummonRandomCritter()
#deprecated
- 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) - Returns 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.
- C_PetJournal.SummonPetByGUID(petID)
#nocombat
- Summons (or dismisses) a pet. - C_PetJournal.SummonRandomPet(allPets)
#nocombat
- 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(index)
- 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, itemLink, transmoglink, sourceType, itemSubClass
- 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()
- 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)
- 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()
- CastPetAction(index)
#protected
- 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() - Returns true if the player currently has an active (hunter) pet out.
- IsPetActive()
- IsPetAttackActive() - Returns true if the pet is currently auto attacking.
- PetAbandon() - Permanently abandons your pet.
- PetAggressiveMode()
#protected
- PetAssistMode()
#protected
- Set your pet to Assist mode. - PetAttack()
#protected
- Instruct your pet to attack your target. - PetCanBeAbandoned() - Returns true if the pet can be abandoned.
- PetMoveTo(target)
#protected
- PetCanBeDismissed()
- PetCanBeRenamed() - Returns true if the pet can be renamed.
- PetDefensiveMode()
#protected
- Set your pet in defensive mode. - PetDefensiveAssistMode()
- PetDismiss() - Dismiss your pet.
- PetFollow()
#protected
- Instruct your pet to follow you. - PetHasSpellbook()
- PetPassiveMode()
#protected
- Set your pet into passive mode. - PetRename(name) - Renames your pet.
- PetStopAttack() - Stops the pet from attacking.
- PetUsesPetFrame()
- PetWait()
#protected
- Instruct your pet to remain still. - TogglePetAutocast(index)
#protected
- Toggles whether the specified pet ability should autocast or not. - ToggleSpellAutocast(spellName | spellId, bookType)
#protected
- 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 info for 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
- ChangeActionBarPage(page)
#nocombat
- 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) - Returns 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) - Returns true if an action slot is occupied.
- IsActionInRange(slot) - Returns true if the specified action is in range.
- IsAttackAction(slot) - Returns true if an action is the "Auto Attack" action.
- IsAutoRepeatAction(slot) - Returns true if an action is currently auto-repeating (e.g. Shoot for wand and Auto Shot for Hunters).
- IsConsumableAction(slot) - Returns true if an action is a consumable, i.e. it has a count.
- IsCurrentAction(slot) - Returns true if the specified action is currently being used.
- IsEquippedAction(slot) - Returns true if the specified action slot is an equipped item.
- IsItemAction(slot)
- IsPetAttackAction(index)
- IsStackableAction(slot)
- IsUsableAction(slot) - Returns true if the character can currently use the specified action (sufficient mana, reagents and not on cooldown).
- SetActionUIButton(checkboxFrame, actionSlot, cooldownFrame)
- SetSpellbookPetAction(slot, target)
- UseAction(slot [, checkCursor, onSelf])
#protected
- 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]) - Returns the binding action performed when the specified key combination is triggered.
- GetBindingKey(command) - Returns the keys bound to the given command.
- 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.
- SetBinding(key [, command, mode])
#nocombat
- Sets a key binding to an action. - SetBindingSpell(key, spellName)
#nocombat
- Sets a binding to cast the specified spell. - SetBindingClick(key, ButtonName [, mouseButton])
#nocombat
- Sets a binding to click the specified Button widget. - SetBindingItem(key, itemname)
#nocombat
- SetBindingMacro(key, macroname or macroId)
#nocombat
- SetOverrideBinding(owner, isPriority, key [, command])
#nocombat
- Sets an override key binding. - SetOverrideBindingSpell(owner, isPriority, key, spellname)
#nocombat
- SetOverrideBindingClick(owner, isPriority, key, buttonName [, mouseClick])
#nocombat
- Sets an override binding that performs a button click. - SetOverrideBindingItem(owner, isPriority, key, itemname)
#nocombat
- SetOverrideBindingMacro(owner, isPriority, key, macroname or macroId)
#nocombat
- ClearOverrideBindings(owner)
#nocombat
- 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) - Returns true if the modifier key needed for an an action is pressed.
- IsModifierKeyDown() - Returns true if a modifier key is currently pressed down.
- 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.
- CursorHasItem() - Returns 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.
- DeleteCursorItem()
#hwevent
#noscript
- 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() - Returns 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.
- 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)
- ShowRepairCursor()
Camera
- CameraOrSelectOrMoveStart()
#protected
- Begin "Left click" in the 3D world. - CameraOrSelectOrMoveStop([stickyFlag])
#protected
- 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() - Returns 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.
- PitchDownStart()
#protected
- Begins pitching the camera Downward. - PitchDownStop()
#protected
- Stops pitching the camera after PitchDownStart() is called. - PitchUpStart()
#protected
- Begins pitching the camera Upward. - PitchUpStop()
#protected
- 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.
- AssistUnit(unit)
#protected
- Assists the unit by targeting the same target. - ClearFocus()
#protected
- Clears the focus target. - ClearTarget()
#protected
- Clears the selected target. - FocusUnit(unit)
#protected
- Sets the focus target. - TargetDirectionEnemy(facing)
#protected
- TargetDirectionFinished()
#protected
- TargetDirectionFriend(facing)
#protected
- TargetLastEnemy()
#protected
- Targets the previously targeted enemy. - TargetLastFriend()
#protected
- TargetLastTarget()
#protected
- Selects the last target as the current target. - TargetNearestEnemy([reverseFlag])
#protected
- Selects the nearest enemy as the current target. - TargetNearestEnemyPlayer([reverseFlag])
#protected
- Selects the nearest enemy player as the current target. - TargetNearestFriend([reverseFlag])
#protected
- Targets the nearest friendly unit. - TargetNearestFriendPlayer([reverseFlag])
#protected
- Selects the nearest friendly player as the current target. - TargetNearest()
#protected
- TargetNearestPartyMember()
#protected
- Selects the nearest Party member as the current target. - TargetNearestRaidMember()
#protected
- Selects the nearest Raid member as the current target. - TargetPriorityHighlightEnd()
#protected
- TargetPriorityHighlightStart()
#protected
- TargetUnit(unit [, exactMatch])
#protected
- Targets the specified unit.
Movement
Most of these functions may only be called on a hardware event from secure code.
- AscendStop()
#protected
- Called when the player releases the jump key. - AttackTarget()
#protected
- Toggles auto-attacking of the current target. - DescendStop()
#protected
- Stops descending while flying or swimming. - FollowUnit(unit)
#hwevent
- Follows a friendly player unit. - IsPlayerMoving()
- JumpOrAscendStart()
#protected
- Makes the character jump or swim/fly upwards. - MoveAndSteerStart()
#protected
- MoveAndSteerStop()
#protected
- MoveBackwardStart()
#protected
- The player begins moving backward at the specified time. - MoveBackwardStop()
#protected
- The player stops moving backward at the specified time. - MoveForwardStart()
#protected
- The player begins moving forward at the specified time. - MoveForwardStop()
#protected
- The player stops moving forward at the specified time. - SetMoveEnabled()
#protected
- SetTurnEnabled()
#protected
- SitStandOrDescendStart()
#protected
- Makes the player sit, stand, or descend (while swimming or flying). - StartAttack()
#protected
- StopAttack() - Turns off auto-attack, if currently active.
- StartAutoRun()
#protected
- StopAutoRun()
#protected
- StrafeLeftStart()
#protected
- The player begins strafing left at the specified time. - StrafeLeftStop()
#protected
- The player stops strafing left at the specified time. - StrafeRightStart()
#protected
- The player begins strafing right at the specified time. - StrafeRightStop()
#protected
- The player stops strafing right at the specified time. - ToggleAutoRun()
#protected
- Turns auto-run on or off. - ToggleRun()
#protected
- Toggle between running and walking. - TurnLeftStart()
#protected
- Turns the player left at the specified time. - TurnLeftStop()
#protected
- The player stops turning left at the specified time. - TurnOrActionStart()
#protected
- Starts a "right click" in the 3D game world. - TurnOrActionStop()
#protected
- Stops a "right click" in the 3D game world. - TurnRightStart()
#protected
- Turns the player right at the specified time. - TurnRightStop()
#protected
- 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)
- GetNumWatchedTokens()
#framexml
- Returns the number of currently watched currencies.
Customer Support
Relates to Customer Support.
- AcknowledgeSurvey(caseIndex)
- DeleteGMTicket()
#protected
- 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.
- C_FriendList.AddFriend(name [, notes])
#noscript
- 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.
- C_FriendList.SendWho(filter)
#hwevent
- 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.GetFriendAccountInfo(friendIndex [, wowAccountGUID]) : accountInfo - Returns information about a Battle.net friend account.
- C_BattleNet.GetAccountInfoByID(id [, wowAccountGUID]) : accountInfo
- C_BattleNet.GetAccountInfoByGUID(guid) : accountInfo
- C_BattleNet.GetFriendGameAccountInfo(friendIndex, accountIndex) : gameAccountInfo - Returns information on the game the Battle.net friend is playing.
- C_BattleNet.GetGameAccountInfoByID(id) : gameAccountInfo
- C_BattleNet.GetGameAccountInfoByGUID(guid) : 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() - Returns 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.
- 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([rafVersion]) : 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, optionalCompleteAtLeastCount
- 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() - Declines an invitation to a group.
- 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]) - Returns true if the player is in a group.
- IsInGuildGroup()
- IsInRaid([groupType]) - Returns true if the player is in a raid.
- PromoteToLeader(unit) - Promotes a unit to group leader.
- RespondToInviteConfirmation(guid, accept)
- UninviteUnit(name [, reason])
#hwevent
- Removes a player from the group if you're the leader, or initiates a vote to kick. - UnitInAnyGroup(unit)
- UnitInParty(unit) - Returns 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]) - Returns 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()
- SetPartyAssignment(assignment, player)
#protected
- SetRaidSubgroup(index, subgroup)
#nocombat
- Move a raid member from his current subgroup into a different (non-full) subgroup. - SwapRaidSubgroup(index1, index2)
#nocombat
- 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) - Returns 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.
- PlaceRaidMarker(index)
#protected
- 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)
- SetRaidTargetIcon(unit, index)
#framexml
- 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)
#hwevent
- C_LFGList.CanCreateQuestGroup(questID) : canCreate
- C_LFGList.ClearApplicationTextFields()
- C_LFGList.ClearCreationTextFields()
- C_LFGList.ClearSearchResults()
- C_LFGList.ClearSearchTextFields()
- C_LFGList.CopyActiveEntryInfoToCreationFields()
- C_LFGList.CreateListing(activityID, itemLevel, honorLevel [, autoAccept, privateGroup, questID])
#hwevent
- 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
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.
- SearchLFGJoin(typeID, lfgID)
#hwevent
- 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, outClubId - 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, questSessionActive, leaderGUID
- 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 - Returns true if the player can edit guild officer notes.
- C_GuildInfo.CanSpeakInGuildChat() : canSpeakInGuildChat - Returns true if the player can use guild chat.
- C_GuildInfo.CanViewOfficerNote() : canViewOfficerNote - Returns 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.
- AcceptGuild() - Accepts a guild invite.
- BuyGuildCharter(guildName) - Purchases a .
- 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() - Returns 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() - Returns true if the player can demote guild members.
- CanGuildInvite() - Returns true if the player can invite new members to the guild.
- CanGuildPromote() - Returns 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() - Returns 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() - Returns 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.
- GuildControlSetRank(rank)
#protected
- Selects a guild rank. - GuildControlSetRankFlag(index, enabled)
#protected
- Sets guild rank permissions. - GuildControlShiftRankDown(rankOrder)
- GuildControlShiftRankUp(rankOrder)
- GuildDemote(name)
#protected
- 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.
- GuildInvite(name)
#hwevent
- Invites a player to the guild. - GuildLeave() - Removes you from your current guild.
- GuildMasterAbsent()
- GuildNewsSetSticky(index, bool)
- GuildNewsSort(byDate)
- GuildPromote(name)
#protected
- 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.
- GuildUninvite(name)
#protected
- Removes a player from the guild. - IsGuildLeader(name) - Returns 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() - Returns 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+
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, dungeonScore
- C_MythicPlus.GetWeeklyChestRewardLevel() : currentWeekBestLevel, weeklyRewardLevel, nextDifficultyWeeklyRewardLevel, nextBestLevel
- 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, wasActiveKeystoneCharged
- C_ChallengeMode.GetAffixInfo(affixID) : name, description, filedataid
- C_ChallengeMode.GetCompletionInfo() : mapChallengeModeID, level, time, onTime, keystoneUpgradeLevels, practiceRun, oldOverallDungeonScore, newOverallDungeonScore, IsMapRecord, IsAffixRecord, PrimaryAffix, isEligibleForScore, members
- 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.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, limitCategoryID
- 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.SetPendingItem([item]) : success
- C_NewItems.ClearAll() - Clears the new item flag on all items in the player's inventory.
- C_NewItems.IsNewItem(containerIndex, slotIndex) : isNew - Returns true if the item in the inventory slot is flagged as new.
- C_NewItems.RemoveNewItem(containerIndex, slotIndex) - 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)
- IsConsumableItem(item)
- IsCurrentItem(item)
- IsEquippableItem(item) - Returns true if an item is equipable by the player.
- IsEquippedItem(item)
- IsEquippedItemType(type) - Returns 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()
- UseItemByName(itemName, unit)
#protected
- 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.
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])
Looting
Relates to Loot.
- C_Loot.IsLegacyLootModeEnabled() : isLegacyLootModeEnabled
- 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() - Returns 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.
- CreateMacro(name, icon, body, perCharacter, isLocal)
#nocombat
- Creates a macro. - DeleteMacro(id or name) - Deletes a macro.
- EditMacro(index, name, iconIndex, body, isLocal, perCharacter)
#nocombat
- 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()
- RunMacro(id or name)
#protected
- Executes a macro. - RunMacroText(macro)
#protected
- 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])
- StopMacro()
#protected
- Stops the currently executing macro.
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) - Returns 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.
- SendMail(target, subject, body)
#noscript
- Sends in-game mail. - SetSendMailCOD(amount)
#protected
- Make next mail sent using SendMail() COD target for amount. - SetSendMailMoney(amount)
#protected
- 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 group 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, textureX, textureY, scrollChildX, scrollChildY - Returns a map highlight pin for a location.
- C_Map.GetMapInfo(uiMapID) : info - Returns map information.
- C_Map.GetMapInfoAtPosition(uiMapID, x, y [, ignoreZoneMapPositionData]) : 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
- C_Map.GetPlayerMapPosition(uiMapID, unitToken) : position
#noinstance
- 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.
- GetPlayerFacing()
#noinstance
- 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.
- UnitDistanceSquared(unit) : distance, checkedDistance
#noinstance
- Returns the squared distance to a unit in your group. - UnitPosition(unit)
#noinstance
- Returns the position of a unit in the current world area. - WorldMapFrame:AddDataProvider(dataProvider)
#framexml
- Adds a map data provider. - WorldMapFrame:GetMapID()
#framexml
- Returns the currently viewed world map. - WorldMapFrame:SetMapID(uiMapID)
#framexml
- Sets the world map. - WorldMapFrame:EnumerateAllPins()
#framexml
- 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
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, hideTimerInTooltip - Returns whether an area poi is timed.
- 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, vignetteFacing
- 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) - Returns 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() - Returns true if the merchant can repair items.
- CloseMerchant() - Closes the merchant window.
- 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 the 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() - Returns 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()
- C_PetBattles.SkipTurn()
#hwevent
- C_PetBattles.StartPVPDuel()
- C_PetBattles.StartPVPMatchmaking()
- C_PetBattles.StopPVPMatchmaking()
- C_PetBattles.UseAbility(actionIndex)
#hwevent
- C_PetBattles.UseTrap()
#hwevent
- 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 - Returns true if the GUID belongs to a player.
- C_PlayerInfo.IsConnected([playerLocation]) : isConnected - Returns true if the player is connected.
- C_PlayerInfo.UnitIsSameServer(playerLocation) : unitIsSameServer - Returns 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]) - Returns true if the player can inspect the unit.
- CheckInteractDistance(unit, interaction) - Returns 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.
- InspectUnit(unit)
#framexml
- Instructs FrameXML to inspect a particular unit (query server; show UI).
Trading
Relates to Trading.
- AcceptTrade()
#hwevent
- 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.
- 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.
- PortGraveyard()
#protected
- 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, craftingReagents, recipeLevel, orderID]) - 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.GetOnlyShowMakeableRecipes()
- C_TradeSkillUI.GetOnlyShowSkillUpRecipes()
- 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, craftingReagents [, allocationItemGUID]) : description - 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.GetRecipeSourceText(recipeID)
- C_TradeSkillUI.GetSubCategories(categoryID)
- C_TradeSkillUI.GetTradeSkillDisplayName(skillLineID) : professionDisplayName
- C_TradeSkillUI.GetTradeSkillLineForRecipe(recipeID) : tradeSkillID, skillLineName, parentTradeSkillID - Get the associated profession information for a recipe.
- C_TradeSkillUI.GetTradeSkillListLink() - Returns a link for the currently displayed profession.
- C_TradeSkillUI.GetTradeSkillTexture(tradeSkillID)
- C_TradeSkillUI.IsAnyRecipeFromSource(sourceType)
- C_TradeSkillUI.IsDataSourceChanging()
- C_TradeSkillUI.IsInventorySlotFiltered(index)
- C_TradeSkillUI.IsNPCCrafting() : result - Returns 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(skillLineID) : opened
- C_TradeSkillUI.SetInventorySlotFilter(index [, enable, exclusive])
- C_TradeSkillUI.SetOnlyShowMakeableRecipes(onlyMakable) - Controls whether only recipes you have the reagents to craft are shown.
- C_TradeSkillUI.SetOnlyShowSkillUpRecipes()
- C_TradeSkillUI.SetRecipeCategoryFilter(categoryID [, subCategoryID])
- C_TradeSkillUI.SetRecipeFavorite(recipeID, favorite)
- C_TradeSkillUI.SetRecipeItemLevelFilter(minLevel, maxLevel)
- C_TradeSkillUI.SetRecipeItemNameFilter()
- 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() - Returns 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.
- 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() - Returns 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()
- 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, pvpTierMaxFromWins
- 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 true if the player has enabled 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) - Sets the player's PvP flag.
- SetPVPRoles()
- SortBGList()
- StartDuel(name) - Challenges the specified player to a duel.
- TogglePVP() - Toggles the player's PvP flag on or off.
- 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) - Returns 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) - Returns 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, roleShortageBonus
- C_PvP.GetArenaSkirmishRewards() : honor, experience, itemRewards, currencyRewards, roleShortageBonus
- 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.
- GetNumArenaOpponents()
- GetNumArenaOpponentSpecs()
- GetPreviousArenaSeason() - Gets the previous Arena season.
- IsActiveBattlefieldArena() - Returns 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, roleShortageBonus
- C_PvP.GetRandomEpicBGInfo() : info
- C_PvP.GetRandomEpicBGRewards() : honor, experience, itemRewards, currencyRewards, roleShortageBonus
- C_PvP.GetRatedBGRewards() : honor, experience, itemRewards, currencyRewards, roleShortageBonus
- 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() - Returns true if the player can join a battlefield with a group.
- CancelAreaSpiritHeal() - Cancels the Spirit Healer's resurrection in battlegrounds.
- 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.
- GetBattlefieldScore(index)
#deprecated
- Returns info for a player's score in battlefields. - GetBattlefieldStatData(playerIndex, slotIndex)
#deprecated
- 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()
- JoinBattlefield(index [, joinAs])
#protected
- Joins the battleground queue solo or as a group. - JoinRatedBattlefield()
#protected
- 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, roleShortageBonus, 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.
- 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)
- GetQuestUiMapID(questID)
- GetSuggestedGroupSize()
- HaveQuestData(questID)
- HaveQuestRewardData(questID)
- IsBreadcrumbQuest(questID)
- IsCurrentQuestFailed()
- IsQuestCompletable() - Returns true if the displayed quest at a quest giver can be completed.
- IsQuestIDValidSpellTarget(questID)
- IsQuestItemHidden(index)
- IsQuestSequenced(questID)
- IsStoryQuest(questID)
- 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() - Returns true if the offered quest is a daily quest.
- QuestIsFromAreaTrigger()
- QuestIsWeekly() - Returns 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
- PVPGetConquestLevelInfo()
#framexml
- QuestUtils_GetQuestName()
#framexml
- 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, isActivitySet
- 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, portraitGiverModelSceneID
- 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 - Returns 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 - Returns 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.
- 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()
- GetQuestLogRewardTitle()
- GetQuestLogRewardXP()
- GetQuestLogSpecialItemCooldown(index)
- GetQuestLogSpecialItemInfo(index)
- 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 - Returns 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.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(optionID) - Selects an active quest from the gossip window.
- C_GossipInfo.SelectAvailableQuest(optionID) - Selects an available quest from the gossip window.
- C_GossipInfo.SelectOption(optionID [, 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()
- 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()
- 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.
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_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.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, tooLowLevelForParagon - Returns Paragon info on a faction.
- C_Reputation.IsFactionParagon(factionID) : hasParagon - Returns 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.
- 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) - Returns 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)
- CancelSpellByName(name)
#nocombat
- CastSpell(spellIndex, bookType)
#protected
- Casts a spell from the spellbook. - CastSpellByID(spellID [, target])
#protected
- CastSpellByName(name [, target])
#protected
- Casts a spell by name. - DeclineSpellConfirmationPrompt(spellID)
- DoesSpellExist(spellName)
- FindBaseSpellByID(spellID)
- FindSpellOverrideByID(spellID)
- GetMaxSpellStartRecoveryOffset()
- GetSchoolString(schoolMask)
- GetSpellAutocast(spellName | spellId, bookType) - Returns 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) - Returns true if a spellbook item is the "Auto Attack" spell.
- IsAutoRepeatSpell(spell)
- IsConsumableSpell()
- IsCurrentSpell(spellID) - Returns 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) - Returns true if the specified spell is a passive ability.
- IsPlayerSpell(spellID)
- IsSpellInRange(spellName [, unit]) - Returns 1 if the player is in range to use the specified spell on the target unit, 0 otherwise.
- IsSpellKnown(spellID, isPetSpell) - Returns whether the player (or pet) knows the given spell.
- IsSpellKnownOrOverridesKnown(spellID [, isPet])
- IsSpellOverlayed(spellID) - Returns 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) - Returns 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() - Returns true if a spell is about to be cast and is waiting for the player to select a target.
- SpellStopCasting()
#protected
- Stops the current spellcast. - SpellStopTargeting()
#protected
- Cancels the spell awaiting target selection. - SpellTargetUnit(unit)
#protected
- Casts the spell awaiting target selection on the unit. - SpellTargetItem(item)
#protected
- QueryCastSequence(sequence)
#framexml
- 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 [, glyphID]) : 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
- C_CharacterServices.AssignPCTDistribution()
#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()
#protected
- 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
- C_UI.Reload()
#hwevent
- Reloads the User Interface. - C_System.GetFrameStack() : objects
- CancelLogout() - Cancels the logout timer (from camping or quitting).
- CopyToClipboard(text)
#protected
- 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.
- ForceLogout()
#protected
- ForceQuit()
#protected
- 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() - Returns true if on a Linux client.
- IsLoggedIn() - Returns nil before the PLAYER_LOGIN event has fired, 1 afterwards.
- IsMacClient() - Returns true if on a Mac client.
- IsOnGlueScreen()
- IsPublicBuild()
- IsTestBuild()
- IsUsingFixedTimeStep() - Whether the UI is updating at a fixed rate independent of the framerate.
- IsWindowsClient() - Returns true if on a Windows client.
- LoadURLIndex(index)
- Logout()
#protected
- Logs the player out of the game. - ProcessExceptionClient()
- Quit()
#protected
- Quits the game. - Screenshot() - Takes a screenshot.
- SendSystemMessage(message) - Prints a yellow CHAT_MSG_SYSTEM message.
- Stuck()
#protected
- Notifies the game engine that the player is stuck. - ToggleFramerate()
#framexml
- 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]) : success - Sets a console variable.
- C_CVar.SetCVarBitfield(name, index, value) : 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.
- date(format, time)
#lua
- Returns the current date according to the user's machine. - time(table)
#lua
- Returns a timestamp for the specified time or the current Unix time.
Timers
- C_Timer.After(seconds, callback) - Schedules a timer.
- C_Timer.NewTimer(seconds, callback) : cbObject - Schedules a timer that can be canceled.
- C_Timer.NewTicker(seconds, callback [, iterations]) : cbObject - Schedules a repeating timer that can be canceled.
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.
- DevTools_Dump(value [, startKey])
#framexml
- Pretty prints a variable or value. Equivalent to the/dump
macro. - print(...)
#framexml
- Calls the current print output handler with the provided values; by default printing the values to the default chat frame. - getprinthandler()
#framexml
- Returns the function currently handling print() output. - setprinthandler(func)
#framexml
- Changes the function handling print() output. - message(text)
#framexml
- Displays a message box with your text message and an "Okay" button. - 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)
#protected
Graphics
- C_ScriptedAnimations.GetAllScriptedAnimationEffects() : scriptedAnimationEffects
- C_VideoOptions.GetGxAdapterInfo() : adapters - Returns info about the system's graphics adapter.
- AntiAliasingSupported()
- AutoChooseCurrentGraphicsSetting()
- GetCurrentGraphicsSetting()
- GetCurrentScaledResolution()
- GetGraphicsAPIs() - Returns the supported graphics APIs for the system, D3D11_LEGACY, D3D11, D3D12, etc.
- GetMaxRenderScale()
- GetMinRenderScale()
- GetMonitorAspectRatio()
- GetMonitorCount()
- GetMonitorName()
- GetPhysicalScreenSize()
- GetScreenDPIScale()
- GetScreenHeight() - Returns the height of the window in pixels, affected by UI scale.
- GetScreenWidth() - Returns the width of the window in pixels, affected by UI scale.
- GetVideoCaps()
- IsDesaturateSupported()
- IsOutlineModeSupported()
- MultiSampleAntiAliasingSupported()
- RestartGx() - Restarts the graphics engine.
- SetCurrentGraphicsSetting(setting{0=normal, 1=raid/BG})
- 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) - Returns the memory used for an addon.
- GetFrameCPUUsage(frame [, includeChildren]) - Returns the total time used by and number of calls of a frame's event handlers.
- 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() - Returns true if the combat lockdown restrictions are active.
- issecure() - Returns true if the current execution path is secure.
- issecurevariable([table,] name) - Returns 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)
- CanAccessObject(obj)
#framexml
- 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.
- EasyMenu(menuList, menuFrame, anchor, x, y, displayMode, autoHideDelay)
#framexml
- ToggleDropDownMenu(level, value, dropDownFrame, anchorName, xOffset, yOffset)
#framexml
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()
- GetMouseFocus() - Returns the frame that currently has mouse focus.
- SetupFullscreenScale(frame) - Sizes a frame to take up the entire screen regardless of screen resolution.
- MouseIsOver(region, topOffset, bottomOffset, leftOffset, rightOffset)
#framexml
- Checks whether the mouse is over the frame (or within specified offsets). - UIFrameFadeIn(frame, timeToFade, startAlpha, endAlpha)
#framexml
- Fades a frame in. - UIFrameFadeOut(frame, timeToFade, startAlpha, endAlpha)
#framexml
- 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.
- SetPortraitTexture(textureObject, unitToken [, disableMasking]) - Sets a texture to a unit's 2D portrait.
- SetPortraitToTexture(textureObject, texturePath) - Applies a circular mask to a texture, making it resemble a portrait.
- CreateAtlasMarkup(atlasName [, height, width, offsetX, offsetY])
#framexml
- Returns a texture fontstring for an atlas. - CreateTextureMarkup(file, fileWidth, fileHeight, width, height, left, right, top, bottom [, xOffset, yOffset])
#framexml
- Returns a texture fontstring. - GetTextureInfo(obj)
#framexml
- 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, flags
- GetUICameraInfo(uiCameraID)
Widget objects
- C_Widget.IsFrameWidget()
- C_Widget.IsRenderableWidget()
- C_Widget.IsWidget(object)
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; see UPDATE_UI_WIDGET for usage information.
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])
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) - Returns 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.
- UnitCanCooperate(unit, otherUnit) - Returns true if the first unit can cooperate with the second.
- 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) - Returns 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) - Returns 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) : inRange, checkedRange
#grouponly
- Returns true if the unit is within 40 yards range (25 yards for Evokers). - UnitIsAFK(unit) - Returns true if a friendly unit is AFK (Away from keyboard).
- UnitIsCharmed(unit) - Returns true if the unit is charmed.
- UnitIsConnected(unit) : isConnected - Returns 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) - Returns true if the unit is dead.
- UnitIsDeadOrGhost(unit) - Returns true if the unit is dead or in ghost form.
- UnitIsDND(unit) - Returns true if a unit is DND (Do not disturb).
- UnitIsEnemy(unit, otherUnit) - Returns true if the specified units are hostile to each other.
- UnitIsFeignDeath(unit) - Returns true if the unit (must be a group member) is feigning death.
- UnitIsFriend(unit, otherUnit) - Returns true if the specified units are friendly to each other.
- UnitIsGhost(unit) - Returns 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) - Returns true if the unit is a player character.
- UnitIsPossessed(unit) - Returns 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) - Returns 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) - Returns true if the specified units are the same unit.
- UnitIsVisible(unit) - Returns 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(unit)
- UnitPlayerControlled(unit) - Returns true if the unit is controlled by a player.
- UnitPlayerOrPetInParty(unit) - Returns true if a different unit or pet is a member of the party.
- UnitPlayerOrPetInRaid(unit) - Returns 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(unit)
- 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(unit, mobUnit)
- 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) : bankedLevels, xpIntoCurrentLevel, xpForNextLevel
- 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.
- GetUnitName(unit [, showServerName])
#framexml
- Returns the name and optionally the realm of the unit.
Buffs
- CancelUnitBuff(unit, index or spell [, filter or rank])
#nocombat
- Removes a specific buff from the 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")
- AuraUtil.FindAura(predicate, unit, filter, predicateArg1, predicateArg2, predicateArg3)
#framexml
- AuraUtil.FindAuraByName(auraName, unit, filter)
#framexml
- Finds the first aura that matches the name. - AuraUtil.ForEachAura(unit, filter, maxCount, func)
#framexml
- AuraUtil.ShouldSkipAuraUpdate(isFullUpdate, updatedAuraInfos, isRelevantFunc, ...)
#framexml
Weapon Enchants
- CancelItemTempEnchantment(weaponHand)
#protected
- 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) - Returns true if the unit is currently in a vehicle.
- UnitVehicleSeatCount(unit)
- UnitVehicleSeatInfo(unit, seatId)
- UnitVehicleSkin(unit)
- VehicleAimDecrement()
- VehicleAimDownStart()
- VehicleAimDownStop()
- VehicleAimGetNormPower()
- VehicleAimIncrement()
- VehicleAimRequestAngle()
- 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.
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, failureDescription, uiCameraID, altHandCameraID, swatchColorR, swatchColorG, swatchColorB, modelOpacity, modelSaturation, obtainable - Returns information about a selected artifact appearance.
- C_ArtifactUI.GetAppearanceInfoByID(artifactAppearanceID) : artifactAppearanceSetID, artifactAppearanceID, appearanceName, displayIndex, unlocked, failureDescription, uiCameraID, altHandCameraID, swatchColorR, swatchColorG, swatchColorB, modelOpacity, modelSaturation, obtainable - Returns information about a selected artifact appearance.
- C_ArtifactUI.GetAppearanceSetInfo(appearanceSetIndex) : artifactAppearanceSetID, appearanceSetName, appearanceSetDescription, numAppearances
- C_ArtifactUI.GetArtifactArtInfo() : artifactArtInfo - Returns information about the currently equipped artifact weapon.
- C_ArtifactUI.GetArtifactInfo() : itemID, altItemID, name, icon, xp, pointsSpent, quality, artifactAppearanceID, appearanceModID, itemAppearanceID, altItemAppearanceID, altOnTop, tier
- 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, appearanceModID, itemAppearanceID, altItemAppearanceID, altOnTop, tier
- 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, appearanceModID, itemAppearanceID, altItemAppearanceID, altOnTop, tier
- 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, startTime - 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 - Returns 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.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
- 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.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()
#protected
- 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)
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()
Cypher Equipment
- C_Garrison.GetCurrentCypherEquipmentLevel() : equipmentLevel
- C_Garrison.GetCyphersToNextEquipmentLevel() : cyphersToNext
- C_Garrison.GetMaxCypherEquipmentLevel() : maxEquipmentLevel
See also
- Widget API documents methods that can be called on widgets objects
- Lua functions describe the language and library functions available in the WoW client.
- API change summaries document changes made in WoW patches, as summarized on the US official UI forum.
- User Defined Functions lists various useful user-contributed functions.
- Category:Function Libraries contains some AddOns that do nothing but provide you with utility functions.
- Protected Functions for functions unusable by addons.
- Removed Functions for no longer available functions.
- World of Warcraft Non-Public API for functions not used in FrameXML.
External links
- Townlong Yak Blizzard API Documentation