Back to Home

ESO Lua File v100032

internalingame/antiquitydigging/antiquitydigging.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
local ACCEPT = true
local REJECT = false
local ANTIQUITY_DIGGING_FANFARE_LONG_DELAY_MS = 2000
local ANTIQUITY_DIGGING_FANFARE_SHORT_DELAY_MS = 500
ZO_Dialogs_RegisterCustomDialog("CONFIRM_STOP_ANTIQUITY_DIGGING",
{
    mustChoose = true,
    gamepadInfo =
    {
        dialogType = GAMEPAD_DIALOGS.BASIC,
    },
    title =
    {
        text = SI_ANTIQUITY_DIGGING_CONFIRM_EXIT_DIALOG_TITLE
    },
    mainText =
    {
        text = function()
            if IsDiggingAntiquityUnearthed() then
                return GetString(SI_ANTIQUITY_DIGGING_CONFIRM_EXIT_DIALOG_VICTORY_DESCRIPTION)
            else
                return GetString(SI_ANTIQUITY_DIGGING_CONFIRM_EXIT_DIALOG_ABORT_DESCRIPTION)
            end
        end
    },
    setup = function()
        ANTIQUITY_DIGGING:RefreshInputState()
    end,
    finishedCallback = function()
        ANTIQUITY_DIGGING:RefreshInputState()
    end,
    buttons =
    {
        {
            text = SI_DIALOG_ACCEPT,
            callback = function()
                if IsDiggingAntiquityUnearthed() then
                    AntiquityDiggingExitResponse(REJECT)
                    FinishAntiquityDiggingEarly()
                else
                    AntiquityDiggingExitResponse(ACCEPT)
                end
            end
        },
        {
            text = SI_DIALOG_DECLINE,
            callback = function()
                AntiquityDiggingExitResponse(REJECT)
            end
        },
    }
})
----------------------
-- Antiquity Digging --
----------------------
local KEYBOARD_STYLE =
{
    keybindLabelFont = "ZoFontWinH2",
}
local GAMEPAD_STYLE =
{
    keybindLabelFont = "ZoFontGamepad22",
}
ZO_AntiquityDigging = ZO_Object:Subclass()
function ZO_AntiquityDigging:New(...)
    local object = ZO_Object.New(self)
    object:Initialize(...)
    return object
