Back to Home

ESO Lua File v101041

ingame/mail/gamepad/mailinbox_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
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
-- Some configuration options.
local MAX_READ_ATTACHMENTS = MAIL_MAX_ATTACHED_ITEMS + 1
local SYSTEM_MAIL_ICON = "EsoUI/Art/Mail/Gamepad/gp_mailMenu_mailType_system.dds"
local CUSTOMERSERVICE_MAIL_ICON = "EsoUI/Art/Mail/Gamepad/gp_mailMenu_mailType_CS.dds"
local EXPIRATION_IMMINENT_ICON = "EsoUI/Art/Miscellaneous/timerRed_64.dds"
local EMPTY_ATTACHMENT_ICON = nil
local ZO_GAME_REPRESENTATIVE_TEXT_UNSELECTED = ZO_GAME_REPRESENTATIVE_TEXT:Lerp(ZO_DISABLED_TEXT, 0.5)
local function IsMailSystem(mailData)
    return mailData and (mailData.fromCS or mailData.fromSystem)
end
local function IsMailReportable(mailData)
    return mailData and (not IsMailSystem(mailData))
end
local function GetEntryColors(mailData)
    local hasCOD = (mailData.codAmount > 0)
    local hasEnoughMoney = (mailData.codAmount <= GetCurrencyAmount(CURT_MONEY, CURRENCY_LOCATION_CHARACTER))
    if not hasEnoughMoney then
        return ZO_MAIL_COD_MONEY_INSUFFICIENT_COLOR_GAMEPAD, ZO_MAIL_COD_MONEY_INSUFFICIENT_COLOR_GAMEPAD
    end
    if hasCOD then
        return ZO_MAIL_COD_MONEY_COLOR_GAMEPAD, ZO_MAIL_COD_MONEY_COLOR_UNSELECTED_GAMEPAD
    end
    local isSystem = IsMailSystem(mailData)
    if isSystem then
        return ZO_GAME_REPRESENTATIVE_TEXT, ZO_GAME_REPRESENTATIVE_TEXT_UNSELECTED
    end
    return ZO_SELECTED_TEXT, ZO_DISABLED_TEXT
end
-- The main class.
ZO_MailInbox_Gamepad = ZO_Object:Subclass()
function ZO_MailInbox_Gamepad:New(...)
    local mailInbox = ZO_Object.New(self)
    mailInbox:InitializeInbox(...)
    return mailInbox
end
function ZO_MailInbox_Gamepad:InitializeInbox(control)
    self.control = control
    self.mailDataById = {}
    self.dirty = true
    self.dirtyMail = nil
    self.activeLinks = ZO_GamepadLinks:New()
    self.activeLinks:SetUseKeybind("UI_SHORTCUT_LEFT_STICK")
    self.activeLinks:SetKeybindAlignment(KEYBIND_STRIP_ALIGN_RIGHT)
    self.activeLinks:RegisterCallback("CycleLinks", function()
        --Re-narrate when cycling between multiple links
        SCREEN_NARRATION_MANAGER:QueueParametricListEntry(self.mailList)
    end)
end
function ZO_MailInbox_Gamepad:OnShowing()
    if self.isLoading then
        self:EnterLoading()
    else
        self:EnterMailList()
    end
    if self.dirty then
        self:RefreshMailList()
    end
    if self.dirtyMail then
        -- Suppress link updating as this is initially handled by OnShown.
        local SUPPRESS_LINK_UPDATE = true
        self:ShowMailItem(self.dirtyMail, SUPPRESS_LINK_UPDATE)
    end
end
function ZO_MailInbox_Gamepad:OnShown()
    if IsLocalMailboxFull() then
        TriggerTutorial(TUTORIAL_TRIGGER_MAIL_OPENED_AND_FULL)
    end
    self:UpdateLinks()
end
function ZO_MailInbox_Gamepad:OnHiding()
    self.activeLinks:ResetLinks()
    self.activeLinks:Hide()
end
function ZO_MailInbox_Gamepad:OnHidden()
    self:HideAll()
end
function ZO_MailInbox_Gamepad:PerformDeferredInitialization()
    if self.initialized then return end
    self.initialized = true
end
function ZO_MailInbox_Gamepad:InitializeFragment()
    GAMEPAD_MAIL_INBOX_FRAGMENT = ZO_FadeSceneFragment:New(ZO_MailManager_GamepadInbox)
    GAMEPAD_MAIL_INBOX_FRAGMENT:RegisterCallback("StateChange", function(oldState, newState)
        if newState == SCENE_FRAGMENT_SHOWING then
            self:OnShowing()
        elseif newState == SCENE_FRAGMENT_SHOWN then
            self:OnShown()
        elseif newState == SCENE_FRAGMENT_HIDING then
            self:OnHiding()
        elseif newState == SCENE_FRAGMENT_HIDDEN then
            self:OnHidden()
        end
    end)
