Back to Home

ESO Lua File v101049

libraries/zo_scene/zo_scenemanager_base.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
ZO_REMOTE_SCENE_NO_SCENE_IDENTIFIER = "INVALID_SCENE"
ZO_SceneManager_Base = ZO_InitializingCallbackObject:Subclass()
function ZO_SceneManager_Base:Initialize()
    self.scenes = {}
    self.sceneGroups = {}
    self.callWhen = {}
        
    self:SetBaseScene(ZO_Scene:New("empty", self):GetName())
    EVENT_MANAGER:RegisterForEvent("SceneManager", EVENT_FOLLOWER_SCENE_FINISHED_FRAGMENT_TRANSITION, function(eventId, ...) self:OnRemoteSceneFinishedFragmentTransition(...) end)
end
-- scenes
function ZO_SceneManager_Base:Add(scene)
    local name = scene:GetName()
    self.scenes[name] = scene
end
function ZO_SceneManager_Base:GetScene(sceneName)
    return self.scenes[sceneName]
end
-- Parent scene
-- Setting a parent scene will constrain the fragments in this scene manager to only show when the parent scene is showing.
function ZO_SceneManager_Base:GetParentScene()
    return self.parentScene
end
function ZO_SceneManager_Base:SetParentScene(parentScene)
    if parentScene ~= self.parentScene then
        if self.parentScene then
            self.parentScene:UnregisterCallback("StateChange", self.onParentSceneStateChangedCallback)
        end
        if parentScene then
            if not self.onParentSceneStateChangedCallback then
                self.onParentSceneStateChangedCallback = function(oldState, newState)
                    if self.currentScene then
                        local wasShowing = oldState == SCENE_SHOWING or oldState == SCENE_SHOWN
                        local isShowing = newState == SCENE_SHOWING or newState == SCENE_SHOWN
                        if wasShowing ~= isShowing then
                            --The part of ZO_SceneFragment:ComputeIfFragmentShouldShow() that cares about the parent scene only cares about the broad strokes of showing/shown vs. hiding/hidden.
                            self.currentScene:RefreshFragments()
                        end
                    end
                end
            end
            self.parentScene = parentScene
            parentScene:RegisterCallback("StateChange", self.onParentSceneStateChangedCallback)
        end
        if self.currentScene then
            self.currentScene:RefreshFragments()
        end
    end
end
-- scene groups
function ZO_SceneManager_Base:AddSceneGroup(sceneGroupName, sceneGroup)
    self.sceneGroups[sceneGroupName] = sceneGroup
end
function ZO_SceneManager_Base:GetSceneGroup(sceneGroupName)
    return self.sceneGroups[sceneGroupName]
end
function ZO_SceneManager_Base:IsSceneGroupShowing(sceneGroupName)
    local sceneGroup = self:GetSceneGroup(sceneGroupName)
    if sceneGroup then
        return sceneGroup:IsShowing()
    end
    return false
end
-- call whens
function ZO_SceneManager_Base:CallWhen(sceneName, state, func)
    local sceneCallbackList = self.callWhen[sceneName]
    if sceneCallbackList == nil then
        sceneCallbackList = {}
        self.callWhen[sceneName] = sceneCallbackList
    end
    table.insert(sceneCallbackList, {state = state, func = func})
end
function ZO_SceneManager_Base:TriggerCallWhens(sceneName, state)
    local sceneCallbackList = self.callWhen[sceneName]
    if sceneCallbackList then
        local i = 1
        while i <= #sceneCallbackList do
            local callWhenInfo = sceneCallbackList[i]
            if callWhenInfo.state == state then
                callWhenInfo.func()
                table.remove(sceneCallbackList, i)
            else
                i = i + 1
            end
        end
    end
end
-- fragments
function ZO_SceneManager_Base:AddFragment(fragment)
    if self.currentScene then
        local state = self.currentScene:GetState()
        if state == SCENE_SHOWING or state == SCENE_SHOWN then
            self.currentScene:AddTemporaryFragment(fragment)
        end
    end
