Package net.neoforged.neoforge.common.conditions

Class ConditionalOps<T>

java.lang.Object

net.minecraft.resources.DelegatingOps<T>

net.minecraft.resources.RegistryOps<T>

net.neoforged.neoforge.common.conditions.ConditionalOps<T>

All Implemented Interfaces:

com.mojang.serialization.DynamicOps<T>

public class ConditionalOps<T>
extends RegistryOps<T>

Extension of RegistryOps that also encapsulates a ICondition.IContext. This allows getting the ICondition.IContext while decoding an entry from within a codec.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static final class	ConditionalOps.ConditionalDecoder<A>
private static final class	ConditionalOps.ConditionalEncoder<A>

Nested classes/interfaces inherited from class net.minecraft.resources.RegistryOps

RegistryOps.RegistryInfo<T>, RegistryOps.RegistryInfoLookup

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONDITIONAL_VALUE_KEY	Key used to store the value associated with conditions, when the value is not represented as a map.
private final ICondition.IContext	context
static final String	DEFAULT_CONDITIONS_KEY	Key used for the conditions inside an object.

Fields inherited from class net.minecraft.resources.DelegatingOps

delegate

Constructor Summary

Constructors

Modifier	Constructor	Description
private	ConditionalOps(RegistryOps<T> ops, ICondition.IContext context)

Method Summary

Modifier and Type	Method	Description
static <T> ConditionalOps<T>	create(RegistryOps<T> ops, ICondition.IContext context)
static <T> com.mojang.serialization.Codec<Optional<T>>	createConditionalCodec(com.mojang.serialization.Codec<T> ownerCodec)
static <T> com.mojang.serialization.Codec<Optional<T>>	createConditionalCodec(com.mojang.serialization.Codec<T> ownerCodec, String conditionalsKey)	Creates a conditional codec.
static <T> com.mojang.serialization.Codec<Optional<WithConditions<T>>>	createConditionalCodecWithConditions(com.mojang.serialization.Codec<T> ownerCodec)
static <T> com.mojang.serialization.Codec<Optional<WithConditions<T>>>	createConditionalCodecWithConditions(com.mojang.serialization.Codec<T> ownerCodec, String conditionalsKey)	Creates a conditional codec.
static <T> com.mojang.serialization.Codec<List<T>>	decodeListWithElementConditions(com.mojang.serialization.Codec<T> ownerCodec)	Creates a codec that can decode a list of elements, and will check for conditions on each element.
static <T> com.mojang.serialization.Codec<List<T>>	decodeListWithElementConditionsAndIndexedPeek(com.mojang.serialization.Codec<T> ownerCodec, ObjIntConsumer<T> consumer)	Creates a codec that can decode a list of elements, and will check for conditions on element.
static com.mojang.serialization.MapCodec<ICondition.IContext>	retrieveContext()	Returns a codec that can retrieve a ICondition.IContext from a registry ops, for example with retrieveContext().decode(ops, ops.emptyMap()).

Methods inherited from class net.minecraft.resources.RegistryOps

create, create, getter, owner, retrieveElement, retrieveGetter, retrieveRegistryLookup

Methods inherited from class net.minecraft.resources.DelegatingOps

compressMaps, convertTo, createBoolean, createByte, createByteList, createDouble, createFloat, createInt, createIntList, createList, createLong, createLongList, createMap, createNumeric, createShort, createString, empty, getBooleanValue, getByteBuffer, getIntStream, getList, getLongStream, getMap, getMapEntries, getMapValues, getNumberValue, getStream, getStringValue, listBuilder, mapBuilder, mergeToList, mergeToList, mergeToMap, mergeToMap, remove

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.mojang.serialization.DynamicOps

convertList, convertMap, createMap, emptyList, emptyMap, get, getGeneric, getNumberValue, mergeToMap, mergeToPrimitive, set, update, updateGeneric, withDecoder, withEncoder, withParser

Field Details

context

private final ICondition.IContext context

DEFAULT_CONDITIONS_KEY

public static final String DEFAULT_CONDITIONS_KEY

Key used for the conditions inside an object.

See Also:

• Constant Field Values

CONDITIONAL_VALUE_KEY

public static final String CONDITIONAL_VALUE_KEY

Key used to store the value associated with conditions, when the value is not represented as a map. For example, if we wanted to store the value 2 with some conditions, we could do:

 {
     "neoforge:conditions": [ ... ],
     "neoforge:value": 2
 }
 

See Also:

• Constant Field Values

Constructor Details

ConditionalOps

private ConditionalOps(RegistryOps<T> ops,
 ICondition.IContext context)

Method Details

create

public static <T> ConditionalOps<T> create(RegistryOps<T> ops,
 ICondition.IContext context)

retrieveContext

public static com.mojang.serialization.MapCodec<ICondition.IContext> retrieveContext()

Returns a codec that can retrieve a ICondition.IContext from a registry ops, for example with retrieveContext().decode(ops, ops.emptyMap()).

createConditionalCodec

public static <T>
com.mojang.serialization.Codec<Optional<T>> createConditionalCodec(com.mojang.serialization.Codec<T> ownerCodec)

See Also:

• createConditionalCodec(Codec, String)

createConditionalCodec

public static <T>
com.mojang.serialization.Codec<Optional<T>> createConditionalCodec(com.mojang.serialization.Codec<T> ownerCodec,
 String conditionalsKey)

Creates a conditional codec.

The conditional codec is generally not suitable for use as a dispatch target because it is never a MapCodec.MapCodecCodec. If you need to dispatch on a conditional codec, consider using NeoForgeExtraCodecs.dispatchUnsafe(com.mojang.serialization.Codec<K>, java.util.function.Function<? super V, ? extends K>, java.util.function.Function<? super K, ? extends com.mojang.serialization.Codec<? extends V>>).

decodeListWithElementConditions

public static <T>
com.mojang.serialization.Codec<List<T>> decodeListWithElementConditions(com.mojang.serialization.Codec<T> ownerCodec)

Creates a codec that can decode a list of elements, and will check for conditions on each element.

decodeListWithElementConditionsAndIndexedPeek

public static <T>
com.mojang.serialization.Codec<List<T>> decodeListWithElementConditionsAndIndexedPeek(com.mojang.serialization.Codec<T> ownerCodec,
 ObjIntConsumer<T> consumer)

Creates a codec that can decode a list of elements, and will check for conditions on element. Additionally, a callback will be invoked with each deserialized element and its index in the list.

The index is computed before filtering out the elements with non-matching conditions, but the callback will only be invoked on the elements with matching conditions.

createConditionalCodecWithConditions

public static <T>
com.mojang.serialization.Codec<Optional<WithConditions<T>>> createConditionalCodecWithConditions(com.mojang.serialization.Codec<T> ownerCodec)

See Also:

• createConditionalCodecWithConditions(Codec, String)

createConditionalCodecWithConditions

public static <T>
com.mojang.serialization.Codec<Optional<WithConditions<T>>> createConditionalCodecWithConditions(com.mojang.serialization.Codec<T> ownerCodec,
 String conditionalsKey)

Creates a conditional codec.

The conditional codec is generally not suitable for use as a dispatch target because it is never a MapCodec.MapCodecCodec. If you need to dispatch on a conditional codec, consider using NeoForgeExtraCodecs.dispatchUnsafe(com.mojang.serialization.Codec<K>, java.util.function.Function<? super V, ? extends K>, java.util.function.Function<? super K, ? extends com.mojang.serialization.Codec<? extends V>>).