Back to Home

ESO Lua File v101050

ingame/lorelibrary/keyboard/lorelibrary_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
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
local LoreLibrary = ZO_InitializingObject:Subclass()
local LoreLibraryScrollList
function LoreLibrary:Initialize(control)
    control.owner = self
    self.control = control
    self.totalCollectedLabel = control:GetNamedChild("TotalCollected")
    LORE_LIBRARY_SCENE = ZO_Scene:New("loreLibrary", SCENE_MANAGER)
    local function OnStateChanged(oldState, newState)
        if newState == SCENE_SHOWING then
            KEYBIND_STRIP:AddKeybindButtonGroup(self.keybindStripDescriptor)
            if self.collectionIdToSelect then
                self.dirty = true
            end
        elseif newState == SCENE_HIDDEN then
            KEYBIND_STRIP:RemoveKeybindButtonGroup(self.keybindStripDescriptor)
        end
    end
    LORE_LIBRARY_SCENE:RegisterCallback("StateChange", OnStateChanged)
    self.dirty = true
end
function LoreLibrary:InitializeCategoryList(control)
    self.navigationTree = ZO_Tree:New(control:GetNamedChild("NavigationContainerScrollChild"), 40, -10, 385)
    local function TreeHeaderSetup(node, controlHeader, data, open)
        controlHeader:SetText(data.name)
        ZO_LabelHeader_Setup(controlHeader, open)
    end
    local function TreeHeaderEquality(left, right)
        -- One of these fields will be nil and the other will be valid.
        return left.categoryIndex == right.categoryIndex and left.mailListIndex == right.mailListIndex
    end
    self.navigationTree:AddTemplate("ZO_LabelHeader", TreeHeaderSetup, nil, TreeHeaderEquality, nil, 0)
    local function TreeEntrySetup(node, entryControl, data, open)
        if data.mailListIndex ~= nil then
            if data.numUnlocked < data.total then
                -- When only some messages are known: "Correspondence 5"
                entryControl:SetText(zo_strformat(SI_LORE_LIBRARY_MAIL_LIST_TREE_ENTRY, data.name, ZO_SELECTED_TEXT:Colorize(data.numUnlocked)))
            else
                -- When all messages are known: "Correspondence 15/15"
                entryControl:SetText(zo_strformat(SI_LORE_LIBRARY_KNOWN_BOOKS, data.name, data.numUnlocked, data.total))
            end
            entryControl:SetEnabled(data.numUnlocked > 0)
            node:SetEnabled(data.numUnlocked > 0)
        else
            -- When any book is known: "Book 5/16"
            entryControl:SetText(zo_strformat(SI_LORE_LIBRARY_KNOWN_BOOKS, data.name, data.numKnownBooks, data.totalBooks))
        end
    end
    local function TreeEntryOnSelected(entryControl, data, selected, reselectingDuringRebuild)
        entryControl:SetSelected(selected)
        if selected then
            self:BuildBookList()
        end
        KEYBIND_STRIP:UpdateKeybindButtonGroup(self.keybindStripDescriptor)
    end
    local function TreeEntryEquality(left, right)
        -- Either category and collection will be valid or mailListIndex type will be. Sufficient for an equality check.
        return left.categoryIndex == right.categoryIndex and left.collectionIndex == right.collectionIndex and left.mailListIndex == right.mailListIndex
    end
    self.navigationTree:AddTemplate("ZO_LoreLibraryNavigationEntry", TreeEntrySetup, TreeEntryOnSelected, TreeEntryEquality)
    self.navigationTree:SetExclusive(true)
    self.navigationTree:SetOpenAnimation("ZO_TreeOpenAnimation")
end
function LoreLibrary:InitializeBookList(control)
    self.list = LoreLibraryScrollList:New(control, self)
end
function LoreLibrary:InitializeEvents(control)
    local function RefreshCategoryList()
        self:BuildCategoryList()
    end
    control:RegisterForEvent(EVENT_LORE_LIBRARY_INITIALIZED, RefreshCategoryList)
    control:RegisterForEvent(EVENT_LORE_BOOK_LEARNED, RefreshCategoryList)
    control:RegisterForEvent(EVENT_LORE_BOOK_COLLECTION_LEARNED, RefreshCategoryList)
    control:RegisterForEvent(EVENT_MAIL_LISTS_INITIALIZED, RefreshCategoryList)
    control:RegisterForEvent(EVENT_MAIL_LISTS_UPDATED, RefreshCategoryList)
end
function LoreLibrary:RefreshCollectedInfo()
    self.totalCollectedLabel:SetText(zo_strformat(SI_LORE_LIBRARY_TOTAL_COLLECTED, self.totalCurrentlyCollected, self.totalPossibleCollected))
end
function LoreLibrary:OnShow()
    if self.dirty then
        self:BuildCategoryList()
    end
