テキストファイルの文章をウインドウに表示する - InstallText.js

シェア用テキスト：

▼テキストファイルの文章をウインドウに表示する（こばた ふたる様作） - InstallText.js
https://plugin.fungamemake.com/archives/29323
テキストファイルの文章をメッセージウインドウに表示するプラグインです。テキストファイル内にタグを記述することで、文章の表示の停止/再開、ラベルジャンプなど様々な機能が使えます。MVMZ両方に対応しています。

ふりがな：てきすとふぁいるの　ぶんしょうを　ういんどうに　ひょうじする

機能概要： テキストファイルの文章をメッセージウインドウに表示するプラグインです。テキストファイル内にタグを記述することで、文章の表示の停止/再開、ラベルジャンプなど様々な機能が使えます。MVMZ両方に対応しています。

利用規約（ライセンス）： MITライセンス

作者：こばた ふたる

作者サイト：https://twitter.com/Kass_kobataku

解説ページ：https://github.com/PhthalKobata/RPGMakerMVMZ/blob/maste…

直接ダウンロード：Zipファイル

ダウンロードページ：https://raw.githubusercontent.com/PhthalKobata/RPGMaker…

ファイル名：InstallText.js

プラグインのヘルプ：

/*
 * @help 
 * This is released under the MIT Licence.
 * このプラグインは作者に無断で改変可能です。
 * 同人・商業・18禁、有償作品などいかなる形態の作品にも利用できます。
 * RPGツクール(RPG Maker) MV/MZに対応しています。
 * 
 * チュートリアル方式の使い方はコチラ↓
 * https://github.com/PhthalKobata/RPGMakerMVMZ/blob/master/InstallText%E3%81%AE%E4%BD%BF%E3%81%84%E6%96%B9.pdf
 * 
 * プラグインコマンド
 * phk_installText build ファイル名  : テキストを読み込みプログラムを立ち上げ初期化
 * phk_installText init             : シナリオ進行を初期化（テキストの最初からに）する
 * phk_installText start            : シナリオ進行を開始・stopの後から再開
 * phk_installText jump ラベル名     : labelに飛ぶ
 * phk_installText end              : シナリオ進行を終了
 * phk_installText destruct         : テキストデータの解放
 * phk_installText debug index      : 何番目の文章またはタグを参照しているか
 * phk_installText debug done       : シナリオが進行しているかどうか
 * phk_installText_convert ファイル名: 指定のファイルのいテキスト変数などを展開したtextを出力する
 * 
 * 【タグ】
 * 
 * テキストに記述するイベントタグの記法
 * #e{stop}    : シナリオの進行を一時的に抜ける
 * #l{ラベル名} : ラベル {} の中に任意のラベル名を入れる
 * #e{end}     : シナリオの終了
 * 
 * #o{選択肢1 (=>ラベル1), 選択肢2 (=>ラベル2), ...}
 * または
 * #o{
 * 選択肢1 (=>ラベル1)
 * 選択肢2 (=>ラベル2)
 * }
 * 　　　      ：選択肢の表示
 * 　　　　　　　選択肢はコンマ区切りか改行区切り
 *              末尾に選択肢を選んだときにジャンプするラベル名を (=>ラベル名) の形式で記載
 * 　　　　　　　末尾の (=>ラベル名) は省略可能
 * 　　　　　　　（省略した選択肢を選んだ場合はラベルジャンプせずに次の文章が表示されます）
 * 
 * 
 * 
 * プラグインパラメータの「テキストタグ設定>一時停止・終了タグの設定」で#e{}の中身の記法を変更できます。
 * 
 * ツクールコマンドの記法
 * \v[4] (本文に直に書く場合はそのまま)
 * ただし後述する変数に入れる場合は\\v[4]とする。
 * 
 * 変数の使い方
 * プラグインパラメータの「テキストタグ設定>テキスト変数の設定」に記述します。
 * 記述方法は以下です。
 * プラグインパラメータでの設定　：主人公 = ハロルド
 * テキストでの変数の使用　　　　：$v{主人公}
 * パラメータには他のテキスト変数や制御文字も使用できます。
 * 例：　主人公2 = $c{赤}\\v[1]$c{白}($c{青}$v{変身状態}の姿$c{白})
 * このプラグインのdefaultParameterのvariableで直接設定もできます。
 * 
 * カラーコード
 * $c{blue}などで\C[n]を取得できます。
 * ツクールのカラーパレットを編集している人とか{}に入れる色の名前を変えたい人は
 * プラグインパラメータの「テキストタグ設定>色制御文字の設定」で設定を上書きできます。
 * 記述方法はテキスト変数の設定と同じです。
 * このプラグインのdefaultParameterのcolorを編集してもできます。
 * 
 * unicode文字の使用
 * $u{ハート}などで記述する事で文字化けのリスクを回避できます。
 * 16進数の文字コードを調べる必要がありますが、プラグインパラメータの「テキストタグ設定>unicode文字の設定」で設定できます。
 * 記述方法はテキスト変数の設定と同じです。
 * deefaultParameterのunicodeでも追加が可能です。
 * 他と同様にキーを編集すれば{}内に入れる文字も変更できます。
 * 
 * コメントアウト
 * //{コメントの中身}と記述すると、コメントアウト扱いになり文章に反映されません。
 * 文章中に挿入されていてもコメントアウトになります。
 * 例：あいう//{コメント}えお -> あいうえお
 * 
 * 【ウインドウに関するパラメーター】
 * このパラメーターは一度設定すると、変更されるまで設定が引き継がれます。
 * 例えばウインドウ表示を中央に設定すると、下に設定し直すまで中央に設定され続けます。
 * 
 * ウインドウ設定
 * !b{暗く} !p{上} などでウインドウを設定できます。
 * 設定を反映させたい文章の直前に記述してください。
 * {}内のデフォルトでは以下ですがプラグインパラメータの「テキストタグ設定>テキストウインドウの設定」で変更できます。
 * 通常・暗く・透明
 * 上・中・下
 * 
 * 顔グラの設定
 * !f{Actor1,4}のように{ファイル名,番号}で指定します。
 * 顔グラなしの場合は!f{,0}としてください。
 * 設定を反映させたい文章の直前に記述してください。
 * 
 * 名前欄の設定(MZのみ)
 * !s{なまえ}と指定すると名前欄に「なまえ」が表示されます。
 * 名前欄の表示を消すときは!s{}としてください。
 * MVで使用すると表示する文の先頭に追記されますので、4行の文章では改ページがずれます。
 * 
 * 
 * タグ記法の変更方法
 * タグの記法$vなどは変更可能です。
 * プラグインパラメータの「定義>○○タグ」で設定を変更できます。
 * 例えば$vを%hに書き換えれば%h{変数}に変化します。
 * ただし、複数項目でタグの名前が被ってもエラー検出されないので名前被りには注意してください。
 * また$$v{}と$v{}のような一部が被るパターンも回避してください。
 * 
 * 文章コンバートについて
 * このプラグインでゲームを作るとどうしてもテキストファイルがむき出しになります。（エニグマとか使えば別ですが）
 * テキストむき出しは嫌だという人のための機能として、文章コンバート機能を搭載しています。
 * これによって変換されたテキストをコピーして「文章の表示（一括入力）」でペーストできます。
 * ただしウインドウの設定は反映されないので注意してください。
 * 適当なイベントを作成して以下を設定、ゲームを起動してイベントを実行してください。
 * MV: phk_installText_convert ファイル名
 * MZ: 変換テキスト出力　ファイル名
 * ファイル名には*（任意の文字列）や?（任意の一文字）を使用できます。
 * 例えばファイル名を*.txtにするとテキストファイルすべてが一度に変換されます。
 * 出力されたファイルは!converted_○○です。
 * 
 * 
 * その他
 * ・このプラグインは文章とアクションを切り離して記述することを想定しています。
 * 　そのためツクール内での文章の閲覧はできません。
 * ・ビルドされたテキストは複数のイベント間での共有はできません。
 * 　イベントまたはコモンイベント毎にビルドしてください。
 * ・変数で変数名を生成するような記述は正常に作動しません。やらないでください。
 * 　例：いろは = $v{$v{いろは}にほ}$c{青}　など$v{$v{}}の形になるのはダメ。
 * ・変数の入れ子は可能です。
 * 　例：abc = aaabbbccc, def = dddeeefff, xyz = $v{abc}$v{def}
 *   $v{xyz} -> $v{abc}$v{def} -> aaabbbcccdddeeefff
 * ・やる人いないと思いますが、想定外なテキスト（1000万字の壮大なテキストなど）
 * 　イタズラめいた設定（変数を1万回入れ子するなど）ではバグることがあります。
 * 　また変数を循環参照すると動かなくなるので注意してください。
 * 　いろは = $v{ほへと}, ほへと = $v{いろは}　はダメ。
 * ・シナリオを適切に終了せずにイベントを終了させてしまう（例：#e{stop}でシナリオを抜けたままイベントを終了させる）と、
 * 　セーブができなくなるなどのバグが起こることがあります。
 * 　「#e{end}を使う」「テキストの終端までジャンプする」「テキストデータ解放コマンドを使う」のいずれかで正常に終了します。
 * 
*/