Back to Home

ESO Lua File v100035

common/gamepad/zo_gamepadentrydata.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
--[[ Gamepad Visual Data Object ]]--
ZO_GamepadEntryData = ZO_DataSourceObject:Subclass()
function ZO_GamepadEntryData:New(...)
    local entryData = ZO_DataSourceObject.New(self)
    entryData:Initialize(...)
    return entryData
end
function ZO_GamepadEntryData:Initialize(text, icon, selectedIcon, highlight, isNew)
    self.text = text
    self.numIcons = 0
    self:AddIcon(icon, selectedIcon)
    self.highlight = highlight
    self:SetNew(isNew)
    self.fontScaleOnSelection = true
    self.alphaChangeOnSelection = false
    self.showBarEvenWhenUnselected = true
    self.enabled = true
    self.subLabelTemplate = "ZO_GamepadMenuEntrySubLabelTemplateMain"
end
function ZO_GamepadEntryData:InitializeInventoryVisualData(itemData)
    -- Need this on self so that it can be used for a compare by EqualityFunction in ParametricScrollList,
    -- SharedInventory modifies the dataSource's uniqueId before the GamepadEntryData is rebuilt,
    -- so by copying it over, we can still have access to the old one during the Equality check
    self.uniqueId = itemData.uniqueId
    self:SetDataSource(itemData)
    self:AddIcon(itemData.icon)
    if not itemData.questIndex then
        -- self.quality is deprecated, included here for addon backwards compatibility
        self:SetNameColors(self:GetColorsBasedOnQuality(self.displayQuality or self.quality))  --quest items are only white
    end
    self.cooldownIcon = itemData.icon or itemData.iconFile
    self:SetFontScaleOnSelection(false)    --item entries don't grow on selection
end
function ZO_GamepadEntryData:InitializeStoreVisualData(itemData)
    if itemData.entryType == STORE_ENTRY_TYPE_ANTIQUITY_LEAD then
        -- self.quality is deprecated, included here for addon backwards compatibility
        self:SetNameColors(self:GetColorsBasedOnAntiquityQuality(self.displayQuality or self.quality))
    end
    self.meetsUsageRequirement = itemData.meetsRequirementsToBuy and itemData.meetsRequirementsToEquip
    self.currencyType1 = itemData.currencyType1
end
function ZO_GamepadEntryData:InitializeTradingHouseVisualData(itemData)
    self:SetSubLabelColors(ZO_NORMAL_TEXT)
end
function ZO_GamepadEntryData:InitializeItemImprovementVisualData(bag, index, stackCount, displayQuality)
    self.bag = bag
    self.index = index
    self:SetStackCount(stackCount)
    self.displayQuality = displayQuality
    -- self.quality is deprecated, included here for addon backwards compatibility
    self.quality = displayQuality
    self:SetFontScaleOnSelection(false)    --item entries don't grow on selection
    if displayQuality then
        self:SetNameColors(self:GetColorsBasedOnQuality(displayQuality))
    else
       self:SetNameColors(ZO_NORMAL_TEXT)
    end
end
function ZO_GamepadEntryData:AddSubLabels(subLabels)
    for _, subLabel in ipairs(subLabels) do
        self:AddSubLabel(subLabel)
    end
end
function ZO_GamepadEntryData:InitializeImprovementKitVisualData(bag, index, stackCount, displayQuality, subLabels)
    self:InitializeItemImprovementVisualData(bag, index, stackCount, displayQuality)
    self:AddSubLabels(subLabels)
    self:SetSubLabelColors(ZO_NORMAL_TEXT)