end
function ZO_SceneManager_Base:RemoveFragment(fragment)
    if self.currentScene then
        local state = self.currentScene:GetState()
        if state ~= SCENE_HIDDEN then
            self.currentScene:RemoveTemporaryFragment(fragment)
        end
    end
end
function ZO_SceneManager_Base:RemoveFragmentImmediately(fragment)
    if fragment:GetHideOnSceneHidden() then
        --The fragment may already be in the hiding state waiting for scene hidden when this happens. So we enable show/hide time updates so it can re-try hiding now that it doesn't have to wait on scene hidden.
        fragment:SetAllowShowHideTimeUpdates(true)
        fragment:SetHideOnSceneHidden(false)
        SCENE_MANAGER:RemoveFragment(fragment)
        fragment:SetHideOnSceneHidden(true)
        fragment:SetAllowShowHideTimeUpdates(false)
    else
        SCENE_MANAGER:RemoveFragment(fragment)
    end
end
function ZO_SceneManager_Base:AddFragmentGroup(fragmentGroup)
    for i, fragment in ipairs(fragmentGroup) do
        self:AddFragment(fragment)
    end
end
function ZO_SceneManager_Base:RemoveFragmentGroup(fragmentGroup)
    for _, fragment in pairs(fragmentGroup) do
        self:RemoveFragment(fragment)
    end
end
function ZO_SceneManager_Base:RemoveFragmentGroupImmediately(fragmentGroup)
    for _, fragment in pairs(fragmentGroup) do
        self:RemoveFragmentImmediately(fragment)
    end
end
-- base scene, next scene, and current scene
function ZO_SceneManager_Base:SetBaseScene(sceneName)
    self.baseScene = self.scenes[sceneName]
end
function ZO_SceneManager_Base:GetBaseScene()
    return self.baseScene
end
function ZO_SceneManager_Base:SetNextScene(nextScene, push, nextSceneClearsSceneStack, numScenesNextScenePops)
    self.nextScene = nextScene
    if nextScene then
    end
end
function ZO_SceneManager_Base:GetNextScene()
    return self.nextScene
end
function ZO_SceneManager_Base:ClearNextScene()
    self:SetNextScene()
end
function ZO_SceneManager_Base:SetCurrentScene(currentScene)
    self.currentScene = currentScene
end
function ZO_SceneManager_Base:GetCurrentScene()
    return self.currentScene
end
function ZO_SceneManager_Base:GetCurrentSceneName()
    if self.currentScene then
        return self.currentScene:GetName()
    end
    return nil
end
function ZO_SceneManager_Base:IsCurrentSceneGamepad()
    if self.currentScene then
        return self.currentScene:WasShownInGamepadPreferredMode()
    else
        return false
    end
end
-- Scene logic
function ZO_SceneManager_Base:ShowScene(scene, sequenceNumber)
    if scene:IsRemoteScene() then
        scene:SetSequenceNumber(sequenceNumber)
    end
    scene:SetState(SCENE_SHOWING)
end
function ZO_SceneManager_Base:HideScene(scene, sequenceNumber)
    if scene:IsRemoteScene() then
        scene:SetSequenceNumber(sequenceNumber)
    end
    scene:SetState(SCENE_HIDING)
end
function ZO_SceneManager_Base:ShowBaseScene()
    if self.baseScene then
        if not self.currentScene or (self.currentScene ~= self.baseScene and self.nextScene ~= self.baseScene) then
            self:Show(self.baseScene:GetName())
        end
    end
end
function ZO_SceneManager_Base:Toggle(sceneName)
    if self.currentScene and self.currentScene:GetName() == sceneName and self:IsShowing(sceneName) then
        self:ShowBaseScene()
    else
        self:Show(sceneName)
    end
end
function ZO_SceneManager_Base:IsShowing(sceneName)
    local currentScene = self:GetCurrentScene()
    if currentScene and currentScene:GetName() == sceneName and (currentScene:GetState() == SCENE_SHOWING or currentScene:GetState() == SCENE_SHOWN) then
        return true
    else
        return false
    end
end
function ZO_SceneManager_Base:IsShowingBaseScene()
    if self.baseScene then
        return self:IsShowing(self.baseScene:GetName())
    end
    return false
