Patch 2.5.1/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

• TOC: 20501
• Diffs: wow-ui-source, BlizzardInterfaceResources
• Deprecated APIs: Deprecated_2_5_1.lua
• Community patch notes: 2.5.1 Consolidated UI Changes

Global API

Added (301)

Removed (38)

AcceptArenaTeam AcceptSockets ArenaTeamDisband ArenaTeamInviteByName ArenaTeamLeave ArenaTeamRoster ArenaTeamSetLeaderByName ArenaTeamUninviteByName BuyArenaCharter C_AchievementInfo.GetRewardItemID C_AchievementInfo.GetSupercedingAchievements C_AchievementInfo.IsValidAchievement C_AchievementInfo.SetPortraitTexture C_ActionBar.IsHarmfulAction C_ActionBar.IsHelpfulAction C_ChatInfo.SwapChatChannelsByChannelIndex C_Commentator.AssignPlayersToTeamInCurrentInstance C_Commentator.AssignPlayersToTeam C_Commentator.AssignPlayerToTeam C_Commentator.FindSpectatedUnit C_Commentator.FindTeamNameInCurrentInstance C_Commentator.FindTeamNameInDirectory C_Commentator.FlushCommentatorHistory C_Commentator.GetCommentatorHistory C_Commentator.GetIndirectSpellID C_Commentator.GetMatchDuration C_Commentator.GetOrCreateSeries C_Commentator.GetPlayerAuraInfoByUnit C_Commentator.GetPlayerAuraInfo C_Commentator.GetPlayerCooldownInfoByUnit C_Commentator.GetPlayerData C_Commentator.GetPlayerFlagInfoByUnit C_Commentator.GetPlayerSpellChargesByUnit C_Commentator.GetTeamColorByUnit C_Commentator.GetTeamColor C_Commentator.GetTrackedSpellID C_Commentator.GetTrackedSpellsByUnit C_Commentator.GetTrackedSpells C_Commentator.GetUnitData C_Commentator.IsTrackedSpellByUnit C_Commentator.IsTrackedSpell C_Commentator.ResetSeriesScores C_Commentator.ResetSettings C_Commentator.SetCommentatorHistory C_Commentator.SetRequestedDebuffCooldowns C_Commentator.SetSeriesScores C_Commentator.SetSeriesScore C_CurrencyInfo.GetCurrencyInfoFromLink C_CurrencyInfo.GetCurrencyInfo C_CVar.GetCVarBitfield C_CVar.GetCVarBool C_CVar.GetCVarDefault C_CVar.GetCVar C_CVar.RegisterCVar C_CVar.ResetTestCVars C_CVar.SetCVarBitfield C_CVar.SetCVar C_DateAndTime.AdjustTimeByDays C_DateAndTime.AdjustTimeByMinutes C_DateAndTime.CompareCalendarTime C_DateAndTime.GetCalendarTimeFromEpoch C_DateAndTime.GetCurrentCalendarTime C_DateAndTime.GetSecondsUntilDailyReset C_DateAndTime.GetSecondsUntilWeeklyReset C_DateAndTime.GetServerTimeLocal C_EquipmentSet.AssignSpecToEquipmentSet C_EquipmentSet.CanUseEquipmentSets C_EquipmentSet.ClearIgnoredSlotsForSave C_EquipmentSet.CreateEquipmentSet C_EquipmentSet.DeleteEquipmentSet C_EquipmentSet.EquipmentSetContainsLockedItems C_EquipmentSet.GetEquipmentSetAssignedSpec C_EquipmentSet.GetEquipmentSetForSpec C_EquipmentSet.GetEquipmentSetIDs C_EquipmentSet.GetEquipmentSetID C_EquipmentSet.GetEquipmentSetInfo C_EquipmentSet.GetIgnoredSlots C_EquipmentSet.GetItemIDs C_EquipmentSet.GetItemLocations C_EquipmentSet.GetNumEquipmentSets C_EquipmentSet.IgnoreSlotForSave C_EquipmentSet.IsSlotIgnoredForSave C_EquipmentSet.ModifyEquipmentSet C_EquipmentSet.PickupEquipmentSet C_EquipmentSet.SaveEquipmentSet C_EquipmentSet.UnassignEquipmentSetSpec C_EquipmentSet.UnignoreSlotForSave C_EquipmentSet.UseEquipmentSet C_GamePad.ApplyConfigs C_GamePad.AxisIndexToConfigName C_GamePad.ButtonBindingToIndex C_GamePad.ButtonIndexToBinding C_GamePad.ButtonIndexToConfigName C_GamePad.DeleteConfig C_GamePad.GetActiveDeviceID C_GamePad.GetAllConfigIDs C_GamePad.GetAllDeviceIDs C_GamePad.GetCombinedDeviceID C_GamePad.GetConfig C_GamePad.GetDeviceMappedState C_GamePad.GetDeviceRawState C_GamePad.IsEnabled C_GamePad.SetConfig C_GamePad.StickIndexToConfigName C_GossipInfo.GetCustomGossipDescriptionString C_GossipInfo.GetPoiForUiMapID C_GossipInfo.GetPoiInfo C_GuildInfo.CanEditOfficerNote C_GuildInfo.CanViewOfficerNote C_GuildInfo.GetGuildTabardInfo C_GuildInfo.GuildRoster C_GuildInfo.IsGuildOfficer C_GuildInfo.QueryGuildMembersForRecipe C_Item.GetStackCount C_Item.LockItemByGUID C_Item.UnlockItemByGUID C_ItemSocketInfo.CompleteSocketing C_ItemUpgrade.GetItemHyperlink C_LFGInfo.CanPlayerUseGroupFinder C_LFGInfo.CanPlayerUseLFD C_LFGInfo.CanPlayerUseLFR C_LFGInfo.CanPlayerUsePremadeGroup C_LFGInfo.CanPlayerUsePVP C_LFGInfo.ConfirmLfgExpandSearch C_LFGInfo.GetAllEntriesForCategory C_LFGInfo.GetLFDLockStates C_LFGInfo.GetRoleCheckDifficultyDetails C_LFGInfo.HideNameFromUI C_Loot.IsLegacyLootModeEnabled C_LossOfControl.GetActiveLossOfControlDataByUnit C_LossOfControl.GetActiveLossOfControlDataCountByUnit C_LossOfControl.GetActiveLossOfControlDataCount C_LossOfControl.GetActiveLossOfControlData C_PartyInfo.ConfirmLeaveParty C_PlayerInfo.GUIDIsPlayer C_PlayerInfo.UnitIsSameServer C_PvP.GetArenaCrowdControlInfo C_PvP.IsInBrawl C_PvP.RequestCrowdControlSpell C_QuestLog.IsQuestFlaggedCompleted C_QuestSession.CanStart C_QuestSession.CanStop C_QuestSession.Exists C_QuestSession.GetAvailableSessionCommand C_QuestSession.GetPendingCommand C_QuestSession.GetProposedMaxLevelForSession C_QuestSession.GetSessionBeginDetails C_QuestSession.GetSuperTrackedQuest C_QuestSession.HasJoined C_QuestSession.HasPendingCommand C_QuestSession.RequestSessionStart C_QuestSession.RequestSessionStop C_QuestSession.SendSessionBeginResponse C_QuestSession.SetQuestIsSuperTracked C_RaidLocks.IsEncounterComplete C_Reputation.GetFactionParagonInfo C_Reputation.IsFactionParagon C_Reputation.RequestFactionParagonPreloadRewardData C_ScriptedAnimations.GetAllScriptedAnimationEffects C_SocialRestrictions.IsMuted C_SocialRestrictions.IsSilenced C_SocialRestrictions.IsSquelched C_StableInfo.GetNumActivePets C_StableInfo.GetNumStablePets C_TaskQuest.DoesMapShowTaskQuestObjectives C_TaskQuest.GetQuestInfoByQuestID C_TaskQuest.GetQuestLocation C_TaskQuest.GetQuestProgressBarInfo C_TaskQuest.GetQuestsForPlayerByMapID C_TaskQuest.GetQuestTimeLeftMinutes C_TaskQuest.GetQuestTimeLeftSeconds C_TaskQuest.GetQuestZoneID C_TaskQuest.GetThreatQuests C_TaskQuest.GetUIWidgetSetIDFromQuestID C_TaskQuest.IsActive C_TaskQuest.RequestPreloadRewardData C_Texture.GetAtlasInfo C_ToyBoxInfo.ClearFanfare C_ToyBoxInfo.NeedsFanfare C_UserFeedback.SubmitBug C_UserFeedback.SubmitSuggestion C_VoiceChat.GetMasterVolumeScale C_VoiceChat.SetMasterVolumeScale CanAutoSetGamePadCursorControl CanGamePadControlCursor ClassicExpansionAtLeast ClearAllTracking ClearFocus ClickSocketButton CloseArenaTeamRoster ClosePetitionRegistrar CloseSocketInfo DeclineArenaTeam DestroyTotem DoesItemContainSpec FocusUnit GetArenaTeamGdfInfo GetArenaTeamIndexBySize GetArenaTeamRosterInfo GetArenaTeamRosterSelection GetArenaTeamRosterShowOffline GetArenaTeam GetArmorPenetration GetClassicExpansionLevel GetClassInfo GetCraftCooldown GetCraftNumMade GetCraftRecipeLink GetCritChanceFromAgility GetCurrentArenaSeason GetCurrentTitle GetDailyQuestsCompleted GetDifficultyInfo GetDungeonDifficultyID GetExistingSocketInfo GetExistingSocketLink GetExpertisePercent GetExpertise GetInspectArenaTeamData GetItemChildInfo GetItemGem GetItemSpecInfo GetLegacyRaidDifficultyID GetMaxDailyQuests GetNewSocketInfo GetNewSocketLink GetNumArenaOpponents GetNumArenaTeamMembers GetNumClasses GetNumSockets GetNumTitles GetNumTrackingTypes GetPetitionItemPrice GetPreviousArenaSeason GetQuestLogGroupNum GetQuestLogRewardHonor GetQuestLogRewardTitle GetQuestResetTime GetRaidDifficultyID GetRewardHonor GetRewardTitle GetServerExpansionLevel GetSocketItemBoundTradeable GetSocketItemInfo GetSocketItemRefundable GetSocketTypes GetSpellCritChanceFromIntellect GetSuggestedGroupNum GetTalentLink GetTitleName GetTotemCannotDismiss GetTrackingInfo GetTradeSkillRecipeLink GetUnitHealthRegenRateFromSpirit GetUnitManaRegenRateFromSpirit HasBoundGemProposed HasFilledPetition IsActiveBattlefieldArena IsArenaSeasonActive IsArenaSkirmish IsArenaTeamCaptain IsBattlefieldArena IsBindingForGamePad IsFlyableArea IsFlying IsGamePadCursorControlEnabled IsGamePadFreelookEnabled IsInArenaTeam IsLeftMetaKeyDown IsLegacyDifficulty IsMetaKeyDown IsRightMetaKeyDown IsTitleKnown JoinArena JoinSkirmish MuteSoundFile QuestIsDaily RequeueSkirmish SaveBindings SetArenaTeamRosterSelection SetArenaTeamRosterShowOffline SetCurrentTitle SetDungeonDifficultyID SetGamePadCursorControl SetGamePadFreeLook SetLegacyRaidDifficultyID SetMoveEnabled SetPendingReportArenaTeamName SetRaidDifficultyID SetTracking SetTurnEnabled ShouldKnowUnitHealth SocketContainerItem SocketInventoryItem SortArenaTeamRoster TurnInArenaPetition UnitCastingInfo UnitChannelInfo UnitNameUnmodified UnmuteSoundFile UpdateWindow

