SecureActionButtonTemplate with macrotext attribute not working

[Zax]

None of my secure buttons with macrotext attribute are working on PTR 10.x

In the main XML file (MyAddon.xml):

<Frame name="npcm_frameMain" frameStrata="BACKGROUND" virtual="false" hidden="true" resizable="true" parent="UIParent" inherits="SecureHandlerStateTemplate">

In the main lua file (MyAddon.lua):

local button = CreateFrame("Button", "secureBtnTest", npcm_frameMain, "SecureActionButtonTemplate")
button:SetSize(32,32)
button:SetPoint("LEFT", npcm_frameMain, "RIGHT", 300, 0)
local texture = button:CreateTexture("$parent_tex", "BACKGROUND")
texture:SetAllPoints(true)
texture:SetTexture(GetSpellTexture("Forme de Voyage"))
button.texture = texture
    
button:SetAttribute("type", "macro")
button:SetAttribute("macrotext", "/sit")
button:SetScript("PostClick", function(self, arg1)
    print(self:GetName(), arg1, self:GetAttribute("macrotext"))--testing
end)

Nothing happens when the button is clicked (and no error message nor warning about blocked action).
Thank you for your help.

[SDPhantom]

You still need to call Button:RegisterForClicks() for the OnClick handler to work.

It's also good practice to make sure Frame:EnableMouse() or Frame:SetMouseClickEnabled() is set.
Frame:EnableMouse() is a legacy function that controls both clicks and mouseover while Frame:SetMouseClickEnabled() and Frame:SetMouseMotionEnabled() individually control each of their respective features.

On a side note, you don't need a SecureActionButton to send /sit. It's processed as an emote using the "SIT" and DoEmote() is not protected. You can run it as DoEmote("SIT").

[Zax]

I understand the value of following good practices, but as far as I know a frame defined as "button" handles mouseClick by default.

Anyhow, I tested with button:SetMouseClickEnabled() without success.
PostClick script works, so the button is active and correctly responds to clicks. The problem comes from:

button:SetAttribute("type", "macro")
button:SetAttribute("macrotext", "/sit")

Concerning the macro itself (/sit), it's just a basic example used in my tests.
As the buttons in part of my addon NPCsMarker, the real macro is something like "/wm 1" or "/cwm 1" to place or clear ground markers.

[Dridzt]

Could it simply be a case of some script functionality not being enabled on the alpha/beta whatever 10 is atm?

[SDPhantom]

You still didn't address Button:RegisterForClicks(), which tells the button what clicks to look for (Left, Right, Middle, etc.) If you don't register any, it won't know what to listen for and therefore won't work.

This is a separate function from just telling a frame it should react to mouse events.

[Zax]

To be sure, I just tested with Button:RegisterForClicks() without success.

button:RegisterForClicks("LeftButtonUp", "RightButtonUp")
button:SetMouseClickEnabled(true)

I think the PostClick script wouldn't be executed if the Click was ignored.

[SDPhantom]

Here's the OnClick handler on PTR.

function SecureActionButton_OnClick(self, inputButton, down, isKeyPress)
    local pressAndHoldAction = SecureButton_GetAttribute(self, "pressAndHoldAction");
    local useOnKeyDown = GetCVarBool("ActionButtonUseKeyDown") or pressAndHoldAction;
    local clickAction = (down and useOnKeyDown) or (not down and not useOnKeyDown);
    local releasePressAndHoldAction = (not down) and (pressAndHoldAction or GetCVarBool("ActionButtonUseKeyHeldSpell"));
 
    if clickAction then
        OnActionButtonClick(self, inputButton, down, isKeyPress);
        return true;
    elseif releasePressAndHoldAction then
        OnActionButtonPressAndHoldRelease(self, inputButton, isKeyPress);
        return true;
    end
 
    return false;
end

-FrameXML\SecureTemplates.lua:730

Basically, the handler is looking for either an up or down click event specifically according to how the ActionButtonUseKeyDown CVar is set. If it never gets the matching click event, the code never runs. It's probably a good idea to register both up and down click events for every button you intend to respond to. If you don't care about registering individual buttons, you can use "AnyUp" and "AnyDown".

