Page tree
Skip to end of metadata
Go to start of metadata



Introduced in

Version:1.00

Description

Description:Creates a Structured_Text, using the formatting string, and replaces any variables with the passed arguments. Formatting tags (such as <t size='2'>big</t>) are not parsed, an are passed in the original form to the output string.

Syntax

Syntax:formatText [formatString, var1, var2, ...]
Parameters:
  • formatString: String - A string containing text and / or references to the variables passed after the string. The references appear in the form of %1%2, and so on. Line breaks can be passed as a variable, containing lineBreak.
  • var1: Any Value - Variable referenced by %1.
  • var2: Any Value - Variable referenced by %2.
Return Value:Structured_Text

Examples

Examples:
_text = "<t size=2>BIG</t>";
_img = image "\vbs2\ui\data\flag_bluefor_co";
hint formatText ["Unparsed:%1%2Parsed:%3%4Image:%5",_text,lineBreak,parseText _text,lineBreak,_img]

Additional Information

See also: parseText, composeText, format
Multiplayer: 
Problems: 

Notes