ESO Lua File v100015

libraries/zo_scene/zo_scene.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
-----------------------
--Scene Stack Fragments
-----------------------
ZO_StackFragmentGroup = ZO_Object:Subclass()
function ZO_StackFragmentGroup:New(fragment, object)
    local group = ZO_Object.New(self)
    group.fragments = {}
    group.objects = {}
    group.activateAll = false
    group:Add(fragment, object)
    return group
end
function ZO_StackFragmentGroup:Add(fragment, object)
    if(fragment) then
        table.insert(self.fragments, fragment)
        table.insert(self.objects, object or false)
    end
end
function ZO_StackFragmentGroup:SetOnActivatedCallback(onActivatedCallback)
end
function ZO_StackFragmentGroup:SetOnDeactivatedCallback(onDeactivatedCallback)
end
function ZO_StackFragmentGroup:SetActivateAll(activateAll)
    self.activateAll = activateAll
end
function ZO_StackFragmentGroup:GetFragments()
    return self.fragments
end
function ZO_StackFragmentGroup:SetActive(active)
    for i, object in ipairs(self.objects) do
        if(object) then
            object:SetActive(active)
            if(not self.activateAll) then
                break
            end
        end
    end
    if active then
        if self.onActivatedCallback then
            self.onActivatedCallback()
        end
    else
        if self.onDeactivatedCallback then
            self.onDeactivatedCallback()
        end
    end
end
----------
--Scene
----------
ZO_Scene = ZO_CallbackObject:Subclass()
SCENE_SHOWN = "shown"
SCENE_HIDDEN = "hidden"
SCENE_SHOWING = "showing"
SCENE_HIDING = "hiding"
function ZO_Scene:New(...)
    local scene = ZO_CallbackObject.New(self)
    scene:Initialize(...)
    return scene
end
function ZO_Scene:Initialize(name, sceneManager)
    self.name = name
    self.state = SCENE_HIDDEN
    self.sceneManager = sceneManager
    self.fragments = {}
    sceneManager:Add(self)
end
function ZO_Scene:AddFragment(fragment)
    if not self:HasFragment(fragment) then
        table.insert(self.fragments, fragment)
        fragment:SetSceneManager(self.sceneManager)
        fragment:Refresh()
    end
end
function ZO_Scene:RemoveFragment(fragment)
    for i = 1, #self.fragments do
        if(self.fragments[i] == fragment) then
            table.remove(self.fragments, i)
            fragment:Refresh()
            break
        end
    end
end
function ZO_Scene:HasFragment(fragment)
    for i = 1, #self.fragments do
        if(self.fragments[i] == fragment) then
            return true
        end
    end
    return false
end
function ZO_Scene:AddTemporaryFragment(fragment)
    if not self:HasFragment(fragment) then
        if(not self.temporaryFragments) then
            self.temporaryFragments = {}
        end
        self.temporaryFragments[fragment] = true
        self:AddFragment(fragment)
        fragment:SetSceneManager(self.sceneManager)
        fragment:Refresh()
    end
end
function ZO_Scene:RemoveTemporaryFragment(fragment)
    if self.temporaryFragments and self.temporaryFragments[fragment] then
        self.temporaryFragments[fragment] = nil
        self:RemoveFragment(fragment)
        fragment:Refresh()
    end
end
function ZO_Scene:HasStackFragmentGroup(stackFragmentGroup)
    if(self.stackFragmentGroups) then
        for i = 1, #self.stackFragmentGroups do
            if(self.stackFragmentGroups[i] == stackFragmentGroup) then
                return true
            end
        end
    end
    return false
