Record Class TmxPropertyMetadataRegistry.PropertyMetadata

java.lang.Object
java.lang.Record
de.gurkenlabs.litiengine.environment.tilemap.TmxPropertyMetadataRegistry.PropertyMetadata
Record Components:
name - The serialized property name.
description - The canonical English description.
category - The editor grouping.
type - The serialized value type.
defaultValue - The default represented as text.
resourceKey - The optional localization key.
Enclosing class:
TmxPropertyMetadataRegistry
public static record TmxPropertyMetadataRegistry.PropertyMetadata(String name, String description, String category, String type, String defaultValue, String resourceKey) extends Record
Documentation and serialization metadata for one TMX property.

  • Constructor Details

    • PropertyMetadata

      public PropertyMetadata(String name, String description, String category, String type, String defaultValue, String resourceKey)
      Creates an instance of a PropertyMetadata record class.
      Parameters:
      name - the value for the name record component
      description - the value for the description record component
      category - the value for the category record component
      type - the value for the type record component
      defaultValue - the value for the defaultValue record component
      resourceKey - the value for the resourceKey record component

  • Method Details

    • getTranslatedDescription

      public String getTranslatedDescription()
      Gets the localized description if a resource key translation is available, falling back to the canonical English description.
      Returns:
      The localized or canonical description.

    • 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.

    • name

      public String name()
      Returns the value of the name record component.
      Returns:
      the value of the name record component

    • description

      public String description()
      Returns the value of the description record component.
      Returns:
      the value of the description record component

    • category

      public String category()
      Returns the value of the category record component.
      Returns:
      the value of the category record component

    • type

      public String type()
      Returns the value of the type record component.
      Returns:
      the value of the type record component

    • defaultValue

      public String defaultValue()
      Returns the value of the defaultValue record component.
      Returns:
      the value of the defaultValue record component

    • resourceKey

      public String resourceKey()
      Returns the value of the resourceKey record component.
      Returns:
      the value of the resourceKey record component