Back to Home

ESO Lua File v101044

ingame/chatsystem/gamepad/chatmenu_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
ZO_CHAT_MENU_GAMEPAD_LOG_MAX_SIZE = 200
ZO_CHAT_MENU_GAMEPAD_COLOR_MODIFIER = 0.7
ZO_CHAT_MENU_GAMEPAD_DESATURATION_MODIFIER = 0.1
------------------
--Initialization--
------------------
ZO_ChatMenu_Gamepad = ZO_InteractiveChatLog_Gamepad:Subclass()
function ZO_ChatMenu_Gamepad:Initialize(control)
    CHAT_MENU_GAMEPAD_SCENE = ZO_Scene:New("gamepadChatMenu", SCENE_MANAGER)
    ZO_InteractiveChatLog_Gamepad.Initialize(self, control, CHAT_MENU_GAMEPAD_SCENE)
    self.activeLinks = ZO_GamepadLinks:New()
    self.activeLinks:SetKeybindAlignment(KEYBIND_STRIP_ALIGN_RIGHT)
    self.activeLinks:RegisterCallback("CycleLinks", function()
        --Re-narrate when cycling between multiple links
        SCREEN_NARRATION_MANAGER:QueueParametricListEntry(self.list)
    end)
end
-- ZO_InteractiveChatLog_Gamepad Overrides
function ZO_ChatMenu_Gamepad:InitializeHeader()
    self.headerData =
    {
        titleText = GetString(SI_GAMEPAD_TEXT_CHAT),
    }
end
function ZO_ChatMenu_Gamepad:InitializeTextInputSection()
    --For active focus switching between channel and edit box
    self.textInputFocusSwitcher = ZO_GamepadFocus:New(self.textInputControl, nil, MOVEMENT_CONTROLLER_DIRECTION_HORIZONTAL)
    ZO_InteractiveChatLog_Gamepad.InitializeTextInputSection(self)
end
function ZO_ChatMenu_Gamepad:InitializeTextEdit()
    ZO_InteractiveChatLog_Gamepad.InitializeTextEdit(self)
    local textEditData =
    {
        callback = function()
            if not self.textEdit:HasFocus() then
                self.textEdit:TakeFocus()
            end
        end,
        activate = function()
            SCREEN_NARRATION_MANAGER:QueueFocus(self.textInputFocusSwitcher)
        end,
        narrationText = function()
            return ZO_FormatEditBoxNarrationText(self.textEdit, self.selectedChannelText)
        end,
        highlight = self.textControlHighlight,
        control = self.textEdit,
    }
    self.textInputFocusSwitcher:AddEntry(textEditData)
end
function ZO_ChatMenu_Gamepad:RegisterForEvents()
    ZO_InteractiveChatLog_Gamepad.RegisterForEvents(self)
    local function AddMessage(...)
        self:AddMessage(...)
    end
    local function DirtyChannelDropdown()
        self:DirtyChannelDropdown()
    end
    local function DirtyActiveChannel()
        self:DirtyActiveChannel()
    end
    local function OnGroupMemberJoined(eventCode, playerName)
        if playerName == GetRawUnitName("player") then
            self:DirtyChannelDropdown()
        end
    end
    local function OnGroupMemberLeft(eventCode, characterName, reason, isLocalPlayer)
        if isLocalPlayer then
            self:DirtyChannelDropdown()
        end
    end
    local function OnGuildMemberRankChanged(eventCode, guildId, displayName)
        if displayName == GetDisplayName() then
            self:DirtyChannelDropdown()
        end
    end
    CHAT_ROUTER:RegisterCallback("FormattedChatMessage", AddMessage)
    CALLBACK_MANAGER:RegisterCallback("OnChatChannelUpdated", DirtyActiveChannel)
    self.control:RegisterForEvent(EVENT_GROUP_MEMBER_JOINED, OnGroupMemberJoined)
    self.control:RegisterForEvent(EVENT_GROUP_MEMBER_LEFT, OnGroupMemberLeft)
    self.control:RegisterForEvent(EVENT_GUILD_SELF_JOINED_GUILD, DirtyChannelDropdown)
    self.control:RegisterForEvent(EVENT_GUILD_SELF_LEFT_GUILD, DirtyChannelDropdown)
    self.control:RegisterForEvent(EVENT_GUILD_MEMBER_RANK_CHANGED, OnGuildMemberRankChanged)
    self.control:RegisterForEvent(EVENT_PLAYER_ACTIVATED, DirtyChannelDropdown)
    self.control:RegisterForEvent(EVENT_CHAT_CATEGORY_COLOR_CHANGED, DirtyChannelDropdown)
end
function ZO_ChatMenu_Gamepad:InitializeFocusKeybinds()
    self.chatEntryListKeybindDescriptor =
    {
        alignment = KEYBIND_STRIP_ALIGN_LEFT,
        -- Back to text input
        {
            name = GetString(SI_GAMEPAD_BACK_OPTION),
            keybind = "UI_SHORTCUT_NEGATIVE",
            callback = function()
                self:FocusTextInput()
            end,
            sound = SOUNDS.GAMEPAD_MENU_BACK,
        },
    }
    ZO_Gamepad_AddListTriggerKeybindDescriptors(self.chatEntryListKeybindDescriptor, self.list)
    local function AreOptionsAvailable()
        local targetData = self.list:GetTargetData()
        if targetData then
            local data = targetData.data
            if data then
                if data.fromDisplayName and data.fromDisplayName ~= "" and self:HasAnyShownOptions() then
                    return true
                end
            end
        end
        return false
    end
    local DEFAULT_CALLBACK, DEFAULT_KEYBIND, DEFAULT_NAME, DEFAULT_SOUND
    self:AddSocialOptionsKeybind(self.chatEntryListKeybindDescriptor, DEFAULT_CALLBACK, DEFAULT_KEYBIND, DEFAULT_NAME, DEFAULT_SOUND, AreOptionsAvailable)
    self.chatEntryPanelFocalArea:SetKeybindDescriptor(self.chatEntryListKeybindDescriptor)
    self.textInputAreaKeybindDescriptor =
    {
        alignment = KEYBIND_STRIP_ALIGN_LEFT,
        {
            name = GetString(SI_GAMEPAD_SELECT_OPTION),
            keybind = "UI_SHORTCUT_PRIMARY",
            callback = function()
                local data = self.textInputFocusSwitcher:GetFocusItem()
                data.callback()
            end,
        },
        {
            name = GetString(SI_GAMEPAD_CHAT_MENU_SEND_KEYBIND),
            keybind = "UI_SHORTCUT_SECONDARY",
            callback = function()
                local CURRENT_CHANNEL, CURRENT_TARGET
                local DONT_SHOW_HUD_WINDOW = true
                AutoSendChatInput(self.textEdit:GetText(), CURRENT_CHANNEL, CURRENT_TARGET, DONT_SHOW_HUD_WINDOW)
                self.textEdit:Clear()
            end,
            enabled = function()
                local text = self.textEdit:GetText()
                return text and text ~= ""
            end,
        },
        {
            name = GetString(SI_RANDOM_ROLL_KEYBIND),
            keybind = "UI_SHORTCUT_TERTIARY",
            callback = function()
                ZO_RandomRollCommand()
            end,
        },
    }
    ZO_Gamepad_AddBackNavigationKeybindDescriptors(self.textInputAreaKeybindDescriptor, GAME_NAVIGATION_TYPE_BUTTON)
    self.textInputAreaFocalArea:SetKeybindDescriptor(self.textInputAreaKeybindDescriptor)
end
function ZO_ChatMenu_Gamepad:OnShow()
    self.channelRefreshGroup:TryClean()
    if not self.pendingLinkFocus then
        self:FocusTextInput()
    else
        self:SelectMessageEntryByLinkInternal(self.pendingLinkFocus)
        local OLD_TARGET_DATA = nil
        local REACHED_TARGET = nil
        local targetData = self.list:GetTargetData()
        local targetSelectedIndex = self.list:GetSelectedIndex()
        self:OnTargetChanged(self.list, targetData, OLD_TARGET_DATA, REACHED_TARGET, targetSelectedIndex)
    end
    self.pendingLinkFocus = nil
end
function ZO_ChatMenu_Gamepad:FocusTextInput()
    self.activeLinks:ResetLinks()
    ZO_InteractiveChatLog_Gamepad.FocusTextInput(self)
    if self.scene:IsShowing() then
        self.textInputFocusSwitcher:SetFocusToMatchingEntry(self.textEdit)
    end
