FloppaClient/floppaclient.module.settings.impl

Package-level declarations

Types

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.

BooleanSetting

class BooleanSetting(name: String, val default: Boolean = false, visibility: Visibility = Visibility.VISIBLE, description: String? = null) : Setting<Boolean>

A boolean Setting for modules.

ColorSetting

class ColorSetting(name: String, val default: Color, var allowAlpha: Boolean = true, visibility: Visibility = Visibility.VISIBLE, description: String? = null) : Setting<Color>

A color setting for Modules.

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.

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.

Options

interface Options

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.

StringSelectorSetting

class ~~StringSelectorSetting~~(name: String, defaultSelected: String, var options: ArrayList<String>, visibility: Visibility = Visibility.VISIBLE, description: String? = null) : Setting<Int>

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.

Functions

SelectorSetting

inline fun <L : Options, Enum<L>> SelectorSetting(name: String, default: L, visibility: Visibility = Visibility.VISIBLE, description: String? = null): SelectorSetting<L>

This factory function provides a more convenient Constructor for SelectorSetting where options can be omitted. The options are inferred from the provided default value. All available constants will be used.