Back to Home

ESO Lua File v100029

ingame/guild/keyboard/guildhistory_keyboard.lua

[◄ back to folders ]
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
ZO_GUILD_HISTORY_KEYBOARD_CATEGORY_TREE_WIDTH = 240
local GUILD_EVENT_DATA = 1
local LOAD_CONTROL_TRIGGER_TIME_S = .5
local GuildHistoryManager = ZO_SortFilterList:Subclass()
function GuildHistoryManager:New(control)
    return ZO_SortFilterList.New(self, control)
end
function GuildHistoryManager:Initialize(control)
    ZO_SortFilterList.Initialize(self, control)
    self.noEntriesMessageLabel = GetControl(control, "NoEntriesMessage")
    self.control = control
    self.loading = GetControl(control, "Loading")
    self.masterList = {}
    
    ZO_ScrollList_AddDataType(self.list, GUILD_EVENT_DATA, "ZO_GuildHistoryRow", 60, function(control, data) self:SetupGuildEvent(control, data) end)
    self.sortFunction = function(listEntry1, listEntry2) return self:CompareGuildEvents(listEntry1, listEntry2) end
    self.updateFunction = function(control, timeS)
        --delay showing the request loading icon by LOAD_CONTROL_TRIGGER_TIME_S
        if DoesGuildHistoryCategoryHaveOutstandingRequest(self.guildId, self.selectedCategory) then
            if not self.nextLoadControlTrigger then
                self.nextLoadControlTrigger = timeS + LOAD_CONTROL_TRIGGER_TIME_S
            elseif timeS > self.nextLoadControlTrigger then
                self.loading:Show()
            end
        else
            self.nextLoadControlTrigger = nil
            self.loading:Hide()
        end
    end
    control:SetHandler("OnUpdate", self.updateFunction)
    --this update interval has nothing to do with the update handler above
    self:SetUpdateInterval(60)
    self.refreshGroup = ZO_OrderedRefreshGroup:New(ZO_ORDERED_REFRESH_GROUP_AUTO_CLEAN_IMMEDIATELY)
    self.refreshGroup:AddDirtyState("EventListData", function()
        self:RefreshData()
    end)
    self.refreshGroup:AddDirtyState("EventListFilters", function()
        self:RefreshFilters()
    end)
    self.refreshGroup:SetActive(function()
        return self:IsShowing()
    end)
    
    control:RegisterForEvent(EVENT_GUILD_HISTORY_CATEGORY_UPDATED, function(_, guildId, category) self:OnGuildHistoryCategoryUpdated(guildId, category) end)
    control:RegisterForEvent(EVENT_GUILD_HISTORY_REFRESHED, function() 
        self.selectedSubcategory = nil
        self.refreshGroup:MarkDirty("EventListData")
        self:RequestInitialEvents()
    end)
    control:RegisterForEvent(EVENT_SCREEN_RESIZED, function()
        --The template used is based on the size of the text which changes slightly relative to the size of the row when the screen resizes. This handles the text being right at the wrap point and either
        --unwrapping or wrapping at the new size.
        self.refreshGroup:MarkDirty("EventListData")
    end)
    GUILD_HISTORY_SCENE = ZO_Scene:New("guildHistory", SCENE_MANAGER)
    GUILD_HISTORY_SCENE:RegisterCallback("StateChange",     function(oldState, state)
                                                                if(state == SCENE_SHOWING) then
                                                                    self.refreshGroup:TryClean()
                                                                    self:RequestInitialEvents()
                                                                    KEYBIND_STRIP:AddKeybindButtonGroup(self.keybindStripDescriptor)
                                                                elseif(state == SCENE_HIDDEN) then
                                                                    KEYBIND_STRIP:RemoveKeybindButtonGroup(self.keybindStripDescriptor)
                                                                end
                                                            end)
end
function GuildHistoryManager:InitializeKeybindDescriptors()
    self.keybindStripDescriptor =
    {
        alignment = KEYBIND_STRIP_ALIGN_RIGHT,
        -- Show More
        {
            name = GetString(SI_GUILD_HISTORY_SHOW_MORE),
            keybind = "UI_SHORTCUT_PRIMARY",
            visible = function()
                return self.selectedCategory ~= nil and self.selectedSubcategory == nil and DoesGuildHistoryCategoryHaveMoreEvents(self.guildId, self.selectedCategory)
            end,
        
            callback = function()
                self:RequestMoreEvents()
            end,
        },
    }
