str: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "|= Game version" to "|Game version=")
m (Some wiki formatting)
 
(68 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


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


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


| 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:
|game3= arma2oa
|version3= 1.50


<code>// Before the fix:
|game4= tkoh
[[hint]] [[str]] "string "" string"; // "string " string" <- invalid string
|version4= 1.00
[[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=
|game5= arma3
____________________________________________________________________________________________
|version5= 0.50


| '''str''' value |SYNTAX=
|gr1= Strings


|p1= value: [[Anything]] |PARAMETER1=
|descr= Converts any value into a string, depending on its type. If an [[Object]] has a [[vehicleVarName]], it is returned (see {{Link|#Example 4}}).


| [[String]] |RETURNVALUE=
|pr= Before {{GVI|arma3|1.64|size= 0.75}} this command did not escape a [[String]]'s double quotes {{hl|""}} properly.
____________________________________________________________________________________________
 
|x1= <code>_s = [[str]] (2 + 3);</code>


The value of ''_s'' is the string "5" |EXAMPLE1=
|s1= [[str]] value


|x2= <code>a = [];
|p1= value: [[Anything]]
 
|r1= [[String]] - if ''value'' is a [[String]], double quotes {{hl|""}} will surround it (see {{Link|#Example 3}})
 
|x1= <sqf>_s = str (5 + 2); // The value of _s is the string "7"</sqf>
 
|x2= <sqf>
a = [];
ac = 0;
ac = 0;
[[while]] {ac < 5} [[do]] {
while { ac < 5 } do
ac = [[count]] a;
{
a [[set]] [ac, [[format]] ["Index %1", ac]];
ac = count a;
a set [ac, format ["Index %1", ac]];
};
};
[[hintSilent]] [[str]] a;</code>
hintSilent str a; // hints all of ["Index 0","Index 1","Index 2","Index 3","Index 4"] including brackets, quotes and commas
</sqf>
 
|x3= <sqf>
str [0, 0, 0] == "[0, 0, 0]"; // false
str [0, 0, 0] == "[0,0,0]"; // true


Hints all of ''["Index 0","Index 1","Index 2","Index 3","Index 4"]'' including brackets, quotes and commas. |EXAMPLE1=
str "a"; // """a"""
____________________________________________________________________________________________
count str "a"; // 3
str text "a"; // "a"
count str text "a"; // 1
</sqf>


| [[toArray]], [[toString]], [[isText]], [[select]], [[count]], [[find]], [[endl]], [[format]], [[formatText]] |SEEALSO=
|x4= <sqf>
str objNull; // "<NULL-object>"
str player; // e.g "B Alpha 1-1:1 (PlayerName)"
player setVehicleVarName "PlayerUnit";
str player; // "PlayerUnit"
</sqf>


|seealso= [[toArray]] [[toString]] [[isText]] [[select]] [[count]] [[find]] [[endl]] [[format]] [[formatText]]
}}
}}
<h3 style="display:none">Bottom Section</h3>
[[Category:Scripting Commands|STR]]
[[Category:Scripting Commands ArmA|STR]]
[[Category:Command_Group:_Variables|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]


<!-- CONTINUE Notes -->
{{Note
<dl class="command_description">
|user= Sbsmac
<dd class="notedate">Posted on September 29, 2009 - 20:17 (UTC)</dd>
|timestamp= 20090929201700
<dt class="note">[[User:Sbsmac|Sbsmac]]</dt>
|text= When applied to a unit, this returns the variable name that was assigned to the unit in the editor (see also [[vehicleVarName]]).
<dd class="note">
For example, if you have created a playable unit with the name 'thePlayer' then you can use 'str player' to return "thePlayer".
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 -->

Latest revision as of 09:38, 3 October 2023

Hover & click on the images for description

Description

Description:
Converts any value into a string, depending on its type. If an Object has a vehicleVarName, it is returned (see Example 4).
Problems:
Before Arma 3 logo black.png1.64 this command did not escape a String's double quotes "" properly.
Groups:
Strings

Syntax

Syntax:
str value
Parameters:
value: Anything
Return Value:
String - if value is a String, double quotes "" will surround it (see Example 3)

Examples

Example 1:
_s = str (5 + 2); // The value of _s is the string "7"
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
Example 3:
str [0, 0, 0] == "[0, 0, 0]"; // false str [0, 0, 0] == "[0,0,0]"; // true str "a"; // """a""" count str "a"; // 3 str text "a"; // "a" count str text "a"; // 1
Example 4:
str objNull; // "<NULL-object>" str player; // e.g "B Alpha 1-1:1 (PlayerName)" player setVehicleVarName "PlayerUnit"; str player; // "PlayerUnit"

Additional Information

See also:
toArray toString isText select count find endl format formatText

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
Sbsmac - c
Posted on Sep 29, 2009 - 20:17 (UTC)
When applied to a unit, this returns the variable name that was assigned to the unit in the editor (see also vehicleVarName). For example, if you have created a playable unit with the name 'thePlayer' then you can use 'str player' to return "thePlayer".