ktConfig/dev.s7a.ktconfig/ktConfigFile

ktConfigFile

inline fun <T : Any> ktConfigFile(file: File): T?

Load config from file.

Return

Config data or null

Since

1.0.0

Parameters

file

Yaml file

T

Config type

Throws

inline fun <T : Any> ktConfigFile(plugin: JavaPlugin, path: String): T?

Load config from JavaPlugin.dataFolder/path.

Return

Config data or null

Since

1.0.0

Parameters

plugin

JavaPlugin

path

File path in plugin data folder

T

Config type

Throws

@JvmName(name = "ktConfigFile_")
inline fun <T : Any> JavaPlugin.ktConfigFile(path: String): T?

Load config from JavaPlugin.dataFolder/path.

Receiver

JavaPlugin

Return

Config data or null

Since

1.0.0

Parameters

path

File path in plugin data folder

T

Config type

Throws

inline fun <T : Any> ktConfigFile(file: File, noinline default: () -> T): T
inline fun <T : Any> ktConfigFile(file: File, default: T): T

Load config from file. If file doesn't exist or is empty, save default.

Return

Config data or default

Since

1.0.0

Parameters

file

Yaml file

default

Default config data

T

Config type

Throws

inline fun <T : Any> ktConfigFile(plugin: JavaPlugin, path: String, noinline default: () -> T): T

Load config from JavaPlugin.dataFolder/path. If the file doesn't exist or is empty, save default.

Receiver

JavaPlugin

Return

Config data or default

Since

1.0.0

Parameters

plugin

JavaPlugin

path

File path in plugin data folder

default

Default config data

T

Config type

Throws

inline fun <T : Any> ktConfigFile(plugin: JavaPlugin, path: String, default: T): T

Load config from JavaPlugin.dataFolder/path. If the file doesn't exist or is empty, save default.

Return

Config data or default

Since

1.0.0

Parameters

plugin

JavaPlugin

path

File path in plugin data folder

default

Default config data

T

Config type

Throws

@JvmName(name = "ktConfigFile_")
inline fun <T : Any> JavaPlugin.ktConfigFile(path: String, noinline default: () -> T): T
@JvmName(name = "ktConfigFile_")
inline fun <T : Any> JavaPlugin.ktConfigFile(path: String, default: T): T

Load config from JavaPlugin.dataFolder/path. If the file doesn't exist or is empty, save default.

Receiver

JavaPlugin

Return

Config data or default

Since

1.0.0

Parameters

path

File path in plugin data folder

default

Default config data

T

Config type

Throws