Back to Home

ESO Lua File v100018

ingame/help/gamepad/help_mechanicassistance_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
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
local TICKET_STATE =
{
    FIELD_ENTRY = 1,
    START_SUBMISSION = 2,
}
local TICKET_VALIDATION_STATUS = 
{
    SUCCESS = true,
    FAILED_NO_DETAILS = GetString(SI_GAMEPAD_HELP_TICKET_FAILED_REPORT_WITHOUT_DETAILS),
    FAILED_NO_CATEGORY = GetString(SI_GAMEPAD_HELP_TICKET_FAILED_REPORT_WITHOUT_CATEGORY),
    FAILED_NO_DESCRIPTION = GetString(SI_GAMEPAD_HELP_TICKET_FAILED_REPORT_WITHOUT_DESCRIPTION),
}
ZO_MECHANIC_ASSISTANCE_TICKET_FIELD =
{
    CATEGORY = 1,
    DETAILS = 2,
    DESCRIPTION = 3,
    SUBMIT = 4,
}
local REFRESH_KEYBIND_STRIP = true
ZO_Help_MechanicAssistance_Gamepad = ZO_Gamepad_ParametricList_Screen:Subclass()
function ZO_Help_MechanicAssistance_Gamepad:New(...)
    return ZO_Gamepad_ParametricList_Screen.New(self, ...)
end
function ZO_Help_MechanicAssistance_Gamepad:Initialize(control, mechanicCategoriesData)
    local scene = ZO_Scene:New(self:GetSceneName(), SCENE_MANAGER)
    ZO_Gamepad_ParametricList_Screen.Initialize(self, control, ZO_GAMEPAD_HEADER_TABBAR_DONT_CREATE, nil, scene)
    local fragment = ZO_FadeSceneFragment:New(control)
    scene:AddFragment(fragment)
    
    self.itemList = ZO_Gamepad_ParametricList_Screen.GetMainList(self)
    self.savedFields = {}
    self.mechanicCategoriesData = mechanicCategoriesData
    self.headerDataFieldEntry = 
    {
        titleText = self:GetTitle(),
        messageText = GetString(SI_GAMEPAD_HELP_CUSTOMER_SERVICE_FIELD_ENTRY_MESSAGE),
    }
    self.headerDataStartSubmission =
    {
        titleText = GetString(SI_GAMEPAD_HELP_CUSTOMER_SERVICE_SUBMISSION_IN_PROGRESS_TITLE),
        messageText = GetString(SI_GAMEPAD_HELP_CUSTOMER_SERVICE_SUBMISSION_IN_PROGRESS_MESSAGE),
    }
    local function OnCustomerServiceTicketSubmitted()
        self:ResetTicket()
        self:ChangeTicketState(TICKET_STATE.FIELD_ENTRY)
    end
    control:RegisterForEvent(EVENT_CUSTOMER_SERVICE_TICKET_SUBMITTED, OnCustomerServiceTicketSubmitted)
end
function ZO_Help_MechanicAssistance_Gamepad:BuildList()
    self:AddSubmitEntry()
    self.itemList:Commit()
end
function ZO_Help_MechanicAssistance_Gamepad:AddCategoriesEntry()
    local entryData = ZO_GamepadEntryData:New("")
    entryData.header = GetString(SI_GAMEPAD_HELP_FIELD_TITLE_CATEGORY)
    entryData.fieldType = ZO_MECHANIC_ASSISTANCE_TICKET_FIELD.CATEGORY
    self.itemList:AddEntryWithHeader("ZO_Gamepad_Help_Dropdown_Item", entryData)
end
function ZO_Help_MechanicAssistance_Gamepad:AddDetailsEntry()
    local entryData = ZO_GamepadEntryData:New("")
    entryData.header = self.detailsHeader
    entryData.fieldType = ZO_MECHANIC_ASSISTANCE_TICKET_FIELD.DETAILS
    self.itemList:AddEntryWithHeader("ZO_Help_MechanicAssistance_Gamepad_DetailsItem", entryData)
end
function ZO_Help_MechanicAssistance_Gamepad:AddDescriptionEntry()
    local entryData = ZO_GamepadEntryData:New("")
    entryData.header = GetString(SI_CUSTOMER_SERVICE_DESCRIPTION)
    entryData.fieldType = ZO_MECHANIC_ASSISTANCE_TICKET_FIELD.DESCRIPTION
    self.itemList:AddEntryWithHeader("ZO_GamepadTextFieldItem_Multiline", entryData)
