GFNetworkMessage¶
API Reference / Network / 类索引
- 路径：
addons/gf/extensions/network/messages/gf_network_message.gd - 模块：
Network - 继承：
RefCounted - API：
public - 类别：值对象 (
value_object) - 首次版本：
3.17.0
通用网络消息载体。 只描述传输元信息和字典载荷，不绑定具体协议、后端或业务消息类型。
成员概览¶
| 类型 | 名称 | 签名 |
|---|---|---|
| 属性 | message_type |
var message_type: StringName = &"" |
| 属性 | sequence |
var sequence: int = 0 |
| 属性 | tick |
var tick: int = 0 |
| 属性 | sender_id |
var sender_id: int = -1 |
| 属性 | channel_id |
var channel_id: StringName = &"" |
| 属性 | payload |
var payload: Dictionary = {} |
| 方法 | to_dict |
func to_dict() -> Dictionary: |
| 方法 | from_dict |
func from_dict(data: Dictionary) -> void: |
属性¶
message_type¶
- API：
public
消息类型标识。
sequence¶
- API：
public
发送端自增序号。
tick¶
- API：
public
逻辑 tick 或帧号。
sender_id¶
- API：
public
发送者标识。
channel_id¶
- API：
public
逻辑网络通道标识。为空时入站侧可按 message_type 匹配同名通道。
payload¶
- API：
public
消息载荷。
结构：
payload: Dictionary[StringName|String, Variant]，保存消息业务载荷。
方法¶
to_dict¶
- API：
public
转为可序列化字典。
返回：字典载荷。
结构：
return: Dictionary，包含 type、sequence、tick、sender_id、channel_id、payload。
from_dict¶
- API：
public
从字典恢复。
参数：
| 名称 | 说明 |
|---|---|
data |
字典载荷。 |
结构：
data: Dictionary，包含 type、sequence、tick、sender_id、channel_id、payload。