end
function ZO_SceneManager_Base:IsShowingNext(sceneName)
    if self.nextScene then
        return self.nextScene:GetName() == sceneName
    else
        return false
    end
end
function ZO_SceneManager_Base:IsShowingBaseSceneNext()
    if self.baseScene then
        return self:IsShowingNext(self.baseScene:GetName())
    end
    return false
end
function ZO_SceneManager_Base:OnNextSceneRemovedFromQueue(oldNextScene, newNextScene)
    oldNextScene:OnRemovedFromQueue(newNextScene)
end
function ZO_SceneManager_Base:GetPreviousSceneName()
    if self.previousScene then
        return self.previousScene:GetName()
    end
    return nil
end
function ZO_SceneManager_Base:OnSceneStateChange(scene, oldState, newState)
    if scene == self:GetCurrentScene() then
        if oldState == SCENE_HIDING and newState == SCENE_HIDDEN then
            self:OnSceneStateHidden(scene)
        elseif newState == SCENE_HIDING then
            self:OnSceneStateHiding(scene)
        elseif newState == SCENE_SHOWN then
            self:OnSceneStateShown(scene)
        end
    end
    self:TriggerCallWhens(scene:GetName(), newState)
    self:FireCallbacks("SceneStateChanged", scene, oldState, newState)
end
function ZO_SceneManager_Base:OnSceneStateHiding(scene)
    local lastSceneGroup = scene:GetSceneGroup()
    local nextSceneGroup
    if self.nextScene then
        nextSceneGroup = self.nextScene:GetSceneGroup()
    end
    if lastSceneGroup ~= nextSceneGroup and lastSceneGroup ~= nil then
        lastSceneGroup:SetState(SCENE_GROUP_HIDING)
    end
end
function ZO_SceneManager_Base:OnSceneStateHidden(scene)
    -- To be overridden
end
function ZO_SceneManager_Base:OnSceneStateShown(scene)
    local sceneGroup = scene:GetSceneGroup()
    if sceneGroup then
        sceneGroup:SetState(SCENE_GROUP_SHOWN)
    end
end
function ZO_SceneManager_Base:OnRemoteSceneFinishedFragmentTransition(sceneChangeOrigin, sceneName, sequenceNumber)
    local scene = self:GetScene(sceneName)
    if scene and scene:IsRemoteScene() and (sceneChangeOrigin ~= ZO_REMOTE_SCENE_CHANGE_ORIGIN) then
        scene:OnRemoteSceneFinishedFragmentTransition(sequenceNumber)
    end
end
function ZO_SceneManager_Base:OnPreSceneStateChange(scene, currentState, nextState)
    -- optional override
end
function ZO_SceneManager_Base:HideCurrentScene(bypassHideSceneConfirmationReason)
    if self.currentScene then
        self:Hide(self.currentScene:GetName(), bypassHideSceneConfirmationReason)
    end
end
function ZO_SceneManager_Base:Push(sceneName)
    assert(false) -- This function should be overridden
end
function ZO_SceneManager_Base:SwapCurrentScene(newCurrentSceneName)
    assert(false) -- This function should be overridden
end
function ZO_SceneManager_Base:Show(sceneName)
    assert(false) -- This function should be overridden
end
function ZO_SceneManager_Base:Hide(sceneName)
    assert(false) -- This function should be overridden
end
function ZO_SceneManager_Base:RequestShowLeaderBaseScene()
    assert(false) -- This function should be overridden
end
function ZO_SceneManager_Base:SendFragmentCompleteMessage()
    assert(false) -- This function should be overridden
end
-- We don't have a scene stack in ZO_SceneManager_Base, but
-- there are still some scenes/fragments using these functions,
-- so we'll maintain these functions as shared for now
function ZO_SceneManager_Base:IsSceneOnStack(sceneName)
    return false -- Optional override
end
function ZO_SceneManager_Base:WasSceneOnStack(sceneName)
    return false -- Optional override
end
function ZO_SceneManager_Base:WasSceneOnTopOfStack(sceneName)
    return false -- Optional override
end