How can I do this without causing a taint?

Folji · 04-11-16, 07:58 AM

Hiya!

So I've managed to get the bottom action bars working like this.

But, unfortunately, it's causing combat taints. Any changes to the bars and it gets blocked, which is a huge problem whenever exiting a vehicle while still in combat.

The frame hierarchy pretty much goes like this:

Code:

MultiBarHolder
	MultiBarLeft
		MultiBarBottomLeftButton1..12
	MultiBarRight
		MultiBarBottomRightButton1..12

So essentially I've got a holder frame containing two frames, anchored to the left and right respectively of the holder frame. And then those two frames contain the bottom left and bottom right action buttons respectively. I have a single handler function that handles everything on that bottom bar; the action bars, the xp/rep bars, all of it. And it runs whenever a related event fires (visibility of the action bars, faction watch status, XP update, etc.) with no real issue. Except for this part here;

Lua Code:

if VisibleLeft and VisibleRight then
    ns.MultiBarHolder:SetHeight(40)
    ns.MultiBarHolder:SetWidth((458*2))
elseif VisibleLeft or VisibleRight then
    ns.MultiBarHolder:SetHeight(40)
    ns.MultiBarHolder:SetWidth(460)
else
    ns.MultiBarHolder:SetHeight(1)
    ns.MultiBarHolder:SetWidth(460)
end

I'm not even touching the action bars, or the frames they're sitting on. I'm changing the height and width of the holder frame it's all anchored to, and for some reason that causes the code to freak out. I tried to log the taint, and this section was the culprit, every single time. So I'm guessing that I need to handle this frame's sizing securely somehow?

MunkDev · 04-11-16, 08:10 AM

You can't resize or mess with any secure frames in combat in response to an event. You can, however, use macro conditionals to alter the behavior of your action bar. See code below for example:

Lua Code:

local Bar = CreateFrame("Frame", barName, UIParent, "SecureHandlerStateTemplate")
RegisterStateDriver(Bar, "visibility", "[petbattle][vehicleui] hide; show") -- hide the bar if SecureCmdOptionParse returns true for petbattle or vehicleui, else show

Your holder frame automatically becomes protected when you anchor secure frames to it. Moving or altering the holder frame insecurely also makes changes to where the bars are drawn on screen, which causes your errors.

Regions may be explicitly protected by Blizzard scripts or XML; other regions can become protected by becoming children of protected regions or by being positioned relative to protected regions.

Folji · 04-11-16, 09:10 AM

Yeah, I assumed that was the case, heh. Been trying to figure out just how state handlers and state drivers work, but I really don't seem to be getting it. I mean, I noticed that SecureStateHeaderTemplate has attributes called headwidth and headheight. How am I supposed to be leveraging that?

My first guess was that it'd either be RegisterStateDriver(Bar, "headwidth", "40") or Bar:SetAttribute("headwidth", "40"). But trying it out definitely didn't work. I must be missing something here, or just not getting it.

MunkDev · 04-11-16, 09:41 AM

A state driver is just a macro condition that makes changes to your secure header. State drivers are used for things like action bar paging or modified actions. You can also create custom conditions that fire custom state updates. Here's an example of how that works:

Lua Code:

-- registers a state driver that sends ctrlsh, ctrl, shift or nil depending on modifier(s) held down
RegisterStateDriver(Bar, "modifier", "[mod:ctrl,mod:shift] ctrlsh; [mod:ctrl] ctrl; [mod:shift] shift; nil")
 
-- state drivers fire pre-defined snippets of code in the form of strings attached to the header with a dedicated attribute
-- the attribute is "_onstate-XXX" for a given state driver.
Bar:SetAttribute("_onstate-modifier", [[ 
    -- change the "modifier" attribute on all children of the header to the new modifier value
    control:ChildUpdate("modifier", newstate)
]])

Likewise, you may do something like this to change the size in response to a macro condition:

Lua Code:

RegisterStateDriver(Bar, "override", "[petbattle][vehicleui] minimize; maximize")
 
Bar:SetAttribute("_onstate-override", [[
    if newstate == "minimize" then
        self:SetHeight(40)
    elseif newstate == "maximize" then
        self:SetHeight(60)
    end
]])

