TextMeshPro の隠しタグ一覧

はじめに

TextMeshPro には、 ヘルプ に載っていないタグやパラメータが一部存在します。
それらを紹介していきたいと思います。

本稿の内容は TextMeshPro 3.0.6 で確認しています。

ちなみに、タグの長さの上限は 128 文字です。 <link> タグなどで長い URL を直指定した場合問題になることがあります。

一覧

<br>

改行します。 \u000a と同じです。

<nbsp>

ノーブレークスペースを入れます。 \u00a0 と同じです。

<zwsp>

ゼロ幅スペースを入れます。 \u200b と同じです。

<mark>

color および padding パラメータが使用可能です。

color は略記法 (<mark=#ff000088>) が公式ヘルプには載っていますが、明示的に指定することもできます。

padding は読んで字のごとくパディングを設定します。
<mark padding=左,右,上,下> のように指定します。負の値も指定できるようです。

<material>

マテリアルを指定します。 <material="..."> のように指定します。
実質 <font>material パラメータでできることと同じな気がします。

</a>

パースはされますが、実装されていません。
閉じタグだけパースされます。

<gradient>

tint パラメータが使用できます。 0 か 1 を指定するようです。
<gradient tint=1> のように指定します。詳しくは試してみてください。(丸投げ)

<class>

ソースコード中に痕跡がありますが、実装されておらず、パースもされません。

<sprite>

anim パラメータが指定可能です。アニメーションします。
<sprite=1 anim=0,16,12> と指定すると、スプライト 0 番から 16 番までを 12 fps で再生します。
ランタイムでのみアニメーションするので注意してください。

<margin>

left および right パラメータが指定可能です。
それぞれ <margin-left><margin-right> と同じ働きになります。

<action>

デバッグログが表示されます。それだけです。
おそらく未実装です。表示された瞬間に何らかのコールバックを呼べるようにする予定だったのでしょうか?

<scale>

<scale=2>hoge</scale> とすると、 hoge が横に 2 倍の長さで描画されます。
なんで…?

</table><tr><th>

パースはされますが実装されていません。
</table> は閉じタグだけ認識されます。
なお、 <td>ソースコード上に痕跡がありますが実装されていません。

おわりに

<sprite anim=...> を紹介したかっただけです。
なお、ソースコードを読んだ雰囲気からすると、 TODO や懸念点が書いてあったりするため、これらが正式にサポートされるかは微妙なところです。
自己責任でお使いください。