end
function ZO_AntiquityDigging:Initialize(control)
    self.control = control
    self.keybindContainer = control:GetNamedChild("KeybindContainer")
    self.keybindContainerTimeline = ANIMATION_MANAGER:CreateTimelineFromVirtual("ZO_AntiquityDiggingHUDFade", self.keybindContainer)
    self.keybindContainerFastTimeline = ANIMATION_MANAGER:CreateTimelineFromVirtual("ZO_AntiquityDiggingHUDFastFade", self.keybindContainer)
    self.keybindLabels = {} -- will be populated on EVENT_KEYBINDINGS_LOADED
    self.isHelpOverlayVisible = false
    self.areGamepadControlsEnabled = false
    ANTIQUITY_DIGGING_FRAGMENT = ZO_FadeSceneFragment:New(control)
    -- (ESO-670681) When a remote scene is about to change via ZO_SceneManager_Follower:OnLeaderToFollowerSync, the next scene is established before the current scene is hidden
    -- When the next scene is set, the fragments are refreshed and, since there is a next scene, the fragments hide. Because of this order of operations,
    -- the fragment can be hiding while the scene is still considered "showing." Therefore, we can rely on the state of the scene or the state of the fragment, but not both in unison.
    ANTIQUITY_DIGGING_SCENE = ZO_RemoteScene:New("antiquityDigging", SCENE_MANAGER)
    ANTIQUITY_DIGGING_SCENE:RegisterCallback("StateChange", function(oldState, newState)
        if newState == SCENE_SHOWING then
            self.isReadyToPlay = false
            self.selectedRow = nil
            self.selectedColumn = nil
            control:RegisterForEvent(EVENT_ANTIQUITY_DIGGING_READY_TO_PLAY, function() self:OnAntiquityDiggingReadyToPlay() end)
            self:RefreshActiveToolKeybinds()
        elseif newState == SCENE_HIDING then
            control:UnregisterForEvent(EVENT_ANTIQUITY_DIGGING_READY_TO_PLAY)
            control:SetHandler("OnUpdate", nil)
            --clear the current tutorial when hiding so we don't push an extra action layer
            self.triggeredTutorial = false
            self:RefreshInputState()
            ZO_Dialogs_ReleaseAllDialogsOfName("CONFIRM_STOP_ANTIQUITY_DIGGING")
        elseif newState == SCENE_HIDDEN then
            self.keybindContainerTimeline:PlayInstantlyToStart()
            if self.beginEndOfGameFanfareEventId  then
                EVENT_MANAGER:UnregisterForUpdate(self.beginEndOfGameFanfareEventId)
                self.beginEndOfGameFanfareEventId = nil
            end
        end
    end)
    ANTIQUITY_DIGGING_SUMMARY_FRAGMENT:RegisterCallback("StateChange", function(oldState, newState)
        -- When the end of game summary fragment comes in, we want to get rid of the keybinds
        -- and tone down the bars so they don't feel like they're part of the summary but can still be referenced
        if ANTIQUITY_DIGGING_SCENE:IsShowing() then
            if newState == SCENE_FRAGMENT_SHOWING then
                self.keybindContainerFastTimeline:PlayFromEnd()
            elseif newState == SCENE_FRAGMENT_HIDDEN then
                -- This is only here in cases where we hide the fragment while the game is still going (i.e. debug)
                self.keybindContainerFastTimeline:PlayFromStart()
            end
        end
    end)
    control:RegisterForEvent(EVENT_START_ANTIQUITY_DIGGING, function()
        SCENE_MANAGER:Show("antiquityDigging")
    end)
    control:RegisterForEvent(EVENT_KEYBINDINGS_LOADED, function()
        self:BuildKeybindLabels()
        control:UnregisterForEvent(EVENT_KEYBINDINGS_LOADED)
    end)
    control:RegisterForEvent(EVENT_ANTIQUITY_DIGGING_ACTIVE_SKILL_CHANGED, function()
        self:RefreshKeybindAlpha()
    end)
    control:RegisterForEvent(EVENT_REQUEST_ANTIQUITY_DIGGING_EXIT, function()
        if ANTIQUITY_DIGGING_SUMMARY_FRAGMENT:IsHidden() then
            ZO_Dialogs_ShowPlatformDialog("CONFIRM_STOP_ANTIQUITY_DIGGING")
        end
    end)
    control:RegisterForEvent(EVENT_ANTIQUITY_DIGGING_GAME_OVER, function(eventId, gameOverFlags)
        local fanfareDelayMs = PlayerLeftDiggingEarly() and ANTIQUITY_DIGGING_FANFARE_SHORT_DELAY_MS or ANTIQUITY_DIGGING_FANFARE_LONG_DELAY_MS
        self.beginEndOfGameFanfareEventId = zo_callLater(function()
            self.beginEndOfGameFanfareEventId = nil
            ANTIQUITY_DIGGING_SUMMARY:BeginEndOfGameFanfare(gameOverFlags)
        end, fanfareDelayMs)
    end)
    
    control:RegisterForEvent(EVENT_GAMEPAD_PREFERRED_MODE_CHANGED, function()
        self:RefreshInputState()
    end)
    control:RegisterForEvent(EVENT_TUTORIAL_HIDDEN, function()
        if self.triggeredTutorial then
            self.triggeredTutorial = false
            self:RefreshInputState()
        end
    end)
    control:RegisterForEvent(EVENT_ANTIQUITY_DIGGING_ANTIQUITY_UNEARTHED, function()
        self:ShowTutorial(TUTORIAL_TRIGGER_ANTIQUITY_DIGGING_ANTIQUITY_UNEARTHED)
    end)
    control:RegisterForEvent(EVENT_ANTIQUITY_DIGGING_BONUS_LOOT_UNEARTHED, function()
        self:ShowTutorial(TUTORIAL_TRIGGER_ANTIQUITY_DIGGING_BONUS_LOOT_UNEARTHED)
    end)
    control:RegisterForEvent(EVENT_ANTIQUITY_DIG_SPOT_DURABILITY_CHANGED, function(_, newDurability)
        self:ShowTutorial(TUTORIAL_TRIGGER_ANTIQUITY_DIGGING_ANTIQUITY_DAMAGED)
        if newDurability == 0 then
            self:ShowTutorial(TUTORIAL_TRIGGER_ANTIQUITY_DIGGING_ANTIQUITY_DESTROYED)
        end
    end)
    control:RegisterForEvent(EVENT_HELP_OVERLAY_VISIBILITY_CHANGED, function(_, isVisible)
        self.isHelpOverlayVisible = isVisible
        self:RefreshInputState()
    end)
    self.platformStyle = ZO_PlatformStyle:New(function(style) self:ApplyPlatformStyle(style) end, KEYBOARD_STYLE, GAMEPAD_STYLE)
