Signal support.
class Signal3Use the connect(flags:_:) method to connect to the signal on the container object, and disconnect(_:) to drop the connection.
You can also await the emitted property for waiting for a single emission of the signal.
import SwiftGodotFramework to write Godot Game Extensions using the Swift Programming Language.
class PopupMenuA modal window used to display a list of options.
@discardableResult func connect(flags: Object.ConnectFlags = [], _ callback: @escaping (_ index: Int64) -> ()) -> Object Connects the signal to the specified callback
func disconnect(_ token: Object) Disconnects a signal that was previously connected, the return value from calling connect(flags:_:)
var emitted: Void { get async }You can await this property to wait for the signal to be emitted once
override class var godotClassName: StringName { get }final var allowSearch: Bool { get set }If true, allows navigating PopupMenu with letter keys.
final var hideOnCheckableItemSelection: Bool { get set }If true, hides the PopupMenu when a checkbox or radio button is selected.
final var hideOnItemSelection: Bool { get set }If true, hides the PopupMenu when an item is selected.
final var hideOnStateItemSelection: Bool { get set }If true, hides the PopupMenu when a state item is selected.
var idFocused: Signal2 { get }Emitted when the user navigated to an item of some id using the ProjectSettings/input/uiUp or ProjectSettings/input/uiDown input action.
var idPressed: Signal1 { get }Emitted when an item of some id is pressed or its accelerator is activated.
var indexPressed: Signal3 { get }Emitted when an item of some index is pressed or its accelerator is activated.
final var itemCount: Int32 { get set }The number of items currently in the list.
var menuChanged: SimpleSignal { get }Emitted when any item is added, modified or removed.
final var preferNativeMenu: Bool { get set }If true, MenuBar will use native menu when supported.
final var submenuPopupDelay: Double { get set }Sets the delay time in seconds for the submenu item to popup on mouse hovering. If the popup menu is added as a child of another (acting as a submenu), it will inherit the delay time of the parent menu item.
final var systemMenuId: NativeMenu.SystemMenus { get set }If set to one of the values of NativeMenu.SystemMenus, this PopupMenu is bound to the special system menu. Only one PopupMenu can be bound to each special menu at a time.
final func activateItemByEvent(_ event: InputEvent?, forGlobalOnly: Bool = false) -> Bool Checks the provided event against the PopupMenu’s shortcuts and accelerators, and activates the first item with matching events. If forGlobalOnly is true, only shortcuts and accelerators with global set to true will be called.
final func addCheckItem(label: String, id: Int32 = -1, accel: Key = .none) Adds a new checkable item with text label.
final func addCheckShortcut(_ shortcut: Shortcut?, id: Int32 = -1, global: Bool = false) Adds a new checkable item and assigns the specified Shortcut to it. Sets the label of the checkbox to the Shortcut’s name.
final func addIconCheckItem(texture: Texture2D?, label: String, id: Int32 = -1, accel: Key = .none) Adds a new checkable item with text label and icon texture.
final func addIconCheckShortcut(texture: Texture2D?, shortcut: Shortcut?, id: Int32 = -1, global: Bool = false) Adds a new checkable item and assigns the specified Shortcut and icon texture to it. Sets the label of the checkbox to the Shortcut’s name.
final func addIconItem(texture: Texture2D?, label: String, id: Int32 = -1, accel: Key = .none) Adds a new item with text label and icon texture.
final func addIconRadioCheckItem(texture: Texture2D?, label: String, id: Int32 = -1, accel: Key = .none) Same as addIconCheckItem(texture:label:id:accel:), but uses a radio check button.
final func addIconRadioCheckShortcut(texture: Texture2D?, shortcut: Shortcut?, id: Int32 = -1, global: Bool = false) Same as addIconCheckShortcut(texture:shortcut:id:global:), but uses a radio check button.
final func addIconShortcut(texture: Texture2D?, shortcut: Shortcut?, id: Int32 = -1, global: Bool = false, allowEcho: Bool = false) Adds a new item and assigns the specified Shortcut and icon texture to it. Sets the label of the checkbox to the Shortcut’s name.
final func addItem(label: String, id: Int32 = -1, accel: Key = .none) Adds a new item with text label.
final func addMultistateItem(label: String, maxStates: Int32, defaultState: Int32 = 0, id: Int32 = -1, accel: Key = .none) Adds a new multistate item with text label.
final func addRadioCheckItem(label: String, id: Int32 = -1, accel: Key = .none) Adds a new radio check button with text label.
final func addRadioCheckShortcut(_ shortcut: Shortcut?, id: Int32 = -1, global: Bool = false) Adds a new radio check button and assigns a Shortcut to it. Sets the label of the checkbox to the Shortcut’s name.
final func addSeparator(label: String = "", id: Int32 = -1) Adds a separator between items. Separators also occupy an index, which you can set by using the id parameter.
final func addShortcut(_ shortcut: Shortcut?, id: Int32 = -1, global: Bool = false, allowEcho: Bool = false) Adds a Shortcut.
final func addSubmenuItem(label: String, submenu: String, id: Int32 = -1) Adds an item that will act as a submenu of the parent PopupMenu node when clicked. The submenu argument must be the name of an existing PopupMenu that has been added as a child to this node. This submenu will be shown when the item is clicked, hovered for long enough, or activated using the ui_select or ui_right input actions.
final func addSubmenuNodeItem(label: String, submenu: PopupMenu?, id: Int32 = -1) Adds an item that will act as a submenu of the parent PopupMenu node when clicked. This submenu will be shown when the item is clicked, hovered for long enough, or activated using the ui_select or ui_right input actions.
final func clear(freeSubmenus: Bool = false) Removes all items from the PopupMenu. If freeSubmenus is true, the submenu nodes are automatically freed.
final func getFocusedItem() -> Int32 Returns the index of the currently focused item. Returns -1 if no item is focused.
final func getItemAccelerator(index: Int32) -> Key Returns the accelerator of the item at the given index. An accelerator is a keyboard shortcut that can be pressed to trigger the menu button even if it’s not currently open. The return value is an integer which is generally a combination of KeyModifierMasks and Keys using bitwise OR such as KEY_MASK_CTRL | KEY_A ([kbd]Ctrl + A[/kbd]). If no accelerator is defined for the specified index, getItemAccelerator(index:) returns 0 (corresponding to @GlobalScope.KEY_NONE).
final func getItemIcon(index: Int32) -> Texture2D? Returns the icon of the item at the given index.
final func getItemIconMaxWidth(index: Int32) -> Int32 Returns the maximum allowed width of the icon for the item at the given index.
final func getItemIconModulate(index: Int32) -> Color Returns a Color modulating the item’s icon at the given index.
final func getItemId(index: Int32) -> Int32 Returns the ID of the item at the given index. id can be manually assigned, while index can not.
final func getItemIndent(index: Int32) -> Int32 Returns the horizontal offset of the item at the given index.
final func getItemIndex(id: Int32) -> Int32 Returns the index of the item containing the specified id. Index is automatically assigned to each item by the engine and can not be set manually.
final func getItemLanguage(index: Int32) -> String Returns item’s text language code.
final func getItemMetadata(index: Int32) -> Variant Returns the metadata of the specified item, which might be of any type. You can set it with setItemMetadata(index:metadata:), which provides a simple way of assigning context data to items.
final func getItemMultistate(index: Int32) -> Int32 Returns the state of the item at the given index.
final func getItemMultistateMax(index: Int32) -> Int32 Returns the max states of the item at the given index.
final func getItemShortcut(index: Int32) -> Shortcut? Returns the Shortcut associated with the item at the given index.
final func getItemSubmenu(index: Int32) -> String Returns the submenu name of the item at the given index. See addSubmenuItem(label:submenu:id:) for more info on how to add a submenu.
final func getItemSubmenuNode(index: Int32) -> PopupMenu? Returns the submenu of the item at the given index, or null if no submenu was added. See addSubmenuNodeItem(label:submenu:id:) for more info on how to add a submenu.
final func getItemText(index: Int32) -> String Returns the text of the item at the given index.
final func getItemTextDirection(index: Int32) -> Control.TextDirection Returns item’s text base writing direction.
final func getItemTooltip(index: Int32) -> String Returns the tooltip associated with the item at the given index.
final func isItemCheckable(index: Int32) -> Bool Returns true if the item at the given index is checkable in some way, i.e. if it has a checkbox or radio button.
final func isItemChecked(index: Int32) -> Bool Returns true if the item at the given index is checked.
final func isItemDisabled(index: Int32) -> Bool Returns true if the item at the given index is disabled. When it is disabled it can’t be selected, or its action invoked.
final func isItemRadioCheckable(index: Int32) -> Bool Returns true if the item at the given index has radio button-style checkability.
final func isItemSeparator(index: Int32) -> Bool Returns true if the item is a separator. If it is, it will be displayed as a line. See addSeparator(label:id:) for more info on how to add a separator.
final func isItemShortcutDisabled(index: Int32) -> Bool Returns true if the specified item’s shortcut is disabled.
final func isSystemMenu() -> Bool Returns true if the menu is bound to the special system menu.
final func removeItem(index: Int32) Removes the item at the given index from the menu.
final func scrollToItem(index: Int32) Moves the scroll view to make the item at the given index visible.
final func setFocusedItem(index: Int32) Sets the currently focused item as the given index.
final func setItemAccelerator(index: Int32, accel: Key) Sets the accelerator of the item at the given index. An accelerator is a keyboard shortcut that can be pressed to trigger the menu button even if it’s not currently open. accel is generally a combination of KeyModifierMasks and Keys using bitwise OR such as KEY_MASK_CTRL | KEY_A ([kbd]Ctrl + A[/kbd]).
final func setItemAsCheckable(index: Int32, enable: Bool) Sets whether the item at the given index has a checkbox. If false, sets the type of the item to plain text.
final func setItemAsRadioCheckable(index: Int32, enable: Bool) Sets the type of the item at the given index to radio button. If false, sets the type of the item to plain text.
final func setItemAsSeparator(index: Int32, enable: Bool) Mark the item at the given index as a separator, which means that it would be displayed as a line. If false, sets the type of the item to plain text.
final func setItemChecked(index: Int32, checked: Bool) Sets the checkstate status of the item at the given index.
final func setItemDisabled(index: Int32, disabled: Bool) Enables/disables the item at the given index. When it is disabled, it can’t be selected and its action can’t be invoked.
final func setItemIcon(index: Int32, icon: Texture2D?) Replaces the Texture2D icon of the item at the given index.
final func setItemIconMaxWidth(index: Int32, width: Int32) Sets the maximum allowed width of the icon for the item at the given index. This limit is applied on top of the default size of the icon and on top of [theme_item icon_max_width]. The height is adjusted according to the icon’s ratio.
final func setItemIconModulate(index: Int32, modulate: Color) Sets a modulating Color of the item’s icon at the given index.
final func setItemId(index: Int32, id: Int32) Sets the id of the item at the given index.
final func setItemIndent(index: Int32, indent: Int32) Sets the horizontal offset of the item at the given index.
final func setItemLanguage(index: Int32, language: String) Sets language code of item’s text used for line-breaking and text shaping algorithms, if left empty current locale is used instead.
final func setItemMetadata(index: Int32, metadata: Variant) Sets the metadata of an item, which may be of any type. You can later get it with getItemMetadata(index:), which provides a simple way of assigning context data to items.
final func setItemMultistate(index: Int32, state: Int32) Sets the state of a multistate item. See addMultistateItem(label:maxStates:defaultState:id:accel:) for details.
final func setItemMultistateMax(index: Int32, maxStates: Int32) Sets the max states of a multistate item. See addMultistateItem(label:maxStates:defaultState:id:accel:) for details.
final func setItemShortcut(index: Int32, shortcut: Shortcut?, global: Bool = false) Sets a Shortcut for the item at the given index.
final func setItemShortcutDisabled(index: Int32, disabled: Bool) Disables the Shortcut of the item at the given index.
final func setItemSubmenu(index: Int32, submenu: String) Sets the submenu of the item at the given index. The submenu is the name of a child PopupMenu node that would be shown when the item is clicked.
final func setItemSubmenuNode(index: Int32, submenu: PopupMenu?) Sets the submenu of the item at the given index. The submenu is a PopupMenu node that would be shown when the item is clicked. It must either be a child of this PopupMenu or has no parent (in which case it will be automatically added as a child). If the submenu popup has another parent, this method will fail.
final func setItemText(index: Int32, text: String) Sets the text of the item at the given index.
final func setItemTextDirection(index: Int32, direction: Control.TextDirection) Sets item’s text base writing direction.
final func setItemTooltip(index: Int32, tooltip: String) Sets the String tooltip of the item at the given index.
final func toggleItemChecked(index: Int32) Toggles the check state of the item at the given index.
final func toggleItemMultistate(index: Int32) Cycle to the next state of a multistate item. See addMultistateItem(label:maxStates:defaultState:id:accel:) for details.
class Signal1Signal support.
class Signal2Signal support.