diff options
author | kobewi <kobewi4e@gmail.com> | 2020-12-27 21:51:54 +0100 |
---|---|---|
committer | kobewi <kobewi4e@gmail.com> | 2020-12-27 21:51:54 +0100 |
commit | 86aa9b1233e37844bfd357709f1ff4c0c3a3222a (patch) | |
tree | 00cbcd3e2b9659ed8d504477c4863b65aac49319 | |
parent | 2f7980c0fe9b0845b6b891062cd0d429a10e4730 (diff) |
Mention that change_scene is deferred
-rw-r--r-- | doc/classes/SceneTree.xml | 2 |
1 files changed, 2 insertions, 0 deletions
diff --git a/doc/classes/SceneTree.xml b/doc/classes/SceneTree.xml index a95ce6c663..5fc1d0b895 100644 --- a/doc/classes/SceneTree.xml +++ b/doc/classes/SceneTree.xml @@ -45,6 +45,7 @@ <description> Changes the running scene to the one at the given [code]path[/code], after loading it into a [PackedScene] and creating a new instance. Returns [constant OK] on success, [constant ERR_CANT_OPEN] if the [code]path[/code] cannot be loaded into a [PackedScene], or [constant ERR_CANT_CREATE] if that scene cannot be instantiated. + [b]Note:[/b] The scene change is deferred, which means that the new scene node is added on the next idle frame. You won't be able to access it immediately after the [method change_scene] call. </description> </method> <method name="change_scene_to"> @@ -55,6 +56,7 @@ <description> Changes the running scene to a new instance of the given [PackedScene]. Returns [constant OK] on success or [constant ERR_CANT_CREATE] if the scene cannot be instantiated. + [b]Note:[/b] The scene change is deferred, which means that the new scene node is added on the next idle frame. You won't be able to access it immediately after the [method change_scene_to] call. </description> </method> <method name="create_timer"> |