Aliucord/com.aliucord.api/SettingsAPI

SettingsAPI

open class SettingsAPI

Constructors

SettingsAPI

constructor(plugin: String)

Creates a SettingsAPI for the specified plugin

Functions

delegate

fun <T> SettingsAPI.delegate(defaultValue: T): SettingsDelegate<T>

exists

open fun exists(key: String): Boolean

Check if Key exists in settings

getAllKeys

open fun getAllKeys(): List<String>

Gets All Keys from settings

getBool

open fun getBool(key: String, defValue: Boolean): Boolean

Reads a from the settings.

getFloat

open fun getFloat(key: String, defValue: Float): Float

Gets a stored in the settings.

getInt

open fun getInt(key: String, defValue: Int): Int

Gets an stored in the settings.

getLong

open fun getLong(key: String, defValue: Long): Long

Gets a stored in the settings.

getObject

open fun <T> getObject(key: String, defValue: T): T

open fun <T> getObject(key: String, defValue: T, type: Type): T

Gets an Object stored in the settings.

getString

open fun getString(key: String, defValue: String): String

Gets a String stored in the settings.

getUnknown

open fun getUnknown(key: String, defValue: Any): Any

Get a value of an unknown type

remove

open fun remove(key: String): Boolean

Removes Item from settings

resetSettings

open fun resetSettings(): Boolean

Resets All Settings

setBool

open fun setBool(key: String, val: Boolean)

Writes a to the settings.

setFloat

open fun setFloat(key: String, val: Float)

Writes a to the settings.

setInt

open fun setInt(key: String, val: Int)

Writes an to the settings.

setLong

open fun setLong(key: String, val: Long)

Writes a to the settings.

setObject

open fun setObject(key: String, val: Any)

Writes an Object to the settings.

setString

open fun setString(key: String, val: String)

Writes a String to the settings.

setUnknown

open fun setUnknown(key: String, value: Any)

Set a value of an unknown type

toggleBool

open fun toggleBool(key: String, defValue: Boolean): Boolean

Toggles Boolean and returns it