GFNetworkLobbyJoinResult¶
API Reference / Network / 类索引
- 路径：
addons/gf/extensions/network/session/gf_network_lobby_join_result.gd - 模块：
Network - 继承：
RefCounted - API：
public - 类别：值对象 (
value_object) - 首次版本：
8.0.0
Lobby 创建或加入结果。 该值对象统一表达同步或异步 backend 的最终结果，避免项目代码直接依赖 平台 SDK 的错误码枚举。
成员概览¶
| 类型 | 名称 | 签名 |
|---|---|---|
| 属性 | ok |
var ok: bool = false |
| 属性 | lobby_id |
var lobby_id: String = "" |
| 属性 | lobby |
var lobby: GFNetworkLobbyDescriptor = null |
| 属性 | error |
var error: StringName = &"" |
| 属性 | message |
var message: String = "" |
| 属性 | metadata |
var metadata: Dictionary = {} |
| 方法 | configure_success |
func configure_success(p_lobby: GFNetworkLobbyDescriptor, p_metadata: Dictionary = {}) -> GFNetworkLobbyJoinResult: |
| 方法 | configure_failure |
func configure_failure( p_lobby_id: String, p_error: StringName, p_message: String = "", p_metadata: Dictionary = {} ) -> GFNetworkLobbyJoinResult: |
| 方法 | to_dict |
func to_dict() -> Dictionary: |
| 方法 | apply_dict |
func apply_dict(data: Dictionary) -> void: |
| 方法 | duplicate_result |
func duplicate_result() -> GFNetworkLobbyJoinResult: |
| 方法 | success |
static func success(lobby_value: GFNetworkLobbyDescriptor, metadata_value: Dictionary = {}) -> GFNetworkLobbyJoinResult: |
| 方法 | failure |
static func failure( lobby_id_value: String, error_value: StringName, message_value: String = "", metadata_value: Dictionary = {} ) -> GFNetworkLobbyJoinResult: |
| 方法 | from_dict |
static func from_dict(data: Dictionary) -> GFNetworkLobbyJoinResult: |
属性¶
ok¶
- API：
public - 首次版本：
8.0.0
操作是否成功。
lobby_id¶
- API：
public - 首次版本：
8.0.0
相关 lobby ID。
lobby¶
- API：
public - 首次版本：
8.0.0
成功时的 lobby 快照。
error¶
- API：
public - 首次版本：
8.0.0
失败原因标识。
message¶
- API：
public - 首次版本：
8.0.0
人读说明。
metadata¶
- API：
public - 首次版本：
8.0.0
调用方自定义元数据。
结构：
metadata: Dictionary caller-defined result metadata.
方法¶
configure_success¶
- API：
public - 首次版本：
8.0.0
func configure_success(p_lobby: GFNetworkLobbyDescriptor, p_metadata: Dictionary = {}) -> GFNetworkLobbyJoinResult:
配置成功结果。
参数：
| 名称 | 说明 |
|---|---|
p_lobby |
Lobby 快照。 |
p_metadata |
调用方元数据。 |
返回：当前结果。
结构：
p_metadata: Dictionary caller-defined result metadata.
configure_failure¶
- API：
public - 首次版本：
8.0.0
func configure_failure( p_lobby_id: String, p_error: StringName, p_message: String = "", p_metadata: Dictionary = {} ) -> GFNetworkLobbyJoinResult:
配置失败结果。
参数：
| 名称 | 说明 |
|---|---|
p_lobby_id |
相关 lobby ID。 |
p_error |
失败原因标识。 |
p_message |
人读说明。 |
p_metadata |
调用方元数据。 |
返回：当前结果。
结构：
p_metadata: Dictionary caller-defined result metadata.
to_dict¶
- API：
public - 首次版本：
8.0.0
转换为字典。
返回：结果字典。
结构：
return: Dictionary with ok, lobby_id, lobby, error, message, and metadata.
apply_dict¶
- API：
public - 首次版本：
8.0.0
从字典应用结果字段。
参数：
| 名称 | 说明 |
|---|---|
data |
结果字典。 |
结构：
data: Dictionary with ok, lobby_id, lobby, error, message, and metadata.
duplicate_result¶
- API：
public - 首次版本：
8.0.0
创建结果深拷贝。
返回：新结果。
success¶
- API：
public - 首次版本：
8.0.0
static func success(lobby_value: GFNetworkLobbyDescriptor, metadata_value: Dictionary = {}) -> GFNetworkLobbyJoinResult:
创建成功结果。
参数：
| 名称 | 说明 |
|---|---|
lobby_value |
Lobby 快照。 |
metadata_value |
调用方元数据。 |
返回：成功结果。
结构：
metadata_value: Dictionary caller-defined result metadata.
failure¶
- API：
public - 首次版本：
8.0.0
static func failure( lobby_id_value: String, error_value: StringName, message_value: String = "", metadata_value: Dictionary = {} ) -> GFNetworkLobbyJoinResult:
创建失败结果。
参数：
| 名称 | 说明 |
|---|---|
lobby_id_value |
相关 lobby ID。 |
error_value |
失败原因标识。 |
message_value |
人读说明。 |
metadata_value |
调用方元数据。 |
返回：失败结果。
结构：
metadata_value: Dictionary caller-defined result metadata.
from_dict¶
- API：
public - 首次版本：
8.0.0
从字典创建结果。
参数：
| 名称 | 说明 |
|---|---|
data |
结果字典。 |
返回：新结果。
结构：
data: Dictionary with ok, lobby_id, lobby, error, message, and metadata.