ESO Lua File v100010

ingame/playeremote/gamepad/playeremote_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
local GAMEPAD_PLAYER_EMOTE_SCENE_NAME = "gamepad_player_emote"
local GAMEPAD_PLAYER_EMOTE_MENU_ENTRY_TEMPLATE = "ZO_GamepadMenuEntryTemplate"
local EMPTY_QUICKSLOT_TEXTURE = "EsoUI/Art/Quickslots/quickslot_emptySlot.dds"
local EMPTY_QUICKSLOT_STRING = GetString(SI_QUICKSLOTS_EMPTY)
local MODE_CATEGORY_INACTIVE = 0
local MODE_CATEGORY_SELECTION = 1
local MODE_EMOTE_SELECTION = 2
local MODE_EMOTE_ASSIGNMENT = 3
local ZO_EMOTE_COLUMN_WIDTH = 400
local ZO_EMOTE_ROW_HEIGHT = 60
local NUM_EMOTE_ITEMS_IN_COLUMN = 10
local NUM_EMOTE_ITEM_COLUMNS = 3
local NUM_EMOTES_ON_PAGE = NUM_EMOTE_ITEM_COLUMNS * NUM_EMOTE_ITEMS_IN_COLUMN
-- ZO_EmoteItem class. These items wrap the controls that make up the grid of emotes the user can select from
local ZO_EmoteItem = ZO_Object:Subclass()
function ZO_EmoteItem:New(...)
    local emote = ZO_Object.New(self)
    emote:Initialize(...)
    return emote
end
function ZO_EmoteItem:Initialize(control)
    self.control = control
    self.title = control:GetNamedChild("Title")
    self.highlight = control:GetNamedChild("Highlight")
    self:SetHighlightVisible(false)
end
function ZO_EmoteItem:SetAnchor(column, row)
    self.control:SetAnchor(TOPLEFT, nil, TOPLEFT, (column-1)*ZO_EMOTE_COLUMN_WIDTH, (row-1)*ZO_EMOTE_ROW_HEIGHT)
end
function ZO_EmoteItem:SetVisible(visible)
    self.control:SetHidden(not visible)
end
function ZO_EmoteItem:SetHighlightVisible(visible)
    self.highlight:SetHidden(not visible)
end
function ZO_EmoteItem:SetEmoteInfo(emoteId)
    self.emoteInfo = PLAYER_EMOTE_MANAGER:GetEmoteItemInfo(emoteId)
    self.title:SetText(zo_strformat(GetString(SI_GAMEPAD_PLAYER_EMOTE_NAME), self.emoteInfo.emoteName))
end
function ZO_EmoteItem:GetName()
    return self.emoteInfo.emoteName
end
function ZO_EmoteItem:GetEmoteIndex()
    return self.emoteInfo.emoteIndex
end
function ZO_EmoteItem:GetEmoteCategory()
    return self.emoteInfo.emoteCategory
end
-- ZO_GamepadEmoteGrid class. This class manages the full grid of items including page switching
local ZO_GamepadEmoteGrid = ZO_GamepadPagedGrid:Subclass()
function ZO_GamepadEmoteGrid:New(...)
    return ZO_GamepadPagedGrid.New(self, ...)
end
function ZO_GamepadEmoteGrid:Initialize(control)
    local COLUMN_MAJOR = false
    ZO_GamepadPagedGrid.Initialize(self, control, COLUMN_MAJOR)
    self.allowHighlight = true
    self.emoteItems = {}
    self.visibleEmotes = {}
end
local function ResetEmote(emote)
    emote:SetVisible(false)
    emote:SetHighlightVisible(false)
end
function ZO_GamepadEmoteGrid:InitializeEmoteItemPool()
    local function CreateEmote(objectPool)
        local emoteControl = ZO_ObjectPool_CreateControl("ZO_PlayerEmoteItemControl", objectPool, self.control)
        return ZO_EmoteItem:New(emoteControl)
    end
    self.emoteItemPool = ZO_ObjectPool:New(CreateEmote, ResetEmote)
