次の方法で共有

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 など) または定義済みの検索キー (PFLobbyMemberCountSearchKey、PFLobbyAmMemberSearchKey、または PFLobbyMembershipLockSearchKey) のいずれかを指定する必要があります。

各 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 に似た並べ替え構文で書式設定されます。検索プロパティ キーのコンマ区切りリストと、昇順または降順で並べ替えるオプションの指定子が含まれます。

昇順を指定するには、関連付けられている検索プロパティ キーの後に "asc" 演算子を使用します。 降順を指定するには、関連付けられている検索プロパティ キーの後に "desc" 演算子を使用します。

さらに、特殊な並べ替えリンク パス (距離) がサポートされており、一部の数値から最も近い距離で並べ替えることができます。 たとえば、"distance{number_key10=5} asc" は結果を並べ替え、値 "5" に近い "number_key10" 検索プロパティを持つロビーが検索結果の早い方を返すようにします。

この文字列は 100 文字以下にする必要があります。

例: "string_key1 asc,lobby/memberCount desc"

clientSearchResultCount const uint32_t*
nullptr でもかまいません

title_player_account エンティティで指定された場合、完了応答で提供される結果の数を制限する省略可能な値。

この値は、TITLE_PLAYER_ACCOUNT エンティティを使用して PFMultiplayerFindLobbies が呼び出された場合にのみ指定できます。

この値は、PFLobbyClientRequestedSearchResultCountUpperLimit より大きくすることはできません。

指定しない場合、検索結果の数の制限はサービス定義ですが、PFLobbyClientRequestedSearchResultCountUpperLimit 以下になります。

要件

ヘッダー: PFLobby.h

関連項目

PFLobby メンバー