Hyperlink Tooltip Help

cokedrivers · 12-31-14, 08:36 PM

This code has been around for a while and (first found it with NeavUI) but it seems to wrk for most item links except battle pets is there something im missing? Does a battle pet link have it own link style?

In this first image you will notice the mouseover is working. ( I also have fstack enabled to see what the difference in links are)

In this second image I linked a battle pet in the "say" channel and no tooltip. (again fstack is enabled)

Here is the current code I am using:

Code:

		local _G = getfenv(0)
		local orig1, orig2 = {}, {}
		local GameTooltip = GameTooltip

		local linktypes = {
			achievement  = true,
			enchant      = true,
			glyph        = true,
			item         = true,
			instancelock = true,
			quest        = true,
			spell        = true,
			talent       = true,
			unit         = true,
		}

		local function OnHyperlinkEnter(frame, link, ...)
			local linktype = link:match('^([^:]+)')
			if (linktype and linktypes[linktype]) then
				GameTooltip:SetOwner(ChatFrame1, 'ANCHOR_CURSOR', 0, 20)
				GameTooltip:SetHyperlink(link)
				GameTooltip:Show()
			else
				GameTooltip:Hide()
			end

			if (orig1[frame]) then 
				return orig1[frame](frame, link, ...) 
			end
		end

		local function OnHyperlinkLeave(frame, ...)
			GameTooltip:Hide()

			if (orig2[frame]) then 
				return orig2[frame](frame, ...) 
			end
		end

		local function EnableItemLinkTooltip()
			for _, v in pairs(CHAT_FRAMES) do
				local chat = _G[v]
				if (chat and not chat.URLCopy) then
					orig1[chat] = chat:GetScript('OnHyperlinkEnter')
					chat:SetScript('OnHyperlinkEnter', OnHyperlinkEnter)

					orig2[chat] = chat:GetScript('OnHyperlinkLeave')
					chat:SetScript('OnHyperlinkLeave', OnHyperlinkLeave)
					chat.URLCopy = true
				end
			end
		end
		hooksecurefunc('FCF_OpenTemporaryWindow', EnableItemLinkTooltip)
		EnableItemLinkTooltip()

I noticed in the code that linktypes does not have battlepet or any reference to pets so im thinking that might be my issue but what name would I use to get this to work?

Thanks
Coke

Phanx · 01-01-15, 12:34 AM

Battle pets have their own tooltip object; they don't use the GameTooltip at all. Battle pet abilities, garrison followers, follower abilities, and missions also have their own tooltips objects. You can see how the default UI handles those here, though really it would be a lot easier to just call the click function on mouseover instead of recreating it:

Code:

chat:HookScript('OnHyperlinkEnter', ChatFrame_OnHyperlinkShow)

If you wanted to filter out certain types of links, and/or not have it treat "mouseover while shift is down" as a shift-click, then this would still be simpler:

Code:

local linktypes = {
	-- These use GameTooltip:
	achievement    = true,
	enchant        = true,
	glyph          = true,
	item           = true,
	instancelock   = true,
	quest          = true,
	spell          = true,
	talent         = true,
	unit           = true,
	-- This uses FloatingBattlePetTooltip:
	battlepet      = true,
	-- This uses FloatingPetBattleAbilityTooltip:
	battlePetAbil = true,
	-- This uses FloatingGarrisonFollowerTooltip:
	garrfollower  = true,
	-- This uses FloatingGarrisonFollowerAbilityTooltip:
	garrfollowerability = true,
	-- This uses FloatingGarrisonMissionTooltip:
	garrmission   = true,
}

local function OnHyperlinkEnter(frame, link, text)
	local linkType = strsplit(":", link)
	if linktypes[linktype] and not IsModifiedClick() then
		ChatFrame_OnHyperlinkShow(frame, link, text, "LeftButton")
	end
end

chat:HookScript('OnHyperlinkEnter', OnHyperlinkEnter)

Remember to update your OnHyperlinkLeave script to also hide those additional tooltip objects.

Also you can just use HookScript instead of manually storing and replacing and calling the original script. If there is no original script then HookScript behaves exactly like SetScript.

cokedrivers · 01-01-15, 09:56 AM

Originally Posted by Phanx

Code:

chat:HookScript('OnHyperlinkEnter', ChatFrame_OnHyperlinkShow)

The above code works when I add it to my "local function ModChat(self)" but the whole point of the "mouseover tooltip is to have it show and hide with mouseover, this shows the tooltip but then you need to click the x to close it.

Originally Posted by Phanx

If you wanted to filter out certain types of links, and/or not have it treat "mouseover while shift is down" as a shift-click, then this would still be simpler:

