FloppaClient/floppaclient.module.settings.impl/ColorSetting

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.

Represented by 3 or 4 sliders in the GUI.

Author

Aton

Constructors

fun ColorSetting(name: String, default: Color, allowAlpha: Boolean = true, visibility: Visibility = Visibility.VISIBLE, description: String? = null)

Types

enum ColorComponent : Enum<ColorSetting.ColorComponent>

Enum to allow for a for loop through the values. This is the best solution I could come up with on the spot to circumvent that I cannot pass a reference to the int values.

Functions

fun colors(): Array<ColorSetting.ColorComponent>

Returns an array of the availiable settings. Those are either red, green and blue or red, green, blue and alpha.

fun getNumber(colorNumber: ColorSetting.ColorComponent): Double

Gets the value for the given color.

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

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, Color>

This operator provides the Delegate to the Setting.

open fun reset()

Sets value to default.

fun setNumber(colorNumber: ColorSetting.ColorComponent, number: Double)

Sets the value for the specified color.

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

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

Properties

var allowAlpha: Boolean = true

var brightness: Float

open override val default: Color

The default for value.

var description: String?

val name: String

var processInput: (Color) -> Color

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

var red: Int

var saturation: Float

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

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