BIS fnc filterString: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " <h3 style="display:none">Notes</h3> <dl class="command_description"> <!-- Note Section BEGIN --> <!-- Note Section END --> </dl>" to "")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments \("local" or "global"\)|Multiplayer Effects \("local" or "global"\)|Multiplayer Execution \("server" o...)
Line 1: Line 1:
{{Function|Comments=
{{Function


| arma3 |Game name=
| arma3


|1.00|Game version=
|1.00


|gr1 = Strings |GROUP1=
|gr1 = Strings


| 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.


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


|p1= '''text:''': [[String]] - Text to filter. |Parameter1=
|p1= '''text:''': [[String]] - Text to filter.


|p2= '''filter''' (Optional): [[String]] - Filter of allowed characters (default: A-Z, a-z, 0-9 and "_") |PARAMETER2=
|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. |RETURNVALUE=
| [[String]] - Filtered text with only the allowed characters supplied in the filter.


|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>


|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>


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




<h3 style="display:none">Bottom Section</h3>
<h3 style="display:none">Bottom Section</h3>

Revision as of 00:00, 18 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


Bottom Section