AcceptLevelGrant AttemptToSaveBindings C_Commentator.GetPlayerInfo C_Commentator.GetTeamHighlightColor C_Commentator.GetTrackedDefensiveCooldowns C_Commentator.GetTrackedOffensiveCooldowns C_Commentator.GetUnitTeamIndex C_Commentator.IsTrackedDefensiveCooldown C_Commentator.IsTrackedOffensiveCooldown C_DateAndTime.GetDateFromEpoch C_DateAndTime.GetTodaysDate C_DateAndTime.GetYesterdaysDate C_GossipInfo.GetGossipPoiForUiMapID C_GossipInfo.GetGossipPoiInfo C_LossOfControl.GetEventInfo C_LossOfControl.GetNumEvents C_RecruitAFriend.CheckEmailEnabled C_RecruitAFriend.GetRecruitInfo C_RecruitAFriend.IsSendingEnabled C_RecruitAFriend.SendRecruit CanEditOfficerNote CanViewOfficerNote CloseGuildRegistrar DeclineLevelGrant GetCVarBitfield GetCVarBool GetCVarDefault GetCVar GetNumStablePets GrantLevel GuildRoster IsQuestFlaggedCompleted RegisterCVar ResetTestCvars SetCVarBitfield SetCVar SwapChatChannelByLocalID UnitWeaponAttackPower

