Table of Contents

Class MenuButton

Namespace
Godot
Assembly
GodotSharp.dll

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.

public class MenuButton : Button, IDisposable
Inheritance
MenuButton
Implements
Inherited Members

Constructors

MenuButton() 

public MenuButton()

Properties

ItemCount

The number of items currently in the list.

public int ItemCount { get; set; }

Property Value

int

SwitchOnHover

If true, when the cursor hovers above another MenuButton within the same parent which also has SwitchOnHover enabled, it will close the current MenuButton and open the other one.

public bool SwitchOnHover { get; set; }

Property Value

bool

Methods

GetPopup()

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 Visible property.

public PopupMenu GetPopup()

Returns

PopupMenu

HasGodotClassMethod(in godot_string_name)

Check if the type contains a method with the given name. This method is used by Godot to check if a method exists before invoking it. Do not call or override this method.

protected override bool HasGodotClassMethod(in godot_string_name method)

Parameters

method godot_string_name

Name of the method to check for.

Returns

bool

HasGodotClassSignal(in godot_string_name)

Check if the type contains a signal with the given name. This method is used by Godot to check if a signal exists before raising it. Do not call or override this method.

protected override bool HasGodotClassSignal(in godot_string_name signal)

Parameters

signal godot_string_name

Name of the signal to check for.

Returns

bool

InvokeGodotClassMethod(in godot_string_name, NativeVariantPtrArgs, out godot_variant)

Invokes the method with the given name, using the given arguments. This method is used by Godot to invoke methods from the engine side. Do not call or override this method.

protected override bool InvokeGodotClassMethod(in godot_string_name method, NativeVariantPtrArgs args, out godot_variant ret)

Parameters

method godot_string_name

Name of the method to invoke.

args NativeVariantPtrArgs

Arguments to use with the invoked method.

ret godot_variant

Value returned by the invoked method.

Returns

bool

SetDisableShortcuts(bool)

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

public void SetDisableShortcuts(bool disabled)

Parameters

disabled bool

ShowPopup()

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

public void ShowPopup()

Events

AboutToPopup

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

public event Action AboutToPopup

Event Type

Action
Edit this page