godot-docs/classes/class_optionbutton.rst

:github_url: hide

.. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the OptionButton.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _class_OptionButton:

OptionButton
============

**Inherits:** :ref:`Button<class_Button>` **<** :ref:`BaseButton<class_BaseButton>` **<** :ref:`Control<class_Control>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`

Button control that provides selectable options when pressed.

Description
-----------

OptionButton is a type button that provides a selectable list of items when pressed. The item selected becomes the "current" item and is displayed as the button text.

See also :ref:`BaseButton<class_BaseButton>` which contains common properties and methods associated with this node.

Properties
----------

+-----------------------------------------------+-------------------------------------------------------+------------------------------+
| :ref:`ActionMode<enum_BaseButton_ActionMode>` | action_mode                                           | ``0`` *(parent override)*    |
+-----------------------------------------------+-------------------------------------------------------+------------------------------+
| :ref:`TextAlign<enum_Button_TextAlign>`       | align                                                 | ``0`` *(parent override)*    |
+-----------------------------------------------+-------------------------------------------------------+------------------------------+
| :ref:`int<class_int>`                         | :ref:`selected<class_OptionButton_property_selected>` | ``-1``                       |
+-----------------------------------------------+-------------------------------------------------------+------------------------------+
| :ref:`bool<class_bool>`                       | toggle_mode                                           | ``true`` *(parent override)* |
+-----------------------------------------------+-------------------------------------------------------+------------------------------+

Methods
-------

+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                              | :ref:`add_icon_item<class_OptionButton_method_add_icon_item>` **(** :ref:`Texture2D<class_Texture2D>` texture, :ref:`String<class_String>` label, :ref:`int<class_int>` id=-1 **)** |
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                              | :ref:`add_item<class_OptionButton_method_add_item>` **(** :ref:`String<class_String>` label, :ref:`int<class_int>` id=-1 **)**                                                      |
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                              | :ref:`add_separator<class_OptionButton_method_add_separator>` **(** **)**                                                                                                           |
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                              | :ref:`clear<class_OptionButton_method_clear>` **(** **)**                                                                                                                           |
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`             | :ref:`get_item_count<class_OptionButton_method_get_item_count>` **(** **)** |const|                                                                                                 |
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`get_item_icon<class_OptionButton_method_get_item_icon>` **(** :ref:`int<class_int>` idx **)** |const|                                                                         |
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`             | :ref:`get_item_id<class_OptionButton_method_get_item_id>` **(** :ref:`int<class_int>` idx **)** |const|                                                                             |
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`             | :ref:`get_item_index<class_OptionButton_method_get_item_index>` **(** :ref:`int<class_int>` id **)** |const|                                                                        |
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Variant<class_Variant>`     | :ref:`get_item_metadata<class_OptionButton_method_get_item_metadata>` **(** :ref:`int<class_int>` idx **)** |const|                                                                 |
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`       | :ref:`get_item_text<class_OptionButton_method_get_item_text>` **(** :ref:`int<class_int>` idx **)** |const|                                                                         |
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PopupMenu<class_PopupMenu>` | :ref:`get_popup<class_OptionButton_method_get_popup>` **(** **)** |const|                                                                                                           |
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`             | :ref:`get_selected_id<class_OptionButton_method_get_selected_id>` **(** **)** |const|                                                                                               |
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Variant<class_Variant>`     | :ref:`get_selected_metadata<class_OptionButton_method_get_selected_metadata>` **(** **)** |const|                                                                                   |
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`           | :ref:`is_item_disabled<class_OptionButton_method_is_item_disabled>` **(** :ref:`int<class_int>` idx **)** |const|                                                                   |
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                              | :ref:`remove_item<class_OptionButton_method_remove_item>` **(** :ref:`int<class_int>` idx **)**                                                                                     |
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                              | :ref:`select<class_OptionButton_method_select>` **(** :ref:`int<class_int>` idx **)**                                                                                               |
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                              | :ref:`set_item_disabled<class_OptionButton_method_set_item_disabled>` **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` disabled **)**                                       |
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                              | :ref:`set_item_icon<class_OptionButton_method_set_item_icon>` **(** :ref:`int<class_int>` idx, :ref:`Texture2D<class_Texture2D>` texture **)**                                      |
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                              | :ref:`set_item_id<class_OptionButton_method_set_item_id>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` id **)**                                                           |
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                              | :ref:`set_item_metadata<class_OptionButton_method_set_item_metadata>` **(** :ref:`int<class_int>` idx, :ref:`Variant<class_Variant>` metadata **)**                                 |
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                              | :ref:`set_item_text<class_OptionButton_method_set_item_text>` **(** :ref:`int<class_int>` idx, :ref:`String<class_String>` text **)**                                               |
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Theme Properties
----------------

