Package org.cyclops.cyclopscore.config

Annotation Interface ConfigurableProperty

@Deprecated @Retention(RUNTIME) @Target(FIELD) public @interface ConfigurableProperty
Deprecated.
Property inside configs that can be configured in the config file.

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    category
    Deprecated.
    The category of the field.
    String
    comment
    Deprecated.
    The comment for the field in the config file.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    net.neoforged.fml.config.ModConfig.Type
    configLocation
    Deprecated.
     
    boolean
    isCommandable
    Deprecated.
    Whether or not this field can be changed with commands at runtime.
    int
    maximalValue
    Deprecated.
    The maximal value of the field, as a integer.
    int
    minimalValue
    Deprecated.
    The minimal value of the field, as a integer.
    String
    namedId
    Deprecated.
    Override the named id if multiple instances of a given config class exists.
    boolean
    requiresMcRestart
    Deprecated.
     
    boolean
    requiresWorldRestart
    Deprecated.
     
    boolean
    showInGui
    Deprecated.
     

  • Element Details

    • namedId

      String namedId
      Deprecated.
      Override the named id if multiple instances of a given config class exists.
      Returns:
      A custom named id to place this property under. If empty, then the named id of the hosting config will be used.
      Default:
      ""

    • category

      String category
      Deprecated.
      The category of the field.
      Returns:
      The category.

    • comment

      String comment
      Deprecated.
      The comment for the field in the config file.
      Returns:
      The comment.

    • isCommandable

      boolean isCommandable
      Deprecated.
      Whether or not this field can be changed with commands at runtime.
      Returns:
      If it is commandable.
      Default:
      false

    • requiresWorldRestart

      boolean requiresWorldRestart
      Deprecated.
      Returns:
      If this configurable requires worlds to regenerate.
      Default:
      false

    • requiresMcRestart

      boolean requiresMcRestart
      Deprecated.
      Returns:
      If this configurable requires minecraft to restart.
      Default:
      false

    • showInGui

      boolean showInGui
      Deprecated.
      Returns:
      If this configurable will be shown in the gui.
      Default:
      true

    • minimalValue

      int minimalValue
      Deprecated.
      The minimal value of the field, as a integer.
      Returns:
      The minimal value.
      Default:
      -2147483648

    • maximalValue

      int maximalValue
      Deprecated.
      The maximal value of the field, as a integer.
      Returns:
      The maximal value.
      Default:
      2147483647

    • configLocation

      net.neoforged.fml.config.ModConfig.Type configLocation
      Deprecated.
      Returns:
      The location of this config property.
      Default:
      COMMON