formatText: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "<br/>" to "<br>")
m (Fix <br /> / <br> replacement mistake)
Line 10: Line 10:
____________________________________________________________________________________________
____________________________________________________________________________________________


| '''formatText''' [format, argument1, argument2, ...] |SYNTAX=
| [[formatText]] [format, argument1, argument2, ...] |SYNTAX=


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


| [[Structured Text]] |RETURNVALUE=
| [[Structured Text]] |RETURNVALUE=
Line 20: Line 22:
   
   
|x1= <code>[[hint]] [[formatText]] ["Image: %1", [[image]] "\a3\Data_f\Flags\flag_Altis_co.paa"];</code> |EXAMPLE1=
|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
 
[[hint]] [[formatText]] ["%1%2%3", "line1", [[lineBreak]], "line2"]; // result displayed in two lines</code> |EXAMPLE2=
|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> |EXAMPLE2=
____________________________________________________________________________________________
____________________________________________________________________________________________


| [[format]], [[composeText]], [[text]], [[parseText]] |SEEALSO=
| [[Structured Text]], [[format]], [[composeText]], [[text]], [[parseText]] |SEEALSO=
 
}}
}}


Line 37: Line 39:


<h3 style="display:none">Bottom Section</h3>
<h3 style="display:none">Bottom Section</h3>
[[Category:Scripting Commands|FORMATTEXT]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands OFP Elite |FORMATTEXT]]
[[Category:Scripting Commands OFP Elite |{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA|FORMATTEXT]]
[[Category:Scripting Commands ArmA|{{uc:{{PAGENAME}}}}]]
[[Category:Command_Group:_Interaction|{{uc:{{PAGENAME}}}}]]
[[Category:Command_Group:_Variables|{{uc:{{PAGENAME}}}}]]
[[Category:Command_Group:_Variables|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Command_Group:_Interaction|{{uc:{{PAGENAME}}}}]]

Revision as of 11:19, 19 March 2020

-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:
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

Notes

Bottom Section