Back to Home

ESO Lua File v100019

ingame/lorereader/lorereader.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
467
468
469
470
471
472
473
474
475
476
477
478
479
--[[ Lore Reader ]]--
local LoreReader = ZO_Object:Subclass()
function LoreReader:New(...)
    local loreReader = ZO_Object.New(self)
    loreReader:Initialize(...)
    
    return loreReader
end
function LoreReader:Initialize(control)
    control.owner = self
    self.control = control
    self.bookContainer = control:GetNamedChild("BookContainer")
    self.mediumBg = self.bookContainer:GetNamedChild("MediumBg")
    self.firstPage = self.bookContainer:GetNamedChild("FirstPage")
    self.firstPage.scrollChild = self.firstPage:GetNamedChild("Child")
    self.title = self.firstPage.scrollChild:GetNamedChild("Title")
    self.firstPage.body = self.firstPage.scrollChild:GetNamedChild("Body")
    self.secondPage = self.bookContainer:GetNamedChild("SecondPage")
    self.secondPage.scrollChild = self.secondPage:GetNamedChild("Child")
    self.secondPage.body = self.secondPage.scrollChild:GetNamedChild("Body")
    local function OnShowBook(eventCode, title, body, medium, showTitle, bookId)
        local willShow = self:Show(title, body, medium, showTitle)
        if willShow then
            PlaySound(self.OpenSound)
        else
            EndInteraction(INTERACTION_BOOK)
        end
    end
    local function OnHideBook()
        SCENE_MANAGER:Hide("loreReaderInteraction")
    end
    local function OnAllGuiScreensResized()
        if not self.control:IsHidden() then
            self.page = 1
            self:LayoutText()
        end
    end
    control:RegisterForEvent(EVENT_SHOW_BOOK, OnShowBook)
    control:RegisterForEvent(EVENT_HIDE_BOOK, OnHideBook)
    control:RegisterForEvent(EVENT_ALL_GUI_SCREENS_RESIZED, OnAllGuiScreensResized)
    LORE_READER_INVENTORY_SCENE = ZO_Scene:New("loreReaderInventory", SCENE_MANAGER)
    LORE_READER_LORE_LIBRARY_SCENE = ZO_Scene:New("loreReaderLoreLibrary", SCENE_MANAGER)
    LORE_READER_INTERACTION_SCENE = ZO_Scene:New("loreReaderInteraction", SCENE_MANAGER)
    GAMEPAD_LORE_READER_INVENTORY_SCENE = ZO_Scene:New("gamepad_loreReaderInventory", SCENE_MANAGER)
    GAMEPAD_LORE_READER_LORE_LIBRARY_SCENE = ZO_Scene:New("gamepad_loreReaderLoreLibrary", SCENE_MANAGER)
    GAMEPAD_LORE_READER_INTERACTION_SCENE = ZO_Scene:New("gamepad_loreReaderInteraction", SCENE_MANAGER)
    local function OnPCSceneStateChange(oldState, newState)
        if(newState == SCENE_SHOWING) then
            KEYBIND_STRIP:AddKeybindButtonGroup(self.PCKeybindStripDescriptor)
            self.keybindStripDescriptor = self.PCKeybindStripDescriptor
        elseif(newState == SCENE_HIDDEN) then
            KEYBIND_STRIP:RemoveKeybindButtonGroup(self.PCKeybindStripDescriptor)
        end
    end
    local function OnGamepadSceneStateChange(oldState, newState)
        if(newState == SCENE_SHOWING) then
            KEYBIND_STRIP:AddKeybindButtonGroup(self.gamepadKeybindStripDescriptor)
            self.keybindStripDescriptor = self.gamepadKeybindStripDescriptor
        elseif(newState == SCENE_HIDDEN) then
            KEYBIND_STRIP:RemoveKeybindButtonGroup(self.gamepadKeybindStripDescriptor)
        end
    end
    LORE_READER_INVENTORY_SCENE:RegisterCallback("StateChange", OnPCSceneStateChange)
    LORE_READER_LORE_LIBRARY_SCENE:RegisterCallback("StateChange", OnPCSceneStateChange)
    LORE_READER_INTERACTION_SCENE:RegisterCallback("StateChange", OnPCSceneStateChange)
    GAMEPAD_LORE_READER_INVENTORY_SCENE:RegisterCallback("StateChange", OnGamepadSceneStateChange)
    GAMEPAD_LORE_READER_LORE_LIBRARY_SCENE:RegisterCallback("StateChange", OnGamepadSceneStateChange)
    GAMEPAD_LORE_READER_INTERACTION_SCENE:RegisterCallback("StateChange", OnGamepadSceneStateChange)
