PFLobbySearchConfiguration

用于指定应如何执行 PFMultiplayerFindLobbies 操作的配置结构。

语法

struct PFLobbySearchConfiguration {  
    const PFLobbySearchFriendsFilter* friendsFilter;  
    const char* filterString;  
    const char* sortString;  
    const uint32_t* clientSearchResultCount;  
}  

成员

friendsFilter const PFLobbySearchFriendsFilter*
可能是 nullptr

一个筛选器,如果提供此筛选器,则会将大厅搜索操作限制为只有该玩家的各种好友列表的成员拥有的那些内容。

如果省略,搜索操作将搜索所有可用的大厅。

仅当使用 title_player_account 实体调用 PFMultiplayerFindLobbies 时,才能指定此值。

filterString const char*
以 null 结尾

用于筛选搜索结果中返回的大厅的查询字符串。

此字符串采用类似于 OData 的筛选语法格式。

仅支持以下运算符:“and”(逻辑和)、“eq”(等于)、“ne”(不等于)、“ge”(大于或等于)、“gt”(大于)、“le”(小于或等于)和“lt”(小于)。

每个 OData 逻辑表达式的左侧应为搜索属性键(例如 string_key1、number_key3 等)或预定义的搜索键之一(PFLobbyMemberCountSearchKeyPFLobbyAmMemberSearchKeyPFLobbyMembershipLockSearchKey

每个 OData 逻辑表达式的左侧应为搜索属性键。

此字符串不能超过 500 个字符。

示例:“lobby/membershipLock eq 'Unlocked' and string_key1 eq 'CaptureTheFlag' and number_key10 gt 50 and lobby/memberCount lt 5”

sortString const char*
以 null 结尾

用于对搜索结果中返回的大厅进行排序的查询字符串。

此字符串采用类似于 OData 的 order-by 语法格式化:以逗号分隔的搜索属性键列表,其中包含可选说明符,可按升序或降序排序。

若要指定升序,请在关联的搜索属性键后面使用“asc”运算符。 若要指定降序,请在关联的搜索属性键后面使用“desc”运算符。

此外,支持使用特殊的排序名字对象“距离”来按与某个数值最近的距离进行排序。 例如,“distance{number_key10=5} asc”将对结果进行排序,以便其“number_key10”搜索属性更接近值“5”的大厅在搜索结果中较早返回。

此字符串不能超过 100 个字符。

示例:“string_key1 asc,lobby/memberCount desc”

clientSearchResultCount const uint32_t*
可能是 nullptr

一个可选值,当由title_player_account实体指定时,它将限制完成响应中提供的结果数。

仅当使用 title_player_account 实体调用 PFMultiplayerFindLobbies 时,才能指定此值。

此值不能大于 PFLobbyClientRequestedSearchResultCountUpperLimit

如果未指定,则搜索结果数的限制是服务定义的,但不会大于 PFLobbyClientRequestedSearchResultCountUpperLimit

要求

标头: PFLobby.h

另请参阅

PFLobby 成员