Back to Home

ESO Lua File v101044

libraries/zo_statemachine/zo_statemachine.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
------------
--Triggers--
------------
--Base--
ZO_StateMachine_TriggerBase = ZO_Object:Subclass()
function ZO_StateMachine_TriggerBase:New(...)
    local object = ZO_Object.New(self)
    object:Initialize(...)
    return object
end
function ZO_StateMachine_TriggerBase:Initialize()
    self.registeredEdge = nil
    self.defaultTriggerFunction = function() self:Trigger() end
end
function ZO_StateMachine_TriggerBase:RegisterEdge(edge)
    --A trigger can't be registered to more than one edge at a time, lest madness occur
    assert(self.registeredEdge == nil)
    self.registeredEdge = edge
end
function ZO_StateMachine_TriggerBase:UnregisterEdge()
    self.registeredEdge = nil
end
function ZO_StateMachine_TriggerBase:Trigger()
    if self.registeredEdge then
        self.registeredEdge:Trigger()
    end
end
--Keybind--
ZO_StateMachine_TriggerKeybind = ZO_StateMachine_TriggerBase:Subclass()
function ZO_StateMachine_TriggerKeybind:New(...)
    return ZO_StateMachine_TriggerBase.New(self, ...)
end
function ZO_StateMachine_TriggerKeybind:Initialize(keybindDescriptor)
    ZO_StateMachine_TriggerBase.Initialize(self)
    self.keybindDescriptor = keybindDescriptor
end
function ZO_StateMachine_TriggerKeybind:RegisterEdge(edge)
    ZO_StateMachine_TriggerBase.RegisterEdge(self, edge)
    self.keybindDescriptor.callback = self.defaultTriggerFunction
    KEYBIND_STRIP:AddKeybindButton(self.keybindDescriptor)
end
function ZO_StateMachine_TriggerKeybind:UnregisterEdge()
    ZO_StateMachine_TriggerBase.UnregisterEdge(self)
    KEYBIND_STRIP:RemoveKeybindButton(self.keybindDescriptor)
end
--State Callback--
ZO_StateMachine_TriggerStateCallback = ZO_StateMachine_TriggerBase:Subclass()
function ZO_StateMachine_TriggerStateCallback:New(...)
    return ZO_StateMachine_TriggerBase.New(self, ...)
end
function ZO_StateMachine_TriggerStateCallback:Initialize(eventName)
    ZO_StateMachine_TriggerBase.Initialize(self)
    self.eventName = eventName
    self.eventCountOrCallback = nil
    self.triggerFunction = function()
        if self.eventCountNeeded then
            self.eventCountNeeded = self.eventCountNeeded - 1
            if self.eventCountNeeded > 0 then
                return
            end
        end
        self.defaultTriggerFunction()
    end
end
function ZO_StateMachine_TriggerStateCallback:RegisterEdge(edge)
    ZO_StateMachine_TriggerBase.RegisterEdge(self, edge)
    
    if self.eventCountOrCallback then
        if type(self.eventCountOrCallback) == "function" then
            self.eventCountNeeded = self.eventCountOrCallback()
        else
            self.eventCountNeeded = self.eventCountOrCallback
        end
    end
end
function ZO_StateMachine_TriggerStateCallback:UnregisterEdge()
    self.registeredEdge:GetParentMachine():UnregisterCallback(self.eventName, self.triggerFunction)
    self.eventCountNeeded = nil
    ZO_StateMachine_TriggerBase.UnregisterEdge(self)
end
--Use this if you want to wait until a dynamic number of the specified events gets called before triggering
function ZO_StateMachine_TriggerStateCallback:SetEventCount(countOrCallback)
    self.eventCountOrCallback = countOrCallback
end
--Event Manager--
ZO_StateMachine_TriggerEventManager = ZO_StateMachine_TriggerBase:Subclass()
function ZO_StateMachine_TriggerEventManager:New(...)
    return ZO_StateMachine_TriggerBase.New(self, ...)
end
function ZO_StateMachine_TriggerEventManager:Initialize(eventId)
    ZO_StateMachine_TriggerBase.Initialize(self)
    self.eventId = eventId
    self.edgeName = nil
    self.filterCallback = nil
    self.triggerFunction = function(...)
        if not self.filterCallback or self.filterCallback(...) then
            self.defaultTriggerFunction()
        end
    end
end
function ZO_StateMachine_TriggerEventManager:RegisterEdge(edge)
    ZO_StateMachine_TriggerBase.RegisterEdge(self, edge)
    self.edgeName = edge:GetEdgeName()
    EVENT_MANAGER:RegisterForEvent(self.edgeName, self.eventId, self.triggerFunction)
end
function ZO_StateMachine_TriggerEventManager:UnregisterEdge()
    EVENT_MANAGER:UnregisterForEvent(self.edgeName, self.eventId)
    self.edgeName = nil
    ZO_StateMachine_TriggerBase.UnregisterEdge(self)
