ESO Lua File v100010

ingame/contacts/friendslist.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
-----------------
--Friends List
-----------------
local ZO_FriendsListManager = ZO_SocialList:Subclass()
local FRIEND_DATA = 1
local FRIEND_SEARCH = 1
local ENTRY_SORT_KEYS =
{
    ["displayName"] = { },
    ["status"]  = { tiebreaker = "normalizedLogoffSort", isNumeric = true  },
    ["class"]  = { tiebreaker = "displayName" },
    ["zone"]  = { tiebreaker = "displayName" },
    ["alliance"] = { tiebreaker = "displayName" },
    ["veteranRank"] = { tiebreaker = "displayName", isNumeric = true},
    ["level"] = { tiebreaker = "veteranRank", isNumeric = true },
    ["normalizedLogoffSort"] = { tiebreaker = "displayName", isNumeric = true },
}
function ZO_FriendsListManager:New(control)
    local manager = ZO_SocialList.New(self, control)
    control:SetHandler("OnEffectivelyHidden", function() manager:OnEffectivelyHidden() end)
    manager.lastUpdateTime = 0
    manager.numOnlineFriends = 0
    manager.playerAlliance = GetUnitAlliance("player")
    
    ZO_ScrollList_AddDataType(manager.list, FRIEND_DATA, "ZO_FriendsListRow", 30, function(control, data) manager:SetupFriendEntry(control, data) end)
    ZO_ScrollList_EnableHighlight(manager.list, "ZO_ThinListHighlight")
    manager.searchBox = GetControl(control, "SearchBox")
    manager.searchBox:SetHandler("OnTextChanged", function() manager:OnSearchTextChanged() end)
    manager.search = ZO_StringSearch:New()
    manager.search:AddProcessor(FRIEND_SEARCH, function(stringSearch, data, searchTerm, cache) return manager:ProcessFriendEntry(stringSearch, data, searchTerm, cache) end)
    manager.sortFunction = function(listEntry1, listEntry2) return manager:CompareFriends(listEntry1, listEntry2) end
    manager.noteEditedFunction = function(displayName, note)
        for i = 1, GetNumFriends() do
            local currentDisplayName = GetFriendInfo(i)
            if(currentDisplayName == displayName) then
                SetFriendNote(i, note)
                return
            end
        end
    end
    manager.masterList = {}
    manager:SetEmptyText(GetString(SI_FRIENDS_LIST_PANEL_NO_FRIENDS_MESSAGE))
    manager:RefreshData()
    manager.sortHeaderGroup:SelectHeaderByKey("status")
    
    EVENT_MANAGER:RegisterForEvent("FriendsList", EVENT_SOCIAL_DATA_LOADED, function() manager:OnSocialDataLoaded() end)
    EVENT_MANAGER:RegisterForEvent("FriendsList", EVENT_FRIEND_ADDED, function(_, displayName) manager:OnFriendAdded(displayName) end)
    EVENT_MANAGER:RegisterForEvent("FriendsList", EVENT_FRIEND_REMOVED, function(_, displayName) manager:OnFriendRemoved(displayName) end)
    EVENT_MANAGER:RegisterForEvent("FriendsList", EVENT_FRIEND_CHARACTER_UPDATED, function(_, displayName) manager:OnFriendCharacterUpdated(displayName) end)
    EVENT_MANAGER:RegisterForEvent("FriendsList", EVENT_FRIEND_CHARACTER_ZONE_CHANGED, function(_, displayName, characterName, zoneName) manager:OnFriendCharacterZoneChanged(displayName, characterName, zoneName) end)
    EVENT_MANAGER:RegisterForEvent("FriendsList", EVENT_FRIEND_CHARACTER_LEVEL_CHANGED, function(_, displayName, characterName, level) manager:OnFriendCharacterLevelChanged(displayName, characterName, level) end)
    EVENT_MANAGER:RegisterForEvent("FriendsList", EVENT_FRIEND_CHARACTER_VETERAN_RANK_CHANGED, function(_, displayName, characterName, veteranRank) manager:OnFriendCharacterVeteranRankChanged(displayName, characterName, veteranRank) end)
    EVENT_MANAGER:RegisterForEvent("FriendsList", EVENT_FRIEND_NOTE_UPDATED, function(_, displayName, note) manager:OnFriendNoteUpdated(displayName, note) end)
    EVENT_MANAGER:RegisterForEvent("FriendsList", EVENT_FRIEND_PLAYER_STATUS_CHANGED, function(_, displayName, characterName, oldStatus, newStatus) manager:OnFriendPlayerStatusChanged(displayName, characterName, oldStatus, newStatus) end)
    
    manager:InitializeKeybindDescriptors()
    FRIENDS_LIST_SCENE = ZO_Scene:New("friendsList", SCENE_MANAGER)
    FRIENDS_LIST_SCENE:RegisterCallback("StateChange",  function(oldState, newState)
                                                            if(newState == SCENE_SHOWING) then        
                                                                KEYBIND_STRIP:AddKeybindButtonGroup(manager.staticKeybindStripDescriptor)
                                                                KEYBIND_STRIP:AddKeybindButtonGroup(manager.keybindStripDescriptor)
                                                            elseif(newState == SCENE_HIDDEN) then      
                                                                KEYBIND_STRIP:RemoveKeybindButtonGroup(manager.staticKeybindStripDescriptor)                                                          
                                                                KEYBIND_STRIP:RemoveKeybindButtonGroup(manager.keybindStripDescriptor)
                                                            end
                                                        end)
    return manager
