Back to Home

ESO Lua File v101050

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
--[[ Lore Reader ]]--
local LoreReader = ZO_InitializingObject:Subclass()
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")
    self.overrideImageTexture = control:GetNamedChild("OverrideImage")
    self.overrideImageTitle = self.overrideImageTexture:GetNamedChild("Title")
    local function OnShowBook(eventCode, title, body, medium, showTitle, bookId)
        local overrideImage, overrideImageTitlePosition = GetLoreBookOverrideImageFromBookId(bookId)
        self:Show(title, body, medium, showTitle, overrideImage, overrideImageTitlePosition)
    end
    local function OnHideBook()
        SCENE_MANAGER:Hide("loreReaderDefault")
    end
    local function OnAllGuiScreensResized()
        if not self.control:IsHidden() then
            self.pageGrouping = 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_DEFAULT_SCENE = ZO_Scene:New("loreReaderDefault", 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_DEFAULT_SCENE = ZO_Scene:New("gamepad_loreReaderDefault", SCENE_MANAGER)
    local function OnPCSceneStateChange(oldState, newState)
        if newState == SCENE_SHOWING then
            KEYBIND_STRIP:RemoveDefaultExit()
            KEYBIND_STRIP:AddKeybindButtonGroup(self.PCKeybindStripDescriptor)
            self.keybindStripDescriptor = self.PCKeybindStripDescriptor
        elseif newState == SCENE_HIDDEN then
            KEYBIND_STRIP:RemoveKeybindButtonGroup(self.PCKeybindStripDescriptor)
            KEYBIND_STRIP:RestoreDefaultExit()
        end
    end
    local function OnGamepadSceneStateChange(oldState, newState)
        if newState == SCENE_SHOWING then
            KEYBIND_STRIP:AddKeybindButtonGroup(self.gamepadKeybindStripDescriptor)
            self.keybindStripDescriptor = self.gamepadKeybindStripDescriptor
            SCREEN_NARRATION_MANAGER:QueueCustomEntry("loreReader")
        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_DEFAULT_SCENE:RegisterCallback("StateChange", OnPCSceneStateChange)
    GAMEPAD_LORE_READER_INVENTORY_SCENE:RegisterCallback("StateChange", OnGamepadSceneStateChange)
    GAMEPAD_LORE_READER_LORE_LIBRARY_SCENE:RegisterCallback("StateChange", OnGamepadSceneStateChange)
    GAMEPAD_LORE_READER_DEFAULT_SCENE:RegisterCallback("StateChange", OnGamepadSceneStateChange)
    local narrationInfo =
    {
        canNarrate = function()
            return GAMEPAD_LORE_READER_INVENTORY_SCENE:IsShowing() or GAMEPAD_LORE_READER_LORE_LIBRARY_SCENE:IsShowing() or GAMEPAD_LORE_READER_DEFAULT_SCENE:IsShowing()
        end,
        selectedNarrationFunction = function()
            return self:GetNarrationText()
        end,
    }
    SCREEN_NARRATION_MANAGER:RegisterCustomObject("loreReader", narrationInfo)
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.maxPageGroupings > 1 end,
        },
        -- The keyboard exit should just close this scene (so if it was pushed on the scene stack it will go back, such as going back to the lore library)
        {
            name = GetString(SI_EXIT_BUTTON),
            keybind = "UI_SHORTCUT_EXIT",
            order = -10000,
            callback = function()
                SCENE_MANAGER:HideCurrentScene()
            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:ChangePageGrouping(-1)
            end,
            enabled = function() return self.pageGrouping ~= 1 end,
            visible = function() return self.maxPageGroupings > 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:ChangePageGrouping(1)
            end,
            enabled = function() return self.pageGrouping ~= self.maxPageGroupings end,
            visible = function() return self.maxPageGroupings > 1 end,
        },
    }
    ZO_Gamepad_AddBackNavigationKeybindDescriptors(self.gamepadKeybindStripDescriptor, GAME_NAVIGATION_TYPE_BUTTON)