end
function ZO_AntiquityDigging:ApplyPlatformStyle(style)
    for _, keybindLabel in pairs(self.keybindLabels) do
        keybindLabel:SetFont(style.keybindLabelFont)
    end
end
function ZO_AntiquityDigging:SetKeyboardControlsEnabled(enabled)
    if enabled then
        self.control:SetHandler("OnMouseDown", function(...) self:OnMouseDown(...) end)
    else
        self.control:SetHandler("OnMouseDown", nil)
    end
end
function ZO_AntiquityDigging:SetGamepadControlsEnabled(enabled)
    if self.areGamepadControlsEnabled == enabled then
        return
    end
    self.areGamepadControlsEnabled = enabled
    if enabled then
        if not self.horizontalMovementController then
            local function GetStickMagnitude(direction)
                --When using a movement controller on the slightest input in a direction it will move in that direction and then start accumulating to do the following move. This is important for responsiveness.
                --However it means that it's super touchy when using both X and Y. Pressing the stick at 89 degress will cause a movement to the right. So we apply these thresholds to get rid of those weird moves.
                if direction == MOVEMENT_CONTROLLER_DIRECTION_VERTICAL then
                    return zo_abs(self.gamepadY) > 0.4 and self.gamepadY or 0
                end
                return zo_abs(self.gamepadX) > 0.4 and -self.gamepadX or 0
            end
            self.horizontalMovementController = ZO_MovementController:New(MOVEMENT_CONTROLLER_DIRECTION_HORIZONTAL, 8, GetStickMagnitude)
            self.verticalMovementController = ZO_MovementController:New(MOVEMENT_CONTROLLER_DIRECTION_VERTICAL, 8, GetStickMagnitude)
        end
        self.numRows, self.numColumns = GetDigSpotDimensions()
        if not self.selectedRow then
            self.selectedRow = zo_floor(self.numRows * 0.5)
            self.selectedColumn = zo_floor(self.numColumns * 0.5)
        end
        DIRECTIONAL_INPUT:Activate(self, self.control)
    else
        DIRECTIONAL_INPUT:Deactivate(self)
    end
end
function ZO_AntiquityDigging:OnMouseDown(control, button)
    if button == MOUSE_BUTTON_INDEX_LEFT then
        local mouseOverSkill = GetMouseOverDiggingActiveSkill()
        if mouseOverSkill then
            SetSelectedDiggingActiveSkill(mouseOverSkill)
        else
            local selectedSkill = GetSelectedDiggingActiveSkill()
            local selectedRow, selectedColumn = GetSelectedDigCell()
            if selectedSkill and selectedRow and selectedColumn then
                UseDiggingActiveSkillOnSelectedCell(selectedSkill)
            else
                PlayDiggingMouseClickEffect()
            end
        end
    end
end
function ZO_AntiquityDigging:OnAntiquityDiggingReadyToPlay()
    self.keybindContainerTimeline:PlayForward()
    self.isReadyToPlay = true
    self.control:SetHandler("OnUpdate", function()
        self:OnUpdate()
    end)
end
function ZO_AntiquityDigging:IsReadyToPlay()
    return ANTIQUITY_DIGGING_SCENE:IsShowing() and self.isReadyToPlay
end
function ZO_AntiquityDigging:OnUpdate()
    if not IsInGamepadPreferredMode() then
    end
