composeText: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]OFP[ _]Elite *(\|.*)?\]\]" to "{{GameCategory|ofpe|Scripting Commands}}")
m (Text replacement - "_{10,} " to "")
Line 1: Line 1:
{{Command|Comments=
{{Command|Comments=
____________________________________________________________________________________________


| arma1 |Game name=
| arma1 |Game name=
Line 9: Line 8:


|gr2= Structured Text |GROUP2=
|gr2= Structured Text |GROUP2=
____________________________________________________________________________________________


| Creates a [[Structured Text]] by joining the given [[Structured Text | structured]] or [[String | plain]] text arguments. |DESCRIPTION=
| Creates a [[Structured Text]] by joining the given [[Structured Text | structured]] or [[String | plain]] text arguments. |DESCRIPTION=
____________________________________________________________________________________________


| [[composeText]] [argument1, argument2, ...] |SYNTAX=
| [[composeText]] [argument1, argument2, ...] |SYNTAX=
Line 21: Line 18:


| [[Structured Text]] |RETURNVALUE=
| [[Structured Text]] |RETURNVALUE=
____________________________________________________________________________________________
   
   
|x1= <code>[[hint]] [[composeText]] ["Image: ", [[image]] "\a3\Data_f\Flags\flag_Altis_co.paa"];</code> |EXAMPLE1=
|x1= <code>[[hint]] [[composeText]] ["Image: ", [[image]] "\a3\Data_f\Flags\flag_Altis_co.paa"];</code> |EXAMPLE1=
|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> |EXAMPLE2=
[[hint]] [[composeText]] ["line1", [[lineBreak]], "line2"]; {{cc|result displayed in two lines}}</code> |EXAMPLE2=
____________________________________________________________________________________________


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

Revision as of 00:27, 17 January 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 [argument1, argument2, ...]
Parameters:
[argument1, argument2, ...]: Array
argument: String 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

Notes

Bottom Section