Tooltip hook stopped working in latest patch?

[Yocote]

Is anyone aware of any changes in how tooltip hooking works in yesterday's DragonFlight patch (2022-10-04, patch 45969)? One of my addons that adds a few lines to item tooltips has unexpecetdly stopped working (it worked in earlier dragonflight beta patches). Has there been a change? Or alternatively, can anyone show a minimalistic example of addon code that adds a line to an item tooltip?

[Fizzlemizz]

Tooltips have been reworked with C_TooltipInfo but, from what I've read so far, if your tooltip uses "GameTooltipTemplate" instead of "SharedTooltipTemplate" you should be (mostly) OK... for the time being.

The info hasn't been added to WowPedia yet which is understandable being new and all.

[Yocote]

Thanks for the info! I am not creating my own tooltip though, but adding extra lines to the system "GameTooltip" (and a few related ones), using code similar to this to hook in my code:

local tooltips = {
  GameTooltip,
  ItemRefTooltip,
  ShoppingTooltip1,
  ShoppingTooltip2,
}
 
function events:PLAYER_LOGIN()
  for i=1,#tooltips do
    tooltips[i]:HookScript("OnTooltipSetItem", function(tt)
      MyTooltipAddon:ProcessTip(tt)
    end)
  end
end

What I observe is that my "MyTooltipAddon:ProcessTip" method is no longer being called at all since this patch. The hooking code in the PLAYER_LOGIN event handler is called, and no errors are raised there, but the hooks are just never called, as if HookScript silently no longer does anything anymore.

[Gello]

I've found OnTooltipSetItem is not being called for GameTooltip as I'd expect. GameTooltip's SetCurrencyToken continues to work as expected. Unfortunately I've not had time to look into this more beyond acknowledging that was a problem. Looks like you use that too.

[Xrystal]

As per Gello's response... 10.0 PTR has OnTooltipSetItem exists but on 10.0 Beta it doesn't in the ItemRef.xml file.

[Fizzlemizz]

Presumably the PTR will get the Beta code at some stage before launch, but as it's new there maybe more things to come to match the differences between the two for at least a period before full deprecation.

[Xrystal]

Yeah, there are definitely things in flux .. Container file also has differences between PTR and Beta. So I have had to withhold any changes there as I can't fully test it yet. The Container changes are kicking up errors with nUI but not pointing to which line in nUI is causing the problem. So could be a regular error rather than an addon error .. or .. similar to the options and editmode changes, they just don't like addons interfering with frames they want to work with :chuckle:

[Yocote]

Originally Posted by Gello I've found OnTooltipSetItem is not being called for GameTooltip as I'd expect. GameTooltip's SetCurrencyToken continues to work as expected. Unfortunately I've not had time to look into this more beyond acknowledging that was a problem. Looks like you use that too.

Looking at Interface/FrameXML/GameTooltip.xml in https://github.com/Gethe/wow-ui-sour...eb0ac4e2343e35 , it seems that <OnTooltipSetItem> indeed was removed from the <Scripts> section of GameTooltip in this latest patch. Now I wonder if that means that the main tooltip no longer can be hooked in any way ...

[Fizzlemizz]

It means there's more to "unpack" from the latest changes and possibly more changes to come... must be getting close to launch

[Xrystal]

Originally Posted by Fizzlemizz It means there's more to "unpack" from the latest changes and possibly more changes to come... must be getting close to launch

Somethings happening or something is horribly wrong .. PTR Servers are still down ( I checked Over 20 hours ago ). And the update for Retail is in a loop.

Edit: Well the update finally kicked in just now. But PTR servers are still down.

[Rilgamon]

local function ResetItem2(tooltip)
    print("ResetItem")
end
 
local function SetItem2(tooltip)
    local tooltipData = tooltip:GetTooltipData()
    if(tooltipData and tooltipData.id and tooltipData.type == 0) then -- type -> 0 = item, 1 = spell 
        print("SetItem", tooltipData.type, tooltipData.id)
        tooltip:AddLine('Test')
        GameTooltip_CalculatePadding(tooltip)
    end
end
 
