GFModalConfig¶
API Reference / Standard / 类索引
- 路径：
addons/gf/standard/utilities/ui/gf_modal_config.gd - 模块：
Standard - 继承：
Resource - API：
public - 类别：资源定义 (
resource_definition) - 首次版本：
3.17.0
通用 modal 配置。 用 Resource 描述标题、正文、动作和交互策略，使项目自定义 modal 面板 可以共享同一套打开与结果协议。
成员概览¶
| 类型 | 名称 | 签名 |
|---|---|---|
| 属性 | title |
var title: String = "" |
| 属性 | message |
var message: String = "" |
| 属性 | actions |
var actions: Array[GFModalAction] = [] |
| 属性 | dismiss_on_backdrop |
var dismiss_on_backdrop: bool = false |
| 属性 | dismiss_on_cancel |
var dismiss_on_cancel: bool = true |
| 属性 | auto_focus |
var auto_focus: bool = true |
| 属性 | restore_focus_on_close |
var restore_focus_on_close: bool = true |
| 属性 | metadata |
var metadata: Dictionary = {} |
| 方法 | get_actions |
func get_actions() -> Array[GFModalAction]: |
| 方法 | get_action |
func get_action(action_id: StringName) -> GFModalAction: |
| 方法 | duplicate_config |
func duplicate_config() -> GFModalConfig: |
属性¶
title¶
- API：
public
标题文本。
message¶
- API：
public
正文文本。
actions¶
- API：
public
动作列表。为空时不生成默认动作；项目应显式声明可渲染动作。
结构：
actions: Array[GFModalAction]，modal 可渲染的动作声明列表。
dismiss_on_backdrop¶
- API：
public
点击背景是否按取消处理。
dismiss_on_cancel¶
- API：
public
取消请求是否关闭 modal。
auto_focus¶
- API：
public
打开时是否自动聚焦动作按钮。
restore_focus_on_close¶
- API：
public
关闭后是否恢复打开前焦点。
metadata¶
- API：
public
可选元数据，供项目层或自定义面板解释。
结构：
metadata: Dictionary，项目层或自定义 modal 面板解释的配置元数据。
方法¶
get_actions¶
- API：
public
获取可用动作列表。
返回：动作列表副本。
get_action¶
- API：
public
查找指定动作。
参数：
| 名称 | 说明 |
|---|---|
action_id |
动作 ID。 |
返回：找到时返回动作副本，否则返回 null。
duplicate_config¶
- API：
public
创建同内容拷贝。
返回：新配置。