AcceptPlayerSession()ActivateGameSession()DescribePlayerSessions()GetGameSessionId()GetInstanceCertificate()GetSdkVersion()GetTerminationTime()InitSDK()ProcessEnding()ProcessReady()RemovePlayerSession()StartMatchBackfill()StopMatchBackfill()TerminateGameSession()UpdatePlayerSessionCreationPolicy()

Referenz zum GameLift Amazon-Server-SDK (C#): Aktionen

Sie können diese Amazon GameLift C#-Server-SDK-Referenz verwenden, um Ihr Multiplayer-Spiel für die Verwendung mit Amazon GameLift vorzubereiten. Einzelheiten zum Integrationsprozess finden Sie unterFüge Amazon GameLift zu deinem Gameserver hinzu.

Aktionen
Datentypen

AcceptPlayerSession()

Benachrichtigt den GameLift Amazon-Dienst, dass ein Spieler mit der angegebenen Spielersitzungs-ID eine Verbindung zum Serverprozess hergestellt hat und eine Überprüfung benötigt. Amazon GameLift überprüft, ob die Spielersitzungs-ID gültig ist, d. h., ob die Spieler-ID einen Spielerplatz in der Spielsitzung reserviert hat. Nach der Bestätigung GameLift ändert Amazon den Status des Spielerslots von RESERVED auf ACTIVE.

Syntax


GenericOutcome AcceptPlayerSession(String playerSessionId)

Parameter

playerSessionId

Eindeutige ID, die von Amazon ausgestellt wird, GameLift wenn eine neue Spielersitzung erstellt wird. Eine Player-Sitzungs-ID ist in einem PlayerSession Objekt angegeben, das als Antwort auf einen Client-Aufruf der GameLiftAPI-Aktionen StartGameSessionPlacement, CreateGameSession DescribeGameSessionPlacement, oder zurückgegeben wird DescribePlayerSessions.

Typ: Zeichenfolge

Erforderlich: Ja

Rückgabewert

Gibt ein generisches Ergebnis zurück, das aus Erfolg oder Misserfolg mit einer Fehlermeldung besteht.

Beispiel

Dieses Beispiel veranschaulicht eine Funktion für die Verarbeitung einer Verbindungsanforderung, einschließlich dem Validieren und Abweisen ungültiger Spielersitzungs-IDs.


void ReceiveConnectingPlayerSessionID (Connection connection, String playerSessionId){
    var acceptPlayerSessionOutcome =  GameLiftServerAPI.AcceptPlayerSession(playerSessionId);
     if(acceptPlayerSessionOutcome.Success)
    {
        connectionToSessionMap.emplace(connection, playerSessionId);
        connection.Accept();
    }
     else 
    {
        connection.Reject(acceptPlayerSessionOutcome.Error.ErrorMessage);    }       
}

ActivateGameSession()

Benachrichtigt den GameLift Amazon-Dienst, dass der Serverprozess eine Spielsitzung aktiviert hat und nun bereit ist, Spielerverbindungen zu empfangen. Diese Aktion muss im Rahmen der onStartGameSession()-Callback-Funktion aufgerufen werden, nachdem die Initialisierung der Spielsitzung vollständig abgeschlossen ist.

Syntax


GenericOutcome ActivateGameSession()

Parameter

Diese Aktion hat keine Parameter.

Rückgabewert

Gibt ein generisches Ergebnis zurück, das aus Erfolg oder Misserfolg mit einer Fehlermeldung besteht.

Beispiel

In diesem Beispiel wird ActivateGameSession() als Teil der onStartGameSession()-Delegate-Funktion aufgerufen.


void OnStartGameSession(GameSession gameSession)
{
    // game-specific tasks when starting a new game session, such as loading map   

    // When ready to receive players   
    var activateGameSessionOutcome = GameLiftServerAPI.ActivateGameSession();
}

DescribePlayerSessions()

Ruft Sitzungsdaten der Spieler, einschließlich Einstellungen, Metadaten zu der Sitzung und Spielerdaten ab. Verwenden Sie diese Aktion, um für eine einzelne Spielersitzung, für alle Spielersitzungen in einer Spielsitzung oder für alle Spielersitzungen zu einer einzelnen Spieler-ID abzurufen.

Syntax


DescribePlayerSessionsOutcome DescribePlayerSessions(DescribePlayerSessionsRequest describePlayerSessionsRequest)

Parameter

describePlayerSessionsAnfrage

Ein DescribePlayerSessionsRequest-Objekt, mit dem beschrieben wird, welche Spielersitzungen abgerufen werden sollen.

Erforderlich: Ja

Rückgabewert

Wenn sie erfolgreich ausgeführt wird, gibt die Funktion ein DescribePlayerSessionsOutcome-Objekt mit einer Menge von Spielersitzungsobjekten zurück, die den Anforderungsparametern entsprechen. Player-Sitzungsobjekte haben eine Struktur, die mit dem GameLift PlayerSessionAmazon-API-Datentyp des AWS SDK identisch ist.

Beispiel

Dieses Beispiel zeigt eine Anforderung für alle Spielersitzungen, die derzeit aktiv mit einer angegebenen Spielsitzung verbunden sind. Wenn Sie den Grenzwert weglassen NextTokenund auf 10 setzen, gibt Amazon GameLift die Datensätze der ersten 10 Spielersitzungen zurück, die der Anfrage entsprechen.


// Set request parameters 
var describePlayerSessionsRequest = new Aws.GameLift.Server.Model.DescribePlayerSessionsRequest()
{
    GameSessionId = GameLiftServerAPI.GetGameSessionId().Result,    //gets the ID for the current game session
    Limit = 10,
    PlayerSessionStatusFilter = PlayerSessionStatusMapper.GetNameForPlayerSessionStatus(PlayerSessionStatus.ACTIVE)
}; 
// Call DescribePlayerSessions
Aws::GameLift::DescribePlayerSessionsOutcome playerSessionsOutcome = 
    Aws::GameLift::Server::Model::DescribePlayerSessions(describePlayerSessionRequest);

GetGameSessionId()

Ruft die ID der Spielsitzung ab, die derzeit von dem Serverprozess gehostet wird, wenn der Serverprozess aktiv ist.

Bei inaktiven Prozessen, die noch nicht mit einer Spielsitzung aktiviert wurden, gibt der Aufruf Success = True und GameSessionId = "" (eine leere Zeichenfolge) zurück.

Syntax


AwsStringOutcome GetGameSessionId()

Parameter

Diese Aktion hat keine Parameter.

Rückgabewert

War der Aufruf erfolgreich, gibt die Funktion die Spielsitzungs-ID als AwsStringOutcome-Objekt zurück. Wenn die Funktion nicht erfolgreich ausgeführt wird, wird eine Fehlermeldung zurückgegeben.

Beispiel


var getGameSessionIdOutcome = GameLiftServerAPI.GetGameSessionId();

GetInstanceCertificate()

Ruft den Speicherort eines PEM-kodierten TLS-Zertifikats ab, das der Flotte und ihren Instanzen zugeordnet ist. AWS Certificate Managergeneriert dieses Zertifikat, wenn Sie eine neue Flotte erstellen, wobei die Zertifikatskonfiguration auf GENERATED gesetzt ist. Verwenden Sie dieses Zertifikat, um eine sichere Verbindung mit einem Spiele-Client herzustellen und die Client-/Serverkommunikation zu verschlüsseln.

Syntax


GetInstanceCertificateOutcome GetInstanceCertificate();

Parameter

Diese Aktion hat keine Parameter.

Rückgabewert

Bei Erfolg wird ein GetInstanceCertificateOutcome Objekt zurückgegeben, das den Speicherort der TLS-Zertifikatsdatei und der Zertifikatskette der Flotte enthält, die auf der Instanz gespeichert sind. Eine Stammzertifikatsdatei, die aus der Zertifikatskette extrahiert wurde, wird ebenfalls auf der Instanz gespeichert. Wenn die Funktion nicht erfolgreich ausgeführt wird, wird eine Fehlermeldung zurückgegeben.

Weitere Informationen über das Zertifikat und die Zertifikatskettendaten finden Sie unter GetCertificateAntwortelemente in der AWS Certificate Manager API-Referenz.

Beispiel


var getInstanceCertificateOutcome = GameLiftServerAPI.GetInstanceCertificate();

GetSdkVersion()

Gibt die aktuelle Versionsnummer des SDK zurück, das in den Serverprozess integriert ist.

Syntax


AwsStringOutcome GetSdkVersion()

Parameter

Diese Aktion hat keine Parameter.

Rückgabewert

War der Aufruf erfolgreich, gibt die Funktion die aktuelle SDK-Version als AwsStringOutcome-Objekt zurück. Die zurückgegebene Zeichenfolge enthält nur die Versionsnummer (z. B. „3.1.5"). Wenn die Funktion nicht erfolgreich ausgeführt wird, wird eine Fehlermeldung zurückgegeben.

Beispiel


var getSdkVersionOutcome = GameLiftServerAPI.GetSdkVersion();

GetTerminationTime()

Gibt die Zeit zurück, für die das Herunterfahren eines Serverprozesses geplant ist (wenn eine Zeit zum Beenden verfügbar ist). Ein Serverprozess führt diese Aktion aus, nachdem er einen onProcessTerminate() Rückruf vom GameLift Amazon-Dienst erhalten hat. Amazon GameLift kann aus den folgenden onProcessTerminate() Gründen anrufen: (1) wegen eines schlechten Zustands (der Serverprozess hat den Port-Zustand gemeldet oder hat Amazon nicht reagiert)GameLift, (2) wenn die Instance während eines Scale-Down-Ereignisses beendet wird oder (3) wenn eine Instance aufgrund einer Spot-Instance-Unterbrechung beendet wird.

Wenn der Prozess einen onProcessTerminate() Rückruf erhalten hat, ist der zurückgegebene Wert die geschätzte Abbruchzeit. Wenn der Prozess keinen onProcessTerminate() Rückruf erhalten hat, wird eine Fehlermeldung zurückgegeben. Weitere Informationen über das Herunterfahren eines Serverprozesses.

Syntax


AwsDateTimeOutcome GetTerminationTime()

Parameter

Diese Aktion hat keine Parameter.

Rückgabewert

Bei Erfolg wird die Abbruchzeit als AwsDateTimeOutcome Objekt zurückgegeben. Der Wert ist die Abbruchzeit, ausgedrückt in verstrichenen Ticks seit 0001 00:00:00. Beispielsweise entspricht der Datums-/Uhrzeitwert 2020-09-13 12:26:40 -000Z 637355968000000000 Ticks. Wenn keine Kündigungszeit verfügbar ist, wird eine Fehlermeldung zurückgegeben.

Beispiel


var getTerminationTimeOutcome = GameLiftServerAPI.GetTerminationTime();

InitSDK()

Initialisiert das Amazon GameLift SDK. Diese Methode sollte beim Start aufgerufen werden, bevor eine andere Initialisierung GameLift im Zusammenhang mit Amazon erfolgt.

Syntax


InitSDKOutcome InitSDK()

Parameter

Diese Aktion hat keine Parameter.

Rückgabewert

Bei Erfolg wird ein InitSdkOutcome Objekt zurückgegeben, das angibt, dass der Serverprozess zum Aufrufen bereit istProcessReady().

Beispiel


var initSDKOutcome = GameLiftServerAPI.InitSDK();

ProcessEnding()

Benachrichtigt den GameLift Amazon-Dienst, dass der Serverprozess heruntergefahren wird. Diese Methode sollte aufgerufen werden, nachdem alle anderen Aufgaben ausgeführt sind, und insbesondere auch alle aktiven Spielsitzungen beendet sind. Diese Methode sollte mit einem Beendigungscode 0 beendet werden. Andere Beendigungscodes sorgen für eine Ereignisnachricht zum unsauberen Beenden des Prozesses.

Sobald die Methode mit einem Code von 0 beendet wird, können Sie den Prozess mit einem erfolgreichen Exit-Code beenden. Sie können den Vorgang auch mit einem Fehlercode beenden. Wenn Sie den Vorgang mit einem Fehlercode beenden, zeigt das Flottenereignis an, dass der Prozess ungewöhnlich beendet wurde (SERVER_PROCESS_TERMINATED_UNHEALTHY).

Syntax


GenericOutcome ProcessEnding()

Parameter

Diese Aktion hat keine Parameter.

Rückgabewert

Gibt ein generisches Ergebnis zurück, das aus Erfolg oder Misserfolg mit einer Fehlermeldung besteht.

Beispiel


var processEndingOutcome = GameLiftServerAPI.ProcessEnding();
if (processReadyOutcome.Success)
   Environment.Exit(0);
// otherwise, exit with error code
Environment.Exit(errorCode);

ProcessReady()

Benachrichtigt den GameLift Amazon-Dienst, dass der Serverprozess bereit ist, Spielesitzungen zu hosten. Rufen Sie diese Methode auf, nachdem Sie die Einrichtungsaufgaben erfolgreich aufgerufen InitSDK() und abgeschlossen haben, die erforderlich sind, bevor der Serverprozess eine Spielsitzung hosten kann. Diese Methode sollte nur einmal pro Prozess aufgerufen werden.

Syntax


GenericOutcome ProcessReady(ProcessParameters processParameters)

Parameter

processParameters

Ein ProcessParameters-Objekt, das die folgenden Informationen über den Serverprozess mitteilt:

Namen der im Spieleservercode implementierten Callback-Methoden, die der GameLift Amazon-Dienst zur Kommunikation mit dem Serverprozess aufruft.
Die Portnummer, auf der der Serverprozess horcht.
Pfad zu allen spielsitzungsspezifischen Dateien, die Amazon erfassen und GameLift speichern soll.

Erforderlich: Ja

Rückgabewert

Gibt ein generisches Ergebnis zurück, das aus Erfolg oder Misserfolg mit einer Fehlermeldung besteht.

Beispiel

Dieses Beispiel veranschaulicht die Implementierung des ProcessReady()-Aufrufs und der Delegate-Funktion.


// Set parameters and call ProcessReady
var processParams = new ProcessParameters(
   this.OnGameSession,
   this.OnProcessTerminate,
   this.OnHealthCheck,
   this.OnGameSessionUpdate,
   port,
   new LogParameters(new List<string>()          // Examples of log and error files written by the game server
   {
      "C:\\game\\logs",
      "C:\\game\\error"
   })
);

var processReadyOutcome = GameLiftServerAPI.ProcessReady(processParams);

// Implement callback functions
void OnGameSession(GameSession gameSession)
{
   // game-specific tasks when starting a new game session, such as loading map
   // When ready to receive players
   var activateGameSessionOutcome = GameLiftServerAPI.ActivateGameSession();
}

void OnProcessTerminate()
{
   // game-specific tasks required to gracefully shut down a game session, 
   // such as notifying players, preserving game state data, and other cleanup
    var ProcessEndingOutcome = GameLiftServerAPI.ProcessEnding();
}

bool OnHealthCheck()
{
    bool isHealthy;
    // complete health evaluation within 60 seconds and set health
    return isHealthy;
}

RemovePlayerSession()

Benachrichtigt den GameLift Amazon-Dienst, dass ein Spieler mit der angegebenen Spieler-Sitzungs-ID die Verbindung zum Serverprozess getrennt hat. Als Reaktion darauf GameLift ändert Amazon den Spielerplatz auf verfügbar, sodass er einem neuen Spieler zugewiesen werden kann.

Syntax


GenericOutcome RemovePlayerSession(String playerSessionId)

Parameter

playerSessionId

Typ: Zeichenfolge

Erforderlich: Ja

Rückgabewert

Gibt ein generisches Ergebnis zurück, das aus Erfolg oder Misserfolg mit einer Fehlermeldung besteht.

Beispiel


Aws::GameLift::GenericOutcome disconnectOutcome = 
    Aws::GameLift::Server::RemovePlayerSession(playerSessionId);

StartMatchBackfill()

Sendet eine Anforderung zur Suche nach neuen Spielern für offene Slots in einer Spielsitzung, die mit FlexMatch erstellt wurde. Siehe auch die AWS SDK-Aktion StartMatchBackfill(). Mit dieser Aktion können Match-Backfill-Anforderungen von einem Game-Server-Prozess initiiert werden, der die Spielsitzung hostet. Erfahren Sie mehr über die FlexMatchBackfill-Funktion.

Diese Aktion ist asynchron. Wenn neue Spieler erfolgreich gematcht werden, liefert der GameLift Amazon-Service mithilfe der Callback-Funktion aktualisierte Matchmaker-Daten. OnUpdateGameSession()

Ein Serverprozess kann immer nur eine aktive Match-Backfill-Anforderung haben. Um eine neue Anforderung zu senden, rufen Sie zuerst StopMatchBackfill() auf, um die ursprüngliche Anforderung abzubrechen.

Syntax


StartMatchBackfillOutcome StartMatchBackfill (StartMatchBackfillRequest startBackfillRequest);

Parameter

StartMatchBackfillRequest

Ein StartMatchBackfillRequest-Objekt, das die folgenden Informationen übermittelt:

Eine Ticket-ID für die Zuordnung zur Backfill-Anforderung. Diese Information ist optional. Wenn keine ID angegeben GameLift wird, generiert Amazon automatisch eine.
Der Matchmaker, an den die Anfrage gesendet werden soll. Der vollständige ARN der Konfiguration ist erforderlich. Dieser Wert kann aus den Matchmaker-Daten der Spielsitzung abgerufen werden.
Die ID der Spielsitzung für das Backfill.
Verfügbare Matchmaking-Daten für die aktuellen Spieler der Spielsitzung.

Erforderlich: Ja

Rückgabewert

Gibt ein StartMatchBackfillOutcome Objekt mit der Match-Backfill-Ticket-ID oder einen Fehler mit einer Fehlermeldung zurück.

Beispiel


// Build a backfill request
var startBackfillRequest = new AWS.GameLift.Server.Model.StartMatchBackfillRequest()
{
    TicketId = "a ticket ID", //optional
    MatchmakingConfigurationArn = "the matchmaker configuration ARN", 
    GameSessionId = GameLiftServerAPI.GetGameSessionId().Result,    // gets ID for current game session
        //get player data for all currently connected players
            MatchmakerData matchmakerData =        
              MatchmakerData.FromJson(gameSession.MatchmakerData);  // gets matchmaker data for current players
            // get matchmakerData.Players
            // remove data for players who are no longer connected
    Players = ListOfPlayersRemainingInTheGame
};

// Send backfill request
var startBackfillOutcome = GameLiftServerAPI.StartMatchBackfill(startBackfillRequest);

// Implement callback function for backfill
void OnUpdateGameSession(GameSession myGameSession)
{
   // game-specific tasks to prepare for the newly matched players and update matchmaker data as needed  
}

StopMatchBackfill()

Bricht eine aktive mit dem Befehl StartMatchBackfill() erstellte Match-Backfill-Anforderung ab. Siehe auch die AWS SDK-Aktion StopMatchmaking(). Erfahren Sie mehr über die FlexMatchBackfill-Funktion.

Syntax


GenericOutcome StopMatchBackfill (StopMatchBackfillRequest stopBackfillRequest);

Parameter

StopMatchBackfillRequest

Ein StopMatchBackfillRequest-Objekt, das das abzubrechende Matchmaking-Ticket identifiziert:

Ticket-ID der abzubrechenden Backfill-Anforderung
Matchmaker, an den die Backfill-Anforderung gesendet wurde
Spielsitzung für die Backfill-Anforderung

Erforderlich: Ja

Rückgabewert

Gibt ein generisches Ergebnis zurück, das aus Erfolg oder Misserfolg mit einer Fehlermeldung besteht.

Beispiel


// Set backfill stop request parameters

var stopBackfillRequest = new AWS.GameLift.Server.Model.StopMatchBackfillRequest()
{
    TicketId = "a ticket ID", //optional, if not provided one is autogenerated
    MatchmakingConfigurationArn = "the matchmaker configuration ARN", //from the game session matchmaker data
    GameSessionId = GameLiftServerAPI.GetGameSessionId().Result    //gets the ID for the current game session
};

var stopBackfillOutcome = GameLiftServerAPI.StopMatchBackfillRequest(stopBackfillRequest);

TerminateGameSession()

Diese Methode ist mit Version 4.0.1 veraltet. Stattdessen sollte der Serverprozess ProcessEnding() nach dem Ende einer Spielsitzung aufgerufen werden.

Benachrichtigt den GameLift Amazon-Dienst, dass der Serverprozess die aktuelle Spielsitzung beendet hat. Diese Aktion wird aufgerufen, wenn der Serverprozess aktiv bleibt und bereit ist, eine neue Spielsitzung zu veranstalten. Es sollte erst aufgerufen werden, nachdem das Verfahren zur Beendigung der Spielsitzung abgeschlossen ist, da es Amazon signalisiertGameLift, dass der Serverprozess sofort für das Hosten einer neuen Spielsitzung verfügbar ist.

Diese Aktion wird nicht aufgerufen, wenn der Serverprozess nach Beendigung der Spielsitzung heruntergefahren wird. Rufen Sie stattdessen an, ProcessEnding() um zu signalisieren, dass sowohl die Spielsitzung als auch der Serverprozess beendet werden.

Syntax


GenericOutcome TerminateGameSession()

Parameter

Diese Aktion hat keine Parameter.

Rückgabewert

Gibt ein generisches Ergebnis zurück, das aus Erfolg oder Misserfolg mit einer Fehlermeldung besteht.

Beispiel

Dieses Beispiel zeigt einen Serverprozess am Ende einer Spielsitzung.


// game-specific tasks required to gracefully shut down a game session, 
// such as notifying players, preserving game state data, and other cleanup

var terminateGameSessionOutcome = GameLiftServerAPI.TerminateGameSession();
var processReadyOutcome = GameLiftServerAPI.ProcessReady(processParams);

UpdatePlayerSessionCreationPolicy()

Aktualisiert die Kapazität der aktuellen Spielsitzung zur Aufnahme neuer Spielersitzungen. Eine Spielsitzung kann so eingerichtet werden, dass Sie alle neuen Spieler-Sitzungen akzeptiert oder ablehnt. (Siehe auch die Aktion UpdateGameSession() in der Amazon GameLift Service API-Referenz).

Syntax


GenericOutcome UpdatePlayerSessionCreationPolicy(PlayerSessionCreationPolicy playerSessionPolicy)

Parameter

newPlayerSessionRichtlinie

Zeichenfolgenwert, der angibt, ob die Spielsitzung neue Spieler akzeptiert.

Eingabe: PlayerSessionCreationPolicy enum. Gültige Werte sind:

ACCEPT_ALL – Akzeptiert alle neuen Spielersitzungen.
DENY_ALL – Verwehrt neue Spielersitzungen.

Erforderlich: Ja

Rückgabewert

Gibt ein generisches Ergebnis zurück, das aus Erfolg oder Misserfolg mit einer Fehlermeldung besteht.

Beispiel

In diesem Beispiel werden die Richtlinien für die aktuelle Spielsitzung für neue Spieler so festgelegt, dass alle Spieler akzeptiert werden.


var updatePlayerSessionCreationPolicyOutcomex = 
    GameLiftServerAPI.UpdatePlayerSessionCreationPolicy(PlayerSessionCreationPolicy.ACCEPT_ALL);

Warnung JavaScript ist in Ihrem Browser nicht verfügbar oder deaktiviert.

Zur Nutzung der AWS-Dokumentation muss JavaScript aktiviert sein. Weitere Informationen finden auf den Hilfe-Seiten Ihres Browsers.

Dokumentkonventionen

Server-SDK-Referenz 4.x für C#

Datentypen