Package net.neoforged.neoforge.common

Class ModConfigSpec.ListValueSpec

java.lang.Object

net.neoforged.neoforge.common.ModConfigSpec.ValueSpec

net.neoforged.neoforge.common.ModConfigSpec.ListValueSpec

Enclosing class:

ModConfigSpec

public static class ModConfigSpec.ListValueSpec
extends ModConfigSpec.ValueSpec

Field Summary

Fields

Modifier and Type	Field	Description
private final Predicate<Object>	elementValidator
private static final ModConfigSpec.Range<Integer>	MAX_ELEMENTS
private final @Nullable Supplier<?>	newElementSupplier
private static final ModConfigSpec.Range<Integer>	NON_EMPTY
private final @Nullable ModConfigSpec.Range<Integer>	sizeRange

Constructor Summary

Constructors

Modifier	Constructor	Description
private	ListValueSpec(Supplier<?> supplier, @Nullable Supplier<?> newElementSupplier, Predicate<Object> listValidator, Predicate<Object> elementValidator, ModConfigSpec.BuilderContext context, List<String> path, @Nullable ModConfigSpec.Range<Integer> sizeRange)

Method Summary

Modifier and Type	Method	Description
@Nullable Supplier<?>	getNewElementSupplier()	Creates a new empty element that can be added to the end of the list or null if the list doesn't support adding elements.
ModConfigSpec.Range<Integer>	getSizeRange()	The allowable range of the size of the list.
boolean	testElement(Object value)	Determines if a given object can be part of the list.

Methods inherited from class net.neoforged.neoforge.common.ModConfigSpec.ValueSpec

correct, getClazz, getComment, getDefault, getRange, getTranslationKey, restartType, test

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

MAX_ELEMENTS

private static final ModConfigSpec.Range<Integer> MAX_ELEMENTS

NON_EMPTY

private static final ModConfigSpec.Range<Integer> NON_EMPTY

newElementSupplier

@Nullable
private final @Nullable Supplier<?> newElementSupplier

sizeRange

@Nullable
private final @Nullable ModConfigSpec.Range<Integer> sizeRange

elementValidator

private final Predicate<Object> elementValidator

Constructor Details

ListValueSpec

private ListValueSpec(Supplier<?> supplier,
 @Nullable
 @Nullable Supplier<?> newElementSupplier,
 Predicate<Object> listValidator,
 Predicate<Object> elementValidator,
 ModConfigSpec.BuilderContext context,
 List<String> path,
 @Nullable
 @Nullable ModConfigSpec.Range<Integer> sizeRange)

Method Details

getNewElementSupplier

@Nullable
public @Nullable Supplier<?> getNewElementSupplier()

Creates a new empty element that can be added to the end of the list or null if the list doesn't support adding elements.

The element does not need to validate with either ModConfigSpec.ValueSpec.test(Object) or testElement(Object), but it should give the user a good starting point for their edit.

Only used by the UI!

testElement

public boolean testElement(Object value)

Determines if a given object can be part of the list.

Note that the list-level validator overrules this.

Only used by the UI!

getSizeRange

public ModConfigSpec.Range<Integer> getSizeRange()

The allowable range of the size of the list.

Note that the validator overrules this.

Only used by the UI!