Quantcast Update 5.2 - ESOUI
Thread Tools Display Modes
09/16/19, 09:04 AM   #1
sirinsidiator's Avatar
AddOn Author - Click to view addons
Join Date: Apr 2014
Posts: 1,282
Update 5.2

The next update "Dragonhold" is now available on the PTS.

New API Version: 100029

PTS Dev Guild
We have created guilds on the EU and NA server for all addon developers, which get copied over during the PTS cycle for a new update, so we can test guild related things, ask for help with testing or just chat. If you need an invite, ask here or over on our Gitter channel. You are also free to join them on the live servers so you don't always have to be reinvited when the PTS is wiped.

I'll edit the OP with more useful information as you post it and add the links as they become available.
Attached Files
File Type: txt ESOUIDocumentationP24.txt (717.3 KB, 60 views)
Like what I do? Support me on Patreon!
>siri.exe MyAddon
Does your addon work? [y/n] n
There is a typo in there.

Last edited by sirinsidiator : 10/15/19 at 02:13 PM.
  Reply With Quote
09/22/19, 09:52 AM   #2
Baertram's Avatar
AddOn Author - Click to view addons
Join Date: Mar 2014
Posts: 2,423
LibAddonMenu-2.0 currently fails to load properly on PTS, here is a fix provided by Votan:

Change the following in LAM function "CreateAddonSettingsMenuEntry" in file LibAddonMenu-2.0.lua:
After this line: ZO_GameMenu_AddSettingPanel(panelData)
KEYBOARD_OPTIONS.controlTable[panelData.id] = {}
  Reply With Quote
09/27/19, 02:39 PM   #3
ZOS Staff!
Premium Member
Yes this person is from ZeniMax!
Join Date: Oct 2014
Posts: 551
This patch also includes a change to the Lua security system. Now when you register a callback for a script handler, event, or update it will run that callback as insecure code even if the code itself is secure. This only impacts registering existing secure closures (not addon created closures), so it should have little impact overall.
  Reply With Quote
09/27/19, 03:39 PM   #4
Baertram's Avatar
AddOn Author - Click to view addons
Join Date: Mar 2014
Posts: 2,423
I'm not sure what you mean by "This only impacts registering existing secure closures".
I e.g. got the problem on PTS now that my addon FCOItemSaver cannot use a PreHookHandler like OnMouseDoubleClick (called from another prehookhandler "OnEffectivelyShown" of the inventory) on child controls of the inventory anymore as it says it got unsecure 5 steps before.

I'm pretty sure I can solve this by changing my code to use some other preHook (which will takes much work and I'm annoyed to have to do this after some patches again and again, but well...) but WHY is it getting insecure if I do the following?
1. ZO_PreHookHandler(ZO_PlayerInventoryListContents , "OnEffectivelyShown", FCOItemSaver_OnEffectivelyShown)
2. In function "FCOItemSaver_OnEffectivelyShown" for each child control of ZO_PlayerInventoryListContents
ZO_PreHookHandler(childrenCtrl, "OnMouseDoubleClick", FCOItemSaver_InventoryItem_OnMouseDoubleClick)
3. And after 2. in the same function "FCOItemSaver_OnEffectivelyShown" for each child control of ZO_PlayerInventoryListContents
ZO_PreHookHandler(childrenCtrl, "OnMouseUp", FCOItemSaver_InventoryItem_OnMouseUp)

This will throw an insecure error if the step 2 is executed -> As you double click an inventory item!

But it will not throw an error if I do just the following?
1. ZO_PreHookHandler(ZO_PlayerInventoryListContents , "OnEffectivelyShown", FCOItemSaver_OnEffectivelyShown)
2. In the function "FCOItemSaver_OnEffectivelyShown" for each child control of ZO_PlayerInventoryListContents
ZO_PreHookHandler(childrenCtrl, "OnMouseUp", FCOItemSaver_InventoryItem_OnMouseUp)

Why is the PreHookHandler of OnMouseDoubleClick raising an insecure code but OnMouseUp doesn't? Because the function UseItem or whatever is called from the vanilla UI double click is secured?
  Reply With Quote
10/03/19, 09:19 AM   #5
Baertram's Avatar
AddOn Author - Click to view addons
Join Date: Mar 2014
Posts: 2,423
The following kind of "Post HooK" code, which is used in some addons which got to do with crafting...
currently makes the PickupInventoryItem code insecure...
EsoUI/Ingame/Inventory/InventorySlot.lua:2630: 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:2630: in function '(anonymous)'
|caaaaaa<Locals> inventorySlot = ud, bag = 6, index = 39 </Locals>|r
EsoUI/Ingame/Utility/ZO_SlotUtil.lua:14: in function 'RunHandlers'
|caaaaaa<Locals> handlerTable = [table:1]{}, slot = ud, handlers = [table:2]{}, i = 1 </Locals>|r
(tail call): ?
ZO_StackSplitSource_DragStart:4: in function '(main chunk)'
|caaaaaa<Locals> self = ud, button = 1 </Locals>|r

