Class PopupMenu

A modal window used to display a list of options.

Inheritance: Popup

Window

Viewport

Node

Object

PopupMenu

Remarks

PopupMenu is a modal window used to display a list of options. Useful for toolbars and context menus.

The size of a PopupMenu can be limited by using max_size. If the height of the list of items is larger than the maximum height of the PopupMenu, a ScrollContainer within the popup will allow the user to scroll the contents. If no maximum size is set, or if it is set to 0, the PopupMenu height will be limited by its parent rect.

All set_* methods allow negative item indices, i.e. -1 to access the last item, -2 to select the second-to-last item, and so on.

Incremental search: Like ItemList and Tree, PopupMenu supports searching within the list while the control is focused. Press a key that matches the first letter of an item's name to select the first item starting with the given letter. After that point, there are two ways to perform incremental search: 1) Press the same key again before the timeout duration to select the next item starting with the same letter. 2) Press letter keys that match the rest of the word before the timeout duration to match to select the item in question directly. Both of these actions will be reset to the beginning of the list if the timeout duration has passed since the last keystroke was registered. You can adjust the timeout duration by changing gui/timers/incremental_search_max_interval_msec.

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.

Properties

allow_search

If true, allows navigating PopupMenu with letter keys.

var allow_search : bool = true

Property Value

bool

Remarks

void set_allow_search(bool value)
bool get_allow_search

hide_on_checkable_item_selection

If true, hides the PopupMenu when a checkbox or radio button is selected.

var hide_on_checkable_item_selection : bool = true

Property Value

bool

Remarks

void set_hide_on_checkable_item_selection(bool value)
bool is_hide_on_checkable_item_selection

hide_on_item_selection

If true, hides the PopupMenu when an item is selected.

var hide_on_item_selection : bool = true

Property Value

bool

Remarks

void set_hide_on_item_selection(bool value)
bool is_hide_on_item_selection

hide_on_state_item_selection

If true, hides the PopupMenu when a state item is selected.

var hide_on_state_item_selection : bool = false

Property Value

bool

Remarks

void set_hide_on_state_item_selection(bool value)
bool is_hide_on_state_item_selection

item_count

The number of items currently in the list.

var item_count : int = 0

Property Value

int

Remarks

void set_item_count(int value)
int get_item_count

prefer_native_menu

If true, MenuBar will use native menu when supported.

Note: If PopupMenu is linked to StatusIndicator, MenuBar, or another PopupMenu item it can use native menu regardless of this property, use is_native_menu to check it.

var prefer_native_menu : bool = false

Property Value

bool

Remarks

void set_prefer_native_menu(bool value)
bool is_prefer_native_menu

submenu_popup_delay

Sets the delay time in seconds for the submenu item to popup on mouse hovering. If the popup menu is added as a child of another (acting as a submenu), it will inherit the delay time of the parent menu item.

var submenu_popup_delay : float = 0.3

Property Value

float

Remarks

void set_submenu_popup_delay(float value)
float get_submenu_popup_delay

system_menu_id

If set to one of the values of SystemMenus, this PopupMenu is bound to the special system menu. Only one PopupMenu can be bound to each special menu at a time.

var system_menu_id : int = 0

Property Value

int

Remarks

void set_system_menu(int value)
int get_system_menu

font_accelerator_color

Theme Property

The text Color used for shortcuts and accelerators that show next to the menu item name when defined. See PopupMenu.get_item_accelerator for more info on accelerators.

 = ``Color(0.7, 0.7, 0.7, 0.8)``

Property Value

Color

font_color

Theme Property

The default text Color for menu items' names.

 = ``Color(0.875, 0.875, 0.875, 1)``

Property Value

Color

font_disabled_color

Theme Property

Color used for disabled menu items' text.

 = ``Color(0.4, 0.4, 0.4, 0.8)``

Property Value

Color

font_hover_color

Theme Property

