ESO Lua File v100012

ingame/deathrecap/deathrecap.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
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
--Death Recap Toggle
----------------------
local DeathRecapToggle = ZO_Object:Subclass()
function DeathRecapToggle:New(...)
    local object = ZO_Object.New(self)
    object:Initialize(...)
    return object
end
function DeathRecapToggle:Initialize(control)
    DEATH_RECAP:RegisterCallback("OnDeathRecapAvailableChanged", function() self:RefreshEnabled() end)
    self:RefreshEnabled()
end
function DeathRecapToggle:RefreshEnabled()
    self.enabled = DEATH_RECAP:IsDeathRecapAvailable()
end
function DeathRecapToggle:Toggle()
    DEATH:ToggleDeathRecap()
end
function DeathRecapToggle:Hide()
    if(self.enabled) then
        if(DEATH_RECAP:IsWindowOpen()) then
            DEATH_RECAP:SetWindowOpen(false)
            return true
        end
    end
    return false
end
--Death Recap
------------------
local DEATH_RECAP_DELAY = 2000
local DeathRecap = ZO_CallbackObject:Subclass()
function DeathRecap:New(...)
    local object = ZO_CallbackObject.New(self)
    object:Initialize(...)
    return object
end
function DeathRecap:Initialize(control)
    self.control = control
    self.scrollContainer = control:GetNamedChild("ScrollContainer")
    self.scrollControl = self.scrollContainer:GetNamedChild("ScrollChild")
    self.waitingToShowPrompt = false
    self.windowOpen = true
    self.deathRecapAvailable = false
    self.killingBlowIcon = GetControl(self.scrollControl, "AttacksKillingBlowIcon")
    self.killingBlowTimeline = ANIMATION_MANAGER:CreateTimelineFromVirtual("ZO_DeathRecapKillingBlowAnimation", self.killingBlowIcon)
    self.hintTimeline = ANIMATION_MANAGER:CreateTimelineFromVirtual("ZO_DeathRecapHintAnimation", self.scrollControl:GetNamedChild("HintsContainerHints"))
    EVENT_MANAGER:RegisterForEvent("DeathRecap", EVENT_PLAYER_DEAD, function() self:OnPlayerDead() end)
    EVENT_MANAGER:RegisterForEvent("DeathRecap", EVENT_PLAYER_ALIVE, function() self:OnPlayerAlive() end)
    EVENT_MANAGER:RegisterForEvent("DeathRecap", EVENT_PLAYER_ACTIVATED, function() self:SetupDeathRecap() end)
    CALLBACK_MANAGER:RegisterCallback("UnitFramesCreated", function() self:OnUnitFramesCreated() end)
    DEATH_RECAP_FRAGMENT = ZO_HUDFadeSceneFragment:New(control)
    DEATH_RECAP_FRAGMENT:RegisterCallback("StateChange", function(oldState, newState)
        self:RefreshBossBarVisibility()
        self:RefreshUnitFrameVisibility()
        if(newState == SCENE_FRAGMENT_SHOWING) then
            if(self.animateOnShow) then
                self.animateOnShow = nil
                self:Animate()
            end
        end
    end)
    local function OnAddOnLoaded(event, name)
        if name == "ZO_Ingame" then
            local defaults = { recapOn = true, }
            self.savedVars = ZO_SavedVars:New("ZO_Ingame_SavedVariables", 1, "DeathRecap", defaults)
            self:SetWindowOpen(self.savedVars.recapOn)
            self.control:UnregisterForEvent(EVENT_ADD_ON_LOADED)
        end
    end
    self.control:RegisterForEvent(EVENT_ADD_ON_LOADED, OnAddOnLoaded)
    
    self.control:SetHandler("OnEffectivelyShown", function() self:OnEffectivelyShown() end)
    self.control:SetHandler("OnEffectivelyHidden", function() self:OnEffectivelyHidden() end)
    self:ApplyStyle() -- Setup initial visual style based on current mode.
    self.control:RegisterForEvent(EVENT_GAMEPAD_PREFERRED_MODE_CHANGED, function() self:OnGamepadPreferredModeChanged() end)
    local DEATH_RECAP_RIGHT_SCROLL_INDICATOR_OFFSET_X = -64
    ZO_Scroll_Gamepad_SetScrollIndicatorSide(self.scrollContainer:GetNamedChild("ScrollIndicator"), self.control, RIGHT, DEATH_RECAP_RIGHT_SCROLL_INDICATOR_OFFSET_X)
