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

Class FabricTagProvider<T>

java.lang.Object

net.minecraft.data.tag.TagProvider<T>

net.fabricmc.fabric.api.datagen.v1.provider.FabricTagProvider<T>

All Implemented Interfaces:

DataProvider

Direct Known Subclasses:

FabricTagProvider.BlockEntityTypeTagProvider, FabricTagProvider.BlockTagProvider, FabricTagProvider.EnchantmentTagProvider, FabricTagProvider.EntityTypeTagProvider, FabricTagProvider.FluidTagProvider, FabricTagProvider.ItemTagProvider

public abstract class FabricTagProvider<T>
extends TagProvider<T>

Implement this class (or one of the inner classes) to generate a tag list.

Register your implementation using FabricDataGenerator.Pack.addProvider(net.fabricmc.fabric.api.datagen.v1.FabricDataGenerator.Pack.Factory<T>) in a DataGeneratorEntrypoint.

When generating tags for modded dynamic registry entries (such as biomes), either the entry must be added to the registry using DataGeneratorEntrypoint.buildRegistry(RegistryBuilder) or TagBuilder.addOptional(Identifier) must be used. Otherwise, the data generator cannot find the entry and crashes.

Commonly used implementations of this class are provided:

See Also:

• FabricTagProvider.BlockTagProvider
• FabricTagProvider.ItemTagProvider
• FabricTagProvider.FluidTagProvider
• FabricTagProvider.EntityTypeTagProvider

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
final class	FabricTagProvider.AliasGroupBuilder	A builder for tag alias groups.
static class	FabricTagProvider.BlockEntityTypeTagProvider	Extend this class to create BlockEntityType tags in the "/block_entity_type" tag directory.
static class	FabricTagProvider.BlockTagProvider	Extend this class to create Block tags in the "/blocks" tag directory.
static class	FabricTagProvider.EnchantmentTagProvider	Extend this class to create Enchantment tags in the "/enchantments" tag directory.
static class	FabricTagProvider.EntityTypeTagProvider	Extend this class to create EntityType tags in the "/entity_types" tag directory.
final class	FabricTagProvider.FabricTagBuilder	An extension to TagProvider.ProvidedTagBuilder that provides additional functionality.
static class	FabricTagProvider.FluidTagProvider	Extend this class to create Fluid tags in the "/fluids" tag directory.
static class	FabricTagProvider.ItemTagProvider	Extend this class to create Item tags in the "/items" tag directory.

Nested classes/interfaces inherited from class net.minecraft.data.tag.TagProvider

TagProvider.ProvidedTagBuilder<T>, TagProvider.TagLookup<T>

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

DataProvider.Factory<T extends DataProvider>

Field Summary

Fields inherited from class net.minecraft.data.tag.TagProvider

pathResolver, registryRef

Fields inherited from interface net.minecraft.data.DataProvider

JSON_KEY_SORT_ORDER, JSON_KEY_SORTING_COMPARATOR, LOGGER

Constructor Summary

Constructors

Constructor	Description
FabricTagProvider(FabricDataOutput output, RegistryKey<? extends Registry<T>> registryKey, CompletableFuture<RegistryWrapper.WrapperLookup> registriesFuture)	Constructs a new FabricTagProvider with the default computed path.

Method Summary

Modifier and Type	Method	Description
protected FabricTagProvider<T>.AliasGroupBuilder	aliasGroup(String group)	Gets an FabricTagProvider<T>.AliasGroupBuilder with the given ID.
protected FabricTagProvider<T>.AliasGroupBuilder	aliasGroup(Identifier groupId)	Gets an FabricTagProvider<T>.AliasGroupBuilder with the given ID.
protected abstract void	configure(RegistryWrapper.WrapperLookup wrapperLookup)	Implement this method and then use getOrCreateTagBuilder(net.minecraft.registry.tag.TagKey<T>) to get and register new tag builders.
Map<Identifier,FabricTagProvider<T>.AliasGroupBuilder>	getAliasGroupBuilders()	Returns a read-only map of alias group builders by the alias group ID.
protected FabricTagProvider<T>.FabricTagBuilder	getOrCreateTagBuilder(TagKey<T> tag)	Creates a new instance of FabricTagProvider<T>.FabricTagBuilder for the given TagKey tag.
protected RegistryKey<T>	reverseLookup(T element)	Override to enable adding objects to the tag builder directly.

Methods inherited from class net.minecraft.data.tag.TagProvider

getName, getRegistriesFuture, getTagBuilder, getTagLookupFuture, run

Methods inherited from class java.lang.Object

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

Constructor Details

FabricTagProvider

public FabricTagProvider(FabricDataOutput output,
 RegistryKey<? extends Registry<T>> registryKey,
 CompletableFuture<RegistryWrapper.WrapperLookup> registriesFuture)

Constructs a new FabricTagProvider with the default computed path.

Common implementations of this class are provided.

Parameters:

output - the FabricDataOutput instance

registriesFuture - the backing registry for the tag type

Method Details

configure

protected abstract void configure(RegistryWrapper.WrapperLookup wrapperLookup)

Implement this method and then use getOrCreateTagBuilder(net.minecraft.registry.tag.TagKey<T>) to get and register new tag builders.

Specified by:

configure in class TagProvider<T>

reverseLookup

protected RegistryKey<T> reverseLookup(T element)

Override to enable adding objects to the tag builder directly.

getOrCreateTagBuilder

protected FabricTagProvider<T>.FabricTagBuilder getOrCreateTagBuilder(TagKey<T> tag)

Creates a new instance of FabricTagProvider<T>.FabricTagBuilder for the given TagKey tag.

Overrides:

getOrCreateTagBuilder in class TagProvider<T>

Parameters:

tag - The TagKey tag to create the builder for

Returns:

The FabricTagProvider<T>.FabricTagBuilder instance

aliasGroup

protected FabricTagProvider<T>.AliasGroupBuilder aliasGroup(Identifier groupId)

Gets an FabricTagProvider<T>.AliasGroupBuilder with the given ID.

Parameters:

groupId - the group ID

Returns:

the alias group builder

aliasGroup

protected FabricTagProvider<T>.AliasGroupBuilder aliasGroup(String group)

Gets an FabricTagProvider<T>.AliasGroupBuilder with the given ID.

Parameters:

group - the group name

Returns:

the alias group builder

getAliasGroupBuilders

public Map<Identifier,FabricTagProvider<T>.AliasGroupBuilder> getAliasGroupBuilders()

Returns a read-only map of alias group builders by the alias group ID..

Returns:

a read-only map of alias group builders by the alias group ID