Patch 10.2.6/API changes

Main Menu
WoW API Lua API FrameXML Widget API Widget scripts XML schema Events CVars Macro commands Combat Log Escape sequences Hyperlinks API changes HOWTOs wowuidev

Summary

• Many global functions have been moved to various C_* namespaces. Refer to Deprecated API.

Resources

• TOC: 100206
• Diffs: wow-ui-source, BlizzardInterfaceResources
• Official patch notes: None (Dragonflight: Plunderstorm Content Update Notes)

Diffs

Global API

10.2.5 (52902) → 10.2.6 (53840) Mar 18 2024

Added (122)

Removed (81)

C_AddOns.GetScriptsDisallowedForBeta C_Commentator.ZoomIn_Position C_Commentator.ZoomOut_Position C_CurrencyInfo.GetCoinIcon C_CurrencyInfo.GetCoinTextureString C_CurrencyInfo.GetCoinText C_Debug.FrameXMLDebug C_GameEnvironmentManager.GetCurrentEventRealmQueues C_GameEnvironmentManager.GetCurrentGameEnvironment C_GameEnvironmentManager.RequestGameEnvironment C_GameModeManager.GetCurrentGameMode C_GameModeManager.GetFeatureSetting C_GameModeManager.IsFeatureEnabled C_GuildInfo.Demote C_GuildInfo.Disband C_GuildInfo.Invite C_GuildInfo.Leave C_GuildInfo.Promote C_GuildInfo.SetLeader C_GuildInfo.SetMOTD C_GuildInfo.Uninvite C_Item.ActionBindsItem C_Item.BindEnchant C_Item.ConfirmBindOnUse C_Item.ConfirmNoRefundOnUse C_Item.ConfirmOnUse C_Item.DoesItemContainSpec C_Item.DropItemOnUnit C_Item.EndBoundTradeable C_Item.EndRefund C_Item.EquipItemByName C_Item.GetDetailedItemLevelInfo C_Item.GetFirstTriggeredSpellForItem C_Item.GetItemChildInfo C_Item.GetItemClassInfo C_Item.GetItemCooldown C_Item.GetItemCount C_Item.GetItemCreationContext C_Item.GetItemFamily C_Item.GetItemGem C_Item.GetItemInfoInstant C_Item.GetItemInfo C_Item.GetItemInventorySlotInfo C_Item.GetItemQualityColor C_Item.GetItemSetInfo C_Item.GetItemSpecInfo C_Item.GetItemSpell C_Item.GetItemSubClassInfo C_Item.GetItemUniqueness C_Item.IsArtifactPowerItem C_Item.IsConsumableItem C_Item.IsCorruptedItem C_Item.IsCosmeticItem C_Item.IsCurrentItem C_Item.IsEquippableItem C_Item.IsEquippedItemType C_Item.IsEquippedItem C_Item.IsHarmfulItem C_Item.IsHelpfulItem C_Item.IsItemInRange C_Item.IsUsableItem C_Item.ItemHasRange C_Item.PickupItem C_Item.ReplaceEnchant C_Item.ReplaceTradeEnchant C_Item.ReplaceTradeskillEnchant C_Item.UseItemByName C_Navigation.GetNearestPartyMemberToken C_PlayerInfo.IsSelfFoundActive C_PvP.GetZonePVPInfo C_PvP.IsSubZonePVPPOI C_PvP.SetPVP C_PvP.TogglePVP C_RecruitAFriend.CanSummonFriend C_RecruitAFriend.GetSummonFriendCooldown C_RecruitAFriend.IsRecruitAFriendLinked C_RecruitAFriend.SummonFriend C_SeasonInfo.GetCurrentDisplaySeasonExpansion C_SeasonInfo.GetCurrentDisplaySeasonID C_Sound.PlayVocalErrorSound C_SpectatingUI.GetSpectateTargetInfo C_SpectatingUI.GetSpectatingPlayerSpellItemQuality C_SpectatingUI.LeaveSpectateMode C_SpectatingUI.SpectateChange C_Spell.GetMawPowerLinkBySpellID C_Spell.GetSchoolString C_Spell.GetSpellQueueWindow C_Spell.TargetSpellReplacesBonusTree C_TaskQuest.GetQuestIconUIWidgetSet C_TaskQuest.GetQuestTooltipUIWidgetSet C_UIWidgetManager.GetMapPinAnimationWidgetVisualizationInfo C_WorldLootObject.GetCurrentWorldLootObjectSwapInventoryType C_WorldLootObject.GetWorldLootObjectInfo C_WorldLootObject.IsWorldLootObjectInRange C_WorldLootObject.IsWorldLootObject C_WorldLootObject.OnWorldLootObjectClick C_WowLabsDataManager.PushCircleInfoToLua C_WoWLabsMatchmaking.AcceptPartyInvite C_WoWLabsMatchmaking.CanEnterMatchmaking C_WoWLabsMatchmaking.DeclinePartyInvite C_WoWLabsMatchmaking.GetCurrentParty C_WoWLabsMatchmaking.GetInQueueTimeStart C_WoWLabsMatchmaking.GetNumPartyInvites C_WoWLabsMatchmaking.GetPartyInviteByIndex C_WoWLabsMatchmaking.GetPartyPlaylistEntry C_WoWLabsMatchmaking.GetPartySize C_WoWLabsMatchmaking.IsAloneInWoWLabsParty C_WoWLabsMatchmaking.IsFindingMatch C_WoWLabsMatchmaking.IsPartyFull C_WoWLabsMatchmaking.IsPartyLeader C_WoWLabsMatchmaking.IsPlayerReady C_WoWLabsMatchmaking.IsPlayer C_WoWLabsMatchmaking.IsWowLabsMatchmakingMember C_WoWLabsMatchmaking.LeaveParty C_WoWLabsMatchmaking.RemovePlayerFromParty C_WoWLabsMatchmaking.SendPartyInvite C_WoWLabsMatchmaking.SetPartyPlaylistEntry C_WoWLabsMatchmaking.SetPlayerReady CheckTalentMasterDist ClassicExpansionAtLeast GetCameraFOVDefaults GetClassicExpansionLevel

