Back to Home

ESO Lua File v100029

pregame/accountlogin/gamepad/legalagreementsscreen_gamepad.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
--[[
Legal docs providers abstract out the platform specific details of obtaining non-eula legal docs, they should implement:
ShouldShowEULA() -> bool
NextLegalDoc() -> LegalDocData or nil
PreviousLegalDoc() -> LegalDocData or nil
OnDocsFinished()
]]
--
-- Heron legal docs behave as PC EULAs do and are loaded from disk
local ZO_HeronLegalDocsProvider = ZO_Object:Subclass()
function ZO_HeronLegalDocsProvider:New(...)
    local object = ZO_Object.New(self)
    return object
end
function ZO_HeronLegalDocsProvider:ShouldShowEULA()
    return self:GetNextEULAType() ~= nil
end
function ZO_HeronLegalDocsProvider:GetNextEULAType()
    for _, eulaType in ipairs(ZO_PREGAME_EULAS) do
        if ShouldShowEULA(eulaType) then
            return eulaType
        end
    end
    return nil
end
function ZO_HeronLegalDocsProvider:NextLegalDoc()
    local eulaType = self:GetNextEULAType()
    if eulaType then
        local eulaText, agreeText, disagreeText, hasAgreed, eulaTitle, readCheckText = GetEULADetails(eulaType)
        if eulaTitle == "" then
            eulaTitle = GetString(SI_WINDOW_TITLE_EULA)
        end
        return
        {
            name = eulaTitle,
            text = eulaText,
            positiveButtonPrompt = agreeText,
            negativeButtonPrompt = disagreeText,
            acceptFunction = function() AgreeToEULA(eulaType) end,
        }
    end
    return nil
end
function ZO_HeronLegalDocsProvider:PreviousLegalDoc()
    -- not supported
    return nil
end
function ZO_HeronLegalDocsProvider:OnDocsFinished()
    -- log in
end
-- On consoles, EULAs are loaded from disk, but other types of docs need to be asynchronously fetched from services. We only fetch the docs that have not yet been accepted.
local ZO_ConsoleLegalDocsProvider = ZO_Object:Subclass()
function ZO_ConsoleLegalDocsProvider:New(...)
    local object = ZO_Object.New(self)
    object:Initialize(...)
    return object
end
function ZO_ConsoleLegalDocsProvider:Initialize()
    self.haveFetchedRemoteDocs = false
    self.nextLegalDocIndex = nil
    EVENT_MANAGER:RegisterForEvent("ZO_ConsoleLegalDocsProvider", EVENT_FETCHED_LEGAL_DOCS, function()
        self.haveFetchedRemoteDocs = true
        self.nextLegalDocIndex = 1
        EVENT_MANAGER:UnregisterForEvent("ZO_ConsoleLegalDocsProvider", EVENT_FETCHED_LEGAL_DOCS)
        PregameStateManager_SetState("LegalAgreements")
    end)
end
function ZO_ConsoleLegalDocsProvider:ShouldShowEULA()
    return ShouldShowEULA(EULA_TYPE_PREGAME_EULA)
end
function ZO_ConsoleLegalDocsProvider:NextLegalDoc()
    if self:ShouldShowEULA() then
        local eulaText, agreeText, disagreeText = GetEULADetails(ET_PREGAME_EULA)
        return
        {
            name = GetString(SI_WINDOW_TITLE_EULA), 
            text = eulaText,
            positiveButtonPrompt = agreeText,
            negativeButtonPrompt = disagreeText,
            acceptFunction = function() AgreeToEULA() end,
        }
    elseif self.haveFetchedRemoteDocs and self.nextLegalDocIndex <= GetNumLegalDocs() then
        local i = self.nextLegalDocIndex
        self.nextLegalDocIndex = self.nextLegalDocIndex + 1
        return
        {
            name = GetLegalDocTitle(i),
            text = GetLegalDocContent(i),
            positiveButtonPrompt = GetString(SI_CONSOLE_LEGAL_BUTTON_AGREE),
            negativeButtonPrompt = GetString(SI_CONSOLE_LEGAL_BUTTON_DISAGREE),
            acceptFunction = function() end,
        }
    end
    return nil