end
function ZO_FriendsListManager:InitializeKeybindDescriptors()
    self.staticKeybindStripDescriptor =
    {
        alignment = KEYBIND_STRIP_ALIGN_CENTER,
        -- Add Friend
        {
            name = GetString(SI_FRIENDS_LIST_PANEL_ADD_FRIEND),
            keybind = "UI_SHORTCUT_PRIMARY",
        
            callback = function()
                ZO_Dialogs_ShowDialog("REQUEST_FRIEND")
            end,
        },
    }
    
    self.keybindStripDescriptor =
    {
        alignment = KEYBIND_STRIP_ALIGN_RIGHT,
        -- Whisper
        {
            name = GetString(SI_SOCIAL_LIST_PANEL_WHISPER),
            keybind = "UI_SHORTCUT_SECONDARY",
        
            callback = function()
                local data = ZO_ScrollList_GetData(self.mouseOverRow)
                StartChatInput("", CHAT_CHANNEL_WHISPER, data.displayName)
            end,
            visible = function()
                if(self.mouseOverRow) then
                    local data = ZO_ScrollList_GetData(self.mouseOverRow)
                    return data.hasCharacter and data.online
                end
                return false
            end
        },
        -- Invite to Group
        {
            name = GetString(SI_FRIENDS_LIST_PANEL_INVITE),
            keybind = "UI_SHORTCUT_TERTIARY",
        
            callback = function()
                local data = ZO_ScrollList_GetData(self.mouseOverRow)
                local NOT_SENT_FROM_CHAT = false
                local DISPLAY_INVITED_MESSAGE = true
                TryGroupInviteByName(data.characterName, NOT_SENT_FROM_CHAT, DISPLAY_INVITED_MESSAGE)
            end,
            visible = function()
                if(self.mouseOverRow) then
                    local data = ZO_ScrollList_GetData(self.mouseOverRow)
                    if(data.hasCharacter and data.online and data.alliance == self.playerAlliance) then                        
                        return true
                    end
                end
                return false
            end
        },  
    }    
end
function ZO_FriendsListManager:OnNumOnlineChanged()
    if(FRIENDS_ONLINE) then
        FRIENDS_ONLINE:Update()
    end
    CHAT_SYSTEM:OnNumOnlineFriendsChanged(self.numOnlineFriends)
end
function ZO_FriendsListManager:OnNumTotalFriendsChanged()
    if(FRIENDS_ONLINE) then
        FRIENDS_ONLINE:Update()
    end
end
function ZO_FriendsListManager:GetNumOnline()
    return self.numOnlineFriends
end
function ZO_FriendsListManager:SetupFriendEntry(control, data)
    local note = GetControl(control, "Note")
    note:SetHidden(data.note == "")
end
function ZO_FriendsListManager:CreateFriendData(friendIndex, displayName, note, status)
    local hasCharacter, characterName, zone, class, alliance, level, veteranRank = GetFriendCharacterInfo(friendIndex)
       
    local data = 
    {
        displayName = displayName,
        hasCharacter = hasCharacter,
        characterName = zo_strformat(SI_UNIT_NAME, characterName), 
        gender = GetGenderFromNameDescriptor(characterName),
        level = level, 
        veteranRank = veteranRank, 
        class = class, 
        zone = zone, 
        alliance = alliance, 
        allianceName = GetAllianceName(alliance), 
        note = note,
        type = FRIEND_SEARCH,
        status = status,
    }
    return data
