ESO Lua File v100011

ingame/centerscreenannounce/centerscreenannounce.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
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
local CSA_INACTIVE = 0
CSA_EVENT_SMALL_TEXT = 1
CSA_EVENT_LARGE_TEXT = 2
CSA_EVENT_COMBINED_TEXT = 3
CSA_EVENT_NO_TEXT = 4
CSA_OPTION_SUPPRESS_ICON_FRAME = true
local ARG_INDEX_SOUND = 1
local ARG_INDEX_MESSAGE = 2
local ARG_INDEX_COMBINED_MESSAGE = 3
local ARG_INDEX_ICON = 4
local ARG_INDEX_ICON_BG = 5
local ARG_INDEX_EXPIRING_CALLBACK = 6
local ARG_INDEX_BAR_PARAMS = 7
local ARG_INDEX_LIFESPAN = 8
local ARG_INDEX_SUPPRESS_FRAME = 9
local SMALL_TEXT_FONT_KEYBOARD = "ZoFontCenterScreenAnnounceSmall"
local SMALL_TEXT_FONT_GAMEPAD = "ZoFontGamepad34"
local DEFAULT_FADE_OUT_TIME = 3500
local CenterScreenPlayerProgressBarParams = ZO_Object:Subclass()
function CenterScreenPlayerProgressBarParams:New()
    return ZO_Object.New(self)
end
function CenterScreenPlayerProgressBarParams:Reset()
    self.type = nil
    self.startLevel = nil
    self.start = nil
    self.stop = nil
    self.sound = nil
    self.showNoGain = false
end
function CenterScreenPlayerProgressBarParams:Set(barType, startLevel, start, stop, sound)
    self.type = barType
    self.startLevel = startLevel
    self.start = start
    self.stop = stop
    self.sound = sound
end
function CenterScreenPlayerProgressBarParams:GetParams()
    return self.type, self.startLevel, self.start, self.stop, self.sound
end
function CenterScreenPlayerProgressBarParams:SetShowNoGain(showNoGain)
    self.showNoGain = showNoGain
end
function CenterScreenPlayerProgressBarParams:SetSound(sound)
    self.sound = sound
end
local function CallExpiringCallbackTimeline(timeline, offset)
    CENTER_SCREEN_ANNOUNCE:CallExpiringCallback(timeline.m_control)
end
local CenterScreenAnnounce = ZO_Object:Subclass()
function CenterScreenAnnounce:New(...)
    local announce = ZO_Object.New(self)
    announce:Initialize(...)
    return announce
end
function CenterScreenAnnounce:InitializeLineAnimation(line, timelineTemplate, timelineMemberKey, stopHandler, expiringCallbackCheckOffset, expiringCallbackExecutor)
    local timeline = ANIMATION_MANAGER:CreateTimelineFromVirtual(timelineTemplate, line)
    line[timelineMemberKey] = timeline
    timeline.m_control = line
    timeline:SetHandler("OnStop", stopHandler)
    if(expiringCallbackCheckOffset and expiringCallbackExecutor) then
        timeline:InsertCallback(expiringCallbackExecutor, expiringCallbackCheckOffset)
    end
end
function CenterScreenAnnounce:InitializeWipeAnimation(container, timelineTemplate, timelineMemberKey, stopHandler, expiringCallbackCheckOffset, expiringCallbackExecutor, wipeIn, wipeOut)
    self:InitializeLineAnimation(container, timelineTemplate, timelineMemberKey, stopHandler, expiringCallbackCheckOffset, expiringCallbackExecutor)
    local timeline = container[timelineMemberKey]
    local wipeInAnim = timeline:GetAnimation(1)
    wipeInAnim:SetHandler("OnPlay", wipeIn)
    local wipeOutAnim = timeline:GetAnimation(2)
    wipeOutAnim:SetHandler("OnPlay", wipeOut)