end
function ZO_GamepadEmoteGrid:InitializeEmoteItemGrid()
    for column=1, NUM_EMOTE_ITEM_COLUMNS do
        self.emoteItems[column] = {}
        for row=1, NUM_EMOTE_ITEMS_IN_COLUMN do
            local emoteItem = self.emoteItemPool:AcquireObject()
            emoteItem:SetAnchor(column, row)
            self.emoteItems[column][row] = emoteItem
        end
    end
end
function ZO_GamepadEmoteGrid:ResetGridItem(column, row, visible)
    local emoteItem = self.emoteItems[column][row]
    emoteItem:SetHighlightVisible(false)
    emoteItem:SetVisible(visible)
end
function ZO_GamepadEmoteGrid:ResetPageInfo()
    if self.emoteList then
        local FIRST_PAGE = 1
        local numPages = math.ceil(#self.emoteList / NUM_EMOTES_ON_PAGE)
        self:SetPageInfo(FIRST_PAGE, numPages)
    end
end
function ZO_GamepadEmoteGrid:ChangeEmoteType(emoteType)
    self.emoteType = emoteType
    self.emoteList = PLAYER_EMOTE_MANAGER:GetEmoteListForType(self.emoteType)
    self:ResetPageInfo()
end
function ZO_GamepadEmoteGrid:GetCurrentSelectedEmote()
    return self.emoteItems[self.currentHighlight.column][self.currentHighlight.row]
end
function ZO_GamepadEmoteGrid:GetSelectedEmoteName()
    return self:GetCurrentSelectedEmote():GetName()
end
function ZO_GamepadEmoteGrid:GetSelectedEmoteIndex()
end
function ZO_GamepadEmoteGrid:GetSelectedEmoteCategory()
end
function ZO_GamepadEmoteGrid:SetAllowHighlight(allow)
    self.allowHighlight = allow
end
function ZO_GamepadEmoteGrid:RefreshGrid()
    --[[
Refresh the grid by reseting the visibleEmotes boolean array used by ZO_GamepadGrid and then setting controls
Visible or Hidden based on how many items are needed to be shown for the current list size on the current page
]]
    self.visibleEmotes = {}
    local currentPage = self:GetCurrentPage()
    local emoteStartIndex = ((currentPage - 1) * NUM_EMOTES_ON_PAGE)
    local numEmotesToShow = zo_min(#self.emoteList - emoteStartIndex, NUM_EMOTES_ON_PAGE)
    local numShown = 0
    local SHOW_GRID_ITEM = true
    local HIDE_GRID_ITEM = false
    for column=1, NUM_EMOTE_ITEM_COLUMNS do
        if numShown < numEmotesToShow then
            self.visibleEmotes[column] = {}
        end
        for row=1, NUM_EMOTE_ITEMS_IN_COLUMN do
            if numShown < numEmotesToShow then
                self:ResetGridItem(column, row, SHOW_GRID_ITEM)
                self.visibleEmotes[column][row] = true
                numShown = numShown + 1
                self.emoteItems[column][row]:SetEmoteInfo(self.emoteList[emoteStartIndex + numShown])
            else
                self:ResetGridItem(column, row, HIDE_GRID_ITEM)
            end
        end
    end
end
-- functions overriden from base class
function ZO_GamepadEmoteGrid:GetGridItems()
    return self.visibleEmotes
end
function ZO_GamepadEmoteGrid:RefreshGridHighlight()
    if self.currentHighlight then
        self.emoteItems[self.currentHighlight.column][self.currentHighlight.row]:SetHighlightVisible(false)
    end
    local column,row = self:GetGridPosition()
    if column > 0 and row > 0 then
        self.emoteItems[column][row]:SetHighlightVisible(self.allowHighlight)
        self.currentHighlight = {row=row, column=column}
    end
end
-- ZO_GamepadPlayerEmote class. This class creates our gamepad scene and emote category list and contains
-- a ZO_GamepadEmoteGrid object and quickslot radial menu
local ZO_GamepadPlayerEmote = ZO_Gamepad_ParametricList_Screen:Subclass()
function ZO_GamepadPlayerEmote:New(...)
    return ZO_Gamepad_ParametricList_Screen.New(self, ...)
end
function ZO_GamepadPlayerEmote:Initialize(control)
    self.control = control
    self.emoteListGridControl = control:GetNamedChild("EmoteListGrid")
    self.radialControl = control:GetNamedChild("Quickslot"):GetNamedChild("Container"):GetNamedChild("Radial")
    GAMEPAD_PLAYER_EMOTE_SCENE = ZO_Scene:New(GAMEPAD_PLAYER_EMOTE_SCENE_NAME, SCENE_MANAGER)
    local ACTIVATE_ON_SHOW = true
    ZO_Gamepad_ParametricList_Screen.Initialize(self, control, ZO_GAMEPAD_HEADER_TABBAR_DONT_CREATE, ACTIVATE_ON_SHOW, GAMEPAD_PLAYER_EMOTE_SCENE)
end
function ZO_GamepadPlayerEmote:OnDeferredInitialize()
    self:InitializeList()
end
function ZO_GamepadPlayerEmote:OnSelectionChanged()
    local selectedData = self.itemList:GetSelectedData()
    if selectedData then
        self.currentCategory = selectedData.emoteCategory
        self.emoteListGrid:ChangeEmoteType(self.currentCategory)
    end
end
function ZO_GamepadPlayerEmote:InitializeList()
    self.itemList = self:GetMainList()
     self.itemList:Clear()
    local categories = PLAYER_EMOTE_MANAGER:GetEmoteCategories()
    for _, category in ipairs(categories) do
        local iconInfo = PLAYER_EMOTE_MANAGER:GetEmoteIconForCategory(category)
        local data = ZO_GamepadEntryData:New(GetString("SI_EMOTECATEGORY", category), iconInfo and iconInfo.activeIcon)
        data.emoteCategory = category
        self.itemList:AddEntry(GAMEPAD_PLAYER_EMOTE_MENU_ENTRY_TEMPLATE, data)
    end
    self.itemList:Commit()
end
function ZO_GamepadPlayerEmote:InitializeHeader()
    self.headerData = {titleText = GetString(SI_GAMEPAD_PLAYER_EMOTE_CATEGORY)}
    local rightPane = self.control:GetNamedChild("RightPane")
    local contentContainer = rightPane:GetNamedChild("ContentHeader")
    self.contentHeader = contentContainer:GetNamedChild("Header")
    ZO_GamepadGenericHeader_Initialize(self.contentHeader, ZO_GAMEPAD_HEADER_TABBAR_DONT_CREATE, ZO_GAMEPAD_HEADER_LAYOUTS.DATA_PAIRS_TOGETHER)
    local function ShowContentHeader()
        return self.mode == MODE_CATEGORY_SELECTION or self.mode == MODE_EMOTE_SELECTION
    end
    self.contentHeaderData = {
        titleText = function()
            if ShowContentHeader() then
                return zo_strformat(GetString(SI_GAMEPAD_PLAYER_EMOTE_CATEGORY_NAME), GetString("SI_EMOTECATEGORY", self.currentCategory))
            end
        end,
        data0HeaderText = function()
            if ShowContentHeader() then
                return GetString(SI_GAMEPAD_PLAYER_EMOTE_PAGE_LABEL)
            end
        end,
        data0Text = function()
            if ShowContentHeader() then
                local currentPage = self.emoteListGrid:GetCurrentPage()
                local numPages = self.emoteListGrid:GetNumPages()
                return zo_strformat(GetString(SI_GAMEPAD_PLAYER_EMOTE_PAGE_FORMAT), currentPage, numPages)
            end
        end,
    }
end
function ZO_GamepadPlayerEmote:InitializeEmoteGrid()
    self.emoteListGrid = ZO_GamepadEmoteGrid:New(self.emoteListGridControl)
    self.emoteListGrid:SetPageChangedCallback(function() self:RefreshHeader() end)
end
function ZO_GamepadPlayerEmote:InitializeRadialMenu(control)
    self.radialMenu = ZO_RadialMenu:New(self.radialControl, "ZO_GamepadPlayerEmoteRadialMenuEntryTemplate", nil, "SelectableItemRadialMenuEntryAnimation", "RadialMenu")
    self.radialMenu.activeIcon = self.radialControl:GetNamedChild("Icon")
    self.radialMenu.activeName = self.radialControl:GetNamedChild("Name")
    local function SetupEntryControl(entryControl, data)
        entryControl.label:SetText(data.name)
        ZO_SetupSelectableItemRadialMenuEntryTemplate(entryControl)
    end
    local function OnActionSlotUpdated(eventCode, physicalSlot)
        self:RefreshQuickslotMenu()
    end
    self.radialControl:RegisterForEvent(EVENT_ACTION_SLOT_UPDATED, OnActionSlotUpdated)
end
function ZO_GamepadPlayerEmote:PerformUpdate()
    self:RefreshHeader()
end
function ZO_GamepadPlayerEmote:RefreshHeader()
    ZO_GamepadGenericHeader_Refresh(self.header, self.headerData)
    ZO_GamepadGenericHeader_Refresh(self.contentHeader, self.contentHeaderData)
end
function ZO_GamepadPlayerEmote:InitializeKeybindStripDescriptors()
    self.categoryKeybindStripDescriptor = {
        {
            name = GetString(SI_GAMEPAD_PLAYER_EMOTE_USE_EMOTE),
            keybind = "UI_SHORTCUT_PRIMARY",
            alignment = KEYBIND_STRIP_ALIGN_LEFT,
            callback = function()
                SCENE_MANAGER:ShowBaseScene()
                PlayEmoteByIndex(self.emoteListGrid:GetSelectedEmoteIndex())
            end,
        },
        {
            name = GetString(SI_GAMEPAD_PLAYER_EMOTE_ASSIGN_EMOTE),
            keybind = "UI_SHORTCUT_SECONDARY",
            alignment = KEYBIND_STRIP_ALIGN_LEFT,
            callback = function()
                self:ChangeCurrentMode(MODE_EMOTE_ASSIGNMENT)
            end,
        },
    }
    ZO_Gamepad_AddBackNavigationKeybindDescriptors(self.categoryKeybindStripDescriptor,
                                                            GAME_NAVIGATION_TYPE_BUTTON,
                                                            function() self:ChangeCurrentMode(MODE_CATEGORY_SELECTION) end)
    self.emoteAssignmentKeybindStripDescriptor = {}
    ZO_Gamepad_AddForwardNavigationKeybindDescriptors(self.emoteAssignmentKeybindStripDescriptor, 
                                            GAME_NAVIGATION_TYPE_BUTTON, 
                                            function() self:AssignSelectedQuickslot() end,
                                            GetString(SI_GAMEPAD_ITEM_ACTION_QUICKSLOT_ASSIGN))
    ZO_Gamepad_AddBackNavigationKeybindDescriptors(self.emoteAssignmentKeybindStripDescriptor,
                                                            GAME_NAVIGATION_TYPE_BUTTON,
                                                            function() self:ChangeCurrentMode(MODE_EMOTE_SELECTION) end)
    self.keybindStripDescriptor = {}
    ZO_Gamepad_AddForwardNavigationKeybindDescriptors(self.keybindStripDescriptor, 
                                                GAME_NAVIGATION_TYPE_BUTTON, 
                                                function() self:ChangeCurrentMode(MODE_EMOTE_SELECTION) end, 
                                                GetString(SI_GAMEPAD_SELECT_OPTION), 
                                                function() return self.currentCategory end )
    ZO_Gamepad_AddBackNavigationKeybindDescriptors(self.keybindStripDescriptor, GAME_NAVIGATION_TYPE_BUTTON)
end
function ZO_GamepadPlayerEmote:DeselectCurrentMode()
    if self.mode == MODE_CATEGORY_SELECTION then
        KEYBIND_STRIP:RemoveKeybindButtonGroup(self.keybindStripDescriptor)
        self.itemList:Deactivate()
    elseif self.mode == MODE_EMOTE_SELECTION then
        KEYBIND_STRIP:RemoveKeybindButtonGroup(self.categoryKeybindStripDescriptor)
        self.emoteListGrid:Deactivate()
        self.emoteListGrid:SetAllowHighlight(false)
    elseif self.mode == MODE_EMOTE_ASSIGNMENT then
        self:HideQuickslotMenu()
        self.emoteListGridControl:SetHidden(false)
        KEYBIND_STRIP:RemoveKeybindButtonGroup(self.emoteAssignmentKeybindStripDescriptor)
    end
    self.mode = MODE_CATEGORY_INACTIVE
end
function ZO_GamepadPlayerEmote:SelectMode(mode)
    self.mode = mode
    if self.mode == MODE_CATEGORY_SELECTION then
        KEYBIND_STRIP:AddKeybindButtonGroup(self.keybindStripDescriptor)
        self.itemList:Activate()
        self.emoteListGrid:SetAllowHighlight(false)
    elseif self.mode == MODE_EMOTE_SELECTION then
        KEYBIND_STRIP:AddKeybindButtonGroup(self.categoryKeybindStripDescriptor)
        self.emoteListGrid:SetAllowHighlight(true)
        self.emoteListGrid:Activate()
    elseif self.mode == MODE_EMOTE_ASSIGNMENT then
        self.emoteListGridControl:SetHidden(true)
        KEYBIND_STRIP:AddKeybindButtonGroup(self.emoteAssignmentKeybindStripDescriptor)
        self:ShowQuickslotMenu()
    end
end
function ZO_GamepadPlayerEmote:ChangeCurrentMode(mode)
    if self.mode ~= mode then
        self:DeselectCurrentMode()
        self:SelectMode(mode)
        self:RefreshHeader()
    end
end
function ZO_GamepadPlayerEmote:ShowQuickslotMenu()
    self.radialMenu:Clear()
    local emoteIcon = PLAYER_EMOTE_MANAGER:GetEmoteIconForCategory(self.emoteListGrid:GetSelectedEmoteCategory())
    self.radialMenu.activeIcon:SetTexture(emoteIcon.activeIcon)
    self.radialMenu.activeName:SetText(self.emoteListGrid:GetSelectedEmoteName())
    self.radialMenu.activeName:SetHidden(false)
    self.activeEmoteIndex = self.emoteListGrid:GetSelectedEmoteIndex()
    -- This will Activate the menu and show it
    self.radialMenu:Show()
end
function ZO_GamepadPlayerEmote:HideQuickslotMenu()
    self.activeEmoteIndex = nil
    -- This will deactivate the menu and hide it
    self.radialMenu:Clear()
end
function ZO_GamepadPlayerEmote:PopulateRadialMenu()
    local slottedEmotes = PLAYER_EMOTE_MANAGER:GetSlottedEmotes()
    for i = 1, ACTION_BAR_EMOTE_QUICK_SLOT_SIZE do
        local emoteID = slottedEmotes[i]
        local emoteInfo = PLAYER_EMOTE_MANAGER:GetEmoteItemInfo(emoteID)
        if emoteInfo then
            local emoteIcons = PLAYER_EMOTE_MANAGER:GetEmoteIconForCategory(emoteInfo.emoteCategory)
            self.radialMenu:AddEntry(emoteInfo.emoteName, emoteIcons.inactiveIcon, emoteIcons.activeIcon, nil, {name = emoteInfo.emoteName, slot = i})
        else
            self.radialMenu:AddEntry(EMPTY_QUICKSLOT_STRING, EMPTY_QUICKSLOT_TEXTURE, EMPTY_QUICKSLOT_TEXTURE, nil, {name = EMPTY_QUICKSLOT_STRING, slot = i})
        end
    end
    if self.activeIcon then
        self.radialMenu.activeIcon:SetTexture(self.activeIcon)
    end
end
function ZO_GamepadPlayerEmote:RefreshQuickslotMenu()
    self.radialMenu:ResetData()
    self.radialMenu:Refresh()
end
function ZO_GamepadPlayerEmote:AssignSelectedQuickslot()
    local selectedData = self.radialMenu.selectedEntry.data
    local slotIndex = selectedData.slot + ACTION_BAR_FIRST_EMOTE_QUICK_SLOT_INDEX
    SelectSlotEmote(self.activeEmoteIndex, slotIndex)
end
function ZO_GamepadPlayerEmote:OnShowing()
    self:ChangeCurrentMode(MODE_CATEGORY_SELECTION)
    self.itemList:SetFirstIndexSelected()
    self.emoteListGrid:ResetPageInfo()
end
function ZO_GamepadPlayerEmote:OnHide()
    self:ChangeCurrentMode(MODE_CATEGORY_INACTIVE)
end
--Global XML Handlers
-----------------------
    GAMEPAD_PLAYER_EMOTE = ZO_GamepadPlayerEmote:New(control)
end