Back to Home

ESO Lua File v101038

publicallingames/tribute/tributecard.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
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
local NO_CARD = 0
local TRIBUTE_CARD_ATLAS_FILE_DIMENSIONS = 512
ZO_TRIBUTE_CARD_UI_WIDTH = 284
ZO_TRIBUTE_CARD_UI_HEIGHT = 493
ZO_TRIBUTE_CARD_TOP_COORD = 0
ZO_TRIBUTE_CARD_BOTTOM_COORD = ZO_TRIBUTE_CARD_UI_HEIGHT / TRIBUTE_CARD_ATLAS_FILE_DIMENSIONS
ZO_TRIBUTE_CARD_LEFT_COORD = 0
ZO_TRIBUTE_CARD_RIGHT_COORD = ZO_TRIBUTE_CARD_UI_WIDTH / TRIBUTE_CARD_ATLAS_FILE_DIMENSIONS
local TRIBUTE_CARD_WORLD_WIDTH = 0.1115
ZO_TRIBUTE_CARD_WORLD_SCALE = TRIBUTE_CARD_WORLD_WIDTH / ZO_TRIBUTE_CARD_UI_WIDTH
ZO_TRIBUTE_SUIT_ICON_DIMENSIONS = 64
ZO_TRIBUTE_SUIT_ICON_TOP_COORD = 0
ZO_TRIBUTE_SUIT_ICON_BOTTOM_COORD = ZO_TRIBUTE_SUIT_ICON_DIMENSIONS / TRIBUTE_CARD_ATLAS_FILE_DIMENSIONS
ZO_TRIBUTE_SUIT_ICON_LEFT_COORD = (TRIBUTE_CARD_ATLAS_FILE_DIMENSIONS - ZO_TRIBUTE_SUIT_ICON_DIMENSIONS) / TRIBUTE_CARD_ATLAS_FILE_DIMENSIONS
ZO_TRIBUTE_SUIT_ICON_RIGHT_COORD = 1
local TRIBUTE_CARD_COLOR_DAMAGED = ZO_ColorDef:New(ZO_ColorDef.HexToFloats("fff25454"))
local TRIBUTE_CARD_COLOR_HEALED = ZO_ColorDef:New(ZO_ColorDef.HexToFloats("ff2adc22"))
local MECHANIC_CONTAINER_LARGE_ACTIVATION_HEIGHT = 55
local MECHANIC_CONTAINER_LARGE_COMBO_HEIGHT = 55
local MECHANIC_CONTAINER_SMALL_ACTIVATION_HEIGHT = 41
local MECHANIC_CONTAINER_SMALL_COMBO_HEIGHT = 41
ZO_MECHANIC_TYPE_ICON_LARGE_DIMENSIONS = 32
ZO_MECHANIC_TYPE_ICON_SMALL_DIMENSIONS = 24
local TRIBUTE_CARD_STATE_EFFECT_LAYER_OVERLAY = 1
local TRIBUTE_CARD_STATE_EFFECT_LAYER_UNDERLAY = 2
local TRIBUTE_CARD_STATE_EFFECT_LAYERS =
{
    TRIBUTE_CARD_STATE_EFFECT_LAYER_OVERLAY,
    TRIBUTE_CARD_STATE_EFFECT_LAYER_UNDERLAY,
}
local TRIBUTE_CARD_STATE_EFFECT_CONTROL_TEMPLATES =
{
    [TRIBUTE_CARD_STATE_FLAGS_BUYABLE] =
    {
        [TRIBUTE_CARD_STATE_EFFECT_LAYER_OVERLAY] = "ZO_TributeCard_BuyableOverlay_Template",
        [TRIBUTE_CARD_STATE_EFFECT_LAYER_UNDERLAY] = "ZO_TributeCard_BuyableUnderlay_Template",
    },
    [TRIBUTE_CARD_STATE_FLAGS_DAMAGEABLE] =
    {
        [TRIBUTE_CARD_STATE_EFFECT_LAYER_OVERLAY] = "ZO_TributeCard_DamageableOverlay_Template",
        [TRIBUTE_CARD_STATE_EFFECT_LAYER_UNDERLAY] = "ZO_TributeCard_DamageableUnderlay_Template",
    },
    [TRIBUTE_CARD_STATE_FLAGS_PLAYABLE] =
    {
        [TRIBUTE_CARD_STATE_EFFECT_LAYER_OVERLAY] = "ZO_TributeCard_PlayableOverlay_Template",
        [TRIBUTE_CARD_STATE_EFFECT_LAYER_UNDERLAY] = "ZO_TributeCard_PlayableUnderlay_Template",
    },
    [TRIBUTE_CARD_STATE_FLAGS_TARGETABLE] =
    {
        [TRIBUTE_CARD_STATE_EFFECT_LAYER_OVERLAY] = "ZO_TributeCard_TargetableOverlay_Template",
        [TRIBUTE_CARD_STATE_EFFECT_LAYER_UNDERLAY] = "ZO_TributeCard_TargetableUnderlay_Template",
    },
    [TRIBUTE_CARD_STATE_FLAGS_TARGETED] =
    {
        [TRIBUTE_CARD_STATE_EFFECT_LAYER_OVERLAY] = "ZO_TributeCard_TargetedOverlay_Template",
        [TRIBUTE_CARD_STATE_EFFECT_LAYER_UNDERLAY] = "ZO_TributeCard_TargetedUnderlay_Template",
    },
    [TRIBUTE_CARD_STATE_FLAGS_STACK_PLAYABLE] =
    {
        [TRIBUTE_CARD_STATE_EFFECT_LAYER_OVERLAY] = "ZO_TributeCard_StackPlayableOverlay_Template",
        [TRIBUTE_CARD_STATE_EFFECT_LAYER_UNDERLAY] = "ZO_TributeCard_StackPlayableUnderlay_Template",
    },
    [TRIBUTE_CARD_STATE_FLAGS_STACK_DAMAGEABLE] =
    {
        [TRIBUTE_CARD_STATE_EFFECT_LAYER_OVERLAY] = "ZO_TributeCard_StackDamageableOverlay_Template",
        [TRIBUTE_CARD_STATE_EFFECT_LAYER_UNDERLAY] = "ZO_TributeCard_StackDamageableUnderlay_Template",
    },
    [TRIBUTE_CARD_STATE_FLAGS_CALLOUT] =
    {
        [TRIBUTE_CARD_STATE_EFFECT_LAYER_OVERLAY] = "ZO_TributeCard_CalloutOverlay_Template",
        [TRIBUTE_CARD_STATE_EFFECT_LAYER_UNDERLAY] = "ZO_TributeCard_CalloutUnderlay_Template",
    },
}
local TRIBUTE_PILE_TOOLTIP_BOARD_LOCATIONS =
{
    TRIBUTE_BOARD_LOCATION_OPPONENT_BOARD_ACTION,
    TRIBUTE_BOARD_LOCATION_OPPONENT_BOARD_AGENT,
    TRIBUTE_BOARD_LOCATION_OPPONENT_COOLDOWN,
    TRIBUTE_BOARD_LOCATION_OPPONENT_DECK,
    TRIBUTE_BOARD_LOCATION_PLAYER_BOARD_ACTION,
    TRIBUTE_BOARD_LOCATION_PLAYER_BOARD_AGENT,
    TRIBUTE_BOARD_LOCATION_PLAYER_COOLDOWN,
    TRIBUTE_BOARD_LOCATION_PLAYER_DECK,
}
local IGNORE_ANIMATION_CALLBACKS = true
-- Mechanic Container --
ZO_TributeCard_MechanicContainer = ZO_PooledObject:Subclass()
function ZO_TributeCard_MechanicContainer:Initialize(control)
    self.control = control
    control.object = self
    self.frameTexture = control:GetNamedChild("Frame")
    self.typeIconTexture = control:GetNamedChild("TypeIcon")
    self.quantityLabel = control:GetNamedChild("Quantity")
