summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorkobewi <kobewi4e@gmail.com>2023-04-06 14:47:49 +0200
committerRĂ©mi Verschelde <rverschelde@gmail.com>2023-05-12 12:31:22 +0200
commit1146172b302a68393e4f97b47e6460d78db75518 (patch)
tree6b2cfc2e2ac14f2e6aa177ea561c569630c11f73 /doc
parent2a8501e1a26b12dadd4f6fcbed799e319cd77027 (diff)
Prevent errors when using ViewportTexture
(cherry picked from commit 1b9802fa8cb45e876cd90d6a174b95b270a7f934)
Diffstat (limited to 'doc')
-rw-r--r--doc/classes/Node.xml7
-rw-r--r--doc/classes/ViewportTexture.xml2
2 files changed, 8 insertions, 1 deletions
diff --git a/doc/classes/Node.xml b/doc/classes/Node.xml
index 62d708618a..ead022ecb3 100644
--- a/doc/classes/Node.xml
+++ b/doc/classes/Node.xml
@@ -500,6 +500,13 @@
Returns [code]true[/code] if the local system is the multiplayer authority of this node.
</description>
</method>
+ <method name="is_node_ready" qualifiers="const">
+ <return type="bool" />
+ <description>
+ Returns [code]true[/code] if the node is ready, i.e. it's inside scene tree and all its children are initialized.
+ [method request_ready] resets it back to [code]false[/code].
+ </description>
+ </method>
<method name="is_physics_processing" qualifiers="const">
<return type="bool" />
<description>
diff --git a/doc/classes/ViewportTexture.xml b/doc/classes/ViewportTexture.xml
index 6bd64a50bb..8ecda45bd6 100644
--- a/doc/classes/ViewportTexture.xml
+++ b/doc/classes/ViewportTexture.xml
@@ -6,7 +6,7 @@
<description>
Displays the content of a [Viewport] node as a dynamic [Texture2D]. This can be used to mix controls, 2D, and 3D elements in the same scene.
To create a ViewportTexture in code, use the [method Viewport.get_texture] method on the target viewport.
- [b]Note:[/b] When local to scene, this texture uses [method Resource.setup_local_to_scene] to set the proxy texture and flags in the local viewport.
+ [b]Note:[/b] When local to scene, this texture uses [method Resource.setup_local_to_scene] to set the proxy texture and flags in the local viewport. Local to scene viewport textures will return incorrect data until the scene root is ready (see [signal Node.ready]).
</description>
<tutorials>
<link title="GUI in 3D Demo">https://godotengine.org/asset-library/asset/127</link>