+-----------------------------------+--------------------------------------------------------------------------------+--------------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`arrow<class_OptionButton_theme_icon_arrow>`                              |                                |
+-----------------------------------+--------------------------------------------------------------------------------+--------------------------------+
| :ref:`int<class_int>`             | :ref:`arrow_margin<class_OptionButton_theme_constant_arrow_margin>`            | ``2``                          |
+-----------------------------------+--------------------------------------------------------------------------------+--------------------------------+
| :ref:`StyleBox<class_StyleBox>`   | :ref:`disabled<class_OptionButton_theme_style_disabled>`                       |                                |
+-----------------------------------+--------------------------------------------------------------------------------+--------------------------------+
| :ref:`StyleBox<class_StyleBox>`   | :ref:`disabled_mirrored<class_OptionButton_theme_style_disabled_mirrored>`     |                                |
+-----------------------------------+--------------------------------------------------------------------------------+--------------------------------+
| :ref:`StyleBox<class_StyleBox>`   | :ref:`focus<class_OptionButton_theme_style_focus>`                             |                                |
+-----------------------------------+--------------------------------------------------------------------------------+--------------------------------+
| :ref:`Font<class_Font>`           | :ref:`font<class_OptionButton_theme_font_font>`                                |                                |
+-----------------------------------+--------------------------------------------------------------------------------+--------------------------------+
| :ref:`Color<class_Color>`         | :ref:`font_color<class_OptionButton_theme_color_font_color>`                   | ``Color(0.88, 0.88, 0.88, 1)`` |
+-----------------------------------+--------------------------------------------------------------------------------+--------------------------------+
| :ref:`Color<class_Color>`         | :ref:`font_disabled_color<class_OptionButton_theme_color_font_disabled_color>` | ``Color(0.9, 0.9, 0.9, 0.2)``  |
+-----------------------------------+--------------------------------------------------------------------------------+--------------------------------+
| :ref:`Color<class_Color>`         | :ref:`font_focus_color<class_OptionButton_theme_color_font_focus_color>`       | ``Color(0.94, 0.94, 0.94, 1)`` |
+-----------------------------------+--------------------------------------------------------------------------------+--------------------------------+
| :ref:`Color<class_Color>`         | :ref:`font_hover_color<class_OptionButton_theme_color_font_hover_color>`       | ``Color(0.94, 0.94, 0.94, 1)`` |
+-----------------------------------+--------------------------------------------------------------------------------+--------------------------------+
| :ref:`Color<class_Color>`         | :ref:`font_outline_color<class_OptionButton_theme_color_font_outline_color>`   | ``Color(1, 1, 1, 1)``          |
+-----------------------------------+--------------------------------------------------------------------------------+--------------------------------+
| :ref:`Color<class_Color>`         | :ref:`font_pressed_color<class_OptionButton_theme_color_font_pressed_color>`   | ``Color(1, 1, 1, 1)``          |
+-----------------------------------+--------------------------------------------------------------------------------+--------------------------------+
| :ref:`int<class_int>`             | :ref:`font_size<class_OptionButton_theme_font_size_font_size>`                 |                                |
+-----------------------------------+--------------------------------------------------------------------------------+--------------------------------+
| :ref:`StyleBox<class_StyleBox>`   | :ref:`hover<class_OptionButton_theme_style_hover>`                             |                                |
+-----------------------------------+--------------------------------------------------------------------------------+--------------------------------+
| :ref:`StyleBox<class_StyleBox>`   | :ref:`hover_mirrored<class_OptionButton_theme_style_hover_mirrored>`           |                                |
+-----------------------------------+--------------------------------------------------------------------------------+--------------------------------+
| :ref:`int<class_int>`             | :ref:`hseparation<class_OptionButton_theme_constant_hseparation>`              | ``2``                          |
+-----------------------------------+--------------------------------------------------------------------------------+--------------------------------+
| :ref:`StyleBox<class_StyleBox>`   | :ref:`normal<class_OptionButton_theme_style_normal>`                           |                                |
+-----------------------------------+--------------------------------------------------------------------------------+--------------------------------+
| :ref:`StyleBox<class_StyleBox>`   | :ref:`normal_mirrored<class_OptionButton_theme_style_normal_mirrored>`         |                                |
+-----------------------------------+--------------------------------------------------------------------------------+--------------------------------+
| :ref:`int<class_int>`             | :ref:`outline_size<class_OptionButton_theme_constant_outline_size>`            | ``0``                          |
+-----------------------------------+--------------------------------------------------------------------------------+--------------------------------+
| :ref:`StyleBox<class_StyleBox>`   | :ref:`pressed<class_OptionButton_theme_style_pressed>`                         |                                |
+-----------------------------------+--------------------------------------------------------------------------------+--------------------------------+
| :ref:`StyleBox<class_StyleBox>`   | :ref:`pressed_mirrored<class_OptionButton_theme_style_pressed_mirrored>`       |                                |
+-----------------------------------+--------------------------------------------------------------------------------+--------------------------------+

