BIS fnc filterString: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
m (Some wiki formatting)
 
(29 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{RV|type=function


{{Function|= Comments
|game1= arma3
____________________________________________________________________________________________
|version1= 1.00


| arma3 |= Game name
|gr1= Strings


|1.00|= Game version
|descr= Removes characters from a string based on the list of allowed characters.
____________________________________________________________________________________________


| Removes characters from a string based on the list of allowed characters. |DESCRIPTION=
|s1= [text, allowedChars] call [[BIS_fnc_filterString]]
____________________________________________________________________________________________


| [ text, filter ] call BIS_fnc_filterString; |SYNTAX=
|p1= '''text:''': [[String]] - text to filter


|p1= '''text:''': [[String]] - Text to filter. |=
|p2= '''allowedChars''': [[String]] - (Optional, default a..z, A..Z, 0..9, "_") allowed characters
|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=
|r1= [[String]] - filtered text with only the allowed characters supplied in the filter.
____________________________________________________________________________________________


|x1= <code><nowiki>[</nowiki>"Player 1 @%!@$"] call BIS_fnc_filterString;</code> Returns "Player1" |=
|x1= <sqf>["Player 1 @%!@$"] call BIS_fnc_filterString; // returns "Player1"</sqf>


|x2= <code><nowiki>[</nowiki>"Player 1", "Player"] call BIS_fnc_filterString;</code> Returns "Player" |=
|x2= <sqf>["Player 1", "aelrPy"] call BIS_fnc_filterString; // returns "Player"</sqf>
____________________________________________________________________________________________
 
|[[find]], [[BIS_fnc_inString]], [[splitString]], [[joinString]] |SEEALSO=


|seealso= [[find]] [[BIS_fnc_inString]] [[splitString]] [[joinString]]
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Function Group: Strings|{{uc:filterString}}]]
[[Category:Functions|{{uc:filterString}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:filterString}}]]

Latest revision as of 17:22, 13 July 2022

Arma 3 logo black.png1.00
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, allowedChars] call BIS_fnc_filterString
Parameters:
text:: String - text to filter
allowedChars: String - (Optional, default a..z, A..Z, 0..9, "_") allowed characters
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", "aelrPy"] call BIS_fnc_filterString; // returns "Player"

Additional Information

See also:
find BIS_fnc_inString splitString joinString

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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_filterString&oldid=327982"