...or this to show a custom target button when the target exists:

Lua Code:

local MyTargetFrame = CreateFrame("Button", "MyTargetFrame", UIParent, "SecureActionButtonTemplate, SecureHandlerStateTemplate")
MyTargetFrame:SetAttribute("type", "unit")
MyTargetFrame:SetAttribute("unit", "target")
RegisterStateDriver(MyTargetFrame, "unitexists", "[@target,exists,nodead] true; nil")
 
MyTargetFrame:SetAttribute("_onstate-unitexists", [[
    if newstate then
        self:Show()
    else
        self:Hide()
    end
]])

Although the last bit can be simplified by using RegisterUnitWatch.

If you explain exactly what you're trying to do and provide the current code you're using, I'll be able to supply a working solution.

lightspark · 04-11-16, 09:42 AM

So, do you want to change your bar width/height at will, or do you change it, when some specific even fires or something happens, like you get into vehicle and so on?

-- updated

Whatevs, MunkDev explained possible scenarios quite well

Folji · 04-11-16, 10:04 AM

Alright, sweet, think I'm starting to get it now!

But essentially, in my actionbars.lua file I'm creating a holder frame for the action bars.

Lua Code:

ns.MultiBarHolder = CreateFrame("Frame","MultiBarHolder",MainMenuBar,"SecureHandlerStateTemplate")
ns.MultiBarHolder:SetPoint("BOTTOM",MainMenuBar,"BOTTOM",0,29)

And this frame essentially contains two more frames, MultiBarLeft and MultiBarRight, both of which are filled with the MultiBarBottomLeft/Right action buttons. And this part is perfectly fine, they're static frames anchored inside of the holder frame, and there's nothing happening to them.

Then there's this function, located inside bottomframe.lua, that works as a visibility handler for the bottom chunk of the UI. It scales the bottom frame based on what's in it, like it shows in the GIF at the top, and it runs on events updating experience and reputation, upon login, OnHide and OnShow for the game's default MultiBarBottom frames, so pretty much anything that affects the visibility of its contents.

Lua Code:

local function BottomElementsHandler()
 
        -- Checking button visibility on their original container frames
        local VisibleLeft = MultiBarBottomLeft:IsVisible()
        local VisibleRight = MultiBarBottomRight:IsVisible()
        local RepVisible = ns.Reputation:IsShown()
        local ExpVisible = ns.Experience:IsShown()
        local BarWidth = 483
        local BarHeight = 11
 
        -- Visibility handling for the MultiBars
            if VisibleLeft and VisibleRight then
                ns.MultiBarHolder:SetHeight(40)
                ns.MultiBarHolder:SetWidth((458*2))
            elseif VisibleLeft or VisibleRight then
                ns.MultiBarHolder:SetHeight(40)
                ns.MultiBarHolder:SetWidth(460)
            else
                ns.MultiBarHolder:SetHeight(1)
                ns.MultiBarHolder:SetWidth(460)
            end
 
        -- Visibility for the MultiBar art
        if VisibleLeft or VisibleRight then
            ns.MultiBarRightArt:Show()
            ns.MultiBarLeftArt:Show()
        else
            ns.MultiBarRightArt:Hide()
            ns.MultiBarLeftArt:Hide()
        end
 
        -- Set width for the statusbars
        if (ns.MultiBarHolder:GetWidth() > 500) then
            BarWidth = ns.MultiBarHolder:GetWidth()+4
        else
            BarWidth = 464
        end
 
        -- Set the anchor points of the Exp and Rep bars
        if RepVisible and ExpVisible then
            ns.ExpRepHolder:SetHeight(BarHeight)
            ns.Reputation:SetPoint("RIGHT",ns.ExpRepHolder,"RIGHT")
            ns.Reputation:SetPoint("LEFT",ns.ExpRepHolder,"CENTER")
            ns.Experience:SetPoint("LEFT",ns.ExpRepHolder,"LEFT")
            ns.Experience:SetPoint("RIGHT",ns.ExpRepHolder,"CENTER")
        elseif RepVisible or ExpVisible then
            ns.ExpRepHolder:SetHeight(BarHeight)
            ns.Reputation:SetPoint("LEFT",ns.ExpRepHolder,"LEFT")
            ns.Reputation:SetPoint("RIGHT",ns.ExpRepHolder,"RIGHT")
            ns.Experience:SetPoint("LEFT",ns.ExpRepHolder,"LEFT")
            ns.Experience:SetPoint("RIGHT",ns.ExpRepHolder,"RIGHT")
        else
            ns.ExpRepHolder:SetHeight(1)
        end
 
        ns.ExpRepHolder:SetWidth(BarWidth)
 
        MicroBarTexture:SetWidth(ns.MultiBarHolder:GetWidth()+4)
 
        LeftEdgeArt:SetPoint("TOPRIGHT",ns.ExpRepHolder,"TOPLEFT",83,28)
        RightEdgeArt:SetPoint("TOPLEFT",ns.ExpRepHolder,"TOPRIGHT",-83,28)
 
 
    end

