formatText: Difference between revisions

Latest revision as of 03:21, 27 November 2023

Hover & click on the images for description

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)
Return Value:: Structured Text

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

: 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

@@ Line 1: / Line 1: @@
-[[Category:Scripting Commands|F]]
+{{RV|type=command
-[[Category:Scripting Commands OFP Elite |F]]
-[[Category:Scripting Commands ArmA|F]]
-<new command not populated>
+|game1= arma1
+|version1= 1.00
+|game2= arma2
+|version2= 1.00
-<h2 style="color:#000066">''''' formatText '''''</h2>
+|game3= arma2oa
+|version3= 1.50
+|game4= tkoh
+|version4= 1.00
-'''Operand types:'''
+|game5= arma3
+|version5= 0.50
-'''Type of returned value:'''
+|gr1= Strings
-'''Compatibility:'''
+|gr2= Structured Text
-'''Description:'''
+|descr= Creates a [[Structured Text]] similar to [[format]] command.
+|s1= [[formatText]] [format, argument1, argument2, ...]
-'''Example:'''
+|p1= 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.
+|p2= argumentN: [[Anything]] - use [[Structured Text]] where necessary (see [[#Example|Example 2]])
+|r1= [[Structured Text]]
+|x1= <sqf>hint formatText ["Image: %1", image "\a3\Data_f\Flags\flag_Altis_co.paa"];</sqf>
+|x2= <sqf>
+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
+</sqf>
+|seealso= [[Structured Text]] [[format]] [[composeText]] [[text]] [[parseText]]
+}}