Back to Home

ESO Lua File v100020

ingame/collections/keyboard/specializedcollectionsbook_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
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
local NOTIFICATIONS_PROVIDER = NOTIFICATIONS:GetCollectionsProvider()
ZO_SpecializedCollectionsBook_Keyboard = ZO_Object:Subclass()
function ZO_SpecializedCollectionsBook_Keyboard:New(...)
    local object = ZO_Object.New(self)
    object:Initialize(...)
    return object
end
function ZO_SpecializedCollectionsBook_Keyboard:Initialize(control, sceneName, ...)
    control.owner = self
    self.control = control
    self.sceneName = sceneName
    self.collectibleCategoryTypes = { ... }
    
    self:InitializeControls()
    self:InitializeNavigationList()
    self:InitializeEvents()
    local specializedBookScene = ZO_Scene:New(self.sceneName, SCENE_MANAGER)
    specializedBookScene:RegisterCallback("StateChange", function(oldState, newState)
                                                             if newState == SCENE_SHOWN then
                                                                 self:OnSceneShown()
                                                             end
                                                         end)
end
function ZO_SpecializedCollectionsBook_Keyboard:InitializeControls()
    self.navigationList = self.control:GetNamedChild("NavigationList")
    local contents = self.control:GetNamedChild("Contents")
    self.imageControl = contents:GetNamedChild("Image")
    self.nameLabel = contents:GetNamedChild("Name")
    local scrollSection = contents:GetNamedChild("ScrollContainer"):GetNamedChild("ScrollChild")
    self.descriptionLabel = scrollSection:GetNamedChild("Description")
end
function ZO_SpecializedCollectionsBook_Keyboard:DoesCollectibleHaveAlert(data)
    --Override for additional checks if a collectible has been updated
    return IsCollectibleNew(data.collectibleId)
end
function ZO_SpecializedCollectionsBook_Keyboard:InitializeNavigationList()
    self.navigationTree = ZO_Tree:New(self.navigationList:GetNamedChild("ScrollChild"), 60, -10, 300)
    local OPEN_TEXTURE = "EsoUI/Art/Buttons/tree_open_up.dds"
    local CLOSED_TEXTURE = "EsoUI/Art/Buttons/tree_closed_up.dds"
    local OVER_OPEN_TEXTURE = "EsoUI/Art/Buttons/tree_open_over.dds"
    local OVER_CLOSED_TEXTURE = "EsoUI/Art/Buttons/tree_closed_over.dds"
    local function TreeHeaderSetup(node, control, name, open)
        control.text:SetModifyTextType(MODIFY_TEXT_TYPE_UPPERCASE)
        control.text:SetText(name)
        control.icon:SetTexture(open and OPEN_TEXTURE or CLOSED_TEXTURE)
        control.iconHighlight:SetTexture(open and OVER_OPEN_TEXTURE or OVER_CLOSED_TEXTURE)
        local ENABLED = true
        local DISABLE_SCALING = true
        ZO_IconHeader_Setup(control, open, ENABLED, DISABLE_SCALING)
    end
    self.navigationTree:AddTemplate("ZO_SpecializedCollection_Book_NavigationHeader_Keyboard", TreeHeaderSetup, nil, nil, nil, 0)
    local function TreeEntrySetup(node, control, data, open)
        control:SetText(zo_strformat(SI_COLLECTIBLE_NAME_FORMATTER, data.name))
        control:SetSelected(node:IsSelected())
        control.statusIcon = control:GetNamedChild("StatusIcon")
        data.notificationId = NOTIFICATIONS_PROVIDER:GetNotificationIdForCollectible(data.collectibleId)
        local isNew = data.notificationId or self:DoesCollectibleHaveAlert(data)
        control.statusIcon:SetHidden(not isNew)
    end
    local function TreeEntryOnSelected(control, data, selected, reselectingDuringRebuild)
        control:SetSelected(selected)
         if selected then
            self.selectedId = data.collectibleId
            if not reselectingDuringRebuild then
                self:RefreshDetails()
            end
            if data.notificationId then
                RemoveCollectibleNotification(data.notificationId)
            end
            ClearCollectibleNewStatus(data.collectibleId)
        end
    end
    local function TreeEntryEquality(left, right)
        return left.name == right.name
    end
    self.navigationTree:AddTemplate("ZO_SpecializedCollection_Book_NavigationEntry_Keyboard", TreeEntrySetup, TreeEntryOnSelected, TreeEntryEquality)
    self.navigationTree:SetOpenAnimation("ZO_TreeOpenAnimation")
    self.headerNodes = {}
    self.collectibleIdToTreeNode = {}
    self:RefreshList()
