composeText: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
m (Text replacement - "{{HashLink" to "{{Link")
 
(77 intermediate revisions by 17 users not shown)
Line 1: Line 1:
[[Category:Scripting Commands|COMPOSETEXT]]
{{RV|type=command
[[Category:Scripting Commands OFP Elite |COMPOSETEXT]]
[[Category:Scripting Commands ArmA|COMPOSETEXT]]


|game1= ofpe
|version1= 1.00


<h2 style="color:#000066">''' composeText ''[text1, text2, ...]'''''</h2>
|game2= arma1
|version2= 1.00


|game3= arma2
|version3= 1.00


'''Operand types:'''
|game4= arma2oa
|version4= 1.50


'''[text1, text2, ...]:''' [[Array]]
|game5= tkoh
|version5= 1.00


'''Type of returned value:'''
|game6= arma3
|version6= 0.50


[[Structured Text]]
|gr1= Strings


'''Compatibility:'''
|gr2= Structured Text


Version 2.01 required.
|descr= Creates a [[Structured Text]] by joining the given [[Structured Text | structured]] or [[String | plain]] text arguments.


'''Description:'''
|s1= [[composeText]] arguments


Creates a structured text by joining the given structured or plain texts.
|p1= arguments: [[Array]] of [[String]] and/or [[Structured Text]] - use [[Structured Text]] where necessary (see {{Link|#Example 2}})


|r1= [[Structured Text]]


'''Example:'''
|x1= <sqf>hint composeText ["Image: ", image "\a3\Data_f\Flags\flag_Altis_co.paa"];</sqf>


txt = '''composeText''' ["First line", image "data\isniper.paa", lineBreak, "Second line"]
|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]]
}}

Latest revision as of 17:43, 4 January 2023

Hover & click on the images for description

Description

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

Syntax

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

Examples

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

Additional Information

See also:
Structured Text formatText image lineBreak parseText text setAttributes

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