end
do
    internalassert(TRIBUTE_MECHANIC_ACTIVATION_SOURCE_ITERATION_END == 1, "A new Tribute mechanic activation source has been added. Please add it to the MECHANIC_ACTIVATION_SOURCE_SUFFIX table")
    local MECHANIC_ACTIVATION_SOURCE_SUFFIX =
    {
        [TRIBUTE_MECHANIC_ACTIVATION_SOURCE_ACTIVATION] = "Activation",
        [TRIBUTE_MECHANIC_ACTIVATION_SOURCE_COMBO] = "Combo",
    }
    internalassert(TRIBUTE_MECHANIC_ITERATION_END == 15, "A new Tribute mechanic has been added. Does the MECHANIC_PARAM_MODIFIERS need special modifiers for this mechanic?")
    local MECHANIC_PARAM_MODIFIERS =
    {
        [TRIBUTE_MECHANIC_HEAL_AGENT] =
        {
            quantityDisplayOverride =
            {
                displayParam = 1,
            }
        },
        [TRIBUTE_MECHANIC_ACQUIRE_CARDS] =
        {
            quantityDisplayOverride =
            {
                displayParam = 1,
            }
        },
    }
    local OFFSET_X = 42
    local LARGE_DOUBLE_DIGIT_OFFSET_X = 52
    local FIRST_TOP_OFFSET_Y = 135
    local LARGE_PADDING_Y = 15
    local SMALL_PADDING_Y = 10
    local OVERSIZED_SCALE = 1.2
    local OVERSIZED_PADDING_Y = 6
    function ZO_TributeCard_MechanicContainer:Setup(cardObject, activationSource, mechanicIndex)
        local control = self.control
        self.cardDefId = cardObject:GetCardDefId()
        self.activationSource = activationSource
        self.mechanicIndex = mechanicIndex
        local triggerId
        self.tributeMechanicType, self.quantity, self.comboNum, self.param1, self.param2, self.param3, triggerId = cardObject:GetMechanicInfo(activationSource, mechanicIndex)
        self.numSiblings = cardObject:GetNumMechanics(activationSource)
        local isOnActivation = activationSource == TRIBUTE_MECHANIC_ACTIVATION_SOURCE_ACTIVATION
        local isOnCombo = activationSource == TRIBUTE_MECHANIC_ACTIVATION_SOURCE_COMBO
        local isOnTrigger = triggerId ~= 0
        local chooseOneMechanic = isOnActivation and cardObject:DoesChooseOneMechanic()
        local isOversized = self.numSiblings <= 2
        local scale = isOversized and OVERSIZED_SCALE or 1
        control:SetScale(scale)
        if chooseOneMechanic then
            -- Quick and dirty workaround. The choice display isn't actually a mechanic, it replaces all of the mechanics on the card as one unified concept
            -- TODO Tribute: If we want to change to let design control which mechanics require choice, or work with combos, this logic will be useless and will need to be reimplemented
            if mechanicIndex == 1 then
                ApplyTemplateToControl(control, "ZO_TributeCard_MechanicContainer_Large_SingleDigit_Activation_Style")
                self.typeIconTexture:SetTexture("EsoUI/Art/Tribute/Mechanics/tributeMechanicCardDisplay_chooseOne.dds")
                self.quantityLabel:SetText(self.numSiblings)
                local offsetY = FIRST_TOP_OFFSET_Y + (MECHANIC_CONTAINER_LARGE_ACTIVATION_HEIGHT / 2 * OVERSIZED_SCALE)
                control:SetAnchor(CENTER, nil, TOPLEFT, OFFSET_X, offsetY)
            else
                control:SetHidden(true)
            end
            return
        end
        local isSmallContainer = self.numSiblings >= 4
        local activationSourceSuffix = isOnTrigger and "Trigger" or MECHANIC_ACTIVATION_SOURCE_SUFFIX[activationSource]
        local sizeSuffix = isSmallContainer and "Small" or "Large"
        local quantityDisplayValue = self.quantity
        local paramModifiers = MECHANIC_PARAM_MODIFIERS[self.tributeMechanicType]
        if paramModifiers then
            local paramQuantityDisplayOverride = paramModifiers.quantityDisplayOverride
            if paramQuantityDisplayOverride then
                if paramQuantityDisplayOverride.displayParam == 1 then
                    quantityDisplayValue = self.param1
                elseif paramQuantityDisplayOverride.displayParam == 2 then
                    quantityDisplayValue = self.param2
                elseif paramQuantityDisplayOverride.displayFunction then
                    quantityDisplayValue = paramQuantityDisplayOverride.displayFunction(self.param1, self.param2)
                else
                    quantityDisplayValue = paramQuantityDisplayOverride[self.param1]
                end
            end
        end
        local isDoubleDigitContainer = quantityDisplayValue >= 10
        local digitsSuffix = isDoubleDigitContainer and "Double" or "Single"
        ApplyTemplateToControl(control, string.format("ZO_TributeCard_MechanicContainer_%s_%sDigit_%s_Style", sizeSuffix, digitsSuffix, activationSourceSuffix))
        self.typeIconTexture:SetTexture(GetTributeMechanicIconPath(self.tributeMechanicType, self.param1, self.param2, self.param3))
        local quantityDisplayText = quantityDisplayValue == 0 and GetString(SI_TRIBUTE_MECHANIC_ANY_QUANTITY_SYMBOL) or quantityDisplayValue
        self.quantityLabel:SetText(quantityDisplayText)
        self.frameGlowTextureFileName = string.format("EsoUI/Art/Tribute/Mechanics/tributeMechanicCardFrame_%s_%s_%s_glow.dds", activationSourceSuffix, sizeSuffix, digitsSuffix)
        -- Add pips to combo hexes.
        -- Combo 2 has no pips. Combo 3 has 1 pip. Combo 4 has 2 pips...
        if isOnCombo and self.comboNum > 2 then
            if not self.pipsLabel then
                self.pipsLabel = CreateControlFromVirtual("$(parent)Pips", control, "ZO_TributeCard_MechanicComboPip_Template")
            end
            local pipSize = isSmallContainer and 14 or 16
            local offsetY = isSmallContainer and 17 or 24
            local pipTextureMarkup = zo_iconFormat("EsoUI/Art/Tribute/Mechanics/tributeMechanicComboPip_full.dds", pipSize, pipSize)
            local numPips = self.comboNum - 2
            self.pipsLabel:SetText(string.rep(pipTextureMarkup, numPips))
            self.pipsLabel:SetAnchor(CENTER, control, CENTER, 0, offsetY)
        end
        local offsetX = OFFSET_X
        local height
        local paddingY
        if isSmallContainer then
            height = isOnActivation and MECHANIC_CONTAINER_SMALL_ACTIVATION_HEIGHT or MECHANIC_CONTAINER_SMALL_COMBO_HEIGHT
            paddingY = SMALL_PADDING_Y
        else
            height = isOnActivation and MECHANIC_CONTAINER_LARGE_ACTIVATION_HEIGHT or MECHANIC_CONTAINER_LARGE_COMBO_HEIGHT
            height = height * scale
            paddingY = LARGE_PADDING_Y
            if isDoubleDigitContainer then
                offsetX = LARGE_DOUBLE_DIGIT_OFFSET_X
            end
        end
        
        local firstCenterOffsetY = FIRST_TOP_OFFSET_Y + (height / 2)
        local offsetY = firstCenterOffsetY + ((height + paddingY) * (mechanicIndex - 1))
        if isOnActivation then
            control:SetAnchor(CENTER, nil, TOPLEFT, offsetX, offsetY)
        else
            control:SetAnchor(CENTER, nil, TOPRIGHT, -offsetX, offsetY)
        end
    end
end
function ZO_TributeCard_MechanicContainer:Reset()
    self:SetGlowHidden(true)
    if self.pipsLabel then
        self.pipsLabel:SetText("")
    end
    self.cardDefId = nil
    self.activationSource = nil
    self.mechanicIndex = nil
    self.tributeMechanicType = nil
    self.quantity = nil
    self.param1 = nil
    self.param2 = nil
    self.param3 = nil
    self.numSiblings = nil
    self.frameGlowTextureFileName = nil
