hertog/godot-module-template
Template
2
1
Fork 1
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Document the in operator in String, Array and Dictionary classes

Browse source 
This also clarifies the `in` operator behavior in Object.
This commit is contained in:
Hugo Locurcio 2020-06-11 19:53:55 +02:00
parent cbcc0eacd5
commit 7f01f68226
No known key found for this signature in database
GPG key ID: 39E8F8BE30B0A49C
4 changed files with 26 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

14
doc/classes/String.xml
View file

@ -412,7 +412,13 @@
<argument index="1" name="from" type="int" default="0">
</argument>
<description>
Finds the first occurrence of a substring. Returns the starting position of the substring or -1 if not found. Optionally, the initial search index can be passed.
Finds the first occurrence of a substring. Returns the starting position of the substring or [code]-1[/code] if not found. Optionally, the initial search index can be passed.
[b]Note:[/b] If you just want to know whether a string contains a substring, use the [code]in[/code] operator as follows:
[codeblock]
# Will evaluate to `false`.
if "i" in "team":
pass
[/codeblock]
</description>
</method>
<method name="find_last">
@ -421,7 +427,7 @@
<argument index="0" name="what" type="String">
</argument>
<description>
Finds the last occurrence of a substring. Returns the starting position of the substring or -1 if not found.
Finds the last occurrence of a substring. Returns the starting position of the substring or [code]-1[/code] if not found.
</description>
</method>
<method name="findn">
@ -432,7 +438,7 @@
<argument index="1" name="from" type="int" default="0">
</argument>
<description>
Finds the first occurrence of a substring, ignoring case. Returns the starting position of the substring or -1 if not found. Optionally, the initial search index can be passed.
Finds the first occurrence of a substring, ignoring case. Returns the starting position of the substring or [code]-1[/code] if not found. Optionally, the initial search index can be passed.
</description>
</method>
<method name="format">
@ -947,7 +953,7 @@
<argument index="1" name="len" type="int" default="-1">
</argument>
<description>
Returns part of the string from the position [code]from[/code] with length [code]len[/code]. Argument [code]len[/code] is optional and using -1 will return remaining characters from given position.
Returns part of the string from the position [code]from[/code] with length [code]len[/code]. Argument [code]len[/code] is optional and using [code]-1[/code] will return remaining characters from given position.
</description>
</method>
<method name="to_ascii">