core/com.github.spigotbasics.core.config/SavedConfig

SavedConfig

open class SavedConfig(context: ConfigInstantiationContext) : YamlConfiguration

Represents a YamlConfiguration that is backed by a file. Instances of this class should only be obtained using com.github.spigotbasics.core.module.AbstractBasicsModule.getConfig. It is fine to keep this object around and pass it around, it will automatically get updated on module reload instead of replaced.

Inheritors

CoreConfig

FixClassLoadingConfig

CoreMessages

StorageConfig

Constructors

SavedConfig

constructor(context: ConfigInstantiationContext)

Functions

addDefault

open override fun addDefault(@NotNull p0: String, @Nullable p1: Any?)

addDefaults

open override fun addDefaults(@NotNull p0: MutableMap<String, Any>)

open override fun addDefaults(@NotNull p0: Configuration)

contains

open operator override fun contains(@NotNull p0: String): Boolean

open override fun contains(@NotNull p0: String, p1: Boolean): Boolean

createSection

@NotNull

open override fun createSection(@NotNull p0: String): ConfigurationSection

@NotNull

open override fun createSection(@NotNull p0: String, @NotNull p1: MutableMap<*, *>): ConfigurationSection

get

@Nullable

open operator override fun get(@NotNull p0: String): Any?

@Contract(value = "_, !null -> !null")

@Nullable

open operator override fun get(@NotNull p0: String, @Nullable p1: Any?): Any?

getAsNewLineSeparatedString

fun MemorySection.getAsNewLineSeparatedString(key: String): String

getAsStringList

fun MemorySection.getAsStringList(key: String): List<String>

Get a list of strings, no matter if the value is a list or a single string.

getBoolean

open override fun getBoolean(@NotNull p0: String): Boolean

open override fun getBoolean(@NotNull p0: String, p1: Boolean): Boolean

getBooleanList

@NotNull

open override fun getBooleanList(@NotNull p0: String): MutableList<Boolean>

getByteList

@NotNull

open override fun getByteList(@NotNull p0: String): MutableList<Byte>

getCharacterList

@NotNull

open override fun getCharacterList(@NotNull p0: String): MutableList<Char>

getColor

@Nullable

open override fun getColor(@NotNull p0: String): Color?

@Contract(value = "_, !null -> !null")

@Nullable

open override fun getColor(@NotNull p0: String, @Nullable p1: Color?): Color?

getComments

@NotNull

open override fun getComments(@NotNull p0: String): MutableList<String>

getConfigurationSection

@Nullable

open override fun getConfigurationSection(@NotNull p0: String): ConfigurationSection?

getCurrentPath

@NotNull

open override fun getCurrentPath(): String

getDefaults

@Nullable

open override fun getDefaults(): Configuration?

getDefaultSection

@Nullable

open override fun getDefaultSection(): ConfigurationSection?

getDouble

open override fun getDouble(@NotNull p0: String): Double

open override fun getDouble(@NotNull p0: String, p1: Double): Double

getDoubleList

@NotNull

open override fun getDoubleList(@NotNull p0: String): MutableList<Double>

getDurationAsMillis

fun MemorySection.getDurationAsMillis(key: String, defaultValue: Long): Long

getDurationAsTicks

fun MemorySection.getDurationAsTicks(key: String, defaultValue: Long): Long

getFloatList

@NotNull

open override fun getFloatList(@NotNull p0: String): MutableList<Float>

getInlineComments

@NotNull

open override fun getInlineComments(@NotNull p0: String): MutableList<String>

getInt

open override fun getInt(@NotNull p0: String): Int

open override fun getInt(@NotNull p0: String, p1: Int): Int

getIntegerList

@NotNull

open override fun getIntegerList(@NotNull p0: String): MutableList<Int>

getItemStack

@Nullable

open override fun getItemStack(@NotNull p0: String): ItemStack?

@Contract(value = "_, !null -> !null")

@Nullable

open override fun getItemStack(@NotNull p0: String, @Nullable p1: ItemStack?): ItemStack?

getKeys

@NotNull

open override fun getKeys(p0: Boolean): MutableSet<String>

getList

@Nullable

open override fun getList(@NotNull p0: String): MutableList<*>?

@Contract(value = "_, !null -> !null")

@Nullable

open override fun getList(@NotNull p0: String, @Nullable p1: MutableList<*>?): MutableList<*>?

getLocation

@Nullable

open override fun getLocation(@NotNull p0: String): Location?

@Contract(value = "_, !null -> !null")

@Nullable

open override fun getLocation(@NotNull p0: String, @Nullable p1: Location?): Location?

getLong

open override fun getLong(@NotNull p0: String): Long

open override fun getLong(@NotNull p0: String, p1: Long): Long

getLongList

@NotNull

open override fun getLongList(@NotNull p0: String): MutableList<Long>

getMapList

@NotNull

open override fun getMapList(@NotNull p0: String): MutableList<MutableMap<*, *>>

getMessage

fun getMessage(path: String): Message

Get a Message from the config. Messages can be declared as simple String (one line), a list of Strings (multiple lines) or an empty list (disabled message):

getName

@NotNull

open override fun getName(): String

getObject

@Nullable