end
function ZO_AntiquityDigging:CreateKeybindLabel(skill, bindingName)
    local label = CreateControlFromVirtual("$(parent)", self.keybindContainer, "ZO_AntiquityDiggingKeybindLabel", skill)
    ZO_Keybindings_RegisterLabelForBindingUpdate(label, bindingName)
    self.keybindLabels[skill] = label
end
function ZO_AntiquityDigging:BuildKeybindLabels()
    self:CreateKeybindLabel(DIGGING_ACTIVE_SKILL_BASIC_EXCAVATION, "ANTIQUITY_DIGGING_SELECT_BASIC_EXCAVATION")
    self:CreateKeybindLabel(DIGGING_ACTIVE_SKILL_RADAR_SENSE, "ANTIQUITY_DIGGING_SELECT_RADAR_SENSE")
    self:CreateKeybindLabel(DIGGING_ACTIVE_SKILL_HEAVY_SHOVEL, "ANTIQUITY_DIGGING_SELECT_HEAVY_SHOVEL")
    self:CreateKeybindLabel(DIGGING_ACTIVE_SKILL_CAREFUL_TOUCH, "ANTIQUITY_DIGGING_SELECT_CAREFUL_TOUCH")
    self.platformStyle:Apply()
end
function ZO_AntiquityDigging:RefreshKeybindAnchors()
    for skill = DIGGING_ACTIVE_SKILL_ITERATION_BEGIN, DIGGING_ACTIVE_SKILL_ITERATION_END do
        local x, y = GetDigToolUIKeybindPosition(skill)
        local label = self.keybindLabels[skill]
        label:ClearAnchors()
        label:SetAnchor(TOP, GuiRoot, TOPLEFT, x, y)
    end
end
function ZO_AntiquityDigging:RefreshKeybindAlpha()
    local activeSkill = GetSelectedDiggingActiveSkill()
    for skill = DIGGING_ACTIVE_SKILL_ITERATION_BEGIN, DIGGING_ACTIVE_SKILL_ITERATION_END do
        local label = self.keybindLabels[skill]
        if skill == activeSkill then
            label:SetAlpha(1)
        else
            label:SetAlpha(0.3)
        end
    end
end
function ZO_AntiquityDigging:RefreshActiveToolKeybinds()
    for skill = DIGGING_ACTIVE_SKILL_ITERATION_BEGIN, DIGGING_ACTIVE_SKILL_ITERATION_END do
        local label = self.keybindLabels[skill]
        label:SetHidden(not IsDiggingActiveSkillUnlocked(skill))
    end
end
function ZO_AntiquityDigging:ShowTutorial(tutorial)
    local tutorialId = GetTutorialId(tutorial)
    if CanTutorialBeSeen(tutorialId) and (not HasSeenTutorial(tutorialId)) then
        self.triggeredTutorial = true
        self:RefreshInputState()
        TriggerTutorial(tutorial)
    end
end
function ZO_AntiquityDigging:RefreshInputState()
    local allowPlayerInput = self:IsReadyToPlay() and not self.triggeredTutorial and not self.isHelpOverlayVisible and not ZO_Dialogs_IsShowingDialog()
    if self.isPlayerInputEnabled ~= allowPlayerInput then
        if allowPlayerInput then
            PushActionLayerByName("AntiquityDiggingActions")
            self.isPlayerInputEnabled = true
        else
            RemoveActionLayerByName("AntiquityDiggingActions")
            self.isPlayerInputEnabled = false
        end
    end
    local isGamepad = IsInGamepadPreferredMode()
    local keyboardEnabled = allowPlayerInput and not isGamepad
    local gamepadEnabled = allowPlayerInput and isGamepad
    self:SetKeyboardControlsEnabled(keyboardEnabled)
    self:SetGamepadControlsEnabled(gamepadEnabled)
