Button on the minimap

Hubb777 · 04-11-24, 05:13 AM

Hi all. I created a button on the minimap. But I can’t get it to open another LUA file.

the button itself (triggered by LMB).

Lua Code:

local addonName, addon = ...
local addonName = "MyAddon"
local L = {} -- Localization table (if needed)
 
-- Check if the addon object is already registered
if not LibStub("LibDBIcon-1.0", true):GetMinimapButton(addonName) then
    -- Create the minimap icon
    local icon = LibStub("LibDBIcon-1.0")
    local minimapIcon = LibStub("LibDataBroker-1.1"):NewDataObject(addonName, {
        type = "data source",
        text = addonName,
        icon = "Interface\\AddOns\\TEST_ADDON\\Icons\\goblin", -- Replace with path to your icon
        OnClick = function(_, button)
            if button == "LeftButton" then
                MyAddonOptionsPanel_Toggle() -- Open or close the options panel
            end
        end,
        OnTooltipShow = function(tooltip)
            tooltip:SetText(addonName)
            tooltip:AddLine("Click to open options")
            tooltip:Show()
        end,
    })
 
    -- Register the minimap icon
    icon:Register(addonName, minimapIcon, MyAddonOptionsPanelDB) -- Replace MyAddonDB with your saved variables table name
end
 
-- Define the function to toggle the options panel
function MyAddonOptionsPanel_Toggle()
    -- Add code to open or close the options panel here
    print("Toggle options panel")
end

The frame that the button should open

Lua Code:

local panel = CreateFrame("Frame", "MyAddonOptionsPanel", InterfaceOptionsFrame)

Xrystal · 04-11-24, 06:11 AM

Your toggle function only displays text in the chat frame - did you check to see if it appeared ?

Lua Code:

function MyAddonOptionsPanel_Toggle()
    -- Add code to open or close the options panel here
    print("Toggle options panel")
end

If that text appeared then it is working, you just need to add your code to manage the opening and closing of the panel.

Hubb777 · 04-11-24, 07:51 AM

Originally Posted by Xrystal

Your toggle function only displays text in the chat frame - did you check to see if it appeared ?

Lua Code:

function MyAddonOptionsPanel_Toggle()
    -- Add code to open or close the options panel here
    print("Toggle options panel")
end

If that text appeared then it is working, you just need to add your code to manage the opening and closing of the panel.

Hello. Yes, the inscription "Toggle options panel" appears. How to add? I'm new to writing addons for wow.

Xrystal · 04-11-24, 10:37 AM

I've personally not used the Wow Options system, but I would try to use the example in the wiki page below. If you were aiming to have a panel inside the wow options screen like several addons have done before .. you might want to see how close you are to the example in there.

https://warcraft.wiki.gg/wiki/Using_...s_Addons_panel

Take note of the known bug mentioned in the small print at the bottom.

Hubb777 · 04-11-24, 11:50 PM

You gave an example of creating a panel. I was looking for how to open it through the “icon on the minimap”.

Xrystal · 04-12-24, 03:09 AM

Okay.

Which one of these were you hoping to implement ? Each one will involve different set up and calls to show up.

1. Display Panel in pre Dragonflight InterfaceOptionsFrame

Use example in https://warcraft.wiki.gg/wiki/Using_...s_Addons_panel to make sure your panel is correctly set up to work with the Interface Options Addons Panel system. And then use

