GFConfigPipelineProfile¶
API Reference / Tool Packages / 类索引
- 路径：
addons/gf/tools/config_pipeline/gf_config_pipeline_profile.gd - 模块：
Tool Packages - 继承：
Resource - API：
public - 类别：工具 API (
tool_api) - 首次版本：
5.2.0
配置导表工具的批量构建声明。 描述一组表来源、数据库标识、输出路径和构建选项，供编辑器工具、CI 或项目脚本复用。 该资源属于可选 tool package，只表达制作期或 CI 期通用导表任务，不规定项目目录结构、业务字段语义或发布流程。
成员概览¶
| 类型 | 名称 | 签名 |
|---|---|---|
| 属性 | profile_id |
var profile_id: StringName = &"" |
| 属性 | database_id |
var database_id: StringName = &"" |
| 属性 | version |
var version: String = "" |
| 属性 | output_path |
var output_path: String = "" |
| 属性 | access_output_path |
var access_output_path: String = "" |
| 属性 | access_class_name |
var access_class_name: String = "GFConfigAccess" |
| 属性 | access_provider_accessor |
var access_provider_accessor: String = "null" |
| 属性 | sources |
var sources: Array[GFConfigPipelineTableSource] = [] |
| 属性 | build_options |
var build_options: Dictionary = {} |
| 属性 | save_options |
var save_options: Dictionary = {} |
| 属性 | access_options |
var access_options: Dictionary = {} |
| 属性 | metadata |
var metadata: Dictionary = {} |
| 方法 | make_build_options |
func make_build_options(overrides: Dictionary = {}) -> Dictionary: |
| 方法 | make_save_options |
func make_save_options(overrides: Dictionary = {}) -> Dictionary: |
| 方法 | make_access_options |
func make_access_options(overrides: Dictionary = {}) -> Dictionary: |
| 方法 | resolve_output_path |
func resolve_output_path(overrides: Dictionary = {}) -> String: |
| 方法 | resolve_access_output_path |
func resolve_access_output_path(overrides: Dictionary = {}) -> String: |
| 方法 | resolve_access_class_name |
func resolve_access_class_name(overrides: Dictionary = {}) -> String: |
| 方法 | resolve_access_provider_accessor |
func resolve_access_provider_accessor(overrides: Dictionary = {}) -> String: |
| 方法 | duplicate_profile |
func duplicate_profile() -> GFConfigPipelineProfile: |
| 方法 | describe |
func describe() -> Dictionary: |
属性¶
profile_id¶
- API：
public - 首次版本：
5.2.0
Profile 稳定标识。
database_id¶
- API：
public - 首次版本：
5.2.0
生成数据库资源的标识。
version¶
- API：
public - 首次版本：
5.2.0
写入数据库资源的版本字符串。
output_path¶
- API：
public - 首次版本：
5.2.0
导出目标路径。通常指向 .tres、.res 或 .json。
access_output_path¶
- API：
public - 首次版本：
5.2.0
可选访问器脚本输出路径。为空时不生成访问器。
access_class_name¶
- API：
public - 首次版本：
5.2.0
可选访问器脚本 class_name。
access_provider_accessor¶
- API：
public - 首次版本：
5.2.0
可选访问器脚本默认 provider 获取表达式。
sources¶
- API：
public - 首次版本：
5.2.0
单表来源列表。
结构：
sources: Array[GFConfigPipelineTableSource]。
build_options¶
- API：
public - 首次版本：
5.2.0
传给 GFConfigPipeline.build_database() 的构建选项。
结构：
build_options: Dictionary，可包含 database_id、version、metadata、validate_database、validate_schema、parse_options 和 rebuild_indexes。
save_options¶
- API：
public - 首次版本：
5.2.0
传给 GFConfigPipeline.save_database() 的保存选项。
结构：
save_options: Dictionary，可包含 output_format、include_schema、include_indexes、indent 和 sort_keys。
access_options¶
- API：
public - 首次版本：
5.2.0
传给 GFConfigAccessGenerator 的访问器生成选项。
结构：
access_options: Dictionary，可包含 method_name_style、constant_prefix、record_method_pattern、table_method_pattern、include_schema_comments、include_typed_records、typed_record_method_pattern、typed_record_class_suffix 和 overwrite_existing。
metadata¶
- API：
public - 首次版本：
5.2.0
附加到生成数据库资源的元数据。
结构：
metadata: Dictionary，保存项目工具、编辑器或 CI 附加的构建信息。
方法¶
make_build_options¶
- API：
public - 首次版本：
5.2.0
合成构建选项。
参数：
| 名称 | 说明 |
|---|---|
overrides |
本次构建的覆盖选项；build_options 子字典和直接字段都会覆盖 Profile 默认值。 |
返回：传给 GFConfigPipeline.build_database() 的选项。
结构：
overrides: Dictionary，可包含 build_options、database_id、version、metadata、validate_database、validate_schema、parse_options 和 rebuild_indexes。return: Dictionary，包含合成后的构建选项。
make_save_options¶
- API：
public - 首次版本：
5.2.0
合成保存选项。
参数：
| 名称 | 说明 |
|---|---|
overrides |
本次导出的覆盖选项。 |
返回：传给 GFConfigPipeline.save_database() 的选项。
结构：
overrides: Dictionary，可包含 save_options。return: Dictionary，包含合成后的保存选项。
make_access_options¶
- API：
public - 首次版本：
5.2.0
合成访问器生成选项。
参数：
| 名称 | 说明 |
|---|---|
overrides |
本次访问器生成的覆盖选项。 |
返回：传给 GFConfigAccessGenerator 的生成选项。
结构：
overrides: Dictionary，可包含 access_options。return: Dictionary，包含合成后的访问器生成选项。
resolve_output_path¶
- API：
public - 首次版本：
5.2.0
获取本次导出的输出路径。
参数：
| 名称 | 说明 |
|---|---|
overrides |
本次导出的覆盖选项。 |
返回：覆盖后的输出路径；未覆盖时返回 output_path。
结构：
overrides: Dictionary，可包含 output_path。
resolve_access_output_path¶
- API：
public - 首次版本：
5.2.0
获取本次访问器生成的输出路径。
参数：
| 名称 | 说明 |
|---|---|
overrides |
本次访问器生成的覆盖选项。 |
返回：覆盖后的访问器输出路径；未配置时返回空字符串。
结构：
overrides: Dictionary，可包含 access_output_path。
resolve_access_class_name¶
- API：
public - 首次版本：
5.2.0
获取本次访问器生成的 class_name。
参数：
| 名称 | 说明 |
|---|---|
overrides |
本次访问器生成的覆盖选项。 |
返回：覆盖后的访问器 class_name。
结构：
overrides: Dictionary，可包含 access_class_name。
resolve_access_provider_accessor¶
- API：
public - 首次版本：
5.2.0
获取本次访问器生成的默认 provider 获取表达式。
参数：
| 名称 | 说明 |
|---|---|
overrides |
本次访问器生成的覆盖选项。 |
返回：覆盖后的 provider 获取表达式。
结构：
overrides: Dictionary，可包含 access_provider_accessor。
duplicate_profile¶
- API：
public - 首次版本：
5.2.0
创建同内容拷贝。
返回：新 Profile 资源。
describe¶
- API：
public - 首次版本：
5.2.0
导出 Profile 摘要。
返回：Profile 摘要字典。
结构：
return: Dictionary，包含 profile_id、database_id、version、output_path、access_output_path、access_class_name、access_provider_accessor、source_count、sources、build_options、save_options、access_options 和 metadata。