doc: Add note about VisibilityNotifier.is_on_screen after instantiation

Fixes #9430.

(cherry picked from commit 3fc1f7dfbe)
This commit is contained in:
Rémi Verschelde 2019-04-15 17:10:33 +02:00
parent 64a7a6b2f4
commit 67a72a2759
2 changed files with 4 additions and 2 deletions

View File

@ -15,7 +15,8 @@
<return type="bool"> <return type="bool">
</return> </return>
<description> <description>
If [code]true[/code] the bounding box is on the screen. If [code]true[/code], the bounding box is on the screen.
Note: It takes one frame for the node's visibility to be assessed once added to the scene tree, so this method will return [code]false[/code] right after it is instantiated, even if it will be on screen in the draw pass.
</description> </description>
</method> </method>
</methods> </methods>

View File

@ -15,7 +15,8 @@
<return type="bool"> <return type="bool">
</return> </return>
<description> <description>
If [code]true[/code] the bounding rectangle is on the screen. If [code]true[/code], the bounding rectangle is on the screen.
Note: It takes one frame for the node's visibility to be assessed once added to the scene tree, so this method will return [code]false[/code] right after it is instantiated, even if it will be on screen in the draw pass.
</description> </description>
</method> </method>
</methods> </methods>