Amazon GameLift Server SDK 4.x für C++: Datentypen

Verwenden Sie die Amazon GameLift SDK C++-Serverreferenz, um Ihr Multiplayer-Spiel für das Hosting bei Amazon zu integrieren GameLift. Hinweise zum Integrationsprozess finden Sie unterFüge Amazon GameLift zu deinem Spieleserver hinzu.

Anmerkung

Diese Referenz bezieht sich auf eine frühere Version des GameLift Amazon-ServersSDK. Informationen zur neuesten Version finden Sie unter Amazon GameLift Server SDK 5.x für C++: Datentypen.

Dies API ist in GameLiftServerAPI.hLogParameters.h, und definiertProcessParameters.h.

Amazon GameLift Server SDK 4.x für C++: Aktionen

DescribePlayerSessionsRequest

Dieser Datentyp wird verwendet, um anzugeben, welche Spielersitzung(en) abgerufen werden sollen. Sie können ihn wie folgt verwenden:

• Geben Sie a PlayerSessionId an, um eine bestimmte Spielersitzung anzufordern.

• Geben Sie a GameSessionId an, um alle Spielersitzungen in der angegebenen Spielsitzung anzufordern.

• Geben Sie a PlayerId an, um alle Spielersitzungen für den angegebenen Spieler anzufordern.

Verwenden Sie für große Sammlungen von Spielersitzungen die Paginierungsparameter, um Ergebnisse in aufeinander folgenden Blöcken abzurufen.

Inhalt

GameSessionId

Eindeutiger Bezeichner für die Spielsitzung. Verwenden Sie diesen Parameter, um alle Spielersitzungen für die angegebene Spielsitzung anzufragen. Das Format der Spielsitzungs-ID ist wie folgt: arn:aws:gamelift:<region>::gamesession/fleet-<fleet ID>/<ID string>. Der Wert von <ID-String> ist entweder eine benutzerdefinierte ID-Zeichenfolge (sofern bei der Erstellung der Spielsitzung angegeben) oder eine generierte Zeichenfolge.

Typ: Zeichenfolge

Erforderlich: Nein

Limit

Maximale Anzahl der zurückzugebenden Ergebnisse. Verwenden Sie diesen Parameter mit NextToken, um Ergebnisse in Form einer Reihe von aufeinanderfolgenden Seiten zu erhalten. Wenn eine Spielersitzungs-ID angegeben ist, wird dieser Parameter ignoriert.

Typ: Ganzzahl

Erforderlich: Nein

NextToken

Token, der den Beginn der nächsten Seite mit Ergebnissen anzeigt. Verwenden Sie den Token, der bei einem früheren Aufruf dieser Aktion zurückgegeben wurde. Um den Beginn des Ergebnissatzes anzugeben, geben Sie keinen Wert an. Wenn eine Spielersitzungs-ID angegeben ist, wird dieser Parameter ignoriert.

Typ: Zeichenfolge

Erforderlich: Nein

PlayerId

Eindeutiger Bezeichner für den Spieler. Spieler IDs werden vom Entwickler definiert. Siehe Generieren Sie Spieler-IDs.

Typ: Zeichenfolge

Erforderlich: Nein

PlayerSessionId

Eindeutiger Bezeichner für eine Spielersitzung.

Typ: Zeichenfolge

Erforderlich: Nein

PlayerSessionStatusFilter

Status der Spielersitzung für die Filterung der Ergebnisse. Mögliche Spielersitzungsstatus sind u. a.:

• RESERVED— Die Anfrage für die Spielersitzung wurde empfangen, aber der Spieler hat sich noch nicht mit dem Serverprozess verbunden und/oder wurde noch nicht validiert.

• ACTIVE— Der Spieler wurde durch den Serverprozess validiert und ist derzeit verbunden.

• COMPLETED— Die Spielerverbindung wurde unterbrochen.

• TIMEDOUT— Eine Anfrage für eine Spielersitzung wurde empfangen, aber der Spieler hat keine Verbindung hergestellt und/oder wurde innerhalb des Timeouts (60 Sekunden) nicht bestätigt.

Typ: Zeichenfolge

Erforderlich: Nein

LogParameters

Dieser Datentyp wird verwendet, um zu identifizieren, welche Dateien während einer Spielsitzung generiert wurden und die Amazon GameLift nach Ende der Spielsitzung hochladen und speichern soll. Diese Informationen werden dem GameLift Amazon-Service in einem ProcessReady() Anruf mitgeteilt.

Inhalt

logPaths

Verzeichnispfade zu den Protokolldateien des Spieleservers, die Amazon für den future GameLift Zugriff speichern soll. Diese Dateien werden während jeder Spielsitzung generiert. Dateipfade und Namen sind in Ihrem Spieleserver definiert und im Root-Spiel-Build-Verzeichnis gespeichert. Die Protokollpfade müssen absolut sein. Zum Beispiel: Wenn Ihr Spiel-Build Spielsitzungsprotokolle in einem Pfad wie MyGame\sessionlogs\ speichert, ist der Protokollpfad c:\game\MyGame\sessionLogs (auf einer Windows-Instance) oder /local/game/MyGame/sessionLogs (auf einer Linux-Instance).

Typ: std:vector<std::string>

Erforderlich: Nein

ProcessParameters

Dieser Datentyp enthält den Satz von Parametern, die in einem ProcessReady() Aufruf an den GameLift Amazon-Service gesendet werden.

Inhalt

port

Nummer des Ports, den der Serverprozess für neue Spielerverbindungen überwacht. Der Wert muss innerhalb des Port-Bereich liegen, der für eine Flotte definiert wurde, die diesen Spiel-Server-Build verwendet. Diese Portnummer ist in Spielsitzungs- und Spielersitzungsobjekten enthalten, die die Spielsitzungen bei der Verbindung mit einem Serverprozess verwenden.

