GFConfigTableReference¶
API Reference / Standard / 类索引
- 路径：
addons/gf/standard/utilities/config/gf_config_table_reference.gd - 模块：
Standard - 继承：
Resource - API：
public - 类别：资源定义 (
resource_definition) - 首次版本：
3.17.0
导表跨表引用声明。 描述当前记录的一组字段如何指向另一张表的一组字段。
成员概览¶
| 类型 | 名称 | 签名 |
|---|---|---|
| 属性 | reference_id |
var reference_id: StringName = &"" |
| 属性 | source_fields |
var source_fields: PackedStringArray = PackedStringArray() |
| 属性 | target_table_name |
var target_table_name: StringName = &"" |
| 属性 | target_fields |
var target_fields: PackedStringArray = PackedStringArray() |
| 属性 | required |
var required: bool = true |
| 属性 | allow_null_values |
var allow_null_values: bool = true |
| 属性 | metadata |
var metadata: Dictionary = {} |
| 方法 | get_reference_id |
func get_reference_id() -> StringName: |
| 方法 | is_valid_definition |
func is_valid_definition() -> bool: |
| 方法 | get_target_fields |
func get_target_fields(target_schema: GFConfigTableSchema = null) -> PackedStringArray: |
| 方法 | make_source_key |
func make_source_key(record: Dictionary) -> String: |
| 方法 | make_target_key |
func make_target_key(record: Dictionary, target_schema: GFConfigTableSchema = null) -> String: |
| 方法 | duplicate_reference |
func duplicate_reference() -> GFConfigTableReference: |
| 方法 | describe |
func describe() -> Dictionary: |
属性¶
reference_id¶
- API：
public
引用稳定标识。为空时会根据来源字段和目标表生成。
source_fields¶
- API：
public
当前表中参与引用的字段名。
target_table_name¶
- API：
public
目标表名。
target_fields¶
- API：
public
目标表中参与匹配的字段名。为空时由目标 schema 的 id_field 补齐。
required¶
- API：
public
为 true 时，非空引用必须能在目标表中找到。
allow_null_values¶
- API：
public
是否允许来源字段值为 null。
metadata¶
- API：
public
可选元数据，供导入器、编辑器或项目层扩展使用。
结构：
metadata: Dictionary，保存导入器、编辑器或项目层附加到当前引用的元数据。
方法¶
get_reference_id¶
- API：
public
获取稳定引用标识。
返回：引用标识。
is_valid_definition¶
- API：
public
检查引用声明是否有效。
返回：有效返回 true。
get_target_fields¶
- API：
public
获取目标字段名。
参数：
| 名称 | 说明 |
|---|---|
target_schema |
可选目标 schema。 |
返回：目标字段列表。
make_source_key¶
- API：
public
根据来源记录构建引用键。
参数：
| 名称 | 说明 |
|---|---|
record |
来源记录。 |
返回：引用键；字段缺失或 null 不允许时返回空字符串。
结构：
record: Dictionary，用于构建引用键的来源配置记录。
make_target_key¶
- API：
public
根据目标记录构建引用键。
参数：
| 名称 | 说明 |
|---|---|
record |
目标记录。 |
target_schema |
可选目标 schema。 |
返回：引用键；字段缺失或 null 不允许时返回空字符串。
结构：
record: Dictionary，用于构建引用键的目标配置记录。
duplicate_reference¶
- API：
public
创建同内容拷贝。
返回：新引用声明。
describe¶
- API：
public
导出引用声明摘要。
返回：引用声明字典。
结构：
return: Dictionary，包含 reference_id、source_fields、target_table_name、target_fields、required、allow_null_values 和 metadata。