end
function ZO_SpecializedCollectionsBook_Keyboard:RefreshListIfDirty()
    if self.dirty then
        self:RefreshList()
        self.dirty = false
    end
end
function ZO_SpecializedCollectionsBook_Keyboard:InitializeEvents()
    COLLECTIONS_BOOK_SINGLETON:RegisterCallback("OnCollectibleUpdated", function(...) self:OnCollectibleUpdated(...) end)
    COLLECTIONS_BOOK_SINGLETON:RegisterCallback("OnCollectionUpdated", function() self:OnCollectionUpdated() end)
    COLLECTIONS_BOOK_SINGLETON:RegisterCallback("OnCollectiblesUpdated", function() self:OnCollectionUpdated() end)
    COLLECTIONS_BOOK_SINGLETON:RegisterCallback("OnCollectionNotificationRemoved", function(...) self:OnCollectionNotificationRemoved(...) end)
    COLLECTIONS_BOOK_SINGLETON:RegisterCallback("OnCollectibleNewStatusRemoved", function(...) self:OnCollectibleNewStatusRemoved(...) end)
end
function ZO_SpecializedCollectionsBook_Keyboard:GetSelectedData()
    return self.navigationTree:GetSelectedData()
end
function ZO_SpecializedCollectionsBook_Keyboard:FocusCollectibleId(id)
    local node = self.collectibleIdToTreeNode[id]
    if node then
        if self.navigationTree:GetSelectedNode() == node then
            local RESELECT = true
            node:OnSelected(RESELECT)
        else
            self.navigationTree:SelectNode(node)
        end
    end
end
function ZO_SpecializedCollectionsBook_Keyboard:SetupAdditionalCollectibleData(data)
    --Override to add additional data if needed
end
do
    local function DefaultSort(entry1, entry2)
        if entry1.sortOrder ~= entry2.sortOrder then
            return entry1.sortOrder < entry2.sortOrder
        else
            return entry1.name < entry2.name
        end
    end
    function ZO_SpecializedCollectionsBook_Keyboard:SortCollectibleData(collectibleData)
        table.sort(collectibleData, DefaultSort)
    end
end
function ZO_SpecializedCollectionsBook_Keyboard:GetRelevantCollectibles()
    local collectiblesData = {}
    for _, collectibleCategoryType in ipairs(self.collectibleCategoryTypes) do
        for i = 1, GetTotalCollectiblesByCategoryType(collectibleCategoryType) do
            local collectibleId = GetCollectibleIdFromType(collectibleCategoryType, i)
            local name, description, _, _, unlocked, purchasable, active, _, hint, isPlaceholder = GetCollectibleInfo(collectibleId)
            if not isPlaceholder then
                if hint and hint ~= "" then
                    hint = ZO_CachedStrFormat(ZO_CACHED_STR_FORMAT_NO_FORMATTER, hint)
                end
                local data =
                {
                    collectibleId = collectibleId,
                    name = name,
                    description = description,
                    background = GetCollectibleKeyboardBackgroundImage(collectibleId),
                    unlockState = GetCollectibleUnlockStateById(collectibleId),
                    active = active,
                    purchasable = purchasable,
                    unlocked = unlocked,
                    hint = hint,
                    nickname = GetCollectibleNickname(collectibleId),
                    referenceId = GetCollectibleReferenceId(collectibleId),
                    sortOrder = GetCollectibleSortOrder(collectibleId),
                }
                self:SetupAdditionalCollectibleData(data)
                table.insert(collectiblesData, data)
            end
        end
    end
    self:SortCollectibleData(collectiblesData)
    return collectiblesData
end
function ZO_SpecializedCollectionsBook_Keyboard:GetCategorizedLists()
    local collectiblesData = self:GetRelevantCollectibles()
    local unlockedList = {}
    local lockedList = {}
    local lists = 
    {
        {
            name = GetString("SI_COLLECTIBLEUNLOCKSTATE", COLLECTIBLE_UNLOCK_STATE_UNLOCKED_OWNED),
            collectibles = unlockedList,
        },
        {
            name = GetString("SI_COLLECTIBLEUNLOCKSTATE", COLLECTIBLE_UNLOCK_STATE_LOCKED),
            collectibles = lockedList,
        },
    }
    for _, data in ipairs(collectiblesData) do
        if data.unlocked then
            table.insert(unlockedList, data)
        else
            table.insert(lockedList, data)
        end
    end
    return lists
