Back to Home

ESO Lua File v100019

ingame/globals/autocomplete.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
AUTO_COMPLETE_FLAG_NONE = 0
AUTO_COMPLETE_FLAG_FRIEND = 1
AUTO_COMPLETE_FLAG_GUILD = 2
AUTO_COMPLETE_FLAG_RECENT = 3
AUTO_COMPLETE_FLAG_RECENT_TARGET = 4
AUTO_COMPLETE_FLAG_RECENT_CHAT = 5
AUTO_COMPLETE_FLAG_GUILD_NAMES = 6
AUTO_COMPLETE_FLAG_ALL = 7
local g_currentPlayerName
local g_currentPlayerUserId
local RecentPlayerTracker = ZO_Object:Subclass()
function RecentPlayerTracker:New(...)
    local recentPlayerTracker = ZO_Object.New(self)
    recentPlayerTracker:Initialize(...)
    return recentPlayerTracker
end
function RecentPlayerTracker:Initialize(maxPlayers, optTableToUse)
    self.maxPlayers = maxPlayers
    self.recentPlayers = optTableToUse or {}
    self.numRecentPlayers = NonContiguousCount(self.recentPlayers)
end
function RecentPlayerTracker:GetPlayers()
    return self.recentPlayers
end
function RecentPlayerTracker:RemoveOldPlayers()
    local entriesToRemove = self.numRecentPlayers - self.maxPlayers
    local currentTimeStamp = GetTimeStamp()
    while entriesToRemove > 0 do
        local oldestName, oldestTimestampDifference
        for name, timestamp in pairs(self.recentPlayers) do
            local difference = GetDiffBetweenTimeStamps(currentTimeStamp, timestamp)
            if not oldestTimestampDifference or difference > oldestTimestampDifference then
                oldestName = name
                oldestTimestampDifference = difference
            end
        end
        assert(oldestName)
        self.recentPlayers[oldestName] = nil
        entriesToRemove = entriesToRemove - 1
    end
    self.numRecentPlayers = self.maxPlayers
end
function RecentPlayerTracker:AddRecentPlayer(name)
    if name and name ~= g_currentPlayerName and name ~= g_currentPlayerUserId then
        if self.recentPlayers[name] then
            --Already exists, just update the timestamp
            self.recentPlayers[name] = GetTimeStamp()
        else
            --Didn't exist, add it, then check if there's too many entries
            self.recentPlayers[name] = GetTimeStamp()
            self.numRecentPlayers = self.numRecentPlayers + 1
            if self.numRecentPlayers > self.maxPlayers then
                self:RemoveOldPlayers()
            end
        end
    end
end
local g_recentInteractions -- created below from saved variables
local g_recentTargets = RecentPlayerTracker:New(15) -- not persisted
local g_recentChat = RecentPlayerTracker:New(30) -- not persisted
local INCLUDE = true
local EXCLUDE = false
local function IncludeOrExcludeResult(results, result, include)
    if result ~= g_currentPlayerName and result ~= g_currentPlayerUserId then
        local lowerResult = zo_strlower(result)
        if include then
            results[lowerResult] = result
        else
            results[lowerResult] = nil
        end
    end
end
local function IncludeOrExcludePlayersFromRecentPlayerTracker(recentPlayerTracker, results, include)
    local isDecoratedDisplayName
    local isConsoleUI = IsConsoleUI()
    for name in pairs(recentPlayerTracker:GetPlayers()) do
        isDecoratedDisplayName = IsDecoratedDisplayName(name)
        if isDecoratedDisplayName then
            name = ZO_FormatUserFacingDisplayName(name)
        end
        if not isConsoleUI or isDecoratedDisplayName then
            IncludeOrExcludeResult(results, name, include)
        end
    end
