ESO Lua File v100012

ingame/group/zo_groupingtools_shared.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
local ACTIVITY_DATA = {
    [LFG_ACTIVITY_WORLD] = {
        name = GetString("SI_LFGACTIVITY", LFG_ACTIVITY_WORLD),
        type = LFG_ACTIVITY_WORLD,
        texture = "EsoUI/Art/LFG/Keyboard/LFG_activityArt_world_keyboard.dds",
        textureGamepad = "EsoUI/Art/LFG/Gamepad/LFG_activityArt_world_gamepad.dds",
        allDescription = GetString(SI_LFG_WORLD_DESCRIPTION),
    },
    [LFG_ACTIVITY_AVA] = {
        name = GetString("SI_LFGACTIVITY", LFG_ACTIVITY_AVA),
        type = LFG_ACTIVITY_AVA,
        texture = "EsoUI/Art/LFG/Keyboard/LFG_activityArt_ava_keyboard.dds",
        textureGamepad = "EsoUI/Art/LFG/Gamepad/LFG_activityArt_ava_gamepad.dds",
        allDescription = GetString(SI_LFG_AVA_DESCRIPTION),
    },
    [LFG_ACTIVITY_DUNGEON] = {
        name = GetString("SI_LFGACTIVITY", LFG_ACTIVITY_DUNGEON),
        type = LFG_ACTIVITY_DUNGEON,
        texture = "EsoUI/Art/LFG/Keyboard/LFG_activityArt_dungeon_keyboard.dds",
        textureGamepad = "EsoUI/Art/LFG/Gamepad/LFG_activityArt_dungeon_gamepad.dds",
        allText = GetString(SI_LFG_ANY_DUNGEON),
        allDescription = GetString(SI_LFG_ANY_DUNGEON_DESCRIPTION),
    },
    [LFG_ACTIVITY_MASTER_DUNGEON] = {
        name = GetString("SI_LFGACTIVITY", LFG_ACTIVITY_MASTER_DUNGEON),
        type = LFG_ACTIVITY_MASTER_DUNGEON,
        texture = "EsoUI/Art/LFG/Keyboard/LFG_activityArt_vetDungeon_keyboard.dds",
        textureGamepad = "EsoUI/Art/LFG/Gamepad/LFG_activityArt_vetDungeon_gamepad.dds",
        allText = GetString(SI_LFG_ANY_VETERAN_DUNGEON),
        allDescription = GetString(SI_LFG_ANY_VETERAN_DUNGEON_DESCRIPTION),
    },
    [LFG_ACTIVITY_TRIAL] = {
        name = GetString("SI_LFGACTIVITY", LFG_ACTIVITY_TRIAL),
        type = LFG_ACTIVITY_TRIAL,
        texture = "EsoUI/Art/LFG/Keyboard/LFG_activityArt_vetDungeon_keyboard.dds",
        textureGamepad = "EsoUI/Art/LFG/Gamepad/LFG_activityArt_vetDungeon_gamepad.dds",
    },
}
local NO_TEXTURE_FILE = "/esoui/art/icons/icon_missing.dds"
ZO_GROUP_TYPE_TO_SIZE = {
    [LFG_GROUP_TYPE_REGULAR] = SMALL_GROUP_SIZE_THRESHOLD,
    [LFG_GROUP_TYPE_MEDIUM] = RAID_GROUP_SIZE_THRESHOLD,
    [LFG_GROUP_TYPE_LARGE] = GROUP_SIZE_MAX,
}
LFG_LOCATIONS_ALL_INDEX = 1
local FIRST_LOCATION_INDEX = 2
local SHARE_REQUIREMENTS_LEVEL, SHARE_REQUIREMENTS_RANK = GetLFGContributionShareRequirements()
function LFGLevelSort(entry1, entry2)
    if entry1.veteranRankMin ~= entry2.veteranRankMin then
        return entry1.veteranRankMin < entry2.veteranRankMin
    elseif entry1.levelMin ~= entry2.levelMin then
        return entry1.levelMin < entry2.levelMin
    elseif entry1.veteranRankMax ~= entry2.veteranRankMax then
        return entry1.veteranRankMax < entry2.veteranRankMax
    elseif entry1.levelMax ~= entry2.levelMax then
        return entry1.levelMax < entry2.levelMax
    else
        return entry1.name < entry2.name
    end
