ActionSetting

class ActionSetting(name: String, visibility: Visibility = Visibility.VISIBLE, description: String? = null, val default: () -> Unit = {}) : Setting<() -> Unit>

A clickable setting for Modules that runs code on click.

Represented by a button in the GUI which when clicked will invoke value.

Author

Aton

Constructors

Link copied to clipboard
fun ActionSetting(name: String, visibility: Visibility = Visibility.VISIBLE, description: String? = null, default: () -> Unit = {})

Functions

Link copied to clipboard
fun doAction()
Link copied to clipboard
open operator override fun getValue(thisRef: Module, property: KProperty<*>): () -> Unit

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

Link copied to clipboard
open operator override fun provideDelegate(thisRef: Module, property: KProperty<*>): ReadWriteProperty<Module, () -> Unit>

This operator provides the Delegate to the Setting.

Link copied to clipboard
open fun reset()

Sets value to default.

Link copied to clipboard
open operator override fun setValue(thisRef: Module, property: KProperty<*>, value: () -> Unit)

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

Properties

Link copied to clipboard
var action: () -> Unit
Link copied to clipboard
open override val default: () -> Unit

The default for value.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
var processInput: (() -> Unit) -> () -> Unit

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

Link copied to clipboard

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

Link copied to clipboard
open override var value: () -> Unit

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.

Link copied to clipboard