Color used for the hovered text.

 = ``Color(0.875, 0.875, 0.875, 1)``

Property Value

Color

font_outline_color

Theme Property

The tint of text outline of the menu item.

 = ``Color(0, 0, 0, 1)``

Property Value

Color

font_separator_color

Theme Property

Color used for labeled separators' text. See PopupMenu.add_separator.

 = ``Color(0.875, 0.875, 0.875, 1)``

Property Value

Color

font_separator_outline_color

Theme Property

The tint of text outline of the labeled separator.

 = ``Color(0, 0, 0, 1)``

Property Value

Color

h_separation

Theme Property

The horizontal space between the item's elements.

 = ``4``

Property Value

int

icon_max_width

Theme Property

The maximum allowed width of the item's icon. This limit is applied on top of the default size of the icon, but before the value set with PopupMenu.set_item_icon_max_width. The height is adjusted according to the icon's ratio.

 = ``0``

Property Value

int

indent

Theme Property

Width of the single indentation level.

 = ``10``

Property Value

int

item_end_padding

Theme Property

Horizontal padding to the right of the items (or left, in RTL layout).

 = ``2``

Property Value

int

item_start_padding

Theme Property

Horizontal padding to the left of the items (or right, in RTL layout).

 = ``2``

Property Value

int

outline_size

Theme Property

The size of the item text outline.

Note: If using a font with multichannel_signed_distance_field enabled, its msdf_pixel_range must be set to at least twice the value of outline_size for outline rendering to look correct. Otherwise, the outline may appear to be cut off earlier than intended.

 = ``0``

Property Value

int

separator_outline_size

Theme Property

The size of the labeled separator text outline.

 = ``0``

Property Value

int

v_separation

Theme Property

The vertical space between each menu item.

 = ``4``

Property Value

int

font

Theme Property

Font used for the menu items.

Font font

Property Value

Font

font_separator

Theme Property

Font used for the labeled separator.

Font font_separator

Property Value

Font

font_separator_size

Theme Property

Font size of the labeled separator.

int font_separator_size

Property Value

int

font_size

Theme Property

Font size of the menu items.

int font_size

Property Value

int

checked

Theme Property

Texture2D icon for the checked checkbox items.

Texture2D checked

Property Value

Texture2D

checked_disabled

Theme Property

Texture2D icon for the checked checkbox items when they are disabled.

Texture2D checked_disabled

Property Value

Texture2D

radio_checked

Theme Property

Texture2D icon for the checked radio button items.

Texture2D radio_checked

Property Value

Texture2D

radio_checked_disabled

Theme Property

Texture2D icon for the checked radio button items when they are disabled.

Texture2D radio_checked_disabled

Property Value

Texture2D

radio_unchecked

Theme Property

Texture2D icon for the unchecked radio button items.

Texture2D radio_unchecked

Property Value

Texture2D

radio_unchecked_disabled

Theme Property

Texture2D icon for the unchecked radio button items when they are disabled.

Texture2D radio_unchecked_disabled

Property Value

Texture2D

submenu

Theme Property

Texture2D icon for the submenu arrow (for left-to-right layouts).

Texture2D submenu

Property Value

Texture2D

submenu_mirrored

Theme Property

Texture2D icon for the submenu arrow (for right-to-left layouts).

Texture2D submenu_mirrored

Property Value

Texture2D

unchecked

Theme Property

Texture2D icon for the unchecked checkbox items.

Texture2D unchecked

Property Value

Texture2D

unchecked_disabled

Theme Property

Texture2D icon for the unchecked checkbox items when they are disabled.

Texture2D unchecked_disabled

Property Value

Texture2D

hover

Theme Property

StyleBox displayed when the PopupMenu item is hovered.

StyleBox hover

Property Value

StyleBox

labeled_separator_left

Theme Property

StyleBox for the left side of labeled separator. See PopupMenu.add_separator.

StyleBox labeled_separator_left

Property Value

StyleBox