end
function ZO_TributeCard_MechanicContainer:GetControl()
    return self.control
end
function ZO_TributeCard_MechanicContainer:GetActivationSourceAndIndex()
    return self.activationSource, self.mechanicIndex
end
function ZO_TributeCard_MechanicContainer:GetFrameGlowTextureFileName()
    return self.frameGlowTextureFileName
end
function ZO_TributeCard_MechanicContainer:SetGlowHidden(hidden)
    if hidden then
        if self.frameGlowTexture then
            TRIBUTE_POOL_MANAGER:GetMechanicGlowPool():ReleaseObject(self.frameGlowTexture.key)
            self.frameGlowTexture = nil
        end
    else
        if not self.frameGlowTexture then
            self.frameGlowTexture = TRIBUTE_POOL_MANAGER:GetMechanicGlowPool():AcquireObject(self)
        end
    end
end
-- Card Defeat Cost Adjustment --
ZO_TributeCard_DefeatCostAdjustment = ZO_InitializingObject:Subclass()
function ZO_TributeCard_DefeatCostAdjustment:Initialize(cardObject)
    self.cardObject = cardObject
    local frontControl = self.cardObject:GetFrontControl()
    self.control = CreateControlFromVirtual("$(parent)DefeatCostAdjustment", frontControl, "ZO_TributeCard_DefeatCostAdjustment")
    self.bannerTexture = self.control:GetNamedChild("Banner")
    self.baseBannerTexture = frontControl:GetNamedChild("DefeatCostBanner")
    self.anchorToControl = frontControl:GetNamedChild("NameBanner")
    local timeline = ANIMATION_MANAGER:CreateTimelineFromVirtual("ZO_TributeCard_DefeatCostAdjustmentTimeline")
    self.timeline = timeline
    timeline.object = self
    self.queue = {}
    self:Reset()
end
function ZO_TributeCard_DefeatCostAdjustment:Reset()
    ZO_ClearTable(self.queue)
    self:ResetVisuals()
end
function ZO_TributeCard_DefeatCostAdjustment:ResetVisuals()
    local control = self.control
    control:SetHidden(true)
    control:SetAlpha(0)
    control:SetAnchor(TOP, self.anchorToControl, nil, nil, 30)
    control:SetScale(1)
    local bannerTexture = self.bannerTexture
    bannerTexture:SetScale(1)
    -- Order matters
    self.currentEntry = nil
    self.targetOffsetX = nil
    self.targetOffsetY = nil
    self.timeline:PlayInstantlyToStart()
end
do
    local function TryShowNextQueueEntry(self, queueEntry)
        if self.currentEntry then
            if queueEntry then
                -- An animation is already playing; queue this entry.
                table.insert(self.queue, queueEntry)
            end
            return
        end
        local nextQueueEntry = table.remove(self.queue, 1)
        if nextQueueEntry then
            if queueEntry then
                -- The queue is not empty; queue this entry and play the next entry from the queue.
                table.insert(self.queue, queueEntry)
            end
        else
            nextQueueEntry = queueEntry
        end
        if not nextQueueEntry then
            -- The queue is empty and no queue entry was specified.
            return
        end
        -- Order matters
        self.currentEntry = nextQueueEntry
        self:OnTimelineStarted()
        self.timeline:PlayForward()
    end
    function ZO_TributeCard_DefeatCostAdjustment:UpdateDefeatCost(newCost, costDelta)
        -- Queue this animation or, if the queue is empty and no animation is already playing, play it immediately.
        local queueEntry =
        {
            oldCost = newCost - costDelta,
            newCost = newCost,
            costDelta = costDelta,
        }
        TryShowNextQueueEntry(self, queueEntry)
    end
    function ZO_TributeCard_DefeatCostAdjustment:OnTimelineStopped()
        if self.currentEntry then
            -- Order matters
            self:ResetVisuals()
            TryShowNextQueueEntry(self)
        end
    end
end
function ZO_TributeCard_DefeatCostAdjustment:OnTimelineStarted()
    local entry = self.currentEntry
    if not entry then
        -- No animation is currently playing.
        return
    end
    local control = self.control
    control:SetText(string.format("%s%d", entry.costDelta > 0 and "+" or "", entry.costDelta))
    -- Interpolate the font color based upon whether this is a damage or healing event.
    if entry.costDelta < 0 then
        self.startFontColor = TRIBUTE_CARD_COLOR_DAMAGED
    else
        self.startFontColor = TRIBUTE_CARD_COLOR_HEALED
    end
    self.endFontColor = self.startFontColor:GetBright()
    control:SetColor(self.startFontColor:UnpackRGBA())
    local cardBannerTextureFileName = self.cardObject:GetDefeatCostTextureFile()
    self.bannerTexture:SetTexture(cardBannerTextureFileName)
    -- Translate upward and to either the left or right randomly.
    local MIN_OFFSET = 90
    local MAX_OFFSET = 100
    local targetOffset = zo_lerp(MIN_OFFSET, MAX_OFFSET, zo_random())
    if zo_random() < 0.5 then
        self.targetOffsetX = -targetOffset
    else
        self.targetOffsetX = targetOffset
    end
    self.targetOffsetY = 30 - targetOffset * 0.25
    -- Animate over slightly varied durations to reduce repetitiveness.
    local MIN_DURATION_MS = 1900
    local MAX_DURATION_MS = 2100
    local durationMS = zo_lerp(MIN_DURATION_MS, MAX_DURATION_MS, zo_random())
    local animation = self.timeline:GetFirstAnimation()
    animation:SetDuration(durationMS)
    control:SetHidden(false)
end
function ZO_TributeCard_DefeatCostAdjustment:OnTimelineUpdate(progress)
    local entry = self.currentEntry
    if not entry then
        -- No animation is currently playing.
        return
    end
    -- Interpolate the banner texture scale.
    local easeOut = ZO_EaseOutQuadratic(progress)
    self.bannerTexture:SetScale(zo_lerp(1, 1.75, easeOut))
    local control = self.control
    -- Translate the control up and to the left/right.
    local interpolatedOffsetX = zo_lerp(0, self.targetOffsetX, easeOut)
    local interpolatedOffsetY = zo_lerp(30, self.targetOffsetY, ZO_EaseOutQuartic(progress))
    control:SetAnchor(CENTER, self.anchorToControl, nil, interpolatedOffsetX, interpolatedOffsetY)
    -- Interpolate the font color from dim to bright while gradually fading the control away.
    local r, g, b = self.startFontColor:Lerp(self.endFontColor, easeOut):UnpackRGB()
    local a = progress < 0.75 and 1 or (1 - (progress - 0.75) * 4)
    control:SetColor(r, g, b, a)
end
-- Card State Effect --
ZO_TributeCard_StateEffect = ZO_PooledObject:Subclass()
function ZO_TributeCard_StateEffect:Initialize(control)
    self.control = control
    control.object = self
    self:Reset()
end
function ZO_TributeCard_StateEffect:InitializeAnimation()
    local timeline = ANIMATION_MANAGER:CreateTimelineFromVirtual("ZO_TributeCard_StateEffectTimeline")
    self.timeline = timeline
    timeline.object = self
end
do
    -- Used for diversification of animation visuals.
    local nextAnimationOffset = 0
    local MIN_WAVE_ANGLE = ZO_PI - ZO_HALF_PI
    local MAX_WAVE_ANGLE = ZO_PI + ZO_HALF_PI
    function ZO_TributeCard_StateEffect:Setup(cardObject, cardState, cardLayer)
        self.cardObject = cardObject
        self.cardState = cardState
        self.cardLayer = cardLayer
        internalassert(self:IsValid(), "Tribute card state effect 'cardObject', 'cardState' or 'cardLayer' is invalid.")
        local control = self.control
        local controlTemplate = self:GetControlTemplate()
        ApplyTemplateToControl(control, controlTemplate)
        local parentControl = self.cardObject.control
        control:SetParent(parentControl)
        control:ClearAnchors()
        control:SetAnchor(CENTER, parentControl)
        nextAnimationOffset = nextAnimationOffset + 1
        local offset = ((nextAnimationOffset % 10) + 1) / 10
        control:SetWaveOffset(offset * 20)
        control:SetWaveAngle(zo_lerp(MIN_WAVE_ANGLE, MAX_WAVE_ANGLE, offset))
        control:SetHidden(false)
        self:SetActive(true)
    end
