【RPGツクール】プラグインコマンドを作ってみる

今日はARPGプラグインセットはお休み。

RPGツクールのお仕事を頂いたので、そこで使ったプラグインコマンドを記事にします。
初期化時に選択した文字列を覚えておき、それを後で判断するという流れで使っています。

結局このプラグインコマンドは不要になりましたが、楽しかったのでよし。

●プラグイン記述

とあるプラグインを参考にしてプラグインコマンドを作成しました。
表示文字列を選択するコマンドと、文字列を表示するコマンド、2つを定義しています。

/*:
 * @plugindesc プラグインコマンドのテスト
 * @author dar9matter
 *
 * @command setDisplayText
 * @text 表示文字列を選択
 * @desc 「文字列表示」を呼び出した時に表示する文字列を選択
 *
 * @arg text
 * @type select
 * @option あいうえお
 * @option かきくけこ
 * @option さしすせそ
 * @option たちつてと
 * @option なにぬねの
 * @option はひふへほ
 * @option まみむめも
 * @option や ゆ よ
 * @option らりるれろ
 * @option わ を ん
 * @text 表示文字列
 * @desc 表示する文字列を指定します。
 * 
 * @command displayText
 * @text 文字列を表示
 * @desc 選択した文字列を表示
 *
 * @help
 * プラグインコマンドのテスト
 */

(() => {
    const pluginName = "d9mPluginCommandTest";
    let displayText = '';

    PluginManager.registerCommand(pluginName, "setDisplayText", args => {
        displayText = args.text;
    });

    PluginManager.registerCommand(pluginName, "displayText", args => {
        $gameMessage.add(displayText);
    });
})();

機密保持ということで、何にどのように使うか分からないようにしてます。

これだけでも以下2つにハマって1時間ほどかかりました。

・pluginNameの内容とファイル名は一致させる(同じにするとは気付かなかった)
・@commandの内容とregisterCommandの第2引数に渡す値は一致させる(単なる変更漏れ)

●プラグイン有効化

RPGツクールMZに認識させます。

イベントにプラグインコマンドを追加します。
文章の前に表示文字列の選択を追加、「かきくけこ」の表示を指定します。

「かきくけこ」を選択
「かきくけこ」を選択

次は文章の最後に文字列表示を追加します。
引数はなし。

●まとめ

今回はプラグインコマンドを作成しました。

プラグイン名とファイル名を一致させずにハマったのは焦りました。
コマンド名も一致させ忘れていましたが、こちらは焦っての変更漏れです。

色々記述しなければならないので面倒ですが、プラグインコマンド使った方がメンテナンス楽そうですね。

変数の型だけでも色々あるのでまだまだ使いこなすのは大変そうですが、楽しんでいきましょう。

コメント

タイトルとURLをコピーしました