diff options
| author | Ryan Roden-Corrent <ryan@rcorre.net> | 2021-12-03 19:07:01 -0500 |
|---|---|---|
| committer | Ryan Roden-Corrent <ryan@rcorre.net> | 2021-12-12 07:55:01 -0500 |
| commit | 9d04086451545fb744fbfce8639e8e66327a65c0 (patch) | |
| tree | dc4321f33217b18cf904672ba40f6966093c4eb4 /doc/classes/ScrollContainer.xml | |
| parent | b8914ab8b6c678c80a972d57cee162076f3c5e03 (diff) | |
| download | redot-engine-9d04086451545fb744fbfce8639e8e66327a65c0.tar.gz | |
Document how to autoscroll ScrollContainer.
It is not uncommon to want to scroll to the most recently added child of
a ScrollContainer (e.g. a chat box or activity log). This is a little
tricky, since `ensure_control_visible` will not work on a node on the
same frame as you add it. Let's at least document that you need to wait
until the next frame.
Relates to https://github.com/godotengine/godot-proposals/issues/3629.
Co-authored-by: Yuri Sizov <pycbouh@users.noreply.github.com>
Diffstat (limited to 'doc/classes/ScrollContainer.xml')
| -rw-r--r-- | doc/classes/ScrollContainer.xml | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/doc/classes/ScrollContainer.xml b/doc/classes/ScrollContainer.xml index 976c32c243..711e028a67 100644 --- a/doc/classes/ScrollContainer.xml +++ b/doc/classes/ScrollContainer.xml @@ -16,6 +16,12 @@ <argument index="0" name="control" type="Control" /> <description> Ensures the given [code]control[/code] is visible (must be a direct or indirect child of the ScrollContainer). Used by [member follow_focus]. + [b]Note:[/b] This will not work on a node that was just added during the same frame. If you want to scroll to a newly added child, you must wait until the next frame using [signal SceneTree.process_frame]: + [codeblock] + add_child(child_node) + await get_tree().process_frame + ensure_control_visible(child_node) + [/codeblock] </description> </method> <method name="get_h_scrollbar"> |