Super class for all Modules in the mod.

Annotate with AlwaysActive to have a Module always registered to the Event Bus regardless of the Module being enabled.

Making your own Module

To make your own Module simply create an object which inherits from this class and add it to the list of modules in ModuleManager. The sample provided below shows how you can do this.

Adding settings to your Module.

If you want your Module to have Settings which appear in the GUI you need to define the settings in your Module and also register them by adding them to the settings list.

There are four different ways to achieve this. These are shown in the following on the example of a NumberSetting. Probably the easiest to understand is to first define a property in your Module which is an Instance of the setting you want. And then registering that setting in the initializer.

private val distance : NumberSetting = NumberSetting("Distance", 4.0)

init{
    this.addSettings(distance)
}

This syntax can be shortened by using the register method directly when defining your setting. Inside of Module classes the unary Add operator is overridden for members of Setting to register them. So the following two lines will do exactly the same.

private val distance : NumberSetting = register(NumberSetting("Distance", 4.0))
private val distance : NumberSetting = +NumberSetting("Distance", 4.0)

Lastly the probably most convenient way of adding settings is through the use of delegation. The key difference here is that the property you are defining is not referring to the Setting but rather directly to its value. Since often the value is the only relevant aspect of the setting within the Modules code this approach is a lot more convenient to use in most cases. Notice how the type of distance is Double in the following example and not NumberSetting.

private val distance : Double by NumberSetting("Distance", 4.0)

Adding more functionality to your Settings.

The setting classes offer support for more functionality, namely adding a dependency for the setting to show in the GUI and the option to perform custom processing of changes to the setting. The sample from AutoClicker below shows both of these being used. The input transform is used to further limit the range in which the slider can be moved. And the dependency is set so that the setting only shows in the click gui when the corresponding click mode is enabled.

Adding a HUD to your Module

To add a HUD to your module simply declare an object which inherits from the HudElement class within your Module. For this HUD element to be active you need to register it. All you need to do for that is to annotate it with the RegisterHudElement annotation. Inside your HUD element object you need to implement the renderHud method. This ís responsible for rendering the element.

The following example shows how to use it.

object MyModule : Module("My Module", category = Category.RENDER) {
    @RegisterHudElement
    object MyHudElement : HudElement(this, 0, 150, 100, 20) {
        override fun renderHud() {
            // Rendering implementation
        }
    }
}