CustomConfig

class CustomConfig

コンフィグを操作するクラス

Since

1.3.0

Parameters

plugin

コンフィグがあるプラグイン

output

メッセージの出力先

file

コンフィグファイル

default

デフォルト設定

Functions

contains

fun contains(path: String): Boolean

存在するコンフィグパスかを取得する。

delete

fun delete()

ファイルを削除する。

formatMismatchError

fun formatMismatchError(path: String)

Format: "フォーマットを間違っています"

get

fun <T> get(path: String, type: ConfigDataType<T>, notFoundError: Boolean = true): T?

ConfigDataType を使って値の取得をする。

fun <T> get(path: String, type: ConfigDataType<T>, default: T, notFoundError: Boolean = true): T

ConfigDataType を使って値の取得をするが、存在しない場合はデフォルトの値を利用する。

getListUnsafe

inline fun <T> getListUnsafe(path: String, typeName: String, notFoundError: Boolean = true): List<T>

YamlConfiguration.getList を使って値の取得をする。取得できない可能性がある。

getUnsafe

inline fun <T> getUnsafe(path: String, typeName: String, notFoundError: Boolean): T?

YamlConfiguration.get を使って値の取得をする。取得できない可能性がある。

notFoundError

fun notFoundError(path: String)

Format: "見つかりませんでした"

nullError

fun nullError(path: String, thing: String)

Format: "$thing が null です"

reload

fun reload()

コンフィグファイルの再読み込みを行う。

rename

fun rename(newName: String): Boolean

ファイルの名前を変更する。

save

fun save()

ファイルの変更を保存する。

section

fun section(path: String, notFoundError: Boolean = true): Set<String>?

セクションを取得する。

fun <T> section(path: String, type: ConfigSectionType<T>, notFoundError: Boolean = true): List<T>?

セクションを取得し、ConfigSectionType で任意の型に変換する。

sendError

fun sendError(path: String, message: String)

エラーを出力する。

Format: "&6[$filePath|$path] &c$message"

sendMessage

fun sendMessage(path: String, message: String)

メッセージを出力する。

Format: "&6[$filePath|$path] &f$message"

set

fun <T> set(path: String, type: ConfigDataType<T>, value: T?, save: Boolean = false)

ConfigDataType を使って値の変更をする。

setNull

fun setNull(path: String, save: Boolean = false)

コンフィグから値を削除する。

setUnsafe

fun setUnsafe(path: String, value: Any?, save: Boolean = false)

YamlConfiguration.set を使って値の変更をする。変更できない可能性がある。

typeMismatchError

fun typeMismatchError(path: String, typeName: String)

Format: "データタイプが $typeName ではありませんでした"

Properties

config

var config: YamlConfiguration

YamlConfiguration のインスタンス。

file

val file: File

コンフィグファイル

filePath

val filePath: String

コンフィグファイルの相対パス。

plugin

val plugin: JavaPlugin

コンフィグがあるプラグイン