Back to Home

ESO Lua File v101041

ingame/zonestories/gamepad/zonestories_gamepad.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
480
local GAMEPAD_ZONE_STORIES_BACKGROUND_SOURCE_WIDTH = 1024
local GAMEPAD_ZONE_STORIES_BACKGROUND_TEXTURE_WIDTH = 832
ZO_GAMEPAD_ZONE_STORIES_BACKGROUND_TEXTURE_COORDS_RIGHT = GAMEPAD_ZONE_STORIES_BACKGROUND_TEXTURE_WIDTH / GAMEPAD_ZONE_STORIES_BACKGROUND_SOURCE_WIDTH
local GAMEPAD_ZONE_STORIES_BACKGROUND_SOURCE_HEIGHT = 1024
local GAMEPAD_ZONE_STORIES_BACKGROUND_TEXTURE_HEIGHT = 955
ZO_GAMEPAD_ZONE_STORIES_BACKGROUND_TEXTURE_COORDS_BOTTOM = GAMEPAD_ZONE_STORIES_BACKGROUND_TEXTURE_HEIGHT / GAMEPAD_ZONE_STORIES_BACKGROUND_SOURCE_HEIGHT
local ZONE_STORIES_TILE_GRID_PADDING_X = 5
local ZONE_STORIES_TILE_GRID_PADDING_Y = 25
local COMPLETION_ACTIVITY_DESCRIPTION_TOOLTIP_INDEX = 0
ZO_ZoneStories_Gamepad = ZO_Object.MultiSubclass(ZO_ZoneStories_Shared, ZO_Gamepad_ParametricList_Screen)
function ZO_ZoneStories_Gamepad:New(...)
    return ZO_Gamepad_ParametricList_Screen.New(self, ...)
end
function ZO_ZoneStories_Gamepad:Initialize(control)
    local templateData =
    {
        gridListClass = ZO_GridScrollList_Gamepad,
        achievements = 
        {
            entryTemplate = "ZO_ZoneStory_AchievementTile_Gamepad_Control",
            dimensionsX = ZO_ZONE_STORIES_ACHIEVEMENT_TILE_GAMEPAD_DIMENSIONS_X,
            dimensionsY = ZO_ZONE_STORIES_ACHIEVEMENT_TILE_GAMEPAD_DIMENSIONS_Y,
            gridPaddingX = ZONE_STORIES_TILE_GRID_PADDING_X,
            gridPaddingY = ZONE_STORIES_TILE_GRID_PADDING_Y,
        },
        activityCompletion =
        {
            headerTemplate = "ZO_ZoneStory_ActivityCompletionHeader_Gamepad",
            entryTemplate = "ZO_ZoneStory_ActivityCompletionTile_Gamepad_Control",
            dimensionsX = ZO_ZONE_STORIES_ACTIVITY_COMPLETION_TILE_GAMEPAD_DIMENSIONS_X,
            dimensionsY = ZO_ZONE_STORIES_ACTIVITY_COMPLETION_TILE_GAMEPAD_DIMENSIONS_Y,
            gridPaddingX = ZONE_STORIES_TILE_GRID_PADDING_X,
            gridPaddingY = ZONE_STORIES_TILE_GRID_PADDING_Y,
            headerHeight = 70,
        },
        headerPrePadding = ZONE_STORIES_TILE_GRID_PADDING_Y
    }
    local sceneName = "zoneStoriesGamepad"
    GAMEPAD_ZONE_STORIES_SCENE = ZO_Scene:New(sceneName, SCENE_MANAGER)
    local ACTIVATE_LIST_ON_SHOW = true
    ZO_Gamepad_ParametricList_Screen.Initialize(self, control, ZO_GAMEPAD_HEADER_TABBAR_DONT_CREATE, ACTIVATE_LIST_ON_SHOW, GAMEPAD_ZONE_STORIES_SCENE)
    local function SubMenuEntrySetup(entryControl, data, selected, reselectingDuringRebuild, enabled, active)
        ZO_SharedGamepadEntry_OnSetup(entryControl, data, selected, reselectingDuringRebuild, enabled, active)
        local NO_TINT = nil
        local iconControl = entryControl.statusIndicator
        local trackedZoneId = GetTrackedZoneStoryActivityInfo()
        local playerZoneId = ZO_ExplorationUtils_GetZoneStoryZoneIdByZoneIndex(GetUnitZoneIndex("player"))
        iconControl:ClearIcons()
        if trackedZoneId == data.id then
            iconControl:AddIcon(ZO_CHECK_ICON, NO_TINT, GetString(SI_SCREEN_NARRATION_TRACKED_ICON_NARRATION))
        end
        if playerZoneId == data.id then
            iconControl:AddIcon("EsoUI/Art/Icons/mapKey/mapKey_player.dds", NO_TINT, GetString(SI_SCREEN_NARRATION_CURRENT_ZONE_ICON_NARRATION))
        end
        iconControl:Show()
    end
    -- Initialize shared elements in info display area
    local rightPane = control:GetNamedChild("RightPane")
    local rightPaneFragment = ZO_FadeSceneFragment:New(rightPane)
    GAMEPAD_ZONE_STORIES_SCENE:AddFragment(rightPaneFragment)
    local infoContainerControl = rightPane:GetNamedChild("InfoContainer")
    ZO_ZoneStories_Shared.Initialize(self, control, infoContainerControl, templateData)
    self.headerData =
    {
        titleText = GetString(SI_ACTIVITY_FINDER_CATEGORY_ZONE_STORIES),
    }
    self.tooltipSelectedIndex = COMPLETION_ACTIVITY_DESCRIPTION_TOOLTIP_INDEX
    -- Adds Zone Stories to category list in Activity Finder
    local categoryData = ZONE_STORIES_MANAGER.GetCategoryData()
    local gamepadCategoryData = categoryData.gamepadData
    ZO_ACTIVITY_FINDER_ROOT_GAMEPAD:AddCategory(gamepadCategoryData, gamepadCategoryData.priority)
    GAMEPAD_ZONE_STORIES_SCENE:RegisterCallback("StateChange", function(oldState, newState)
                                                            if newState == SCENE_SHOWING then
                                                                self:UpdateZoneStory()
                                                                self:SetFocusOnSelectedZone()
                                                                TriggerTutorial(TUTORIAL_TRIGGER_ZONE_STORIES_SHOWN)
                                                            end
                                                        end)
