Config Api

Die SurfConfigApi ist die zentrale Schnittstelle zur Verwaltung von Konfigurationsdateien innerhalb der Surf API. Sie unterstützt zwei Systeme:

• Sponge Configs (YAML & JSON)

• DazzlConf Configs

---

Unterstützte Formate:

• .yml / .yaml

• .json

---

DazzlConf-Konfigurationen

Konfiguration erstellen

fun <C> createDazzlConfig(
    configClass: Class<C>,
    configFolder: Path,
    configFileName: String
): C

Parameter	Beschreibung
configClass	Ziel-Config-Klasse
configFolder	Pfad zum Config-Verzeichnis
configFileName	YAML-Dateiname (*.yml/*.yaml)

---

Konfiguration abrufen

fun <C> getDazzlConfig(configClass: Class<C>): C

Konfiguration neuladen

fun <C> reloadDazzlConfig(configClass: Class<C>): C

---

Sponge-Konfigurationen

YAML erstellen

fun <C> createSpongeYmlConfig(
    configClass: Class<C>,
    configFolder: Path,
    configFileName: String
): C

JSON erstellen

fun <C> createSpongeJsonConfig(
    configClass: Class<C>,
    configFolder: Path,
    configFileName: String
): C

Abrufen

fun <C> getSpongeConfig(configClass: Class<C>): C

Neuladen

fun <C> reloadSpongeConfig(configClass: Class<C>): C

---

SpongeConfigManager abrufen

fun <C> getSpongeConfigManagerForConfig(configClass: Class<C>): SpongeConfigManager<C>

---

Reified Extensions

DazzlConf

surfConfigApi.createDazzlConfig<MyConfig>(folder, "config.yml")
surfConfigApi.getDazzlConfig<MyConfig>()
surfConfigApi.reloadDazzlConfig<MyConfig>()

Sponge (YML & JSON)

surfConfigApi.createSpongeYmlConfig<MyConfig>(folder, "config.yml")
surfConfigApi.createSpongeJsonConfig<MyConfig>(folder, "config.json")
surfConfigApi.getSpongeConfig<MyConfig>()

---

Beispiel

data class MyConfig(val enabled: Boolean = true)

val config = surfConfigApi.createSpongeYmlConfig<MyConfig>(
    configFolder = Path.of("configs"),
    configFileName = "myconfig.yml"
)

println(config.enabled)