GFCapabilityQuery¶
API Reference / Capability / 类索引
- 路径：
addons/gf/extensions/capability/core/gf_capability_query.gd - 模块：
Capability - 继承：
Resource - API：
public - 类别：资源定义 (
resource_definition) - 首次版本：
6.0.0
可资源化的能力接收者查询条件。 用于把 required / rejected 能力类型、分组和子类匹配策略保存为 Resource， 便于编辑器工具、配置资源或项目脚本复用同一套查询声明。
成员概览¶
| 类型 | 名称 | 签名 |
|---|---|---|
| 属性 | required_capability_types |
var required_capability_types: Array[Script] = [] |
| 属性 | rejected_capability_types |
var rejected_capability_types: Array[Script] = [] |
| 属性 | include_subclasses |
var include_subclasses: bool = true |
| 属性 | group_name |
var group_name: StringName = &"" |
| 属性 | metadata |
var metadata: Dictionary = {} |
| 方法 | get_receivers |
func get_receivers(capability_utility: GFCapabilityUtility) -> Array[Object]: |
| 方法 | matches_receiver |
func matches_receiver(capability_utility: GFCapabilityUtility, receiver: Object) -> bool: |
| 方法 | duplicate_query |
func duplicate_query() -> GFCapabilityQuery: |
| 方法 | describe_query |
func describe_query() -> Dictionary: |
属性¶
required_capability_types¶
- API：
public - 首次版本：
6.0.0
查询必须拥有的能力类型列表。
结构：
required_capability_types: Array[Script]，元素为必须拥有的能力脚本类型。
rejected_capability_types¶
- API：
public - 首次版本：
6.0.0
查询必须排除的能力类型列表。
结构：
rejected_capability_types: Array[Script]，元素为必须排除的能力脚本类型。
include_subclasses¶
- API：
public - 首次版本：
6.0.0
是否在 required / rejected 匹配中包含子类能力。
group_name¶
- API：
public - 首次版本：
6.0.0
可选能力分组；非空时只在该分组内查询。
metadata¶
- API：
public - 首次版本：
6.0.0
项目或工具自定义元数据。框架不解释该字段。
结构：
metadata: Dictionary，保存项目或工具附加信息。
方法¶
get_receivers¶
- API：
public - 首次版本：
6.0.0
使用指定 Utility 执行当前查询。
参数：
| 名称 | 说明 |
|---|---|
capability_utility |
能力 Utility。 |
返回：当前仍有效且满足条件的 receiver 列表。
结构：
return: Array[Object]，元素为当前仍有效的能力接收对象。
matches_receiver¶
- API：
public - 首次版本：
6.0.0
判断指定 receiver 是否满足当前查询。
参数：
| 名称 | 说明 |
|---|---|
capability_utility |
能力 Utility。 |
receiver |
要检查的能力接收对象。 |
返回：满足查询返回 true。
duplicate_query¶
- API：
public - 首次版本：
6.0.0
创建同内容查询拷贝。
返回：新查询资源。
describe_query¶
- API：
public - 首次版本：
6.0.0
导出查询声明摘要。
返回：查询声明字典。
结构：
return: Dictionary，包含 required_capability_types、rejected_capability_types、include_subclasses、group_name 和 metadata。