Pictures
File Info
| Compatibility: | Scribes of Fate (8.3.5) Firesong (8.2.5) |
| Updated: | 03/13/23 03:24 PM |
| Created: | 07/11/15 10:51 AM |
| Monthly downloads: | 41,225 |
| Total downloads: | 4,367,432 |
| Favorites: | 1,962 |
| MD5: |
LibCustomMenu 
Info
This library is for addon developers. Download it, if an addon dependency tells you so.
Description
This library is written to overcome one way to get the "Access a private function XYZ from insecure code". But beginning with version 2.0, it does additional provide a new feature: sub menus.
Beginning with version 3.0, it does additional provide a new feature: divider.
Background
Controls, created from add-on code (as part of code path) are marked as "insecure/compromissed".
Functions, which have no problem with been called from "insecure" controls, are still working perfectly.
Like those of add-ons or Show On Map, Link in Chat or Get Help.
But "secured" functions like UseItem, InitiateDestroy, PickupInventoryItem raising the error message from above.
Once you hook AddMenuItem ALL controls created for the context-menu are "insecure".
Prior to ESO 2.0.13 if an add-on offers a full custom context-menu (no built-in menu entries) and this context-menu is shown first after (re-)load UI the first menu item controls are insecure. A crash of "Use" in the inventory afterwards was guaranteed.
Starting with ESO 2.0.13 ZOS preallocates 10 "secure" menu items. See here.
But this just reduces the chance of running into that problem, it does not fix it.
Currently the number of preallocated controls is 30. Running into this problem with AddMenuItem is real rare, but inventory action slots still don't like custom menu entries.
To avoid the error message, the controls of built-in menu items and add-on menu items must be strictly separated. That's what AddCustomMenuItem of this library does. It uses an own pool of controls, which look exactly the same. Sounds strange, but works.
I don't use private functions. Why should I use this lib?
It's not you, who uses private functions. It is built-in code, which re-uses controls indirectly created by your add-on in AddMenuItem.
I want to use this lib, so what to do?
After you have included the lib in your add-on manifest (.txt) do a text search for the global function AddMenuItem (not any :AddMenuItem of other objects) and replace it with AddCustomMenuItem.
Be careful with a simple "Replace All" over all files! You probably replace the AddMenuItem of LibCustomMenu itself
Version 1.0
This version was intended as proof of concept, but was successfully used in Beartram's FCO Item Saver, Circonian's FilterIt and my Fish Fillet.
Version 2.0
In order to have more value than avoiding a rare, just annoying "bug", sirinsidiator suggested and provided proof of concept code for sub menu items.
A big thank to sirinsidiator!
I finalized it and here we are.
API 2.0
function AddCustomMenuItem(mytext, myfunction, itemType, myfont, normalColor, highlightColor, itemYPad)
Fully compatible with AddMenuItem.
mytext: string, required. Caption of menu item.
myfunction: function(), required. Called if clicked.
itemType: int, optional. MENU_ADD_OPTION_LABEL or MENU_ADD_OPTION_CHECKBOX. Default MENU_ADD_OPTION_LABEL.
myfont: string, optional.
normalColor: ZO_ColorDef, optional. Color of unselected item.
highlightColor: ZO_ColorDef, optional. Color of selected/hovered item.
itemYPad: int, optional. y-padding between items.
function AddCustomSubMenuItem(mytext, entries, myfont, normalColor, highlightColor, itemYPad, subMenuButtonCallbackFunc)
mytext: string, required. Caption of menu item.
entries: table of sub items or callback returning table of sub items, required.
myfont: string, optional.
normalColor: ZO_ColorDef, optional. Color of unselected/normal sub item.
highlightColor: ZO_ColorDef, optional. Color of selected/hovered sub item.
itemYPad: int, optional. y-padding between sub items.
subMenuButtonCallbackFunc: function, optional. Callback function for the click on the submenu open button (the one at the main menu showing the submenu)
sub item:
label: string or function(rootMenu, childControl), required.
callback: function(), required.
disabled: boolean or function(rootMenu, childControl), optional. Default false. if true, sub item is visible, but gray and not clickable.
visible: boolean or function(rootMenu, childControl), optional. Default true.
These examples are for self-created menus. If you want to add items to the inventory context-menu, look at the example for LibCustomMenu:RegisterContextMenu more below.
example 1:
example 2:
If you have Notebook or ZAM Notebook, you could copy&paste the scripts from above and execute them.
API 3.0
In addition to API 2.0:
Allow divider by setting member label to a static "-". Suggested by Beartram.
example:
API 4.1
In addition to API 3.0:
actionSlots:AddCustomSlotAction(actionStringId, actionCallback, actionType, visibilityFunction, options)
for example while hooking ZO_InventorySlot_DiscoverSlotActionsFromActionList(inventorySlot, slotActions)
for example within the callback of API 6.0. See below.
API 5.0
In addition to API 4.1+:
New entry properties itemType and checked.
itemType = MENU_ADD_OPTION_LABEL (default) or MENU_ADD_OPTION_CHECKBOX for a checkbox
checked = false/true or function() return state end
The initial checked state than opening the sub menu.
example:
API 6.2
In addition to API 5+:
Added callbacks, you can register to, to hook into inventory slot context menu. You don't need to reinvent the hook and are able to control the position of your entry/entries more granular.
category
lib.CATEGORY_EARLY
lib.CATEGORY_PRIMARY
lib.CATEGORY_SECONDARY
lib.CATEGORY_TERTIARY
lib.CATEGORY_QUATERNARY
lib.CATEGORY_LATE
CATEGORY_EARLY is before the first built-in menu entry.
CATEGORY_PRIMARY is after the first built-in menu entry. And so on.
CATEGORY_LATE is after built-in menu and default.
lib:RegisterContextMenu(func, category)
Register to the context menu of the inventory mouse right click.
lib:RegisterKeyStripEnter(func, category)
Register to the inventory mouse hover used to update the keybind buttons at the bottom.
func: callback function to be called.
Signature:
category: optional. defaults to CATEGORY_LATE.
lib:RegisterKeyStripExit(func)
Register to the inventory mouse hover used to update the keybind buttons at the bottom, if the mouse exits an inventory slot.
func: callback function to be called.
Signature:
example:
example 2:
Not really practical, because it hides the built-in keybind. 
But you could use the callback just to be notified as well.
API 6.8
In addition to API 6.2+:
Added functionality to add an optional tooltip to a menu entry.
For the top level menu entries there is a new global function:
function AddCustomMenuTooltip(tooltip, index)
tooltip: Either a string shown as a simple tooltip or a callback function to let you do everything.
Signature:
control: the menu entry control.
inside: The function is called on mouse enter with inside=true and on mouse exit with inside=false.
index: Optional. Index of the menu entry, the tooltip is for. By default the index of the last added item is used. => You call AddCustomMenuItem and when AddCustomMenuTooltip.
For sub-menus a new key "tooltip" can be used. Again it is either a string or the callback function with the signature from above.
example:
How to use Checkbox at top level
API 6.9
lib:EnableSpecialKeyContextMenu(key)
key: KEY_CTRL or KEY_ALT or KEY_SHIFT or KEY_COMMAND
Show an alternative context menu, if the special key is pressed while right-clicking the inventory item.
lib:RegisterSpecialKeyContextMenu(func)
Register a callback for the alternative context menu. You, the addon author, have to check which menu items you want to add for the given combination of special keys. (See signature below)
You have to enable all the keys you want to handle. See lib:EnableSpecialKeyContextMenu(key). There is no DisableSpecialKeyContextMenu, because you don't know who else had enabled them.
Signature:
API 6.92
lib:RegisterPlayerContextMenu(func, category)
Register to the context menu of the chat player link mouse right click,
func: callback function to be called.
Signature:
Category: See API 6.2 description for the available categories.
API 7.1
lib:RegisterGuildRosterContextMenu(func, category)
Register to the context menu of the guild roster member mouse right click.
func: callback function to be called.
Signature:
API 7.2
lib:RegisterFriendsListContextMenu(func, category)
Register to the context menu of the friends list mouse right click.
lib:RegisterGroupListContextMenu(func, category)
Register to the context menu of the group list mouse right click.
Both analog to RegisterGuildRosterContextMenu. See above.
Example
This library is for addon developers. Download it, if an addon dependency tells you so.
Description
This library is written to overcome one way to get the "Access a private function XYZ from insecure code". But beginning with version 2.0, it does additional provide a new feature: sub menus.
Beginning with version 3.0, it does additional provide a new feature: divider.
Background
Controls, created from add-on code (as part of code path) are marked as "insecure/compromissed".
Functions, which have no problem with been called from "insecure" controls, are still working perfectly.
Like those of add-ons or Show On Map, Link in Chat or Get Help.
But "secured" functions like UseItem, InitiateDestroy, PickupInventoryItem raising the error message from above.
Once you hook AddMenuItem ALL controls created for the context-menu are "insecure".
Prior to ESO 2.0.13 if an add-on offers a full custom context-menu (no built-in menu entries) and this context-menu is shown first after (re-)load UI the first menu item controls are insecure. A crash of "Use" in the inventory afterwards was guaranteed.
Starting with ESO 2.0.13 ZOS preallocates 10 "secure" menu items. See here.
But this just reduces the chance of running into that problem, it does not fix it.
Currently the number of preallocated controls is 30. Running into this problem with AddMenuItem is real rare, but inventory action slots still don't like custom menu entries.
To avoid the error message, the controls of built-in menu items and add-on menu items must be strictly separated. That's what AddCustomMenuItem of this library does. It uses an own pool of controls, which look exactly the same. Sounds strange, but works.
I don't use private functions. Why should I use this lib?
It's not you, who uses private functions. It is built-in code, which re-uses controls indirectly created by your add-on in AddMenuItem.
I want to use this lib, so what to do?
After you have included the lib in your add-on manifest (.txt) do a text search for the global function AddMenuItem (not any :AddMenuItem of other objects) and replace it with AddCustomMenuItem.
Be careful with a simple "Replace All" over all files! You probably replace the AddMenuItem of LibCustomMenu itself
Version 1.0
This version was intended as proof of concept, but was successfully used in Beartram's FCO Item Saver, Circonian's FilterIt and my Fish Fillet.
Version 2.0
In order to have more value than avoiding a rare, just annoying "bug", sirinsidiator suggested and provided proof of concept code for sub menu items.
A big thank to sirinsidiator!
I finalized it and here we are.
API 2.0
function AddCustomMenuItem(mytext, myfunction, itemType, myfont, normalColor, highlightColor, itemYPad)
Fully compatible with AddMenuItem.
mytext: string, required. Caption of menu item.
myfunction: function(), required. Called if clicked.
itemType: int, optional. MENU_ADD_OPTION_LABEL or MENU_ADD_OPTION_CHECKBOX. Default MENU_ADD_OPTION_LABEL.
myfont: string, optional.
normalColor: ZO_ColorDef, optional. Color of unselected item.
highlightColor: ZO_ColorDef, optional. Color of selected/hovered item.
itemYPad: int, optional. y-padding between items.
function AddCustomSubMenuItem(mytext, entries, myfont, normalColor, highlightColor, itemYPad, subMenuButtonCallbackFunc)
mytext: string, required. Caption of menu item.
entries: table of sub items or callback returning table of sub items, required.
myfont: string, optional.
normalColor: ZO_ColorDef, optional. Color of unselected/normal sub item.
highlightColor: ZO_ColorDef, optional. Color of selected/hovered sub item.
itemYPad: int, optional. y-padding between sub items.
subMenuButtonCallbackFunc: function, optional. Callback function for the click on the submenu open button (the one at the main menu showing the submenu)
sub item:
label: string or function(rootMenu, childControl), required.
callback: function(), required.
disabled: boolean or function(rootMenu, childControl), optional. Default false. if true, sub item is visible, but gray and not clickable.
visible: boolean or function(rootMenu, childControl), optional. Default true.
These examples are for self-created menus. If you want to add items to the inventory context-menu, look at the example for LibCustomMenu:RegisterContextMenu more below.
example 1:
Lua Code:
example 2:
Lua Code:
API 3.0
In addition to API 2.0:
Allow divider by setting member label to a static "-". Suggested by Beartram.
example:
Lua Code:
API 4.1
In addition to API 3.0:
actionSlots:AddCustomSlotAction(actionStringId, actionCallback, actionType, visibilityFunction, options)
for example within the callback of API 6.0. See below.
API 5.0
In addition to API 4.1+:
New entry properties itemType and checked.
itemType = MENU_ADD_OPTION_LABEL (default) or MENU_ADD_OPTION_CHECKBOX for a checkbox
checked = false/true or function() return state end
The initial checked state than opening the sub menu.
example:
Lua Code:
API 6.2
In addition to API 5+:
Added callbacks, you can register to, to hook into inventory slot context menu. You don't need to reinvent the hook and are able to control the position of your entry/entries more granular.
category
lib.CATEGORY_EARLY
lib.CATEGORY_PRIMARY
lib.CATEGORY_SECONDARY
lib.CATEGORY_TERTIARY
lib.CATEGORY_QUATERNARY
lib.CATEGORY_LATE
CATEGORY_EARLY is before the first built-in menu entry.
CATEGORY_PRIMARY is after the first built-in menu entry. And so on.
CATEGORY_LATE is after built-in menu and default.
lib:RegisterContextMenu(func, category)
Register to the context menu of the inventory mouse right click.
lib:RegisterKeyStripEnter(func, category)
Register to the inventory mouse hover used to update the keybind buttons at the bottom.
func: callback function to be called.
Signature:
Lua Code:
category: optional. defaults to CATEGORY_LATE.
lib:RegisterKeyStripExit(func)
Register to the inventory mouse hover used to update the keybind buttons at the bottom, if the mouse exits an inventory slot.
func: callback function to be called.
Signature:
Lua Code:
example:
Lua Code:
example 2:
Lua Code:
But you could use the callback just to be notified as well.
API 6.8
In addition to API 6.2+:
Added functionality to add an optional tooltip to a menu entry.
For the top level menu entries there is a new global function:
function AddCustomMenuTooltip(tooltip, index)
tooltip: Either a string shown as a simple tooltip or a callback function to let you do everything.
Signature:
Lua Code:
inside: The function is called on mouse enter with inside=true and on mouse exit with inside=false.
index: Optional. Index of the menu entry, the tooltip is for. By default the index of the last added item is used. => You call AddCustomMenuItem and when AddCustomMenuTooltip.
For sub-menus a new key "tooltip" can be used. Again it is either a string or the callback function with the signature from above.
example:
Lua Code:
Lua Code:
API 6.9
lib:EnableSpecialKeyContextMenu(key)
key: KEY_CTRL or KEY_ALT or KEY_SHIFT or KEY_COMMAND
Show an alternative context menu, if the special key is pressed while right-clicking the inventory item.
lib:RegisterSpecialKeyContextMenu(func)
Register a callback for the alternative context menu. You, the addon author, have to check which menu items you want to add for the given combination of special keys. (See signature below)
You have to enable all the keys you want to handle. See lib:EnableSpecialKeyContextMenu(key). There is no DisableSpecialKeyContextMenu, because you don't know who else had enabled them.
Signature:
Lua Code:
lib:RegisterPlayerContextMenu(func, category)
Register to the context menu of the chat player link mouse right click,
func: callback function to be called.
Signature:
Code:
local function func(playerName, rawName) end
API 7.1
lib:RegisterGuildRosterContextMenu(func, category)
Register to the context menu of the guild roster member mouse right click.
func: callback function to be called.
Signature:
Code:
local function func(rowData) end
lib:RegisterFriendsListContextMenu(func, category)
Register to the context menu of the friends list mouse right click.
lib:RegisterGroupListContextMenu(func, category)
Register to the context menu of the group list mouse right click.
Both analog to RegisterGuildRosterContextMenu. See above.
Example
Lua Code:
Optional Files (0)
Archived Files (35)
File Name |
Version |
Size |
Uploader |
Date |
7.2.0 |
8kB |
votan |
03/11/23 11:59 AM |
|
7.1.3 |
8kB |
votan |
04/24/22 09:04 AM |
|
7.1.2 |
8kB |
votan |
10/24/21 07:44 AM |
|
7.1.1 |
8kB |
votan |
09/05/21 07:30 AM |
|
7.1.0 |
8kB |
votan |
09/04/21 09:32 AM |
|
7.0.1 |
8kB |
votan |
07/04/21 04:46 AM |
|
7.0.0 |
8kB |
votan |
04/28/21 11:21 AM |
|
6.9.5 |
7kB |
votan |
02/20/21 09:09 AM |
|
6.9.4 |
7kB |
votan |
11/02/20 04:41 AM |
|
6.9.3 |
7kB |
votan |
08/22/20 04:55 AM |
|
6.9.2 |
7kB |
votan |
04/21/20 03:12 PM |
|
6.9.1 |
7kB |
votan |
04/04/20 06:22 AM |
|
6.9.0 |
7kB |
votan |
04/03/20 11:43 AM |
|
6.8.2 |
7kB |
votan |
02/15/20 11:44 AM |
|
6.8.1 |
7kB |
votan |
10/03/19 04:37 AM |
|
6.8.0 |
7kB |
votan |
08/07/19 01:15 PM |
|
6.7.1 |
7kB |
votan |
07/30/19 11:57 AM |
|
6.7.0 |
7kB |
votan |
05/18/19 08:07 AM |
|
6.6.3 |
16kB |
votan |
02/23/19 10:15 AM |
|
6.6.2 |
8kB |
votan |
10/21/18 09:31 AM |
|
6.6.1 |
7kB |
votan |
10/19/18 12:13 PM |
|
6.6 |
14kB |
votan |
08/13/18 11:17 AM |
|
6.5 |
8kB |
votan |
04/22/18 05:21 AM |
|
6.4 |
7kB |
votan |
04/16/18 11:45 AM |
|
6.3 |
7kB |
votan |
03/03/18 10:58 AM |
|
6.2 |
8kB |
votan |
02/02/18 12:35 AM |
|
5 |
7kB |
votan |
01/27/18 03:11 PM |
|
5 |
7kB |
votan |
08/15/17 12:34 PM |
|
4.3 |
6kB |
votan |
07/15/17 01:00 PM |
|
4.2.0 |
6kB |
votan |
10/12/16 12:56 PM |
|
4.1.1 |
6kB |
votan |
03/07/16 12:13 PM |
|
4.1.0 |
6kB |
votan |
11/22/15 02:24 PM |
|
4.0.0 |
6kB |
votan |
08/06/15 10:48 AM |
|
3.0.0 |
6kB |
votan |
07/25/15 05:36 AM |
|
2.0.0 |
5kB |
votan |
07/11/15 10:51 AM |
 |
