LiquidBounce/net.ccbluex.liquidbounce.config.types/RangedValue

RangedValue

class RangedValue<T : Any>(name: String, aliases: List<String> = emptyList(), defaultValue: T, val range: ClosedRange<*>, val suffix: String, valueType: ValueType) : Value<T>

Ranged value adds support for closed ranges

Constructors

RangedValue

constructor(name: String, aliases: List<String> = emptyList(), defaultValue: T, range: ClosedRange<*>, suffix: String, valueType: ValueType)

Types

Companion

object Companion

Properties

aliases

val aliases: List<String>

description

open var description: Supplier<String?>

descriptionKey

var descriptionKey: String?

doNotInclude

var doNotInclude: () -> Boolean

If true, value will not be included in generated public config

independentDescription

var independentDescription: Boolean

If true, the description won't be bound to any net.ccbluex.liquidbounce.config.types.group.ValueGroup.

isImmutable

var isImmutable: Boolean

If true, value will always keep inner equals defaultValue

key

var key: String?

name

@SerializedName(value = "name")

val name: String

notAnOption

var notAnOption: Boolean

If true, value will not be included in generated RestAPI config

range

val range: ClosedRange<*>

suffix

val suffix: String

valueType

val valueType: ValueType

Functions

asRefreshable

fun Value<ClosedFloatingPointRange<Float>>.asRefreshable(): RefreshableFloatState

fun Value<IntRange>.asRefreshable(): RefreshableIntState

asStateFlow

fun asStateFlow(): StateFlow<T>

bind

fun Value<InputBind>.bind(name: String)

Binds to the given input name.

fun Value<InputBind>.bind(key: InputConstants.Key, action: InputBind.BindAction, modifiers: Set<InputBind.Modifier>)

Binds to the given input type and code.

deserializeFrom

open fun deserializeFrom(gson: Gson, element: JsonElement)

Deserialize value from JSON

doNotIncludeAlways

fun doNotIncludeAlways(): Value<T>

doNotIncludeWhen

fun doNotIncludeWhen(condition: () -> Boolean): Value<T>

get

fun get(): T

getTagValue

@JvmName(name = "getTagValue")

fun getTagValue(): Any

getValue

@JvmName(name = "getValue")

fun getValue(): Any

operator fun getValue(u: Any?, property: KProperty<*>): T

Support for delegated properties example: var autoaim by boolean(name = "autoaim", default = true) if(!autoaim) autoaim = true

immutable

fun immutable(): Value<T>

independentDescription

fun independentDescription(): Value<T>

notAnOption

fun notAnOption(): Value<T>

onChange

fun onChange(listener: ValueListener<T>): Value<T>

onChanged

fun onChanged(listener: ValueChangedListener<T>): Value<T>

restore

open fun restore()

Restore value to default value

set

fun set(t: T)

fun set(t: T, apply: Consumer<in T>)

setByString

open override fun setByString(string: String)

setValue

@JvmName(name = "setValue")

fun setValue(t: Value): Result<Unit>

operator fun setValue(u: Any?, property: KProperty<*>, t: T)

squared

@JvmStatic

fun RangedValue<ClosedFloatingPointRange<Float>>.squared(): ReadOnlyProperty<Any?, ClosedFloatingPointRange<Float>>

toString

open override fun toString(): String

type

fun type(): ValueType

unbind

fun Value<InputBind>.unbind()

Unbinds the key by setting it to UNKNOWN_KEY.