GFWeightedEntry¶
API Reference / Standard / 类索引
- 路径:
addons/gf/standard/foundation/math/gf_weighted_entry.gd - 模块:
Standard - 继承:
Resource - API:
public - 类别:资源定义 (
resource_definition) - 首次版本:
3.17.0
权重表中的单个候选项。 只保存值、权重和可选元数据,不约束 value 的业务类型。
成员概览¶
| 类型 | 名称 | 签名 |
|---|---|---|
| 属性 | value |
var value: Variant = null |
| 属性 | weight |
var weight: float = 1.0 |
| 属性 | metadata |
var metadata: Dictionary = {} |
| 方法 | configure |
func configure(p_value: Variant, p_weight: float = 1.0, p_metadata: Dictionary = {}) -> GFWeightedEntry: |
| 方法 | is_selectable |
func is_selectable() -> bool: |
| 方法 | duplicate_entry |
func duplicate_entry(deep: bool = true) -> GFWeightedEntry: |
| 方法 | to_dict |
func to_dict() -> Dictionary: |
| 方法 | from_dict |
static func from_dict(data: Dictionary) -> GFWeightedEntry: |
属性¶
value¶
- API:
public
被选择后返回的值。
结构:
value: Variant selected value owned by project code.
weight¶
- API:
public
权重;小于等于 0 的条目不会被选择。
metadata¶
- API:
public
项目层可选元数据,框架不解释其含义。
结构:
metadata: Dictionary extension metadata for the weighted entry.
方法¶
configure¶
- API:
public
func configure(p_value: Variant, p_weight: float = 1.0, p_metadata: Dictionary = {}) -> GFWeightedEntry:
配置条目内容。
参数:
| 名称 | 说明 |
|---|---|
p_value |
被选择后返回的值。 |
p_weight |
权重;小于等于 0 表示不可被选择。 |
p_metadata |
可选元数据。 |
返回:当前条目。
结构:
p_value: Variant selected value owned by project code.p_metadata: Dictionary extension metadata for the weighted entry.
is_selectable¶
- API:
public
判断该条目当前是否可被选择。
返回:权重大于 0 时返回 true。
duplicate_entry¶
- API:
public
复制当前条目。
参数:
| 名称 | 说明 |
|---|---|
deep |
是否深拷贝元数据。 |
返回:新条目实例。
to_dict¶
- API:
public
导出为通用字典。
返回:包含 value、weight 与 metadata 的字典。
结构:
return: Dictionary serialized weighted entry.
from_dict¶
- API:
public
从通用字典创建条目。
参数:
| 名称 | 说明 |
|---|---|
data |
包含 value、weight 与 metadata 的字典。 |
返回:新条目实例。
结构:
data: Dictionary serialized weighted entry.