FloppaClient/floppaclient.module.settings.impl/DummySetting

DummySetting

class DummySetting(name: String, visibility: Visibility = Visibility.VISIBLE, description: String? = null) : Setting<Any?>

A direct subclass of Setting which does not provide any backing field.

Do not use this as a Setting for your Module!

This class is meant to be used as a placeholder when no other Setting is applicable. Doing this allows you to avoid using the nullable type Setting?.

Used for pasrsing the config file and for displaying the Module Keybind in the advanced gui.

Author

Aton

Constructors

DummySetting

fun DummySetting(name: String, visibility: Visibility = Visibility.VISIBLE, description: String? = null)

Functions

getValue

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

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, Any?>

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: Any?)

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

Properties

default

open override val default: Any?

Always is null. Not intended to be used.

description

var description: String?

name

val name: String

processInput

var processInput: (Any?) -> Any?

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.

value

open override var value: Any?

Always is null. Not intended to be used.

visibility

val visibility: Visibility