str: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(description)
m (template:command argument fix)
(17 intermediate revisions by 4 users not shown)
Line 7: Line 7:
____________________________________________________________________________________________
____________________________________________________________________________________________


| Converts any variable to a string by placing " and " around the argument. This command will not parse any escaped " withing the string. In order to preserve "", use single quotes:
| 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:
<code>[[str]] "string "" string"; //"string " string" <- not a valid string
 
[[str]] 'string "" string'; //"string "" string" <- a valid string</code> |= Description
<code>// 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
</code>
 
When used on object, object debug name is returned. |DESCRIPTION=
____________________________________________________________________________________________
____________________________________________________________________________________________


| [[String]] <nowiki>=</nowiki> '''str''' value |= Syntax
| '''str''' value |SYNTAX=


|p1= value: [[Anything]] |= Parameter 1
|p1= value: [[Anything]] |PARAMETER1=


| [[String]] |= Return value
| [[String]] |RETURNVALUE=
____________________________________________________________________________________________
____________________________________________________________________________________________
   
   
|x1= <code>_s = [[str]] (2 + 3);</code>
|x1= <code>_s = [[str]] (2 + 3);</code>


The value of ''_s'' is the string "5" |= Example 1
The value of ''_s'' is the string "5" |EXAMPLE1=


|x2= <code>a = [];
|x2= <code>a = [];
Line 31: Line 39:
[[hintSilent]] [[str]] a;</code>
[[hintSilent]] [[str]] a;</code>


Hints all of ''["Index 0","Index 1","Index 2","Index 3","Index 4"]'' including brackets, quotes and commas. |= Example 1
Hints all of ''["Index 0","Index 1","Index 2","Index 3","Index 4"]'' including brackets, quotes and commas. |EXAMPLE1=
____________________________________________________________________________________________
____________________________________________________________________________________________


| |= See also
| [[toArray]], [[toString]], [[isText]], [[select]], [[count]], [[find]], [[endl]], [[format]], [[formatText]] |SEEALSO=


}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
* 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" ; [[User:Sbsmac|Sbsmac]]
* When applied to a string, places quotes around it. If it also contains quotes, be careful in how you use it; e.g. including it as part of a string and then compiling it as code won't work. [[User:MaHuJa|MaHuJa]] 06:58, 26 April 2012 (CEST)
<!-- Note Section END -->
</dl>
<h3 style="display:none">Bottom Section</h3>
<h3 style="display:none">Bottom Section</h3>
[[Category:Scripting Commands|STR]]
[[Category:Scripting Commands|STR]]
Line 54: Line 52:
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
<!-- CONTINUE Notes -->
<dl class="command_description">
<dd class="notedate">Posted on September 29, 2009 - 20:17 (UTC)</dd>
<dt class="note">[[User:Sbsmac|Sbsmac]]</dt>
<dd class="note">
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";
</dd>
</dl>
<dl class="command_description">
<dd class="notedate">Posted on December 5, 2014 - 20:21 (UTC)</dd>
<dt class="note">[[User:DreadedEntity|DreadedEntity]]</dt>
<dd class="note">
If you try to [[count]] string, the added quotations marks are valid characters and will be counted.
</dd>
</dl>
<!-- DISCONTINUE Notes -->
<!-- CONTINUE Notes -->
<dl class="command_description">
<dd class="notedate">Posted on July 15, 2017 - 09:59 (UTC)</dd>
<dt class="note">[[User:Killzone Kid|Killzone Kid]]</dt>
<dd class="note">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]]:
<code>[[str]] ""; // ""
[[count]] [[str]] ""; // 2
[[str]] [[text]] ""; //
[[count]] [[str]] [[text]] ""; // 0</code>
</dd>
</dl>
<!-- DISCONTINUE Notes -->

Revision as of 15:49, 7 April 2019

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

Description

Description:
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: // 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 When used on object, object debug name is returned.
Groups:
Uncategorised

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

Bottom Section

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
Retrieved from "https://community.bistudio.com/wiki?title=str&oldid=122830"