PFLobbySearchConfiguration
Die Konfigurationsstruktur, die verwendet wird, um anzugeben, wie ein PFMultiplayerFindLobbies-Vorgang ausgeführt werden soll.
Syntax
struct PFLobbySearchConfiguration {
const PFLobbySearchFriendsFilter* friendsFilter;
const char* filterString;
const char* sortString;
const uint32_t* clientSearchResultCount;
}
Mitglieder
friendsFilter const PFLobbySearchFriendsFilter*
kann nullptr sein
Ein Filter, der, sofern angegeben, den Suchvorgang der Lobby auf diejenigen einschränkt, die sich im Besitz der Mitglieder der verschiedenen Freundeslisten dieses Spielers befinden.
Wenn nicht angegeben, durchsucht der Suchvorgang alle verfügbaren Lobbies.
Dieser Wert kann nur angegeben werden, wenn PFMultiplayerFindLobbies mit einer title_player_account-Entität aufgerufen wird.
filterString const char*
ist NULL-terminiert.
Die Abfragezeichenfolge, mit der gefiltert wird, welche Lobbies in den Suchergebnissen zurückgegeben werden.
Diese Zeichenfolge ist in einer OData-ähnlichen Filtersyntax formatiert.
Nur die folgenden Operatoren werden unterstützt: "and" (logisches und), "eq" (gleich), "ne" (ungleich), "ge" (größer als oder gleich), "gt" (größer als), "le" (kleiner als oder gleich) und "lt" (kleiner als).
Die linke Seite jedes logischen OData-Ausdrucks sollte entweder ein Sucheigenschaftenschlüssel (z. B. string_key1, number_key3 usw.) oder einer der vordefinierten Suchschlüssel (PFLobbyMemberCountSearchKey, PFLobbyAmMemberSearchKeyoder PFLobbyMembershipLockSearchKey) sein.
Die linke Seite jedes logischen OData-Ausdrucks sollte ein Sucheigenschaftenschlüssel sein.
Diese Zeichenfolge darf 500 Zeichen nicht überschreiten.
Beispiel: "lobby/membershipLock eq 'Unlocked' and string_key1 eq 'CaptureTheFlag' and number_key10 gt 50 and lobby/memberCount lt 5"
sortString const char*
ist NULL-terminiert.
Die Abfragezeichenfolge, die verwendet wird, um die in den Suchergebnissen zurückgegebenen Lobbies zu sortieren.
Diese Zeichenfolge ist in einer OData-ähnlichen Sortiersyntax formatiert: eine durch Trennzeichen getrennte Liste von Sucheigenschaftenschlüsseln mit einem optionalen Bezeichner, der entweder in aufsteigender oder absteigender Reihenfolge sortiert werden kann.
Um aufsteigende Reihenfolge anzugeben, verwenden Sie den Operator "asc" nach dem zugeordneten Sucheigenschaftenschlüssel. Um absteigende Reihenfolge anzugeben, verwenden Sie den Operator "desc" nach dem zugeordneten Sucheigenschaftenschlüssel.
Darüber hinaus wird ein spezieller Sortiermoniker,Distance, unterstützt, um die Sortierung nach dem nächstgelegenen Abstand von einem numerischen Wert zu ermöglichen. Beispielsweise sortiert "distance{number_key10=5} asc" die Ergebnisse, sodass Lobbies, deren Sucheigenschaft "number_key10" näher am Wert "5" liegt, früher in den Suchergebnissen zurückgegeben werden.
Diese Zeichenfolge darf 100 Zeichen nicht überschreiten.
Beispiel: "string_key1 asc,lobby/memberCount desc"
clientSearchResultCount const uint32_t*
kann nullptr sein
Ein optionaler Wert, der bei Angabe durch title_player_account Entitäten die Anzahl der in der Abschlussantwort bereitgestellten Ergebnisse begrenzt.
Dieser Wert kann nur angegeben werden, wenn PFMultiplayerFindLobbies mit einer title_player_account-Entität aufgerufen wird.
Dieser Wert darf nicht höher als PFLobbyClientRequestedSearchResultCountUpperLimitsein.
Wenn nicht angegeben, ist der Grenzwert für die Anzahl von Suchergebnissen vom Dienst definiert, aber nicht größer als PFLobbyClientRequestedSearchResultCountUpperLimit.
Voraussetzungen
Header: PFLobby.h