hooksecurefunc(GameTooltip, "Show",SetItem2)
hooksecurefunc(GameTooltip, "Hide",ResetItem2)
--GameTooltip:HookScript("OnShow", SetItem2)
--GameTooltip:HookScript("OnHide", ResetItem2)

I'm looking into this, too because of my items addon. I can change the tooltip and add a line. With hooksecure my function is called multiple times a second and the line is added 1-3 times for a tooltip (3 times when I hover over one of the bags in the bagbar, 2 times mostly for items). With HookScript its called only once but the tooltip is changed back after my line shows up for a split second. Not so promising I really hope someone has a good guide how this is meant to work in the future

[Fizzlemizz]

Docs have been updated.

[sirpucna]

is the pre patch using a old version of wow compared to the beta?
Retail Pre-Patch: 46313
Current Beta: 46259

Seems many of the old Tooltip handlers are still used whereas the new ones suggested for beta dont work
So just ended up doing this:

if TooltipDataProcessor then
	TooltipDataProcessor.AddTooltipPostCall(Enum.TooltipDataType.Unit, TooltipSetUnit)
else
	GameTooltip:HookScript("OnTooltipSetUnit", TooltipSetUnit)
end

[LudiusMaximus]

Is there still a way to do a pre-hook on what used to be OnTooltipSetItem?

I want to operate on the tooltip of items before any other addons added their lines to it.
Before 10.0.2 I executed this code (a few seconds after login, to make sure that all other addons have already registered):

local OtherScripts = GameTooltip:GetScript("OnTooltipSetItem")
local function RunOtherScripts(self, ...)
  if OtherScripts then
    return OtherScripts(self, ...)
  else
    return
  end
end
 
GameTooltip:SetScript("OnTooltipSetItem", function(self, ...)
 
  -- Do my stuff with the untouched tooltip.
 
  -- Then let the other addons append their lines.
  return RunOtherScripts(self, ...)
end)

How could the same effect be achieved with the new TooltipDataProcessor?

[LudiusMaximus]

Originally Posted by LudiusMaximus Is there still a way to do a pre-hook on what used to be OnTooltipSetItem?

I just found out that there is also a `TooltipDataProcessor.AddTooltipPreCall`, which seems to let you do stuff to the tooltip before any other addons have done their modifications.

[SDPhantom]

Other addons can also register with that function and there's no guarantee that your code would run first. Nor is there a way to force it without causing taint, which is more of an issue now that the new TooltipDataHandler is capable of handling secure code.

[LudiusMaximus]

That's true. Thanks for pointing it out.
In fact, it seems that the registered functions are executed in the order they have been registered. So it is not possible to make sure you are first by waiting with the registration.

local startupFrame = CreateFrame("Frame")
startupFrame:RegisterEvent("PLAYER_LOGIN")
startupFrame:SetScript("OnEvent", function(self, event, ...)
 
  TooltipDataProcessor.AddTooltipPreCall(Enum.TooltipDataType.Item, function(self)
    print("Registered first.")
  end)
  
  C_Timer.After(3.0, function()
    TooltipDataProcessor.AddTooltipPreCall(Enum.TooltipDataType.Item, function(self)
      print("Registered after 3 seconds.")
    end)
  end)
  
  C_Timer.After(5.0, function()
    TooltipDataProcessor.AddTooltipPreCall(Enum.TooltipDataType.Item, function(self)
      print("Registered after 5 seconds.")
    end)
  end)
  
end)

Printed result is:
Registered first.
Registered after 3 seconds.
Registered after 5 seconds.

[SDPhantom]

Originally Posted by LudiusMaximus In fact, it seems that the registered functions are executed in the order they have been registered.

Indeed. The functions are registered by table.insert() and iterated with ipairs().

[Xrystal]

I have a similar problem in nUI now that I have reinstated its action bars back to service.

nUI adds Keybinding info to the action button tooltip which of course no longer displays permanently due to the tooltip changes I presume.

Now, looking at your findings I tried to do something similar but it has gone belly up.

In PLAYER_LOGIN I have the following block of code - amongst other code

