composeText: Difference between revisions

Latest revision as of 18:43, 4 January 2023

Hover & click on the images for description

Description:: Creates a Structured Text by joining the given structured or plain text arguments.
Groups:: Strings Structured Text

Syntax:: composeText arguments
Parameters:: arguments: Array of String and/or Structured Text - use Structured Text where necessary (see Example 2)
Return Value:: Structured Text

Example 1:: hint composeText ["Image: ", image "\a3\Data_f\Flags\flag_Altis_co.paa"];
Example 2:: hint composeText ["line1", "<br/>", "line2"]; // result displayed in one line hint composeText ["line1", lineBreak, "line2"]; // result displayed in two lines

See also:: Structured Text formatText image lineBreak parseText text setAttributes

: 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

@@ Line 1: / Line 1: @@
-[[Category:Scripting Commands|C]]
+{{RV|type=command
-[[Category:Scripting Commands OFP Elite |C]]
-[[Category:Scripting Commands ArmA|C]]
-<new command not populated>
+|game1= ofpe
+|version1= 1.00
+|game2= arma1
+|version2= 1.00
-<h2 style="color:#000066">''''' composeText '''''</h2>
+|game3= arma2
+|version3= 1.00
+|game4= arma2oa
+|version4= 1.50
-'''Operand types:'''
+|game5= tkoh
+|version5= 1.00
-'''Type of returned value:'''
+|game6= arma3
+|version6= 0.50
-'''Compatibility:'''
+|gr1= Strings
-'''Description:'''
+|gr2= Structured Text
+|descr= Creates a [[Structured Text]] by joining the given [[Structured Text | structured]] or [[String | plain]] text arguments.
-'''Example:'''
+|s1= [[composeText]] arguments
+|p1= arguments: [[Array]] of [[String]] and/or [[Structured Text]] - use [[Structured Text]] where necessary (see {{Link|#Example 2}})
+|r1= [[Structured Text]]
+|x1= <sqf>hint composeText ["Image: ", image "\a3\Data_f\Flags\flag_Altis_co.paa"];</sqf>
+|x2= <sqf>
+hint composeText ["line1", "<br/>", "line2"];		// result displayed in one line
+hint composeText ["line1", lineBreak, "line2"];	// result displayed in two lines
+</sqf>
+|seealso= [[Structured Text]] [[formatText]] [[image]] [[lineBreak]] [[parseText]] [[text]] [[setAttributes]]
+}}