SecureActionButtonTemplate - stance/form/vehicle

[MunkDev]

The documentation on SecureActionButtonTemplate is pretty vague, and thus far I haven't figured out the behaviour completely. If I want to create a secure button that uses the type attribute "action" to cast spells etc, how can I make it so it'll change action depending on which action page is currently occupying the normal action bar?

Since I couldn't figure it out back then, my current approach is using the click type and assigning it to the actual button on the bar. This approach sucks, because it doesn't work with vehicles and pet battles. It only works with stances, forms and paging.

Here's a basic visible button in the center of the screen for testing:

local btn = CreateFrame("Button", "myButton", UIParent, "SecureActionButtonTemplate, UIMenuButtonStretchTemplate")
btn:SetSize(50,50)
btn:SetPoint("CENTER", 0,0)
btn:SetAttribute("type", "action")
btn:SetAttribute("action", 1)
btn:Show()

Thanks in advance, fellow lua wizards.

[Elkano]

Judging from this code in ActionButton.lua

 function ActionButton_CalculateAction (self, button)
 	if ( not button ) then
 		button = SecureButton_GetEffectiveButton(self);
 	end
 	if ( self:GetID() > 0 ) then
 		local page = SecureButton_GetModifiedAttribute(self, "actionpage", button);
 		if ( not page ) then
 			page = GetActionBarPage();
 			if ( self.isExtra ) then
 				page = GetExtraBarIndex();
 			elseif ( self.buttonType == "MULTICASTACTIONBUTTON" ) then
 				page = GetMultiCastBarIndex();
 			end
 		end
 		return (self:GetID() + ((page - 1) * NUM_ACTIONBAR_BUTTONS));
 	else
 		return SecureButton_GetModifiedAttribute(self, "action", button) or 1;
 	end
 end

I'd say instead of setting the action attribute you'll have to assign an ID.

[MunkDev]

Originally Posted by Elkano I'd say instead of setting the action attribute you'll have to assign an ID.

This:

local btn = CreateFrame("Button", "TestActionButton", UIParent, "SecureActionButtonTemplate, UIMenuButtonStretchTemplate")
btn:SetSize(50,50)
btn:SetPoint("CENTER", 0,0)
btn:SetID(1)
btn:Show()

.. doesn't work. I tried adding the type attribute to this snippet

btn:SetAttribute("type", "action")

.. and this does exactly the same as specifiying an action as an attribute. But it doesn't work with stances/forms.

Edit: I hooked that function to try and find out what's going on:

/run hooksecurefunc("ActionButton_CalculateAction", function(...) local s, b = ...; print(s:GetName(), s:GetID(), (s:GetID() + (GetActionBarPage()-1) * NUM_ACTIONBAR_BUTTONS), SecureButton_GetModifiedAttribute(s, "actionpage", b)) end)

And these are the returns I get:

ActionButton1 1 1 1 -- default ActionButton1 1 1 7 -- cat form ActionButton1 1 1 9 -- bear form TestActionButton 1 1 nil -- regardless of form

Granted, my button doesn't have an "actionpage" attribute. If I assign the actionpage attribute, that attribute is of course static and I can't mess with that in combat. Since Bartender and I'm assuming a whole bunch of addons have vehicle and dynamic actionbars, it must be possible to do what I'm trying to do. How can I update the actionpage attribute in combat?

[kurapica.igas]

Based on the ActionButton_CalculateAction, if you want it act like what you want, you would also control the button's "actionpage" attribute by yourself.

Here is an example to show how to modify the attribute during the combat.

1. Create one manager secure frame to controls the modification.

Manager = CreateFrame("Frame", "MyActionButtonManager", UIParent, "SecureHandlerStateTemplate")
 
