formatText: Difference between revisions

From Bohemia Interactive Community
m (Text replacement - "<h3 style="display:none">Bottom Section</h3> " to "")
mNo edit summary
 
(14 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Command
{{RV|type=command


| arma1
|game1= arma1
|version1= 1.00


|1.00
|game2= arma2
|version2= 1.00
 
|game3= arma2oa
|version3= 1.50
 
|game4= tkoh
|version4= 1.00
 
|game5= arma3
|version5= 0.50


|gr1= Strings
|gr1= Strings
Line 9: Line 20:
|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= [format, argument1, argument2, ...]: [[Array]]
|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= 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= argumentN: [[Anything]] - use [[Structured Text]] where necessary (see [[#Example|Example 2]])


|p3= argument: [[Anything]] - use [[Structured Text]] where necessary (see [[#Example|Example 2]])
|r1= [[Structured Text]]


| [[Structured Text]]
|x1= <sqf>hint formatText ["Image: %1", image "\a3\Data_f\Flags\flag_Altis_co.paa"];</sqf>
 
|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= <sqf>
[[hint]] [[formatText]] ["%1%2%3", "line1", [[lineBreak]], "line2"]; {{cc|result displayed in two lines}}</code>
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
</sqf>


| [[Structured Text]], [[format]], [[composeText]], [[text]], [[parseText]]
|seealso= [[Structured Text]] [[format]] [[composeText]] [[text]] [[parseText]]
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
{{GameCategory|ofpe|Scripting Commands}}
{{GameCategory|arma2|Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}
{{GameCategory|tkoh|Scripting Commands}}

Latest revision as of 03:21, 27 November 2023

Logo A1 black.png 1.00Logo A2.png 1.00A2 OA Logo.png 1.50tkoh logo small.png 1.00Arma 3 logo black.png 0.50
Hover & click on the images for description

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.
argumentN: 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 Text format composeText text parseText

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
Retrieved from "https://community.bistudio.com/wiki?title=formatText&oldid=351276"