end
local function CreateLocationData(activityType, lfgIndex)
    local name, levelMin, levelMax, veteranRankMin, veteranRankMax, groupType, passedReqs, description, descriptionTexture, descriptionTextureGamepad = GetLFGOption(activityType, lfgIndex)
    --Default to 'all' art if one doesn't exist for this location
    if descriptionTexture == NO_TEXTURE_FILE then
        descriptionTexture = ACTIVITY_DATA[activityType].texture
    end
    if descriptionTextureGamepad == NO_TEXTURE_FILE then
        descriptionTextureGamepad = ACTIVITY_DATA[activityType].textureGamepad
    end
    return {
        name = name,
        description = description,
        descriptionTexture = descriptionTexture,
        descriptionTextureGamepad = descriptionTextureGamepad,
        activityType = activityType,
        levelMin = levelMin,
        levelMax = levelMax,
        veteranRankMin = veteranRankMin,
        veteranRankMax = veteranRankMax,
        groupType = groupType,
        isSelected = false,
        lfgIndex = lfgIndex
    }
end
local function IsPreferredRoleSelected()
    local isDPS, isHeal, isTank = GetPlayerRoles()
    return isDPS or isHeal or isTank
end
--------------------------------------------
-- Grouping Tools Selector
--------------------------------------------
--Class meant to act as a container and selector for a subset of LFG search entries/locations.
--The general idea is for a selector to be thought of as a search location itself, but actually represents one of its contained entries.
local ZO_GroupingToolsSelector = ZO_Object:Subclass()
function ZO_GroupingToolsSelector:New(activityType)
    local manager = ZO_Object.New(self)
    manager:Initialize(activityType)
    return manager
end
function ZO_GroupingToolsSelector:Initialize(activityType)
    local activityData = ACTIVITY_DATA[activityType]
    self.name = activityData.name
    self.description = activityData.allDescription
    self.descriptionTexture = activityData.texture
    self.descriptionTextureGamepad = activityData.textureGamepad
    self.activityType = activityType
    self.lockReasonText = nil
    self.isLocked = false
    self.isSelected = false
    self.selectedLocation = nil
    self.groupType = nil
    self.locationsData = {}
end
function ZO_GroupingToolsSelector:ToggleSelected()
    if self.isLocked then
        return
    end
    if self.isSelected then 
        self:Unselect()
    else
        self:Select()
    end
end
function ZO_GroupingToolsSelector:Unselect()
    self.selectedLocation = nil
    self.isSelected = false
    self.groupType = nil
end
function ZO_GroupingToolsSelector:IsSelected()
    return self.isSelected
end
function ZO_GroupingToolsSelector:SetSelected(selected)
    self.isSelected = selected
end
function ZO_GroupingToolsSelector:IsLocked()
    return self.isLocked
end
function ZO_GroupingToolsSelector:GetGroupType()
    return self.groupType
end
function ZO_GroupingToolsSelector:SetGroupType(groupType)
    self.groupType = groupType
end
function ZO_GroupingToolsSelector:GetSelectedLocation()
    return self.selectedLocation
end
function ZO_GroupingToolsSelector:SetSelectedLocation(location)
    self.selectedLocation = location
end
function ZO_GroupingToolsSelector:GetLocations()
    return self.locationsData
end
function ZO_GroupingToolsSelector:GetLocation(lfgIndex)
    for i = 1, #self.locationsData do
        local location = self.locationsData[i]
        if location.lfgIndex == lfgIndex then
            return location
        end
    end
end
function ZO_GroupingToolsSelector:GetDisplayData()
    return {
        activityType = self.activityType,
        name = self.name,
        descriptionTexture = self.descriptionTexture,
        descriptionTextureGamepad = self.descriptionTextureGamepad,
        description = self.description,
        groupType = self.groupType,
        isLocked = self.isLocked,
        lockReasonText = self.lockReasonText,
        isSelected = self.isSelected
    }
end
--------------------------------------------
-- Grouping Tools World Selector
--------------------------------------------
local ZO_GroupingToolsWorldSelector = ZO_GroupingToolsSelector:Subclass()
function ZO_GroupingToolsWorldSelector:New()
    local manager = ZO_GroupingToolsSelector.New(self, LFG_ACTIVITY_WORLD)
    return manager
