MenuButton

    Special button that brings up a PopupMenu when clicked.

    Special button that brings up a PopupMenu when clicked.

    New items can be created inside this using . You can also create them directly from the editor. To do so, select the MenuButton node, then in the toolbar at the top of the 2D editor, click Items then click Add in the popup. You will be able to give each item new properties.

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

    Properties

    get_popup ( ) const

    void

    ( bool disabled )

    Theme Properties

    Color

    Color( 0.88, 0.88, 0.88, 1 )

    Color

    Color

    Color( 0.94, 0.94, 0.94, 1 )

    Color

    Color( 0.94, 0.94, 0.94, 1 )

    Color

    Color( 1, 1, 1, 1 )

    int

    Font

    StyleBox

    StyleBox

    StyleBox

    StyleBox

    StyleBox

    • about_to_show ( )

    Emitted when of this MenuButton is about to show.

    Property Descriptions

    • switch_on_hover

    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.

    • get_popup ( ) const

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

    • void set_disable_shortcuts ( bool disabled )

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

    Theme Property Descriptions

    Default

    Color( 0.88, 0.88, 0.88, 1 )

    Default text of the MenuButton.

    • Color font_color_disabled

    Default

    Color( 1, 1, 1, 0.3 )

    Text used when the MenuButton is disabled.

    Text used when the is focused. Only replaces the normal text color of the button. Disabled, hovered, and pressed states take precedence over this color.

    Default

    Color( 0.94, 0.94, 0.94, 1 )

    Text Color used when the MenuButton is being hovered.

    • font_color_pressed

    Default

    Color( 1, 1, 1, 1 )

    Text Color used when the MenuButton is being pressed.

    • hseparation

    The horizontal space between MenuButton‘s icon and text.

    of the MenuButton‘s text.

    used when the MenuButton is disabled.

    used when the MenuButton is focused. It is displayed over the current StyleBox, so using will just disable the focus visual effect.

    used when the MenuButton is being hovered.

    used when the is being pressed.