Package net.minecraftforge.registries

Interface IForgeRegistry<V>

Type Parameters:

V - The top level type for the registry

All Superinterfaces:

Iterable<V>

All Known Subinterfaces:

IForgeRegistryInternal<V>, IForgeRegistryModifiable<V>

All Known Implementing Classes:

ForgeRegistry

public interface IForgeRegistry<V>
extends Iterable<V>

Main interface for the registry system. Use this to query the registry system.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	IForgeRegistry.AddCallback<V>	Callback fired when objects are added to the registry.
static interface	IForgeRegistry.BakeCallback<V>	Callback fired when the registry is done processing.
static interface	IForgeRegistry.ClearCallback<V>	Callback fired when the registry is cleared.
static interface	IForgeRegistry.CreateCallback<V>	Callback fired when a registry instance is created.
static interface	IForgeRegistry.MissingFactory<V>
static final record	IForgeRegistry.SlaveKey<T>
static interface	IForgeRegistry.ValidateCallback<V>	Callback fired when the registry contents are validated.

Method Summary

Modifier and Type	Method	Description
boolean	containsKey(ResourceLocation key)
boolean	containsValue(V value)
@NotNull com.mojang.serialization.Codec<V>	getCodec()
@Nullable ResourceLocation	getDefaultKey()
@NotNull Optional<Holder.Reference<V>>	getDelegate(ResourceKey<V> rkey)
@NotNull Optional<Holder.Reference<V>>	getDelegate(ResourceLocation key)
@NotNull Optional<Holder.Reference<V>>	getDelegate(V value)
Holder.Reference<V>	getDelegateOrThrow(ResourceKey<V> rkey)
Holder.Reference<V>	getDelegateOrThrow(ResourceLocation key)
Holder.Reference<V>	getDelegateOrThrow(V value)
@NotNull Set<Map.Entry<ResourceKey<V>,V>>	getEntries()
@NotNull Optional<Holder<V>>	getHolder(ResourceKey<V> key)	This method exists purely as a stopgap for vanilla compatibility.
@NotNull Optional<Holder<V>>	getHolder(ResourceLocation location)	This method exists purely as a stopgap for vanilla compatibility.
@NotNull Optional<Holder<V>>	getHolder(V value)	This method exists purely as a stopgap for vanilla compatibility.
@Nullable ResourceLocation	getKey(V value)
@NotNull Set<ResourceLocation>	getKeys()
ResourceKey<Registry<V>>	getRegistryKey()
ResourceLocation	getRegistryName()
@NotNull Optional<ResourceKey<V>>	getResourceKey(V value)
<T> T	getSlaveMap(IForgeRegistry.SlaveKey<T> key)	Retrieve the slave map of type T from the registry.
V	getValue(ResourceLocation key)
@NotNull Collection<V>	getValues()
boolean	isEmpty()
void	register(String key, V value)	The supplied string key will be prefixed with the currently active mod's mod id.
void	register(ResourceLocation key, V value)
@Nullable ITagManager<V>	tags()

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Details

getRegistryKey

ResourceKey<Registry<V>> getRegistryKey()

getRegistryName

ResourceLocation getRegistryName()

register

void register(String key,
 V value)

The supplied string key will be prefixed with the currently active mod's mod id. If the supplied name already has a prefix that is different, it will be used and a warning will be logged.

register

void register(ResourceLocation key,
 V value)

containsKey

boolean containsKey(ResourceLocation key)

containsValue

boolean containsValue(V value)

isEmpty

boolean isEmpty()

getValue

@Nullable
V getValue(ResourceLocation key)

getKey

@Nullable
@Nullable ResourceLocation getKey(V value)

getDefaultKey

@Nullable
@Nullable ResourceLocation getDefaultKey()

getResourceKey

@NotNull
@NotNull Optional<ResourceKey<V>> getResourceKey(V value)

getKeys

@NotNull
@NotNull Set<ResourceLocation> getKeys()

getValues

@NotNull
@NotNull Collection<V> getValues()

getEntries

@NotNull
@NotNull Set<Map.Entry<ResourceKey<V>,V>> getEntries()

getCodec

@NotNull
@NotNull com.mojang.serialization.Codec<V> getCodec()

See Also:

• Registry.byNameCodec()

getHolder

@NotNull
@NotNull Optional<Holder<V>> getHolder(ResourceKey<V> key)

This method exists purely as a stopgap for vanilla compatibility. For anything tag related, use tags().

See Also:

• Registry.getHolder(ResourceKey)

getHolder

@NotNull
@NotNull Optional<Holder<V>> getHolder(ResourceLocation location)

This method exists purely as a stopgap for vanilla compatibility. For anything tag related, use tags().

getHolder

@NotNull
@NotNull Optional<Holder<V>> getHolder(V value)

This method exists purely as a stopgap for vanilla compatibility. For anything tag related, use tags().

tags

@Nullable
@Nullable ITagManager<V> tags()

Returns:

an instance of ITagManager if this registry supports tags and/or has a wrapper registry, null otherwise

getDelegate

@NotNull
@NotNull Optional<Holder.Reference<V>> getDelegate(ResourceKey<V> rkey)

getDelegateOrThrow

@NotNull
Holder.Reference<V> getDelegateOrThrow(ResourceKey<V> rkey)

getDelegate

@NotNull
@NotNull Optional<Holder.Reference<V>> getDelegate(ResourceLocation key)

getDelegateOrThrow

@NotNull
Holder.Reference<V> getDelegateOrThrow(ResourceLocation key)

getDelegate

@NotNull
@NotNull Optional<Holder.Reference<V>> getDelegate(V value)

getDelegateOrThrow

@NotNull
Holder.Reference<V> getDelegateOrThrow(V value)

getSlaveMap

<T> T getSlaveMap(IForgeRegistry.SlaveKey<T> key)

Retrieve the slave map of type T from the registry. Slave maps are maps which are dependent on registry content in some way.

Type Parameters:

T - Type to return

Parameters:

slaveMapName - The name of the slavemap

type - The type

Returns:

The slavemap if present