Package net.minecraftforge.registries

Class RegistryBuilder<T extends IForgeRegistryEntry<T>>

java.lang.Object

net.minecraftforge.registries.RegistryBuilder<T>

public class RegistryBuilder<T extends IForgeRegistryEntry<T>>
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
private List<IForgeRegistry.AddCallback<T>>	addCallback
private boolean	allowModifications
private boolean	allowOverrides
private List<IForgeRegistry.BakeCallback<T>>	bakeCallback
private List<IForgeRegistry.ClearCallback<T>>	clearCallback
private List<IForgeRegistry.CreateCallback<T>>	createCallback
private Supplier<RegistryAccess.RegistryData<T>>	dataPackRegistryData
private IForgeRegistry.DummyFactory<T>	dummyFactory
private boolean	hasWrapper
private Set<ResourceLocation>	legacyNames
private static final int	MAX_ID
private int	maxId
private int	minId
private IForgeRegistry.MissingFactory<T>	missingFactory
private ResourceLocation	optionalDefaultKey
private ResourceLocation	registryName
private Class<T>	registryType
private boolean	saveToDisc
private boolean	sync
private List<IForgeRegistry.ValidateCallback<T>>	validateCallback
private Function<T,Holder.Reference<T>>	vanillaHolder

Constructor Summary

Constructors

Constructor	Description
RegistryBuilder()

Method Summary

Modifier and Type	Method	Description
RegistryBuilder<T>	add(IForgeRegistry.AddCallback<T> add)
RegistryBuilder<T>	add(IForgeRegistry.BakeCallback<T> bake)
RegistryBuilder<T>	add(IForgeRegistry.ClearCallback<T> clear)
RegistryBuilder<T>	add(IForgeRegistry.CreateCallback<T> create)
RegistryBuilder<T>	add(IForgeRegistry.ValidateCallback<T> validate)
RegistryBuilder<T>	addCallback(Object inst)
RegistryBuilder<T>	allowModification()
(package private) IForgeRegistry<T>	create()	Modders: Use NewRegistryEvent.create(RegistryBuilder) instead
RegistryBuilder<T>	dataPackRegistry(com.mojang.serialization.Codec<T> codec)	Register this registry as an unsynced datapack registry, which will cause data to be loaded from a datapack folder based on the registry's name.
RegistryBuilder<T>	dataPackRegistry(com.mojang.serialization.Codec<T> codec, com.mojang.serialization.Codec<T> networkCodec)	Register this registry as a datapack registry, which will cause data to be loaded from a datapack folder based on the registry's name.
RegistryBuilder<T>	disableOverrides()
RegistryBuilder<T>	disableSaving()
RegistryBuilder<T>	disableSync()	Prevents the registry from being synced to clients.
RegistryBuilder<T>	dummy(IForgeRegistry.DummyFactory<T> factory)
IForgeRegistry.AddCallback<T>	getAdd()
boolean	getAllowModifications()
boolean	getAllowOverrides()
IForgeRegistry.BakeCallback<T>	getBake()
IForgeRegistry.ClearCallback<T>	getClear()
IForgeRegistry.CreateCallback<T>	getCreate()
(package private) RegistryAccess.RegistryData<T>	getDataPackRegistryData()	Retrieves datapack registry information, if any.
ResourceLocation	getDefault()
IForgeRegistry.DummyFactory<T>	getDummyFactory()
(package private) boolean	getHasWrapper()
Set<ResourceLocation>	getLegacyNames()
int	getMaxId()
int	getMinId()
IForgeRegistry.MissingFactory<T>	getMissingFactory()
boolean	getSaveToDisc()
boolean	getSync()
Class<T>	getType()
IForgeRegistry.ValidateCallback<T>	getValidate()
(package private) Function<T,Holder.Reference<T>>	getVanillaHolder()
RegistryBuilder<T>	hasTags()	Enables tags for this registry if not already.
(package private) RegistryBuilder<T>	hasWrapper()
RegistryBuilder<T>	legacyName(String name)
RegistryBuilder<T>	legacyName(ResourceLocation name)
RegistryBuilder<T>	missing(IForgeRegistry.MissingFactory<T> missing)
RegistryBuilder<T>	onAdd(IForgeRegistry.AddCallback<T> add)
RegistryBuilder<T>	onBake(IForgeRegistry.BakeCallback<T> bake)
RegistryBuilder<T>	onClear(IForgeRegistry.ClearCallback<T> clear)
RegistryBuilder<T>	onCreate(IForgeRegistry.CreateCallback<T> create)
RegistryBuilder<T>	onValidate(IForgeRegistry.ValidateCallback<T> validate)
RegistryBuilder<T>	set(IForgeRegistry.DummyFactory<T> factory)
RegistryBuilder<T>	set(IForgeRegistry.MissingFactory<T> missing)
RegistryBuilder<T>	setDefaultKey(ResourceLocation key)
RegistryBuilder<T>	setIDRange(int min, int max)
RegistryBuilder<T>	setMaxID(int max)
RegistryBuilder<T>	setName(ResourceLocation name)
RegistryBuilder<T>	setType(Class<T> type)
(package private) RegistryBuilder<T>	vanillaHolder(Function<T,Holder.Reference<T>> func)