end
function ZO_MailInbox_Gamepad:InitializeControls()
    self.inboxControl = self.control:GetNamedChild("Inbox")
    -- Loading
    self.loadingBox = self.control:GetNamedChild("Loading")
    self.loadingLabel = self.loadingBox:GetNamedChild("ContainerText")
    -- Mail Display
    self.inboxRightPane = self.inboxControl:GetNamedChild("RightPane")
    self.inbox = self.inboxRightPane:GetNamedChild("Container"):GetNamedChild("Inbox")
    local IS_OUTBOX = false
    self.inbox:Initialize(GetString(SI_GAMEPAD_MAIL_INBOX_FROM), EMPTY_ATTACHMENT_ICON, IS_OUTBOX, ZO_MAIL_COD_MONEY_OPTIONS_GAMEPAD, ZO_MAIL_ATTACHED_MONEY_OPTIONS_GAMEPAD, MAX_READ_ATTACHMENTS)
end
function ZO_MailInbox_Gamepad:AttachmentSelectionChanged(list, selectedData, oldSelectedData)
    GAMEPAD_TOOLTIPS:ClearLines(GAMEPAD_LEFT_TOOLTIP)
    if selectedData then
        local EQUIPPED = false
        GAMEPAD_TOOLTIPS:LayoutItem(GAMEPAD_LEFT_TOOLTIP, selectedData.itemLink, EQUIPPED, selectedData.creator)
    end
end
local function SetupAttachmentsList(attachmentsList)
    attachmentsList:AddDataTemplate("ZO_GamepadMenuEntryTemplateLowercase34", ZO_SharedGamepadEntry_OnSetup, ZO_GamepadMenuEntryTemplateParametricListFunction)
end
function ZO_MailInbox_Gamepad:InitializeAttachmentsList()
    self.attachmentsList = MAIL_MANAGER_GAMEPAD:AddList("Attachments", SetupAttachmentsList)
    self.attachmentsListControl = self.attachmentsList:GetControl()
    self.attachmentsList:SetOnSelectedDataChangedCallback(function(...) self:AttachmentSelectionChanged(...) end)
end
function ZO_MailInbox_Gamepad:InitializeOptionsList()
    self.optionsList = MAIL_MANAGER_GAMEPAD:AddList("Options")
    self.optionsListControl = self.optionsList:GetControl()
    if IsConsoleUI() then
        local gamercardOption = ZO_GamepadEntryData:New(GetString(GetGamerCardStringId()))
        gamercardOption.selectedCallback =  function()
                                                local mailData = self:GetActiveMailData()
                                                if not mailData.fromSystem then
                                                    ZO_ShowGamerCardFromDisplayNameOrFallback(mailData.senderDisplayName, ZO_ID_REQUEST_TYPE_MAIL_ID, mailData.mailId)
                                                end
                                            end
        self.optionsList:AddEntry("ZO_GamepadMenuEntryTemplate", gamercardOption)
    end
    local replyOption = ZO_GamepadEntryData:New(GetString(SI_MAIL_READ_REPLY))
    replyOption.selectedCallback = function()
                                       self:Reply()
                                   end
    replyOption.selectedNameColor = function()                                        
                                        local mailData = self:GetActiveMailData()
                                        if mailData and mailData.isFromPlayer then
                                            return ZO_SELECTED_TEXT
                                        end
                                        return ZO_DISABLED_TEXT 
                                    end
    self.optionsList:AddEntry("ZO_GamepadMenuEntryTemplate", replyOption)
    local returnToSenderOption = ZO_GamepadEntryData:New(GetString(SI_MAIL_READ_RETURN))
    returnToSenderOption.selectedCallback = function()
                                                if not IsMailReturnable(self:GetActiveMailId()) then
                                                    ZO_Alert(UI_ALERT_CATEGORY_ALERT, nil, GetString(SI_GAMEPAD_MAIL_INBOX_CANNOT_RETURN))
                                                else
                                                    ZO_Dialogs_ShowGamepadDialog("MAIL_RETURN_ATTACHMENTS", { callback = function() self:ReturnToSender() end, finishedCallback = function() self:ExitReturnDialog() end }, {mainTextParams = {self:GetActiveMailSender()}})
                                                end
                                            end
    returnToSenderOption.selectedNameColor = function() return IsMailReturnable(self:GetActiveMailId()) and ZO_SELECTED_TEXT or ZO_DISABLED_TEXT end
    self.optionsList:AddEntry("ZO_GamepadMenuEntryTemplate", returnToSenderOption)
    --Customer service options are not currently available for PC Gamepad
    if IsConsoleUI() then
        local reportOption = ZO_GamepadEntryData:New(GetString(SI_MAIL_READ_REPORT_PLAYER))
        reportOption.selectedCallback = function() 
                                            self:ReportPlayer()
                                        end
        reportOption.selectedNameColor = function() return IsMailReportable(self:GetActiveMailData()) and ZO_SELECTED_TEXT or ZO_DISABLED_TEXT end
        self.optionsList:AddEntry("ZO_GamepadMenuEntryTemplate", reportOption)
    end
    self.optionsList:Commit()