Signals
-------

.. _class_OptionButton_signal_item_focused:

- **item_focused** **(** :ref:`int<class_int>` index **)**

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

----

.. _class_OptionButton_signal_item_selected:

- **item_selected** **(** :ref:`int<class_int>` index **)**

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

Property Descriptions
---------------------

.. _class_OptionButton_property_selected:

- :ref:`int<class_int>` **selected**

+-----------+----------------+
| *Default* | ``-1``         |
+-----------+----------------+
| *Getter*  | get_selected() |
+-----------+----------------+

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

Method Descriptions
-------------------

.. _class_OptionButton_method_add_icon_item:

- void **add_icon_item** **(** :ref:`Texture2D<class_Texture2D>` texture, :ref:`String<class_String>` label, :ref:`int<class_int>` id=-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.

----

.. _class_OptionButton_method_add_item:

- void **add_item** **(** :ref:`String<class_String>` label, :ref:`int<class_int>` id=-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.

----

.. _class_OptionButton_method_add_separator:

- void **add_separator** **(** **)**

Adds a separator to the list of items. Separators help to group items. Separator also takes up an index and is appended at the end.

----

.. _class_OptionButton_method_clear:

- void **clear** **(** **)**

Clears all the items in the ``OptionButton``.

----

.. _class_OptionButton_method_get_item_count:

- :ref:`int<class_int>` **get_item_count** **(** **)** |const|

Returns the amount of items in the OptionButton, including separators.

----

.. _class_OptionButton_method_get_item_icon:

- :ref:`Texture2D<class_Texture2D>` **get_item_icon** **(** :ref:`int<class_int>` idx **)** |const|

Returns the icon of the item at index ``idx``.

----

.. _class_OptionButton_method_get_item_id:

- :ref:`int<class_int>` **get_item_id** **(** :ref:`int<class_int>` idx **)** |const|

Returns the ID of the item at index ``idx``.

----

.. _class_OptionButton_method_get_item_index:

- :ref:`int<class_int>` **get_item_index** **(** :ref:`int<class_int>` id **)** |const|

Returns the index of the item with the given ``id``.

----

.. _class_OptionButton_method_get_item_metadata:

- :ref:`Variant<class_Variant>` **get_item_metadata** **(** :ref:`int<class_int>` idx **)** |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.

----

.. _class_OptionButton_method_get_item_text:

- :ref:`String<class_String>` **get_item_text** **(** :ref:`int<class_int>` idx **)** |const|

Returns the text of the item at index ``idx``.

----

.. _class_OptionButton_method_get_popup:

- :ref:`PopupMenu<class_PopupMenu>` **get_popup** **(** **)** |const|

Returns the :ref:`PopupMenu<class_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 :ref:`Window.visible<class_Window_property_visible>` property.

----

.. _class_OptionButton_method_get_selected_id:

- :ref:`int<class_int>` **get_selected_id** **(** **)** |const|

Returns the ID of the selected item, or ``0`` if no item is selected.

----

.. _class_OptionButton_method_get_selected_metadata:

- :ref:`Variant<class_Variant>` **get_selected_metadata** **(** **)** |const|

Gets the metadata of the selected item. Metadata for items can be set using :ref:`set_item_metadata<class_OptionButton_method_set_item_metadata>`.

----

.. _class_OptionButton_method_is_item_disabled:

- :ref:`bool<class_bool>` **is_item_disabled** **(** :ref:`int<class_int>` idx **)** |const|

Returns ``true`` if the item at index ``idx`` is disabled.

----

.. _class_OptionButton_method_remove_item:

- void **remove_item** **(** :ref:`int<class_int>` idx **)**

Removes the item at index ``idx``.

----

.. _class_OptionButton_method_select:

- void **select** **(** :ref:`int<class_int>` idx **)**

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

----

.. _class_OptionButton_method_set_item_disabled:

- void **set_item_disabled** **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` disabled **)**

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.

----

.. _class_OptionButton_method_set_item_icon:

- void **set_item_icon** **(** :ref:`int<class_int>` idx, :ref:`Texture2D<class_Texture2D>` texture **)**

Sets the icon of the item at index ``idx``.

----

.. _class_OptionButton_method_set_item_id:

- void **set_item_id** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` id **)**

Sets the ID of the item at index ``idx``.

----

.. _class_OptionButton_method_set_item_metadata:

- void **set_item_metadata** **(** :ref:`int<class_int>` idx, :ref:`Variant<class_Variant>` metadata **)**

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.

----

.. _class_OptionButton_method_set_item_text:

- void **set_item_text** **(** :ref:`int<class_int>` idx, :ref:`String<class_String>` text **)**

Sets the text of the item at index ``idx``.

Theme Property Descriptions
---------------------------

.. _class_OptionButton_theme_icon_arrow:

- :ref:`Texture2D<class_Texture2D>` **arrow**

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

----

.. _class_OptionButton_theme_constant_arrow_margin:

- :ref:`int<class_int>` **arrow_margin**

+-----------+-------+
| *Default* | ``2`` |
+-----------+-------+

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

----

.. _class_OptionButton_theme_style_disabled:

- :ref:`StyleBox<class_StyleBox>` **disabled**

:ref:`StyleBox<class_StyleBox>` used when the ``OptionButton`` is disabled (for left-to-right layouts).

----

.. _class_OptionButton_theme_style_disabled_mirrored:

- :ref:`StyleBox<class_StyleBox>` **disabled_mirrored**

:ref:`StyleBox<class_StyleBox>` used when the ``OptionButton`` is disabled (for right-to-left layouts).

----

.. _class_OptionButton_theme_style_focus:

- :ref:`StyleBox<class_StyleBox>` **focus**

:ref:`StyleBox<class_StyleBox>` used when the ``OptionButton`` is focused. It is displayed over the current :ref:`StyleBox<class_StyleBox>`, so using :ref:`StyleBoxEmpty<class_StyleBoxEmpty>` will just disable the focus visual effect.

----

.. _class_OptionButton_theme_font_font:

- :ref:`Font<class_Font>` **font**

:ref:`Font<class_Font>` of the ``OptionButton``'s text.

----

.. _class_OptionButton_theme_color_font_color:

- :ref:`Color<class_Color>` **font_color**

+-----------+--------------------------------+
| *Default* | ``Color(0.88, 0.88, 0.88, 1)`` |
+-----------+--------------------------------+

Default text :ref:`Color<class_Color>` of the ``OptionButton``.

----

.. _class_OptionButton_theme_color_font_disabled_color:

- :ref:`Color<class_Color>` **font_disabled_color**

+-----------+-------------------------------+
| *Default* | ``Color(0.9, 0.9, 0.9, 0.2)`` |
+-----------+-------------------------------+

Text :ref:`Color<class_Color>` used when the ``OptionButton`` is disabled.

----

.. _class_OptionButton_theme_color_font_focus_color:

- :ref:`Color<class_Color>` **font_focus_color**

+-----------+--------------------------------+
| *Default* | ``Color(0.94, 0.94, 0.94, 1)`` |
+-----------+--------------------------------+

Text :ref:`Color<class_Color>` used when the ``OptionButton`` is focused. Only replaces the normal text color of the button. Disabled, hovered, and pressed states take precedence over this color.

----

.. _class_OptionButton_theme_color_font_hover_color:

- :ref:`Color<class_Color>` **font_hover_color**

+-----------+--------------------------------+
| *Default* | ``Color(0.94, 0.94, 0.94, 1)`` |
+-----------+--------------------------------+

Text :ref:`Color<class_Color>` used when the ``OptionButton`` is being hovered.

----

.. _class_OptionButton_theme_color_font_outline_color:

- :ref:`Color<class_Color>` **font_outline_color**

+-----------+-----------------------+
| *Default* | ``Color(1, 1, 1, 1)`` |
+-----------+-----------------------+

The tint of text outline of the ``OptionButton``.

----

.. _class_OptionButton_theme_color_font_pressed_color:

- :ref:`Color<class_Color>` **font_pressed_color**

+-----------+-----------------------+
| *Default* | ``Color(1, 1, 1, 1)`` |
+-----------+-----------------------+

Text :ref:`Color<class_Color>` used when the ``OptionButton`` is being pressed.

----

.. _class_OptionButton_theme_font_size_font_size:

- :ref:`int<class_int>` **font_size**

Font size of the ``OptionButton``'s text.

----

.. _class_OptionButton_theme_style_hover:

- :ref:`StyleBox<class_StyleBox>` **hover**

:ref:`StyleBox<class_StyleBox>` used when the ``OptionButton`` is being hovered (for left-to-right layouts).

----

.. _class_OptionButton_theme_style_hover_mirrored:

- :ref:`StyleBox<class_StyleBox>` **hover_mirrored**

:ref:`StyleBox<class_StyleBox>` used when the ``OptionButton`` is being hovered (for right-to-left layouts).

----

.. _class_OptionButton_theme_constant_hseparation:

- :ref:`int<class_int>` **hseparation**

+-----------+-------+
| *Default* | ``2`` |
+-----------+-------+

The horizontal space between ``OptionButton``'s icon and text.

----

.. _class_OptionButton_theme_style_normal:

- :ref:`StyleBox<class_StyleBox>` **normal**

Default :ref:`StyleBox<class_StyleBox>` for the ``OptionButton`` (for left-to-right layouts).

----

.. _class_OptionButton_theme_style_normal_mirrored:

- :ref:`StyleBox<class_StyleBox>` **normal_mirrored**

Default :ref:`StyleBox<class_StyleBox>` for the ``OptionButton`` (for right-to-left layouts).

----

.. _class_OptionButton_theme_constant_outline_size:

- :ref:`int<class_int>` **outline_size**

+-----------+-------+
| *Default* | ``0`` |
+-----------+-------+

The size of the text outline.

----

.. _class_OptionButton_theme_style_pressed:

- :ref:`StyleBox<class_StyleBox>` **pressed**

:ref:`StyleBox<class_StyleBox>` used when the ``OptionButton`` is being pressed (for left-to-right layouts).

----

.. _class_OptionButton_theme_style_pressed_mirrored:

- :ref:`StyleBox<class_StyleBox>` **pressed_mirrored**

:ref:`StyleBox<class_StyleBox>` used when the ``OptionButton`` is being pressed (for right-to-left layouts).

.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`