diff options
| author | Rémi Verschelde <rverschelde@gmail.com> | 2019-04-15 18:09:02 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-04-15 18:09:02 +0200 |
| commit | 96123035da59f2d317c763abd4da8273fd6f5074 (patch) | |
| tree | 3e7fb628d7165570b61b85c48adae55eb48efa9b | |
| parent | 09e94aa087485ccf5b4318c4a619db4f6b067cc5 (diff) | |
| parent | 3fc1f7dfbeb038ca7db8da637b67282c800b492e (diff) | |
Merge pull request #28056 from akien-mga/doc-visibilitynotifier-ready
doc: Add note about VisibilityNotifier.is_on_screen after instantiation
| -rw-r--r-- | doc/classes/VisibilityNotifier.xml | 1 | ||||
| -rw-r--r-- | doc/classes/VisibilityNotifier2D.xml | 1 |
2 files changed, 2 insertions, 0 deletions
diff --git a/doc/classes/VisibilityNotifier.xml b/doc/classes/VisibilityNotifier.xml index e30078d82f..062371ba29 100644 --- a/doc/classes/VisibilityNotifier.xml +++ b/doc/classes/VisibilityNotifier.xml @@ -16,6 +16,7 @@ </return> <description> 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> </method> </methods> diff --git a/doc/classes/VisibilityNotifier2D.xml b/doc/classes/VisibilityNotifier2D.xml index 5689ced4bf..7b553c7518 100644 --- a/doc/classes/VisibilityNotifier2D.xml +++ b/doc/classes/VisibilityNotifier2D.xml @@ -16,6 +16,7 @@ </return> <description> 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> </method> </methods> |