end
local function SetupList(list)
end
function ZO_MailInbox_Gamepad:InitializeMailList()
    self.mailList = MAIL_MANAGER_GAMEPAD:AddList("Mail", SetupList)
    self.mailListControl = self.mailList:GetControl()
    
    self.mailList:SetOnTargetDataChangedCallback(function(...) self:OnMailTargetChanged(...) end)
    self.mailList:SetNoItemText(GetString(SI_GAMEPAD_MAIL_INBOX_EMPTY))
end
local function GetInventoryString()
    return zo_strformat(SI_GAMEPAD_MAIL_INBOX_INVENTORY_SPACES, GetNumBagUsedSlots(BAG_BACKPACK), GetBagSize(BAG_BACKPACK))
end
local function UpdatePlayerGold(control)
    ZO_CurrencyControl_SetSimpleCurrency(control, CURT_MONEY, GetCurrencyAmount(CURT_MONEY, CURRENCY_LOCATION_CHARACTER), ZO_MAIL_HEADER_MONEY_OPTIONS_GAMEPAD)
    return true
end
function ZO_MailInbox_Gamepad:InitializeHeader()
    self.mainHeaderData = {
        data1HeaderText = GetString(SI_GAMEPAD_MAIL_INBOX_PLAYER_GOLD),
        data1Text = UpdatePlayerGold,
        data2HeaderText = GetString(SI_GAMEPAD_MAIL_INBOX_INVENTORY),
        data2Text = GetInventoryString,
        tabBarEntries = MAIL_MANAGER_GAMEPAD.tabBarEntries,
    }
    local function UpdateCODAmount(control)
        local mailData = self:GetActiveMailData()
        if mailData then
            ZO_CurrencyControl_SetSimpleCurrency(control, CURT_MONEY, mailData.codAmount, ZO_MAIL_HEADER_MONEY_OPTIONS_GAMEPAD)
        end
        return true
    end
    local function GetCODAmountNarration()
        local mailData = self:GetActiveMailData()
        if mailData then
            return ZO_Currency_FormatGamepad(CURT_MONEY, mailData.codAmount, ZO_CURRENCY_FORMAT_AMOUNT_ICON)
        end
    end
    self.confirmCODDialogData = 
    {
        data1 = 
        {
            header = GetString(SI_GAMEPAD_MAIL_INBOX_PLAYER_GOLD),
            value = UpdatePlayerGold,
        },
        data2 = 
        {
            header = GetString(SI_MAIL_READ_COD_LABEL),
            value = UpdateCODAmount,
            valueNarration = GetCODAmountNarration,
        },
        callback = function() self:TakeAll() end,
    }