Widgets

Added (36)

Removed (8)

Region:AdjustPointsOffset Region:ClearPointByName Region:ClearPointsOffset Region:GetPointByName Region:GetScaledRect Region:IsAnchoringRestricted FontString:SetFixedColor AnimationGroup:SetPlaying Animation:SetPlaying Frame:DesaturateHierarchy Frame:EnableGamePadButton Frame:EnableGamePadStick Frame:HasFixedFrameLevel Frame:HasFixedFrameStrata Frame:IsGamePadButtonEnabled Frame:IsGamePadStickEnabled Frame:RotateTextures Frame:SetDrawLayerEnabled Frame:SetFixedFrameLevel Frame:SetFixedFrameStrata Button:RegisterForMouse Cooldown:SetCountdownAbbrevThreshold Cooldown:SetCountdownFont EditBox:ClearHighlightText GameTooltip:SetExistingSocketGem GameTooltip:SetGuildBankItem GameTooltip:SetSocketGem GameTooltip:SetSocketedItem GameTooltip:SetTotem SimpleHTML:GetTextData ModelSceneActor:GetParticleOverrideScale ModelSceneActor:SetParticleOverrideScale Scripts Frame OnGamePadButtonDown Frame OnGamePadButtonUp Frame OnGamePadStick Model OnAnimStarted