end
function LoreReader:InitializeKeybindStripDescriptors()
    local customKeybindControl = self.control:GetNamedChild("KeyStripMouseButtons")
    customKeybindControl:SetHidden(true)
    customKeybindControl.owner = self
    self.PCKeybindStripDescriptor =
    {
        -- Turn pages
        {
            alignment = KEYBIND_STRIP_ALIGN_CENTER,
            name = GetString(SI_LORE_READER_TURN_PAGES),
            keybind = "CUSTOM_LORE_READER",
            callback = function() end,
            customKeybindControl = customKeybindControl,
            visible = function() return self.maxPages > 1 end,
        },
    }
    self.gamepadKeybindStripDescriptor =
    {
        -- Gamepad turn page backward
        {
            alignment = KEYBIND_STRIP_ALIGN_CENTER,
            name = GetString(SI_LORE_READER_PREVIOUS_PAGE),
            keybind = "UI_SHORTCUT_LEFT_TRIGGER",
            callback = function() 
                self:ChangePage(-1)
            end,
            enabled = function() return self.page ~= 1 end,
            visible = function() return self.maxPages > 1 end,
        },
        -- Gamepad turn page forward
        {
            alignment = KEYBIND_STRIP_ALIGN_CENTER,
            name = GetString(SI_LORE_READER_NEXT_PAGE),
            keybind = "UI_SHORTCUT_RIGHT_TRIGGER",
            callback = function() 
                self:ChangePage(1)
            end,
            enabled = function() return self.page ~= self.maxPages end,
            visible = function() return self.maxPages > 1 end,
        },
    }
    ZO_Gamepad_AddBackNavigationKeybindDescriptors(self.gamepadKeybindStripDescriptor, GAME_NAVIGATION_TYPE_BUTTON)
end
function LoreReader:Show(title, body, medium, showTitle)
    local isGamepad = IsInGamepadPreferredMode()
    self:SetupBook(title, body, medium, showTitle, isGamepad)
    if SCENE_MANAGER:IsShowingBaseScene() then
        if isGamepad then
            SCENE_MANAGER:Show("gamepad_loreReaderInteraction")
        else
            SCENE_MANAGER:Show("loreReaderInteraction")
        end
    else
        local currentSceneName = SCENE_MANAGER:GetCurrentScene():GetName()
        if currentSceneName == "loreLibrary" or currentSceneName == "bookSetGamepad" then
            if isGamepad then
                SCENE_MANAGER:Push("gamepad_loreReaderLoreLibrary")
            else
                SCENE_MANAGER:Push("loreReaderLoreLibrary")
            end
        elseif currentSceneName == "inventory" or currentSceneName == "gamepad_inventory_item_filter" or currentSceneName == "gamepad_inventory_root" then
            if isGamepad then
                SCENE_MANAGER:Push("gamepad_loreReaderInventory")
            else
                SCENE_MANAGER:Push("loreReaderInventory")
            end
        else
            return false
        end
    end
    return true
end
function LoreReader:SetupBook(title, body, medium, showTitle, isGamepad)
    self:ApplyMedium(medium, isGamepad)
    self.page = 1
    self:SetText(title, body, showTitle)
end
function LoreReader:OnHide()
    EndInteraction(INTERACTION_BOOK)
    PlaySound(self.CloseSound)
