Displaying item tooltip to the right of profession window.

Eommus · 05-24-17, 09:59 AM

Hi,

I am building a simple addon that will display the tooltip of the output item of a recipe to the right top of the profession window, when that recipe is clicked in the profession window recipes list. The tooltip will be sticky, I mean when the recipe is clicked, the tooltip will be displayed and stay there until the profession window is closed. Please see below image:

http://imgur.com/xY8t682

I was able to get the output item ID on recipe click, display the (empty) frame on recipe click (I tested it with a simple button frame) and hide the frame with "profession window close" using the following:

Lua Code:

local f = CreateFrame("?", "tooltip", UIParent, "?")
f:Hide()
 
hooksecurefunc(TradeSkillFrame.RecipeList, "OnRecipeButtonClicked", function(self, ...)
    local itemId = C_TradeSkillUI.GetRecipeItemLink(TradeSkillFrame.RecipeList.selectedRecipeID):match("item:(%d+):")
    if itemId ~= nil then -- some enchanting recipes show recipe spell instead of item
        f:Show()
    end
end)
 
TradeSkillFrame:HookScript("OnHide", function()
    f:Hide()
end)

I just need to actually create the frame to display the item tooltip as described above. I don't know what frame type and template I should use (tooltip? simpleHTML?), also I don't know how to populate the frame via item info.

Thanks for any tips and ideas.

MunkDev · 05-24-17, 10:20 AM

Lua Code:

local tooltip = CreateFrame('GameTooltip', nil, UIParent, 'GameTooltipTemplate')

Documentation (although outdated):
http://wowprogramming.com/docs/widgets/GameTooltip

Try:

Lua Code:

tooltip:SetHyperlink(link)

Or:

Lua Code:

tooltip:SetItemByID(itemID)

You also have to set the owner of the tooltip to get it to anchor and display correctly.

Lua Code:

tooltip:SetOwner(self, 'ANCHOR_RIGHT')

Eommus · 05-24-17, 11:16 AM

@MunkDev Thank you, I feel I am on the right track. I now have:

Lua Code:

local f = CreateFrame("GameTooltip", "tooltip", UIParent, "GameTooltipTemplate")
f:SetOwner(self, "ANCHOR_RIGHT")
f:Hide()
 
hooksecurefunc(TradeSkillFrame.RecipeList, "OnRecipeButtonClicked", function(self, ...)
    local itemId = C_TradeSkillUI.GetRecipeItemLink(TradeSkillFrame.RecipeList.selectedRecipeID):match("item:(%d+):")
    if itemId ~= nil then -- some enchanting recipes show recipe spell instead of item
        f:SetItemByID(itemId)
        f:Show()
    end
end)
 
TradeSkillFrame:HookScript("OnHide", function()
    f:Hide()
end)

Which doesn't display anything at all. Not sure which part I am doing wrong.

Kanegasi · 05-24-17, 11:51 AM

That self on the second line is nil. You need to set the owner as TradeSkillFrame.

MunkDev · 05-24-17, 01:42 PM

I also suggest not naming your tooltip just "tooltip". It doesn't imply where it's coming from if you ever intend to release the addon you're working on.

Ketho · 05-24-17, 04:08 PM

Original thread for reference

http://www.mmo-champion.com/threads/...dow-is-clicked

Eommus · 05-24-17, 10:45 PM

Thank you all for the tips. I was able to finish it just the way I wanted and also published it, in case others might need the same thing. It will definitely save me a lot of time and mouse moving in the long term, while crafting.

https://mods.curse.com/addons/wow/26...n-item-tooltip

Originally Posted by MunkDev

I also suggest not naming your tooltip just "tooltip". It doesn't imply where it's coming from if you ever intend to release the addon you're working on.

Thanks, I changed it. But, to understand it better, can you elaborate why "it doesn't imply where it's coming from" is important? Is it related to debugging while many addons are installed?

Kanegasi · 05-25-17, 04:49 AM

It is good Lua practice to give global variables unique names. In WoW, the same goes for frame names of any kind. For example, if I were to create a frame, register some events, and then open the addon EventTracker, I will see that frame's name listed under the events. I believe Blizzard's included etrace also shows some frame names if they cause too much CPU off an event.

Even if no one ever finds your frame in any debug situation, frame names are global and someone else may have used "tooltip" as well. Something as simple as "TradeSkillItemTooltip" will do.

MunkDev · 05-25-17, 05:48 AM

In an environment where people run all kinds of combinations of addons together that may range from robustly designed to pure garbage, it's always wise to scope and name your own code properly so it doesn't conflict with anything else.

I can give you a concrete example of this. In one of my addons, I'm using a hook on CreateFrame to scan and cache frames that have specific names to add compatibility for other mods. I received a bug report that indicated that my code was trying to compare the "name" parameter of CreateFrame with a number. Now, normally you would either omit the name parameter altogether and therefore it would be nil, or you would provide a string name. Some other addon was just sending a simple number as the frame name, causing my code to break.

In this case, it was bad practice to just give the frame a number as its name, since all frame names are stored as globals and it also doesn't say anything about which addon it belongs to. Let's say someone wanted to expand on your concept by adding additional details to the tooltip if your addon is running simultaneously, (such as a genuine all-purpose tooltip addon). How would they find your custom tooltip?

Ketho · 05-25-17, 08:37 AM

