跳转至

GFConfigLocalizationKeyValidationRule

API Reference / Standard / 类索引

  • 路径：addons/gf/standard/utilities/config/validation/gf_config_localization_key_validation_rule.gd
  • 模块：Standard
  • 继承：GFConfigValidationRule
  • API：public
  • 类别：资源定义 (resource_definition)
  • 首次版本：3.17.0

文本 key 校验规则。 用于检查配置字段中的本地化 key 是否存在于显式 key 列表、字典或 Godot 翻译表中。

成员概览

类型 名称 签名
属性 allow_empty var allow_empty: bool = true
属性 known_keys var known_keys: PackedStringArray = PackedStringArray()
属性 text_map var text_map: Dictionary = {}
属性 use_translation_server var use_translation_server: bool = true
方法 describe func describe() -> Dictionary:
方法 _get_default_rule_id func _get_default_rule_id() -> StringName:
方法 _validate_value func _validate_value(value: Variant, context: Dictionary, report: Dictionary) -> void:

属性

allow_empty

  • API：public
var allow_empty: bool = true

空字符串是否直接视为通过。

known_keys

  • API：public
var known_keys: PackedStringArray = PackedStringArray()

显式允许的文本 key。

text_map

  • API：public
var text_map: Dictionary = {}

可选文本字典。只检查 key 是否存在，不解释 value。

结构：

  • text_map: Dictionary，将本地化 key 映射到项目自有文本值。

use_translation_server

  • API：public
var use_translation_server: bool = true

是否尝试通过 TranslationServer 判断 key。

方法

describe

  • API：public
func describe() -> Dictionary:

导出规则摘要。

返回：规则摘要字典。

结构：

  • return: Dictionary，包含基础规则字段和本地化 key 来源设置。

_get_default_rule_id

  • API：protected
func _get_default_rule_id() -> StringName:

返回本地化 key 规则的默认稳定标识。

返回：默认规则标识。

_validate_value

  • API：protected
func _validate_value(value: Variant, context: Dictionary, report: Dictionary) -> void:

校验单个字段值是否存在于配置的文本 key 来源中。

参数：

名称 说明
value 待校验值。
context 校验上下文。
report 当前校验报告。

结构：

  • value: Variant，期望为 String 或 StringName 本地化 key。
  • context: Dictionary，可包含 table_name、row_key、field、source、line 和 column 字段。
  • report: GFConfigValidationReport 兼容 Dictionary，会被当前规则修改。