if you try to drag any item from the crafting table inventory row:

Lua Code:
  1. local origSmithingSetMode = ZO_Smithing.SetMode
  2.     ZO_Smithing.SetMode = function(smithingCtrl, mode, ...)
  3.         local retVar = origSmithingSetMode(smithingCtrl, mode, ...)
  4.         ---Your addon post hook code here
  5.         return retVar

Same for ZO_Enchanting.OnModeUpdated!

Error happens at the craftbag as well then as it seems.

Hope we can get another working PostHook so addons lik AdvancedFilters and others can work together without problems. In the past it had to be the posthook and to ZO_Smithing and ZO_Enchanting to make them all work together.

Info from sirinsidiator for SMITHING
That's because SetMode calls the SetHidden method for each panel, which in turn calls PerformFullRefresh on the crafting intenvories down the line, which is what creates the inventory slots.

You could try to hook into e.g. SMITHING.researchPanel.SetHidden instead.
It is the last function call in SetMode and it doesn't use a craftinginventory so cannot taint any code.
If you PreHook it and use something like
Lua Code:
  1. local smithingMode = SMITHING.mode
you can run your code with the smithingMode variable again.
Smithing - Alternative
You can also PreHook EACH panel's SetHidden function of the SMITHING variable (like SMITHING.refinePanel or SMITHING.deconstructionPanel) and execute your code there.

But the SetHidden function is called for EACH panel of the crafting table (e.g. refine, create, deconstruction, improve, research, furniture recipes) EACH time you change ANY of them.
So if you change from deconstruction to refine, deconstruction will be SetHidden(true), refine will be SetHidden(false) and ALL others will be SetHidden(true) as well! So be sure to check if the isHidden parameter is false to "apply your code at this panel properly", and check which panel you currently are inside your function code.

Both way unfortunately do not work for ENCHANTING as it does not own any "panels", just ENCHANTING.
If your ENCHANTING PostHook of OnModeUpdateddoes not work anymore you can try this tricky solution provided by Shinni e.g. (untested!)
Lua Code:
  1. local secondCall = false
  2. local isPreHook = false
  4. ZO_PreHook(ZO_Smithing, "SetMode", function(self, mode)
  5.     if not isPreHook then
  6.         -- this is actually a post hook
  7.         -- do stuff here
  8.         return true -- prevent 2nd execution of SetMode
  9.     end
  10. end)
  12. ZO_PreHook(ZO_Smithing, "SetMode", function(self, mode)
  13.     if not secondCall then
  14.         secondCall = true
  15.         return self.SetMode(self, mode)
  16.     end
  17.     isPreHook = true
  18. end)
Should work for ZO_Enchanting, "OnModeUpdated" as well.

Or use a Zo_PreHook to ENCHANTING.OnModeUpdated with zo_callLater (about 25ms should be enough) to get the correct enchantingMode again.

Last edited by Baertram : 10/03/19 at 11:32 AM.
  Reply With Quote
Yesterday, 03:47 PM   #6
Baertram's Avatar
AddOn Author - Click to view addons
Join Date: Mar 2014
Posts: 2,423
SecurePostHook -> Call code after original function

On PTS Dragonhold 100029:
The following function was added by ZOs to call your code securely AFTER the original function was executed.
Lua Code:
  1. SecurePostHook(control/variable,, "FunctionName", callbackFunction)

Lua Code:
  1. SecurePostHook(ZO_Smithing, "SetMode", smithingSetModeHook)

I've also tested this with some of the inventories ChangeFilter functions but I'll get an error then.
-> Reported them to Chip in order to see if we can get this solved or if this happens because of other addons maybe using other hooks on the same functions (see below).

What I found out as well:
If addons which work in the same "regions" (inventory e.g.) do not use the same methods, but on uses the new SecurePostHook and another one uses ZO_PreHook on the same function, they will have problems at drag&drop of the inventory items -> Insecure errors will appear.
Tested with FCOItemSaver and AdvancedFilters e.g.
FCOIS used ZO_PreHook and AF SecurePostHook already.
After changing FCOIS to the same SecurePostHook the errors were gone.

I recommand to change your addons, which have created manual PostHook at ZO_Smithing, ZO_Enchanting etc. SetMode/OnModeUpdate functions to be changed to use SecurePostHook now so all addons will work properly together!

Or at least build a test version and see if it fixes stuff. Most errors I found were raised as one dragged an item from the inventory, or crafting inventories.

Last edited by Baertram : Yesterday at 04:46 PM.
  Reply With Quote

ESOUI » Developer Discussions » Tutorials & Other Helpful Info » Update 5.2

Thread Tools
Display Modes

Posting Rules
You may not post new threads
You may not post replies
You may not post attachments
You may not edit your posts

vB code is On
Smilies are On
[IMG] code is On
HTML code is Off