end
function ZO_ChatMenu_Gamepad:SetupLogMessage(control, data, selected, reselectingDuringRebuild, enabled, active)
    ZO_SharedGamepadEntry_OnSetup(control, data, selected, reselectingDuringRebuild, enabled, active)
    local entryData = data.data
    local r, g, b
    if entryData.overrideColorDef then
        r, g, b = entryData.overrideColorDef:UnpackRGB()
    else
        r, g, b = GetChatCategoryColor(entryData.category)
    end
    local isSelected = selected and self.chatEntryPanelFocalArea:IsFocused()
    control.marker:SetHidden(not isSelected)
    if isSelected then
        control.label:SetAnchor(TOPLEFT, control.marker, TOPRIGHT)
    else
        control.label:SetAnchor(TOPLEFT, control.marker, TOPLEFT)
    end
    local colorSelectedModifier = isSelected and 1 or ZO_CHAT_MENU_GAMEPAD_COLOR_MODIFIER
    control.label:SetColor(r * colorSelectedModifier, g * colorSelectedModifier, b * colorSelectedModifier, 1)
    control.label:SetDesaturation(isSelected and 0 or ZO_CHAT_MENU_GAMEPAD_DESATURATION_MODIFIER)
end
function ZO_ChatMenu_Gamepad:AddMessage(message, category, targetChannel, fromDisplayName, rawMessageText, narrationMessage, overrideColorDef)
    if message ~= nil then
        local targetIndex = self.list:GetTargetIndex()
        local selectingMostRecent = targetIndex == #self.messageEntries
        local links
        --Only chat channel messages will have raw text, because they're the only ones that could have links in them
        if rawMessageText then
            links = {}
            ZO_ExtractLinksFromText(rawMessageText, ZO_VALID_LINK_TYPES_CHAT, links)
            links = #links > 0 and links or nil
        end
        
        local messageEntry = ZO_GamepadEntryData:New(message)
        messageEntry:SetFontScaleOnSelection(false)
        messageEntry.data =
        {
            id = self.nextMessageId,
            fromDisplayName = fromDisplayName,
            category = category,
            targetChannel = targetChannel,
            rawMessageText = rawMessageText,
            links = links,
            narrationMessage = narrationMessage,
            overrideColorDef = overrideColorDef,
        }
        self.nextMessageId = self.nextMessageId + 1
        table.insert(self.messageEntries, messageEntry)
        if #self.messageEntries > ZO_CHAT_MENU_GAMEPAD_LOG_MAX_SIZE then
            table.remove(self.messageEntries, 1)
            self:BuildChatList()
        else
            self.list:AddEntry("ZO_InteractiveChatLog_Gamepad_LogLine", messageEntry)
            self.list:Commit()
        end
        if selectingMostRecent then
            self.list:SetSelectedIndex(#self.messageEntries)
        end
    end
end
function ZO_ChatMenu_Gamepad:OnTargetChanged(list, targetData, ...)
    self.activeLinks:ResetLinks()
    ZO_InteractiveChatLog_Gamepad.OnTargetChanged(self, list, targetData, ...)
    self:RefreshTooltip(targetData)
end
function ZO_ChatMenu_Gamepad:SetupOptions(entryData)
    local data = entryData.data
    local socialData =
    {
        displayName = data.fromDisplayName,
        category = data.category,
        targetChannel = data.targetChannel,
    }
    ZO_InteractiveChatLog_Gamepad.SetupOptions(self, socialData)
end
function ZO_ChatMenu_Gamepad:BuildOptionsList()
    local groupId = self:AddOptionTemplateGroup(ZO_SocialOptionsDialogGamepad.GetDefaultHeader)
    self:AddOptionTemplate(groupId, ZO_SocialOptionsDialogGamepad.BuildGamerCardOption, IsConsoleUI)
    self:AddOptionTemplate(groupId, ZO_SocialOptionsDialogGamepad.BuildInviteToGroupOption, ZO_SocialOptionsDialogGamepad.ShouldAddInviteToGroupOption)
    self:AddOptionTemplate(groupId, ZO_SocialOptionsDialogGamepad.BuildWhisperOption)
    self:AddOptionTemplate(groupId, ZO_SocialOptionsDialogGamepad.BuildAddFriendOption, ZO_SocialOptionsDialogGamepad.ShouldAddFriendOption)
    self:AddOptionTemplate(groupId, ZO_SocialOptionsDialogGamepad.BuildSendMailOption, ZO_SocialOptionsDialogGamepad.ShouldAddSendMailOption)
    self:AddOptionTemplate(groupId, ZO_SocialOptionsDialogGamepad.BuildIgnoreOption, ZO_SocialOptionsDialogGamepad.SelectedDataIsNotPlayer)
end
function ZO_ChatMenu_Gamepad:OnScreenResized()
    ZO_InteractiveChatLog_Gamepad.OnScreenResized(self)
end
function ZO_ChatMenu_Gamepad:OnTextInputAreaActivated()
    self.textInputFocusSwitcher:Activate()
    ZO_InteractiveChatLog_Gamepad.OnTextInputAreaActivated(self)
end
function ZO_ChatMenu_Gamepad:OnTextInputAreaDeactivated()
    self.textInputFocusSwitcher:Deactivate()
    ZO_InteractiveChatLog_Gamepad.OnTextInputAreaDeactivated(self)
end
function ZO_ChatMenu_Gamepad:OnChatEntryPanelActivated()
    ZO_InteractiveChatLog_Gamepad.OnChatEntryPanelActivated(self)
    self:RefreshTooltip()
end
function ZO_ChatMenu_Gamepad:OnChatEntryPanelDeactivated()
    ZO_InteractiveChatLog_Gamepad.OnChatEntryPanelDeactivated(self)
    self.activeLinks:ResetLinks()
end
-- End ZO_InteractiveChatLog_Gamepad Overrides
function ZO_ChatMenu_Gamepad:InitializeChannelDropdown()
    local channelControl = self.textInputControl:GetNamedChild("Channel")
    local channelDropdownControl = channelControl:GetNamedChild("Dropdown")
    local channelDropdown = ZO_ComboBox_ObjectFromContainer(channelDropdownControl)
    channelDropdown:SetSelectedColor(ZO_DISABLED_TEXT)
    channelDropdown:SetSortsItems(false)
    channelDropdown:SetDontSetSelectedTextOnSelection(true)
    self.selectedChannelLabel = channelDropdownControl:GetNamedChild("SelectedItemText")
    self.selectedChannelFakeLabel = channelDropdownControl:GetNamedChild("SelectedItemFakeTextForResizing")
    local function DropDownDeactivatedCallback()
        SCREEN_NARRATION_MANAGER:QueueFocus(self.textInputFocusSwitcher)
    end
    -- Prepare switches for sorting
    -- These switches are the slash commands used to set the channel (e.g.:/zone)
    -- The channelData holds a table of all the channels and their information,
    -- and the switch lookup provides the mapping of the channel id to the default (e.g.: /zone vs /z) switch needed to go there
    local channelData = ZO_ChatSystem_GetChannelInfo()
    local switchLookup = ZO_ChatSystem_GetChannelSwitchLookupTable()
    local switches = {}
    for channel in pairs(channelData) do
        local switch = switchLookup[channel]
        --Not every channel in the channel data is going to map to a switch
        if switch then
            switches[#switches + 1] = switch
        end
    end
    table.sort(switches)
    --The functionality that auto activates the dropdown upon focusing relies upon code in ZO_GamepadFocus.lua that will try to call active on the control if the focus data does not have an activate
    --Adding an activate to this data would prevent that functionality from happening, so if we do, make sure that behavior is accounted for
    local channelFocusData =
    {
        keybindText = GetString(SI_GAMEPAD_SELECT_OPTION),
        callback = function()
            channelDropdown:Activate()
        end,
        narrationText = function()
            return channelDropdown:GetNarrationText()
        end,
        highlight = channelControl:GetNamedChild("Highlight"),
        control = channelDropdown,
    }
    self.textInputFocusSwitcher:AddEntry(channelFocusData)
    self.channelDropdown = channelDropdown
    self.channelControl = channelControl
    self.sortedChannelSwitches = switches
    local DONT_RESELECT = false
    self:RefreshChannelDropdown(DONT_RESELECT)
end
function ZO_ChatMenu_Gamepad:RefreshChannelDropdown(reselectDuringRebuild)
    local function OnChannelSelected(_, _, entry, _)
        local data = entry.data
        --Target means we don't yet have enough info to properly change channels
        if data and not data.target then
            GAMEPAD_CHAT_SYSTEM:SetChannel(data.id)
        end
    end
    local switchLookup = ZO_ChatSystem_GetChannelSwitchLookupTable()
    local channelDropdown = self.channelDropdown
    channelDropdown.minimumWidth = 0
    channelDropdown:ClearItems()
    --Add sorted switches
    for i, switch in ipairs(self.sortedChannelSwitches) do
        --The switchLookup also includes a backward lookup to use any switch (not just defaults) to find the associated channel data
        local channelData = switchLookup[switch]
        -- exclude channels that require an explicit target (ie. /tell) and channels that we don't currently meet the requirements for
        if channelData and not channelData.target and (not channelData.requires or channelData.requires(channelData.id)) then
            local r, g, b = ZO_ChatSystem_GetCategoryColorFromChannel(channelData.id)
            local itemColor = ZO_ColorDef:New(r, g, b)
            local coloredSwitchText = itemColor:Colorize(switch)
            local entry = channelDropdown:CreateItemEntry(coloredSwitchText, OnChannelSelected)
            entry.data = channelData
            channelDropdown:AddItem(entry, ZO_COMBOBOX_SUPRESS_UPDATE)
            local stringWidth = (self.selectedChannelFakeLabel:GetStringWidth(zo_strupper(switch)) / GetUIGlobalScale()) + 10 -- 10px of margin to avoid word wrapping
            channelDropdown.minimumWidth = zo_max(stringWidth, channelDropdown.minimumWidth)
        end
    end
    if reselectDuringRebuild then
        self:OnChatChannelChanged()
    end
end
do
    local function IsEntryForCurrentChannel(entry)
        local channelData = GAMEPAD_CHAT_SYSTEM:GetCurrentChannelData()
        return entry.data == channelData
    end
    function ZO_ChatMenu_Gamepad:OnChatChannelChanged()
        --Set the dropdown selection to the appropriate channel
        self.channelDropdown:SetSelectedItemByEval(IsEntryForCurrentChannel, true)
        --Set the selected item text for the dropdown to the appropriate text
        local channelData, channelTarget = CHAT_ROUTER:GetCurrentChannelData()
        local channelText
        if channelTarget then
            --Console can only have display names. This won't do anything to character names on PC
            channelTarget = ZO_FormatUserFacingDisplayName(channelTarget)
            channelText = zo_strformat(SI_CHAT_ENTRY_TARGET_FORMAT, GetChannelName(channelData.id), channelTarget)
        else
            channelText = zo_strformat(SI_CHAT_ENTRY_GENERAL_FORMAT, GetChannelName(channelData.id))
        end
        self.selectedChannelText = channelText
        self.selectedChannelLabel:SetText(channelText)
        local r, g, b = ZO_ChatSystem_GetCategoryColorFromChannel(channelData.id)
        self.selectedChannelLabel:SetColor(r, g, b, 1)
        self.textEdit:SetColor(r, g, b)
        --Set the dropdown width to be wide enough to fit the text
        local stringWidth = self.selectedChannelFakeLabel:GetStringWidth(zo_strupper(channelText)) / GetUIGlobalScale()
        self.channelControl:SetWidth(zo_max(self.channelDropdown.minimumWidth, stringWidth))
    end
end
function ZO_ChatMenu_Gamepad:RefreshTooltip(targetData)
    self.activeLinks:ResetLinks()
    local currentTargetData = targetData or self.list:GetTargetData()
    if currentTargetData then
        if self.scene:GetState() == SCENE_SHOWN and self.chatEntryPanelFocalArea:IsFocused() then
            local links = currentTargetData.data.links
            self.activeLinks:AddLinksTable(links)
            self.activeLinks:Show()
            if self.activeLinks:GetCurrentLink() == CRAFTED_ABILITY_LINK_TYPE then
                ResetCraftedAbilityScriptSelectionOverride()
            end
        end
    end
end
function ZO_ChatMenu_Gamepad:InitializeRefreshGroup()
    self.channelRefreshGroup = ZO_OrderedRefreshGroup:New(ZO_ORDERED_REFRESH_GROUP_AUTO_CLEAN_PER_FRAME)
    self.channelRefreshGroup:AddDirtyState("Dropdown", function()
        local RESELECT = true
        self:RefreshChannelDropdown(RESELECT)
    end)
    self.channelRefreshGroup:AddDirtyState("ActiveChannel", function()
        self:OnChatChannelChanged()
    end)
end
function ZO_ChatMenu_Gamepad:DirtyChannelDropdown()
    self.channelRefreshGroup:MarkDirty("Dropdown")
end
function ZO_ChatMenu_Gamepad:DirtyActiveChannel()
    self.channelRefreshGroup:MarkDirty("ActiveChannel")
end
function ZO_ChatMenu_Gamepad:SelectMessageEntryByLink(link)
    if self.scene:GetState() == SCENE_SHOWN then
        self:SelectMessageEntryByLinkInternal(link)
    else
        self.pendingLinkFocus = link
    end
end
function ZO_ChatMenu_Gamepad:SelectMessageEntryByLinkInternal(link)
    self.pendingLinkFocus = nil
    self.activeLinks:ResetLinks()
    self:ActivateFocusArea(self.chatEntryPanelFocalArea)
    for messageIndex = 1, #self.messageEntries do
        local entry = self.messageEntries[messageIndex]
        if entry.data.links then
            for linkIndex, currentLink in ipairs(entry.data.links) do
                if currentLink.link == link then
                    self.list:SetSelectedIndex(messageIndex)
                    return
                end
            end
        end
    end
end
--------------
--Global XML--
--------------
    CHAT_MENU_GAMEPAD = ZO_ChatMenu_Gamepad:New(control)
end