for i in pairs( nUI_ButtonBars.Bars ) do
    local bar = nUI_ButtonBars.Bars[i];
    for row in pairs( bar.Buttons ) do
        for col in pairs( bar.Buttons[row] ) do
            local button      = bar.Buttons[row][col];
            local key1, key2  = GetBindingKey( "CLICK "..button:GetName()..":LeftButton" );
 
            TooltipDataProcessor.AddTooltipPostCall(Enum.TooltipDataType.Spell, function(self)
                if key1 then GameTooltip:AddLine( nUI_L["Key Binding"].." 1: |cFF00FFFF"..GetBindingText( key1, "KEY_" ).."|r", 1, 1, 1 ); end
                if key2 then GameTooltip:AddLine( nUI_L["Key Binding"].." 2: |cFF00FFFF"..GetBindingText( key2, "KEY_" ).."|r", 1, 1, 1 ); end                                  
                if not key1 and not key2 then GameTooltip:AddLine( nUI_L["No key bindings found"], 1, 1, 1 ); end
                 GameTooltip:AddLine( nUI_L["<ctrl-alt-right click> to change bindings"], 0, 1, 1 );                                        
            end)
 
            button:SetScript( "OnEnter", function()
                if nUI_Options.combat_tooltips or not InCombatLockdown() then
                    button:SetTooltip()
                    -- Old Code used to be here
                    GameTooltip:Show();
                end
            end );
        end
    end
end

All but the TooltipDataProcessor open and close lines were already in the code, but initially inside the OnEnterScript.

It worked fine before Dragonflight but now inside OnEnter it briefly shows but then disappears, and outside OnEnter it shows a ton of lines running down the screen. Instead of the 1-4 I am expecting per button.

Anyone have any ideas on how I would get it working like before ?

Thanks in advance.


edit:
I also tried creating my own tooltip as follows:
local tooltip = CreateFrame("GameTooltip",nil,button,"GameTooltipTemplate")
And using this instead of GameTooltip but no difference.

[SDPhantom]

The problem with registering with TooltipDataProcessor.AddTooltipPostCall() is it's a global register. This means it'll call the function every time anything wishes to display a spell's tooltip. Not just the individual button you're working with.

For example, someone mouseovers a spell in their spellbook and every instance of that function for every button you've created will run sequentially for that single tooltip.



I wouldn't suggest this approach as it would impact performance if everyone would start doing it this way, but here's an attempt to fix your code example.

local nUI_ButtonCache = {};
 
TooltipDataProcessor.AddTooltipPostCall(TooltipDataProcessor.AllTypes, function(self)
    local owner = self:GetOwner();
    if nUI_ButtonCache[owner] then
        local key1, key2 = GetBindingKey(("CLICK %s:LeftButton"):format( owner:GetName() ));
        if key1 then self:AddLine(("%s 1: |cFF00FFFF%s|r"):format( nUI_L["Key Binding"], GetBindingText( key1, "KEY_" )), 1, 1, 1 ); end
        if key2 then self:AddLine(("%s 1: |cFF00FFFF%s|r"):format( nUI_L["Key Binding"], GetBindingText( key2, "KEY_" )), 1, 1, 1 ); end
        if not (key1 or key2) then self:AddLine( nUI_L["No key bindings found"], 1, 1, 1 ); end
        self:AddLine( nUI_L["<ctrl-alt-right click> to change bindings"], 0, 1, 1 );
    end
end);
 
for _, bar in pairs( nUI_ButtonBars.Bars ) do
    for _, row in pairs( bar.Buttons ) do
        for _, button in pairs( row ) do
            nUI_ButtonCache[button] = true;
            button:SetScript( "OnEnter", function()
                if nUI_Options.combat_tooltips or not InCombatLockdown() then
                    button:SetTooltip()
                    -- Old Code used to be here
                    GameTooltip:Show();
                end
            end);
        end
    end
end

As noted earlier, TooltipDataProcessor.AddTooltipPostCall() is a global register, so I reduced its handler to a single function. I registered it with the TooltipDataProcessor.AllTypes enum, which is a special flag that tells the processor to call the handler for every tooltip type. The handler is called with the tooltip being processed and its associated raw data table. We can query its owner with :GetOwner() and check if it's one of our buttons. If it is, we can proceed with posting its keybind info.