formatText

Description

Creates a Structured Text similar to format command.

Syntax

formatText [format, argument1, argument2, ...]

Parameters:

• format: String - a string containing text and/or references to the variables listed below in the array. The references appear in the form of %1, %2 etc.
• argumentN: Anything - use Structured Text where necessary (see Example 2)

Returns: Structured Text

Examples

Example 1

hint formatText ["Image: %1", image "\a3\Data_f\Flags\flag_Altis_co.paa"];

Example 2

hint formatText ["%1%2%3", "line1", "<br/>", "line2"];        // result displayed in one line
hint formatText ["%1%2%3", "line1", lineBreak, "line2"];    // result displayed in two lines

See also

Structured Text · format · composeText · text · parseText