summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorRĂ©mi Verschelde <rverschelde@gmail.com>2019-04-12 12:29:36 +0200
committerGitHub <noreply@github.com>2019-04-12 12:29:36 +0200
commit6008745991fb5191945e936f38cda21f751b7ff6 (patch)
treea3245f20bfcc359ce8a28f529d5c2e836ede4926 /doc
parente7a1fbe83aab61c62b1fc2e18e37b03a1d1f126a (diff)
parent70499faff80b7213d7344db6128a8dc51634613f (diff)
Merge pull request #27949 from YeldhamDev/doc_is_valid_filename
Document String's 'is_valid_filename()'
Diffstat (limited to 'doc')
-rw-r--r--doc/classes/String.xml8
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/classes/String.xml b/doc/classes/String.xml
index c3c4b6f938..0cfa246275 100644
--- a/doc/classes/String.xml
+++ b/doc/classes/String.xml
@@ -432,6 +432,14 @@
Returns [code]true[/code] if this string is a subsequence of the given string, without considering case.
</description>
</method>
+ <method name="is_valid_filename">
+ <return type="bool">
+ </return>
+ <description>
+ Returns [code]true[/code] if this string is free from characters that aren't allowed in file names, those being:
+ [code]: / \ ? * " | % < >[/code]
+ </description>
+ </method>
<method name="is_valid_float">
<return type="bool">
</return>