end
--Use this if you want to run verification checks on the event params before accepting the event as a trigger
function ZO_StateMachine_TriggerEventManager:SetFilterCallback(callback)
end
--Anim Note Event Manager--
ZO_StateMachine_TriggerAnimNote = ZO_StateMachine_TriggerEventManager:Subclass()
function ZO_StateMachine_TriggerAnimNote:New(...)
    return ZO_StateMachine_TriggerEventManager.New(self, ...)
end
function ZO_StateMachine_TriggerAnimNote:Initialize(expectedNote)
    ZO_StateMachine_TriggerEventManager.Initialize(self, EVENT_ANIMATION_NOTE)
    local function FilterCallback(eventCode, eventNote)
        return expectedNote == eventNote
    end
end
--Multi-Trigger
--Used when you need to get one edge to proc on a number of triggers being hit
ZO_StateMachine_MultiTrigger = ZO_StateMachine_TriggerBase:Subclass()
function ZO_StateMachine_MultiTrigger:New(...)
    return ZO_StateMachine_TriggerBase.New(self, ...)
end
function ZO_StateMachine_MultiTrigger:Initialize(...)
    ZO_StateMachine_TriggerBase.Initialize(self)
    self.triggerList = {}
    self.pendingTriggers = {}
    local function OnTrigger(trigger)
        self.pendingTriggers[trigger] = nil
        
        if NonContiguousCount(self.pendingTriggers) == 0 then
            self.defaultTriggerFunction()
        end
    end
    for i = 1, select("#", ...) do
        local trigger = select(i, ...)
        trigger.Trigger = OnTrigger
        table.insert(self.triggerList, trigger)
    end
end
function ZO_StateMachine_MultiTrigger:RegisterEdge(edge)
    ZO_StateMachine_TriggerBase.RegisterEdge(self, edge)
    for _, trigger in ipairs(self.triggerList) do
        trigger:RegisterEdge(edge)
        self.pendingTriggers[trigger] = true
    end
end
function ZO_StateMachine_MultiTrigger:UnregisterEdge()
    ZO_ClearTable(self.pendingTriggers)
    for _, trigger in ipairs(self.triggerList) do
        trigger:UnregisterEdge()
    end
    ZO_StateMachine_TriggerBase.UnregisterEdge(self)
end
--------
--Edge--
--------
ZO_StateMachine_Edge = ZO_CallbackObject:Subclass()
function ZO_StateMachine_Edge:New(...)
    local object = ZO_CallbackObject.New(self)
    object:Initialize(...)
    return object
end
function ZO_StateMachine_Edge:Initialize(fromState, toState)
    -- Don't draw a bridge across machines
    assert(fromState:GetParentMachine() == toState:GetParentMachine())
    self.parentMachine = fromState:GetParentMachine()
    self.fromState = fromState
    self.toState = toState
    self.triggers = {}
    self.active = false
    fromState:AddEdge(self)
end
function ZO_StateMachine_Edge:GetParentMachine()
    return self.parentMachine
end
function ZO_StateMachine_Edge:GetEdgeName()
    return self.fromState:GetFullName() .. self.toState:GetName()
end
function ZO_StateMachine_Edge:SetConditional(conditionalCallback)
end
function ZO_StateMachine_Edge:AddTrigger(trigger)
    table.insert(self.triggers, trigger)
end
function ZO_StateMachine_Edge:Activate()
    if self.conditionalCallback and not self.conditionalCallback() then
        return
    end
    for _, trigger in ipairs(self.triggers) do
        trigger:RegisterEdge(self)
    end
    self.active = true
    self:FireCallbacks("OnActivated")
end
function ZO_StateMachine_Edge:Deactivate()
    if self.active then
        self.active = false
        for _, trigger in ipairs(self.triggers) do
            trigger:UnregisterEdge(self)
        end
        self:FireCallbacks("OnDeactivated")
    end
end
function ZO_StateMachine_Edge:Trigger()
    if self.parentMachine:GetDebugLoggingEnabled() then
        d("Triggering edge between " .. self.fromState:GetFullName() .. " and " .. self.toState:GetFullName())
    end
    self:FireCallbacks("OnTrigger")
    self.parentMachine:SetCurrentState(self.toState)
end
function ZO_StateMachine_Edge:IsActive()
    return self.active
end
---------
--State--
---------
ZO_StateMachine_State = ZO_CallbackObject:Subclass()
function ZO_StateMachine_State:New(...)
    local object = ZO_CallbackObject.New(self)
    object:Initialize(...)
    return object
end
do
    local FULL_NAME_FORMAT = "%s_%s"
    function ZO_StateMachine_State:Initialize(parentMachine, name)
        self.name = name
        self.parentMachine = parentMachine
        self.fullName = string.format(FULL_NAME_FORMAT, self.parentMachine:GetName(), name)
        self.edges = {}
    end
end
function ZO_StateMachine_State:GetName()
    return self.name
end
function ZO_StateMachine_State:GetFullName()
    return self.fullName
end
function ZO_StateMachine_State:SetUpdate(updateCallback)
    assert(updateCallback ~= nil)
    self.updateName = self.fullName
end
function ZO_StateMachine_State:AddEdge(edge)
    table.insert(self.edges, edge)
