ConfigFieldBuilder¶
class ConfigFieldBuilder<T : Any>(
resetButtonKey: Component,
fieldNameKey: Component,
value: T,
openScreen: (Screen) -> Screen
) : AbstractFieldBuilder<T, ConfigSpecEntry<T>, ConfigFieldBuilder<T>>
Cloth Config field builder producing a ConfigSpecEntry - a single "Edit" button field that navigates into whatever screen openScreen builds for value. Built via ConfigEntryBuilder.startConfigField/startScreenField, used by net.kernelpanicsoft.archie.config.ClientConfigContainer and net.kernelpanicsoft.archie.config.ClientConfigGroup to let a container/group screen drill down into each of its children.
Constructors¶
ConfigFieldBuilder¶
constructor(
resetButtonKey: Component,
fieldNameKey: Component,
value: T,
openScreen: (Screen) -> Screen
)
Properties¶
buttonText¶
var buttonText: Component
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(): ConfigSpecEntry<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(): ConfigFieldBuilder<T>?
open fun requireRestart(requireRestart: Boolean)
setDefaultValue¶
open fun setDefaultValue(defaultValue: T?): ConfigFieldBuilder<T>?
open fun setDefaultValue(defaultValue: Supplier<T?>?): ConfigFieldBuilder<T>?
setDisplayRequirement¶
@Contract
(mutates = "this")@ApiStatus.Experimental
fun setDisplayRequirement(requirement: Requirement?): ConfigFieldBuilder<T>?
setErrorSupplier¶
open fun setErrorSupplier(errorSupplier: Function<T?, Optional<Component?>?>?): ConfigFieldBuilder<T>?
setRequirement¶
@Contract
(mutates = "this")@ApiStatus.Experimental
fun setRequirement(requirement: Requirement?): ConfigFieldBuilder<T>?
setSaveConsumer¶
open fun setSaveConsumer(saveConsumer: Consumer<T?>?): ConfigFieldBuilder<T>?
setTooltip¶
open fun setTooltip(tooltip: Optional<Array<out Component?>?>?): ConfigFieldBuilder<T>?
open fun setTooltip(vararg tooltip: Component?): ConfigFieldBuilder<T>?
setTooltipSupplier¶
open fun setTooltipSupplier(tooltipSupplier: Function<T?, Optional<Array<out Component?>?>?>?): ConfigFieldBuilder<T>?
open fun setTooltipSupplier(tooltipSupplier: Supplier<Optional<Array<out Component?>?>?>?): ConfigFieldBuilder<T>?