Package net.minecraftforge.registries

Class ForgeRegistry<V>

java.lang.Object

net.minecraftforge.registries.ForgeRegistry<V>

All Implemented Interfaces:

Iterable<V>, IForgeRegistry<V>, IForgeRegistryInternal<V>, IForgeRegistryModifiable<V>

@Internal
public class ForgeRegistry<V>
extends Object
implements IForgeRegistryInternal<V>, IForgeRegistryModifiable<V>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static final record	ForgeRegistry.DumpRow
private static final record	ForgeRegistry.OverrideOwner<V>
private class	ForgeRegistry.RegistryCodec
static class	ForgeRegistry.Snapshot

Nested classes/interfaces inherited from interface net.minecraftforge.registries.IForgeRegistry

IForgeRegistry.AddCallback<V>, IForgeRegistry.BakeCallback<V>, IForgeRegistry.ClearCallback<V>, IForgeRegistry.CreateCallback<V>, IForgeRegistry.DummyFactory<V>, IForgeRegistry.MissingFactory<V>, IForgeRegistry.ValidateCallback<V>

Field Summary

Fields

Modifier and Type	Field	Description
private final IForgeRegistry.AddCallback<V>	add
private final Map<ResourceLocation,ResourceLocation>	aliases
private final boolean	allowOverrides
private final BitSet	availabilityMap
private final IForgeRegistry.BakeCallback<V>	bake
private final Set<Integer>	blocked
private final RegistryBuilder<V>	builder
private final IForgeRegistry.ClearCallback<V>	clear
private final com.mojang.serialization.Codec<V>	codec
private final IForgeRegistry.CreateCallback<V>	create
private final ResourceLocation	defaultKey
private final ResourceKey<V>	defaultResourceKey
private V	defaultValue
private final Map<ResourceLocation,Holder.Reference<V>>	delegatesByName
private final Map<V,Holder.Reference<V>>	delegatesByValue
private final Set<ResourceLocation>	dummies	Deprecated, for removal: This API element is subject to removal in a future version.
private final IForgeRegistry.DummyFactory<V>	dummyFactory	Deprecated, for removal: This API element is subject to removal in a future version.
private final boolean	hasWrapper
private final com.google.common.collect.BiMap<Integer,V>	ids
(package private) boolean	isFrozen
private final boolean	isModifiable
private final ResourceKey<Registry<V>>	key
private final com.google.common.collect.BiMap<ResourceKey<V>,V>	keys
private static org.apache.logging.log4j.Logger	LOGGER
private final int	max
private final int	min
private final IForgeRegistry.MissingFactory<V>	missing
private final ResourceLocation	name
private final com.google.common.collect.BiMap<ResourceLocation,V>	names
private final com.google.common.collect.Multimap<ResourceLocation,V>	overrides
private final com.google.common.collect.BiMap<ForgeRegistry.OverrideOwner<V>,V>	owners
static org.apache.logging.log4j.Marker	REGISTRIES
private static org.apache.logging.log4j.Marker	REGISTRYDUMP
(package private) final Map<ResourceLocation,?>	slaves
private final RegistryManager	stage
private final ForgeRegistryTagManager<V>	tagManager
private final IForgeRegistry.ValidateCallback<V>	validate

Constructor Summary

Constructors

Constructor	Description
ForgeRegistry(RegistryManager stage, ResourceLocation name, RegistryBuilder<V> builder)

Method Summary

