Record Class ContextKey<A>
java.lang.Object
java.lang.Record
com.pixelmonmod.pixelmon.api.context.ContextKey<A>
- Type Parameters:
A
- The type- Record Components:
key
- The resource location to identify the keyclazz
- The type being storedplaceholders
- The placeholders that can be used in the context
public record ContextKey<A>(net.minecraft.resources.ResourceLocation key, Class<A> clazz, List<ContextPlaceholder<A>> placeholders, boolean immutable)
extends Record
A key for the interaction context
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionContextKey
(net.minecraft.resources.ResourceLocation key, Class<A> clazz, List<ContextPlaceholder<A>> placeholders, boolean immutable) The constructor for the context key. -
Method Summary
Modifier and TypeMethodDescriptionclazz()
Returns the value of theclazz
record component.boolean
Indicates whether some other object is "equal to" this one.int
hashCode()
Returns a hash code value for this object.boolean
Returns the value of theimmutable
record component.static <T> ContextKey
<T> Creates an immutable context keystatic <T> ContextKey
<T> immutable
(String key, Class<T> clazz, ContextPlaceholder<T>... placeholders) Creates an immutable context keystatic <T> ContextKey
<T> Creates an immutable context keystatic <T> ContextKey
<T> immutable
(net.minecraft.resources.ResourceLocation key, Class<T> clazz, ContextPlaceholder<T>... placeholders) Creates an immutable context keystatic <T> ContextKey
<T> immutable
(net.minecraft.resources.ResourceLocation key, Class<T> clazz, List<ContextPlaceholder<T>> placeholders) Creates an immutable context keynet.minecraft.resources.ResourceLocation
key()
Returns the value of thekey
record component.static <T> ContextKey
<T> Creates a mutable context keystatic <T> ContextKey
<T> mutable
(String key, Class<T> clazz, ContextPlaceholder<T>... placeholders) Creates a mutable context keystatic <T> ContextKey
<T> Creates a mutable context keystatic <T> ContextKey
<T> mutable
(net.minecraft.resources.ResourceLocation key, Class<T> clazz, ContextPlaceholder<T>... placeholders) Creates a mutable context keyReturns the value of theplaceholders
record component.void
register
(net.neoforged.neoforge.registries.RegisterEvent.RegisterHelper<ContextKey<?>> registerHelper) Registers the context key to the registry
Call this from insideRegisterEvent
Replaces the placeholders in the textfinal String
toString()
Returns a string representation of this record class.
-
Field Details
-
CODEC
-
-
Constructor Details
-
ContextKey
public ContextKey(net.minecraft.resources.ResourceLocation key, Class<A> clazz, List<ContextPlaceholder<A>> placeholders, boolean immutable) The constructor for the context key.
DO NOT USE THIS.
Usemutable(String, Class)
orimmutable(String, Class)
instead.- Parameters:
key
- The key to identify the contextclazz
- The type of the contextplaceholders
- The placeholders that can be used in the contextimmutable
- Whether the context key is immutable or not
-
-
Method Details
-
mutable
Creates a mutable context key- Type Parameters:
T
- The type of the context- Parameters:
key
- The key to identify the contextclazz
- The type of the context- Returns:
- The context key
-
mutable
public static <T> ContextKey<T> mutable(net.minecraft.resources.ResourceLocation key, Class<T> clazz) Creates a mutable context key- Type Parameters:
T
- The type of the context- Parameters:
key
- The key to identify the contextclazz
- The type of the context- Returns:
- The context key
-
mutable
@SafeVarargs public static <T> ContextKey<T> mutable(String key, Class<T> clazz, ContextPlaceholder<T>... placeholders) Creates a mutable context key- Type Parameters:
T
- The type of the context- Parameters:
key
- The key to identify the contextclazz
- The type of the contextplaceholders
- The placeholders that can be used in the context- Returns:
- The context key
-
mutable
@SafeVarargs public static <T> ContextKey<T> mutable(net.minecraft.resources.ResourceLocation key, Class<T> clazz, ContextPlaceholder<T>... placeholders) Creates a mutable context key- Type Parameters:
T
- The type of the context- Parameters:
key
- The key to identify the contextclazz
- The type of the contextplaceholders
- The placeholders that can be used in the context- Returns:
- The context key
-
immutable
Creates an immutable context key- Type Parameters:
T
- The type of the context- Parameters:
key
- The key to identify the contextclazz
- The type of the context- Returns:
- The context key
-
immutable
public static <T> ContextKey<T> immutable(net.minecraft.resources.ResourceLocation key, Class<T> clazz) Creates an immutable context key- Type Parameters:
T
- The type of the context- Parameters:
key
- The key to identify the contextclazz
- The type of the context- Returns:
- The context key
-
immutable
@SafeVarargs public static <T> ContextKey<T> immutable(String key, Class<T> clazz, ContextPlaceholder<T>... placeholders) Creates an immutable context key- Type Parameters:
T
- The type of the context- Parameters:
key
- The key to identify the contextclazz
- The type of the contextplaceholders
- The placeholders that can be used in the context- Returns:
- The context key
-
immutable
@SafeVarargs public static <T> ContextKey<T> immutable(net.minecraft.resources.ResourceLocation key, Class<T> clazz, ContextPlaceholder<T>... placeholders) Creates an immutable context key- Type Parameters:
T
- The type of the context- Parameters:
key
- The key to identify the contextclazz
- The type of the contextplaceholders
- The placeholders that can be used in the context- Returns:
- The context key
-
immutable
public static <T> ContextKey<T> immutable(net.minecraft.resources.ResourceLocation key, Class<T> clazz, List<ContextPlaceholder<T>> placeholders) Creates an immutable context key- Type Parameters:
T
- The type of the context- Parameters:
key
- The key to identify the contextclazz
- The type of the contextplaceholders
- The placeholders that can be used in the context- Returns:
- The context key
-
replace
Replaces the placeholders in the text- Parameters:
originalText
- The text to replace- Returns:
- The text with the placeholders replaced
-
register
public void register(net.neoforged.neoforge.registries.RegisterEvent.RegisterHelper<ContextKey<?>> registerHelper) Registers the context key to the registry
Call this from insideRegisterEvent
- Parameters:
registerHelper
- The register helper
-
equals
Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared withObjects::equals(Object,Object)
; primitive components are compared with '=='. -
hashCode
public int hashCode()Returns a hash code value for this object. The value is derived from the hash code of each of the record components. -
toString
Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components. -
key
public net.minecraft.resources.ResourceLocation key()Returns the value of thekey
record component.- Returns:
- the value of the
key
record component
-
clazz
Returns the value of theclazz
record component.- Returns:
- the value of the
clazz
record component
-
placeholders
Returns the value of theplaceholders
record component.- Returns:
- the value of the
placeholders
record component
-
immutable
public boolean immutable()Returns the value of theimmutable
record component.- Returns:
- the value of the
immutable
record component
-