end
function ZO_Scene:PushStackFragmentGroup(stackFragmentGroup, isBase)
    if not self:HasStackFragmentGroup(stackFragmentGroup) then
        local fragments = stackFragmentGroup:GetFragments()
        for i, fragment in ipairs(fragments) do
            if self:HasFragment(fragment) then
                return
            end
        end
        if(not self.stackFragmentGroups) then
            self.stackFragmentGroups = {}
        end
        if(#self.stackFragmentGroups > 0) then
            self.stackFragmentGroups[#self.stackFragmentGroups]:SetActive(false)
        end
        table.insert(self.stackFragmentGroups, stackFragmentGroup)
        stackFragmentGroup:SetActive(true)
        if isBase then
            self.stackFragmentGroupBaseIndex = #self.stackFragmentGroups
        end
        
        for i, fragment in ipairs(fragments) do
            self:AddFragment(fragment)
            fragment:SetSceneManager(self.sceneManager)
            fragment:Refresh()
        end
    end
end
function ZO_Scene:PushBaseStackFragmentGroup(stackFragmentGroup)
    self:PushStackFragmentGroup(stackFragmentGroup, true)
end
function ZO_Scene:PopStackFragmentGroup()
    if(self.stackFragmentGroups and #self.stackFragmentGroups > 0) then
        local stackFragmentGroup = self.stackFragmentGroups[#self.stackFragmentGroups]
        stackFragmentGroup:SetActive(false)
        if self.stackFragmentGroupBaseIndex == #self.stackFragmentGroups then
            self.sceneManager:HideCurrentScene()
        else
            local fragments = stackFragmentGroup:GetFragments()
            for i, fragment in ipairs(fragments) do
                self:RemoveFragment(fragment)
                fragment:Refresh()
            end
            local hideCurrentSceneFromBaseFragment = self.stackFragmentGroupBaseIndex == #self.stackFragmentGroups
            self.stackFragmentGroups[#self.stackFragmentGroups] = nil
            if(#self.stackFragmentGroups > 0) then
                self.stackFragmentGroups[#self.stackFragmentGroups]:SetActive(true)
            end
        end
    else
        self.sceneManager:HideCurrentScene()
    end
end
function ZO_Scene:AddFragmentGroup(fragments)
    for _, fragment in pairs(fragments) do
        self:AddFragment(fragment)
    end
end
function ZO_Scene:RemoveFragmentGroup(fragments)
    for _, fragment in pairs(fragments) do
        self:RemoveFragment(fragment)
    end
end
function ZO_Scene:GetName()
    return self.name
end
function ZO_Scene:GetState()
    return self.state
end
function ZO_Scene:IsShowing()
    return self.state == SCENE_SHOWN or self.state == SCENE_SHOWING
end
function ZO_Scene:HasFragmentWithCategory(category)
    return self:GetFragmentWithCategory(category) ~= nil
end
function ZO_Scene:GetFragmentWithCategory(category)
    for _, fragment in ipairs(self.fragments) do
        local fragmentCategory = fragment:GetCategory()
        if(fragmentCategory == category) then
            return fragment
        end
    end
end
function ZO_Scene:SetState(newState)
    if self.state ~= newState then
        local oldState = self.state
        self.sceneManager:OnPreSceneStateChange(self, oldState, newState)
        self.state = newState
        if(self.state == SCENE_SHOWING) then
            self.wasShownInGamepadPreferredMode = IsInGamepadPreferredMode()
        end
        self:FireCallbacks("StateChange", oldState, newState)
        self.sceneManager:OnSceneStateChange(self, oldState, newState)
        if(self.state == SCENE_HIDDEN) then
            self:RemoveTemporaryFragments()
            if(not SCENE_MANAGER:IsSceneOnStack(self.name)) then
                self:RemoveStackFragmentGroups()
            end
        end
        self:RefreshFragments()
    end
end
function ZO_Scene:OnRemovedFromQueue()
    --Meant to be overriden
end
function ZO_Scene:RemoveTemporaryFragments()
    if(self.temporaryFragments) then
        for tempFragment in pairs(self.temporaryFragments) do
            self:RemoveFragment(tempFragment)
            tempFragment:Refresh()
        end
        self.temporaryFragments = nil
    end
end
function ZO_Scene:RemoveStackFragmentGroups()
    if(self.stackFragmentGroups) then
        for i, stackFragmentGroup in ipairs(self.stackFragmentGroups) do
            stackFragmentGroup:SetActive(false)
            local fragments = stackFragmentGroup:GetFragments()
            for i, fragment in ipairs(fragments) do
                self:RemoveFragment(fragment)
                fragment:Refresh()
            end
        end
        ZO_ClearNumericallyIndexedTable(self.stackFragmentGroups)
    end        
end
function ZO_Scene:RefreshFragmentsHelper(...)
    for i = 1, select("#", ...) do
        local fragment = select(i, ...)
        fragment:Refresh()
    end
end
function ZO_Scene:RefreshFragments()
    --wait until after we have refreshed all fragments to evaluate if we're done
    self.allowEvaluateTransitionComplete = false
    --Protect against fragments being added or removed during iteration by unpacking onto the stack
    self:RefreshFragmentsHelper(unpack(self.fragments))
    self.allowEvaluateTransitionComplete = true
end
function ZO_Scene:OnSceneFragmentStateChange(fragment, oldState, newState)
    if(self.allowEvaluateTransitionComplete) then
    end
end
function ZO_Scene:HideAllHideOnSceneEndFragments(...)
    local allHiddenImmediately = true 
    for i = 1, select("#", ...) do
        local fragment = select(i, ...)
        if(fragment:GetHideOnSceneHidden()) then                
            fragment:Hide()
            if(fragment:GetState() ~= SCENE_FRAGMENT_HIDDEN) then
                allHiddenImmediately = false
            end
        end
    end
    return allHiddenImmediately
end
function ZO_Scene:IsTransitionComplete()
    local hasHideOnSceneHiddenFragments = false
    if(self.state == SCENE_SHOWING or self.state == SCENE_HIDING) then
        for _, fragment in ipairs(self.fragments) do
            local fragmentState = fragment:GetState()
            if(self.state == SCENE_SHOWING) then
                --If we waited for a fragment with a conditional to show before considering the scene shown we may wait forever,
                --because the conditional may not be true. So we just ignore them on show.
                if(not fragment:HasConditional() and fragmentState ~= SCENE_FRAGMENT_SHOWN) then
                    return false
                end
            elseif(self.state == SCENE_HIDING) then
                if(fragmentState == SCENE_FRAGMENT_HIDING) then
                    if(fragment:GetHideOnSceneHidden()) then
                        hasHideOnSceneHiddenFragments = true
                    else
                        return false
                    end
                end
            end
        end
    end
    if(hasHideOnSceneHiddenFragments) then
        --dont evaluate whether we should transition as a result of hiding a fragment here
        --since we're already evaluating that right now and will return the correct result
        self.allowEvaluateTransitionComplete = false
        --Protect against fragments being added or removed during iteration by unpacking onto the stack
        local allHiddenImmediately = self:HideAllHideOnSceneEndFragments(unpack(self.fragments))
        self.allowEvaluateTransitionComplete = true
        return allHiddenImmediately
    end
    return true
end
function ZO_Scene:DetermineIfTransitionIsComplete()
    if(self.state == SCENE_SHOWING) then
        if(self:IsTransitionComplete()) then
            self:SetState(SCENE_SHOWN)
        end
    elseif(self.state == SCENE_HIDING) then
        if(self:IsTransitionComplete()) then
            self:SetState(SCENE_HIDDEN)
        end
    end
end
function ZO_Scene:GetSceneGroup()
    return self.sceneGroup
end
function ZO_Scene:SetSceneGroup(sceneGroup)
    self.sceneGroup = sceneGroup
end
function ZO_Scene:WasShownInGamepadPreferredMode()
    return self.wasShownInGamepadPreferredMode
end
function ZO_Scene:IsRemoteScene()
    return false
end
----------
--Remote Scene
----------
ZO_RemoteScene = ZO_Scene:Subclass()
function ZO_RemoteScene:New(...)
    local scene = ZO_Scene.New(self, ...)
    return scene
end
function ZO_RemoteScene:Initialize(name, sceneManager)
    ZO_Scene.Initialize(self, name, sceneManager)
    self:SetSendsStateChanges(true)
end
function ZO_RemoteScene:SetState(newState)
    if self.state ~= newState then
        if self.sendStateChanges then
            if newState == SCENE_SHOWING then
                ChangeRemoteSceneVisibility(self.name, REMOTE_SCENE_STATE_CHANGE_TYPE_SHOW, ZO_REMOTE_SCENE_CHANGE_ORIGIN)
            elseif newState == SCENE_HIDING then
                ChangeRemoteSceneVisibility(self.name, REMOTE_SCENE_STATE_CHANGE_TYPE_HIDE, ZO_REMOTE_SCENE_CHANGE_ORIGIN)
            end
        end
        -- call parent SetState after we send out message becase it could
        -- trigger another call to SetState and the events would be out of order
        ZO_Scene.SetState(self, newState)
    end
end
function ZO_RemoteScene:SetSendsStateChanges(sendsState)
    self.sendStateChanges = sendsState
end
function ZO_RemoteScene:GetSendsStateChanges()
    return self.sendStateChanges
end
function ZO_RemoteScene:IsRemoteScene()
    return true
end
function ZO_RemoteScene:PushRemoteScene()
    if self.sendStateChanges then
        ChangeRemoteSceneVisibility(self.name, REMOTE_SCENE_STATE_CHANGE_TYPE_PUSH, ZO_REMOTE_SCENE_CHANGE_ORIGIN)
    end
end
function ZO_RemoteScene:SwapRemoteScene()
    if self.sendStateChanges then
        ChangeRemoteSceneVisibility(self.name, REMOTE_SCENE_STATE_CHANGE_TYPE_SWAP, ZO_REMOTE_SCENE_CHANGE_ORIGIN)
    end
end