Typ: Ganzzahl

Erforderlich: Ja

logParameters

Objekt mit einer Liste der Verzeichnispfade zu den Spielsitzungsprotokolldateien.

Typ: Aws::GameLift: :Server:: LogParameters

Erforderlich: Nein

onStartGameSitzung

Name der Callback-Funktion, die der GameLift Amazon-Dienst aufruft, um eine neue Spielsitzung zu aktivieren. Amazon GameLift ruft diese Funktion als Antwort auf die Kundenanfrage auf CreateGameSession. Die Callback-Funktion übergibt ein GameSessionObjekt (definiert in der Amazon GameLift Service API Reference).

Typ: const std::function<void(Aws::GameLift::Model::GameSession)> onStartGameSession

Erforderlich: Ja

onProcessTerminate

Name der Callback-Funktion, die der GameLift Amazon-Service aufruft, um das Herunterfahren des Serverprozesses zu erzwingen. Nach dem Aufruf dieser Funktion GameLift wartet Amazon fünf Minuten, bis der Serverprozess heruntergefahren ist, und antwortet mit einem ProcessEnding() Anruf. Wird keine Antwort empfangen, wird der Server-Prozess beendet.

Typ: std::function<void()> onProcessTerminate

Erforderlich: Nein

onHealthCheck

Name der Callback-Funktion, die der GameLift Amazon-Service aufruft, um einen Statusbericht vom Serverprozess anzufordern. Amazon GameLift ruft diese Funktion alle 60 Sekunden auf. Nach dem Aufrufen dieser Funktion GameLift wartet Amazon 60 Sekunden auf eine Antwort, und wenn keine eingeht, zeichnet Amazon den Serverprozess als fehlerhaft auf.

Typ: std::function<bool()> onHealthCheck

Erforderlich: Nein

onUpdateGameSitzung

Name der Callback-Funktion, die der GameLift Amazon-Service aufruft, um ein aktualisiertes Spielsitzungsobjekt an den Serverprozess zu übergeben. Amazon GameLift ruft diese Funktion auf, wenn eine Match-Backfill-Anfrage bearbeitet wurde, um aktualisierte Matchmaker-Daten bereitzustellen. Sie übergibt ein GameSessionObjekt, eine Statusmeldung (updateReason) und die Match-Backfill-Ticket-ID.

Typ: std::function<void(Aws::GameLift::Server::Model::UpdateGameSession)> onUpdateGameSession

Erforderlich: Nein

StartMatchBackfillRequest

Dieser Datentyp wird verwendet, um eine Matchmaking-Backfill-Anforderung zu versenden. Die Informationen werden in einem StartMatchBackfill() Anruf an den GameLift Amazon-Service übermittelt.

Inhalt

GameSessionArn

Eindeutiger Bezeichner für die Spielsitzung. Die API Aktion GetGameSessionId() gibt die Kennung im ARN Format zurück.

Typ: Zeichenfolge

Erforderlich: Ja

MatchmakingConfigurationArn

Eindeutiger Bezeichner in Form einerARN, den der Matchmaker für diese Anfrage verwenden kann. Um den Matchmaker zu finden, der für die Erstellung der ursprünglichen Spielsitzung verwendet wurde, suchen Sie im Spielsitzungsobjekt in der Dateneigenschaft Matchmaker. Erfahren Sie mehr über Matchmaker-Daten in Word mit Matchmaker-Daten.

Typ: Zeichenfolge

Erforderlich: Ja

Players

Ein Datensatz, der alle Spieler repräsentiert, die sich gerade in der Spielsitzung befinden. Der Matchmaker verwendet diese Informationen, um nach neuen Spielern zu suchen, die zu den aktuellen Spielern passen. Eine Beschreibung des Player-Objektformats finden Sie im GameLift APIAmazon-Referenzhandbuch. Spielerattribute und Teamzuweisungen finden Sie im Objekt „Spielsitzung“ in der Eigenschaft „Matchmaker-Daten“. IDs Wenn der Matchmaker die Latenz nutzt, erfassen Sie die aktualisierte Latenz für die aktuelle Region und nehmen Sie sie in die Daten jedes Spielers auf.

Typ: std:vectorhttps://docs.aws.amazon.com/gamelift/latest/apireference/API_Player.html <player>

Erforderlich: Ja

TicketId

Eindeutiger Bezeichner für ein Matchmaking- oder Match-Backfill-Request-Ticket. Wenn hier kein Wert angegeben GameLift wird, generiert Amazon einen Wert in Form einesUUID. Verwenden Sie diesen Bezeichner, um den Status des Backfill-Tickets zu verfolgen oder die Anfrage bei Bedarf abzubrechen.

Typ: Zeichenfolge

Erforderlich: Nein

StopMatchBackfillRequest

Dieser Datentyp wird verwendet, um eine Matchmaking-Backfill-Anforderung abzubrechen. Die Informationen werden in einem StopMatchBackfill() Anruf an den GameLift Amazon-Service übermittelt.

Inhalt

GameSessionArn

Eindeutiger Bezeichner der Spielsitzung für die Abbruchanfrage.

Typ: Zeichenfolge

Erforderlich: Ja

MatchmakingConfigurationArn

Eindeutiger Bezeichner des Matchmakers, an den diese Anfrage gesendet wurde.

Typ: Zeichenfolge

Erforderlich: Ja

TicketId

Eindeutiger Bezeichner des abzubrechenden Tickets für die Backfill-Anforderung.

Typ: Zeichenfolge

Erforderlich: Ja