Help#

Here are some things about BetterEventSystem that i think might be confusing, so i wrote this page to help you.

Don’t be afraid to use the contents section at the right of this page to find what you need.

If you still have questions, check the API reference or feel free to contact me

preprocessor / postprocessor#

preprocessors are functions that are called before all listeners. They can be used to modify the data before your listeners are called.

How do I create a preprocessor?

to add a preprocessor to an event, use the AddPreprocessor method. your preprocessor function must take two parameters, the first is an EventData, the second is an Action.

Once you have finished modifying the data, you must call the second parameter to continue the event. If you don’t, the preprocessor will be called in an infinite loop until you do.

If you don’t want to modify the data, just call the second parameter anyway.

Example:

// add preprocessor to the event
EventSystem.GetEvent("my_event").AddPreprocessor((e, next) => {
    Console.WriteLine("my_event is about to be triggered, this is a preprocessor");
    // cast the data to a dictionary, as we send it as a Dictionary. If your data is not a dictionary, you must cast it to whatever you want to send.
    // But keep in mind if it is not a dictionary, the following code will not work.
    Dictionary<string, string> data = e.data as Dictionary<string, string>; 
    foreach (var item in data.Values.ToList()) {
        Console.WriteLine("data: " + item); // this will print all the values in the dictionary
    }
    data.Add("preprocessor", "true"); // add a new key to the dictionary
    e.data = data;  // set our changed data
    next(e); // pass our data to the next preprocessor or the event listener
});

What is the difference between a preprocessor and a listener?

A preprocessor is a function that can be used to modify the data before your listeners are called.

A listener cannot modify data, but a preprocessor can.

postprocessors are functions that are caled after all listeners.

How do i create a postprocessor

to add a postprocessor to an event, use the AddPostprocessor method. your postprocessor function must take an EventData object.

What is the difference between a postprocessor and a listener?

It is the exact same as a listener, except it is called after and can be cancelled by the listener dynamically.

Example:

// add postprocessor to the event
EventSystem.GetEvent("my_event").AddPostprocessor(e => {
    Console.WriteLine("my_event has finished being run.");
    // cast the data to a dictionary, as we send it as a Dictionary. If your data is not a dictionary, you must cast it to whatever you want to send.
    // But keep in mind if it is not a dictionary, the following code will not work.
    Dictionary<string, string> data = e.data as Dictionary<string, string>; 
    foreach (var item in data.Values.ToList()) {
        Console.WriteLine("data: " + item); // this will print all the values in the dictionary
    }
});