end
local READER_MEDIA = {
    [BOOK_MEDIUM_YELLOWED_PAPER] = {
        NumPages = 2,
        Bg = "EsoUI/Art/LoreLibrary/loreLibrary_paperBook.dds",
        keyboardFonts = {
                            TitleFont = "ZoFontBookPaperTitle",
                            BodyFont = "ZoFontBookPaper",
                        },
        gamepadFonts = {
                            TitleFont = "ZoFontGamepadBookPaperTitle",
                            BodyFont = "ZoFontGamepadBookPaper",
                        },
        OpenSound = SOUNDS.BOOK_OPEN,
        CloseSound = SOUNDS.BOOK_CLOSE,
        TurnPageSound = SOUNDS.BOOK_PAGE_TURN,
    },
    [BOOK_MEDIUM_ANIMAL_SKIN] = {
        NumPages = 2,
        Bg = "EsoUI/Art/LoreLibrary/loreLibrary_skinBook.dds",
        keyboardFonts = {
                            TitleFont = "ZoFontBookSkinTitle",
                            BodyFont = "ZoFontBookSkin",
                        },
        gamepadFonts = {
                            TitleFont = "ZoFontGamepadBookSkinTitle",
                            BodyFont = "ZoFontGamepadBookSkin",
                        },
        OpenSound = SOUNDS.BOOK_OPEN,
        CloseSound = SOUNDS.BOOK_CLOSE,
        TurnPageSound = SOUNDS.BOOK_PAGE_TURN,
    },
    [BOOK_MEDIUM_RUBBING_PAPER] = {
        NumPages = 2,
        Bg = "EsoUI/Art/LoreLibrary/loreLibrary_rubbingBook.dds",
        keyboardFonts = {
                            TitleFont = "ZoFontBookRubbingTitle",
                            BodyFont = "ZoFontBookRubbing",
                        },
        gamepadFonts = {
                            TitleFont = "ZoFontGamepadBookRubbingTitle",
                            BodyFont = "ZoFontGamepadBookRubbing",
                        },
        OpenSound = SOUNDS.BOOK_OPEN,
        CloseSound = SOUNDS.BOOK_CLOSE,
        TurnPageSound = SOUNDS.BOOK_PAGE_TURN,
    },
    [BOOK_MEDIUM_LETTER] = {
        NumPages = 1,
        Bg = "EsoUI/Art/LoreLibrary/loreLibrary_letter.dds",
        keyboardFonts = {
                            TitleFont = "ZoFontBookLetterTitle",
                            BodyFont = "ZoFontBookLetter",
                        },
        gamepadFonts = {
                            TitleFont = "ZoFontGamepadBookLetterTitle",
                            BodyFont = "ZoFontGamepadBookLetter",
                        },
        PageWidth = 520,
        PageHeight = 725,
        OpenSound = SOUNDS.NOTE_OPEN,
        CloseSound = SOUNDS.NOTE_CLOSE,
        TurnPageSound = SOUNDS.NOTE_PAGE_TURN,
    },
    [BOOK_MEDIUM_NOTE] = {
        NumPages = 1,
        Bg = "EsoUI/Art/LoreLibrary/loreLibrary_note.dds",
        keyboardFonts = {
                            TitleFont = "ZoFontBookNoteTitle",
                            BodyFont = "ZoFontBookNote",
                        },
        gamepadFonts = {
                            TitleFont = "ZoFontGamepadBookNoteTitle",
                            BodyFont = "ZoFontGamepadBookNote",
                        },
        PageWidth = 520,
        PageHeight = 725,
        OpenSound = SOUNDS.NOTE_OPEN,
        CloseSound = SOUNDS.NOTE_CLOSE,
        TurnPageSound = SOUNDS.NOTE_PAGE_TURN,
    },
    [BOOK_MEDIUM_SCROLL] = {
        NumPages = 1,
        Bg = "EsoUI/Art/LoreLibrary/loreLibrary_scroll.dds",
        keyboardFonts = {
                            TitleFont = "ZoFontBookScrollTitle",
                            BodyFont = "ZoFontBookScroll",
                        },
        gamepadFonts = {
                            TitleFont = "ZoFontGamepadBookScrollTitle",
                            BodyFont = "ZoFontGamepadBookScroll",
                        },
        PageWidth = 480,
        PageHeight = 650,
        FontAlpha = .65,
        OpenSound = SOUNDS.NOTE_OPEN,
        CloseSound = SOUNDS.NOTE_CLOSE,
        TurnPageSound = SOUNDS.NOTE_PAGE_TURN,
    },
    [BOOK_MEDIUM_STONE_TABLET] = {
        NumPages = 1,
        Bg = "EsoUI/Art/LoreLibrary/loreLibrary_stoneTablet.dds",
        keyboardFonts = {
                            TitleFont = "ZoFontBookTabletTitle",
                            BodyFont = "ZoFontBookTablet",
                        },
        gamepadFonts = {
                            TitleFont = "ZoFontGamepadBookTabletTitle",
                            BodyFont = "ZoFontGamepadBookTablet",
                        },
        PageHeight = 765,
        PageWidth = 780,
        FontAlpha = .65,
        FontStyleColor = ZO_ColorDef:New(1, 1, 1, .8),
        OpenSound = SOUNDS.TABLET_OPEN,
        CloseSound = SOUNDS.TABLET_CLOSE,
        TurnPageSound = SOUNDS.TABLET_PAGE_TURN,
    }
}
function LoreReader:ApplyMedium(medium, isGamepad)
    local mediumData = READER_MEDIA[medium] or READER_MEDIA[BOOK_MEDIUM_YELLOWED_PAPER]
    self.renderablePageHeight = mediumData.PageHeight or 660
    self.mediumBg:SetTexture(mediumData.Bg)
    local r, g, b = GetInterfaceColor(INTERFACE_COLOR_TYPE_BOOK_MEDIUM, medium)
    self.title:SetColor(r, g, b, mediumData.FontAlpha or .8)
    local styleR, styleG, styleB, styleA
    if mediumData.FontStyleColor then
        styleR, styleG, styleB, styleA = mediumData.FontStyleColor:UnpackRGBA()
    else
        styleR, styleG, styleB, styleA = 0, 0, 0, 1
    end
    self.title:SetStyleColor(styleR, styleG, styleB, styleA)
    self.firstPage.body:SetColor(r, g, b, mediumData.FontAlpha or .8)
    self.firstPage.body:SetStyleColor(styleR, styleG, styleB, styleA)
    self.secondPage.body:SetColor(r, g, b, mediumData.FontAlpha or .8)
    self.secondPage.body:SetStyleColor(styleR, styleG, styleB, styleA)
    local titleFont
    local bodyFont
    if isGamepad then
        titleFont = mediumData.gamepadFonts.TitleFont
        bodyFont = mediumData.gamepadFonts.BodyFont
    else
        titleFont = mediumData.keyboardFonts.TitleFont
        bodyFont = mediumData.keyboardFonts.BodyFont
    end
    self.title:SetFont(titleFont)
    self.firstPage:SetHeight(self.renderablePageHeight)
    self.firstPage.body:SetFont(bodyFont)
    self.secondPage:SetHeight(self.renderablePageHeight)
    self.secondPage.body:SetFont(bodyFont)
    self.firstPage:ClearAnchors()
    self.secondPage:ClearAnchors()
    local pageWidth = mediumData.PageWidth or 375
    local pageYOffset = mediumData.PageYOffset or -20
    self.title:SetWidth(pageWidth)
    self.numPages = mediumData.NumPages
    if self.numPages > 1 then
        local leftPageXOffset = mediumData.LeftPageXOffset or 100
        local rightPageXOffset = mediumData.RightPageXOffset or -95
        self.firstPage:SetAnchor(LEFT, nil, LEFT, leftPageXOffset, pageYOffset)
        self.secondPage:SetAnchor(RIGHT, nil, RIGHT, rightPageXOffset, pageYOffset)
    else
        local pageXOffset = mediumData.LeftPageXOffset or 0
        self.firstPage:SetAnchor(CENTER, nil, CENTER, pageXOffset, pageYOffset)
    end
    
    self.firstPage:SetWidth(pageWidth)
    self.firstPage.body:SetWidth(pageWidth)
    self.secondPage:SetWidth(pageWidth)
    self.secondPage.body:SetWidth(pageWidth)
    self.CloseSound = mediumData.CloseSound
    self.OpenSound = mediumData.OpenSound
    self.TurnPageSound = mediumData.TurnPageSound
