GFTurnContext¶
API Reference / Turn Based / 类索引
- 路径：
addons/gf/extensions/turn_based/runtime/gf_turn_context.gd - 模块：
Turn Based - 继承：
RefCounted - API：
public - 类别：领域模型 (
domain_model) - 首次版本：
3.17.0
通用回合流程上下文。 只记录参与者、行动、轮次和元数据，不假设生命值、阵营、技能等业务概念。
成员概览¶
| 类型 | 名称 | 签名 |
|---|---|---|
| 属性 | current_actor |
var current_actor: Object: |
| 属性 | round_index |
var round_index: int: |
| 属性 | metadata |
var metadata: Dictionary = {} |
| 方法 | add_actor |
func add_actor(actor: Object) -> void: |
| 方法 | remove_actor |
func remove_actor(actor: Object) -> void: |
| 方法 | get_actors |
func get_actors() -> Array[Object]: |
| 方法 | cleanup_invalid_actors |
func cleanup_invalid_actors() -> int: |
| 方法 | get_actor_value |
func get_actor_value(actor: Object, key: StringName, fallback: Variant = null) -> Variant: |
属性¶
current_actor¶
- API：
public - 首次版本：
3.17.0
当前行动主体。
round_index¶
- API：
public - 首次版本：
3.17.0
当前轮次索引。
metadata¶
- API：
public
自定义元数据，框架不解释该字段。
结构：
metadata: Dictionary[String, Variant] project-defined turn flow metadata.
方法¶
add_actor¶
- API：
public
添加参与者。
参数：
| 名称 | 说明 |
|---|---|
actor |
参与者对象。 |
remove_actor¶
- API：
public
移除参与者。
参数：
| 名称 | 说明 |
|---|---|
actor |
参与者对象。 |
get_actors¶
- API：
public - 首次版本：
8.0.0
获取参与者只读快照。
返回：当前有效性尚未重新校验的参与者数组快照。
cleanup_invalid_actors¶
- API：
public - 首次版本：
8.0.0
清理已经失效的参与者引用。
返回：被移除的失效参与者数量。
结构：
return: int removed invalid actor reference count.
get_actor_value¶
- API：
public - 首次版本：
3.17.0
从参与者读取排序或判定值。 优先调用 get_turn_value(key, fallback)，其次读取对象属性。
参数：
| 名称 | 说明 |
|---|---|
actor |
参与者对象。 |
key |
值键。 |
fallback |
读取失败时的兜底值。 |
返回：读取到的值。
结构：
fallback: Variant returned when no actor value can be read.return: Variant read from get_turn_value(), object property access, or fallback.