end
function ZO_StateMachine_State:GetParentMachine()
    return self.parentMachine
end
function ZO_StateMachine_State:Activate()
    self:FireCallbacks("OnActivating")
    for _, edge in ipairs(self.edges) do
        edge:Activate()
    end
    if self.parentMachine:GetDebugLoggingEnabled() then
        d(self.fullName .. " firing its OnActivated callbacks.")
    end
    if self.updateName then
        EVENT_MANAGER:RegisterForUpdate(self.updateName, 0, self.updateCallback)
        if self.parentMachine:GetDebugLoggingEnabled() then
            d(self.fullName .. " registered for an update.")
        end
    end
    
    self:FireCallbacks("OnActivated")
end
function ZO_StateMachine_State:Deactivate()
    self:FireCallbacks("OnDeactivating")
    if self.updateName then
        EVENT_MANAGER:UnregisterForUpdate(self.updateName)
        if self.parentMachine:GetDebugLoggingEnabled() then
            d(self.fullName .. " unregistered for an update.")
        end
    end
    
    if self.parentMachine:GetDebugLoggingEnabled() then
        d(self.fullName .. " firing its OnDeactivated callbacks.")
    end
    for _, edge in ipairs(self.edges) do
        edge:Deactivate()
    end
    
    self:FireCallbacks("OnDeactivated")
end
--------
--Base--
--------
ZO_StateMachine_Base = ZO_CallbackObject:Subclass()
function ZO_StateMachine_Base:New(...)
    local object = ZO_CallbackObject.New(self)
    object:Initialize(...)
    return object
end
function ZO_StateMachine_Base:Initialize(name)
    self.name = name
    self.currentState = nil
    self.states = {}
    self.edges = {}
    self.triggers = {}
end
function ZO_StateMachine_Base:GetName()
    return self.name
end
-- States --
function ZO_StateMachine_Base:AddState(stateName, optionalStateTemplate, ...)
    local template = optionalStateTemplate or ZO_StateMachine_State
    local state = template:New(self, stateName, ...)
    self.states[stateName] = state
    return state
end
function ZO_StateMachine_Base:GetStateByName(stateName)
    return self.states[stateName]
end
function ZO_StateMachine_Base:SetCurrentState(state)
    if type(state) == "string" then
        state = self:GetStateByName(state)
    end
    if state == self.currentState then
        return
    end
    if self.currentState then
        self.currentState:Deactivate()
    end
    self.currentState = state
    state:Activate()
    self:FireCallbacks("OnStateChange")
end
function ZO_StateMachine_Base:GetCurrentState()
    return self.currentState
end
function ZO_StateMachine_Base:HasCurrentState()
    return self.currentState ~= nil
end
function ZO_StateMachine_Base:IsCurrentState(state)
    if type(state) == "string" then
        state = self:GetStateByName(state)
    end
    return self:GetCurrentState() == state
end
-- Edges --
function ZO_StateMachine_Base:AddEdge(edgeName, fromState, toState, optionalEdgeTemplate, ...)
    if type(fromState) == "string" then
        fromState = self:GetStateByName(fromState)
    end
    if type(toState) == "string" then
        toState = self:GetStateByName(toState)
    end
    local template = optionalEdgeTemplate or ZO_StateMachine_Edge
    local edge = template:New(fromState, toState, ...)
    self.edges[edgeName] = edge
    return edge
end
function ZO_StateMachine_Base:AddEdgeAutoName(fromState, toState, optionalEdgeTemplate, ...)
    local fromStateName = (type(fromState) == "string") and fromState or fromState:GetName()
    local toStateName = (type(toState) == "string") and toState or toState:GetName()
    local edgeName = string.format("%s_TO_%s", fromStateName, toStateName)
    return self:AddEdge(edgeName, fromState, toState, optionalEdgeTemplate, ...)
end
function ZO_StateMachine_Base:GetEdgeByName(edgeName)
    return self.edges[edgeName]
end
-- Triggers --
function ZO_StateMachine_Base:AddTrigger(triggerName, triggerTemplate, ...)
    local trigger = triggerTemplate:New(...)
    self.triggers[triggerName] = trigger
    return trigger
end
function ZO_StateMachine_Base:SetTrigger(triggerName, trigger)
    self.triggers[triggerName] = trigger
end
function ZO_StateMachine_Base:GetTriggerByName(triggerName)
    return self.triggers[triggerName]
end
function ZO_StateMachine_Base:AddTriggerToEdge(trigger, edge)
    if type(trigger) == "string" then
        trigger = self:GetTriggerByName(trigger)
    end
    if type(edge) == "string" then
        edge = self:GetEdgeByName(edge)
    end
    edge:AddTrigger(trigger)
end
function ZO_StateMachine_Base:Reset()
    if self.currentState then
        self.currentState:Deactivate()
        self.currentState = nil
    end
end
function ZO_StateMachine_Base:SetDebugLoggingEnabled(enabled)
    self.debugLoggingEnabled = enabled
end
function ZO_StateMachine_Base:GetDebugLoggingEnabled()
    return self.debugLoggingEnabled
end