GFNetworkChannel¶
API Reference / Network / 类索引
- 路径：
addons/gf/extensions/network/session/gf_network_channel.gd - 模块：
Network - 继承：
Resource - API：
public - 类别：资源定义 (
resource_definition) - 首次版本：
3.17.0
网络发送通道描述。 描述一类消息的传输偏好，例如通道编号、可靠性和包体上限。
成员概览¶
| 类型 | 名称 | 签名 |
|---|---|---|
| 属性 | channel_id |
var channel_id: StringName = &"" |
| 属性 | display_name |
var display_name: String = "" |
| 属性 | transfer_channel |
var transfer_channel: int = 0 |
| 属性 | reliable |
var reliable: bool = true |
| 属性 | max_packet_size |
var max_packet_size: int = 0 |
| 属性 | metadata |
var metadata: Dictionary = {} |
| 方法 | get_display_name |
func get_display_name() -> String: |
| 方法 | build_send_options |
func build_send_options(overrides: Dictionary = {}) -> Dictionary: |
| 方法 | describe |
func describe() -> Dictionary: |
属性¶
channel_id¶
- API：
public
通道稳定标识。
display_name¶
- API：
public
编辑器展示名称。
transfer_channel¶
- API：
public
后端传输通道编号。
reliable¶
- API：
public
默认是否可靠传输。
max_packet_size¶
- API：
public
最大包体大小。小于等于 0 表示不限制。
metadata¶
- API：
public
项目自定义元数据。框架不解释该字段。
结构：
metadata: Dictionary，保存项目自定义通道元数据。
方法¶
get_display_name¶
- API：
public
获取展示名称。
返回：展示名称。
build_send_options¶
- API：
public
构建后端发送选项。
参数：
| 名称 | 说明 |
|---|---|
overrides |
项目层额外发送选项。 |
返回：后端选项字典。
结构：
overrides: Dictionary，项目层发送选项；channel 和 reliable 缺失时由通道默认值补齐。return: Dictionary，后端发送选项，至少包含 channel 和 reliable。
describe¶
- API：
public
描述通道。
返回：描述字典。
结构：
return: Dictionary，包含 channel_id、display_name、transfer_channel、reliable、max_packet_size、metadata。