end
local WAIT_INTERVAL_SECONDS = 0.5
function CenterScreenAnnounce:Initialize(control)
    self.m_control = control
    control.m_object = self
    self.m_displayQueue = {}
    self.m_activeSmallTextLines = {}
    self.allowedCategories = {}
    self.m_activeLineCount = 0
    self.m_hasActiveBar = false
    self.m_displayMode = CSA_INACTIVE
    self.m_largeTextContainer = control:GetNamedChild("LargeTextContainer")
    self.m_largeText = self.m_largeTextContainer:GetNamedChild("Text")
    self.m_smallCombinedText = self.m_largeText:GetNamedChild("Combined")    
    self.m_smallCombinedIcon = self.m_smallCombinedText:GetNamedChild("Icon")
    self.m_smallCombinedIconBG = self.m_smallCombinedText:GetNamedChild("IconBG")
    self.m_nextQueueIndex = 1
    -- Recent message handler, using a 250 ms expiry delay
    self.m_recentMessages = ZO_RecentMessages:New(250)
    local function OnFadeOutComplete(timeline, completedPlayback)
        if(not completedPlayback) then return end
        local control = timeline.m_control
        self:ReleaseLine(control)
        self:UpdateDisplay(control) -- passing in the control whose animation just finished...yes, it's already been released
    end
    local function OnSmallLineTranslateComplete(timeline, completedPlayback)
        if(not completedPlayback) then return end
        local control = timeline.m_control
        if(self:IsTopLine(control)) then
            local offset = zo_clamp(GetFrameTimeMilliseconds() - control.m_acquisitionTime, 0, 2500)
            control.m_fadeOutTimeline:PlayFromStart(offset)
        end
    end 
    local function OnSmallTextLineCheckNextEvent(timeline, offset)
        self.m_lastSmallLineMovedOutOfTheWay = true
        self:UpdateDisplay(timeline.m_control, true)
    end
    local function SetupWipeIn(animation, container)
        container:ClearAnchors()
        container:SetAnchor(TOPLEFT, control, TOPLEFT, -512, 0)
    end
    local function SetupWipeOut(animation, container)
        container:ClearAnchors()
        container:SetAnchor(TOPRIGHT, control, TOPRIGHT, 512, 0)
    end
    self:InitializeWipeAnimation(self.m_largeTextContainer, "CenterScreenLargeText", "m_timeline", OnFadeOutComplete, DEFAULT_FADE_OUT_TIME, CallExpiringCallbackTimeline, SetupWipeIn, SetupWipeOut)
    
    local function SmallLineFactory(line)
        self:InitializeLineAnimation(line, "CenterScreenSmallTextFadeIn", "m_fadeInTimeline")
        self:InitializeLineAnimation(line, "CenterScreenSmallTextFadeOut", "m_fadeOutTimeline", OnFadeOutComplete, 0, CallExpiringCallbackTimeline)
        self:InitializeLineAnimation(line, "CenterScreenSmallTextTranslate", "m_translateTimeline", OnSmallLineTranslateComplete)
        line.m_translateTimeline:InsertCallback(OnSmallTextLineCheckNextEvent, 500)
        return line
    end
    local function SmallLineReset(line)
        line.m_key = nil
    end
    local function SmallLineAcquire(line)
        line.m_acquisitionTime = GetFrameTimeMilliseconds()
        line:SetFont(IsInGamepadPreferredMode() and SMALL_TEXT_FONT_GAMEPAD or SMALL_TEXT_FONT_KEYBOARD)
    end
    self.m_pool = ZO_ControlPool:New("ZO_CenterScreenAnnounceSmallTextTemplate", control)
    self.MAX_SMALL_TEXT_LINES = 5
    local testLine, testKey = self.m_pool:AcquireObject()
    testLine:SetFont(SMALL_TEXT_FONT_KEYBOARD)
    self.INITIAL_LINE_OFFSET_KEYBOARD = testLine:GetFontHeight() * self.MAX_SMALL_TEXT_LINES
    testLine:SetFont(SMALL_TEXT_FONT_GAMEPAD)
    self.INITIAL_LINE_OFFSET_GAMEPAD = testLine:GetFontHeight() * self.MAX_SMALL_TEXT_LINES
    self.m_pool:ReleaseObject(testKey)
    self.m_nextUpdateTimeSeconds = 0
    local function OnUpdate(control, timeNow)
        if(timeNow > self.m_nextUpdateTimeSeconds) then
            self.m_nextUpdateTimeSeconds = timeNow + 0.02
            self:TryDisplayingNextQueuedMessage()
        end
    end
    PLAYER_PROGRESS_BAR:RegisterCallback("Show", function()
        --if the announcement has begun fading out ("expiring") before the bar even shows, we don't need to hold
        if(PLAYER_PROGRESS_BAR:GetOwner() == CENTER_SCREEN_ANNOUNCE and self.m_displayMode ~= CSA_EVENT_NO_TEXT and self.m_largeTextContainer.m_timeline.beforeExpiring) then
            PLAYER_PROGRESS_BAR:SetHoldBeforeFadeOut(true)
        end
    end)
    PLAYER_PROGRESS_BAR:RegisterCallback("Complete", function()
        self.m_hasActiveBar = false
        self:CheckNowInactive()
    end)
    local function BarParamFactory(pool)
        return CenterScreenPlayerProgressBarParams:New()
    end
    local function BarParamReset(params)
        params:Reset()
        params.key = nil
    end
    self.m_barParamsPool = ZO_ObjectPool:New(BarParamFactory, BarParamReset)
    self:ApplyStyle() -- Setup initial visual style based on current mode.
    control:RegisterForEvent(EVENT_GAMEPAD_PREFERRED_MODE_CHANGED, function() self:OnGamepadPreferredModeChanged() end)