end
function ZO_GroupingToolsWorldSelector:Initialize(activityType)
    ZO_GroupingToolsSelector.Initialize(self, activityType)
    for lfgIndex = 1, GetNumLFGOptions(LFG_ACTIVITY_WORLD) do
        local passedRequirements = select(7, GetLFGOption(activityType, lfgIndex))
        if passedRequirements then --this should only need to be checked at initialization, the current requirements don't change between sessions
            local data = CreateLocationData(LFG_ACTIVITY_WORLD, lfgIndex)
            data.description = self.description
            data.isSelected = true --for display purposes for queued entries, actual selection is determined by the selector
            table.insert(self.locationsData, data)
        end
    end
    table.sort(self.locationsData, LFGLevelSort)
end
function ZO_GroupingToolsWorldSelector:Refresh(selectedGroupType, isAnyLocationSelected)
    local locationsData = self.locationsData
    for i = 1, #locationsData do
        locationsData[i].playerMeetsRequirements = DoesPlayerMeetLFGLevelRequirements(LFG_ACTIVITY_WORLD, locationsData[i].lfgIndex)
    end
    --Determine lock status
    local inAGroup = IsUnitGrouped("player")
    local groupSize = GetGroupSize()
    local groupFull = groupSize == SMALL_GROUP_SIZE_THRESHOLD --for now, all world locations are of the same group size (small)
    local groupTooLarge = groupSize > SMALL_GROUP_SIZE_THRESHOLD
    local isDifferentGroupType = selectedGroupType and (selectedGroupType ~= LFG_GROUP_TYPE_REGULAR) or false
    local isAnotherLocationSelected = isAnyLocationSelected and not self.isSelected
    local isRoleSelected = IsPreferredRoleSelected()
    self.isLocked = true
    if inAGroup and not IsUnitGroupLeader("player") then
        self.lockReasonText = GetString(SI_LFG_LOCK_REASON_NOT_LEADER)
    elseif not isRoleSelected then
        self.lockReasonText = GetString(SI_LFG_LOCK_REASON_NO_ROLES_SELECTED)
    elseif IsInAvAZone() then --can select only AVA locations while in AVA area
        self.lockReasonText = GetString(SI_LFG_LOCK_REASON_IN_AVA)
    elseif groupTooLarge then
        self.lockReasonText = GetString(SI_LFG_LOCK_REASON_GROUP_TOO_LARGE)
    elseif groupFull then
        self.lockReasonText = GetString(SI_LFG_LOCK_REASON_GROUP_FULL)
    elseif inAGroup and not DoesGroupMeetLFGContributionShareRequirements() then
        if GetUnitVeteranRank("player") > 0 then
            self.lockReasonText = zo_strformat(SI_LFG_LOCK_REASON_GROUP_RANK_CONTRIBUTION_REQUIREMENTS, SHARE_REQUIREMENTS_RANK)
        else
            self.lockReasonText = zo_strformat(SI_LFG_LOCK_REASON_GROUP_LEVEL_CONTRIBUTION_REQUIREMENTS, SHARE_REQUIREMENTS_LEVEL)
        end
    elseif isDifferentGroupType then
        self.lockReasonText = GetString(SI_LFG_LOCK_REASON_SELECTIONS_GROUP_SIZE)
    elseif inAGroup and isAnotherLocationSelected then
        self.lockReasonText = GetString(SI_LFG_LOCK_REASON_SELECTION_LIMIT_MEMBER_SEARCH)
    else
        self.isLocked = false
        self.lockReasonText = ""
    end
end
function ZO_GroupingToolsWorldSelector:Select()
    --Default to first valid location
    local locationsData = self.locationsData
    for i = 1, #locationsData do
        if locationsData[i].playerMeetsRequirements then
            self.selectedLocation = locationsData[i]
            self.isSelected = true
            self.groupType = LFG_GROUP_TYPE_REGULAR
            break
        end
    end
end
--------------------------------------------
-- Grouping Tools AVA Selector
--------------------------------------------
local ZO_GroupingToolsAVASelector = ZO_GroupingToolsSelector:Subclass()
function ZO_GroupingToolsAVASelector:New()
    local manager = ZO_GroupingToolsSelector.New(self, LFG_ACTIVITY_AVA)
    return manager
end
local function AVASort(entry1, entry2)
    return entry1.groupType < entry2.groupType
