Back to Home

ESO Lua File v101050

publicallingames/itempreview/previewscreen_shared.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
-- Previewable Reward Data --
ZO_PreviewableRewardData = ZO_InitializingObject:Subclass()
ZO_PreviewableRewardData:MUST_IMPLEMENT("CanPreviewReward")
-- Preview Screen --
ZO_PREVIEW_SCREEN_REWARD_DATA_PREVIEW_TYPES =
{
    NONE = 0,
    ACTIVE_PREVIEW = 1,
    QUICK_PREVIEW = 2,
}
ZO_PreviewScreen_Shared = ZO_DeferredInitializingObject:Subclass()
ZO_PreviewScreen_Shared:MUST_IMPLEMENT("InitializeKeybindStripDescriptor")
ZO_PreviewScreen_Shared:MUST_IMPLEMENT("GetControlByPreviewableRewardData")
ZO_PreviewScreen_Shared:MUST_IMPLEMENT("PreviewRewardList")
ZO_PreviewScreen_Shared:MUST_IMPLEMENT("EndPreviewRewardList")
function ZO_PreviewScreen_Shared:OnDeferredInitialize()
end
function ZO_PreviewScreen_Shared:ActivePreviewRewardInternal(rewardId)
    if CanPreviewReward(rewardId) then
        SYSTEMS:GetObject("itemPreview"):PreviewReward(rewardId)
        self:SetPreviewControlsHidden(false)
    else
        self:SetPreviewControlsHidden(true)
    end
end
function ZO_PreviewScreen_Shared:QuickPreviewRewardInternal(rewardId)
    if CanPreviewReward(rewardId) then
        SYSTEMS:GetObject("itemPreview"):PreviewReward(rewardId)
    end
end
function ZO_PreviewScreen_Shared:BeginActivePreviewInternal(previousPreviewableRewardData, previewableRewardData)
    local rewardId = previewableRewardData:GetRewardId()
    if GetRewardType(rewardId) == REWARD_ENTRY_TYPE_REWARD_LIST then
        local control = self:GetControlByPreviewableRewardData(previewableRewardData)
        if not control then
            return
        end
        self:EndQuickPreview()
        self:PreviewRewardList(rewardId, control)
        self.activePreviewableRewardData = nil
        return
    end
    -- Order matters
    self.activePreviewableRewardData = previewableRewardData
    local newPreviewRewardData = self:GetCurrentPreviewableRewardData()
    self:OnPreviewedPreviewableRewardDataChanged(previousPreviewableRewardData, newPreviewRewardData)
end
function ZO_PreviewScreen_Shared:BeginPreview(previewType, previewableRewardData)
    if not previewableRewardData:CanPreviewReward() then
        return
    end
    local previousPreviewableRewardData = self:GetCurrentPreviewableRewardData()
    if previewType == ZO_PREVIEW_SCREEN_REWARD_DATA_PREVIEW_TYPES.QUICK_PREVIEW then
        self:BeginQuickPreviewInternal(previousPreviewableRewardData, previewableRewardData)
    elseif previewType == ZO_PREVIEW_SCREEN_REWARD_DATA_PREVIEW_TYPES.ACTIVE_PREVIEW then
        self:BeginActivePreviewInternal(previousPreviewableRewardData, previewableRewardData)
    else
        internalassert(false, "Invalid previewType: ZO_PREVIEW_SCREEN_REWARD_DATA_PREVIEW_TYPES value specified is invalid.")
    end
end
function ZO_PreviewScreen_Shared:BeginQuickPreview(previewableRewardData)
    if not (previewableRewardData:CanPreviewReward() and self:CanQuickPreview()) then
        return
    end
    -- Order matters
    self.quickPreviewTimeoutSeconds = nil
    self.queuedQuickPreviewableRewardData = previewableRewardData
    self.queuedQuickPreviewableRewardDataStartTimeSeconds = GetFrameTimeSeconds() + QUICK_PREVIEW_DELAY_SECONDS
end
function ZO_PreviewScreen_Shared:BeginQuickPreviewInternal(previousPreviewableRewardData, previewableRewardData)
    local rewardId = previewableRewardData:GetRewardId()
    if GetRewardType(rewardId) == REWARD_ENTRY_TYPE_REWARD_LIST then
        local tile = self:GetControlByPreviewableRewardData(previewableRewardData)
        self:PreviewRewardList(rewardId, tile)
        return
    end
    if not self:CanQuickPreview() then
        self:EndQuickPreview()
        return
    end
    self.quickPreviewableRewardData = previewableRewardData
    local newPreviewRewardData = self:GetCurrentPreviewableRewardData()
    self:OnPreviewedPreviewableRewardDataChanged(previousPreviewableRewardData, newPreviewRewardData)
end
function ZO_PreviewScreen_Shared:EndActivePreview()
    if self.activePreviewableRewardData then
        local previousPreviewableRewardData = self.activePreviewableRewardData
        self.activePreviewableRewardData = nil
        self:EndPreviewInternal()
        self:OnPreviewedPreviewableRewardDataChanged(previousPreviewableRewardData, nil)
        self:OnEndActivePreview()
    end
end
function ZO_PreviewScreen_Shared:EndPreviewInternal()
    SYSTEMS:GetObject("itemPreview"):ClearPreviewCollection()