end
function ZO_ZoneStories_Gamepad:PerformUpdate()
    -- Function override required
end
function ZO_ZoneStories_Gamepad:InitializeZonesList()
    self:BuildZonesList()
end
function ZO_ZoneStories_Gamepad:InitializeGridList()
    ZO_ZoneStories_Shared.InitializeGridList(self)
    local function GetHeaderNarration()
        local narrations = {}
        local data = self:GetSelectedStoryData()
        local zoneData = ZONE_STORIES_MANAGER:GetZoneData(data.id)
        ZO_AppendNarration(narrations, SCREEN_NARRATION_MANAGER:CreateNarratableObject(zoneData.name))
        ZO_AppendNarration(narrations, SCREEN_NARRATION_MANAGER:CreateNarratableObject(zoneData.description))
        return narrations
    end
    self.gridList:SetOnSelectedDataChangedCallback(function(...) self:OnGridSelectionChanged(...) end)
end
function ZO_ZoneStories_Gamepad:Deactivate()
    ZO_Gamepad_ParametricList_Screen.Deactivate(self)
    self.gridList:Deactivate()
    GAMEPAD_TOOLTIPS:ClearTooltip(GAMEPAD_QUAD1_TOOLTIP)
    KEYBIND_STRIP:RemoveKeybindButtonGroup(self.zoneKeybindStripDescriptor)