end
function ZO_GroupingToolsAVASelector:Initialize(activityType)
    ZO_GroupingToolsSelector.Initialize(self, activityType)
    for lfgIndex = 1, GetNumLFGOptions(LFG_ACTIVITY_AVA) do
        local data = CreateLocationData(LFG_ACTIVITY_AVA, lfgIndex)
        data.name = zo_strformat(SI_LFG_GROUP_SIZE_LIST_ENTRY, ZO_GROUP_TYPE_TO_SIZE[data.groupType])
        data.description = self.description
        data.isSelected = true --for display purposes for queued entries, actual selection is determined by the selector
        table.insert(self.locationsData, data)
    end
    table.sort(self.locationsData, AVASort)
end
function ZO_GroupingToolsAVASelector:Refresh()
    local locationsData = self.locationsData
    local groupSize = GetGroupSize()
    for i = 1, #locationsData do
        local groupType = locationsData[i].groupType
        locationsData[i].isLocked = groupSize >= ZO_GROUP_TYPE_TO_SIZE[groupType]
    end
    local inAGroup = IsUnitGrouped("player")
    local groupFull = groupSize == GROUP_SIZE_MAX --AVA supports all group types, so it's only full when the group size is at maximum
    local isRoleSelected = IsPreferredRoleSelected()
    --We can take advantage of the fact that when AVA selections are selectable, it's the only type that's selectable.
    --With this, we can ignore difficult group type lock requirements imposed on (or from) other activity types.
    self.isLocked = true
    if inAGroup and not IsUnitGroupLeader("player") then
        self.lockReasonText = GetString(SI_LFG_LOCK_REASON_NOT_LEADER)
    elseif not isRoleSelected then
        self.lockReasonText = GetString(SI_LFG_LOCK_REASON_NO_ROLES_SELECTED)
    elseif not IsInAvAZone() then --can select only AVA locations while in AVA area
        self.lockReasonText = GetString(SI_LFG_LOCK_REASON_NOT_IN_AVA)
    elseif groupFull then
        self.lockReasonText = GetString(SI_LFG_LOCK_REASON_GROUP_FULL)
    elseif inAGroup and not DoesGroupMeetLFGContributionShareRequirements() then
        if GetUnitVeteranRank("player") > 0 then
            self.lockReasonText = zo_strformat(SI_LFG_LOCK_REASON_GROUP_RANK_CONTRIBUTION_REQUIREMENTS, SHARE_REQUIREMENTS_RANK)
        else
            self.lockReasonText = zo_strformat(SI_LFG_LOCK_REASON_GROUP_LEVEL_CONTRIBUTION_REQUIREMENTS, SHARE_REQUIREMENTS_LEVEL)
        end
    else
        self.isLocked = false
        self.lockReasonText = ""
    end
end
function ZO_GroupingToolsAVASelector:Select()
    --Default to first valid size
    local locationsData = self.locationsData
    for i = 1, #locationsData do
        if not locationsData[i].isLocked then
            self.selectedLocation = locationsData[i]
            self.isSelected = true
            self.groupType = locationsData[i].groupType
            break
        end
    end
end
--------------------------------------------
-- Grouping Tools Manager Shared
--------------------------------------------
ZO_GroupingToolsManager_Shared = ZO_Object:Subclass()
function ZO_GroupingToolsManager_Shared:New(control)
    local manager = ZO_Object.New(self)
    manager:Initialize(control)
    return manager
end
function ZO_GroupingToolsManager_Shared:Initialize(control)
    self.control = control
    self.meetsContributionShareRequirements = DoesGroupMeetLFGContributionShareRequirements()
    self.selectedGroupType = nil
end
local ACTIVITY_ORDER = {
    [LFG_ACTIVITY_DUNGEON]        = 0,
    [LFG_ACTIVITY_MASTER_DUNGEON] = 1,
    [LFG_ACTIVITY_TRIAL]          = 2,
    [LFG_ACTIVITY_AVA]            = 3,
    [LFG_ACTIVITY_WORLD]          = 4,
}
local function ActivitySort(entry1, entry2)
    return ACTIVITY_ORDER[entry1.type] < ACTIVITY_ORDER[entry2.type]
end
function ZO_GroupingToolsManager_Shared:InitializeActivityData()
    local activitiesData = {}
    for type, data in pairs(ACTIVITY_DATA) do
        table.insert(activitiesData, data)
    end
    table.sort(activitiesData, ActivitySort)
    self.activitiesData = activitiesData
    self.selectedActivityIndex = 1
