formatText: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(format, see also)
(example)
Line 7: Line 7:
____________________________________________________________________________________________
____________________________________________________________________________________________


| Creates a structured text by replacing %1, %2, etc. in format with plain <u>or structured texts</u> given as arguments. |= Description
| Creates a [[Structured Text]] similar to [[format]] command. |= Description
____________________________________________________________________________________________
____________________________________________________________________________________________


| '''formatText''' [format, arg1, arg2, ...] |= Syntax
| '''formatText''' [format, argument1, argument2, ...] |= Syntax


|p1= [format, arg1, arg2, ...]: [[Array]]
|p1= [format, argument1, argument2, ...]: [[Array]]
|p2= format: [[String]]
|p2= 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.
|p3= args: [[Anything]]
|p3= argument: [[Anything]] - use [[Structured Text]] where necessary (see Example 2)


| [[Structured Text]] |= Return value
| [[Structured Text]] |= Return value
____________________________________________________________________________________________
____________________________________________________________________________________________
   
   
|x1= <code>_text = [[formatText]] ["Image: %1", [[image]] "data\isniper.paa"];</code> |= Example 1
|x1= <code>[[hint]] [[formatText]] ["Image: %1", [[image]] "\a3\Data_f\Flags\flag_Altis_co.paa"];</code> |= Example 1
|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> |= Example 2
____________________________________________________________________________________________
____________________________________________________________________________________________



Revision as of 21:25, 13 January 2019

-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