Setting Descriptor
SettingDescriptor has two required properties:
key,
pluginId (
PluginId).
And two optional ones:
tags (list of
SettingTag),serializer (
SettingSerializerDescriptor).
The key provided is not the final effective key. The plugin ID is automatically and implicitly prepended to it. The concept of a component name does not exist.
There is no need for you to use a special group for your plugin settings. The implicitly prepended plugin ID forms this implicit group.
Serializer
The serializer merely serves as a descriptor for what to serialize, it doesn't implement the serialization itself. The Settings Controller will determine the appropriate serialization format based on the setting tags.
Kotlin serialization is used. The setting value class must be annotated with
kotlinx.serialization.Serializable.You should always specify default values.
Tags
The implementation of a settings controller can significantly vary. Therefore, tags should be considered more as hints rather than fixed instructions.
Remote Dev
Remote Dev can introduce tag like "Merge Strategy" — merge to a client or host.
Settings Sync
Settings Sync can introduce tag "Category" — to implement selective sync.
Mutability
Mutability — we cannot enforce read-write on compile time. Mutability is not a part of option descriptor, but defined by a controller, so, changed in runtime. For example, TBE implementation of settings controller will forbid some settings, and an error will be thrown on set.
We want to throw an error on the set for transparent behavior. On a Settings UI page, such an error may be caught on the platform level.