Back to Home

ESO Lua File v101038

ingame/collections/keyboard/collectibletile_keyboard.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
ZO_COLLECTIBLE_TILE_KEYBOARD_DIMENSIONS_X = 175
ZO_COLLECTIBLE_TILE_KEYBOARD_DIMENSIONS_Y = 125
ZO_COLLECTIBLE_TILE_KEYBOARD_ICON_DIMENSIONS = 52
ZO_CollectibleTile_Keyboard_MouseOverIconAnimationProvider = ZO_ReversibleAnimationProvider:New("ZO_CollectibleTile_Keyboard_MouseOverIconAnimation")
-- Primary logic class must be subclassed after the platform class so that platform specific functions will have priority over the logic class functionality
ZO_CollectibleTile_Keyboard = ZO_Object.MultiSubclass(ZO_ContextualActionsTile_Keyboard, ZO_ContextualActionsTile)
function ZO_CollectibleTile_Keyboard:New(...)
    return ZO_ContextualActionsTile.New(self, ...)
end
-- Begin ZO_ContextualActionsTile_Keyboard Overrides --
function ZO_CollectibleTile_Keyboard:InitializePlatform()
    ZO_ContextualActionsTile_Keyboard.InitializePlatform(self)
    self.statusMultiIcon = self.control:GetNamedChild("Status")
    self.cornerTagTexture = self.control:GetNamedChild("CornerTag")
    self.favoriteIcon = self.control:GetNamedChild("IconFavoriteIcon")
    self.cooldownIcon = self.control:GetNamedChild("CooldownIcon")
    self.cooldownIconDesaturated = self.control:GetNamedChild("CooldownIconDesaturated")
    self.cooldownTimeLabel = self.control:GetNamedChild("CooldownTime")
    self.cooldownEdgeTexture = self.control:GetNamedChild("CooldownEdge")
    self.isCooldownActive = false
    self.cooldownDuration = 0
    self.cooldownStartTime = 0
    
    self.onUpdateCooldownsCallback = function() self:OnUpdateCooldowns() end
    self:GetControl():SetHandler("OnUpdate", function() self:OnUpdate() end)
    self:GetControl():SetHandler("OnDragStart", function(_, ...) self:OnDragStart(...) end)
end
function ZO_CollectibleTile_Keyboard:PostInitializePlatform()
    -- keybindStripDescriptor and canFocus need to be set after initialize, because ZO_ContextualActionsTile
    -- won't have finished initializing those until after InitializePlatform is called
    ZO_ContextualActionsTile_Keyboard.PostInitializePlatform(self)
    table.insert(self.keybindStripDescriptor,
    {
        keybind = "UI_SHORTCUT_PRIMARY",
        name = function()
            return GetString(self:GetPrimaryInteractionStringId())
        end,
        callback = function()
            self.collectibleData:Use(self:GetActorCategory())
        end,
        visible = function()
            return self.collectibleData and self.collectibleData:IsUsable(self:GetActorCategory()) and self:GetPrimaryInteractionStringId() ~= nil
        end,
    })
    table.insert(self.keybindStripDescriptor,
    {
        keybind = "UI_SHORTCUT_SECONDARY",
        name = GetString(SI_COLLECTIBLE_ACTION_RENAME),
        callback = function()
            ZO_CollectionsBook.ShowRenameDialog(self.collectibleData:GetId())
        end,
        visible = function()
            return self.collectibleData and self.collectibleData:IsRenameable()
        end,
    })
    table.insert(self.keybindStripDescriptor,
    {
        keybind = "UI_SHORTCUT_TERTIARY",
        name = GetString(SI_COLLECTIBLE_ACTION_ASSIGN),
        callback = function()
            local emoteId = self.collectibleData:GetReferenceId()
            local emoteInfo = PLAYER_EMOTE_MANAGER:GetEmoteItemInfo(emoteId)
            if emoteInfo then
                KEYBOARD_PLAYER_EMOTE:ShowCategory(emoteInfo.emoteCategory)
            end
        end,
        visible = function()
            return self.collectibleData and self.collectibleData:IsUnlocked() and self.collectibleData:IsCategoryType(COLLECTIBLE_CATEGORY_TYPE_EMOTE)
        end,
    })
    self:SetCanFocus(false)
end
-- End ZO_ContextualActionsTile_Keyboard Overrides --
function ZO_CollectibleTile_Keyboard:GetActorCategory()
    return self.actorCategory or GAMEPLAY_ACTOR_CATEGORY_PLAYER
end
function ZO_CollectibleTile_Keyboard:OnUpdate()
    if self.collectibleData and self.isCooldownActive then
        self:UpdateCooldownEffect()
    end
