LockpickNotifier : Miscellaneous : Elder Scrolls Online AddOns

(4 Kb)

Download

Updated: 07/10/23 06:56 AM

Add Favorite

Install Help

Pictures

File Info

Compatibility:	Necrom (9.0.0) Scribes of Fate (8.3.5) Firesong (8.2.5)
Updated:	07/10/23 06:56 AM
Created:	05/25/21 09:50 AM
Monthly downloads:	520
Total downloads:	26,814
Favorites:	35
MD5:

LockpickNotifier Popular! (More than 5000 hits)

Version: 1.6

by: Rednas [More]

A simple add-on i made for myself, to notify my party members i found a chest in a dungeon.
Due to requests to share the add-on, i uploaded it here!
I hope you guys like it!

What does this addon do:

Detects when you try to pick a lock
If you try to pick a locked chest in a dungeon, it will automatically add a string to the party chat that you found a chest. (you only need to press Enter)

What can you configure (/lpn for the settings page):

When the add-on should be active (group dungeon, trial, neither or both)
Default: Group Dungeons only
Your own text, use %s for the difficulty
Default: Chest found, quality: %s
Your own alternatives for the chest difficulty
Default: Simple, Intermediate, Advanced & Master

REQUIRED LIBRARIES:

LibAddonMenu-2.0

Notice:
This add-on is made as a hobby project in my free time. I'm not a professional developer. I can't promise (regular) updates, (quick) bug fixes, that the add-on is bug free or 100% optimized. I however did my best to make it as useful as possible. This is also why I included the "AS IS" notice in the folder. I hope however that this add-on will be useful to someone.

;Changelog 1.6
; - added JP chest name
; - bugfix for normal trials (when trials is turned off in the settings)

;Changelog 1.5
; - API Bumb
; - Fix for the error you got when the new chapter got released
;
; Thanks @bear_amara for testing it so quickly!!

;Changelog 1.4
; - API Bumb
; - Fix for Russian language (It should work now!)

;Changelog 1.3
; - Added Settings
; - Turn on/off in trial, group dungeon
; - Custom chest difficulty names
; - Custom string
; - Changed API version

V1.2:

Improved the chest detection (Thanks to other helpful authors)
It should now work with the EN, FR, DE and RU cliënt
Removed the capital from Quality.

V1.1:
added an unregister to the EVENT_ADD_ON_LOADED event

Archived Files (5)

File Name	Version	Size	Uploader	Date
LockpickNotifier	1.5	3kB	Rednas	06/05/23 05:42 AM
LockpickNotifier	1.4	3kB	Rednas	11/04/22 10:24 AM
LockpickNotifier	1.3	3kB	Rednas	06/04/21 06:23 AM
LockpickNotifier	1.2	2kB	Rednas	05/26/21 09:42 AM
LockpickNotifier	1.1	1kB	Rednas	05/25/21 10:46 AM

Comment Options

Page 1 of 2

05/25/21, 10:08 AM

Baertram

Super Moderator

Forum posts: 5000

File comments: 6056

Uploads: 78

Thanks for the addon.
You should Unregister the EVENT_ADD_ON_LOADED after your addon was found again as it else will fire again for each of your addons, and will run your addonName comparison then each time again, for nothing.

Lua Code:

function LPN.OnAddOnLoaded(event, addonName)
  if addonName == LPN.name then
    --EVENT_ADD_ON_LOADED will be called for EACH of your installed addons and libs 1 time! So unregister it again after your addon was determined via the if addonName == LPN.name then check
    EVENT_MANAGER:UnregisterForEvent(LPN.name, EVENT_ADD_ON_LOADED)
    LPN:Initialize()
  end
end
 
EVENT_MANAGER:RegisterForEvent(LPN.name, EVENT_ADD_ON_LOADED, LPN.OnAddOnLoaded)

Last edited by Baertram : 05/25/21 at 10:16 AM.

05/25/21, 10:14 AM

Rednas

Forum posts: 0

File comments: 13

Uploads: 5

Originally Posted by Baertram

Lua Code:

function LPN.OnAddOnLoaded(event, addonName)
  if addonName == LPN.name then
    --EVENT_ADD_ON_LOADED will be called for EACH of your installed addons and libs 1 time! So unregister it again after your addon was determined via the if addonName == LPN.name then check
    EVENT_MANAGER:UnregisterForEvent(LPN.name, EVENT_ADD_ON_LOADED)
    LPN:Initialize()
  end
