メッセージウィンドウを拡張するプラグイン – FTKR_ExMessageWindow.js

-----------------------------------------------------------------------------
概要
-----------------------------------------------------------------------------
文章の表示等に使用できる制御文字に、以下の制御文字を追加します。

1. サブウィンドウで文章の表示
\SUBA[表示位置, 文章, 顔画像ファイル名, 顔画像番号)]
\SUBB[表示位置, 文章, 顔画像ファイル名, 顔画像番号)]
\SUBW[ウィンドウ番号, 顔画像設定, ウィンドウ設定, 表示位置, 文章]
:サブAとサブBのウィンドウは同時に表示できます。
:この制御文字は、文章の表示時にのみ使用できます。


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


-----------------------------------------------------------------------------
「サブウィンドウで文章の表示」機能
-----------------------------------------------------------------------------
以下の制御文字で画像を表示できます。
顔画像ファイル名と顔画像番号の入力方式はどちらを使用しても同じ結果になります。

\SUBA[表示位置, 文章, 顔画像ファイル名, 顔画像番号]
\SUBA[表示位置, 文章, 顔画像ファイル名(顔画像番号)]

\SUBB[表示位置, 文章(, 顔画像ファイル名, 顔画像番号)]
\SUBB[表示位置, 文章, 顔画像ファイル名(顔画像番号)]

\SUBW[ウィンドウ番号, 顔画像ファイル名(顔画像番号), 背景設定, 表示位置, 文章]

ウィンドウ番号
:表示するサブウィンドウの番号を指定します。
: 0 - サブウィンドウA
: 1 - サブウィンドウB
:後述するスクリプトで指定するウィンドウ番号と同じ意味です。

表示位置
:画面内でサブウィンドウを表示する位置を指定します。
: 0 または 上 - 画面上部
: 1 または 中 - 画面中央
: 2 または 下 - 画面下部
: 左 - 画面左寄せ
: 右 - 画面左寄せ
: 「左上」のように組み合わせて指定できます。

文章
:サブウィンドウに表示する文章を記載します。
:制御文字を使用したい場合は、別途入力が必要です。

顔画像ファイル名
:表示させたい顔画像のファイル名を指定します。
:入力しない場合は表示しません。

顔画像番号
:顔画像ファイル内の何番目の画像を表示するか指定します。
:入力しない場合は0番目を表示します。

背景設定
:背景設定は、以下の数字または文字で指定します。
: 0 または ウィンドウ
: 1 または 暗くする
: 2 または 透明
:空欄の場合は、ウィンドウタイプになります。

入力例)
\SUBA[上,こんにちは]
画面上部に、サブウィンドウAに「こんにちは」を表示します。

\SUBA[0,こんにちは,Actor1,2]
\SUBA[上,こんにちは,Actor1(2)]
画面上部に、Actor1.pngの2番目の顔画像付きで
サブウィンドウAに「こんにちは」を表示します。

\SUBW[0, Actor1(2), 暗くする, 上, こんにちは]
画面上部に、Actor1.pngの2番目の顔画像付きでサブウィンドウ0番を
「こんにちは」という内容で表示します。
背景設定は「暗くする」になります。


-----------------------------------------------------------------------------
サブウィンドウを表示するタイミングについて
-----------------------------------------------------------------------------
サブウィンドウを表示するタイミングは、文章の表示欄に制御文字を
挿入した箇所で決まります。

入力例）下のようにイベントで文章の表示を実行したとします。

◆文章：Actor1(1),ウィンドウ,下
： ：こんにちは
： ：\SUBA[0,こんにちは,Actor1,2]いい天気ですね
◆

この場合は、下の順番で表示します。

1.メインウィンドウが画面下部に表示
2.メインウィンドウに「こんにちは」が表示
3.画面上部にサブウィンドウAが表示
4.サブウィンドウAに「こんにちは」が表示し、入力待ち
5.入力後、メインウィンドウに「いい天気ですね」が表示、入力待ち
6.入力後、メインウィンドウとサブウィンドウAが消える

上記の通りに、サブウィンドウが消えるタイミングは、メインウィンドウの表示が
終了した後になります。


-----------------------------------------------------------------------------
サブウィンドウに制御文字を使用したい場合
-----------------------------------------------------------------------------
サブウィンドウに制御文字を使用したい場合は、スクリプトで表示内容を設定する
必要があります。

以下のスクリプトコマンドを、文章を表示するイベントコマンドの前に
実行してください。

$gameSubMessage.add(ウィンドウ番号,'表示内容')

ウィンドウ番号
:表示するサブウィンドウに合わせて、以下の数値を指定してください。
:0 - サブウィンドウA
:1 - サブウィンドウB

表示内容
:表示したい内容を''で囲って入力してください。
:制御文字を使用できますが、制御文字を入力する場合は
:必ずバックスラッシュ(\)を2重にしてください。
:なお、ここで入力した内容を、1行分として表示します。


入力例)アイコンID76を、サブウィンドウAに表示させる場合
◆スクリプト：$gameSubMessage.add(0,'これでアイコン\\I[76]を表示します')
◆文章：Actor1(1),ウィンドウ,下
： ：サブウィンドウでアイコンを表示させます。
： ：\SUBA[0,ここは2行目です,Actor1,2]
◆
この場合、
1.メインウィンドウに「サブウィンドウでアイコンを表示させます。」が表示
2.画面上部にサブウィンドウAが表示
3.サブウィンドウAに
「これでアイコンを表示します
　ここは2行目です」
が表示し、入力待ち
⇒の部分にアイコンを表示します。
3の結果のように、スクリプトで入力した文章の次の行に、
制御文字で入力した文章を表示します。


-----------------------------------------------------------------------------
サブウィンドウのサイズを変更したい場合
-----------------------------------------------------------------------------
サブウィンドウのサイズを変更したい場合は、以下のスクリプトを
文章を表示するイベントコマンドの前に実行してください。

$gameSubMessage.setWindowSize(ウィンドウ番号, ウィンドウ幅, 行数)

ウィンドウ番号
:表示するサブウィンドウに合わせて、以下の数値を指定してください。
:0 - サブウィンドウA
:1 - サブウィンドウB

ウィンドウ幅
:ウィンドウの横幅を、画面サイズと同じ幅を100として百分率で
:指定してください。

行数
:ウィンドウの高さを、表示できる行数で指定してください。


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

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


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

v1.0.2 - 2017/04/02 : 機能追加
1. サブウィンドウの表示位置を日本語で指定できる機能を追加。
2. サブウィンドウ表示用の制御文字を追加。

v1.0.1 - 2017/03/30 : ヘルプ修正

v1.0.0 - 2017/03/28 : 初版作成

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