Patch 10.0.2/API changes

• GameTooltip related APIs have been significantly overhauled. Refer to the Tooltip Changes section for more details.
• Many bag container related APIs have been moved to the namespace. Additionally, some of these functions now return structured tables instead of multiple values.
• A new general-purpose function has been added for mapping a unit GUID to a unit token.

• 10.0.2 TOC:
• Diffs: wow-ui-source, BlizzardInterfaceResources
• Official patch notes: Dragonflight Pre-Expansion Phase 2 Update Notes

frames no longer expose native methods for retrieving or populating tooltip contents. Instead, a new C_TooltipInfo namespace has been added which provides APIs for retrieving structured data for use in tooltips and a new set of tooltip-related mixins have been added to populate tooltips from these APIs.

Any addons that are creating GameTooltip frames should now ensure they inherit GameTooltipTemplate. This template has been updated to include the new GameTooltipDataMixin mixin, which provides automatic updates of tooltip contents from the event as well as a subset of backwards-compatible methods for retrieving or populating tooltip contents from the new C_TooltipInfo APIs.

The C_TooltipInfo functions can be used to replace existing tooltip scanning techniques, removing the need to create a tooltip frame. The following example will demonstrate extracting information for a unit tooltip on the player.

> Tooltip Type: 2 (Enum.TooltipDataType.Unit) > Unit GUID: "Player-4184-00227A8F" > Unit Name: "Sandse" > Unit Info: "Level 70 Gnome Mage (Player)" > Unit Faction: "Alliance"

The dump below has been significantly shortened to only show the fields written by TooltipUtil.SurfaceArgs.

tooltipData = { type = 2, lines = { [1] = { leftText = "Sandse", leftColor = { r = 1, g = 0.81960791349411, b = 0 }, type = 2, unitToken = "player", }, [2] = { leftColor = { r = 1, g = 1, b = 1 }, type = 0, leftText = "Level 70 Gnome Mage (Player)", }, [3] = { leftColor = { r = 1, g = 1, b = 1 }, type = 0, leftText = "Alliance", }, }, guid = "Player-4184-00227A8F", healthGUID = "Player-4184-00227A8F", }

The following GameTooltip script handlers have been removed. This change will not be reflected in the UI XML schema definition until a future patch.

Usages of these script handlers should be replaced by registering callbacks with the new TooltipDataProcessor.AddTooltipPostCall function. Note that callbacks registered with this mechanism are global and will be triggered for all tooltips which inherit from GameTooltipTemplate.

+ ret 1: <font color="#00b400">perkInfos - ret 1: <font color="#ff6767">perkIDs + ret 4: <font color="#00b400">isActivitySet + arg 5: <font color="#00b400">orderID + ret 2: <font color="#00b400">alwaysShowUnowned - ret 2: <font color="#ff6767">alwaysHideUnowned + ret 2: <font color="#00b400">skillLineAbilityID + arg 3: <font color="#00b400">skillLineAbilityID + arg 4: <font color="#00b400">overrideQualityID # arg 1: <font color="#ecbc2a">recipeID, Nilable: false -> true

+ 2: <font color="#00b400">isTool + 1: <font color="#00b400">readyCheckInfo - 1: <font color="#ff6767">roleQueueInfo + 1: <font color="#00b400">readyCheckInfo - 1: <font color="#ff6767">roleQueueInfo + 1: <font color="#00b400">isScrapping

Enum.BattlePetSpeciesFlags + 17: <font color="#00b400">NoWildPetAddsAllowed Enum.BattlepetDbFlags + 11: <font color="#00b400">AcquiredViaLicense Enum.CurrencyDestroyReason + 12: <font color="#00b400">FulfillCraftingOrder Enum.CurrencySource + 57: <font color="#00b400">CraftingOrder + 58: <font color="#00b400">CatalystBalancing + 59: <font color="#00b400">CatalystCraft + 60: <font color="#00b400">ProfessionInitialAward + 61: <font color="#00b400">PlayerTraitRefund Enum.GraphicsValidationResult + 30: <font color="#00b400">LegacyUnsupported + 31: <font color="#00b400">Dx11Unsupported + 33: <font color="#00b400">RemoteDesktopUnsupported Enum.NavigationState + 4: <font color="#00b400">Disabled Enum.ProfTraitPerkNodeFlags + 2: <font color="#00b400">IsMajorBonus Enum.UIItemInteractionFlags + 5: <font color="#00b400">AddCurrency + 6: <font color="#00b400">UsesCharges Enum.UIWidgetTextSizeType + 1: <font color="#00b400">Small12Pt + 2: <font color="#00b400">Medium16Pt + 3: <font color="#00b400">Large24Pt + 4: <font color="#00b400">Huge27Pt + 5: <font color="#00b400">Standard14Pt + 6: <font color="#00b400">Small10Pt + 7: <font color="#00b400">Small11Pt + 8: <font color="#00b400">Medium18Pt + 9: <font color="#00b400">Large20Pt - 1: <font color="#ff6767">Small - 2: <font color="#ff6767">Medium - 3: <font color="#ff6767">Large - 4: <font color="#ff6767">Huge - 5: <font color="#ff6767">Standard Enum.UIWidgetVisualizationType + 26: <font color="#00b400">TextWithSubtext

AreaPOIInfo + 10: <font color="#00b400">factionID + 11: <font color="#00b400">isPrimaryMapForPOI + 12: <font color="#00b400">isAlwaysOnFlightmap CharCustomizationChoice + 7: <font color="#00b400">isLocked + 8: <font color="#00b400">lockedText - 7: <font color="#ff6767">showLocked - 8: <font color="#ff6767">lockedTooltip CraftingCurrencyResultData + 3: <font color="#00b400">operationID + 4: <font color="#00b400">firstCraftReward + 5: <font color="#00b400">showCurrencyText - 3: <font color="#ff6767">associatedItemGUID CraftingItemResultData + 12: <font color="#00b400">operationID + 13: <font color="#00b400">firstCraftReward - 12: <font color="#ff6767">associatedItemGUID CraftingOperationInfo + 13: <font color="#00b400">guaranteedCraftingQualityID CraftingOrderCustomerOptionInfo + 9: <font color="#00b400">qualityIlvlBonuses + 10: <font color="#00b400">craftingQualityIDs # 13: <font color="#ecbc2a">level, Nilable: false -> true CraftingReagentSlotSchematic + 8: <font color="#00b400">orderSource EncounterJournalItemInfo + 13: <font color="#00b400">displayAsVeryRare + 14: <font color="#00b400">displayAsExtremelyRare ItemInteractionFrameInfo + 12: <font color="#00b400">slotTooltip MajorFactionData + 6: <font color="#00b400">unlockDescription + 7: <font color="#00b400">unlockOrder QuestInfo + 10: <font color="#00b400">useMinimalHeader TextureAndTextRowVisualizationInfo # 3: <font color="#ecbc2a">textSizeType, Type: UIWidgetTextSizeType -> UIWidgetTextureAndTextSizeType TradeSkillRecipeInfo + 18: <font color="#00b400">skillLineAbilityID TraitDefinitionInfo + 7: <font color="#00b400">subType