ActionBindsItem BindEnchant C_CameraDefaults.GetCameraFOVDefaults C_TaskQuest.GetUIWidgetSetIDFromQuestID CanSummonFriend ConfirmBindOnUse ConfirmNoRefundOnUse ConfirmOnUse DoesItemContainSpec DropItemOnUnit DumpMovementCapture EndBoundTradeable EndRefund EquipItemByName FrameXML_Debug GetCoinIcon GetCoinTextureString GetCoinText GetDetailedItemLevelInfo GetItemChildInfo GetItemClassInfo GetItemCooldown GetItemCount GetItemCreationContext GetItemFamily GetItemGem GetItemIcon GetItemInfoInstant GetItemInfo GetItemInventorySlotInfo GetItemQualityColor GetItemSetInfo GetItemSpecInfo GetItemSpell GetItemSubClassInfo GetItemUniqueness GetMawPowerLinkBySpellID GetMaxSpellStartRecoveryOffset GetSchoolString GetSpellQueueWindow GetSummonFriendCooldown GetZonePVPInfo GuildDemote GuildDisband GuildInvite GuildLeave GuildPromote GuildSetLeader GuildSetMOTD GuildUninvite IsArtifactPowerItem IsConsumableItem IsCorruptedItem IsCosmeticItem IsCurrentItem IsDesaturateSupported IsEquippableItem IsEquippedItemType IsEquippedItem IsHarmfulItem IsHelpfulItem IsItemInRange IsRecruitAFriendLinked IsSplashFramePrimaryFeatureUnlocked IsSubZonePVPPOI IsUsableItem IsWorldLootObject ItemHasRange PickupItem PlayVocalErrorSoundID ReplaceEnchant ReplaceTradeEnchant ReplaceTradeskillEnchant ScriptsDisallowedForBeta SetPVP SummonFriend TargetSpellReplacesBonusTree ToggleAnimKitDisplay ToggleDebugAIDisplay TogglePVP UseItemByName

Events

Added (1)	Removed (0)
GAME_ENVIRONMENT_SWITCHED

CVars

Added (13)

Removed (3)

