Redirecting keybinds mid combat

[MunkDev]

I'm trying to figure out whether the following scenario is possible:

• A key is bound to an in-game button, which inherits the SecureActionButtonTemplate.
• When no extra frames are visible, the button casts an arbitrary spell or performs a protected action.
• When a frame is visible (e.g. WorldMapFrame, QuestFrame) the keybinding is redirected to perform operations on that frame. Think of it as frame hotkeys.
• When the player enters combat, the button is NOT immediately reverted to cast spells, but rather stick to handling whatever frame is overlaying the UI until the player decides to close that frame.
• When in combat, and all frames are hidden, whether they are closed mid combat or not, the secure button goes back to casting spells.
• The definition of an overlaying frame is set by the code author.

My current approach is just reverting instantly upon PLAYER_REGEN_DISABLED, since this will not taint or cause any issues. The problem is that if I'm trying to manage a frame using keyboard input, it will instantly stop working if I happen to grab aggro from a nearby mob. This is obviously not favorable, since there are more than a few scenarios in which you need to interact with the interface mid combat. Since action bar swapping is something I handle with a SecureStateHandler, maybe it's possible to also make decisions depending on which frames are visible?

Example of what I'm currently using:

local btn   = CreateFrame("Button", name..modifier, UIParent, "SecureActionButtonTemplate");
--
-- Bunch of irrelevant shit missing here
--
btn.reset   = function()
    btn.default = {
        type = "click",
        attr = "clickbutton",
        val  = btn.action
    }
end
-- MainBarAction is a function that determines whether the action exists on the standard action bar
btn.revert  = function()
    if  MainBarAction(btn.default.val) then
        btn.default.type = "action";
        btn.default.attr = "action";
        btn.default.val  = MainBarAction(btn.default.val);
        btn:SetID(btn.default.val);
    end
    btn:SetAttribute("type", btn.default.type);
    btn:SetAttribute(btn.default.attr, btn.default.val);
    btn:SetAttribute("clickbutton", btn.action);
end
 
-- This works because of the grace period between the event and secure state lockdown
btn:RegisterEvent("PLAYER_REGEN_DISABLED");
btn:SetScript("OnEvent", btn.revert);
 
-- Register to handler
Handler:SetFrameRef("NewButton", btn);
SecureHandlerExecute(Handler, [[
    BUTTONS[self:GetFrameRef("NewButton")] = true
]]);

Handler code for bar and stance swapping:

local m = CreateFrame("Frame", "Handler", UIParent, "SecureHandlerStateTemplate");
SecureHandlerExecute(m, [[
    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(BUTTONS) do
            btn:SetAttribute("actionpage", page);
        end
    ]=]
]]);
m:SetFrameRef("MainMenuBarArtFrame", MainMenuBarArtFrame)
m:SetFrameRef("OverrideActionBar", OverrideActionBar)
local state = {};
tinsert(state, "[overridebar][possessbar]possess");
for i = 2, 6 do
    tinsert(state, ("[bar:%d]%d"):format(i, i));
end
local _, playerClass = UnitClass("player");
if playerClass == "DRUID" then
    tinsert(state, "[bonusbar:1,stealth]7");
elseif playerClass == "WARRIOR" then
    tinsert(state, "[stance:2]7");
    tinsert(state, "[stance:3]8");
end
for i = 1, 4 do
    tinsert(state, ("[bonusbar:%d]%d"):format(i, i+6));
end
tinsert(state, "[stance:1]tempshapeshift");
tinsert(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);
]=]);

[semlar]

If you're not planning on doing something restricted based on the visibility of the map, and I'm not sure why you would, you can just call :EnableKeyboard(true) on the WorldMapFrame and give it something to do OnKeyDown.

If you want their keys to continue doing other stuff, while still responding to whatever key presses you're interested in on the frame, you can call SetPropagateKeyboardInput on it.

[MunkDev]

Originally Posted by semlar If you're not planning on doing something restricted based on the visibility of the map, and I'm not sure why you would, you can just call :EnableKeyboard(true) on the WorldMapFrame and give it something to do OnKeyDown.

Unless we're talking EditBox, I don't think you can keep moving around with keyboard enabled on a frame?

I've investigated the problem a bit, created a mock frame and tried to wrap its OnHide script with my current handler. This seems to work just fine, aslong as the frame in question is secure. In order to hide the frame in combat, I had to create a secure button for that aswell. The problem I face next is how (if its even possible) I can hide the frame by pressing Escape (ToggleGameMenu()), since it doesn't work simply by inserting the frame into the UISpecialFrames table.

