ConfigRefFieldBuilder

class ConfigRefFieldBuilder<T : ConfigSpec>(
    resetButtonKey: Component, 
    fieldNameKey: Component, 
    options: List<T>, 
    value: T
) : AbstractFieldBuilder<T, ConfigRefEntry<T>, ConfigRefFieldBuilder<T>> 

Cloth Config field builder producing a ConfigRefEntry for a configRef field. Built via ConfigEntryBuilder.startConfigRefField.

Constructors

ConfigRefFieldBuilder

constructor(
    resetButtonKey: Component, 
    fieldNameKey: Component, 
    options: List<T>, 
    value: T
)

Properties

defaultValue

@get:



Nullable



override var defaultValue: @Nullable



 Supplier<T?>?

fieldNameKey

@get:



NotNull



override val fieldNameKey: @NotNull



 Component

isRequireRestart

open override val isRequireRestart: Boolean

requiresRestart

var requiresRestart: Boolean

resetButtonKey

@get:



NotNull



override val resetButtonKey: @NotNull



 Component

saveConsumer

open override var saveConsumer: Consumer<T?>?

tooltipSupplier

open override var tooltipSupplier: Function<T?, Optional<Array<out Component?>?>?>?

Functions

build

open override fun build(): ConfigRefEntry<T>

buildEntry

fun buildEntry(): AbstractConfigListEntry<*>?

getDefaultValue

@Nullable



fun getDefaultValue(): @Nullable



 Supplier<T?>?

getSaveConsumer

open fun getSaveConsumer(): Consumer<T?>?

getTooltipSupplier

open fun getTooltipSupplier(): Function<T?, Optional<Array<out Component?>?>?>?

requireRestart

open fun requireRestart(): ConfigRefFieldBuilder<T>?

open fun requireRestart(requireRestart: Boolean)

setDefaultValue

open fun setDefaultValue(defaultValue: T?): ConfigRefFieldBuilder<T>?

open fun setDefaultValue(defaultValue: Supplier<T?>?): ConfigRefFieldBuilder<T>?

setDisplayRequirement

@Contract



(mutates = "this")@ApiStatus.Experimental



fun setDisplayRequirement(requirement: Requirement?): ConfigRefFieldBuilder<T>?

setErrorSupplier

open fun setErrorSupplier(errorSupplier: Function<T?, Optional<Component?>?>?): ConfigRefFieldBuilder<T>?

setRequirement

@Contract



(mutates = "this")@ApiStatus.Experimental



fun setRequirement(requirement: Requirement?): ConfigRefFieldBuilder<T>?

setSaveConsumer

open fun setSaveConsumer(saveConsumer: Consumer<T?>?): ConfigRefFieldBuilder<T>?

setTooltip

open fun setTooltip(tooltip: Optional<Array<out Component?>?>?): ConfigRefFieldBuilder<T>?

open fun setTooltip(vararg tooltip: Component?): ConfigRefFieldBuilder<T>?

setTooltipSupplier

open fun setTooltipSupplier(tooltipSupplier: Function<T?, Optional<Array<out Component?>?>?>?): ConfigRefFieldBuilder<T>?

open fun setTooltipSupplier(tooltipSupplier: Supplier<Optional<Array<out Component?>?>?>?): ConfigRefFieldBuilder<T>?