end
function ZO_GamepadEntryData:InitializeCraftingInventoryVisualData(bagId, slotIndex, stackCount, customSortData, customBestCategoryNameFunction, slotData)
    self:SetStackCount(stackCount)
    self.bagId = bagId
    self.slotIndex = slotIndex
    local itemName = GetItemName(self.bagId, self.slotIndex)
    local icon, _, sellPrice, meetsUsageRequirements, _, _, _, functionalQuality, displayQuality = GetItemInfo(self.bagId, self.slotIndex)
    self:AddIcon(icon)
    self.pressedIcon = self.pressedIcon or icon
    self.sellPrice = sellPrice
    self.meetsUsageRequirement = meetsUsageRequirements
    self.functionalQuality = functionalQuality
    self.displayQuality = displayQuality
    -- self.quality is deprecated, included here for addon backwards compatibility
    self.quality = displayQuality
    self.itemType = GetItemType(self.bagId, self.slotIndex)
    self.customSortData = customSortData
    if slotData then
        ZO_ShallowTableCopy(slotData, self)
    end
    else
        self.bestItemCategoryName = zo_strformat(GetString("SI_ITEMTYPE", self.itemType))
    end
    self.subLabelSelectedColor = self.selectedNameColor
    self:SetFontScaleOnSelection(false)    --item entries don't grow on selection
end
local LOOT_QUEST_COLOR = ZO_ColorDef:New(GetInterfaceColor(INTERFACE_COLOR_TYPE_ITEM_TOOLTIP, ITEM_TOOLTIP_COLOR_QUEST_ITEM_NAME))
function ZO_GamepadEntryData:InitializeLootVisualData(lootId, count, displayQuality, value, isQuest, isStolen, lootType)
    self.lootId = lootId
    self.displayQuality = displayQuality
    -- self.quality is deprecated, included here for addon backwards compatibility
    self.quality = displayQuality
    self.value = value
    self.isQuest = isQuest
    self.isStolen = isStolen
    self.lootType = lootType
    self:SetFontScaleOnSelection(false)    --item entries don't grow on selection
    if isQuest then
        self:SetNameColors(LOOT_QUEST_COLOR, LOOT_QUEST_COLOR)
    elseif lootType == LOOT_TYPE_ANTIQUITY_LEAD then
        self:SetNameColors(self:GetColorsBasedOnAntiquityQuality(displayQuality))
    elseif displayQuality then
        self:SetNameColors(self:GetColorsBasedOnQuality(displayQuality))
    else
       self:SetNameColors(ZO_NORMAL_TEXT)
    end
end
--[[ Setters for specific fields and options ]]--
function ZO_GamepadEntryData:SetHeader(header)
    self.header = header
end
function ZO_GamepadEntryData:GetHeader()
    return self.header
end
function ZO_GamepadEntryData:SetNew(isNew)
    self.brandNew = isNew
end
function ZO_GamepadEntryData:IsNew()
    if type(self.brandNew) == "function" then
        return self.brandNew(self)
    else
        return self.brandNew
    end
end
function ZO_GamepadEntryData:SetText(text)
    self.text = text
end
function ZO_GamepadEntryData:GetText()
    return self.text
end
function ZO_GamepadEntryData:SetFontScaleOnSelection(active)
    self.fontScaleOnSelection = active
end
function ZO_GamepadEntryData:SetAlphaChangeOnSelection(active)
    self.alphaChangeOnSelection = active
end
function ZO_GamepadEntryData:SetMaxIconAlpha(alpha)
    self.maxIconAlpha = alpha
end
function ZO_GamepadEntryData:SetIgnoreTraitInformation(ignoreTraitInformation)
    self.ignoreTraitInformation = ignoreTraitInformation
end
function ZO_GamepadEntryData:GetColorsBasedOnQuality(displayQuality)
    local selectedNameColor = GetItemQualityColor(displayQuality)
    local unselectedNameColor = GetDimItemQualityColor(displayQuality)
    return selectedNameColor, unselectedNameColor
end
function ZO_GamepadEntryData:GetColorsBasedOnAntiquityQuality(antiquityQuality)
    local selectedNameColor = GetAntiquityQualityColor(antiquityQuality)
    local unselectedNameColor = GetDimAntiquityQualityColor(antiquityQuality)
    return selectedNameColor, unselectedNameColor
end
function ZO_GamepadEntryData:SetCooldown(remainingMs, durationMs)
    self.timeCooldownRecordedMs = GetFrameTimeMilliseconds()
    self.cooldownRemainingMs = remainingMs
    self.cooldownDurationMs = durationMs
