FloppaClient/floppaclient.module.settings.impl/NumberSetting

NumberSetting

class NumberSetting(name: String, val default: Double = 1.0, val min: Double = -10000.0, val max: Double = 10000.0, val increment: Double = 1.0, visibility: Visibility = Visibility.VISIBLE, description: String? = null) : Setting<Double>

A Double Setting for Modules.

Represented in the GUI by a slider. To use a different type adjust the increment and use the toInt() etc. methods.

Constructors

fun NumberSetting(name: String, default: Double = 1.0, min: Double = -10000.0, max: Double = 10000.0, increment: Double = 1.0, visibility: Visibility = Visibility.VISIBLE, description: String? = null)

Functions

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

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

provideDelegate

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

This operator provides the Delegate to the Setting.

open fun reset()

Sets value to default.

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

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

Properties

open override val default: Double = 1.0

The default for value.

var description: String?

val increment: Double = 1.0

val max: Double = 10000.0

val min: Double

val name: String

var processInput: (Double) -> Double

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

shouldBeVisible

val shouldBeVisible: Boolean

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

open override var value: Double

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.

val visibility: Visibility