end
function ZO_TributeCard_StateEffect:Reset()
    -- Order matters
    self.cardObject = nil
    self.cardState = nil
    self.cardLayer = nil
    self.control:SetHidden(true)
    self.timeline:PlayInstantlyToStart()
end
function ZO_TributeCard_StateEffect:GetCardObject()
    return self.cardObject
end
function ZO_TributeCard_StateEffect:GetCardState()
    return self.cardState
end
function ZO_TributeCard_StateEffect:GetCardLayer()
    return self.cardLayer
end
function ZO_TributeCard_StateEffect:GetControlTemplate()
    local stateEffectTemplates = TRIBUTE_CARD_STATE_EFFECT_CONTROL_TEMPLATES[self.cardState]
    if not stateEffectTemplates then
        internalassert(false, string.format("No card state effect template configured for Tribute card state '%s'.", tostring(self.cardState) or "nil"))
    end
    local controlTemplate = stateEffectTemplates[self.cardLayer]
    if not controlTemplate then
        internalassert(false, string.format("Layer '%s' does not exist for card state effect template '%s'.", tostring(self.cardLayer) or "nil", tostring(self.cardState)))
    end
    return controlTemplate
end
function ZO_TributeCard_StateEffect:IsValid()
    return self.cardObject ~= nil and self.cardState ~= nil and self.cardLayer ~= nil
end
function ZO_TributeCard_StateEffect:IsActive()
    return not self.timeline:IsPlayingBackward() and (self.timeline:IsPlaying() or self.timeline:GetProgress() > 0)
end
function ZO_TributeCard_StateEffect:SetActive(active)
    if self:IsValid() and active ~= self:IsActive() then
        if active then
            self.timeline:PlayForward()
        else
            self.timeline:PlayBackward()
        end
    end
end
function ZO_TributeCard_StateEffect:OnStateEffectTimelineStopped(completedPlaying)
    if self:IsValid() then
        self.cardObject:OnStateEffectChanged(self, self:IsActive())
    end
end
-- Trigger Animation --
ZO_TributeCard_TriggerAnimation = ZO_TributeCard_StateEffect:Subclass()
function ZO_TributeCard_TriggerAnimation:InitializeAnimation()
    local timeline = ANIMATION_MANAGER:CreateTimelineFromVirtual("ZO_TributeCard_TriggerAnimationTimeline")
    self.timeline = timeline
    timeline.object = self
end
function ZO_TributeCard_StateEffect:Reset()
    -- Order matters
    self.cardObject = nil
    self.cardState = nil
    self.cardLayer = nil
    self.control:SetHidden(true)
    self.timeline:PlayInstantlyToStart(IGNORE_ANIMATION_CALLBACKS)
end
function ZO_TributeCard_TriggerAnimation:GetControlTemplate()
    local layer = self.cardLayer == TRIBUTE_CARD_STATE_EFFECT_LAYER_OVERLAY and "Overlay" or "Underlay"
    local controlTemplate = string.format("ZO_TributeCard_TriggerAnimation%s_Template", layer)
    return controlTemplate
end
function ZO_TributeCard_TriggerAnimation:IsValid()
    return self.cardObject ~= nil and self.cardLayer ~= nil
end
function ZO_TributeCard_TriggerAnimation:IsActive()
    return self.timeline:IsPlaying()
end
function ZO_TributeCard_TriggerAnimation:SetActive(active)
    if self:IsValid() and active ~= self:IsActive() then
        if active then
            self.timeline:PlayFromStart()
        else
            self.timeline:PlayInstantlyToEnd(IGNORE_ANIMATION_CALLBACKS)
        end
    end
end
function ZO_TributeCard_TriggerAnimation:OnStateEffectTimelineStopped(completedPlaying)
    if self:IsValid() then
        self.cardObject:OnTriggerAnimationComplete(self, completedPlaying)
    end
end
-- Card --
ZO_TributeCard = ZO_InitializingObject:MultiSubclass(ZO_PooledObject, ZO_TributeCardData)
function ZO_TributeCard:Initialize(control)
    ZO_TributeCardData.Initialize(self)
    self.control = control
    control.object = self
    local frontControl = control:GetNamedChild("Front")
    self.frontControl = frontControl
    self.bgGlowableTexture = frontControl:GetNamedChild("BG")
    self.portraitGlowableTexture = frontControl:GetNamedChild("Portrait")
    self.frameGlowableTexture = frontControl:GetNamedChild("Frame")
    self.suitGlowableTexture = frontControl:GetNamedChild("Suit")
    self.nameLabel = frontControl:GetNamedChild("Name")
    self.contractOrCurseBannerTexture = frontControl:GetNamedChild("ContractOrCurseBanner")
    self.costLabel = frontControl:GetNamedChild("Cost")
    self.costIconTexture = self.costLabel:GetNamedChild("Icon")
    self.defeatCostLabel = frontControl:GetNamedChild("DefeatCost")
    if self.defeatCostLabel then
        self.defeatCostBannerTexture = self.defeatCostLabel:GetNamedChild("Banner")
    end
    self.backGlowableTexture = control:GetNamedChild("Back")
    self.mechanicContainers = {}
    self.numMechanicsByActivationSource = {}
    self.stateEffects = {}
    self.triggerAnimations = {}
    self:Reset()
end
function ZO_TributeCard:Setup(cardDefId, patronDefId, overrideSpace)
    ZO_TributeCardData.Setup(self, patronDefId, cardDefId)
    if overrideSpace and overrideSpace ~= self.control:GetParent():GetSpace() then
        self.control:SetSpace(overrideSpace)
    end
    self.popupType = nil
    if self:IsWorldCard() then
        self.control:SetAnchor(CENTER, GuiRoot)
    end
    local patronData = self:GetPatronData()
    local suitAtlasImage, suitAtlasGlowImage = patronData:GetSuitAtlas(self:GetCardType())
    local portraitImage, portraitGlowImage = self:GetPortrait()
    local isContract = self:IsContract()
    local isCurse = self:IsCurse()
    self.bgGlowableTexture:SetTexture(suitAtlasImage)
    self.bgGlowableTexture.glowTexture:SetTexture(suitAtlasGlowImage)
    if isCurse then
        self.suitGlowableTexture:SetHidden(true)
    else
        self.suitGlowableTexture:SetHidden(false)
        self.suitGlowableTexture:SetTexture(suitAtlasImage)
        self.suitGlowableTexture.glowTexture:SetTexture(suitAtlasGlowImage)
    end
    self.portraitGlowableTexture:SetTexture(portraitImage)
    self.portraitGlowableTexture.glowTexture:SetTexture(portraitGlowImage)
    self.nameLabel:SetText(self:GetFormattedName())
    local contractOrCurseBannerTextureFile = nil
    if isContract then
        contractOrCurseBannerTextureFile = "EsoUI/Art/Tribute/tributeCardContractBanner.dds"
    elseif isCurse then
        contractOrCurseBannerTextureFile = "EsoUI/Art/Tribute/tributeCardCurseBanner.dds"
    end
    if contractOrCurseBannerTextureFile then
        self.contractOrCurseBannerTexture:SetTexture(contractOrCurseBannerTextureFile)
        self.contractOrCurseBannerTexture:SetHidden(false)
    else
        self.contractOrCurseBannerTexture:SetHidden(true)
    end
    local costResourceType, costQuantity = self:GetAcquireCost()
    if costQuantity > 0 then
        self.costLabel:SetHidden(false)
        self.costLabel:SetText(costQuantity)
        local costTextureFile = self:GetAcquireCostTextureFile(isContract)
        self.costIconTexture:SetTexture(costTextureFile)
    else
        self.costLabel:SetHidden(true)
    end
    local defeatCostBannerTextureFile = self:GetDefeatCostTextureFile()
    if defeatCostBannerTextureFile then
        self.defeatCostBannerTexture:SetTexture(defeatCostBannerTextureFile)
    end
    local mechanicContainerPool = TRIBUTE_POOL_MANAGER:GetMechanicContainerPool()
    for activationSource = TRIBUTE_MECHANIC_ACTIVATION_SOURCE_ITERATION_BEGIN, TRIBUTE_MECHANIC_ACTIVATION_SOURCE_ITERATION_END do
        for mechanicIndex = 1, self.numMechanicsByActivationSource[activationSource] do
            local mechanicContainer = mechanicContainerPool:AcquireObject(self, activationSource, mechanicIndex)
            table.insert(self.mechanicContainers, mechanicContainer)
        end
    end