end
function ZO_GamepadEntryData:GetCooldownDurationMs()
    return self.cooldownDurationMs or 0
end
function ZO_GamepadEntryData:GetCooldownTimeRemainingMs()
    if self.timeCooldownRecordedMs and self.cooldownRemainingMs then
        local timeOffsetMs = GetFrameTimeMilliseconds() - self.timeCooldownRecordedMs
        return self.cooldownRemainingMs - timeOffsetMs
    end
    return 0
end
function ZO_GamepadEntryData:IsOnCooldown()
    return self:GetCooldownDurationMs() > 0 and self:GetCooldownTimeRemainingMs() > 0
end
function ZO_GamepadEntryData:AddIconSubtype(subtypeName, texture)
    if texture then
        if not self[subtypeName] then
            self[subtypeName] = {}
            for i = 1, self.numIcons do
                table.insert(self[subtypeName], false)
            end
        end
        table.insert(self[subtypeName], texture)
    end
end
function ZO_GamepadEntryData:GetNumIcons()
    return self.numIcons
end
function ZO_GamepadEntryData:GetSubtypeIcon(subtypeName, index)
    if self[subtypeName] then
        return self[subtypeName][index] or nil
    end
end
function ZO_GamepadEntryData:GetIcon(index, selected)
    if selected then
        local selectedIcon = self:GetSubtypeIcon("iconsSelected", index)
        if selectedIcon then
            return selectedIcon
        end
    end
    return self:GetSubtypeIcon("iconsNormal", index)
end
function ZO_GamepadEntryData:AddIcon(normalTexture, selectedTexture)
    if normalTexture or selectedTexture then
        self:AddIconSubtype("iconsNormal", normalTexture)
        self:AddIconSubtype("iconsSelected", selectedTexture)
        self.numIcons = self.numIcons + 1
    end
end
function ZO_GamepadEntryData:ClearIcons()
    if self.iconsNormal then
        ZO_ClearNumericallyIndexedTable(self.iconsNormal)
    end
    if self.iconsSelected then
        ZO_ClearNumericallyIndexedTable(self.iconsSelected)
    end
end
function ZO_GamepadEntryData:GetNameColor(selected)
    if self.enabled then
        if selected then
            return self.selectedNameColor or ZO_GAMEPAD_SELECTED_COLOR
        else
            return self.unselectedNameColor or ZO_GAMEPAD_UNSELECTED_COLOR
        end
    else
        return self:GetNameDisabledColor(selected)
    end
end
function ZO_GamepadEntryData:SetIconTintOnSelection(selected)
    self:SetIconTint(selected and ZO_GAMEPAD_SELECTED_COLOR, selected and ZO_GAMEPAD_UNSELECTED_COLOR)
end
function ZO_GamepadEntryData:GetSubLabelColor(selected)
    if selected then
        return self.selectedSubLabelColor or ZO_GAMEPAD_SELECTED_COLOR
    else
        return self.unselectedSubLabelColor or ZO_GAMEPAD_UNSELECTED_COLOR
    end
end
function ZO_GamepadEntryData:SetNameColors(selectedColor, unselectedColor)
    self.selectedNameColor = selectedColor
    self.unselectedNameColor = unselectedColor
end
function ZO_GamepadEntryData:SetSubLabelColors(selectedColor, unselectedColor)
    self.selectedSubLabelColor = selectedColor
    self.unselectedSubLabelColor = unselectedColor
end
function ZO_GamepadEntryData:GetSubLabelTemplate()
    return self.subLabelTemplate
end
function ZO_GamepadEntryData:SetSubLabelTemplate(template)
    self.subLabelTemplate = template
end
function ZO_GamepadEntryData:SetIconTint(selectedColor, unselectedColor)
    self.selectedIconTint = selectedColor
    self.unselectedIconTint = unselectedColor
end
-- If this is set for one data entry in a list for a given data type, it must be set for all entries in that list for that data type
-- Otherwise it will not be reset when the control gets recycled
function ZO_GamepadEntryData:SetIconDesaturation(desaturation)
    self.iconDesaturation = desaturation
