Page 1 of 1

OnEvent wrapper for easy usage

Posted: Sat Oct 13, 2018 4:14 am
by Emral
Tired of being confused at the structure of onEvent/onEventDirect? Do you always get lost in a heap of if/elseif statements that seem odd?
Maybe not. Maybe yes. Here's a cleaner way to make entirely seperate per-event onEvent branches anyway.

In every case of the different examples, all that needs to be done is to create a new function and reference it in the table with the key as the name of the event that should call it. Multiple events can, of course, call to the same function, by binding the function to 2 event names seperately.
It comes in 3 flavours:

OnEvent and I don't care about which event was fired:

Code: Select all

--write your code for onEvent into functions like this

local function myFirstEventFunc()
    -- do stuff
end

--reference functions to have them be called at the right time

local eventFuncs = {
    ["Level-Start"] = myFirstEventFunc,
    ["mycustomevent"] = myFirstEventFunc
}

--onEvent doesn't need to be touched

function onEvent(eventname)
    if eventFuncs[eventname] then eventFuncs[eventname]()
end

OnEvent and I do care about what was fired:

Code: Select all

--write your code for onEvent into functions like this

local function myFirstEventFunc(eventname)
    -- do stuff
end

--reference functions to have them be called at the right time

local eventFuncs = {
    ["Level-Start"] = myFirstEventFunc,
    ["mycustomevent"] = myFirstEventFunc
}

--onEvent doesn't need to be touched

function onEvent(eventname)
    if eventFuncs[eventname] then eventFuncs[eventname](eventname)
end
I want to be able to cancel events so I'm using onEventDirect:

Code: Select all

--write your code for onEvent into functions like this

local function myFirstEventFunc(eventobj, eventname)
    -- do stuff
end

--reference functions to have them be called at the right time

local eventFuncs = {
    ["Level-Start"] = myFirstEventFunc,
    ["mycustomevent"] = myFirstEventFunc
}

--onEvent doesn't need to be touched

function onEventDirect(eventobj, eventname)
    if eventFuncs[eventname] then eventFuncs[eventname](eventobj, eventname)
end
Might be helpful for those of you who previously got confused at the notion of onEvent("killboss1") not working. This is kind of the next best thing. That specific concept is kind of represented in the eventFuncs table with lines like ["mycustomevent"] = myFirstEventFunc.

Re: OnEvent wrapper for easy usage

Posted: Fri Oct 19, 2018 1:53 pm
by ThePieSkyHigh
This will help a lot of people.

I don't use a lot of events and layers yet, but I'll get to it someday.

Somebody is gonna quote me saying: "Please make more productive posts."

:/