`InterfaceOptionsFrame_OpenToCategory(panel)` to open the frame when you click your button ( you might have to call it twice for it to work as per the comment in the small print at the bottom. It will have a close button to close it again - no need to toggle.

2. Display your own custom panel on the main screen like any other frame you create.

In this case, make sure your frame has a background/backdrop and any other controls it needs. And then you can use the following function to toggle your panel to show or hide based on its current status when you click your button.

Example Code:

Lua Code:

local function TogglePanel(panel)
    if panel:IsShown() then
       panel:Hide()
   else
      panel:Show()
   end
end function

But you would have to change this

Lua Code:

local panel = CreateFrame("Frame", "MyAddonOptionsPanel", InterfaceOptionsFrame)
-- Rest of your panel creation code

To this

Lua Code:

local panel = CreateFrame("Frame", "MyAddonOptionsPanel",UIParent)
-- Rest of your panel creation code

3. Have your panel show up as part of the Dragonflight SettingsPanel

https://warcraft.wiki.gg/wiki/Patch_10.0.0/API_changes gives you some sort of example on how to set up your frame to be part of the settings panel. But not an example on how to jump to your panel.

There is a similar Settings.OpenToCategory() function which Fizzle points to in https://www.wowinterface.com/forums/...11&postcount=2 but it only goes to the AddOns tab and not a particular AddOns panel.

Xrystal · 04-12-24, 04:47 AM

Just copied the Dragonflight Settings example and tested a button click to open and Fizzles code works. It won't go straight to your addon page, but it will go to the addon page list section.

This was the code I used:

Lua Code:

local addonName, addonNS = ...
 
XSettings_PanelTest_SavedVariables = {}
local function OnSettingChanged(_, setting, value)
    local variable = setting:GetVariable()
    XSettings_PanelTest_SavedVariables[variable] = value
end
 
local category = Settings.RegisterVerticalLayoutCategory("XSettings_PanelTest")
 
do
    local variable = "toggle"
    local name = "Test Checkbox"
    local tooltip = "This is a tooltip for the checkbox."
    local defaultValue = false
 
    local setting = Settings.RegisterAddOnSetting(category, name, variable, type(defaultValue), defaultValue)
    Settings.CreateCheckBox(category, setting, tooltip)
    Settings.SetOnValueChangedCallback(variable, OnSettingChanged)
end
 
do
    local variable = "slider"
    local name = "Test Slider"
    local tooltip = "This is a tooltip for the slider."
    local defaultValue = 180
    local minValue = 90
    local maxValue = 360
    local step = 10
 
    local setting = Settings.RegisterAddOnSetting(category, name, variable, type(defaultValue), defaultValue)
    local options = Settings.CreateSliderOptions(minValue, maxValue, step)
    options:SetLabelFormatter(MinimalSliderWithSteppersMixin.Label.Right);
    Settings.CreateSlider(category, setting, options, tooltip)
    Settings.SetOnValueChangedCallback(variable, OnSettingChanged)
end
 
do
    local variable = "selection"
    local defaultValue = 2  -- Corresponds to "Option 2" below.
    local name = "Test Dropdown"
    local tooltip = "This is a tooltip for the dropdown."
 
    local function GetOptions()
        local container = Settings.CreateControlTextContainer()
        container:Add(1, "Option 1")
        container:Add(2, "Option 2")
        container:Add(3, "Option 3")
        return container:GetData()
    end
 
    local setting = Settings.RegisterAddOnSetting(category, name, variable, type(defaultValue), defaultValue)
    Settings.CreateDropDown(category, setting, GetOptions, tooltip)
    Settings.SetOnValueChangedCallback(variable, OnSettingChanged)
end
 
Settings.RegisterAddOnCategory(category)
 
 
local btn = CreateFrame("Button", nil, UIParent, "UIPanelButtonTemplate")
btn:SetPoint("CENTER")
btn:SetSize(100, 40)
btn:SetText("Click me")
btn:SetScript("OnClick", function(self, button, down)
    Settings.OpenToCategory()   
    SettingsPanel.AddOnsTab:Click()
end)
btn:RegisterForClicks("AnyDown", "AnyUp")

Hubb777 · 04-12-24, 04:47 AM

I need the settings menu for my addon to open.
How it works for me now (a menu with game settings opens)

How I want it to work (my addon settings should open)

Here is my final code

Lua Code:

local addonName, addon = ...
local addonName = "MyAddon"
local L = {} -- Localization table (if needed)
 
-- Check if the addon object is already registered
if not LibStub("LibDBIcon-1.0", true):GetMinimapButton(addonName) then
    -- Create the minimap icon
    local icon = LibStub("LibDBIcon-1.0")
    local minimapIcon = LibStub("LibDataBroker-1.1"):NewDataObject(addonName, {
        type = "data source",
        text = addonName,
        icon = "Interface\\AddOns\\ZamestoTV_GoldFarm\\Icons\\goblin", -- Replace with path to your icon
        OnClick = function(_, button)
            if button == "LeftButton" then
                MyAddonOptionsPanel_Toggle() -- Open or close the options panel
            end
        end,
        OnTooltipShow = function(tooltip)
            tooltip:SetText(addonName)
            tooltip:AddLine("Click to open options")
            tooltip:Show()
        end,
    })
 
    -- Register the minimap icon
    icon:Register(addonName, minimapIcon, MyAddonOptionsPanelDB) -- Replace MyAddonDB with your saved variables table name
end
 
-- Define the function to toggle the options panel
function MyAddonOptionsPanel_Toggle()
    -- Add code to open or close the options panel here
    InterfaceOptionsFrame_OpenToCategory("MyAddonOptionsPanel") -- Open options panel to a specific category
    print("Toggle options panel")
end
 
-- Define the function to toggle the panel visibility
local function TogglePanel(panel)
    if panel:IsShown() then
        panel:Hide()
    else
        panel:Show()
    end
end

Xrystal · 04-12-24, 07:22 AM

Yes, my last example, 2 lines in the OnClick script will open the settings panel to the addon list page. There doesn't seem to be a way addons can open to their own section of the settings by code. Maybe it is protected and needs the user to select the item in the list.

Where is the code where you set up your settings/options page ?

You might still have stuff missing to make it work.

And how you have done it will determine whether you need to use

Lua Code:

InterfaceOptions_OpenToCategory("AddonName")

or

Lua Code:

Settings.OpenToCategory(category:GetID())

As a reminder:
This link gives you an example on how to use the OLD InterfaceOptionsFrame way of adding a settings page. And includes the example on how to show the page on request.
https://warcraft.wiki.gg/wiki/Using_...s_Addons_panel

This post from 2 years ago talks through a few problems people have had getting it to work. It might help you.
https://www.wowinterface.com/forums/...ad.php?t=57172

Bear in mind that the

Lua Code:

InterfaceOptionsFrame_OpenToCategory("MyAddonOptionsPanel")

line is deprecated in Dragonflight and will be removed eventually.

Instead it is replaced with

Lua Code:

Settings.OpenToCategory()

So, you might want to consider using the new Settings functionality added in Dragonflight. This will save you having to figure it out again later when it stops working when the functionality is removed.

But you have to set up your settings page to work with Blizzards Settings ( my last block of code gives an example of how one of those ways works - Vertical Display - and the link below also includes the Canvas route and that is the closest to the old InterfaceOptions way).

As a reminder:
https://warcraft.wiki.gg/wiki/Patch_...s#Settings_API Gives you an example of how to set that up ( my last code block is a copy of this with a button to click it open added.

You can then use the following to open up the settings frame and show the addon page ( finally managed to get it work with my example with the following in the OnClick function.

Lua Code:

Settings.OpenToCategory(category:GetID())

category is set up when you create your settings panel and connect it to the settings system.

So .. depending on how you have created your panel, will determine which version you use and whether it will work or not.

Hubb777 · 04-12-24, 10:02 PM

Looks like I didn't succeed =(

I added this to the code of the panel that I want to open:

Lua Code:

local category = Settings.RegisterCanvasLayoutCategory(panel, "MyAddonOptionsPanel")
    Settings.RegisterAddOnCategory(category)

I also changed the button code on the minimap

Lua Code:

local addonName, addon = ...
-- Create the minimap icon
local addonName = "MyAddon"
local LDB = LibStub("LibDataBroker-1.1")
local minimapIcon = LibStub("LibDBIcon-1.0")
 
-- Create a data broker object for the addon
local dataBroker = LDB:NewDataObject(addonName, {
    type = "data source",
    icon = "Interface\\AddOns\\ZamestoTV_GoldFarm\\Icons\\goblin", -- Replace with your addon's icon path
    OnClick = function(self, button)
        if button == "LeftButton" then
            local categoryID = MyAddonOptionsPanel:GetID() -- Replace with your addon's options panel ID
            Settings.OpenToCategory(categoryID)
        end
    end,
})
 
-- Register the data broker with the minimap icon
minimapIcon:Register(addonName, dataBroker, {
    hide = false,
    minimapPos = 180, -- Set the position on the minimap (in degrees)
})
 
-- Add a function to set the category ID for opening
function addon:SetOptionsPanelCategory(categoryID)
    MyAddonOptionsPanel:SetID(categoryID)
end

As a result, the button works without changes (using the example with the pictures above)

Xrystal · 04-13-24, 01:28 AM

So is it working as you wanted or not ?

Is it opening to your addon's settings panel ?
Is it showing all the controls you set up for it ?
Is it saving the settings between play sessions ( if you wanted it to do that )

Hubb777 · 04-13-24, 04:06 AM

How I have it now (and how it was before): I click on the “icon on the minimap” and the “game settings” open (see picture below)

How I want: When I click the “icon on the minimap”, the settings of my addon “MyAddonOptionsPanel” open. (see picture below)

Xrystal · 04-13-24, 04:19 AM

Your code must still be missing something which is why I asked to see the code where you create your settings panel. How you create that will determine how you display it.

Xrystal · 04-13-24, 04:40 AM

I would suggest you try creating a simple addon that just shows a settings panel, using the example code on the wiki.gg page I linked. Once you have seen how that works, you can add your addon's functionality.

It was what I did to figure out how it worked so I could explain it to you.

Hubb777 · 04-13-24, 05:13 AM

Originally Posted by Xrystal

Your code must still be missing something which is why I asked to see the code where you create your settings panel. How you create that will determine how you display it.

Sorry. Looks like I didn't see it. Here is the panel code.

Lua Code:

local addonName, addon = ...
-- Create a function to add options to the Interface Options Addons panel
local function AddAddonOptions()
    local panel = CreateFrame("Frame", "MyAddonOptionsPanel", UIParent)
    panel.name = "ZamestoTV: Gold" -- Replace "MyAddon" with your addon's name
 
    -- Create a checkbox for QuestCompletionFrame
    local completionCheckBox = CreateFrame("CheckButton", "QuestCompletionFrameCheckbox", panel, "InterfaceOptionsCheckButtonTemplate")
    completionCheckBox:SetPoint("TOPLEFT", 16, -16)
    completionCheckBox.Text:SetText("Enable Quest Completion Frame") -- Replace with your desired default text
    completionCheckBox.tooltipText = "Enable the Quest Completion Frame" -- Replace with your desired default tooltip text
 
    completionCheckBox:SetScript("OnClick", function(self)
        local isChecked = self:GetChecked()
        -- Handle the checkbox state change here
        if isChecked then
            -- Checkbox is checked, enable QuestCompletionFrame
            QuestCompletionFrame:Show()
        else
            -- Checkbox is unchecked, disable QuestCompletionFrame
            QuestCompletionFrame:Hide()
        end
    end)
 
    -- Create a checkbox for ZAMTimer777 frame
    local timerCheckBox = CreateFrame("CheckButton", "ZAMTimer777Checkbox", panel, "InterfaceOptionsCheckButtonTemplate")
    timerCheckBox:SetPoint("TOPLEFT", completionCheckBox, "BOTTOMLEFT", 0, -8)
    timerCheckBox.Text:SetText("Enable ZAMTimer777 Frame") -- Replace with your desired default text
    timerCheckBox.tooltipText = "Enable the ZAMTimer777 Frame" -- Replace with your desired default tooltip text
 
    timerCheckBox:SetScript("OnClick", function(self)
        local isChecked = self:GetChecked()
        -- Handle the checkbox state change here
        if isChecked then
            -- Checkbox is checked, enable ZAMTimer777 frame
            ZAMTimer777:Show()
        else
            -- Checkbox is unchecked, disable ZAMTimer777 frame
            ZAMTimer777:Hide()
        end
    end)
 
    -- Add the panel to the Interface Options Addons category
    InterfaceOptions_AddCategory(panel)
 
    -- Handle language localization
    local locale = GetLocale()
    if locale == "deDE" then
        -- German localization
        completionCheckBox.Text:SetText("Aufgabenliste: Ein-/Ausblenden")
        completionCheckBox.tooltipText = "Aufgabenliste: Ein-/Ausblenden"
        timerCheckBox.Text:SetText("Timer: Ein-/Ausblenden")
        timerCheckBox.tooltipText = "Timer: Ein-/Ausblenden"
        panel.name = "ZamestoTV: Gold"
    elseif locale == "enUS" then
        -- English localization
        completionCheckBox.Text:SetText("To Do List: Show/Hide")
        completionCheckBox.tooltipText = "To Do List: Show/Hide"
        timerCheckBox.Text:SetText("Timer: Show/Hide")
        timerCheckBox.tooltipText = "Timer: Show/Hide"
        panel.name = "ZamestoTV: Gold"
    end
end
 
-- Register the addon-specific options when the player logs in
local frame = CreateFrame("FRAME")
frame:RegisterEvent("PLAYER_LOGIN")
frame:SetScript("OnEvent", function()
    AddAddonOptions()
end)

I'm new to writing LUA, but I was advised to use ChatGPT (with the help of it I was able to create the panel code and the "icons on the minimap" code)

Xrystal · 04-13-24, 05:50 AM

That's understandable.

ChatGPT may not be wise enough to realise new addons are probably best to use new functions rather than ones that will be gone by the next expansion.

Looking at your code I can see you have mixed and matched the two ways ( new and old ) which explains why it doesn't quite work as you expected.

Let me rig up a version of this panel frame that should work.

Hubb777 · 04-13-24, 06:12 AM

Originally Posted by Xrystal

Let me rig up a version of this panel frame that should work.

It would be fantastic.

Xrystal · 04-13-24, 06:34 AM

Okay. These are all the files I needed to make it work. Remember order in the toc is important with separate files.

TOC File - Remember to change Title/Author/Version/SavedVariables/Notes to suit your addon

Lua Code:

## Interface: 100207
## Title: TestAddonSettings
## Author: Xrystal (c) 2024  All Rights Reserved
## Version: 0.0.1.001
## Notes: Testing Addon Settings
## RequiredDeps: 
## OptionalDeps: 
## DefaultState: Enabled
## LoadOnDemand: 0
## SavedVariables: TestingAddonSettingsData
## SavedVariablesPerCharacter: 
 
SettingsPanel.lua
MinimapButton.lua

SettingsPanel.lua - Remember to use unique frame names if you need to use frame names.
I have made some notes in here.
This has to be loaded before your MinimapButton tries to reference it.

Lua Code:

local addonName, addon = ...
 
-- Create a function to add options to the Interface Options Addons panel
local function AddAddonOptions()
    
    -- Create Panel with unique frame name
    local panel = CreateFrame("Frame", "ZTVOptionsPanel", UIParent)
    
    -- Give it a more friendly display name
    panel.name = "ZamestoTV: Gold" 
 
    -- Create a checkbox for QuestCompletionFrame with unique name
    local completionCheckBox = CreateFrame("CheckButton", "ZTV_QuestCompletionFrameCheckbox", panel, "InterfaceOptionsCheckButtonTemplate")
    completionCheckBox:SetPoint("TOPLEFT", 16, -16)
    completionCheckBox.Text:SetText("Enable Quest Completion Frame") -- Replace with your desired default text
    completionCheckBox.tooltipText = "Enable the Quest Completion Frame" -- Replace with your desired default tooltip text
 
    -- If QuestCompletionFrame is your own frame I would suggest giving it a unique name like adding ZTV_ infront like I did above
    completionCheckBox:SetScript("OnClick", function(self)
        local isChecked = self:GetChecked()
        -- Handle the checkbox state change here
        if isChecked then
            -- Checkbox is checked, enable QuestCompletionFrame
            QuestCompletionFrame:Show()
        else
            -- Checkbox is unchecked, disable QuestCompletionFrame
            QuestCompletionFrame:Hide()
        end
    end)
 
    -- Create a checkbox for ZAMTimer777 frame
    local timerCheckBox = CreateFrame("CheckButton", "ZAMTimer777Checkbox", panel, "InterfaceOptionsCheckButtonTemplate")
    timerCheckBox:SetPoint("TOPLEFT", completionCheckBox, "BOTTOMLEFT", 0, -8)
    timerCheckBox.Text:SetText("Enable ZAMTimer777 Frame") -- Replace with your desired default text
    timerCheckBox.tooltipText = "Enable the ZAMTimer777 Frame" -- Replace with your desired default tooltip text
 
    timerCheckBox:SetScript("OnClick", function(self)
        local isChecked = self:GetChecked()
        -- Handle the checkbox state change here
        if isChecked then
            -- Checkbox is checked, enable ZAMTimer777 frame
            ZAMTimer777:Show()
        else
            -- Checkbox is unchecked, disable ZAMTimer777 frame
            ZAMTimer777:Hide()
        end
    end)
 
    -- Add the panel to the Interface Options Addons category
    -- InterfaceOptions_AddCategory(panel)  -- this is the old way
    
    -- Use the new way to register this set up as a Canvas Layout ( which gives similar layout control back to the addon creator )
    -- Notice I have added this to the addon wide data table to ensure other files have access to this category value.
    -- Also notice that I have given the category a link to the addonName.  This should be what shows up on the list of addons.
    -- You MIGHT be able to use panel.name though
    addon.category = Settings.RegisterCanvasLayoutCategory(panel, addonName)
    Settings.RegisterAddOnCategory(addon.category)
 
    -- Handle language localization
    local locale = GetLocale()
    if locale == "deDE" then
        -- German localization
        completionCheckBox.Text:SetText("Aufgabenliste: Ein-/Ausblenden")
        completionCheckBox.tooltipText = "Aufgabenliste: Ein-/Ausblenden"
        timerCheckBox.Text:SetText("Timer: Ein-/Ausblenden")
        timerCheckBox.tooltipText = "Timer: Ein-/Ausblenden"
        panel.name = "ZamestoTV: Gold"
    elseif locale == "enUS" then
        -- English localization
        completionCheckBox.Text:SetText("To Do List: Show/Hide")
        completionCheckBox.tooltipText = "To Do List: Show/Hide"
        timerCheckBox.Text:SetText("Timer: Show/Hide")
        timerCheckBox.tooltipText = "Timer: Show/Hide"
        panel.name = "ZamestoTV: Gold"
    end
end
 
-- Register the addon-specific options when the player logs in
local frame = CreateFrame("FRAME")
frame:RegisterEvent("PLAYER_LOGIN")
frame:SetScript("OnEvent", function()
    AddAddonOptions()
end)

MinimapButton.lua - Didn't have to change much here - just where the category value was stored and the name of the SavedVariables table which isn't used in your code but needs to be set up and the icon I used on the minimap button.

Lua Code:

local addonName, addon = ...
 
-- Check if the addon object is already registered
if not LibStub("LibDBIcon-1.0", true):GetMinimapButton(addonName) then
    -- Create the minimap icon
    local icon = LibStub("LibDBIcon-1.0")
    local minimapIcon = LibStub("LibDataBroker-1.1"):NewDataObject(addonName, {
        type = "data source",
        text = addonName,
        icon = "Interface\\BUTTONS\\UI-GroupLoot-Dice-Up", -- Replace with path to your icon
        OnClick = function(_, button)
            if button == "LeftButton" then
                Settings.OpenToCategory(addon.category:GetID()) -- Open or close the options panel
            end
        end,
        OnTooltipShow = function(tooltip)
            tooltip:SetText(addonName)
            tooltip:AddLine("Click to open options")
            tooltip:Show()
        end,
    })
 
    -- Register the minimap icon
    icon:Register(addonName, minimapIcon, TestingAddonSettingsData) -- Replace MyAddonDB with your saved variables table name
end

Xrystal · 04-13-24, 06:38 AM

Remember the code I attached just has the addon settings panel and the minimap button code. The rest of your addon code will need to be added to the toc file if you use my version of the code as the base of the addon. Or vice versa if you pull in my version of the code to your addon. Remember to remove or comment out the old code the new code is replacing so there isn't any conflict.

Edit:
Also, this was tested on the ptr 10.2.7 so we know this code will work with the next patch.

Hubb777 · 04-13-24, 07:00 AM

yes it works. Thank you very much
As I understand it, this part of the code in the “panel” answers: the panel will open through the minimap icon yes/no? Right?

Lua Code:

addon.category = Settings.RegisterCanvasLayoutCategory(panel, addonName)
    Settings.RegisterAddOnCategory(addon.category)

Is this part of the code in the “minimap icon” code?

Lua Code:

OnClick = function(_, button)
            if button == "LeftButton" then
                Settings.OpenToCategory(addon.category:GetID()) -- Open or close the options panel
            end
        end,

Can I add these parts to my other addon and everything will work there too? Or am I missing something?