GFNetworkLobbyQuery¶
API Reference / Network / 类索引
- 路径：
addons/gf/extensions/network/session/gf_network_lobby_query.gd - 模块：
Network - 继承：
Resource - API：
public - 类别：值对象 (
value_object) - 首次版本：
8.0.0
平台中立的 lobby 查询条件。 查询对象只描述通用过滤条件，由具体 backend 决定如何映射到平台查询、 局域网发现或自建服务请求。
成员概览¶
| 类型 | 名称 | 签名 |
|---|---|---|
| 属性 | query_id |
var query_id: StringName = &"" |
| 属性 | search_text |
var search_text: String = "" |
| 属性 | required_tags |
var required_tags: PackedStringArray = PackedStringArray() |
| 属性 | required_metadata |
var required_metadata: Dictionary = {} |
| 属性 | max_results |
var max_results: int = 0 |
| 属性 | include_full_lobbies |
var include_full_lobbies: bool = false |
| 属性 | include_unjoinable_lobbies |
var include_unjoinable_lobbies: bool = false |
| 属性 | metadata |
var metadata: Dictionary = {} |
| 方法 | matches |
func matches(lobby: GFNetworkLobbyDescriptor) -> bool: |
| 方法 | to_dict |
func to_dict() -> Dictionary: |
| 方法 | apply_dict |
func apply_dict(data: Dictionary) -> void: |
| 方法 | duplicate_query |
func duplicate_query() -> GFNetworkLobbyQuery: |
| 方法 | from_dict |
static func from_dict(data: Dictionary) -> GFNetworkLobbyQuery: |
属性¶
query_id¶
- API：
public - 首次版本：
8.0.0
查询稳定标识。
search_text¶
- API：
public - 首次版本：
8.0.0
可选搜索文本。backend 可用它匹配显示名或平台自定义字段。
required_tags¶
- API：
public - 首次版本：
8.0.0
必须同时具备的 tag。
required_metadata¶
- API：
public - 首次版本：
8.0.0
必须匹配的 metadata 键值。
结构：
required_metadata: Dictionary metadata key/value filters.
max_results¶
- API：
public - 首次版本：
8.0.0
最大结果数。小于等于 0 表示不限制。
include_full_lobbies¶
- API：
public - 首次版本：
8.0.0
是否包含已满 lobby。
include_unjoinable_lobbies¶
- API：
public - 首次版本：
8.0.0
是否包含不可加入 lobby。
metadata¶
- API：
public - 首次版本：
8.0.0
调用方自定义查询选项。
结构：
metadata: Dictionary caller-defined query metadata.
方法¶
matches¶
- API：
public - 首次版本：
8.0.0
检查 lobby 是否满足本地可判断的查询条件。
参数：
| 名称 | 说明 |
|---|---|
lobby |
Lobby 快照。 |
返回：满足条件返回 true。
to_dict¶
- API：
public - 首次版本：
8.0.0
转换为字典。
返回：查询字典。
结构：
return: Dictionary with query_id, search_text, required_tags, required_metadata, max_results, include_full_lobbies, include_unjoinable_lobbies, and metadata.
apply_dict¶
- API：
public - 首次版本：
8.0.0
从字典应用查询字段。
参数：
| 名称 | 说明 |
|---|---|
data |
查询字典。 |
结构：
data: Dictionary with query_id, search_text, required_tags, required_metadata, max_results, include_full_lobbies, include_unjoinable_lobbies, and metadata.
duplicate_query¶
- API：
public - 首次版本：
8.0.0
创建查询深拷贝。
返回：新查询。
from_dict¶
- API：
public - 首次版本：
8.0.0
从字典创建查询。
参数：
| 名称 | 说明 |
|---|---|
data |
查询字典。 |
返回：新查询。
结构：
data: Dictionary with query_id, search_text, required_tags, required_metadata, max_results, include_full_lobbies, include_unjoinable_lobbies, and metadata.