Record Class GoggleComponent

java.lang.Object
java.lang.Record
com.cake.azimuth.goggle.component.GoggleComponent
Record Components:
modId - owning mod id for generated keys
keySuffix - key suffix under tooltip namespace
defaultEnglish - optional default english string for datagen
absoluteTranslationKey - optional fully-qualified translation key override

public record GoggleComponent(String modId, String keySuffix, @Nullable String defaultEnglish, @Nullable String absoluteTranslationKey) extends Record
A reusable tooltip component reference.
  • Constructor Details

    • GoggleComponent

      public GoggleComponent(String modId, String keySuffix, @Nullable @Nullable String defaultEnglish, @Nullable @Nullable String absoluteTranslationKey)
      Creates an instance of a GoggleComponent record class.
      Parameters:
      modId - the value for the modId record component
      keySuffix - the value for the keySuffix record component
      defaultEnglish - the value for the defaultEnglish record component
      absoluteTranslationKey - the value for the absoluteTranslationKey record component
  • Method Details

    • scoped

      public static GoggleComponent scoped(String modId, String keySuffix, @Nullable @Nullable String defaultEnglish)
    • absolute

      public static GoggleComponent absolute(String absoluteTranslationKey)
    • fullTranslationKey

      public String fullTranslationKey()
    • 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
    • hashCode

      public final 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
    • equals

      public final 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. All components in this record class are compared with Objects::equals(Object,Object).
      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.
    • modId

      public String modId()
      Returns the value of the modId record component.
      Returns:
      the value of the modId record component
    • keySuffix

      public String keySuffix()
      Returns the value of the keySuffix record component.
      Returns:
      the value of the keySuffix record component
    • defaultEnglish

      @Nullable public @Nullable String defaultEnglish()
      Returns the value of the defaultEnglish record component.
      Returns:
      the value of the defaultEnglish record component
    • absoluteTranslationKey

      @Nullable public @Nullable String absoluteTranslationKey()
      Returns the value of the absoluteTranslationKey record component.
      Returns:
      the value of the absoluteTranslationKey record component