end
function ZO_MailInbox_Gamepad:InitializeKeybindDescriptors()
    local function IsReadInfoReady()
        local mailData = self:GetActiveMailData()
        return mailData and mailData.isReadInfoReady
    end
    local function CanTakeAttachments()
        local mailData = self:GetActiveMailData()
        local hasEnoughCOD = mailData and mailData.codAmount <= GetCurrencyAmount(CURT_MONEY, CURRENCY_LOCATION_CHARACTER)
        return IsReadInfoReady() and (self:GetActiveMailHasAttachedItems() or self:GetActiveMailHasAttachedGold()) and hasEnoughCOD
    end
    local takeAttachmentsBind = {
            name = GetString(SI_MAIL_READ_ATTACHMENTS_TAKE),
            keybind = "UI_SHORTCUT_PRIMARY",
            callback =  function()
                            if CanTakeAttachments() then
                                self:TryTakeAll()
                            end
                        end,
            visible = CanTakeAttachments,
        }
    local backToMailListBind = KEYBIND_STRIP:GenerateGamepadBackButtonDescriptor(function() self:EnterMailList() end)
    local backToOptionsBind = KEYBIND_STRIP:GenerateGamepadBackButtonDescriptor(function() self:EnterOptionsList() end)
    -- Loading.
    self.loadingKeybindDescriptor = 
    {
        alignment = KEYBIND_STRIP_ALIGN_LEFT,
        -- Back
        KEYBIND_STRIP:GetDefaultGamepadBackButtonDescriptor(),
    }
    -- Main list.
    local function CanViewAttachments()
        return IsReadInfoReady() and self:GetActiveMailHasAttachedItems()
    end
    self.mainKeybindDescriptor =
    {
        alignment = KEYBIND_STRIP_ALIGN_LEFT,
        -- Back
        KEYBIND_STRIP:GetDefaultGamepadBackButtonDescriptor(),
        -- Take Attachments
        takeAttachmentsBind,
        -- Delete
        {
            name = GetString(SI_MAIL_READ_DELETE),
            keybind = "UI_SHORTCUT_SECONDARY",
            callback = function()
                            ZO_Dialogs_ShowGamepadDialog("DELETE_MAIL", { callback = function() self:Delete() end })
                        end,
            visible = function() return self:CanDeleteActiveMail() end,
        },
        -- Options
        {
            name = GetString(SI_GAMEPAD_MAIL_INBOX_OPTIONS),
            keybind = "UI_SHORTCUT_TERTIARY",
            visible = function()
                            local mailData = self:GetActiveMailData()
                            -- Options only has "Report", "Reply" and "Return to Sender", none of which are valid on system messages.
                            return mailData and (not IsMailSystem(mailData))
                      end,
            callback = function() self:EnterOptionsList() end,
        },
        -- View Attachments
        {
            name = GetString(SI_GAMEPAD_MAIL_INBOX_VIEW_ATTACHMENTS),
            keybind = "UI_SHORTCUT_RIGHT_STICK",
            visible = CanViewAttachments,
            callback = function()
                            if CanViewAttachments() then
                                self:EnterViewAttachments()
                            end
                        end,
        },
    }
    ZO_Gamepad_AddListTriggerKeybindDescriptors(self.mainKeybindDescriptor, self.mailList)
    -- Options List
    self.optionsKeybindDescriptor =
    {
        alignment = KEYBIND_STRIP_ALIGN_LEFT,
        -- Select
        {
            name = GetString(SI_GAMEPAD_SELECT_OPTION),
            keybind = "UI_SHORTCUT_PRIMARY",
            callback = function() self.optionsList:GetTargetData().selectedCallback() end,
        },
        -- Cancel
        backToMailListBind,
    }
    ZO_Gamepad_AddListTriggerKeybindDescriptors(self.optionsKeybindDescriptor, self.optionsList)
    
    -- View Attachments
    self.viewAttachmentsKeybindDescriptor =
    {
        alignment = KEYBIND_STRIP_ALIGN_LEFT,
        backToMailListBind,
        takeAttachmentsBind,
    }
    ZO_Gamepad_AddListTriggerKeybindDescriptors(self.viewAttachmentsKeybindDescriptor, self.attachmentsList)
end
function ZO_MailInbox_Gamepad:InitializeEvents()
    local function OnMailReadable(_, mailId)
        if not self.inboxControl:IsControlHidden() then
            self:ShowMailItem(mailId)
            MAIL_MANAGER_GAMEPAD:RefreshKeybind()
        end
    end
    
    local function TakeAttachment(_, mailId)
        self:ShowMailItem(mailId)
        MAIL_MANAGER_GAMEPAD:RefreshKeybind()
        MAIL_MANAGER_GAMEPAD:RefreshHeader()
        SCREEN_NARRATION_MANAGER:QueueParametricListEntry(self.mailList)
    end
    local function OnMoneyUpdated()
        local mailId = self:GetActiveMailId()
        if mailId then
            self:ShowMailItem(mailId)
        end
        self:UpdateMailColors()
        self.mailList:RefreshVisible()
        MAIL_MANAGER_GAMEPAD:RefreshHeader()
    end
    local function OnMailRemoved(evt, mailId)
        MAIL_MANAGER_GAMEPAD:RefreshHeader()
        self:RefreshMailList()
    end
    self.control:RegisterForEvent(EVENT_MAIL_INBOX_UPDATE, function() self:MailboxUpdated() end)
    self.control:RegisterForEvent(EVENT_MAIL_READABLE, OnMailReadable)
    self.control:RegisterForEvent(EVENT_MAIL_TAKE_ATTACHED_ITEM_SUCCESS, TakeAttachment)
    self.control:RegisterForEvent(EVENT_MAIL_TAKE_ATTACHED_MONEY_SUCCESS, TakeAttachment)
    self.control:RegisterForEvent(EVENT_MAIL_REMOVED, OnMailRemoved)
    self.control:RegisterForEvent(EVENT_MONEY_UPDATE, OnMoneyUpdated)
    self.control:RegisterForEvent(EVENT_MAIL_NUM_UNREAD_CHANGED, function(...) MAIL_MANAGER_GAMEPAD:RefreshHeader() end)
end
function ZO_MailInbox_Gamepad:MailboxUpdated()
    if self.isLoading then
        self.isLoading = false
        
        if not self.inboxControl:IsHidden() then
            self:EnterMailList()
        end
    end