Originally Posted by Zax the real macro is something like "/wm 1" or "/cwm 1" to place or clear ground markers.

This code clip may be of interest to you.

SECURE_ACTIONS.worldmarker =
    function(self, unit, button)
        local marker = tonumber(SecureButton_GetModifiedAttribute(self, "marker", button));
        local action = SecureButton_GetModifiedAttribute(self, "action", button) or "toggle";
        if ( action == "set" ) then
            PlaceRaidMarker(marker or 1);
        elseif ( action == "clear" ) then
            ClearRaidMarker(marker);
        elseif ( action == "toggle" ) then
            marker = marker or 1;
            if ( IsRaidMarkerActive(marker) ) then
                ClearRaidMarker(marker);
            else
                PlaceRaidMarker(marker);
            end
        end
    end;

-FrameXML\SecureTemplates.lua:589

This defines type "worldmarker" with parameters "marker" and "action".
As with any other attribute fetched by SecureButton_GetModifiedAttribute(), you can append the attribute name (not the value) with a number representing the mouse button to bind to (1=Left, 2=Right, 3=Middle, etc.)

[Zax]

Interesting, SDPhantom. Thank you.

I have to say that I'm not sure how to adapt my code based on what you found.
As a reminder, I use the following basic code for a button with a macrotext attribute. It works fine on WoW 9.x:

local frame = CreateFrame("Frame", "Test", UIParent, "SecureHandlerStateTemplate")
    frame:SetSize(40, 40)
    frame:SetPoint("TOPLEFT", UIParent, 10, -150)
 
    local button = CreateFrame("Button", "TestBtn", frame, "SecureActionButtonTemplate")
    button:ClearAllPoints()
    button:SetSize(32, 32)
    button:SetPoint("CENTER", frame)
    local texture = button:CreateTexture("$parent_tex", "BACKGROUND")
    texture:SetAllPoints(true)
    texture:SetTexture(GetSpellTexture(783)) -- "Travel Form"
    button.texture = texture
 
    button:RegisterForClicks("LeftButtonUp", "RightButtonUp")
    button:SetMouseClickEnabled(true)
    button:SetAttribute("type", "macro")
    button:SetAttribute("macrotext", "/abs")
    
    ------ testing purpose
    button:SetScript("PostClick", function(self, arg1)
        print("POSTCLICK: Clicked button=", self:GetName(), "  macroTxt=", self:GetAttribute("macrotext"))
    end)
end

Also, I believe the code you found concerns the raid markers (placed on units) and not the ground markers (placed on... the ground ).

[Xrystal]

Based on the example on this page
https://wowpedia.fandom.com/wiki/Sec...ButtonTemplate

Have you tried changing type and macrotext to type1 and macrotext1 for left button click as these are attributes as SDPhantom mentioned. Although, I think ( not 100% sure ), that left button is default so maybe macrotext with no number is treated as macrotext1 :shrugs:

Just tested this version of your code using your original sit test on the PTR just now ( there was a big update ) and it worked

local frame = CreateFrame("Frame", "Test", UIParent, "SecureHandlerStateTemplate")
frame:SetSize(40, 40)
frame:SetPoint("TOPLEFT", UIParent, 10, -150)
 
local button = CreateFrame("Button", "TestBtn", frame, "SecureActionButtonTemplate")
button:ClearAllPoints()
button:SetSize(32, 32)
button:SetPoint("CENTER", frame)
local texture = button:CreateTexture("$parent_tex", "BACKGROUND")
texture:SetAllPoints(true)
texture:SetTexture(GetSpellTexture(783)) -- "Travel Form"
button.texture = texture
 
button:RegisterForClicks("LeftButtonUp", "RightButtonUp")
button:SetMouseClickEnabled(true)
button:SetAttribute("type1", "macro")
button:SetAttribute("macrotext1", "/sit")
 
