settings-core/io.github.mlmgames.settings.core.annotations/Setting

Setting

@Target(allowedTargets = [AnnotationTarget.PROPERTY])

annotation class Setting(val title: String = "", val description: String = "", val category: KClass<*>, val type: KClass<*> = Toggle::class, val key: String = "", val dependsOn: String = "", val titleRes: Int = 0, val descriptionRes: Int = 0, val min: Float = 0.0f, val max: Float = 100.0f, val step: Float = 1.0f, val options: Array<String> = [], val optionsRes: Int = 0, val platforms: Array<SettingPlatform> = [SettingPlatform.ALL])

Marks a property as a UI-visible setting.

Usage:

@Setting(
    title = "Dark Mode",
    category = Appearance::class,
    type = Toggle::class
)
val darkMode: Boolean = false

Properties

val category: KClass<*>

Category object class (must have @CategoryDefinition)

val dependsOn: String

Property name this setting depends on. Setting is disabled when dependency is false.

val description: String

Optional description

val descriptionRes: Int = 0

String resource ID for localized description

val key: String

Stable persistence key. If empty, defaults to snake_case of property name.

val max: Float = 100.0f

val min: Float = 0.0f

val options: Array<String>

val optionsRes: Int = 0

Resource array for localized dropdown options

val platforms: Array<SettingPlatform>

Platforms where this setting should be visible. Empty = ALL platforms.

val step: Float = 1.0f

val title: String

Display title

val titleRes: Int = 0

String resource ID for localized title

val type: KClass<*>

UI type object class (Toggle, Slider, Dropdown, Button, or custom)