GFConfigSetValidationRule¶
API Reference / Standard / 类索引
- 路径：
addons/gf/standard/utilities/config/validation/gf_config_set_validation_rule.gd - 模块：
Standard - 继承：
GFConfigValidationRule - API：
public - 类别：资源定义 (
resource_definition) - 首次版本：
3.17.0
值集合校验规则。 用于限制字段值必须出现在一个显式白名单中，不解释白名单背后的业务含义。
成员概览¶
| 类型 | 名称 | 签名 |
|---|---|---|
| 属性 | allowed_values |
var allowed_values: Array = [] |
| 属性 | case_sensitive |
var case_sensitive: 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: |
属性¶
allowed_values¶
- API：
public
允许出现的值列表。
结构：
allowed_values: Array，包含当前规则允许的 Variant 值。
case_sensitive¶
- API：
public
字符串比较是否区分大小写。
方法¶
describe¶
- API：
public
导出规则摘要。
返回：规则摘要字典。
结构：
return: Dictionary，包含基础规则字段、allowed_values 和 case_sensitive。
_get_default_rule_id¶
- API：
protected
返回集合规则的默认稳定标识。
返回：默认规则标识。
_validate_value¶
- API：
protected
校验单个字段值是否属于允许集合。
参数：
| 名称 | 说明 |
|---|---|
value |
待校验值。 |
context |
校验上下文。 |
report |
当前校验报告。 |
结构：
value: Variant，与 allowed_values 比较的字段值。context: Dictionary，可包含 table_name、row_key、field、source、line 和 column 字段。report: GFConfigValidationReport 兼容 Dictionary，会被当前规则修改。