BIS fnc filterString: Difference between revisions

Latest revision as of 17:22, 13 July 2022

Hover & click on the images for description

Description:: Removes characters from a string based on the list of allowed characters.
Execution:: call
Groups:: Strings

Syntax:: [text, allowedChars] call BIS_fnc_filterString
Parameters:: text:: String - text to filter
: allowedChars: String - (Optional, default a..z, A..Z, 0..9, "_") allowed characters
Return Value:: String - filtered text with only the allowed characters supplied in the filter.

Example 1:: ["Player 1 @%!@$"] call BIS_fnc_filterString; // returns "Player1"
Example 2:: ["Player 1", "aelrPy"] call BIS_fnc_filterString; // returns "Player"

: 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

@@ Line 8: / Line 8: @@
 |descr= Removes characters from a string based on the list of allowed characters.
-|s1= [ text, filter ] call [[BIS_fnc_filterString]]
+|s1= [text, allowedChars] call [[BIS_fnc_filterString]]
-|p1= '''text:''': [[String]] - Text to filter.
+|p1= '''text:''': [[String]] - text to filter
-|p2= '''filter''' (Optional): [[String]] - Filter of allowed characters (default: A-Z, a-z, 0-9 and "_")
+|p2= '''allowedChars''': [[String]] - (Optional, default a..z, A..Z, 0..9, "_") allowed characters
-|r1= [[String]] - Filtered text with only the allowed characters supplied in the filter.
+|r1= [[String]] - filtered text with only the allowed characters supplied in the filter.
-|x1= <code><nowiki>[</nowiki>"Player 1 @%!@$"] [[call]] [[BIS_fnc_filterString]]; // returns "Player1"</code>
+|x1= <sqf>["Player 1 @%!@$"] call BIS_fnc_filterString; // returns "Player1"</sqf>
-|x2= <code><nowiki>[</nowiki>"Player 1", "Player"] [[call]] [[BIS_fnc_filterString]]; // returns "Player"</code>
+|x2= <sqf>["Player 1", "aelrPy"] call BIS_fnc_filterString; // returns "Player"</sqf>
 |seealso= [[find]] [[BIS_fnc_inString]] [[splitString]] [[joinString]]
 }}