FloppaClient/floppaclient.module.settings.impl/SelectorSetting

SelectorSetting

class SelectorSetting<T : Options, Enum<T>>(name: String, val default: T, val options: Array<out T>, visibility: Visibility = Visibility.VISIBLE, description: String? = null) : Setting<T>

A setting which allows for a selection out of a given set of options.

In most cases it is more convenient to use the factory function which acts as a constructor which omits the options parameter.

Author

Aton

Constructors

SelectorSetting

fun <T : Options, Enum<T>> SelectorSetting(name: String, default: T, options: Array<out T>, visibility: Visibility = Visibility.VISIBLE, description: String? = null)

Functions

getValue

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

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

isSelected

fun isSelected(option: Options): Boolean

provideDelegate

open operator override fun provideDelegate(thisRef: Module, property: KProperty<*>): ReadWriteProperty<Module, T>

This operator provides the Delegate to the Setting.

reset

open fun reset()

Sets value to default.

setValue

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

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

Properties

default

open override val default: T

The default for value.

description

var description: String?

index

var index: Int

name

val name: String

options

val options: Array<out T>

processInput

var processInput: (T) -> T

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

selected

var selected: String

displayName of the selected Enum. Can be used to set value based on the displayName of the Enum. This is required for loading data from the config. If possible value should be directly instead.

shouldBeVisible

val shouldBeVisible: Boolean

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

value

open override var value: T

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.

visibility

val visibility: Visibility