composeText: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[#Examples\|Example ([0-9])\]\]" to "{{HashLink|#Example $1}}")
m (Some wiki formatting)
Line 25: Line 25:
|descr= Creates a [[Structured Text]] by joining the given [[Structured Text | structured]] or [[String | plain]] text arguments.
|descr= Creates a [[Structured Text]] by joining the given [[Structured Text | structured]] or [[String | plain]] text arguments.


|s1= [[composeText]] [argument1, argument2, ...]
|s1= [[composeText]] arguments


|p1= [argument1, argument2, ...]: [[Array]]
|p1= arguments: [[Array]] of [[String]] and/or [[Structured Text]] - use [[Structured Text]] where necessary (see {{HashLink|#Example 2}})
 
|p2= argument: [[String]] or [[Structured Text]] - use [[Structured Text]] where necessary (see {{HashLink|#Example 2}})


|r1= [[Structured Text]]
|r1= [[Structured Text]]


|x1= <code>[[hint]] [[composeText]] ["Image: ", [[image]] "\a3\Data_f\Flags\flag_Altis_co.paa"];</code>
|x1= <code>[[hint]] [[composeText]] ["Image: ", [[image]] "\a3\Data_f\Flags\flag_Altis_co.paa"];</code>
|x2= <code>[[hint]] [[composeText]] ["line1", "<nowiki><br/></nowiki>", "line2"]; {{cc|result displayed in one line}}
|x2= <code>[[hint]] [[composeText]] ["line1", "<nowiki><br/></nowiki>", "line2"]; {{cc|result displayed in one line}}
[[hint]] [[composeText]] ["line1", [[lineBreak]], "line2"]; {{cc|result displayed in two lines}}</code>
[[hint]] [[composeText]] ["line1", [[lineBreak]], "line2"]; {{cc|result displayed in two lines}}</code>

Revision as of 03:04, 25 November 2021

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 TextformatTextimagelineBreakparseTexttextsetAttributes

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