AceConfigRegistry's NotifyChange()

[Sweetsour]

So, I'm more or less trying to confirm the purpose of this function. My assumption is that I call it to request an update to AceConfig's options? Their site doesn't provide much material on the function.

My code

local ACFG = LibStub("AceConfigRegistry-3.0")
ACFG:RegisterOptionsTable("CustomAudio Spell Sounds", GetSpellOptions)
 
local ACD = LibStub("AceConfigDialog-3.0")
ACD:AddToBlizOptions("CustomAudio Spell Sounds", "Spell Sounds", "CustomAudio")
 
-- I run this code when the player changes the active profile
LibStub("AceConfigRegistry-3.0"):NotifyChange("CustomAudio Spell Sounds")

From what I've found, the code seems to be correct, but it doesn't actually update any of my config's values. Currently, when I try to update the active profile, I have to ReloadUI() to have the proper values appear.

Is there perhaps a different function/method I should be using to update my config's values?

[jeffy162]

Correct me if I'm wrong, but, doesn't your "config" values go to your "SavedVariables"? Those don't get written until you either log off your character, reload the UI, or exit the game (or the game does a cinematic, I think). If that's the case, you wouldn't see them if you check for them and didn't do any of those.

[Sweetsour]

Yea, I tried for hours, but I just ended up going with reloading the UI, lol.

[Seerah]

What's your actual code?

[Sweetsour]

local function RefreshConfig()
    foreach(LibStub("AceConfigRegistry-3.0").tables,function(k,v)
        ACFG:NotifyChange(k)
    end)
end
 
function Ace3:OnProfileUpdate(event,db,profileKey)
    if (db) then
        ReloadUI()
    end
 
    --What I've tried, but is currently commented
    SCA.profile = self.db.profile
    RefreshConfig()
end
 
-- Event: ADDON_LOADED
function Ace3:OnInitialize()
    local about_panel = LibStub:GetLibrary("LibAboutPanel", true)
 
    if about_panel then
        self.optionsFrame = about_panel.new(nil, "CustomAudio")
    end
 
    self.db = LibStub("AceDB-3.0"):New("SCA_db", SCA.defaults)
    SCA.profile = self.db.profile
 
    self.db.RegisterCallback(self, "OnNewProfile", "OnProfileUpdate")
    self.db.RegisterCallback(self, "OnProfileChanged", "OnProfileUpdate")
    self.db.RegisterCallback(self, "OnProfileCopied", "OnProfileUpdate")
    self.db.RegisterCallback(self, "OnProfileReset", "OnProfileUpdate")
 
    self:SetupOptions()
end
 
function Ace3:SetupOptions()
    local ACFG = LibStub("AceConfigRegistry-3.0")
    ACFG:RegisterOptionsTable("CustomAudio Quick Toggle", GetToggleOptions)
    ACFG:RegisterOptionsTable("CustomAudio Spell Sounds", GetSpellOptions)
    ACFG:RegisterOptionsTable("CustomAudio Defense Sounds", GetDefenseOptions)
    ACFG:RegisterOptionsTable("CustomAudio Combat Sounds", GetCombatOptions)
    ACFG:RegisterOptionsTable("CustomAudio Loot Sounds", GetLootOptions)
    ACFG:RegisterOptionsTable("CustomAudio Chat Sounds", GetChatOptions)
    ACFG:RegisterOptionsTable("CustomAudio Movement Sounds", GetMoveOptions)
    ACFG:RegisterOptionsTable("CustomAudio Backup Sounds", GetBackupOptions)
    ACFG:RegisterOptionsTable("CustomAudio Restore Sounds", GetRestoreOptions)
    ACFG:RegisterOptionsTable("CustomAudio Profiles", LibStub("AceDBOptions-3.0"):GetOptionsTable(self.db,true))
 
    local ACD = LibStub("AceConfigDialog-3.0")
    ACD:AddToBlizOptions("CustomAudio Quick Toggle", "Quick Toggle", "CustomAudio")
    ACD:AddToBlizOptions("CustomAudio Spell Sounds", "Spell Sounds", "CustomAudio")
    ACD:AddToBlizOptions("CustomAudio Defense Sounds", "Defense Sounds", "CustomAudio")
    ACD:AddToBlizOptions("CustomAudio Combat Sounds", "Combat Sounds", "CustomAudio")
    ACD:AddToBlizOptions("CustomAudio Loot Sounds", "Loot Sounds", "CustomAudio")
    ACD:AddToBlizOptions("CustomAudio Chat Sounds", "Chat Sounds", "CustomAudio")
    ACD:AddToBlizOptions("CustomAudio Movement Sounds", "Movement Sounds", "CustomAudio")
    ACD:AddToBlizOptions("CustomAudio Backup Sounds", "Backup Sounds", "CustomAudio")
    ACD:AddToBlizOptions("CustomAudio Restore Sounds", "Restore Sounds", "CustomAudio")
    ACD:AddToBlizOptions("CustomAudio Profiles", "Profiles", "CustomAudio")
