BIS fnc filterString: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (1 revision)
No edit summary
Line 8: Line 8:
____________________________________________________________________________________________
____________________________________________________________________________________________


| <pre>/*
| Removes characters from a string based on the list of allowed characters. |= Description
____________________________________________________________________________________________


Description:
| [ text, filter ] call BIS_fnc_filterString; |= Syntax
Removes characters from a string based on the list of allowed characters.


Parameter(s):
|p1= '''text:''': [[String]] - String to filter text from. |=
_this select 0: STRING - Filtered text
|p2= '''filter''' (Optional): [[String]] - Filter of allowed characters (default: A-Z, a-z, 0-9 and "_") |=
_this select 1 (Optional): STRING - Filter (default: A-Z, a-z, 0-9 and "_")


Returns:
| [[String]] - Filtered text with only the allowed characters supplied in the filter. |= Return value
STRING
*/
 
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
____________________________________________________________________________________________
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_filterString]]; --> |= Syntax
|x1= <code><nowiki>[</nowiki>"Player 1 @%!@$"] call BIS_fnc_filterString;</code> Returns "Player1" |=
 
|p1= |= Parameter 1
 
| |= Return value
____________________________________________________________________________________________


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



Revision as of 06:07, 19 January 2015


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 - String to filter text from.
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:
See also needed

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