GetSdkVersion()InitSDK()InitSDK()ProcessReady()ProcessEnding()ActivateGameSession()UpdatePlayerSessionCreationPolicy()GetGameSessionId()GetTerminationTime()AcceptPlayerSession()RemovePlayerSession()DescribePlayerSessions()StartMatchBackfill()StopMatchBackfill()GetComputeCertificate()GetFleetRoleCredentials()Distruggi ()

Riferimento all'SDK GameLift del server Amazon per C# e Unity: azioni

Questo riferimento all'SDK del server Amazon GameLift C# ti aiuta a preparare il tuo gioco multiplayer da utilizzare con Amazon. GameLift Per i dettagli sul processo di integrazione, consulta Aggiungi Amazon GameLift al tuo server di gioco e per informazioni sull'utilizzo del plug-in SDK del server C# per Unity, consulta. Integra Amazon GameLift in un progetto Unity

Azioni

GetSdkVersion()
InitSDK()
InitSDK()
ProcessReady()
ProcessEnding()
ActivateGameSession()
UpdatePlayerSessionCreationPolicy()
GetGameSessionId()
GetTerminationTime()
AcceptPlayerSession()
RemovePlayerSession()
DescribePlayerSessions()
StartMatchBackfill()
StopMatchBackfill()
GetComputeCertificate()
GetFleetRoleCredentials()
Distruggi ()

GetSdkVersion()

Restituisce il numero di versione corrente dell'SDK integrato nel processo del server.

Sintassi


AwsStringOutcome GetSdkVersion();

Valore restituito

Se l'esito è positivo, restituisce la versione corrente dell'SDK come oggetto AwsStringOutcome. La stringa restituita include il numero di versione (esempio5.0.0). Se l'esito è negativo, verrà restituito un messaggio di errore.

Esempio


var getSdkVersionOutcome = GameLiftServerAPI.GetSdkVersion();

InitSDK()

Inizializza l'Amazon GameLift SDK per una flotta EC2 gestita. Chiama questo metodo all'avvio, prima che GameLift si verifichi qualsiasi altra inizializzazione relativa ad Amazon. Questo metodo legge i parametri del server dall'ambiente host per configurare la comunicazione tra il server e il GameLift servizio Amazon.

Sintassi


GenericOutcome InitSDK();

Valore restituito

In caso di successo, restituisce un InitSdkOutcome oggetto per indicare che il processo del server è pronto per la chiamataProcessReady().

Esempio


//Call InitSDK to establish a local connection with the GameLift agent to enable further communication.
GenericOutcome initSDKOutcome = GameLiftServerAPI.InitSDK();

InitSDK()

Inizializza l'Amazon GameLift SDK per una flotta. Anywhere Chiama questo metodo all'avvio, prima che GameLift si verifichi qualsiasi altra inizializzazione relativa ad Amazon. Questo metodo richiede parametri espliciti del server per configurare la comunicazione tra il server e il GameLift servizio Amazon.

Sintassi


GenericOutcome InitSDK(ServerParameters serverParameters);

Parametri

ServerParameters

Per inizializzare un server di gioco su una GameLift Anywhere flotta Amazon, costruisci un ServerParameters oggetto con le seguenti informazioni:

L'URL WebSocket usato per connetterti al tuo server di gioco.
L'ID del processo utilizzato per ospitare il server di gioco.
L'ID del computer che ospita i processi del server di gioco.
L'ID della GameLift flotta Amazon contenente i tuoi dati di GameLift Anywhere calcolo Amazon.
Il token di autorizzazione generato dall' GameLift operazione Amazon.

Valore restituito

In caso di successo, restituisce un InitSdkOutcome oggetto per indicare che il processo del server è pronto per la chiamataProcessReady().

Nota