Comment Options |
06/02/18, 03:33 AM
|
|
|
Forum posts: 6
File comments: 391
Uploads: 0
|
|
|
|
|
05/30/18, 03:21 AM
|
|
|
Forum posts: 6
File comments: 391
Uploads: 0
|
|
|
|
|
|
05/30/18, 02:55 AM
|
|
 Forum posts: 577
File comments: 1670
Uploads: 40
|
|
|
|
|
|
05/30/18, 02:15 AM
|
|
|
Forum posts: 6
File comments: 391
Uploads: 0
|
Hi Votan. I'm still quite often getting the following error at banks:
Code:
EsoUI/Ingame/Inventory/InventorySlot.lua:697: Attempt to access a private function 'PickupInventoryItem' from insecure code. The callstack became untrusted 3 stack frame(s) from the top. stack traceback: EsoUI/Ingame/Inventory/InventorySlot.lua:697: in function 'TryBankItem' EsoUI/Ingame/Inventory/InventorySlot.lua:1516: in function 'INDEX_ACTION_CALLBACK' EsoUI/Ingame/Inventory/InventorySlotActions.lua:96: in function 'ZO_InventorySlotActions:DoPrimaryAction' EsoUI/Ingame/Inventory/ItemSlotActionController.lua:30: in function 'callback' EsoUI/Libraries/ZO_KeybindStrip/ZO_KeybindStrip.lua:645: in function 'ZO_KeybindStrip:TryHandlingKeybindDown' (tail call): ? (tail call): ? I've updated all my addons to use this latest version of LibCustomMenu (as well as LibAddonMenu). I don't understand scripting very well, but I gather that this problem is one that this Lib tries to address. Do you think this error is occurring because of something with the lib, or the improper use of the lib by other authors? Not sure who to try to contact to let them know that this is a problem. Thanks! |
|
|
|
|
04/27/18, 12:03 AM
|
|||
|
Forum posts: 577
File comments: 1670
Uploads: 40
|
Imagine how it felt that "your"(=mine) lib causing trouble for everybody on PTS  |
||
|
|
|
|
04/26/18, 11:40 PM
|
||
|
Forum posts: 66
File comments: 384
Uploads: 17
|
 I reaaaaaally don't like it when nobody can use PTS inventory because of my addons throwing permissions errors. Guess I kinda panicked. Btw, thanks for the API changes regarding hooks. I plan to rewrite my hooking stuff in CraftBagExtended to use it. |
