一度に複数のメッセージウィンドウを表示するプラグイン – FTKR_ExMessageWindow2.js

-----------------------------------------------------------------------------
概要
-----------------------------------------------------------------------------
このプラグインを使用することで、文章の表示イベントで以下の動作が
可能になります。

1. 複数のメッセージウィンドウを画面に表示できます。

2. メッセージ表示中にプレイヤーの行動を許可できます。
(イベント実行のトリガーが「自動実行」または「並列処理」の場合のみ)

3. 表示中のメッセージウィンドウを強制終了させることができます。

このプラグインは、ツクールMVのコアスクリプトv1.5.0以降用です。
v1.5.0以前のバージョンのコアスクリプトでは動作しません。


-----------------------------------------------------------------------------
設定方法
-----------------------------------------------------------------------------
1.「プラグインマネージャー(プラグイン管理)」に、本プラグインを追加して
ください。

2. YEP_MessageCore.jsと組み合わせる場合は、本プラグインを
YEP_MessageCore.jsよりも下に配置してください。

3. 本プラグインは、FTKR_ExMessageWindow.js (v1.x.x)と組み合わせて
使用できません。


-----------------------------------------------------------------------------
拡張メッセージウィンドウ と メッセージウィンドウIDについて
-----------------------------------------------------------------------------
本プラグインを有効にすると、イベントコマンド「文章の表示」に
使用するウィンドウに、MVデフォルトのメッセージウィンドウとは別の
拡張メッセージウィンドウを使用します。

拡張メッセージウィンドウは、メッセージウィンドウIDを持っており
このIDを変えることで、一度に複数のウィンドウを表示させることができます。

メッセージウィンドウIDは、プラグインのデフォルトで ID0 を使用します。
ID0 - MVデフォルトのメッセージウィンドウ

＜ウィンドウIDの表示順＞
複数の拡張メッセージウィンドウが重なった場合、ウィンドウIDが大きい方を
前面に表示します。
ただし、ID0については常に最前面に表示します。


＜ウィンドウIDの使用できる数＞
ウィンドウIDを何番まで使用できるかは以下の設定によります。
1. プラグインパラメータ<Create ExWindow Number>の設定
2. マップのメモ欄のタグ<EMW_生成数: x>または<EMW_NUMBER: x> の x値

マップデータのメモ欄の設定を優先します。
設定値が 2 なら、ID0 ~ ID2 まで使用できます。


！！注意！！
ウィンドウデータは、シーン開始時に生成します。
ウィンドウIDの生成数が多すぎる場合(1)、シーン変更に数秒掛かるように
なる可能性があります。

(1)PCのスペックや、マップの広さ、マップ上のイベント数などによって
変わります。


！！注意２！！
当プラグインの拡張メッセージウィンドウ(ウィンドウID1以降)は、
通常のメッセージウィンドウとは別の専用の処理を使用しています。
そのため、他のメッセージウィンドウ用のプラグインの機能を使用することは
できません。
他のメッセージウィンドウ用のプラグインの機能を使う場合は、
ウィンドウID0 を使用してください。

ただし、以下のプラグインは、拡張メッセージウィンドウに対応済みです。
YEP_MessageCore.js
MessageWindowPopup.js


-----------------------------------------------------------------------------
拡張メッセージウィンドウを使用した文章の表示方法
-----------------------------------------------------------------------------
以下にイベント例を示します。


◆プラグインコマンド：EMW_メッセージウィンドウ指定 1
◆文章：なし, ウィンドウ, 下
：　　：会話中に行動可能になる制御文字が使えるぜ！
：　　：いいだろう？
◆プラグインコマンド：EMW_メッセージウィンドウ指定 2
◆文章：なし, ウィンドウ, 上
：　　：いいね！


プラグインコマンド「EMW_メッセージウィンドウ指定 x」を使うことで
表示させるウィンドウIDを指定します。

上記の例では、一つ目の文章をメッセージウィンドウID1に表示し、
二つ目の文章をID2に表示します。
このように、文章イベントの実行前にプラグインコマンドで設定します。

ただし、このままではメッセージウィンドウID1とメッセージウィンドウID2は
同時に表示しません。
メッセージウィンドウID1が消えた後にメッセージウィンドウID2が表示します。


-----------------------------------------------------------------------------
拡張メッセージウィンドウを使用した複数のメッセージウィンドウの表示方法
-----------------------------------------------------------------------------
メッセージウィンドウID1を表示したままメッセージウィンドウID2を表示させる
ためには、以下のイベントの組み方が必要です。