end
function ZO_GroupingToolsManager_Shared:InitializeLocationData()
    local locationsData = {}
    for i = 1, #self.activitiesData do
        local activityType = self.activitiesData[i].type
        if activityType == LFG_ACTIVITY_WORLD then
            self.worldSelector = ZO_GroupingToolsWorldSelector:New()
        elseif activityType == LFG_ACTIVITY_AVA then
            self.avaSelector = ZO_GroupingToolsAVASelector:New()
        else
            locationsData[activityType] = {}
            for lfgIndex = 1, GetNumLFGOptions(activityType) do
                local passedRequirements = select(7, GetLFGOption(activityType, lfgIndex))
                if passedRequirements then --this should only need to be checked at initialization, the current requirements don't change between sessions
                    local data = CreateLocationData(activityType, lfgIndex)
                    table.insert(locationsData[activityType], data)
                end
            end
            
            table.sort(locationsData[activityType], LFGLevelSort)
            --Insert the all selection
            if DoesLFGActivityHasAllOption(activityType) then
                local activityData = ACTIVITY_DATA[activityType]
                local data = {
                        name = activityData.allText,
                        description = activityData.allDescription,
                        descriptionTexture = activityData.texture,
                        descriptionTextureGamepad = activityData.textureGamepad,
                        activityType = activityType,
                        groupType = locationsData[activityType][LFG_LOCATIONS_ALL_INDEX].groupType, --there should not be an all option unless the group types are the same for all locations
                        isSelected = false,
                        isAllOption = true,
                    }
                table.insert(locationsData[activityType], LFG_LOCATIONS_ALL_INDEX, data)
            end
        end
    end
    self.locationsData = locationsData
end
function ZO_GroupingToolsManager_Shared:RegisterForEvents()
    local function OnGroupChanged()
    end
    self.control:RegisterForEvent(EVENT_PLAYER_ACTIVATED, function() self:ClearUpdate() end)
    self.control:RegisterForEvent(EVENT_GROUPING_TOOLS_STATUS_UPDATE, function(event, ...) self:OnGroupingToolsStatusUpdate(...) end)
    self.control:RegisterForEvent(EVENT_PREFERRED_CAMPAIGN_CHANGED, function(event, ...) self:OnPreferredCampaignChanged(...) end)
    self.control:RegisterForEvent(EVENT_LEVEL_UPDATE, function(eventCode, ...) self:OnLevelUpdate(...) end)
    self.control:RegisterForEvent(EVENT_VETERAN_RANK_UPDATE, function(eventCode, ...) self:OnVeteranRankUpdate(...) end)
    self.control:RegisterForEvent(EVENT_GROUP_MEMBER_LEFT, OnGroupChanged)
    self.control:RegisterForEvent(EVENT_GROUP_MEMBER_JOINED, OnGroupChanged)
    self.control:RegisterForEvent(EVENT_GROUP_UPDATE, OnGroupChanged)
    self.control:RegisterForEvent(EVENT_LEADER_UPDATE, function(event, ...) self:ClearUpdate() end)
end
function ZO_GroupingToolsManager_Shared:ClearUpdate()
    -- A clear and update is required when the selections may change due to requirement changes. (Ex: a group member
    --joins that doesn't meet the level requirement of a location already selected. The location needs to be unselected
    --and locked, and then all other locations need to be refreshed again in case they are now unlocked. Instead of
    --nesting refreshes, just clear and update when an event occurs that can lead to this.)
end
function ZO_GroupingToolsManager_Shared:RefreshContributionRequirements()
    self.meetsContributionShareRequirements = DoesGroupMeetLFGContributionShareRequirements()
    self:ClearUpdate()
