-
Notifications
You must be signed in to change notification settings - Fork 0
/
GuildBookkeeper.lua
315 lines (294 loc) · 11.8 KB
/
GuildBookkeeper.lua
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
--[[
MIT License
Copyright (c) 2022 UnusualPi
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
of the Software, and to permit persons to whom the Software is furnished to do
so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
]]
local LGH = LibHistoire
local LAM = LibAddonMenu2
local GBK = {}
GBK.name = "GuildBookkeeper"
GBK.version = "0.0.7"
GBK.author = 'ArcHouse'
GBK.saveVars = 'GuildBookkeeperVariables'
GBK.default = {guilds={}, ledger={}}
GBK.listeners = {}
function GBK.Msg(text, type) -- Make text coloring easy & standard by passing a message type.
-- https://www.color-hex.com/color-palette/1015961
if type == 'info' then
d('[' .. GBK.name ..'] ' .. '|cfff85c' .. text .. '|r')
elseif type == 'emph' then
d('[' .. GBK.name ..'] ' .. '|c00b8ff' .. text .. '|r')
elseif type == 'warn' then
d('[' .. GBK.name ..'] ' .. '|cfb9e30' .. text .. '|r')
elseif type == 'err' then
d('[' .. GBK.name ..'] ' .. '|cff2f82' .. text .. '|r')
end
end
function GBK.OnAddOnLoaded(event, addonName)
if addonName == GBK.name then
GBK:Initialize()
EVENT_MANAGER:UnregisterForEvent(GBK.name, EVENT_ADD_ON_LOADED)
end
end
function GBK.Initialize()
EVENT_MANAGER:RegisterForEvent('GBK-initmsg', EVENT_PLAYER_ACTIVATED, GBK.InitMsg)
EVENT_MANAGER:RegisterForEvent('GBK-ListenerState', EVENT_PLAYER_ACTIVATED, GBK.GetListenerState)
GBK.GuildInfo()
GBK.savedVariables=ZO_SavedVars:NewAccountWide(GBK.saveVars, 1, nil, GBK.default)
GBK.SetupListeners()
GBK.InitSettingMenu()
end
function GBK.InitMsg()
GBK.Msg('v'..GBK.version..' add-on initializing...', 'info')
EVENT_MANAGER:UnregisterForEvent('GBK-initmsg', EVENT_PLAYER_ACTIVATED)
end
function GBK.GuildInfo()
for i=1, GetNumGuilds() do
local guildId = GetGuildId(i)
local guildName = GetGuildName(guildId)
GBK.default['guilds'][guildId] = {guildName=guildName, enabled = false, lastEvent=nil, lookBackPeriod = 31}
GBK.default['ledger'][guildName] = {}
end
end
function GBK:GetTamrielTradeCentrePrice(itemLink)
local priceStats = {}
if not TamrielTradeCentrePrice then -- if TTC not installed
priceStats['AmountCount'] = 'TTC not installed'
priceStats['Avg'] = ''
priceStats['SuggestedPrice'] = ''
else
local ttcPrices = TamrielTradeCentrePrice:GetPriceInfo(itemLink)
-- Line 22 of TamrielTradeCentrePrice.lua
if ttcPrices == nil then
priceStats['AmountCount'] = 'No TTC records'
priceStats['Avg'] = ''
priceStats['SuggestedPrice'] = ''
else
priceStats['AmountCount'] = ttcPrices['AmountCount']
priceStats['Avg'] = ttcPrices['Avg']
priceStats['SuggestedPrice'] = ttcPrices['SuggestedPrice']
end
end
return priceStats
end
function GBK:GetMmPrice(itemLink) -- Prices pull from MM's "Default Days Range"
local priceStats={}
if not MasterMerchant then -- If MM not installed
priceStats['numDays'] = ''
priceStats['avgPrice'] = ''
priceStats['numSales'] = 'MM not installed'
else
local mmStats = MasterMerchant:itemStats(itemLink, false)
-- line 76 of MasterMerchant_Alias.lua which actually just returns the
-- output from MasterMerchant:GetTooltipStats() on line 312 of MasterMerchant.lua
-- continue to use `itemStats` for now since its recommended, but may not be
-- needed in future.
if mmStats['numSales'] == nil then
priceStats['numDays'] = ''
priceStats['avgPrice'] = ''
priceStats['numSales'] = 'No MM sales'
else
priceStats['numDays'] = mmStats['numDays']
priceStats['avgPrice'] = mmStats['avgPrice']
priceStats['numSales'] = mmStats['numSales']
end
end
return priceStats
end
function GBK:CheckExists(eventId, guildId, guildName)
local e = false
for k,v in pairs(GBK.savedVariables['ledger'][guildName]) do
if v.transactionId == Id64ToString(eventId) then
e = true break
end
end
return e
end
function GBK.SetupListeners()
for guildId,v in pairs(GBK.default['guilds']) do
local guildName = GBK.default['guilds'][guildId]['guildName']
GBK.SetupListener(guildId, guildName)
if GBK.savedVariables['guilds'][guildId]['enabled'] == true then
-- Guild listener should default to inactive, user should enabled in settings.
GBK.listeners[guildId]:Start()
end
end
end
function GBK.SetupListener(guildId, guildName)
GBK.listeners[guildId] = LGH:CreateGuildHistoryListener(guildId, GUILD_HISTORY_BANK)
if GBK.savedVariables['guilds'][guildId]['lastEvent'] ~= nil then
GBK.listeners[guildId]:SetAfterEventId(StringToId64(GBK.savedVariables['guilds'][guildId]['lastEvent']))
else
local minTs = os.time()-(GBK.savedVariables['guilds'][guildId]['lookBackPeriod']*86400)
GBK.listeners[guildId]:SetAfterEventTime(minTs)
end
GBK.listeners[guildId]:SetNextEventCallback(function(eventType, eventId, eventTime, param1, param2, param3, param4, param5, param6)
-- https://github.com/sirinsidiator/ESO-LibHistoire/blob/536e39d6313116b84f7dfa6e4f31c46047d8b6ff/src/guildHistoryCache/GuildHistoryEventListener.lua#L202
local ttc = GBK:GetTamrielTradeCentrePrice(param3)
local mm = GBK:GetMmPrice(param3)
local typeId = eventType
-- https://wiki.esoui.com/Constant_Values
if typeId == 13 then typeName = 'Credit' typeDesc = 'Item Deposited' -- GUILD_EVENT_BANKITEM_ADDED
elseif typeId == 14 then typeName = 'Debit' typeDesc = 'Item Withdrawn' -- GUILD_EVENT_BANKITEM_REMOVED
elseif typeId == 21 then typeName = 'Credit' typeDesc = 'Gold Deposited'-- GUILD_EVENT_BANKGOLD_ADDED
elseif typeId == 22 then typeName = 'Debit' typeDesc = 'Gold Withdrawn'-- GUILD_EVENT_BANKGOLD_REMOVED
elseif typeId == 29 then typeName = 'Credit' typeDesc = 'Store Tax'-- GUILD_EVENT_BANKGOLD_GUILD_STORE_TAX
elseif typeId == 29 then typeName = 'Credit' typeDesc = 'Kiosk Bid'-- GUILD_EVENT_BANKGOLD_KIOSK_BID
elseif typeId == 23 then typeName = 'Debit' typeDesc = 'Kiosk Bid Refund'-- GUILD_EVENT_BANKGOLD_KIOSK_BID_REFUND
elseif typeId == 26 then typeName = 'Credit' typeDesc = 'Heraldry Purchase'-- GUILD_EVENT_BANKGOLD_PURCHASE_HERALDRY
else typeId = ''
end
if typeId == 13 or typeId == 14 then
-- TODO: Need to validate table structure below will handle all Event Types listed above.
-- Only tested for types 13 & 14 so ignoring all others for now.
t = {transactionId = Id64ToString(eventId)
, transactionType = typeName
, transactionDescription = typeDesc
, typeId = eventType
, transactionTimestamp = eventTime
, transactionDatetime = os.date('%Y-%m-%d %H:%M:%S', eventTime)
, guildMember = param1
, itemId = GetItemLinkItemId(param3)
, transactionQuantity = param2
, itemName = GetItemLinkName(param3)
, itemQuality = GetItemLinkQuality(param3)
, itemTrait = GetItemLinkTraitType(param3)
, itemCp = GetItemLinkRequiredChampionPoints(param3)
, itemLevel = GetItemLinkRequiredLevel(param3)
, ttcNumListings = ttc['AmountCount']
, ttcAvg = ttc["Avg"]
, ttcSuggested = ttc["SuggestedPrice"]
, mmAvg = mm['avgPrice']
, mmNumDays = mm['numDays']
, mmNumSales = mm['numSales']
, itemLink = param3
, key = GBK.listeners[guildId]:GetKey()
}
if GBK:CheckExists(eventId, guildId, guildName) == false then
-- !!THIS IS O(n), but good enough for now
table.insert(GBK.savedVariables['ledger'][guildName], t)
end
GBK.savedVariables['guilds'][guildId]['lastEvent'] = Id64ToString(eventId)
end
end)
end
-------------------
--- SETTINGS UI ---
-------------------
function GBK:GetListenerState()
for guildId,v in pairs(GBK.savedVariables['guilds']) do
local guildName = GBK.default['guilds'][guildId]['guildName']
local state = 'Dormant.'
if GBK.listeners[guildId]:IsRunning() == true then
state = 'Active.'
GBK.Msg(guildName .. ': ' .. state, 'emph')
else
GBK.Msg(guildName .. ': ' .. state, 'warn')
end
end
EVENT_MANAGER:UnregisterForEvent('GBK-ListenerState', EVENT_PLAYER_ACTIVATED, GBK.GetListenerState)
end
function GBK:ToggleListenerState(guildId)
if GBK.listeners[guildId]:IsRunning() == true then
GBK.listeners[guildId]:Stop()
GBK.savedVariables['guilds'][guildId]['enabled'] = false
else
GBK.listeners[guildId]:Start()
GBK.savedVariables['guilds'][guildId]['enabled'] = true
end
GBK:GetListenerState()
end
function GBK:ClearGuildLedger(guildId, guildName)
GBK.savedVariables['guilds'][guildId]['lastEvent'] = nil
local tt = GBK.savedVariables['ledger'][guildName]
for i=1, #tt do
tt[i] = nil
end
GBK.Msg('Ledger for ' .. guildName .. ' cleared.', 'err')
end
function GBK.UpdateLookback(guildId, guildName, days)
GBK.savedVariables['guilds'][guildId]['lookBackPeriod'] = days
GBK:ClearGuildLedger(guildId, guildName) -- meh, good enough, force reloadui.
end
function GBK:InitSettingMenu()
local panelData = {
type = "panel"
, name = "Guild Bookkeeper"
, author = GBK.author
, version = GBK.version
, registerForRefresh = true
, registerForDefaults= false
}
local optionsTable = {
[1] = {
type = "header",
name = "Utilities",
width = "full"
},
[2] = {
type = "button",
name = "Show States",
tooltip = "Display listener states in chat.",
func = function() GBK:GetListenerState() end
},
}
for guildId,v in pairs(GBK.default['guilds']) do
local guildName = GBK.default['guilds'][guildId]['guildName']
table.insert(optionsTable,
{
type = 'header',
name = guildName .. ' Options',
width = 'full'
}
)
table.insert(optionsTable,
{
type = 'checkbox',
name = 'Monitoring',
tooltip = 'Enable monitoring for '.. guildName,
getFunc = function() return GBK.listeners[guildId]:IsRunning() end,
setFunc = function(v) GBK:ToggleListenerState(guildId) end
}
)
table.insert(optionsTable,
{
type = "slider",
name = "Lookback Days",
requiresReload = true,
getFunc = function() return GBK.savedVariables['guilds'][guildId]['lookBackPeriod'] end,
setFunc = function(value) GBK.UpdateLookback(guildId, guildName, value) end,
min = 1,
max = 365,
default = GBK.defaultLookback,
reference = guildName.."Lookback Days"
}
)
table.insert(optionsTable,
{
type = 'button',
name = 'Clear Ledger',
warning = 'Clears all data for ' .. guildName,
func = function() GBK:ClearGuildLedger(guildId, guildName) end
}
)
end
LAM:RegisterAddonPanel("Guild Bancair", panelData)
LAM:RegisterOptionControls("Guild Bancair", optionsTable)
end
--------------------
--- /SETTINGS UI ---
--------------------
EVENT_MANAGER:RegisterForEvent(GBK.name, EVENT_ADD_ON_LOADED, GBK.OnAddOnLoaded)