Se le chiamate a non InitSDK() riescono per le build di gioco distribuite sulle flotte Anywhere, controlla il ServerSdkVersion parametro utilizzato durante la creazione della risorsa di compilazione. È necessario impostare esplicitamente questo valore sulla versione SDK del server in uso. Il valore predefinito per questo parametro è 4.x, che non è compatibile. Per risolvere questo problema, crea una nuova build e distribuiscila in una nuova flotta.

Esempio


//Define the server parameters
string websocketUrl = "wss://us-west-1.api.amazongamelift.com";
string processId = "PID1234";
string fleetId = "aarn:aws:gamelift:us-west-1:111122223333:fleet/fleet-9999ffff-88ee-77dd-66cc-5555bbbb44aa";
string hostId = "HardwareAnywhere";
string authToken = "1111aaaa-22bb-33cc-44dd-5555eeee66ff";
ServerParameters serverParameters = 
  new ServerParameters(webSocketUrl, processId, hostId, fleetId, authToken);

//Call InitSDK to establish a local connection with the GameLift agent to enable further communication.
GenericOutcome initSDKOutcome = GameLiftServerAPI.InitSDK(serverParameters);

ProcessReady()

Notifica ad Amazon GameLift che il processo del server è pronto per ospitare sessioni di gioco. Chiama questo metodo dopo averlo InitSDK() invocato. Questo metodo deve essere chiamato solo una volta per processo.

Sintassi


GenericOutcome ProcessReady(ProcessParameters processParameters)

Parametri

ProcessParameters: Un ProcessParameters oggetto contiene informazioni sul processo del server.

Valore restituito

Restituisce un risultato generico costituito da successo o fallimento con un messaggio di errore.

Esempio

Questo esempio illustra sia l'implementazione del metodo che quella delle funzioni di delega.


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

ProcessEnding()

Notifica ad Amazon GameLift che il processo del server sta terminando. Richiama questo metodo dopo tutte le altre attività di pulizia (inclusa la chiusura della sessione di gioco attiva) e prima di terminare il processo. A seconda del risultato diProcessEnding(), il processo termina con successo (0) o errore (-1) e genera un evento relativo alla flotta. Se il processo termina con un errore, l'evento fleet generato è. SERVER_PROCESS_TERMINATED_UNHEALTHY

Sintassi


GenericOutcome ProcessEnding()

Valore restituito

Restituisce un risultato generico costituito da successo o fallimento con un messaggio di errore.

Esempio

Questo esempio chiama ProcessEnding() e Destroy() prima di terminare il processo del server con un codice di uscita riuscito o di errore.


GenericOutcome processEndingOutcome = GameLiftServerAPI.ProcessEnding();
GameLiftServerAPI.Destroy();

if (processEndingOutcome.Success)
  {
    Environment.Exit(0);
  }
else
  {
    Console.WriteLine("ProcessEnding() failed. Error: " + processEndingOutcome.Error.ToString());
    Environment.Exit(-1);  
  }

ActivateGameSession()

Notifica ad Amazon GameLift che il processo del server ha attivato una sessione di gioco ed è ora pronto per ricevere le connessioni dei giocatori. Questa azione deve essere richiamata come parte della funzione di onStartGameSession() callback, dopo l'inizializzazione di tutta la sessione di gioco.

Sintassi


GenericOutcome ActivateGameSession()

Valore restituito

Restituisce un risultato generico composto da successo o fallimento con un messaggio di errore.

Esempio

Questo esempio illustra la chiamata a ActivateGameSession() nell'ambito della funzione delegata onStartGameSession().


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

UpdatePlayerSessionCreationPolicy()

Aggiorna la capacità della sessione di gioco corrente di accettare nuove sessioni giocatore. Una sessione di gioco può essere configurata per accettare o rifiutare tutte le nuove sessioni giocatore.

Sintassi


GenericOutcome UpdatePlayerSessionCreationPolicy(PlayerSessionCreationPolicy playerSessionPolicy)

Parametri

playerSessionPolicy

Valore di stringa che indica se la sessione di gioco accetta nuovi giocatori.

