surf-api-core-api/dev.slne.surf.surfapi.core.api.config/SurfConfigApi

SurfConfigApi

API for managing configuration files in the Surf API, supporting both Sponge and DazzlConf configurations. Provides methods to create, retrieve, and reload configuration files in various formats (YAML, JSON).

Types

Companion

object Companion

Functions

createDazzlConfig

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

Creates a DazzlConf configuration file.

createDazzlConfig

inline fun <C> SurfConfigApi.createDazzlConfig(configFolder: Path, configFileName: @YamlConfigFileNamePattern String): C

Creates a DazzlConf configuration using a reified type.

createSpongeJsonConfig

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

Creates a Sponge JSON configuration file.

createSpongeJsonConfig

inline fun <C> SurfConfigApi.createSpongeJsonConfig(configFolder: Path, configFileName: @JsonConfigFileNamePattern String): C

Creates a Sponge JSON configuration using a reified type.

createSpongeYmlConfig

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

Creates a Sponge YAML configuration file.

createSpongeYmlConfig

inline fun <C> SurfConfigApi.createSpongeYmlConfig(configFolder: Path, configFileName: @YamlConfigFileNamePattern String): C

Creates a Sponge YAML configuration using a reified type.

getDazzlConfig

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

Retrieves a DazzlConf configuration.

getDazzlConfig

inline fun <C> SurfConfigApi.getDazzlConfig(): C

Retrieves a DazzlConf configuration using a reified type.

getSpongeConfig

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

Retrieves a Sponge configuration.

getSpongeConfig

inline fun <C> SurfConfigApi.getSpongeConfig(): C

Retrieves a Sponge configuration using a reified type.

getSpongeConfigManagerForConfig

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

Retrieves the SpongeConfigManager for a specific configuration class.

reloadDazzlConfig

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

Reloads a DazzlConf configuration from the file.

reloadDazzlConfig

inline fun <C> SurfConfigApi.reloadDazzlConfig(): C

Reloads a DazzlConf configuration using a reified type.

reloadSpongeConfig

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

Reloads a Sponge configuration from the file.