end
function ZO_Help_MechanicAssistance_Gamepad:AddSubmitEntry()
    local entryData = ZO_GamepadEntryData:New(GetString(SI_GAMEPAD_HELP_SUBMIT_TICKET), ZO_GAMEPAD_SUBMIT_ENTRY_ICON)
    entryData.fieldType = ZO_MECHANIC_ASSISTANCE_TICKET_FIELD.SUBMIT
    self.itemList:AddEntry("ZO_GamepadTextFieldSubmitItem", entryData)
end
function ZO_Help_MechanicAssistance_Gamepad:OnShowing()
    self:ChangeTicketState(TICKET_STATE.FIELD_ENTRY)
end
function ZO_Help_MechanicAssistance_Gamepad:OnShow()
end
function ZO_Help_MechanicAssistance_Gamepad:OnHiding()
    KEYBIND_STRIP:RemoveKeybindButtonGroup(self.keybindStripDescriptor)
end
function ZO_Help_MechanicAssistance_Gamepad:OnHide()
    if self.currentDropdown ~= nil then
        self.categoryDropdown:Deactivate(true)
    end
    self:ResetTicket()
end
function ZO_Help_MechanicAssistance_Gamepad:InitializeKeybindStripDescriptors()
    self.keybindStripDescriptorsByState = 
    {
        [TICKET_STATE.FIELD_ENTRY] = 
        {
            alignment = KEYBIND_STRIP_ALIGN_LEFT,
            -- Back
            KEYBIND_STRIP:GenerateGamepadBackButtonDescriptor(function() SCENE_MANAGER:HideCurrentScene() end, nil, SOUNDS.DIALOG_DECLINE),
            -- Select
            {
                name = function()
                    local targetData = self.itemList:GetTargetData()
                    local fieldType = targetData.fieldType
                    if fieldType == ZO_MECHANIC_ASSISTANCE_TICKET_FIELD.DETAILS then
                        return self.goToDetailsSourceKeybindText
                    elseif fieldType == ZO_MECHANIC_ASSISTANCE_TICKET_FIELD.SUBMIT then
                        return GetString(SI_GAMEPAD_HELP_SUBMIT_TICKET)
                    else
                        return GetString(SI_GAMEPAD_SELECT_OPTION)
                    end
                end,
                keybind = "UI_SHORTCUT_PRIMARY",
                callback = function()
                    local targetData = self.itemList:GetTargetData()
                    local fieldType = targetData.fieldType
                    if fieldType == ZO_MECHANIC_ASSISTANCE_TICKET_FIELD.CATEGORY then
                        self.categoryDropdown:Activate()
                    elseif fieldType == ZO_MECHANIC_ASSISTANCE_TICKET_FIELD.DETAILS then
                        self:GoToDetailsSourceScene()
                    elseif fieldType == ZO_MECHANIC_ASSISTANCE_TICKET_FIELD.DESCRIPTION then
                        local editBox = self.descriptionEditBox
                        if editBox:HasFocus() then
                            editBox:LoseFocus()
                        else
                            editBox:TakeFocus()
                        end
                    elseif fieldType == ZO_MECHANIC_ASSISTANCE_TICKET_FIELD.SUBMIT then
                        self:TrySubmitTicket()
                        PlaySound(SOUNDS.DIALOG_ACCEPT)
                    end
                end,
            },
        },
        [TICKET_STATE.START_SUBMISSION] = 
        {
            alignment = KEYBIND_STRIP_ALIGN_LEFT,
        },
    }
end
function ZO_Help_MechanicAssistance_Gamepad:AddKeybindsBasedOnState()
    KEYBIND_STRIP:RemoveKeybindButtonGroup(self.keybindStripDescriptor)
    self.keybindStripDescriptor = self.keybindStripDescriptorsByState[self.ticketState]
    
    KEYBIND_STRIP:AddKeybindButtonGroup(self.keybindStripDescriptor)
end
-- refreshKeybindStrip should only be used for internal state changes
function ZO_Help_MechanicAssistance_Gamepad:ChangeTicketState(ticketState, refreshKeybindStrip)
    if self.ticketState ~= ticketState then
        self.ticketState = ticketState
        if refreshKeybindStrip then
            self:AddKeybindsBasedOnState()
        end
        -- field entry
        if self.ticketState == TICKET_STATE.FIELD_ENTRY then
            self.headerData = self.headerDataFieldEntry
            self:BuildList()
        -- start submission
        elseif self.ticketState == TICKET_STATE.START_SUBMISSION then
            self.headerData = self.headerDataStartSubmission
            self.itemList:Clear()
            self.itemList:Commit()
            self:SubmitTicket()
        end
        ZO_GamepadGenericHeader_Refresh(self.header, self.headerData)
    end
