3テラバイト

プログラム関連備忘録サイト。主にゲーム。

RPGツクールMV

RPGツクールMV – プラグインのパラメータ設定方法まとめ

投稿日:2020年5月11日 更新日:

こんにちは、今日はRPGツクールMVでプラグインを作る際に使用するパラメータの設定方法についてまとめていきます。

確認環境

RPGツクールMV Version 1.6.2

パラメータ共通の書式

以下がパラメータで設定可能な書式です。
この他@typeの設定値ごとに設定可能な項目が増えることがあります。

@paramパラメータ名です。
この値がパラメータを参照する際のキーに使用され、@textを設定していない場合はプラグインのパラメータ > 名前にも表示されます。
日本語等の全角文字も使用可能です。
@descパラメータの説明です。
パラメータを編集する際に表示される説明テキスト部分に表示されます。
@typeパラメータの型を指定します。
@defaultパラメータのデフォルト値を設定します。
@parentパラメータの親を設定でき、表示が階層化されます。
RPGツクールMVエディタ上の表示のみで有効で、実際のパラメータの構造には影響しません。
@textRPGツクール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'];

-RPGツクールMV


comment

メールアドレスが公開されることはありません。

関連記事

no image

RPGツクールMVで所持金の増減をスクリプトから行う

イベントコマンドの1ページ目、パーティ > 所持金の増減…と同様の操作を、イベントコマンドの3ページ目、上級 > スクリプトから行う方法です。 スクリプトコード 以下のコードで所持金の増減をすることが …

no image

RPGツクールMVでアイテム等のヘルプウィンドウを拡張するプラグインDescriptionExtendの使い方

スキル、アイテム、武器、防具についてはデータベースから説明テキストを2行までで設定できますが、この行数を拡張することができるプラグインです。 このプラグインはトリアコンタンさんが作成されたプラグインで …

no image

RPGツクールMVでアイテムを重量制にできるプラグインPNDK_LuggageCapacityの使い方

このプラグインはパンダコ様が制作されたプラグインです。 確認環境 RPGツクールMV Version 1.6.2PNDK_LuggageCapacity Version:1.4.0 ダウンロード 以下 …

no image

セーブデータを単一にするRPGツクールMVプラグインUseOnlyOneSaveの使い方

このプラグインを導入すると、セーブやロード時にファイルを選択する画面がスキップされ、ファイル1が自動で使用されるようになり、メニューからセーブを行った際には上の画像のようなセーブ完了の旨を知らせるウィ …

no image

RPGツクールMVで能力値の増減をスクリプトから行う

RPGツクールMVで能力値の増減をスクリプトから行う方法についてまとめていきます。 イベントコマンドの1ページ目、アクター > 能力値の増減…と同様の操作を、イベントコマンドの3ページ目、上級 > ス …