str: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\| *((\[\[[a-zA-Z0-9_ |()]+\]\],? ?)+) * \}\}" to "|seealso= $1 }}")
(formatting to improve ledgibility)
Line 1: Line 1:
{{RV|type=command
{{RV|type=command


| arma1
|game1= arma1


|1.00
|version1= 1.00


|gr1= Strings
|gr1= Strings


| Converts any value into a string by placing " and " around the argument. Since Arma 3 v1.63.137891 this command will correctly escape all " inside a string:
|descr= Converts any value into a string by placing " and " around the argument. When used on object, object debug name is returned.<br><br>Since Arma 3 v1.63.137891 this command will correctly escape all " inside a string:


<code>// Before the fix:
<code>{{cc|Before the fix:}}
[[hint]] [[str]] "string "" string"; // "string " string" <- invalid string
[[hint]] [[str]] "string "" string"; {{cc|"string " string" <- invalid string}}
[[call]] [[compile]] [[str]] "string "" string"; // ERROR
[[call]] [[compile]] [[str]] "string "" string"; {{cc|ERROR}}</code>
// After the fix:
 
[[hint]] [[str]] "string "" string"; // "string "" string" <- valid string
<code>{{cc|After the fix:}}
[[call]] [[compile]] [[str]] "string "" string"; // OK
[[hint]] [[str]] "string "" string"; {{cc|"string "" string" <- valid string}}
[[call]] [[compile]] [[str]] "string "" string"; {{cc|OK}}
</code>
</code>


When used on object, object debug name is returned.
|s1= '''str''' value
 
| '''str''' value


|p1= value: [[Anything]]
|p1= value: [[Anything]]


| [[String]]
|r1= [[String]]
   
   
|x1= <code>_s = [[str]] (2 + 3);</code>
|x1= <code>_s = [[str]] (2 + 3);{{cc|The value of ''_s'' is the string "5"}}</code>
 
The value of ''_s'' is the string "5"


|x2= <code>a = [];
|x2= <code>a = [];
ac = 0;
ac = 0;
[[while]] {ac < 5} [[do]] {
[[while]] {ac < 5} [[do]]
{
ac = [[count]] a;
ac = [[count]] a;
a [[set]] [ac, [[format]] ["Index %1", ac]];
a [[set]] [ac, [[format]] ["Index %1", ac]];
};
};
[[hintSilent]] [[str]] a;</code>
[[hintSilent]] [[str]] a;{{cc|Hints all of ''["Index 0","Index 1","Index 2","Index 3","Index 4"]'' including brackets, quotes and commas}}</code>
 
Hints all of ''["Index 0","Index 1","Index 2","Index 3","Index 4"]'' including brackets, quotes and commas.


|seealso= [[toArray]], [[toString]], [[isText]], [[select]], [[count]], [[find]], [[endl]], [[format]], [[formatText]]
|seealso= [[toArray]], [[toString]], [[isText]], [[select]], [[count]], [[find]], [[endl]], [[format]], [[formatText]]
}}
}}
{{GameCategory|arma1|Scripting Commands}}


{{GameCategory|arma2|Scripting Commands}}
{{GameCategory|arma2|Scripting Commands}}
Line 73: Line 67:
</dl>
</dl>
<!-- DISCONTINUE Notes -->
<!-- DISCONTINUE Notes -->


<dl class="command_description">
<dl class="command_description">

Revision as of 01:16, 17 February 2021

Hover & click on the images for description

Description

Description:
Converts any value into a string by placing " and " around the argument. When used on object, object debug name is returned.

Since Arma 3 v1.63.137891 this command will correctly escape all " inside a string: // Before the fix: hint str "string "" string"; // "string " string" <- invalid string call compile str "string "" string"; // ERROR // After the fix: hint str "string "" string"; // "string "" string" <- valid string call compile str "string "" string"; // OK
Groups:
Strings

Syntax

Syntax:
str value
Parameters:
value: Anything
Return Value:
String

Examples

Example 1:
_s = str (2 + 3);// The value of _s is the string "5"
Example 2:
a = []; ac = 0; while {ac < 5} do { ac = count a; a set [ac, format ["Index %1", ac]]; }; hintSilent str a;// Hints all of ["Index 0","Index 1","Index 2","Index 3","Index 4"] including brackets, quotes and commas

Additional Information

See also:
toArraytoStringisTextselectcountfindendlformatformatText

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
Posted on September 29, 2009 - 20:17 (UTC)
Sbsmac
When applied to a unit, this returns the variable name that was assigned to the unit in the editor. For example, if you have created a playable unit with the name 'thePlayer' then you can use 'str player' to return "thePlayer";
Posted on December 5, 2014 - 20:21 (UTC)
DreadedEntity
If you try to count string, the added quotations marks are valid characters and will be counted.
Posted on July 15, 2017 - 09:59 (UTC)
Killzone Kid
If you want to make empty string with str that doesn't have any quotation marks, but is still a String you can use text: str ""; // "" count str ""; // 2 str text ""; // count str text ""; // 0
Posted on February 16, 2021 - 20:59 (UTC)
R3vo
Be careful when using str on arrays and you are used to putting a whitespace behind every comma: str [0, 0, 0] == "[0, 0, 0]"; // false