Back to Home

ESO Lua File v101044

libraries/zo_recurrencetracker/zo_recurrencetracker.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
local DEFAULT_EXPIRATION_INTERVAL_MS = 5000
local DEFAULT_EXTENSION_INTERVAL_MS = 5000
-- Tracks the number of occurrences of each value within an indeterminate set using a sliding time window.
ZO_RecurrenceTrackerValue = ZO_InitializingObject:Subclass()
function ZO_RecurrenceTrackerValue:Initialize(value, expirationMS)
    local currentFrameTimeMS = GetFrameTimeMilliseconds()
    self.m_expirationMS = expirationMS
    self.m_numOccurrences = 1
    self.m_value = value
end
function ZO_RecurrenceTrackerValue:GetExpirationMS()
    return self.m_expirationMS
end
function ZO_RecurrenceTrackerValue:GetNumOccurrences()
    return self.m_numOccurrences
end
function ZO_RecurrenceTrackerValue:GetValue()
    return self.m_value
end
function ZO_RecurrenceTrackerValue:HasExpired()
    return self.m_expirationMS and self.m_expirationMS <= GetFrameTimeMilliseconds() or false
end
-- Note: Expiration should only be set by the owning ZO_RecurrenceTracker
-- instance to optimize the maintenance for value expiration and removal.
function ZO_RecurrenceTrackerValue:SetExpirationMS(expirationMS)
    self.m_expirationMS = expirationMS
end
function ZO_RecurrenceTrackerValue:SetNumOccurrences(numOccurrences)
    self.m_numOccurrences = numOccurrences
end
ZO_RecurrenceTracker = ZO_InitializingObject:Subclass()
-- expirationIntervalMS = the initial lifetime for new values.
-- extensionIntervalMS = how long an existing value's lifetime should be extended for subsequent occurrences.
function ZO_RecurrenceTracker:Initialize(expirationIntervalMS, extensionIntervalMS)
    self:Reset()
    self.m_expirationIntervalMS = tonumber(expirationIntervalMS) or DEFAULT_EXPIRATION_INTERVAL_MS
    self.m_extensionIntervalMS = tonumber(extensionIntervalMS) or DEFAULT_EXTENSION_INTERVAL_MS
end
function ZO_RecurrenceTracker:AddValue(value)
    if value == nil then
        -- Ignore nil values.
        return
    end
    -- Perform clean up only when necessary.
    local currentTimeMS = GetFrameTimeMilliseconds()
    local expirationMS = nil
    local valueEntry = self:GetValue(value)
    if valueEntry then
        -- Increment the number of occurrences.
        local numOccurrences = valueEntry:GetNumOccurrences()
        numOccurrences = numOccurrences + 1
        valueEntry:SetNumOccurrences(numOccurrences)
        -- Extend the expiration time to the maximum of either the current expiration time or now + m_extensionIntervalMS.
        expirationMS = valueEntry:GetExpirationMS()
        expirationMS = zo_max(expirationMS, currentTimeMS + self.m_extensionIntervalMS)
        valueEntry:SetExpirationMS(expirationMS)
    else
        -- Add the new value entry.
        expirationMS = currentTimeMS + self.m_expirationIntervalMS
        valueEntry = ZO_RecurrenceTrackerValue:New(value, expirationMS)
        self.m_values[value] = valueEntry
    end
    if not self.m_nextExpirationMS or expirationMS < self.m_nextExpirationMS then
        -- Update the next expiration to this expiration.
        self.m_nextExpirationMS = expirationMS
    end
    return valueEntry:GetNumOccurrences()
end
-- Returns the number of unexpired occurrences for the specified value.
function ZO_RecurrenceTracker:GetNumValueOccurrences(value)
    local valueEntry = self:GetValue(value)
    return valueEntry and valueEntry:GetNumOccurrences() or 0
end
-- Returns the number of unexpired values (not occurrences).
function ZO_RecurrenceTracker:GetNumValues()
    -- Perform clean up only when necessary.
    return NonContiguousCount(self.m_values)
end
-- Returns a reference to the specified value entry object if the value
-- exists and has not yet expired.
function ZO_RecurrenceTracker:GetValue(value)
    local valueEntry = self.m_values[value]
    if valueEntry and valueEntry:HasExpired() then
        -- This entry has already expired; remove it and return nil.
        valueEntry = nil
        self.m_values[value] = nil
    end
    return valueEntry
end
-- Returns true if the specified value exists and has not yet expired.
function ZO_RecurrenceTracker:HasValue(value)
    local valueEntry = self:GetValue(value)
    return valueEntry ~= nil
end
-- Removes and returns the specified value if it exists and has not yet expired.
function ZO_RecurrenceTracker:RemoveValue(value)
    local valueEntry = self:GetValue(value)
    if valueEntry then
        self.m_values[value] = nil
    end
    return valueEntry
end
-- Removes all values.
function ZO_RecurrenceTracker:Reset()
    self.m_nextExpirationMS = nil
    self.m_values = {}
end
-- Performs internal maintenance for value expiration and removal.
-- Note: It should not be necessary to call this externally; the
-- tracker performs maintenance automatically when necessary.
function ZO_RecurrenceTracker:RemoveExpiredValues()
    if not self.m_nextExpirationMS then
        -- There are no values pending expiration.
        return
    end
    local currentTimeMS = GetFrameTimeMilliseconds()
    if currentTimeMS < self.m_nextExpirationMS then
        -- There are no values that have expired.
        return
    end
    -- Remove expired values and identify the next upcoming value expiration time.
    local nextExpirationMS = nil
    local values = self.m_values
    for value, valueEntry in pairs(values) do
        local expirationMS = valueEntry:GetExpirationMS()
        if expirationMS <= currentTimeMS then
            -- Remove the expired value.
            values[value] = nil
        elseif not nextExpirationMS or expirationMS < nextExpirationMS then
            -- Track the next upcoming expiration time.
            nextExpirationMS = expirationMS
        end
    end
    -- Track the next upcoming value expiration to avoid unnecessary maintenance.
    self.m_nextExpirationMS = nextExpirationMS
end