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 - "{{HashLink" to "{{Link")
 
(36 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


| arma1 |Game name=
|game1= ofpe
|version1= 1.00


|1.00|Game version=
|game2= arma1
|version2= 1.00


|gr1= Strings |GROUP1=
|game3= arma2
|version3= 1.00


|gr2= Structured Text |GROUP2=
|game4= arma2oa
____________________________________________________________________________________________
|version4= 1.50


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


| [[composeText]] [argument1, argument2, ...] |SYNTAX=
|game6= arma3
|version6= 0.50


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


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


| [[Structured Text]] |RETURNVALUE=
|descr= Creates a [[Structured Text]] by joining the given [[Structured Text | structured]] or [[String | plain]] text arguments.
____________________________________________________________________________________________
 
|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}}
[[hint]] [[composeText]] ["line1", [[lineBreak]], "line2"]; {{cc|result displayed in two lines}}</code> |EXAMPLE2=
____________________________________________________________________________________________


| [[Structured Text]], [[formatText]], [[image]], [[lineBreak]], [[parseText]], [[text]], [[setAttributes]] |SEEALSO=
|s1= [[composeText]] arguments
}}
 
|p1= arguments: [[Array]] of [[String]] and/or [[Structured Text]] - use [[Structured Text]] where necessary (see {{Link|#Example 2}})


<h3 style="display:none">Notes</h3>
|r1= [[Structured Text]]
<dl class="command_description">
<!-- Note Section BEGIN -->


<!-- Note Section END -->
|x1= <sqf>hint composeText ["Image: ", image "\a3\Data_f\Flags\flag_Altis_co.paa"];</sqf>
</dl>


<h3 style="display:none">Bottom Section</h3>
|x2= <sqf>
hint composeText ["line1", "<br/>", "line2"]; // result displayed in one line
hint composeText ["line1", lineBreak, "line2"]; // result displayed in two lines
</sqf>


[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
|seealso= [[Structured Text]] [[formatText]] [[image]] [[lineBreak]] [[parseText]] [[text]] [[setAttributes]]
{{GameCategory|ofpe|Scripting Commands}}
}}
{{GameCategory|arma1|Scripting Commands}}
{{GameCategory|arma2|Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}
{{GameCategory|tkoh|Scripting Commands}}

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"