Fzzy Config/me.fzzyhmstrs.fzzy_config.validation.misc/ValidatedPair

ValidatedPair

open class ValidatedPair<A, B> @JvmOverloads constructor(defaultValue: ValidatedPair.Tuple<A, B>, leftHandler: Entry<A, *>, rightHandler: Entry<B, *>, layoutStyle: ValidatedPair.LayoutStyle = LayoutStyle.SIDE_BY_SIDE) : ValidatedField<ValidatedPair.Tuple<A, B>>

A validated pair of values

Author

fzzyhmstrs since 0.6.0

Parameters

stored type of the left side of the tuple

stored type of the right side of the tuple

defaultValue

Tuple default pair of values

leftHandler

Entry<A> handler for left side of the tuple

rightHandler

Entry<B> handler for right side of the tuple

layoutStyle

LayoutStyle, optional. Whether the two handlers' widgets are laid-out side by side with half the space for each, or stacked like two "normal" settings on top of each other. Default is side-by-side.

Samples

import me.fzzyhmstrs.fzzy_config.util.AllowableIdentifiers
import me.fzzyhmstrs.fzzy_config.util.EnumTranslatable
import me.fzzyhmstrs.fzzy_config.util.FcText.lit
import me.fzzyhmstrs.fzzy_config.util.ValidationResult
import me.fzzyhmstrs.fzzy_config.validation.collection.ValidatedList
import me.fzzyhmstrs.fzzy_config.validation.minecraft.ValidatedIdentifier
import me.fzzyhmstrs.fzzy_config.validation.minecraft.ValidatedRegistryType
import me.fzzyhmstrs.fzzy_config.validation.minecraft.ValidatedTagKey
import me.fzzyhmstrs.fzzy_config.validation.misc.*
import me.fzzyhmstrs.fzzy_config.validation.misc.ValidatedColor.Companion.validatedColor
import me.fzzyhmstrs.fzzy_config.validation.number.ValidatedInt
import net.minecraft.item.Items
import net.minecraft.item.SwordItem
import net.minecraft.registry.Registries
import net.minecraft.registry.tag.ItemTags
import net.minecraft.util.Identifier
import java.awt.Color
import java.util.function.Function

fun main() { 
   //sampleStart 
   //example validated pair. This is the long form constructor version, pairTo is convenient shorthand
val validatedPair = ValidatedPair(ValidatedPair.Tuple(5, "Hi"), ValidatedInt(5, 10, 0), ValidatedString())

//validated pair made with shorthand method
val validatedPairShort = ValidatedInt(5, 10, 0).pairWith(ValidatedString()) 
   //sampleEnd
}

Constructors

ValidatedPair

@JvmOverloads

constructor(defaultValue: ValidatedPair.Tuple<A, B>, leftHandler: Entry<A, *>, rightHandler: Entry<B, *>, layoutStyle: ValidatedPair.LayoutStyle = LayoutStyle.SIDE_BY_SIDE)

Types

LayoutStyle

enum LayoutStyle : Enum<ValidatedPair.LayoutStyle>

Determines how the child widgets will be laid out in the overall pair widget

Tuple

data class Tuple<X, Y>(val left: X, val right: Y)

Simple pair data class for storing and interacting with arbitrary pairs of types.

Properties

translatableEntryKey

open override var translatableEntryKey: String

Functions

open override fun accept(input: ValidatedPair.Tuple<A, B>)

updates the wrapped value. NOTE: this method will push updates to an UpdateManager, if any. For in-game updating consider validateAndSet

addListener

open fun ~~addListener~~(listener: Consumer<ValidatedField<ValidatedPair.Tuple<A, B>>>)

Attaches a listener to this field. This listener will be called any time the field is written to ("set"). accept, validateAndSet, setAndUpdate and so on will all call the listener.

andThen

open fun andThen(p0: Consumer<in ValidatedPair.Tuple<A, B>>): Consumer<ValidatedPair.Tuple<A, B>>

codec

fun codec(): Codec<ValidatedPair.Tuple<A, B>>

Provides a Codec representing the value type of this validation, backed by the validators within as applicable

copyStoredValue

open fun copyStoredValue(): ValidatedPair.Tuple<A, B>

Copies the stored value and returns it.

copyValue

open override fun copyValue(input: ValidatedPair.Tuple<A, B>): ValidatedPair.Tuple<A, B>

Copies the provided input as deeply as possible. For immutables like numbers and booleans, this will simply return the input

description

open fun description(fallback: String? = null): MutableText

The translated Text description from the descriptionKey. Falls back to an empty string so no tooltip is rendered.

descriptionKey

open override fun descriptionKey(): String

translation key of this Translatable's description. the "description" in-game, the descriptions Enchantment Descriptions adds to enchantment tooltips are a good example.

deserializedChanged

open fun deserializedChanged(old: Any?, new: Any?): Boolean

Specialized equals method for determining if a newly deserialized value is effectively equal to its old counterpart.

flags

open override fun flags(): Byte

get

open override fun get(): ValidatedPair.Tuple<A, B>

supplies the wrapped value

getDefault

fun getDefault(): ValidatedPair.Tuple<A, B>

Provides this validations default value

getEntryKey

abstract fun getEntryKey(): String

hasDescription

open fun hasDescription(): Boolean

Whether this Translatable has a valid description

hasFlag

open override fun hasFlag(flag: EntryFlag.Flag): Boolean

hasPrefix

open fun hasPrefix(): Boolean

Whether this Translatable has a valid prefix

hasTranslation

open fun hasTranslation(): Boolean

Whether this Translatable has a valid translation

instanceEntry

open override fun instanceEntry(): ValidatedPair<A, B>