◆プラグインコマンド：EMW_メッセージウィンドウ指定 1 終了禁止
◆文章：なし, ウィンドウ, 下
：　　：会話中に行動可能になる制御文字が使えるぜ！
：　　：いいだろう？\^
◆プラグインコマンド：EMW_メッセージウィンドウ指定 2 終了禁止
◆文章：なし, ウィンドウ, 上
：　　：いいね！
◆プラグインコマンド：EMW_メッセージウィンドウ指定 1
◆文章：なし, ウィンドウ, 下
：　　：だよな
◆プラグインコマンド：EMW_メッセージウィンドウ指定 2 終了許可
◆文章：なし, ウィンドウ, 上
：　　：俺もやってみるよ！
◆プラグインコマンド：EMW_メッセージウィンドウ強制終了 1


今度は、二人が交互に２回会話するイベントです。
先ほどの例とことなり、プラグインコマンドの引数が変わっています。

ウィンドウ指定のコマンドに、'終了禁止'をつけることで
指定したウィンドウを閉じなくすることができます。

最後の文章表示前のプラグインコマンドの'終了許可'によって
ウィンドウID2は、文章表示後にウィンドウが閉じるようになります。

また、最後のコマンドによって、ウィンドウID1は強制的に閉じます。


このような流れで、メッセージウィンドウを複数表示することができます。
あとは、2番目の文章と3番目の文章の間に、プラグインコマンドと文章を
追加していくことで、長い会話イベントを作成することができます。


-----------------------------------------------------------------------------
行動許可の設定方法
-----------------------------------------------------------------------------
１．プラグインコマンドで設定
以下のプラグインコマンドで指定したウィンドウIDを表示中のに
プレイヤーの行動を許可できます。

EMW_メッセージウィンドウ行動許可 ウィンドウID
EMW_MESSAGEWINDOW_CANMOVE windowID

または

EMW_メッセージウィンドウ指定 ウィンドウID 行動許可
EMW_MESSAGEWINDOW_SET windowID CANMOVE


２．制御文字で設定
以下の制御文字を文章中に入力することで、メッセージ表示中に
プレイヤーの行動可否を設定できます。

\EMP - 行動を許可
\DMP - 行動を禁止


！！注意１！！
行動許可の設定は、イベントのトリガーが「自動実行」または「並列処理」の場合に
有効になります。
「決定ボタン」や「○○から接触」によって実行するイベントの場合、行動許可は
無効になります。


！！注意２！！
行動許可の設定はすべてのシーンで共通です。
そのため、行動許可設定にした場合、場所移動等を行っても対象のウィンドウIDは
行動許可設定のままです。
行動禁止設定にしたい場合は、かならず行動禁止コマンドや制御文字を
実行してください。(強制終了コマンドでは行動禁止設定にはなりません)


-----------------------------------------------------------------------------
行動許可中の文章の表示
-----------------------------------------------------------------------------
イベントの文章表示中にプレイヤーの行動を許可した場合
別のイベントと会話イベントを起こすことが可能です。

この場合、文章表示中のメッセージウィンドウIDとは別のウィンドウIDに
表示させる必要があります。

文章表示のイベントコマンドの前に、ウィンドウIDを指定するコマンドを
実行してください。

なお、複数のメッセージウィンドウを表示している間に行動を許可させる場合は
表示しているすべてのウィンドウIDに対して行動許可が必要です。


-----------------------------------------------------------------------------
文章を表示しているイベントに話しかけたい場合
-----------------------------------------------------------------------------
文章を表示しているイベントに話しかけたい場合は、以下のイベントの作成方法が
あります。

1. 自動で表示させる文章表示イベントの作成
「自律移動」のタイプ「カスタム」のルート設定内に、以下のスクリプトを
入力することで文章を表示させます。

スクリプト
$gameMessageEx.window(1).add('\\EMP文章\\|\\^')

window(1) は 文章を表示させるウィンドウID の番号を指定します。
ここでは、例としてID1 を使用します。

add()内には、表示する文章を入力します。
この時、制御文字「\\EMP」でプレイヤーの行動を許可させて、
制御文字「\\|」でウィンドウを1秒表示させます。
制御文字「\\^」でプレイヤーの入力待ちを不要にします。


2. 話しかけて表示させる文章表示イベントの作成
上記と同じページの実行内容に以下のイベントを作成します。(一例です)

トリガーは「決定ボタン」です。

実行内容
◆プラグインコマンド：EMW_メッセージウィンドウ強制終了 1
◆プラグインコマンド：EMW_メッセージウィンドウ指定 2
◆文章：なし, ウィンドウ, 下
：　　：話しかけるな！

