formatText: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "Category:Scripting Commands ArmA2" to "Category:Scripting Commands Arma 2")
m (Text replacement - "<br/>" to "<br>")
Line 20: Line 20:
   
   
|x1= <code>[[hint]] [[formatText]] ["Image: %1", [[image]] "\a3\Data_f\Flags\flag_Altis_co.paa"];</code> |EXAMPLE1=
|x1= <code>[[hint]] [[formatText]] ["Image: %1", [[image]] "\a3\Data_f\Flags\flag_Altis_co.paa"];</code> |EXAMPLE1=
|x2= <code>[[hint]] [[formatText]] ["%1%2%3", "line1", "<nowiki><br/></nowiki>", "line2"]; // result displayed in one line
|x2= <code>[[hint]] [[formatText]] ["%1%2%3", "line1", "<nowiki><br></nowiki>", "line2"]; // result displayed in one line
[[hint]] [[formatText]] ["%1%2%3", "line1", [[lineBreak]], "line2"]; // result displayed in two lines</code> |EXAMPLE2=
[[hint]] [[formatText]] ["%1%2%3", "line1", [[lineBreak]], "line2"]; // result displayed in two lines</code> |EXAMPLE2=
____________________________________________________________________________________________
____________________________________________________________________________________________

Revision as of 14:42, 14 March 2020

-wrong parameter ("Arma") defined!-1.00
Hover & click on the images for description

Description

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

Syntax

Syntax:
formatText [format, argument1, argument2, ...]
Parameters:
[format, argument1, argument2, ...]: Array
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:
formatcomposeTexttextparseText

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

Notes

Bottom Section