godotengine/godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #40540 from TheDuriel/patch-2

Browse Source 
Clarify TreeItem return values
This commit is contained in:
Rémi Verschelde 2020-07-31 13:04:13 +02:00 committed by GitHub
commit 932a719f6e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
doc/classes/TreeItem.xml
View File

@ -118,7 +118,7 @@
<return type="TreeItem">
</return>
<description>
Returns the TreeItem's child items.
Returns the TreeItem's first child item or a null object if there is none.
</description>
</method>
<method name="get_custom_bg_color" qualifiers="const">
@ -196,7 +196,7 @@
<return type="TreeItem">
</return>
<description>
Returns the next TreeItem in the tree.
Returns the next TreeItem in the tree or a null object if there is none.
</description>
</method>
<method name="get_next_visible">
@ -205,7 +205,7 @@
<argument index="0" name="wrap" type="bool" default="false">
</argument>
<description>
Returns the next visible TreeItem in the tree.
Returns the next visible TreeItem in the tree or a null object if there is none.
If [code]wrap[/code] is enabled, the method will wrap around to the first visible element in the tree when called on the last visible element, otherwise it returns [code]null[/code].
</description>
</method>
@ -213,14 +213,14 @@
<return type="TreeItem">
</return>
<description>
Returns the parent TreeItem.
Returns the parent TreeItem or a null object if there is none.
</description>
</method>
<method name="get_prev">
<return type="TreeItem">
</return>
<description>
Returns the previous TreeItem in the tree.
Returns the previous TreeItem in the tree or a null object if there is none.
</description>
</method>
<method name="get_prev_visible">
@ -229,7 +229,7 @@
<argument index="0" name="wrap" type="bool" default="false">
</argument>
<description>
Returns the previous visible TreeItem in the tree.
Returns the previous visible TreeItem in the tree or a null object if there is none.
If [code]wrap[/code] is enabled, the method will wrap around to the last visible element in the tree when called on the first visible element, otherwise it returns [code]null[/code].
</description>
</method>