EffectiveSpigot/ru.hukm.effectiveSpigot.config/EffectiveConfig

EffectiveConfig

abstract class EffectiveConfig

Base class for a plugin's YAML config.

A subclass names its owning plugin (getInstance) and file (getFileName). init copies the bundled default resource on first run and loads it; call it once before reading any values (from onLoad or onEnable — both work, since dataFolder/saveResource are available by then). Typed getters wrap FileConfiguration, and set writes through to disk immediately.

object ExampleConfig : EffectiveConfig() {
    override fun getInstance() = ExamplePlugin.instance
    override fun getFileName() = "config.yml"
    fun getSpawnRadius() = getInt("spawn-radius", 10)
}

Constructors

EffectiveConfig

constructor()

Properties

lateinit var config: FileConfiguration

The loaded configuration; valid after init.

Functions

fun contains(path: String): Boolean

Whether path exists in the config.

fun get(path: String): Any?

Raw value at path, or null if absent.

fun getBoolean(path: String, def: Boolean = false): Boolean

Boolean at path, or def if absent.

fun getBooleanList(path: String): List<Boolean>

Boolean list at path (empty if absent).

getConfigurationSection

fun getConfigurationSection(path: String): ConfigurationSection?

Configuration section at path, or null if absent.

fun getDouble(path: String, def: Double = 0.0): Double

Double at path, or def if absent.

fun getDoubleList(path: String): List<Double>

Double list at path (empty if absent).

abstract fun getFileName(): String

Config file name inside the plugin's data folder, e.g. "config.yml".

abstract fun getInstance(): JavaPlugin

The plugin that owns this config (used for data folder and bundled resource).

fun getInt(path: String, def: Int = 0): Int

Int at path, or def if absent.

fun getIntegerList(path: String): List<Int>

Int list at path (empty if absent).

fun getList(path: String): List<*>?

Raw list at path, or null if absent.

fun getLong(path: String, def: Long = 0): Long

Long at path, or def if absent.

fun getLongList(path: String): List<Long>

Long list at path (empty if absent).

fun getString(path: String, def: String? = null): String?

String at path, or def if absent.

fun getStringList(path: String): List<String>

String list at path (empty if absent).

fun init()

Copies the bundled default (if missing) and loads the config file. Call once before reading values.

fun set(path: String, value: Any?)

Sets path to value and saves the file immediately.