end
local function AnchorIconToText(iconControl, textControl)
    -- Dynamically anchor the icon to the start of the text
    local textWidth = textControl:GetTextWidth()
    local lineWidth = textControl:GetWidth()
    local centeringOffset = (lineWidth - textWidth) / 2
    iconControl:ClearAnchors()
    iconControl:SetAnchor(RIGHT, textControl, LEFT, centeringOffset - 10, 0)            
end
function CenterScreenAnnounce:ApplyStyle()
    ApplyTemplateToControl(self.m_control, ZO_GetPlatformTemplate("ZO_CenterScreenAnnounce"))
    ApplyTemplateToControl(self.m_largeTextContainer, ZO_GetPlatformTemplate("ZO_CenterScreenAnnounce_LargeTextContainer"))
    local smallFont = IsInGamepadPreferredMode() and SMALL_TEXT_FONT_GAMEPAD or SMALL_TEXT_FONT_KEYBOARD
    local smallLines = self.m_pool:GetActiveObjects()
    for _, smallLine in pairs(smallLines) do
        smallLine:SetFont(smallFont)
    end
    local iconControl = self.m_smallCombinedIcon
    if not iconControl:IsHidden() then
        AnchorIconToText(iconControl, self.m_smallCombinedText)
    end
end
function CenterScreenAnnounce:OnGamepadPreferredModeChanged()
    self:ApplyStyle()
end
function CenterScreenAnnounce:IsInactive()
    return self.m_displayMode == CSA_INACTIVE
end
function CenterScreenAnnounce:CreateBarParams(...)
    local barParams, key = self.m_barParamsPool:AcquireObject()
    barParams.key = key
    barParams:Set(...)
    return barParams