gxMTDecalsgxMTDecals (Graphics) Default: 1 Sort and Render decal passes in parallel gxMTMiscgxMTMisc (Graphics) Default: 1 Render miscelleous passes in parallel gxMTOutlinesgxMTOutlines (Graphics) Default: 1 Render outline passes in parallel gxMTTriggerOnBeginDrawCompletegxMTTriggerOnBeginDrawComplete (Graphics) Default: 1 Use Begin Draw Complete Trigger Mechanism GxSlowShaderWarnThresholdGxSlowShaderWarnThreshold (Graphics) Default: 30000 Max time (in milliseconds) the shader compile can take before warning via a popup message last_matchmaking_party_sizelast_matchmaking_party_size (Game) Default: 0 0=Solo,1=Duo,2=Trio lastRenownForMajorFaction2593lastRenownForMajorFaction2593 (Game) Default: 0, Scope: Account Stores the Keg Leg's Crew renown when Renown UI is closed modelLightShaftsColormodelLightShaftsColor Default: 0xFFFFFFFF modelLightShaftsSpreadmodelLightShaftsSpread Default: 32.0 partyInvitesCollapsed_GluepartyInvitesCollapsed_Glue (Game) Default: 0 The info for pending invites has been shown telemetryWowlabsPackagetelemetryWowlabsPackage Default: Blizzard.Telemetry.Wow_Labs The secondary package we want to send telemetry to e.g. Wow_Wowlabs telemetryWowPackagetelemetryWowPackage Default: Blizzard.Telemetry.Wow_Mainline The primary package we want to send telemetry to e.g. Wow_Mainline or Wow_Classic Commands testOutputtestOutput (Console) Tests that all output paths work.

partyInvitesCollapsed_WowLabspartyInvitesCollapsed_WowLabs (Game) Default: 0 The info for pending invites has been shown profanityFilterprofanityFilter (Game) Default: 1, Scope: Account Whether to enable mature language filtering telemetryTargetPackagetelemetryTargetPackage Default: Blizzard.Telemetry.Wow_Mainline The Package we want to send telemetry to e.g. Wow_Mainline or Wow_Classic

Enums

Enum.AccountData
  + FrontendChatSettings = 15
Enum.PointsModifierSourceType
  + FirstTimeQuestCompletionRewards = 65
Enum.SuperTrackingType
  + PartyMember = 5
Enum.UIWidgetScale
  + OneHundredTen = 6
  + OneHundredTwenty = 7
  + OneHundredThirty = 8
  + OneHundredForty = 9
  + OneHundredFifty = 10
  + OneHundredSixty = 11
  + OneHundredSeventy = 12
  + OneHundredEighty = 13
  + OneHundredNinety = 14
  + TwoHundred = 15
Enum.UIWidgetSetLayoutDirection
  + Overlap = 2
Enum.UIWidgetTextureAndTextSizeType
  + Medium2 = 5
Enum.UIWidgetVisualizationType
  # WorldLootObject -> MapPinAnimation = 26
Enum.WidgetEnabledState
  + BrightBlue = 7

Structures

AreaPOIInfo
  # addPaddingAboveWidgets -> addPaddingAboveTooltipWidgets
  # widgetSetID -> tooltipWidgetSet
  + iconWidgetSet
EncounterJournalItemInfo
  + displaySeasonID
HorizontalCurrenciesWidgetVisualizationInfo
  + updateAnimType
PartyPoseInfo
  + extraButtonText
TextureAndTextVisualizationInfo
  + textSizeType
UIWidgetCurrencyInfo
  + textFontType
  + textSizeType
VignetteInfo
  # addPaddingAboveWidgets -> addPaddingAboveTooltipWidgets
  # widgetSetID -> tooltipWidgetSet
  + iconWidgetSet

Deprecated API

These are functions that were deprecated and will be removed in the future.

Deprecated_10_2_6.lua

FrameXML_Debug → C_Debug.FrameXMLDebug

GetMawPowerLinkBySpellID → C_Spell.GetMawPowerLinkBySpellID

C_AreaPoiInfo.GetAreaPOIInfo

.widgetSetID -> .tooltipWidgetSet

.addPaddingAboveWidgets -> .addPaddingAboveTooltipWidgets

C_VignetteInfo.GetVignetteInfo

.widgetSetID -> .tooltipWidgetSet

.addPaddingAboveWidgets -> .addPaddingAboveTooltipWidgets

Deprecated_CurrencyScript.lua

GetCoinIcon → C_CurrencyInfo.GetCoinIcon

