Annotation Interface TmxPropertyInfo

@Target(FIELD) @Retention(RUNTIME) public @interface TmxPropertyInfo
Provides rich metadata for a TMX map object property, including canonical English documentation, category grouping, value type, default values, and translation keys for localization.

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    name
    The property name key as stored in TMX map objects.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    category
    Category or group name for organizing properties in inspectors and docs (e.g. "Combat", "Collision", "Graphics").
    String
    defaultValue
    Default value representation string.
    String
    description
    Canonical English description of the property for documentation and tooltips.
    String
    resourceKey
    Localization resource key for translated descriptions.
    String
    type
    Expected value type (e.g. "string", "int", "float", "boolean", "color", "enum").

  • Element Details

    • name

      String name
      The property name key as stored in TMX map objects.
      Returns:
      The TMX property key name.

    • description

      String description
      Canonical English description of the property for documentation and tooltips.
      Returns:
      The English description.
      Default:
      ""

    • category

      String category
      Category or group name for organizing properties in inspectors and docs (e.g. "Combat", "Collision", "Graphics").
      Returns:
      The property category.
      Default:
      "General"

    • type

      String type
      Expected value type (e.g. "string", "int", "float", "boolean", "color", "enum").
      Returns:
      The value type string.
      Default:
      "string"

    • defaultValue

      String defaultValue
      Default value representation string.
      Returns:
      The default value string.
      Default:
      ""

    • resourceKey

      String resourceKey
      Localization resource key for translated descriptions.
      Returns:
      The resource key.
      Default:
      ""