end
function CenterScreenAnnounce:CanDisplayMessage(category)
    if(self.m_displayMode == CSA_INACTIVE) then return true end
    if(category == CSA_EVENT_SMALL_TEXT and self.m_displayMode == category) then
        return self.m_lastSmallLineMovedOutOfTheWay and (#self.m_activeSmallTextLines < self.MAX_SMALL_TEXT_LINES)
    end
    
    return false
end
local messagePriorities = {}
function CenterScreenAnnounce:GetPriority(eventId)
    return messagePriorities[eventId] or 1
end
function CenterScreenAnnounce:CreateMessagePayload(eventId, category, queuedOrder, ...)
    local priority = self:GetPriority(eventId)
    local eventData = { ... }
    eventData.priority = priority
    eventData.category = category
    eventData.length = select("#", ...)
    eventData.queuedOrder = queuedOrder
    return priority, eventData
end
function CenterScreenAnnounce:QueueMessage(eventId, category, ...)
    self.m_control:SetHandler("OnUpdate", self.m_onUpdateHandler)
    --Delay choosing the next message to show by WAIT_INTERVAL_SECONDS each time a new message comes in to stabilize a bit
    local timeNowSeconds = GetFrameTimeMilliseconds() / 1000 
    self.m_nextUpdateTimeSeconds = timeNowSeconds + WAIT_INTERVAL_SECONDS
    local priority, data = self:CreateMessagePayload(eventId, category, self.m_nextQueueIndex, ...)
    table.insert(self.m_displayQueue, data)
    self.m_nextQueueIndex = self.m_nextQueueIndex + 1
    self.m_isQueueDirty = true
end
local function SortEventData(left, right)
    if(left.priority ~= right.priority) then
        return left.priority > right.priority
    else
        local leftBarParams = left[ARG_INDEX_BAR_PARAMS]
        local rightBarParams = right[ARG_INDEX_BAR_PARAMS]
        if(leftBarParams ~= nil and rightBarParams ~= nil) then
            if(leftBarParams.startLevel ~= rightBarParams.startLevel) then
                return leftBarParams.startLevel < rightBarParams.startLevel
            else
                if(leftBarParams.start ~= rightBarParams.start) then
                    return leftBarParams.start < rightBarParams.start
                else
                    if(leftBarParams.stop ~= rightBarParams.stop) then
                        return leftBarParams.stop < rightBarParams.stop
                    else
                        return false
                    end
                end
            end
        elseif (left.queuedOrder ~= right.queuedOrder) then
            return left.queuedOrder < right.queuedOrder
        else
            return false
        end
    end
end
function CenterScreenAnnounce:SortQueue()
    local maxBarTypePriorities = {}
    for _, eventData in ipairs(self.m_displayQueue) do
        local barParams = eventData[ARG_INDEX_BAR_PARAMS]
        if(barParams) then
            local barType = barParams:GetParams()
            local currentMaxPriority = maxBarTypePriorities[barType]
            if(currentMaxPriority == nil or eventData.priority > currentMaxPriority) then
                maxBarTypePriorities[barType] = eventData.priority
            end
        end
    end
    for _, eventData in ipairs(self.m_displayQueue) do
        local barParams = eventData[ARG_INDEX_BAR_PARAMS]
        if(barParams) then
            local barType = barParams:GetParams()
            eventData.priority = maxBarTypePriorities[barType]
        end
    end
    table.sort(self.m_displayQueue, SortEventData)
end
function CenterScreenAnnounce:GetNumQueuedEvents()
    return #self.m_displayQueue
end
function CenterScreenAnnounce:PeekNextEvent()
    return self.m_displayQueue[1]
end
function CenterScreenAnnounce:DoesNextEventHaveBar()
    local nextEvent = self:PeekNextEvent()
    if(nextEvent) then
        local params = nextEvent[ARG_INDEX_BAR_PARAMS]
        return params ~= nil
    end
    return false
end
function CenterScreenAnnounce:DoesNextEventHaveBarType(barType)
    local nextEvent = self:PeekNextEvent()
    if(nextEvent) then
        local params = nextEvent[ARG_INDEX_BAR_PARAMS]
        if(params and barType == params.type) then
            return true
        end
    end
    return false
end
function CenterScreenAnnounce:HasBarTypeInQueue(barType)
    for _, event in ipairs(self.m_displayQueue) do
        local currentParams = event[ARG_INDEX_BAR_PARAMS]
        if(currentParams and barType == currentParams.type) then
            return true
        end
    end
    return false
end
function CenterScreenAnnounce:RemoveNextEvent()
    return table.remove(self.m_displayQueue, 1)
end
function CenterScreenAnnounce:DisplayNextQueuedEvent()
    local nextEvent = self:RemoveNextEvent()
    self:DisplayMessage(nextEvent.category, unpack(nextEvent, 1, nextEvent.length))
    self.m_control:SetHandler("OnUpdate", nil)
end
function CenterScreenAnnounce:MoveSmallTextLinesUp(completedLine)
    self.m_lastSmallLineMovedOutOfTheWay = (#self.m_activeSmallTextLines == 0)
    local nextTop = completedLine:GetTop()
    for index, line in ipairs(self.m_activeSmallTextLines) do
        local distanceFromDestination = line:GetTop() - nextTop
        nextTop = nextTop + line.m_lineHeight
        local timeline = line.m_translateTimeline
        timeline:Stop()
        timeline:GetAnimation(1):SetTranslateDeltas(0, -distanceFromDestination)
        timeline:PlayFromStart()
    end
end
function CenterScreenAnnounce:IsTopLine(line)
    return (self.m_activeSmallTextLines[1] == line)
end
function CenterScreenAnnounce:TryDisplayingNextQueuedMessage()
    if(self.m_isQueueDirty) then
        self:SortQueue()
        self.m_isQueueDirty = false
    end
    local nextEvent = self:PeekNextEvent()
    if(nextEvent and self:CanDisplayMessage(nextEvent.category)) then
        self:DisplayNextQueuedEvent()
    end
end
function CenterScreenAnnounce:UpdateDisplay(completedLine, skipSmallBlockMove)
    if(self.m_displayMode == CSA_EVENT_SMALL_TEXT and not skipSmallBlockMove) then
        self:MoveSmallTextLinesUp(completedLine)
    end
end
function CenterScreenAnnounce:ReleaseLine(completedLine)
    self.m_activeLineCount = self.m_activeLineCount - 1
    if(completedLine.m_key) then
        completedLine:SetHandler("OnUpdate", nil)
        self.m_pool:ReleaseObject(completedLine.m_key)
        assert(self.m_activeSmallTextLines[1] == completedLine)
        table.remove(self.m_activeSmallTextLines, 1)
    elseif completedLine == self.m_largeTextContainer then
        self.m_largeText:SetHandler("OnUpdate", nil)
        self.m_smallCombinedText:SetHandler("OnUpdate", nil)
    end
end
function CenterScreenAnnounce:CheckNowInactive()
    if(self.m_activeLineCount == 0 and self.m_hasActiveBar == false) then
        self.m_displayMode = CSA_INACTIVE
    end
end
function CenterScreenAnnounce:ShouldRejectCategory(category)
    return self.allowedCategories[category] == false
end
function CenterScreenAnnounce:SetRejectCategory(category, reject)
    self.allowedCategories[category] = not reject
end
do
    local function SetDynamicTextHelper(label)
        label:SetText(label.dynamicTextFunction())
    end
    function TrySettingDynamicText(label, textOrFunction)
        if type(textOrFunction) == "function" then
            label.dynamicTextFunction = textOrFunction
            label:SetHandler("OnUpdate", SetDynamicTextHelper)
        else
            label:SetText(textOrFunction)
            label:SetHandler("OnUpdate", nil)
        end
    end
end
local setupFunctions =
{
    [CSA_EVENT_SMALL_TEXT] = function(self, ...)
        self.m_lastSmallLineMovedOutOfTheWay = false
        local line, poolKey = self.m_pool:AcquireObject()
        line.m_key = poolKey
        TrySettingDynamicText(line, select(ARG_INDEX_MESSAGE, ...))
        line.m_lineHeight = line:GetTextHeight()
        -- check for an overriding lifespan coming from the handlers, if not stick with the default
        local fadeOutAnimation = line.m_fadeOutTimeline:GetAnimation(1)
        local lifespan = select(ARG_INDEX_LIFESPAN, ...)
        if(lifespan) then
            line.m_fadeOutTimeline:SetAnimationOffset(fadeOutAnimation, lifespan)
               line.m_fadeOutTimeline:SetCallbackOffset(CallExpiringCallbackTimeline, lifespan)
        else
            line.m_fadeOutTimeline:SetAnimationOffset(fadeOutAnimation, DEFAULT_FADE_OUT_TIME)
               line.m_fadeOutTimeline:SetCallbackOffset(CallExpiringCallbackTimeline, DEFAULT_FADE_OUT_TIME)
        end
        line.m_fadeInTimeline:PlayFromStart()
        line:ClearAnchors()
        
        local numSmallText = #self.m_activeSmallTextLines + 1
        self.m_activeSmallTextLines[numSmallText] = line
        local initialLineOffset = IsInGamepadPreferredMode() and self.INITIAL_LINE_OFFSET_GAMEPAD or self.INITIAL_LINE_OFFSET_KEYBOARD
        local initialAnchorOffset = initialLineOffset
        local translateAnimationOffset = -initialLineOffset
        local translateTimeline = line.m_translateTimeline
        if(numSmallText > 1) then
            local totalLinesHeight = 0
            for i = 1, numSmallText - 1 do -- don't include the latest line, we don't care about its height
                totalLinesHeight = totalLinesHeight + self.m_activeSmallTextLines[i].m_lineHeight
            end
            if(totalLinesHeight >= initialAnchorOffset) then
                translateAnimationOffset = nil
                initialAnchorOffset = totalLinesHeight
            else
                translateAnimationOffset = -(initialLineOffset - totalLinesHeight)
            end
        end
        line:SetAnchor(TOP, nil, TOP, 0, initialAnchorOffset) -- lines always appear at the bottom and scroll up
        if(translateAnimationOffset ~= nil) then
            translateTimeline:GetAnimation(1):SetTranslateDeltas(0, translateAnimationOffset)
            translateTimeline:PlayFromStart()
        end
        return line
    end,
    [CSA_EVENT_LARGE_TEXT] = function(self, ...)
        TrySettingDynamicText(self.m_largeText, select(ARG_INDEX_MESSAGE, ...))
        TrySettingDynamicText(self.m_smallCombinedText, "")
        
        -- check for an overriding lifespan coming from the handlers, if not stick with the default
        local fadeOutAnimation = self.m_largeTextContainer.m_timeline:GetAnimation(2)
        local lifespan = select(ARG_INDEX_LIFESPAN, ...)
        if(lifespan) then
            self.m_largeTextContainer.m_timeline:SetAnimationOffset(fadeOutAnimation, lifespan)
               self.m_largeTextContainer.m_timeline:SetCallbackOffset(CallExpiringCallbackTimeline, lifespan)
        else
            self.m_largeTextContainer.m_timeline:SetAnimationOffset(fadeOutAnimation, DEFAULT_FADE_OUT_TIME)
               self.m_largeTextContainer.m_timeline:SetCallbackOffset(CallExpiringCallbackTimeline, DEFAULT_FADE_OUT_TIME)
        end
        self.m_largeTextContainer.m_timeline:PlayFromStart()
        self.m_largeTextContainer.m_timeline.beforeExpiring = true
        self.m_smallCombinedIcon:SetHidden(true)
        return self.m_largeTextContainer
    end,
    [CSA_EVENT_COMBINED_TEXT] = function(self, ...)
        local smallText = self.m_smallCombinedText
        TrySettingDynamicText(self.m_largeText, select(ARG_INDEX_MESSAGE, ...))
        TrySettingDynamicText(smallText, select(ARG_INDEX_COMBINED_MESSAGE, ...))
        -- check for an overriding lifespan coming from the handlers, if not stick with the default
        local fadeOutAnimation = self.m_largeTextContainer.m_timeline:GetAnimation(2)
        local lifespan = select(ARG_INDEX_LIFESPAN, ...)
        if(lifespan) then
            self.m_largeTextContainer.m_timeline:SetAnimationOffset(fadeOutAnimation, lifespan)
               self.m_largeTextContainer.m_timeline:SetCallbackOffset(CallExpiringCallbackTimeline, lifespan)
        else
            self.m_largeTextContainer.m_timeline:SetAnimationOffset(fadeOutAnimation, DEFAULT_FADE_OUT_TIME)
               self.m_largeTextContainer.m_timeline:SetCallbackOffset(CallExpiringCallbackTimeline, DEFAULT_FADE_OUT_TIME)
        end
        self.m_largeTextContainer.m_timeline:PlayFromStart()
        self.m_largeTextContainer.m_timeline.beforeExpiring = true
        -- NOTE: Combined text is the only thing that uses icons for now...and only on the small text label.
        local icon = select(ARG_INDEX_ICON, ...)
        local iconControl = self.m_smallCombinedIcon
        iconControl:SetHidden(icon == nil)
        iconControl:GetNamedChild("Frame"):SetHidden(select(ARG_INDEX_SUPPRESS_FRAME, ...) == CSA_OPTION_SUPPRESS_ICON_FRAME)
        
        if(icon) then
            iconControl:SetTexture(icon)
            AnchorIconToText(iconControl, smallText)
        end
        local iconBG = select(ARG_INDEX_ICON_BG, ...)
        self.m_smallCombinedIconBG:SetHidden(iconBG == nil)
        if(iconBG) then
            self.m_smallCombinedIconBG:SetTexture(iconBG)
        end
        return self.m_largeTextContainer
    end,
    [CSA_EVENT_NO_TEXT] = function(self, ...)
        return nil
    end,
}
function CenterScreenAnnounce:SetExpiringCallback(line, callback)
    line.m_expiringCallback = callback
end
function CenterScreenAnnounce:CallExpiringCallback(control)
    if(control.m_expiringCallback) then
        control.m_expiringCallback()
        control.m_expiringCallback = nil
    end
    if(control.m_timeline) then
        control.m_timeline.beforeExpiring = false
    end
    if(PLAYER_PROGRESS_BAR:GetOwner() == self) then
        PLAYER_PROGRESS_BAR:SetHoldBeforeFadeOut(false)
    end
end
function CenterScreenAnnounce:DisplayMessage(category, ...)
    if self:ShouldRejectCategory(category) then
        return
    end
     SYSTEMS:GetObject("craftingResults"):ClearAll()
    local setupFunction = setupFunctions[category]
    if(setupFunction) then
        self.m_displayMode = category
        local displayLine = setupFunction(self, ...)
        if(displayLine) then
            self:SetExpiringCallback(displayLine, select(ARG_INDEX_EXPIRING_CALLBACK, ...))
            self.m_activeLineCount = self.m_activeLineCount + 1
        end
        local soundId = select(ARG_INDEX_SOUND, ...)
        if(soundId) then PlaySound(soundId) end
        local barParams = select(ARG_INDEX_BAR_PARAMS, ...)
        if(barParams and (category == CSA_EVENT_LARGE_TEXT or category == CSA_EVENT_COMBINED_TEXT or category == CSA_EVENT_NO_TEXT)) then
            local barType, startLevel, start, stop, sound = barParams:GetParams()
            if(stop - start > 0 or barParams.showNoGain) then
                self.m_hasActiveBar = true
                PLAYER_PROGRESS_BAR:ShowIncrease(barType, startLevel, start, stop, sound, category == CSA_EVENT_NO_TEXT and 0 or 500, self)
            end
            self.m_barParamsPool:ReleaseObject(barParams.key)
        end
    end
end
local ALLOWED_EVENTS_WHILE_CRAFTING = {
    [EVENT_QUEST_ADDED] = true,
    [EVENT_QUEST_CONDITION_COUNTER_CHANGED] = true,
    [EVENT_QUEST_ADVANCED] = true,
    [EVENT_QUEST_COMPLETE] = true,
    [EVENT_OBJECTIVE_COMPLETED] = true,
    [EVENT_QUEST_OPTIONAL_STEP_ADVANCED] = true,
    [EVENT_ACHIEVEMENT_AWARDED] = true
}
function CenterScreenAnnounce:AddMessage(eventId, category, ...)
    if(category ~= nil) then
        local barParams = select(ARG_INDEX_BAR_PARAMS, ...)
        if(category == CSA_EVENT_NO_TEXT and barParams == nil) then
            return
        end
        -- prevent unwanted announcements from appearing when the user is crafting
        if ZO_CraftingUtils_IsCraftingWindowOpen() and not ALLOWED_EVENTS_WHILE_CRAFTING[eventId] then
            return
        end
        -- Checking the recency of the message should be sufficient for duplicate messages
        -- Otherwise, this needs to combine the full message text into a single string and check the recency of that.
        -- MLR: Changing to use the Combined message when available because when multiple similar messages come in on the same frame,
        -- the recency sees them as the same message and only the first will display.
        local message = select(ARG_INDEX_COMBINED_MESSAGE, ...) or select(ARG_INDEX_MESSAGE, ...)
        if(message == nil or self.m_recentMessages:ShouldDisplayMessage(message)) then
            self:QueueMessage(eventId, category, ...)
        else
            local expiringCallback = select(ARG_INDEX_EXPIRING_CALLBACK, ...)
            if expiringCallback then
                expiringCallback()
            end
        end
    end
end
-- Exposed so that external code can add custom events with appropriate priorities
local nextAutoPriority = 1
function ZO_CenterScreenAnnounce_SetEventPriority(eventId, priority)
    if(priority == nil) then
        priority = nextAutoPriority
        nextAutoPriority = nextAutoPriority + 1
    end
    
    messagePriorities[eventId] = priority
end
    CENTER_SCREEN_ANNOUNCE = CenterScreenAnnounce:New(self)
    local handlers = ZO_CenterScreenAnnounce_GetHandlers()
    local function OnCenterScreenEvent(eventId, ...)
        if handlers[eventId] then
            CENTER_SCREEN_ANNOUNCE:AddMessage(eventId, handlers[eventId](...))
        end
    end
    for event in pairs(handlers) do
        self:RegisterForEvent(event, OnCenterScreenEvent)
    end
end