NRP CommonMoveRouteMZ.jsに機能追加 - NRP_K_CommonMoveRouteMZ.js

2024-09-29

シェア用テキスト：

▼NRP CommonMoveRouteMZ.jsに機能追加（砂川赳様作） - NRP_K_CommonMoveRouteMZ.js
https://plugin-mz.fungamemake.com/archives/4265
任意のイベントから特定のコモンイベントを呼び出すことで、そのイベントの移動ルートを設定出来ます。同じ動作をする複数のイベントを、一つのコモンイベントの記述で処理できます。

ふりがな：CommonMoveRouteMZ.jsにきのうついか

機能概要：任意のイベントから特定のコモンイベントを呼び出すことで、そのイベントの移動ルートを設定出来ます。同じ動作をする複数のイベントを、一つのコモンイベントの記述で処理できます。

利用規約（ライセンス）：
・著作権：保持
・商用利用：許可
・追加改変：許可
・再配布：許可
・詳細はダウンロードページ・プラグイン内を確認

作者：砂川赳

作者サイト：https://newrpg.seesaa.net//

解説ページ：https://newrpg.seesaa.net/index-3.html#CommonMoveRoute

ファイル名：NRP_K_CommonMoveRouteMZ.js

プラグインのヘルプ：

/*:ja
 * @target MZ
 * @plugindesc v1.02 複数イベントの移動ルートをひとつのコモンイベントで制御可能
 * @author 神無月サスケ（原案：terunon）（改造：砂川赳）
 *
 * @command set
 * @text コモン移動ルート設定
 * @desc イベントの移動ルート用コモンイベントを設定
 *
 * @arg eventId
 * @text イベントID
 * @desc 移動ルートを設定するイベント
 * @type number
 * @min 1
 * @default 1
 *
 * @arg commonEventId
 * @text コモンイベントID
 * @desc 移動ルートが設定されたコモンイベント
 * @type common_event
 * @default 1
 *
 * @arg flag
 * @text 実行条件式
 * @desc この式の評価結果がfalseの時は設定を行いません。
 * @type string
 * @default true
 *
 * @command set2
 * @text コモン移動ルート設定(変数指定可)
 * @desc イベントの移動ルート用コモンイベントを設定
 * 変数やイベント名での設定が可能
 * @arg eventId
 * @text イベントID
 * @desc 移動ルートを設定するイベント
 * V+変数ID やイベント名での設定も可
 * @type string
 * @default 1
 *
 * @arg commonEventId
 * @text コモンイベントID
 * @desc 移動ルートが設定されたコモンイベント
 * V+変数ID (例：V10 V25)やイベント名での設定も可
 * @type string
 * @default 1
 *
 * @arg flag
 * @text 実行条件式
 * @desc この式の評価結果がfalseの時は設定を行いません。
 * @type string
 * @default true
 *
 * @command setPlayer
 * @text プレイヤーのルート設定
 * @desc プレイヤーの移動ルート用コモンイベントを設定
 *
 * @arg commonEventId
 * @text コモンイベントID
 * @desc 移動ルートが設定されたコモンイベント
 * @type common_event
 * @default 1
 *
 * @arg flag
 * @text 実行条件式
 * @desc この式の評価結果がfalseの時は設定を行いません。
 * @type string
 * @default true
 *
 * @command setPlayer2
 * @text プレイヤーのルート設定(変数指定可)
 * @desc プレイヤーの移動ルート用コモンイベントを設定
 * 変数やイベント名での設定が可能
 *
 * @arg commonEventId
 * @text コモンイベントID
 * @desc 移動ルートが設定されたコモンイベント
 * V+変数ID (例：V10 V25)やイベント名での設定も可
 * @type string
 * @default 1
 *
 * @arg flag
 * @text 実行条件式
 * @desc この式の評価結果がfalseの時は設定を行いません。
 * @type string
 * @default true
 * 
 * 
 * @param LockRunningEvent
 * @text 実行イベントをロック
 * @type boolean
 * @default true
 * @desc 実行中のイベントに対して、当プラグインによる自律移動を禁止します。
 *
 * @param LockOtherEventsSwitch
 * @text 他イベント停止スイッチ
 * @type switch
 * @desc スイッチがオンの間、当プラグインによる全イベントの自律移動を禁止します。0（なし）なら常に停止。
 * 
 * @help
 * このプラグインは神無月サスケ様（原案：terunon様）による
 * ＲＰＧツクールＭＺのローンチプラグインCommonMoveRouteMZ.jsに対して、
 * 砂川赳が機能追加を行ったものです。
 * 
 * 元の仕様だとコモンイベントで指定した動作は
 * イベント実行中も動作するようになっていますが、
 * プラグインパラメータによって、それを停止できます。
 * 
 * -------------------------------------------------------------------
 * ■以下、オリジナルの解説
 * -------------------------------------------------------------------
 * このプラグインは、RPGツクールMZに対応しています。
 *
 * ■概要
 * 任意のイベントから特定のコモンイベントを呼び出すことで、そのイベントの
 * 移動ルートを設定出来ます。
 * 同じ動作をする複数のイベントを、一つのコモンイベントの記述で処理できます。
 *
 * なお、コモンイベント内には、ほぼすべてのイベントコマンドが使えます。
 * ピクチャの表示や、条件分岐などあらゆることが可能です。
 *
 * 並列イベントとは異なり、あくまで移動ルートでの設定であるため、
 * 例えば、接触をした際に、反応をさせるといったことが可能です。
 *
 * ■設定可能な表記例（基本）
 * プラグインコマンド、スクリプト、移動ルートの設定のいずれからも呼び出せます。
 * 以下、イベントID19番に、4番のコモンイベントを移動ルートに設定する書式を
 * 説明します。数値は適宜置き換えてください。
 * ◆イベントコマンド『スクリプト』
 * this.toCommon(4);          // このコマンドを呼び出したイベントに設定
 * this.commandRoute(4);      // 同上
 * this.toCommon2(19, 4);     // イベントID19番のイベントに設定
 * this.commandRoute2(19, 4); // 同上
 * ◆イベントコマンド『移動ルートの設定』の中での『スクリプト』
 * this.toCommon(4);          // 『移動ルートの設定』で指定したイベントに設定
 * this.commandRoute(4);      // 同上
 * ◆設定上の注意
 * ・移動ルートの対象を「プレイヤー」にする場合、プラグインコマンドを使うか、
 * 上記のスクリプトでイベントIDを-1にしてください。
 *
 * ■設定可能な表記例（応用１）
 * 上記のパラメータの数値は、数字のみならず、すべて以下の書式が可能です。
 * ・V10 や V25 のように頭にVを付けると、その変数IDの値になります。
 * ・イベントID はイベント名で、コモンイベントID はコモンイベント名での
 *   指定も可能です。
 * 以下に一例を示します。
 * ◆イベントコマンド『スクリプト』での例：
 * this.toCommon2('青鬼', 'ランダム移動');
 *   「青鬼」という名のイベントに、「ランダム移動」という名のコモンイベントを
 *   移動ルートに設定します。
 *
 * ■設定可能な表記例（応用２）
 * 上記の任意の数値の後に、true や false や 数式を書いた場合、
 * その内容は eval で評価され、false と見做された場合は、実行を行いません。
 * ◆設定例：
 * this.toCommon2(19, 4, $gameSwitches.value(15));
 *
 * ■プラグインコマンド
 * 上記の設定をプラグインコマンドで行うことも出来ます。
 * 定数版と、変数版があります。
 * プレイヤーの設定もプラグインコマンドで可能です
 * 
 * ■設定上のコツと注意
 * ・コモンイベントによる移動ルート中、ウェイトを含むイベントコマンドを
 *   実行した場合、イベントに設定された本来の自律移動することがたまにあります。
 *   ウェイトを含むイベントコマンドを入れる場合、注意が必要です。
 * ・コモンイベント内から、さらに上記の記法でコモンイベントを呼び出すことも
 *   可能です(いわゆる「入れ子」)。ただし、循環参照などで、入れ子の深さが
 *   100を越えると、エラーになります。（これは通常のインタプリタと同様）
 * 
 * ■補足情報
 * ◆コモンイベント内で作者が使用可能を確認したイベントコマンド一覧
 * ・移動ルートの設定：最初の行でなくても問題なし。いくつも記述可能
 * ・スイッチ、変数、セルフスイッチの変更
 * ・条件分岐、ラベルジャンプ、ループ処理、中断など、フロー制御すべて
 * ・コモンイベント呼び出し（つまり入れ子にすることが可能）
 * ・ピクチャ関連、天候関連,フキダシアイコン
 * ・「イベントの一時消去」「場所移動（同マップへ）」なども受け付けます。
 * ◆コモンイベントの終了後の挙動
 * ・記述内にループや「動作を繰り返す」移動ルートの設定があった場合、
 *   ページが切り替わるまでコモンイベントの移動を続けます。
 * ・コモンイベントが終了した場合は、ただちに従来の自律移動に戻ります。
 *
 * ■ライセンス表記
 * このプラグインは、terunon(エイリアスエイク)様の TN_commonMoveRoute.js を
 * 元に、神無月サスケが機能追加およびバグ修正を行ったものです(MV版)。
 * terunon様に感謝いたします。
 *
 * このプラグインは MIT ライセンスで配布されます。
 * ご自由にお使いください。
 * http://opensource.org/licenses/mit-license.php
 */