Code:

local linktypes = {
	-- These use GameTooltip:
	achievement    = true,
	enchant        = true,
	glyph          = true,
	item           = true,
	instancelock   = true,
	quest          = true,
	spell          = true,
	talent         = true,
	unit           = true,
	-- This uses FloatingBattlePetTooltip:
	battlepet      = true,
	-- This uses FloatingPetBattleAbilityTooltip:
	battlePetAbil = true,
	-- This uses FloatingGarrisonFollowerTooltip:
	garrfollower  = true,
	-- This uses FloatingGarrisonFollowerAbilityTooltip:
	garrfollowerability = true,
	-- This uses FloatingGarrisonMissionTooltip:
	garrmission   = true,
}

local function OnHyperlinkEnter(frame, link, text)
	local linkType = strsplit(":", link)
	if linktypes[linktype] and not IsModifiedClick() then
		ChatFrame_OnHyperlinkShow(frame, link, text, "LeftButton")
	end
end

chat:HookScript('OnHyperlinkEnter', OnHyperlinkEnter)

Tried this also and nothing happened no tooltip show or anything.

Originally Posted by Phanx

Remember to update your OnHyperlinkLeave script to also hide those additional tooltip objects.

Again tried this and got nothing.

So this is what I tried and didn't get to work:

Code:

                local _G = getfenv(0)
		local orig1, orig2 = {}, {}

		local linktypes = {
			-- These use GameTooltip:
			achievement    = true,
			enchant        = true,
			glyph          = true,
			item           = true,
			instancelock   = true,
			quest          = true,
			spell          = true,
			talent         = true,
			unit           = true,
			-- This uses FloatingBattlePetTooltip:
			battlepet      = true,
			-- This uses FloatingPetBattleAbilityTooltip:
			battlePetAbil = true,
			-- This uses FloatingGarrisonFollowerTooltip:
			garrfollower  = true,
			-- This uses FloatingGarrisonFollowerAbilityTooltip:
			garrfollowerability = true,
			-- This uses FloatingGarrisonMissionTooltip:
			garrmission   = true,
		}

		local function OnHyperlinkEnter(frame, link, ...)
			
			for _, tooltip in pairs({	
				'GameTooltip',
				'FloatingBattlePetTooltip',
				'FloatingPetBattleAbilityTooltip',
				'FloatingGarrisonFollowerTooltip',
				'FloatingGarrisonFollowerAbilityTooltip',
				'FloatingGarrisonMissionTooltip',			
			}) do
			        local linktype = link:match('^([^:]+)')
			        if (linktype and linktypes[linktype]) then				
					tooltip:SetOwner(ChatFrame1, 'ANCHOR_CURSOR', 0, 20)
					tooltip:SetHyperlink(link)
					tooltip:Show()				
				else
					tooltip:Hide()
				end
			end

			if (orig1[frame]) then 
				return orig1[frame](frame, link, ...) 
			end
		end

		local function OnHyperlinkLeave(frame, ...)
			for _, tooltip in pairs({		
				'GameTooltip',
				'FloatingBattlePetTooltip',
				'FloatingPetBattleAbilityTooltip',
				'FloatingGarrisonFollowerTooltip',
				'FloatingGarrisonFollowerAbilityTooltip',
				'FloatingGarrisonMissionTooltip',			
			}) do
				tooltip:Hide()
			end
			
			if (orig2[frame]) then 
				return orig2[frame](frame, ...) 
			end
		end

		local function EnableItemLinkTooltip()
			for _, v in pairs(CHAT_FRAMES) do
				local chat = _G[v]
				if (chat) then
					orig1[chat] = chat:GetScript('OnHyperlinkEnter')
					chat:HookScript('OnHyperlinkEnter', OnHyperlinkEnter)

					orig2[chat] = chat:GetScript('OnHyperlinkLeave')
					chat:HookScript('OnHyperlinkLeave', OnHyperlinkLeave)
				end
			end
		end
		hooksecurefunc('FCF_OpenTemporaryWindow', EnableItemLinkTooltip)
		EnableItemLinkTooltip()

Am I looking at this totally wrong?

Coke

cokedrivers · 01-01-15, 10:31 AM

so I figured it out (kinda on my own :P)

in Phanx's original code the linkType the T was no capitalized in the function code so it was not finding the table.