end
function ZO_GroupingToolsManager_Shared:UpdateLocations()
    if IsCurrentlySearchingForGroup() then
        self:UpdateLocationsFromSearch()
        return
    end
    for activityType, locationsByActivity in pairs(self.locationsData) do
        local allAreLocked = true
        local inAGroup = IsUnitGrouped("player")
        local groupSize = GetGroupSize()
        for index = #locationsByActivity, 1, -1 do --reversed so we know the 'all locked' status for the all entry at index 1
            local location = locationsByActivity[index]
            --Determine lock status
            if location.isAllOption then
                location.isLocked = true
                if inAGroup and not IsUnitGroupLeader("player") then
                     location.lockReasonText = GetString(SI_LFG_LOCK_REASON_NOT_LEADER)
                elseif allAreLocked then
                    location.lockReasonText = zo_strformat(SI_LFG_LOCK_REASON_ALL_LOCATIONS_LOCKED, GetString("SI_LFGACTIVITY", activityType))
                elseif inAGroup then
                    location.lockReasonText = GetString(SI_LFG_LOCK_REASON_SELECTION_LIMIT_MEMBER_SEARCH)
                else
                    location.isLocked = false
                    location.lockReasonText = ""
                end
            else
                local lfgIndex = location.lfgIndex
                location.playerMeetsRequirements = DoesPlayerMeetLFGLevelRequirements(activityType, lfgIndex)
                location.groupMeetsLevelRequirements = DoesGroupMeetLFGLevelRequirements(activityType, lfgIndex)
                local groupFull = groupSize == ZO_GROUP_TYPE_TO_SIZE[location.groupType]
                local groupTooLarge = groupSize > ZO_GROUP_TYPE_TO_SIZE[location.groupType]
                local isDifferentGroupType = self.selectedGroupType and (location.groupType ~= self.selectedGroupType) or false
                local isAnotherLocationSelected = self:IsAnyLocationSelected() and not location.isSelected
                local isRoleSelected = IsPreferredRoleSelected()
                local requiredCollectible = GetRequiredLFGCollectibleId(activityType, lfgIndex)
                
                location.isLocked = true
                if inAGroup and not IsUnitGroupLeader("player") then
                    location.lockReasonText = GetString(SI_LFG_LOCK_REASON_NOT_LEADER)
                elseif not isRoleSelected then
                    location.lockReasonText = GetString(SI_LFG_LOCK_REASON_NO_ROLES_SELECTED)
                elseif IsInAvAZone() then --can only select AVA locations while in AVA area
                    location.lockReasonText = GetString(SI_LFG_LOCK_REASON_IN_AVA)
                elseif groupTooLarge then
                    location.lockReasonText = GetString(SI_LFG_LOCK_REASON_GROUP_TOO_LARGE)
                elseif groupFull then
                    location.lockReasonText = GetString(SI_LFG_LOCK_REASON_GROUP_FULL)
                elseif not location.playerMeetsRequirements then
                    local playerRank = GetUnitVeteranRank("player")
                    local levelMin = location.levelMin
                    if playerRank > 0 or location.levelMin == GetMaxLevel() then
                        local veteranRankMin = location.veteranRankMin
                        local veteranRankMax = location.veteranRankMax
                        if playerRank < veteranRankMin then
                            location.lockReasonText = zo_strformat(SI_LFG_LOCK_REASON_PLAYER_MIN_RANK_REQUIREMENT, veteranRankMin)
                        elseif playerRank > veteranRankMax then
                            location.lockReasonText = zo_strformat(SI_LFG_LOCK_REASON_PLAYER_MAX_RANK_REQUIREMENT, veteranRankMax)
                        end
                    else
                        local levelMax = location.levelMax
                        local playerLevel = GetUnitLevel("player")
                        if playerLevel < levelMin then
                            location.lockReasonText = zo_strformat(SI_LFG_LOCK_REASON_PLAYER_MIN_LEVEL_REQUIREMENT, levelMin)
                        elseif playerLevel > levelMax then
                            location.lockReasonText = zo_strformat(SI_LFG_LOCK_REASON_PLAYER_MAX_LEVEL_REQUIREMENT, levelMax)
                        end
                    end
                elseif not location.groupMeetsLevelRequirements and inAGroup then
                    if self.meetsContributionShareRequirements then
                        location.lockReasonText = GetString(SI_LFG_LOCK_REASON_GROUP_LOCATION_LEVEL_REQUIREMENTS)
                    else
                        if GetUnitVeteranRank("player") > 0 then
                            location.lockReasonText = zo_strformat(SI_LFG_LOCK_REASON_GROUP_RANK_CONTRIBUTION_REQUIREMENTS, SHARE_REQUIREMENTS_RANK)
                        else
                            location.lockReasonText = zo_strformat(SI_LFG_LOCK_REASON_GROUP_LEVEL_CONTRIBUTION_REQUIREMENTS, SHARE_REQUIREMENTS_LEVEL)
                        end
                    end
                elseif isDifferentGroupType then
                    location.lockReasonText = GetString(SI_LFG_LOCK_REASON_SELECTIONS_GROUP_SIZE)
                elseif inAGroup and isAnotherLocationSelected then --enforce having only one selection for LFM
                    location.lockReasonText = GetString(SI_LFG_LOCK_REASON_SELECTION_LIMIT_MEMBER_SEARCH)
                elseif requiredCollectible ~= 0 and not IsCollectibleUnlocked(requiredCollectible) then
                    location.lockReasonText = zo_strformat(SI_LFG_LOCK_REASON_DLC_NOT_UNLOCKED, GetCollectibleName(requiredCollectible))
                else
                    location.isLocked = false
                    location.lockReasonText = ""
                    allAreLocked = false
                end
            end
        end
    end
    self.worldSelector:Refresh(self.selectedGroupType, self:IsAnyLocationSelected())
    self.avaSelector:Refresh()
