MenuButton
A button that brings up a PopupMenu
when clicked.
class MenuButton
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.
This object emits the following signals:
Superclasses
class Button
A themed button that can contain text and an icon.
Citizens in SwiftGodot
Conformances
protocol CustomStringConvertible
A type with a customized textual representation.
protocol Equatable
A type that can be compared for value equality.
protocol Hashable
A type that can be hashed into a
Hasher
to produce an integer hash value.protocol Identifiable<ID>
A class of types whose instances hold the value of an entity with stable identity.
protocol VariantRepresentable
Types that conform to VariantRepresentable can be stored directly in
Variant
with no conversion. These include all of the Variant types from Godot (for exampleGString
,Rect
,Plane
), Godot objects (those that subclass SwiftGodot.Object) as well as the built-in Swift types UInt8, Int64 and Double.protocol VariantStorable
Types that conform to VariantStorable can be stored in a Variant and can be extracted back out of a Variant.
Type members
Instance members
var aboutToPopup: SimpleSignal
Emitted when the
PopupMenu
of this MenuButton is about to show.var itemCount: Int32
The number of items currently in the list.
var switchOnHover: Bool
If
true
, when the cursor hovers above anotherMenuButton
within the same parent which also hasswitchOnHover
enabled, it will close the currentMenuButton
and open the other one.func getPopup(
) -> PopupMenu? Returns the
PopupMenu
contained in this button.func setDisableShortcuts(disabled: Bool
) If
true
, shortcuts are disabled and cannot be used to trigger the button.func showPopup(
) Adjusts popup position and sizing for the
MenuButton
, then shows thePopupMenu
. Prefer this over usingget_popup().popup()
.