Package net.fabricmc.fabric.api.datagen.v1

Class FabricDataGenerator

java.lang.Object

net.minecraft.data.DataGenerator

net.fabricmc.fabric.api.datagen.v1.FabricDataGenerator

public final class FabricDataGenerator
extends DataGenerator

An extension to vanilla's DataGenerator providing mod specific data, and helper functions.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
final class	FabricDataGenerator.Pack	Represents a pack of generated data (i.e.

Constructor Summary

Constructors

Constructor	Description
FabricDataGenerator(Path output, net.fabricmc.loader.api.ModContainer mod, boolean strictValidation, CompletableFuture<RegistryWrapper.WrapperLookup> registriesFuture)

Method Summary

Modifier and Type	Method	Description
FabricDataGenerator.Pack	createBuiltinResourcePack(Identifier id)	Create a new FabricDataGenerator.Pack instance for generating a builtin resource pack.
FabricDataGenerator.Pack	createPack()	Create a default FabricDataGenerator.Pack instance for generating a mod's data.
DataGenerator.Pack	createVanillaPack(boolean shouldRun)	Deprecated. Please use createPack()
DataGenerator.Pack	createVanillaSubPack(boolean shouldRun, String packName)	Deprecated. Please use createBuiltinResourcePack(Identifier)
net.fabricmc.loader.api.ModContainer	getModContainer()	Returns the ModContainer for the mod that this data generator has been created for.
String	getModId()	Returns the mod ID for the mod that this data generator has been created for.
CompletableFuture<RegistryWrapper.WrapperLookup>	getRegistries()	Get a future returning the default registries produced by BuiltinRegistries and DataGeneratorEntrypoint.buildRegistry(RegistryBuilder).
boolean	isStrictValidationEnabled()	When enabled data providers can do strict validation to ensure that all entries have data generated for them.

Methods inherited from class net.minecraft.data.DataGenerator

run

Methods inherited from class java.lang.Object

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

Constructor Details

FabricDataGenerator

@Internal
public FabricDataGenerator(Path output,
 net.fabricmc.loader.api.ModContainer mod,
 boolean strictValidation,
 CompletableFuture<RegistryWrapper.WrapperLookup> registriesFuture)

Method Details

createPack

public FabricDataGenerator.Pack createPack()

Create a default FabricDataGenerator.Pack instance for generating a mod's data.

createBuiltinResourcePack

public FabricDataGenerator.Pack createBuiltinResourcePack(Identifier id)

Create a new FabricDataGenerator.Pack instance for generating a builtin resource pack.

To be used in conjunction with ResourceManagerHelper.registerBuiltinResourcePack(net.minecraft.util.Identifier, net.fabricmc.loader.api.ModContainer, net.fabricmc.fabric.api.resource.ResourcePackActivationType)

The path in which the resource pack is generated is "resourcepacks/<id path>". id path being the path specified in the identifier.

getModContainer

public net.fabricmc.loader.api.ModContainer getModContainer()

Returns the ModContainer for the mod that this data generator has been created for.

Returns:

a ModContainer instance

getModId

public String getModId()

Returns the mod ID for the mod that this data generator has been created for.

Returns:

a mod ID

isStrictValidationEnabled

public boolean isStrictValidationEnabled()

When enabled data providers can do strict validation to ensure that all entries have data generated for them.

Returns:

if strict validation should be enabled

getRegistries

public CompletableFuture<RegistryWrapper.WrapperLookup> getRegistries()

Get a future returning the default registries produced by BuiltinRegistries and DataGeneratorEntrypoint.buildRegistry(RegistryBuilder).

Generally one does not need direct access to the registries, and instead can pass them directly to a DataProvider by using FabricDataGenerator.Pack.addProvider(Pack.RegistryDependentFactory). However, this method may be useful when extending the vanilla registries (such as with ExperimentalRegistriesValidator).

Returns:

A future containing the builtin registries.

createVanillaPack

@Deprecated
public DataGenerator.Pack createVanillaPack(boolean shouldRun)

Deprecated.

Please use createPack()

Overrides:

createVanillaPack in class DataGenerator

createVanillaSubPack

@Deprecated
public DataGenerator.Pack createVanillaSubPack(boolean shouldRun,
 String packName)

Deprecated.

Please use createBuiltinResourcePack(Identifier)

Overrides:

createVanillaSubPack in class DataGenerator