You can use rich text tags to alter the appearance and layout of your text. These tags work like HTML or XML tags, but have less strict syntax.
A tag looks like
<tag>. Many tags operate on a scope, which you can end with
</tag>. Such scopes can be nested, and you don't have to close them in the same order that you started them.
Some tags have values and attributes, like
<tag attribute=value>. These arguments are either names or numeric values. Numbers are either regular decimal numbers, pixels like
1px, percentages like
80%, font units like
1.2em, or hexadecimal color values like
#FF. Names can be either with or without double quotes, but if there are more attributes, it's best to use quotes.
Tags plus their attributes can be up to 128 characters long. This limitation shouldn't be an issue, unless you're using very long string attributes.
|alpha, color||Color and opacity.|
|b, i||Bold and italic style.|
|font||Font and material selection.|
|lowercase, uppercase, smallcaps||Capitalization.|
|pos||Horizontal caret position.|
|s, u||Strikethrough and underline.|
|sub, sup||Subscript and superscript.|
Each text object has an overall alignment, but you can override this with tags. All four horizontal alignment options are available.
Typically, you put these tags at the start of a paragraph. If you do end up with multiply alignment tags on the same line, the last one will win.
Successive alignment scopes don't stack. The
</align> tag reverts back to the object's overall alignment.
You can change the color of your text in various ways. The most straightforward is to use
<color="colorName">. Supported color names are black, blue, green, orange, purple, red, white, and yellow.
You can also use a hexadecimal number to specify a color. Such colors are of the form
#FFFFFFFF if you also want to define the alpha value. In this case, you can omit the
color tag name.
If you only want to change the opacity of the text, you can use the
alpha tag. It works with hexadecimal values.
All color adjustments are terminated with the same color tag, no matter which starting tag you used.
Bold and Italic
You can apply bold and italic styling to your text with simple tags. The appearance of these styles are defined by the font asset that you're using.
cspace allows you to adjust the character spacing, either absolute or relative to the original font. You can use pixels or font units. Postive adjustments push the characters apart, while negative adjustments pull them together.
The closing tag reverts back to the font's normal spacing.
You can switch to a different font via
<font="fontAssetName">. From then on until you close the tag, the default font will be replaced by the font that you specified. You can also specify a material to use, so you can switch between different materials for a single font. Font and material assets must be placed inside a specifc folder, defined in the settings asset.
Font tags can be nested. Reverting to the default font can be done by closing all font tags, or by using
default as the font asset name.
indent tag does the same as the
pos tag, but the effect persists across lines. You can use this to create layouts like bullet points that work with word-wrapping. You can use pixels, font units, or percentages.
line-height tag gives you manual control over the line height. Use it to pull lines closer together or push them further apart. As the line-height controls how far down the next line start, this tag does not change the current line.
You can use pixels, font units, and percentages. Relative adjustments are based on the line-height specified by the font asset. The closing tag reverts to this height.
line-indent inserts horizontal space directly after it, and before the start of each new line. It only affects manual line breaks, not word-wrapped lines. You can use pixels, font units, or percentages.
The closing tag ends the indentation of lines.
Lowercase, Uppercase, and Smallcaps
These three tags are used to alter the capitalization of your text. The
uppercase tags work as you would expect.
allcaps is an alias for
smallcaps tag works like
uppercase, but it also decreases the size of all characters that weren't originally uppercase.
You can adjust the horizontal margins of the text with the
margin tag. If you only want to adjust the left or right margin, you can use the
margin-right tags. You can use pixels, font units, and percentages.
mark tag adds an overlay on top of the text. You can use this to highlight portions of your text. Because the markings lay on top of the text, you have to give them a semitransparent color to still be able to see the text.
Marks tags don't stack, they replace each other.
You can override a font's character spacing and turn it into a monospace font with the
mspace tag. This will force all characters to claim the same horizontal space. You can use pixels or font units to set the monospace character width.
</mspace> tag clears all monospace overrides.
Sometimes, you want to show text that will be interpreted as a tag. You could disable rich tags to deal with this. But if you also want to use tags in the same text, you can use the
noparse tag to create a scope that isn't parsed.
If you want words to stay together and not be separated by word wrapping, you can use the
You can use the
page tag to insert page breaks in your text. This cuts the text into separate blocks. The text object has to be set to page overflow mode for this to work.
pos tag gives you direct control over the horizontal caret position. You can put it anywhere on the same line, regardless where it started. You can use either pixels, font units, or percentages.
This tags is best used with left alignment.
You can adjust the font size of your text at any time. You can specify the new size in either pixels, font units, or as a percentage. Pixel adjustments can be either absolute or relative, like
-1. All relative sizes are based on the original font size, so they're not cumulative.
space tag inserts a horizontal offset, as if you inserted multiple spaces. You can use pixels or font units.
This tag interacts with word wrapping by sticking to the words it touches. If you want them to word-wrap separarately, put space characters around this tag.
You can use the
sprite tag to insert images from a sprite atlas into your text. You can access sprites by index
<sprite index=1> or by name
<sprite name="spriteName">. This inserts a sprite from the default asset.
To use a different sprite asset, use
<sprite="assetName" index=1> or
<sprite="assetName" name="spriteName">. Sprite assets must be located in a specific folder, defined by the settings asset.
If you're using a sprite index from the default sprite asset, you can use the index shorthand
By default, sprites are not affected by the Color (Vertex) setting of the text. Adding the
tint=1 attribute to the tag will tint the sprites with this color. You can also use a specific color by adding
Strikethrough and Underline
You can add an additional line that runs along your text. Underline draws the line slightly below the baseline. The vertical offset is defined by the font asset. Strikethrough places it slightly above the baseline.
Custom styles can be accessed via the
style tag. You need to specify the style name for the opening tag, but not for the closing tag. It just closes the last opened style.
Subscript and Superscript
sub tags allow you to layout text as superscript or subscript. Their offset and size is defined by the font asset. This is often used in scientific notations and numbering, like 1st and 2nd.
voffset gives the baseline a vertical offset. You can use pixels or font units and it's always relative to the original baseline. The closing tag resets back to the original baseline.
The line height is adjusted to accommodate the displaced text. If you don't want that, you can manually adjust the line height.
You can adjust the horizontal size of text area with the
width tag, using either pixels, font units, or percentages. You cannot go beyond the original size of the text object, though.
The change takes effect on the current line, but only after the tag itself. You typically place it at the start of a paragraph.
Width adjustments override each other, and the closing tag reverts to the original width.