GFNetworkLobbyInvite¶
API Reference / Network / 类索引
- 路径：
addons/gf/extensions/network/session/gf_network_lobby_invite.gd - 模块：
Network - 继承：
Resource - API：
public - 类别：事件契约 (
event_contract) - 首次版本：
8.0.0
平台中立的 lobby 邀请事件。 邀请只表达发送方、目标方和 lobby 入口信息。好友 UI、每日任务、奖励等业务策略 必须留在项目层或外部 adapter 中。
成员概览¶
| 类型 | 名称 | 签名 |
|---|---|---|
| 属性 | invite_id |
var invite_id: String = "" |
| 属性 | lobby_id |
var lobby_id: String = "" |
| 属性 | backend_id |
var backend_id: StringName = &"" |
| 属性 | sender |
var sender: GFNetworkPeerIdentity = null |
| 属性 | target |
var target: GFNetworkPeerIdentity = null |
| 属性 | message |
var message: String = "" |
| 属性 | metadata |
var metadata: Dictionary = {} |
| 方法 | to_dict |
func to_dict() -> Dictionary: |
| 方法 | apply_dict |
func apply_dict(data: Dictionary) -> void: |
| 方法 | duplicate_invite |
func duplicate_invite() -> GFNetworkLobbyInvite: |
| 方法 | from_dict |
static func from_dict(data: Dictionary) -> GFNetworkLobbyInvite: |
属性¶
invite_id¶
- API：
public - 首次版本：
8.0.0
邀请 ID。没有平台邀请 ID 时可为空。
lobby_id¶
- API：
public - 首次版本：
8.0.0
相关 lobby ID。
backend_id¶
- API：
public - 首次版本：
8.0.0
提供邀请的 backend 标识。
sender¶
- API：
public - 首次版本：
8.0.0
邀请发送方身份。
target¶
- API：
public - 首次版本：
8.0.0
邀请目标身份。
message¶
- API：
public - 首次版本：
8.0.0
人读说明或平台侧附带消息。
metadata¶
- API：
public - 首次版本：
8.0.0
调用方自定义元数据。
结构：
metadata: Dictionary caller-defined invite metadata.
方法¶
to_dict¶
- API：
public - 首次版本：
8.0.0
转换为字典。
返回：邀请字典。
结构：
return: Dictionary with invite_id, lobby_id, backend_id, sender, target, message, and metadata.
apply_dict¶
- API：
public - 首次版本：
8.0.0
从字典应用邀请字段。
参数：
| 名称 | 说明 |
|---|---|
data |
邀请字典。 |
结构：
data: Dictionary with invite_id, lobby_id, backend_id, sender, target, message, and metadata.
duplicate_invite¶
- API：
public - 首次版本：
8.0.0
创建邀请深拷贝。
返回：新邀请。
from_dict¶
- API：
public - 首次版本：
8.0.0
从字典创建邀请。
参数：
| 名称 | 说明 |
|---|---|
data |
邀请字典。 |
返回：新邀请。
结构：
data: Dictionary with invite_id, lobby_id, backend_id, sender, target, message, and metadata.