end
function DeathRecap:InitializeAttackPool()
    self.attackPool = ZO_ControlPool:New("ZO_DeathRecapAttack", self.scrollControl:GetNamedChild("Attacks"), "")
    self.attackTemplate = ZO_GetPlatformTemplate("ZO_DeathRecapAttack")
    self.attackPool:SetCustomFactoryBehavior(function(control)
        control.timeline = ANIMATION_MANAGER:CreateTimelineFromVirtual("ZO_DeathRecapAttackAnimation")
        local nestedTimeline = control.timeline:GetAnimationTimeline(1)
        local iconTexture = control:GetNamedChild("Icon")
        local textContainer = control:GetNamedChild("Text")
        for i = 1, 3 do
            local animation = nestedTimeline:GetAnimation(i)
            animation:SetAnimatedControl(iconTexture)
        end
        nestedTimeline:GetAnimation(4):SetAnimatedControl(textContainer)
    end)
    self.attackPool:SetCustomAcquireBehavior(function(control)
        ApplyTemplateToControl(control, self.attackTemplate)
    end)
    self.attackPool:SetCustomResetBehavior(function(control)
        control.timeline:Stop()
        local iconTexture = control:GetNamedChild("Icon")
        iconTexture:SetScale(1)
        ApplyTemplateToControl(control, self.attackTemplate)
    end)
end
function DeathRecap:InitializeHintPool()
    self.hintPool = ZO_ControlPool:New("ZO_DeathRecapHint", self.scrollControl:GetNamedChild("HintsContainerHints"), "")
    self.hintTemplate = ZO_GetPlatformTemplate("ZO_DeathRecapHint")
    
    self.hintPool:SetCustomAcquireBehavior(function(control)
        ApplyTemplateToControl(control, self.hintTemplate)
    end)
    
    self.hintPool:SetCustomResetBehavior(function(control)
        ApplyTemplateToControl(control, self.hintTemplate)
    end)
end
function DeathRecap:InitializeTelvarStoneLossLabel()
    self.telvarStoneLossControl = self.scrollControl:GetNamedChild("TelvarStoneLoss")
    self.telvarStoneLossTemplate = ZO_GetPlatformTemplate("ZO_DeathRecapTelvarStoneLoss")
    ApplyTemplateToControl(self.telvarStoneLossControl, self.telvarStoneLossTemplate)
    self.telvarStoneLossValueControl = self.telvarStoneLossControl:GetNamedChild("Value");
    self.telvarLossTimeline = ANIMATION_MANAGER:CreateTimelineFromVirtual("ZO_DeathRecapTelvarLossAnimation", self.telvarStoneLossControl)
end
function DeathRecap:IsWindowOpen()
    return self.windowOpen
end
function DeathRecap:SetWindowOpen(open)
    self.savedVars.recapOn = open
    self.windowOpen = open
    if IsConsoleUI() then
        AUTO_SAVING:MarkDirty()
    end
end
function DeathRecap:IsDeathRecapAvailable()
    return self.deathRecapAvailable
end
function DeathRecap:SetDeathRecapAvailable(available)
    self.deathRecapAvailable = available
    self:FireCallbacks("OnDeathRecapAvailableChanged", available)
end
function DeathRecap:RefreshVisibility()
    DEATH_RECAP_FRAGMENT:SetHiddenForReason("NotAvailable", not self.deathRecapAvailable)
    DEATH_RECAP_FRAGMENT:SetHiddenForReason("WindowHiddenByUser", not self.windowOpen, DEFAULT_HUD_DURATION, DEFAULT_HUD_DURATION)
end
function DeathRecap:RefreshBossBarVisibility()
    COMPASS_FRAME:SetBossBarHiddenForReason("deathRecap", not DEATH_RECAP_FRAGMENT:IsHidden())
end
function DeathRecap:RefreshUnitFrameVisibility()
    if(UNIT_FRAMES) then
        UNIT_FRAMES:SetFrameHiddenForReason("reticleover", "deathRecap", not DEATH_RECAP_FRAGMENT:IsHidden())
        UNIT_FRAMES:SetGroupAndRaidFramesHiddenForReason("deathRecap", not DEATH_RECAP_FRAGMENT:IsHidden())
    end
