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

FileValue

class FileValue(name: String, default: File?, val dialogMode: FileDialogMode, val supportedExtensions: Set<String>?) : Value<File>

A value file input that supports different file dialog modes and optional file type filtering. It will be treated as a relative path if it starts with ConfigSystem.rootFolder.

Parameters

name

The name of the configuration option.

default

The default selected file. The default value is ConfigSystem.rootFolder.

dialogMode

Specifies the type of file dialog to show (e.g., open file, save file, choose folder).

supportedExtensions

A set of allowed file extensions (without the dot), e.g., setOf("txt", "json"). Use null to allow any file type. This is ignored if dialogMode is set to select directories.

Constructors

constructor(name: String, default: File?, dialogMode: FileDialogMode, supportedExtensions: Set<String>?)

Types

object Companion

Properties

val absoluteFile: File

The absolute file path.

val aliases: List<String>

open var description: Supplier<String?>

var descriptionKey: String?

val dialogMode: FileDialogMode

var doNotInclude: BooleanSupplier

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

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.

var isImmutable: Boolean

If true, value will always keep inner equals defaultValue.

var key: String?

@SerializedName(value = "name")

val name: String

var notAnOption: Boolean

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

supportedExtensions

val supportedExtensions: Set<String>?

val valueType: ValueType

Functions

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

fun Value<IntRange>.asRefreshable(): RefreshableIntState

fun asStateFlow(): StateFlow<File>

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

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

Deserialize value from JSON

doNotIncludeAlways

fun doNotIncludeAlways(): Value<File>

doNotIncludeWhen

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

fun get(): File

@JvmName(name = "getTagValue")

fun getTagValue(): Any

@JvmName(name = "getValue")

fun getValue(): Any

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

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

fun immutable(): Value<File>

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

independentDescription

fun independentDescription(): Value<File>

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

fun notAnOption(): Value<File>

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

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

open fun restore()

Restore value to default value

fun set(t: File)

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

open fun setByString(string: String)

@JvmName(name = "setValue")

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

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

open override fun toString(): String

toTextureProperty

fun <V : EventListener, Value<*>> FileValue.toTextureProperty(owner: V, printErrorToChat: Boolean = true): ReadOnlyProperty<Any?, DynamicTexture?>

Convert the FileValue to a ReadOnlyProperty of DynamicTexture.

fun type(): ValueType

fun Value<InputBind>.unbind()

Unbinds the key by setting it to UNKNOWN_KEY.