FloppaClient/floppaclient.module/ConfigModule

ConfigModule

class ConfigModule(name: String, keyCode: Int = 0, category: Category = Category.MISC, toggled: Boolean = false, settings: ArrayList<Setting<*>> = ArrayList(), description: String = "") : Module

A dummy implementation of the Module class.

This class is made to be used as a dummy class for gson to use when reading the module config.

Author

Aton

Constructors

ConfigModule

fun ConfigModule(name: String, keyCode: Int = 0, category: Category = Category.MISC, toggled: Boolean = false, settings: ArrayList<Setting<*>> = ArrayList(), description: String = "")

Functions

addSettings

fun addSettings(vararg setArray: Setting<*>)

Adds all settings in the input to the settings field of the module. This is required for saving and loading these settings to / from a file. Keep in mind, that these settings are passed by reference, which will get lost if the original setting is reassigned.

getSettingByName

fun getSettingByName(name: String): Setting<*>?

initializeModule

fun initializeModule()

Triggers the module initialization.

loadModule

fun loadModule()

Loads self registering elements of the module such as hud elements.

onDisable

open fun onDisable()

This method is run whenever the module is disabled.

onEnable

open fun onEnable()

This method is run whenever the module is enabled.

onInitialize

open fun onInitialize()

This method will be run on the FMLLoadCompleteEvent on game startup after the config is loaded.

onKeyBind

open fun onKeyBind()

This method is run whenever the key-bind for the Module is pressed.

fun <K : Setting<*>> register(setting: K): K

Registers the setting to this Module. This will make the setting appear in the GUI and save to the config. The following is an example of how it can be used to define a setting for a module.

toggle

fun toggle()

Will toggle the module.

unaryPlus

operator fun <K : Setting<*>> K.unaryPlus(): K

Overloads the unaryPlus operator for Setting classes to register them to the module. The following is an example of how it can be used to define a setting for a module.

ConfigModule

Author

Constructors

Functions

Properties