Difference between revisions of "text"

From Bohemia Interactive Community
Jump to navigation Jump to search
m
m (template:command argument fix)
(21 intermediate revisions by 8 users not shown)
Line 1: Line 1:
[[Category:Scripting Commands|TEXT]]
+
{{Command|= Comments
[[Category:Scripting Commands ArmA|TEXT]]
+
____________________________________________________________________________________________
  
 +
| arma |= Game name
  
 +
|1.00|= Game version
 +
____________________________________________________________________________________________
  
 +
| 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=
 +
____________________________________________________________________________________________
  
<h2 style="color:#000066">''''' text ''''' ''text''</h2>
+
|'''text''' string |SYNTAX=
  
 +
|p1= string: [[String]] |PARAMETER1=
  
'''Operand types:'''
+
| [[Structured Text]] |RETURNVALUE=
  
text: [[String]]
+
| s2= '''text''' location |SYNTAX=
  
'''Type of returned value:'''
+
|p21= location: [[Location]] |PARAMETER1=
  
Nothing
+
| r2= [[String]] |RETURNVALUE=
 +
____________________________________________________________________________________________
 +
 
 +
|x1= <code>_stxt2 = [[text]] "Hello world.";</code> |EXAMPLE1=
 +
|x2= <code>_townName = [[text]] myTownLocation;</code> |EXAMPLE2=
 +
|x3= <code>_loc = [[text]] [[nearestLocation]] <nowiki>[</nowiki>[[position]] [[player]], "NameMarine"]; //"Marina Bay"</code> |EXAMPLE3=
  
'''Compatibility:'''
+
____________________________________________________________________________________________
  
Version 2.01 required.
+
| [[parseText]], [[composeText]], [[image]], [[lineBreak]], [[setText]], [[createLocation]], [[deleteLocation]], [[drawLocation]], [[locationPosition]], [[locationNull]], [[nearestLocation]], [[nearestLocations]], [[nearestLocationWithDubbing]], [[name]] |SEEALSO=
  
'''Description:'''
+
}}
  
Creates a structured text containing the given plain text.
+
<h3 style="display:none">Notes</h3>
 +
<dl class="command_description">
 +
<!-- Note Section BEGIN -->
  
 +
<!-- Note Section END -->
 +
</dl>
  
'''Example:'''
+
<h3 style="display:none">Bottom Section</h3>
 
+
[[Category:Scripting Commands|TEXT]]
txt2 = '''text''' "Hello world."
+
[[Category:Scripting Commands ArmA|TEXT]]
 +
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
 +
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
 +
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
 +
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
 +
[[Category:Command_Group:_Locations|{{uc:{{PAGENAME}}}}]]

Revision as of 15:50, 7 April 2019

Introduced with Armed Assault version 1.00
  

Click on the images for descriptions

Introduced in

Game:
Armed Assault
Version:
1.00

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

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

Multiplayer:
-
See also:
parseTextcomposeTextimagelineBreaksetTextcreateLocationdeleteLocationdrawLocationlocationPositionlocationNullnearestLocationnearestLocationsnearestLocationWithDubbingname

Notes

Only post proven facts here. Report bugs on the feedback tracker. Use the talk page or the forums for discussions.
Add New Note | How To

Notes

Bottom Section