-- Init the manager's environment
SecureHandlerExecute(Manager, [[
        MyButtons = newtable()   -- Register buttons in here
 
        -- Define the Main action bar updating snippet
    UpdateMainActionBar = [=[
        local page = ...
        if page == "tempshapeshift" then
            if HasTempShapeshiftActionBar() then
                page = GetTempShapeshiftBarIndex()
            else
                page = 1
            end
        elseif page == "possess" then
            page = Manager:GetFrameRef("MainMenuBarArtFrame"):GetAttribute("actionpage")
            if page <= 10 then
                page = Manager:GetFrameRef("OverrideActionBar"):GetAttribute("actionpage")
            end
            if page <= 10 then
                page = 12
            end
        end
        Manager:SetAttribute("actionpage", page)
 
        for btn in pairs(MyButtons) do
            btn:SetAttribute("actionpage", page)
 
            -- Call btn's Refresh method
            btn:CallMethod("Refresh")
        end
    ]=]
]])

2. Register the manager to state driver to get the action page based on conditions.

-- We can get true action page from those frames.
Manager:SetFrameRef("MainMenuBarArtFrame", MainMenuBarArtFrame)
Manager:SetFrameRef("OverrideActionBar", OverrideActionBar)
 
-- ActionBar swap register
local state = {}
 
-- special using
tinsert(state, "[overridebar][possessbar]possess")
 
-- action bar swap
for i = 2, 6 do
    tinsert(state, ("[bar:%d]%d"):format(i, i))
end
 
-- stance
local _, playerclass = UnitClass("player")
 
if playerclass == "DRUID" then
    -- prowl first
    tinsert(state, "[bonusbar:1,stealth]8")
elseif playerclass == "WARRIOR" then
    tinsert(state, "[stance:2]7")
    tinsert(state, "[stance:3]8")
end
 
-- bonusbar map
for i = 1, 4 do
    tinsert(state, ("[bonusbar:%d]%d"):format(i, i+6))
end
 
-- Fix for temp shape shift bar
tinsert(state, "[stance:1]tempshapeshift")
 
tinsert(state, "1")
 
state = table.concat(state, ";")
 
local now = SecureCmdOptionParse(state)
 
-- Register the init value
Manager:SetAttribute("actionpage", now)
 
Manager:RegisterStateDriver("page", state)
 
Manager:SetAttribute("_onstate-page", [=[
    Manager:Run(UpdateMainActionBar, newstate)
]=])

3. Create those action buttons and register them to the Manager

for i = 1, 12 do
    local btn = CreateFrame("CheckButton", "MyActionButton" .. i, UIParent, "SecureActionButtonTemplate")
    btn:SetID(i)
    btn:SetAttribute("type", "action")
    btn:SetAttribute("actionpage", Manager:GetAttribute("actionpage"))
 
    -- Other init code
        btn.Refresh = function(self)
                -- Do some refresh work based on it's action
        end
 
    -- Register it to the Manager
    Manager:SetFrameRef("NewButton", btn)
    SecureHandlerExecute(Manager, [[
        MyButtons[Manager:GetFrameRef("NewButton")] = true
    ]])
end

It's an example code from my lib file ActionHandler.

I don't have much time to test it, but I think it's enough for your questions.

[Elkano]

This part of ActionBarControler.lua should be what handles switching the bar in the default code:

function ActionBarController_UpdateAll(force)
    PossessBar_Update();
    StanceBar_Update();
    CURRENT_ACTION_BAR_STATE = LE_ACTIONBAR_STATE_MAIN;
    
    -- If we have a skinned vehicle bar or skinned override bar, display the OverrideActionBar
    if ((HasVehicleActionBar() and UnitVehicleSkin("player") and UnitVehicleSkin("player") ~= "")
    or (HasOverrideActionBar() and GetOverrideBarSkin() and GetOverrideBarSkin() ~= "")) then
        -- For now, a vehicle has precedence over override bars (hopefully designers make it so these never conflict)
        if (HasVehicleActionBar()) then
            OverrideActionBar_Setup(UnitVehicleSkin("player"), GetVehicleBarIndex());
        else
            OverrideActionBar_Setup(GetOverrideBarSkin(), GetOverrideBarIndex());
        end
        
        CURRENT_ACTION_BAR_STATE = LE_ACTIONBAR_STATE_OVERRIDE;
    -- If we have a non-skinned override bar of some sort, use the MainMenuBarArtFrame
    elseif ( HasBonusActionBar() or HasOverrideActionBar() or HasVehicleActionBar() or HasTempShapeshiftActionBar() or C_PetBattles.IsInBattle() ) then
        if (HasVehicleActionBar()) then
            MainMenuBarArtFrame:SetAttribute("actionpage", GetVehicleBarIndex());
        elseif (HasOverrideActionBar()) then
            MainMenuBarArtFrame:SetAttribute("actionpage", GetOverrideBarIndex());
        elseif (HasTempShapeshiftActionBar()) then
            MainMenuBarArtFrame:SetAttribute("actionpage", GetTempShapeshiftBarIndex());
        elseif (HasBonusActionBar() and GetActionBarPage() == 1) then
            MainMenuBarArtFrame:SetAttribute("actionpage", GetBonusBarIndex());
        else
            MainMenuBarArtFrame:SetAttribute("actionpage", GetActionBarPage());
        end
        
        for k, frame in pairs(ActionBarButtonEventsFrame.frames) do
            ActionButton_UpdateAction(frame);
        end
    else
        -- Otherwise, display the normal action bar
        ActionBarController_ResetToDefault(force);
    end
    
    ValidateActionBarTransition();
