AutoTweaker API/io.github.autotweaker.api.config/SettingDef

SettingDef

interface SettingDef<out V : SettingValue<*>>(source)

实现此接口并打上 @AutoService(SettingDef::class) 注释即可注册一个设置。

使用 io.github.autotweaker.api.base.IntSetting 等基类可以省去一些声明设置的重复代码。

通过 io.github.autotweaker.api.adapter.CoreAPI.ConfigAPI 可管理所有设置。

AutoTweaker 通过 SPI 和 SettingService 来实现分布式的设置声明以及安全的取值。

See also

Inheritors

Properties

abstract val default: V

设置的默认值。

abstract val description: Localizations

设置的多语言描述，由 i18n 服务管理，也同样支持自动翻译。

Functions

fun SettingDef<SettingValue.ValString>.format(vararg args: Any?): String

获取一个字符串 SettingDef 的当前值，并通过 java.lang.String.format 填充字符串占位符。

fun <V : SettingValue<T>, T> SettingDef<V>.get(): T

对一个 SettingDef 调用 get 可以直接从数据库拿到当前配置值。

fun <V : SettingValue<T>, T> SettingDef<V>.set(value: T)

对一个 SettingDef 调用 set 可以更新配置值。