BIS fnc filterString: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " {{Function|Comments=" to "{{Function|Comments=")
mNo edit summary
Line 14: Line 14:
|p1= '''text:''': [[String]] - Text to filter. |Parameter1=
|p1= '''text:''': [[String]] - Text to filter. |Parameter1=


|p2= '''filter''' (Optional): [[String]] - Filter of allowed characters (default: A-Z, a-z, 0-9 and "_") |=
|p2= '''filter''' (Optional): [[String]] - Filter of allowed characters (default: A-Z, a-z, 0-9 and "_") |PARAMETER2=


| [[String]] - Filtered text with only the allowed characters supplied in the filter. |RETURNVALUE=
| [[String]] - Filtered text with only the allowed characters supplied in the filter. |RETURNVALUE=
Line 21: Line 21:
|x1= <code><nowiki>[</nowiki>"Player 1 @%!@$"] call BIS_fnc_filterString;</code> Returns "Player1" |Example1=
|x1= <code><nowiki>[</nowiki>"Player 1 @%!@$"] call BIS_fnc_filterString;</code> Returns "Player1" |Example1=


|x2= <code><nowiki>[</nowiki>"Player 1", "Player"] call BIS_fnc_filterString;</code> Returns "Player" |=
|x2= <code><nowiki>[</nowiki>"Player 1", "Player"] call BIS_fnc_filterString;</code> Returns "Player" |EXAMPLE2=
____________________________________________________________________________________________
____________________________________________________________________________________________



Revision as of 09:20, 25 September 2020

Hover & click on the images for description

Description

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

Syntax

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

Examples

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

Additional Information

See also:
findBIS_fnc_inStringsplitStringjoinString

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