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

BindValue

class BindValue(name: String, aliases: List<String> = emptyList(), defaultValue: InputBind) : Value<InputBind>

Constructors

BindValue

constructor(name: String, aliases: List<String> = emptyList(), defaultValue: InputBind)

Properties

aliases

val aliases: List<String>

description

open var description: Supplier<String?>

descriptionKey

var descriptionKey: String?

doNotInclude

var doNotInclude: BooleanSupplier

If true, value will not be included in generated public config. Can be set using doNotIncludeWhen or doNotIncludeAlways.

inclusionGroup

var inclusionGroup: OptionalInclusion?

Group for optional inclusion during configuration saving. Managed by AutoConfig.

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.

valueType

val valueType: ValueType

Functions

asRefreshable

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

fun Value<IntRange>.asRefreshable(): RefreshableIntState

asStateFlow

fun asStateFlow(): StateFlow<InputBind>

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.

checkIfInclude

fun checkIfInclude(): Boolean

Checks if this value should be included in the public configuration based on its doNotInclude condition and inclusionGroup.

deserializeFrom

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

Deserialize value from JSON

doNotIncludeAlways

fun doNotIncludeAlways(): Value<InputBind>

doNotIncludeWhen

fun doNotIncludeWhen(condition: BooleanSupplier): Value<InputBind>

get

fun get(): InputBind

getTagValue

@JvmName(name = "getTagValue")

fun getTagValue(): Any

getValue

@JvmName(name = "getValue")

fun getValue(): Any

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

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

immutable

fun immutable(): Value<InputBind>

inclusionGroup

open fun inclusionGroup(group: OptionalInclusion): Value<InputBind>

independentDescription

fun independentDescription(): Value<InputBind>

mapReadOnly

fun <T : Any, R> Value<T>.mapReadOnly(transform: (T) -> R): ReadOnlyProperty<Any?, R>

notAnOption

fun notAnOption(): Value<InputBind>

onChange

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

onChanged

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

restore

open fun restore()

Restore value to default value

set

fun set(t: InputBind)

fun set(t: InputBind, apply: ValueChangedListener<InputBind>)

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: InputBind)

toString

open override fun toString(): String

type

fun type(): ValueType

unbind

fun Value<InputBind>.unbind()

Unbinds the key by setting it to UNKNOWN_KEY.