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でセーブデータに変数の値を表示するプラグインTMSaveDataLabelの使い方

プラグインを導入すると、セーブデータを表示する画面で任意の変数の値をセーブデータに表示することができます。 このプラグインはtomoaky様が制作されたものです。 確認環境 RPGツクールMV Ver …

no image

RPGツクールMV – 戦闘画面で発生するLoading Error対応方法

こんにちは、今日はRPGツクールMVの戦闘画面で発生するLoading Errorの対応方法についてまとめていきます。 画面に表示されるエラー内容は以下のようなものです。 Loading Error …

no image

RPGツクールMVでBGM再生中かどうか判定する

現在再生されているBGMの情報はAudioManager._currentBgmに格納されているため、条件分岐のスクリプトでこの値がnullかどうかの判定を行います。 イベントコマンドの条件分岐を追加 …

no image

RPGツクールMV – 画面サイズを変更する方法

こんにちは、今日はRPGツクールMVで画面サイズを変更する方法についてまとめていきます。 確認環境 RPGツクールMV Version 1.6.2 画面サイズ変更方法 デフォルトで追加、および有効化さ …

no image

RPGツクールMVで画面の色調変更をスクリプトから行う

スクリプトコード 第一引数に赤、緑、青、グレーの値の配列を、第二引数に時間を指定します。 $gameScreen.startTint([0,0,0,0], 60); イベントコマンドの内容 { …