end
function ZO_Help_MechanicAssistance_Gamepad:TrySubmitTicket()
    local result = self:ValidateTicketFields()
    if result == TICKET_VALIDATION_STATUS.SUCCESS then
        self:ChangeTicketState(TICKET_STATE.START_SUBMISSION, REFRESH_KEYBIND_STRIP)
    else
        ZO_Dialogs_ShowGamepadDialog("HELP_CUSTOMER_SERVICE_TICKET_FAILED_REASON", nil, {mainTextParams = { result }})
    end
end
function ZO_Help_MechanicAssistance_Gamepad:DetailsRequired()
    return false
end
function ZO_Help_MechanicAssistance_Gamepad:ValidateTicketFields()
    local selectedCategoryData = self.categoryDropdown:GetSelectedItemData()
    local savedDetails = self:GetSavedField(ZO_MECHANIC_ASSISTANCE_TICKET_FIELD.DETAILS)
    local savedCategoryIndex = self.savedFields[ZO_MECHANIC_ASSISTANCE_TICKET_FIELD.CATEGORY]
    local savedDescription = self.savedFields[ZO_MECHANIC_ASSISTANCE_TICKET_FIELD.DESCRIPTION]
    if savedCategoryIndex == self.mechanicCategoriesData.invalidCategory then
        return TICKET_VALIDATION_STATUS.FAILED_NO_CATEGORY
    elseif self:DetailsRequired() and (not savedDetails or savedDetails == "") then
        return TICKET_VALIDATION_STATUS.FAILED_NO_DETAILS
    elseif self.descriptionEditBox and (not savedDescription or savedDescription == "") then
        return TICKET_VALIDATION_STATUS.FAILED_NO_DESCRIPTION
    end
    return TICKET_VALIDATION_STATUS.SUCCESS
end
function ZO_Help_MechanicAssistance_Gamepad:SubmitTicket()
    local savedDescription = self.savedFields[ZO_MECHANIC_ASSISTANCE_TICKET_FIELD.DESCRIPTION]
    if savedDescription then
        SetCustomerServiceTicketBody(savedDescription)
    end
end
function ZO_Help_MechanicAssistance_Gamepad:ResetTicket()
    ZO_ClearTable(self.savedFields)
    self.itemList:RefreshVisible()
end
function ZO_Help_MechanicAssistance_Gamepad:GetCurrentTicketCategory()
    local categoryIndex = self.savedFields[ZO_MECHANIC_ASSISTANCE_TICKET_FIELD.CATEGORY]
    if categoryIndex then
        local categoryData = self.mechanicCategoriesData.ticketCategoryMap[categoryIndex]
        if categoryData then
            return categoryData.ticketCategory
        end
    end
