Übersicht über die PFMultiplayer-C/C++-API – PFLobby.h
Funktionen
| Funktion | Beschreibung |
|---|---|
| PFLobbyAddMember | Fügen Sie dem Wartebereich einen lokalen Benutzer als Mitglied hinzu. |
| PFLobbyForceRemoveMember | Entfernen Sie eine Entität aus dem Wartebereich. |
| PFLobbyGetAccessPolicy | Ruft die Zugriffsrichtlinie des Wartebereichs ab. |
| PFLobbyGetConnectionString | Ruft die Standard-Verbindungszeichenfolge ab, die dem Wartebereich zugeordnet ist. |
| PFLobbyGetCustomContext | Ruft den privaten, benutzerdefinierten Kontextwert der App ab, der diesem Warteobjekt zuvor zugeordnet war. |
| PFLobbyGetLobbyId | Ruft die ID des Wartebereichs ab. |
| PFLobbyGetLobbyProperty | Rufen Sie den Wert der Lobbyeigenschaft aus ihrem Schlüssel ab. |
| PFLobbyGetLobbyPropertyKeys | Rufen Sie die Liste der Lobby-Eigenschaftenschlüssel ab. |
| PFLobbyGetMaxMemberCount | Ruft die maximale Anzahl der Mitglieder des Wartebereichs ab. |
| PFLobbyGetMemberConnectionStatus | Bestimmt die Verbindung eines Mitglieds status mit dem Benachrichtigungsdienst. |
| PFLobbyGetMemberProperty | Rufen Sie den Wert der Membereigenschaft aus ihrem Schlüssel ab. |
| PFLobbyGetMemberPropertyKeys | Ruft eine Liste der Eigenschaftenschlüssel des angegebenen Elements ab. |
| PFLobbyGetMembers | Ruft die Liste der PlayFab-Entitäten ab, die dem Wartebereich derzeit als Mitglieder beigetreten sind. |
| PFLobbyGetMembershipLock | Ruft den aktuellen Mitgliedschaftssperrstatus des Wartebereichs ab. |
| PFLobbyGetOwner | Ruft den aktuellen Besitzer des Wartebereichs ab. |
| PFLobbyGetOwnerMigrationPolicy | Ruft die Besitzermigrationsrichtlinie des Wartebereichs ab. |
| PFLobbyGetSearchProperty | Ruft den Sucheigenschaftswert aus seinem Schlüssel ab. |
| PFLobbyGetSearchPropertyKeys | Ruft die Liste der Sucheigenschaftenschlüssel ab. |
| PFLobbyGetServer | Ruft die Mit dem Wartebereich verknüpfte Serverentität ab. |
| PFLobbyGetServerConnectionStatus | Ruft die Verbindung des Warteservers status mit dem Benachrichtigungsdienst ab. |
| PFLobbyGetServerProperty | Rufen Sie den Wert der Lobbyservereigenschaft aus ihrem Schlüssel ab. |
| PFLobbyGetServerPropertyKeys | Rufen Sie eine Liste der Eigenschaftenschlüssel des Lobbyservers ab. |
| PFLobbyLeave | Fordern Sie einen oder alle lokalen Benutzer auf, den Wartebereich zu verlassen. |
| PFLobbyPostUpdate | Posten Sie ein Update im Wartebereich als Spieler. |
| PFLobbySendInvite | Senden Sie eine Einladung an diesen Wartebereich vom lokalen Benutzer an die eingeladene Entität. |
| PFLobbyServerDeleteLobby | Löschen Sie einen Wartebereich im Namen der game_server Entität, der die Lobby gehört. |
| PFLobbyServerLeaveAsServer | Fordert an, dass der Server den clienteigenen Wartebereich verlässt, in dem er sich derzeit befindet. |
| PFLobbyServerPostUpdate | Veröffentlichen Sie ein Update im Wartebereich als Serverbesitzer. |
| PFLobbyServerPostUpdateAsServer | Veröffentlichen Sie ein Update für einen clienteigenen Wartebereich als verknüpften Server. |
| PFLobbySetCustomContext | Konfiguriert einen optionalen, benutzerdefinierten Kontextwert in Zeigergröße mit diesem Lobbyobjekt. |
| PFMultiplayerClaimServerLobby | Anspruch auf den Besitz eines bereits vorhandenen Serverlobbys. |
| PFMultiplayerCreateAndClaimServerLobby | Erstellen Sie einen neuen Wartebereich als game_server Entität. |
| PFMultiplayerCreateAndJoinLobby | Erstellen Sie einen neuen Wartebereich, und fügen Sie ihr die erstellende PlayFab-Entität hinzu. |
| PFMultiplayerFindLobbies | Suchen Sie im Namen des lokalen Benutzers nach Lobbies. |
| PFMultiplayerFinishProcessingLobbyStateChanges | Gibt ein Array von PFLobbyStateChanges zurück, die verarbeitet wurden. |
| PFMultiplayerGetLobbyInviteListenerStatus | Rufen Sie die status des Einladungslisteners der Entität ab. |
| PFMultiplayerJoinArrangedLobby | Schließt sich einem Wartebereich mithilfe einer Anordnungszeichenfolge an, die von einem anderen Dienst bereitgestellt wird, z. B. Matchmaking. Wenn noch niemand dem Wartebereich beigetreten ist, wird der Wartebereich mit den Konfigurationsparametern initialisiert. |
| PFMultiplayerJoinLobby | Treten Sie einer Lobby als lokale PlayFab-Entität bei. |
| PFMultiplayerJoinLobbyAsServer | Treten Sie einer clienteigenen Lobby als Server bei. |
| PFMultiplayerStartListeningForLobbyInvites | Aktiviert den Wartelistener für Die Lobby-Einladung für eine bestimmte Entität. |
| PFMultiplayerStartProcessingLobbyStateChanges | Ruft ein Array aller PFLobbyStateChanges ab, die seit dem letzten Aufruf dieser Art verarbeitet werden sollen. |
| PFMultiplayerStopListeningForLobbyInvites | Deaktiviert den Wartelistener für Die Lobby-Einladung für eine bestimmte Entität. |
Strukturen
| Struktur | Beschreibung |
|---|---|
| PFLobbyArrangedJoinConfiguration | Die anfänglichen Konfigurationsdaten, die beim Beitreten zu einem angeordneten Wartebereich verwendet werden. |
| PFLobbyCreateConfiguration | Die anfänglichen Konfigurationsdaten, die beim Erstellen eines Wartebereichs verwendet werden. |
| PFLobbyDataUpdate | Eine Anforderung zum Durchführen eines Updates für den freigegebenen Teil des Wartebereichs. |
| PFLobbyJoinConfiguration | Die anfänglichen Konfigurationsdaten, die beim Beitritt zu einem Wartebereich verwendet werden. |
| PFLobbyMemberDataUpdate | Eine Anforderung, eine Aktualisierung des Mitgliederanteils des Wartedokuments vorzunehmen. |
| PFLobbyMemberUpdateSummary | Eine Sammlung von Hinweisen zu einem Update, das im Namen eines Mitglieds erfolgreich auf den Wartebereich angewendet wurde. |
| PFLobbySearchConfiguration | Die Konfigurationsstruktur, die verwendet wird, um anzugeben, wie ein PFMultiplayerFindLobbies-Vorgang ausgeführt werden soll. |
| PFLobbySearchFriendsFilter | Die Filterstruktur, die verwendet wird, um die Suchergebnisse der Lobby auf die Lobbies zu beschränken, die sich im Besitz der Freunde des Spielers befinden. |
| PFLobbySearchResult | Ein Eintrag in der Sammlung von Lobbysuchergebnissen, die nach erfolgreichem Abschluss eines PFMultiplayerFindLobbies-Vorgangs empfangen wurden. |
| PFLobbyServerDataUpdate | Eine Anforderung zum Durchführen einer Aktualisierung des zugeordneten Serverstatus eines clienteigenen Wartebereichs. |
| PFLobbyServerJoinConfiguration | Die anfänglichen Konfigurationsdaten, die beim Beitreten zu einem clienteigenen Wartebereich als Server verwendet werden. |
Zustandsänderungen
| Zustandsänderung | Beschreibung |
|---|---|
| PFLobbyAddMemberCompletedStateChange | Spezifische Informationen für den AddMemberCompleted-Typ der Zustandsänderung. |
| PFLobbyClaimServerLobbyCompletedStateChange | Spezifische Informationen für die Zustandsänderung vom Typ "ClaimServerLobbyCompleted ". |
| PFLobbyCreateAndClaimServerLobbyCompletedStateChange | Spezifische Informationen zum CreateAndClaimServerLobbyCompleted-Typ der Zustandsänderung. |
| PFLobbyCreateAndJoinLobbyCompletedStateChange | Spezifische Informationen für den CreateAndJoinLobbyCompleted-Typ der Zustandsänderung. |
| PFLobbyDisconnectedStateChange | Informationen, die für die Änderung des Zustands "Getrennt" spezifisch sind. |
| PFLobbyDisconnectingStateChange | Informationen, die für die Änderung des Zustands "Verbindung trennen" spezifisch sind. |
| PFLobbyFindLobbiesCompletedStateChange | Informationen speziell für den FindLobbiesCompleted-Typ der Zustandsänderung. |
| PFLobbyForceRemoveMemberCompletedStateChange | Spezifische Informationen für den ForceRemoveMemberCompleted-Typ der Zustandsänderung. |
| PFLobbyInviteListenerStatusChangedStateChange | Spezifische Informationen für die Zustandsänderungsart InviteListenerStatusChanged . |
| PFLobbyInviteReceivedStateChange | Spezifische Informationen für den InviteReceived-Typ der Zustandsänderung. |
| PFLobbyJoinArrangedLobbyCompletedStateChange | Spezifische Informationen für den JoinArrangedLobbyCompleted-Typ der Zustandsänderung. |
| PFLobbyJoinLobbyAsServerCompletedStateChange | Spezifische Informationen für den JoinLobbyAsServerCompleted-Typ der Zustandsänderung. |
| PFLobbyJoinLobbyCompletedStateChange | Spezifische Informationen für den JoinLobbyCompleted-Zustandsänderungstyp . |
| PFLobbyLeaveLobbyCompletedStateChange | Spezifische Informationen für den LeaveLobbyCompleted-Typ der Zustandsänderung. |
| PFLobbyMemberAddedStateChange | Spezifische Informationen für die Zustandsänderung vom Typ "MemberAdded ". |
| PFLobbyMemberRemovedStateChange | Informationen, die für den MemberRemoved-Typ der Zustandsänderung spezifisch sind. |
| PFLobbyPostUpdateCompletedStateChange | Informationen, die für den PostUpdateCompleted-Typ der Zustandsänderung spezifisch sind. |
| PFLobbySendInviteCompletedStateChange | Spezifische Informationen für den SendInviteCompleted-Typ der Zustandsänderung. |
| PFLobbyServerDeleteLobbyCompletedStateChange | Spezifische Informationen für den ServerDeleteLobbyCompleted-Typ der Zustandsänderung. |
| PFLobbyServerLeaveLobbyAsServerCompletedStateChange | Spezifische Informationen für den ServerLeaveLobbyAsServerCompleted-Typ der Zustandsänderung. |
| PFLobbyServerPostUpdateAsServerCompletedStateChange | Spezifische Informationen für den ServerPostUpdateAsServerCompleted-Typ der Zustandsänderung. |
| PFLobbyServerPostUpdateCompletedStateChange | Spezifische Informationen für den ServerPostUpdateCompleted-Typ der Zustandsänderung. |
| PFLobbyStateChange | Eine generische Basisstrukturdarstellung eines Ereignisses oder einer Zustandsänderung in der Lobbybibliothek. |
| PFLobbyUpdatedStateChange | Spezifische Informationen für den Aktualisierten Zustandsänderungstyp. |
Enumerationen
| Enumeration | Beschreibung |
|---|---|
| PFLobbyAccessPolicy | Werte, die die Zugriffsrichtlinie des Wartebereichs darstellen. |
| PFLobbyDisconnectingReason | Gründe, warum der Client keinen Zugriff mehr auf den Wartebereich hat. |
| PFLobbyInviteListenerStatus | Werte, die die aktuelle status eines Einladungslisteners darstellen. |
| PFLobbyMemberConnectionStatus | Werte, die die aktuelle status der Verbindung eines Mitglieds status mit dem Benachrichtigungsdienst darstellen. |
| PFLobbyMemberRemovedReason | Gründe, warum ein Mitglied aus einem Wartebereich entfernt wurde. |
| PFLobbyMembershipLock | Werte, die den Status der Mitgliedschaftssperre des Wartebereichs darstellen. |
| PFLobbyOwnerMigrationPolicy | Die verfügbaren Richtlinien, die der Lobbydienst verwenden kann, um den Besitz von Lobbys zwischen Mitgliedern zu migrieren. |
| PFLobbyServerConnectionStatus | Werte, die die aktuelle status der Verbindung des Lobbyservers status mit dem Benachrichtigungsdienst darstellen. |
| PFLobbyStateChangeType | Die Typen von Zustandsänderungen, die in der Lobbybibliothek auftreten können. |