end
function LoreLibrary:SetCollectionIdToSelect(collectionId)
    self.collectionIdToSelect = collectionId
end
function LoreLibrary:GetSelectedCategoryIndex()
    local selectedData = self.navigationTree:GetSelectedData()
    if selectedData then
        return selectedData.categoryIndex
    end
end
function LoreLibrary:GetSelectedCollectionIndex()
    local selectedData = self.navigationTree:GetSelectedData()
    if selectedData then
        return selectedData.collectionIndex
    end
end
function LoreLibrary:BuildBookList()
end
local function NameSorter(left, right)
    return left.name < right.name
end
local function GetMailListMessages(mailListIndex)
    local numMessages = GetNumUnlockedMailsInMailList(mailListIndex)
    local messages = {}
    for messageIndex = 1, numMessages do
        local sender, subject, body, icon = GetMailInfoFromMailList(mailListIndex, messageIndex)
        local title = zo_strformat(SI_LORE_LIBRARY_MAIL_ENTRY_FORMATTER, subject, messageIndex)
        table.insert(messages,
        {
            mailListIndex = mailListIndex,
            messageIndex = messageIndex,
            title = title,
            body = body,
            icon = icon,
            sender = sender,
        })
    end
    return messages
end
function LoreLibrary:BuildCategoryList()
    if self.control:IsControlHidden() then
        self.dirty = true
        return
    end
    self.totalCurrentlyCollected = 0
    self.totalPossibleCollected = 0
    self.navigationTree:Reset()
    local categories = {}
    for categoryIndex = 1, GetNumLoreCategories() do
        local categoryName, numCollections = GetLoreCategoryInfo(categoryIndex)
        for collectionIndex = 1, numCollections do
            local _, _, _, _, hidden = GetLoreCollectionInfo(categoryIndex, collectionIndex)
            if not hidden then
                table.insert(categories, { categoryIndex = categoryIndex, name = categoryName, numCollections = numCollections, })
                break
            end
        end
    end
    table.sort(categories, NameSorter)
    local collectionNodeToSelect = nil
    for i, categoryData in ipairs(categories) do
        local parent = self.navigationTree:AddNode("ZO_LabelHeader", categoryData)
        local categoryIndex = categoryData.categoryIndex
        local numCollections = categoryData.numCollections
        local collections = {}
        for collectionIndex = 1, numCollections do
            local collectionName, description, numKnownBooks, totalBooks, hidden, _, collectionId = GetLoreCollectionInfo(categoryIndex, collectionIndex)
            if not hidden then
                table.insert(collections, { categoryIndex = categoryIndex, collectionIndex = collectionIndex, name = collectionName, description = description, numKnownBooks = numKnownBooks, totalBooks = totalBooks, collectionId = collectionId, })
                self.totalCurrentlyCollected = self.totalCurrentlyCollected + numKnownBooks
                self.totalPossibleCollected = self.totalPossibleCollected + totalBooks
            end
        end
        table.sort(collections, NameSorter)
        for k, collectionData in ipairs(collections) do
            local node = self.navigationTree:AddNode("ZO_LoreLibraryNavigationEntry", collectionData, parent)
            if self.collectionIdToSelect and self.collectionIdToSelect == collectionData.collectionId then
                collectionNodeToSelect = node
            end
        end
    end
    -- Add categories for all mail lists
    local parent = self.navigationTree:AddNode("ZO_LabelHeader", { name = GetString(SI_LORE_LIBRARY_MAIL_LIST_HEADER), })
    local mailLists = ZO_LoreLibrary_GetSortedMailLists()
    for index, mailList in ipairs(mailLists) do
        if mailList.total > 0 then
            self.navigationTree:AddNode("ZO_LoreLibraryNavigationEntry", mailList, parent)
        end
    end
    self.navigationTree:Commit(collectionNodeToSelect, true)
    KEYBIND_STRIP:UpdateKeybindButtonGroup(self.keybindStripDescriptor)
    self.collectionIdToSelect = nil
    self.dirty = false
