composeText: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " <h3 style="display:none">Notes</h3> <dl class="command_description"> <!-- Note Section BEGIN --> <!-- Note Section END --> </dl> " to "")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|Game|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments( \("local" or "global"\))?|Effects|Multiplayer Effects( \("local" or "global"\))?|Multiplayer Exe...)
Line 1: Line 1:
{{Command|Comments=
{{Command


| arma1 |Game name=
| arma1


|1.00|Game version=
|1.00


|gr1= Strings |GROUP1=
|gr1= Strings


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


| 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.


| [[composeText]] [argument1, argument2, ...] |SYNTAX=
| [[composeText]] [argument1, argument2, ...]


|p1= [argument1, argument2, ...]: [[Array]] |PARAMETER1=
|p1= [argument1, argument2, ...]: [[Array]]


|p2= argument: [[String]] or [[Structured Text]] - use [[Structured Text]] where necessary (see [[#Examples|Example 2]]) |PARAMETER2=
|p2= argument: [[String]] or [[Structured Text]] - use [[Structured Text]] where necessary (see [[#Examples|Example 2]])


| [[Structured Text]] |RETURNVALUE=
| [[Structured Text]]
   
   
|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>
|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>


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



Revision as of 00:12, 18 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

Bottom Section