end
function ZO_PreviewScreen_Shared:EndPreview()
    local currentPreviewType = self:GetCurrentPreviewType()
    if currentPreviewType == ZO_PREVIEW_SCREEN_REWARD_DATA_PREVIEW_TYPES.ACTIVE_PREVIEW then
        self:EndActivePreview()
    elseif currentPreviewType == ZO_PREVIEW_SCREEN_REWARD_DATA_PREVIEW_TYPES.QUICK_PREVIEW then
        self:EndQuickPreview()
    else
        self:EndPreviewInternal()
    end
end
function ZO_PreviewScreen_Shared:ClearQueuedQuickPreview()
    self.queuedQuickPreviewableRewardData = nil
    self.queuedQuickPreviewableRewardDataStartTimeSeconds = nil
end
function ZO_PreviewScreen_Shared:ClearQuickPreview()
    local previousPreviewableRewardData = self:GetCurrentPreviewableRewardData()
    self.quickPreviewableRewardData = nil
    self.quickPreviewTimeoutSeconds = nil
    local newPreviewableRewardData = self:GetCurrentPreviewableRewardData()
    self:OnPreviewedPreviewableRewardDataChanged(previousPreviewableRewardData, newPreviewableRewardData)
end
function ZO_PreviewScreen_Shared:EndQuickPreview()
    if self.quickPreviewableRewardData or self.queuedQuickPreviewableRewardDataStartTimeSeconds then
        -- Order matters
        self:ClearQueuedQuickPreview()
        self:ClearQuickPreview()
        if self:GetCurrentPreviewType() ~= ZO_PREVIEW_SCREEN_REWARD_DATA_PREVIEW_TYPES.ACTIVE_PREVIEW then
            self:EndPreviewInternal()
        end
    end
end
function ZO_PreviewScreen_Shared:GetCurrentPreviewType()
    if self.activePreviewableRewardData then
        return ZO_PREVIEW_SCREEN_REWARD_DATA_PREVIEW_TYPES.ACTIVE_PREVIEW
    end
    if self.quickPreviewableRewardData or self.quickPreviewableRewardDataStartTimeSeconds then
        return ZO_PREVIEW_SCREEN_REWARD_DATA_PREVIEW_TYPES.QUICK_PREVIEW
    end
    return ZO_PREVIEW_SCREEN_REWARD_DATA_PREVIEW_TYPES.NONE
end
function ZO_PreviewScreen_Shared:GetCurrentPreviewableRewardData()
    local previewType = self:GetCurrentPreviewType()
    if previewType == ZO_PREVIEW_SCREEN_REWARD_DATA_PREVIEW_TYPES.ACTIVE_PREVIEW then
        return self.activePreviewableRewardData
    end
    
    if previewType == ZO_PREVIEW_SCREEN_REWARD_DATA_PREVIEW_TYPES.QUICK_PREVIEW then
        return self.quickPreviewableRewardData or self.queuedQuickPreviewableRewardData
    end
    return nil
end
function ZO_PreviewScreen_Shared:UpdateKeybinds()
    if self.scene:IsShowing() then
        if self.areKeybindsAdded then
            KEYBIND_STRIP:UpdateKeybindButtonGroup(self.keybindStripDescriptor)
        else
            KEYBIND_STRIP:AddKeybindButtonGroup(self.keybindStripDescriptor)
            self.areKeybindsAdded = true
        end
    else
        if self.areKeybindsAdded then
            KEYBIND_STRIP:RemoveKeybindButtonGroup(self.keybindStripDescriptor)
            self.areKeybindsAdded = false
        end
    end
end
function ZO_PreviewScreen_Shared:OnBeginActivePreview()
    -- Can be overridden
end
function ZO_PreviewScreen_Shared:OnEndActivePreview()
    -- Can be overridden
end
function ZO_PreviewScreen_Shared:OnBeginQuickPreview()
    -- Can be overridden
end
function ZO_PreviewScreen_Shared:OnEndQuickPreview()
    -- Can be overridden
end
function ZO_PreviewScreen_Shared:OnPreviewedPreviewableRewardDataChanged(previousPreviewableRewardData, newPreviewableRewardData)
    if previousPreviewableRewardData ~= newPreviewableRewardData then
        if previousPreviewableRewardData then
            self:SetIsPreviewableRewardPreviewing(previousPreviewableRewardData, false)
        end
        if newPreviewableRewardData then
            self:SetIsPreviewableRewardPreviewing(newPreviewableRewardData, true)
        end
    end
end
function ZO_PreviewScreen_Shared:SetPreviewControlsHidden(hidden)
    local previewSystem = SYSTEMS:GetObject("itemPreview")
    if hidden then
        previewSystem:SetActionControlsHidden(true)
        previewSystem:SetVariationControlsHidden(true)
    else
        -- Restores the preview action carousel and/or variaton controls if appropriate to do so.
        previewSystem:SetupActionCarousel()
        previewSystem:SetupVariationControls()
    end
end
function ZO_PreviewScreen_Shared:SetIsPreviewableRewardPreviewing(previewableRewardData, isPreviewing)
    local control = self:GetControlByPreviewableRewardData(previewableRewardData)
    if not control then
        return
    end
    control.object:GetReward():SetPreviewing(isPreviewing)
end
-- Indicates whether this scene should retain the current preview when hidden.
function ZO_PreviewScreen_Shared:ShouldRetainPreview()
    return false
end
function ZO_PreviewScreen_Shared:OnHiding()
    if self:GetCurrentPreviewType() ~= ZO_PREVIEW_SCREEN_REWARD_DATA_PREVIEW_TYPES.NONE and self:ShouldRetainPreview() then
        -- The upcoming scene will need the current preview, if any, to remain visible.
        self:SetPreviewControlsHidden(false)
    else
        self:EndPreview()
    end
end