end
function LoreReader:GetCustomSceneName(currentSceneName)
    if currentSceneName == "loreLibrary" or currentSceneName == "bookSetGamepad" then
        return IsInGamepadPreferredMode() and "gamepad_loreReaderLoreLibrary" or "loreReaderLoreLibrary"
    elseif currentSceneName == "inventory" or currentSceneName == "gamepad_inventory_item_filter" or currentSceneName == "gamepad_inventory_root" then
        return IsInGamepadPreferredMode() and "gamepad_loreReaderInventory" or "loreReaderInventory"
    end
end
function LoreReader:Show(title, body, medium, showTitle, overrideImage, overrideImageTitlePosition)
    local isGamepad = IsInGamepadPreferredMode()
    self:SetupBook(title, body, medium, showTitle, isGamepad, overrideImage, overrideImageTitlePosition)
    local customSceneName = self:GetCustomSceneName(SCENE_MANAGER:GetCurrentScene():GetName())
    if customSceneName then
        SCENE_MANAGER:Push(customSceneName)
    else
        --If we are not pushing a custom scene, just fall back to the default
        local defaultSceneName = isGamepad and "gamepad_loreReaderDefault" or "loreReaderDefault"
        SCENE_MANAGER:Show(defaultSceneName)
    end
end
function LoreReader:SetupBook(title, body, medium, showTitle, isGamepad, overrideImage, overrideImageTitlePosition)
    self:ApplyMedium(medium, isGamepad, overrideImage)
    self.pageGrouping = 1
    self:SetText(title, body, showTitle, overrideImageTitlePosition)
end
function LoreReader:OnShow()
    PlaySound(self.OpenSound)
end
function LoreReader:OnHide()
    EndInteraction(INTERACTION_BOOK)
    PlaySound(self.CloseSound)
end
function LoreReader:ApplyMedium(medium, isGamepad, overrideImage)
    local bg, numPages, pageWidth, pageHeight, pageYOffset, leftPageXOffset, rightPageXOffset, openSound, closeSound, turnPageSound = GetBookMediumInfo(medium)
    local titleFontName, titleFontSize, titleFontStyle, bodyFontName, bodyFontSize, bodyFontStyle, r, g, b, a, styleR, styleG, styleB, styleA = GetBookMediumFontInfo(medium, isGamepad)
    local titleFont = ZO_CreateFontString(titleFontName, titleFontSize, titleFontStyle)
    local bodyFont = ZO_CreateFontString(bodyFontName, bodyFontSize, bodyFontStyle)
    self.CloseSound = closeSound
    self.OpenSound = openSound
    self.useOverrideImage = overrideImage ~= nil
    if self.useOverrideImage then
        self.bookContainer:SetHidden(true)
        self.overrideImageTexture:SetHidden(false)
        
        self.overrideImageTexture:SetTexture(overrideImage)
        self.overrideImageTitle:SetColor(r, g, b, a)
        self.overrideImageTitle:SetStyleColor(styleR, styleG, styleB, styleA)
        self.overrideImageTitle:SetFont(titleFont)
    else
        self.bookContainer:SetHidden(false)
        self.overrideImageTexture:SetHidden(true)
        self.renderablePageHeight = pageHeight
        self.mediumBg:SetTexture(bg)
        self.title:SetColor(r, g, b, a)
        self.title:SetStyleColor(styleR, styleG, styleB, styleA)
        self.firstPage.body:SetColor(r, g, b, a)
        self.firstPage.body:SetStyleColor(styleR, styleG, styleB, styleA)
        self.secondPage.body:SetColor(r, g, b, a)
        self.secondPage.body:SetStyleColor(styleR, styleG, styleB, styleA)
        self.title:SetFont(titleFont)
        self.firstPage:SetHeight(pageHeight)
        self.firstPage.body:SetFont(bodyFont)
        self.secondPage:SetHeight(pageHeight)
        self.secondPage.body:SetFont(bodyFont)
        self.firstPage:ClearAnchors()
        self.secondPage:ClearAnchors()
        self.title:SetWidth(pageWidth)
        self.numPagesPerGrouping = numPages
        if numPages > 1 then
            self.firstPage:SetAnchor(LEFT, nil, LEFT, leftPageXOffset, pageYOffset)
            self.secondPage:SetAnchor(RIGHT, nil, RIGHT, rightPageXOffset, pageYOffset)
        else
            local pageXOffset = leftPageXOffset
            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.TurnPageSound = turnPageSound
    end
