#freeze
TITLE:テキスト表示関連コマンド（Ver16.6.1）
#contents
~
*文字窓（textbox）[#textbox]
文字窓 txtbox1 0 480 80 1280 200 imgnmincho.ttf 24 "いつもここから"
-ノベルゲームで一般的に用いられる、連続段階でテキストを表示してゆくテキストボックスを設定します。
''このコマンドを設定しておかなければ、「"」等の使用によってエディター上で青にハイライトされているテキストをゲーム上に表示できません''。忘れずに設定・適用しましょう。
-設定する前に、文字窓において用いる''フォントのファイルをFontsフォルダに入れておく必要があります''。
-透明度を0にすると、テキスト進行が防がれます。
-Ver7.6.0から、文字窓に対するコマンド「移動」「拡大」「回転」の適用が可能になりました。
-文字窓0……透明度を0に設定します。
-Ver8.0.0から、初期表示テキストの設定が可能になりました。
文字速度変更時等のテストテキストの表示に文字窓を用いる際等において設定するものと思われます。
--Ver12.10.0から、初期表示テキストに改行文字「\n」を用いることが可能になりました。
-Ver14.4.0より、''テキストが文字窓範囲を超過する場合にエラーとなる''よう仕様が変更されました。
これは、設定項目「超過無視」の指定、またはコマンド「文字超過自動待機」を有効化することで回避できます。
参照：[[文字超過自動待機>#textOverflowAutoWait]]
||設定項目|記述の種類|説明|h
|&color(Red){【必須】};|名前|命名|文字窓に設定する個体名|
|&color(Red){【必須】};|x座標|数値|文字窓左上の頂点のx座標（左右方向の座標）|
|&color(Red){【必須】};|y座標|数値|文字窓左上の頂点のy座標（上下方向の座標）|
|&color(Red){【必須】};|r座標|数値|文字窓左上の頂点のr座標（手前方向の座標）|
|&color(Red){【必須】};|幅|数値|文字窓の左右方向の大きさ|
|&color(Red){【必須】};|高さ|数値|文字窓の上下方向の大きさ|
|&color(Red){【必須】};|フォント名|ファイル名|ファイル名文字窓で使用するフォントのファイル名|
|&color(Red){【必須】};|フォント大きさ|数値|使用フォントの表示サイズ（単位：px）|
||超過無視|設定項目の語句&br;（超過無視）|テキストが文字窓範囲を超過する際にエラーとしない|
||カメラオプション|※1|カメラに対する反映方法|
||初期表示テキスト|テキスト|文字窓表示時に必ず最初に表示するテキスト|
※1……「カメラオプション」に関しては項目参照：[[カメラオプションについて>command#command1a5]]
///////////////////////////////////////////////////////////////////////////////////
*使用文字窓（useTextbox）[#useTextbox]
使用文字窓 txtbox1
-このコマンド設定以降においては、指定した文字窓を用いてテキストを表示します。
''このコマンドが存在しない限り、コマンド「文字窓」で設定した文字窓は使用されません''。忘れずに設定しておきましょう。
-文字窓として指定できる個体には、文字窓個体だけでなく、文字個体も含まれます。
Ver14.4.0において、コマンド「続行」が文字窓指定された文字個体も対象とするよう拡張されました。
||設定項目|記述の種類|説明|h
|&color(Red){【必須】};|対象名|個体名|使用する文字窓の個体名|
///////////////////////////////////////////////////////////////////////////////
*文字（text）[#text]
文字 ch_name1 500 20 130 antadare.ttf 20 "知らないヤツ" バックログ登録
-''文字窓とは独立してテキストを表示します''。
つまり、1文字ずつの段階表示をするテキストではなく、文字群としてのテキストを設定できるということです。
--Ver14.0.0より、設定項目「バックログ登録」を指定することで、文字群をバックログに記録することができます。
-整形指定時は、x軸方向のみに整形を適用します（縦書き適用時はy軸方向）。
-テキスト最大長さを設定した場合、指定字数を超える文字は文頭から指定字数分のみを表示し、残りは表示されません。
サンプルスクリプトにおいてはセーブ時に文字窓で表示しているテキストを記録・表示する文字に設定されています。
-設定する前に、文字群において用いる''フォントのファイルをFontsフォルダに入れておく必要があります''。
-Ver7.6.0から、文字窓に対するコマンド「移動」「拡大」「回転」の適用が可能になりました。
-文字0……透明度を0に設定します。
||設定項目|記述の種類|説明|h
|&color(Red){【必須】};|名前|命名|文字群に設定する個体名|
|&color(Red){【必須】};|x座標|数値|文字群の仮想長方形領域の左上頂点のx座標（左右方向の座標）|
|&color(Red){【必須】};|y座標|数値|文字群の仮想長方形領域の左上頂点のy座標（上下方向の座標）|
|&color(Red){【必須】};|r座標|数値|文字群の仮想長方形領域の左上頂点のr座標（手前方向の座標）|
|&color(Red){【必須】};|フォント名|ファイル名|文字群に使用するフォントのファイル名|
|&color(Red){【必須】};|フォント大きさ|数値|文字群に適用するフォント高さ（単位：px）|
||行大きさ|数値|文字群における1行のサイズ（単位：px）|
||縦&br;または&br;横|設定項目の語句&br;（縦・横）|文字群の方向の指定|
||左&br;または&br;中央&br;または&br;右|設定項目の語句&br;（左・中央・右）|文字群の整形の指定|
||テキスト最大長さ|数値|表示する文字数の最大値|
||カメラオプション|※1|カメラに対する反映方法|
|&color(Red){【必須】};|"テキスト"|テキスト|表示する文字群|
||バックログ登録|設定項目の語句&br;（バックログ登録）|文字群をバックログに追加する指定|
※1……「カメラオプション」に関しては項目参照：[[カメラオプションについて>command#command1a5]]
///////////////////////////////////////////////////////////////////////////////
*台詞情報種類（textTableColumn）[#textTableColumn]
台詞情報種類 eng
-csvファイルの項目名（テーブル列名）を指定し、現在表示中のデータ行のテキストを指定した列のものに更新します。
以降に表示するCSVファイルのテキストは、指定したテーブル列のものになります。
--バックログの既存記録は新たな列のものには更新されません。これは現在行も含まれます。
しかし、文字窓上のテキストは更新されているため、バックログとの整合性が取れないことに留意する必要があります。
-Ver13.6.0より、台詞情報種類の更新によるバックログの自動初期化が仕様処理ではなくなりました。
||設定項目|記述の種類|説明|h
|&color(Red){【必須】};|項目名|※1|文字窓上のテキストに指定するテーブル列の名前|
※1……csvファイル内の項目名に準拠
///////////////////////////////////////////////////////////////////////////////
*台詞情報登録（textTableLoad）[#textTableLoad]
台詞情報登録 scenariotable01.csv 0
-フォルダ「Scripts」内のCSVファイルを文字窓テキストのデータとして指定し、初回表示時に読込むデータ行を指定します。
-CSVファイルの1行めは項目名となり、データ行はその直下から読み取られます。
''次回読込開始行は項目名の直下を0行めとして指定します''。
||設定項目|記述の種類|説明|h
|&color(Red){【必須】};|CSVファイル|ファイル名|文字窓上のテキストに用いるCSVファイル|
|&color(Red){【必須】};|初回読込開始行|数値|登録後の初回に読込むデータ行|
///////////////////////////////////////////////////////////////////////////////
*台詞情報新文章（textTableLine）[#textTableLine]
台詞情報新文章 scenariotable01.csv
台詞情報新文章 scenariotable01.csv 22
台詞情報新文章 scenariotable02.csv | 待機
-指定したCSVファイルを読込み、文字窓上に新規テキストとして表示します。
--行番号を指定しない場合、CSVファイルは事前にコマンド「台詞情報登録」で登録されている必要があります。
-CSVファイルからのテキスト読込みは、スクリプト記述においてはテキストではなくコマンド扱いになります。
したがって、コマンド「文字自動待機 2」による自動待機を適用することはできません。
待機をさせるには、下記のいずれかで対応します。
--テキスト側で「\w」を末尾に記述しておく
--スクリプト側でコマンド「待機」を設定する。
--コマンド「文字自動待機 1」を設定する。
||設定項目|記述の種類|説明|h
|&color(Red){【必須】};|CSVファイル|ファイル名|文字窓上の新規テキストに用いるCSVファイル|
||行番号|数値|読み込む行番号|
///////////////////////////////////////////////////////////////////////////////
*台詞情報追加文章（textTableCont）[#textTableCont]
台詞情報追加文章 scenariotable01.csv
台詞情報追加文章 scenariotable01.csv 22
台詞情報追加文章 scenariotable02.csv | 待機
-指定したCSVファイルを読込み、文字窓上に追加テキストとして表示します。
--行番号を指定しない場合、CSVファイルは事前にコマンド「台詞情報登録」で登録されている必要があります。
-CSVファイルからのテキスト読込みは、スクリプト記述においてはテキストではなくコマンド扱いになります。
したがって、コマンド「文字自動待機 2」による自動待機を適用することはできません。
待機をさせるには、下記のいずれかで対応します。
--テキスト側で「\w」を末尾に記述しておく
--スクリプト側でコマンド「待機」を設定する。
--コマンド「文字自動待機 1」を設定する。
||設定項目|記述の種類|説明|h
|&color(Red){【必須】};|CSVファイル|ファイル名|文字窓上の新規テキストに用いるCSVファイル|
||行番号|数値|読み込む行番号|
///////////////////////////////////////////////////////////////////////////////
*文章消去（textClear）[#textClear]
文章消去 word1
-テキストを消去します。
-対象名を指定しない場合は、文字窓に表示中のテキストを消去します。
-[[テキスト>text]]においても紹介していますが、Light.vnにおいては文字窓のテキストを消去する方法として''行頭に「"」を付加する''というものがあります。
||設定項目|記述の種類|説明|h
| |対象名|個体名|テキストを消去する対象の名前|
///////////////////////////////////////////////////////////////////////////////
*文字消去（textPop）[#textPop]
文字消去 tb1 4
文字消去 5
-指定した文字数だけ、対象のテキストの''末尾から''テキストを消去します。
-対象名を指定しない場合は、文字窓に表示中のテキストの末尾からテキストを消去します。
||設定項目|記述の種類|説明|h
|&color(Red){【必須】};|対象名|個体名|テキストを消去する対象の名前|
///////////////////////////////////////////////////////////////////////////////
*文字フォント（textFont）[#textFont]
文字フォント word1 nanchalagosick.otf
-文字窓または文字において使用するフォントを変更します。
-対象名を指定してこのコマンドを設定すると、すでに表示したテキストにも変更が適用されます。
指定しない場合は、すでに表示しているテキストのフォントは変更せず、使用中の文字窓で以降に使用されるフォントを変更します。
-フォルダ「Fonts」に収められているフォントファイル以外を用いることはできません。必ず入れておきましょう。
||設定項目|記述の種類|説明|h
||対象名|個体名|フォントを変更する対象の文字窓または文字の個体名|
|&color(Red){【必須】};|フォント名|ファイル名|指定するフォントのファイル名|
///////////////////////////////////////////////////////////////////////////////
*文字サイズ（textSize）[#textSize]
文字サイズ word1 60
-文字窓または文字におけるフォントサイズを変更します。
-対象名を指定してこのコマンドを設定すると、すでに表示したテキストにも変更が適用されます。
指定しない場合は、すでに表示しているテキストのフォントサイズは変更せず、使用中の文字窓で以降に適用するフォントサイズを変更します。
||設定項目|記述の種類|説明|h
||対象名|個体名|フォントサイズを変更する対象の文字窓または文字の個体名|
|&color(Red){【必須】};|大きさ|数値|変更するフォントの表示サイズ（単位：px）|
///////////////////////////////////////////////////////////////////////////////
*文字行サイズ（textLineSize）[#textLineSize]
文字行サイズ txtbox1 36
-文字個体または文字窓個体における1行のサイズを設定・変更します。
行間設定に近いですが、''文字も含めたサイズを指定するので、フォントサイズよりも大きい数値を指定する''ことがほとんどでしょう。
-対象名を指定してこのコマンドを設定すると、すでに表示したテキストにも変更が適用されます。
指定しない場合は、すでに表示しているテキストの行サイズは変更せず、使用中の文字窓で以降に適用する行サイズを変更します。
||設定項目|記述の種類|説明|h
||対象名|個体名|行サイズの設定・変更を適用する文字窓の個体名|
|&color(Red){【必須】};|大きさ|数値|1行のサイズ（単位：px）|
///////////////////////////////////////////////////////////////////////////////
*文字色（textColour）[#textColour]
文字色 word1 255 255 255 200
文字色 word2 #1f1f1f3d
文字色 word3 #1f1f1f3d 60% #3f3f3f3d
-文字の色や透明度を設定・変更します。
-対象名を指定してこのコマンドを設定すると、すでに表示したテキストに変更が適用されます。
指定しない場合は、すでに表示されているテキストの文字色は変更せず、使用中の文字窓で以降に適用する文字色を変更します。
-Ver14.6.0より、2つのカラーコードの間に反映率を記述することで、縦方向のグラデーション効果を設定することができます。
--反映率は、文字の上方から下方までにおいてどの割合まで基準色を用いるかを設定するものです。
上記の例では、上から60%までは基準色の領域となり、そこから下縁まで段階色へと変化してゆきます。
-色の指定にはRGB（10進数）またはHEX（16進数）のいずれかを用います。
--RGBを使用する場合は、''0～255の数値を3つ指定します''。左から順に、光の三原色である&color(Red){赤};・&color(Green){緑};・&color(Blue){青};を表しています。
--HEXを使用する場合は、''先頭に「#」を置いてから、6桁の英数字を指定します''。#を除いて、左から2桁ずつがRGBと同様の三原色に対応しています。
-透明度も指定するにはRGBA（10進数）またはHEX（16進数）のいずれかを用います。
--RGBAを使用する場合は、''0～255の数値を4つ指定します''。左から順に、光の三原色である&color(Red){赤};・&color(Green){緑};・&color(Blue){青};、透明度を表しています。
--HEXを使用する場合は、''先頭に「#」を置いてから、8桁の英数字を指定します''。#を除いて、左から2桁ずつがRGBAと同様の三原色と透明度に対応しています。
||設定項目|記述の種類|説明|h
||対象名|個体名|色を設定・変更する文字窓または文字の個体名|
|&color(Red){【必須】};|RGB・RGBAカラーコード&br;または&br;HEXカラーコード|数値|指定した対象に用いる色のカラーコード|
||設定項目|記述の種類|説明|h
||対象名|個体名|色を設定・変更する文字窓または文字の個体名|
|&color(Red){【必須】};|RGB・RGBAカラーコード1&br;または&br;HEXカラーコード1|数値|指定した対象に用いる基準色のカラーコード|
|&color(Red){【必須】};|カラー1反映率|数値（%付）|基準色の、文字上方からの領域割合|
|&color(Red){【必須】};|RGB・RGBAカラーコード2&br;または&br;HEXカラーコード2|数値|指定した対象に用いる段階色のカラーコード|
///////////////////////////////////////////////////////////////////////////////
*文字色既読（textColourSkippable）[#textColourSkippable]
文字色既読 word1 255 255 255 200
文字色既読 word2 #1f1f1f3d
文字色既読 word3 #1f1f1f3d 60% #3f3f3f3d
-既読である文字の色や透明度を設定・変更します。
-設定項目はコマンド「文字色」と共通です。
-設定した色は、既読判定された文字窓表示テキストのうち、文字装飾コマンドで色が特定されていない範囲に対して適用されます。
||設定項目|記述の種類|説明|h
||対象名|個体名|色を設定・変更する文字窓または文字の個体名|
|&color(Red){【必須】};|RGB・RGBAカラーコード&br;または&br;HEXカラーコード|数値|指定した対象に用いる色のカラーコード|
||設定項目|記述の種類|説明|h
||対象名|個体名|色を設定・変更する文字窓または文字の個体名|
|&color(Red){【必須】};|RGB・RGBAカラーコード1&br;または&br;HEXカラーコード1|数値|指定した対象に用いる基準色のカラーコード|
|&color(Red){【必須】};|カラー1反映率|数値（%付）|基準色の、文字上方からの領域割合|
|&color(Red){【必須】};|RGB・RGBAカラーコード2&br;または&br;HEXカラーコード2|数値|指定した対象に用いる段階色のカラーコード|
///////////////////////////////////////////////////////////////////////////////
*文字太字（textBold）[#textBold]
文字太字 word1 true
-指定した文字窓または文字で太字体を使用するかどうかを設定・変更します。
-このコマンドが設定されていない場合は、太字を使用しないのが既定となります。
-対象名を指定してこのコマンドを設定すると、すでに表示したテキストにも変更が適用されます。
指定しない場合は、すでに表示しているテキストは太字体にならず、使用中の文字窓で以降のテキストに太字体を適用します。
-&color(Red){Ver6.2.0以前のコマンド名は「文字''ボールド''」です。Ver7.0.0において「文字''太字''」に変更されました。};
||設定項目|記述の種類|説明|h
||対象名|個体名|太字体使用の設定・変更をする対象の文字窓または文字の個体名|
|&color(Red){【必須】};|true&br;または&br;false|設定項目の語句&br;（true・false）|太字体の使用の有無|
///////////////////////////////////////////////////////////////////////////////
*文字斜体（textItalic）[#textItalic]
文字斜体 true
-指定した文字窓または文字で斜体を使用するかどうかを変更します。
-対象名を指定してこのコマンドを設定すると、すでに表示したテキストにも変更が適用されます。
指定しない場合は、すでに表示しているテキストは斜体にならず、使用中の文字窓で以降のテキストに斜体を適用します。
||設定項目|記述の種類|説明|h
|&color(Red){【必須】};|true&br;または&br;false|設定項目の語句&br;（true・false）|斜体の使用&br;または&br;斜体の不使用|
///////////////////////////////////////////////////////////////////////////////
*文字陰（textShadow）[#textShadow]
文字陰 word1 0
文字陰 word2 1 2 100 100 100
文字陰 word3 1 1 #001010ff 5 5
-指定した文字窓または文字で文字陰を使用するかどうかを変更します。
使用する場合はRGB・RGBA・HEXカラーコードで色の指定ができます。
-このコマンドが設定されていない場合は、不透明の黒（0 0 0 255）の文字陰を使用するのが既定となります。
-対象名を指定してこのコマンドを設定すると、すでに表示したテキストにも変更が適用されます。
指定しない場合は、すでに表示しているテキストには文字陰を適用せず、使用中の文字窓で以降のテキストに変更を適用します。
-文字陰を使用する場合には、カラーコードの色成分の指定が必須となります。
||設定項目|記述の種類|説明|h
||対象名|個体名|文字陰使用の設定・変更をする対象の文字窓または文字の個体名|
|&color(Red){【必須】};|0&br;または&br;1|数値|文字陰の不使用&br;または&br;文字陰の使用|
||太さ|数値|文字陰の太さ（単位：px）|
||RGB・RGBAカラーコード&br;または&br;HEXカラーコード|数値|文字陰に用いる色のカラーコード|
||相対x座標|数値|文字陰のx軸方向のズレ（単位：px）|
||相対y座標|数値|文字陰のy軸方向のズレ（単位：px）|
///////////////////////////////////////////////////////////////////////////////
*文字速度（textSpeed）[#textSpeed]
文字速度 txtbox1 50
-文字窓上における、テキストの1文字あたりの表示速度を設定します。
-対象名を指定しない場合は、使用中の文字窓に変更を適用します。
-このコマンドを用いて表示速度を指定すると、ゲーム内の既定表示速度が無視されます。
たとえば、システム変数やトラックバーを用いて既定表示速度を100ms/時としている場合でも、上記の例のようなスクリプト文が存在すると、文字速度は50ms/時となります。
-''規定表示速度に設定したい場合には、表示速度に「設定反映」を指定します''。
オート時の既定表示速度に設定したい場合には、表示速度に「オート設定反映」を指定します。
||設定項目|記述の種類|説明|h
||対象名|個体名|表示速度の設定・変更をする対象の文字窓の個体名|
|&color(Red){【必須】};|表示速度|数値|1文字あたりの表示速度（単位：ms）|
///////////////////////////////////////////////////////////////////////////////
*文字ワードラップ（textWordWrap）[#textWordWrap]
文字ワードラップ txtbox1 false
-指定した文字窓で英文等におけるワードラップを使用するかどうかを設定します。
--ワードラップとは、英単語が途中で文字窓の終端に当たってしまう際に、折り返しによって英単語が読みづらくなるのを、その単語をまるごと折り返すことで防ぐ機能のことです。
sugar water is transp
arent
となるのがワードラップ不使用時で、
sugar water is
transparent
となるのがワードラップ使用時です。
-対象名を指定してこのコマンドを設定すると、すでに表示したテキストにもワードラップが適用されます。
指定しない場合は、すでに表示したテキストにはワードラップが適用されず、使用中の文字窓で以降のテキストにワードラップを適用します。
-Ver13.8.0未満における正常な動作は保証されません。
//実験者：雪原たかし
||設定項目|記述の種類|説明|h
||対象名|個体名|ワードラップの設定・変更をする対象の文字窓の個体名|
|&color(Red){【必須】};|true&br;または&br;false|設定項目の語句&br;（true・false）|ワードラップの使用&br;または&br;ワードラップの不使用|
///////////////////////////////////////////////////////////////////////////////
*文字自動送り（textAutoIndent）[#textAutoIndent]
文字自動送り txtbox1 "[{「｛" 5
-指定した文字のいずれかが''文字窓の開始行の先頭に来る場合''において、その文字分の字下げを以降の行に適用します。
字下げは文字窓のテキストが消去されるまで継続されます。
-対象名を指定しない場合は、使用中の文字窓で以降に表示するテキストから字下げを適用します。
-Ver8.0.0現在においては左揃えの横書きテキストにのみ適用できます。
||設定項目|記述の種類|説明|h
||対象名|個体名|自動字送りの設定・変更をする対象の文字窓の個体名|
|&color(Red){【必須】};|送り字|テキスト|自動字送りを行う文字群|
||追加間隔|数値|送り字と本文との間に挿入する間隔（単位：px）|
///////////////////////////////////////////////////////////////////////////////
*文字送り（textIndent）[#textIndent]
文字送り txtbox1 5
-指定した大きさの字下げを、以降の行に適用します。
字下げは文字窓のテキストが消去されるまで継続されます。
-対象名を指定しない場合は、使用中の文字窓で以降に表示するテキストから字下げを適用します。
||設定項目|記述の種類|説明|h
||対象名|個体名|字送りの設定・変更をする対象の文字窓の個体名|
|&color(Red){【必須】};|追加間隔|数値|送り字と本文との間に挿入する間隔（単位：px）|
///////////////////////////////////////////////////////////////////////////////
*文字禁則行頭（textDisallowStart）[#textDisallowStart]
文字禁則行頭 txtbox1 "]」"
-指定した文字のいずれかが''文字窓の終端における改行によって文字窓の行頭に来る場合''において、その文字の改行を中止して前行の末尾に表示させ、次の文字で改行させます。
改行文字等による改行で行頭に来る場合には禁則処理が行われません。
-対象名を指定しない場合は、使用中の文字窓で以降に表示するテキストから禁則処理を適用します。
||設定項目|記述の種類|説明|h
||対象名|個体名|行頭禁則の設定・変更をする対象の文字窓の個体名|
|&color(Red){【必須】};|"禁則文字"|テキスト|行頭禁則の対象として指定する文字群|
///////////////////////////////////////////////////////////////////////////////
*文字禁則行末（textDisallowEnd）[#textDisallowEnd]
文字禁則行頭 txtbox1 "「["
-指定した文字のいずれかが''文字窓の終端に接触する場合''において、その文字を改行させます。
指定した文字が各行の途中に存在しても改行は行われません。
-対象名を指定しない場合は、使用中の文字窓で以降に表示するテキストから禁則処理を適用します。
||設定項目|記述の種類|説明|h
||対象名|個体名|行末禁則の設定・変更をする対象の文字窓の個体名|
|&color(Red){【必須】};|"禁則文字"|テキスト|行末禁則の対象として指定する文字群|
///////////////////////////////////////////////////////////////////////////////
*文字追加間隔（textExtraSpacing）[#textExtraSpacing]
文字追加間隔 txtbox1 4 2
-使用フォントの文字間隔に、指定した量の間隔を追加します。
-対象名を指定しない場合は、使用中の文字窓で以降に表示するテキストから間隔を追加します。
-対象名を指定してこのコマンドを設定すると、すでに表示したテキストにも変更が適用されます。
指定しない場合は、すでに表示しているテキストには間隔を追加せず、使用中の文字窓で表示する以降のテキストに間隔を追加します。
||設定項目|記述の種類|説明|h
||対象名|個体名|追加間隔の設定・変更をする対象の文字窓の個体名|
|&color(Red){【必須】};|x間隔|数値|左右方向の追加間隔（横書きテキストに適用）|
|&color(Red){【必須】};|y間隔|数値|上下方向の追加間隔（縦書きテキストに適用）|
///////////////////////////////////////////////////////////////////////////////
*文字方向（textDir）[#textDir]
文字方向 txtbox1 縦
-指定した文字窓のテキストの方向を変更します。
-このコマンドが設定されていない場合は、''横書きが既定''となります。
-対象名を指定してこのコマンドを設定すると、すでに表示したテキストにも変更が適用されます。
指定しない場合は、すでに表示したテキストに変更は適用されず、使用中の文字窓で以降のテキストに変更を適用します。
||設定項目|記述の種類|説明|h
||対象名|個体名|変更を適用する文字窓の個体名|
|&color(Red){【必須】};|縦&br;または&br;横|設定項目の語句&br;（縦・横）|テキストの方向|
///////////////////////////////////////////////////////////////////////////////
*文字整列（textAlignment）[#textAlignment]
文字整列 中央
-指定した文字窓または文字を整形します。ワープロ等で見かけるものと同じです。
-このコマンドが設定されていない場合は、''左揃えが既定''となります。
-対象名を指定してこのコマンドを設定すると、すでに表示したテキストや文字にも変更が適用されます。
指定しない場合は、すでに表示したテキストに変更は適用されず、使用中の文字窓で以降のテキストに変更を適用します。
||設定項目|記述の種類|説明|h
||対象名|個体名|変更を適用する文字窓の個体名|
|&color(Red){【必須】};|左&br;または&br;中央&br;または&br;右|設定項目の語句&br;（左・中央・右）|整形の方式|
///////////////////////////////////////////////////////////////////////////////
*文字窓スキン（textboxSkin）[#textboxSkin]
文字窓スキン txtbox1 skin1.png 0 450 100% 100%
-文字窓の下地に使用する画像を設定します。設定後は個体名「（対象文字窓の個体名）_skin」を持つ個体となり、効果コマンド等の対象として指定することができます。
-このコマンドが設定されていない場合は、''文字窓が透明となり、文字のみが表示されます''。
設定すると、''文字窓は指定した画像を下地に持つ素材として表示され、文字がその下地の上に表示されます''。
この場合、下地の画像は文字窓と同じレイヤー上に設置されますが、''常に文字よりも下に表示されます''。したがって、コマンド「絵」よりも簡単かつ確実に文字窓の下地を設定できます。
-対象名を指定しない場合は、使用中の文字窓に設定を適用します。
-''Ver7.6.0より、文字窓スキンの座標を文字窓の左上頂点からの相対座標で指定することになりました''。
-拡大比率を指定する場合、2種類の様式があります。
--全体の拡大比率の指定
設定項目「拡大比率」のみに数値と「%」を記述すると、指定した数値の拡大率を適用します。
--縦横を区別しての拡大比率の指定
設定項目「拡大比率：y軸」にも数値と「%」を記述すると、設定項目「拡大比率」が左右方向の拡大率を指定することになり、設定項目「拡大比率：y軸」では上下方向の拡大比率を指定することになります。
||設定項目|記述の種類|説明|h
||対象名|個体名|下地を設定する文字窓の個体名|
|&color(Red){【必須】};|下地素材ファイル名&br;または&br;登録済みアニメ名|ファイル名&br;または&br;個体名|下地に使用する素材のファイル名&br;または&br;登録済みアニメ名|
|&color(Red){【必須】};|相対x座標|数値|下地素材左上の頂点の相対x座標（左右方向の座標）|
|&color(Red){【必須】};|相対y座標|数値|下地素材左上の頂点の相対y座標（上下方向の座標）|
||拡大比率|数値（単位付）|下地素材の拡大率（単位：%）&br;または&br;下地素材の左右方向の拡大率（単位：%）|
||拡大比率：y軸|数値（単位付）|下地素材の上下方向の拡大率（単位：%）|
※「登録済みアニメ名」に関しては項目参照：[[アニメ登録>commands/transition#animation]]
~
-解説動画：[[「文字窓スキン」【Light.vn】【ノベルゲーム制作】>https://youtu.be/Ttx9V2dtP5o]]
#flex_container(flex-start){{{
#flex_box(450px){{
#youtube(Ttx9V2dtP5o)
}}
}}}
&br;
///////////////////////////////////////////////////////////////////////////////
*文字窓待機絵（textWaitIcon）[#textWaitIcon]
文字窓待機絵 tb01 0 wait.png 5 -8
-文字窓待機絵を設定します。文字窓待機絵とは、テキスト表示中に待機状態となった時にテキスト末尾や文字窓の角付近に表示する画像素材のことです。
-このコマンドが設定されていない場合は、文字窓待機絵を表示しません。
-対象名を指定しない場合は、使用中の文字窓に設定を適用します。
-位置タイプ（座標の基準）は2種類から選択できます。既定では「0」になります。
--0……テキストの末尾を基準とします。
--1……文字窓の左上頂点を基準とします。
-文字窓待機絵を明滅表示させる場合には、表示する画像素材と透明な画像素材をコマンド「アニメ登録」でアニメとして登録し、このコマンドで指定します。
-文字窓待機絵の座標は左右方向と上下方向とで基準が異なります。
||設定項目|記述の種類|説明|h
||対象名|個体名|文字窓待機絵を設定する文字窓の個体名|
||0&br;または&br;1|数値|位置タイプ|
|&color(Red){【必須】};|素材ファイル名&br;または&br;登録済みアニメ名|ファイル名&br;または&br;個体名|使用する素材のファイル名&br;または&br;登録済みアニメ名|
|&color(Red){【必須】};|x座標|数値|文字窓待機絵の素材基準点のx座標（左右方向の座標）|
|&color(Red){【必須】};|y座標|数値|文字窓待機絵の素材基準点のy座標（上下方向の座標）|
※「登録済みアニメ名」に関しては項目参照：[[アニメ登録>commands/transition#animation]]
~
-解説動画：[[「文字窓待機絵」【Light.vn】【ノベルゲーム制作】>https://youtu.be/_r-mruqoeWE]]
#flex_container(flex-start){{{
#flex_box(450px){{
#youtube(_r-mruqoeWE)
}}
}}}
&br;
///////////////////////////////////////////////////////////////////////////////
*文字出力効果（textFlowEffect）[#textWaitIcon]
文字出力効果 4
-文字表示のなめらかさを設定します。
フェード効果を用いる場合には、強度に1以上の数値を指定します。値が大きくなるほどフェード時間が長くなり、なめらかに表示されるように見えます。
フェード効果を切る場合には強度に0を指定します（Ver10.8.0以降）。
-Ver12.4.0から、ルビに対してもフェード効果が適用されるようになりました。
||設定項目|記述の種類|説明|h
|&color(Red){【必須】};|強度|数値|文字表示におけるフェード効果の強度|
///////////////////////////////////////////////////////////////////////////////
*文字再度出力（textRedisplay）[#textRedisplay]
文字再度出力 script_char
-対象の文字個体または文字窓個体のテキストを再表示します。
--文字窓個体においては、直近表示分のみではなく文字窓のテキスト全体が再表示され、初回表示の際の待機等は無視されます。
-対象名を指定しない場合は、使用中の文字窓で再表示を行います。
||設定項目|記述の種類|説明|h
| |対象名|個体名|テキストを再表示する文字窓の名前|
///////////////////////////////////////////////////////////////////////////////
*文字反復出力（textRepeat）[#textRepeat]
文字反復出力 script_char
-対象の文字窓のテキストを反復表示します。
対象の文字窓でテキストの表示が完了する度に、同じテキストの再表示を開始します。
-文字速度に「オート設定反映」を指定している場合には、反復の際にオート待機時間に従った待機を挟んでから再表示をします。
-対象名を指定しない場合は、使用中の文字窓で再表示を行います。
||設定項目|記述の種類|説明|h
| |対象名|個体名|テキストを再表示する文字窓の名前|
///////////////////////////////////////////////////////////////////////////////
*文字読後透明度（textReadAlpha）[#textReadAlpha]
文字読後透明度 txtbox01 100 200
-対象の文字窓でテキストが追加表示される際に、既存のテキストの透明度を変更します。
テキストの更新頻度が少ないような作品形態において特に効果が見込まれます。
-対象名を指定しない場合は、使用中の文字窓に対して設定されます。
||設定項目|記述の種類|説明|h
||対象名|個体名|読後透明度を設定する文字窓の名前|
|&color(Red){【必須】};|透明度|数値|読後テキストの透明度|
||効果時間|数値|読後テキストの透明度変更の効果時間（単位：ms）|
///////////////////////////////////////////////////////////////////////////////
*文字超過自動待機（textOverflowAutoWait）[#textOverflowAutoWait]
文字超過自動待機 true
-文字窓個体において、テキストが領域を超過する場合に、領域内に収まるテキストまでを表示してから自動で待機状態に入らせるかを設定します。
この待機状態を解除すると、まだ表示されていない残りのテキストを表示します。
-true状態下にない場合において、テキストが文字窓領域を超過するとエラーとなります。
-Ver16.6.0以降において、既定値は「true」です。
||設定項目|記述の種類|説明|h
|&color(Red){【必須】};|true&br;または&br;false|設定項目の語句&br;（true・false）|超過時待機の有効化&br;または&br;超過時待機の無効化|
///////////////////////////////////////////////////////////////////////////////
*文字自動待機（textAutoWait）[#textAutoWait]
文字自動待機 0
-テキストにおいて、末尾に「\w」を付与していない場合でもプレイヤーの入力を待機するかどうかを設定します。
制作者の負担を軽減するためのコマンドです。''適用すれば、末尾に「\w」を付与する手間を省くことができます''。
-待機方式番号の詳細は以下のとおりです。
--''「0」''
テキスト行の末尾に「\w」が存在すれば待機します。
--''「1」''
テキスト行の末尾まで読込むたびに待機します。
--''「2」''
空白のテキスト行を読込むと待機します。
Ver16.3.1以前では空白行毎に待機します。Ver16.4.0以降では連続空白行に対しても1回のみ待機します。
-Ver14.6.1以前は「0」が、Ver16.0.0以降は「2」が、それぞれ既定となります。
||設定項目|記述の種類|説明|h
|&color(Red){【必須】};|待機方式番号|数値（0,1,2）|文字待機の方式|
///////////////////////////////////////////////////////////////////////////////
*文字自動改行（textAutoNewline）[#textAutoNewline]
文字自動改行 true
-文字窓用テキストにおいて、テキストの改行を文字窓上における改行に対応させるかどうかを設定します。
-制作者の負担を軽減するためのコマンドです。''適用すれば、先頭の「.」やテキスト内に「\n」を付与する手間を省くことができます''。
||設定項目|記述の種類|説明|h
|&color(Red){【必須】};|true&br;または&br;false|設定項目の語句&br;（true・false）|文字自動改行の使用&br;または&br;文字自動改行の不使用|
///////////////////////////////////////////////////////////////////////////////
*文字進行形式（textReadVersion）[#textReadVersion]
文字進行形式 1
-コマンド「文字進行オート」「文字進行スキップ」の動作を設定します。適用対象はすべての文字窓になります。
--''「0」''
既定形式です。オート・スキップ進行が排他的に「true」となります。
スキップ進行を「true」に設定すると、オート進行が「true」に設定された時点、またはスキップ条件に合致しない行に到達した時点で、スキップ進行が「false」に再設定されます。
オート進行を「true」に設定すると、スキップ進行が「true」に設定された時点でオート進行が「false」に再設定されます。
--''「1」''
オート・スキップ進行が同時に「true」となることが許可され、「false」への変更が直接指定された場合のみ実行されます。
スキップ進行を「true」に設定すると、スキップ条件に合致しない行ではスキップ進行をしませんが、状態は「true」のままになります。したがって、再度スキップ条件に合致する行に到達すればスキップ進行が適用されます。
オート進行を「true」に設定すると、スキップ進行が適用されている状況においてはオート進行にはなりませんが、オート進行の状態は「true」のままになります。スキップ進行ではない状況においてはオート進行が適用されます。
-簡潔に表すと、コマンド「文字進行オート」「文字進行スキップ」の扱いが、「文字進行形式 0」は「オート・スキップ進行の指示」となるのに対して、「文字進行形式 1」は「オート・スキップ進行の自動適用の選択」となります。
||設定項目|記述の種類|説明|h
|&color(Red){【必須】};|進行形式番号|数値（0,1）|オート・スキップ進行の方式|
///////////////////////////////////////////////////////////////////////////////
*文字進行スキップ（textReadSkip）[#textReadSkip]
文字進行スキップ true
-スキップ進行を適用・解除します。解除後の進行はコマンド「文字進行形式」「文字進行オート」「文字進行通常」「文字進行通常強制」に依存します。
-スキップ進行中は、''効果関係のコマンドに設定されている効果時間のほとんどが無視されます''。また、コマンド「待機」は一部のオプションを除いて無視されます。
||設定項目|記述の種類|説明|h
|&color(Red){【必須】};|true&br;または&br;false|設定項目の語句&br;（true・false）|スキップ進行の適用&br;または&br;スキップ進行の解除|
///////////////////////////////////////////////////////////////////////////////
*文字進行オート（textReadAuto）[#textReadAuto]
文字進行オート true
-オート進行を適用・解除します。解除後の進行はコマンド「文字進行形式」「文字進行スキップ」「文字進行通常」「文字進行通常強制」に依存します。
-オート進行における自動待機は、テキストの表示完了と音声の再生完了のいずれか遅いほうが開始点となります。
||設定項目|記述の種類|説明|h
|&color(Red){【必須】};|true&br;または&br;false|設定項目の語句&br;（true・false）|オート進行の適用&br;または&br;オート進行の解除|
///////////////////////////////////////////////////////////////////////////////
*文字進行通常（textReadNormal）[#textReadNormal]
文字進行通常
-オート・スキップ状態を解除し、通常進行を適用します。設定項目はありません。
///////////////////////////////////////////////////////////////////////////////
*文字進行通常強制（textReadNormalForce）[#textReadNormalForce]
文字進行通常強制 true
-通常進行を優先適用します。一時的に通常進行をしたい場合などに用いることが想定されます。
「true」は通常進行を優先適用します。オート・スキップ進行が「false」になるわけではなく、あくまで一時的に通常進行を優先させるということです。
「false」は通常進行の優先適用を解除します。解除後は優先適用前の進行に戻ります。
||設定項目|記述の種類|説明|h
|&color(Red){【必須】};|true&br;または&br;false|設定項目の語句&br;（true・false）|通常進行の優先適用&br;または&br;通常進行の優先適用の解除|
///////////////////////////////////////////////////////////////////////////////
*文字スキップ方式（textSkipMode）[#textSkipMode]
文字スキップ方式 1
-早送りの適用に関する条件を設定します。
--文字スキップ方式 0……すべてのテキストにおいて早送りを適用します。
--文字スキップ方式 1……プレイヤーがまだ見ていないテキストには早送りが適用されなくなります。
なお、既読領域の判別にはSaveDataフォルダ内にある「global0.xml」ファイルが用いられています。
||設定項目|記述の種類|説明|h
|&color(Red){【必須】};|0&br;または&br;1|数値|早送りに適用する条件|
///////////////////////////////////////////////////////////////////////////////
*続行時文字進行通常（restoreReadOnContinue）[#restoreReadOnContinue]
続行時文字進行通常 true
-コマンド「続行」の適用時に通常進行を適用します。
クリック等でオート・スキップ進行を解除するようにしたい場合に設定するコマンドです。
||設定項目|記述の種類|説明|h
|&color(Red){【必須】};|true&br;または&br;false|設定項目の語句&br;（true・false）|続行時の通常進行の適用&br;または&br;続行時の進行形式維持|
///////////////////////////////////////////////////////////////////////////////
*バックログ設定（backlogConfig）[#backlogConfig]
バックログ設定 logbox voicebtn.png voicebtn2.png
-バックログ機能を設定します。
Light.vnでは、文字窓で表示するテキストを自動的に記録するバックログ機能が導入されています。
ただし、ゲーム内でバックログ機能の使用を開始するには、このコマンドの設定が必要となります。
ゲーム内でバックログ機能を使用したい場合は、ゲームを起動してから最初に文字窓を表示する度に必ずこのコマンドが設定されるようなスクリプトにするよう注意しましょう。
-バックログには文字窓を使用します。したがって、このコマンドを設定する前に、''コマンド「文字窓」で新しく文字窓を作っておく必要があります''。
その際、バックログの性質上、文字窓の表示レイヤーは大きめにしておきましょう。
-バックログのスクロールは、スクロールバーの操作、またはマウスホイールによって行います。
ただし、マウスホイールの使用時には、バックログの最終行を表示した状態でホイールダウンをすると、''バックログを表示するために呼び出したスクリプトの待機状態を、コマンド「待機」のオプションの有無に関係なく解除し、以降のスクリプトを読込みます''。
したがって、このコマンドの下にコマンド「待機 続行禁止」を設定している場合、さらにその下でコマンド「アウト バックログ」によってバックログを退場させる必要があります。
-このコマンドでは''バックログのスクロールバーが設定できません''。スクロールバーの設定には、コマンド「トラックバー」を用います。
-このコマンドで設定したバックログは、コマンド「イン バックログ」で表示することができます（この場合において、インは時間設定ができなくなります）。退場にはコマンド「アウト バックログ」を用います（インと同様で、時間設定ができなくなります）。
-このコマンドが設定されると、''バックログに使用する文字窓は透明になり、コマンド「イン バックログ」で表示しない限りはバックログが表示されないままになります''。
-バックログのボイス再生ボタンは、通常のボタンと同様にコマンド「タッチ素材設定」で素材を指定することができます。
ボタン効果音の設定は、コマンド「バックログ設定」では非対応ですが、コマンド「タッチ素材設定」では対応しています。
||設定項目|記述の種類|説明|h
|&color(Red){【必須】};|使用文字窓|個体名|バックログに使用する文字窓の個体名|
||ボイス再生ボタンファイル名|ファイル名&br;または&br;個体名|ボイス再生ボタンに用いる画像素材のファイル名&br;または&br;登録済みアニメ名|
||ボイス再生ボタンタッチ時ファイル名|ファイル名&br;または&br;個体名|ボイス再生ボタンにカーソルを合わせた時に用いる画像素材のファイル名&br;または&br;登録済みアニメ名|
///////////////////////////////////////////////////////////////////////////////
*バックログボイス位置（backlogVoiceOffset）[#backlogVoiceOffset]
バックログボイス位置 -20 5
-バックログにおけるボイス再生ボタンの位置を指定します。
座標の相対関係は、x座標が文字窓左端に対するボタン右端、y座標が現在話者の最終行の下端に対するボタン中心点となります。
||設定項目|記述の種類|説明|h
|&color(Red){【必須】};|相対x座標|数値|ボイス再生ボタンの右端の相対x座標（左右方向の座標）|
|&color(Red){【必須】};|相対y座標|数値|ボイス再生ボタンの中心点の相対y座標（左右方向の座標）|
///////////////////////////////////////////////////////////////////////////////
*バックログボイス上書き（backlogVoiceOverwrite）[#backlogVoiceOverwrite]
バックログボイス上書き false
-バックログのボイス再生ボタンを押した際に、再生対象以外のボイスを削除するかを設定します。
「false」で同時再生、「true」で排他再生します。
||設定項目|記述の種類|説明|h
|&color(Red){【必須】};|true&br;または&br;false|設定項目の語句&br;（true・false）|バックログボイスの排他再生&br;または&br;バックログボイスの同時再生許可|
///////////////////////////////////////////////////////////////////////////////
*バックログ現在話者（backlogCurSpeaker）[#backlogCurSpeaker]
バックログ現在話者 "［ミスター］"
-バックログにおける発言主の名前を指定します。
このコマンドの設定によって、以降の文字窓用テキストは指定した発言主のものとして扱われ、バックログ上では指定した文字列がテキストの先頭に付加されます。
発言主を持たないようなテキストである場合には、「""」と記述して空にしておきます。
-発言主の名前だけでなく、バックログの体裁を整えるための文字列を加えておくのが一般的な使い方になります。
サンプルスクリプトでは「-」による水平線と「\n」による改行を加えています。
||設定項目|記述の種類|説明|h
|&color(Red){【必須】};|発言主|テキスト|文字窓用テキストの発言主|
///////////////////////////////////////////////////////////////////////////////
*バックログ改ページ接頭辞（backlogNewPagePrefix）[#backlogNewPagePrefix]
バックログ改ページ接頭辞 "\n\n\n"
-文字窓用テキストが「"」によって更新された時に、バックログへ挿入する文字列を指定します。
接頭辞という名前ですが、無条件で行頭になるわけではありません。「""」と記述して空にすることもできますが、基本的には「\n」で改行を指定します。
||設定項目|記述の種類|説明|h
|&color(Red){【必須】};|改ページ接頭辞|テキスト|テキスト更新時にバックログへ挿入する文字列|
///////////////////////////////////////////////////////////////////////////////
*バックログスクロール（backlog_scroll）[#backlog_scroll]
バックログスクロール -1
-バックログの表示範囲を、指定の行数だけ移動します。
1以上の整数では新しいほうへ、-1以下の整数では古いほうへ移動します。
-基本的にはキートリガーに設定するコマンドです。
||設定項目|記述の種類|説明|h
|&color(Red){【必須】};|移動行数|数値|バックログの表示範囲の移動行数|
///////////////////////////////////////////////////////////////////////////////
*バックログ台詞登録（backlogAddLines）[#backlogAddLines]
バックログ台詞登録 false
-バックログへの記録を停止または再開します。
「false」で停止、「true」で再開します。
-このコマンドを設定しない場合はバックログへの記録を行います。
-一時的にバックログへの記録を停止したい場合などに用いるものと思われます。
||設定項目|記述の種類|説明|h
|&color(Red){【必須】};|true&br;または&br;false|設定項目の語句&br;（true・false）|バックログへの記録の停止&br;または&br;バックログへの記録の再開|
///////////////////////////////////////////////////////////////////////////////
*バックログリセット（backlogReset）[#backlogReset]
バックログリセット
-バックログの記録を初期化します。
''このコマンドが設定されない場合は、コマンド「バックログ設定」の適用からゲームを終了するまでの間、バックログを記録し続けます''。
記録・表示量が過剰になる可能性がありますので、たとえば物語の各章ごと等においてこのコマンドを設定することをおすすめします。
///////////////////////////////////////////////////////////////////////////////
*バックログ続く文章追加（backlogAddLineCont）[#backlogAddLineCont]
バックログ続く文章追加 "\n（この時点ではまだ17歳だったんだ！）"
-指定したテキストをバックログに追加します。
バックログにTipsを残す等に使うことができます。
||設定項目|記述の種類|説明|h
|&color(Red){【必須】};|追加文章|テキスト|バックログへ追加する文字列|