LibAddonMenu-2.0 - looking for a few people to poke at it

**Seerah** · 06/04/14, 10:36 PM

I finished LAM-2.0 last night. Here is a .zip of the file and some rough starter docs. Hoping to get a few ambitious people to play with it and see if anything breaks.

As usual, you need to grab LAM from LibStub first:

Lua Code:

local lam = LibStub("LibAddonMenu-2.0")

METHOD: REGISTER ADDON PANEL

Lua Code:

--registers your addon with LibAddonMenu and creates a panel
--Usage:
--  addonID = "string"; unique ID which will be the global name of your panel
--  panelData = table; data object for your panel - see controls\panel.lua
lam:RegisterAddonPanel(addonID, panelData)

METHOD: REGISTER OPTION CONTROLS

Lua Code:

--registers the options you want shown for your addon
--these are stored in a table where each key-value pair is the order
--of the options in the panel and the data for that control, respectively
--see exampleoptions.lua for an example
--see controls\<widget>.lua for usage of each widget type
--Usage:
--  addonID = "string"; the same string passed to :RegisterAddonPanel
--  optionsTable = table; the table containing all of the options controls and their data
lam:RegisterOptionControls(addonID, optionsTable)

With the new LAM, you only need to make those two function calls and define your data in tables. (See exampleoptions.lua for an example of usage.) Everything else is handled by the library itself.

For power-users who wish to get their hands dirty, the widget controls are registered under the LAMCreateControls object. You can bypass LAM and create everything manually - either using your own window/panel, or registering for one through LAM. If you're not so ambitious, but still want something in your options panel that LAM doesn't provide, you can either register your own widget type (see the :RegisterWidget method) or use the "custom" widget type, which is basically just a container.

--------------

June 6 Update:
- fixed checkbox control for initial value bug
- localized game Settings menu lookup & encoded LAM-2.0 Lua file in UTF-8

--------------

June 8 Update:
- cleaned up ForceDefaults code
- set bg center of addon panel and addon menu to transparent
- fixed editbox multiline bug
- fixed description anchoring bug
- fixed defaults button and confirm dialog
- added optional custom function for when resetting defaults (will be called after all settings are reset)

Garkin · 06/05/14, 06:58 AM

Wow. It looks really great. Settings for all addons at one place is really good idea. It is much cleaner solution then in LAM 1.0.

I would just suggest adding some kind of transparency to the panel as it will feel more like part of default UI. Also it would be great if you can add an option to turn on/off addon, so all about addons is on the same place.

By the way write somewhere that I should not use the same name for my settings menu as I use for global table in my addon...

EDIT:
I think that default widgets should be "hardcoded" so their functionality will be guaranteed. It is really easy to break other addons, if you replace default widget.

Vuelhering · 06/05/14, 01:44 PM

I'll check it out!

edit: btw, I notice you use the term All Rights Reserved, but you probably want to use the actual word "Copyright" followed by the year and your entity name. At least in the US, that is the proper labelling.

I don't believe ARR means anything, legally.

Kentarii · 06/05/14, 07:55 PM

Cool stuff, will take it for a spin this weekend.

Froali · 06/06/14, 06:57 AM

I'm getting this error, when i am trying to open the settings through the defined /-command:

Code:

user:/AddOns/ThurisazGuildInfo/lib/LibAddonMenu-2.0/LibAddonMenu-2.0.lua:52: attempt to index a nil value
stack traceback:
	user:/AddOns/ThurisazGuildInfo/lib/LibAddonMenu-2.0/LibAddonMenu-2.0.lua:52: in function 'func'
	EsoUI/Libraries/Globals/globalapi.lua:156: in function '(anonymous)'

Though the settings menu is accessible via ESC->Addon Settings and works so far.

If you need more information to reproduce it, let me know

Great work so far. Thanks Seerah!

Edit: Just clicked through ZO_GameMenu_InGame via /zgoo. This is just dumb... the table

Code:

ZO_GameMenu_InGame.gameMenu.headerControls.Settings

is localized and has a different name in the german client i'm using:

Code:

ZO_GameMenu_InGame.gameMenu.headerControls.Einstellungen

Froali · 06/06/14, 07:51 AM

I think i found another little bug in checkbox.lua:70

In function UpdateValue. In order to set the checkbox initial value to the actual current value, shouldn't it be

Lua Code:

else
     control.value = control.data.getFunc()
end

In your original code it simple sets value = .... resulting in the checkbox being false all the time