Attention: Here be dragons
This is the latest
(unstable) version of this documentation, which may document features
not available in or compatible with released stable versions of Godot.
Checking the stable version of the documentation...
ScrollContainer¶
Inherits: Container < Control < CanvasItem < Node < Object
Inherited By: EditorInspector
Un nodo de ayuda para mostrar elementos desplazables como listas.
Descripción¶
A ScrollContainer node meant to contain a Control child. ScrollContainers will automatically create a scrollbar child (HScrollBar, VScrollBar, or both) when needed and will only draw the Control within the ScrollContainer area. Scrollbars will automatically be drawn at the right (for vertical) or bottom (for horizontal) and will enable dragging to move the viewable Control (and its children) within the ScrollContainer. Scrollbars will also automatically resize the grabber based on the Control.rect_min_size of the Control relative to the ScrollContainer. Works great with a Panel control. You can set EXPAND
on the children's size flags, so they will upscale to the ScrollContainer's size if it's larger (scroll is invisible for the chosen dimension).
Propiedades¶
|
||
rect_clip_content |
|
|
|
||
|
||
|
||
|
||
|
Métodos¶
void |
ensure_control_visible ( Control control ) |
get_h_scrollbar ( ) |
|
get_v_scrollbar ( ) |
Propiedades del Theme¶
Señales¶
scroll_ended ( )
Emitido cuando el scroll se detiene.
scroll_started ( )
Emitido cuando se inicia el scrolling.
Descripciones de Propiedades¶
bool follow_focus
Default |
|
Setter |
set_follow_focus(value) |
Getter |
is_following_focus() |
Si true
, el ScrollContainer se desplazará automáticamente a los hijos enfocados (incluyendo los niños indirectos) para asegurarse de que son completamente visibles.
int scroll_deadzone
Default |
|
Setter |
set_deadzone(value) |
Getter |
get_deadzone() |
int scroll_horizontal
Default |
|
Setter |
set_h_scroll(value) |
Getter |
get_h_scroll() |
El valor actual de desplazamiento horizontal.
bool scroll_horizontal_enabled
Default |
|
Setter |
set_enable_h_scroll(value) |
Getter |
is_h_scroll_enabled() |
Si true
, permite el desplazamiento horizontal.
int scroll_vertical
Default |
|
Setter |
set_v_scroll(value) |
Getter |
get_v_scroll() |
El valor actual de scroll vertical.
bool scroll_vertical_enabled
Default |
|
Setter |
set_enable_v_scroll(value) |
Getter |
is_v_scroll_enabled() |
Si true
, permite el desplazamiento vertical.
Descripciones de Métodos¶
void ensure_control_visible ( Control control )
Ensures the given control
is visible (must be a direct or indirect child of the ScrollContainer). Used by follow_focus.
Note: 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 SceneTree.idle_frame:
add_child(child_node)
yield(get_tree(), "idle_frame")
ensure_control_visible(child_node)
HScrollBar get_h_scrollbar ( )
Returns the horizontal scrollbar HScrollBar of this ScrollContainer
.
Warning: This is a required internal node, removing and freeing it may cause a crash. If you wish to disable the horizontal scrollbar, use scroll_horizontal_enabled. If you want to only hide it instead, use its CanvasItem.visible property.
VScrollBar get_v_scrollbar ( )
Returns the vertical scrollbar VScrollBar of this ScrollContainer
.
Warning: This is a required internal node, removing and freeing it may cause a crash. If you wish to disable the vertical scrollbar, use scroll_vertical_enabled. If you want to only hide it instead, use its CanvasItem.visible property.
Theme Property Descriptions¶
StyleBox bg
El fondo StyleBox del ScrollContainer
.