end
do
    local OVERRIDE_IMAGE_TITLE_PADDING = 20
    local function CalculatePageHeight(fontHeight, maxHeight)
        return zo_floor(maxHeight / fontHeight) * fontHeight
    end
    function LoreReader:LayoutText()
        if self.useOverrideImage then
            self.maxPageGroupings = 1
            if self.showTitle then
                self.overrideImageTitle:SetHidden(false)
                local anchorPosition = self.overrideImageTitlePosition
                local offsetX = 0
                local offsetY = 0
                local horizontalAlignment = TEXT_ALIGN_CENTER
                if ZO_FlagHelpers.MaskHasFlag(anchorPosition, LEFT) then
                    offsetX = OVERRIDE_IMAGE_TITLE_PADDING
                    horizontalAlignment = TEXT_ALIGN_LEFT
                elseif ZO_FlagHelpers.MaskHasFlag(anchorPosition, RIGHT) then
                    offsetX = -OVERRIDE_IMAGE_TITLE_PADDING
                    horizontalAlignment = TEXT_ALIGN_RIGHT
                end
                if ZO_FlagHelpers.MaskHasFlag(anchorPosition, TOP) then
                    offsetY = OVERRIDE_IMAGE_TITLE_PADDING
                elseif ZO_FlagHelpers.MaskHasFlag(anchorPosition, BOTTOM) then
                    offsetY = -OVERRIDE_IMAGE_TITLE_PADDING
                end
                self.overrideImageTitle:ClearAnchors()
                self.overrideImageTitle:SetAnchor(anchorPosition, nil, anchorPosition, offsetX, offsetY)
                self.overrideImageTitle:SetText(self.titleText)
                self.overrideImageTitle:SetWidth(self.overrideImageTexture:GetWidth() - (OVERRIDE_IMAGE_TITLE_PADDING * 2))
                self.overrideImageTitle:SetHorizontalAlignment(horizontalAlignment)
            else
                self.overrideImageTitle:SetHidden(true)
            end
        else
            local bodyFontHeight = self.firstPage.body:GetFontHeight()
            --Calculate the number of full lines that can fit in the page then save the height of that many lines as pageHeight.
            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.numPagesPerGrouping > 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)
    
            --The title height + the spacing between the title and body + the body height
            local entireHeight = titleHeight + yOffsetNeededToAlignLines + self.firstPage.body:GetTextHeight()
            --There are cases where the entire height is just barely larger than what can fit in one page (or two pages, or any integer number of pages). This leads to us
            --allocating a whole new page to show the bottom of the last line which often doesn't even have anything visible going on. The slop value is used to modify the
            --calculation so that if the amount that overflows the page is less than 10% of one line in height we don't bother making a new page. This pretty much only happens
            --due to minor floating point differences, but we might as well handle as much as we can.
            local slop = (bodyFontHeight * 0.1) / self.pageHeight
            local numPages = zo_ceil((entireHeight / self.pageHeight) - slop)
            self.maxPageGroupings = zo_ceil(numPages / self.numPagesPerGrouping)
        end
        self:UpdatePagingButtons()
    end
end
function LoreReader:SetText(title, body, showTitle, overrideImageTitlePosition)
    self.titleText = title
    self.bodyText = body
    self.showTitle = showTitle
    self.overrideImageTitlePosition = overrideImageTitlePosition
    self:LayoutText()