I valori validi includono:

ACCEPT_ALL: accetta tutte le nuove sessioni giocatore.
DENY_ALL: rifiuta tutte le nuove sessioni giocatore.

Valore restituito

Restituisce un risultato generico composto da successo o fallimento con un messaggio di errore.

Esempio

Questo esempio definisce la policy di partecipazione alla sessione di gioco corrente per accettare tutti i giocatori.


GenericOutcome updatePlayerSessionPolicyOutcome = 
  GameLiftServerAPI.UpdatePlayerSessionCreationPolicy(PlayerSessionCreationPolicy.ACCEPT_ALL);

GetGameSessionId()

Recupera l'ID della sessione di gioco ospitata dal processo del server attivo.

Per i processi inattivi che non vengono attivati con una sessione di gioco, la chiamata restituisce un. GameLiftError

Sintassi


AwsStringOutcome GetGameSessionId()

Valore restituito

Se l'esito è positivo, l'ID della sessione di gioco verrà restituito come oggetto AwsStringOutcome. Se non riesce, restituisce un messaggio di errore».

Esempio


AwsStringOutcome getGameSessionIdOutcome = GameLiftServerAPI.GetGameSessionId();

GetTerminationTime()

Restituisce il tempo di arresto pianificato di un processo del server, se è disponibile un tempo di chiusura. Un processo server esegue questa azione dopo aver ricevuto una onProcessTerminate() richiamata da Amazon GameLift. Amazon GameLift chiama onProcessTerminate() per i seguenti motivi:

Quando il processo del server ha segnalato problemi di salute o non ha risposto ad Amazon GameLift.
Quando si interrompe l'istanza durante un evento di scale-down.
Quando un'istanza viene terminata a causa di un'interruzione di un'istanza spot.

Sintassi


AwsDateTimeOutcome GetTerminationTime()

Valore restituito

In caso di successo, restituisce l'ora di terminazione come oggetto. AwsDateTimeOutcome Il valore è il tempo di terminazione, espresso in segni di spunta trascorsi da allora. 0001 00:00:00 Ad esempio, il valore della data e dell'ora è uguale ai segni di 2020-09-13 12:26:40 -000Z spunta. 637355968000000000 Se non è disponibile alcun orario di terminazione, restituisce un messaggio di errore.

Esempio


AwsDateTimeOutcome getTerminationTimeOutcome = GameLiftServerAPI.GetTerminationTime();

AcceptPlayerSession()

Notifica ad Amazon GameLift che un giocatore con l'ID di sessione del giocatore specificato si è connesso al processo del server e deve essere convalidato. Amazon GameLift verifica che l'ID di sessione del giocatore sia valido. Dopo la convalida della sessione di gioco, Amazon GameLift modifica lo stato dello slot del giocatore da RISERVATO ad ATTIVO.

Sintassi


GenericOutcome AcceptPlayerSession(String playerSessionId)

Parametri

playerSessionId: ID univoco rilasciato GameLift quando viene creata una nuova sessione di gioco.

Valore restituito

Restituisce un risultato generico composto da successo o fallimento con un messaggio di errore.

Esempio

Questo esempio illustra una funzione per gestire una richiesta di connessione, inclusi la convalida e il rifiuto di ID di sessioni giocatore non validi.


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

RemovePlayerSession()

Notifica ad Amazon GameLift che un giocatore si è disconnesso dal processo del server. In risposta, Amazon GameLift cambia lo slot del giocatore rendendolo disponibile.

Sintassi


GenericOutcome RemovePlayerSession(String playerSessionId)

Parametri

playerSessionId: ID univoco rilasciato da Amazon GameLift quando viene creata una nuova sessione giocatore.

Valore restituito

Restituisce un risultato generico composto da successo o fallimento con un messaggio di errore.

Esempio


GenericOutcome removePlayerSessionOutcome = GameLiftServerAPI.RemovePlayerSession(playerSessionId);