end
function ZO_MailInbox_Gamepad:HideAll()
    if not self.attachmentsListControl:IsHidden() then
        PlaySound(SOUNDS.GAMEPAD_MENU_BACK)
    end
    GAMEPAD_TOOLTIPS:HideBg(GAMEPAD_LEFT_TOOLTIP)
    GAMEPAD_TOOLTIPS:ClearLines(GAMEPAD_LEFT_TOOLTIP)
    GAMEPAD_TOOLTIPS:Reset(GAMEPAD_LEFT_TOOLTIP)
    self.loadingBox:SetHidden(true)
    MAIL_MANAGER_GAMEPAD:DisableCurrentList()
    MAIL_MANAGER_GAMEPAD:SwitchToHeader(self.mainHeaderData)
end
function ZO_MailInbox_Gamepad:Delete()
    local mailId = self:GetActiveMailId()
    if mailId then
        DeleteMail(mailId, true)
        PlaySound(SOUNDS.MAIL_ITEM_DELETED)
    end
    self:EnterMailList()
end
function ZO_MailInbox_Gamepad:EnterLoading()
    self:HideAll()
    MAIL_MANAGER_GAMEPAD:SwitchToKeybind(self.loadingKeybindDescriptor)
    self.loadingLabel:SetText(GetString(SI_GAMEPAD_MAIL_INBOX_LOADING))
    self.loadingBox:SetHidden(false)
    self.inbox:SetHidden(true)
end
function ZO_MailInbox_Gamepad:EnterMailList()
    self:HideAll()
    MAIL_MANAGER_GAMEPAD:SwitchToKeybind(self.mainKeybindDescriptor)
    MAIL_MANAGER_GAMEPAD:SetCurrentList(self.mailList)
end
function ZO_MailInbox_Gamepad:EnterOptionsList()
    self:HideAll()
    MAIL_MANAGER_GAMEPAD:SwitchToKeybind(self.optionsKeybindDescriptor)
    MAIL_MANAGER_GAMEPAD:SwitchToHeader(nil)
    MAIL_MANAGER_GAMEPAD:SetCurrentList(self.optionsList)
    self.optionsList:RefreshVisible()
    PlaySound(SOUNDS.GAMEPAD_MENU_FORWARD)
end
function ZO_MailInbox_Gamepad:Reply()
    MAIL_MANAGER_GAMEPAD:GetSend():SwitchToSendTab()
    PlaySound(SOUNDS.GAMEPAD_MENU_FORWARD)
end
function ZO_MailInbox_Gamepad:InsertBodyText(text)
    MAIL_MANAGER_GAMEPAD:GetSend():InsertBodyText(text)
    MAIL_MANAGER_GAMEPAD:GetSend():SwitchToSendTab()
    PlaySound(SOUNDS.GAMEPAD_MENU_FORWARD)
end
function ZO_MailInbox_Gamepad:EnterViewAttachments()
    -- Populate the list.
    self.attachmentsList:Clear()
    local mailData = self:GetActiveMailData()
    if mailData then
        local mailId = mailData.mailId
        for i = 1, mailData.numAttachments do
            local itemLink = GetAttachedItemLink(mailId, i, LINK_STYLE_DEFAULT)
            local itemName = GetItemLinkName(itemLink)
            local icon, stack, creator, sellPrice, meetsUsageRequirement, equipType, itemStyle, displayQuality = GetAttachedItemInfo(mailId, i)
            itemName = zo_strformat(SI_LINK_FORMAT_ITEM_NAME, itemName)
            local itemData =
            {
                text = itemName,
                icon = icon,
                displayQuality = displayQuality,
                -- quality is deprecated, included here for addon backwards compatibility
                quality = displayQuality,
                stackCount = stack,
                sellPrice = sellPrice,
                meetsUsageRequirement = meetsUsageRequirement,
                equipType = equipType,
                itemStyle = itemStyle,
                creator = creator,
                itemLink = itemLink,
            }
            local attachmentEntry = ZO_GamepadEntryData:New(itemName)
            attachmentEntry:InitializeInventoryVisualData(itemData)
            self.attachmentsList:AddEntry("ZO_GamepadMenuEntryTemplateLowercase34", attachmentEntry)
        end
    end
    self.attachmentsList:Commit()
    -- Swap controls and keybinds.
    self:HideAll()
    MAIL_MANAGER_GAMEPAD:SwitchToKeybind(self.viewAttachmentsKeybindDescriptor)
    MAIL_MANAGER_GAMEPAD:SwitchToHeader(nil)
    GAMEPAD_TOOLTIPS:SetBgType(GAMEPAD_LEFT_TOOLTIP, GAMEPAD_TOOLTIP_DARK_BG)
    GAMEPAD_TOOLTIPS:ShowBg(GAMEPAD_LEFT_TOOLTIP)
    MAIL_MANAGER_GAMEPAD:SetCurrentList(self.attachmentsList)
    self:AttachmentSelectionChanged(self.attachmentsList, self.attachmentsList:GetTargetData(), nil)
    PlaySound(SOUNDS.GAMEPAD_MENU_FORWARD)