1行目のコマンドで、自動表示しているウィンドウを消します。
この時に指定する番号は、スクリプト内で使用したウィンドウIDと
合わせてください。

2行目に別のウィンドウIDを指定して、3行目で文章を表示します。


-----------------------------------------------------------------------------
シーンが変わったときの挙動について
-----------------------------------------------------------------------------
シーンが変わったときの挙動は、以下の通りです。

1. 場所移動
場所移動時に、すべてのウィンドウIDを強制終了します。


2. バトル
戦闘開始時に、すべてのウィンドウIDを強制終了します。


3. メニュー
すべてのウィンドウIDが一旦閉じます。
メニューを閉じた後の処理は、プラグインパラメータの
<Scene Start Terminate>の設定で変わります。

＜有効の場合＞
すべてのウィンドウIDを強制終了します。

＜無効の場合＞
再度ウィンドウが開きます。


！！注意！！
別の並列処理イベントで文章を繰り返し表示している場合、シーン変更の
タイミングによっては強制終了とシーン変更処理の間に文章表示コマンドを
実行してしまう場合があります。
この場合、シーン変更後にその文書を表示してしまいます。

これを回避するためには、以下のような方法があります。
１. プラグインパラメータの<Scene Start Terminate>の設定を有効にする。
２. シーン変更の直前に、並列処理イベントの動作を止めるようにイベントを組む。


-----------------------------------------------------------------------------
プラグインコマンド
-----------------------------------------------------------------------------
1. 文章の表示の強制終了

EMW_メッセージウィンドウ強制終了 すべて
EMW_MESSAGEWINDOW_CLOSE ALL
EMW_メッセージウィンドウ強制終了 Id
EMW_MESSAGEWINDOW_CLOSE Id

表示されているメッセージウィンドウを強制的に閉じます。
このとき終了禁止設定を解除します。
すべて - 表示しているすべてのウィンドウIDを強制的に閉じます。
Id　　 - 指定したウィンドウのIDを強制的に閉じます。
　　 指定しない場合は、ウィンドウID0 を閉じます。


2. 文章を表示するウィンドウを指定

EMW_メッセージウィンドウ指定 Id (終了禁止/終了許可) (行動許可/行動禁止) (幅 x) (行数 y) (左/中/右) (テキスト更新)
EMW_MESSAGEWINDOW_SET Id (NOEND/CANCLOSE) (CANMOVE/NOTMOVE) (WIDTH x) (LINES y) (LEFT/CENTER/RIGTH) (UPDATE_TEXT)

このコマンド以降に文章を表示する場合に使用する拡張ウィンドウの
メッセージウィンドウIDを指定します。

'終了禁止' または '終了許可' をつけると、IDの指定と合わせて、
ウィンドウの開閉設定ができます。

'行動許可' または '行動禁止' をつけると、IDの指定と合わせて、
ウィンドウの行動許可設定ができます。

'幅 x'をつけると、IDの指定と合わせて、
ウィンドウの幅を x pixelに設定できます。

'行数 y'をつけると、IDの指定と合わせて、
ウィンドウの高さを y 行分に設定できます。

'左' '中' または '右'をつけると、IDの指定と合わせて、
ウィンドウのX座標の表示位置を設定できます。

'テキスト更新'とつけると、IDの指定と合わせて、
制御文字で設定したウェイトやカーソル待ちを無視して
文章の表示コマンドで表示内容を上書きできます。


3. 文章を表示するウィンドウの指定をリセット

EMW_メッセージウィンドウリセット
EMW_MESSAGEWINDOW_RESET

このコマンド以降に文章を表示する場合に使用する拡張ウィンドウの
メッセージウィンドウIDをリセットします。(ID0 になる)


4. メッセージウィンドウの終了禁止(ウィンドウが閉じない)

EMW_メッセージウィンドウ終了禁止 Id
EMW_MESSAGEWINDOW_NOEND Id

指定したIDのウィンドウはメッセージ表示後に閉じなくなります。
禁止設定にしたウィンドウを閉じるためには以下の動作が必要です。

a. 強制終了コマンドで閉じる
b. 終了許可設定にした上で、新たにメッセージを表示させる。


5. メッセージウィンドウの終了許可(ウィンドウが閉じる)

EMW_メッセージウィンドウ終了許可 Id
EMW_MESSAGEWINDOW_CANCLOSE Id

指定したIDのウィンドウはメッセージ表示後に閉じるようになります。


6. メッセージウィンドウのサイズ設定(1)

