WoWInterface - SecureHandlers and 'equipmentset'

WoWInterface (https://www.wowinterface.com/forums/index.php)

- General Authoring Discussion (https://www.wowinterface.com/forums/forumdisplay.php?f=20)

- - SecureHandlers and 'equipmentset' (https://www.wowinterface.com/forums/showthread.php?t=49120)

SecureHandlers and 'equipmentset'

Holla everyone

I'm working on my action bar addon an would like to support equipment sets from the Blizz equipment manager.

I've found the following code in SecureHandlers.lua:

Lua Code:

local function PickupAny(kind, target, detail, ...)
    if (kind == "clear") then
        ClearCursor();
        kind, target, detail = target, detail, ...;
    end
 
    if kind == 'action' then
        PickupAction(target);
    elseif kind == 'bag' then
        PickupBagFromSlot(target)
    elseif kind == 'bagslot' then
        PickupContainerItem(target, detail)
    elseif kind == 'inventory' then
        PickupInventoryItem(target)
    elseif kind == 'item' then
        PickupItem(target)
    elseif kind == 'macro' then
        PickupMacro(target)
    elseif kind == 'merchant' then
        PickupMerchantItem(target)
    elseif kind == 'petaction' then
        PickupPetAction(target)
    elseif kind == 'money' then
        PickupPlayerMoney(target)
    elseif kind == 'spell' then
        PickupSpell(target)
    elseif kind == 'companion' then
        PickupCompanion(target, detail)
    elseif kind == 'equipmentset' then
        PickupEquipmentSet(target);
    end
end
function SecureHandler_OnDragEvent(self, snippetAttr, button)
    local body = self:GetAttribute(snippetAttr);
    if (body) then
        PickupAny( SecureHandler_Self_Execute(self,
                                              "self,button,kind,value,...",
                                              body, button, GetCursorInfo()) );
    end
end

Doesn't that mean that a frame that inherits SecureActionButtonTemplate will support the type 'equipmentset'?

Unfortunatly something like

Lua Code:

frame:SetAttribute("type", "equipmentset")
frame:SetAttribute("equipmentset", "<nameofavalidset>")

does not work.

Does someone know if "equipmentset" actually is a valid value for "type"?

Based on that code and the API documentation for PickupEquipmentSet, it looks like you need to use the set index, not the set name, and I'd expect this to work:

Code:

frame:SetAttribute("type", "equipmentset")

frame:SetAttribute("equipmentset", 4)

If you want to let the user enter a name instead of an index, you can find the index like this:

Code:

local function GetEquipmentSetIDByName(name)

    for i = 1, GetNumEquipmentSets() do

        if GetEquipmentSetInfo(i) == name then

            return i

        end

    end

end

I'm not that knowledgable about the equipment set API in general, though... if the indices are not fixed (eg. they can change if the user renames the set or adds a new set) then you probably want to store the set by name, and check its ID every time something changes.

Thank you white cat.
I've tried this:

Lua Code:

local button = CreateFrame("CheckButton", "testbutton1", UIParent, "SecureActionButtonTemplate, ActionButtonTemplate")
    button:RegisterForClicks("AnyUp")
    button:SetPoint("CENTER", UIParent, "CENTER")
    button:SetHeight(50)
    button:SetWidth(50)
    button:SetAttribute("type", "spell")
    button:SetAttribute("spell", "1459")
    local button = CreateFrame("CheckButton", "testbutton2", UIParent, "SecureActionButtonTemplate, ActionButtonTemplate")
    button:RegisterForClicks("AnyUp")
    button:SetPoint("CENTER", UIParent, "CENTER", 0, 55)
    button:SetHeight(50)
    button:SetWidth(50)
    button:SetAttribute("type", "equipmentset")
    button:SetAttribute("equipmentset", "1")

The first button does work (at least on my mage *g*).
The second button still does not. :/

I've created a set named "test". GetEquipmentSetIDByName("test") does return '1', so I'm sure that this is the right index.

I've still no idea what's wrong with it or if "equipmentset" is even a valid type. Any other ideas?

That code from SecureHandlers.lua is for handling dragging. The code to handle clicking/using a button is in SecureTemplates.lua, specifically the possible options for "type" are the entries in the SECURE_ACTIONS table. Based on that you will probably want:

Code:

button:SetAttribute("type", "macro")

button:SetAttribute("macrotext", "/equipset test")

Oh. Ok. I'll use a macro. :/ Thank you.

But why the hell do they implement draging for a type that is not handled?

Those were possible returns from GetCursorInfo that it was checking.

I'm again digging into this. Now with flyout buttons. :)

I've finally managed to set up a flyout button without using the type "action".

Lua Code:

btn:SetAttribute("type", "flyout")
btn:SetAttribute("spell", <flyoutnumber>)

But ... I didn't found a way to support a pick up action for the button.
Right now I'm picking up the button via the flyout id and the PickupSpellBookItem.

Lua Code:

local name = GetFlyoutInfo(value)
    local found
    local spellName = ""
    local i = 1
    while true do
       local spellName = GetSpellBookItemName(i, BOOKTYPE_SPELL)
        if spellName == name then
            found = i
            break
        end
       if not spellName then
          do break end
       end
       i = i + 1
    end
    
    if found then
        PickupSpellBookItem(found, BOOKTYPE_SPELL)
    end

But, well ... this is unsecure. Is there really no way to support dragging flyout buttons from the button frame without using "action" and an action id?

I have no idea, but I wouldn't be surprised if there wasn't. If you want to make real custom action buttons outside of the action scope (in API terms), it's suddenly a whole other deal. There's lots of events and function for "actions" only.