| データベース | JS ファイル | 大域変数 |
|---|---|---|
| プラグイン | plugins.js | $plugins (配列) |
プラグイン管理用のパラメータ。plugins.js は data フォルダではなく js フォルダにある。
プラグインに書かれるパラメータ設定の解説もここに書く。
関連クラス: PluginManager
| Name | Type | Description |
|---|---|---|
name |
String | プラグインの[名前](拡張子を含まない) |
status |
String | ON/OFF の[状態] |
description |
String | [説明] |
parameters |
Object | [パラメータ](PluginManager.parameters() の返り値になる) |
{ "名前": "値", … }のようにプラグインパラメータの[名前]と[値]を組み合わせ、パラメータの数だけ並べたオブジェクト。
値は常に String なので、パラメータの値として文字列以外を指定していた場合、プラグイン個々で構文解析(パース)や型変換(キャスト)をする必要がある。
その際に便利な JSON.parse() が JavaScript に用意されている。
以下でプラグインファイルのコメント文でのパラメータ設定を解説している。
プラグインファイルのコメント( /*: */ )に書かれるプラグインの設定。
頭の方に言語コード( 日本語の場合 /*:ja )を書くと、言語ごとに別の設定が用意できる。
以下で説明する @ではじまる宣言はディレクティブとも呼ばれる。
※ @があるとディレクティブと判断されてしまうため、全ての設定値に@は使用できない。
[説明]に表示される文字列。
[作者]に表示される文字列。
[ヘルプ]に表示される文字列。次の行から別のディレクティブが書かれるまで記述可能。
デプロイメントを実行するときに[未使用ファイルを含まない]にチェックしていた場合。
これでファイルを指定すれば削除されない。
* @requiredAssets img/example/image_1
パラメータ識別子。省略不可。パラメータ毎の設定の先頭に置くこと。
空白文字も使えるが、プラグイン側で値を取り出す時に parameters["param with space "] 形式しか使えず parameters.param with space と書いても正しく認識されないことに注意。
パラメータの[名前](規定値: @param の値) 大体は @param の日本語名。
パラメータの[説明]に表示される文字列(規定値: 空文字列) 複数行書ける。規定値など書いておくと良い。
規定値(デフォルト)(規定値: 空文字列)
パラメータをグループ分けする際に小パラメータから親を @param の識別子で指定。
プラグイン側では子の @param 識別子のみで指定し、親の @param 識別子は無視される。
通常、親に指定されるパラメータは値を持たないが、持たせることもできる。
データに親子関係を持たせたい場合、@type *[] や @type struct<*>を検討しても良い。
* @param group
* @text --- グループ名 ---
*
* @param childData
* @parent group
パラメータの型(詳細は後述)
入力時の UI が型に合わせて変わるが、プラグインに渡される値は全て文字列。
文字列。規定値なので指定する必要はないが、明示しておいた方が誤解がなくて良い。
* @param stringData
* @text 文字列型
* @desc パラメータ文字列の説明(規定値: こんにちは)
* @type string
* @default こんにちは
数値。数個から選ぶ場合は @type select を使った方が良いかもしれない。
なぜか[アイコンセットビューア]が出なくなる(バージョン 1.6.2 で確認)ので、タブで[テキスト]に切り替えた後、コンテクストメニューから指定する必要がある。アイコン ID を指定する場合には使わない方が良いかもしれない。
プラグイン側で受け取るのは文字列なので、parseInt() や parseFloat() を使って型変換(キャスト)を行うといい。
| Name | Description |
|---|---|
@min |
最小値( 規定値 : 0 ) (下限 -9007199254740992 ) |
@max |
最大値 (上限 9007199254740992 ) |
@decimals |
小数点以下桁数( 規定値 : 0 ) |
* @param numberData
* @text 数値型
* @desc パラメータ数値の説明(規定値: 10.0)
* @type number
* @min -100
* @max 100
* @decimals 1
* @default 10.0
真偽値。
| Name | Description |
|---|---|
@on |
ON の説明 |
@off |
OFF の説明 |
* @param booleanData
* @text 論理型
* @desc パラメータ真偽値の説明(規定値: 無視)
* @type boolean
* @on 実行する
* @off 無視
* @default false
配列( * の部分に任意のタイプを書く ) プラグイン側は JSON.parse() で解析する。
ちなみに[プラグイン管理]上で各項目はドラッグで入れ替え可能。
* @param arrayData
* @text 配列型
* @desc パラメータ配列の説明(規定値: ["甲", "乙", "丙"])
* @type string[]
* @default ["甲", "乙", "丙"]
データ構造( * の部分に構造名を書く ) プラグイン側は JSON.parse() で解析する。
構造の内容は別に以下のような記述をしておく。通常の型と同じ記述が可能。
多言語対応をする場合、例えば 構造名_ja というように言語ごとに異なる構造名にして、言語に合わせた構造を指定する。
@default の値はデータ構造側より本体の値が優先される。
構造名には _ などの記号は使えない。
* @param struct
* @text 構造型
* @desc パラメータ構造の説明(規定値: x:10, y:20)
* @type struct<coordinateStruct>
* @default { "x":"10", "y":"20" }
/*~struct~coordinateStruct:
* @param x
* @type number
* @default 0
*
* @param y
* @type number
* @default 0
*/
データ構造の配列。
* @param struct
* @text 構造型
* @desc パラメータ配列・構造の説明。
* @type struct<coordinateStruct>[]
* @default [{ "x":"10", "y":"20" }, { "x":"0", "y":"0" }]
img か audio フォルダ以下のファイル(拡張子を含まない)
@default にはフォルダだけの指定、あるいはファイルだけ、または両方を指定できる。
なお指定できるフォルダは 2 階層まで。
| Name | Description |
|---|---|
@dir |
参照フォルダ( 前後の/は不要 ) 値としては返らない |
@require |
1 を設定するとデプロイメントの際[未使用ファイルを含まない]のチェックされた時も、選択したファイルを削除しない |
* @param file
* @text ファイル
* @desc ファイルの説明(規定値: Actor2)
* @type file
* @dir img/characters
* @require 1
* @default Actor2
セレクトボックスの選択肢から選択。
@default には @value の設定がある場合は @value の値を指定。ない場合は @option の値を指定する。
| Name | Description |
|---|---|
@option |
選択肢(必要な数並べる) |
@value |
@option 選択時にプラグインに渡す値(規定値 : @option そのまま) |
* @param selectBox
* @text セレクトボックス
* @desc オプションの説明(規定値: 左方向)
* @type select
* @option 左方向
* @value 4
* @option 右方向
* @value 6
* @default 4
コンボボックス。文字列の入力、または選択肢から選択。
@type select と異なり @value の指定はできない。
| Name | Description |
|---|---|
@option |
選択肢(必要な数並べる) |
* @param combo
* @text コンボボックス
* @desc 編集可能オプションの説明(規定値: red)
* @type combo
* @option red
* @option blue
* @default red
複数行の文字列が記入できる形式。改行もできる。
プラグインには JSON 文字列化(具体的には " や \のエスケープ、改行の \n への変換)して渡される。
改行が必要なデータ、JSON 形式のデータを直接書く場合などに利用する。
@default の指定は他と異なり、ダブルクォーテーション( " )で囲う必要がある。
* @param note
* @text ノート
* @desc メモの説明。
* @type note
* @default "一行目\n二行目"
変数(Game_Variables)の ID( なし: 0 または 空文字列 )
* @param variableId
* @text 変数ID
* @desc 変数の説明(規定値: 1)
* @type variable
* @default 1
スイッチ(Game_Switches)の ID( なし: 0 または 空文字列 )
* @param switchId
* @text スイッチID
* @desc スイッチの説明(規定値: 1)
* @type switch
* @default 1
アクター(RPG.Actor)の ID( なし: 0 または 空文字列 )
* @param actorId
* @text アクターID
* @desc アクターの説明(規定値: 0)
* @type actor
* @default 0
職業(RPG.Class)の ID( なし: 0 または 空文字列 )
* @param classId
* @text クラスID
* @desc クラスの説明(規定値: 0)
* @type class
* @default 0
スキル(RPG.Skill)の ID( なし: 0 または 空文字列 )
* @param skillId
* @text スキルID
* @desc スキルの説明(規定値: 0)
* @type skill
* @default 0
アイテム(RPG.Item)の ID( なし: 0 または 空文字列 )
* @param itemId
* @text アイテムID
* @desc アイテムの説明(規定値: 0)
* @type item
* @default 0
武器(RPG.Weapon)の ID( なし: 0 または 空文字列 )
* @param weaponId
* @text 武器 ID
* @desc 武器の説明(規定値: 0)
* @type weapon
* @default 0
防具(RPG.Armor)の ID( なし: 0 または 空文字列 )
* @param armorId
* @text 防具ID
* @desc 防具の説明(規定値: 0)
* @type armor
* @default 0
敵キャラ(RPG.Enemy)の ID( なし: 0 または 空文字列 )
* @param enemyId
* @text 敵キャラID
* @desc 敵キャラの説明(規定値: 0)
* @type enemy
* @default 0
敵グループ(RPG.Troop)の ID( なし: 0 または 空文字列 )
* @param troopId
* @text 敵グループID
* @desc 敵グループの説明(規定値: 0)
* @type troop
* @default 0
ステート(RPG.State)の ID( なし: 0 または 空文字列 )
* @param stateId
* @text ステートID
* @desc ステートの説明(規定値: 0)
* @type state
* @default 0
アニメーション(RPG.Animation)の ID( なし: 0 または 空文字列 )
| Name | Description |
|---|---|
@require |
1 を設定すると、選択したファイルを削除しない |
* @param animationId
* @text アニメーションID
* @desc アニメーションの説明(規定値: 0)
* @type animation
* @require 1
* @default 0
タイルセット(RPG.Tileset)の ID( なし: 0 または 空文字列 )
* @param tilesetId
* @text タイルセットID
* @desc タイルセットの説明(規定値: 0)
* @type tileset
* @default 0
コモンイベント(RPG.CommonEvent)の ID( なし: 0 または 空文字列 )
* @param commonEventId
* @type common_event
* @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 から指定 |
アイテムのメモの内容が
<sampleImage:img1>
の場合。
* @noteParam sampleImage
* @noteRequire 1
* @noteDir img/sample/
* @noteType file
* @noteData items