labeled_separator_right

Theme Property

StyleBox for the right side of labeled separator. See PopupMenu.add_separator.

StyleBox labeled_separator_right

Property Value

StyleBox

panel

Theme Property

StyleBox for the background panel.

StyleBox panel

Property Value

StyleBox

separator

Theme Property

StyleBox used for the separators. See PopupMenu.add_separator.

StyleBox separator

Property Value

StyleBox

Methods

activate_item_by_event(InputEvent, bool)

Checks the provided event against the PopupMenu's shortcuts and accelerators, and activates the first item with matching events. If for_global_only is true, only shortcuts and accelerators with global set to true will be called.

Returns true if an item was successfully activated.

Note: Certain Controls, such as MenuButton, will call this method automatically.

bool activate_item_by_event(InputEvent event, bool for_global_only)

Parameters

event InputEvent
for_global_only bool

add_check_item(String, int, int)

Adds a new checkable item with text label.

An id can optionally be provided, as well as an accelerator (accel). If no id is provided, one will be created from the index. If no accel is provided, then the default value of 0 (corresponding to @GlobalScope.KEY_NONE) will be assigned to the item (which means it won't have any accelerator). See PopupMenu.get_item_accelerator for more info on accelerators.

Note: Checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. See PopupMenu.set_item_checked for more info on how to control it.

void add_check_item(String label, int id, int accel)

Parameters

label String
id int
accel int

add_check_shortcut(Shortcut, int, bool)

Adds a new checkable item and assigns the specified Shortcut to it. Sets the label of the checkbox to the Shortcut's name.

An id can optionally be provided. If no id is provided, one will be created from the index.

void add_check_shortcut(Shortcut shortcut, int id, bool global)

Parameters

shortcut Shortcut
id int
global bool

add_icon_check_item(Texture2D, String, int, int)

Adds a new checkable item with text label and icon texture.

void add_icon_check_item(Texture2D texture, String label, int id, int accel)

Parameters

texture Texture2D
label String
id int
accel int

add_icon_check_shortcut(Texture2D, Shortcut, int, bool)

Adds a new checkable item and assigns the specified Shortcut and icon texture to it. Sets the label of the checkbox to the Shortcut's name.

An id can optionally be provided. If no id is provided, one will be created from the index.

void add_icon_check_shortcut(Texture2D texture, Shortcut shortcut, int id, bool global)

Parameters

texture Texture2D
shortcut Shortcut
id int
global bool

add_icon_item(Texture2D, String, int, int)

Adds a new item with text label and icon texture.

void add_icon_item(Texture2D texture, String label, int id, int accel)

Parameters

texture Texture2D
label String
id int
accel int

add_icon_radio_check_item(Texture2D, String, int, int)

Same as PopupMenu.add_icon_check_item, but uses a radio check button.

void add_icon_radio_check_item(Texture2D texture, String label, int id, int accel)

Parameters

texture Texture2D
label String
id int
accel int

add_icon_radio_check_shortcut(Texture2D, Shortcut, int, bool)

Same as PopupMenu.add_icon_check_shortcut, but uses a radio check button.

void add_icon_radio_check_shortcut(Texture2D texture, Shortcut shortcut, int id, bool global)

Parameters

texture Texture2D
shortcut Shortcut
id int
global bool

add_icon_shortcut(Texture2D, Shortcut, int, bool, bool)

Adds a new item and assigns the specified Shortcut and icon texture to it. Sets the label of the checkbox to the Shortcut's name.

An id can optionally be provided. If no id is provided, one will be created from the index.

If allow_echo is true, the shortcut can be activated with echo events.

void add_icon_shortcut(Texture2D texture, Shortcut shortcut, int id, bool global, bool allow_echo)

Parameters

texture Texture2D
shortcut Shortcut
id int
global bool
allow_echo bool

add_item(String, int, int)

Adds a new item with text label.

Note: The provided id is used only in PopupMenu.id_pressed and PopupMenu.id_focused signals. It's not related to the index arguments in e.g. PopupMenu.set_item_checked.

void add_item(String label, int id, int accel)

Parameters

label String
id int
accel int

add_multistate_item(String, int, int, int, int)

Adds a new multistate item with text label.

Contrarily to normal binary items, multistate items can have more than two states, as defined by max_states. The default value is defined by default_state.

func _ready():
    add_multistate_item("Item", 3, 0)

    index_pressed.connect(func(index: int):
            toggle_item_multistate(index)
            match get_item_multistate(index):
                0:
                    print("First state")
                1:
                    print("Second state")
                2:
                    print("Third state")

        )

Note: Multistate items don't update their state automatically and must be done manually. See PopupMenu.toggle_item_multistate, PopupMenu.set_item_multistate and PopupMenu.get_item_multistate for more info on how to control it.

void add_multistate_item(String label, int max_states, int default_state, int id, int accel)

Parameters

label String
max_states int
default_state int
id int
accel int

add_radio_check_item(String, int, int)

Adds a new radio check button with text label.

void add_radio_check_item(String label, int id, int accel)

Parameters

label String
id int
accel int

add_radio_check_shortcut(Shortcut, int, bool)

Adds a new radio check button and assigns a Shortcut to it. Sets the label of the checkbox to the Shortcut's name.

An id can optionally be provided. If no id is provided, one will be created from the index.

void add_radio_check_shortcut(Shortcut shortcut, int id, bool global)

Parameters

shortcut Shortcut
id int
global bool

add_separator(String, int)

Adds a separator between items. Separators also occupy an index, which you can set by using the id parameter.

A label can optionally be provided, which will appear at the center of the separator.

void add_separator(String label, int id)

Parameters

label String
id int

add_shortcut(Shortcut, int, bool, bool)

Adds a Shortcut.

An id can optionally be provided. If no id is provided, one will be created from the index.

If allow_echo is true, the shortcut can be activated with echo events.

void add_shortcut(Shortcut shortcut, int id, bool global, bool allow_echo)

Parameters

shortcut Shortcut
id int
global bool
allow_echo bool

add_submenu_item(String, String, int)

Adds an item that will act as a submenu of the parent PopupMenu node when clicked. The submenu argument must be the name of an existing PopupMenu that has been added as a child to this node. This submenu will be shown when the item is clicked, hovered for long enough, or activated using the ui_select or ui_right input actions.

An id can optionally be provided. If no id is provided, one will be created from the index.

void add_submenu_item(String label, String submenu, int id)

Parameters

label String
submenu String
id int

add_submenu_node_item(String, PopupMenu, int)

Adds an item that will act as a submenu of the parent PopupMenu node when clicked. This submenu will be shown when the item is clicked, hovered for long enough, or activated using the ui_select or ui_right input actions.

submenu must be either child of this PopupMenu or has no parent node (in which case it will be automatically added as a child). If the submenu popup has another parent, this method will fail.

An id can optionally be provided. If no id is provided, one will be created from the index.

void add_submenu_node_item(String label, PopupMenu submenu, int id)

Parameters

label String
submenu PopupMenu
id int

clear(bool)

Removes all items from the PopupMenu. If free_submenus is true, the submenu nodes are automatically freed.

void clear(bool free_submenus)

Parameters

free_submenus bool

get_focused_item

Qualifiers: const

Returns the index of the currently focused item. Returns -1 if no item is focused.

int get_focused_item

get_item_accelerator(int)

Qualifiers: const

Returns the accelerator of the item at the given index. An accelerator is a keyboard shortcut that can be pressed to trigger the menu button even if it's not currently open. The return value is an integer which is generally a combination of KeyModifierMasks and Keys using bitwise OR such as KEY_MASK_CTRL | KEY_A (Ctrl + A). If no accelerator is defined for the specified index, PopupMenu.get_item_accelerator returns 0 (corresponding to @GlobalScope.KEY_NONE).

int get_item_accelerator(int index)

Parameters

index int

get_item_icon(int)

Qualifiers: const

Returns the icon of the item at the given index.

Texture2D get_item_icon(int index)

Parameters

index int

get_item_icon_max_width(int)

Qualifiers: const

Returns the maximum allowed width of the icon for the item at the given index.

int get_item_icon_max_width(int index)

Parameters

index int

get_item_icon_modulate(int)

Qualifiers: const

Returns a Color modulating the item's icon at the given index.

Color get_item_icon_modulate(int index)

Parameters

index int

get_item_id(int)

Qualifiers: const

Returns the ID of the item at the given index. id can be manually assigned, while index can not.

int get_item_id(int index)

Parameters

index int

get_item_indent(int)

Qualifiers: const

Returns the horizontal offset of the item at the given index.

int get_item_indent(int index)

Parameters

index int

get_item_index(int)

Qualifiers: const

Returns the index of the item containing the specified id. Index is automatically assigned to each item by the engine and can not be set manually.

int get_item_index(int id)

Parameters

id int

get_item_language(int)

Qualifiers: const

Returns item's text language code.

String get_item_language(int index)

Parameters

index int

get_item_metadata(int)

Qualifiers: const

Returns the metadata of the specified item, which might be of any type. You can set it with PopupMenu.set_item_metadata, which provides a simple way of assigning context data to items.

Variant get_item_metadata(int index)

Parameters

index int

get_item_multistate(int)

Qualifiers: const

Returns the state of the item at the given index.

int get_item_multistate(int index)

Parameters

index int

get_item_multistate_max(int)

Qualifiers: const

Returns the max states of the item at the given index.

int get_item_multistate_max(int index)

Parameters

index int

get_item_shortcut(int)

Qualifiers: const

Returns the Shortcut associated with the item at the given index.

Shortcut get_item_shortcut(int index)

Parameters

index int

get_item_submenu(int)

Qualifiers: const

Returns the submenu name of the item at the given index. See PopupMenu.add_submenu_item for more info on how to add a submenu.

String get_item_submenu(int index)

Parameters

index int

get_item_submenu_node(int)

Qualifiers: const

Returns the submenu of the item at the given index, or null if no submenu was added. See PopupMenu.add_submenu_node_item for more info on how to add a submenu.

PopupMenu get_item_submenu_node(int index)

Parameters

index int

get_item_text(int)

Qualifiers: const

Returns the text of the item at the given index.

String get_item_text(int index)

Parameters

index int

get_item_text_direction(int)

Qualifiers: const

Returns item's text base writing direction.

int get_item_text_direction(int index)

Parameters

index int

Qualifiers: const

Returns the tooltip associated with the item at the given index.

String get_item_tooltip(int index)

Parameters

index int

is_item_checkable(int)

Qualifiers: const

Returns true if the item at the given index is checkable in some way, i.e. if it has a checkbox or radio button.

Note: Checkable items just display a checkmark or radio button, but don't have any built-in checking behavior and must be checked/unchecked manually.

bool is_item_checkable(int index)

Parameters

index int

is_item_checked(int)

Qualifiers: const

Returns true if the item at the given index is checked.

bool is_item_checked(int index)

Parameters

index int

is_item_disabled(int)

Qualifiers: const

Returns true if the item at the given index is disabled. When it is disabled it can't be selected, or its action invoked.

See PopupMenu.set_item_disabled for more info on how to disable an item.

bool is_item_disabled(int index)

Parameters

index int

is_item_radio_checkable(int)

Qualifiers: const

Returns true if the item at the given index has radio button-style checkability.

Note: This is purely cosmetic; you must add the logic for checking/unchecking items in radio groups.

bool is_item_radio_checkable(int index)

Parameters

index int

is_item_separator(int)

Qualifiers: const

Returns true if the item is a separator. If it is, it will be displayed as a line. See PopupMenu.add_separator for more info on how to add a separator.

bool is_item_separator(int index)

Parameters

index int

is_item_shortcut_disabled(int)

Qualifiers: const

Returns true if the specified item's shortcut is disabled.

bool is_item_shortcut_disabled(int index)

Parameters

index int

is_native_menu

Qualifiers: const

Returns true if the system native menu is supported and currently used by this PopupMenu.

bool is_native_menu

is_system_menu

Qualifiers: const

Returns true if the menu is bound to the special system menu.

bool is_system_menu

remove_item(int)

Removes the item at the given index from the menu.

Note: The indices of items after the removed item will be shifted by one.

void remove_item(int index)

Parameters

index int

scroll_to_item(int)

Moves the scroll view to make the item at the given index visible.

void scroll_to_item(int index)

Parameters

index int

set_focused_item(int)

Sets the currently focused item as the given index.

Passing -1 as the index makes so that no item is focused.

void set_focused_item(int index)

Parameters

index int

set_item_accelerator(int, int)

Sets the accelerator of the item at the given index. An accelerator is a keyboard shortcut that can be pressed to trigger the menu button even if it's not currently open. accel is generally a combination of KeyModifierMasks and Keys using bitwise OR such as KEY_MASK_CTRL | KEY_A (Ctrl + A).

void set_item_accelerator(int index, int accel)

Parameters

index int
accel int

set_item_as_checkable(int, bool)

Sets whether the item at the given index has a checkbox. If false, sets the type of the item to plain text.

Note: Checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually.

void set_item_as_checkable(int index, bool enable)

Parameters

index int
enable bool

set_item_as_radio_checkable(int, bool)

Sets the type of the item at the given index to radio button. If false, sets the type of the item to plain text.

void set_item_as_radio_checkable(int index, bool enable)

Parameters

index int
enable bool

set_item_as_separator(int, bool)

Mark the item at the given index as a separator, which means that it would be displayed as a line. If false, sets the type of the item to plain text.

void set_item_as_separator(int index, bool enable)

Parameters

index int
enable bool

set_item_checked(int, bool)

Sets the checkstate status of the item at the given index.

void set_item_checked(int index, bool checked)

Parameters

index int
checked bool

set_item_disabled(int, bool)

Enables/disables the item at the given index. When it is disabled, it can't be selected and its action can't be invoked.

void set_item_disabled(int index, bool disabled)

Parameters

index int
disabled bool

set_item_icon(int, Texture2D)

Replaces the Texture2D icon of the item at the given index.

void set_item_icon(int index, Texture2D icon)

Parameters

index int
icon Texture2D

set_item_icon_max_width(int, int)

Sets the maximum allowed width of the icon for the item at the given index. This limit is applied on top of the default size of the icon and on top of icon_max_width. The height is adjusted according to the icon's ratio.

void set_item_icon_max_width(int index, int width)

Parameters

index int
width int

set_item_icon_modulate(int, Color)

Sets a modulating Color of the item's icon at the given index.

void set_item_icon_modulate(int index, Color modulate)

Parameters

index int
modulate Color

set_item_id(int, int)

Sets the id of the item at the given index.

The id is used in PopupMenu.id_pressed and PopupMenu.id_focused signals.

void set_item_id(int index, int id)

Parameters

index int
id int

set_item_indent(int, int)

Sets the horizontal offset of the item at the given index.

void set_item_indent(int index, int indent)

Parameters

index int
indent int

set_item_language(int, String)

Sets language code of item's text used for line-breaking and text shaping algorithms, if left empty current locale is used instead.

void set_item_language(int index, String language)

Parameters

index int
language String

set_item_metadata(int, Variant)

Sets the metadata of an item, which may be of any type. You can later get it with PopupMenu.get_item_metadata, which provides a simple way of assigning context data to items.

void set_item_metadata(int index, Variant metadata)

Parameters

index int
metadata Variant

set_item_multistate(int, int)

Sets the state of a multistate item. See PopupMenu.add_multistate_item for details.

void set_item_multistate(int index, int state)

Parameters

index int
state int

set_item_multistate_max(int, int)

Sets the max states of a multistate item. See PopupMenu.add_multistate_item for details.

void set_item_multistate_max(int index, int max_states)

Parameters

index int
max_states int

set_item_shortcut(int, Shortcut, bool)

Sets a Shortcut for the item at the given index.

void set_item_shortcut(int index, Shortcut shortcut, bool global)

Parameters

index int
shortcut Shortcut
global bool

set_item_shortcut_disabled(int, bool)

Disables the Shortcut of the item at the given index.

void set_item_shortcut_disabled(int index, bool disabled)

Parameters

index int
disabled bool

set_item_submenu(int, String)

Sets the submenu of the item at the given index. The submenu is the name of a child PopupMenu node that would be shown when the item is clicked.

void set_item_submenu(int index, String submenu)

Parameters

index int
submenu String

set_item_submenu_node(int, PopupMenu)

Sets the submenu of the item at the given index. The submenu is a PopupMenu node that would be shown when the item is clicked. It must either be a child of this PopupMenu or has no parent (in which case it will be automatically added as a child). If the submenu popup has another parent, this method will fail.

void set_item_submenu_node(int index, PopupMenu submenu)

Parameters

index int
submenu PopupMenu

set_item_text(int, String)

Sets the text of the item at the given index.

void set_item_text(int index, String text)

Parameters

index int
text String

set_item_text_direction(int, int)

Sets item's text base writing direction.

void set_item_text_direction(int index, int direction)

Parameters

index int
direction int

Sets the String tooltip of the item at the given index.

void set_item_tooltip(int index, String tooltip)

Parameters

index int
tooltip String

toggle_item_checked(int)

Toggles the check state of the item at the given index.

void toggle_item_checked(int index)

Parameters

index int

toggle_item_multistate(int)

Cycle to the next state of a multistate item. See PopupMenu.add_multistate_item for details.

void toggle_item_multistate(int index)

Parameters

index int

Events

id_focused(int)

Emitted when the user navigated to an item of some id using the input/ui_up or input/ui_down input action.

signal id_focused(int id)

Parameters

id int

id_pressed(int)

Emitted when an item of some id is pressed or its accelerator is activated.

Note: If id is negative (either explicitly or due to overflow), this will return the corresponding index instead.

signal id_pressed(int id)

Parameters

id int

index_pressed(int)

Emitted when an item of some index is pressed or its accelerator is activated.

signal index_pressed(int index)

Parameters

index int

menu_changed

Emitted when any item is added, modified or removed.

signal menu_changed

Table of Contents

Class PopupMenu

Remarks

Properties

allow_search

Property Value

Remarks

hide_on_checkable_item_selection

Property Value

Remarks

hide_on_item_selection

Property Value

Remarks

hide_on_state_item_selection

Property Value

Remarks

item_count

Property Value

Remarks

prefer_native_menu

Property Value

Remarks

submenu_popup_delay

Property Value

Remarks

system_menu_id

Property Value

Remarks

font_accelerator_color

Property Value

font_color

Property Value

font_disabled_color

Property Value

font_hover_color

Property Value

font_outline_color

Property Value

font_separator_color

Property Value

font_separator_outline_color

Property Value

h_separation

Property Value

icon_max_width

Property Value

indent

Property Value

item_end_padding

Property Value

item_start_padding

Property Value

outline_size

Property Value

separator_outline_size

Property Value

v_separation

Property Value

font

Property Value

font_separator

Property Value

font_separator_size

Property Value

font_size

Property Value

checked

Property Value

checked_disabled

Property Value

radio_checked

Property Value

radio_checked_disabled

Property Value

radio_unchecked

Property Value

radio_unchecked_disabled

Property Value

submenu

Property Value