end
function ZO_Help_MechanicAssistance_Gamepad:SetupList(list)
    ZO_Gamepad_ParametricList_Screen.SetupList(self, list)
    
    local function OnCategorySelectionChanged(control, name, entry, selectionChanged)
        self.savedFields[ZO_MECHANIC_ASSISTANCE_TICKET_FIELD.CATEGORY] = entry.index
    end
    local function SetupCategoryListEntry(control, data, selected, selectedDuringRebuild, enabled, activated)
        ZO_SharedGamepadEntry_OnSetup(control, data, selected, selectedDuringRebuild, enabled, active)
        local dropdown = control.dropdown
        dropdown:SetSortsItems(false)
        dropdown:ClearItems()
        local savedCategoryIndex = self.savedFields[ZO_MECHANIC_ASSISTANCE_TICKET_FIELD.CATEGORY]
        local savedDropdownIndex = 1
        local currentDropdownIndex = 1
        local mechanicCategoriesData = self.mechanicCategoriesData
        for i = mechanicCategoriesData.categoryEnumMin, mechanicCategoriesData.categoryEnumMax do
            local name = GetString(mechanicCategoriesData.categoryEnumStringPrefix, i)
            if name ~= nil then
                local entry = ZO_ComboBox:CreateItemEntry(name, OnCategorySelectionChanged)
                entry.index = i
                dropdown:AddItem(entry, ZO_COMBOBOX_SUPRESS_UPDATE)
                if savedCategoryIndex == i then
                    savedDropdownIndex = currentDropdownIndex
                end
                currentDropdownIndex = currentDropdownIndex + 1
            end
        end
        dropdown:UpdateItems()
        dropdown:SelectItemByIndex(savedDropdownIndex)
        self.categoryDropdown = dropdown
    end
    local function SetupDetailsListEntry(control, data, selected, reselectingDuringRebuild, enabled, active)
        data.text = self:GetDisplayedDetails()
        ZO_SharedGamepadEntry_OnSetup(control, data, selected, reselectingDuringRebuild, enabled, active)
    end
    local function OnDescriptionTextChanged(control)
        self.savedFields[ZO_MECHANIC_ASSISTANCE_TICKET_FIELD.DESCRIPTION] = control:GetText()
    end
    local function SetupDescriptionFieldListEntry(control, data, selected, reselectingDuringRebuild, enabled, active)
        ZO_SharedGamepadEntry_OnSetup(control, data, selected, reselectingDuringRebuild, enabled, active)
        local editContainer = control:GetNamedChild("TextField")
        local editBox = editContainer:GetNamedChild("Edit")
        editBox:SetHandler("OnTextChanged", OnDescriptionTextChanged)
        local savedText = self.savedFields[ZO_MECHANIC_ASSISTANCE_TICKET_FIELD.DESCRIPTION]
        editBox:SetText(savedText or "")
        ZO_EditDefaultText_Initialize(editBox, GetString(SI_CUSTOMER_SERVICE_DEFAULT_DESCRIPTION_TEXT_ASK_FOR_HELP))
        control.highlight:SetHidden(not selected)
        self.descriptionEditBox = editBox
    end
    list:AddDataTemplateWithHeader("ZO_Gamepad_Help_Dropdown_Item", SetupCategoryListEntry, ZO_GamepadMenuEntryTemplateParametricListFunction, nil, "ZO_GamepadMenuEntryFullWidthHeaderTemplate", nil, "Categories")
    list:AddDataTemplateWithHeader("ZO_Help_MechanicAssistance_Gamepad_DetailsItem", SetupDetailsListEntry, ZO_GamepadMenuEntryTemplateParametricListFunction, nil, "ZO_GamepadMenuEntryFullWidthHeaderTemplate", nil, "Details")
    list:AddDataTemplateWithHeader("ZO_GamepadTextFieldItem_Multiline", SetupDescriptionFieldListEntry, ZO_GamepadMenuEntryTemplateParametricListFunction, nil, "ZO_GamepadMenuEntryFullWidthHeaderTemplate", nil, "Desc")
end
function ZO_Help_MechanicAssistance_Gamepad:OnSelectionChanged(list, selectedData, oldSelectedData)
    if self.descriptionEditBox then
        self.descriptionEditBox:LoseFocus()
    end
end
function ZO_Help_MechanicAssistance_Gamepad:GetSceneName()
    assert(false) --Must be overriden
end
function ZO_Help_MechanicAssistance_Gamepad:GetTitle()
    assert(false) --Must be overriden
end
function ZO_Help_MechanicAssistance_Gamepad:SetGoToDetailsSourceKeybindText(keybindText)
    self.goToDetailsSourceKeybindText = keybindText
end
function ZO_Help_MechanicAssistance_Gamepad:SetDetailsHeader(detailsHeader)
    self.detailsHeader = detailsHeader
end
function ZO_Help_MechanicAssistance_Gamepad:GetDetailsInstructions()
    return self.detailsInstructions
end
function ZO_Help_MechanicAssistance_Gamepad:SetDetailsInstructions(detailsInstructions)
    self.detailsInstructions = detailsInstructions
end
function ZO_Help_MechanicAssistance_Gamepad:GoToDetailsSourceScene()
    assert(false) --Must be overriden
end
function ZO_Help_MechanicAssistance_Gamepad:RegisterDetails()
    assert(false) -- Must be overriden
end
function ZO_Help_MechanicAssistance_Gamepad:GetDisplayedDetails()
    local savedDetails = self.savedFields[ZO_MECHANIC_ASSISTANCE_TICKET_FIELD.DETAILS]
    return savedDetails or self.detailsInstructions
end
function ZO_Help_MechanicAssistance_Gamepad:InitWithDetails(detailsData)
    self:ResetTicket()
    self:SetDetailsData(detailsData)
    self:ChangeTicketState(TICKET_STATE.FIELD_ENTRY)
end
function ZO_Help_MechanicAssistance_Gamepad:SetDetailsData(detailsData)
    self.savedFields[ZO_MECHANIC_ASSISTANCE_TICKET_FIELD.DETAILS] = detailsData
    self.itemList:RefreshVisible()
end
function ZO_Help_MechanicAssistance_Gamepad:GetSavedField(ticketField)
    return self.savedFields[ticketField]
end
function ZO_Help_MechanicAssistance_Gamepad:SetSavedField(ticketField, fieldData, refreshVisible)
    self.savedFields[ticketField] = fieldData
    if refreshVisible then
        self.itemList:RefreshVisible()
    end
end