Package net.fabricmc.fabric.api.event.registry

Class FabricRegistryBuilder<T,R extends MutableRegistry<T>>

java.lang.Object

net.fabricmc.fabric.api.event.registry.FabricRegistryBuilder<T,R>

Type Parameters:

T - The type stored in the Registry

R - The registry type

public final class FabricRegistryBuilder<T,R extends MutableRegistry<T>>
extends Object

Used to create custom registries, with specified registry attributes.

See the following example for creating a Registry of String objects.

 
  RegistryKey<Registry<String>> registryKey = RegistryKey.ofRegistry(Identifier.of("modid", "registry_name"));
  Registry<String> registry = FabricRegistryBuilder.createSimple(registryKey)
 													.attribute(RegistryAttribute.SYNCED)
 													.buildAndRegister();
 	
 

Tags for the entries of a custom registry must be placed in /tags/<registry namespace>/<registry path>/. For example, the tags for the example registry above would be placed in /tags/modid/registry_name/.

Method Summary

Modifier and Type	Method	Description
FabricRegistryBuilder<T,R>	attribute(RegistryAttribute attribute)	Add a RegistryAttribute to the registry.
R	buildAndRegister()	Applies the attributes to the registry and registers it.
static <T> FabricRegistryBuilder<T,SimpleDefaultedRegistry<T>>	createDefaulted(Class<T> type, Identifier registryId, Identifier defaultId)	Deprecated. Please migrate to createDefaulted(RegistryKey, Identifier)
static <T> FabricRegistryBuilder<T,SimpleDefaultedRegistry<T>>	createDefaulted(RegistryKey<Registry<T>> registryKey, Identifier defaultId)	Create a new FabricRegistryBuilder using a DefaultedRegistry, the registry has the RegistryAttribute.MODDED attribute by default.
static <T> FabricRegistryBuilder<T,SimpleRegistry<T>>	createSimple(Class<T> type, Identifier registryId)	Deprecated. Please migrate to createSimple(RegistryKey)
static <T> FabricRegistryBuilder<T,SimpleRegistry<T>>	createSimple(RegistryKey<Registry<T>> registryKey)	Create a new FabricRegistryBuilder using a SimpleRegistry, the registry has the RegistryAttribute.MODDED attribute by default.
static <T, R extends MutableRegistry<T>> FabricRegistryBuilder<T,R>	from(R registry)	Create a new FabricRegistryBuilder, the registry has the RegistryAttribute.MODDED attribute by default.

Methods inherited from class java.lang.Object

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

Method Details

from

public static <T,
R extends MutableRegistry<T>>
FabricRegistryBuilder<T,R> from(R registry)

Create a new FabricRegistryBuilder, the registry has the RegistryAttribute.MODDED attribute by default.

Type Parameters:

T - The type stored in the Registry

R - The registry type

Parameters:

registry - The base registry type such as SimpleRegistry or DefaultedRegistry

Returns:

An instance of FabricRegistryBuilder

createSimple

public static <T>
FabricRegistryBuilder<T,SimpleRegistry<T>> createSimple(RegistryKey<Registry<T>> registryKey)

Create a new FabricRegistryBuilder using a SimpleRegistry, the registry has the RegistryAttribute.MODDED attribute by default.

Type Parameters:

T - The type stored in the Registry

Parameters:

registryKey - The registry RegistryKey

Returns:

An instance of FabricRegistryBuilder

createDefaulted

public static <T>
FabricRegistryBuilder<T,SimpleDefaultedRegistry<T>> createDefaulted(RegistryKey<Registry<T>> registryKey,
 Identifier defaultId)

Create a new FabricRegistryBuilder using a DefaultedRegistry, the registry has the RegistryAttribute.MODDED attribute by default.

Type Parameters:

T - The type stored in the Registry

Parameters:

registryKey - The registry RegistryKey

defaultId - The default registry id

Returns:

An instance of FabricRegistryBuilder

createSimple

@Deprecated
public static <T>
FabricRegistryBuilder<T,SimpleRegistry<T>> createSimple(Class<T> type,
 Identifier registryId)

Deprecated.

Please migrate to createSimple(RegistryKey)

Create a new FabricRegistryBuilder using a SimpleRegistry, the registry has the RegistryAttribute.MODDED attribute by default.

Type Parameters:

T - The type stored in the Registry

Parameters:

registryId - The registry Identifier used as the registry id

Returns:

An instance of FabricRegistryBuilder

createDefaulted

@Deprecated
public static <T>
FabricRegistryBuilder<T,SimpleDefaultedRegistry<T>> createDefaulted(Class<T> type,
 Identifier registryId,
 Identifier defaultId)

Deprecated.

Please migrate to createDefaulted(RegistryKey, Identifier)

Create a new FabricRegistryBuilder using a DefaultedRegistry, the registry has the RegistryAttribute.MODDED attribute by default.

Type Parameters:

T - The type stored in the Registry

Parameters:

registryId - The registry Identifier used as the registry id

defaultId - The default registry id

Returns:

An instance of FabricRegistryBuilder

attribute

public FabricRegistryBuilder<T,R> attribute(RegistryAttribute attribute)

Add a RegistryAttribute to the registry.

Parameters:

attribute - the RegistryAttribute to add to the registry

Returns:

the instance of FabricRegistryBuilder

buildAndRegister

public R buildAndRegister()

Applies the attributes to the registry and registers it.

Returns:

the registry instance with the attributes applied