EMW_メッセージウィンドウサイズ設定 Id 幅 x 行数 y
EMW_MESSAGEWINDOW_SETSIZE Id WIDTH x LINES y

指定したIDのウィンドウのサイズを設定します。
幅 - 横幅 x をpixel単位で数値指定してください。
行数 - 高さ y を行数単位で数値指定してください。

(1) この設定は一度ウィンドウが閉じるとリセットします。


7. メッセージウィンドウの表示位置設定(X座標)

EMW_メッセージウィンドウ位置設定 Id position
EMW_MESSAGEWINDOW_SETPOSITION Id position

指定したIDのウィンドウのX座標の表示位置 position を設定します。
表示したい位置に合わせて、以下の文字を指定してください。
左(left) - 画面左寄せ
中(center) - 画面中央
右(rigth) - 画面右寄せ
設定しない場合は、左寄せで表示します。

例)
EMW_メッセージウィンドウ位置設定 1 右
EMW_MESSAGEWINDOW_SETPOSITION 1 right


8. メッセージウィンドウ表示中の行動許可

EMW_メッセージウィンドウ行動許可 Id
EMW_MESSAGEWINDOW_CANMOVE Id

指定したIDのウィンドウ表示中にプレイヤーの行動を許可します。


9. メッセージウィンドウ表示中の行動禁止

EMW_メッセージウィンドウ行動禁止 Id
EMW_MESSAGEWINDOW_NOTMOVE Id

指定したIDのウィンドウ表示中のプレイヤーの行動を禁止します。


10. メッセージウィンドウ表示内容の更新

EMW_メッセージウィンドウテキスト更新 Id
EMW_MESSAGEWINDOW_UPDATE_TEXT Id

指定したIDのウィンドウ表示内容を
制御文字で設定したウェイトやカーソル待ちを無視して
文章の表示コマンドで上書きできます。


-----------------------------------------------------------------------------
スクリプト
-----------------------------------------------------------------------------
拡張メッセージウィンドウのゲームデータは以下のスクリプトで参照できます。
$gameMessageEx.window(ウィンドウID)


拡張メッセージウィンドウのゲームデータに使用できる関数や変数は
MVデフォルトのメッセージウィンドウ($gameMessage)と同じです。

以下に、スクリプトの一例を示します。