|
|
|
|
|
04/26/18, 06:10 PM
|
||
|
Forum posts: 6
File comments: 391
Uploads: 0
|
|
|
|
|
|
|
04/26/18, 02:01 PM
|
||||
|
Forum posts: 577
File comments: 1670
Uploads: 40
|
Everything 6.4+ is ok.To make it more clear: 6.4 is working on live and did not work in the first week of PTS. This required to make 6.5. But ZOS reverted their changes. So, now 6.4 would work on PTS again. But 6.5 is also working for live and PTS. As @silvereyes released 6.5, it is the current version, but 6.4 is not out-dated.
Last edited by votan : 04/26/18 at 02:55 PM.
|
|||
|
|
|
|
04/26/18, 01:33 PM
|
|
|
Forum posts: 306
File comments: 1018
Uploads: 1
|
|
|
|
|
|
04/26/18, 12:21 AM
|
||
|
Forum posts: 6
File comments: 391
Uploads: 0
|
Thanks very much, I appreciate all the work you put in to your addons & the lib! |
|
|
|
|
|
04/25/18, 10:51 AM
|
|
|
Forum posts: 577
File comments: 1670
Uploads: 40
|
|
|
|
|
|
04/25/18, 01:07 AM
|
|
|
Forum posts: 6
File comments: 391
Uploads: 0
|
|
|
|
|
|
01/27/18, 01:45 PM
|
|
|
Forum posts: 577
File comments: 1670
Uploads: 40
|
Last edited by votan : 01/27/18 at 06:05 PM.
|
|
|
|
|
07/13/17, 10:49 AM
|
||
|
Forum posts: 577
File comments: 1670
Uploads: 40
|
|
|
|
|
|
|
07/13/17, 10:00 AM
|
|
|
Forum posts: 167
File comments: 550
Uploads: 22
|
|
|
|
|
|
