NRP メッセージウィンドウを調整 - NRP_MessageWindow.js

シェア用テキスト：

▼NRP メッセージウィンドウを調整（砂川赳様作） - NRP_MessageWindow.js
https://plugin-mz.fungamemake.com/archives/6040
メッセージウィンドウに対して様々な調整を行います。メッセージ表示の３行化、ウィンドウサイズの可変化、ウィンドウの画像化

ふりがな：めっせーじうぃんどうをちょうせい

機能概要： メッセージウィンドウに対して様々な調整を行います。メッセージ表示の３行化、ウィンドウサイズの可変化、ウィンドウの画像化

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

作者：砂川赳

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

解説ページ：https://newrpg.seesaa.net/article/492543897.html

ファイル名：NRP_MessageWindow.js

プラグインのヘルプ：

/*:ja
 * @target MZ
 * @plugindesc v1.043 メッセージウィンドウを調整する。
 * @author 砂川赳（http://newrpg.seesaa.net/）
 * @url https://newrpg.seesaa.net/article/492543897.html
 *
 * @help メッセージウィンドウに対して様々な調整を行います。
 * 例えば、ウィンドウのサイズや位置を調整できます。
 * 
 * -------------------------------------------------------------------
 * ■メッセージ表示の３行化
 * -------------------------------------------------------------------
 * 例えば、フォントを大きくしてメッセージを３行表示にすれば、
 * 文章を読みやすくすることができます。
 * 
 * 調べてみれば分かりますが、今時のＪＲＰＧやＡＤＶは
 * ２～３行＋名前欄というスタイルが主流です。
 * ＭＺデフォルトの４行＋名前欄というスタイルは、
 * かなり文章量が多く、文字も小さくなりがちなので読みづらいです。
 * 何も考えず初期状態を踏襲することはあまりオススメしません。
 * 
 * この際、『一行の縦幅』を広くすることがポイントです。
 * 特に漢字にルビを振るプラグインと併用する場合は、
 * 行間を広めに取ることをオススメします。
 * 
 * -------------------------------------------------------------------
 * ■ウィンドウサイズの可変化
 * -------------------------------------------------------------------
 * ほとんどの項目で数式が使用可能です。
 * 例えば『ウィンドウの縦幅』を「$gameVariables.value(1)」にすれば、
 * 変数１の値によって、メッセージウィンドウの縦幅が変化するようになります。
 * 
 * 例えば「一枚絵を表示するシーンでは文章を２行にしたい」
 * といった場合に便利です。
 * 
 * -------------------------------------------------------------------
 * ■ウィンドウの画像化
 * -------------------------------------------------------------------
 * メッセージウィンドウおよび名前欄を画像で表示することができます。
 * 画像はimgsystemフォルダに配置してください。
 * 
 * メッセージウィンドウと名前欄で別々の画像を使用する方法と、
 * 名前の表示がある場合のみ、別の画像を使用する方法の二通りに対応しています。
 * 
 * また、そのままだと元のウィンドウが残ってしまうため、
 * 不透明度を０にした上で、枠を非表示にしてください。
 * ※元のウィンドウを残した上で画像で装飾しても構いません。
 * 
 * -------------------------------------------------------------------
 * ■マスク画像機能
 * -------------------------------------------------------------------
 * 『マスク画像』を設定することで、ウィンドウの透明度を細かく設定できます。
 * 例えば、ウィンドウの右側だけ透明度を上げるといった調整ができます。
 * マスク画像の白い部分が不透明で黒い部分が透明となります。
 * ※詳細はサンプル画像をご覧ください。
 * 
 * なお、ＲＰＧツクールＭＶではなぜか機能しないのでＭＺ専用です。
 * 
 * -------------------------------------------------------------------
 * ■利用規約
 * -------------------------------------------------------------------
 * 特に制約はありません。
 * 改変、再配布自由、商用可、権利表示も任意です。
 * 作者は責任を負いませんが、不具合については可能な範囲で対応します。
 * 
 * @------------------------------------------------------------------
 * @ プラグインパラメータ
 * @------------------------------------------------------------------
 * 
 * @param <MessageWindow>
 * @text ＜メッセージウィンドウ＞
 * 
 * @param WindowWidth
 * @parent <MessageWindow>
 * @text ウィンドウの横幅
 * @default Graphics.boxWidth
 * @desc メッセージウィンドウの横幅です。
 * 初期値は「Graphics.boxWidth」です。
 * 
 * @param WindowHeight
 * @parent <MessageWindow>
 * @text ウィンドウの縦幅
 * @default this.fittingHeight(4) + 8
 * @desc メッセージウィンドウの縦幅です。
 * 初期値は「this.fittingHeight(4) + 8」です。
 * 
 * @param WindowX
 * @parent <MessageWindow>
 * @text ウィンドウのＸ座標
 * @desc メッセージウィンドウを表示するＸ座標です。
 * 
 * @param WindowY
 * @parent <MessageWindow>
 * @text ウィンドウのＹ座標
 * @default (this._positionType * (Graphics.boxHeight - this.height)) / 2
 * @desc メッセージウィンドウを表示するＹ座標です。
 * 初期値：(this._positionType * (Graphics.boxHeight - this.height)) / 2
 * 
 * @param LineHeight
 * @parent <MessageWindow>
 * @text 一行の縦幅
 * @desc 文章の一行当たりの縦幅です。
 * 初期値は36です。
 * 
 * @param AdjustMessageX
 * @parent <MessageWindow>
 * @text 文章のＸ座標補正
 * @type number @min -9999 @max 9999
 * @desc 文章のＸ座標を調整します。
 * 
 * @param AdjustMessageY
 * @parent <MessageWindow>
 * @text 文章のＹ座標補正
 * @type number @min -9999 @max 9999
 * @desc 文章のＹ座標を調整します。
 * 
 * @param MessageFontSize
 * @parent <MessageWindow>
 * @text 文章のフォントサイズ
 * @desc 文章のフォントサイズです。
 * 
 * @param WindowOpacity
 * @parent <MessageWindow>
 * @text ウィンドウの不透明度
 * @desc メッセージウィンドウの不透明度です。
 * 255で完全な不透明になります。
 * 
 * @param HideWindowFrame
 * @parent <MessageWindow>
 * @text ウィンドウ枠を非表示
 * @type boolean
 * @default false
 * @desc メッセージウィンドウの枠を非表示にします。
 * 
 * @param WindowImage
 * @parent <MessageWindow>
 * @text ウィンドウ画像
 * @type file
 * @dir img/system
 * @desc ウィンドウ用の画像です。
 * 
 * @param AdjustWindowImageX
 * @parent WindowImage
 * @text ウィンドウ画像のＸ補正
 * @type number @min -9999 @max 9999
 * @desc ウィンドウ画像のＸ座標を調整します。
 * 
 * @param AdjustWindowImageY
 * @parent WindowImage
 * @text ウィンドウ画像のＹ補正
 * @type number @min -9999 @max 9999
 * @desc ウィンドウ画像のＹ座標を調整します。
 * 
 * @param WindowImageName
 * @parent WindowImage
 * @text ウィンドウ画像（名前付）
 * @type file
 * @dir img/system
 * @desc 名前欄がある場合、通常のウィンドウ画像の代わりに使用する画像です。
 * 
 * @param MaskImage
 * @parent <MessageWindow>
 * @text マスク画像
 * @type file
 * @dir img/system
 * @desc ウィンドウに半透明処理を施すマスク画像です。
 * この機能はＭＺ専用です。
 * 
 * @param NoMaskOpacity
 * @parent MaskImage
 * @text マスク対象外の不透明度
 * @desc メッセージウィンドウにマスクを適用できなかった場合の不透明度です。
 * 
 * @param FixIconY
 * @parent <MessageWindow>
 * @text アイコンのＹ座標修正
 * @type boolean
 * @default true
 * @desc 一行の縦幅を変更した時に、アイコンのＹ座標がズレる問題を修正します。
 * 
 * @param <NameBoxWindow>
 * @text ＜名前欄＞
 * @desc 名前欄に関する項目です。
 * ツクールＭＶでは存在しないため無効です。
 * 
 * @param NameBoxAdjustX
 * @parent <NameBoxWindow>
 * @text 名前欄のＸ座標補正
 * @desc 名前欄のＸ座標補正値です。
 * 
 * @param NameBoxAdjustY
 * @parent <NameBoxWindow>
 * @text 名前欄のＹ座標補正
 * @desc 名前欄のＹ座標補正値です。
 * 
 * @param NameBoxFontSize
 * @parent <NameBoxWindow>
 * @text 名前欄のフォントサイズ
 * @desc 名前欄のフォントサイズです。
 * 
 * @param NameBoxOpacity
 * @parent <NameBoxWindow>
 * @text 名前欄の不透明度
 * @desc 名前欄の不透明度です。
 * 255で完全な不透明になります。
 * 
 * @param HideNameBoxFrame
 * @parent <NameBoxWindow>
 * @text 名前欄の枠を非表示
 * @type boolean
 * @default false
 * @desc 名前欄の枠を非表示にします。
 * 
 * @param OverlapNameBox
 * @parent <NameBoxWindow>
 * @text 名前欄の重なり対応
 * @type boolean
 * @default false
 * @desc 名前欄が重なっても、メッセージウィンドウが消えないようにします。
 * 
 * @param NameBoxImage
 * @parent <NameBoxWindow>
 * @text 名前欄画像
 * @type file
 * @dir img/system
 * @desc 名前ウィンドウ用の画像です。
 * 
 * @param AdjustNameBoxImageX
 * @parent NameBoxImage
 * @text 名前欄画像のＸ補正
 * @type number @min -9999 @max 9999
 * @desc 名前画像のＸ座標を調整します。
 * 
 * @param AdjustNameBoxImageY
 * @parent NameBoxImage
 * @text 名前欄画像のＹ補正
 * @type number @min -9999 @max 9999
 * @desc 名前欄画像のＹ座標を調整します。
 * 
 * @param <ChoiceWindow>
 * @text ＜選択肢＞
 * @desc 選択肢に関する項目です。
 * 
 * @param FixChoiceX
 * @parent <ChoiceWindow>
 * @text 選択肢のＸ座標修正
 * @type boolean
 * @default true
 * @desc 選択肢ウィンドウのＸ座標をメッセージウィンドウに合わせます。
 */