Back to Home

ESO Lua File v100030

ingame/contacts/friendslist_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
-----------------
--Friends List
-----------------
ZO_FriendsList = ZO_SocialManager:Subclass()
local EVENT_NAMESPACE = "FriendsList"
FRIEND_DATA = 1
FRIENDS_LIST_ENTRY_SORT_KEYS =
{
    ["displayName"] = { },
    ["characterName"] = { },
    ["isHeronUser"] = { tiebreaker = "status" },
    ["status"]  = { tiebreaker = "normalizedLogoffSort", isNumeric = true  },
    ["class"]  = { tiebreaker = "displayName" },
    ["formattedZone"]  = { tiebreaker = "displayName" },
    ["alliance"] = { tiebreaker = "displayName" },
    ["championPoints"] = { tiebreaker = "displayName", isNumeric = true},
    ["level"] = { tiebreaker = "championPoints", isNumeric = true },
    ["normalizedLogoffSort"] = { tiebreaker = "displayName", isNumeric = true },
}
function ZO_FriendsList:New()
    local manager = ZO_SocialManager.New(self)
    ZO_FriendsList.Initialize(manager)
    return manager
end
function ZO_FriendsList:Initialize()
    self.lastUpdateTime = 0
    self.numOnlineFriends = 0
    self.noteEditedFunction = function(displayName, note)
        for i = 1, GetNumFriends() do
            local currentDisplayName = GetFriendInfo(i)
            if currentDisplayName == displayName then
                SetFriendNote(i, note)
                return
            end
        end
    end
    EVENT_MANAGER:RegisterForEvent(EVENT_NAMESPACE, EVENT_SOCIAL_DATA_LOADED, function() self:OnSocialDataLoaded() end)
    EVENT_MANAGER:RegisterForEvent(EVENT_NAMESPACE, EVENT_FRIEND_ADDED, function(_, displayName) self:OnFriendAdded(displayName) end)
    EVENT_MANAGER:RegisterForEvent(EVENT_NAMESPACE, EVENT_FRIEND_REMOVED, function(_, displayName) self:OnFriendRemoved(displayName) end)
    EVENT_MANAGER:RegisterForEvent(EVENT_NAMESPACE, EVENT_FRIEND_CHARACTER_UPDATED, function(_, displayName) self:OnFriendCharacterUpdated(displayName) end)
    EVENT_MANAGER:RegisterForEvent(EVENT_NAMESPACE, EVENT_FRIEND_DISPLAY_NAME_CHANGED, function(_, oldDisplayName, newDisplayName) self:OnFriendDisplayNameChanged(oldDisplayName, newDisplayName) end)
    EVENT_MANAGER:RegisterForEvent(EVENT_NAMESPACE, EVENT_FRIEND_CHARACTER_ZONE_CHANGED, function(_, displayName, characterName, zoneName) self:OnFriendCharacterZoneChanged(displayName, characterName, zoneName) end)
    EVENT_MANAGER:RegisterForEvent(EVENT_NAMESPACE, EVENT_FRIEND_CHARACTER_LEVEL_CHANGED, function(_, displayName, characterName, level) self:OnFriendCharacterLevelChanged(displayName, characterName, level) end)
    EVENT_MANAGER:RegisterForEvent(EVENT_NAMESPACE, EVENT_FRIEND_CHARACTER_CHAMPION_POINTS_CHANGED, function(_, displayName, characterName, championPoints) self:OnFriendCharacterChampionPointsChanged(displayName, characterName, championPoints) end)
    EVENT_MANAGER:RegisterForEvent(EVENT_NAMESPACE, EVENT_FRIEND_NOTE_UPDATED, function(_, displayName, note) self:OnFriendNoteUpdated(displayName, note) end)
    EVENT_MANAGER:RegisterForEvent(EVENT_NAMESPACE, EVENT_FRIEND_PLAYER_STATUS_CHANGED, function(_, displayName, characterName, oldStatus, newStatus) self:OnFriendPlayerStatusChanged(displayName, characterName, oldStatus, newStatus) end)
    if IsHeronUI() then
        EVENT_MANAGER:RegisterForEvent(EVENT_NAMESPACE, EVENT_FRIEND_HERON_USER_INFO_UPDATED, function(_, displayName, heronName) self:OnFriendHeronUserInfoUpdated(displayName, heronName) end)
    end
end
function ZO_FriendsList:GetNumOnline()
    return self.numOnlineFriends
end
function ZO_FriendsList:SetupEntry(control, data, selected)
    local note = GetControl(control, "Note")
    if note then
        note:SetHidden(data.note == "")
    end
end
function ZO_FriendsList:CreateFriendData(friendIndex, displayName, note, status)
    local hasCharacter, characterName, zone, class, alliance, level, championPoints = GetFriendCharacterInfo(friendIndex)
    local heronName
    if IsHeronUI() then
        heronName = GetFriendHeronName(friendIndex)
    end
    local data =
    {
        friendIndex = friendIndex,
        displayName = displayName,
        hasCharacter = hasCharacter,
        characterName = ZO_CachedStrFormat(SI_UNIT_NAME, characterName),
        gender = GetGenderFromNameDescriptor(characterName),
        level = level,
        championPoints = championPoints,
        class = class,
        formattedZone = ZO_CachedStrFormat(SI_ZONE_NAME, zone),
        alliance = alliance,
        formattedAllianceName = ZO_CachedStrFormat(SI_ALLIANCE_NAME, GetAllianceName(alliance)),
        note = note,
        type = SOCIAL_NAME_SEARCH,
        status = status,
        heronName = heronName,
        isHeronUser = heronName ~= nil,
    }
    return data