Modifier and Type	Method	Description
(package private) int	add(int id, ResourceLocation key, V value)
(package private) int	add(int id, ResourceLocation key, V value, String owner)
void	addAlias(ResourceLocation src, ResourceLocation dst)	Adds an alias that maps from the name specified by src to the name specified by dst.
(package private) void	addDummy(ResourceLocation key)	Deprecated, for removal: This API element is subject to removal in a future version.
void	bake()
private Holder.Reference<V>	bindDelegate(ResourceKey<V> rkey, V value)
(package private) void	block(int id)
void	clear()
boolean	containsKey(ResourceLocation key)
boolean	containsValue(V value)
(package private) ForgeRegistry<V>	copy(RegistryManager stage)
private void	createAndAddDummy(ResourceLocation key, int id)	Deprecated, for removal: This API element is subject to removal in a future version.
(package private) void	dump(ResourceLocation name)
void	freeze()	Used to control the times where people can modify this registry.
(package private) RegistryBuilder<V>	getBuilder()
@NotNull com.mojang.serialization.Codec<V>	getCodec()
(package private) V	getDefault()
@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.
int	getID(ResourceLocation name)
int	getID(V value)
private int	getIDRaw(ResourceLocation name)
private int	getIDRaw(V value)
@Nullable ResourceKey<V>	getKey(int id)
ResourceLocation	getKey(V value)
@NotNull Set<ResourceLocation>	getKeys()
MissingMappingsEvent	getMissingEvent(ResourceLocation name, Map<ResourceLocation,Integer> map)
(package private) Map<ResourceLocation,String>	getOverrideOwners()
V	getRaw(ResourceLocation key)
ResourceKey<Registry<V>>	getRegistryKey()
ResourceLocation	getRegistryName()
@NotNull Optional<ResourceKey<V>>	getResourceKey(V value)
(package private) @NotNull Set<ResourceKey<V>>	getResourceKeys()
<T> T	getSlaveMap(ResourceLocation name, Class<T> type)	Retrieve the slave map of type T from the registry.
V	getValue(int id)
V	getValue(ResourceLocation key)
@NotNull Collection<V>	getValues()
(package private) @Nullable NamespacedWrapper<V>	getWrapper()
(package private) @NotNull NamespacedWrapper<V>	getWrapperOrThrow()
(package private) boolean	isDummied(ResourceLocation key)	Deprecated, for removal: This API element is subject to removal in a future version.
boolean	isEmpty()
boolean	isLocked()
Iterator<V>	iterator()
void	loadIds(Map<ResourceLocation,Integer> ids, Map<ResourceLocation,String> overrides, Map<ResourceLocation,Integer> missing, Map<ResourceLocation,IdMappingEvent.IdRemapping> remapped, ForgeRegistry<V> old, ResourceLocation name)
ForgeRegistry.Snapshot	makeSnapshot()
(package private) boolean	markDummy(ResourceLocation key, int id)	Deprecated, for removal: This API element is subject to removal in a future version.
(package private) void	onBindTags(Map<TagKey<V>,HolderSet.Named<V>> tags, Set<TagKey<V>> defaultedTags)
(package private) void	processMissingEvent(ResourceLocation name, ForgeRegistry<V> pool, List<MissingMappingsEvent.Mapping<V>> mappings, Map<ResourceLocation,Integer> missing, Map<ResourceLocation,IdMappingEvent.IdRemapping> remaps, Collection<ResourceLocation> defaulted, Collection<ResourceLocation> failed, boolean injectNetworkDummies)
void	register(int id, ResourceLocation key, V value)
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)
V	remove(ResourceLocation key)
(package private) void	resetDelegates()
void	setSlaveMap(ResourceLocation name, Object obj)
(package private) int	size()
(package private) void	sync(ResourceLocation name, ForgeRegistry<V> from)
@Nullable ITagManager<V>	tags()
void	unfreeze()
(package private) void	validateContent(ResourceLocation registryName)
(package private) void	validateKey()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Details

REGISTRIES

public static org.apache.logging.log4j.Marker REGISTRIES

REGISTRYDUMP

private static org.apache.logging.log4j.Marker REGISTRYDUMP

LOGGER

private static org.apache.logging.log4j.Logger LOGGER

stage

private final RegistryManager stage

ids

private final com.google.common.collect.BiMap<Integer,V> ids

names

private final com.google.common.collect.BiMap<ResourceLocation,V> names

keys

private final com.google.common.collect.BiMap<ResourceKey<V>,V> keys

aliases

private final Map<ResourceLocation,ResourceLocation> aliases

slaves

final Map<ResourceLocation,?> slaves

defaultKey

private final ResourceLocation defaultKey

defaultResourceKey

private final ResourceKey<V> defaultResourceKey

create

private final IForgeRegistry.CreateCallback<V> create

add

private final IForgeRegistry.AddCallback<V> add

clear

private final IForgeRegistry.ClearCallback<V> clear

validate

private final IForgeRegistry.ValidateCallback<V> validate

bake

private final IForgeRegistry.BakeCallback<V> bake

missing

private final IForgeRegistry.MissingFactory<V> missing

availabilityMap

private final BitSet availabilityMap

dummies

@Deprecated(forRemoval=true,
            since="1.19.4")
private final Set<ResourceLocation> dummies

Deprecated, for removal: This API element is subject to removal in a future version.

blocked

private final Set<Integer> blocked

overrides

private final com.google.common.collect.Multimap<ResourceLocation,V> overrides

delegatesByName

private final Map<ResourceLocation,Holder.Reference<V>> delegatesByName

delegatesByValue

