Configuration

Configurationについて

Configurationとは、Mod上でコンフィグを生成するのに必須なAPIである。

コンストラクタ

メソッド名	public Configuration(File file)
概要	fileのファイル名のcfgファイルが、configフォルダに生成される。
補足	Modの初期化関数内で、読み込みと保存を行う必要がある。詳しくはConfigファイル作成方法(Forge)を参照。 また、バージョンやカテゴリの使用についての引数があるコンストラクタもある。

非staticメソッド

メソッド名	public Property getInt(String category, String key, int defaultValue)
概要	categoryには、このクラス内のカテゴリの文字列を、keyは取得する際のキー、defaultValueに初期値を渡すことで、コンフィグに要素が追加される。
補足	第4引数にコメントを、第5、6引数に配列に関する情報を指定できる。普通は値の取得にこちらを使う。

メソッド名	public String getString(String category, String key, String defaultValue)
概要	categoryには、このクラス内のカテゴリの文字列を、keyは取得する際のキー、defaultValueに初期値を渡すことで、コンフィグに要素が追加される。
補足	第4引数にコメントを、第5、6引数に配列に関する情報を指定できる。

メソッド名	public Property get(String category, String key, <型名> defaultValue)
概要	categoryには、このクラス内のカテゴリの文字列を、keyは取得する際のキー、defaultValueに初期値を渡すことで、コンフィグに要素が追加される。
補足	第4引数にコメントを、第5、6引数に配列に関する情報を指定できる。

メソッド名	public String[] getStringList(String category, String key, String[] defaultValue)
概要	categoryには、このクラス内のカテゴリの文字列を、keyは取得する際のキー、defaultValueに初期値を渡すことで、コンフィグに要素が追加される。
補足	第4引数にコメントを、第5、6引数に配列に関する情報を指定できる。

メソッド名	public Boolean getBoolean(String category, String key, Boolean defaultValue)
概要	categoryには、このクラス内のカテゴリの文字列を、keyは取得する際のキー、defaultValueに初期値を渡すことで、コンフィグに要素が追加される。
補足	第4引数にコメントを、第5、6引数に配列に関する情報を指定できる。

メソッド名	public Float getFloat(String category, String key, Float defaultValue)
概要	categoryには、このクラス内のカテゴリの文字列を、keyは取得する際のキー、defaultValueに初期値を渡すことで、コンフィグに要素が追加される。
補足	第4引数にコメントを、第5、6引数に配列に関する情報を指定できる。

メソッド名	public void save()
概要	追加した要素をcfgファイルに保存します。必ず、下記のload()とセットで使う必要があります。
補足

メソッド名	public void load()
概要	cfgファイルの内容を、読み込みます。必ず、上記のsave()とセットで使う必要があります。
補足