Package net.neoforged.neoforge.common.data

Class JsonCodecProvider<T>

java.lang.Object

net.neoforged.neoforge.common.data.JsonCodecProvider<T>

Type Parameters:

T - the type of thing being generated.

All Implemented Interfaces:

DataProvider

Direct Known Subclasses:

SpriteSourceProvider

public abstract class JsonCodecProvider<T>
extends Object
implements DataProvider

Dataprovider for using a Codec to generate jsons. Path names for jsons are derived from the given registry folder and each entry's namespaced id, in the format:

 <assets/data>/entryid/registryfolder/entrypath.json 
 

Nested Class Summary

Nested classes/interfaces inherited from interface net.minecraft.data.DataProvider

DataProvider.Factory<T extends DataProvider>

Field Summary

Fields

Modifier and Type	Field	Description
protected final com.mojang.serialization.Codec<T>	codec
protected final Map<ResourceLocation,WithConditions<T>>	conditions
protected final String	directory
protected final ExistingFileHelper	existingFileHelper
private static final org.slf4j.Logger	LOGGER
protected final CompletableFuture<HolderLookup.Provider>	lookupProvider
protected final String	modid
protected final PackOutput.PathProvider	pathProvider
protected final ExistingFileHelper.ResourceType	resourceType

Fields inherited from interface net.minecraft.data.DataProvider

FIXED_ORDER_FIELDS, KEY_COMPARATOR

Constructor Summary

Constructors

Constructor	Description
JsonCodecProvider(PackOutput output, PackOutput.Target target, String directory, PackType packType, com.mojang.serialization.Codec<T> codec, CompletableFuture<HolderLookup.Provider> lookupProvider, String modId, ExistingFileHelper existingFileHelper)

Method Summary

Modifier and Type	Method	Description
void	conditionally(ResourceLocation id, Consumer<WithConditions.Builder<T>> configurator)
protected abstract void	gather()
String	getName()
private void	process(ResourceLocation id, WithConditions<T> withConditions)
CompletableFuture<?>	run(CachedOutput cache)
void	unconditional(ResourceLocation id, T value)

Methods inherited from class java.lang.Object

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

Field Details

LOGGER

private static final org.slf4j.Logger LOGGER

resourceType

protected final ExistingFileHelper.ResourceType resourceType

pathProvider

protected final PackOutput.PathProvider pathProvider

existingFileHelper

protected final ExistingFileHelper existingFileHelper

lookupProvider

protected final CompletableFuture<HolderLookup.Provider> lookupProvider

modid

protected final String modid

directory

protected final String directory

codec

protected final com.mojang.serialization.Codec<T> codec

conditions

protected final Map<ResourceLocation,WithConditions<T>> conditions

Constructor Details

JsonCodecProvider

public JsonCodecProvider(PackOutput output,
 PackOutput.Target target,
 String directory,
 PackType packType,
 com.mojang.serialization.Codec<T> codec,
 CompletableFuture<HolderLookup.Provider> lookupProvider,
 String modId,
 ExistingFileHelper existingFileHelper)

Parameters:

output - PackOutput provided by the DataGenerator.

packType - PackType specifying whether to generate entries in assets or data.

directory - String representing the directory to generate jsons in, e.g. "dimension" or "cheesemod/cheese".

codec - Codec to encode values to jsons with using the provided DynamicOps.

Method Details

run

public CompletableFuture<?> run(CachedOutput cache)

Specified by:

run in interface DataProvider

gather

protected abstract void gather()

getName

public String getName()

Specified by:

getName in interface DataProvider

unconditional

public void unconditional(ResourceLocation id,
 T value)

conditionally

public void conditionally(ResourceLocation id,
 Consumer<WithConditions.Builder<T>> configurator)

process

private void process(ResourceLocation id,
 WithConditions<T> withConditions)