power spot. 2023/02/27 23:32

カスタムメニュープラグイン講座(第5回)「Windowパラメータ(3):各イベント」

RPGツクールMZ向けのトリアコンタン氏のプラグイン「カスタムメニュープラグイン(SceneCustomMenu.js)」の使い方講座です。

リンク:
カスタムメニュー作成プラグインを調べてみた(とんびさん)

今回はWindowの設定パラメータの概要を解説します。
多くのパラメータが存在するので、複数回に分けて解説する予定です。

前回はデータスクリプトを紹介しました。今回は「決定、キャンセル、カーソルイベント」について解説します。

【1】イベントって何?
カスタムメニュープラグインのイベントというのは、第1回の講座でも出てきた言葉「処理」です。
ツクールのイベントでも、何かしらの処理を記述しますが、それと同じです。
しかもカスタムメニュープラグインのイベント(処理)は、「スクリプト」でも「コモンイベント」でも可能という素晴らしいプラグインとなっております。

【2】イベントの種類
カスタムメニュープラグインのイベント用パラメータは以下の4つがあります。
決定イベント…決定ボタンが押された時の処理。
キャンセルイベント…キャンセルボタンが押された時の処理。
カーソルイベント…カーソルが移動した時の処理。
ボタンイベント…任意のボタンが押された時の処理。

上記のボタンイベント以外の3つは、処理を呼び出すタイミングが異なるだけで基本的には同じパラメータ設定となります。

決定イベントのパラメータは以下の通りです。(キャンセル、カーソルも同じパラメータです)

(1)コモンイベント(CommandId)【重要!】
実行される処理にコモンイベントを設定したいときにコモンイベントIDを入力します。


(2)ウィンドウ識別子(FucusWindowId)【重要!】
別のウィンドウにフォーカスしたいときにはここにウィンドウ識別子を入力します。


(3)カーソルインデックス(FocusWindowIntex)
別のウィンドウにフォーカスするときのインデックスを指定します。


(4)スクリプト(Script)【重要!】


実行される処理のスクリプトを記述します。
プルダウンメニューで選べますが、テキストタブから直接記述することが出来ます。

(5)スイッチ(SwitchId)【重要!】
実行される処理でスイッチをONにします。


(6)元ウィンドウ選択解除(Deselect)
実行される処理で元ウィンドウの選択を解除します。


【3】イベントを入れてみる
実際にイベントを起こしてみましょう。決定イベントを設定してみます。

まずはコモンイベントに次のような簡素な処理を設定します。


次にウィンドウの決定イベントパラメータに、上で作成したコモンイベントIDを設定します。


これで実際にメニュー画面の決定ボタンを押すと、下の画像のように文章が表示されます。



イベント系の処理はさまざまな処理を設定出来るので、オリジナルメニューを作成するには妥協出来ない項目です。
簡単な設定のみを紹介しましたが、次回では今までの講座を鑑みながら、実際にオリジナルのメニューを作成してみたいと思います。