A modal window used to display a list of options.
[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 [member Window.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 [code]0[/code], the [PopupMenu] height will be limited by its parent rect. All [code]set_*[/code] methods allow negative item indices, i.e. [code]-1[/code] to access the last item, [code]-2[/code] to select the second-to-last item, and so on. [b]Incremental search:[/b] 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 [member ProjectSettings.gui/timers/incremental_search_max_interval_msec]. [b]Note:[/b] [PopupMenu] is invisible by default. To make it visible, call one of the [code]popup_*[/code] methods from [Window] on the node, such as [method Window.popup_centered_clamped]. [b]Note:[/b] The ID values used for items are limited to 32 bits, not full 64 bits of [int]. This has a range of [code]-2^32[/code] to [code]2^32 - 1[/code], i.e. [code]-2147483648[/code] to [code]2147483647[/code].
Checks the provided [param event] against the [PopupMenu]'s shortcuts and accelerators, and activates the first item with matching events. If [param for_global_only] is [code]true[/code], only shortcuts and accelerators with [code]global[/code] set to [code]true[/code] will be called. Returns [code]true[/code] if an item was successfully activated. [b]Note:[/b] Certain [Control]s, such as [MenuButton], will call this method automatically.
Adds a new checkable item with text [param label]. An [param id] can optionally be provided, as well as an accelerator ([param accel]). If no [param id] is provided, one will be created from the index. If no [param accel] is provided, then the default value of 0 (corresponding to [constant @GlobalScope.KEY_NONE]) will be assigned to the item (which means it won't have any accelerator). See [method get_item_accelerator] for more info on accelerators. [b]Note:[/b] Checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. See [method set_item_checked] for more info on how to control it.
Adds a new checkable item and assigns the specified [Shortcut] to it. Sets the label of the checkbox to the [Shortcut]'s name. An [param id] can optionally be provided. If no [param id] is provided, one will be created from the index. [b]Note:[/b] Checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. See [method set_item_checked] for more info on how to control it.
Adds a new checkable item with text [param label] and icon [param texture]. An [param id] can optionally be provided, as well as an accelerator ([param accel]). If no [param id] is provided, one will be created from the index. If no [param accel] is provided, then the default value of 0 (corresponding to [constant @GlobalScope.KEY_NONE]) will be assigned to the item (which means it won't have any accelerator). See [method get_item_accelerator] for more info on accelerators. [b]Note:[/b] Checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. See [method set_item_checked] for more info on how to control it.
Adds a new checkable item and assigns the specified [Shortcut] and icon [param texture] to it. Sets the label of the checkbox to the [Shortcut]'s name. An [param id] can optionally be provided. If no [param id] is provided, one will be created from the index. [b]Note:[/b] Checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. See [method set_item_checked] for more info on how to control it.
Adds a new item with text [param label] and icon [param texture]. An [param id] can optionally be provided, as well as an accelerator ([param accel]). If no [param id] is provided, one will be created from the index. If no [param accel] is provided, then the default value of 0 (corresponding to [constant @GlobalScope.KEY_NONE]) will be assigned to the item (which means it won't have any accelerator). See [method get_item_accelerator] for more info on accelerators.
Same as [method add_icon_check_item], but uses a radio check button.
Same as [method add_icon_check_shortcut], but uses a radio check button.
Adds a new item and assigns the specified [Shortcut] and icon [param texture] to it. Sets the label of the checkbox to the [Shortcut]'s name. An [param id] can optionally be provided. If no [param id] is provided, one will be created from the index. If [param allow_echo] is [code]true[/code], the shortcut can be activated with echo events.
Adds a new item with text [param label]. An [param id] can optionally be provided, as well as an accelerator ([param accel]). If no [param id] is provided, one will be created from the index. If no [param accel] is provided, then the default value of 0 (corresponding to [constant @GlobalScope.KEY_NONE]) will be assigned to the item (which means it won't have any accelerator). See [method get_item_accelerator] for more info on accelerators. [b]Note:[/b] The provided [param id] is used only in [signal id_pressed] and [signal id_focused] signals. It's not related to the [code]index[/code] arguments in e.g. [method set_item_checked].
Adds a new multistate item with text [param label]. Contrarily to normal binary items, multistate items can have more than two states, as defined by [param max_states]. The default value is defined by [param default_state]. An [param id] can optionally be provided, as well as an accelerator ([param accel]). If no [param id] is provided, one will be created from the index. If no [param accel] is provided, then the default value of 0 (corresponding to [constant @GlobalScope.KEY_NONE]) will be assigned to the item (which means it won't have any accelerator). See [method get_item_accelerator] for more info on accelerators. [codeblock] 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") ) [/codeblock] [b]Note:[/b] Multistate items don't update their state automatically and must be done manually. See [method toggle_item_multistate], [method set_item_multistate] and [method get_item_multistate] for more info on how to control it.
Adds a new radio check button with text [param label]. An [param id] can optionally be provided, as well as an accelerator ([param accel]). If no [param id] is provided, one will be created from the index. If no [param accel] is provided, then the default value of 0 (corresponding to [constant @GlobalScope.KEY_NONE]) will be assigned to the item (which means it won't have any accelerator). See [method get_item_accelerator] for more info on accelerators. [b]Note:[/b] Checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. See [method set_item_checked] for more info on how to control it.
Adds a new radio check button and assigns a [Shortcut] to it. Sets the label of the checkbox to the [Shortcut]'s name. An [param id] can optionally be provided. If no [param id] is provided, one will be created from the index. [b]Note:[/b] Checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. See [method set_item_checked] for more info on how to control it.
Adds a separator between items. Separators also occupy an index, which you can set by using the [param id] parameter. A [param label] can optionally be provided, which will appear at the center of the separator.
Adds a [Shortcut]. An [param id] can optionally be provided. If no [param id] is provided, one will be created from the index. If [param allow_echo] is [code]true[/code], the shortcut can be activated with echo events.
Adds an item that will act as a submenu of the parent [PopupMenu] node when clicked. The [param 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 [code]ui_select[/code] or [code]ui_right[/code] input actions. An [param id] can optionally be provided. If no [param id] is provided, one will be created from the index.
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 [code]ui_select[/code] or [code]ui_right[/code] input actions. [param 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 [param submenu] popup has another parent, this method will fail. An [param id] can optionally be provided. If no [param id] is provided, one will be created from the index.
Removes all items from the [PopupMenu]. If [param free_submenus] is [code]true[/code], the submenu nodes are automatically freed.
Returns the index of the currently focused item. Returns [code]-1[/code] if no item is focused.
Returns the accelerator of the item at the given [param 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 [enum KeyModifierMask]s and [enum Key]s using bitwise OR such as [code]KEY_MASK_CTRL | KEY_A[/code] ([kbd]Ctrl + A[/kbd]). If no accelerator is defined for the specified [param index], [method get_item_accelerator] returns [code]0[/code] (corresponding to [constant @GlobalScope.KEY_NONE]).
Returns the auto translate mode of the item at the given [param index].
Returns the icon of the item at the given [param index].
Returns the maximum allowed width of the icon for the item at the given [param index].
Returns a [Color] modulating the item's icon at the given [param index].
Returns the ID of the item at the given [param index]. [code]id[/code] can be manually assigned, while index can not.
Returns the horizontal offset of the item at the given [param index].
Returns the index of the item containing the specified [param id]. Index is automatically assigned to each item by the engine and can not be set manually.
Returns item's text language code.
Returns the metadata of the specified item, which might be of any type. You can set it with [method set_item_metadata], which provides a simple way of assigning context data to items.
Returns the state of the item at the given [param index].
Returns the max states of the item at the given [param index].
Returns the [Shortcut] associated with the item at the given [param index].
Returns the submenu name of the item at the given [param index]. See [method add_submenu_item] for more info on how to add a submenu.
Returns the submenu of the item at the given [param index], or [code]null[/code] if no submenu was added. See [method add_submenu_node_item] for more info on how to add a submenu.
Returns the text of the item at the given [param index].
Returns item's text base writing direction.
Returns the tooltip associated with the item at the given [param index].
Returns [code]true[/code] if the item at the given [param index] is checkable in some way, i.e. if it has a checkbox or radio button. [b]Note:[/b] Checkable items just display a checkmark or radio button, but don't have any built-in checking behavior and must be checked/unchecked manually.
Returns [code]true[/code] if the item at the given [param index] is checked.
Returns [code]true[/code] if the item at the given [param index] is disabled. When it is disabled it can't be selected, or its action invoked. See [method set_item_disabled] for more info on how to disable an item.
Returns [code]true[/code] if the item at the given [param index] has radio button-style checkability. [b]Note:[/b] This is purely cosmetic; you must add the logic for checking/unchecking items in radio groups.
Returns [code]true[/code] if the item is a separator. If it is, it will be displayed as a line. See [method add_separator] for more info on how to add a separator.
Returns [code]true[/code] if the specified item's shortcut is disabled.
Returns [code]true[/code] if the system native menu is supported and currently used by this [PopupMenu].
Returns [code]true[/code] if the menu is bound to the special system menu.
Removes the item at the given [param index] from the menu. [b]Note:[/b] The indices of items after the removed item will be shifted by one.
Moves the scroll view to make the item at the given [param index] visible.
Sets the currently focused item as the given [param index]. Passing [code]-1[/code] as the index makes so that no item is focused.
Sets the accelerator of the item at the given [param index]. An accelerator is a keyboard shortcut that can be pressed to trigger the menu button even if it's not currently open. [param accel] is generally a combination of [enum KeyModifierMask]s and [enum Key]s using bitwise OR such as [code]KEY_MASK_CTRL | KEY_A[/code] ([kbd]Ctrl + A[/kbd]).
Sets whether the item at the given [param index] has a checkbox. If [code]false[/code], sets the type of the item to plain text. [b]Note:[/b] Checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually.
Sets the type of the item at the given [param index] to radio button. If [code]false[/code], sets the type of the item to plain text.
Mark the item at the given [param index] as a separator, which means that it would be displayed as a line. If [code]false[/code], sets the type of the item to plain text.
Sets the auto translate mode of the item at the given [param index]. Items use [constant Node.AUTO_TRANSLATE_MODE_INHERIT] by default, which uses the same auto translate mode as the [PopupMenu] itself.
Sets the checkstate status of the item at the given [param index].
Enables/disables the item at the given [param index]. When it is disabled, it can't be selected and its action can't be invoked.
Replaces the [Texture2D] icon of the item at the given [param index].
Sets the maximum allowed width of the icon for the item at the given [param index]. This limit is applied on top of the default size of the icon and on top of [theme_item icon_max_width]. The height is adjusted according to the icon's ratio.
Sets a modulating [Color] of the item's icon at the given [param index].
Sets the [param id] of the item at the given [param index]. The [param id] is used in [signal id_pressed] and [signal id_focused] signals.
Sets the horizontal offset of the item at the given [param index].
Sets the language code of the text for the item at the given index to [param language]. This is used for line-breaking and text shaping algorithms. If [param language] is empty, the current locale is used.
Sets the metadata of an item, which may be of any type. You can later get it with [method get_item_metadata], which provides a simple way of assigning context data to items.
Sets the state of a multistate item. See [method add_multistate_item] for details.
Sets the max states of a multistate item. See [method add_multistate_item] for details.
Sets a [Shortcut] for the item at the given [param index].
Disables the [Shortcut] of the item at the given [param index].
Sets the submenu of the item at the given [param index]. The submenu is the name of a child [PopupMenu] node that would be shown when the item is clicked.
Sets the submenu of the item at the given [param 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 [param submenu] popup has another parent, this method will fail.
Sets the text of the item at the given [param index].
Sets item's text base writing direction.
Sets the [String] tooltip of the item at the given [param index].
Toggles the check state of the item at the given [param index].
Cycle to the next state of a multistate item. See [method add_multistate_item] for details.
- If [code]true[/code], allows navigating [PopupMenu] with letter keys.
- If [code]true[/code], hides the [PopupMenu] when a checkbox or radio button is selected.
- If [code]true[/code], hides the [PopupMenu] when an item is selected.
- If [code]true[/code], hides the [PopupMenu] when a state item is selected.
- The number of items currently in the list.
- If [code]true[/code], [MenuBar] will use native menu when supported. [b]Note:[/b] If [PopupMenu] is linked to [StatusIndicator], [MenuBar], or another [PopupMenu] item it can use native menu regardless of this property, use [method is_native_menu] to check it.
- 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. [b]Note:[/b] If the mouse is exiting a submenu item with an open submenu and enters a different submenu item, the submenu popup delay time is affected by the direction of the mouse movement toward the open submenu. If the mouse is moving toward the submenu, the open submenu will wait approximately [code]0.5[/code] seconds before closing, which then allows the hovered submenu item to open. This additional delay allows the mouse time to move to the open submenu across other menu items without prematurely closing. If the mouse is not moving toward the open submenu, for example in a downward direction, the open submenu will close immediately.
- If set to one of the values of [enum NativeMenu.SystemMenus], this [PopupMenu] is bound to the special system menu. Only one [PopupMenu] can be bound to each special menu at a time.
Emitted when the user navigated to an item of some [param id] using the [member ProjectSettings.input/ui_up] or [member ProjectSettings.input/ui_down] input action.
Emitted when an item of some [param id] is pressed or its accelerator is activated. [b]Note:[/b] If [param id] is negative (either explicitly or due to overflow), this will return the corresponding index instead.
Emitted when an item of some [param index] is pressed or its accelerator is activated.
Emitted when any item is added, modified or removed.
The text [Color] used for shortcuts and accelerators that show next to the menu item name when defined. See [method get_item_accelerator] for more info on accelerators.
The default text [Color] for menu items' names.
[Color] used for disabled menu items' text.
[Color] used for the hovered text.
The tint of text outline of the menu item.
[Color] used for labeled separators' text. See [method add_separator].
The tint of text outline of the labeled separator.
If not [code]0[/code], the icon gutter will be merged with the checkbox gutter when possible. This acts as a boolean.
The horizontal space between the item's elements.
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 [method set_item_icon_max_width]. The height is adjusted according to the icon's ratio.
Width of the single indentation level.
Horizontal padding to the right of the items (or left, in RTL layout).
Horizontal padding to the left of the items (or right, in RTL layout).
The size of the item text outline. [b]Note:[/b] If using a font with [member FontFile.multichannel_signed_distance_field] enabled, its [member FontFile.msdf_pixel_range] must be set to at least [i]twice[/i] the value of [theme_item outline_size] for outline rendering to look correct. Otherwise, the outline may appear to be cut off earlier than intended.
The size of the labeled separator text outline.
The vertical space between each menu item.
[Font] used for the menu items.
[Font] used for the labeled separator.
Font size of the labeled separator.
Font size of the menu items.
[Texture2D] icon for the checked checkbox items.
[Texture2D] icon for the checked checkbox items when they are disabled.
[Texture2D] icon for the checked radio button items.
[Texture2D] icon for the checked radio button items when they are disabled.
[Texture2D] icon for the unchecked radio button items.
[Texture2D] icon for the unchecked radio button items when they are disabled.
[Texture2D] icon for the submenu arrow (for left-to-right layouts).
[Texture2D] icon for the submenu arrow (for right-to-left layouts).
[Texture2D] icon for the unchecked checkbox items.
[Texture2D] icon for the unchecked checkbox items when they are disabled.
[StyleBox] displayed when the [PopupMenu] item is hovered.
[StyleBox] for the left side of labeled separator. See [method add_separator].
[StyleBox] for the right side of labeled separator. See [method add_separator].
[StyleBox] for the background panel.
[StyleBox] used for the separators. See [method add_separator].