formatText: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " +" to " ")
m (Add more games)
Line 3: Line 3:
|game1= arma1
|game1= arma1
|version1= 1.00
|version1= 1.00
|game2= arma2
|version2= 1.00
|game3= arma2oa
|version3= 1.50
|game4= tkoh
|version4= 1.00
|game5= arma3
|version5= 0.50


|gr1= Strings
|gr1= Strings
Line 25: Line 37:
|seealso= [[Structured Text]], [[format]], [[composeText]], [[text]], [[parseText]]
|seealso= [[Structured Text]], [[format]], [[composeText]], [[text]], [[parseText]]
}}
}}
{{GameCategory|arma2|Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}
{{GameCategory|tkoh|Scripting Commands}}

Revision as of 21:20, 16 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