text: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
m (template:command argument fix)
Line 7: Line 7:
____________________________________________________________________________________________
____________________________________________________________________________________________


| Creates a structured text containing the given plain text if argument is [[String]]. Use [[setAttributes]] to set additional [[Structured_Text#Attributes | attributes]] on the text. If the argument is [[location]], returns location's text value (see Alt Syntax).  |= Description
| Creates a structured text containing the given plain text if argument is [[String]]. Use [[setAttributes]] to set additional [[Structured_Text#Attributes | attributes]] on the text. If the argument is [[location]], returns location's text value (see Alt Syntax).  |DESCRIPTION=
____________________________________________________________________________________________
____________________________________________________________________________________________


|'''text''' string |= Syntax
|'''text''' string |SYNTAX=


|p1= string: [[String]] |= Parameter 1
|p1= string: [[String]] |PARAMETER1=


| [[Structured Text]] |= Return value
| [[Structured Text]] |RETURNVALUE=


| s2= '''text''' location |= Syntax
| s2= '''text''' location |SYNTAX=


|p21= location: [[Location]] |= Parameter 1
|p21= location: [[Location]] |PARAMETER1=


| r2= [[String]] |= Return value
| r2= [[String]] |RETURNVALUE=
____________________________________________________________________________________________
____________________________________________________________________________________________
   
   
|x1= <code>_stxt2 = [[text]] "Hello world.";</code> |= Example 1
|x1= <code>_stxt2 = [[text]] "Hello world.";</code> |EXAMPLE1=
|x2= <code>_townName = [[text]] myTownLocation;</code> |= Example 2
|x2= <code>_townName = [[text]] myTownLocation;</code> |EXAMPLE2=
|x3= <code>_loc = [[text]] [[nearestLocation]] <nowiki>[</nowiki>[[position]] [[player]], "NameMarine"]; //"Marina Bay"</code> |= Example 3
|x3= <code>_loc = [[text]] [[nearestLocation]] <nowiki>[</nowiki>[[position]] [[player]], "NameMarine"]; //"Marina Bay"</code> |EXAMPLE3=


____________________________________________________________________________________________
____________________________________________________________________________________________


| [[parseText]], [[composeText]], [[image]], [[lineBreak]], [[setText]], [[createLocation]], [[deleteLocation]], [[drawLocation]], [[locationPosition]], [[locationNull]], [[nearestLocation]], [[nearestLocations]], [[nearestLocationWithDubbing]], [[name]] |= See also
| [[parseText]], [[composeText]], [[image]], [[lineBreak]], [[setText]], [[createLocation]], [[deleteLocation]], [[drawLocation]], [[locationPosition]], [[locationNull]], [[nearestLocation]], [[nearestLocations]], [[nearestLocationWithDubbing]], [[name]] |SEEALSO=


}}
}}

Revision as of 14:50, 7 April 2019

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

Description

Description:
Creates a structured text containing the given plain text if argument is String. Use setAttributes to set additional attributes on the text. If the argument is location, returns location's text value (see Alt Syntax).
Groups:
Uncategorised

Syntax

Syntax:
text string
Parameters:
string: String
Return Value:
Structured Text

Alternative Syntax

Syntax:
text location
Parameters:
location: Location
Return Value:
String

Examples

Example 1:
_stxt2 = text "Hello world.";
Example 2:
_townName = text myTownLocation;
Example 3:
_loc = text nearestLocation [position player, "NameMarine"]; //"Marina Bay"

Additional Information

See also:
parseTextcomposeTextimagelineBreaksetTextcreateLocationdeleteLocationdrawLocationlocationPositionlocationNullnearestLocationnearestLocationsnearestLocationWithDubbingname

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