end
function ZO_TributeCard:GetCardInstanceId()
    return self.cardInstanceId
end
function ZO_TributeCard:SetCardInstanceId(cardInstanceId)
    self.cardInstanceId = cardInstanceId
    if self:IsWorldCard() then
        AssignControlToTributeCard(cardInstanceId, self.control)
    end
end
function ZO_TributeCard:GetNumConfinedCards()
end
function ZO_TributeCard:ShowConfinedCards(previousViewer)
    if self:GetNumConfinedCards() > 0 then
        ZO_TRIBUTE_CONFINEMENT_VIEWER_MANAGER:SetViewingAgent(self:GetCardInstanceId(), previousViewer)
    end
end
function ZO_TributeCard:GetMechanicContainer(mechanicActivationSource, mechanicIndex)
    for _, mechanicContainer in ipairs(self.mechanicContainers) do
        local activationSource, index = mechanicContainer:GetActivationSourceAndIndex()
        if activationSource == mechanicActivationSource and index == mechanicIndex then
            return mechanicContainer
        end
    end
    return nil
end
function ZO_TributeCard:GetPopupType()
    return self.popupType
end
function ZO_TributeCard:SetPopupType(popupType)
    if self.popupType ~= popupType then
        self.popupType = popupType
        self:RefreshStateFlags()
    end
end
function ZO_TributeCard:PlayAlphaAnimation(playForward, animateInstantly)
    if animateInstantly then
        self:ReleaseAlphaAnimation()
        self:SetAlphaProgress(playForward and 1 or 0)
    else
        local timeline = self.alphaTimeline
        if not timeline then
            timeline = TRIBUTE_POOL_MANAGER:GetAlphaAnimationPool():AcquireObject()
            timeline:ApplyAllAnimationsToControl(self.control)
            timeline:PlayInstantlyToStart()
            timeline.cardObject = self
            self.alphaTimeline = timeline
        end
        if playForward then
            timeline:PlayForward()
        else
            timeline:PlayBackward()
        end
    end
end
function ZO_TributeCard:IsRevealed()
    return self.cardInstanceId and not self.frontControl:IsHidden()
end
function ZO_TributeCard:IsInterfaceCard()
    return self.control:GetSpace() == SPACE_INTERFACE
end
function ZO_TributeCard:IsWorldCard()
    return self.control:GetSpace() == SPACE_WORLD
end
function ZO_TributeCard:GetDefaultScale()
    return self:IsWorldCard() and ZO_TRIBUTE_CARD_WORLD_SCALE or 1
end
function ZO_TributeCard:GetScreenAnchor(anchor)
end
function ZO_TributeCard:GetScreenCenter()
    return self.control:ProjectToScreen(0.5, 0.5)
end
function ZO_TributeCard:GetAnchorNearestScreenCenter()
    local screenX, screenY = self:GetScreenAnchor(anchor)
    return anchor, screenX, screenY
end
--- Override of ZO_TributeCardData ---
-- Returns resourceType, maxQuantity, currentQuantity
function ZO_TributeCard:GetDefeatCost()
    local resourceType, maxQuantity = GetTributeCardDefeatCost(self.cardDefId)
    local currentQuantity = maxQuantity
    if self.cardInstanceId then
        resourceType, currentQuantity = GetTributeCardInstanceDefeatCost(self.cardInstanceId)
    end
    return resourceType, maxQuantity, currentQuantity
end
function ZO_TributeCard:SetDefeatCost(quantity)
    if self:GetCardType() ~= TRIBUTE_CARD_TYPE_AGENT then
        -- Only Agent cards have a defeat cost.
        return
    end
    local resourceType, maxQuantity, currentQuantity = self:GetDefeatCost()
    if resourceType ~= TRIBUTE_RESOURCE_POWER then
        assert(false, string.format("Card %d using invalid Defeat Cost type. No UI design for any defeat cost that isn't TRIBUTE_RESOURCE_POWER. If another type is desired, please contact a UI designer.", self.cardDefId))
    end
    quantity = quantity or currentQuantity
    self.defeatCostLabel:SetText(quantity)
    local color = quantity < maxQuantity and TRIBUTE_CARD_COLOR_DAMAGED or ZO_WHITE
    self.defeatCostLabel:SetColor(color:UnpackRGBA())
end
function ZO_TributeCard:RefreshDefeatCost()
    local USE_CURRENT_QUANTITY = nil
    self:SetDefeatCost(USE_CURRENT_QUANTITY)
end
function ZO_TributeCard:UpdateDefeatCost(newCost, costDelta, suppressSound)
    -- Reflect the new defeat cost instantly.
    self:SetDefeatCost(newCost)
    if not self.defeatCostAdjustmentObject then
        -- Create and permanently cache a ZO_TributeCard_DefeatCostAdjustment object for this card object.
        self.defeatCostAdjustmentObject = ZO_TributeCard_DefeatCostAdjustment:New(self)
    end
    -- Queue animation of the defeat cost delta.
    self.defeatCostAdjustmentObject:UpdateDefeatCost(newCost, costDelta)
    if not suppressSound then
        -- Play the associated audio.
        if costDelta < 0 then
            if newCost > 0 then
                PlaySound(SOUNDS.TRIBUTE_AGENT_DAMAGED)
            else
                PlaySound(SOUNDS.TRIBUTE_AGENT_KNOCKED_OUT)
            end
        elseif costDelta > 0 then
            PlaySound(SOUNDS.TRIBUTE_AGENT_HEALED)
        end
    end
end
-- Evaluates the effective state flags given the specified state flags or, if unspecified, the current state flags of the card.
function ZO_TributeCard:GetEffectiveStateFlags(currentStateFlags)
    local stateFlags = currentStateFlags or self.stateFlags
    local _, _, isStacked, isTopOfStack = self:GetStackInfo()
    if self:IsWorldCard() then
        if (isStacked and not isTopOfStack) or not TRIBUTE:CanInteractWithCards() then
            -- Suppress all flags for World space cards (1) while the pile viewer, target viewer or mechanic
            -- selector is open or (2) that are in a stack that are not the top card in that stack.
            stateFlags = 0
        elseif isStacked and isTopOfStack then
            --Suppress playable and damageable for cards at the top of a stack
            stateFlags = ZO_ClearMaskFlags(stateFlags, TRIBUTE_CARD_STATE_FLAGS_DAMAGEABLE, TRIBUTE_CARD_STATE_FLAGS_PLAYABLE)
        elseif ZO_TRIBUTE_TARGET_VIEWER_MANAGER:IsViewingBoard() then
            -- Don't allow the targetable and targeted state flags on world cards when viewing the board from the target viewer
            stateFlags = ZO_ClearMaskFlags(stateFlags, TRIBUTE_CARD_STATE_FLAGS_TARGETABLE, TRIBUTE_CARD_STATE_FLAGS_TARGETED)
        end
    else
        if self:GetPopupType() == ZO_TRIBUTE_CARD_POPUP_TYPE.MECHANIC then
            -- Suppress all flags for a Mechanic tile's popup card.
            stateFlags = 0
        else
            if self:GetPopupType() == ZO_TRIBUTE_CARD_POPUP_TYPE.CARD and ZO_TRIBUTE_TARGET_VIEWER_MANAGER:IsViewingBoard() then
                -- Don't allow the targetable and targeted state flags on popup cards when viewing the board from the target viewer
                stateFlags = ZO_ClearMaskFlags(stateFlags, TRIBUTE_CARD_STATE_FLAGS_TARGETABLE, TRIBUTE_CARD_STATE_FLAGS_TARGETED)
            end
            -- Suppress stack-related flags for non-Mechanic popup cards.
            stateFlags = ZO_ClearMaskFlags(stateFlags, TRIBUTE_CARD_STATE_FLAGS_STACK_DAMAGEABLE, TRIBUTE_CARD_STATE_FLAGS_STACK_PLAYABLE)
        end
    end
    return stateFlags
