LiquidBounce/net.ccbluex.liquidbounce.config.types.list/ListValue

ListValue

open class ListValue<T : MutableCollection<E>, E>(name: String, value: T, valueType: ValueType = ValueType.LIST, val innerValueType: ValueType = ValueType.INVALID, val innerType: Class<E>) : Value<T>

Inheritors

MutableListValue

RegistryListValue

RegistryMutableListValue

Constructors

constructor(name: String, value: T, valueType: ValueType = ValueType.LIST, innerValueType: ValueType = ValueType.INVALID, innerType: Class<E>)

Properties

val aliases: List<String>

open var description: Supplier<String?>

var descriptionKey: String?

var doNotInclude: BooleanSupplier

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

hasLiteralDescription

var hasLiteralDescription: Boolean

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.

val innerType: Class<E>

Used to deserialize the value from JSON. TODO: Might replace innerType with a Class variable from the inner value type in the future.

val innerValueType: ValueType

Used to determine the type of the inner value.

var isImmutable: Boolean

If true, value will always keep inner equals defaultValue.

var isPersistent: Boolean

If false, the value is neither written to nor read from config files, but still reaches the GUI. For values whose state lives elsewhere, such as another client's modules.

var key: String?

@SerializedName(value = "name")

val name: String

var notAnOption: Boolean

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

val valueType: ValueType

visibleCondition

var visibleCondition: BooleanSupplier

Hides the value from the GUI while false. Configs keep it either way.

Functions

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

fun Value<IntRange>.asRefreshable(): RefreshableIntState

fun asStateFlow(): StateFlow<T>

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.

fun checkIfInclude(): Boolean

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

deserializeFrom

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

Deserialize value from JSON

doNotIncludeAlways

fun doNotIncludeAlways(): Value<T>

doNotIncludeWhen

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

fun get(): T

@JvmName(name = "getTagValue")

fun getTagValue(): Any

@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

fun immutable(): Value<T>

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

independentDescription

fun independentDescription(): Value<T>

literalDescription

fun literalDescription(text: Supplier<String?>): Value<T>

Uses text instead of a translation key, for descriptions that come from outside LiquidBounce.

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

fun notAnOption(): Value<T>

fun notPersistent(): Value<T>

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

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

open fun restore()

Restore value to default value

fun set(t: T)

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

override fun setByString(string: String)

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

open override fun toString(): String

fun type(): ValueType

fun Value<InputBind>.unbind()

Unbinds the key by setting it to UNKNOWN_KEY.

fun visibleWhen(condition: BooleanSupplier): Value<T>