end
function ZO_ZoneStories_Gamepad:InitializeKeybindStripDescriptors()
    local trackActivityKeybind = 
    {
        alignment = KEYBIND_STRIP_ALIGN_CENTER,
        name = function()
            return self:GetPlayStoryButtonText()
        end,
        keybind = "UI_SHORTCUT_SECONDARY",
        callback = function()
            self:TrackNextActivity()
            self:BuildZonesList()
        end,
        enabled = function()
            local zoneId = self:GetSelectedZoneId()
            local isZoneAvailable = ZO_ZoneStories_Manager.GetZoneAvailability(zoneId)
            local canContinueZone = CanZoneStoryContinueTrackingActivities(zoneId)
            return isZoneAvailable and canContinueZone
        end,
        visible = function()
            return self:GetSelectedZoneId() ~= nil
        end,
        sound = SOUNDS.ZONE_STORIES_TRACK_ACTIVITY,
    }
    self.keybindStripDescriptor =
    {
        alignment = KEYBIND_STRIP_ALIGN_LEFT,
        -- Select
        {
            name = GetString(SI_GAMEPAD_SELECT_OPTION),
            keybind = "UI_SHORTCUT_PRIMARY",
            callback = function()
                self:SetFocusOnSelectedZone()
            end,
        },
        -- Track Activity
        trackActivityKeybind,
        -- Back
        KEYBIND_STRIP:GetDefaultGamepadBackButtonDescriptor(),
    }
    -- Zone Selected Keybind Strip
    self.zoneKeybindStripDescriptor = {
        -- Track Activity
        trackActivityKeybind,
        -- Stop Tracking
        {
            alignment = KEYBIND_STRIP_ALIGN_CENTER,
            name = GetString(SI_ZONE_STORY_STOP_TRACKING_ZONE_STORY_ACTION),
            keybind = "UI_SHORTCUT_RIGHT_STICK",
            callback = function()
                ClearTrackedZoneStory()
                self:BuildZonesList()
                KEYBIND_STRIP:UpdateKeybindButtonGroup(self.zoneKeybindStripDescriptor)
            end,
            enabled = function()
                return CanZoneStoryContinueTrackingActivities(self:GetSelectedZoneId())
            end,
            visible = function()
                local zoneId  = GetTrackedZoneStoryActivityInfo()
                return zoneId == self:GetSelectedZoneId()
            end,
        },
        -- Back
        KEYBIND_STRIP:GenerateGamepadBackButtonDescriptor(function()
            KEYBIND_STRIP:RemoveKeybindButtonGroup(self.zoneKeybindStripDescriptor)
            KEYBIND_STRIP:AddKeybindButtonGroup(self.keybindStripDescriptor)
            self.gridList:Deactivate()
            GAMEPAD_TOOLTIPS:ClearTooltip(GAMEPAD_QUAD1_TOOLTIP)
            self:UpdateInfoTooltip(GAMEPAD_RIGHT_TOOLTIP)
            self:ActivateCurrentList()
        end),
        -- Cycle tooltip forward
        {
            alignment = KEYBIND_STRIP_ALIGN_RIGHT,
            name = GetString(SI_ZONE_STORY_ACTIVITY_COMPLETION_CYCLE_KEYBIND),
            keybind = "UI_SHORTCUT_RIGHT_SHOULDER",
            visible = function()
                local selectedData = self.gridList:GetSelectedData()
                if selectedData then
                    -- data with a completion type of ZONE_COMPLETION_TYPE_FEATURED_ACHIEVEMENTS is a different
                    -- entry type than the others (it doesn't have zoneData) and it only ever shows 1 tooltip
                    -- all the other types have at least 2 tooltips to show and so always cycle
                    return selectedData.completionType ~= ZONE_COMPLETION_TYPE_FEATURED_ACHIEVEMENTS
                end
                return false
            end,
            callback = function()
                local selectedData = self.gridList:GetSelectedData()
                if selectedData then
                    local zoneData = selectedData.zoneData
                    local completionType = selectedData.completionType
                    self.tooltipSelectedIndex = ZO_ZoneStories_Gamepad.GetValidatedTooltipIndex(zoneData, completionType, self.tooltipSelectedIndex + 1)
                    ZO_ZoneStories_Gamepad.LayoutCompletionTypeTooltip(zoneData, completionType, self.tooltipSelectedIndex)
                    --Re-narrate when cycling the tooltip
                    SCREEN_NARRATION_MANAGER:QueueGridListEntry(self.gridList)
                end
            end,
        },
        -- Cycle tooltip backward
        {
            alignment = KEYBIND_STRIP_ALIGN_RIGHT,
            keybind = "UI_SHORTCUT_LEFT_SHOULDER",
            visible = function()
                local selectedData = self.gridList:GetSelectedData()
                if selectedData then
                    -- data with a completion type of ZONE_COMPLETION_TYPE_FEATURED_ACHIEVEMENTS is a different
                    -- entry type than the others (it doesn't have zoneData) and it only ever shows 1 tooltip
                    -- all the other types have at least 2 tooltips to show and so always cycle
                    return selectedData.completionType ~= ZONE_COMPLETION_TYPE_FEATURED_ACHIEVEMENTS
                end
                return false
            end,
            callback = function()
                local selectedData = self.gridList:GetSelectedData()
                if selectedData then
                    local zoneData = selectedData.zoneData
                    local completionType = selectedData.completionType
                    self.tooltipSelectedIndex = ZO_ZoneStories_Gamepad.GetValidatedTooltipIndex(zoneData, completionType, self.tooltipSelectedIndex - 1)
                    ZO_ZoneStories_Gamepad.LayoutCompletionTypeTooltip(zoneData, completionType, self.tooltipSelectedIndex)
                    --Re-narrate when cycling the tooltip
                    SCREEN_NARRATION_MANAGER:QueueGridListEntry(self.gridList)
                end
            end,
        },
    }
end
function ZO_ZoneStories_Gamepad.GetValidatedTooltipIndex(zoneData, completionType, tooltipIndex)
    -- by default the first tooltip is the activity description tooltip and the second will either be a tooltip that
    -- will list out all the activities for the completion type
    -- However, if the completionType has associated achievements we will show individual tooltips for each achievement
    -- instead of the list tooltip
    local maxTooltipIndex = 1
    local numAssociatedAchievements = GetNumAssociatedAchievementsForZoneCompletionType(zoneData.id, completionType)
    if numAssociatedAchievements > 0 then
        maxTooltipIndex = numAssociatedAchievements
    end
    -- wrap the tooltip index
    if tooltipIndex < COMPLETION_ACTIVITY_DESCRIPTION_TOOLTIP_INDEX then
        return maxTooltipIndex
    elseif tooltipIndex > maxTooltipIndex then
        return COMPLETION_ACTIVITY_DESCRIPTION_TOOLTIP_INDEX
    else
        return tooltipIndex
    end
end
function ZO_ZoneStories_Gamepad.LayoutCompletionTypeTooltip(zoneData, completionType, tooltipIndex)
    GAMEPAD_TOOLTIPS:ClearTooltip(GAMEPAD_RIGHT_TOOLTIP, true)
    if tooltipIndex == COMPLETION_ACTIVITY_DESCRIPTION_TOOLTIP_INDEX then
        GAMEPAD_TOOLTIPS:LayoutZoneStoryActivityCompletion(GAMEPAD_RIGHT_TOOLTIP, zoneData, completionType)
    else
        local achievementId = GetAssociatedAchievementIdForZoneCompletionType(zoneData.id, completionType, tooltipIndex)
        if achievementId ~= 0 then
            GAMEPAD_TOOLTIPS:LayoutAchievement(GAMEPAD_RIGHT_TOOLTIP, achievementId)
        else
            GAMEPAD_TOOLTIPS:LayoutZoneStoryActivityCompletionTypeList(GAMEPAD_RIGHT_TOOLTIP, zoneData, completionType)
        end
    end
end
function ZO_ZoneStories_Gamepad:SetFocusOnSelectedZone()
    self.gridList:Activate()
    KEYBIND_STRIP:RemoveKeybindButtonGroup(self.keybindStripDescriptor)
    KEYBIND_STRIP:AddKeybindButtonGroup(self.zoneKeybindStripDescriptor)
    self:UpdateInfoTooltip(GAMEPAD_QUAD1_TOOLTIP)
end
function ZO_ZoneStories_Gamepad:UpdatePlayStoryButtonText()
    if self.gridList and self.gridList:IsActive() then
        KEYBIND_STRIP:UpdateKeybindButtonGroup(self.zoneKeybindStripDescriptor)
    end
end
function ZO_ZoneStories_Gamepad:UpdateBackgroundTexture()
    local selectedData = self:GetSelectedStoryData()
    if selectedData then
        self.backgroundTexture:SetTexture(GetZoneStoryGamepadBackground(selectedData.id))
    end
end
function ZO_ZoneStories_Gamepad:OnSelectionChanged(list, selectedData, oldSelectedData)
    if GAMEPAD_ZONE_STORIES_SCENE:IsShowing() and selectedData and selectedData.dataSource then
        self:UpdateZoneStory(selectedData.dataSource)
    end
end
function ZO_ZoneStories_Gamepad:UpdateZoneStory()
    ZO_ZoneStories_Shared.UpdateZoneStory(self)
    self:UpdateInfoTooltip(GAMEPAD_RIGHT_TOOLTIP)
end
function ZO_ZoneStories_Gamepad:UpdateInfoTooltip(tooltipType)
    GAMEPAD_TOOLTIPS:ClearTooltip(tooltipType)
    if GAMEPAD_ZONE_STORIES_SCENE:IsShowing() then
        local selectedData = self:GetSelectedStoryData()
        if selectedData then
            local selectedZoneId = selectedData.id
            local isZoneAvailable, zoneAvailableErrorText = ZO_ZoneStories_Manager.GetZoneAvailability(selectedZoneId)
            local shouldShowBlockingMessage = not isZoneAvailable and zoneAvailableErrorText ~= nil
            if shouldShowBlockingMessage then
                GAMEPAD_TOOLTIPS:LayoutTextBlockTooltip(tooltipType, zoneAvailableErrorText)
            else
                local arePriorityQuestsBlocked, errorStringText = ZO_ZoneStories_Manager.GetZoneCompletionTypeBlockingInfo(selectedZoneId, ZONE_COMPLETION_TYPE_PRIORITY_QUESTS)
                shouldShowBlockingMessage = arePriorityQuestsBlocked and errorStringText ~= nil
                if shouldShowBlockingMessage then
                    GAMEPAD_TOOLTIPS:LayoutTextBlockTooltip(tooltipType, errorStringText)
                end
            end
        end
    end
end
function ZO_ZoneStories_Gamepad:OnGridSelectionChanged(oldSelectedData, selectedData)
    -- Deselect previous tile
    if oldSelectedData and oldSelectedData.dataSource and oldSelectedData.dataEntry then
        if oldSelectedData.dataEntry.control then
            oldSelectedData.dataEntry.control.object:SetSelected(false)
        end
        oldSelectedData.isSelected = false
    end
    self.tooltipSelectedIndex = COMPLETION_ACTIVITY_DESCRIPTION_TOOLTIP_INDEX
    -- Select newly selected tile.
    if selectedData and selectedData.dataEntry then
        if selectedData.dataEntry.control then
            selectedData.dataEntry.control.object:SetSelected(true)
        end
        selectedData.isSelected = true
        local completionType = selectedData.completionType
        if completionType == ZONE_COMPLETION_TYPE_FEATURED_ACHIEVEMENTS then
            GAMEPAD_TOOLTIPS:LayoutAchievement(GAMEPAD_RIGHT_TOOLTIP, selectedData.achievementId)
        else
            local zoneData = selectedData.zoneData
            local completedActivities = ZO_ZoneStories_Manager.GetActivityCompletionProgressValues(zoneData.id, completionType)
            if completedActivities > 0 then
                -- the first tooltip is the activity description tooltip so if we've already completed some of the
                -- activities for this type we want to skip to the next tooltip
                -- this should resolve to 1 and since we are guaranteed to have 2 tooltips it doesn't need to be validated
                self.tooltipSelectedIndex = self.tooltipSelectedIndex + 1
            end
            ZO_ZoneStories_Gamepad.LayoutCompletionTypeTooltip(zoneData, completionType, self.tooltipSelectedIndex)
        end
    else
        GAMEPAD_TOOLTIPS:ClearTooltip(GAMEPAD_RIGHT_TOOLTIP)
    end
    KEYBIND_STRIP:UpdateKeybindButtonGroup(self.zoneKeybindStripDescriptor)
end
function ZO_ZoneStories_Gamepad:BuildZonesList()
    ZO_ZoneStories_Shared.BuildZonesList(self)
    local list = self:GetMainList()
    local trackedZoneId = GetTrackedZoneStoryActivityInfo()
    local trackedEntryData
    local defaultZoneId = ZO_ZoneStories_Manager.GetDefaultZoneSelection()
    local defaultEntryData
    list:Clear()
    for _, zoneData in ZONE_STORIES_MANAGER:ZoneListIterator() do
        local entryData = ZO_GamepadEntryData:New(zoneData.name)
        entryData:SetDataSource(zoneData)
        if trackedZoneId ~= 0 and trackedZoneId == zoneData.id then
            trackedEntryData = entryData
        elseif zoneData.id == defaultZoneId then
            defaultEntryData = entryData
        end
        list:AddEntry("ZO_GamepadItemSubEntryTemplate", entryData)
    end
    list:Commit()
    local selectedEntryData = trackedEntryData or defaultEntryData 
    if selectedEntryData then
        local selectIndex = list:GetIndexForData("ZO_GamepadItemSubEntryTemplate", selectedEntryData)
        list:SetSelectedIndexWithoutAnimation(selectIndex)
    end
end
function ZO_ZoneStories_Gamepad:GetSelectedZoneId()
    local list = self:GetMainList()
    local data = list:GetSelectedData()
    if data then
        return data.id
    end
    return nil
end
function ZO_ZoneStories_Gamepad:GetSelectedStoryData()
    local list = self:GetMainList()
    local data = list:GetSelectedData()
    if data then
        return data.dataSource
    end
    return nil
end
function ZO_ZoneStories_Gamepad:SetSelectedByZoneId(zoneId)
    local list = self:GetMainList()
    for i = 1, list:GetNumEntries() do
        local entryData = list:GetEntryData(i)
        if entryData and entryData.id == zoneId then
            list:SetSelectedIndexWithoutAnimation(i)
            break
        end
    end
end
    ZONE_STORIES_GAMEPAD = ZO_ZoneStories_Gamepad:New(control)
end