end
function ZO_FriendsListManager:UpdateFriendData(data, friendIndex)
    local hasCharacter, characterName, zone, class, alliance, level, veteranRank = GetFriendCharacterInfo(friendIndex)
    
    data.hasCharacter = hasCharacter
    data.characterName = zo_strformat(SI_UNIT_NAME, characterName)
    data.gender = GetGenderFromNameDescriptor(characterName)
    data.zone = zone
    data.class = class
    data.alliance = alliance
    data.level = level
    data.veteranRank = veteranRank
end
function ZO_FriendsListManager:ProcessFriendEntry(stringSearch, data, searchTerm, cache)
    local lowerSearchTerm = searchTerm:lower()
    if(zo_plainstrfind(data.displayName:lower(), lowerSearchTerm)) then
        return true
    end
    if(data.characterName ~= nil and zo_plainstrfind(data.characterName:lower(), lowerSearchTerm)) then
        return true
    end
end
function ZO_FriendsListManager: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)
        self:SetUpOnlineData(data, online, secsSinceLogoff)
        self.masterList[i] = data
    end
end
function ZO_FriendsListManager:FilterScrollList()
    local scrollData = ZO_ScrollList_GetDataList(self.list)
    ZO_ClearNumericallyIndexedTable(scrollData)
    local searchTerm = self.searchBox:GetText()
    for i = 1, #self.masterList do
        local data = self.masterList[i]
        if(searchTerm == "" or self.search:IsMatch(searchTerm, data)) then
            table.insert(scrollData, ZO_ScrollList_CreateDataEntry(FRIEND_DATA, data))
        end
    end    
end
function ZO_FriendsListManager:CompareFriends(listEntry1, listEntry2)
    return ZO_TableOrderingFunction(listEntry1.data, listEntry2.data, self.currentSortKey, ENTRY_SORT_KEYS, self.currentSortOrder)
end
function ZO_FriendsListManager:SortScrollList()
    if(self.currentSortKey ~= nil and self.currentSortOrder ~= nil) then
        local scrollData = ZO_ScrollList_GetDataList(self.list)
        table.sort(scrollData, self.sortFunction)
    end
end
function ZO_FriendsListManager:UnlockSelection()
    ZO_SortFilterList.UnlockSelection(self)
    self:RefreshVisible()
end
function ZO_FriendsListManager:FindDataByDisplayName(displayName)
    for i = 1, #self.masterList do
        local data = self.masterList[i]
        if(data.displayName == displayName) then
            return data, i
        end
    end
end
--Events
---------
function ZO_FriendsListManager:FriendsListRow_OnMouseUp(control, button, upInside)
    if(button == 2 and upInside) then
        ClearMenu()
        local data = ZO_ScrollList_GetData(control)
        if data then
            AddMenuItem(GetString(SI_SOCIAL_MENU_EDIT_NOTE),    function()
                                                                    ZO_Dialogs_ShowDialog("EDIT_NOTE", {displayName = data.displayName, note = data.note, changedCallback = self.noteEditedFunction})
                                                                end)
            AddMenuItem(GetString(SI_SOCIAL_MENU_SEND_MAIL), function() MAIL_SEND:ComposeMailTo(data.displayName) end)
            if(data.hasCharacter and data.online) then
                AddMenuItem(GetString(SI_SOCIAL_LIST_SEND_MESSAGE), function() StartChatInput("", CHAT_CHANNEL_WHISPER, data.displayName) end)            
                if(data.alliance == self.playerAlliance) then
                    AddMenuItem(GetString(SI_SOCIAL_MENU_INVITE), function() 
                        local NOT_SENT_FROM_CHAT = false
                        local DISPLAY_INVITED_MESSAGE = true
                        TryGroupInviteByName(data.characterName, NOT_SENT_FROM_CHAT, DISPLAY_INVITED_MESSAGE) 
                    end)
                    AddMenuItem(GetString(SI_SOCIAL_MENU_JUMP_TO_PLAYER), function() JumpToFriend(data.displayName) end)
                end     
            end
            AddMenuItem(GetString(SI_FRIEND_MENU_REMOVE_FRIEND), function() ZO_Dialogs_ShowDialog("CONFIRM_REMOVE_FRIEND", {displayName = data.displayName}, {mainTextParams = {data.displayName}}) end)
            AddMenuItem(GetString(SI_FRIEND_MENU_IGNORE), function() AddIgnore(data.displayName) end)
        
            self:ShowMenu(control)
        end
    end
