【Godot4.2】菜单相关控件和节点完全解析

概述

在开发Godot插件或应用程序时，可能会遇到构建菜单栏或弹出菜单的情况。本文阐述Godot4.2所以供的相关控件和节点。以及构造菜单栏的方法。

菜单栏和弹出菜单构造，一般涉及MenuBar、PopupMenu和MenuButton三个节点和控件类型。

关系类图

简化的关系类图如下：

构造菜单栏

菜单栏通常放置在应用程序或插件界面的最顶部，通常是多个菜单的水平排布。它提供各种下拉菜单和选项，甚至会提供子菜单。

在Godot中，构造菜单栏的标准方式应该是使用MenuBar和PopupMenu的组合。

使用MenuBar和PopupMenu（推荐）

通过在MenuBar控件下添加PopupMenu节点，可以构造水平排列的菜单栏。其逻辑是：

• 添加到MenuBar的PopupMenu节点，会自动水平排列（类似于 HBoxContainer 的效果）。
• PopupMenu隐藏，而自动将其创建为可以点击的MenuButton形式,MenuButton的文本将与PopupMenu节点的名称一致
  

使用HBoxContainer和MenuButton（不推荐）

MenuBar不是必需品，通过为HBoxContainer添加MenuButton，可以获得类似的效果，而且可以添加其他控件，更加灵活，当然，这更适合创建带有一部分菜单项的工具栏。

• MenuButton = Button + PopupMenu，默认显示Button，隐藏PopupMenu，点击Button时显示PopupMenu
• Button用于代表一个菜单，PopupMenu代表菜单项列表
• 通过get_popup()方法，可以获取MenuButton的PopupMenu

关于PopupMenu

可以看到MenuBar和MenuButton本身都不提供菜单的功能。菜单功能是由PopupMenu实现的。

PopupMenu的逻辑是：

• 可以添加若干菜单项，并响应和处理菜单项的点击
• PopupMenu并没有提供抽象的PopupMenuItem类，而是使用一堆方法来添加、获取和设置菜单项
• PopupMenu可以通过设定另一个PopupMenu作为其指定菜单项的子菜单，嵌套结构可以一直持续下去
  

思考
可以看到：

• 菜单项的树形嵌套结构是发生在PopupMenu上的，这种树形结构可以利用类似ETD的简易数据形式描述和动态生成
• 因此在构造基于MenuBar和PopupMenu的水平菜单栏时，可以在MenuBar上挂载一个Array[PackedStringArray]类型的导出变量data来设定多个菜单的类ETD字符串数据。从而动态生成树形结构的菜单项
• MenuButton或PopupMenu则简单的多，直接设定一个data属性，接收类ETD字符串数据，动态生成树形结构的菜单项

也就是基于ETD构造三种自定义节点和控件：ETDMenuBar、ETDMenuButton和ETDPopupMenu。

—— 2024年9月20日01:37:43

为PopupMenu菜单项添加子菜单

• 本质是为PopupMenu添加子PopupMenu
• 然后通过set_item_submenu_node()方法为其某个菜单项指定该子PopupMenu节点

比如下面的结构：

• 我们为MenuBar的第一个PopupMenu添加一个子PopupMenu，并更名为“SubPopupMenu”。
  

• 为“PopupMenu”节点手动添加两个菜单项，文本分别设为“菜单项1”和“菜单项2”。

• 为“SubPopupMenu”节点添加两个菜单项，文本分别设为“子菜单项1”和“子菜单项2”。

• 然后我们为“MenuBar”节点添加如下代码：

extends MenuBar

@onready var popup_menu = $PopupMenu
@onready var sub_popup_menu = $PopupMenu/SubPopupMenu

func _ready():
	# 将SubPopupMenu指定为PopupMenu第一个菜单项的子菜单
	popup_menu.set_item_submenu(0,sub_popup_menu)

• 我们通过set_item_submenu_node()方法为“PopupMenu”节点的第一个菜单项添加了子菜单“SubPopupMenu”。

运行后就可以看到，“PopupMenu”的第一个菜单项可以正确显示和弹出“SubPopupMenu”。

• 对于子菜单的菜单项的子菜单，是类似的道理，需要子PopupMenu下再添加子PopupMenu。
  这种结构理论上可以无限下去，从而创建十分复杂的菜单。