formatText: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "_{10,} " to "") |
Lou Montana (talk | contribs) m (Text replacement - " *\| *([Cc]omments|COMMENTS|Game|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments( \("local" or "global"\))?|Effects|Multiplayer Effects( \("local" or "global"\))?|Multiplayer Exe...) |
||
| Line 1: | Line 1: | ||
{{Command | {{Command | ||
| arma1 | | arma1 | ||
|1.00 | |1.00 | ||
|gr1= Strings | |gr1= Strings | ||
|gr2= Structured Text | |gr2= Structured Text | ||
| Creates a [[Structured Text]] similar to [[format]] command. | | Creates a [[Structured Text]] similar to [[format]] command. | ||
| [[formatText]] [format, argument1, argument2, ...] | | [[formatText]] [format, argument1, argument2, ...] | ||
|p1= [format, argument1, argument2, ...]: [[Array]] | |p1= [format, argument1, argument2, ...]: [[Array]] | ||
| Line 19: | Line 19: | ||
|p3= argument: [[Anything]] - use [[Structured Text]] where necessary (see [[#Example|Example 2]]) | |p3= argument: [[Anything]] - use [[Structured Text]] where necessary (see [[#Example|Example 2]]) | ||
| [[Structured Text]] | | [[Structured Text]] | ||
|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> | ||
|x2= <code>[[hint]] [[formatText]] ["%1%2%3", "line1", "<nowiki><br/></nowiki>", "line2"]; {{cc|result displayed in one line}} | |x2= <code>[[hint]] [[formatText]] ["%1%2%3", "line1", "<nowiki><br/></nowiki>", "line2"]; {{cc|result displayed in one line}} | ||
[[hint]] [[formatText]] ["%1%2%3", "line1", [[lineBreak]], "line2"]; {{cc|result displayed in two lines}}</code> | [[hint]] [[formatText]] ["%1%2%3", "line1", [[lineBreak]], "line2"]; {{cc|result displayed in two lines}}</code> | ||
| [[Structured Text]], [[format]], [[composeText]], [[text]], [[parseText]] | | [[Structured Text]], [[format]], [[composeText]], [[text]], [[parseText]] | ||
}} | }} | ||
Revision as of 01:33, 18 January 2021
Description
- Description:
- Creates a Structured Text similar to format command.
- Groups:
- StringsStructured Text
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
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 Armed Assault version 1.00
- ArmA: Armed Assault: New Scripting Commands
- ArmA: Armed Assault: Scripting Commands
- Command Group: Strings
- Command Group: Structured Text
- Operation Flashpoint: Elite: Scripting Commands
- Arma 2: Scripting Commands
- Arma 3: Scripting Commands
- Take On Helicopters: Scripting Commands