end
function ZO_FriendsListManager:OnSearchTextChanged()
    self:RefreshFilters()
end
function ZO_FriendsListManager:OnEffectivelyHidden()
    ZO_Dialogs_ReleaseDialog("REQUEST_FRIEND")
end
function ZO_FriendsListManager:OnSocialDataLoaded()
    self:RefreshData()
end
function ZO_FriendsListManager:OnFriendAdded(displayName)
    self:RefreshData()
end
function ZO_FriendsListManager: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_FriendsListManager:OnFriendNoteUpdated(displayName, note)
    local data = self:FindDataByDisplayName(displayName)
    if(data) then
        data.note = note
        self:RefreshFilters()
    end
end
function ZO_FriendsListManager:OnFriendCharacterUpdated(displayName)
    local data, friendIndex = self:FindDataByDisplayName(displayName)
    if(data) then
        self:UpdateFriendData(data, friendIndex)
        self:RefreshFilters()
    end
end
function ZO_FriendsListManager:OnFriendCharacterZoneChanged(displayName, characterName, zoneName)
    local data = self:FindDataByDisplayName(displayName)
    if(data) then
        data.zone = zoneName
        self:RefreshSort()
    end
end
function ZO_FriendsListManager:OnFriendCharacterLevelChanged(displayName, characterName, level)
    local data = self:FindDataByDisplayName(displayName)
    if(data) then
        data.level = level
        self:RefreshSort()
    end
end
function ZO_FriendsListManager:OnFriendCharacterVeteranRankChanged(displayName, characterName, veteranRank)
    local data = self:FindDataByDisplayName(displayName)
    if(data) then
        data.veteranRank = veteranRank
        self:RefreshSort()
    end
end
function ZO_FriendsListManager: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
            self:SetUpOnlineData(data, false, 0)
            self.numOnlineFriends = self.numOnlineFriends - 1
            self:OnNumOnlineChanged()
        elseif(not wasOnline and isOnline) then            
            self:SetUpOnlineData(data, true)
            self:UpdateFriendData(data, friendIndex)
            self.numOnlineFriends = self.numOnlineFriends + 1
            self:OnNumOnlineChanged()
        end
        self:RefreshSort()
    end
end
--Local XML
--------------
function ZO_FriendsListManager:FriendsButton_OnMouseEnter(control)
    InitializeTooltip(InformationTooltip, control, TOPLEFT, 0, 0, BOTTOMRIGHT)
    SetTooltipText(InformationTooltip, zo_strformat(SI_FRIENDS_ONLINE_TOOLTIP, self.numOnlineFriends, GetNumFriends()))
end
function ZO_FriendsListManager:FriendsButton_OnMouseExit(control)
    ClearTooltip(InformationTooltip)
end
function ZO_FriendsListManager:FriendsButton_OnClicked(control)
    if(not ZO_Dialogs_IsShowingDialog()) then
        MAIN_MENU:ShowScene("friendsList")
    end
end
--Global XML
---------------
    FRIENDS_LIST:Row_OnMouseEnter(control)
end
    FRIENDS_LIST:Row_OnMouseExit(control)
end
function ZO_FriendsListRow_OnMouseUp(control, button, upInside)
    FRIENDS_LIST:FriendsListRow_OnMouseUp(control, button, upInside)
end
    FRIENDS_LIST:Note_OnMouseEnter(control)
end
    FRIENDS_LIST:Note_OnMouseExit(control)
end
    FRIENDS_LIST:Note_OnClicked(control)
end
    FRIENDS_LIST:DisplayName_OnMouseEnter(control)
end
    FRIENDS_LIST:DisplayName_OnMouseExit(control)
end
    FRIENDS_LIST:Alliance_OnMouseEnter(control)
end
    FRIENDS_LIST:Alliance_OnMouseExit(control)
end
    FRIENDS_LIST:Status_OnMouseEnter(control)
end
    FRIENDS_LIST:Status_OnMouseExit(control)
end
    FRIENDS_LIST:Class_OnMouseEnter(control)
end
    FRIENDS_LIST:Class_OnMouseExit(control)
end
    FRIENDS_LIST = ZO_FriendsListManager:New(self)
end