end
function ZO_SpecializedCollectionsBook_Keyboard:RefreshList()
    ZO_ClearTable(self.headerNodes)
    ZO_ClearTable(self.collectibleIdToTreeNode)
    self.navigationTree:Reset()
    local categorizedLists = self:GetCategorizedLists()
    
    local firstNode = nil
    local selectedNode = nil
    for _, categorizedList in ipairs(categorizedLists) do
        if #categorizedList.collectibles > 0 then
            local headerNode = self.navigationTree:AddNode("ZO_SpecializedCollection_Book_NavigationHeader_Keyboard", categorizedList.name, nil, SOUNDS.JOURNAL_PROGRESS_CATEGORY_SELECTED)
            for _, collectibleData in ipairs(categorizedList.collectibles) do
                local node = self.navigationTree:AddNode("ZO_SpecializedCollection_Book_NavigationEntry_Keyboard", collectibleData, headerNode, SOUNDS.JOURNAL_PROGRESS_SUB_CATEGORY_SELECTED)
                self.collectibleIdToTreeNode[collectibleData.collectibleId] = node
                if not firstNode then
                    firstNode = node
                end
                if self.selectedId and self.selectedId == collectibleData.collectibleId then
                    selectedNode = node
                end
            end
        end
    end
    self.navigationTree:Commit()
    local navigateToNode = selectedNode or firstNode
    if navigateToNode then
        self.navigationTree:SelectNode(navigateToNode)
    end
    self:RefreshDetails()
end
function ZO_SpecializedCollectionsBook_Keyboard:RefreshDetails()
    local data = self.navigationTree:GetSelectedData()
    if data then
        self.imageControl:SetTexture(data.background)
        self.nameLabel:SetText(zo_strformat(SI_COLLECTIBLE_NAME_FORMATTER, data.name))
        self.descriptionLabel:SetText(data.description)
    end
end
function ZO_SpecializedCollectionsBook_Keyboard:BrowseToCollectible(collectibleId)
    self:FocusCollectibleId(collectibleId)
    MAIN_MENU_KEYBOARD:ToggleSceneGroup("collectionsSceneGroup", self.sceneName)
end
function ZO_SpecializedCollectionsBook_Keyboard:OnCollectibleUpdated(collectibleId, justUnlocked)
    if justUnlocked then
        self:RefreshList()
    else
        local node = self.collectibleIdToTreeNode[collectibleId]
        if node then
            local data = node:GetData()
            local wasActive = data.active
            data.active = select(7, GetCollectibleInfo(collectibleId))
            data.nickname = GetCollectibleNickname(collectibleId)
            local unlockState = GetCollectibleUnlockStateById(collectibleId)
            if data.unlockState ~= unlockState then
                self:RefreshList()
            else
                if data.active ~= wasActive then
                    node:RefreshControl()
                end
                self:RefreshDetails()
            end
        end
    end
end
function ZO_SpecializedCollectionsBook_Keyboard:UpdateCollectibleTreeEntry(collectibleId)
    if not SCENE_MANAGER:IsShowing(self.sceneName) then
        self.dirty = true
    else
        local node = self.collectibleIdToTreeNode[collectibleId]
        if node then
            node:RefreshControl()
        end
    end
end
function ZO_SpecializedCollectionsBook_Keyboard:OnCollectionNotificationRemoved(notificationId, collectibleId)
    self:UpdateCollectibleTreeEntry(collectibleId)
end
function ZO_SpecializedCollectionsBook_Keyboard:OnCollectibleNewStatusRemoved(collectibleId)
    self:UpdateCollectibleTreeEntry(collectibleId)
end
function ZO_SpecializedCollectionsBook_Keyboard:OnCollectionUpdated()
    if not SCENE_MANAGER:IsShowing(self.sceneName) then
        self.dirty = true
    else
        self:RefreshList()
    end
end
function ZO_SpecializedCollectionsBook_Keyboard:OnSceneShown()
    self:RefreshListIfDirty()
end