Inheritance #

MenuButton
Table of contents

MenuButton #

is_instantiable, Node, core, not_builtin_classes

A button that brings up a PopupMenu when clicked.

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 Godot editor's inspector.

See also BaseButton which contains common properties and methods associated with this node.

Members #

var action_mode = ACTION_MODE_BUTTON_PRESS#

var flat: bool = true#

var focus_mode = FOCUS_NONE#

var item_count: int = 0#

The number of items currently in the list.

var switch_on_hover: bool = false#

If 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.

var toggle_mode: bool = true#

Methods #

const func get_popup() -> PopupMenu#

Returns 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.

func set_disable_shortcuts(disabled: bool) -> void#

If true, shortcuts are disabled and cannot be used to trigger the button.

func show_popup() -> void#

Adjusts popup position and sizing for the MenuButton, then shows the PopupMenu. Prefer this over using get_popup().popup().

Annotations #

Constants #

Constructors #

Enums #

Operators #

Signals #

signal about_to_popup()#

Emitted when the PopupMenu of this MenuButton is about to show.

Theme Items #

Tutorials #