2017年1月22日日曜日

イベントデバッグプラグイン

 RPGツクールMVで使用可能な自作プラグイン「イベントデバッグプラグイン」の紹介です。

プラグインの説明

 任意の箇所でイベントの実行を一時停止して、1行ずつ実行(ステップ実行)ができるようになります。開始方法は以下の3通りです。マップ画面、戦闘画面のどちらでも利用可能です。

  1. 指定されたキー(デフォルトF7)を押下する。(※1)
  2. プラグインコマンド[BREAK_POINT]を実行する。(条件が指定可能です)
  3. イベントテストを実行する。

※1 並列イベントが複数実行されている場合、どこで止まるかは不確定です。

 止めている間は以下の操作が可能です。

  1. ステップ実行(イベントを1コマンドずつ実行)
  2. 実行中のイベントリスト確認
  3. 実行したイベントのパラメータ確認
  4. デバッグ画面(F9)を開いてスイッチや変数の操作(※2)
  5. デベロッパツールから任意のJavaScriptを実行

※2 マップ画面でのみ有効です。

ステップ実行中の画面

 ステップ実行中は、画面左上にイベント情報が出力されます。変数やスクリプトの評価結果を監視することもできます。(後述) スクリーンショット

 ステップ実行には以下の種類があり、対応するファンクションキーを指定できます。

  • ステップイン:1行実行する。コモンイベントの呼び出し先もステップ実行する。
  • ステップオーバー:1行実行する。コモンイベントの呼び出しは一括実行する。
  • 再開:ステップ実行を終了し、通常のイベント実行に戻る。

デベロッパツールの画面

 ステップ実行が開始されると、操作方法および実行したイベントの履歴がパラメータつきで出力されます。 スクリーンショット

 各イベントコマンドの実行にどのくらい時間が掛かったかも出力します。

デバッグ画面

 ステップ実行中にF9キーを押下すると、デフォルトのデバッグ画面が表示され変数の値を編集できます。(マップ画面のみ) スクリーンショット

変数監視機能

 さらに、変数やスクリプトの評価結果を常時監視することができます。この機能はステップ実行中以外でも常に有効です。監視対象が登録されている場合、右上にウィンドウが表示されます。数値を指定した場合は変数値が、文字列を指定した場合はスクリプトの評価結果が表示されます。

 所定のファンクションキーを押下するか、以下のスクリプトをデベロッパツールから実行すると監視対象を登録できます。

DebugManager.watchVariable(5); # 変数[5]の値を常に監視します。

 このプラグインはテストモードでのみ動作し製品版にはなんら影響を与えません。

ダウンロード

プラグインファイルはGithubで公開しています。
https://raw.githubusercontent.com/triacontane/RPGMakerMV/master/EventDebugger.js

ダウンロード方法(Windowsの場合)

  1. リンク先に飛ぶ
  2. 右クリック
  3. 名前を付けて保存
  4. ファイル名を変えずに、プロジェクトの「js/plugins」配下に配置

利用規約

当プラグインはMITライセンスのもとで公開されています。作者に無断で改変、再配布が可能で、利用形態(商用、18禁利用等)についても制限はありません。このプラグインはもうあなたのものです。
http://opensource.org/licenses/mit-license.php