text: 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 - "\|x([0-9]) *= * <code>([^<]*)<\/code>" to "|x$1= <sqf>$2</sqf>")
 
(33 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command


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


|1.00|Game version=
|game2= arma2
|version2= 1.00


|gr1= Locations |GROUP1=
|game3= arma2oa
|version3= 1.50


|gr2= Strings |GROUP2=
|game4= tkoh
|version4= 1.00


|gr3= Structured Text |GROUP3=
|game5= arma3
|version5= 0.50


| 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=
|gr1= Locations


|'''text''' string |SYNTAX=
|gr2= Strings


|p1= string: [[String]] |PARAMETER1=
|gr3= Structured Text


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


|s2= '''text''' location |SYNTAX2=
|s1= [[text]] string


|p21= location: [[Location]] |PARAMETER21=
|p1= string: [[String]]


|r2= [[String]] |RETURNVALUE2=
|r1= [[Structured Text]]
 
|x1= <code>_stxt2 = [[text]] "Hello world.";</code> |EXAMPLE1=


|x2= <code>_townName = [[text]] myTownLocation;</code> |EXAMPLE2=
|s2= [[text]] location


|x3= <code>_loc = [[text]] [[nearestLocation]] [<nowiki/>[[position]] [[player]], "NameMarine"]; //"Marina Bay"</code> |EXAMPLE3=
|p21= location: [[Location]]


|r2= [[String]]


| [[parseText]], [[composeText]], [[image]], [[lineBreak]], [[setText]], [[createLocation]], [[deleteLocation]], [[drawLocation]], [[locationPosition]], [[locationNull]], [[nearestLocation]], [[nearestLocations]], [[nearestLocationWithDubbing]], [[name]] |SEEALSO=
|x1= <sqf>_stxt2 = text "Hello world.";</sqf>
 
|x2= <sqf>_townName = text myTownLocation;</sqf>
 
|x3= <sqf>_loc = text nearestLocation [position player, "NameMarine"]; //"Marina Bay"</sqf>
 
|seealso= [[parseText]] [[composeText]] [[image]] [[lineBreak]] [[setText]] [[createLocation]] [[deleteLocation]] [[drawLocation]] [[locationPosition]] [[locationNull]] [[nearestLocation]] [[nearestLocations]] [[nearestLocationWithDubbing]] [[name]]
}}
}}
<h3 style="display:none">Bottom Section</h3>
{{GameCategory|arma2|Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}
{{GameCategory|tkoh|Scripting Commands}}

Latest revision as of 10:38, 13 May 2022

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 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:
LocationsStringsStructured Text

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:
parseText composeText image lineBreak setText createLocation deleteLocation drawLocation locationPosition locationNull nearestLocation nearestLocations nearestLocationWithDubbing name

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=text&oldid=320624"