end
function LoreLibrary:InitializeKeybindStripDescriptors()
    self.keybindStripDescriptor =
    {
        -- Read
        {
            alignment = KEYBIND_STRIP_ALIGN_RIGHT,
            name = GetString(SI_LORE_LIBRARY_READ),
            keybind = "UI_SHORTCUT_PRIMARY",
            visible = function() return self.list:GetMouseOverRow() and self.list:GetMouseOverRow().known end,
            callback = function()
                local control = self.list:GetMouseOverRow()
                if control.bookIndex ~= nil then
                    ZO_LoreLibrary_ReadBook(control.categoryIndex, control.collectionIndex, control.bookIndex)
                elseif control.mailListIndex ~= nil then
                    ZO_LoreLibrary_ReadMailFromMailList(control.mailListIndex, control.messageIndex)
                end
            end,
        },
        -- Open in Achievements
        {
            alignment = KEYBIND_STRIP_ALIGN_RIGHT,
            name = GetString(SI_LORE_LIBRARY_TO_ACHIEVEMENT_ACTION),
            keybind = "UI_SHORTCUT_SECONDARY",
            visible = function()
                local targetData = self.navigationTree:GetSelectedData()
                if targetData then
                    local achievementId = GetLoreBookCollectionLinkedAchievement(targetData.categoryIndex, targetData.collectionIndex)
                    return achievementId ~= 0
                end
                return false
            end,
            callback = function()
                local targetData = self.navigationTree:GetSelectedData()
                local achievementId = GetLoreBookCollectionLinkedAchievement(targetData.categoryIndex, targetData.collectionIndex)
                SYSTEMS:GetObject("achievements"):ShowAchievement(achievementId)
                MAIN_MENU_KEYBOARD:ShowScene("achievements")
            end,
        },
    }
end
    LORE_LIBRARY = LoreLibrary:New(control)
end
LoreLibraryScrollList = ZO_SortFilterList:Subclass()
local BOOK_DATA_TYPE = 1
local MAIL_DATA_TYPE = 2
local MAIL_HEADER_TYPE = 3
function LoreLibraryScrollList:Initialize(control, owner)
    ZO_SortFilterList.Initialize(self, control, owner)
    self.owner = owner
    self.keybindStripDescriptor = owner.keybindStripDescriptor
    local function SetUpBookEntry(entryControl, data)
        entryControl.owner = self
        local title, icon, known = GetLoreBookInfo(data.categoryIndex, data.collectionIndex, data.bookIndex)
        entryControl.categoryIndex = data.categoryIndex
        entryControl.collectionIndex = data.collectionIndex
        entryControl.bookIndex = data.bookIndex
        entryControl.known = known
        entryControl.text:SetText(title)
        entryControl.icon:SetTexture(icon)
        ZO_SortFilterList.SetupRow(self, entryControl, data)
    end
    ZO_ScrollList_AddDataType(self.list, BOOK_DATA_TYPE, "ZO_LoreLibrary_BookEntry", 52, SetUpBookEntry)
    
    local function SetUpMailEntry(entryControl, data)
        entryControl.owner = self
        entryControl.mailListIndex = data.mailListIndex
        entryControl.messageIndex = data.messageIndex
        entryControl.known = true
        entryControl.text:SetText(data.title)
        entryControl.icon:SetTexture(data.icon)
        ZO_SortFilterList.SetupRow(self, entryControl, data)
    end
    ZO_ScrollList_AddDataType(self.list, MAIL_DATA_TYPE, "ZO_LoreLibrary_BookEntry", 52, SetUpMailEntry)
    
    local function SetUpMailHeaderEntry(entryControl, data)
        entryControl.owner = self
        entryControl.known = true
        entryControl.text:SetText(data.name)
        ZO_SortFilterList.SetupRow(self, entryControl, data)
    end
    ZO_ScrollList_AddDataType(self.list, MAIL_HEADER_TYPE, "ZO_LoreLibrary_MailHeader", 60, SetUpMailHeaderEntry)
    local function OnHighlightChanged(entryControl, highlighted)
        if highlighted then
            if not entryControl.iconAnimation then
                entryControl.iconAnimation = ANIMATION_MANAGER:CreateTimelineFromVirtual("IconSlotMouseOverAnimation", entryControl.icon)
            end
            entryControl.iconAnimation:PlayForward()
        elseif entryControl.iconAnimation then
            entryControl.iconAnimation:PlayBackward()
        end
    end
    ZO_ScrollList_EnableHighlight(self.list, "ZO_TallListHighlight", OnHighlightChanged)
end
function LoreLibraryScrollList:GetRowColors(data, mouseIsOver, control)
    local known = control.known
    if mouseIsOver then
        return ZO_SELECTED_TEXT, known and 0 or 1
    end
    if known then
        return ZO_NORMAL_TEXT, 0
    end
    return ZO_DISABLED_TEXT, 1
end
function LoreLibraryScrollList:ColorRow(control, data, mouseIsOver)
    local textColor, iconDesaturate = self:GetRowColors(data, mouseIsOver, control)
    control.text:SetColor(textColor:UnpackRGBA())
    control.icon:SetDesaturation(iconDesaturate)
