formatText: Difference between revisions
Jump to navigation
Jump to search
Killzone Kid (talk | contribs) (example) |
m (template:command argument fix) |
||
| Line 7: | Line 7: | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| Creates a [[Structured Text]] similar to [[format]] command. |= | | Creates a [[Structured Text]] similar to [[format]] command. |DESCRIPTION= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| '''formatText''' [format, argument1, argument2, ...] |= | | '''formatText''' [format, argument1, argument2, ...] |SYNTAX= | ||
|p1= [format, argument1, argument2, ...]: [[Array]] | |p1= [format, argument1, argument2, ...]: [[Array]] | ||
| Line 16: | Line 16: | ||
|p3= argument: [[Anything]] - use [[Structured Text]] where necessary (see Example 2) | |p3= argument: [[Anything]] - use [[Structured Text]] where necessary (see Example 2) | ||
| [[Structured Text]] |= | | [[Structured Text]] |RETURNVALUE= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
|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> |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> |= | [[hint]] [[formatText]] ["%1%2%3", "line1", [[lineBreak]], "line2"]; // result displayed in two lines</code> |EXAMPLE2= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| [[format]], [[composeText]], [[text]], [[parseText]] |= | | [[format]], [[composeText]], [[text]], [[parseText]] |SEEALSO= | ||
}} | }} | ||
Revision as of 14:39, 7 April 2019
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
Categories:
- Scripting Commands
- Introduced with Arma version 1.00
- Arma: New Scripting Commands
- Arma: Scripting Commands
- Command Group: Uncategorised
- Scripting Commands OFP Elite
- Scripting Commands ArmA
- Command Group: Interaction
- Command Group: Variables
- Scripting Commands ArmA2
- Scripting Commands Arma 3
- Scripting Commands Take On Helicopters