1. 文章の表示
$gameMessageEx.window(ウィンドウID).disp('文章')
:ウィンドウIDの表示設定を初期化した後に、'文章'を表示します。
:'文章'には制御文字が使用できますが、この時は'\\v[1]'の用に
:'\'記号を2つ使う必要があるので注意です。
:文章中に'\n'を追記すると、その部分で改行します。('\'は一つです)

$gameMessageEx.window(ウィンドウID).add('文章')
:ウィンドウIDに'文章'を追加します。
:このスクリプトを複数回連続して使うことで、複数行の文章を表示できます。


2. 顔画像の設定
$gameMessageEx.window(ウィンドウID).setFaceImage('顔画像名', 顔番号)
:顔画像名 - 表示する顔画像のファイル名です。(例:'Actor1')
:顔番号　 - ファイル内の何番目の顔かを指定する番号です。左上が 0番です。


3. 背景の設定
$gameMessageEx.window(ウィンドウID).setBackground(背景番号)
:背景番号 - ウィンドウ(0) か 暗くする(1) か 透明(2) から選びます。
: 表示したい背景タイプの番号を指定してください。


4. 表示位置(Y座標)の設定
$gameMessageEx.window(ウィンドウID).setPositionType(位置番号)
:位置番号 - 上(0) か 中(1) か 下(2) から選びます。
: 表示したい位置の番号を指定してください。


5. 表示内容の初期化
$gameMessageEx.window(ウィンドウID).clear()
:表示する文章や顔画像等の設定内容を初期化します。
:なお、終了禁止設定と行動許可設定は解除しません。


6. ウィンドウの終了禁止
$gameMessageEx.window(ウィンドウID).prohibitClose()
:指定したウィンドウIDを終了禁止設定にします。


7. ウィンドウの終了許可
$gameMessageEx.window(ウィンドウID).permitClose()
:指定したウィンドウIDを終了許可設定にします。


8. ウィンドウの強制終了
$gameMessageEx.window(ウィンドウID).terminate()
:指定したウィンドウIDを強制終了します。


9. ウィンドウのサイズ設定
$gameMessageEx.window(ウィンドウID).setWindowSize(幅, 行数)
:指定したウィンドウIDのサイズを変更します。
:幅 - 横幅をpixel単位で数値指定してください。
:行数 - 高さを行数単位で数値指定してください。
:それぞれ、0 を指定するとデフォルトサイズを使用します。


10. 表示位置(X座標)の設定
$gameMessageEx.window(ウィンドウID).setWindowX(位置番号)
:指定したウィンドウIDのX座標の位置を変更します。
:位置番号 - 左(0) か 中(1) か 右(2) から選びます。
: 表示したい位置の番号を指定してください。


11. ウィンドウ表示時の行動許可
$gameMessageEx.window(ウィンドウID).enabledCanMovePlayer()
:指定したウィンドウIDの表示中のプレイヤーの行動を許可します。


12. ウィンドウ表示時の行動禁止
$gameMessageEx.window(ウィンドウID).disabledCanMovePlayer()
:指定したウィンドウIDの表示中のプレイヤーの行動を禁止します。


-----------------------------------------------------------------------------
本プラグインのライセンスについて(License)
-----------------------------------------------------------------------------
本プラグインはMITライセンスのもとで公開しています。
This plugin is released under the MIT License.

Copyright (c) 2017 Futokoro
http://opensource.org/licenses/mit-license.php


-----------------------------------------------------------------------------
変更来歴
-----------------------------------------------------------------------------

v2.4.0 - 2017/08/21 : 機能追加
1. バトル画面に対応。

v2.3.1 - 2017/07/06 : 不具合修正
1. v2.3.0の不具合(戦闘開始時にエラー)修正。

v2.3.0 - 2017/06/25 : 機能追加
1. 表示するテキスト内容を強制更新する機能を追加。

v2.2.0 - 2017/06/09 : コアスクリプトv1.5.0に対応

v2.1.2 - 2017/05/31 : 不具合修正
1. 決定ボタン待ちのウィンドウを正常に強制終了できない不具合を修正。

v2.1.1 - 2017/05/25 : 不具合修正
1. ウィンドウの強制終了が正常に動作しない不具合を修正。

v2.1.0 - 2017/05/24 : 仕様見直し、機能追加、ヘルプ修正
1. ウィンドウが閉じても行動許可を解除しないように変更。
2. 行動許可中の文章の表示コマンドの実行判定を見直し。
3. イベント終了時にウィンドウIDをリセットする機能を追加。
4. プラグインコマンドにウィンドウIDの行動禁止コマンドを追加。

v2.0.13 - 2017/05/14 : 他プラグインとの競合修正
1. ウィンドウを閉じる時の設定リセット機能を見直し。

v2.0.12 - 2017/05/14 : 不具合修正
1. デフォルトウィンドウが表示終了時にエラーになる不具合修正。

v2.0.11 - 2017/05/14 : 不具合修正
1. ウィンドウを終了禁止にした後に表示内容を更新できない不具合を修正。
2. ウィンドウの表示位置とサイズの設定が、ウィンドウを閉じても
元に戻らない不具合を修正。

v2.0.10 - 2017/05/08 : プラグインコマンド追加・修正

v2.0.9 - 2017/05/07 : 不具合修正
1. 自動実行または並列処理による文章コマンドに対して、行動許可禁止の
機能が正しく動作していなかった不具合を修正。
2. バトル開始時にすべてのウィンドウIDを強制終了するように変更。

v2.0.8 - 2017/05/06 : 機能追加
1. シーン開始時のウィンドウの挙動を設定する機能を追加。

v2.0.7 - 2017/05/04 : 不具合修正
1. ウィンドウID0 が正しく動作しない不具合を修正。

v2.0.6 - 2017/05/04 : 機能追加
1. 場所移動時に、ウィンドウIDを強制終了させる機能を追加。
2. ウィンドウのX座標位置とサイズの設定機能を見直し。

v2.0.5 - 2017/05/04 : プラグインコマンド、スクリプト追加
1. 文章表示用のスクリプト追加
2. ウィンドウのX座標位置とサイズを指定するコマンド追加

v2.0.4 - 2017/05/02 : 機能追加、スクリプト追加
1. マップメモ欄でウィンドウID生成数を設定するタグを追加

v2.0.3 - 2017/05/01 : プラグインパラメータの不具合修正
1. <Create ExWindow Number>の設定値0の機能を削除
v2.0.2 - 2017/05/01 : 不具合修正

v2.0.1 - 2017/05/01 : 機能追加、ヘルプ修正
1. 強制終了コマンドに表示中の全ウィンドウIDを指定する機能を追加
v2.0.0 - 2017/04/24 : v1から仕様全面見直し

-----------------------------------------------------------------------------