こんにちは、今日はRPGツクールMVでプラグインを作る際に使用するパラメータの設定方法についてまとめていきます。
目次
確認環境
RPGツクールMV Version 1.6.2
パラメータ共通の書式
以下がパラメータで設定可能な書式です。
この他@typeの設定値ごとに設定可能な項目が増えることがあります。
| @param | パラメータ名です。 この値がパラメータを参照する際のキーに使用され、@textを設定していない場合はプラグインのパラメータ > 名前にも表示されます。 日本語等の全角文字も使用可能です。 |
| @desc | パラメータの説明です。 パラメータを編集する際に表示される説明テキスト部分に表示されます。 |
| @type | パラメータの型を指定します。 |
| @default | パラメータのデフォルト値を設定します。 |
| @parent | パラメータの親を設定でき、表示が階層化されます。 RPGツクールMVエディタ上の表示のみで有効で、実際のパラメータの構造には影響しません。 |
| @text | RPGツクールMVエディタ上でパラメータの表示名を設定します。 未設定の場合は@paramの値がそのまま表示されます。 |
@typeに設定可能な値一覧
@typeには以下の値が設定可能です。
また、それぞれ末尾に[]をつけることにより、配列にすることも可能です。
RPGツクールMVのデータベースから選択できるタイプのパラメータについては、エディタ上でデータベースの値を参照しつつ設定できるのみで、実際に設定されるのはそのID文字列になります。
| string | 文字列型 |
| number | 数値型 |
| boolean | 論理型 |
| struct<構造体名> | 構造体 |
| select | オプション セレクトボックスで指定の値の中から選択可能です。 |
| combo | 編集可能オプション コンボボックスで指定の値の中から選択、または直接値の入力が可能です。 |
| note | メモ |
| file | ファイル |
| variable | データベース > 変数 |
| switch | データベース > スイッチ |
| actor | データベース > アクター |
| class | データベース > 職業 |
| skill | データベース > スキル |
| item | データベース > アイテム |
| weapon | データベース > 武器 |
| armor | データベース > 防具 |
| enemy | データベース > 敵キャラ |
| troop | データベース > 敵グループ |
| state | データベース > ステート |
| animation | データベース > アニメーション |
| tileset | データベース > タイルセット |
| common_event | データベース > コモンイベント |
構造体の定義
構造体の定義は以下のように行います。
StructTestの部分は任意の構造体名を設定し、以降は通常通りパラメータが設定可能です。
/*~struct~StructTest:
* @param sample
*/プラグインの説明やパラメータの設定を以下のような「:」から始まるコメント内で行なっていますが、こちらとは別に記述する必要があります。
/*:
* @plugindesc テストプラグイン
* @author プラグイン作者名
*/パラメータの参照方法
プラグインのパラメータはPluginManager.parameters(プラグイン名)で参照できます。
この記事の例で作成したプラグインの場合はTestPluginなので以下のようにパラメータを参照可能です。
var param = PluginManager.parameters('TestPlugin');
var string = param['string'];