end
function ZO_TributeCard:RefreshStateFlags()
    self:OnStateFlagsChanged(self.stateFlags)
end
function ZO_TributeCard:OnStateFlagsChanged(stateFlags)
    -- Cache the state flags in order to avoid unnecessary visual effect spawning/releasing.
    -- TODO Tribute: Reevaluate performance at a later point to see if this is still necessary.
    if not stateFlags then
        stateFlags = 0
    end
    self.stateFlags = stateFlags
    local effectiveStateFlags = self:GetEffectiveStateFlags(stateFlags)
    local flagValueChangesTable = ZO_CompareMaskFlags(self.effectiveStateFlags, effectiveStateFlags)
    if not flagValueChangesTable then
        return
    end
    self.effectiveStateFlags = effectiveStateFlags
    for stateFlag, active in pairs(flagValueChangesTable) do
        self:OnStateFlagChanged(stateFlag, active)
    end
end
function ZO_TributeCard:OnStateFlagChanged(stateFlag, active)
    if stateFlag == TRIBUTE_CARD_STATE_FLAGS_HIGHLIGHTED then
        -- Tribute highlight is handled directly via SetHighlighted.
        self:SetHighlighted(active)
        return
    end
    -- All other card states are managed using pooled state effects.
    local stateEffects = self.stateEffects[stateFlag]
    if stateEffects then
        for cardLayer, layerEffect in pairs(stateEffects) do
            -- If activating, reactivate an existing effect that is in the process of deactivating;
            -- if deactivating, effects will be released via the OnStateEffectChanged callback issued from the OnStop animation event.
            layerEffect:SetActive(active)
        end
    else
        if active then
            stateEffects = {}
            self.stateEffects[stateFlag] = stateEffects
            for _, cardLayer in ipairs(TRIBUTE_CARD_STATE_EFFECT_LAYERS) do
                -- Acquire an effect from the pool; effect activation is handled via the acquisition process.
                local layerEffect = TRIBUTE_POOL_MANAGER:GetCardStateEffectPool():AcquireObject(self, stateFlag, cardLayer)
                stateEffects[cardLayer] = layerEffect
            end
        end
    end
end
function ZO_TributeCard:OnStateEffectChanged(stateEffect, active)
    if not active then
        local cardState = stateEffect:GetCardState()
        if cardState then
            local stateEffects = self.stateEffects[cardState]
            if stateEffects then
                local cardLayer = stateEffect:GetCardLayer()
                local layerEffect = stateEffects[cardLayer]
                if layerEffect == stateEffect then
                    -- Release this effect.
                    stateEffects[cardLayer] = nil
                    layerEffect:ReleaseObject()
                    if not next(stateEffects) then
                        -- If no other layer effects exist for this state
                        -- remove the state table from self.stateEffects.
                        self.stateEffects[cardState] = nil
                    end
                end
            end
        end
    end
end
function ZO_TributeCard:OnTriggerAnimationComplete(triggerAnimation, completedPlaying)
    if completedPlaying then
        for index, animation in ipairs(self.triggerAnimations) do
            if animation == triggerAnimation then
                animation:ReleaseObject()
                table.remove(self.triggerAnimations, index)
                break
            end
        end
    end
end
function ZO_TributeCard:UpdateTriggerAnimation()
    local NO_CARD_STATE = nil
    local triggerAnimationOverlay = TRIBUTE_POOL_MANAGER:GetCardTriggerAnimationPool():AcquireObject(self, NO_CARD_STATE, TRIBUTE_CARD_STATE_EFFECT_LAYER_OVERLAY)
    local triggerAnimationUnderlay = TRIBUTE_POOL_MANAGER:GetCardTriggerAnimationPool():AcquireObject(self, NO_CARD_STATE, TRIBUTE_CARD_STATE_EFFECT_LAYER_UNDERLAY)
    table.insert(self.triggerAnimations, triggerAnimationOverlay)
    table.insert(self.triggerAnimations, triggerAnimationUnderlay)
    -- TODO Tribute: Audio hook?
end
function ZO_TributeCard:Reset()
    if self.defeatCostAdjustmentObject then
        self.defeatCostAdjustmentObject:Reset()
    end
    local control = self.control
    control:SetClampedToScreen(false)
    control:SetClampedToScreenInsets(0, 0, 0, 0)
    control:SetSpace(nil)
    control:SetAlpha(1)
    control:SetScale(1)
    self.frontControl:SetHidden(false)
    self.backGlowableTexture:SetHidden(true)
    -- Allow cleanup of big textures that aren't common among all cards, to gain back some memory
    self.portraitGlowableTexture:SetTexture(nil)
    self.portraitGlowableTexture.glowTexture:SetTexture(nil)
    self.bgGlowableTexture:SetTexture(nil)
    self.bgGlowableTexture.glowTexture:SetTexture(nil)
    self.suitGlowableTexture:SetTexture(nil)
    self.suitGlowableTexture.glowTexture:SetTexture(nil)
    self:SetMouseEnabled(true)
    self.cardDefId = nil
    self.patronDefId = nil
    self.cardInstanceId = nil
    self.effectiveStateFlags = 0
    self.stateFlags = 0
    self.keyboardTooltipControl = nil
    self.gamepadTooltipControl = nil
end
function ZO_TributeCard:ReleaseAllObjects()
end
function ZO_TributeCard:ReleaseAlphaAnimation()
    local timeline = self.alphaTimeline
    if timeline then
        self.alphaTimeline = nil
        TRIBUTE_POOL_MANAGER:GetAlphaAnimationPool():ReleaseObject(timeline.key)
        self:SetAlphaProgress(1)
    end
end
function ZO_TributeCard:ReleaseGlowAnimation()
    local timeline = self.glowTimeline
    if timeline then
        self.glowTimeline = nil
        TRIBUTE_POOL_MANAGER:GetGlowAnimationPool():ReleaseObject(timeline.key)
        self:SetGlowProgress(0)
    end
end
function ZO_TributeCard:ReleaseMechanics()
    ZO_ClearTable(self.numMechanicsByActivationSource)
    for _, mechanicContainer in ipairs(self.mechanicContainers) do
        mechanicContainer:ReleaseObject()
    end
    ZO_ClearNumericallyIndexedTable(self.mechanicContainers)
end
function ZO_TributeCard:ReleaseStackedCardBackTextures()
    if self.stackedCardBackTextures and #self.stackedCardBackTextures > 0 then
        local cardBackPool = TRIBUTE_POOL_MANAGER:GetStackedCardBackTexturePool()
        for _, texture in ipairs(self.stackedCardBackTextures) do
            cardBackPool:ReleaseObject(texture.key)
        end
        ZO_ClearNumericallyIndexedTable(self.stackedCardBackTextures)
    end
end
function ZO_TributeCard:ReleasePopupAnimation()
    local timeline = self.popupTimeline
    if timeline then
        self.popupTimeline = nil
        TRIBUTE_POOL_MANAGER:GetCardPopupAnimationPool():ReleaseObject(timeline.key)
        self:SetPopupProgress(1)
    end
end
function ZO_TributeCard:ReleaseStateEffects()
    for _, stateEffects in pairs(self.stateEffects) do
        for _, layerEffect in pairs(stateEffects) do
            layerEffect:ReleaseObject()
        end
    end
    ZO_ClearTable(self.stateEffects)
