Need help with keybind assertion error

[Baertram]

Hey devs,

using the addon "DoItAll with FCO ItemSaver support" I get the following error message if I:

-Open a crafting station
-Press the key to open the mail panel
-Switch to "Send mail" tab

Error message:

assertion failed
stack traceback:
	[C]: in function 'assert'
	EsoUI/Libraries/ZO_KeybindStrip/ZO_KeybindStrip.lua:174: in function 'ZO_KeybindStrip:AddKeybindButton'
	EsoUI/Libraries/ZO_KeybindStrip/ZO_KeybindStrip.lua:287: in function 'ZO_KeybindStrip:AddKeybindButtonGroup'
	user:/AddOns/DoItAll/src/AttachAll/Keybind.lua:16: in function 'MailSendSceneStateChanged'
	EsoUI/Libraries/Utility/ZO_CallbackObject.lua:104: in function 'ZO_CallbackObject:FireCallbacks'
	EsoUI/Libraries/ZO_Scene/ZO_Scene.lua:248: in function 'ZO_Scene:SetState'
	EsoUI/Libraries/ZO_Scene/ZO_SceneManager.lua:155: in function 'ZO_SceneManager:ShowScene'
	EsoUI/Libraries/ZO_Scene/ZO_SceneManager.lua:430: in function 'ZO_SceneManager:OnSceneStateChange'
	EsoUI/Ingame/Scenes/IngameSceneManager.lua:278: in function 'ZO_IngameSceneManager:OnSceneStateChange'
	EsoUI/Libraries/ZO_Scene/ZO_Scene.lua:249: in function 'ZO_Scene:SetState'

Here is the content of the file from the error message:

DoItAll = DoItAll or {}
 
local keystripDef = {
  {
    name = "Attach All",
    keybind = "SC_BANK_ALL",
    callback = function() DoItAll.AttachAll() end,
    alignment = KEYBIND_STRIP_ALIGN_LEFT,
  }
} 
 
--KEYBIND_STRIP
 
local function MailSendSceneStateChanged(oldState, newState)
  if newState == SCENE_SHOWING then
    KEYBIND_STRIP:AddKeybindButtonGroup(keystripDef)
  elseif newState == SCENE_HIDDEN then
    KEYBIND_STRIP:RemoveKeybindButtonGroup(keystripDef)
  end
end
 
MAIL_SEND_SCENE:RegisterCallback("StateChange", MailSendSceneStateChanged)

As the keybind strip tries to call the function AddKeybindButtonGroup() the assertion fails somehow.


If I directly open the mail panel and choose the send mail tab everything works just fine.
Any ideas how to get rid of that error message AND why it happens? Maybe some keybindings from the crafting station scene mix up with it?

Thanks for your help.

EDIT: Sorry, forgot the error message :-)

[votan]

May SCENE_HIDDEN is too late? (Fading)
What if SCENE_HIDING ?

[circonian]

There are strange things that happen when messing with the keybindStrip, one example: http://www.esoui.com/forums/showthre...t=keybindstrip

But, I can tell you the reason is because you are using the same keybind "SC_BANK_ALL" for each keybindStrip button.
If you do your steps to reproduce the error you will notice that when you open the crafting window it shows the "Extract All" keybindStrip button. when you then click on the mail icon to open the mail from there, you are not removing that keybindStrip button. It will still show "Extract All".
Then when you switch to the Send Mail tab (since your using the same descriptor for all buttons) it is trying to place the "Attach All" button using the same "SC_BANK_ALL" keybind name which causes the assert error because that keybind/button already exists.

However, I wouldn't "just" change the names of them or just try to fix it so they remove properly. I would change it to just add the new keybindStrip button you want to the games default keybindDescriptor tables for each window then you don't have to worry about adding/removing the buttons, or any errors...like this:

Just do this instead:

local mailKeystripDescriptorTable = MAIL_SEND.staticKeybindStripDescriptor
 
local newDescriptor = {
    name = "Attach All",
    keybind = "SC_BANK_ALL",
    callback = function() DoItAll.AttachAll() end,
    alignment = KEYBIND_STRIP_ALIGN_LEFT,
}
 
table.insert(mailKeystripDescriptorTable, newDescriptor)

Thats the only code you need (for the mail send window). The game will handle everything else.

[circonian]

