Skip to content

Commit

Permalink
構造体 と JsonEx が適切でなかったので変更
Browse files Browse the repository at this point in the history
  • Loading branch information
tonbijp committed Apr 29, 2021
1 parent 4095b66 commit cfd7a89
Showing 1 changed file with 50 additions and 48 deletions.
98 changes: 50 additions & 48 deletions docs/jsdoc/MV.PluginSettings.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

プラグインに書かれるパラメータ設定の解説もここに書く。

関連クラス: [PluginManager](PluginManager.md), [JsonEx](JsonEx.md)
関連クラス: [PluginManager](PluginManager.md)

### Properties:

Expand All @@ -26,15 +26,15 @@
<code>{ "名前": "値", … }</code>のようにプラグインパラメータの[名前][]を組み合わせ、パラメータの数だけ並べたオブジェクト。

値は常に <code>String</code> なので、パラメータの値として文字列以外を指定していた場合、プラグイン個々で構文解析(パース)や型変換(キャスト)をする必要がある。<br />
その際に便利な [JsonEx.parse()](JsonEx.md#static-parse-json--object) が用意されている

その際に便利な `JSON.parse()` が JavaScript に用意されている

以下でプラグインファイルのコメント文でのパラメータ設定を解説している。

# プラグインファイルの設定
プラグインファイルのコメント( /\*: \*/ )に書かれるプラグインの設定。<br />
頭の方に言語コード( 日本語の場合 /\*:ja )を書くと、言語ごとに別の設定が用意できる。<br />
以下で説明する @ではじまる宣言はディレクティブとも呼ばれる。

以下で説明する @ではじまる宣言はディレクティブとも呼ばれる。

※ @があるとディレクティブと判断されてしまうため、全ての設定値に@は使用できない。


Expand All @@ -61,7 +61,7 @@
## パラメータ毎の設定

#### @param
パラメータ識別子。省略不可。パラメータ毎の設定の先頭に置くこと。<br />
パラメータ識別子。省略不可。パラメータ毎の設定の先頭に置くこと。<br />
空白文字も使えるが、プラグイン側で値を取り出す時に <code>parameters["param with space "]</code> 形式しか使えず <code>parameters.param with space</code> と書いても正しく認識されないことに注意。

#### @text
Expand All @@ -73,19 +73,21 @@
#### @default
規定値(デフォルト)(規定値: 空文字列)

#### @parent
#### @parent
パラメータをグループ分けする際に小パラメータから親を `@param` の識別子で指定。<br />
プラグイン側では子の `@param` 識別子のみで指定し、親の `@param` 識別子は無視される。<br />
プラグイン側では子の `@param` 識別子のみで指定し、親の `@param` 識別子は無視される。<br />
通常、親に指定されるパラメータは値を持たないが、持たせることもできる。<br />
データに親子関係を持たせたい場合、`@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 以降)
パラメータの型(詳細は後述)<br />
入力時のUIが型に合わせて変わるが、プラグインに渡される値は全て文字列。
Expand Down Expand Up @@ -148,8 +150,8 @@
* @default false
```

### @type \*[]
配列( \* の部分に任意のタイプを書く ) プラグイン側は [JsonEx.parse()](JsonEx.md#static-parse-json--object) で解析する。<br />
### @type \*[]
配列( \* の部分に任意のタイプを書く ) プラグイン側は `JSON.parse()` で解析する。<br />
ちなみに[プラグイン管理]上で各項目はドラッグで入れ替え可能。

##### Example
Expand All @@ -162,10 +164,10 @@
```

### @type struct&lt;\*&gt;
データ構造( \* の部分に構造名を書く ) プラグイン側は [JsonEx.parse()](JsonEx.md#static-parse-json--object) で解析する。<br />
データ構造( \* の部分に構造名を書く ) プラグイン側は `JSON.parse()` で解析する。<br />
構造の内容は別に以下のような記述をしておく。通常の型と同じ記述が可能。<br />
多言語対応をする場合、例えば `構造名_ja` というように言語ごとに異なる構造名にして、言語に合わせた構造を指定する。<br />
`@default` の値は構造体側より本体の値が優先される。<br />
`@default` の値はデータ構造側より本体の値が優先される。<br />
構造名には _ などの記号は使えない。

##### Example
Expand All @@ -188,7 +190,7 @@
*/
```

### @type struct&lt;\*&gt;[]
### @type struct&lt;\*&gt;[]
データ構造の配列。

##### Example
Expand All @@ -202,7 +204,7 @@

### @type file
img か audio フォルダ以下のファイル(拡張子を含まない)<br />
`@default `にはフォルダだけの指定、あるいはファイルだけ、または両方を指定できる。<br />
`@default `にはフォルダだけの指定、あるいはファイルだけ、または両方を指定できる。<br />
なお指定できるフォルダは2階層まで。

| Name | Description |
Expand Down Expand Up @@ -263,9 +265,9 @@ img か audio フォルダ以下のファイル(拡張子を含まない)<br />
```

### @type note
複数行の文字列が記入できる形式。改行もできる。<br />
プラグインにはJSON文字列化(具体的には &quot;\\のエスケープ、改行の \\n への変換)して渡される。<br />
改行が必要なデータ、JSON形式のデータを直接書く場合などに利用する。<br />
複数行の文字列が記入できる形式。改行もできる。<br />
プラグインにはJSON文字列化(具体的には &quot;\\のエスケープ、改行の \\n への変換)して渡される。<br />
改行が必要なデータ、JSON形式のデータを直接書く場合などに利用する。<br />
`@default` の指定は他と異なり、ダブルクォーテーション( &quot; )で囲う必要がある。

##### Example
Expand Down Expand Up @@ -448,35 +450,35 @@ img か audio フォルダ以下のファイル(拡張子を含まない)<br />
* @text コモンイベントID
* @desc コモンイベントの説明(規定値: 0)
* @default 0
```

```


## ファイルを扱うメモタグの設定
[メモ]のメタタグの値としてファイルを使う場合、そのファイルが。
デプロイメントを実行するときに[未使用ファイルを含まない]にチェックしていた場合。<br />
## ファイルを扱うメモタグの設定
[メモ]のメタタグの値としてファイルを使う場合、そのファイルが。
デプロイメントを実行するときに[未使用ファイルを含まない]にチェックしていた場合。<br />
以下のタグを指定すれば削除されない。

| 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
アイテムのメモの内容が
```
```
<sampleImage:img1>
```
の場合。
```
の場合。

```
* @noteParam sampleImage
* @noteRequire 1
* @noteDir img/sample/
* @noteType file
* @noteParam sampleImage
* @noteRequire 1
* @noteDir img/sample/
* @noteType file
* @noteData items
```

```

0 comments on commit cfd7a89

Please sign in to comment.