formatText: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(format, see also)
mNo edit summary
 
(35 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| arma |= Game name
|game1= arma1
|version1= 1.00


|1.00|= Game version
|game2= arma2
____________________________________________________________________________________________
|version2= 1.00


| Creates a structured text by replacing %1, %2, etc. in format with plain <u>or structured texts</u> given as arguments. |= Description
|game3= arma2oa
____________________________________________________________________________________________
|version3= 1.50


| '''formatText''' [format, arg1, arg2, ...] |= Syntax
|game4= tkoh
|version4= 1.00


|p1= [format, arg1, arg2, ...]: [[Array]]
|game5= arma3
|p2= format: [[String]]
|version5= 0.50
|p3= args: [[Anything]]


| [[Structured Text]] |= Return value
|gr1= Strings
____________________________________________________________________________________________
 
|x1= <code>_text = [[formatText]] ["Image: %1", [[image]] "data\isniper.paa"];</code> |= Example 1
____________________________________________________________________________________________


| [[format]], [[composeText]], [[text]], [[parseText]] |= See also
|gr2= Structured Text


}}
|descr= Creates a [[Structured Text]] similar to [[format]] command.
 
|s1= [[formatText]] [format, argument1, argument2, ...]
 
|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= argumentN: [[Anything]] - use [[Structured Text]] where necessary (see [[#Example|Example 2]])


<h3 style="display:none">Notes</h3>
|r1= [[Structured Text]]
<dl class="command_description">


<!-- Note Section BEGIN -->
|x1= <sqf>hint formatText ["Image: %1", image "\a3\Data_f\Flags\flag_Altis_co.paa"];</sqf>


<!-- Note Section END -->
|x2= <sqf>
</dl>
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>


<h3 style="display:none">Bottom Section</h3>
|seealso= [[Structured Text]] [[format]] [[composeText]] [[text]] [[parseText]]
[[Category:Scripting Commands|FORMATTEXT]]
}}
[[Category:Scripting Commands OFP Elite |FORMATTEXT]]
[[Category:Scripting Commands ArmA|FORMATTEXT]]
[[Category:Command_Group:_Interaction|{{uc:{{PAGENAME}}}}]]
[[Category:Command_Group:_Variables|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]

Latest revision as of 04:21, 27 November 2023

Logo A1 black.png1.00Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.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"