end
function ZO_ConsoleLegalDocsProvider:PreviousLegalDoc()
    if self.haveFetchedRemoteDocs and self.nextLegalDocIndex > 1 then
        self.nextLegalDocIndex = self.nextLegalDocIndex - 1
        return self:NextLegalDoc()
    end
    return nil
end
function ZO_ConsoleLegalDocsProvider:OnDocsFinished()
    if not self.haveFetchedRemoteDocs then
        -- we need to attempt to log in, which will fail us if there are any remote docs we need to accept. To do this we'll just advance the state
        -- then we will fetch those docs and restart the flow
    else
        -- We have already fetched the docs and accepted at this point, but remote legal docs require an extra confirmation step before we consider them to be accepted, then we'll advance
        ZO_Dialogs_ShowGamepadDialog("LEGAL_AGREEMENT_UPDATED_ACKNOWLEDGE")
    end
end
local MIN_SCROLL_VALUE = 0
local MAX_SCROLL_VALUE = 100
---------------------------------------
-- The main class.
local ZO_LegalAgreementsScreen_Gamepad = ZO_Object:Subclass()
function ZO_LegalAgreementsScreen_Gamepad:New(...)
    local legalAgreements = ZO_Object.New(self)
    legalAgreements:Initialize(...)
    return legalAgreements
end
function ZO_LegalAgreementsScreen_Gamepad:Initialize(control)
    self.control = control
    self.scrollAvailableAtMS = nil
    self.docData = nil
    if IsConsoleUI() then
        self.docProvider = ZO_ConsoleLegalDocsProvider:New()
    elseif IsHeronUI() then
        self.docProvider = ZO_HeronLegalDocsProvider:New()
    elseif IsGamepadUISupported() then
        internalassert(false, "platform eulas not supported")
    end
    local legalAgreementsScreenFragment = ZO_FadeSceneFragment:New(control)
    LEGAL_AGREEMENTS_GAMEPAD_SCENE = ZO_Scene:New("LegalAgreementsScreen_Gamepad", SCENE_MANAGER)
    LEGAL_AGREEMENTS_GAMEPAD_SCENE:AddFragment(legalAgreementsScreenFragment)
    local function StateChanged(oldState, newState)
        if newState == SCENE_SHOWING then
            DIRECTIONAL_INPUT:Activate(self, self.control)
            self:PerformDeferredInitialize()
            KEYBIND_STRIP:RemoveDefaultExit()
            KEYBIND_STRIP:AddKeybindButtonGroup(self.keybindStripDescriptor)
            self:UpdateCurrentText()
        elseif newState == SCENE_HIDING then
            DIRECTIONAL_INPUT:Deactivate(self)
            KEYBIND_STRIP:RemoveKeybindButtonGroup(self.keybindStripDescriptor)
            KEYBIND_STRIP:RestoreDefaultExit()
        end
    end
    LEGAL_AGREEMENTS_GAMEPAD_SCENE:RegisterCallback("StateChange", StateChanged)
end
function ZO_LegalAgreementsScreen_Gamepad:PerformDeferredInitialize()
    if self.initialized then return end
    self.initialized = true
    local EULAContainer = self.control:GetNamedChild("EULAContainer")
    local container = EULAContainer:GetNamedChild("Container")
    self.scroll = container:GetNamedChild("Scroll")
    self.animation, self.timeline = ZO_CreateScrollAnimation(self)
    self.title = EULAContainer:GetNamedChild("TitleContainer"):GetNamedChild("Title")
    self.divider = EULAContainer:GetNamedChild("Divider")
    self.date = EULAContainer:GetNamedChild("Date")
    self.text = self.scroll:GetNamedChild("Child"):GetNamedChild("Text")
    self.scrollValue = MIN_SCROLL_VALUE
    self.useFadeGradient = true
    ZO_ScrollAnimation_MoveWindow(self, self.scrollValue)
    ZO_UpdateScrollFade(self.useFadeGradient, self.scroll, ZO_SCROLL_DIRECTION_VERTICAL)
    --[[
This is a hack. Without this, the mask on the EULA isn't correct until the player first scrolls it.
This seems to be something to do with the fact that there are no scroll extents in the EULA at this point (the text is still downloading?)
The slider animation has to be modified directly to fix the bug, and only this scroll function seems to have the right low-level access to the scroll system to do what is needed.
]]
end
function ZO_LegalAgreementsScreen_Gamepad:UpdateDirectionalInput()
    if self.scrollAvailableAtMS and self.scrollAvailableAtMS > GetGameTimeMilliseconds() then
        self.scrollValue = MIN_SCROLL_VALUE
    else
        self.scrollAvailableAtMS = nil
        local inputY = DIRECTIONAL_INPUT:GetY(ZO_DI_LEFT_STICK, ZO_DI_DPAD)
        if inputY ~= 0 then
            ZO_ScrollRelative(self, -inputY * 100)
        end
    end