end
function ZO_TributeCard:ReleaseTriggerAnimations()
    for _, triggerAnimation in ipairs(self.triggerAnimations) do
        triggerAnimation:ReleaseObject()
    end
    ZO_ClearTable(self.triggerAnimations)
end
function ZO_TributeCard:GetStackInfo()
    if not self.cardInstanceId then
        return
    end
    
    local cardIndexInPile, numCardsInPile, isStacked = GetTributeCardPositionInPile(self.cardInstanceId)
    local isTopOfStack = isStacked and cardIndexInPile == numCardsInPile
    return cardIndexInPile, numCardsInPile, isStacked, isTopOfStack
end
function ZO_TributeCard:IsStacked()
    local _, _, isStacked = self:GetStackInfo()
    return isStacked == true
end
function ZO_TributeCard:GetBoardLocation()
    return self.cardInstanceId and GetTributeCardInstanceBoardLocation(self.cardInstanceId) or nil
end
function ZO_TributeCard:HideBoardLocationPatronsTooltip()
    if self.keyboardTooltipControl then
        ClearTooltipImmediately(self.keyboardTooltipControl)
        self.keyboardTooltipControl = nil
    end
    if self.gamepadTooltipControl then
        self.gamepadTooltipControl = nil
    end
end
function ZO_TributeCard:ShowBoardLocationPatronsTooltip()
    if not (self.cardInstanceId and self:IsWorldCard()) then
        return false
    end
    local boardLocation = self:GetBoardLocation()
    if not ZO_IsElementInNumericallyIndexedTable(TRIBUTE_PILE_TOOLTIP_BOARD_LOCATIONS, boardLocation) then
        return false
    end
    local anchor, offsetX, offsetY
    local cardCenterX, _ = self:GetScreenCenter()
    local screenCenterX, _ = GuiRoot:GetCenter()
    -- The positioning of the tooltip is based on which half of the screen the card is on
    if cardCenterX > screenCenterX then
        offsetX, offsetY = self:GetScreenAnchor(LEFT)
        anchor = RIGHT
    else
        offsetX, offsetY = self:GetScreenAnchor(RIGHT)
        anchor = LEFT
    end
    if TRIBUTE:IsInputStyleMouse() then
        local control = NarrowTooltip
        InitializeTooltip(control, GuiRoot, anchor, offsetX, offsetY, TOPLEFT)
        control:SetTributeBoardLocationPatrons(boardLocation)
        self.keyboardTooltipControl = control
        return true
    elseif TRIBUTE:IsInputStyleGamepad() then
        local tooltipControl = ZO_TributeBoardLocationPatronsTooltip_Gamepad_GetControl()
        ZO_TributeBoardLocationPatronsTooltip_Gamepad_Show(boardLocation, anchor, GuiRoot, TOPLEFT, offsetX, offsetY)
        self.gamepadTooltipControl = tooltipControl
        return true
    end
    return false
end
function ZO_TributeCard:IsInteractive()
    if not (self.cardInstanceId and TRIBUTE:CanInteractWithCards()) then
        -- Suppress interaction for non-instanced cards or when the pile viewer, target viewer or mechanic selector is open.
        return false
    end
    local _, _, isStacked, isTopOfStack = self:GetStackInfo()
    if isStacked and not isTopOfStack then
        -- Suppress interaction for stacked cards that are not the top card in the stack.
        return false
    end
        --Suppress interaction for confined cards
        return false
    end
    return true
end
function ZO_TributeCard:OnCursorEnter()
    if self:IsInteractive() then
        SetHighlightedTributeCard(self.cardInstanceId)
    end
end
function ZO_TributeCard:OnCursorExit()
    if self.cardInstanceId then
        SetHighlightedTributeCard(NO_CARD)
    end
end
function ZO_TributeCard:OnMouseEnter()
    if TRIBUTE:IsInputStyleMouse() and self:IsInteractive() then
        SetHighlightedTributeCard(self.cardInstanceId)
    end
end
function ZO_TributeCard:OnMouseUp(button, upInside)
    if TRIBUTE:IsInputStyleMouse() and upInside and button == MOUSE_BUTTON_INDEX_LEFT and self.cardInstanceId then
        -- Don't allow interaction with cards while a viewer is up
        if TRIBUTE:GetActiveViewer() ~= nil then
            return
        end
        InteractWithTributeCard(self.cardInstanceId)
    end
end
function ZO_TributeCard:IsCardStateActive(cardState)
    return ZO_MaskHasFlag(self.stateFlags, cardState)
end
function ZO_TributeCard:IsPlayable()
    return ZO_MaskHasFlag(self.stateFlags, TRIBUTE_CARD_STATE_FLAGS_PLAYABLE)
end
function ZO_TributeCard:IsDamageable()
    return ZO_MaskHasFlag(self.stateFlags, TRIBUTE_CARD_STATE_FLAGS_DAMAGEABLE)
end
function ZO_TributeCard:IsTargeted()
    return ZO_MaskHasFlag(self.stateFlags, TRIBUTE_CARD_STATE_FLAGS_TARGETED)
end
function ZO_TributeCard:IsHidden()
    return self.control:IsHidden()
end
function ZO_TributeCard:SetHidden(hidden)
    self.control:SetHidden(hidden)
end
function ZO_TributeCard:IsHighlighted()
    return ZO_MaskHasFlag(self.stateFlags, TRIBUTE_CARD_STATE_FLAGS_HIGHLIGHTED)
end
function ZO_TributeCard:SetHighlighted(isHighlighted)
    local timeline = self.glowTimeline
    if isHighlighted then
        if not timeline then
            timeline = TRIBUTE_POOL_MANAGER:GetGlowAnimationPool():AcquireObject()
            timeline:ApplyAllAnimationsToControl(self.control)
            timeline:PlayInstantlyToStart()
            timeline.cardObject = self
            self.glowTimeline = timeline
        end
        timeline:PlayForward()
        if not self:IsWorldCard() then
            -- If a world card is being highlighted, that means we'll get a popup interface card, also highlighted.
            -- We'll let that play the sound so we don't play it twice.
            PlaySound(SOUNDS.TRIBUTE_CARD_HIGHLIGHTED)
        end
    else
        if timeline then
            timeline:PlayBackward()
        end
    end
end
function ZO_TributeCard:SetMechanicGlowHidden(mechanicActivationSource, mechanicIndex, hidden)
    local mechanicContainer = self:GetMechanicContainer(mechanicActivationSource, mechanicIndex)
    if mechanicContainer then
        mechanicContainer:SetGlowHidden(hidden)
    end
end
function ZO_TributeCard:SetMouseEnabled(enabled)
end
function ZO_TributeCard:ShowAsPopup(screenX, screenY, popupType)
    local control = self.control
    self:SetPopupType(popupType)
    if popupType == ZO_TRIBUTE_CARD_POPUP_TYPE.CARD then
        control:SetAnchor(CENTER, GuiRoot, TOPLEFT, screenX, screenY)
        local timeline = self.popupTimeline
        if not timeline then
            timeline = TRIBUTE_POOL_MANAGER:GetCardPopupAnimationPool():AcquireObject()
            timeline:ApplyAllAnimationsToControl(control)
            timeline:PlayInstantlyToStart()
            timeline.cardObject = self
            self.popupTimeline = timeline
        end
        timeline:PlayForward()
        --If this card has confined cards and will be showing a keybind for it, we need to adjust the inset to account for the keybind underneath
        if TRIBUTE:CanShowConfineKeybind() and self:GetNumConfinedCards() > 0 then
            local BOTTOM_INSET = ZO_TRIBUTE_CONFINED_CARDS_KEYBIND_HEIGHT + ZO_TRIBUTE_CONFINED_CARDS_KEYBIND_OFFSET_Y
            control:SetClampedToScreenInsets(0, 0, 0, BOTTOM_INSET)
        end
        --Only the CARD popup type should show a confined stack
        self:RefreshConfinedStack()
    elseif popupType == ZO_TRIBUTE_CARD_POPUP_TYPE.MECHANIC then
        control:SetAnchor(LEFT, GuiRoot, TOPLEFT, screenX, screenY)
    end
    --If there is a viewer up, check to see if we need to adjust the insets to account for a keybind strip
    local activeViewer = TRIBUTE:GetActiveViewer()
    if activeViewer and activeViewer:IsKeybindStripVisible() then
        local BOTTOM_INSET = IsInGamepadPreferredMode() and ZO_KEYBIND_STRIP_GAMEPAD_VISUAL_HEIGHT or ZO_KEYBIND_STRIP_KEYBOARD_VISUAL_HEIGHT
        control:SetClampedToScreenInsets(0, 0, 0, BOTTOM_INSET)
    end
    control:SetHidden(false)
    self:SetMouseEnabled(false)