end
function GuildHistoryManager:CreateCategoryTree()
    self.categoryTree = ZO_Tree:New(GetControl(self.control, "Categories"), 60, -10, ZO_GUILD_HISTORY_KEYBOARD_CATEGORY_TREE_WIDTH)
    --Category Header
    local function CategoryHeaderSetup(node, control, categoryId, open)
        -- 62 is the amount of space from the left side of the parent control to the right side of the text label
        -- 25 is the offset from the icon to the text label
        local textLabelMaxWidth = ZO_GUILD_HISTORY_KEYBOARD_CATEGORY_TREE_WIDTH - 62 - 25
        control.text:SetDimensionConstraints(0, 0, textLabelMaxWidth, 0)
        control.text:SetModifyTextType(MODIFY_TEXT_TYPE_UPPERCASE)
        control.text:SetText(GetString("SI_GUILDHISTORYCATEGORY", categoryId))
        local categoryData = GUILD_HISTORY_CATEGORIES[categoryId]
        control.icon:SetTexture(open and categoryData.down or categoryData.up)
        control.iconHighlight:SetTexture(categoryData.over)
        ZO_IconHeader_Setup(control, open)
        if open then
            self.categoryTree:SelectFirstChild(node)
        end
    end
    local NO_SELECTION_FUNCTION = nil
    local NO_EQUALITY_FUNCTION = nil
    local DEFAULT_CHILD_INDENT = nil
    local childSpacing = 0
    self.categoryTree:AddTemplate("ZO_IconHeader", CategoryHeaderSetup, NO_SELECTION_FUNCTION, NO_EQUALITY_FUNCTION, DEFAULT_CHILD_INDENT, childSpacing)
    --Subcategory Entry
    local function SubcategoryEntrySetup(node, control, data, open)
        control:SetSelected(false)
        control:SetText(data.name)
    end
    local function SubcategoryEntrySelected(control, data, selected, reselectingDuringRebuild)
        control:SetSelected(selected)
        if selected then
            local oldSelectedCategory = self.selectedCategory
            self.selectedCategory = data.categoryId
            self.selectedSubcategory = data.subcategoryId
            --if it's the same category we can just mess with the filter instead of rebuilding the whole list
            if oldSelectedCategory == self.selectedCategory then
                self.refreshGroup:MarkDirty("EventListFilters")
            else
                self:RequestInitialEvents()
                self.refreshGroup:MarkDirty("EventListData")
            end
            ZO_ScrollList_ResetToTop(self.list)
            KEYBIND_STRIP:UpdateKeybindButtonGroup(self.keybindStripDescriptor)
        end
    end
    self.categoryTree:AddTemplate("ZO_GuildHistorySubcategoryEntry", SubcategoryEntrySetup, SubcategoryEntrySelected)
    --Build Tree
    for i = 1, GetNumGuildHistoryCategories() do
        local categoryData = GUILD_HISTORY_CATEGORIES[i]
        if categoryData then
            local categoryNode = self.categoryTree:AddNode("ZO_IconHeader", i)
           --All
            self.categoryTree:AddNode("ZO_GuildHistorySubcategoryEntry", {categoryId = i, name = GetString(SI_GUILD_HISTORY_SUBCATEGORY_ALL)}, categoryNode)
            if categoryData.subcategories then
                for subcategoryId, _ in pairs(categoryData.subcategories) do
                    self.categoryTree:AddNode("ZO_GuildHistorySubcategoryEntry", {categoryId = i, subcategoryId = subcategoryId, name = GetString(categoryData.subcategoryEnumName, subcategoryId)}, categoryNode)
                end
            end
        end
    end
    self.categoryTree:SetExclusive(true)
    self.categoryTree:SetOpenAnimation("ZO_TreeOpenAnimation")
    self.categoryTree:Commit()
end
function GuildHistoryManager:SetGuildId(guildId)
    self.guildId = guildId
    self.refreshGroup:MarkDirty("EventListData")
