提供: Minecraft Modding Wiki
この編集を取り消せます。
下記の差分を確認して、本当に取り消していいか検証してください。よろしければ変更を保存して取り消しを完了してください。
| 最新版 | 編集中の文章 | ||
| 26行目: | 26行目: | ||
''config.yml''がデータフォルダ配下に存在しない場合は、空の''config.yml''ファイルを読み込んだ事と等しい結果となり、''FileConfiguration''オブジェクトも空の状態でロードされます。 | ''config.yml''がデータフォルダ配下に存在しない場合は、空の''config.yml''ファイルを読み込んだ事と等しい結果となり、''FileConfiguration''オブジェクトも空の状態でロードされます。 | ||
| − | |||
{{warning}} ''getConfig()''の戻り値は、staticなフィールドに割り当てないで下さい。 | {{warning}} ''getConfig()''の戻り値は、staticなフィールドに割り当てないで下さい。 | ||
| − | + | {{warning}} このような割り当てを行うと、''getConfig()''はreloadConfigの後でも再び割り当て処理を繰り返してしまいます。{{note}}''getConfig()''の戻り値は一旦適切なフィールドに割り当ててから利用する事をお勧めします | |
| − | {{warning}} このような割り当てを行うと、''getConfig()''はreloadConfigの後でも再び割り当て処理を繰り返してしまいます。 | ||
| − | |||
| − | {{note}}''getConfig()''の戻り値は一旦適切なフィールドに割り当ててから利用する事をお勧めします | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
=== デフォルト値 === | === デフォルト値 === | ||
| + | ''config.yml''のデフォルト値は、プラグインのユーザに提供されます。 | ||
| + | 設定ファイルが、プラグインのデータディレクトリ配下に存在しない, 空である, キーが無い・・・といった状態である場合には、プラグインのJarファイル内に定義された値が、デフォルト値としてロードされます。 | ||
| − | + | デフォルト値は、データフォルダ配下に存在する''config.yml''が提供しようと意図していた内容と、まったく同一な内容のYAML形式ファイルによって提供されるべきで、そのファイル名は''config.yml''であり、[[Plugin YAML|plugin.yml]]と同一の場所に配置されている必要があります。 | |
| − | + | プラグインのデータフォルダ配下の''config.yml''をデフォルト値で上書きしたい場合は、JavaPluginクラスの''saveDefaultConfig()''メソッドを呼び出す必要があります。既存のファイルを上書きしたくない場合は、copyDefaultsオプションにtrueを設定します。 | |
| − | + | 動的な値をデフォルト値とする場合、addDefaults(Map<String,Object>)や'''addDefault(String, Object)'''のようにコーディングする事で実現できます。 | |
| − | |||
| − | + | 特殊なケースとして、新規のデフォルト値を既存の''config.yml''に追加したい場合は、copyDefaultsにtrueをセットします。 <blockquote><source lang="java">getConfig().options().copyDefaults(true)</source></blockquote> | |
| − | |||
| − | <blockquote><source lang="java"> | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
=== コンフィグ値の取得 === | === コンフィグ値の取得 === | ||
| − | |||
コンフィグ値の読み込み処理は、複数のgetterメソッドの呼び出し処理から成ります。全てのgetterメソッドの一覧は[http://jd.bukkit.org/doxygen/dd/d7c/classorg_1_1bukkit_1_1configuration_1_1file_1_1FileConfiguration.html こちら]です。一般的な用途のgetterメソッドは下記です。 | コンフィグ値の読み込み処理は、複数のgetterメソッドの呼び出し処理から成ります。全てのgetterメソッドの一覧は[http://jd.bukkit.org/doxygen/dd/d7c/classorg_1_1bukkit_1_1configuration_1_1file_1_1FileConfiguration.html こちら]です。一般的な用途のgetterメソッドは下記です。 | ||
*getBoolean(String) | *getBoolean(String) | ||
| 111行目: | 49行目: | ||
*getStringList(String) | *getStringList(String) | ||
| + | ==== Keyの活用 ==== | ||
| + | キーを用いたコンフィグ値の取得処理には、'''FileConfigurationSection'''（コンフィグファイルの階層構造を表すオブジェクト）と、それにアクセスするための'''キー'''と呼ばれる値を利用して行います。キー値の取得には''getKeys(boolean)''メソッドを用い、セクションの取得には''getConfigurationSection(String)''メソッドを用います。キーに先立って、コンフィグファイルのセクションが必要です。 | ||
| + | |||
| + | ''getKeys(boolean)''メソッドのboolean型パラメタは、キーを再帰的に取得するかどうかを指定します。trueであれば、子階層のキーも含めて取得します。falseであれば、対象階層のみのキーを返します。 | ||
| + | |||
| + | *getKeys(boolean) | ||
| + | {{note}} このメソッドは、String型の[http://download.oracle.com/javase/1,5.0/docs/api/java/util/Set.html Set] を返します。 | ||
=== コンフィグ値のセット === | === コンフィグ値のセット === | ||
| 122行目: | 67行目: | ||
利用例: <blockquote><source lang="java"> | 利用例: <blockquote><source lang="java"> | ||
| − | // | + | // setting a boolean value |
this.getConfig().set("path.to.boolean", true); | this.getConfig().set("path.to.boolean", true); | ||
| − | // | + | // setting a String |
| − | this.getConfig().set("path.to.string", | + | String string = "Hello World!"; |
| + | this.getConfig().set("path.to.string", stringValue); | ||
| − | // | + | // Setting a List of Strings |
| − | // | + | // The List of Strings is first defined in this array |
| − | String[] listOfStrings = {" | + | String[] listOfStrings = {"Hello World", "Welcome to Bukkit", "Have a Good Day!"}; |
| − | this.getConfig().set("path.to.list", Arrays.asList(listOfStrings | + | this.getConfig().set("path.to.list", Arrays.asList(listOfStrings); |
| − | // | + | // Setting a vector |
| + | // event is assumed to be an existing event inside an "onEvent" method. | ||
Vector vector = event.getPlayer().getLocation().toVector(); | Vector vector = event.getPlayer().getLocation().toVector(); | ||
this.getConfig().set("path.to.vector", vector); | this.getConfig().set("path.to.vector", vector); | ||
| − | // | + | // Erasing a value |
| − | this.getConfig().set("path.to. | + | this.getConfig().set("path.to.value", null);</source></blockquote><br> |
| − | </source></blockquote> | ||
==== HashMapの活用 ==== | ==== HashMapの活用 ==== | ||
| 148行目: | 94行目: | ||
=== コンフィグファイルのセーブ === | === コンフィグファイルのセーブ === | ||
setメソッドを利用して''FileConfiguration''に多くの変更を加えるか、''Lists''（設定値インスタンスの内部値がList派生型になっている領域を指している）の内容を変更した場合、プラグインの無効化後も残したい設定値であればディスクに書き出すべきです。'''saveConfig'''メソッドを呼び出して、既存の（ディスク上の）コンフィグファイルに上書き保存しましょう。<blockquote><source lang="java">this.saveConfig();</source></blockquote> | setメソッドを利用して''FileConfiguration''に多くの変更を加えるか、''Lists''（設定値インスタンスの内部値がList派生型になっている領域を指している）の内容を変更した場合、プラグインの無効化後も残したい設定値であればディスクに書き出すべきです。'''saveConfig'''メソッドを呼び出して、既存の（ディスク上の）コンフィグファイルに上書き保存しましょう。<blockquote><source lang="java">this.saveConfig();</source></blockquote> | ||
| − | |||
=== ディスクからのリロード === | === ディスクからのリロード === | ||
| − | プラグインのデータフォルダ上の''config.yml''が、ユーザによって変更されている可能性を疑って下さい。この変更点はメモリ上の設定値に反映されていません。''reloadConfig()''メソッドを呼び出して、ディスク上の設定値をプラグインにロードする事ができます。ただしメモリ上の設定値が、ロード内容で上書きされる事にも留意して下さい。 | + | プラグインのデータフォルダ上の''config.yml''が、ユーザによって変更されている可能性を疑って下さい。この変更点はメモリ上の設定値に反映されていません。''reloadConfig()''メソッドを呼び出して、ディスク上の設定値をプラグインにロードする事ができます。ただしメモリ上の設定値が、ロード内容で上書きされる事にも留意して下さい。<source lang="java">this.reloadConfig();</source> |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
== 応用 == | == 応用 == | ||
以下は、より高度なプラグインを製作するための、応用のトピックです。<br> | 以下は、より高度なプラグインを製作するための、応用のトピックです。<br> | ||
| − | + | あなたは既定の''config.yml''を作成するだけでよく、保存したり、移動したりする必要は今後ありません。 | |
=== コンフィグのオプション === | === コンフィグのオプション === | ||
| 189行目: | 111行目: | ||
現在、4つのオプションがあります。<br> | 現在、4つのオプションがあります。<br> | ||
メソッドはオーバーロードされているものがあり、例えば、''copyDefaults()''はブール値を返しますが、''copyDefaults(boolean)''は自分自身を返します。<br> | メソッドはオーバーロードされているものがあり、例えば、''copyDefaults()''はブール値を返しますが、''copyDefaults(boolean)''は自分自身を返します。<br> | ||
| − | '''訳者注''' | + | '''訳者注''' 引数を指定しないメソッドはオプション値を返し、引数を指定するメソッドはオプション値を設定するようです。 |
==== CopyDefaults ==== | ==== CopyDefaults ==== | ||
| − | ''CopyDefaults''オプションは''Configuration'' | + | ''CopyDefaults''オプションは''Configuration''クラスのsaveメソッドを変更しています。<br> |
| − | + | 既定では、デフォルトのコンフィグを保存先ファイルに上書きしません。<br> | |
| − | + | もし引数にtrueが設定された場合、ファイルの上書きをします。<br> | |
| − | + | しかし、1度書き込みが行われるのみで、あなたがデフォルト値を変更したとしてもその値が反映されるわけではありません。 | |
==== PathSeparator ==== | ==== PathSeparator ==== | ||
| 227行目: | 149行目: | ||
プラグインのメソッドを実装した後、それと同じコンテキストで継承された''getConfig()''、 ''reloadConfig()''、 ''saveConfig()''、および ''saveDefaultConfig()''メソッドで呼び出すことができます。<br> | プラグインのメソッドを実装した後、それと同じコンテキストで継承された''getConfig()''、 ''reloadConfig()''、 ''saveConfig()''、および ''saveDefaultConfig()''メソッドで呼び出すことができます。<br> | ||
下記のコード例では、1つのクラスで複数の yaml ファイルにアクセスすることができます。<br> | 下記のコード例では、1つのクラスで複数の yaml ファイルにアクセスすることができます。<br> | ||
| − | このようなクラス実装例を、 [https://gist.github.com/3174347 ここに] 示します。 | + | このようなクラス実装例を、 [https://gist.github.com/3174347 ここに] 示します。 |
まず、2つのフィールドを宣言し、カスタム構成ファイルごとに null に初期化する必要があります。<br> | まず、2つのフィールドを宣言し、カスタム構成ファイルごとに null に初期化する必要があります。<br> | ||
| 246行目: | 168行目: | ||
public void reloadCustomConfig() { | public void reloadCustomConfig() { | ||
if (customConfigFile == null) { | if (customConfigFile == null) { | ||
| − | + | customConfigFile = new File(getDataFolder(), "customConfig.yml"); | |
} | } | ||
customConfig = YamlConfiguration.loadConfiguration(customConfigFile); | customConfig = YamlConfiguration.loadConfiguration(customConfigFile); | ||
| 280行目: | 202行目: | ||
public void saveCustomConfig() { | public void saveCustomConfig() { | ||
if (customConfig == null || customConfigFile == null) { | if (customConfig == null || customConfigFile == null) { | ||
| − | + | return; | |
} | } | ||
try { | try { | ||
| 299行目: | 221行目: | ||
customConfigFile = new File(getDataFolder(), "customConfig.yml"); | customConfigFile = new File(getDataFolder(), "customConfig.yml"); | ||
} | } | ||
| − | if (!configFile.exists()) { | + | if (!configFile.exists()) { |
this.plugin.saveResource(fileName, false); | this.plugin.saveResource(fileName, false); | ||
| − | + | } | |
} | } | ||
</source></blockquote> | </source></blockquote> | ||
| 309行目: | 231行目: | ||
コンフィグAPI は、前述のように''ConfigurationSerializable''インターフェイスを実装する Java オブジェクトを格納することができます。<br> | コンフィグAPI は、前述のように''ConfigurationSerializable''インターフェイスを実装する Java オブジェクトを格納することができます。<br> | ||
オブジェクトのシリアル化では、各種オブジェクトを簡単に保存したり読み込んだりする仕組みを、実装者に提供してくれています。<br> | オブジェクトのシリアル化では、各種オブジェクトを簡単に保存したり読み込んだりする仕組みを、実装者に提供してくれています。<br> | ||
| − | + | 開発者は'[http://jd.bukkit.org/doxygen/da/dac/classorg_1_1bukkit_1_1Location.html Location]''を取得できるシリアライズラッパークラスを使うことで、YAMLに''Location''を保存するような処理がとても簡単に使用することができます。 | |
| − | API | + | API でシリアル化することができますようにクラスは''ConfigurationSerializable''インターフェイスを実装するだけでなく、また implment、Javadoc で指摘したように、以下のいずれかの必要があります。<br> |
| − | * | + | * 1つの''Map''を受け入れるコンストラクター |
| − | * | + | * 1つの''Map''を受け入れてクラスを返す、"deserialize" という名前のstaticメソッド |
| − | * | + | * 1つの''Map''を受け入れてクラスを返す、"valueOf" という名前のstaticメソッド |
シリアライズされたオブジェクトをデシリアライズするには、ConfigurationSerialization に登録されている必要があります。<br> | シリアライズされたオブジェクトをデシリアライズするには、ConfigurationSerialization に登録されている必要があります。<br> | ||
| − | registerClass | + | registerClass メソッドは、シリアル化されたクラスごとに1回呼び出す必要があります。 |
このステートメントは、メインクラスの初期化ブロックに記述することができます。 | このステートメントは、メインクラスの初期化ブロックに記述することができます。 | ||
| 329行目: | 251行目: | ||
クラスがシリアル化されるとき、完全修飾名でマークされています。 | クラスがシリアル化されるとき、完全修飾名でマークされています。 | ||
| − | + | エイリアスをクラスに設定しておくと、代わりにクラスが、エイリアスの完全修飾名を持つ形でシリアル化されません。<br> | |
| − | ''SerializeAs''アノテーションを、ConfigurationSerializableを実装するクラスに指定します。 | + | ''SerializeAs''アノテーションを、ConfigurationSerializableを実装するクラスに指定します。 |
<source lang="java">@SerilizeAs(String)</source> | <source lang="java">@SerilizeAs(String)</source> | ||
| 338行目: | 260行目: | ||
ConfigurationSerialization.registerClass(Class<? extends ConfigurationSerializable>, String) | ConfigurationSerialization.registerClass(Class<? extends ConfigurationSerializable>, String) | ||
</source></blockquote> | </source></blockquote> | ||
| − | |||
| − | |||
== 利用例 == | == 利用例 == | ||
| 361行目: | 281行目: | ||
// もしconfig.ymlが存在しないなら、既定のconfig.ymlをコピーします。 | // もしconfig.ymlが存在しないなら、既定のconfig.ymlをコピーします。 | ||
this.saveDefaultConfig(); | this.saveDefaultConfig(); | ||
| − | + | ||
// 新しいリスナーを登録します。 | // 新しいリスナーを登録します。 | ||
getServer().getPluginManager().registerEvents(new Listener() { | getServer().getPluginManager().registerEvents(new Listener() { | ||
| − | + | ||
@EventHandler | @EventHandler | ||
| − | public | + | public playerJoin(PlayerJoinEvent event) { |
// プレイヤーがサーバーに参加したときに、config.ymlに書かれたメッセージを送ります。 | // プレイヤーがサーバーに参加したときに、config.ymlに書かれたメッセージを送ります。 | ||
event.getPlayer().sendMessage(SimpleMOTD.this.getConfig().getString("message")); | event.getPlayer().sendMessage(SimpleMOTD.this.getConfig().getString("message")); | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
} | } | ||
}, this); | }, this); | ||
| 380行目: | 294行目: | ||
// rulesコマンドのCommandExecutorを登録します。 | // rulesコマンドのCommandExecutorを登録します。 | ||
this.getCommand("rules").setExecutor(new CommandExecutor() { | this.getCommand("rules").setExecutor(new CommandExecutor() { | ||
| − | + | ||
public boolean onCommand(CommandSender sender, Command command, String label, String[] args) { | public boolean onCommand(CommandSender sender, Command command, String label, String[] args) { | ||
// コマンド実行時にコマンド実行者へ、config.ymlのrulesの内容を送ります。 | // コマンド実行時にコマンド実行者へ、config.ymlのrulesの内容を送ります。 | ||
List<String> rules = SimpleMOTD.this.getConfig().getStringList("rules"); | List<String> rules = SimpleMOTD.this.getConfig().getStringList("rules"); | ||
| − | for (String s : rules) | + | for (String s : rules) |
sender.sendMessage(s); | sender.sendMessage(s); | ||
} | } | ||
| 402行目: | 316行目: | ||
- Respect others | - Respect others | ||
- Have Fun | - Have Fun | ||
| − | |||
| − | |||
| − | |||
</source> | </source> | ||