end
do
    local ADDITIONAL_CARDS_CONFINED_ICON = "EsoUI/Art/Tribute/tribute_icon_additionalCardsConfined.dds"
    function ZO_TributeCard:PopulateConfinedCards(cardControls)
        local numConfined = self:GetNumConfinedCards()
        local numControls = #cardControls
        for i, cardControl in ipairs(cardControls) do
            if i > numConfined then
                --If the index for this card control exceeds the number of cards we actually have confined, hide it
                cardControl:SetHidden(true)
            else
                if i == numControls and numConfined > numControls then
                    --Special case: If we have more confined cards than we do controls to show it, we use the last control to represent that instead of showing it as an individual card
                    local additionalQuantity = numConfined - (numControls - 1)
                    cardControl.portrait:SetTexture(ADDITIONAL_CARDS_CONFINED_ICON)
                    --Calculate and show the number of non-visible confined cards
                    cardControl.quantity:SetText(additionalQuantity)
                    cardControl.quantity:SetHidden(false)
                else
                    --Get the portrait for the confined card in question and set it
                    local confinedInstanceId = GetConfinedTributeCardInstanceId(self:GetCardInstanceId(), i)
                    local cardId, patronId = GetTributeCardInstanceDefIds(confinedInstanceId)
                    cardControl.portrait:SetTexture(GetTributeCardPortrait(cardId))
                    cardControl.quantity:SetHidden(true)
                end
                cardControl:SetHidden(false)
            end
        end
    end
end
function ZO_TributeCard:OnAlphaTimelineStopped(timeline)
    if timeline == self.alphaTimeline and timeline:IsPlayingBackward() then
        self:ReleaseAlphaAnimation()
    end
end
function ZO_TributeCard:OnGlowTimelineStopped(timeline)
    if timeline == self.glowTimeline and timeline:IsPlayingBackward() then
        self:ReleaseGlowAnimation()
    end
end
function ZO_TributeCard:SetAlphaProgress(alpha)
    self.control:SetAlpha(alpha)
    if self.cardInstanceId then
        SetTributeCardHidden(self.cardInstanceId, alpha < 1)
    end
end
function ZO_TributeCard:SetGlowProgress(progress)
    self.bgGlowableTexture.glowTexture:SetAlpha(progress)
    self.portraitGlowableTexture.glowTexture:SetAlpha(progress)
    self.frameGlowableTexture.glowTexture:SetAlpha(progress)
    self.suitGlowableTexture.glowTexture:SetAlpha(progress)
    self.backGlowableTexture.glowTexture:SetAlpha(progress)
end
function ZO_TributeCard:SetPopupProgress(progress)
    local maxScale = self:GetDefaultScale()
    local minScale = maxScale * 0.5
    self.control:SetScale(zo_lerp(minScale, maxScale, progress))
end
function ZO_TributeCard:GetControl()
    return self.control
end
function ZO_TributeCard:GetFrontControl()
    return self.frontControl
end
function ZO_TributeCard:GetScreenAnchorPosition(anchor)
    local screenX, screenY = self.control:ProjectRectToScreenAndComputeAABBPoint(anchor)
    return screenX, screenY
end
function ZO_TributeCard:RefreshConfinedStack()
    local numConfinedCards = self:GetNumConfinedCards()
    if numConfinedCards > 0 then
        --Only create this table if we need it
        if not self.stackedCardBackTextures then
            self.stackedCardBackTextures = {}
        end
        local maxCardsInStack = GetMaxTributeCardsInStack()
        local previousControl = nil
        for i = 1, numConfinedCards do
            --Only show individual card back textures up to the maximum number of cards we can show in a stack
            --We do < instead of <= because the jailer itself counts towards this number
            if i < maxCardsInStack then
                local cardBackTexture, key = TRIBUTE_POOL_MANAGER:GetStackedCardBackTexturePool():AcquireObject()
                cardBackTexture.key = key
                cardBackTexture:SetParent(self.control)
                --Each card back texture should be one level lower than the last
                cardBackTexture:SetDrawLevel(maxCardsInStack - i)
                --Anchor the cards slightly differently depending on how many there are
                if numConfinedCards > 1 then
                    cardBackTexture:SetAnchor(TOPLEFT, previousControl, TOPLEFT, 10, -10)
                else
                    cardBackTexture:SetAnchor(TOPLEFT, previousControl, TOPLEFT, 15, -15)
                end
                cardBackTexture:SetHidden(false)
                previousControl = cardBackTexture
                table.insert(self.stackedCardBackTextures, cardBackTexture)
            end
        end
    end
end
-- Global Functions --
    ZO_TributeCard:New(...)
end
function ZO_TributeCard_AlphaTimeline_OnStop(timeline, completedPlaying)
    if timeline.cardObject then
        timeline.cardObject:OnAlphaTimelineStopped(timeline)
    end
end
function ZO_TributeCard_AlphaTimeline_SetProgress(animation, progress)
    local timeline = animation:GetTimeline()
    if timeline.cardObject then
        timeline.cardObject:SetAlphaProgress(progress)
    end
end
function ZO_TributeCard_DefeatCostAdjustmentTimeline_OnStop(timeline, completedPlaying)
    if timeline.object then
        timeline.object:OnTimelineStopped(completedPlaying)
    end
end
    local timeline = animation:GetTimeline()
    if timeline.object then
        timeline.object:OnTimelineUpdate(progress)
    end
end
function ZO_TributeCard_GlowTimeline_OnStop(timeline, completedPlaying)
    if timeline.cardObject then
        timeline.cardObject:OnGlowTimelineStopped(timeline)
    end
end
function ZO_TributeCard_GlowTimeline_SetProgress(animation, progress)
    local timeline = animation:GetTimeline()
    if timeline.cardObject then
        timeline.cardObject:SetGlowProgress(progress)
    end
end
    ZO_TributeCard_MechanicContainer:New(...)
end
function ZO_TributeCard_PopupTimeline_SetProgress(animation, progress)
    local timeline = animation:GetTimeline()
    if timeline.cardObject then
        timeline.cardObject:SetPopupProgress(progress)
    end
end
    ZO_TributeCard_StateEffect:New(...)
end
    ZO_TributeCard_TriggerAnimation:New(...)
end
do
    local fromColor = ZO_ColorDef:New(0, 0, 0, 0)
    local toColor = ZO_ColorDef:New(1, 1, 1, 1)
    function ZO_TributeCard_TriggerAnimation_ColorShift_SetProgress(animation, progress)
        local control = animation:GetAnimatedControl()
        local topLeftColor = fromColor:Lerp(toColor, zo_clamp(math.sin(1.5 * progress * ZO_PI), 0, 1))
        local bottomRightColor = fromColor:Lerp(toColor, zo_clamp(math.sin((1.5 * progress - 0.5) * ZO_PI), 0, 1))
        control:SetVertexColors(VERTEX_POINTS_TOPLEFT, topLeftColor.r, topLeftColor.g, topLeftColor.b, topLeftColor.a)
        control:SetVertexColors(VERTEX_POINTS_BOTTOMRIGHT, bottomRightColor.r, bottomRightColor.g, bottomRightColor.b, bottomRightColor.a)
    end
end
function ZO_TributeCard_StateEffectTimeline_OnStop(timeline, completedPlaying)
    if timeline.object then
        timeline.object:OnStateEffectTimelineStopped(completedPlaying)
    end
end