Package net.minecraft.resources

Class ResourceKey<T>

java.lang.Object

net.minecraft.resources.ResourceKey<T>

Type Parameters:

T - The type of the resource represented by this ResourceKey, or the type of the registry if it is a registry key.

All Implemented Interfaces:

Comparable<ResourceKey<?>>

public class ResourceKey<T>
extends Object
implements Comparable<ResourceKey<?>>

An immutable key for a resource, in terms of the name of its parent registry and its location in that registry.

Registry uses this to return resource keys for registry objects via Registry.getResourceKey(Object). It also uses this class to store its name, with the parent registry name set to minecraft:root. When used in this way it is usually referred to as a "registry key".

See Also:

• ResourceLocation

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static final record	ResourceKey.InternKey

Field Summary

Fields

Modifier and Type	Field	Description
private final ResourceLocation	location	The location of the resource within the registry.
private final ResourceLocation	registryName	The name of the parent registry of the resource.
private static final ConcurrentMap<ResourceKey.InternKey,ResourceKey<?>>	VALUES

Constructor Summary

Constructors

Modifier	Constructor	Description
private	ResourceKey(ResourceLocation pRegistryName, ResourceLocation pLocation)

Method Summary

Modifier and Type	Method	Description
<E> Optional<ResourceKey<E>>	cast(ResourceKey<? extends Registry<E>> pRegistryKey)
static <T> com.mojang.serialization.Codec<ResourceKey<T>>	codec(ResourceKey<? extends Registry<T>> pRegistryKey)
int	compareTo(ResourceKey<?> o)
static <T> ResourceKey<T>	create(ResourceKey<? extends Registry<T>> pRegistryKey, ResourceLocation pLocation)	Constructs a new ResourceKey for a resource with the specified location within the registry specified by the given registryKey.
private static <T> ResourceKey<T>	create(ResourceLocation pRegistryName, ResourceLocation pLocation)
static <T> ResourceKey<Registry<T>>	createRegistryKey(ResourceLocation pLocation)
boolean	isFor(ResourceKey<? extends Registry<?>> pRegistryKey)
ResourceLocation	location()
ResourceLocation	registry()
ResourceKey<Registry<T>>	registryKey()
static <T> StreamCodec<io.netty.buffer.ByteBuf,ResourceKey<T>>	streamCodec(ResourceKey<? extends Registry<T>> pRegistryKey)
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

VALUES

private static final ConcurrentMap<ResourceKey.InternKey,ResourceKey<?>> VALUES

registryName

private final ResourceLocation registryName

The name of the parent registry of the resource.

location

private final ResourceLocation location

The location of the resource within the registry.

Constructor Details

ResourceKey

private ResourceKey(ResourceLocation pRegistryName,
 ResourceLocation pLocation)

Method Details

codec

public static <T>
com.mojang.serialization.Codec<ResourceKey<T>> codec(ResourceKey<? extends Registry<T>> pRegistryKey)

streamCodec

public static <T>
StreamCodec<io.netty.buffer.ByteBuf,ResourceKey<T>> streamCodec(ResourceKey<? extends Registry<T>> pRegistryKey)

create

public static <T> ResourceKey<T> create(ResourceKey<? extends Registry<T>> pRegistryKey,
 ResourceLocation pLocation)

Constructs a new ResourceKey for a resource with the specified location within the registry specified by the given registryKey.

Returns:

the created resource key. The registry name is set to the location of the specified registryKey and with the specified location as the location of the resource.

createRegistryKey

public static <T> ResourceKey<Registry<T>> createRegistryKey(ResourceLocation pLocation)

Returns:

the created registry key. The registry name is set to minecraft:root and the location the specified registryName.

create

private static <T> ResourceKey<T> create(ResourceLocation pRegistryName,
 ResourceLocation pLocation)

toString

public String toString()

Overrides:

toString in class Object

isFor

public boolean isFor(ResourceKey<? extends Registry<?>> pRegistryKey)

Returns:

true if this resource key is a direct child of the specified registryKey.

cast

public <E> Optional<ResourceKey<E>> cast(ResourceKey<? extends Registry<E>> pRegistryKey)

location

public ResourceLocation location()

registry

public ResourceLocation registry()

registryKey

public ResourceKey<Registry<T>> registryKey()

compareTo

public int compareTo(ResourceKey<?> o)

Specified by:

compareTo in interface Comparable<T>