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 (Text replacement - "{{HashLink" to "{{Link")
 
(18 intermediate revisions by the same user not shown)
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 {{Link|#Example 2}})


|p2= argument: [[String]] or [[Structured Text]] - use [[Structured Text]] where necessary (see {{HashLink|#Example 2}})
|r1= [[Structured Text]]


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


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


|seealso= [[Structured Text]], [[formatText]], [[image]], [[lineBreak]], [[parseText]], [[text]], [[setAttributes]]
|seealso= [[Structured Text]] [[formatText]] [[image]] [[lineBreak]] [[parseText]] [[text]] [[setAttributes]]
}}
}}

Latest revision as of 17:43, 4 January 2023

ofpe logo.png1.00Logo 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 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
Retrieved from "https://community.bistudio.com/wiki?title=composeText&oldid=336896"