And it's really just the visibility for the MultiBarHolder, on line 12 - 21, that screws up. It should be doing exactly the same thing, set its own width and height based on the visibility of its two child frames, and that is pretty much the extent of it.

MunkDev · 04-11-16, 10:10 AM

What do you use to change VisibleLeft and VisibleRight? You should definitely not keep these lines in this function. You have to move all the adjustments to the secure parts of your holder frame into the restricted environment.

Folji · 04-11-16, 10:19 AM

There's nothing changing them, aside from in that function. It just gets :IsVisible() on line 4 and 5, so that I don't have to do a full MultiBarBottomSomething:IsVisible() every on every if/else check, and the reason why is really just because it was the easiest way to find the visibility of those frames. When I looked through the settings lua files in the game source I couldn't find any global relating to the visibility of these frames, or whether or not these options were checked, so I decided to leave the original MultiBarBottom frames present but empty so that I can check their visibility directly!

MunkDev · 04-11-16, 10:38 AM

Lol, my bad for not reading every line. Here's something that should work:

Lua Code:

ns.MultiBarHolder = CreateFrame("Frame","MultiBarHolder",MainMenuBar,"SecureHandlerBaseTemplate, SecureHandlerShowHideTemplate, SecureHandlerStateTemplate")
ns.MultiBarHolder:SetPoint("BOTTOM",MainMenuBar,"BOTTOM",0,29)
 
-- Set frame ref so they can be retrieved securely.
ns.MultiBarHolder:SetFrameRef("MultiBarBottomLeft", MultiBarBottomLeft)
ns.MultiBarHolder:SetFrameRef("MultiBarBottomRight", MultiBarBottomRight)
 
-- store the bars as global values in the holder's secure environment
ns.MultiBarHolder:Execute([[
    -- anytime you execute something on the holder frame, these variables are available "globally"
    MultiBarBottomLeft = self:GetFrameRef("MultiBarBottomLeft") 
    MultiBarBottomRight = self:GetFrameRef("MultiBarBottomRight")
 
    -- also store the holder frame as something that won't be overwritten by locals
    Holder = self
]])
 
local VisibilitySnippet = [[
    -- self refers to the calling frame in this snippet, so use Holder to get the holder frame
    -- this is still within the holder frame's secure environment though!
 
    Holder:RunAttribute("UpdateVisibility")
]]
 
ns.MultiBarHolder:WrapScript(MultiBarBottomLeft, "OnShow", VisibilitySnippet)
ns.MultiBarHolder:WrapScript(MultiBarBottomRight, "OnShow", VisibilitySnippet)
ns.MultiBarHolder:WrapScript(MultiBarBottomLeft, "OnHide", VisibilitySnippet)
ns.MultiBarHolder:WrapScript(MultiBarBottomRight, "OnHide", VisibilitySnippet)
 
ns.MultiBarHolder:SetAttribute("UpdateVisibility", [[
    local VisibleLeft = MultiBarBottomLeft:IsVisible()
    local VisibleRight = MultiBarBottomRight:IsVisible()
 
    if VisibleLeft and VisibleRight then
        self:SetSize(458 * 2, 40)
    elseif VisibleLeft or VisibleRight then
        self:SetSize(460, 40)
    else
        self:SetSize(460, 1)
    end
]])
 
