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...

OptionButton

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

Кнопка, яка виводить випадання з вибірковими опціями при натисканні.

Опис

OptionButton – це тип кнопки, яка при натисканні відкриває випадаючий список з елементами, які можна вибрати. Вибраний елемент стає «поточним» елементом і відображається як текст кнопки.

Див. також BaseButton, який містить загальні властивості та методи, пов’язані з цим вузлом.

Примітка: Ідентифікатори, що використовуються для елементів, обмежені 32-бітними цілими числами зі знаком, а не повними 64 бітами int. Вони мають діапазон від -2^31 до 2^31 - 1, тобто від -2147483648 до 2147483647.

Примітка: Властивості Button.text та Button.icon встановлюються автоматично на основі вибраного елемента. Їх не слід змінювати вручну.

Властивості

ActionMode	action_mode	`0` (overrides BaseButton)
HorizontalAlignment	alignment	`0` (overrides Button)
bool	allow_reselect	`false`
bool	fit_to_longest_item	`true`
int	item_count	`0`
bool	popup/item_{index}/disabled	`false`
Texture2D	popup/item_{index}/icon
int	popup/item_{index}/id	`0`
bool	popup/item_{index}/separator	`false`
String	popup/item_{index}/text	`""`
bool	search_bar_enabled	`false`
bool	search_bar_fuzzy_search_enabled	`true`
int	search_bar_fuzzy_search_max_misses	`2`
int	search_bar_min_item_count	`0`
int	selected	`-1`
bool	toggle_mode	`true` (overrides BaseButton)

Методи

void	add_icon_item(texture: Texture2D, label: String, id: int = -1)
void	add_item(label: String, id: int = -1)
void	add_separator(text: String = "")
void	clear()
AutoTranslateMode	get_item_auto_translate_mode(idx: int) const
Texture2D	get_item_icon(idx: int) const
int	get_item_id(idx: int) const
int	get_item_index(id: int) const
Variant	get_item_metadata(idx: int) const
String	get_item_text(idx: int) const
String	get_item_tooltip(idx: int) const
PopupMenu	get_popup() const
int	get_selectable_item(from_last: bool = false) const
int	get_selected_id() const
Variant	get_selected_metadata() const
bool	has_selectable_items() const
bool	is_item_disabled(idx: int) const
bool	is_item_separator(idx: int) const
void	remove_item(idx: int)
void	select(idx: int)
void	set_disable_shortcuts(disabled: bool)
void	set_item_auto_translate_mode(idx: int, mode: AutoTranslateMode)
void	set_item_disabled(idx: int, disabled: bool)
void	set_item_icon(idx: int, texture: Texture2D)
void	set_item_id(idx: int, id: int)
void	set_item_metadata(idx: int, metadata: Variant)
void	set_item_text(idx: int, text: String)
void	set_item_tooltip(idx: int, tooltip: String)
void	show_popup()

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

int	arrow_margin	`4`
int	modulate_arrow	`0`
Texture2D	arrow

Сигнали

item_focused(index: int) 🔗

Повідомлення надсилається, коли користувач переходить до елемента за допомогою дій введення ProjectSettings.input/ui_up або ProjectSettings.input/ui_down. Індекс елемента, на якому встановлено фокус, передається як аргумент.

item_selected(index: int) 🔗

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

allow_reselect повинен бути включений для видалення елемента.

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

bool allow_reselect = false 🔗

void set_allow_reselect(value: bool)
bool get_allow_reselect()

Якщо true, в даний час вибраний пункт можна вибрати знову.

bool fit_to_longest_item = true 🔗

void set_fit_to_longest_item(value: bool)
bool is_fit_to_longest_item()

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

Примітка: З причин виконання, мінімальний розмір не змінюється відразу при додаванні, видаленні або модифікації елементів.

int item_count = 0 🔗

void set_item_count(value: int)
int get_item_count()

Кількість елементів для вибору.

bool popup/item_{index}/disabled = false 🔗

Якщо true, елемент під index вимкнено.