end
function GuildHistoryManager:SetupGuildEvent(control, data)
    local bg = GetControl(control, "BG")
    local hidden = data.sortIndex and (data.sortIndex % 2) == 0
    bg:SetHidden(hidden)
    local description = self:FormatEvent(data.eventType, data.param1, data.param2, data.param3, data.param4, data.param5, data.param6)
    local formattedTime = ZO_FormatDurationAgo(data.secsSinceEvent + GetGameTimeSeconds() - self.lastEventDataUpdateS)
    GetControl(control, "Description"):SetText(description)
    GetControl(control, "Time"):SetText(formattedTime)
end
function GuildHistoryManager:IsShowing()
    return GUILD_HISTORY_SCENE and GUILD_HISTORY_SCENE:IsShowing()
end
function GuildHistoryManager:FormatEvent(eventType, ...)
    local format = GUILD_EVENT_EVENT_FORMAT[eventType]
    if(format) then
        return format(eventType, ...)
    end
end
function GuildHistoryManager:ShouldShowEventType(eventType)
    return GUILD_EVENT_EVENT_FORMAT[eventType] ~= nil
end
function GuildHistoryManager:BuildMasterList()
    if self.guildId and self.selectedCategory then
        ZO_ClearNumericallyIndexedTable(self.masterList)
        self.lastEventDataUpdateS = GetFrameTimeSeconds()        
        for i = 1, GetNumGuildEvents(self.guildId, self.selectedCategory) do
            local eventType, secsSinceEvent, param1, param2, param3, param4, param5, param6, eventId = GetGuildEventInfo(self.guildId, self.selectedCategory, i)
            if self:ShouldShowEventType(eventType) then
                local event = 
                {
                    eventId = eventId,
                    eventType = eventType,
                    param1 = param1,
                    param2 = param2,
                    param3 = param3,
                    param4 = param4,
                    param5 = param5,
                    param6 = param6,
                    secsSinceEvent = secsSinceEvent,
                    subcategoryId = ComputeGuildHistoryEventSubcategory(eventType, self.selectedCategory),
                }
                table.insert(self.masterList, event)
            end
        end
    end
end
function GuildHistoryManager:FilterScrollList()
    local scrollData = ZO_ScrollList_GetDataList(self.list)
    local listWidth = self.list:GetNamedChild("Contents"):GetWidth()
    
    ZO_ClearNumericallyIndexedTable(scrollData)
    for i = 1, #self.masterList do
        local data = self.masterList[i]
        if self.selectedSubcategory == nil or self.selectedSubcategory == data.subcategoryId then
            table.insert(scrollData, ZO_ScrollList_CreateDataEntry(GUILD_EVENT_DATA, data))
        end
    end
    local hasEntries = #scrollData > 0 
    self.noEntriesMessageLabel:SetHidden(hasEntries)
    if not hasEntries then
        self.noEntriesMessageLabel:SetText(ZO_GuildHistory_GetNoEntriesText(self.selectedCategory, self.selectedSubcategory, self.guildId))
    end
end
function GuildHistoryManager:CompareGuildEvents(listEntry1, listEntry2)
    return listEntry1.data.eventId > listEntry2.data.eventId
end
function GuildHistoryManager:SortScrollList()
    local scrollData = ZO_ScrollList_GetDataList(self.list)
    if #scrollData > 1 then
        table.sort(scrollData, self.sortFunction)
    end
end
function GuildHistoryManager:RequestInitialEvents()
    if self.guildId and self.selectedCategory then
        if not HasGuildHistoryCategoryEverBeenRequested(self.guildId, self.selectedCategory) then
            self:RequestMoreEvents()
        end
    end
end
function GuildHistoryManager:RequestMoreEvents()
    if self.guildId and self.selectedCategory then
        if self:IsShowing() then
            RequestMoreGuildHistoryCategoryEvents(self.guildId, self.selectedCategory)
        end
    end
end
--Events
function GuildHistoryManager:OnGuildHistoryCategoryUpdated(guildId, category)
    if self.guildId == guildId and self.selectedCategory == category then
        KEYBIND_STRIP:UpdateKeybindButtonGroup(self.keybindStripDescriptor)
        self.refreshGroup:MarkDirty("EventListData")
    end
end
--Global XML
    GUILD_HISTORY = GuildHistoryManager:New(self)
end