end
local FlagHandlers = {
    [AUTO_COMPLETE_FLAG_FRIEND] = function(results, input, onlineOnly, include)
        for i=1, GetNumFriends() do
            local displayName, _, playerStatus = GetFriendInfo(i)
            if not onlineOnly or playerStatus ~= PLAYER_STATUS_OFFLINE then
                --No @ symbols and no character names on console
                IncludeOrExcludeResult(results, ZO_FormatUserFacingDisplayName(displayName), include)
                if not IsConsoleUI() then
                    local hasCharacter, characterName = GetFriendCharacterInfo(i)
                    if hasCharacter then
                        IncludeOrExcludeResult(results, zo_strformat("<<1>>", characterName), include)
                    end
                end
            end
        end
    end,
    [AUTO_COMPLETE_FLAG_GUILD] = function(results, input, onlineOnly, include)
        for i = 1, GetNumGuilds() do
            local guildId = GetGuildId(i)
            local numMembers = GetNumGuildMembers(guildId)
            for memberIndex = 1, numMembers do
                local displayName, _, _, playerStatus = GetGuildMemberInfo(guildId, memberIndex)
                if not onlineOnly or playerStatus ~= PLAYER_STATUS_OFFLINE then
                    --No @ symbols and no character names on console
                    IncludeOrExcludeResult(results, ZO_FormatUserFacingDisplayName(displayName), include)
                    if not IsConsoleUI() then
                        local hasCharacter, characterName = GetGuildMemberCharacterInfo()
                        if hasCharacter then
                            IncludeOrExcludeResult(results, zo_strformat("<<1>>", characterName), include)
                        end
                    end
                end
            end
        end
    end,
    [AUTO_COMPLETE_FLAG_RECENT] = function(results, input, onlineOnly, include)
        IncludeOrExcludePlayersFromRecentPlayerTracker(g_recentInteractions, results, include)
    end,
    [AUTO_COMPLETE_FLAG_RECENT_TARGET] = function(results, input, onlineOnly, include)
        IncludeOrExcludePlayersFromRecentPlayerTracker(g_recentTargets, results, include)
    end,
    [AUTO_COMPLETE_FLAG_RECENT_CHAT] = function(results, input, onlineOnly, include)
        IncludeOrExcludePlayersFromRecentPlayerTracker(g_recentChat, results, include)
    end,
    [AUTO_COMPLETE_FLAG_GUILD_NAMES] = function(results, input, onlineOnly, include)
        for i = 1, GetNumGuilds() do
            local guildId = GetGuildId(i)
            local guildName = GetGuildName(guildId)
            IncludeOrExcludeResult(results, zo_strformat("<<1>>", guildName), include)
        end
    end,
}
do
    local function ComputeSubStringMatchScore(source, startIndex, trimmedTextToScore)
        local startIndex, endIndex = source:find(trimmedTextToScore, startIndex, true)
        if startIndex then
            return ((endIndex - startIndex) / (#source * .1)) * 10
        end
        return 0
    end
    function ComputeScore(source, scoringText, startIndex, trimmedTextToScore)
        return ComputeStringDistance(source, scoringText) - ComputeSubStringMatchScore(source, startIndex, trimmedTextToScore)
    end
    local POOR_MATCH_RATIO = .75
    local POOR_MATCH_MIN = 1
    local scores = {}
    local function BinaryInsertComparer(leftScore, _, rightIndex)
        return leftScore - scores[rightIndex]
    end
    local zo_binarysearch = zo_binarysearch
    function GetTopMatchesByLevenshteinSubStringScore(stringsToScore, scoringText, startingIndex, maxResults, noMinScore)
        maxResults = maxResults or 10
        if maxResults == 0 then return end
        startIndex = startingIndex or 1
        scoringText = zo_strlower(scoringText)
        local trimmedTextToScore = scoringText:sub(startingIndex, 20)
        local results = {}
        ZO_ClearNumericallyIndexedTable(scores)
        local minScore = POOR_MATCH_RATIO * (zo_min(#scoringText, 10 + startIndex) - startIndex - POOR_MATCH_MIN)
        for lowerSource, source in pairs(stringsToScore) do
            local score = ComputeScore(lowerSource, scoringText, startIndex, trimmedTextToScore)
            if noMinScore or (score <= minScore) then
                local _, insertPosition = zo_binarysearch(score, results, BinaryInsertComparer)
                table.insert(results, insertPosition, source)
                table.insert(scores, insertPosition, score)
                results[maxResults + 1] = nil
                scores[maxResults + 1] = nil
            end
        end
        return results
    end
end
local function TryCallFlagHandler(flag, possibleMatches, input, onlineOnly, include)
    local handler = FlagHandlers[flag]
    if handler then
        handler(possibleMatches, input, onlineOnly, include)
    end
end
local function GenerateAutoCompletionResults(input, maxResults, onlineOnly, includeFlags, excludeFlags, noMinScore)
    local possibleMatches = {}
    if not includeFlags or includeFlags[1] == AUTO_COMPLETE_FLAG_ALL then
        for flag = 1, AUTO_COMPLETE_FLAG_ALL - 1 do
            TryCallFlagHandler(flag, possibleMatches, input, onlineOnly, INCLUDE)
        end
    else
        for i, flag in ipairs(includeFlags) do
            TryCallFlagHandler(flag, possibleMatches, input, onlineOnly, INCLUDE)
        end
    end
    if excludeFlags then
        if excludeFlags[1] == AUTO_COMPLETE_FLAG_ALL then
            return
        end
        for i, flag in ipairs(excludeFlags) do
            TryCallFlagHandler(flag, possibleMatches, input, onlineOnly, EXCLUDE)
        end
    end 
    local results = GetTopMatchesByLevenshteinSubStringScore(possibleMatches, input, 1, maxResults, noMinScore)
    if results then
        return unpack(results)
    end
end
function GetAutoCompletion(input, maxResults, onlineOnly, includeFlags, excludeFlags, noMinScore)
    maxResults = maxResults or 10
    input = input:lower()
    return GenerateAutoCompletionResults(input, maxResults, onlineOnly, includeFlags, excludeFlags, noMinScore)
end
local function Initialize(event, name)
    if name == "ZO_Ingame" then
        g_currentPlayerName = GetUnitName("player")
        g_currentPlayerUserId = GetDisplayName()
        local function OnChatMessage(event, messageType, name)
            if not IsDecoratedDisplayName(name) then
                name = zo_strformat("<<1>>", name)
            end
            if messageType == CHAT_CHANNEL_WHISPER then
                g_recentInteractions:AddRecentPlayer(name)
            else
                g_recentChat:AddRecentPlayer(name)
            end
        end
        local function OnUnitCreated(event, tag)
            g_recentInteractions:AddRecentPlayer(GetUnitName(tag))
        end
        local function OnInboxUpdate()
            for mailId in ZO_GetNextMailIdIter do
                local senderDisplayName, senderCharacterName = GetMailSender(mailId)
                local _, _, fromSystem, fromCustomerService = GetMailFlags(mailId)
                if not fromSystem and not fromCustomerService then
                    g_recentInteractions:AddRecentPlayer(senderDisplayName)
                    g_recentInteractions:AddRecentPlayer(zo_strformat("<<1>>", senderCharacterName))
                end
            end
        end
        local function OnTradeWindowInviteAccepted()
            g_recentInteractions:AddRecentPlayer(zo_strformat(SI_GAMEPAD_TRADE_USERNAME, TRADE_WINDOW.target))
        end
        local function TryAddRecentTarget(unitTag)
            if IsUnitPlayer(unitTag) and AreUnitsCurrentlyAllied("player", unitTag) then
                g_recentTargets:AddRecentPlayer(GetUnitName(unitTag))
            end
        end
        local function OnReticleTargetChanged()
            TryAddRecentTarget("reticleover")
        end
        local function OnReticleTargetPlayerChanged()
            TryAddRecentTarget("reticleoverplayer")
        end
        EVENT_MANAGER:RegisterForEvent("AutoComplete", EVENT_CHAT_MESSAGE_CHANNEL, OnChatMessage)
        EVENT_MANAGER:RegisterForEvent("AutoComplete", EVENT_UNIT_CREATED, OnUnitCreated)
        EVENT_MANAGER:RegisterForEvent("AutoComplete", EVENT_MAIL_INBOX_UPDATE, OnInboxUpdate)
        EVENT_MANAGER:RegisterForEvent("AutoComplete", EVENT_TRADE_INVITE_ACCEPTED, OnTradeWindowInviteAccepted)
        EVENT_MANAGER:RegisterForEvent("AutoComplete", EVENT_RETICLE_TARGET_CHANGED, OnReticleTargetChanged)
        EVENT_MANAGER:RegisterForEvent("AutoComplete", EVENT_RETICLE_TARGET_PLAYER_CHANGED, OnReticleTargetPlayerChanged)
        local defaults = {
            RecentInteractions = {}
        }
        local db = ZO_SavedVars:New("ZO_Ingame_SavedVariables", 3, "AutoComplete", defaults)
        g_recentInteractions = RecentPlayerTracker:New(45, db.RecentInteractions)
        EVENT_MANAGER:UnregisterForEvent("AutoComplete", EVENT_ADD_ON_LOADED)
    end
end
EVENT_MANAGER:RegisterForEvent("AutoComplete", EVENT_ADD_ON_LOADED, Initialize)