end

The issue I'm having is when I make any profile changes, then try to access any part of my addon's config, I get Lua errors because values can't be found.

[Seerah]

This isn't your whole code, but I'll take a guess...

I have no idea what you're doing here:

foreach(LibStub("AceConfigRegistry-3.0").tables,function(k,v)
        ACFG:NotifyChange(k)
    end)

Every usage I've seen of this method is to call :NotifyConfig(ADDON_NAME_HERE)

[Sweetsour]

In AceConfigRegistry-3.0.lua

function AceConfigRegistry:NotifyChange(appName)
    if not AceConfigRegistry.tables[appName] then return end
    AceConfigRegistry.callbacks:Fire("ConfigTableChange", appName)
end

In my AceConfigRegistry.tables:


NotifyChange("CustomAudio") doesn't work

[myrroddin]

NotifyChange is primarily used to update the SV table previously registered with AceDB whenever an external method makes a change to a setting.

Usually this is when you have a LDB or minimap button that can change the options based on user input. Instead of opening AceConfig and presenting the Interface\AddOns\MyAddOn config screen, the LDB or button gives you a menu.

When the user selects a choice from the menu, then you call NotifyChange(MyAddOn) to keep the two option access methods in sync.

[Sweetsour]

That makes sense; thanks for the clarification. So if my code does something that adds new controls to my config panel, I have to reload the UI, correct?

[myrroddin]

Originally Posted by Sweetsour That makes sense; thanks for the clarification. So if my code does something that adds new controls to my config panel, I have to reload the UI, correct?

Yes. Each time you modify a Lua file you need to reload the UI. If you add or remove a Lua file, you need to completely exit out of the game to make that effective.

I never write XML, but I'll assume the same rules apply.

[Vrul]

Originally Posted by Sweetsour So if my code does something that adds new controls to my config panel, I have to reload the UI, correct?

No.

Since the code you've provided is incomplete we are left to guess what is going wrong. Based on what has been provided this code should throw an error:

local function RefreshConfig()
    foreach(LibStub("AceConfigRegistry-3.0").tables,function(k,v)
        ACFG:NotifyChange(k)
    end)
end

That function should look like:

local function RefreshConfig()
    local ACR = LibStub("AceConfigRegistry-3.0")
    for k, v in pairs(ACR.tables) do
        ACR:NotifyChange(k)
    end
end

But even that is overkill since you are trying to refresh every registered set of options. Something more along the lines of this is what you are going for:

local optionsSubTables = {
    ["Quick Toggle"] = GetToggleOptions,
    ["Spell Sounds"] = GetSpellOptions,
    ["Defense Sounds"] = GetDefenseOptions,
    ["Combat Sounds"] = GetCombatOptions,
    ["Loot Sounds"] = GetLootOptions,
    ["Chat Sounds"] = GetChatOptions,
    ["Movement Sounds"] = GetMoveOptions,
    ["Backup Sounds"] = GetBackupOptions,
    ["Restore Sounds"] = GetRestoreOptions,
    ["Profiles"] = false
}

