GFValidationIssue¶
API Reference / Standard / 类索引
- 路径：
addons/gf/standard/foundation/validation/gf_validation_issue.gd - 模块：
Standard - 继承：
RefCounted - API：
public - 类别：值对象 (
value_object) - 首次版本：
3.17.0
通用校验问题条目。 用于描述配置、资源、节点树、存档载荷或编辑器工具中的单个问题。它只记录 严重级别、问题类别、定位信息和附加字段，不决定项目如何展示或修复问题。
成员概览¶
| 类型 | 名称 | 签名 |
|---|---|---|
| 枚举 | Severity |
enum Severity |
| 属性 | severity |
var severity: Severity = Severity.ERROR |
| 属性 | kind |
var kind: StringName = &"" |
| 属性 | key |
var key: Variant = null |
| 属性 | path |
var path: String = "" |
| 属性 | source_path |
var source_path: String = "" |
| 属性 | line |
var line: int = 0 |
| 属性 | column |
var column: int = 0 |
| 属性 | length |
var length: int = 0 |
| 属性 | end_line |
var end_line: int = 0 |
| 属性 | end_column |
var end_column: int = 0 |
| 属性 | preview |
var preview: String = "" |
| 属性 | subject |
var subject: String = "" |
| 属性 | message |
var message: String = "" |
| 属性 | metadata |
var metadata: Dictionary = {} |
| 属性 | extra_fields |
var extra_fields: Dictionary = {} |
| 方法 | _init |
func _init( p_severity: Variant = Severity.ERROR, p_kind: StringName = &"", p_message: String = "", p_key: Variant = null, p_path: String = "", p_metadata: Dictionary = {} ) -> void: |
| 方法 | configure |
func configure( p_severity: Variant, p_kind: StringName, p_message: String, p_key: Variant = null, p_path: String = "", p_metadata: Dictionary = {} ) -> RefCounted: |
| 方法 | apply_dict |
func apply_dict(data: Dictionary) -> void: |
| 方法 | to_dict |
func to_dict(include_empty_fields: bool = false) -> Dictionary: |
| 方法 | duplicate_issue |
func duplicate_issue() -> RefCounted: |
| 方法 | set_source_span |
func set_source_span(source_span: Variant) -> RefCounted: |
| 方法 | get_source_span |
func get_source_span() -> RefCounted: |
| 方法 | has_source_position |
func has_source_position() -> bool: |
| 方法 | get_location_text |
func get_location_text() -> String: |
| 方法 | get_kind_key |
func get_kind_key() -> String: |
| 方法 | is_error |
func is_error() -> bool: |
| 方法 | is_warning |
func is_warning() -> bool: |
| 方法 | is_info |
func is_info() -> bool: |
| 方法 | normalize_severity |
static func normalize_severity(value: Variant) -> Severity: |
| 方法 | severity_to_string |
static func severity_to_string(value: Variant) -> String: |
| 方法 | from_dict |
static func from_dict(data: Dictionary) -> RefCounted: |
枚举¶
Severity¶
- API：
public
校验问题严重级别。
属性¶
severity¶
- API：
public
严重级别。
kind¶
- API：
public
通用问题类别。推荐使用稳定的 snake_case 标识。
key¶
- API：
public
可选定位键，例如行号、资源 key、节点 key 或调用方自定义标识。
结构：
key: Variant caller-defined location key.
path¶
- API：
public
可选路径，例如资源路径、节点路径或数据路径。
source_path¶
- API：
public
可选源文件或资源路径。source 字典字段会作为兼容别名读取。
line¶
- API：
public
可选源码起始行号，1-based；0 表示未知。
column¶
- API：
public
可选源码起始列号，1-based；0 表示未知。
length¶
- API：
public
可选源码范围长度；0 表示未知。
end_line¶
- API：
public
可选源码结束行号，1-based；0 表示未知。
end_column¶
- API：
public
可选源码结束列号，1-based；0 表示未知。
preview¶
- API：
public
可选源码预览。
subject¶
- API：
public
可选主题，用于标记问题所属对象或报告域。
message¶
- API：
public
面向开发者或工具 UI 的简短说明。
metadata¶
- API：
public
可选元数据。框架不解释该字段。
结构：
metadata: Dictionary caller metadata.
extra_fields¶
- API：
public
额外上下文字段。用于无损保留已有报告中的自定义字段。
结构：
extra_fields: Dictionary caller-defined fields preserved during conversion.
方法¶
_init¶
- API：
public
func _init( p_severity: Variant = Severity.ERROR, p_kind: StringName = &"", p_message: String = "", p_key: Variant = null, p_path: String = "", p_metadata: Dictionary = {} ) -> void:
创建校验问题条目。
参数：
| 名称 | 说明 |
|---|---|
p_severity |
严重级别，可传入 Severity、int 或字符串。 |
p_kind |
问题类别。 |
p_message |
问题说明。 |
p_key |
可选定位键。 |
p_path |
可选路径。 |
p_metadata |
可选元数据。 |
结构：
p_severity: Variant Severity, int, or string.p_key: Variant caller-defined location key.p_metadata: Dictionary caller metadata.
configure¶
- API：
public
func configure( p_severity: Variant, p_kind: StringName, p_message: String, p_key: Variant = null, p_path: String = "", p_metadata: Dictionary = {} ) -> RefCounted:
配置问题条目并返回自身，便于链式构造。
参数：
| 名称 | 说明 |
|---|---|
p_severity |
严重级别，可传入 Severity、int 或字符串。 |
p_kind |
问题类别。 |
p_message |
问题说明。 |
p_key |
可选定位键。 |
p_path |
可选路径。 |
p_metadata |
可选元数据。 |
返回：当前问题条目。
结构：
p_severity: Variant Severity, int, or string.p_key: Variant caller-defined location key.p_metadata: Dictionary caller metadata.
apply_dict¶
- API：
public
从字典应用字段。
参数：
| 名称 | 说明 |
|---|---|
data |
输入字典。 |
结构：
data: Dictionary validation issue fields.
to_dict¶
- API：
public
转换为字典。
参数：
| 名称 | 说明 |
|---|---|
include_empty_fields |
为 true 时包含空的可选字段。 |
返回：字典副本。
结构：
return: Dictionary validation issue fields.
duplicate_issue¶
- API：
public
创建当前问题条目的深拷贝。
返回：新问题条目。
set_source_span¶
- API：
public
设置源码定位范围。
参数：
| 名称 | 说明 |
|---|---|
source_span |
GFSourceSpan 或兼容字典。 |
返回：当前问题条目。
结构：
source_span: Variant GFSourceSpan-like object or Dictionary.
get_source_span¶
- API：
public
获取源码定位范围副本。
返回：GFSourceSpan。
has_source_position¶
- API：
public
检查问题是否有源码行号。
返回：有行号时返回 true。
get_location_text¶
- API：
public
获取人类可读定位文本。
返回：例如 res://table.csv:4:2。
get_kind_key¶
- API：
public
获取统计用问题类别。
返回：优先返回 kind，最后返回 unknown。
is_error¶
- API：
public
是否为错误。
返回：严重级别为 ERROR 时返回 true。
is_warning¶
- API：
public
是否为警告。
返回：严重级别为 WARNING 时返回 true。
is_info¶
- API：
public
是否为信息。
返回：严重级别为 INFO 时返回 true。
normalize_severity¶
- API：
public
将任意输入归一为 Severity。
参数：
| 名称 | 说明 |
|---|---|
value |
Severity、int 或字符串。 |
返回：归一后的严重级别。
结构：
value: Variant Severity, int, string, or null.
severity_to_string¶
- API：
public
将严重级别转换为稳定字符串。
参数：
| 名称 | 说明 |
|---|---|
value |
Severity、int 或字符串。 |
返回：info、warning 或 error。
结构：
value: Variant Severity, int, string, or null.
from_dict¶
- API：
public
从字典创建问题条目。
参数：
| 名称 | 说明 |
|---|---|
data |
输入字典。 |
返回：新问题条目。
结构：
data: Dictionary validation issue fields.