end
function ZO_CollectibleTile_Keyboard:RefreshTitleLabelColor()
    if self.collectibleData then
        local isUnlocked = self.collectibleData:IsUnlocked()
        local isMousedOver = self:IsMousedOver()
        local labelColor
        if isUnlocked then
            labelColor = isMousedOver and ZO_HIGHLIGHT_TEXT or ZO_NORMAL_TEXT
        else
            labelColor = isMousedOver and ZO_SELECTED_TEXT or ZO_DISABLED_TEXT
        end
    end
end
function ZO_CollectibleTile_Keyboard:RefreshMouseoverVisuals()
    if self.collectibleData and self:IsMousedOver() then
        -- Tooltip
        ClearTooltip(ItemTooltip)
        local offsetX = self.control:GetParent():GetLeft() - self.control:GetLeft() - 5
        InitializeTooltip(ItemTooltip, self.control, RIGHT, offsetX, 0, LEFT)
        local SHOW_NICKNAME = true
        local SHOW_PURCHASABLE_HINT = true
        local SHOW_BLOCK_REASON = true
        ItemTooltip:SetCollectible(self.collectibleData:GetId(), SHOW_NICKNAME, SHOW_PURCHASABLE_HINT, SHOW_BLOCK_REASON, self:GetActorCategory())
        -- Tags
        if self.collectibleData:IsPurchasable() then
            self.cornerTagTexture:SetHidden(false)
        end
    else
        self.cornerTagTexture:SetHidden(true)
    end
end
function ZO_CollectibleTile_Keyboard:GetPrimaryInteractionStringId()
    if self.isCooldownActive ~= true and not self.collectibleData:IsBlocked(self:GetActorCategory()) then
        return self.collectibleData:GetPrimaryInteractionStringId(self:GetActorCategory())
    end
    return nil
end
function ZO_CollectibleTile_Keyboard:ShowMenu()
    local collectibleData = self.collectibleData
    if collectibleData then
        ClearMenu()
        self:AddMenuOptions()
        ShowMenu(self.control)
    end
end
function ZO_CollectibleTile_Keyboard:AddMenuOptions()
    local collectibleData = self.collectibleData
    --Use
    if collectibleData:IsUsable(self:GetActorCategory()) then
        local stringId = self:GetPrimaryInteractionStringId()
        if stringId then
            AddMenuItem(GetString(stringId), function() collectibleData:Use(self:GetActorCategory()) end)
        end
    end
    local collectibleId = collectibleData:GetId()
        --Link in chat
        AddMenuItem(GetString(SI_ITEM_ACTION_LINK_TO_CHAT), function() ZO_LinkHandler_InsertLink(GetCollectibleLink(collectibleId, LINK_STYLE_BRACKETS)) end)
    end
    --Rename
    if collectibleData:IsRenameable() then
        AddMenuItem(GetString(SI_COLLECTIBLE_ACTION_RENAME), ZO_CollectionsBook.GetShowRenameDialogClosure(collectibleId))
    end
    --Assign and Remove
    if collectibleData:IsUnlocked() then
        local utilityWheel = self.utilityWheel
        if utilityWheel and utilityWheel:IsActionTypeSupported(ACTION_TYPE_COLLECTIBLE) then
            local hotbarCategory = utilityWheel:GetHotbarCategory()
            local slottedEntries = ZO_GetUtilityWheelSlottedEntries(hotbarCategory)
            local matchingSlots = {}
            --First find any slots matching this collectible
            for i, slotData in ipairs(slottedEntries) do
                if slotData.type == ACTION_TYPE_COLLECTIBLE and slotData.id == collectibleId then
                    table.insert(matchingSlots, slotData.slotIndex)
                end
            end
            --If the collectible is slotted in at least one slot, show the Remove option
            if #matchingSlots > 0 then
                AddMenuItem(GetString(SI_ABILITY_ACTION_CLEAR_SLOT), function()
                    for i, slotIndex in ipairs(matchingSlots) do
                        ClearSlot(slotIndex, hotbarCategory)
                    end
                end)
            else
                --If the collectible is not slotted and there is a valid slot available, show the Assign option
                local validSlot = GetFirstFreeValidSlotForSimpleAction(ACTION_TYPE_COLLECTIBLE, collectibleId, hotbarCategory)
                if validSlot then
                    AddMenuItem(GetString(SI_COLLECTIBLE_ACTION_ASSIGN), function()
                        SelectSlotSimpleAction(ACTION_TYPE_COLLECTIBLE, collectibleId, validSlot, hotbarCategory)
                    end)
                end
            end
        end
        if self:GetActorCategory() == GAMEPLAY_ACTOR_CATEGORY_PLAYER and collectibleData:IsFavoritable() then
            if collectibleData:IsFavorite() then
                AddMenuItem(GetString(SI_COLLECTIBLE_ACTION_REMOVE_FAVORITE), function()
                    SetOrClearCollectibleUserFlag(collectibleId, COLLECTIBLE_USER_FLAG_FAVORITE, false)
                end)
            else
                AddMenuItem(GetString(SI_COLLECTIBLE_ACTION_ADD_FAVORITE), function()
                    SetOrClearCollectibleUserFlag(collectibleId, COLLECTIBLE_USER_FLAG_FAVORITE, true)
                end)
            end
        end
    end
