Attention: Here be dragons (unstable version)

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Redot.

Checking the stable version of the documentation...

OptionButton

Inherits: Button < BaseButton < Control < CanvasItem < Node < Object

A button that brings up a dropdown with selectable options when pressed.

Description

OptionButton is a type of button that brings up a dropdown with selectable items when pressed. The item selected becomes the "current" item and is displayed as the button text.

See also BaseButton which contains common properties and methods associated with this node.

Note: The ID values used for items are limited to 32 bits, not full 64 bits of int. This has a range of -2^32 to 2^32 - 1, i.e. -2147483648 to 2147483647.

Note: The Button.text and Button.icon properties are set automatically based on the selected item. They shouldn't be changed manually.

Properties

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`
int	selected	`-1`
bool	toggle_mode	`true` (overrides BaseButton)

Methods

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()
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_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()

Theme Properties

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

Signals

item_focused(index: int) 🔗

Emitted when the user navigates to an item using the ProjectSettings.input/ui_up or ProjectSettings.input/ui_down input actions. The index of the item selected is passed as argument.

item_selected(index: int) 🔗

Emitted when the current item has been changed by the user. The index of the item selected is passed as argument.

allow_reselect must be enabled to reselect an item.

Property Descriptions

bool allow_reselect = false 🔗

void set_allow_reselect(value: bool)
bool get_allow_reselect()

If true, the currently selected item can be selected again.

bool fit_to_longest_item = true 🔗

void set_fit_to_longest_item(value: bool)
bool is_fit_to_longest_item()

If true, minimum size will be determined by the longest item's text, instead of the currently selected one's.

Note: For performance reasons, the minimum size doesn't update immediately when adding, removing or modifying items.

int item_count = 0 🔗

void set_item_count(value: int)
int get_item_count()

The number of items to select from.

int selected = -1 🔗

int get_selected()

The index of the currently selected item, or -1 if no item is selected.

Method Descriptions

void add_icon_item(texture: Texture2D, label: String, id: int = -1) 🔗

Adds an item, with a texture icon, text label and (optionally) id. If no id is passed, the item index will be used as the item's ID. New items are appended at the end.

void add_item(label: String, id: int = -1) 🔗

Adds an item, with text label and (optionally) id. If no id is passed, the item index will be used as the item's ID. New items are appended at the end.

void add_separator(text: String = "") 🔗

Adds a separator to the list of items. Separators help to group items, and can optionally be given a text header. A separator also gets an index assigned, and is appended at the end of the item list.

void clear() 🔗

Clears all the items in the OptionButton.

Texture2D get_item_icon(idx: int) const 🔗

Returns the icon of the item at index idx.

int get_item_id(idx: int) const 🔗

Returns the ID of the item at index idx.

int get_item_index(id: int) const 🔗

Returns the index of the item with the given id.

Variant get_item_metadata(idx: int) const 🔗

Retrieves the metadata of an item. Metadata may be any type and can be used to store extra information about an item, such as an external string ID.

String get_item_text(idx: int) const 🔗

Returns the text of the item at index idx.

Returns the tooltip of the item at index idx.

Returns the PopupMenu contained in this button.

Warning: This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their Window.visible property.

int get_selectable_item(from_last: bool = false) const 🔗

Returns the index of the first item which is not disabled, or marked as a separator. If from_last is true, the items will be searched in reverse order.

Returns -1 if no item is found.

int get_selected_id() const 🔗

Returns the ID of the selected item, or -1 if no item is selected.

Variant get_selected_metadata() const 🔗

Gets the metadata of the selected item. Metadata for items can be set using set_item_metadata.

bool has_selectable_items() const 🔗

Returns true if this button contains at least one item which is not disabled, or marked as a separator.

bool is_item_disabled(idx: int) const 🔗

Returns true if the item at index idx is disabled.

bool is_item_separator(idx: int) const 🔗

Returns true if the item at index idx is marked as a separator.

void remove_item(idx: int) 🔗

Removes the item at index idx.

void select(idx: int) 🔗

Selects an item by index and makes it the current item. This will work even if the item is disabled.

Passing -1 as the index deselects any currently selected item.

void set_disable_shortcuts(disabled: bool) 🔗

If true, shortcuts are disabled and cannot be used to trigger the button.

void set_item_disabled(idx: int, disabled: bool) 🔗

Sets whether the item at index idx is disabled.

Disabled items are drawn differently in the dropdown and are not selectable by the user. If the current selected item is set as disabled, it will remain selected.

void set_item_icon(idx: int, texture: Texture2D) 🔗

Sets the icon of the item at index idx.

void set_item_id(idx: int, id: int) 🔗

Sets the ID of the item at index idx.

void set_item_metadata(idx: int, metadata: Variant) 🔗

Sets the metadata of an item. Metadata may be of any type and can be used to store extra information about an item, such as an external string ID.

void set_item_text(idx: int, text: String) 🔗

Sets the text of the item at index idx.

Sets the tooltip of the item at index idx.

Adjusts popup position and sizing for the OptionButton, then shows the PopupMenu. Prefer this over using get_popup().popup().

Theme Property Descriptions

int arrow_margin = 4 🔗

The horizontal space between the arrow icon and the right edge of the button.

int modulate_arrow = 0 🔗

If different than 0, the arrow icon will be modulated to the font color.

Texture2D arrow 🔗

The arrow icon to be drawn on the right end of the button.