end
local function SortAttacks(left, right)
    if(left.wasKillingBlow) then
        return false
    elseif(right.wasKillingBlow) then
        return true
    else
        return left.lastUpdateAgoMS > right.lastUpdateAgoMS
    end    
end
local ATTACK_FRAME_TEXTURE = "EsoUI/Art/DeathRecap/deathRecap_attackFrame.dds"
local ATTACK_BOSS_FRAME_TEXTURE = "EsoUI/Art/DeathRecap/deathRecap_attackBossFrame.dds"
function DeathRecap:SetupAttacks()
    local startAlpha = self.animateOnShow and 0 or 1
    self.attackPool:ReleaseAllObjects()
    self.killingBlowIcon:SetAlpha(startAlpha)
    local attacks = {}
    for i = 1, GetNumKillingAttacks() do
        local attackName, attackDamage, attackIcon, wasKillingBlow, castTimeAgoMS, durationMS = GetKillingAttackInfo(i)
        local attackInfo = {
            index = i,
            attackName = attackName,
            attackDamage = attackDamage,
            attackIcon = attackIcon,
            wasKillingBlow = wasKillingBlow,
            lastUpdateAgoMS = castTimeAgoMS - durationMS,
        }
        table.insert(attacks, attackInfo)
    end
    table.sort(attacks, SortAttacks)
    local prevAttackControl
    for i, attackInfo in ipairs(attacks) do
        local attackControl = self.attackPool:AcquireObject(i)
        local iconControl = attackControl:GetNamedChild("Icon")
        iconControl:SetTexture(attackInfo.attackIcon)
        local attackNameControl = attackControl:GetNamedChild("AttackName")
        attackNameControl:SetText(zo_strformat(SI_DEATH_RECAP_ATTACK_NAME, attackInfo.attackName))
        local damageControl = attackControl:GetNamedChild("Damage")
        damageControl:SetText(ZO_CommaDelimitNumber(attackInfo.attackDamage))
        iconControl:SetAlpha(startAlpha)
        attackControl:GetNamedChild("Text"):SetAlpha(startAlpha)
        if(attackInfo.wasKillingBlow) then
            self.killingBlowIcon:SetAnchor(CENTER, attackControl, TOPLEFT, 32, 32)
        end
        local attackerNameControl = attackControl:GetNamedChild("AttackerName")
        local isBoss = false
        if(DoesKillingAttackHaveAttacker(attackInfo.index)) then
            local attackerRawName, attackerVeteranRank, attackerLevel, attackerAvARank, isPlayer, isBoss, alliance, minionName, attackerDisplayName = GetKillingAttackerInfo(attackInfo.index)
            
            local attackerNameLine
            if(isPlayer) then
                local coloredRankIconMarkup = GetColoredAvARankIconMarkup(attackerAvARank, alliance, 32)
                local nameToShow = IsInGamepadPreferredMode() and ZO_FormatUserFacingDisplayName(attackerDisplayName) or attackerRawName
                if(minionName == "") then
                    attackerNameLine = zo_strformat(SI_DEATH_RECAP_RANK_ATTACKER_NAME, coloredRankIconMarkup, attackerAvARank, nameToShow)
                else
                    attackerNameLine = zo_strformat(SI_DEATH_RECAP_RANK_ATTACKER_NAME_MINION, coloredRankIconMarkup, attackerAvARank, nameToShow, minionName)
                end
            else
                if(minionName == "") then
                    attackerNameLine = zo_strformat(SI_DEATH_RECAP_ATTACKER_NAME, attackerRawName)
                else
                    attackerNameLine = zo_strformat(SI_DEATH_RECAP_ATTACKER_NAME_MINION, attackerRawName, minionName)
                end
            end
            attackerNameControl:SetText(attackerNameLine)
            attackerNameControl:SetHidden(false) 
            attackerNameControl:ClearAnchors()
            attackerNameControl:SetAnchor(TOPRIGHT, damageControl, TOPLEFT, -10, 0)
            attackerNameControl:SetAnchor(TOPLEFT, nil, TOPLEFT, 150, 6)
            attackNameControl:ClearAnchors()
            attackNameControl:SetAnchor(TOPRIGHT, damageControl, TOPLEFT, -10, 0)
            attackNameControl:SetAnchor(TOPLEFT, attackerNameControl, BOTTOMLEFT, 0, 2)
        else
            attackerNameControl:SetHidden(true)
            attackNameControl:ClearAnchors()
            attackNameControl:SetAnchor(TOPRIGHT, damageControl, TOPLEFT, -10, 0)
            attackNameControl:SetAnchor(LEFT, nil, TOPLEFT, 150, 32)
        end
        local frameControl = iconControl:GetNamedChild("Frame")
        if(isBoss) then
            frameControl:SetTexture(ATTACK_BOSS_FRAME_TEXTURE)
            frameControl:SetDimensions(128, 128)
        else
            frameControl:SetTexture(ATTACK_FRAME_TEXTURE)
            frameControl:SetDimensions(56, 56)
        end
        if(prevAttackControl) then
            attackControl:SetAnchor(TOPLEFT, prevAttackControl, BOTTOMLEFT, 0, 10)
        else
            attackControl:SetAnchor(TOPLEFT, nil, TOPLEFT, 0, 0)
        end
        prevAttackControl = attackControl
    end