end
local function CalculatePageHeight(fontHeight, maxHeight)
    return zo_floor(maxHeight / fontHeight) * fontHeight
end
function LoreReader:LayoutText()
    local bodyFontHeight = self.firstPage.body:GetFontHeight()
    self.pageHeight = CalculatePageHeight(bodyFontHeight, self.renderablePageHeight)
    self.firstPage:SetHeight(self.pageHeight)
    self.firstPage.body:ClearAnchors()
    local titleHeight = 0
    local yOffsetNeededToAlignLines = 0
    if self.showTitle then
        self.title:SetHidden(false)
        self.title:SetText(self.titleText)
        titleHeight = self.title:GetTextHeight()
        yOffsetNeededToAlignLines = bodyFontHeight - (titleHeight % bodyFontHeight)
        self.firstPage.body:SetAnchor(TOP, self.title, BOTTOM, 0, yOffsetNeededToAlignLines)
    else
        self.title:SetHidden(true)
        self.firstPage.body:SetAnchor(TOP, self.title, TOP, 0, 0)
    end
    
    self.firstPage.body:SetText(self.bodyText)
    if self.numPages > 1 then
        self.secondPage:SetHidden(false)
        self.secondPage:SetHeight(self.pageHeight)
        self.secondPage.body:SetText(self.bodyText)
        self.secondPageAdditionalOffset = self.pageHeight - (titleHeight + yOffsetNeededToAlignLines)
        self.secondPage:SetVerticalScroll(self.secondPageAdditionalOffset)
    else
        self.secondPage:SetHidden(true)
    end
    self.firstPage:SetVerticalScroll(0)
    local entireHeight = titleHeight + self.firstPage.body:GetTextHeight()
    self.maxPages = zo_ceil((entireHeight / self.pageHeight) / self.numPages)
    self:UpdatePagingButtons()
