Package com.pixelmonmod.pixelmon.api.context

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 key
clazz - The type being stored
codec - The codec to serialize and deserialize the context value(s)
placeholders - The placeholders that can be used in the context
public record ContextKey<A>(net.minecraft.resources.ResourceLocation key, Class<A> clazz, com.mojang.serialization.Codec<A> codec, List<ContextPlaceholder<A>> placeholders, boolean immutable) extends Record
A key for the interaction context

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final com.mojang.serialization.Codec<ContextKey<?>>
    CODEC
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    ContextKey(net.minecraft.resources.ResourceLocation key, Class<A> clazz, com.mojang.serialization.Codec<A> codec, List<ContextPlaceholder<A>> placeholders, boolean immutable)
    The constructor for the context key.

  • Method Summary

    Modifier and Type
    Method
    Description
    Class<A>
    clazz()
    Returns the value of the clazz record component.
    com.mojang.serialization.Codec<A>
    codec()
    Returns the value of the codec record component.
    boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    int
    hashCode()
    Returns a hash code value for this object.
    boolean
    immutable()
    Returns the value of the immutable record component.
    static <T> ContextKey<T>
    immutable(String key, Class<T> clazz, com.mojang.serialization.Codec<T> codec)
    Creates an immutable context key
    static <T> ContextKey<T>
    immutable(String key, Class<T> clazz, com.mojang.serialization.Codec<T> codec, ContextPlaceholder<T>... placeholders)
    Creates an immutable context key
    static <T> ContextKey<T>
    immutable(net.minecraft.resources.ResourceLocation key, Class<T> clazz, com.mojang.serialization.Codec<T> codec)
    Creates an immutable context key
    static <T> ContextKey<T>
    immutable(net.minecraft.resources.ResourceLocation key, Class<T> clazz, com.mojang.serialization.Codec<T> codec, ContextPlaceholder<T>... placeholders)
    Creates an immutable context key
    static <T> ContextKey<T>
    immutable(net.minecraft.resources.ResourceLocation key, Class<T> clazz, com.mojang.serialization.Codec<T> codec, List<ContextPlaceholder<T>> placeholders)
    Creates an immutable context key
    net.minecraft.resources.ResourceLocation
    key()
    Returns the value of the key record component.
    static <T> ContextKey<T>
    mutable(String key, Class<T> clazz)
    Creates a mutable context key
    static <T> ContextKey<T>
    mutable(String key, Class<T> clazz, ContextPlaceholder<T>... placeholders)
    Creates a mutable context key
    static <T> ContextKey<T>
    mutable(net.minecraft.resources.ResourceLocation key, Class<T> clazz)
    Creates a mutable context key
    static <T> ContextKey<T>
    mutable(net.minecraft.resources.ResourceLocation key, Class<T> clazz, ContextPlaceholder<T>... placeholders)
    Creates a mutable context key
    List<ContextPlaceholder<A>>
    placeholders()
    Returns the value of the placeholders record component.
    void
    register(net.neoforged.neoforge.registries.RegisterEvent.RegisterHelper<ContextKey<?>> registerHelper)
    Registers the context key to the registry
    Call this from inside RegisterEvent
    String
    replace(A value, String originalText)
    Replaces the placeholders in the text
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Field Details

    • CODEC

      public static final com.mojang.serialization.Codec<ContextKey<?>> CODEC

  • Constructor Details

    • ContextKey

      public ContextKey(net.minecraft.resources.ResourceLocation key, Class<A> clazz, com.mojang.serialization.Codec<A> codec, List<ContextPlaceholder<A>> placeholders, boolean immutable)
      The constructor for the context key.

      DO NOT USE THIS.


      Use mutable(String, Class) or
      invalid reference 
      #immutable(String, Class)
      instead.
      Parameters:
      key - The key to identify the context
      clazz - The type of the context
      codec - The codec to serialize and deserialize the context value(s)
      placeholders - The placeholders that can be used in the context
      immutable - Whether the context key is immutable or not

  • Method Details

    • mutable

      public static <T> ContextKey<T> mutable(String key, Class<T> clazz)
      Creates a mutable context key
      Type Parameters:
      T - The type of the context
      Parameters:
      key - The key to identify the context
      clazz - 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 context
      clazz - 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 context
      clazz - The type of the context
      placeholders - 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 context
      clazz - The type of the context
      placeholders - The placeholders that can be used in the context
      Returns:
      The context key

    • immutable

      public static <T> ContextKey<T> immutable(String key, Class<T> clazz, com.mojang.serialization.Codec<T> codec)
      Creates an immutable context key
      Type Parameters:
      T - The type of the context
      Parameters:
      key - The key to identify the context
      clazz - The type of the context
      Returns:
      The context key

    • immutable

      public static <T> ContextKey<T> immutable(net.minecraft.resources.ResourceLocation key, Class<T> clazz, com.mojang.serialization.Codec<T> codec)
      Creates an immutable context key
      Type Parameters:
      T - The type of the context
      Parameters:
      key - The key to identify the context
      clazz - The type of the context
      Returns:
      The context key

    • immutable

      @SafeVarargs public static <T> ContextKey<T> immutable(String key, Class<T> clazz, com.mojang.serialization.Codec<T> codec, ContextPlaceholder<T>... placeholders)
      Creates an immutable context key
      Type Parameters:
      T - The type of the context
      Parameters:
      key - The key to identify the context
      clazz - The type of the context
      placeholders - 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, com.mojang.serialization.Codec<T> codec, ContextPlaceholder<T>... placeholders)
      Creates an immutable context key
      Type Parameters:
      T - The type of the context
      Parameters:
      key - The key to identify the context
      clazz - The type of the context
      placeholders - 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, com.mojang.serialization.Codec<T> codec, List<ContextPlaceholder<T>> placeholders)
      Creates an immutable context key
      Type Parameters:
      T - The type of the context
      Parameters:
      key - The key to identify the context
      clazz - The type of the context
      placeholders - The placeholders that can be used in the context
      Returns:
      The context key

    • replace

      public String replace(A value, String originalText)
      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 inside RegisterEvent
      Parameters:
      registerHelper - The register helper

    • equals

      public boolean equals(Object o)
      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 with Objects::equals(Object,Object); primitive components are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • 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.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • toString

      public final String 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.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • key

      public net.minecraft.resources.ResourceLocation key()
      Returns the value of the key record component.
      Returns:
      the value of the key record component

    • clazz

      public Class<A> clazz()
      Returns the value of the clazz record component.
      Returns:
      the value of the clazz record component

    • codec

      public com.mojang.serialization.Codec<A> codec()
      Returns the value of the codec record component.
      Returns:
      the value of the codec record component

    • placeholders

      public List<ContextPlaceholder<A>> placeholders()
      Returns the value of the placeholders record component.
      Returns:
      the value of the placeholders record component

    • immutable

      public boolean immutable()
      Returns the value of the immutable record component.
      Returns:
      the value of the immutable record component