GFConfigRangeValidationRule¶
API Reference / Standard / 类索引
- 路径：
addons/gf/standard/utilities/config/validation/gf_config_range_validation_rule.gd - 模块：
Standard - 继承：
GFConfigValidationRule - API：
public - 类别：资源定义 (
resource_definition) - 首次版本：
3.17.0
数值范围校验规则。 用于声明字段数值上下限。上下限可以单独启用，比较方式可选择是否包含边界。
成员概览¶
| 类型 | 名称 | 签名 |
|---|---|---|
| 属性 | has_minimum |
var has_minimum: bool = false |
| 属性 | minimum |
var minimum: float = 0.0 |
| 属性 | inclusive_minimum |
var inclusive_minimum: bool = true |
| 属性 | has_maximum |
var has_maximum: bool = false |
| 属性 | maximum |
var maximum: float = 0.0 |
| 属性 | inclusive_maximum |
var inclusive_maximum: 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: |
属性¶
has_minimum¶
- API：
public
是否检查最小值。
minimum¶
- API：
public
最小值。
inclusive_minimum¶
- API：
public
最小值是否包含边界。
has_maximum¶
- API：
public
是否检查最大值。
maximum¶
- API：
public
最大值。
inclusive_maximum¶
- API：
public
最大值是否包含边界。
方法¶
describe¶
- API：
public
导出规则摘要。
返回：规则摘要字典。
结构：
return: Dictionary，包含基础规则字段和数值范围设置。
_get_default_rule_id¶
- API：
protected
返回数值范围规则的默认稳定标识。
返回：默认规则标识。
_validate_value¶
- API：
protected
校验单个数值是否落在允许范围内。
参数：
| 名称 | 说明 |
|---|---|
value |
待校验值。 |
context |
校验上下文。 |
report |
当前校验报告。 |
结构：
value: Variant，期望为 int 或 float。context: Dictionary，可包含 table_name、row_key、field、source、line 和 column 字段。report: GFConfigValidationReport 兼容 Dictionary，会被当前规则修改。