程序包 pers.saikel0rado1iu.silk.util.config

类 ConfigData

java.lang.Object
pers.saikel0rado1iu.silk.util.config.ConfigData
@SilkApi public final class ConfigData extends Object

用于创建模组配置数据

从以下版本开始:
0.1.0

  • 字段详细资料

    • CONFIG_PATH

      public static final Path CONFIG_PATH

    • CHARSET

      public static final Charset CHARSET

  • 方法详细资料

    • builder

      @SilkApi public static ConfigData.Builder builder(@NotNull @NotNull ModBasicData mod)
      创建一个 ModBasicData 模组的空配置

    • builder

      @SilkApi public static ConfigData.Builder builder(@NotNull @NotNull ConfigData defaults)
      使用 ConfigData 作为原始配置创建一份配置副本

    • addSwitch

      @SilkApi public ConfigData addSwitch(String id, Boolean defaultValue)
      添加一个开关配置，只能储存开或关
      参数:
      id - 配置 ID
      defaultValue - 默认值
      返回:
      返回自身以便可以连续添加配置

    • addOption

      @SilkApi public ConfigData addOption(String id, Enum<?> defaultValue)
      添加一个选项配置，用于保存有多个状态的配置
      参数:
      id - 配置 ID
      defaultValue - 默认值
      返回:
      返回自身以便可以连续添加配置

    • getMainConfig

      @SilkApi public ConfigData getMainConfig()
      获取主配置用于读取或保存

    • addIntSlider

      @SilkApi public ConfigData addIntSlider(String id, Integer minValue, Integer maxValue, Integer defaultValue)
      添加一个整数滑块配置，用于保存一个有范围的整数配置
      参数:
      id - 配置 ID
      minValue - 可配置的最小值
      maxValue - 可配置的最大值
      defaultValue - 默认值
      返回:
      返回自身以便可以连续添加配置

    • addFloatSlider

      @SilkApi public ConfigData addFloatSlider(String id, Float minValue, Float maxValue, Float defaultValue)
      添加一个浮点数滑块配置，用于保存一个有范围的浮点数配置
      参数:
      id - 配置 ID
      minValue - 可配置的最小值
      maxValue - 可配置的最大值
      defaultValue - 默认值
      返回:
      返回自身以便可以连续添加配置

    • addSubConfigs

      @SilkApi public ConfigData addSubConfigs(String id, ConfigData subConfigs)
      添加一个子配置组，用于保存作为一个配置的子配置组
      参数:
      id - 配置 ID
      subConfigs - 子配置组
      返回:
      返回自身以便可以连续添加配置

    • setConfig

      @SilkApi public void setConfig(String id, Object value)
      设置已保存配置数据的值，但不能设置子配置的值
      参数:
      id - 配置 ID
      value - 配置值

    • getConfig

      @SilkApi public <O> O getConfig(String id, Class<O> c)
      获取已添加的配置，返回 ConfigData 以便可保持通用
      类型参数:
      O - 转换出的类类型
      参数:
      id - 配置 ID
      c - 将要转换的类
      返回:
      如果返回 Optional.empty() 则表明获取数值失败

    • reader

      @SilkApi public ConfigReader reader()
      返回:
      配置读取器

    • writer

      @SilkApi public ConfigWriter writer()
      返回:
      配置写入器

    • getType

      @SilkApi public ConfigData.Type getType()
      返回:
      配置类型