composeText: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Bot: Reverted to revision 98800 by dr_eyeball on 2017-02-12T07:22:16Z)
(cleanup example)
Line 7: Line 7:
____________________________________________________________________________________________
____________________________________________________________________________________________


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


| '''composeText''' [text1, text2, ...] |= Syntax
| '''composeText''' [argument1, argument2, ...] |= Syntax


|p1= [text1, text2, ...]: [[Array]] of [[String]]s and/or [[Structured Text]]s |= Parameter 1
|p1= [argument1, argument2, ...]: [[Array]] |= Parameter 1
|p2= argument: [[String]] or [[Structured Text]] - use [[Structured Text]] where necessary (see Example 2)|= Parameter 2


| [[Structured Text]] |= Return value
| [[Structured Text]] |= Return value
____________________________________________________________________________________________
____________________________________________________________________________________________
   
   
|x1= <code>_txt = [[composeText]] ["First line", [[image]] "data\isniper.paa", [[lineBreak]], "Second line"];</code> |= Example 1
|x1= <code>[[hint]] [[composeText]] ["Image: ", [[image]] "\a3\Data_f\Flags\flag_Altis_co.paa"];</code> |= Example 1
|x2= <code>[[hint]]  [[composeText]] ["line1", "<nowiki><br/></nowiki>", "line2"]; // result displayed in one line
[[hint]] [[composeText]] ["line1", [[lineBreak]], "line2"]; // result displayed in two lines</code> |= Example 2
____________________________________________________________________________________________
____________________________________________________________________________________________


| [[image]], [[lineBreak]], [[parseText]], [[text]], [[setAttributes]] |= See also
| [[formatText]], [[image]], [[lineBreak]], [[parseText]], [[text]], [[setAttributes]] |= See also


}}
}}

Revision as of 20:34, 13 January 2019

-wrong parameter ("Arma") defined!-1.00
Hover & click on the images for description

Description

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

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:
formatTextimagelineBreakparseTexttextsetAttributes

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