Frame:EnableJoystick Frame:GetBackdrop Frame:GetBackdropBorderColor Frame:GetBackdropColor Frame:IsJoystickEnabled Frame:SetBackdrop Frame:SetBackdropBorderColor Frame:SetBackdropColor

Events

Added (33)

Removed (9)

ADAPTER_LIST_CHANGED ARENA_COOLDOWNS_UPDATE ARENA_CROWD_CONTROL_SPELL_UPDATE ARENA_OPPONENT_UPDATE ARENA_REGISTRAR_CLOSED ARENA_REGISTRAR_SHOW ARENA_REGISTRAR_UPDATE ARENA_SEASON_WORLD_STATE ARENA_TEAM_INVITE_REQUEST ARENA_TEAM_ROSTER_UPDATE ARENA_TEAM_UPDATE AZERITE_EMPOWERED_ITEM_LOOTED COMMENTATOR_HISTORY_FLUSHED COMMENTATOR_RESET_SETTINGS COMMENTATOR_TEAM_NAME_UPDATE COMMENTATOR_TEAMS_SWAPPED CURRENCY_DISPLAY_UPDATE GX_RESTARTED LOSS_OF_CONTROL_COMMENTATOR_ADDED LOSS_OF_CONTROL_COMMENTATOR_UPDATE OBLITERUM_FORGE_CLOSE OBLITERUM_FORGE_PENDING_ITEM_CHANGED OBLITERUM_FORGE_SHOW PLAYER_FOCUS_CHANGED PLAYER_MAX_LEVEL_UPDATE PLAYER_STARTED_LOOKING PLAYER_STARTED_TURNING PLAYER_STOPPED_LOOKING PLAYER_STOPPED_TURNING SHOW_LOOT_TOAST_LEGENDARY_LOOTED SHOW_LOOT_TOAST_UPGRADE SHOW_PVP_FACTION_LOOT_TOAST SHOW_RATED_PVP_REWARD_TOAST

