TextMeshProFormatter

TextMeshProFormatter

The TextMeshProFormatter class provides an easy way to build rich text strings for TextMeshPro in Unity. It supports various formatting options, such as bold, italic, underline, strikethrough, color, size, font, and more.

Features

• Text Formatting: Apply bold, italic, underline, and strikethrough formatting.
• Color and Size: Set the text color and size.
• Font: Specify the font asset for the text.
• Alignment and Opacity: Adjust text alignment and opacity.
• Gradient, Rotation, and More: Create text with gradients, rotate text, and insert sprites.

Usage

Here's a few examples of how to use TextMeshProFormatter:

Font Styles

    public void FontStylesExample()
    {
        StringBuilder sb = new StringBuilder();
        sb.Append("Font styles can be ");
        sb.Append(formatter.AppendText("Bold ").Bold().GetFormattedText());
        sb.Append(formatter.AppendText("Strikethrough ").Strikethrough().GetFormattedText());
        sb.Append(formatter.AppendText("Underline ").Underline().GetFormattedText());
        sb.Append(formatter.AppendText("Italicize").Italicize().GetFormattedText());
        DisplayString(sb.ToString());
    }

Colors

   public const string black = "000000";
   public const string blue = "3498db";
   public const string green = "2ecc71";
   public const string red = "e74c3c";
   public const string purple = "9b59b6";
   public const string white = "ffffff";
   public const string yellow = "f1c40f";

   private string GetRandomColor()
   {
       string[] colors = { black, blue, green, red, purple, white, yellow };
       int index = UnityEngine.Random.Range(0, colors.Length);
       return colors[index];
   }

   public void ColorsExample()
   {
       StringBuilder sb = new StringBuilder();
       sb.Append(formatter.AppendText("Here ").SetColor(GetRandomColor()).GetFormattedText());
       sb.Append(formatter.AppendText("are ").SetColor(GetRandomColor()).GetFormattedText());
       sb.Append(formatter.AppendText("some ").SetColor(GetRandomColor()).GetFormattedText());
       sb.Append(formatter.AppendText("different ").SetColor(GetRandomColor()).GetFormattedText());
       sb.Append(formatter.AppendText("colored ").SetColor(GetRandomColor()).GetFormattedText());
       sb.Append(formatter.AppendText("strings! ").SetColor(GetRandomColor()).GetFormattedText());
       DisplayString(sb.ToString());
   }

Size

   public void SizeExample()
   {
       StringBuilder sb = new StringBuilder();
       sb.Append(formatter.AppendText("Here ").SetSize(40).GetFormattedText());
       sb.Append(formatter.AppendText("are ").SetSize(60).GetFormattedText());
       sb.Append(formatter.AppendText("some ").SetSize(80).GetFormattedText());
       sb.Append(formatter.AppendText("different ").SetSize(50).GetFormattedText());
       sb.Append(formatter.AppendText("sized ").SetSize(100).GetFormattedText());
       sb.Append(formatter.AppendText("strings!").SetSize(90).GetFormattedText());
       DisplayString(sb.ToString());
   }

Alpha and Rotation

   public void AlphaAndRotationExample()
   {
       StringBuilder sb = new StringBuilder();
       sb.Append("Default text\n");
       sb.Append(formatter.AppendText("Decreasing ").SetOpacity(.5f).GetFormattedText());
       sb.Append(formatter.AppendText("Text ").SetOpacity(.25f).GetFormattedText());
       sb.Append(formatter.AppendText("Alpha\n").SetOpacity(.1f).GetFormattedText());
       sb.Append(formatter.AppendText("Rotated ").Rotate(30).GetFormattedText());
       sb.Append(formatter.AppendText("Text ").Rotate(-30).GetFormattedText());
       DisplayString(sb.ToString());
   }

Combined

   public void CombinedExample()
   {
       StringBuilder sb = new StringBuilder();
       sb.AppendLine(formatter.AppendText("Example Title\n")
           .Bold()
           .Underline()
           .SetSize(85)
           .SetColor(red)
           .GetFormattedText());

       sb.AppendLine(formatter.AppendText("Subject: ")
           .SetOpacity(0.5f)
           .AppendText("Example Subject\n")
           .Italicize()
           .SetSize(45)
           .GetFormattedText());

       sb.Append(formatter.AppendText("Here is an example of a message.\n This message has multiple lines.\n End of message.").SetSize(35).GetFormattedText());
       DisplayString(sb.ToString());
   }