Oh, and for the other widows, just find the lua files related to whatever window your trying to add something to & search for "keybindStrip" you'll get several hits, look for the one that creates the keybindStripDescriptors table, example:

function ZO_Smithing:InitializeKeybindStripDescriptors()
    self.keybindStripDescriptor =
    {
        alignment = KEYBIND_STRIP_ALIGN_CENTER,
 
        -- Clear selections
        {
....

So that one (is for all smithing panels) add a descriptor to it you would use:

table.insert(SMITHING.keybindStripDescriptor, newDescriptor)

Last If I remember correctly I would do the keyword search for "keybindStrip" and NOT "keybindStripDescriptor" because I think some windows name that table differently and they don't always have a InitializeKeybindStripDescriptors() function... but the keybindStrip button tables all start with "keybindStrip"

[Baertram]

Thanks a lot for the explanation and help, as always! Very much appreciated.

I'll see what keybind strips these should be when I find the time and change it for some tests.

[circonian]

One last thing, I looked at DoItAll, and this might come in handy for you on the crafting windows.
You can also add a visible function to the descriptor, so you could probably just add (for example) your descriptor to the SMITHING.keybindStripDescriptor table, which makes it visible on all panels, but throw a visible function in your descriptor to determine if it should be visible or not (by checking the SMITHING.mode) rather than trying to add your descriptor to only certain panels:

EDIT (added code):

Warning: Spoiler

local function ShouldShow()
    local mode = SMITHING.mode
    
    -- are these the only two you use I think?
    if mode == SMITHING_MODE_REFINMENT then
        return true
    elseif mode == SMITHING_MODE_DECONSTRUCTION then
        return true
    end
    return false
end
 
local newDescriptor = {
    name = "Attach All",
    keybind = "SC_BANK_ALL",
    callback = function() AttachAll() end,
    alignment = KEYBIND_STRIP_ALIGN_LEFT,
    visible = ShouldShow
}
 
table.insert(SMITHING.keybindStripDescriptor, newDescriptor)

[Baertram]

Ah yes, I saw this in another addon source but forgot about it again.
As DoItAll is not my addon and I only changed it to support other addons, and implemented some new features, I didn't change the basics.

Question:
Are we able to use a function to dynamically set the "name" in the keystrip definition too?

Like:

local function getKeyStripName()
 if x = y then 
   return "Extract All" 
 else
   return "Refine all"
 end
end
 
local keystripDef = {
    {
        name = function() getKeyStripName() end,
        keybind = "SC_BANK_ALL",
        callback = function() DoItAll.ExtractAll() end,
        alignment = KEYBIND_STRIP_ALIGN_LEFT
    }
}

[circonian]

Yes, just make sure you "return" it

name = function() return getKeyStripName() end

here is an example:

Warning: Spoiler

function TweakIt.InitStoreKeybindStripDescriptors()
    STORE_WINDOW.keybindStripDescriptor =    
    {
        alignment = KEYBIND_STRIP_ALIGN_CENTER,
        GetRepairEquippedDescriptor(),
 
        -- Sell All Junk
        {
            name = function() 
                        return zo_strformat(TWEAKIT_SELLALL_JUNK_GOLD, ZO_CurrencyControl_FormatCurrency(GetJunkItemsValue()))
                        end,
            keybind = "UI_SHORTCUT_NEGATIVE",
 
            visible =   function()
                            ---------------------------------------------------------------------
                            -- Temporary change until they fix stolen items showing up in the
                            -- Sell All Junk keybindstrip
                            --return HasAnyJunk(BAG_BACKPACK)
                            return TemporaryVisCheckForSellAllJunk()
                            ---------------------------------------------------------------------
                        end,
            callback =  function()
                            ZO_Dialogs_ShowDialog("SELL_ALL_JUNK")
                        end,
        },
    }
end

[Baertram]

Great, thank you very much!

[Baertram]

local keystripDef = {
    {
        name = function() return GetKeyStripName() end,
        keybind = "SC_BANK_ALL",
        callback = function() DoItAll.ExtractAll() end,
        alignment = KEYBIND_STRIP_ALIGN_LEFT,
                visible = function() return ShouldShow() end,
    }
}
 
table.insert(SMITHING.keybindStripDescriptor, keystripDef)   --error here

This throws me an error message that in file zo_keybindstrip.lua line 186 the table index is NIL

EsoUI/Libraries/ZO_KeybindStrip/ZO_KeybindStrip.lua:186: table index is nil
stack traceback:
	EsoUI/Libraries/ZO_KeybindStrip/ZO_KeybindStrip.lua:186: in function 'ZO_KeybindStrip:AddKeybindButton'
	EsoUI/Libraries/ZO_KeybindStrip/ZO_KeybindStrip.lua:287: in function 'ZO_KeybindStrip:AddKeybindButtonGroup'
	EsoUI/Ingame/Crafting/Smithing.lua:38: in function 'callback'
	EsoUI/Libraries/Utility/ZO_CallbackObject.lua:104: in function 'ZO_CallbackObject:FireCallbacks'
	EsoUI/Libraries/ZO_Scene/ZO_Scene.lua:248: in function 'ZO_Scene:SetState'
	EsoUI/Ingame/Scenes/InteractScene.lua:61: in function 'ZO_InteractScene:SetState'
	EsoUI/Libraries/ZO_Scene/ZO_SceneManager.lua:155: in function 'ZO_SceneManager:ShowScene'
	EsoUI/Libraries/ZO_Scene/ZO_SceneManager.lua:430: in function 'ZO_SceneManager:OnSceneStateChange'
	EsoUI/Ingame/Scenes/IngameSceneManager.lua:278: in function 'ZO_IngameSceneManager:OnSceneStateChange'
	EsoUI/Libraries/ZO_Scene/ZO_Scene.lua:249: in function 'ZO_Scene:SetState'

self.keybinds[keybindButtonDescriptor.keybind] = button

If I just use the old way

KEYBIND_STRIP:AddKeybindButtonGroup(keystripDef)

it works just fine.

Only problem is:
The name of the keybind is not changing if I change the tabs at the crafting station. The name is only updated as the keybind is added.

[circonian]

Ah I didn't notice that in your earlier posts, it should be:

local keystripDef = {
        name = function() return GetKeyStripName() end,
        keybind = "SC_BANK_ALL",
        callback = function() DoItAll.ExtractAll() end,
        alignment = KEYBIND_STRIP_ALIGN_LEFT,
                visible = function() return ShouldShow() end,
}

Not 2 tables:
Its only 2 tables if you are completely replacing the entire keybindStripDescriptor table. But, were not, were just adding a table to the keybindStripDescriptor table.

local keystripDef = {
    {
        name = function() return GetKeyStripName() end,
        keybind = "SC_BANK_ALL",
        callback = function() DoItAll.ExtractAll() end,
        alignment = KEYBIND_STRIP_ALIGN_LEFT,
                visible = function() return ShouldShow() end,
    }
}

Originally Posted by Baertram Only problem is: The name of the keybind is not changing if I change the tabs at the crafting station. The name is only updated as the keybind is added.

When I use Do-It-All it shows the same text for both panels "Refinement" and "Deconstruction" both show "Extract All"
Are you trying to change the way it works to show different names?

[circonian]

Either there is some other error I'm not seeing in your code or its in your GetKeyStripName()

This works & changes names as the panels are changed:

Warning: Spoiler

local function ShouldShow()
    local mode = SMITHING.mode
    
    -- are these the only two you use I think?
    if mode == SMITHING_MODE_REFINMENT then
        return true
    elseif mode == SMITHING_MODE_DECONSTRUCTION then
        return true
    end
    return false
end
 
local function GetName()
    local mode = SMITHING.mode
    if mode == SMITHING_MODE_REFINMENT then
        return "Refine All"
    elseif mode == SMITHING_MODE_DECONSTRUCTION then
        return "Deconstruct All"
    end
end
 
local newDescriptor = {
    name = GetName,
    keybind = "SC_BANK_ALL",
    callback = function() AttachAll() end,
    alignment = KEYBIND_STRIP_ALIGN_LEFT,
    visible = ShouldShow
}
 
table.insert(SMITHING.keybindStripDescriptor, newDescriptor)

EDIT: Oh, it is because you changed the way you implemented it using

KEYBIND_STRIP:AddKeybindButtonGroup(keystripDef)

When you do it the way I mentioned as you switch panels the buttons are refreshed automatically which re-gets the proper name. Using that other method you would have to do that yourself.

[Baertram]

Yeah, it was the double {{}} around the keybind descriptor table...
Thanks for the hint.

Now you solution with the table.insert(SMITHING.keybindStripDescriptor, keystripDef) works fine, and is changing the names automatically!