GFSourceBuilder¶
API Reference / Kernel / 类索引
- 路径：
addons/gf/kernel/editor/gf_source_builder.gd - 模块：
Kernel - 继承：
RefCounted - API：
public - 类别：编辑器 API (
editor_api) - 首次版本：
3.17.0
编辑器代码生成用的轻量源码构建器。 用于集中处理生成脚本时的缩进、空行、section 与文档注释格式， 避免各个 generator 直接拼接 PackedStringArray 时出现格式漂移。
成员概览¶
| 类型 | 名称 | 签名 |
|---|---|---|
| 方法 | line |
func line(text: String = "") -> void: |
| 方法 | doc |
func doc(text: String = "") -> void: |
| 方法 | section |
func section(title: String) -> void: |
| 方法 | blank |
func blank(count: int = 1) -> void: |
| 方法 | indent |
func indent() -> void: |
| 方法 | dedent |
func dedent(count: int = 1) -> void: |
| 方法 | clear |
func clear() -> void: |
| 方法 | build |
func build() -> String: |
方法¶
line¶
- API：
public
添加一行源码。
参数：
| 名称 | 说明 |
|---|---|
text |
行内容；空字符串会生成空行且不添加缩进。 |
doc¶
- API：
public
添加文档注释行。
参数：
| 名称 | 说明 |
|---|---|
text |
注释内容；空字符串会生成 ##。 |
section¶
- API：
public
添加规范 section 标题，并在其后添加一个空行。
参数：
| 名称 | 说明 |
|---|---|
title |
section 标题。 |
blank¶
- API：
public
添加空行。
参数：
| 名称 | 说明 |
|---|---|
count |
空行数量，小于等于 0 时不产生输出。 |
indent¶
- API：
public
增加后续行的缩进层级。
dedent¶
- API：
public
减少后续行的缩进层级。
参数：
| 名称 | 说明 |
|---|---|
count |
要减少的层级数，小于等于 0 时不改变缩进。 |
clear¶
- API：
public
清空已构建内容并重置缩进。
build¶
- API：
public
生成最终源码字符串；非空源码末尾会包含换行。
返回：完整源码文本。