FloppaClient/floppaclient.module.impl.dungeon/AutoWater

AutoWater

A module to automatically complete the water board puzzle in one flow.

It does not actively scan the board to calculate the best path but instead uses preset solutions. It will not work when the board is not in a default state or is being messed with while being solved.

Author

Aton

Types

Condition

open class Condition

Conditions for when to flick a lever.

GateColor

enum GateColor : Enum<AutoWater.GateColor>

Gates

object Gates

Contains and manages information about the gates.

GateState

enum GateState : Enum<AutoWater.GateState>

All 10 possible configuration that have exactly 3 gates closed. also contains the gate states as values, but that is probably not necessary

Lever

enum Lever : Enum<AutoWater.Lever>

Provides all the lever related actions.

Step

data class Step(val lever: AutoWater.Lever, val condition: AutoWater.Condition)

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 override 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.

onInteract

fun onInteract(event: PlayerInteractEvent)

Registers when a lever is clicked. Used to start auto water when flicking the start lever.

onKeyBind

open fun onKeyBind()

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

onPostMove

fun onPostMove(event: PositionUpdateEvent.Post)

PostMove is used for interacting with the levers.

onPreMove

fun onPreMove(event: PositionUpdateEvent.Pre)

Pre move is used for positioning.

onTick

fun onTick(event: TickEvent.ClientTickEvent)

Used to detect the water layout.

onWorldChange

fun onWorldChange(event: WorldEvent.Load)

Reset on warp

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.

reset

fun reset()

Resets the variables.

stop

fun stop()

Force stops the auto water process.

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.

AutoWater

Author

Types

Functions

Properties