BIS fnc splitString: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Generated by BIS_fnc_exportFunctionsToWiki)
 
m (Some wiki formatting)
 
(27 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{RV|type=function


{{Function|= Comments
|game1= arma3
____________________________________________________________________________________________
|version1= 1.00


| arma3 |= Game name
|gr1= Strings


|1.00|= Game version
|descr= Splits given string according to given separator(s).
____________________________________________________________________________________________
{{Feature|arma3|See [[splitString]].}}


| <pre>/*
|s1= [stringToSplit, separators, byWord] call [[BIS_fnc_splitString]]


Description:
|p1= stringToSplit: [[String]]
Split spring according to given separators


Parameter(s):
|p2= separators: [[String]] - (Optional, default "") by default each letter is a separator. If ''byWord'' is set to [[true]], the separator will be treated as whole word
1: STRING - affected string
2: STRING - one or more separators


Returns:
|p3= byWord: [[Boolean]] - (Optional, default [[false]]) by default uses [[splitString]] behaviour e.g. each letter is a separator. If set to [[true]], the separator will be treated as whole word
ARRAY of STRINGs
*/
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_splitString]]; --> |= Syntax
|r1= [[Array]] of [[String]]s


|p1= |= Parameter 1
|x1= <sqf>["this is a test", " "] call BIS_fnc_splitString; // returns ["this", "is", "a", "test"]</sqf>


| |= Return value
|x2= <sqf>["this is a test", "st"] call BIS_fnc_splitString; // returns ["hi"," i"," a ","e"]</sqf>
____________________________________________________________________________________________


|x1= <code></code> |=
|x3= <sqf>["this is a test", "is"] call BIS_fnc_splitString; // returns ["th"," "," a te","t"]</sqf>
____________________________________________________________________________________________


| |= See also
|x4= <sqf>["this is a test", "is", true] call BIS_fnc_splitString; // returns ["th"," "," a test"]</sqf>


|seealso= [[splitString]] [[toArray]] [[toString]]
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Function Group: Strings|{{uc:splitString}}]]
[[Category:Functions|{{uc:splitString}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:splitString}}]]

Latest revision as of 18:01, 30 June 2022

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

Description

Description:
Splits given string according to given separator(s).
Arma 3
Execution:
call
Groups:
Strings

Syntax

Syntax:
[stringToSplit, separators, byWord] call BIS_fnc_splitString
Parameters:
stringToSplit: String
separators: String - (Optional, default "") by default each letter is a separator. If byWord is set to true, the separator will be treated as whole word
byWord: Boolean - (Optional, default false) by default uses splitString behaviour e.g. each letter is a separator. If set to true, the separator will be treated as whole word
Return Value:
Array of Strings

Examples

Example 1:
["this is a test", " "] call BIS_fnc_splitString; // returns ["this", "is", "a", "test"]
Example 2:
["this is a test", "st"] call BIS_fnc_splitString; // returns ["hi"," i"," a ","e"]
Example 3:
["this is a test", "is"] call BIS_fnc_splitString; // returns ["th"," "," a te","t"]
Example 4:
["this is a test", "is", true] call BIS_fnc_splitString; // returns ["th"," "," a test"]

Additional Information

See also:
splitString toArray toString

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