------ testing purpose
button:SetScript("PostClick", function(self, arg1)
    print("POSTCLICK: Clicked button=", self:GetName(), "  macroTxt=", self:GetAttribute("macrotext1"))
end)

[Zax]

Just copy/pasted your code Xrystal (after 2 PTR updates) but if it correctly print the PostClick, the macro (/sit or /abs) wasn't executed.
So, I'm a little bit confused... and still standing

Are you able to sit down with the code you posted? Or maybe we'll have another PTR server update in Europe.

[SDPhantom]

Originally Posted by Zax I have to say that I'm not sure how to adapt my code based on what you found.

As for Button:RegisterForClicks(), change this

button:RegisterForClicks("LeftButtonUp", "RightButtonUp")

to either of these

button:RegisterForClicks("LeftButtonUp", "LeftButtonDown", "RightButtonUp", "RightButtonDown")

button:RegisterForClicks("AnyUp", "AnyDown")

Originally Posted by Zax Also, I believe the code you found concerns the raid markers (placed on units) and not the ground markers (placed on... the ground ).

RaidTarget is what's placed on units and WorldMarker is placed on the ground. RaidTargets aren't protected, so they don't need a SecureActionButton to set.

RaidTargets are set by SetRaidTarget() while WorldMarkers have PlaceRaidMarker() and ClearRaidMarker().
(WoWPedia doesn't have an API page on the WorldMarker functions)

Here's an example of your button configured for this.

button:SetMouseClickEnabled(true);--    Make sure OnClick is enabled
button:RegisterForClicks("AnyUp","AnyDown");--  Listen for all mouse buttons (Both up and down are required for SecureActionButtonTemplate)
 
button:SetAttribute("type","worldmarker");--    Perform "WorldMarker" action
button:SetAttribute("marker",1);--  Use marker index 1
button:SetAttribute("action1","toggle");--  Set left button to toggle
button:SetAttribute("action2","clear");--   Set right button to force clear

Originally Posted by Xrystal Although, I think ( not 100% sure ), that left button is default so maybe macrotext with no number is treated as macrotext1 :shrugs:

The default without the number suffix is to run on any button. Specifying one is useful if you want the same SecureActionButton to perform different actions depending on what mouse button you click it with and/or what modifier keys are held.

[Xrystal]

Originally Posted by Zax Just copy/pasted your code Xrystal (after 2 PTR updates) but if it correctly print the PostClick, the macro (/sit or /abs) wasn't executed. So, I'm a little bit confused... and still standing Are you able to sit down with the code you posted? Or maybe we'll have another PTR server update in Europe.

Yes, I was able to sit down on the 10.0 PTR with that code, and the print statement was displayed as well.

[Xrystal]

Originally Posted by Zax Just copy/pasted your code Xrystal (after 2 PTR updates) but if it correctly print the PostClick, the macro (/sit or /abs) wasn't executed. So, I'm a little bit confused... and still standing Are you able to sit down with the code you posted? Or maybe we'll have another PTR server update in Europe.

That is actually a good thought.
I have a US account despite being in the UK and I had an update this morning ( UK time ) but my brother who has a UK account hasn't noticed any dragonflight changes on his PTR. I wonder if there is some sort of difference between the two regions onders:

[Zax]

OK, I'm now able to /sit
SDPhantom is right: both up and down listener are required for SecureActionButtonTemplate.

EDIT:
As PostClick debugging is now printed twice, I had to add a test before performing PostClick actions.

This is the actual /sit button. I'll test with ground markers this evening and keep you informed.

local frame = CreateFrame("Frame", "Test", UIParent, "SecureHandlerStateTemplate")
    frame:SetSize(40, 40)
    frame:SetPoint("TOPLEFT", UIParent, 10, -150)
     
    local button = CreateFrame("Button", "TestBtn", frame, "SecureActionButtonTemplate")
    button:ClearAllPoints()
    button:SetSize(32, 32)
    button:SetPoint("CENTER", frame)
    local texture = button:CreateTexture("$parent_tex", "BACKGROUND")
    texture:SetAllPoints(true)
    texture:SetTexture(GetSpellTexture(783)) -- "Travel Form"
    button.texture = texture
 
    button:SetMouseClickEnabled(true) -- Make sure OnClick is enabled
    --button:RegisterForClicks("LeftButtonUp", "LeftButtonDown", "RightButtonUp", "RightButtonDown")
    -- button:RegisterForClicks("AnyUp", "AnyDown") -- up and down required for SecureActionButtonTemplate
    button:RegisterForClicks("LeftButtonUp", "LeftButtonDown") -- up and down required for SecureActionButtonTemplate
    
    button:SetAttribute("type", "macro")
    button:SetAttribute("macrotext1", "/sit")
     
    ------ testing purpose
    button:SetScript("PostClick", function(self, btn, down)
        if (down) then print("POSTCLICK: Clicked button=", self:GetName(), "  btn=", btn, "  down=", down, "  macroTxt=", self:GetAttribute("macrotext1")) end
    end)

[Zax]

OK, placing Ground Markers works fine.
Thank you SDPhantom, you saved my addon

I have a specific icon to delete placed ground marker, so I don't use the right-click on marker's button.
But I used shift to trigger another macro (insert marker's icon in the opened chat box, but "/sit" to simplify in the following example:

button:SetAttribute("shift-macrotext1", "/sit")

This code is no longer working. Can you tell how to add a shift-clic macro to your code?

[Xrystal]

try the shift- on the type statement

As in btn:SetAttribute("shift-type1", "macro")

[Zax]

OK.

I still have an annoying problem: as the up and down mouse button are registered, it triggers the action twixe.
I can handle this on the PostClick script with the third argument, but I don't know how to handle the main action - the one defined as a shit-click macro.

For example, line #6 is executed twice

btnMarker:SetMouseClickEnabled(true) -- Make sure OnClick is enabled
        btnMarker:RegisterForClicks("LeftButtonUp", "LeftButtonDown") -- up and down required for SecureActionButtonTemplate
        btnMarker:SetAttribute("type", "macro")
        local macroStr = format("/wm %d", markersOrder[i]) -- place ground marker #i
        btnMarker:SetAttribute("macrotext1", macroStr)
        btnMarker:SetAttribute("shift-macrotext1", "/say TESTING") -- executed twice !!!!!!!!
        btnMarker:SetScript("PostClick", function(self, btn, isDown)
            if (not isDown) then -- execute only when down
                if (not IsModifierKeyDown()) then
                    -- do some stuff when mouseDown with modifier key
                end
            end
        end)

BTW, it's for NPCsMarker, a RP addon.

[Zax]

Originally Posted by Zax For example, line #6 is executed twice

My bad, it's executed twice on Retail, and only once on PTR.
So, all is OK. Thank you all

[Arcinde]

I had a similar confusing situation that was due to having a different setting of cvar `ActionButtonUseKeyDown` on retail vs beta. If `ActionButtonUseKeyDown` is off then `AnyDown` will not work at all.

[Archarodim]

It appears that support for macrotext attributes was dropped in wow 11:

In secureTemplates.lua:

The former following code (in WoW 10.2.7.54988):

SECURE_ACTIONS.macro =
    function (self, unit, button)
        local macro = SecureButton_GetModifiedAttribute(self, "macro", button);
        if ( macro ) then
            -- Save macros in case the one for this action is being edited
            securecall("MacroFrame_SaveMacro");
 
            RunMacro(macro, button);
        else
            local text =
                SecureButton_GetModifiedAttribute(self, "macrotext", button);
            if ( text ) then
                RunMacroText(text, button);
            end
        end
    end;

Became just (in 11.0.0.55000):

SECURE_ACTIONS.macro =
    function (self, unit, button)
        local macro = SecureButton_GetModifiedAttribute(self, "macro", button);
        if ( macro ) then
            -- Save macros in case the one for this action is being edited
            securecall("MacroFrame_SaveMacro");
 
            RunMacro(macro, button);
        end
    end;

So no more custom macro per button, let's pollute the default macro UI instead I guess...

Thank you Blizzard!