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 ( Texture2D texture, String label, int id=-1 )
void	add_item ( String label, int id=-1 )
void	add_separator ( String text="" )
void	clear ( )
Texture2D	get_item_icon ( int idx ) const
int	get_item_id ( int idx ) const
int	get_item_index ( int id ) const
Variant	get_item_metadata ( int idx ) const
String	get_item_text ( int idx ) const
String	get_item_tooltip ( int idx ) const
PopupMenu	get_popup ( ) const
int	get_selectable_item ( bool from_last=false ) const
int	get_selected_id ( ) const
Variant	get_selected_metadata ( ) const
bool	has_selectable_items ( ) const
bool	is_item_disabled ( int idx ) const
bool	is_item_separator ( int idx ) const
void	remove_item ( int idx )
void	select ( int idx )
void	set_disable_shortcuts ( bool disabled )
void	set_item_disabled ( int idx, bool disabled )
void	set_item_icon ( int idx, Texture2D texture )
void	set_item_id ( int idx,