end
function ZO_GroupingToolsManager_Shared:UpdateLocationsFromSearch()
    --Populate data from any existing search
    local numLFGRequests = GetNumLFGRequests()
    if numLFGRequests > 0 then
        --Update locations
        for i = 1, numLFGRequests do
            local activityType, lfgIndex, isDPS, isHealer, isTank = GetLFGRequestInfo(i)
            
            local location = self:GetLocationFromLFGIndex(activityType, lfgIndex)
            if activityType == LFG_ACTIVITY_WORLD then
                self.worldSelector:SetSelectedLocation(location)
                self.worldSelector:SetSelected(true)
            elseif activityType == LFG_ACTIVITY_AVA then
                self.avaSelector:SetSelectedLocation(location)
                self.avaSelector:SetSelected(true)
            else
                location.isSelected = true
            end
        end
        --Update 'all' option
        for activityType, locationsByActivity in pairs(self.locationsData) do
            if DoesLFGActivityHasAllOption(activityType) then
                local allAreSelected = true
                for index = FIRST_LOCATION_INDEX, #locationsByActivity do
                    local location = locationsByActivity[index]
                    if not location.isSelected then
                        allAreSelected = false
                        break
                    end
                end
                if allAreSelected then
                    local allLocation = locationsByActivity[LFG_LOCATIONS_ALL_INDEX]
                    allLocation.isSelected = true
                end
            end
        end
    end
end
function ZO_GroupingToolsManager_Shared:ClearSelections()
    for activityType, locationsByActivity in pairs(self.locationsData) do
        for index = 1, #locationsByActivity do
            local location = locationsByActivity[index]
            location.isSelected = false
            location.isLocked = false
        end
    end
    self.worldSelector:Unselect()
    self.avaSelector:Unselect()
    self.selectedGroupType = nil
end
local function IsRoleSelected(roles)
    return roles[LFG_ROLE_DPS] or roles[LFG_ROLE_HEAL] or roles[LFG_ROLE_TANK]
end
local function CheckAddLocation(activityType, lfgIndex, roles)
    if not IsRoleSelected(roles) then
        local alertEnum = IsUnitGrouped("player") and LFG_ERROR_NO_ROLES_SELECTED or LFG_ERROR_NO_ROLES_SELECTED_MULTIPLE
        ZO_AlertEvent(EVENT_GROUPING_TOOLS_ERROR, alertEnum)    
         return false
    end
    AddGroupFinderSearchEntry(activityType, lfgIndex, roles[LFG_ROLE_DPS], roles[LFG_ROLE_HEAL], roles[LFG_ROLE_TANK])
    return true
end
function ZO_GroupingToolsManager_Shared:StartSearch()
    if IsCurrentlySearchingForGroup() then
        return
    end
    local preferredRoles = GAMEPAD_GROUP_ROLES_BAR:GetRoles()
    --Add locations
    for activityType, locationsByActivity in pairs(self.locationsData) do
        for index = 1, #locationsByActivity do
            local location = locationsByActivity[index]
            if location.isSelected and not location.isAllOption then
                local lfgIndex = location.lfgIndex
                if not CheckAddLocation(activityType, lfgIndex, preferredRoles) then
                    return
                end
            end
        end
    end
    --Add location from the world selector
    if self.worldSelector:IsSelected() then
        local lfgIndex = self.worldSelector:GetSelectedLocation().lfgIndex
        if not CheckAddLocation(LFG_ACTIVITY_WORLD, lfgIndex, preferredRoles) then
            return
        end
    end
    --Add location from the AVA selector
    if self.avaSelector:IsSelected() then
        local lfgIndex = self.avaSelector:GetSelectedLocation().lfgIndex
        if not CheckAddLocation(LFG_ACTIVITY_AVA, lfgIndex, preferredRoles) then
            return
        end
    end