end
function ZO_CollectibleTile_Keyboard:BeginCooldown()
    self.isCooldownActive = true
    self.cooldownIcon:SetHidden(false)
    self.cooldownIconDesaturated:SetHidden(false)
    self.cooldownTimeLabel:SetHidden(false)
    self.cooldownEdgeTexture:SetHidden(false)
    if self:IsMousedOver() then
        self:SetHighlightHidden(true)
        self:UpdateKeybinds()
    end
end
function ZO_CollectibleTile_Keyboard:EndCooldown()
    self.isCooldownActive = false
    self.cooldownIcon:SetTextureCoords(0, 1, 0, 1)
    self.cooldownIcon:SetHeight(ZO_COLLECTIBLE_TILE_KEYBOARD_ICON_DIMENSIONS)
    self.cooldownIcon:SetHidden(true)
    self.cooldownIconDesaturated:SetHidden(true)
    self.cooldownTimeLabel:SetHidden(true)
    self.cooldownTimeLabel:SetText("")
    self.cooldownEdgeTexture:SetHidden(true)
    if self:IsMousedOver() then
        self:SetHighlightHidden(false)
        self:UpdateKeybinds()
    end
end
function ZO_CollectibleTile_Keyboard:UpdateCooldownEffect()
    local duration = self.cooldownDuration
    local cooldown = self.cooldownStartTime + duration - GetFrameTimeMilliseconds()
    local percentCompleted = (1 - (cooldown / duration)) or 1
    local height = zo_ceil(ZO_COLLECTIBLE_TILE_KEYBOARD_ICON_DIMENSIONS * percentCompleted)
    local textureCoord = 1 - (height / ZO_COLLECTIBLE_TILE_KEYBOARD_ICON_DIMENSIONS)
    self.cooldownIcon:SetHeight(height)
    self.cooldownIcon:SetTextureCoords(0, 1, textureCoord, 1)
    if not self.collectibleData:IsActive(self:GetActorCategory()) then
        local secondsRemaining = cooldown / 1000
        self.cooldownTimeLabel:SetText(ZO_FormatTimeAsDecimalWhenBelowThreshold(secondsRemaining))
    else
        self.cooldownTimeLabel:SetText("")
    end
end
function ZO_CollectibleTile_Keyboard:OnUpdateCooldowns()
    if self.control:IsHidden() then
        self:MarkDirty()
    else
        local collectibleData = self.collectibleData
        if collectibleData and collectibleData:IsUsable(self:GetActorCategory()) then
            local remaining, duration = GetCollectibleCooldownAndDuration(collectibleData:GetId())
            if remaining > 0 and duration > 0 then
                self.cooldownDuration = duration
                self.cooldownStartTime = GetFrameTimeMilliseconds() - (duration - remaining)
                if not self.isCooldownActive then
                    self:BeginCooldown()
                end
                return
            end
        end
        self:EndCooldown()
    end
end
-- Begin ZO_Tile Overrides --
function ZO_CollectibleTile_Keyboard:RefreshLayoutInternal()
    -- Currently this only happens with cooldowns
end
function ZO_CollectibleTile_Keyboard:Reset()
    self.collectibleId = nil
    self.collectibleData = nil
    self.actorCategory = nil
    self:SetCanFocus(false)
    local INSTANT = true
    self:SetHighlightHidden(true, INSTANT)
    self:SetTitle("")
    self:GetIconTexture():SetHidden(true)
    self.statusMultiIcon:ClearIcons()
    self.cornerTagTexture:SetHidden(true)
    COLLECTIONS_BOOK_SINGLETON:UnregisterCallback("OnUpdateCooldowns", self.onUpdateCooldownsCallback)
    self:EndCooldown()
end
-- End ZO_Tile Overrides --
-- Begin ZO_ContextualActionsTile Overrides --
function ZO_CollectibleTile_Keyboard:OnControlHidden()
    self:OnMouseExit()
    ZO_ContextualActionsTile.OnControlHidden(self)