end
function LoreReader:SetText(title, body, showTitle)
    self.titleText = title
    self.bodyText = body
    self.showTitle = showTitle
    self:LayoutText()
end
function LoreReader:ChangePage(offset)
    local newPage = zo_clamp(self.page + offset, 1, self.maxPages)
    if self.page ~= newPage then
        self.page = newPage
        local scrollOffset = (self.page - 1) * self.pageHeight * self.numPages
        self.firstPage:SetVerticalScroll(scrollOffset)
        if self.numPages > 1 then
            self.secondPage:SetVerticalScroll(scrollOffset + self.secondPageAdditionalOffset)
        end
        self:UpdatePagingButtons()
        PlaySound(self.TurnPageSound)
    end
end
function LoreReader:UpdatePagingButtons()
    KEYBIND_STRIP:UpdateKeybindButtonGroup(self.keybindStripDescriptor)
end
--[[ XML Handlers ]]--
    LORE_READER = LoreReader:New(control)
end
    control.owner:OnHide()
end
function ZO_LoreReader_OnClicked(control, button)
    if button == MOUSE_BUTTON_INDEX_LEFT then
        control.owner:ChangePage(-1)
    elseif button == MOUSE_BUTTON_INDEX_RIGHT then
        control.owner:ChangePage(1)
    end
end
    control.owner:ChangePage(-1)
end
    control.owner:ChangePage(1)
end