end
function ZO_MailInbox_Gamepad:GetActiveMailId()
    local selectedData = self.mailList:GetTargetData()
    if selectedData then
        return selectedData.mailId
    end
    return nil
end
function ZO_MailInbox_Gamepad:GetActiveMailData()
    local mailId = self:GetActiveMailId()
    if mailId then
        return self.mailDataById[zo_getSafeId64Key(mailId)]
    end
    return nil
end
function ZO_MailInbox_Gamepad:GetActiveMailSender()
    local mailData = self:GetActiveMailData()
    if mailData then
        return ZO_FormatUserFacingDisplayName(mailData.senderDisplayName)
    end
    return nil
end
function ZO_MailInbox_Gamepad:ReportPlayer()
        local displayName = self:GetActiveMailSender()
        ZO_HELP_GENERIC_TICKET_SUBMISSION_MANAGER:OpenReportPlayerTicketScene(displayName)
    else
        ZO_Alert(UI_ALERT_CATEGORY_ALERT, nil, GetString(SI_GAMEPAD_MAIL_INBOX_CANNOT_REPORT))
    end
end
function ZO_MailInbox_Gamepad:ReturnToSender()
    local mailId = self:GetActiveMailId()
    if mailId then
        if IsMailReturnable(mailId) then
            ReturnMail(mailId)
        end
    end
    self.justReturnedMail = true
end
function ZO_MailInbox_Gamepad:ExitReturnDialog()
    if self.justReturnedMail then
        self:EnterMailList()
        self.justReturnedMail = false
    end
end
function ZO_MailInbox_Gamepad:CanDeleteActiveMail()
    local mailData = self:GetActiveMailData()
    if mailData then
        return (mailData.numAttachments == 0) and (mailData.attachedMoney == 0)
    end
    return false
end
function ZO_MailInbox_Gamepad:GetActiveMailHasAttachedGold()
    local mailId = self:GetActiveMailId()
    if mailId then
        local numAttachments, attachedMoney = GetMailAttachmentInfo(mailId)
        return attachedMoney > 0
    end
    return false
end
function ZO_MailInbox_Gamepad:GetActiveMailHasAttachedItems()
    local mailId = self:GetActiveMailId()
    if mailId then
        local numAttachments = GetMailAttachmentInfo(mailId)
        return numAttachments > 0
    end
    return false
end
function ZO_MailInbox_Gamepad:TryTakeAll()
    local mailId = self:GetActiveMailId()
    if mailId then
        local numAttachments, attachedMoney, codAmount = GetMailAttachmentInfo(mailId)
        if codAmount > 0 then
            ZO_Dialogs_ShowGamepadDialog("GAMEPAD_MAIL_TAKE_ATTACHMENT_COD", self.confirmCODDialogData)
        else
            self:TakeAll()
        end
    end
end
function ZO_MailInbox_Gamepad:TakeAll()
    local mailId = self:GetActiveMailId()
    if mailId then
        ZO_MailInboxShared_TakeAll(mailId)        
    end
end
function ZO_MailInbox_Gamepad:OnMailTargetChanged(list, targetData)
    KEYBIND_STRIP:UpdateKeybindButtonGroup(self.mainKeybindDescriptor)
    if targetData and targetData.mailId then
        RequestReadMail(targetData.mailId)
    else
        self.inbox:SetHidden(true)
    end
end
local function UpdateMailIcons(mailData, entryData)
    entryData:ClearIcons()
    if mailData.unread then
       entryData:AddIcon(ZO_GAMEPAD_NEW_ICON_64)
    end
    if mailData.fromSystem then
        entryData:AddIcon(SYSTEM_MAIL_ICON)
    elseif mailData.fromCS then
        entryData:AddIcon(CUSTOMERSERVICE_MAIL_ICON)
    end
    if mailData:IsExpirationImminent() then
        entryData:AddIcon(EXPIRATION_IMMINENT_ICON)
    end
end
function ZO_MailInbox_Gamepad:UpdateMailColors()
    if self.inboxControl:IsHidden() then
        self.dirty = true
        return
    end
    for mailId in ZO_GetNextMailIdIter do
        local mailData = self.mailDataById[zo_getSafeId64Key(mailId)]
        local selectedColor, unselectedColor = GetEntryColors(mailData)
        local entryData = self.mailEntryDataById[zo_getSafeId64Key(mailId)]
        entryData:SetNameColors(selectedColor, unselectedColor)
        entryData:SetSubLabelColors(selectedColor, unselectedColor)
    end
end
local function SortFunction(left, right)
    return ZO_TableOrderingFunction(left, right, MAIL_ENTRY_FIRST_SORT_KEY, MAIL_ENTRY_SORT_KEYS, ZO_SORT_ORDER_UP)