local function RefreshConfig()
    local ACR = LibStub("AceConfigRegistry-3.0")
    for name in pairs(optionsSubTables) do
        ACR:NotifyChange(("CustomAudio %s"):format(name))
    end
end

function Ace3:OnProfileUpdate(event,db,profileKey)
    SCA.profile = self.db.profile
    RefreshConfig()
end

function Ace3:OnInitialize()    -- Event: ADDON_LOADED
    local about_panel = LibStub("LibAboutPanel", true)
 
    if about_panel then
        self.optionsFrame = about_panel.new(nil, "CustomAudio")
    end
 
    self.db = LibStub("AceDB-3.0"):New("SCA_db", SCA.defaults)
    SCA.profile = self.db.profile
 
    self.db.RegisterCallback(self, "OnNewProfile", "OnProfileUpdate")
    self.db.RegisterCallback(self, "OnProfileChanged", "OnProfileUpdate")
    self.db.RegisterCallback(self, "OnProfileCopied", "OnProfileUpdate")
    self.db.RegisterCallback(self, "OnProfileReset", "OnProfileUpdate")
 
    -- Setup Options
    local ACD, ACR = LibStub("AceConfigDialog-3.0"), LibStub("AceConfigRegistry-3.0")
    for name, options in pairs(optionsSubTables) do
        local appName = ("CustomAudio %s"):format(name)
        ACR:RegisterOptionsTable(appName, options or LibStub("AceDBOptions-3.0"):GetOptionsTable(self.db, true))
        ACD:AddToBlizOptions(appName, name, "CustomAudio")
    end
end

If you don't have an alternate way to change profiles (i.e. slash command or plugin menu) you could potentially shrink that more to:

local optionsSubTables = {
    ["Quick Toggle"] = GetToggleOptions,
    ["Spell Sounds"] = GetSpellOptions,
    ["Defense Sounds"] = GetDefenseOptions,
    ["Combat Sounds"] = GetCombatOptions,
    ["Loot Sounds"] = GetLootOptions,
    ["Chat Sounds"] = GetChatOptions,
    ["Movement Sounds"] = GetMoveOptions,
    ["Backup Sounds"] = GetBackupOptions,
    ["Restore Sounds"] = GetRestoreOptions,
    ["Profiles"] = false
}

function Ace3:OnProfileUpdate(event,db,profileKey)
    SCA.profile = self.db.profile
end

function Ace3:OnInitialize()    -- Event: ADDON_LOADED
    local about_panel = LibStub("LibAboutPanel", true)
 
    if about_panel then
        self.optionsFrame = about_panel.new(nil, "CustomAudio")
    end
 
    self.db = LibStub("AceDB-3.0"):New("SCA_db", SCA.defaults)
    SCA.profile = self.db.profile
 
    self.db.RegisterCallback(self, "OnNewProfile", "OnProfileUpdate")
    self.db.RegisterCallback(self, "OnProfileChanged", "OnProfileUpdate")
    self.db.RegisterCallback(self, "OnProfileCopied", "OnProfileUpdate")
    self.db.RegisterCallback(self, "OnProfileReset", "OnProfileUpdate")
 
    -- Setup Options
    local ACD, ACR = LibStub("AceConfigDialog-3.0"), LibStub("AceConfigRegistry-3.0")
    for name, options in pairs(optionsSubTables) do
        local appName = ("CustomAudio %s"):format(name)
        ACR:RegisterOptionsTable(appName, options or LibStub("AceDBOptions-3.0"):GetOptionsTable(self.db, true))
        ACD:AddToBlizOptions(appName, name, "CustomAudio")
    end
end

However, since you didn't post all of your code that can't be tested and your problem may be in unposted code.