end
function ZO_LegalAgreementsScreen_Gamepad:UpdateCurrentText()
    -- disable scrolling while transitioning to next doc so that the doc isn't scrolled all the way to the end when it's not displayed
    self.scrollAvailableAtMS = GetGameTimeMilliseconds() + 100
    self.scrollValue = MIN_SCROLL_VALUE
    local currentData = self.docData
    if currentData then
        self.title:SetText(currentData.name)
        self.text:SetText(currentData.text)
    end
    KEYBIND_STRIP:UpdateKeybindButtonGroup(self.keybindStripDescriptor)
end
function ZO_LegalAgreementsScreen_Gamepad:InitKeybindingDescriptor()
    self.keybindStripDescriptor = 
    {
        -- Decline
        {
            alignment = KEYBIND_STRIP_ALIGN_LEFT,
            name = function()
                local currentData = self.docData
                if currentData ~= nil and currentData.negativeButtonPrompt ~= nil then
                    return currentData.negativeButtonPrompt
                end
                -- Should never occur.
                return ""
            end,
            keybind = "UI_SHORTCUT_NEGATIVE",
            callback = function()
                PlaySound(SOUNDS.NEGATIVE_CLICK)
                self.docData = self.docProvider:PreviousLegalDoc()
                if not self.docData then
                    PREGAME_INITIAL_SCREEN_GAMEPAD:ShowError(GetString(SI_CONSOLE_LEGAL_DECLINE_HEADER), GetString(SI_CONSOLE_LEGAL_DECLINE_PROMPT))
                else
                    self:UpdateCurrentText()
                end
            end,
        },
        -- Accept
        {
            alignment = KEYBIND_STRIP_ALIGN_LEFT,
            name = function()
                local currentData = self.docData
                if currentData ~= nil and currentData.positiveButtonPrompt ~= nil and currentData.positiveButtonPrompt ~= "" then
                    return currentData.positiveButtonPrompt
                end
                -- Should never occur.
                return ""
            end,
            keybind = "UI_SHORTCUT_PRIMARY",
            callback = function()
                PlaySound(SOUNDS.POSITIVE_CLICK)
                self.docData.acceptFunction()
                self.docData = self.docProvider:NextLegalDoc()
                if self.docData then
                    self:UpdateCurrentText()
                else
                    self.docProvider:OnDocsFinished()
                end
            end,
        },
    }
end
function ZO_LegalAgreementsScreen_Gamepad:ShouldShowEULA()
    return self.docProvider:ShouldShowEULA()
end
function ZO_LegalAgreementsScreen_Gamepad:ShowEULA()
    self.docData = self.docProvider:NextLegalDoc()
    SCENE_MANAGER:Show("LegalAgreementsScreen_Gamepad")
end
function ZO_LegalAgreementsScreen_Gamepad:ShowConsoleFetchedDocs()
    self.docData = self.docProvider:NextLegalDoc()
    SCENE_MANAGER:Show("LegalAgreementsScreen_Gamepad")
end
---------------------------------------
-- Global functions.
    LEGAL_AGREEMENT_SCREEN_GAMEPAD = ZO_LegalAgreementsScreen_Gamepad:New(control)
end