Package org.samo_lego.config2brigadier.common.annotation

Annotation Interface BrigadierDescription

@Retention(RUNTIME) @Target(FIELD) public @interface BrigadierDescription
Adds description to the option, which is seen if user executes the config edit command but doesn't provide a value.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    defaultOption
    Default option / value for the field.
    String
    value
    Description for the field.

  • Element Details

    • value

      String value
      Description for the field.
      Returns:
      description of field that will be shown in-game.
      Default:
      ""

    • defaultOption

      String defaultOption
      Default option / value for the field.
      Returns:
      the default field value (the one after config object is generated).
      Default:
      ""