BIS fnc filterString: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Fix cc template usage)
m (Text replacement - "_{10,} " to "")
Line 1: Line 1:
{{Function|Comments=
{{Function|Comments=
____________________________________________________________________________________________


| arma3 |Game name=
| arma3 |Game name=
Line 7: Line 6:


|gr1 = Strings |GROUP1=
|gr1 = Strings |GROUP1=
____________________________________________________________________________________________


| 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=
Line 19: Line 16:


| [[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=
____________________________________________________________________________________________


|x1= <code><nowiki>[</nowiki>"Player 1 @%!@$"] [[call]] [[BIS_fnc_filterString]]; {{cc|returns "Player1"}}</code> |EXAMPLE1=
|x1= <code><nowiki>[</nowiki>"Player 1 @%!@$"] [[call]] [[BIS_fnc_filterString]]; {{cc|returns "Player1"}}</code> |EXAMPLE1=


|x2= <code><nowiki>[</nowiki>"Player 1", "Player"] [[call]] [[BIS_fnc_filterString]]; {{cc|returns "Player"}}</code> |EXAMPLE2=
|x2= <code><nowiki>[</nowiki>"Player 1", "Player"] [[call]] [[BIS_fnc_filterString]]; {{cc|returns "Player"}}</code> |EXAMPLE2=
____________________________________________________________________________________________


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

Revision as of 00:08, 17 January 2021

Hover & click on the images for description

Description

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

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