I've just begun the process to update my addon from Ace2 to Ace3 and I haven't been reading the forums, or looking at addon source for quite some time so I'm a bit out of the loop when it comes to all the changes.
Currently my addon (EveryQuest) works okay with Ace2, but it is quite ugly in terms of the source. I never really got good at Lua and would just trial and error everything until something worked. I'd rather not have to start completly over with an Ace3 version to trial and error everything.
Here's my situation:
My addon uses Quixote-1.0, there's a new LibStub version, LibQuixote-2.0 that uses CallbackHandler. Currently all the documentation for CallbackHandler is how to use it in a library not how to use the library in an addon that uses it.
In the start of my code, I have:
EveryQuest = LibStub("AceAddon-3.0"):NewAddon("EveryQuest", "AceConsole-3.0", "AceEvent-3.0")
local Quixote = LibStub("LibQuixote-2.0")
local L = LibStub("AceLocale-3.0"):GetLocale("EveryQuest")
The first of the arguments is the name of the callback that is being made available by Quixote, and the second is the name of the function to be called. Am I correct so far? Also, please explain the actual function that is being called, is it EveryQuest:Quest_Gained()? or just Quest_Gained(), would it be the first if I Mixin Quixote?
The second problem I have is I use DewdropLib for my zone selection menu. Though I saw somewhere that there's an AceConfig for dropdown menus. Could someone explain how I would go about creating a standalone dropdown menu? This menu is tied to a [FONT=Courier New]UIDropDownMenuTemplate[/FONT] frame. I also use Dewdrop for rightclicking a quest in the list to change it's status.
The third question is about profiles. By default in Ace2, it created profiles and you could access the current profile using [FONT=Courier New]self.db.profile[/FONT] and [FONT=Courier New]self.db.char[/FONT]. My addon absolutely needs to be able to access the old Ace2 DB files. EveryQuest stores the quest history per-character and the rest of the settings account wide.
In relation to profiles, when setting up the DB in Ace2 I setup defaults, 1 set of defaults for per-character, and another for profiles. How does this work in Ace3. I found an example that shows it like this: (The WelcomeHome Ace3 version)
function mod:OnModuleEnable()
Prat.RegisterChatEvent(self,"Prat_PreAddMessage")
end
function mod:OnModuleDisable()
Prat.UnregisterAllChatEvents(self)
end
function mod:Prat_PreAddMessage(event, ...)
-- event == "Prat_PreAddMessage" btw
end
function mod:OnModuleEnable()
Prat.RegisterChatEvent(self,"Prat_PreAddMessage")
end
function mod:OnModuleDisable()
Prat.UnregisterAllChatEvents(self)
end
function mod:Prat_PreAddMessage(event, ...)
-- event == "Prat_PreAddMessage" btw
end
So the name of the register function depends on the library you are using?
I've just begun the process to update my addon from Ace2 to Ace3 and I haven't been reading the forums, or looking at addon source for quite some time so I'm a bit out of the loop when it comes to all the changes.
My best advice to you is to read existing source code of Ace3 addons. Omen3 shouldn't be too horrible to read for example. :)
EveryQuest = LibStub("AceAddon-3.0"):NewAddon("EveryQuest", "AceConsole-3.0", "AceEvent-3.0")
local Quixote = LibStub("LibQuixote-2.0")
local L = LibStub("AceLocale-3.0"):GetLocale("EveryQuest")
The first of the arguments is the name of the callback that is being made available by Quixote, and the second is the name of the function to be called. Am I correct so far? Also, please explain the actual function that is being called, is it EveryQuest:Quest_Gained()? or just Quest_Gained(), would it be the first if I Mixin Quixote?
EveryQuest:Quest_Gained() gets called if you mixed it in. If you had registered it as
Quixote:RegisterCallback("Quest_Gained", Quest_Gained)
without the quotations, then Quest_Gained() would be called instead, assuming Quest_Gained is a function. You can see GatherMate using callbacks by using AceEvent-3.0 (which is a wrapper around CBH)
The second problem I have is I use DewdropLib for my zone selection menu. Though I saw somewhere that there's an AceConfig for dropdown menus. Could someone explain how I would go about creating a standalone dropdown menu? This menu is tied to a [FONT=Courier New]UIDropDownMenuTemplate[/FONT] frame. I also use Dewdrop for rightclicking a quest in the list to change it's status.
There is a simple dropdown menu in Omen3 (when right clicking the title bar). Search for "Omen_TitleDropDownMenu" in the file.
You can also look at Gathermate, HandyNotes for examples of more simple dropdown menus. Note that in these examples I've listed, [FONT=Courier New]UIDropDownMenuTemplate[/FONT] is NOT used at all. Its only used if you want the nice horizontal long select box dropdown display with a nice arrow down button.
The third question is about profiles. By default in Ace2, it created profiles and you could access the current profile using [FONT=Courier New]self.db.profile[/FONT] and [FONT=Courier New]self.db.char[/FONT]. My addon absolutely needs to be able to access the old Ace2 DB files. EveryQuest stores the quest history per-character and the rest of the settings account wide.
You're in trouble. AceDB-3.0 does not read AceDB-2.0 data. You should preferably use a different savedvariable in your addon for your 3.0 version of the addon, but also load the 2.0 savedvariable data (its just a table), and write a custom function to import the data from your old 2.0 SV (you'll have to figure out how to read the data (the SV data also does not save values that are equal to the defaults) to the 3.0 SV. Once conversion is successful, you can then nil out or empty the old Savedvariable. Your ## SavedVariables field in the TOC can certainly specify more than one variable.
In relation to profiles, when setting up the DB in Ace2 I setup defaults, 1 set of defaults for per-character, and another for profiles. How does this work in Ace3. I found an example that shows it like this: (The WelcomeHome Ace3 version)
You're in trouble. AceDB-3.0 does not read AceDB-2.0 data. You should preferably use a different savedvariable in your addon for your 3.0 version of the addon, but also load the 2.0 savedvariable data (its just a table), and write a custom function to import the data from your old 2.0 SV (you'll have to figure out how to read the data (the SV data also does not save values that are equal to the defaults) to the 3.0 SV. Once conversion is successful, you can then nil out or empty the old Savedvariable. Your ## SavedVariables field in the TOC can certainly specify more than one variable.
So for me to read the Ace2 version's data, I have to change
## SavedVariables: EveryQuestDB
## SavedVariablesPerCharacter: EveryQuestDBPC
to
## SavedVariables: EveryQuestDB, EQ2DB
## SavedVariablesPerCharacter: EveryQuestDBPC, EQ2DBPC
Setup AceDB-3.0 to use EQ2DB and EQ2DBPC, then read EveryQuestDB and EveryQuestDBPC after VARIABLES_LOADED event has fired, then migrate it all to the AceDB-3.0?
Just use one Variable. IF you need something per char, just use the db.char table..
And put your DB decleration for AceDB-3 in the addon's OnInit() function.
Just use one Variable. IF you need something per char, just use the db.char table..
And put your DB decleration for AceDB-3 in the addon's OnInit() function.
Everything I save is per-character since it's quest history, only applies to 1 character. So if I use db.char that will only load that character's data? Since the db.char.history table gets very large once people start doing quests. Upwards of 50 additional tables, inside those a table for every quest the player has seen.
Plus what Xinhuan was saying is that AceDB-3.0 doesn't read AceDB-2.0 variables. So that I'd need to create a new AceDB-3.0 variable and read the original EveryQuestDB afterward not using AceDB-3.0
So for me to read the Ace2 version's data, I have to change
## SavedVariables: EveryQuestDB
## SavedVariablesPerCharacter: EveryQuestDBPC
to
## SavedVariables: EveryQuestDB, EQ2DB
## SavedVariablesPerCharacter: EveryQuestDBPC, EQ2DBPC
Setup AceDB-3.0 to use EQ2DB and EQ2DBPC, then read EveryQuestDB and EveryQuestDBPC after VARIABLES_LOADED event has fired, then migrate it all to the AceDB-3.0?
Yes, that is correct. After the migration, you can delete all the data in EveryQuestDB and EveryQuestDBPC so that the file just saves nothing in those variables. You'll still be loading/saving both variables, but you'll only be using one of them. You'll need to add checks or another flag as to whether migration has already taken place, such as EveryQuestDBPC.migrated = true.
Everything I save is per-character since it's quest history, only applies to 1 character. So if I use db.char that will only load that character's data? Since the db.char.history table gets very large once people start doing quests. Upwards of 50 additional tables, inside those a table for every quest the player has seen.
Orionshock is incorrect. Data stored in db.char is loaded across all characters if you registered the db as a global savedvariable.
Only data registered with AceDB-3.0 using a character specific SV is char specific. You will want to
## SavedVariables: EveryQuestDB, EQ2DB
## SavedVariablesPerCharacter: EveryQuestDBPC, EQ2DBPC
function EveryQuest2:OnInitialize()
self.db = LibStub("AceDB-3.0"):New("EQ2DB", defaults)
self.dbpc = LibStub("AceDB-3.0"):New("EQ2DBPC", defaultspc)
-- Check contents of EveryQuestDB and EveryQuestDBPC and migrate
-- You should not delete any data in EveryQuestDB/EveryQuestDBPC
-- until you are absolutely sure the migration is successful.
end
For 2 (or more) level menus, one of your menu items on the 1st level would have
info.text = "my sub menu"
info.hasArrow = 1
info.value = "some id string"
UIDropDownMenu_AddButton(info, level)
Now remember the function has a argument passed in called "level"
if (level == 1) then -- this is a 1st level menu
-- blah blah
elseif (level == 2) then -- this is a 2nd level menu
if UIDROPDOWNMENU_MENU_VALUE == "some id string" then
info.blah = blah
info.blah = blah
UIDropDownMenu_AddButton(info, level)
elseif UIDROPDOWNMENU_MENU_VALUE == "some other id string" then
info.blah = blah
info.blah = blah
UIDropDownMenu_AddButton(info, level)
end
end
Edit:
Note that you can actually assign anything to info.value, which gets assigned to the global variable UIDROPDOWNMENU_MENU_VALUE so you can identify what submenu to display, but strings are preferred.
So all you now need is a nice set of loops to do this for your quest-categories.
I've just begun the process to update my addon from Ace2 to Ace3 and I haven't been reading the forums, or looking at addon source for quite some time so I'm a bit out of the loop when it comes to all the changes.
Currently my addon (EveryQuest) works okay with Ace2, but it is quite ugly in terms of the source. I never really got good at Lua and would just trial and error everything until something worked. I'd rather not have to start completly over with an Ace3 version to trial and error everything.
Here's my situation:
My addon uses Quixote-1.0, there's a new LibStub version, LibQuixote-2.0 that uses CallbackHandler. Currently all the documentation for CallbackHandler is how to use it in a library not how to use the library in an addon that uses it.
In the start of my code, I have:
EveryQuest = LibStub("AceAddon-3.0"):NewAddon("EveryQuest", "AceConsole-3.0", "AceEvent-3.0") local Quixote = LibStub("LibQuixote-2.0") local L = LibStub("AceLocale-3.0"):GetLocale("EveryQuest")I've seen something along the lines ofQuixote:RegisterCallback("Quest_Gained", "Quest_Gained")The first of the arguments is the name of the callback that is being made available by Quixote, and the second is the name of the function to be called. Am I correct so far? Also, please explain the actual function that is being called, is it EveryQuest:Quest_Gained()? or just Quest_Gained(), would it be the first if I Mixin Quixote?The second problem I have is I use DewdropLib for my zone selection menu. Though I saw somewhere that there's an AceConfig for dropdown menus. Could someone explain how I would go about creating a standalone dropdown menu? This menu is tied to a [FONT=Courier New]UIDropDownMenuTemplate[/FONT] frame. I also use Dewdrop for rightclicking a quest in the list to change it's status.
The third question is about profiles. By default in Ace2, it created profiles and you could access the current profile using [FONT=Courier New]self.db.profile[/FONT] and [FONT=Courier New]self.db.char[/FONT]. My addon absolutely needs to be able to access the old Ace2 DB files. EveryQuest stores the quest history per-character and the rest of the settings account wide.
In relation to profiles, when setting up the DB in Ace2 I setup defaults, 1 set of defaults for per-character, and another for profiles. How does this work in Ace3. I found an example that shows it like this: (The WelcomeHome Ace3 version)
self.db = LibStub("AceDB-3.0"):New("EveryQuestDB", defaults, "global")But in the WelcomeHome page, it doesn't actually show the table called defaults.Thank you,
kandarz
-
View User Profile
-
View Posts
-
Send Message
Curse Premium-
View User Profile
-
View Posts
-
Send Message
Curse Premiumlocal defaults = { realm = { }, profile = { }, char = { } }So the name of the register function depends on the library you are using?
-
View User Profile
-
View Posts
-
Send Message
Curse Premium-
View User Profile
-
View Posts
-
Send Message
Curse PremiumMy best advice to you is to read existing source code of Ace3 addons. Omen3 shouldn't be too horrible to read for example. :)
There are lots of other Ace3 addons.
EveryQuest:Quest_Gained() gets called if you mixed it in. If you had registered it as
Quixote:RegisterCallback("Quest_Gained", Quest_Gained)
without the quotations, then Quest_Gained() would be called instead, assuming Quest_Gained is a function. You can see GatherMate using callbacks by using AceEvent-3.0 (which is a wrapper around CBH)
GatherMate:SendMessage("GatherMateConfigChanged")
Display:RegisterMessage("GatherMateConfigChanged","ConfigChanged")
There is a simple dropdown menu in Omen3 (when right clicking the title bar). Search for "Omen_TitleDropDownMenu" in the file.
You can also look at Gathermate, HandyNotes for examples of more simple dropdown menus. Note that in these examples I've listed, [FONT=Courier New]UIDropDownMenuTemplate[/FONT] is NOT used at all. Its only used if you want the nice horizontal long select box dropdown display with a nice arrow down button.
You're in trouble. AceDB-3.0 does not read AceDB-2.0 data. You should preferably use a different savedvariable in your addon for your 3.0 version of the addon, but also load the 2.0 savedvariable data (its just a table), and write a custom function to import the data from your old 2.0 SV (you'll have to figure out how to read the data (the SV data also does not save values that are equal to the defaults) to the 3.0 SV. Once conversion is successful, you can then nil out or empty the old Savedvariable. Your ## SavedVariables field in the TOC can certainly specify more than one variable.
Alternatively you will need to use Ace2 itself.
Sylvanaar's answered this one.
So for me to read the Ace2 version's data, I have to change
## SavedVariables: EveryQuestDB
## SavedVariablesPerCharacter: EveryQuestDBPC
to
## SavedVariables: EveryQuestDB, EQ2DB
## SavedVariablesPerCharacter: EveryQuestDBPC, EQ2DBPC
Setup AceDB-3.0 to use EQ2DB and EQ2DBPC, then read EveryQuestDB and EveryQuestDBPC after VARIABLES_LOADED event has fired, then migrate it all to the AceDB-3.0?
-
View User Profile
-
View Posts
-
Send Message
Curse Premium##Saved Variables: EveryQuestDB
Just use one Variable. IF you need something per char, just use the db.char table..
And put your DB decleration for AceDB-3 in the addon's OnInit() function.
Everything I save is per-character since it's quest history, only applies to 1 character. So if I use db.char that will only load that character's data? Since the db.char.history table gets very large once people start doing quests. Upwards of 50 additional tables, inside those a table for every quest the player has seen.
Plus what Xinhuan was saying is that AceDB-3.0 doesn't read AceDB-2.0 variables. So that I'd need to create a new AceDB-3.0 variable and read the original EveryQuestDB afterward not using AceDB-3.0
-
View User Profile
-
View Posts
-
Send Message
Curse PremiumYes, that is correct. After the migration, you can delete all the data in EveryQuestDB and EveryQuestDBPC so that the file just saves nothing in those variables. You'll still be loading/saving both variables, but you'll only be using one of them. You'll need to add checks or another flag as to whether migration has already taken place, such as EveryQuestDBPC.migrated = true.
-
View User Profile
-
View Posts
-
Send Message
Curse PremiumOrionshock is incorrect. Data stored in db.char is loaded across all characters if you registered the db as a global savedvariable.
Only data registered with AceDB-3.0 using a character specific SV is char specific. You will want to
## SavedVariables: EveryQuestDB, EQ2DB ## SavedVariablesPerCharacter: EveryQuestDBPC, EQ2DBPC function EveryQuest2:OnInitialize() self.db = LibStub("AceDB-3.0"):New("EQ2DB", defaults) self.dbpc = LibStub("AceDB-3.0"):New("EQ2DBPC", defaultspc) -- Check contents of EveryQuestDB and EveryQuestDBPC and migrate -- You should not delete any data in EveryQuestDB/EveryQuestDBPC -- until you are absolutely sure the migration is successful. endlocal zonemenu = { -- Dropdown Zone list ["Eastern Kingdoms"] = { ["Alterac Mountains"] = 36, ["Arathi Highlands"] = 45, ["Badlands"] = 3, ["Blackrock Mountain"] = 25, ["Blasted Lands"] = 4, ["Burning Steppes"] = 46, ["Dalaran"] = 279, ["Deadwind Pass"] = 41, ["Deeprun Tram"] = 2257, ["Dun Morogh"] = 1, ["Duskwood"] = 10, ["Eastern Plaguelands"] = 139, ["Elwynn Forest"] = 12, ["Eversong Woods"] = 3430, ["Ghostlands"] = 3433, ["Hillsbrad Foothills"] = 267, ["Ironforge"] = 1537, ["Isle of Quel'Danas"] = 4080, ["Loch Modan"] = 38, ["Redridge Mountains"] = 44, ["Searing Gorge"] = 51, ["Silvermoon City"] = 3487, ["Silverpine Forest"] = 130, ["Stormwind City"] = 1519, ["Stranglethorn Vale"] = 33, ["Swamp of Sorrows"] = 8, ["The Hinterlands"] = 47, ["Tirisfal Glades"] = 85, ["Undercity"] = 1497, ["Western Plaguelands"] = 28, ["Westfall"] = 40, ["Wetlands"] = 11, }, ["Kalimdor"] = { ["Ashenvale"] = 331, ["Azshara"] = 16, ["Azuremyst Isle"] = 3524, ["Bloodmyst Isle"] = 3525, ["Darkshore"] = 148, ["Darnassus"] = 1657, ["Desolace"] = 405, ["Durotar"] = 14, ["Dustwallow Marsh"] = 15, ["Felwood"] = 361, ["Feralas"] = 357, ["Moonglade"] = 493, ["Mulgore"] = 215, ["Orgrimmar"] = 1637, ["Silithus"] = 1377, ["Stonetalon Mountains"] = 406, ["Tanaris"] = 440, ["Teldrassil"] = 141, ["The Barrens"] = 17, ["The Exodar"] = 3557, ["Thousand Needles"] = 400, ["Thunder Bluff"] = 1638, ["Timbermaw Hold"] = 1216, ["Un'Goro Crater"] = 490, ["Winterspring"] = 618, }, ["Outland"] = { ["Blade's Edge Mountains"] = 3522, ["Hellfire Peninsula"] = 3483, ["Nagrand"] = 3518, ["Netherstorm"] = 3523, ["Shadowmoon Valley"] = 3520, ["Shattrath City"] = 3703, ["Skettis"] = 3679, ["Terokkar Forest"] = 3519, ["Zangarmarsh"] = 3521, }, ["Northrend"] = { ["Borean Tundra"] = 3537, ["Coldarra"] = 4024, ["Dalaran"] = 4395, ["Dragonblight"] = 65, ["Grizzly Hills"] = 394, ["Howling Fjord"] = 495, ["Icecrown"] = 210, ["Sholazar Basin"] = 3711, ["The Storm Peaks"] = 67, ["Wintergrasp"] = 4197, ["Zul'Drak"] = 66, }, ["Dungeons"] = { ["Ahn'kahet: The Old Kingdom"] = 4494, ["Auchenai Crypts"] = 3790, ["Azjol-Nerub"] = 3477, ["Blackfathom Deeps"] = 719, ["Blackrock Depths"] = 1584, ["Blackrock Spire"] = 1583, ["Caverns of Time"] = 1941, ["Coilfang Reservoir"] = 3905, ["Dire Maul"] = 2557, ["Drak'Tharon Keep"] = 4196, ["Gnomeregan"] = 133, ["Gundrak"] = 4375, ["Halls of Lightning"] = 4272, ["Halls of Stone"] = 4264, ["Hellfire Ramparts"] = 3562, ["Magisters' Terrace"] = 4095, ["Mana-Tombs"] = 3792, ["Maraudon"] = 2100, ["Old Hillsbrad Foothills"] = 2367, ["Ragefire Chasm"] = 2437, ["Razorfen Downs"] = 722, ["Razorfen Kraul"] = 491, ["Scarlet Monastery"] = 796, ["Scholomance"] = 2057, ["Sethekk Halls"] = 3791, ["Shadow Labyrinth"] = 3789, ["Shadowfang Keep"] = 209, ["Stratholme"] = 2017, ["Stratholme Past"] = 4100, ["Sunken Temple"] = 1417, ["Tempest Keep"] = 3845, ["The Arcatraz"] = 3846, ["The Black Morass"] = 2366, ["The Blood Furnace"] = 3713, ["The Botanica"] = 3847, ["The Deadmines"] = 1581, ["The Mechanar"] = 3849, ["The Nexus"] = 4120, ["The Oculus"] = 4228, ["The Shattered Halls"] = 3714, ["The Slave Pens"] = 3717, ["The Steamvault"] = 3715, ["The Stockade"] = 717, ["The Underbog"] = 3716, ["The Violet Hold"] = 4415, ["Uldaman"] = 1337, ["Utgarde Keep"] = 206, ["Utgarde Pinnacle"] = 1196, ["Wailing Caverns"] = 718, ["Zul'Farrak"] = 978, }, ["Raids"] = { ["Blackwing Lair"] = 2677, ["Hyjal Summit"] = 3606, ["Karazhan"] = 2562, ["Magtheridon's Lair"] = 3836, ["Molten Core"] = 2717, ["Naxxramas"] = 3456, ["Onyxia's Lair"] = 2159, ["Ruins of Ahn'Qiraj"] = 3429, ["Temple of Ahn'Qiraj"] = 3428, ["The Black Temple"] = 3840, ["The Eye"] = 3842, ["Zul'Aman"] = 3805, ["Zul'Gurub"] = 19, }, ["Classes"] = { ["Death Knight"] = -372, ["Druid"] = -263, ["Hunter"] = -261, ["Mage"] = -161, ["Paladin"] = -141, ["Priest"] = -262, ["Rogue"] = -162, ["Shaman"] = -82, ["Warlock"] = -61, ["Warrior"] = -81, }, ["Professions"] = { ["Alchemy"] = -181, ["Blacksmithing"] = -121, ["Cooking"] = -304, ["Engineering"] = -201, ["First Aid"] = -324, ["Fishing"] = -101, ["Herbalism"] = -24, ["Inscription"] = -371, ["Jewelcrafting"] = -373, ["Leatherworking"] = -182, ["Tailoring"] = -264, }, ["Battlegrounds"] = { ["All"] = -25, ["Arathi Basin"] = 3358, ["Alterac Valley"] = 2597, ["Eye of the Storm"] = 3820, ["Warsong Gulch"] = 3277, }, ["Seasonal"] = { ["Brewfest"] = -370, ["Children's Week"] = -1002, ["Darkmoon Faire"] = -364, ["Hallow's End"] = -1003, ["Harvest Festival"] = -1005, ["Love is in the Air"] = -1004, ["Lunar Festival"] = -366, ["Midsummer Fire Festival"] = -369, ["New Year's Eve"] = -1006, ["Winter Veil"] = -1001, }, ["Miscellaneous"] = { ["Ahn'Qiraj War Effort"] = -365, ["Epic"] = -1, ["Legendary"] = -344, ["Reputation"] = -367, ["Scourge Invasion"] = -368, ["Seasonal"] = -22, }, }-
View User Profile
-
View Posts
-
Send Message
Curse PremiumNow remember the function has a argument passed in called "level"
if (level == 1) then -- this is a 1st level menu -- blah blah elseif (level == 2) then -- this is a 2nd level menu if UIDROPDOWNMENU_MENU_VALUE == "some id string" then info.blah = blah info.blah = blah UIDropDownMenu_AddButton(info, level) elseif UIDROPDOWNMENU_MENU_VALUE == "some other id string" then info.blah = blah info.blah = blah UIDropDownMenu_AddButton(info, level) end endEdit:Note that you can actually assign anything to info.value, which gets assigned to the global variable UIDROPDOWNMENU_MENU_VALUE so you can identify what submenu to display, but strings are preferred.
So all you now need is a nice set of loops to do this for your quest-categories.
Quixote:RegisterCallback("Quest_Gained", "Quest_Gained")In case you haven't already figured this out, don't do that or you will probably break every addon that uses Quixote and Quixote itself.
Would be the correct syntax.