LEVEL_GRANT_PROPOSED PARTY_REFER_A_FRIEND_UPDATED RECRUIT_A_FRIEND_CAN_EMAIL RECRUIT_A_FRIEND_INVITATION_FAILED RECRUIT_A_FRIEND_INVITER_FRIEND_ADDED RECRUIT_A_FRIEND_SYSTEM_STATUS SOR_BY_TEXT_UPDATED SOR_COUNTS_UPDATED SOR_START_EXPERIENCE_INCOMPLETE

CVars

Added (116)

Removed (32)

AIProcessDebugger AuraDebugger autoDismountFlying autoDismount autoStand autoRangedCombat autoUnshift BehaviorTree cacaoBilateralSimilarityDistanceSigma Collision CursorCenteredYPos CursorFreelookCentering CursorFreelookStartDelta CursorStickyCentering doodadLodScale DriverVersionCheck dynamicLod enableRefHistory ffxLingeringVenari ffxVenari floatingCombatTextCombatHealing ForceAllowAero ForceResolutionDefaultToMaxSize fstack_showanchors fstack_showhidden fstack_showregions GamePadAbbreviatedBindingReverse GamePadCameraPitchSpeed GamePadCameraYawSpeed GamePadCursorAutoDisableJump GamePadCursorAutoDisableSticks GamePadCursorAutoEnable GamePadCursorCenteredEmulation GamePadCursorCentering GamePadCursorLeftClick GamePadCursorOnLogin GamePadCursorRightClick GamePadCursorSpeedAccel GamePadCursorSpeedMax GamePadCursorSpeedStart GamePadEmulateAlt GamePadEmulateCtrl GamePadEmulateEsc GamePadEmulateShift GamePadEnable GamePadFaceMovementThreshold GamePadForceXInput GamePadSingleActiveID GamePadSmoothFacing GamePadStickAxisButtons GamePadTankTurnSpeed graphicsSpellDensity graphicsTextureFiltering gxMTAlphaM2 gxMTBeginDraw gxMTDisable gxMTOpaqueM2NoReflect gxMTOpaqueM2 gxMTOpaqueWMO gxMTPrepass gxMTShadow gxMTTerrain GxPrismEnabled HardwareCursor HealHandler horizonClip lodObjectSizeScale MouseNoRepositioning MouseUseLazyRepositioning particulatesEnabled Pathing PhaseHistory PlayerSpawnTracking PreventOsIdleSleep RAIDdoodadLodScale raidGraphicsSpellDensity RAIDhorizonClip RAIDParticulatesEnabled RAIDshadowRt RAIDspellClutter RAIDTerrainLodDiv ResolvedSSAOType screenshotSizeOverride seenAlliedRaceUnlocks seenLevelSquishPopup shadowRt SpawnRegion SpellOverrides SpellTargeting SSAOType targetFPS teleportMaxNoLoadDist TerrainLodDiv videoOptionsVersionDefault vrsParticles vrsWorldGeo wmoPortalMinScreenSize worldEntityLinkMode worldPreloadNonCriticalTimeout worldViewCullMaxJobs Commands D3D11_LEGACY D3D11 D3D12 DefragmentGPU enable GamePadListDevices GetSwapChainSize GetWindowSize GxIsPrism GxLogFlush GxLogFullGPUInfo SetGraphicsQuality SetGraphicsQualityRAID TakeScreenshot ToggleWindowMode UpdateWindow

doodadLodDist graphicsTextureFiltering gxFixLag gxTripleBuffer lodTerrainDiv M2UseLOD mtParticles raidGraphicsTextureFiltering RAIDSSAOBlur RAIDtextureFilteringMode rawMouseValidationMultiplier SSAOBlur SSAODistance terrainAlphaBitDepth terrainHoles textureErrorColors useNewConsole worldPoolUsage Commands AppendLogToFile bgcolor consolelines default DumpSoundKits font GxToggleWindowMode highlightcolor linecount perf proportionaltext ResetChallengeMode settings spacing