Methods inherited from class java.lang.Object

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

Field Details

MAX_ID

private static final int MAX_ID

See Also:

• Constant Field Values

registryName

private ResourceLocation registryName

registryType

private Class<T extends IForgeRegistryEntry<T>> registryType

optionalDefaultKey

private ResourceLocation optionalDefaultKey

minId

private int minId

maxId

private int maxId

addCallback

private List<IForgeRegistry.AddCallback<T extends IForgeRegistryEntry<T>>> addCallback

clearCallback

private List<IForgeRegistry.ClearCallback<T extends IForgeRegistryEntry<T>>> clearCallback

createCallback

private List<IForgeRegistry.CreateCallback<T extends IForgeRegistryEntry<T>>> createCallback

validateCallback

private List<IForgeRegistry.ValidateCallback<T extends IForgeRegistryEntry<T>>> validateCallback

bakeCallback

private List<IForgeRegistry.BakeCallback<T extends IForgeRegistryEntry<T>>> bakeCallback

vanillaHolder

private Function<T extends IForgeRegistryEntry<T>,Holder.Reference<T extends IForgeRegistryEntry<T>>> vanillaHolder

saveToDisc

private boolean saveToDisc

sync

private boolean sync

allowOverrides

private boolean allowOverrides

allowModifications

private boolean allowModifications

hasWrapper

private boolean hasWrapper

dataPackRegistryData

private Supplier<RegistryAccess.RegistryData<T extends IForgeRegistryEntry<T>>> dataPackRegistryData

dummyFactory

private IForgeRegistry.DummyFactory<T extends IForgeRegistryEntry<T>> dummyFactory

missingFactory

private IForgeRegistry.MissingFactory<T extends IForgeRegistryEntry<T>> missingFactory

legacyNames

private Set<ResourceLocation> legacyNames

Constructor Details

RegistryBuilder

public RegistryBuilder()

Method Details

setName

public RegistryBuilder<T> setName(ResourceLocation name)

setType

public RegistryBuilder<T> setType(Class<T> type)

setIDRange

public RegistryBuilder<T> setIDRange(int min,
 int max)

setMaxID

public RegistryBuilder<T> setMaxID(int max)

setDefaultKey

public RegistryBuilder<T> setDefaultKey(ResourceLocation key)

addCallback

public RegistryBuilder<T> addCallback(Object inst)

add

public RegistryBuilder<T> add(IForgeRegistry.AddCallback<T> add)

onAdd

public RegistryBuilder<T> onAdd(IForgeRegistry.AddCallback<T> add)

add

public RegistryBuilder<T> add(IForgeRegistry.ClearCallback<T> clear)

onClear

public RegistryBuilder<T> onClear(IForgeRegistry.ClearCallback<T> clear)

add

public RegistryBuilder<T> add(IForgeRegistry.CreateCallback<T> create)

onCreate

public RegistryBuilder<T> onCreate(IForgeRegistry.CreateCallback<T> create)

add

public RegistryBuilder<T> add(IForgeRegistry.ValidateCallback<T> validate)

onValidate

public RegistryBuilder<T> onValidate(IForgeRegistry.ValidateCallback<T> validate)

add

public RegistryBuilder<T> add(IForgeRegistry.BakeCallback<T> bake)

onBake

public RegistryBuilder<T> onBake(IForgeRegistry.BakeCallback<T> bake)

set

public RegistryBuilder<T> set(IForgeRegistry.DummyFactory<T> factory)

dummy

public RegistryBuilder<T> dummy(IForgeRegistry.DummyFactory<T> factory)