This is the code I'm playing around with:

local Frame = CreateFrame("FRAME", "MockFrame", UIParent, "SecureHandlerBaseTemplate")
Frame.Exit = CreateFrame("BUTTON", nil, Frame, "SecureActionButtonTemplate")
 
-- this works in and out of combat to hide the frame
Frame:WrapScript(Frame.Exit, "OnClick", [[
    self:GetParent():Hide();
]])
 
-- this doesn't work in combat
-- tinsert(UISpecialFrames, "MockFrame");
 
-- Handler
m:WrapScript(MockFrame, "OnHide", [[
    -- run secure shit here
]])

[semlar]

Originally Posted by MunkDev Unless we're talking EditBox, I don't think you can keep moving around with keyboard enabled on a frame?

You can do whatever you want as long as you allow all of the keys to pass through, or none of them to go through, depending on what your goal is.

If you could restrict arbitrary keys from going through in-combat while allowing the rest of your keys to function, that would be immensely abusable.

[MunkDev]

Originally Posted by semlar You can do whatever you want as long as you allow all of the keys to pass through, or none of them to go through, depending on what your goal is. If you could restrict arbitrary keys from going through in-combat while allowing the rest of your keys to function, that would be immensely abusable.

Yeah, that's not my goal either. I'm trying to change my SecureActionButtons behaviour depending on the visibility of a specific frame. I'm pretty much already doing this with the code I used to run, but the main issue is I can't hold off the reassignment until the overlaying frame is closed.

I would probably use an EditBox if I could, but it doesn't seem to work with OnKeyDown and OnKeyUp scripts. I don't mind removing all keybinds, except for movement.

[semlar]

Originally Posted by MunkDev I'm trying to change my SecureActionButtons behaviour depending on the visibility of a specific frame.

If I understand you correctly, you want to change the behavior of a key (escape) based on the visibility of an unsecure frame (WorldMapFrame).

You're going to have to think about a less directly exploitable way to do what you're trying to do, because if you could modify the behavior of a key based on the state of a frame that is not secure, you could do something like, say, prevent yourself from casting an interrupt if the target isn't casting an interruptible spell, or reduce your entire rotation down to spamming one key.

You can rebind M to toggle your frame, then subsequently toggle the map, but you can't change what M does based on the visibility of the map, at least not without making the map frame secure which would prevent anything else from moving it or toggling its visibility.

[SDPhantom]

I've found this section of Blizzard code that apparently captures only one key and causes all others to pass through. This is located in Blizzard_GarrisonUI\Blizzard_GarrisonMissionTemplates.xml line 758.

if ( key == "SPACE" ) then
	self:SetPropagateKeyboardInput(false);
	self.ViewButton:Click();
else
	self:SetPropagateKeyboardInput(true);
end

[MunkDev]

Forget about the WorldMapFrame, it was just an example. In simple terms, I want my frame to capture all keyboard input, but let the player still move around. The code I've provided can do that, but then I can't hide the frame in combat using Escape. I can only hide it by pressing the secure button attached to the frame. So my code works, but I have to click the cross in the corner to get rid of the frame, which kinda sucks.

It also sucks to be dabbling in secure functionality just to make this possible. It feels extremely unnecessary.

Originally Posted by SDPhantom I've found this section of Blizzard code that apparently captures only one key and causes all others to pass through. This is located in Blizzard_GarrisonMissionTemplates.xml line 758 in Blizzard_GarrisonUI. if ( key == "SPACE" ) then self:SetPropagateKeyboardInput(false); self.ViewButton:Click(); else self:SetPropagateKeyboardInput(true); end

Worth looking into. Does this mean even that input will propagate? Not just the next one?

Edit: Doesn't seem to work the way I anticipated.

[Fizzlemizz]

If it's just the esc type functionality you're looking for

tinsert(UISpecialFrames, "Your_Frame_Name")

Will hide it automaticaly when entering combat.
Edit: and using esc. when not.

[MunkDev]

Originally Posted by Fizzlemizz If it's just the esc type functionality you're looking for tinsert(UISpecialFrames, "Your_Frame_Name") Will hide it automaticaly when entering combat. Edit: and using esc. when not.

Only works for non-secure frames. If the frame is not secure then it can't change attributes on SecureActionButtons in combat.

[Fizzlemizz]

Originally Posted by MunkDev Only works for non-secure frames.

Missed that bit, sorry.

[semlar]

You can override whatever keys you're interested in while your frame is visible within the restricted environment using frame:SetBindingClick(priority, "key", "buttonName", ["mouseButton"]) and frame:ClearBindings()