creates a deep copy of this ValidatedBoolean return ValidatedBoolean wrapping the current boolean value

listenToEntry

open override fun listenToEntry(listener: Consumer<Entry<ValidatedPair.Tuple<A, B>, *>>)

Attaches a listener to this field. This listener will be called any time the field is written to ("set"). accept, validateAndSet, setAndUpdate and so on will all call the listener.

map

fun <N> map(to: Function<ValidatedPair.Tuple<A, B>, out N>, from: Function<in N, ValidatedPair.Tuple<A, B>>): ValidatedField<N>

Maps this validation to a new convertible type. The default value will be applied from this delegates current storedValue

fun <N> map(defaultValue: N, to: Function<ValidatedPair.Tuple<A, B>, out N>, from: Function<in N, ValidatedPair.Tuple<A, B>>): ValidatedField<N>

fun <N> map(to: Function<ValidatedPair.Tuple<A, B>, out N>, from: Function<in N, ValidatedPair.Tuple<A, B>>, defaultValue: ValidatedPair.Tuple<A, B>): ValidatedField<N>

Maps this validation to a new convertible type.

onLeftChanged

open fun onLeftChanged(left: Entry<A, *>)

Called when the left side value is modified in-GUI or with set methods

onRightChanged

open fun onRightChanged(right: Entry<B, *>)

Called when the right side value is modified in-GUI or with set methods

pairWith

fun <B> pairWith(other: Entry<B, *>): ValidatedPair<ValidatedPair.Tuple<A, B>, B>

Pairs this validation with another validation into one ValidatedPair

prefix

open fun prefix(fallback: String? = null): MutableText

The translated Text description from the descriptionKey. Falls back to an empty string so no tooltip is rendered.

prefixKey

open override fun prefixKey(): String

translation key of this Translatable's inline prefix text. Unlike descriptions, which are usually displayed in-tooltips, prefixes are displayed inline in the config screen itself

prepare

open fun prepare(scope: String, groups: LinkedList<String>, annotations: List<Annotation>, globalAnnotations: List<Annotation>)

Called in the prepare stage of screen building to perform any necessary pre-entry-creation tasks.

setEntryKey

abstract fun setEntryKey(key: String)

toCondition

open fun toCondition(condition: ValidatedField<Boolean>, fallback: Supplier<ValidatedPair.Tuple<A, B>>): ValidatedCondition<ValidatedPair.Tuple<A, B>>

Convert this field to a ValidatedCondition using the provided validation as a supplier. The provided condition (and any others you append) must pass for the stored value to be provided, otherwise the fallback will be supplied.

open fun toCondition(condition: ValidatedCondition.Condition, fallback: Supplier<ValidatedPair.Tuple<A, B>>): ValidatedCondition<ValidatedPair.Tuple<A, B>>

open fun toCondition(condition: Supplier<Boolean>, failMessage: Text, fallback: Supplier<ValidatedPair.Tuple<A, B>>): ValidatedCondition<ValidatedPair.Tuple<A, B>>

Convert this field to a ValidatedCondition. The provided condition (and any others you append) must pass for the stored value to be provided, otherwise the fallback will be supplied.

open fun toCondition(scope: String, failMessage: Text, fallback: Supplier<ValidatedPair.Tuple<A, B>>): ValidatedCondition<ValidatedPair.Tuple<A, B>>

Convert this field to a ValidatedCondition using the provided scope with a default boolean provider. The provided condition (and any others you append) must pass for the stored value to be provided, otherwise the fallback will be supplied. The provided scope must point to a valid boolean config scope otherwise the initial condition will never pass.

toList

fun toList(vararg elements: ValidatedPair.Tuple<A, B>): ValidatedList<ValidatedPair.Tuple<A, B>>

Wraps the provided values into a ValidatedList with this field as validation

fun toList(collection: Collection<ValidatedPair.Tuple<A, B>>): ValidatedList<ValidatedPair.Tuple<A, B>>

Wraps the provided collection into a ValidatedList with this field as validation

toSet

fun toSet(vararg elements: ValidatedPair.Tuple<A, B>): ValidatedSet<ValidatedPair.Tuple<A, B>>

Wraps the provided values into a ValidatedSet with this field as validation

fun toSet(collection: Collection<ValidatedPair.Tuple<A, B>>): ValidatedSet<ValidatedPair.Tuple<A, B>>

Wraps the provided collection into a ValidatedSet with this field as validation

translationKey

open override fun translationKey(): String

translation key of this Translatable. the "name" in-game

trySerialize

fun trySerialize(input: Any?, errorBuilder: MutableList<String>, flags: Byte): TomlElement?

trySet

open override fun trySet(input: Any?)

Attempts to set an arbitrary input into this Entry. Should fail soft if the input is incompatible

update

open fun update(updateMessage: Text)

validateAndSet

open fun validateAndSet(input: ValidatedPair.Tuple<A, B>): ValidationResult<ValidatedPair.Tuple<A, B>>

A setter method for the storedValue that first validates the value being set and then stores the post-validation result.

validateAndSetFlagged

open fun validateAndSetFlagged(input: ValidatedPair.Tuple<A, B>, vararg flag: EntryFlag.Flag): ValidationResult<ValidatedPair.Tuple<A, B>>

A setter method for the storedValue that first validates the value being set and then stores the post-validation result.

widgetAndTooltipEntry

open fun widgetAndTooltipEntry(choicePredicate: ChoiceValidator<ValidatedPair.Tuple<A, B>> = ChoiceValidator.any()): ClickableWidget

Builds a new ClickableWidget and applies a tooltip to it. This shouldn't need to be overridden in most cases

ValidatedPair

Author

Parameters

See also

Samples

Constructors

Types

Properties

Functions