formatText: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(names params, parameter cleanup, removed ofpe category (command was added in arma 1))
mNo edit summary
 
(11 intermediate revisions by one other user not shown)
Line 2: Line 2:


|game1= arma1
|game1= arma1
|version1= 1.00


|version1= 1.00
|game2= arma2
|version2= 1.00
 
|game3= arma2oa
|version3= 1.50
 
|game4= tkoh
|version4= 1.00
 
|game5= arma3
|version5= 0.50


|gr1= Strings
|gr1= Strings
Line 15: Line 26:
|p1= format: [[String]] - a string containing text and/or references to the variables listed below in the array. The references appear in the form of %1, %2 etc.
|p1= format: [[String]] - a string containing text and/or references to the variables listed below in the array. The references appear in the form of %1, %2 etc.


|p2= argument: [[Anything]] - use [[Structured Text]] where necessary (see [[#Example|Example 2]])
|p2= argumentN: [[Anything]] - use [[Structured Text]] where necessary (see [[#Example|Example 2]])


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


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


|seealso= [[Structured Text]], [[format]], [[composeText]], [[text]], [[parseText]]
|seealso= [[Structured Text]] [[format]] [[composeText]] [[text]] [[parseText]]
}}
}}
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
{{GameCategory|arma2|Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}
{{GameCategory|tkoh|Scripting Commands}}

Latest revision as of 04:21, 27 November 2023

Logo 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 similar to format command.
Groups:
StringsStructured Text

Syntax

Syntax:
formatText [format, argument1, argument2, ...]
Parameters:
format: String - a string containing text and/or references to the variables listed below in the array. The references appear in the form of %1, %2 etc.
argumentN: Anything - use Structured Text where necessary (see Example 2)
Return Value:
Structured Text

Examples

Example 1:
hint formatText ["Image: %1", image "\a3\Data_f\Flags\flag_Altis_co.paa"];
Example 2:
hint formatText ["%1%2%3", "line1", "<br/>", "line2"]; // result displayed in one line hint formatText ["%1%2%3", "line1", lineBreak, "line2"]; // result displayed in two lines

Additional Information

See also:
Structured Text format composeText text parseText

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=formatText&oldid=351276"