GetCoinText → C_CurrencyInfo.GetCoinText

GetCoinTextureString → C_CurrencyInfo.GetCoinTextureString

Deprecated_GuildScript.lua

GuildInvite → C_GuildInfo.Invite

GuildUninvite → C_GuildInfo.Uninvite

GuildPromote → C_GuildInfo.Promote

GuildDemote → C_GuildInfo.Demote

GuildSetLeader → C_GuildInfo.SetLeader

GuildSetMOTD → C_GuildInfo.SetMOTD

GuildLeave → C_GuildInfo.Leave

GuildDisband → C_GuildInfo.Disband

Deprecated_ItemScript.lua

GetItemQualityColor → C_Item.GetItemQualityColor

GetItemInfoInstant → C_Item.GetItemInfoInstant

GetItemSetInfo → C_Item.GetItemSetInfo

GetItemChildInfo → C_Item.GetItemChildInfo

DoesItemContainSpec → C_Item.DoesItemContainSpec

GetItemGem → C_Item.GetItemGem

GetItemCreationContext → C_Item.GetItemCreationContext

GetItemIcon → C_Item.GetItemIconByID

GetItemFamily → C_Item.GetItemFamily

GetItemSpell → C_Item.GetItemSpell

IsArtifactPowerItem → C_Item.IsArtifactPowerItem

IsCurrentItem → C_Item.IsCurrentItem

IsUsableItem → C_Item.IsUsableItem

IsHelpfulItem → C_Item.IsHelpfulItem

IsHarmfulItem → C_Item.IsHarmfulItem

IsConsumableItem → C_Item.IsConsumableItem

IsEquippableItem → C_Item.IsEquippableItem

IsEquippedItem → C_Item.IsEquippedItem

IsEquippedItemType → C_Item.IsEquippedItemType

ItemHasRange → C_Item.ItemHasRange

IsItemInRange → C_Item.IsItemInRange

GetItemClassInfo → C_Item.GetItemClassInfo

GetItemInventorySlotInfo → C_Item.GetItemInventorySlotInfo

BindEnchant → C_Item.BindEnchant

ActionBindsItem → C_Item.ActionBindsItem

ReplaceEnchant → C_Item.ReplaceEnchant

ReplaceTradeEnchant → C_Item.ReplaceTradeEnchant

ConfirmBindOnUse → C_Item.ConfirmBindOnUse

ConfirmOnUse → C_Item.ConfirmOnUse

ConfirmNoRefundOnUse → C_Item.ConfirmNoRefundOnUse

DropItemOnUnit → C_Item.DropItemOnUnit

EndBoundTradeable → C_Item.EndBoundTradeable

EndRefund → C_Item.EndRefund

GetItemInfo → C_Item.GetItemInfo

GetDetailedItemLevelInfo → C_Item.GetDetailedItemLevelInfo

GetItemSpecInfo → C_Item.GetItemSpecInfo

GetItemUniqueness → C_Item.GetItemUniqueness

GetItemCount → C_Item.GetItemCount

PickupItem → C_Item.PickupItem

GetItemSubClassInfo → C_Item.GetItemSubClassInfo

UseItemByName → C_Item.UseItemByName

EquipItemByName → C_Item.EquipItemByName

ReplaceTradeskillEnchant → C_Item.ReplaceTradeskillEnchant

GetItemCooldown → C_Item.GetItemCooldown

IsCorruptedItem → C_Item.IsCorruptedItem

IsCosmeticItem → C_Item.IsCosmeticItem

IsDressableItem → C_Item.IsDressableItem

Deprecated_PvpScript.lua

IsSubZonePVPPOI → C_PvP.IsSubZonePVPPOI

GetZonePVPInfo → C_PvP.GetZonePVPInfo

TogglePVP → C_PvP.TogglePVP

SetPVP → C_PvP.SetPVP

Deprecated_SoundScript.lua

PlayVocalErrorSoundID → C_Sound.PlayVocalErrorSound

Deprecated_SpellScript.lua

TargetSpellReplacesBonusTree → C_Spell.TargetSpellReplacesBonusTree

GetMaxSpellStartRecoveryOffset → C_Spell.GetSpellQueueWindow

GetSpellQueueWindow → C_Spell.GetSpellQueueWindow

GetSchoolString → C_Spell.GetSchoolString