From cfd7a89608fb6236c41b2daa65f2813af01a4c91 Mon Sep 17 00:00:00 2001 From: OHGUSHI toshifumi Date: Thu, 29 Apr 2021 10:07:59 +0900 Subject: [PATCH] =?UTF-8?q?=E6=A7=8B=E9=80=A0=E4=BD=93=20=E3=81=A8=20JsonE?= =?UTF-8?q?x=20=E3=81=8C=E9=81=A9=E5=88=87=E3=81=A7=E3=81=AA=E3=81=8B?= =?UTF-8?q?=E3=81=A3=E3=81=9F=E3=81=AE=E3=81=A7=E5=A4=89=E6=9B=B4?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/jsdoc/MV.PluginSettings.md | 98 +++++++++++++++++---------------- 1 file changed, 50 insertions(+), 48 deletions(-) diff --git a/docs/jsdoc/MV.PluginSettings.md b/docs/jsdoc/MV.PluginSettings.md index c61ad17..463eed2 100644 --- a/docs/jsdoc/MV.PluginSettings.md +++ b/docs/jsdoc/MV.PluginSettings.md @@ -10,7 +10,7 @@ プラグインに書かれるパラメータ設定の解説もここに書く。 -関連クラス: [PluginManager](PluginManager.md), [JsonEx](JsonEx.md) +関連クラス: [PluginManager](PluginManager.md) ### Properties: @@ -26,15 +26,15 @@ { "名前": "値", … }のようにプラグインパラメータの[名前]と[値]を組み合わせ、パラメータの数だけ並べたオブジェクト。 値は常に String なので、パラメータの値として文字列以外を指定していた場合、プラグイン個々で構文解析(パース)や型変換(キャスト)をする必要がある。
-その際に便利な [JsonEx.parse()](JsonEx.md#static-parse-json--object) が用意されている。 - +その際に便利な `JSON.parse()` が JavaScript に用意されている。 + 以下でプラグインファイルのコメント文でのパラメータ設定を解説している。 # プラグインファイルの設定 プラグインファイルのコメント( /\*: \*/ )に書かれるプラグインの設定。
頭の方に言語コード( 日本語の場合 /\*:ja )を書くと、言語ごとに別の設定が用意できる。
-以下で説明する @ではじまる宣言はディレクティブとも呼ばれる。 - +以下で説明する @ではじまる宣言はディレクティブとも呼ばれる。 + ※ @があるとディレクティブと判断されてしまうため、全ての設定値に@は使用できない。 @@ -61,7 +61,7 @@ ## パラメータ毎の設定 #### @param -パラメータ識別子。省略不可。パラメータ毎の設定の先頭に置くこと。
+パラメータ識別子。省略不可。パラメータ毎の設定の先頭に置くこと。
空白文字も使えるが、プラグイン側で値を取り出す時に parameters["param with space "] 形式しか使えず parameters.param with space と書いても正しく認識されないことに注意。 #### @text @@ -73,19 +73,21 @@ #### @default 規定値(デフォルト)(規定値: 空文字列) -#### @parent +#### @parent パラメータをグループ分けする際に小パラメータから親を `@param` の識別子で指定。
-プラグイン側では子の `@param` 識別子のみで指定し、親の `@param` 識別子は無視される。
+プラグイン側では子の `@param` 識別子のみで指定し、親の `@param` 識別子は無視される。
通常、親に指定されるパラメータは値を持たないが、持たせることもできる。
-データに親子関係を持たせたい場合、`@type *[]` や `@type struct<*>`を検討しても良い。 +データに親子関係を持たせたい場合、`@type *[]` や `@type struct<*>`を検討しても良い。 ##### Example -``` * @param group - * @text --- グループ名 --- - * - * @param childData - * @parent group -``` +``` + * @param group + * @text --- グループ名 --- + * + * @param childData + * @parent group +``` + #### @type (ver1.5.0 以降) パラメータの型(詳細は後述)
入力時のUIが型に合わせて変わるが、プラグインに渡される値は全て文字列。 @@ -148,8 +150,8 @@ * @default false ``` -### @type \*[] -配列( \* の部分に任意のタイプを書く ) プラグイン側は [JsonEx.parse()](JsonEx.md#static-parse-json--object) で解析する。
+### @type \*[] +配列( \* の部分に任意のタイプを書く ) プラグイン側は `JSON.parse()` で解析する。
ちなみに[プラグイン管理]上で各項目はドラッグで入れ替え可能。 ##### Example @@ -162,10 +164,10 @@ ``` ### @type struct<\*> -データ構造( \* の部分に構造名を書く ) プラグイン側は [JsonEx.parse()](JsonEx.md#static-parse-json--object) で解析する。
+データ構造( \* の部分に構造名を書く ) プラグイン側は `JSON.parse()` で解析する。
構造の内容は別に以下のような記述をしておく。通常の型と同じ記述が可能。
多言語対応をする場合、例えば `構造名_ja` というように言語ごとに異なる構造名にして、言語に合わせた構造を指定する。
-`@default` の値は構造体側より本体の値が優先される。
+`@default` の値はデータ構造側より本体の値が優先される。
構造名には _ などの記号は使えない。 ##### Example @@ -188,7 +190,7 @@ */ ``` -### @type struct<\*>[] +### @type struct<\*>[] データ構造の配列。 ##### Example @@ -202,7 +204,7 @@ ### @type file img か audio フォルダ以下のファイル(拡張子を含まない)
-`@default `にはフォルダだけの指定、あるいはファイルだけ、または両方を指定できる。
+`@default `にはフォルダだけの指定、あるいはファイルだけ、または両方を指定できる。
なお指定できるフォルダは2階層まで。 | Name | Description | @@ -263,9 +265,9 @@ img か audio フォルダ以下のファイル(拡張子を含まない)
``` ### @type note -複数行の文字列が記入できる形式。改行もできる。
-プラグインにはJSON文字列化(具体的には " や \\のエスケープ、改行の \\n への変換)して渡される。
-改行が必要なデータ、JSON形式のデータを直接書く場合などに利用する。
+複数行の文字列が記入できる形式。改行もできる。
+プラグインにはJSON文字列化(具体的には " や \\のエスケープ、改行の \\n への変換)して渡される。
+改行が必要なデータ、JSON形式のデータを直接書く場合などに利用する。
`@default` の指定は他と異なり、ダブルクォーテーション( " )で囲う必要がある。 ##### Example @@ -448,35 +450,35 @@ img か audio フォルダ以下のファイル(拡張子を含まない)
* @text コモンイベントID * @desc コモンイベントの説明(規定値: 0) * @default 0 -``` - +``` + -## ファイルを扱うメモタグの設定 -[メモ]のメタタグの値としてファイルを使う場合、そのファイルが。 -デプロイメントを実行するときに[未使用ファイルを含まない]にチェックしていた場合。
+## ファイルを扱うメモタグの設定 +[メモ]のメタタグの値としてファイルを使う場合、そのファイルが。 +デプロイメントを実行するときに[未使用ファイルを含まない]にチェックしていた場合。
以下のタグを指定すれば削除されない。 - -| Name | Description | -| --- | --- | -| `@noteParam` | タグ名 | -| `@noteRequire` | 1 を設定するとデプロイメントの際[未使用ファイルを含まない]のチェックされた時も、選択したファイルを削除しない | -| `@noteDir` | ファイルがあるディレクトリ | -| `@noteType` | データに合わせて、file か animation を指定 | -| `@noteData` | メモを利用するオブジェクトを maps, events, actors, classes, skills, items, weapons, armors, enemies, states, tilesets から指定 | - + +| Name | Description | +| --- | --- | +| `@noteParam` | タグ名 | +| `@noteRequire` | 1 を設定するとデプロイメントの際[未使用ファイルを含まない]のチェックされた時も、選択したファイルを削除しない | +| `@noteDir` | ファイルがあるディレクトリ | +| `@noteType` | データに合わせて、file か animation を指定 | +| `@noteData` | メモを利用するオブジェクトを maps, events, actors, classes, skills, items, weapons, armors, enemies, states, tilesets から指定 | + -##### Example +##### Example アイテムのメモの内容が -``` +``` -``` -の場合。 +``` +の場合。 ``` - * @noteParam sampleImage - * @noteRequire 1 - * @noteDir img/sample/ - * @noteType file + * @noteParam sampleImage + * @noteRequire 1 + * @noteDir img/sample/ + * @noteType file * @noteData items -``` - +``` +