Code:

		local linktypes = {
			-- These use GameTooltip:
			achievement    = true,
			enchant        = true,
			glyph          = true,
			item           = true,
			instancelock   = true,
			quest          = true,
			spell          = true,
			talent         = true,
			unit           = true,
			-- This uses FloatingBattlePetTooltip:
			battlepet      = true,
			-- This uses FloatingPetBattleAbilityTooltip:
			battlePetAbil = true,
			-- This uses FloatingGarrisonFollowerTooltip:
			garrfollower  = true,
			-- This uses FloatingGarrisonFollowerAbilityTooltip:
			garrfollowerability = true,
			-- This uses FloatingGarrisonMissionTooltip:
			garrmission   = true,
		}

		local function OnHyperlinkEnter(frame, link, text)
			local linkType = strsplit(":", link)
			if linktypes[linkType] and not IsModifiedClick() then
				ChatFrame_OnHyperlinkShow(frame, link, text, "LeftButton")
			end
		end	
		
		local function OnHyperlinkLeave(frame, link, text)
			local linkType = strsplit(":", link)
			if linktypes[linkType] and not IsModifiedClick() then
				ChatFrame_OnHyperlinkShow(frame, link, text, "LeftButton")
			end
		end		
		
		local function ModChat(self)
			local chat = _G[self]


			chat:HookScript('OnHyperlinkEnter', OnHyperlinkEnter)
			chat:HookScript('OnHyperlinkLeave', OnHyperlinkLeave)
               end

Now mouse over shows and hides.

Coke

Phanx · 01-01-15, 10:47 AM

That works too, but your last attempt didn't work because you were using some awful table-creating Frankenstein instead of the code I posted.

(1) When you use HookScript you should not manually capture and call the original script -- if you do that, it will be called twice, once before your script, and once from inside your script. If the original method toggles something, then calling it twice is like not calling it at all.

(2) You were looping over a list of string values and trying to call frame methods on them. This would generate a Lua error telling you exactly what and where the problem was. I know I've told you before -- go get an error display addon and use it!

(3) Even if you fixed #2, you'd still be attempting to show every tooltip object at the same time, which doesn't even make sense, because...

(4) You'd also be calling methods like SetOwner and SetHyperlink on objects that do not have those methods. Battle pet and garrison related tooltips are not GameTooltip-type objects, and cannot display arbitrary hyperlinks.

cokedrivers · 01-01-15, 11:06 AM

is there a SetPoint I can use to have the tooltip for the hyperlink show above my chatframe instead of above my mainmenubar?

I guess what im asking is were would I put this code:

Code:

	local i
	for i = 1, NUM_CHAT_WINDOWS do
               tooltip:SetPoint("TOP", _G["ChatFrame"..i], 0, 20)
        end

or ami totally off base here?

Coke

cokedrivers · 01-01-15, 11:12 AM

Originally Posted by Phanx

(2) You were looping over a list of string values and trying to call frame methods on them. This would generate a Lua error telling you exactly what and where the problem was. I know I've told you before -- go get an error display addon and use it!

I do have Bugger and Bugsack installed an have them on at all times. I just didn't post the errors because like you posted in [4] it was throwing errors for SetOwner and Hide.

And believe it or not Phanx I listen to everything you have to say on coding, It might not sink in for the first few attempts or tries but in the end all my code seems to have the Phanx Seal of Approval

because it is how you have written it.

Coke

Phanx · 10-27-16, 11:38 PM

Try changing this:

Code:

        local function OnHyperlinkEnter(frame, linkData, link)
            local normal = showLinkType[linkData:match("^(.-):")]

to this:

Code:

        local function OnHyperlinkEnter(frame, link, text)
            local normal = showLinkType[link:match("(%a+):%d+")]

and this:

Code:

        local function OnHyperlinkLeave(frame, linkData, link)
            local normal = showLinkType[linkData:match("^(.-):")]

to this:

Code:

        local function OnHyperlinkLeave(frame, link, text)
            local normal = showLinkType[link:match("(%a+):%d+")]

and both instances of this:

Code:

                SetItemRef(linkData, link, "LeftButton", frame)

to this:

Code:

                SetItemRef(link, text, "LeftButton", frame)

The variable name changes are probably not strictly necessary (just the string.match argument change) but I'm just using the same names and techniques Blizzard is now using so I don't have to load the game client and test anything to figure out what actually changed.

Tonyleila · 10-28-16, 01:20 PM

Thanks for the reply Phanx! I think I made exactly the changes you posted but I still get exactly the same error, so I guess its something different going on here. I also disable all other addons.

Code:

13x LinkHover\LinkHover-1.6.lua:34: attempt to index local 'link' (a nil value)
LinkHover\LinkHover-1.6.lua:34: in function <LinkHover\LinkHover.lua:33>

.........

New code:

Lua Code:

local showLinkType = {
            -- Normal tooltip things:
            achievement  = true,
            enchant      = true,
            glyph        = true,
            item         = true,
            instancelock = true,
            quest        = true,
            spell        = true,
            talent       = true,
            unit         = true,
            currency       = true,
            -- Special tooltip things:
            battlepet           = false,
            battlePetAbil       = false,
            garrfollowerability = false,
            garrfollower        = false,
            garrmission         = false,
        }
         
        local function OnHyperlinkEnter(frame, link, text)
            local normal = showLinkType[link:match("(%a+):%d+")]
            if normal == true then
                GameTooltip:SetOwner(ChatFrame1Tab, "ANCHOR_TOPLEFT", 20, 20)
                GameTooltip:SetHyperlink(link)
                GameTooltip:Show()
            elseif normal == false then
                -- Uses a special tooltip, just let the default function handle it.
                SetItemRef(link, text, "LeftButton", frame)
            end
        end
     
        local function OnHyperlinkLeave(frame, link, text)
            local normal = showLinkType[link:match("(%a+):%d+")]
            if normal == true then
                GameTooltip:Hide()
            elseif normal == false then
                -- Uses a special tooltip, just let the default function handle it.
                SetItemRef(link, text, "LeftButton", frame)
            end
        end
         
        local function RegisterFrame(frame)
            frame:SetScript("OnHyperlinkEnter", OnHyperlinkEnter)
            frame:SetScript("OnHyperlinkLeave", OnHyperlinkLeave)
        end
         
        local f = CreateFrame("Frame")
        f:RegisterEvent("PLAYER_LOGIN")
        f:SetScript("OnEvent", function(self, event, name)
            if event == "PLAYER_LOGIN" then
                for i = 1, NUM_CHAT_WINDOWS do
                    RegisterFrame(_G["ChatFrame"..i])
                end
            end
            if GuildBankMessageFrame then
                RegisterFrame(GuildBankMessageFrame)
                self:UnregisterAllEvents()
                self:SetScript("OnEvent", nil)
                RegisterFrame = nil
            else
                self:RegisterEvent("ADDON_LOADED")
            end
        end)

Phanx · 10-29-16, 02:30 PM

Replace:

Code:

local function OnHyperlinkLeave(frame, link, text)

with:

Code:

local function OnHyperlinkLeave(...)
    return print("OnHyperlinkLeave", ...)

Mouse over a link, then off, then post the printout you get in the chat frame.

Tonyleila · 10-30-16, 07:46 AM

Originally Posted by Phanx

Replace:

Code:

local function OnHyperlinkLeave(frame, link, text)

with:

Code:

local function OnHyperlinkLeave(...)
    return print("OnHyperlinkLeave", ...)

Mouse over a link, then off, then post the printout you get in the chat frame.

That code did not work but I replaced it with this:

Lua Code:

local function OnHyperlinkLeave(...)
            if true then --debug
                return print("OnHyperlinkLeave", ...)
            end
            if normal == true then
                GameTooltip:Hide()
            elseif normal == false then
                -- Uses a special tooltip, just let the default function handle it.
                SetItemRef(link, text, "LeftButton", frame)
            end
        end

and got this chat printout:

Code:

OnHyperlinkLeave table: 00000165D37D7F7

reloaded UI and disabled all addons new chat print:

Code:

OnHyperlinkLeave table: 00000165D35AEEA0

Tested it and it changes ever time.

Phanx · 10-31-16, 04:13 AM

That means it's only receiving the "self" argument, without any information about the link. You'll have to keep track of that yourself:

Code:

        local lastLink, lastText, useGameTooltip

        local function OnHyperlinkEnter(frame, link, text)
            lastLink, lastText, useGameTooltip = link, text, showLinkType[link:match("(%a+):%d+")]
            if useGameTooltip then
                GameTooltip:SetOwner(ChatFrame1Tab, "ANCHOR_TOPLEFT", 20, 20)
                GameTooltip:SetHyperlink(link)
                GameTooltip:Show()
            elseif useGameTooltip == false then
                -- Uses a special tooltip, just let the default function handle it.
                SetItemRef(link, text, "LeftButton", frame)
            end
        end
     
        local function OnHyperlinkLeave(frame)
            if useGameTooltip then
                GameTooltip:Hide()
            elseif useGameTooltip == false then
                -- Uses a special tooltip, just let the default function handle it.
                SetItemRef(lastLink, lastText, "LeftButton", frame)
            end
            lastLink, lastText, lastLinkIsNormal = nil, nil, nil
        end

Green lines are new. Yellow lines are changed. A few lines were removed, too. (On a side note, you can just do "if X then" instead of "if X == true then" if your only need to to make sure X isn't false or nil.)