Functions/HudMessage



Display a message on the player's HUD.

Inspector Settings





 * Primary Hud Message - Message to be displayed top centre in large font.
 * Primary Display Time - Time in seconds to display the message.
 * Secondary Hud Message - Message to be displayed in top left in smaller font. This is the same area where item pickups are mentioned.
 * Secondary Display Time - Time in seconds to display the message.
 * Is Tutorial Message - ????

Adding styling
Text within the HudMessage can be styled such as adding color, increasing text size, bolding, italicizing, etc. Styling is done by adding specific supported tags. The supported tags roughly matches this list:

http://digitalnativestudios.com/textmeshpro/docs/rich-text/

The tags and examples from the above page have been reproduced here as well.

Text Alignment
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 tag reverts back to the object's overall alignment.

Right Center Left

Switching alignment.

Color
You can change the color of your text in various ways. The most straightforward is to use . 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 #FFFFFF, or #FFFFFFFF if you also want to define the alpha value. In this case, you can omit the color tag name.

Red Dark Green <#0000FF>Blue Semitransparent Red

Colors.

If you only want to change the opacity of the text, you can use the alpha tag. It works with hexadecimal values.

FF CC AA 88 66 44 22 00

Alpha from 100% to 0%.

All color adjustments are terminated with the same color tag, no matter which starting tag you used.

Red, Blue, and red again.

Restoring color.

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.

The &lt;i&gt;quick brown fox&lt;/i&gt; jumps over the &lt;b&gt;lazy dog&lt;/b&gt;.

Bold and italic.

Character Spacing
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.

Spacing is just as important as timing.

Character spacing.

Indentation
The 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.

1. It is useful for things like bullet points. 2. It is handy.

Using indentation to make a list.

Line Height
The 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 height at 100% Line height at 50% Rather cozy. <line-height=150%>Line height at 150% Such distance!

Different line heights.

Line Indentation
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.

<line-indent=15%>This is the first line of this text example. This is the second line of the same text.

Indent every new line, with one tag.

Text Link
You can use <link="ID">my link to add link metadata to a text segment. The link ID should be unique to allow you to retrieve its ID and link text content when the user interacts with your text.

You do not have to give each link a unique ID. You can reuse IDs when it makes sense, for example when linking to the same data multiple times. The linkInfo array will contain each ID only once.

While this link enables user interaction, it does not change the appearance of the linked text. You have to use other tags for that.

Lowercase, Uppercase, and Smallcaps
These three tags are used to alter the capitalization of your text. The lowercase and uppercase tags work as you would expect. allcaps is an alias for uppercase.

The smallcaps tag works like uppercase, but it also decreases the size of all characters that weren't originally uppercase.

Alice and Bob watched TV. Alice and Bob watched TV. Alice and Bob watched TV.

Modifying capitalization.

Margin
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-left or margin-right tags. You can use pixels, font units, and percentages.

Our margins used to be very wide. But those days are long gone.

Adjusting margins.

Mark
The 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.

Text <mark=#ffff00aa>can be marked with an overlay.

Marked text.

Monospacing
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.

The tag clears all monospace overrides.

Any font can become<mspace=2.75em> monospace, if you really want it.

Treating a font as monospace.

Noparse
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.

Use &lt;b&gt; for &lt;b&gt;bold&lt;/b&gt; text.

Prevent parsing of some tags.

Non-breaking Spaces
If you want words to stay together and not be separated by word wrapping, you can use the nobr tag.

You don't want I M P O R T A N T things to be broken up.

The important parts stay together.

Page Break
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.

Horizontal Position
The 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.

at <pos=75%>75% at <pos=25%>25% at <pos=50%>50% at 0%

Setting positions.

Font Size
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 and -1. All relative sizes are based on the original font size, so they're not cumulative.

<size=100%>Echo <size=80%>Echo <size=60%>Echo <size=40%>Echo <size=20%>Echo

Adjusting size.

Horizontal Space
The 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.

Give me some space.

Adding some space.

Sprite
You can use the sprite tag to insert images from a sprite atlas into your text. You can access sprites by index 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 color=#FFFFFF.

Sprites! More sprites! And even more! <sprite name="Default Sprite Asset_4" color=#55FF55FF>

Inserting sprites from the default sprite asset.

Prodeus specific sprite information
Each sprite appears to be a keyboard or game controller button. The range appears to go from to. Sprite 0 is the 'Q' keyboard key and it goes left to right (US 105 key keyboard). So sprites 0 to 12 is the Q key to the \ key (backslash). Sprite 13 starts at the 'A' key, so on and so forth.

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.

The &lt;s&gt;quick brown&lt;/s&gt; fox jumps over &lt;u&gt;the lazy dog&lt;/u&gt;.

Strikethrough and underline.

Style
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.

<style="Title">Styles You can create your own.

Custom styles are handy.

Subscript and Superscript
The sup and 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.

We have 1m3 of H2O.

Subscript and superscript.

Vertical Offset
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.

Up up UP and <voffset=-0.5em>down we go again.

Vertical offset.

Text Width
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.

I remember when we had lots of space for text. <width=60%>But those days are long gone.

Adjusting text area width.