end

The individual ActionButtons are set to use their parent's value, but that'll just save some calls:

self:SetAttribute("useparent-actionpage", true);

Now regarding your problem of updating the attributes on your own frames, using SecureStateDriver and SecureHandlerStateTemplate, like the previous poster also did, is likely the way to go.
However, instead of hardcoding all bar ids like he seems to have done, maybe one can clone Blizzard's code.

Never used the stuff myself though, so the whole things posted were just dug up quickly.

[MunkDev]

Certainly more complicated than I thought it would be. This should suffice.
Just a quick question though and I might be an idiot for asking it; why isn't "Manager" localized?
Thank you very much for this!

[MunkDev]

Thank you kurapica.igas. I managed to get it working using a modified version of the code you provided

[kurapica.igas]

In my action system, I don't really need an existed action bar, so I don't use a use parent attribute.

Localized the Manager is because a blizzard's bug, the "control" may not existed in some condition, but it's a long time ago, I don't know if they fix it.

Since all the snippets are running in the Manager's environment, it's simple to keep a global variable to make sure I can get it everywhere.

[kurapica.igas]

Ah, I forget it in the first part, the first part should be

Manager = CreateFrame("Frame", "MyActionButtonManager", UIParent, "SecureHandlerStateTemplate")
 
-- Init the manager's environment
SecureHandlerExecute(Manager, [[
     Manager = self    -- I forget this, But I think you already found it by yourself
 
        MyButtons = newtable()   -- Register buttons in here
       -- ...
    ]=]
]])

I just extract some code from my files, it's defined in several files, sorry, I missed the important line.

[MunkDev]

Yes, I figured it all out. This is the code I use for my secure buttons and handler now:

function ConsolePort:CreateManager()
    if not ConsolePortManager then
        local m = CreateFrame("Frame", "ConsolePortManager", ConsolePort, "SecureHandlerStateTemplate");
        SecureHandlerExecute(m, [[
            CP_BUTTONS = newtable();
            UpdateMainActionBar = [=[
                local page = ...;
                if page == "tempshapeshift" then
                    if HasTempShapeshiftActionBar() then
                        page = GetTempShapeshiftBarIndex();
                    else
                        page = 1;
                    end
                elseif page == "possess" then
                    page = self:GetFrameRef("MainMenuBarArtFrame"):GetAttribute("actionpage");
                    if page <= 10 then
                        page = self:GetFrameRef("OverrideActionBar"):GetAttribute("actionpage");
                    end
                    if page <= 10 then
                        page = 12;
                    end
                end
                self:SetAttribute("actionpage", page);
                for btn in pairs(CP_BUTTONS) do
                    btn:SetAttribute("actionpage", page);
                end
            ]=]
        ]]);
        m:SetFrameRef("MainMenuBarArtFrame", MainMenuBarArtFrame)
        m:SetFrameRef("OverrideActionBar", OverrideActionBar)
        local state = {};
        table.insert(state, "[overridebar][possessbar]possess");
        for i = 2, 6 do
            table.insert(state, ("[bar:%d]%d"):format(i, i));
        end
        local _, playerClass = UnitClass("player");
        if playerClass == "DRUID" then
            table.insert(state, "[bonusbar:1,stealth]7"); -- edited
        elseif playerClass == "WARRIOR" then
            table.insert(state, "[stance:2]7");
            table.insert(state, "[stance:3]8");
        end
        for i = 1, 4 do
            table.insert(state, ("[bonusbar:%d]%d"):format(i, i+6));
        end
        table.insert(state, "[stance:1]tempshapeshift");
        table.insert(state, "1");
        state = table.concat(state, ";");
        local now = SecureCmdOptionParse(state);
        m:SetAttribute("actionpage", now);
        RegisterStateDriver(m, "page", state);
        m:SetAttribute("_onstate-page", [=[
            self:Run(UpdateMainActionBar, newstate);
        ]=]);
    end