DescribePlayerSessions()

Recupera i dati della sessione del giocatore che includono impostazioni, metadati della sessione e dati del giocatore. Utilizza questa operazione per ottenere le informazioni per una singola sessione giocatore, per tutte le sessioni giocatore in una sessione di gioco o per tutte le sessioni giocatore associate a un singolo ID giocatore.

Sintassi


DescribePlayerSessionsOutcome DescribePlayerSessions(DescribePlayerSessionsRequest describePlayerSessionsRequest)

Parametri

DescribePlayerSessionsRequest: Un DescribePlayerSessionsRequest oggetto che descrive le sessioni dei giocatori da recuperare.

Valore restituito

In caso di successo, restituisce un DescribePlayerSessionsOutcome oggetto che contiene un set di oggetti della sessione del giocatore che soddisfano i parametri della richiesta.

Esempio

Questo esempio illustra una richiesta per tutte le sessioni giocatore attivamente connesse a una sessione di gioco specificata. Omettendo NextTokene impostando il valore Limite su 10, Amazon GameLift restituirà i primi 10 record delle sessioni di gioco corrispondenti alla richiesta.


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

StartMatchBackfill()

Invia una richiesta per trovare nuovi giocatori per gli slot aperti in una sessione di gioco creata con FlexMatch. Per ulteriori informazioni, consulta la funzione di FlexMatch riempimento.

Questa operazione è asincrona. Se vengono abbinati nuovi giocatori, Amazon GameLift fornisce dati aggiornati sui matchmaker utilizzando la funzione di callback. OnUpdateGameSession()

Un processo del server può avere un solo backfill degli abbinamenti attivo alla volta. Per inviare una nuova richiesta, chiama prima StopMatchBackfill() per annullare la richiesta originale.

Sintassi


StartMatchBackfillOutcome StartMatchBackfill (StartMatchBackfillRequest startBackfillRequest);

Parametri

StartMatchBackfillRequest: Un StartMatchBackfillRequest oggetto contiene informazioni sulla richiesta di riempimento.

Valore restituito

Restituisce un StartMatchBackfillOutcome oggetto con l'ID del ticket Match Backfill o restituisce un errore con un messaggio di errore.

Esempio


