formatText: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "{{Command " to "{{RV|type=command ") |
(names params, parameter cleanup, removed ofpe category (command was added in arma 1)) |
||
| Line 1: | Line 1: | ||
{{RV|type=command | {{RV|type=command | ||
| arma1 | |game1= arma1 | ||
|1.00 | |version1= 1.00 | ||
|gr1= Strings | |gr1= Strings | ||
| Line 9: | Line 9: | ||
|gr2= Structured Text | |gr2= Structured Text | ||
| Creates a [[Structured Text]] similar to [[format]] command. | |descr= Creates a [[Structured Text]] similar to [[format]] command. | ||
| [[formatText]] [format, argument1, argument2, ...] | |s1= [[formatText]] [format, argument1, argument2, ...] | ||
|p1= | |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= | |p2= argument: [[Anything]] - use [[Structured Text]] where necessary (see [[#Example|Example 2]]) | ||
| | |r1= [[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> | ||
| Line 26: | Line 24: | ||
[[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]] | |seealso= [[Structured Text]], [[format]], [[composeText]], [[text]], [[parseText]] | ||
}} | }} | ||
| Line 36: | Line 34: | ||
</dl> | </dl> | ||
{{GameCategory|arma2|Scripting Commands}} | {{GameCategory|arma2|Scripting Commands}} | ||
{{GameCategory|arma3|Scripting Commands}} | {{GameCategory|arma3|Scripting Commands}} | ||
{{GameCategory|tkoh|Scripting Commands}} | {{GameCategory|tkoh|Scripting Commands}} | ||
Revision as of 02:10, 11 February 2021
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
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