GFEditorToolOption¶
API Reference / Kernel / 类索引
- 路径：
addons/gf/kernel/editor/gf_editor_tool_option.gd - 模块：
Kernel - 继承：
Resource - API：
public - 类别：编辑器 API (
editor_api) - 首次版本：
3.17.0
编辑器工具选项声明。 用通用字段描述工具面板需要的一个选项，不绑定具体 UI 控件或资源类型。
成员概览¶
| 类型 | 名称 | 签名 |
|---|---|---|
| 枚举 | ValueType |
enum ValueType |
| 属性 | option_id |
var option_id: StringName = &"" |
| 属性 | label |
var label: String = "" |
| 属性 | tooltip |
var tooltip: String = "" |
| 属性 | value_type |
var value_type: ValueType = ValueType.ANY |
| 属性 | default_value |
var default_value: Variant = null |
| 属性 | min_value |
var min_value: float = 0.0 |
| 属性 | max_value |
var max_value: float = 1.0 |
| 属性 | step |
var step: float = 0.01 |
| 属性 | choices |
var choices: Array = [] |
| 属性 | metadata |
var metadata: Dictionary = {} |
| 方法 | get_option_id |
func get_option_id() -> StringName: |
| 方法 | is_valid_definition |
func is_valid_definition() -> bool: |
| 方法 | normalize_value |
func normalize_value(value: Variant) -> Variant: |
| 方法 | is_value_valid |
func is_value_valid(value: Variant) -> bool: |
| 方法 | duplicate_option |
func duplicate_option() -> GFEditorToolOption: |
| 方法 | describe |
func describe() -> Dictionary: |
枚举¶
ValueType¶
- API：
public
enum ValueType { ## 不做类型约束。 ANY, ## 布尔值。 BOOL, ## 整数。 INT, ## 浮点数。 FLOAT, ## 字符串。 STRING, ## StringName。 STRING_NAME, ## Color。 COLOR, ## Vector2。 VECTOR2, ## Vector2i。 VECTOR2I, ## NodePath。 NODE_PATH, ## 从 choices 中选择。 OPTION, }
编辑器工具选项的通用值类型。
属性¶
option_id¶
- API：
public
选项稳定标识。
label¶
- API：
public
选项显示名称。
tooltip¶
- API：
public
选项提示文本。
value_type¶
- API：
public
选项值类型。
default_value¶
- API：
public
默认值。
结构：
default_value: Variant default value duplicated when needed.
min_value¶
- API：
public
数值最小值。
max_value¶
- API：
public
数值最大值。
step¶
- API：
public
数值步长。
choices¶
- API：
public
可选项列表。value_type 为 OPTION 时用于校验。
结构：
choices: Array of allowed values for OPTION value_type.
metadata¶
- API：
public
可选元数据，供工具 UI、持久化或项目层扩展使用。
结构：
metadata: Dictionary for caller-defined option metadata.
方法¶
get_option_id¶
- API：
public
获取稳定选项标识。
返回：选项标识。
is_valid_definition¶
- API：
public
检查选项声明是否有效。
返回：有效返回 true。
normalize_value¶
- API：
public
规范化输入值。
参数：
| 名称 | 说明 |
|---|---|
value |
输入值。 |
返回：规范化后的值。
结构：
value: Variant raw option value.return: Variant normalized option value.
is_value_valid¶
- API：
public
检查值是否符合选项声明。
参数：
| 名称 | 说明 |
|---|---|
value |
待检查值。 |
返回：符合声明时返回 true。
结构：
value: Variant option value to validate.
duplicate_option¶
- API：
public
创建同内容拷贝。
返回：新选项声明。
describe¶
- API：
public
导出选项声明摘要。
返回：选项声明字典。
结构：
return: Dictionary containing option_id, label, tooltip, value_type, default_value, numeric constraints, choices, and metadata.