--Update the visibility when the holder is shown/hidden
ns.MultiBarHolder:SetAttribute("_onshow", ns.MultiBarHolder:GetAttribute("UpdateVisibility"))
ns.MultiBarHolder:SetAttribute("_onhide", ns.MultiBarHolder:GetAttribute("UpdateVisibility"))
 
local function BottomElementsHandler()
 
    -- Checking button visibility on their original container frames
    local VisibleLeft = MultiBarBottomLeft:IsVisible()
    local VisibleRight = MultiBarBottomRight:IsVisible()
    local RepVisible = ns.Reputation:IsShown()
    local ExpVisible = ns.Experience:IsShown()
    local BarWidth = 483
    local BarHeight = 11
 
    -- Visibility handling for the MultiBars
    -- if VisibleLeft and VisibleRight then
    --     ns.MultiBarHolder:SetHeight(40)
    --     ns.MultiBarHolder:SetWidth((458*2))
    -- elseif VisibleLeft or VisibleRight then
    --     ns.MultiBarHolder:SetHeight(40)
    --     ns.MultiBarHolder:SetWidth(460)
    -- else
    --     ns.MultiBarHolder:SetHeight(1)
    --     ns.MultiBarHolder:SetWidth(460)
    -- end
 
    -- Visibility for the MultiBar art
    if VisibleLeft or VisibleRight then
        ns.MultiBarRightArt:Show()
        ns.MultiBarLeftArt:Show()
    else
        ns.MultiBarRightArt:Hide()
        ns.MultiBarLeftArt:Hide()
    end
 
    -- Set width for the statusbars
    if (ns.MultiBarHolder:GetWidth() > 500) then
        BarWidth = ns.MultiBarHolder:GetWidth()+4
    else
        BarWidth = 464
    end
 
    -- Set the anchor points of the Exp and Rep bars
    if RepVisible and ExpVisible then
        ns.ExpRepHolder:SetHeight(BarHeight)
        ns.Reputation:SetPoint("RIGHT",ns.ExpRepHolder,"RIGHT")
        ns.Reputation:SetPoint("LEFT",ns.ExpRepHolder,"CENTER")
        ns.Experience:SetPoint("LEFT",ns.ExpRepHolder,"LEFT")
        ns.Experience:SetPoint("RIGHT",ns.ExpRepHolder,"CENTER")
    elseif RepVisible or ExpVisible then
        ns.ExpRepHolder:SetHeight(BarHeight)
        ns.Reputation:SetPoint("LEFT",ns.ExpRepHolder,"LEFT")
        ns.Reputation:SetPoint("RIGHT",ns.ExpRepHolder,"RIGHT")
        ns.Experience:SetPoint("LEFT",ns.ExpRepHolder,"LEFT")
        ns.Experience:SetPoint("RIGHT",ns.ExpRepHolder,"RIGHT")
    else
        ns.ExpRepHolder:SetHeight(1)
    end
 
    ns.ExpRepHolder:SetWidth(BarWidth)
 
    MicroBarTexture:SetWidth(ns.MultiBarHolder:GetWidth()+4)
 
    LeftEdgeArt:SetPoint("TOPRIGHT",ns.ExpRepHolder,"TOPLEFT",83,28)
    RightEdgeArt:SetPoint("TOPLEFT",ns.ExpRepHolder,"TOPRIGHT",-83,28)
 
end

Folji · 04-11-16, 11:52 AM

Huh, so that's how it all fits together? Don't know if I would've figured that out on my own, heh!

Can't quite seem to get it working, though. Think it's the VisibilitySnippet part that doesn't run, for some reason?

MunkDev · 04-11-16, 12:08 PM

Hard to debug without having access to the full code, but you could try forcing an update by adding this at the end:

Lua Code:

ns.MultiBarHolder:Show()

Are you not getting any errors?

Folji · 04-11-16, 12:22 PM

I could put the source online, if you'd like to have a look at the whole of it!

