テキストタグ

Tweet

宴では独自のテキストタグを使うことで、ルビやパラメーター表示の表示が可能です。
宴４ではTextMeshPro用のタグを使うことで、文字の色やサイズを変えたり、絵文字など、豊富なテキスト表現をすることができます。

宴3までの基本だったLegacyText版のドキュメントはこちらを参照してください。

宴の独自タグ

以下は、宴の独自のタグです。

param (パラメーター表示)

パラメーターをテキスト表示する
サンプル
文字列パラメーターの表示サンプル。<param=game_title>。

数字パラメーターの表示サンプル。<param=num_boot>。

format (書式つきのパラメーター表示)

C#のformatと同じ書き方で、パラメーターをテキスト表示します。字詰めや桁区切りなどが可能です。

C#のformat書式つきの、パラメーターの表示サンプル。<format={0,3}:num_boot>

speed (文字速度を変える)

speedタグをつかうことで、メッセージ1文字を表示する秒数を指定できます。
スピードタグを設定した部分は、コンフィグ画面のメッセージ速度は無視される点だけ注意してください。
サンプル
<speed=0.5>speedタグをつかうことで、</speed><speed=0>メッセージ1文字を表示する時間を指定できます。</speed>

em (傍点)

emタグで囲った文字に傍点をふります。em=?　の形で傍点に使用する文字を指定できます。
サンプル
<em=、>傍点</em>のサンプルです。任意の文字を使うことで<em=●>黒丸</em>や、<em=◎>二重丸</em>を使えます。<em=↓>このような</em>通常は傍点では使わない文字も使えます。

ruby (ルビ)

rubyタグで囲った文字にルビを振ります。ruby=??　でルビの文字を指定できます。ルビの文字の長さとテキストの長さによって、表示位置が若干違います（画像参照）。また、ルビの途中で自動改行されなくなります。
サンプル
<ruby=うたげ>宴</ruby>のルビの<ruby=じっけん>サンプル</ruby>です。ルビの途中では<ruby=じどうかいぎょう>自動改行</ruby>されません。

ルビがある場合の文字間隔について

ルビがある場合は、文字間隔が自動調整されます。
　

ルビに使える文字

ルビに使える文字は、ひらがなカタカナだけでなく、漢字であってもフォントに組み込まれている文字であれば制限なく使えます。ただし、文字の大きさは小さいので気をつけてください。

TextMeshProのタグ

TextMeshProのタグはpageタグ以外、宴でも利用可能です。
詳しくはTextMeshPro公式のタグ一覧、TextMeshPro公式のドキュメント、を参照してください
後日、ここで改めてドキュメント化する予定です。

宴では使えないTextMeshProタグ

TextMeshProのタグはほぼそのまま使用可能ですが、pageタグだけは、宴の改ページ処理などと矛盾するためサポートしていません。

宴3までのLegacyTextText版のタグとTextMeshPro版のテキストタグの互換表　

宴3までの基本だったLegacyText版タグのうち、TextMeshProの同一機能で名前が違うタグや、そのまま使えないタグを以下にまとめてあります。

その他のタグはそのまま使用可能です。

傍線（ダーシ）

長い傍線を表示する場合は、ダーシタグを使います。dash=?　で傍線の文字数を指定できます。
対応が不完全。今後仕様変更か廃止をするかもしれません。
TextMeshPro自体には同様の機能がなく、似たような機能である「s」（取り消し線）タグを使って機能を代替しています。
ただし、TextMeshProの「s」タグはテキストの末端で機能しないほか、
文字送りをした際に若干の不具合（線が現在表示している1文字先まで伸びている）があるため、その点はご注意ください。

サンプル
<dash=2>二文字以上の棒線をつなげて表示したい場合はダーシタグを使う<dash=2>

TIPSタグ

未実装です。