// Build a backfill request
StartMatchBackfillRequest startBackfillRequest = new StartMatchBackfillRequest()
{
  TicketId = "1111aaaa-22bb-33cc-44dd-5555eeee66ff", //optional
  MatchmakingConfigurationArn = "arn:aws:gamelift:us-west-2:111122223333:matchmakingconfiguration/MyMatchmakerConfig", 
  GameSessionId = GameLiftServerAPI.GetGameSessionId().Result,    // gets ID for current game session
  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
StartMatchBackfillOutcome 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()

Annulla una richiesta di match backfill attiva. Per ulteriori informazioni, consulta la funzione di FlexMatch riempimento.

Sintassi


GenericOutcome StopMatchBackfill (StopMatchBackfillRequest stopBackfillRequest);

Parametri

StopMatchBackfillRequest: Un StopMatchBackfillRequest oggetto che fornisce dettagli sul ticket di matchmaking che stai interrompendo.

Valore restituito

Restituisce un risultato generico composto da successo o fallimento con un messaggio di errore.

Esempio


// Set backfill stop request parameters
StopMatchBackfillRequest stopBackfillRequest = new StopMatchBackfillRequest(){
  TicketId = "1111aaaa-22bb-33cc-44dd-5555eeee66ff", //optional, if not provided one is autogenerated
  MatchmakingConfigurationArn = "arn:aws:gamelift:us-west-2:111122223333:matchmakingconfiguration/MyMatchmakerConfig",
  GameSessionId = GameLiftServerAPI.GetGameSessionId().Result    //gets the ID for the current game session
};
GenericOutcome stopBackfillOutcome = GameLiftServerAPI.StopMatchBackfillRequest(stopBackfillRequest);

GetComputeCertificate()

Recupera il percorso del certificato TLS utilizzato per crittografare la connessione di rete tra il server di gioco e il client di gioco. Puoi utilizzare il percorso del certificato quando registri il tuo dispositivo di elaborazione in una GameLift Anywhere flotta Amazon. Per ulteriori informazioni, consulta, RegisterCompute.

Sintassi


GetComputeCertificateOutcome GetComputeCertificate();

Valore restituito

Restituisce un GetComputeCertificateResponse oggetto che contiene quanto segue:

CertificatePath: il percorso del certificato TLS sulla risorsa di calcolo. Quando si utilizza una flotta GameLift gestita da Amazon, questo percorso contiene:
- certificate.pem: Il certificato dell'utente finale. La catena completa di certificati è la combinazione dei certificati certificateChain.pem aggiunti a questo certificato.
- certificateChain.pem: La catena di certificati che contiene il certificato principale e i certificati intermedi.
- rootCertificate.pem: Il certificato principale.
- privateKey.pem: la chiave privata per il certificato dell'utente finale.
ComputeName: il nome della risorsa di calcolo.

Esempio


GetComputeCertificateOutcome getComputeCertificateOutcome = GameLiftServerAPI.GetComputeCertificate();

GetFleetRoleCredentials()

Recupera le credenziali del ruolo IAM che autorizzano GameLift Amazon a interagire con altri. Servizi AWS Per ulteriori informazioni, consulta Comunica con altre AWS risorse delle tue flotte.

Sintassi


GetFleetRoleCredentialsOutcome GetFleetRoleCredentials(GetFleetRoleCredentialsRequest request);

Parametri

GetFleetRoleCredentialsRequest: Credenziali di ruolo che estendono l'accesso limitato alle tue AWS risorse al server di gioco.

Valore restituito

Restituisce un oggetto GetFleetRoleCredentialsOutcome.

Esempio


// form the fleet credentials request  
GetFleetRoleCredentialsRequest getFleetRoleCredentialsRequest = new GetFleetRoleCredentialsRequest(){  
  RoleArn = "arn:aws:iam::123456789012:role/service-role/exampleGameLiftAction"  
};
GetFleetRoleCredentialsOutcome GetFleetRoleCredentialsOutcome credentials = GetFleetRoleCredentials(getFleetRoleCredentialsRequest);

Distruggi ()

Libera l'SDK del server di GameLift gioco Amazon dalla memoria. Come best practice, richiama questo metodo dopo ProcessEnding() e prima di terminare il processo. Se utilizzi una flotta Anywhere e non interrompi i processi del server dopo ogni sessione di gioco, chiama Destroy() e poi reinizializza prima di notificare InitSDK() ad Amazon GameLift che il processo è pronto per ospitare una sessione di gioco con. ProcessReady()

Sintassi


GenericOutcome Destroy()

Valore restituito

Restituisce un risultato generico composto da successo o fallimento con un messaggio di errore.

Esempio


// Operations to end game sessions and the server process
GenericOutcome processEndingOutcome = GameLiftServerAPI.ProcessEnding();

// Shut down and destroy the instance of the GameLift Game Server SDK
GenericOutcome destroyOutcome = GameLiftServerAPI.Destroy();

// Exit the process with success or failure
if (processEndingOutcome.Success)
  { 
    Environment.Exit(0); 
  }
else
  {
    Console.WriteLine("ProcessEnding() failed. Error: " + processEndingOutcome.Error.ToString());
    Environment.Exit(-1); 
  }

Avvertimento JavaScript è disabilitato o non è disponibile nel tuo browser.

Per usare la documentazione AWS, JavaScript deve essere abilitato. Consulta le pagine della guida del browser per le istruzioni.

Convenzioni dei documenti

Riferimento Server SDK 5.x per C# e Unity

Tipi di dati