formatText: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " <dl class="command_description"> </dl>" to "")
m (Text replacement - " " to " ")
Line 17: Line 17:


|r1= [[Structured Text]]
|r1= [[Structured Text]]
 
 
|x1= <code>[[hint]] [[formatText]] ["Image: %1", [[image]] "\a3\Data_f\Flags\flag_Altis_co.paa"];</code>
|x1= <code>[[hint]] [[formatText]] ["Image: %1", [[image]] "\a3\Data_f\Flags\flag_Altis_co.paa"];</code>



Revision as of 21:00, 10 June 2021

Hover & click on the images for description

Description

Description:
Creates a Structured Text similar to format command.
Groups:
StringsStructured Text

Syntax

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.
argument: Anything - use Structured Text where necessary (see Example 2)
Return Value:
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

Additional Information

See also:
Structured TextformatcomposeTexttextparseText

Notes

Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note