- Joined
- Jun 26, 2013
- Messages
- 49
Event Dispatcher implemented in Lua. It can work in the normal object mode or in the WLPM module mode (detected automatically).
One of the fundamental modules when building achitecture application.
Solves the high сohesion problem. Based on the observer pattern.
Installation
Copy code from /src and use eventDispatcher global
OR use WLPM and import("eventDispatcher")
wlpm install Indaxia/lua-eventDispatcher
Usage
Refer the test file for details
One of the fundamental modules when building achitecture application.
Solves the high сohesion problem. Based on the observer pattern.
Installation
Copy code from /src and use eventDispatcher global
OR use WLPM and import("eventDispatcher")
wlpm install Indaxia/lua-eventDispatcher
Usage
Lua:
-- Subscription on the event
-- The event param is an object with "data", "name" and "stopPropagation" properties
-- You can set event.stopPropagation = true inside the callback to break current dispatch loop
eventDispatcher.on("my.event.a", function(event)
print("Callback A 1: " .. event.data)
end)
-- ... another file ...
-- Dispatch with any data
eventDispatcher.dispatch("my.event.a", "Dispatch A 1 Data")
Lua:
if(_G["WM"] == nil) then WM = (function(m,h) h(nil,(function() end), (function(e) _G[m] = e end)) end) end -- WLPM MM fallback
-- Warcraft 3 eventDispatcher module by ScorpioT1000 / 2020
WM("eventDispatcher", function(import, export, exportDefault)
local handlers = {}
exportDefault({
-- Subscribe to an event with the callback function that takes an event param
-- The event param is an object with "data", "name" and "stopPropagation" properties
-- You can set event.stopPropagation = true inside the callback
-- to break current dispatch loop
--- @param eventName string
--- @param callback function
on = function(eventName, callback)
if(handlers[eventName] == nil) then
handlers[eventName] = {}
end
table.insert(handlers[eventName], callback)
end,
-- Unsubscribe from the event. Specify the same function ref from on() to avoid every subscription removal
--- @param eventName string
--- @param specialCallback function
off = function(eventName, specialCallback)
local callbacks = handlers[eventName]
if(callbacks ~= nil) then
if(specialCallback ~= nil) then
local counter = #callbacks
for i = #callbacks, 1, -1 do
if(callbacks[i] == specialCallback) then
table.remove(callbacks, i)
end
end
else
handlers[eventName] = nil
end
end
end,
-- Dispatch the event and pass a data to it (optional)
--- @param eventName string
--- @param data
dispatch = function(eventName, data)
local callbacks = handlers[eventName]
local event = {
name = eventName,
data = data,
stopPropagation = false
}
if(callbacks == nil) then
return
end
for i,callback in ipairs(callbacks) do
callback(event)
if(event.stopPropagation) then
return
end
end
end,
-- Removes all handlers
clear = function()
handlers = {}
end
})
end)Version History
1.2: fixed potential desync (different behavior on different machines) in case of multiple listeners of one eventRefer the test file for details
Last edited:
