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

Успадковує: Container < Control < CanvasItem < Node < Object

Успадковано від: EditorInspector

Контейнер, який використовується для забезпечення прокруток дитини при необхідності.

Опис

Контейнер, який використовується для забезпечення контролю дитини з прокрутками при необхідності. Скролборди автоматично будуть намальовані на правому (для вертикального) або дна (для горизонтальних) і дозволять перетягування, щоб перемістити видимий контроль (і його діти) в рамках ScrollContainer. Скролбари також автоматично змінять зчеплення на основі Control.custom_minimum_size контролю відносно ScrollContainer.

Посібники

Властивості

bool

clip_contents

true (overrides Control)

bool

draw_focus_border

false

bool

follow_focus

false

ScrollMode

horizontal_scroll_mode

1

bool

propagate_maximum_size

false (overrides Control)

int

scroll_deadzone

0

ScrollHintMode

scroll_hint_mode

0

int

scroll_horizontal

0

bool

scroll_horizontal_by_default

false

float

scroll_horizontal_custom_step

-1.0

int

scroll_vertical

0

float

scroll_vertical_custom_step

-1.0

bool

tile_scroll_hint

false

ScrollMode

vertical_scroll_mode

1

Методи

void

ensure_control_visible(control: Control)

HScrollBar

get_h_scroll_bar()

VScrollBar

get_v_scroll_bar()

Властивості теми

Color

scroll_hint_horizontal_color

Color(0, 0, 0, 1)

Color

scroll_hint_vertical_color

Color(0, 0, 0, 1)

int

scrollbar_h_separation

0

int

scrollbar_v_separation

0

Texture2D

scroll_hint_horizontal

Texture2D

scroll_hint_vertical

StyleBox

focus

StyleBox

panel

Сигнали

scroll_ended() 🔗

Випробувано при прокручуванні зупинок при перетягування прокрученої площі * з сенсорною подією . Цей сигнал *not введений при прокручуванні, прокручування за допомогою миші або прокручування за допомогою клавіатури / грипада подій.

Примітка: Цей сигнал використовується тільки на Android або iOS, або на настільних / веб-платформах, коли ProjectSettings.input_devices/pointing/emulate_touch_from_mouse.

scroll_started() 🔗

Випробувано при прокручуванні починається при перетягування прокрученої площі with сенсорний захід. Цей сигнал not вдається при прокручуванні за допомогою прокручування, прокручування за допомогою миші або прокручування за допомогою клавіатури / грипаду подій.

Примітка: Цей сигнал використовується тільки на Android або iOS, або на настільних / веб-платформах, коли ProjectSettings.input_devices/pointing/emulate_touch_from_mouse.

Переліки

enum ScrollMode: 🔗

ScrollMode SCROLL_MODE_DISABLED = 0

Вимкніть вимкнені, прокрутка буде невидимимим.

ScrollMode SCROLL_MODE_AUTO = 1

Увімкнути, прокрутку буде видно тільки при необхідності, тобто вміст контейнера більше, ніж контейнер.

ScrollMode SCROLL_MODE_SHOW_ALWAYS = 2

Увімкнено прокрутку, прокрутка завжди буде видно.

ScrollMode SCROLL_MODE_SHOW_NEVER = 3

Увімкніть, прокрутка буде прихована.

ScrollMode SCROLL_MODE_RESERVE = 4

Поєднує SCROLL_MODE_AUTO і SCROLL_MODE_SHOW_ALWAYS. Смуга прокрутки відображається лише за необхідності, але розмір вмісту регулюється так, ніби він завжди був видимим. Це корисно для забезпечення того, щоб розмір вмісту залишався незмінним незалежно від того, чи видно смугу прокрутки.

ScrollMode SCROLL_MODE_MAXIMIZE_FIRST = 5

Працює так само, як SCROLL_MODE_AUTO, але змушує ScrollContainer повідомляти про мінімальний розмір на основі його вмісту (обмежений параметром Control.custom_maximum_size, якщо він заданий для відповідної осі). Це дозволяє йому спочатку розширюватися, а прокрутка починається лише після досягнення обмеження.

enum ScrollHintMode: 🔗

ScrollHintMode SCROLL_HINT_MODE_DISABLED = 0

Підказки прокручування ніколи не відображатимуться.

ScrollHintMode SCROLL_HINT_MODE_ALL = 1

Підказки прокручування будуть відображатися вгорі та внизу (якщо вертикально) або ліворуч та праворуч (якщо горизонтально).

ScrollHintMode SCROLL_HINT_MODE_TOP_AND_LEFT = 2

Підказки прокручування будуть відображатися зверху (якщо вертикально) або ліворуч (якщо горизонтально).

ScrollHintMode SCROLL_HINT_MODE_BOTTOM_AND_RIGHT = 3

Підказки прокручування будуть відображатися внизу (якщо горизонтальне розташування) або праворуч (якщо горизонтальне розташування).

Описи властивостей

bool draw_focus_border = false 🔗

  • void set_draw_focus_border(value: bool)

  • bool get_draw_focus_border()

Якщо true, focus малюється, коли сфокусовано ScrollContainer або один із його вузлів-нащадків.

bool follow_focus = false 🔗

  • void set_follow_focus(value: bool)

  • bool is_following_focus()

Якщо true, ScrollContainer автоматично прокручує до фокусованих дітей (включаючи непрямі діти), щоб переконатися, що вони повністю видимі.

ScrollMode horizontal_scroll_mode = 1 🔗

