GFConfigTableIndexDefinition¶
API Reference / Standard / 类索引
- 路径：
addons/gf/standard/utilities/config/gf_config_table_index_definition.gd - 模块：
Standard - 继承：
Resource - API：
public - 类别：资源定义 (
resource_definition) - 首次版本：
3.17.0
导表索引声明。 描述一组字段如何组成查询键或唯一键，不绑定任何具体业务表。
成员概览¶
| 类型 | 名称 | 签名 |
|---|---|---|
| 属性 | index_id |
var index_id: StringName = &"" |
| 属性 | field_names |
var field_names: PackedStringArray = PackedStringArray() |
| 属性 | unique |
var unique: bool = false |
| 属性 | allow_null_values |
var allow_null_values: bool = true |
| 属性 | metadata |
var metadata: Dictionary = {} |
| 方法 | get_index_id |
func get_index_id() -> StringName: |
| 方法 | is_valid_definition |
func is_valid_definition() -> bool: |
| 方法 | make_key |
func make_key(record: Dictionary) -> String: |
| 方法 | duplicate_index |
func duplicate_index() -> GFConfigTableIndexDefinition: |
| 方法 | describe |
func describe() -> Dictionary: |
属性¶
index_id¶
- API：
public
索引稳定标识。为空时会根据字段名生成。
field_names¶
- API：
public
参与索引的字段名，顺序会影响复合键。
unique¶
- API：
public
为 true 时校验表数据中该复合键唯一。
allow_null_values¶
- API：
public
是否允许索引键中出现 null 值。
metadata¶
- API：
public
可选元数据，供导入器、编辑器或项目层扩展使用。
结构：
metadata: Dictionary，保存导入器、编辑器或项目层附加到当前索引的元数据。
方法¶
get_index_id¶
- API：
public
获取稳定索引标识。
返回：索引标识。
is_valid_definition¶
- API：
public
检查索引声明是否有效。
返回：有效返回 true。
make_key¶
- API：
public
根据记录构建索引键。
参数：
| 名称 | 说明 |
|---|---|
record |
记录数据。 |
返回：索引键；字段缺失或 null 不允许时返回空字符串。
结构：
record: Dictionary，用于构建索引键的配置记录。
duplicate_index¶
- API：
public
创建同内容拷贝。
返回：新索引声明。
describe¶
- API：
public
导出索引声明摘要。
返回：索引声明字典。
结构：
return: Dictionary，包含 index_id、field_names、unique、allow_null_values 和 metadata。