Using Events

Configurable company provides some events that can help you updating configuration values and many other things.

The events are all registered under CEvents class.

Add An Event Listener

To start listening a new event you need to attach a listener. I recommend to add all listeners when your mod starts.

// This method should be called when you plugin starts
public static void AttachListeners() {

    // In this example we will listen to configuration changes
    CEvents.ConfigEvents.ChangeConfig.AddListener(MyEventListener);

}

public static void MyEventListener(CEventChangeConfig evt) {

    if (evt.Config.ID == myConfig.ID) {
        // The configuration is the one I want to check
    }
}

A brief explanation about what is happening. When you attach a listener, you are telling the event what method(s) should it call.

All events have one parameter that contains all the information about the event. In the example above this paramter is a CEventChangeConfig that contains information about what value changed in a configuration.

INFO
Some events have a CEvent parameter. This is the default one and does not contain any information, however it should be added as a parameter anyways.

Existing Events

There a lot of events you can listen to. These are divided into multiples sections depending on the type of event.