GFInteractionContext¶
API Reference / Interaction / 类索引
- 路径：
addons/gf/extensions/interaction/runtime/gf_interaction_context.gd - 模块：
Interaction - 继承：
RefCounted - API：
public - 类别：运行时句柄 (
runtime_handle) - 首次版本：
3.17.0
一次交互流程的轻量上下文。 用于在 Command、事件或项目自定义方法之间传递 sender、target、payload 与可选分组信息。
成员概览¶
| 类型 | 名称 | 签名 |
|---|---|---|
| 属性 | sender |
var sender: Object: |
| 属性 | target |
var target: Object: |
| 属性 | sender_instance_id |
var sender_instance_id: int = 0 |
| 属性 | target_instance_id |
var target_instance_id: int = 0 |
| 属性 | sender_path |
var sender_path: NodePath = NodePath("") |
| 属性 | target_path |
var target_path: NodePath = NodePath("") |
| 属性 | sender_class |
var sender_class: String = "" |
| 属性 | target_class |
var target_class: String = "" |
| 属性 | payload |
var payload: Variant = null |
| 属性 | group_name |
var group_name: StringName = &"" |
| 方法 | with_sender |
func with_sender(value: Object) -> GFInteractionContext: |
| 方法 | with_target |
func with_target(value: Object) -> GFInteractionContext: |
| 方法 | with_payload |
func with_payload(value: Variant) -> GFInteractionContext: |
| 方法 | with_group |
func with_group(value: StringName) -> GFInteractionContext: |
| 方法 | get_sender_or_null |
func get_sender_or_null() -> Object: |
| 方法 | get_target_or_null |
func get_target_or_null() -> Object: |
属性¶
sender¶
- API：
public - 首次版本：
7.0.0
交互发起者。
target¶
- API：
public - 首次版本：
7.0.0
交互目标。
sender_instance_id¶
- API：
public - 首次版本：
7.0.0
交互发起者实例 ID 快照。
target_instance_id¶
- API：
public - 首次版本：
7.0.0
交互目标实例 ID 快照。
sender_path¶
- API：
public - 首次版本：
7.0.0
交互发起者节点路径快照。
target_path¶
- API：
public - 首次版本：
7.0.0
交互目标节点路径快照。
sender_class¶
- API：
public - 首次版本：
7.0.0
交互发起者类名快照。
target_class¶
- API：
public - 首次版本：
7.0.0
交互目标类名快照。
payload¶
- API：
public - 首次版本：
3.17.0
交互携带的数据。
结构：
payload: 交互携带的任意项目载荷；框架只透传，不解释其中结构。
group_name¶
- API：
public - 首次版本：
3.17.0
交互所属的可选分组。
方法¶
with_sender¶
- API：
public - 首次版本：
3.17.0
设置 sender 并返回自身，便于链式构造。
参数：
| 名称 | 说明 |
|---|---|
value |
要写入或修改的值。 |
返回：当前上下文。
with_target¶
- API：
public - 首次版本：
3.17.0
设置 target 并返回自身，便于链式构造。
参数：
| 名称 | 说明 |
|---|---|
value |
要写入或修改的值。 |
返回：当前上下文。
with_payload¶
- API：
public - 首次版本：
3.17.0
设置 payload 并返回自身，便于链式构造。
参数：
| 名称 | 说明 |
|---|---|
value |
要写入或修改的值。 |
返回：当前上下文。
结构：
value: 要写入 payload 的任意项目载荷。
with_group¶
- API：
public - 首次版本：
3.17.0
设置 group_name 并返回自身，便于链式构造。
参数：
| 名称 | 说明 |
|---|---|
value |
要写入或修改的值。 |
返回：当前上下文。
get_sender_or_null¶
- API：
public - 首次版本：
7.0.0
获取当前 sender；对象已释放时返回 null。
返回：当前 sender 或 null。
get_target_or_null¶
- API：
public - 首次版本：
7.0.0
获取当前 target；对象已释放时返回 null。
返回：当前 target 或 null。