end
 
function ConsolePort:CreateSecureButton(name, modifier, clickbutton, UIcommand)
    local btn   = CreateFrame("Button", name..modifier, UIParent, "SecureActionButtonTemplate");
    local functionRefs = {
        "Taxi", "Gossip", "Quest", "Map", "Book", "Spec", "Glyph", "Menu",
        "Bags", "Gear", "Shop", "Misc", "Popup", "Loot", "Stack", -- "List" (taint issue, left out atm)
    }
    btn.name    = name;
    btn.timer   = 0;
    btn.state   = G.STATE_UP;
    btn.action  = _G[clickbutton];
    btn.command = UIcommand;
    btn.mod     = modifier;
    btn.default = {
        type = "click",
        attr = "clickbutton",
        val  = btn.action
    };
    for i, func in pairs(functionRefs) do
        btn[func] = function(btn) self[func](self, btn.command, btn.state); end;
    end
    btn.rebind  = function(btn) self:ChangeButtonBinding(btn); end;
    btn.revert  = function()
        if  MainBarAction(btn.default.val) then
            btn.default.type = "action";
            btn.default.attr = "action";
            btn.default.val  = MainBarAction(btn.default.val);
        end
        btn:SetAttribute("type", btn.default.type);
        btn:SetAttribute(btn.default.attr, btn.default.val);
    end
    btn:SetID(btn.action:GetID());
    btn.revert();
    btn:SetAttribute("actionpage", ConsolePortManager:GetAttribute("actionpage"));
    btn:RegisterEvent("PLAYER_REGEN_DISABLED");
    btn:SetScript("OnEvent", function(self, event, ...)
        self.revert();
    end);
    btn:HookScript("OnMouseDown", function(self, button)
        local func = self:GetAttribute("type");
        local click = self:GetAttribute("clickbutton");
        self.state = G.STATE_DOWN;
        self.timer = 0;
        if  func == "click" or func == "action" then
            click:SetButtonState("PUSHED");
            return;
        end
        -- Fire function twice where keystate is requested
        if  self[func] then self[func](self); end;
    end);
    btn:HookScript("OnMouseUp", function(self, button)
        local func = self:GetAttribute("type");
        local click = self:GetAttribute("clickbutton");
        self.state = G.STATE_UP;
        if func == "click" or func == "action" then
            click:SetButtonState("NORMAL");
        end
    end);
    if  btn.command == G.UP or
        btn.command == G.DOWN or
        btn.command == G.LEFT or
        btn.command == G.RIGHT then
        btn:SetScript("OnUpdate", function(self, elapsed)
            self.timer = self.timer + elapsed;
            if self.timer >= 0.2 and btn.state == G.STATE_DOWN then
                local func = self:GetAttribute("type");
                if self[func] then self[func](self); end;
                self.timer = 0;
            end
        end);
    end
    ConsolePortManager:SetFrameRef("NewButton", btn);
    SecureHandlerExecute(ConsolePortManager, [[
        CP_BUTTONS[self:GetFrameRef("NewButton")] = true
    ]]);
end

As you can see, I changed all the inbound references to self already.

[MunkDev]

I've just noticed that this solution doesn't seem to work for prowling druids in cat form.
Any ideas?

Edit: Solved it! The prowled actionpage is 7, not 8.
Changed this bit:

table.insert(state, "[bonusbar:1,stealth]8");

To this:

table.insert(state, "[bonusbar:1,stealth]7");