end
function ZO_GroupingToolsManager_Shared:ToggleSelectorSelected(selector)
    if selector:IsLocked() then
        return
    end
    selector:ToggleSelected()
    --Set group type. This should only ever be cleared or re-set to the same type since locations of different types are locked.
    if self:IsAnyLocationSelected() then
        self.selectedGroupType = selector:GetGroupType()
    else
        self.selectedGroupType = nil
    end
end
function ZO_GroupingToolsManager_Shared:ToggleLocationSelected(location)
    if location.isLocked then
        return
    end
    if location.isAllOption then
        local locationsByActivity = self.locationsData[location.activityType]
        location.isSelected = not location.isSelected
        for i = 1, #locationsByActivity do
            locationsByActivity[i].isSelected = location.isSelected and not locationsByActivity[i].isLocked
        end
    else
        --Don't allow toggling individual locations when All option is selected
        if self:IsAllOptionSelected(location.activityType) then
            return
        end
        
        location.isSelected = not location.isSelected
    end
    --Set group type. This should only ever be cleared or re-set to the same type since locations of different types are locked.
    if self:IsAnyLocationSelected() then
        self.selectedGroupType = location.groupType
    else
        self.selectedGroupType = nil
    end
end
function ZO_GroupingToolsManager_Shared:IsAllOptionSelected(activityType)
    if DoesLFGActivityHasAllOption(activityType) then
        local locationsByActivity = self.locationsData[activityType]
        return locationsByActivity[LFG_LOCATIONS_ALL_INDEX].isSelected
    end
    return false
end
function ZO_GroupingToolsManager_Shared:IsAnyLocationSelected()
    --TODO: maybe keep an ongoing count of selected activities instead, and return > 0
    for activityType, locationsByActivity in pairs(self.locationsData) do
        for i = 1, #locationsByActivity do
            if locationsByActivity[i].isSelected then
                return true
            end
        end
    end
    if self.worldSelector:IsSelected() then
        return true
    end
    if self.avaSelector:IsSelected() then
        return true
    end
    return false
end
function ZO_GroupingToolsManager_Shared:GetLocationFromLFGIndex(activityType, lfgIndex)
    local locationsByActivity = self.locationsData[activityType]
    if activityType == LFG_ACTIVITY_WORLD then
        return self.worldSelector:GetLocation(lfgIndex)
    elseif activityType == LFG_ACTIVITY_AVA then
        return self.avaSelector:GetLocation(lfgIndex)
    else
        for i = 1, #locationsByActivity do
            if locationsByActivity[i].lfgIndex == lfgIndex then
                return locationsByActivity[i]
            end
        end
    end
end
-- Event callbacks
function ZO_GroupingToolsManager_Shared:OnGroupingToolsStatusUpdate()
    self:ClearUpdate()
end
function ZO_GroupingToolsManager_Shared:OnPreferredCampaignChanged(preferredCampaignId)
    self.currentCampaignName = GetCampaignName(preferredCampaignId)
end
function ZO_GroupingToolsManager_Shared:OnLevelUpdate(unitTag)
    if ZO_Group_IsGroupUnitTag(unitTag) or unitTag == "player" then
    end
end
function ZO_GroupingToolsManager_Shared:OnVeteranRankUpdate(unitTag)
    self:OnLevelUpdate(unitTag)
end
-- 'Virtual' functions
function ZO_GroupingToolsManager_Shared:RefreshLocationsList()
end
do
    EVENT_MANAGER:RegisterForEvent("ZO_GroupingToolsManager_Shared_OnGroupingToolsStatusUpdate", EVENT_GROUPING_TOOLS_STATUS_UPDATE,
        function(event, isSearching)
            PlaySound(isSearching and SOUNDS.LFG_SEARCH_STARTED or SOUNDS.LFG_SEARCH_FINISHED)
        end
    )
end