end
local function RandomlyTake(array)
    local index = zo_random(1, #array)
    local value = array[index]
    table.remove(array, index)
    return value
end
function DeathRecap:AddHint(text, prevHintControl)
    local hintIndex = #self.hintPool:GetActiveObjects() + 1
    local hintControl = self.hintPool:AcquireObject(hintIndex)
    hintControl:GetNamedChild("Text"):SetText(text)
            
    if(prevHintControl) then
        hintControl:SetAnchor(TOPLEFT, prevHintControl, BOTTOMLEFT, 0, 10)
    else
        hintControl:SetAnchor(TOPLEFT, nil, TOPLEFT, 0, 0)
    end
    return hintControl
end
function DeathRecap:SetupHints()
    self.hintPool:ReleaseAllObjects()
    self.hintTimeline:Stop()
    local startAlpha = self.animateOnShow and 0 or 1
    self.scrollControl:GetNamedChild("HintsContainerHints"):SetAlpha(startAlpha)
    local numHints = GetNumDeathRecapHints()
    if numHints == 0 then
        self:AddHint(GetString(SI_DEATH_RECAP_NO_HINTS))
    else
        local exclusiveHints = {}
        local alwaysShowHints = {}
        local normalHints = {}
        for i = 1, numHints do
            local hintText, hintImportance = GetDeathRecapHintInfo(i)
            if(hintImportance == DEATH_RECAP_HINT_IMPORTANCE_EXCLUSIVE) then
                table.insert(exclusiveHints, hintText)
            elseif(hintImportance == DEATH_RECAP_HINT_IMPORTANCE_ALWAYS_INCLUDE) then
                table.insert(alwaysShowHints, hintText)
            else
                table.insert(normalHints, hintText)
            end
        end
        local prevHintControl
        if(#exclusiveHints > 0) then
            local text = RandomlyTake(exclusiveHints)
            self:AddHint(text)
            return
        end
        local hintsAdded = 0
        local MAX_HINTS = 3
        while #alwaysShowHints > 0 and hintsAdded < MAX_HINTS do
            local text = RandomlyTake(alwaysShowHints)
            prevHintControl = self:AddHint(text, prevHintControl)
            hintsAdded = hintsAdded + 1
        end
        while #normalHints > 0 and hintsAdded < MAX_HINTS do
            local text = RandomlyTake(normalHints)
            prevHintControl = self:AddHint(text, prevHintControl)
            hintsAdded = hintsAdded + 1
        end        
    end
end
function DeathRecap:SetupTelvarStoneLoss()
    local telvarStonesLost = GetNumTelvarStonesLost()
    
    if telvarStonesLost > 0 then
        self.telvarStoneLossValueControl:SetText(zo_strformat(SI_DEATH_RECAP_TELVAR_STONE_LOSS_VALUE, telvarStonesLost))
        self.telvarStoneLossControl:SetAlpha(self.animateOnShow and 0 or 1)
    else
        self.telvarStoneLossControl:SetAlpha(0)
    end
end
function DeathRecap:SetupDeathRecap()
    local numAttacks = GetNumKillingAttacks()
    if(numAttacks > 0 and IsUnitDead("player")) then
        self:SetupAttacks()
        self:SetupHints()
        self:SetupTelvarStoneLoss()
        self:SetDeathRecapAvailable(true)
    else
        self:SetDeathRecapAvailable(false)
    end
end
local ATTACK_ROW_ANIMATION_OVERLAP_PERCENT = 0.5
local HINT_ANIMATION_DELAY_MS = 300
function DeathRecap:Animate()
    local delay = 0
    local lastRowDuration
    for attackRowIndex, attackControl in ipairs(self.attackPool:GetActiveObjects()) do
        local timeline = attackControl.timeline
        local isLastRow = (attackRowIndex == #self.attackPool:GetActiveObjects())
        local nestedTimeline = timeline:GetAnimationTimeline(1)
        local duration = nestedTimeline:GetDuration()
        timeline:SetAnimationTimelineOffset(nestedTimeline, delay)
        nestedTimeline.isKillingBlow = isLastRow
        timeline:PlayFromStart()
        delay = delay + duration * ATTACK_ROW_ANIMATION_OVERLAP_PERCENT
        if(isLastRow) then
            lastRowDuration = duration
        end
    end
    local nestedKBTimeline = self.killingBlowTimeline:GetAnimationTimeline(1)
    self.killingBlowTimeline:SetAnimationTimelineOffset(nestedKBTimeline, delay - lastRowDuration)
    self.killingBlowTimeline:PlayFromStart()
    if GetNumTelvarStonesLost() > 0 then
        local nestedTelvarLossTimeline = self.telvarLossTimeline:GetAnimationTimeline(1)
        self.telvarLossTimeline:SetAnimationTimelineOffset(nestedTelvarLossTimeline, delay)
        self.telvarLossTimeline:PlayFromStart()
    end
    
    local nestedTimeline = self.hintTimeline:GetAnimationTimeline(1)    
    self.hintTimeline:SetAnimationTimelineOffset(nestedTimeline, delay + HINT_ANIMATION_DELAY_MS)
    self.hintTimeline:PlayFromStart()
end
--Events
function DeathRecap:OnPlayerAlive()
end
function DeathRecap:OnPlayerDead()
    self.isPlayerDead = true
    if(not self.waitingToShowPrompt) then
        self.waitingToShowPrompt = true
        EVENT_MANAGER:RegisterForUpdate("DeathRecapUpdate", DEATH_RECAP_DELAY, function()
            self.waitingToShowPrompt = false
            EVENT_MANAGER:UnregisterForUpdate("DeathRecapUpdate")
            self.animateOnShow = true
            self:SetupDeathRecap()
        end)
    end
end
function DeathRecap:OnUnitFramesCreated()
end
function DeathRecap:ApplyStyle()
    self.attackTemplate = ZO_GetPlatformTemplate("ZO_DeathRecapAttack")
    self.hintTemplate = ZO_GetPlatformTemplate("ZO_DeathRecapHint")
    self.telvarStoneLossTemplate = ZO_GetPlatformTemplate("ZO_DeathRecapTelvarStoneLoss")
    ApplyTemplateToControl(self.telvarStoneLossControl, ZO_GetPlatformTemplate("ZO_DeathRecapTelvarStoneLoss"))
    if self.isPlayerDead then
        self:SetupDeathRecap()
        if (not self.control:IsHidden()) then
            if IsInGamepadPreferredMode() then
                DIRECTIONAL_INPUT:Activate(self, self.control)
            else
                DIRECTIONAL_INPUT:Deactivate(self)
            end
        end
    end
end
function DeathRecap:OnGamepadPreferredModeChanged()
    self:ApplyStyle()
end
function DeathRecap:UpdateDirectionalInput()
    if not self.control:IsHidden() then
        DIRECTIONAL_INPUT:Consume(ZO_DI_RIGHT_STICK) -- Consume input to block camera movement when in gamepad mode with the death recap screen up.
    end
end
function DeathRecap:OnEffectivelyShown()
    if IsInGamepadPreferredMode() then
        DIRECTIONAL_INPUT:Activate(self, self.control)
    end
end
function DeathRecap:OnEffectivelyHidden()
    DIRECTIONAL_INPUT:Deactivate(self)
end
--Global XML
    DEATH_RECAP = DeathRecap:New(self)
    DEATH_RECAP_TOGGLE = DeathRecapToggle:New()
end