Package org.polyfrost.oneconfig.api.config.v1.annotations

Annotation Interface File

@Retention(RUNTIME) @Target(FIELD) @Documented public @interface File

  • Element Details

    • title

      String title

    • titleTranslation

      @Deprecated boolean titleTranslation
      Deprecated.
      No longer needed. OneConfig now checks whether the given title is a translation key present in the active language, and translates it automatically when it is. Pass the translation key directly as the title and remove this flag.
      Default:
      false

    • titleKey

      @Deprecated String titleKey
      Deprecated.
      Default:
      ""

    • description

      String description
      Default:
      ""

    • descriptionTranslation

      @Deprecated boolean descriptionTranslation
      Deprecated.
      No longer needed. OneConfig now checks whether the given description is a translation key present in the active language, and translates it automatically when it is. Pass the translation key directly as the description and remove this flag.
      Default:
      false

    • descriptionKey

      @Deprecated String descriptionKey
      Deprecated.
      Default:
      ""

    • icon

      String icon
      Default:
      ""

    • types

      String[] types
      The file extensions to filter the dialog by, e.g. {".png", ".jpg"}. Entries may be written as ".png", "png" or "*.png"; they are all normalised to the *.ext form tinyfd expects. Leave empty to allow any file.
      Default:
      {}

    • filterName

      String filterName
      A human-readable description for the types() filter, e.g. "Images".
      Default:
      ""

    • directory

      boolean directory
      Select a directory instead of a file. When true, types() is ignored.
      Default:
      false

    • category

      String category
      Default:
      "General"

    • categoryKey

      @Deprecated String categoryKey
      Deprecated.
      Default:
      ""

    • categoryTranslation

      @Deprecated boolean categoryTranslation
      Deprecated.
      No longer needed. OneConfig now checks whether the given category is a translation key present in the active language, and translates it automatically when it is. Pass the translation key directly as the category and remove this flag.
      Default:
      false

    • subcategory

      String subcategory
      Default:
      "General"

    • subcategoryKey

      @Deprecated String subcategoryKey
      Deprecated.
      Default:
      ""

    • subcategoryTranslation

      @Deprecated boolean subcategoryTranslation
      Deprecated.
      translation keys will be translated by default.
      Default:
      false

    • placeholder

      @TranslatedDefault("oneconfig.filepicker.placeholder") String placeholder
      Default:
      "oneconfig.filepicker.placeholder"

    • placeholderTranslation

      @Deprecated boolean placeholderTranslation
      Deprecated.
      No longer needed. OneConfig now checks whether the given placeholder is a translation key present in the active language, and translates it automatically when it is. Pass the translation key directly as the placeholder and remove this flag.
      Default:
      false

    • placeholderKey

      @Deprecated String placeholderKey
      Deprecated.
      Default:
      ""