Package net.neoforged.neoforge.registries

Class RegistryBuilder<T>

java.lang.Object

net.neoforged.neoforge.registries.RegistryBuilder<T>

public class RegistryBuilder<T>
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
private final List<RegistryCallback<T>>	callbacks
private @Nullable ResourceLocation	defaultKey
private boolean	intrusiveHolders
private int	maxId
private boolean	registrationCheck
private final ResourceKey<? extends Registry<T>>	registryKey
private boolean	sync

Constructor Summary

Constructors

Constructor	Description
RegistryBuilder(ResourceKey<? extends Registry<T>> registryKey)

Method Summary

Modifier and Type	Method	Description
RegistryBuilder<T>	callback(RegistryCallback<T> callback)
Registry<T>	create()	Creates a new registry from this builder.
RegistryBuilder<T>	defaultKey(ResourceKey<T> key)
RegistryBuilder<T>	defaultKey(ResourceLocation key)
RegistryBuilder<T>	disableRegistrationCheck()	Disables the safeguard that ensures this registry is registered to NewRegistryEvent in due time.
RegistryBuilder<T>	maxId(int maxId)	Sets the highest numerical id that an entry in this registry is allowed to use.
RegistryBuilder<T>	onAdd(AddCallback<T> callback)
RegistryBuilder<T>	onBake(BakeCallback<T> callback)
RegistryBuilder<T>	onClear(ClearCallback<T> callback)
RegistryBuilder<T>	sync(boolean sync)	Sets whether this registry should have its numerical IDs synced to clients.
RegistryBuilder<T>	withIntrusiveHolders()	Deprecated. Vanilla has deprecated intrusive holders and is in the process of moving away from them, you should not use this unless you have no better option.

Methods inherited from class java.lang.Object

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

Field Details

registryKey

private final ResourceKey<? extends Registry<T>> registryKey

callbacks

private final List<RegistryCallback<T>> callbacks

defaultKey

@Nullable
private @Nullable ResourceLocation defaultKey

intrusiveHolders

private boolean intrusiveHolders

maxId

private int maxId

sync

private boolean sync

registrationCheck

private boolean registrationCheck

Constructor Details

RegistryBuilder

public RegistryBuilder(ResourceKey<? extends Registry<T>> registryKey)

Method Details

defaultKey

public RegistryBuilder<T> defaultKey(ResourceLocation key)

defaultKey

public RegistryBuilder<T> defaultKey(ResourceKey<T> key)

withIntrusiveHolders

@Deprecated
public RegistryBuilder<T> withIntrusiveHolders()

Deprecated.

Vanilla has deprecated intrusive holders and is in the process of moving away from them, you should not use this unless you have no better option.

callback

public RegistryBuilder<T> callback(RegistryCallback<T> callback)

onAdd

public RegistryBuilder<T> onAdd(AddCallback<T> callback)

onBake

public RegistryBuilder<T> onBake(BakeCallback<T> callback)

onClear

public RegistryBuilder<T> onClear(ClearCallback<T> callback)

maxId

public RegistryBuilder<T> maxId(int maxId)

Sets the highest numerical id that an entry in this registry is allowed to use. Must be greater than or equal to zero.

Parameters:

maxId - the highest numerical id

sync

public RegistryBuilder<T> sync(boolean sync)

Sets whether this registry should have its numerical IDs synced to clients. Default: false.

disableRegistrationCheck

public RegistryBuilder<T> disableRegistrationCheck()

Disables the safeguard that ensures this registry is registered to NewRegistryEvent in due time. DO NOT CALL THIS METHOD UNLESS YOU KNOW WHAT YOU ARE DOING.

create

public Registry<T> create()

Creates a new registry from this builder. Use NewRegistryEvent.create(RegistryBuilder) or DeferredRegister.makeRegistry(Consumer) to not have to call this manually. All created registries must be registered, see NewRegistryEvent.register(Registry).

Returns:

the created registry

See Also:

• NewRegistryEvent.register(Registry)