end
do
    local function BookEntryComparator(leftScrollData, rightScrollData)
        local leftData = leftScrollData.data
        local rightData = rightScrollData.data
        local leftTitle, _, leftKnown = GetLoreBookInfo(leftData.categoryIndex, leftData.collectionIndex, leftData.bookIndex)
        local rightTitle, _, rightKnown = GetLoreBookInfo(rightData.categoryIndex, rightData.collectionIndex, rightData.bookIndex)
        if leftKnown == rightKnown then
            return leftTitle < rightTitle
        end
        return leftKnown
    end
    function LoreLibraryScrollList:SortScrollList()
        local scrollData = ZO_ScrollList_GetDataList(self.list)
        local categoryData = self.owner.navigationTree:GetSelectedData()
        if categoryData.mailListIndex == nil then
            table.sort(scrollData, BookEntryComparator)
        end
    end
end
function LoreLibraryScrollList:BuildMasterList()
    -- do nothing
    -- the lore library builds all its data in FilterScrollList because it doesn't need to keep a master list around
end
function LoreLibraryScrollList:FilterScrollList()
    local scrollData = ZO_ScrollList_GetDataList(self.list)
    local categoryData = self.owner.navigationTree:GetSelectedData()
    if categoryData.mailListIndex ~= nil then
        local currentMailSenderLower = ""
        -- Add mails to the list
        local messages = GetMailListMessages(categoryData.mailListIndex)
        for index, messageData in ipairs(messages) do
            local nextSender = messageData.sender
            local nextSenderLower = zo_strlower(nextSender)
            -- ESO-862381: Compare with lower because sometimes senders scream their name
            if currentMailSenderLower ~= nextSenderLower then
                currentMailSenderLower = nextSenderLower
                -- ESO-862381, ESO-888526: If the sender is all caps, lower it before formatting it.
                -- Otherwise, leave it alone so <<C:1>> works right in non-English languages
                local senderClean = zo_strIsUpper(nextSender) and nextSenderLower or nextSender
                table.insert(scrollData, ZO_ScrollList_CreateDataEntry(MAIL_HEADER_TYPE,
                {
                    mailListIndex = messageData.mailListIndex,
                    name = zo_strformat(SI_LORE_LIBRARY_MAIL_SENDER_FORMATTER, senderClean),
                    sortOrder = index,
                }))
            end
            messageData.sortOrder = index
            table.insert(scrollData, ZO_ScrollList_CreateDataEntry(MAIL_DATA_TYPE, messageData))
        end
    else
        -- Fill out books of a collection into the list.
        local categoryIndex = self.owner:GetSelectedCategoryIndex()
        local collectionIndex = self.owner:GetSelectedCollectionIndex()
        local totalBooks = select(4, GetLoreCollectionInfo(categoryIndex, collectionIndex))
        for bookIndex = 1, totalBooks do
            table.insert(scrollData,
                ZO_ScrollList_CreateDataEntry(BOOK_DATA_TYPE, 
                { 
                    categoryIndex = categoryIndex, 
                    collectionIndex = collectionIndex, 
                    bookIndex = bookIndex,
                })
            )
        end
    end
end
function LoreLibraryScrollList:OnRowMouseUp(control, button)
    if button == MOUSE_BUTTON_INDEX_RIGHT then
        ClearMenu()
        SetMenuHiddenCallback(function() self:UnlockSelection() end)
        self:LockSelection()
        if control.known then
            AddMenuItem(GetString(SI_LORE_LIBRARY_READ), function() 
                if control.bookIndex ~= nil then
                    ZO_LoreLibrary_ReadBook(control.categoryIndex, control.collectionIndex, control.bookIndex) 
                elseif control.mailListIndex ~= nil then
                    ZO_LoreLibrary_ReadMailFromMailList(control.mailListIndex, control.messageIndex)
                end
            end)
        end
        if IsChatSystemAvailableForCurrentPlatform() and control.bookIndex ~= nil then
            AddMenuItem(GetString(SI_ITEM_ACTION_LINK_TO_CHAT), function()
                local link = ZO_LinkHandler_CreateChatLink(GetLoreBookLink, control.categoryIndex, control.collectionIndex, control.bookIndex)
                ZO_LinkHandler_InsertLink(link) 
            end)
        end
        ShowMenu(control)
    end
end
function LoreLibraryScrollList:OnMouseDoubleClick(control, button)
    if button == MOUSE_BUTTON_INDEX_LEFT then
        if control.known then
            if control.bookIndex ~= nil then
                ZO_LoreLibrary_ReadBook(control.categoryIndex, control.collectionIndex, control.bookIndex)
            elseif control.mailListIndex ~= nil then
                ZO_LoreLibrary_ReadMailFromMailList(control.mailListIndex, control.messageIndex)
            end
        else
            ZO_AlertNoSuppression(UI_ALERT_CATEGORY_ALERT, nil, zo_strformat(SI_LORE_LIBRARY_UNKNOWN_BOOK, control.text:GetText()))
        end
    end
end
function LoreLibraryScrollList:GetMouseOverRow()
    return self.mouseOverRow
end