BIS fnc filterString: Difference between revisions

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


| Removes characters from a string based on the list of allowed characters. |= Description
| Removes characters from a string based on the list of allowed characters. |DESCRIPTION=
____________________________________________________________________________________________
____________________________________________________________________________________________


| [ text, filter ] call BIS_fnc_filterString; |= Syntax
| [ text, filter ] call BIS_fnc_filterString; |SYNTAX=


|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= '''filter''' (Optional): [[String]] - Filter of allowed characters (default: A-Z, a-z, 0-9 and "_") |=


| [[String]] - Filtered text with only the allowed characters supplied in the filter. |= Return value
| [[String]] - Filtered text with only the allowed characters supplied in the filter. |RETURNVALUE=
____________________________________________________________________________________________
____________________________________________________________________________________________


Line 24: Line 24:
____________________________________________________________________________________________
____________________________________________________________________________________________


|[[find]], [[BIS_fnc_inString]], [[splitString]], [[joinString]] |= See also
|[[find]], [[BIS_fnc_inString]], [[splitString]], [[joinString]] |SEEALSO=


}}
}}

Revision as of 12:28, 7 April 2019


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