set

public RegistryBuilder<T> set(IForgeRegistry.MissingFactory<T> missing)

missing

public RegistryBuilder<T> missing(IForgeRegistry.MissingFactory<T> missing)

disableSaving

public RegistryBuilder<T> disableSaving()

disableSync

public RegistryBuilder<T> disableSync()

Prevents the registry from being synced to clients. Does *not* affect datapack registries, datapack registries are unsynced by default unless a non-null network codec is registered via dataPackRegistry(Codec, Codec)

Returns:

this

disableOverrides

public RegistryBuilder<T> disableOverrides()

allowModification

public RegistryBuilder<T> allowModification()

hasWrapper

RegistryBuilder<T> hasWrapper()

legacyName

public RegistryBuilder<T> legacyName(String name)

legacyName

public RegistryBuilder<T> legacyName(ResourceLocation name)

vanillaHolder

RegistryBuilder<T> vanillaHolder(Function<T,Holder.Reference<T>> func)

hasTags

public RegistryBuilder<T> hasTags()

Enables tags for this registry if not already. All forge registries with wrappers inherently support tags.

Returns:

this builder

See Also:

• hasWrapper()

dataPackRegistry

public RegistryBuilder<T> dataPackRegistry(com.mojang.serialization.Codec<T> codec)

Register this registry as an unsynced datapack registry, which will cause data to be loaded from a datapack folder based on the registry's name. The mod that registers this registry does not need to exist on the client to connect to servers with the mod/registry.

Data JSONs will be loaded from data/<datapack_namespace>/modid/registryname/, where modid is the mod that registered this registry.

Parameters:

codec - the codec to be used for loading data from datapacks on servers

Returns:

this builder

See Also:

• dataPackRegistry(Codec, Codec)

dataPackRegistry

public RegistryBuilder<T> dataPackRegistry(com.mojang.serialization.Codec<T> codec,
 @Nullable
 com.mojang.serialization.Codec<T> networkCodec)

Register this registry as a datapack registry, which will cause data to be loaded from a datapack folder based on the registry's name.

Data JSONs will be loaded from data/<datapack_namespace>/modid/registryname/, where modid is the mod that registered this registry.

Parameters:

codec - the codec to be used for loading data from datapacks on servers

networkCodec - the codec to be used for syncing loaded data to clients.
If networkCodec is null, data will not be synced, and clients without the mod that registered this registry can connect to servers with the mod.
If networkCodec is not null, then data will be synced (accessible via ClientPacketListener.registryAccess()), and the mod must be present on a client to connect to servers with the mod.

Returns:

this builder

See Also:

• dataPackRegistry(Codec)

getDataPackRegistryData

@Nullable
RegistryAccess.RegistryData<T> getDataPackRegistryData()

Retrieves datapack registry information, if any.

Returns:

RegistryData containing the registry's key and codec(s). If returned data is null, this has not been marked as a datapack registry.

Throws:

IllegalStateException - if this has been marked as a datapack registry, but registry name has not been set.

create

IForgeRegistry<T> create()

Modders: Use NewRegistryEvent.create(RegistryBuilder) instead

getAdd

@Nullable
public IForgeRegistry.AddCallback<T> getAdd()

getClear

@Nullable
public IForgeRegistry.ClearCallback<T> getClear()

getCreate

@Nullable
public IForgeRegistry.CreateCallback<T> getCreate()

getValidate

@Nullable
public IForgeRegistry.ValidateCallback<T> getValidate()

getBake

@Nullable
public IForgeRegistry.BakeCallback<T> getBake()

getType

public Class<T> getType()

getDefault

@Nullable
public ResourceLocation getDefault()

getMinId

public int getMinId()

getMaxId

public int getMaxId()

getAllowOverrides

public boolean getAllowOverrides()

getAllowModifications

public boolean getAllowModifications()

getDummyFactory

@Nullable
public IForgeRegistry.DummyFactory<T> getDummyFactory()

getMissingFactory

@Nullable
public IForgeRegistry.MissingFactory<T> getMissingFactory()

getSaveToDisc

public boolean getSaveToDisc()

getSync

public boolean getSync()

getLegacyNames

public Set<ResourceLocation> getLegacyNames()

getVanillaHolder

Function<T,Holder.Reference<T>> getVanillaHolder()

getHasWrapper

boolean getHasWrapper()