Rich Text

The text for UI elements and text meshes can incorporate multiple font styles and sizes. The Text, GUIStyle, and TextMesh classes have a Rich Text setting which instructs Unity to look for markup tags within the text. The Debug.Log function can also use these markup tags to enhance error reports from code. The tags are not displayed but indicate style changes to be applied to the text.

Markup format

Система разметки текста в Unity была создана на основе HTML, однако при этом строгая совместимость со стандартным HTML не подразумевается. Основная идея заключается в том, что фрагменты текста можно заключать в пару согласующихся друг с другом тегов:-

We are <b>not</b> amused.

As the example shows, the tags are just pieces of text inside the “angle bracket” characters, < and >.

You place the opening tag at the beginning of the section. The text inside the tag denotes its name (which in this case is just b).

You place another tag at the end of the section. This is the closing tag. It has the same name as the opening tag, but the name is prefixed with a slash / character. Every opening tag must have a corresponding closing tag. If you don’t close an opening tag, it is rendered as regular text.

The tags are not displayed to the user directly but are interpreted as instructions for styling the text they enclose. The b tag used in the example above applies boldface to the word “not”, so the text appears ons creen as:-

We are not amused

Размеченный фрагмент текста (включая оборачивающие его теги) также называется элементом.

Nested elements

Существует возможность применять более одного стиля к фрагменту текста при помощи «вложения» одних элементов в другие.

We are <b><i>definitely not</i></b> amused

The <i> tag applies italic style, so this would be presented onscreen as

We are definitely not amused

Note the ordering of the closing tags, which is in reverse to that of the opening tags. The reason for this is perhaps clearer when you consider that the inner tags need not span the whole text of the outermost element

We are <b>absolutely <i>definitely</i> not</b> amused

дает следующий результат:

We are absolutely definitely not amused

Tag parameters

Some tags have a simple all-or-nothing effect on the text but others might allow for variations. For example, the color tag needs to know which color to apply. Information like this is added to tags by the use of parameters:-

We are <color=green>green</color> with envy

Which produces this result:

Note that the ending tag doesn’t include the parameter value. Optionally, the value can be surrounded by quotation marks but this isn’t required.

Tag parameters cannot include blank spaces. For example:

We are <color = green>green</color> with envy

does not work because of the spaces to either side of the = character.

Supported tags

The following list describes all the styling tags supported by Unity.

Supported colors

The following table lists colors for which you can use a name instead of a hexadecimal tag in the <color> rich text tag.

Название цвета	Шестнадцатиричный код	Пример
aqua (same as cyan)	#00ffffff
black	#000000ff
blue	#0000ffff
brown	#a52a2aff
cyan (same as aqua)	#00ffffff
darkblue	#0000a0ff
fuchsia (same as magenta)	#ff00ffff
green	#008000ff
grey	#808080ff
lightblue	#add8e6ff
lime	#00ff00ff
magenta (same as fuchsia)	#ff00ffff
maroon	#800000ff
navy	#000080ff
olive	#808000ff
orange	#ffa500ff
purple	#800080ff
red	#ff0000ff
silver	#c0c0c0ff
teal	#008080ff
white	#ffffffff
yellow	#ffff00ff

Editor GUI

Rich text is disabled by default in the editor GUI system but it can be enabled explicitly using a custom GUIStyle. The richText property should be set to true and the style passed to the GUI function in question:

GUIStyle style = new GUIStyle ();
style.richText = true;
GUILayout.Label("<size=30>Some <color=yellow>RICH</color> text</size>",style);