end
local function GetMailNarrationText(entryData, entryControl)
    local narrations = {}
    ZO_AppendNarration(narrations, ZO_GetSharedGamepadEntryDefaultNarrationText(entryData, entryControl))
    local moneyHeader
    local moneyText
    local hasAttachedMoney = entryData.attachedMoney > 0
    local hasCod = entryData.codAmount > 0
    --Generate the COD Fee/Sent Gold text
    if hasAttachedMoney then
        moneyHeader = GetString(SI_MAIL_READ_SENT_GOLD_LABEL)
        moneyText = ZO_Currency_FormatGamepad(CURT_MONEY, entryData.attachedMoney, ZO_CURRENCY_FORMAT_AMOUNT_NAME)
    elseif hasCod then
        moneyHeader = GetString(SI_MAIL_READ_COD_LABEL)
        moneyText = ZO_Currency_FormatGamepad(CURT_MONEY, entryData.codAmount, ZO_CURRENCY_FORMAT_AMOUNT_NAME)
        --If this mail has a COD Fee, include the narration for the COD notice
        ZO_AppendNarration(narrations, SCREEN_NARRATION_MANAGER:CreateNarratableObject(GetString(SI_GAMEPAD_MAIL_INBOX_COD_NOTICE)))
    else
        moneyHeader = GetString(SI_MAIL_READ_SENT_GOLD_LABEL)
        moneyText = GetString(SI_GAMEPAD_MAIL_INBOX_NO_ATTACHED_GOLD)
    end
    --Generate the narration for the From section
    ZO_AppendNarration(narrations, SCREEN_NARRATION_MANAGER:CreateNarratableObject(GetString(SI_GAMEPAD_MAIL_INBOX_FROM)))
    ZO_AppendNarration(narrations, SCREEN_NARRATION_MANAGER:CreateNarratableObject(entryData.senderDisplayName))
    --Generate the narration for the Subject section
    ZO_AppendNarration(narrations, SCREEN_NARRATION_MANAGER:CreateNarratableObject(GetString(SI_GAMEPAD_MAIL_SUBJECT_LABEL)))
    ZO_AppendNarration(narrations, SCREEN_NARRATION_MANAGER:CreateNarratableObject(entryData:GetFormattedSubject()))
    --Generate the narration for the Message section
    ZO_AppendNarration(narrations, SCREEN_NARRATION_MANAGER:CreateNarratableObject(GetString(SI_GAMEPAD_MAIL_BODY_LABEL)))
    local body = ReadMail(entryData.mailId)
    if body == "" then
        body = GetString(SI_MAIL_READ_NO_BODY)
    end
    ZO_AppendNarration(narrations, SCREEN_NARRATION_MANAGER:CreateNarratableObject(body))
    --Generate the narration for the attached money/cod fee
    ZO_AppendNarration(narrations, SCREEN_NARRATION_MANAGER:CreateNarratableObject(moneyHeader))
    ZO_AppendNarration(narrations, SCREEN_NARRATION_MANAGER:CreateNarratableObject(moneyText))
    --Generate the narration for the attachments
    ZO_AppendNarration(narrations, SCREEN_NARRATION_MANAGER:CreateNarratableObject(GetString(SI_MAIL_ATTACHMENTS_HEADER)))
    if entryData.numAttachments > 0 then
        local totalAttachments = 0
        for i = 1, entryData.numAttachments do
            local icon, stack, creator = GetAttachedItemInfo(entryData.mailId, i)
            totalAttachments = totalAttachments + stack
        end
        --Narrate the total stack count of all the attachments, not just the number of unique attachments
        ZO_AppendNarration(narrations, SCREEN_NARRATION_MANAGER:CreateNarratableObject(totalAttachments))
    else
        ZO_AppendNarration(narrations, SCREEN_NARRATION_MANAGER:CreateNarratableObject(GetString(SI_GAMEPAD_MAIL_INBOX_NO_ATTACHMENTS)))
    end
    return narrations
