Package dev.latvian.mods.kubejs.recipe.component

Interface RecipeComponentWithParent<T>

Type Parameters:

T - The value type of this component

All Superinterfaces:

RecipeComponent<T>

All Known Implementing Classes:

RecipeComponentWithCodec

public interface RecipeComponentWithParent<T>
extends RecipeComponent<T>

A recipe component that may delegate most of its logic to a parent component. A common example of using this would be to define a custom item output component with different serialization or matching logic, but that can still use the same base ItemOutput type as its parent.

Method Summary

Modifier and Type	Method	Description
default boolean	allowEmpty()
default void	buildUniqueId(UniqueIdBuilder builder, T value)
default com.mojang.serialization.Codec<T>	codec()
default @Nullable RecipeComponentBuilder	createBuilder()
default boolean	hasPriority(RecipeMatchContext cx, Object from)	Declares whether this component should take priority when being considered by e.g.
default boolean	isEmpty(T value)	Shallow empty check function
default boolean	matches(RecipeMatchContext cx, T value, ReplacementMatchInfo match)
RecipeComponent<T>	parentComponent()
default T	replace(RecipeScriptContext cx, T original, ReplacementMatchInfo match, Object with)
default List<?>	spread(T value)
default dev.latvian.mods.rhino.type.TypeInfo	typeInfo()	Defines a description for how this component may be constructed.
default void	validate(RecipeValidationContext ctx, T value)
default T	wrap(RecipeScriptContext cx, Object from)	Method to read the value contained within this component from an input object; this may be some arbitrary value passed into a schema's constructor(s) or automatically generated builder methods.

Methods inherited from interface dev.latvian.mods.kubejs.recipe.component.RecipeComponent

asConditionalList, asConditionalListOrSelf, asList, asListOrSelf, asMap, asPatternKey, inputKey, isIgnored, key, or, orSelf, otherKey, outputKey, readFromJson, toString, type, withCodec, writeToJson

Method Details

parentComponent

RecipeComponent<T> parentComponent()

codec

default com.mojang.serialization.Codec<T> codec()

Specified by:

codec in interface RecipeComponent<T>

typeInfo

default dev.latvian.mods.rhino.type.TypeInfo typeInfo()

Description copied from interface: RecipeComponent

Defines a description for how this component may be constructed. Type descriptions may be comprised of a primitive type such as a string, number or Java class (which may be useful if that that class has an appropriate type wrapper for it already), an array of fixed or dynamic length, a map / object, or a union of multiple types.

Type descriptions are used by addons like ProbeJS to provide typing hints.

Specified by:

typeInfo in interface RecipeComponent<T>

Returns:

A description of how this component may be constructed

wrap

default T wrap(RecipeScriptContext cx,
 Object from)

Description copied from interface: RecipeComponent

Method to read the value contained within this component from an input object; this may be some arbitrary value passed into a schema's constructor(s) or automatically generated builder methods. By default, it will attempt to type wrap based on RecipeComponent.typeInfo()

Specified by:

wrap in interface RecipeComponent<T>

Parameters:

cx - Script context

from - An object to be converted to a value for this component

Returns:

The value read from the input

hasPriority

default boolean hasPriority(RecipeMatchContext cx,
 Object from)

Description copied from interface: RecipeComponent

Declares whether this component should take priority when being considered by e.g. an EitherRecipeComponent during deserialization.

Specified by:

hasPriority in interface RecipeComponent<T>

Parameters:

cx - Script context

from - The object to be deserialized from

Returns:

Whether this component should take priority

matches

default boolean matches(RecipeMatchContext cx,
 T value,
 ReplacementMatchInfo match)

Specified by:

matches in interface RecipeComponent<T>

Parameters:

cx - Script context

value - The value to check

match - The replacement match to check against

Returns:

true if the given value matches the given replacement match.

replace

default T replace(RecipeScriptContext cx,
 T original,
 ReplacementMatchInfo match,
 Object with)

Specified by:

replace in interface RecipeComponent<T>

allowEmpty

default boolean allowEmpty()

Specified by:

allowEmpty in interface RecipeComponent<T>

validate

default void validate(RecipeValidationContext ctx,
 T value)

Specified by:

validate in interface RecipeComponent<T>

isEmpty

default boolean isEmpty(T value)

Description copied from interface: RecipeComponent

Shallow empty check function

Specified by:

isEmpty in interface RecipeComponent<T>

buildUniqueId

default void buildUniqueId(UniqueIdBuilder builder,
 T value)

Specified by:

buildUniqueId in interface RecipeComponent<T>

createBuilder

@Nullable
default @Nullable RecipeComponentBuilder createBuilder()

Specified by:

createBuilder in interface RecipeComponent<T>

spread

default List<?> spread(T value)

Specified by:

spread in interface RecipeComponent<T>