end
 
EVENT_MANAGER:RegisterForEvent(LPN.name, EVENT_ADD_ON_LOADED, LPN.OnAddOnLoaded)

Thanks for the suggestion, i will add it to the add-on. Totally forgot about it!

05/25/21, 10:16 AM
Baertram Super Moderator Forum posts: 5000 File comments: 6056 Uploads: 78	Btw via the interactionManager (the FISHING_MANAGER is a "hack" to point to the interacton manager, as it seems to be the global variable given we can use for it) one can indentify chests. They are "not owned" and their actionText will be GetString(SI_GAMECAMERAACTIONTYPE12) ("Unlock"). Lua Code: local myAddonInteractionData = {} SecurePostHook(FISHING_MANAGER, "StartInteraction", function(...) myAddonInteractionData = {} myAddonInteractionData.action, myAddonInteractionData.name, myAddonInteractionData.blockedNode, myAddonInteractionData.isOwned = GetGameCameraInteractableActionInfo() end) In your EVENT_LOCKPICK_STARTED then e.g. do something like: Lua Code: function LPN.StartLockpick(event) --Abort if we are not in a dungeon or if we are in a raid if not IsUnitInDungeon("player") or IsPlayerInRaid() then return end --Check if the last interaction was with an unowned item and if the text was "Unlock" if myAddonInteractionData.isOwned or myAddonInteractionData.action ~= GetString(SI_GAMECAMERAACTIONTYPE12) then --reset the variables myAddonInteractionData = {} --Abort here return end ... --Your other code here but without the boss checks as this should be handled via the interactionManager isOwned and actionText now above! end Maybe you are able to strip the boss name check this way (as you only check for English names and not also German, French, and Russian (the other official languages of this game!) as it hopefully will not fire for a door opening as the text is different than "Unlock" (GetString(SI_GAMECAMERAACTIONTYPE12)). And using the string constant SI_GAMECAMERAACTIONTYPE12, which is translated properly in the supported languages, will be an easier way so you ONLY need to check once at the lockpick event callback function if you are in a dungeon: You only need to test if FISHING_MANAGER:StartInteraction is fired before the event_lockpick_start but I think I remember it must be. Small performance improvement: Do not check if the player is in combat each time in your loop! Just do it once at the start of the function as it will be enough. The combat state most likely will not change in the few ms the source code needs to run through your callback function. Same for other IsUnit checks. If not needed inside the loop (like get the boss 1, 2, 3) it should be done before and stored in a locla variable if you need to re-use it more than 1 time in your following code. Last edited by Baertram : 05/25/21 at 10:23 AM.

05/26/21, 06:04 AM
Trinity Is My Name Forum posts: 0 File comments: 27 Uploads: 0	Such A Useful Addon! Thanks So Much! Thanks so much for this! I run a lot of dungeons and this Addon helps immensely!

05/26/21, 08:37 AM
xgoku1 Forum posts: 5 File comments: 6 Uploads: 1	Just to add to what Baertram said, IsUnitInDungeon returns true even for a delve and public dungeon. In my addon I check if the value of GetZoneId(GetUnitZoneIndex("player")) is in a table containing the ids of the dungeon to satisfy the conditional code (you can find the zoneId for dungeons from LibSets datasheet) - should be a language independent implementation I also use the FISHING_MANAGER hack mentioned to correctly identify a chest, perhaps you can get some ideas from my code. Not sure if multiple FISHING_MANAGER calls from different addons will conflict, from my testing it should be fine as long as they are not called with the exact same ms in the RegisterForUpdate registered function

05/26/21, 09:46 AM

Rednas

Forum posts: 0

File comments: 13

Uploads: 5

Originally Posted by xgoku1

Just to add to what Baertram said, IsUnitInDungeon returns true even for a delve and public dungeon.

In my addon I check if the value of GetZoneId(GetUnitZoneIndex("player")) is in a table containing the ids of the dungeon to satisfy the conditional code (you can find the zoneId for dungeons from LibSets datasheet) - should be a language independent implementation

I also use the FISHING_MANAGER hack mentioned to correctly identify a chest, perhaps you can get some ideas from my code.

Not sure if multiple FISHING_MANAGER calls from different addons will conflict, from my testing it should be fine as long as they are not called with the exact same ms in the RegisterForUpdate registered function

Thanks for the idea's, but for my add-on it's enough to know the difficulty of the dungeon. 0 is a delve, 1 and 2 are dungeons. Adding a lib or another way to detect if you are in a dungeon, should not be needed. (double tested it today, it only triggers in a dungeon)

Thanks to Baertram, i was also able to update the chest detection. I will take a look at your add-on if i find any more difficulties

Last edited by Rednas : 05/26/21 at 09:48 AM.

05/26/21, 10:32 AM

Baertram

Super Moderator

Forum posts: 5000

File comments: 6056

Uploads: 78

The dungeon can be also checked via IsUnitInDungeon("player") and "IsUnitGrouped("player") == true as you would port out of a real dungeon (non-delve) if you are not grouped (after 2 mins of time I think), or did they change that?
But the GetCurrentZoneDungeonDifficulty() idea should work even better then, if it always returns 1 or 2 for "real group dungeons" and 0 for delves. Need to check if this applies to PubDungeons as well.

Originally Posted by Rednas

Originally Posted by xgoku1

Last edited by Baertram : 05/26/21 at 10:35 AM.

05/26/21, 10:46 AM

Rednas

Forum posts: 0

File comments: 13

Uploads: 5

Checked the public dungeons as well before i released it here, they also return 0. Rechecked it today before i submitted v1.2 and the ones i checked returned 0. So i kept this validation intact.

Originally Posted by Baertram

Originally Posted by Rednas

Originally Posted by xgoku1

05/26/21, 10:47 AM

Baertram

Super Moderator

Forum posts: 5000

File comments: 6056

Uploads: 78

Thanks, good to know! This eases the checks a lot imo.

Originally Posted by Rednas

Checked the public dungeons as well before i released it here, they also return 0. Rechecked it today before i submitted v1.2 and the ones i checked returned 0. So i kept this validation intact.

Originally Posted by Baertram

Originally Posted by Rednas

Originally Posted by xgoku1

05/26/21, 03:17 PM

xgoku1

Forum posts: 5

File comments: 6

Uploads: 1

Originally Posted by Rednas

Nice. Much better solution than my table check method, I'll use this as well - will save me a lot of trouble in the future. Thanks

06/10/21, 08:46 PM
Huntardy Forum posts: 0 File comments: 1 Uploads: 0	Is there a way to make the addon press enter for the user?

06/11/21, 05:13 AM

Rednas

Forum posts: 0

File comments: 13

Uploads: 5

Originally Posted by Huntardy

Is there a way to make the addon press enter for the user?

As far as i know it isn't possible with the API, because you could make spam addon's with it.

09/20/22, 01:57 PM
Meridiano Forum posts: 1 File comments: 17 Uploads: 0	Not working Couldn't get it to work, I have the menu but no chat message inserts on lockpicking UPD: I've found the cause, you have "Cундук" in the russian locale but you need "Сундук", the first letter is the difference, you have latin C (string.byte -- 67) and russian locale has cyrillic С (string.byte -- 208+161). Last edited by Meridiano : 09/20/22 at 03:49 PM.

11/04/22, 10:45 AM

Rednas

Forum posts: 0

File comments: 13

Uploads: 5

Re: Not working

Originally Posted by Meridiano

Couldn't get it to work, I have the menu but no chat message inserts on lockpicking

UPD: I've found the cause, you have "Cундук" in the russian locale but you need "Сундук", the first letter is the difference, you have latin C (string.byte -- 67) and russian locale has cyrillic С (string.byte -- 208+161).

Thanks for letting me know.
It may be a bit late, but it should be updated now with the cyrillic C.
Please let me know if it still isn't working than i can try to fix it another way.

Last edited by Rednas : 11/05/22 at 12:46 PM.

11/05/22, 06:13 AM

Meridiano

Forum posts: 1

File comments: 17

Uploads: 0

Re: Re: Not working

Originally Posted by Rednas

Thanks for letting me know.
It may bit a bit late, but it should be updated now with the cyrillic C.
Please let me know if it still isn't working than i can try to fix it another way.

It works nice now, tyvm

Page 1 of 2

Report this File