parseSimpleArray: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
(improved)
Line 8: Line 8:
____________________________________________________________________________________________
____________________________________________________________________________________________


| Converts given, formatted as simple array, [[String]] into a valid [[Array]]. Simple array is array consisting of [[Number]]s, [[String]]s, [[Boolean]]s and [[Array]]s of all of the above. For example: <tt>[1,"2",true,[4,"five",false]]</tt>. The string representation of this array compatible with [[parseSimpleArray]] will be <tt>"[1,""2"",true,[4,""five"",false]]"</tt> accordingly.
| Converts given, formatted as simple array, [[String]] into a valid [[Array]]. Simple array is array consisting of [[Number]]s, [[String]]s, [[Boolean]]s and [[Array]]s of all of the above. For example: <tt>[1,"2",true,[4,"five",false]]</tt>. The string representation of this array compatible with [[parseSimpleArray]] will be <tt>"[1,""2"",true,[4,""five"",false]]"</tt> accordingly. This command is almost '''4x faster''' than similar uncached [[call]] [[compile]] method. And because [[call]] [[compile]] is not required, it is also '''more secure''' and primarily intended for use with [[callExtension]] to parse the [[String]] output into [[Array]]. Since Arma 3 v.1.95 the command will tolerate extra spaces and supports single quotes. The only recognised keywords (case insensitive) are:
<br><br>
* <tt>true</tt> - translates into [[true]]
This command is built for speed and security and because of this has several limitations. There is limited error reporting about format errors as the command expects well formatted array as argument. To be able to see exact format expected, you can just copy output result of [[str]] command applied to an array for reference:  <tt>[[copyToClipboard]] [[str]] [[str]] [1,"2",true,[4,"five",false]]</tt> (notice the use of double [[str]] with [[copyToClipboard]]).
* <tt>false</tt> - translates into [[false]]
<br><br>
* <tt>nil</tt> - translates into [[nil]]
In any case here are the explicit rules:
* <tt>null</tt> - translates into [[nil]]
* no spaces are permitted between array elements: <tt>[1,2,3]</tt> - correct, <tt>[1, 2, 3]</tt> - incorrect!
|DESCRIPTION=
* only double quotes " supported for [[String]]s: <tt>["hello"]</tt> - correct, <tt>['hello']</tt> - incorrect!
* use " to escape ", for example <tt>["hello"]</tt> converted to string should look like this: <tt>"[""hello""]"</tt>
* no spaces should exist before or after array brackets: <tt>"[1,2,3]"</tt> - correct, <tt>"[1,2,3] "</tt> - incorrect!
To simplify, your constructed array format should be the same as Arma array converted to string with [[str]]:
<code>_arr1 <nowiki>=</nowiki> [[getUnitLoadout]] [[player]];
_arr2 <nowiki>=</nowiki> [[parseSimpleArray]] [[str]] _arr1;
[[hint]] [[str]] (_arr1 [[isEqualTo]] _arr2); //true
</code>
Because of this strictness the command is on average '''3x faster''' than similar [[call]] [[compile]] string array method. And because [[call]] [[compile]] is not required, it is also '''more secure''' and primarily intended for use with [[callExtension]] to parse the [[String]] output into [[Array]].  |DESCRIPTION=
____________________________________________________________________________________________
____________________________________________________________________________________________


Revision as of 18:36, 17 July 2019

Arma 3 logo black.png1.68
Hover & click on the images for description

Description

Description:
Converts given, formatted as simple array, String into a valid Array. Simple array is array consisting of Numbers, Strings, Booleans and Arrays of all of the above. For example: [1,"2",true,[4,"five",false]]. The string representation of this array compatible with parseSimpleArray will be "[1,""2"",true,[4,""five"",false]]" accordingly. This command is almost 4x faster than similar uncached call compile method. And because call compile is not required, it is also more secure and primarily intended for use with callExtension to parse the String output into Array. Since Arma 3 v.1.95 the command will tolerate extra spaces and supports single quotes. The only recognised keywords (case insensitive) are:
  • true - translates into true
  • false - translates into false
  • nil - translates into nil
  • null - translates into nil
Groups:
Uncategorised

Syntax

Syntax:
parseSimpleArray stringArray
Parameters:
stringArray: String - string formatted as simple array
Return Value:
Array - valid array

Examples

Example 1:
_arr = parseSimpleArray "[1,2,3]";
Example 2:
_bool = true; _num = 123.45; _str = "ok"; _arr = [1,false,"cool"]; _res = parseSimpleArray format ["[%1,%2,%3,%4]", _bool, _num, str _str, str _arr]; // Note how _bool and _num do not need str, however if used anyway, the result in this case would be identical hint str _res; // [true,123.45,"ok",[1,false,"cool"]]

Additional Information

See also:
setresizepushBackpushBackUniqueselectapplyreversecountfindinforEachdeleteAtdeleteRangeappendsortarrayIntersectcallExtension

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

Notes

Bottom Section


Retrieved from "https://community.bistudio.com/wiki?title=parseSimpleArray&oldid=125034"