end
function LoreReader:ChangePageGrouping(offset)
    local newPage = zo_clamp(self.pageGrouping + offset, 1, self.maxPageGroupings)
    if self.pageGrouping ~= newPage then
        self.pageGrouping = newPage
        local scrollOffset = (self.pageGrouping - 1) * self.pageHeight * self.numPagesPerGrouping
        self.firstPage:SetVerticalScroll(scrollOffset)
        if self.numPagesPerGrouping > 1 then
            self.secondPage:SetVerticalScroll(scrollOffset + self.secondPageAdditionalOffset)
        end
        self:UpdatePagingButtons()
        PlaySound(self.TurnPageSound)
        --Re-narrate when changing the page grouping
        SCREEN_NARRATION_MANAGER:QueueCustomEntry("loreReader")
    end
end
function LoreReader:UpdatePagingButtons()
    KEYBIND_STRIP:UpdateKeybindButtonGroup(self.keybindStripDescriptor)
end
function LoreReader:GetNarrationText()
    
    if self.useOverrideImage then
        if self.showTitle then
            return SCREEN_NARRATION_MANAGER:CreateNarratableObject(self.titleText)
        end
    else
        local narrations = {}
        local bodyFontHeight = self.firstPage.body:GetFontHeight()
        local titleHeight = 0
        local yOffsetNeededToAlignLines = 0
        if self.showTitle then
            --If this is the first page and we are showing the title, include that in the narration
            if self.pageGrouping == 1 then
                table.insert(narrations, SCREEN_NARRATION_MANAGER:CreateNarratableObject(self.titleText))
            end
            titleHeight = self.title:GetTextHeight()
            yOffsetNeededToAlignLines = bodyFontHeight - (titleHeight % bodyFontHeight)
        end
    
        --Calculate the number of lines for the first page, taking title into account
        local numLinesFirstPage = zo_floor((self.renderablePageHeight - (yOffsetNeededToAlignLines + titleHeight)) / bodyFontHeight)
        --Calculate the number of lines for the rest of the pages
        local numLinesNormal = zo_floor(self.renderablePageHeight / bodyFontHeight)
        --Determine the number of lines for the second page (if there is one)
        local additionalLinesPerGrouping = 0
        if self.numPagesPerGrouping > 1 then
            additionalLinesPerGrouping = numLinesNormal
        end
        --Determine the number of lines for the first and second page combined
        local numLinesPerGrouping = numLinesNormal + additionalLinesPerGrouping
        local startLine
        local endLine
        if self.pageGrouping > 1 then
            --The first page grouping could potentially have a different number of lines than the rest, so manually account for that in the calculation
            local endLinePrevious = (self.pageGrouping - 2) * numLinesPerGrouping + numLinesFirstPage + additionalLinesPerGrouping
            startLine = endLinePrevious + 1
            endLine = endLinePrevious + numLinesPerGrouping
        else
            --If this is the first page grouping, then we can assume we are starting at line 1
            startLine = 1
            endLine = numLinesFirstPage + additionalLinesPerGrouping
        end
        --Get the text for the lines we determined and add it to the narration
        local narrationText = self.firstPage.body:GetTextForLines(startLine, endLine)
        table.insert(narrations, SCREEN_NARRATION_MANAGER:CreateNarratableObject(narrationText))
        return narrations
    end
end
--[[ XML Handlers ]]--
    LORE_READER = LoreReader:New(control)
end
    control.owner:OnShow()
end
    control.owner:OnHide()
end
    if button == MOUSE_BUTTON_INDEX_LEFT then
        control.owner:ChangePageGrouping(-1)
    elseif button == MOUSE_BUTTON_INDEX_RIGHT then
        control.owner:ChangePageGrouping(1)
    end
end
    control.owner:ChangePageGrouping(-1)
end
    control.owner:ChangePageGrouping(1)
end