private final Map<V,Holder.Reference<V>> delegatesByValue

owners

private final com.google.common.collect.BiMap<ForgeRegistry.OverrideOwner<V>,V> owners

tagManager

private final ForgeRegistryTagManager<V> tagManager

dummyFactory

@Deprecated(forRemoval=true,
            since="1.19.4")
private final IForgeRegistry.DummyFactory<V> dummyFactory

Deprecated, for removal: This API element is subject to removal in a future version.

min

private final int min

max

private final int max

allowOverrides

private final boolean allowOverrides

isModifiable

private final boolean isModifiable

hasWrapper

private final boolean hasWrapper

defaultValue

private V defaultValue

isFrozen

boolean isFrozen

name

private final ResourceLocation name

key

private final ResourceKey<Registry<V>> key

builder

private final RegistryBuilder<V> builder

codec

private final com.mojang.serialization.Codec<V> codec

Constructor Details

ForgeRegistry

ForgeRegistry(RegistryManager stage,
 ResourceLocation name,
 RegistryBuilder<V> builder)

Method Details

register

public void register(String key,
 V value)

Description copied from interface: IForgeRegistry

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.

Specified by:

register in interface IForgeRegistry<V>

register

public void register(ResourceLocation key,
 V value)

Specified by:

register in interface IForgeRegistry<V>

iterator

public Iterator<V> iterator()

Specified by:

iterator in interface Iterable<V>

getRegistryName

public ResourceLocation getRegistryName()

Specified by:

getRegistryName in interface IForgeRegistry<V>

getRegistryKey

public ResourceKey<Registry<V>> getRegistryKey()

Specified by:

getRegistryKey in interface IForgeRegistry<V>

getCodec

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

Specified by:

getCodec in interface IForgeRegistry<V>

See Also:

• Registry.byNameCodec()

containsKey

public boolean containsKey(ResourceLocation key)

Specified by:

containsKey in interface IForgeRegistry<V>

containsValue

public boolean containsValue(V value)

Specified by:

containsValue in interface IForgeRegistry<V>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface IForgeRegistry<V>

size

int size()

getValue

public V getValue(ResourceLocation key)

Specified by:

getValue in interface IForgeRegistry<V>

getKey

public ResourceLocation getKey(V value)

Specified by:

getKey in interface IForgeRegistry<V>

getResourceKey

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

Specified by:

getResourceKey in interface IForgeRegistry<V>

getWrapper

@Nullable
@Nullable NamespacedWrapper<V> getWrapper()

getWrapperOrThrow

@NotNull
@NotNull NamespacedWrapper<V> getWrapperOrThrow()

onBindTags

void onBindTags(Map<TagKey<V>,HolderSet.Named<V>> tags,
 Set<TagKey<V>> defaultedTags)

getHolder

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

Description copied from interface: IForgeRegistry

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

Specified by:

getHolder in interface IForgeRegistry<V>

See Also:

• Registry.getHolder(ResourceKey)

getHolder

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

Description copied from interface: IForgeRegistry

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

Specified by:

getHolder in interface IForgeRegistry<V>

getHolder

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

Description copied from interface: IForgeRegistry

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

Specified by:

getHolder in interface IForgeRegistry<V>

tags

@Nullable
public @Nullable ITagManager<V> tags()

Specified by:

tags in interface IForgeRegistry<V>

Returns:

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

getKeys

@NotNull
public @NotNull Set<ResourceLocation> getKeys()

Specified by:

getKeys in interface IForgeRegistry<V>

getResourceKeys

@NotNull
@NotNull Set<ResourceKey<V>> getResourceKeys()

getValues

@NotNull
public @NotNull Collection<V> getValues()

Specified by:

getValues in interface IForgeRegistry<V>

getEntries

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

Specified by:

getEntries in interface IForgeRegistry<V>

getSlaveMap

public <T> T getSlaveMap(ResourceLocation name,
 Class<T> type)

Description copied from interface: IForgeRegistry

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

Specified by:

getSlaveMap in interface IForgeRegistry<V>

Type Parameters:

T - Type to return

Parameters:

name - The name of the slavemap

type - The type

Returns:

The slavemap if present

setSlaveMap

public void setSlaveMap(ResourceLocation name,
 Object obj)

Specified by:

setSlaveMap in interface IForgeRegistryInternal<V>

getID

public int getID(V value)

getID

public int getID(ResourceLocation name)

getIDRaw

private int getIDRaw(V value)

getIDRaw

private int getIDRaw(ResourceLocation name)