Контролює, чи можна використовувати горизонтальну смугу прокручування та коли вона має бути видимою.

int scroll_deadzone = 0 🔗

  • void set_deadzone(value: int)

  • int get_deadzone()

Дедзон для сенсорного прокручування. Низьке мертвозон робить прокручування більш чутливою.

ScrollHintMode scroll_hint_mode = 0 🔗

Спосіб відображення підказок прокручування (індикаторів, які показують, що вміст все ще можна прокручувати в певному напрямку).

Примітка: Підказки не відображатимуться, якщо вміст можна прокручувати як вертикально, так і горизонтально.

int scroll_horizontal = 0 🔗

  • void set_h_scroll(value: int)

  • int get_h_scroll()

Поточне значення горизонтальної прокрутки.

Примітка. Якщо ви встановлюєте це значення у функції Node._ready() або раніше, його потрібно обернути Object.set_deferred(), оскільки Range.max_value смуги прокрутки ще не ініціалізовано.

func _ready():
    set_deferred("scroll_horizontal", 600)

bool scroll_horizontal_by_default = false 🔗

  • void set_scroll_horizontal_by_default(value: bool)

  • bool is_scroll_horizontal_by_default()

Якщо true, колесо миші забезпечує горизонтальну прокрутку вікна, а при утриманні клавіші Shift — вертикальну.

Якщо false (за замовчуванням), колесо миші забезпечує вертикальну прокрутку вікна, а при утриманні клавіші Shift — горизонтальну.

float scroll_horizontal_custom_step = -1.0 🔗

  • void set_horizontal_custom_step(value: float)

  • float get_horizontal_custom_step()

На відміну від ScrollBar.custom_step використовується при натисканні на горизонтальну підшлункову планку та натисканні кнопки або при використанні клавіш зі стрілками при фокусі ScrollBar.

int scroll_vertical = 0 🔗

  • void set_v_scroll(value: int)

  • int get_v_scroll()

Поточне значення вертикальної прокрутки.

**Примітка: ** Раннє налаштування потрібно відкласти, як і в scroll_horizontal.

func _ready():
    set_deferred("scroll_vertical", 600)

float scroll_vertical_custom_step = -1.0 🔗

  • void set_vertical_custom_step(value: float)

  • float get_vertical_custom_step()

На відміну від ScrollBar.custom_step використовується при натисканні на вертикальну підв’язкість та відключення кнопки або при використанні клавіш зі стрілками при фокусі ScrollBar.

bool tile_scroll_hint = false 🔗

  • void set_tile_scroll_hint(value: bool)

  • bool is_scroll_hint_tiled()

Якщо значення true, текстура підказки прокручування буде розкладена мозаїкою, а не розтягнута. Див. scroll_hint_mode.

ScrollMode vertical_scroll_mode = 1 🔗

Контролює, чи можна використовувати вертикальну смугу прокручування та коли вона має бути видимою.

Описи методів

void ensure_control_visible(control: Control) 🔗

Забезпечує задану параметровий контроль видиму (посередньо чи непряму дитину ScrollContainer). Використовуються follow_focus.

Примітка: Це не буде працювати на вершині, яка була просто додана під час однакового каркасу. Якщо ви хочете прокрутити до нової дитини, ви повинні чекати до наступного кадру за допомогою SceneTree.process_frame:

add_child(child_node)
await get_tree().process_frame
ensure_control_visible(child_node)

HScrollBar get_h_scroll_bar() 🔗

Повертає горизонтальну прокрутку HScrollBar цього ScrollContainer.

Попередження: Це необхідний внутрішній вузол, видаляючи і звільняючи його може призвести до аварії. Якщо ви хочете відключити або приховати прокрутку, ви можете скористатися horizontal_scroll_mode.

VScrollBar get_v_scroll_bar() 🔗

Повертає вертикальні прокрутки VScrollBar цього ScrollContainer.

Попередження: Це необхідний внутрішній вузол, видаляючи і звільняючи його може призвести до аварії. Якщо ви хочете відключити або приховати прокрутку, ви можете скористатися vertical_scroll_mode.

Описи тематичної нерухомості

Color scroll_hint_horizontal_color = Color(0, 0, 0, 1) 🔗

Color використовується для модуляції текстури scroll_hint_horizontal.

Color scroll_hint_vertical_color = Color(0, 0, 0, 1) 🔗

Color використовується для модуляції текстури scroll_hint_vertical.

int scrollbar_h_separation = 0 🔗

Простір між вертикальною смугою прокручування ScrollContainer та його вмістом у пікселях. Простір не додаватиметься, якщо мінімальний розмір вмісту перевищує розмір ScrollContainer.

int scrollbar_v_separation = 0 🔗

Простір між горизонтальною смугою прокручування ScrollContainer та його вмістом у пікселях. Простір не додаватиметься, якщо мінімальний розмір вмісту перевищує розмір ScrollContainer.

Texture2D scroll_hint_horizontal 🔗

Індикатор, який відображатиметься, коли вміст все ще можна прокручувати горизонтально. Див. scroll_hint_mode.

Texture2D scroll_hint_vertical 🔗

Індикатор, який відображатиметься, коли вміст все ще можна прокручувати вертикально. Див. scroll_hint_mode.

StyleBox focus 🔗

Межа фокусу StyleBox ScrollContainer. Використовується, лише якщо draw_focus_border має значення true.

StyleBox panel 🔗

Підручник StyleBox ScrollContainer.