end
do
    local TOOL_TUTORIALS =
    {
        [DIGGING_ACTIVE_SKILL_CAREFUL_TOUCH] = TUTORIAL_TRIGGER_ANTIQUITY_DIGGING_CAREFUL_TOUCH_UNLOCKED,
        [DIGGING_ACTIVE_SKILL_BASIC_EXCAVATION] = TUTORIAL_TRIGGER_ANTIQUITY_DIGGING_BASIC_EXCAVATION_UNLOCKED,
        [DIGGING_ACTIVE_SKILL_RADAR_SENSE] = TUTORIAL_TRIGGER_ANTIQUITY_DIGGING_RADAR_SENSE_UNLOCKED,
        [DIGGING_ACTIVE_SKILL_HEAVY_SHOVEL] = TUTORIAL_TRIGGER_ANTIQUITY_DIGGING_HEAVY_SHOVEL_UNLOCKED,
    }
    local UPGRADED_TOOL_TUTORIALS =
    {
        [DIGGING_ACTIVE_SKILL_CAREFUL_TOUCH] = TUTORIAL_TRIGGER_ANTIQUITY_DIGGING_CAREFUL_TOUCH_UPGRADED,
        [DIGGING_ACTIVE_SKILL_BASIC_EXCAVATION] = TUTORIAL_TRIGGER_ANTIQUITY_DIGGING_BASIC_EXCAVATION_UPGRADED,
        [DIGGING_ACTIVE_SKILL_RADAR_SENSE] = TUTORIAL_TRIGGER_ANTIQUITY_DIGGING_RADAR_SENSE_UPGRADED,
        [DIGGING_ACTIVE_SKILL_HEAVY_SHOVEL] = TUTORIAL_TRIGGER_ANTIQUITY_DIGGING_HEAVY_SHOVEL_UPGRADED,
    }
    function ZO_AntiquityDigging:TryTriggerInitialTutorials()
        self:ShowTutorial(TUTORIAL_TRIGGER_ANTIQUITY_DIGGING_OPENED)
        for skill = DIGGING_ACTIVE_SKILL_ITERATION_BEGIN, DIGGING_ACTIVE_SKILL_ITERATION_END do
            if IsDiggingActiveSkillUnlocked(skill) then
                self:ShowTutorial(TOOL_TUTORIALS[skill])
                if IsDiggingActiveSkillUpgraded(skill) then
                    self:ShowTutorial(UPGRADED_TOOL_TUTORIALS[skill])
                end
            end
        end
        if DidDigSpotSpawnWithFissures() then
            self:ShowTutorial(TUTORIAL_TRIGGER_ANTIQUITY_DIGGING_FISSURE_SPAWNED)
        end
    end
end
-- Begin Gamepad Actions --
function ZO_AntiquityDigging:UpdateDirectionalInput()
    self.gamepadX, self.gamepadY = DIRECTIONAL_INPUT:GetXY(ZO_DI_LEFT_STICK, ZO_DI_DPAD)
    local moveX = self.horizontalMovementController:CheckMovement()
    local moveY = self.verticalMovementController:CheckMovement()
    local deltaX = moveX == MOVEMENT_CONTROLLER_MOVE_PREVIOUS and -1 or moveX == MOVEMENT_CONTROLLER_MOVE_NEXT and 1 or 0
    local deltaY = moveY == MOVEMENT_CONTROLLER_MOVE_PREVIOUS and -1 or moveY == MOVEMENT_CONTROLLER_MOVE_NEXT and 1 or 0
    self.selectedColumn = zo_clamp(self.selectedColumn + deltaX, 1, self.numColumns)
    self.selectedRow = zo_clamp(self.selectedRow + deltaY, 1, self.numRows)
    SetSelectedDigCell(self.selectedRow, self.selectedColumn)
end
function ZO_AntiquityDigging:UsePrimaryAction()
    if ANTIQUITY_DIGGING_SUMMARY_FRAGMENT:IsHidden() then
    else
        ANTIQUITY_DIGGING_SUMMARY:OnUsePrimaryAction()
    end
end
function ZO_AntiquityDigging:UseCodex()
    if not ANTIQUITY_DIGGING_SUMMARY_FRAGMENT:IsHidden() then
        ANTIQUITY_DIGGING_SUMMARY:OnUseCodex()
    end
end
function ZO_AntiquityDigging:SelectTool(activeSkill)
    SetSelectedDiggingActiveSkill(activeSkill)
end
function ZO_AntiquityDigging:TryCancel()
    SCENE_MANAGER:Hide("antiquityDigging")
end
-- End Gamepad Actions --
-- Global / XML --
    ANTIQUITY_DIGGING = ZO_AntiquityDigging:New(control)
end