BooleanSetting

class BooleanSetting(name: String, val default: Boolean = false, visibility: Visibility = Visibility.VISIBLE, description: String? = null) : Setting<Boolean>

A boolean Setting for modules.

Can be used to toggle aspects of a Module. Represented by a toggle button in the GUI.

Aton

Constructors

fun BooleanSetting(name: String, default: Boolean = false, visibility: Visibility = Visibility.VISIBLE, description: String? = null)

open operator override fun getValue(thisRef: Module, property: KProperty<*>): Boolean

This method acts as the getter for the property delegated to this class.

This operator provides the Delegate to the Setting.

open fun reset()

open operator override fun setValue(thisRef: Module, property: KProperty<*>, value: Boolean)

This method acts as the setter for the property delegated to this class.

open override val default: Boolean = false

The default for value.

Can be set to add a setting specific restraint / extra action when setting the new value.

Returns whether this setting should be visible based on visibilityDependency. Is true by default. Use withDependency to change this behavior.

open override var value: Boolean

This is the main field used to store the state of the setting. There can be additional properties for managing the state in the implementations.