It's undocumented but you can just use GameTooltip.SetRecipeResultItem, instead of getting the Item Id for in GameTooltip.SetItemByID

Lua Code:

function TradeSkillDetailsMixin:OnResultMouseEnter(resultButton)
    if self.selectedRecipeID then
        GameTooltip:SetOwner(resultButton, "ANCHOR_RIGHT");
        GameTooltip:SetRecipeResultItem(self.selectedRecipeID);
        CursorUpdate(resultButton);
    end
    
    resultButton.UpdateTooltip = resultButton.UpdateTooltip or function(owner) self:OnResultMouseEnter(owner); end;
end

This can be shortened to this

Lua Code:

TradeSkillFrame:HookScript("OnHide", function()
    f:Hide()
end)

Lua Code:

TradeSkillFrame:HookScript("OnHide", f.Hide)

Haven't tested your addon, but is the OnHide hook actually needed if you can just parent your tooltip to the TradeSkillFrame?

Code:

local f = CreateFrame("GameTooltip", "ProfessionItemtooltip", TradeSkillFrame, "GameTooltipTemplate")

Ketho · 05-25-17, 08:38 AM

Originally Posted by Kanegasi

Even if no one ever finds your frame in any debug situation, frame names are global and someone else may have used "tooltip" as well. Something as simple as "TradeSkillItemTooltip" will do.

Originally Posted by MunkDev

In an environment where people run all kinds of combinations of addons together that may range from robustly designed to pure garbage, it's always wise to scope and name your own code properly so it doesn't conflict with anything else.

The horror... https://www.townlong-yak.com/globe/wut/#q:tooltip

Kanegasi · 05-25-17, 09:26 AM

Originally Posted by Ketho

The horror... https://www.townlong-yak.com/globe/wut/#q:tooltip

Oh my god. This is powerful. How long has this addon code search tool been around?

Edit: I searched for underscore. Appalling.

**Seerah** · 05-25-17, 10:28 AM

Originally Posted by Ketho

The horror... https://www.townlong-yak.com/globe/wut/#q:tooltip

/bookmarks

Eommus · 05-26-17, 01:08 AM

Originally Posted by Kanegasi

frame names are global and someone else may have used "tooltip" as well.

Originally Posted by MunkDev

it's always wise to scope and name your own code properly so it doesn't conflict with anything else.

Thanks, that's enough to know.

Originally Posted by Ketho

Lua Code:

function TradeSkillDetailsMixin:OnResultMouseEnter(resultButton)
    if self.selectedRecipeID then
        GameTooltip:SetOwner(resultButton, "ANCHOR_RIGHT");
        GameTooltip:SetRecipeResultItem(self.selectedRecipeID);
        CursorUpdate(resultButton);
    end
    
    resultButton.UpdateTooltip = resultButton.UpdateTooltip or function(owner) self:OnResultMouseEnter(owner); end;
end

I didn't quite understand what the above code does. If it is possible, could you explain what each line does? I like using code I understand, so that I can modify it when needed.

Originally Posted by Ketho

Haven't tested your addon, but is the OnHide hook actually needed if you can just parent your tooltip to the TradeSkillFrame?

Code:

local f = CreateFrame("GameTooltip", "ProfessionItemtooltip", TradeSkillFrame, "GameTooltipTemplate")

Thanks, changed the parent and removed the OnHide hook. Works fine.

Ketho · 05-26-17, 06:44 AM

Originally Posted by Eommus

I didn't quite understand what the above code does. If it is possible, could you explain what each line does? I like using code I understand, so that I can modify it when needed.

It's the reference code from the Blizzard FrameXML. If you clicked the "GameTooltip.SetRecipeResultItem" link in my previous post you would have known that...
https://github.com/Gethe/wow-ui-sour...tails.lua#L376

Originally Posted by Kanegasi

How long has this addon code search tool been around?

No idea, but I saw Foxlit post it in #wowuidev sometimes
http://infobot.rikers.org/%23wowuidev/20160617.html.gz

Eommus · 05-26-17, 07:52 AM

Originally Posted by Ketho

It's the reference code from the Blizzard FrameXML. If you clicked the "GameTooltip.SetRecipeResultItem" link in my previous post you would have known that...
https://github.com/Gethe/wow-ui-sour...tails.lua#L376

I had clicked that link and studied that and other files of Blizzard earlier. But as a newbie, it is hard for me to figure out what a code block does by looking at it. For example, I didn't understand what resultButton is, when OnResultMouseEnter is fired, what CursorUpdate does etc. Anyway, thanks for all the tips.

I believe I am done with this addon at this time.

MunkDev · 05-26-17, 08:40 AM

Originally Posted by Eommus

But as a newbie, it is hard for me to figure out what a code block does by looking at it. For example, I didn't understand what resultButton is, when OnResultMouseEnter is fired, what CursorUpdate does etc. Anyway, thanks for all the tips.

Even as a seasoned developer, you don't always intuitively know how something works just by looking at an isolated piece of code. The important part is to know how to figure out how it works. If you have the source code downloaded, make sure you're using an editor that allows you to search for code in multiple files. You can usually figure out how something works by tracing the function calls either backwards or forwards depending on where you start.

In this case, it would have been a good idea to find out where the TradeSkillDetailsMixin is used and from where the function OnResultMouseEnter is called. That would have given you an answer what the variable resultButton actually is.

If you know how to track the function calls, you can easily find out how anything in the Lua implementation of the UI works.