StringSetting

class StringSetting(name: String, val default: String = "", val length: Int = 30, visibility: Visibility = Visibility.VISIBLE, description: String? = null) : Setting<String>

Provides a Setting which stores a String.

This Setting is represented by a text field in the gui.

Aton

Constructors

fun StringSetting(name: String, default: String = "", length: Int = 30, visibility: Visibility = Visibility.VISIBLE, description: String? = null)

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

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: String)

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

open override val default: String

The default for value.

val length: Int = 30

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: String

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.