But no errors, no. Tried circumventing the VisibilitySnippet by just putting the RunAttribute() right into the end of the WrapScript() like ns.MultiBarHolder:WrapScript(MultiBarBottomLeft, "OnShow", 'Holder:RunAttribute("UpdateVisibility")'), but that didn't seem to get me anywhere. Same situation without any errors.

Also tried to straight-up do MultiBarBottomLeft:SetScript("OnShow", VisibilitySnippet), which of course returns the expected usage of SetScript and the fact that it's expecting a function and getting what I'm guessing is a string?

EDIT: Here's a dropbox link to the project. https://www.dropbox.com/s/84p8ac0weg...estUI.zip?dl=0

I should really find an actual name for it soon, haha. And maybe put it up on my Github instead.

MunkDev · 04-11-16, 01:00 PM

The secure environment doesn't allow direct functions. All script snippets are strings that are compiled on the fly, which means you can't sneak information in there inside combat. I've been doing some probing, and it seems that the multibars always return false when :IsVisible is used securely. The snippets don't run because the bars themselves don't actually trigger any OnShow or OnHide script. I'm not sure why.

MunkDev · 04-11-16, 01:21 PM

Okay, I managed to get it working by creating two separate dummy frames and anchoring them to each bar. Why I had to do this is beyond me, but at least the thing is triggering correctly now.

Lua Code:

ns.probeLeft = CreateFrame("Frame", nil, MultiBarBottomLeft, "SecureHandlerBaseTemplate")
ns.probeRight = CreateFrame("Frame", nil, MultiBarBottomRight, "SecureHandlerBaseTemplate")
 
ns.MultiBarHolder:SetFrameRef("MultiBarBottomLeft", ns.probeLeft)
ns.MultiBarHolder:SetFrameRef("MultiBarBottomRight", ns.probeRight)

Here's the modified zip. Hope I didn't screw up your formatting too much since it seems we're using different editors.

https://www.dropbox.com/s/wbh5t8ndu5...estUI.zip?dl=0

Btw, you can discard my old feedback about the look of the art. It looks better in person without screenshot compression.

Folji · 04-11-16, 01:33 PM

Really? Yikes. They've really locked the secure environment down tight, huh?

Thanks a whole lot for the help with this, Munk! Don't think I would've figured it out on my own, not by simply staring at the documentation, haha. And now that I've seen how secure state handlers and state drivers work, it'll be a lot easier to implement conditional visibility later! Woo!

MunkDev · 04-11-16, 01:46 PM

The secure environment normally works just fine, without these issues. I'm using a very similar approach to completely replace the spell flyout and that works without fault. It's just the implementation of the action bars are really jacked into everything. I guess this is the reason most action bar replacements resort to using community-created libs and just stuff the default bars into a hidden frame. They are pretty annoying to deal with compared to creating your own bars.

Folji · 04-11-16, 02:01 PM

Heheh yeah, I've noticed that a lot of the older game code at least, the core GUI elements. There's a lot of moments where you never know when you're going to encounter a hardcoded function call overriding whatever you're trying to do with the core elements. So you either have to override it completely or try a long-winding workaround!

Resike · 04-11-16, 02:48 PM

Whats that execute snippet is good for? You should be able to call the GetFrameRef function in any secure environemnt, also self is a valid frame reference to the handler itself. Or is it only to minimalize the number of GetFrameRef calls?

MunkDev · 04-11-16, 03:42 PM

Originally Posted by Resike

Whats that execute snippet is good for? You should be able to call the GetFrameRef function in any secure environemnt, also self is a valid frame reference to the handler itself. Or is it only to minimalize the number of GetFrameRef calls?

In that context, self will be overwritten and refer to the wrapped frame, which is why the explicit Holder is there. And yes, they are simply globally defined in that environment to remove a bunch of GetFrameRef calls. This is not at all necessary, just makes the code more readable.

Resike · 04-15-16, 01:56 PM

Originally Posted by MunkDev

In that context, self will be overwritten and refer to the wrapped frame, which is why the explicit Holder is there. And yes, they are simply globally defined in that environment to remove a bunch of GetFrameRef calls. This is not at all necessary, just makes the code more readable.

Well me likey everything which can reduce call times. Gonna use it from now.