str: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
m (Some wiki formatting)
 
(107 intermediate revisions by 15 users not shown)
Line 1: Line 1:
[[Category:Scripting Commands|STR]]
{{RV|type=command
[[Category:Scripting Commands ArmA|STR]]


|game1= arma1
|version1= 1.00


<h2 style="color:#000066">'''str ''any value'''''</h2>
|game2= arma2
|version2= 1.00


|game3= arma2oa
|version3= 1.50


'''Operand types:'''
|game4= tkoh
|version4= 1.00


'''any value''' [[Anything]]
|game5= arma3
|version5= 0.50


'''Type of returned value:'''
|gr1= Strings


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


'''Compatibility'''
|pr= Before {{GVI|arma3|1.64|size= 0.75}} this command did not escape a [[String]]'s double quotes {{hl|""}} properly.


Version 2.00 required.
|s1= [[str]] value


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


Converts any variable to a string.
|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>


'''Example:'''
|x2= <sqf>
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
</sqf>


'''str'''(2+3)  , result is "5"
|x3= <sqf>
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
</sqf>
 
|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]]
}}
 
{{Note
|user= Sbsmac
|timestamp= 20090929201700
|text= 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".
}}

Latest revision as of 10: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".