end
-- See comment for SetIconDesaturation
function ZO_GamepadEntryData:SetIconSampleProcessingWeight(type, weight)
    if not self.textureSampleProcessingWeights then
        self.textureSampleProcessingWeights = {}
    end
    self.textureSampleProcessingWeights[type] = weight
end
-- See comment for SetIconDesaturation
function ZO_GamepadEntryData:SetIconSampleProcessingWeightTable(typeToWeightTable)
    self.textureSampleProcessingWeights = typeToWeightTable
end
-- See comment for SetIconDesaturation
function ZO_GamepadEntryData:SetIconColor(color)
    self.iconColor = color
end
function ZO_GamepadEntryData:AddSubLabel(text)
    if not self.subLabels then
        self.subLabels = {}
    end
    table.insert(self.subLabels, text)
end
function ZO_GamepadEntryData:ClearSubLabels()
    if self.subLabels then
        ZO_ClearNumericallyIndexedTable(self.subLabels)
    end
end
function ZO_GamepadEntryData:SetShowUnselectedSublabels(showUnselectedSublabels)
    self.showUnselectedSublabels = showUnselectedSublabels
end
function ZO_GamepadEntryData:SetChannelActive(isChannelActive)
    self.isChannelActive = isChannelActive
end
function ZO_GamepadEntryData:SetLocked(isLocked)
    self.isLocked = isLocked
end
function ZO_GamepadEntryData:SetSelected(isSelected)
    self.isSelected = isSelected
end
function ZO_GamepadEntryData:SetChannelActive(isChannelActive)
    self.isChannelActive = isChannelActive
end
-- Functions for displaying an entry as disabled
function ZO_GamepadEntryData:SetEnabled(isEnabled)
    self.enabled = isEnabled
end
function ZO_GamepadEntryData:IsEnabled()
    return self.enabled
end
function ZO_GamepadEntryData:SetDisabledNameColors(selectedColor, unselectedColor)
    self.selectedNameDisabledColor = selectedColor
    self.unselectedNameDisabledColor = unselectedColor
end
function ZO_GamepadEntryData:SetDisabledIconTint(selectedColor, unselectedColor)
    self.selectedIconDisabledTint = selectedColor
    self.unselectedIconDisabledTint = unselectedColor
end
function ZO_GamepadEntryData:GetNameDisabledColor(selected)
    if selected then
        return self.selectedNameDisabledColor or ZO_GAMEPAD_DISABLED_SELECTED_COLOR
    else
        return self.unselectedNameDisabledColor or ZO_GAMEPAD_DISABLED_UNSELECTED_COLOR
    end
end
function ZO_GamepadEntryData:SetIconDisabledTintOnSelection(selected)
    self:SetDisabledIconTint(selected and ZO_GAMEPAD_DISABLED_SELECTED_COLOR, selected and ZO_GAMEPAD_DISABLED_UNSELECTED_COLOR)
end
function ZO_GamepadEntryData:SetModifyTextType(modifyTextType)
    self.modifyTextType = modifyTextType
end
function ZO_GamepadEntryData:SetIsHiddenByWardrobe(isHidden)
    self.isHiddenByWardrobe = isHidden
end
function ZO_GamepadEntryData:SetStackCount(stackCount)
    self.stackCount = stackCount
end
function ZO_GamepadEntryData:SetCooldownIcon(icon)
    self.cooldownIcon = icon
end
function ZO_GamepadEntryData:SetCanLevel(canLevel)
    self.canLevel = canLevel
end
function ZO_GamepadEntryData:CanLevel()
    if self.canLevel then
        if type(self.canLevel) == "function" then
            return self.canLevel()
        else
            return self.canLevel
        end
    else
        return false
    end
end
function ZO_GamepadEntryData:SetBarValues(min, max, value)
    self.barMin = min
    self.barMax = max
    self.barValue = value
end
function ZO_GamepadEntryData:SetShowBarEvenWhenUnselected(showBarEvenWhenUnselected)
    self.showBarEvenWhenUnselected = showBarEvenWhenUnselected
end