end
function ZO_MailInbox_Gamepad:RefreshMailList()
    if not GAMEPAD_MAIL_INBOX_FRAGMENT:IsShowing() then
        self.dirty = true
        return
    end
    self.dirty = false
    -- Update the inbox list.
    self.mailDataById = {}
    self.mailEntryDataById = {}
    self.mailList:Clear()
    local entries = {}
    for mailId in ZO_GetNextMailIdIter do
        -- Get mail data.
        local mailData = {}
        ZO_MailInboxShared_PopulateMailData(mailData, mailId)
        local selectedColor, unselectedColor = GetEntryColors(mailData)
        local subject = mailData.subject
        if (not subject) or (subject == "") then
            subject = GetString(SI_MAIL_READ_NO_SUBJECT)
        end
        -- Basic setup.
        local entryData = ZO_GamepadEntryData:New(subject)
        entryData:SetDataSource(mailData)
        entryData:SetNameColors(selectedColor, unselectedColor)
        entryData:SetSubLabelColors(selectedColor, unselectedColor)
        entryData:AddSubLabel(zo_strformat(SI_GAMEPAD_MAIL_INBOX_RECEIVED_TEXT, mailData:GetReceivedText()))
        entryData.narrationText = GetMailNarrationText
        local expiresText = zo_strformat(SI_MAIL_INBOX_EXPIRES_TEXT, mailData:GetExpiresText())
        if mailData:IsExpirationImminent() then
            expiresText = ZO_ERROR_COLOR:Colorize(expiresText)
        end
        entryData:AddSubLabel(expiresText)
        local safeIdKey = zo_getSafeId64Key(mailId)
        self.mailDataById[safeIdKey] = mailData
        self.mailEntryDataById[safeIdKey] = entryData
        -- Setup icons.
        UpdateMailIcons(mailData, entryData)
        table.insert(entries, entryData)
    end
    table.sort(entries, SortFunction)
    for i=1, #entries do
        local entryData = entries[i]
        self.mailList:AddEntry("ZO_GamepadMenuEntryNoCapitalization", entryData)
    end
    self.mailList:Commit()
    -- If we have a queued message update, update it.
    if self.dirtyMail then
        self:ShowMailItem(self.dirtyMail)
    end
    MAIL_MANAGER_GAMEPAD:RefreshKeybind()
    if #entries == 0 then
        self.inbox:SetHidden(true)
    else
        self.inbox:SetHidden(false)
    end
end
function ZO_MailInbox_Gamepad:ShowMailItem(mailId, suppressLinkUpdate)
    self.activeLinks:ResetLinks()
    -- If the mail Id does not match the current selection, ignore the update. This could happen if the user
    -- changes active messages and the messages are still loading.
    if (not AreId64sEqual(mailId, self:GetActiveMailId())) then
        return
    end
    -- If we have a queued message list refresh, or the control is hidden, queue a refresh of the mail message.
    if self.dirty or self.inboxControl:IsHidden() then
        self.dirtyMail = mailId
        return
    end
    self.dirtyMail = nil
    -- Basic display setup.
    self.inbox:SetHidden(false)
    MAIL_MANAGER_GAMEPAD:RefreshKeybind()
    -- Get the data.
    local safeIdKey = zo_getSafeId64Key(mailId)
    local mailData = self.mailDataById[safeIdKey]
    local entryData = self.mailEntryDataById[safeIdKey]
    local wasUnread = mailData.unread
    ZO_MailInboxShared_PopulateMailData(mailData, mailId)
    if mailData.unread ~= wasUnread then
        UpdateMailIcons(mailData, entryData)
    end
    local body = ReadMail(mailData.mailId)
    if body == "" then
        body = GetString(SI_MAIL_READ_NO_BODY)
    end
    local isSystem = (mailData.fromCS or mailData.fromSystem)
    local noAttachments = (mailData.numAttachments == 0)
    -- System mail should not add platform ID icon formatting, the name is already undecorated and ready to display if from the system
    local displayName = isSystem and mailData.senderDisplayName or ZO_FormatUserFacingDisplayName(mailData.senderDisplayName)
    self.inbox:Display(mailData.codAmount, mailData.attachedMoney, displayName, mailData:GetFormattedSubject(), body, isSystem, noAttachments)
    -- Attachments.
    for i = 1, mailData.numAttachments do
        local icon, stack, creator = GetAttachedItemInfo(mailId, i)
        self.inbox:SetAttachment(i, stack, icon)
    end
    for i = mailData.numAttachments + 1, MAX_READ_ATTACHMENTS do
        self.inbox:ClearAttachment(i)
    end
    if noAttachments and MAIL_MANAGER_GAMEPAD:IsCurrentList(self.attachmentsList) then
        self:EnterMailList()
    end
    -- Update the mail list (mostly for unread icon update).
    self.mailList:RefreshVisible()
    if not suppressLinkUpdate then
        self:UpdateLinks()
    end
end
------------------
-- Active Links --
------------------
function ZO_MailInbox_Gamepad:UpdateLinks()
    if self.inboxControl:IsHidden() then
        self.activeLinks:Hide()
        return
    end
    -- Extract and register any links found in the Guild's
    -- Message of the Day and Description (About Us) text.
    self.activeLinks:ResetLinks()
    local bodyText = self.inbox.bodyEdit.edit:GetText()
    if bodyText ~= "" then
        self.activeLinks:AddLinksFromText(bodyText)
    end
    if self.activeLinks:HasLinks() then
        self.inboxRightPane:SetWidth(ZO_GAMEPAD_QUADRANT_2_3_WIDTH)
        self.activeLinks:Show()
    else
        self.inboxRightPane:SetWidth(ZO_GAMEPAD_QUADRANT_2_3_4_WIDTH)
        self.activeLinks:Hide()
    end
end