end
function ZO_FriendsList:UpdateFriendData(data, friendIndex)
    local hasCharacter, characterName, zone, class, alliance, level, championPoints = GetFriendCharacterInfo(friendIndex)
    data.friendIndex = friendIndex
    data.hasCharacter = hasCharacter
    data.characterName = ZO_CachedStrFormat(SI_UNIT_NAME, characterName)
    data.gender = GetGenderFromNameDescriptor(characterName)
    data.formattedZone = ZO_CachedStrFormat(SI_ZONE_NAME, zone)
    data.class = class
    data.alliance = alliance
    data.formattedAllianceName = ZO_CachedStrFormat(SI_ALLIANCE_NAME, GetAllianceName(alliance))
    data.level = level
    data.championPoints = championPoints
end
function ZO_FriendsList:BuildMasterList()
    self.numOnlineFriends = 0
    local numFriends = GetNumFriends()
    for i=1, numFriends do
        local displayName, note, status, secsSinceLogoff = GetFriendInfo(i)
        local online = status ~= PLAYER_STATUS_OFFLINE
        if online then
            self.numOnlineFriends = self.numOnlineFriends + 1
        end
        local data = self:CreateFriendData(i, displayName, note, status)
        ZO_SocialList_SetUpOnlineData(data, online, secsSinceLogoff)
        self.masterList[i] = data
    end
end
function ZO_FriendsList:FindDataByDisplayName(displayName)
    for i = 1, #self.masterList do
        local data = self.masterList[i]
        if data.displayName == displayName then
            return data, i
        end
    end
end
function ZO_FriendsList:GetNoteEditedFunction()
    return self.noteEditedFunction
end
--Events
---------
function ZO_FriendsList:OnSocialDataLoaded()
    self:RefreshData()
end
function ZO_FriendsList:OnFriendAdded(displayName)
    self:RefreshData()
end
function ZO_FriendsList:OnFriendRemoved(displayName)
    local data, index = self:FindDataByDisplayName(displayName)
    if index then
        -- NOTE: This must stay in sync with the friends list ordering-by-index in the client
        -- TODO: Use displayName as accessor?
        self.masterList[index] = self.masterList[#self.masterList]
        self.masterList[#self.masterList] = nil
        self:OnNumTotalFriendsChanged()
        if data.online then
            self.numOnlineFriends = self.numOnlineFriends - 1
            self:OnNumOnlineChanged()
        end
        self:RefreshFilters()
    end
end
function ZO_FriendsList:OnFriendNoteUpdated(displayName, note)
    local data = self:FindDataByDisplayName(displayName)
    if data then
        data.note = note
        self:RefreshFilters()
    end
end
function ZO_FriendsList:OnFriendCharacterUpdated(displayName)
    local data, friendIndex = self:FindDataByDisplayName(displayName)
    if data then
        self:UpdateFriendData(data, friendIndex)
        self:RefreshFilters()
    end
end
function ZO_FriendsList:OnFriendDisplayNameChanged(oldDisplayName, newDisplayName)
    local data = self:FindDataByDisplayName(oldDisplayName)
    if data then
        data.displayName = newDisplayName
        self:RefreshSort()
    end
end
function ZO_FriendsList:OnFriendCharacterZoneChanged(displayName, characterName, zoneName)
    local data = self:FindDataByDisplayName(displayName)
    if data then
        data.zone = zoneName
        data.formattedZone = ZO_CachedStrFormat(SI_ZONE_NAME, zoneName)
        self:RefreshSort()
    end
end
function ZO_FriendsList:OnFriendCharacterLevelChanged(displayName, characterName, level)
    local data = self:FindDataByDisplayName(displayName)
    if data then
        data.level = level
        self:RefreshSort()
    end
end
function ZO_FriendsList:OnFriendCharacterChampionPointsChanged(displayName, characterName, championPoints)
    local data = self:FindDataByDisplayName(displayName)
    if data then
        data.championPoints = championPoints
        self:RefreshSort()
    end
end
function ZO_FriendsList:OnFriendPlayerStatusChanged(displayName, characterName, oldStatus, newStatus)
    local data, friendIndex = self:FindDataByDisplayName(displayName)
    if data then
        --Because we may have refreshed the whole list in between when this event happened and when we received it,
        --we must use our conception of whether they were online, not whether they were online or not when the event happened.
        local wasOnline = data.online
        local isOnline = (newStatus ~= PLAYER_STATUS_OFFLINE)
        data.status = newStatus
        if wasOnline and not isOnline then
            ZO_SocialList_SetUpOnlineData(data, false, 0)
            self.numOnlineFriends = self.numOnlineFriends - 1
            self:OnNumOnlineChanged()
        elseif not wasOnline and isOnline then
            ZO_SocialList_SetUpOnlineData(data, true)
            self:UpdateFriendData(data, friendIndex)
            self.numOnlineFriends = self.numOnlineFriends + 1
            self:OnNumOnlineChanged()
        end
        self:RefreshFilters()
    end
end
function ZO_FriendsList:OnFriendHeronUserInfoChanged(displayName, heronName)
    local data, friendIndex = self:FindDataByDisplayName(displayName)
    if data then
        data.heronName = heronName
        data.isHeronUser = heronName ~= nil
        self:RefreshSort()
    end
end
function ZO_FriendsList:OnNumTotalFriendsChanged()
    self:CallFunctionOnLists("OnNumTotalFriendsChanged")
end
function ZO_FriendsList:OnNumOnlineChanged()
    self:CallFunctionOnLists("OnNumOnlineChanged")
    CALLBACK_MANAGER:FireCallbacks("NumOnlineFriendsChanged", self.numOnlineFriends)
end
-- A singleton will be used by both keyboard and gamepad screens
FRIENDS_LIST_MANAGER = ZO_FriendsList:New()