Package dev.latvian.mods.kubejs.recipe.schema

Class RecipeSchema

java.lang.Object

dev.latvian.mods.kubejs.recipe.schema.RecipeSchema

Direct Known Subclasses:

UnknownRecipeSchema

public class RecipeSchema
extends Object

A recipe schema is a set of keys that defines how a recipe is constructed from both KubeJS scripts (through the constructors) and JSON files (using the deserialize(SourceLine, RecipeTypeFunction, ResourceLocation, JsonObject) method).

The schema also defines a recipeFactory in order to create a KubeRecipe object that implements serialization logic, post-load validation (KubeRecipe.validate(RecipeValidationContext)), as well as entirely custom logic such as additional methods a developer may call from scripts.

See Also:

• RecipeKey
• KubeRecipe

Field Summary

Fields

Modifier and Type	Field	Description
final Map<String,RecipeFunctionInstance>	functions
final List<RecipeKey<?>>	includedKeys
final Map<RecipeKey<?>,RecipeOptional<?>>	keyOverrides
final List<RecipeKey<?>>	keys
KubeRecipeFactory	recipeFactory
net.minecraft.resources.ResourceLocation	typeOverride

Constructor Summary

Constructors

Constructor	Description
RecipeSchema(RecipeKey<?>... keys)
RecipeSchema(Map<RecipeKey<?>,RecipeOptional<?>> keyOverrides, List<RecipeKey<?>> keys)	Defines a new recipe schema that creates recipes of the given KubeRecipe subclass.

Method Summary

Modifier and Type	Method	Description
<T> RecipeSchema	addToListOpFunction(String name, RecipeKey<List<T>> key)
@Nullable String	buildUniqueId(KubeRecipe r)
RecipeSchema	constructor(RecipeKey<?>... keys)	Defines an additional constructor to be for this schema.
RecipeSchema	constructor(RecipeConstructor constructor)
it.unimi.dsi.fastutil.ints.Int2ObjectMap<RecipeConstructor>	constructors()
boolean	constructorsGenerated()
KubeRecipe	deserialize(SourceLine sourceLine, RecipeTypeFunction type, @Nullable net.minecraft.resources.ResourceLocation id, com.google.gson.JsonObject json)
RecipeSchema	factory(KubeRecipeFactory factory)
RecipeSchema	function(RecipeFunctionInstance function)
<T> RecipeKey<T>	getKey(String id)
<T> @Nullable RecipeKey<T>	getOptionalKey(String id)
int	inputCount()
boolean	isHidden()
int	minRequiredArguments()
int	outputCount()
RecipeSchema	postProcessor(RecipePostProcessor processor)
List<RecipePostProcessor>	postProcessors()
<T> RecipeSchema	setOpFunction(String name, RecipeKey<T> key, T value)
com.google.gson.JsonObject	toJson(RecipeSchemaStorage storage, RecipeSchemaType schemaType, net.minecraft.resources.RegistryOps<com.google.gson.JsonElement> ops)
RecipeSchema	typeOverride(net.minecraft.resources.ResourceLocation id)
RecipeSchema	uniqueId(RecipeKey<?> key)
List<RecipeKey<?>>	uniqueIds()
RecipeSchema	uniqueIds(SequencedCollection<RecipeKey<?>> keys)

Methods inherited from class java.lang.Object

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

Field Details

recipeFactory

public KubeRecipeFactory recipeFactory

typeOverride

public net.minecraft.resources.ResourceLocation typeOverride

keys

public final List<RecipeKey<?>> keys

includedKeys

public final List<RecipeKey<?>> includedKeys

keyOverrides

public final Map<RecipeKey<?>,RecipeOptional<?>> keyOverrides

functions

public final Map<String,RecipeFunctionInstance> functions

Constructor Details

RecipeSchema

public RecipeSchema(Map<RecipeKey<?>,RecipeOptional<?>> keyOverrides,
 List<RecipeKey<?>> keys)

Defines a new recipe schema that creates recipes of the given KubeRecipe subclass.

Keys are defined in order of their appearance in the autogenerated constructor, where optional keys must be placed after all required keys.

Parameters:

keys - The keys that define this schema.

RecipeSchema

public RecipeSchema(RecipeKey<?>... keys)

Method Details

factory

public RecipeSchema factory(KubeRecipeFactory factory)

typeOverride

public RecipeSchema typeOverride(net.minecraft.resources.ResourceLocation id)

constructor

public RecipeSchema constructor(RecipeConstructor constructor)

constructor

@RemapForJS("addConstructor")
public RecipeSchema constructor(RecipeKey<?>... keys)

Defines an additional constructor to be for this schema.

Parameters:

keys - The arguments that this constructor takes in.

Returns:

This schema.

uniqueId

public RecipeSchema uniqueId(RecipeKey<?> key)

uniqueIds

public RecipeSchema uniqueIds(SequencedCollection<RecipeKey<?>> keys)

buildUniqueId

@Nullable
public @Nullable String buildUniqueId(KubeRecipe r)

constructors

public it.unimi.dsi.fastutil.ints.Int2ObjectMap<RecipeConstructor> constructors()

uniqueIds

public List<RecipeKey<?>> uniqueIds()

minRequiredArguments

public int minRequiredArguments()

inputCount

public int inputCount()

outputCount

public int outputCount()

isHidden

public boolean isHidden()

constructorsGenerated

public boolean constructorsGenerated()

deserialize

public KubeRecipe deserialize(SourceLine sourceLine,
 RecipeTypeFunction type,
 @Nullable
 @Nullable net.minecraft.resources.ResourceLocation id,
 com.google.gson.JsonObject json)

function

public RecipeSchema function(RecipeFunctionInstance function)

setOpFunction

public <T> RecipeSchema setOpFunction(String name,
 RecipeKey<T> key,
 T value)

addToListOpFunction

public <T> RecipeSchema addToListOpFunction(String name,
 RecipeKey<List<T>> key)

postProcessor

public RecipeSchema postProcessor(RecipePostProcessor processor)

getOptionalKey

@Nullable
public <T> @Nullable RecipeKey<T> getOptionalKey(String id)

getKey

public <T> RecipeKey<T> getKey(String id)

postProcessors

public List<RecipePostProcessor> postProcessors()

toJson

public com.google.gson.JsonObject toJson(RecipeSchemaStorage storage,
 RecipeSchemaType schemaType,
 net.minecraft.resources.RegistryOps<com.google.gson.JsonElement> ops)