end
function ZO_CollectibleTile_Keyboard:OnFocusChanged(isFocused)
    ZO_ContextualActionsTile.OnFocusChanged(self, isFocused)
    local collectibleData = self.collectibleData
    if collectibleData then
        if not isFocused then
            ClearTooltip(ItemTooltip)
            if collectibleData:GetNotificationId() then
                RemoveCollectibleNotification(collectibleData:GetNotificationId())
            end
            if collectibleData:IsNew() then
                ClearCollectibleNewStatus(collectibleData:GetId())
            end
        end
        self:RefreshMouseoverVisuals()
    end
end
function ZO_CollectibleTile_Keyboard:SetHighlightHidden(hidden, instant)
    ZO_ContextualActionsTile.SetHighlightHidden(self, hidden, instant)
    if hidden or self.isCooldownActive then
        ZO_CollectibleTile_Keyboard_MouseOverIconAnimationProvider:PlayBackward(self:GetIconTexture(), instant)
    else
        ZO_CollectibleTile_Keyboard_MouseOverIconAnimationProvider:PlayForward(self:GetIconTexture(), instant)
    end
end
-- End ZO_ContextualActionsTile Overrides --
-- Begin ZO_ContextualActionsTile_Keyboard Overrides --
function ZO_CollectibleTile_Keyboard:LayoutPlatform(data)
    local collectibleData = ZO_COLLECTIBLE_DATA_MANAGER:GetCollectibleDataById(data.collectibleId)
    internalassert(collectibleData ~= nil)
    self.collectibleData = collectibleData
    self.actorCategory = data.actorCategory
    self.utilityWheel = data.utilityWheel
    self:SetCanFocus(true)
    -- Title
    self:SetTitle(collectibleData:GetFormattedName())
    -- Icon/Highlight
    local iconFile = collectibleData:GetIcon()
    local iconTexture = self:GetIconTexture()
    iconTexture:SetTexture(iconFile)
        
    local desaturation = (collectibleData:IsLocked() or collectibleData:IsBlocked(self:GetActorCategory())) and 1 or 0
    self:GetHighlightControl():SetDesaturation(desaturation)
    local isLocked = collectibleData:IsLocked()
    ZO_SetDefaultIconSilhouette(iconTexture, isLocked)
    iconTexture:SetDesaturation(desaturation)
    iconTexture:SetHidden(false)
    self:SetFavoriteIconVisibility(collectibleData:IsFavorite())
    -- Status
    local statusMultiIcon = self.statusMultiIcon
    statusMultiIcon:ClearIcons()
    if collectibleData:IsUnlocked() then
        local actorCategory = self:GetActorCategory()
        if collectibleData:IsActive(actorCategory) and not collectibleData:ShouldSuppressActiveState(actorCategory) then
            statusMultiIcon:AddIcon(ZO_CHECK_ICON)
            if collectibleData:WouldBeHidden() then
                statusMultiIcon:AddIcon("EsoUI/Art/Inventory/inventory_icon_hiddenBy.dds")
            end
        end
        if collectibleData:IsNew() then
            statusMultiIcon:AddIcon(ZO_KEYBOARD_NEW_ICON)
        end
    end
    statusMultiIcon:Show()
    -- Mouseover
    --Cooldowns
    self.cooldownIcon:SetTexture(iconFile)
    self.cooldownIconDesaturated:SetTexture(iconFile)
    self.cooldownTimeLabel:SetText("")
    COLLECTIONS_BOOK_SINGLETON:RegisterCallback("OnUpdateCooldowns", self.onUpdateCooldownsCallback)
end
function ZO_CollectibleTile_Keyboard:OnMouseUp(button, upInside)
    if upInside and button == MOUSE_BUTTON_INDEX_RIGHT then
        self:ShowMenu()
    end
end
function ZO_CollectibleTile_Keyboard:OnMouseDoubleClick(button)
    if button == MOUSE_BUTTON_INDEX_LEFT then
        local collectibleData = self.collectibleData
        if collectibleData and collectibleData:IsUsable(self:GetActorCategory()) then
            collectibleData:Use(self:GetActorCategory())
        end
    end
end
function ZO_CollectibleTile_Keyboard:OnDragStart(button)
    if button == MOUSE_BUTTON_INDEX_LEFT then
        if self.collectibleData and self.collectibleData:IsUnlocked() and self.utilityWheel and self.utilityWheel:IsActionTypeSupported(ACTION_TYPE_COLLECTIBLE) and GetCursorContentType() == MOUSE_CONTENT_EMPTY then
            PickupCollectible(self.collectibleData:GetId())
        end
    end
end
function ZO_CollectibleTile_Keyboard:SetFavoriteIconVisibility(visible)
    self.favoriteIcon:SetHidden(not visible)
end
-- End ZO_ContextualActionsTile_Keyboard Overrides --
-- Begin Global XML Functions --
    ZO_CollectibleTile_Keyboard:New(control)
end
-- End Global XML Functions --