getValue

public V getValue(int id)

Specified by:

getValue in interface IForgeRegistryInternal<V>

getKey

@Nullable
public @Nullable ResourceKey<V> getKey(int id)

validateKey

void validateKey()

getDefaultKey

@Nullable
public @Nullable ResourceLocation getDefaultKey()

Specified by:

getDefaultKey in interface IForgeRegistry<V>

copy

ForgeRegistry<V> copy(RegistryManager stage)

register

public void register(int id,
 ResourceLocation key,
 V value)

Specified by:

register in interface IForgeRegistryInternal<V>

add

int add(int id,
 ResourceLocation key,
 V value)

add

int add(int id,
 ResourceLocation key,
 V value,
 String owner)

getRaw

public V getRaw(ResourceLocation key)

addAlias

public void addAlias(ResourceLocation src,
 ResourceLocation dst)

Adds an alias that maps from the name specified by src to the name specified by dst.

Any registry lookups that target the first name will resolve as the second name, if the first name is not present.

Parameters:

src - The source registry name to alias from.

dst - The target registry name to alias to. TODO: Add as public API in IForgeRegistry and DeferredRegister.

addDummy

@Deprecated(forRemoval=true,
            since="1.19.4")
void addDummy(ResourceLocation key)

Deprecated, for removal: This API element is subject to removal in a future version.

getDelegate

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

Specified by:

getDelegate in interface IForgeRegistry<V>

getDelegateOrThrow

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

Specified by:

getDelegateOrThrow in interface IForgeRegistry<V>

getDelegate

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

Specified by:

getDelegate in interface IForgeRegistry<V>

getDelegateOrThrow

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

Specified by:

getDelegateOrThrow in interface IForgeRegistry<V>

getDelegate

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

Specified by:

getDelegate in interface IForgeRegistry<V>

getDelegateOrThrow

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

Specified by:

getDelegateOrThrow in interface IForgeRegistry<V>

bindDelegate

private Holder.Reference<V> bindDelegate(ResourceKey<V> rkey,
 V value)

resetDelegates

void resetDelegates()

getDefault

V getDefault()

isDummied

@Deprecated(forRemoval=true,
            since="1.19.4")
boolean isDummied(ResourceLocation key)

Deprecated, for removal: This API element is subject to removal in a future version.

validateContent

void validateContent(ResourceLocation registryName)

bake

public void bake()

sync

void sync(ResourceLocation name,
 ForgeRegistry<V> from)

clear

public void clear()

Specified by:

clear in interface IForgeRegistryModifiable<V>

remove

public V remove(ResourceLocation key)

Specified by:

remove in interface IForgeRegistryModifiable<V>

block

void block(int id)

isLocked

public boolean isLocked()

Specified by:

isLocked in interface IForgeRegistryModifiable<V>

freeze

public void freeze()

Used to control the times where people can modify this registry. Users should only ever register things in the Register<?> events!

unfreeze

public void unfreeze()

dump

void dump(ResourceLocation name)

loadIds

public void loadIds(Map<ResourceLocation,Integer> ids,
 Map<ResourceLocation,String> overrides,
 Map<ResourceLocation,Integer> missing,
 Map<ResourceLocation,IdMappingEvent.IdRemapping> remapped,
 ForgeRegistry<V> old,
 ResourceLocation name)

markDummy

@Deprecated(forRemoval=true,
            since="1.19.4")
boolean markDummy(ResourceLocation key,
 int id)

Deprecated, for removal: This API element is subject to removal in a future version.

createAndAddDummy

@Deprecated(forRemoval=true,
            since="1.19.4")
private void createAndAddDummy(ResourceLocation key,
 int id)

Deprecated, for removal: This API element is subject to removal in a future version.

makeSnapshot

public ForgeRegistry.Snapshot makeSnapshot()

getOverrideOwners

Map<ResourceLocation,String> getOverrideOwners()

getMissingEvent

public MissingMappingsEvent getMissingEvent(ResourceLocation name,
 Map<ResourceLocation,Integer> map)

processMissingEvent

void processMissingEvent(ResourceLocation name,
 ForgeRegistry<V> pool,
 List<MissingMappingsEvent.Mapping<V>> mappings,
 Map<ResourceLocation,Integer> missing,
 Map<ResourceLocation,IdMappingEvent.IdRemapping> remaps,
 Collection<ResourceLocation> defaulted,
 Collection<ResourceLocation> failed,
 boolean injectNetworkDummies)

getBuilder

RegistryBuilder<V> getBuilder()