Class reference
MenuButton
Inherits Button
A button that brings up a PopupMenu when clicked.
Description
A button that brings up a PopupMenu when clicked. To create new items inside this PopupMenu, use get_popup().add_item("My Item Name"). You can also create them directly from Redot editor's inspector. See also BaseButton which contains common properties and methods associated with this node.
Properties
int action_mode = 0
int action_mode = 0bool flat = true
bool flat = trueint focus_mode = 3
int focus_mode = 3int item_count = 0
int item_count = 0The number of items currently in the list.
bool switch_on_hover = false
bool switch_on_hover = falseIf true, when the cursor hovers above another MenuButton within the same parent which also has switch_on_hover enabled, it will close the current MenuButton and open the other one.
bool toggle_mode = true
bool toggle_mode = trueMethods
PopupMenu get_popup() const
PopupMenu get_popup() constReturns 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.
void set_disable_shortcuts(bool disabled)
bool disabled)If true, shortcuts are disabled and cannot be used to trigger the button.
void show_popup()
Adjusts popup position and sizing for the MenuButton, then shows the PopupMenu. Prefer this over using get_popup().popup().
Signals
about_to_popup()
Emitted when the PopupMenu of this MenuButton is about to show.