Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.
Amazon GameLift server SDK 4.x per C#: azioni
Usa il SDK riferimento al server Amazon GameLift C# per integrare il tuo gioco multiplayer per l'hosting con Amazon GameLift. Per indicazioni sul processo di integrazione, consultaAggiungi Amazon GameLift al tuo server di gioco.
Nota
Questo riferimento si riferisce a una versione precedente del GameLift server AmazonSDK. Per la versione più recente, consulta Amazon GameLift server SDK 5.x per C# e Unity: azioni.
Amazon GameLift server SDK 4.x per C#: tipi di dati
Argomenti
- AcceptPlayerSession()
- ActivateGameSession()
- DescribePlayerSessions()
- GetGameSessionId()
- GetInstanceCertificate()
- GetSdkVersion()
- GetTerminationTime()
- Init SDK ()
- ProcessEnding()
- ProcessReady()
- RemovePlayerSession()
- StartMatchBackfill()
- StopMatchBackfill()
- TerminateGameSession()
- UpdatePlayerSessionCreationPolicy()
AcceptPlayerSession()
Notifica al GameLift servizio Amazon 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 della sessione del giocatore sia valido, ovvero che l'ID giocatore abbia riservato uno slot per giocatore nella sessione di gioco. Una volta convalidato, Amazon GameLift modifica lo stato dello slot del giocatore da RESERVED aACTIVE.
Sintassi
GenericOutcome AcceptPlayerSession(String playerSessionId)
Parametri
- playerSessionId
-
ID univoco rilasciato da Amazon GameLift quando viene creata una nuova sessione giocatore. Un ID di sessione del giocatore è specificato in un
PlayerSession
oggetto, che viene restituito in risposta a una chiamata del client alle GameLift APIazioni StartGameSessionPlacement CreateGameSession, DescribeGameSessionPlacement, o DescribePlayerSessions.Tipo: stringa
Campo obbligatorio: sì
Valore restituito
Restituisce un risultato generico composto da successo o fallimento con un messaggio di errore.
Esempio
Questo esempio illustra una funzione per la gestione di una richiesta di connessione, inclusa la convalida e il rifiuto di una sessione giocatore non valida. 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()
Notifica al GameLift servizio Amazon che il processo del server ha attivato una sessione di gioco ed è ora pronto per ricevere le connessioni dei giocatori. Questa operazione deve essere chiamata come parte della funzione di callback onStartGameSession()
, dopo il completamento dell'inizializzazione di tutte le sessioni di gioco.
Sintassi
GenericOutcome ActivateGameSession()
Parametri
Questa operazione non prevede parametri.
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 var activateGameSessionOutcome = GameLiftServerAPI.ActivateGameSession(); }
DescribePlayerSessions()
Recupera i dati della sessione giocatore, tra cui le impostazioni, i metadati della sessione e i dati dei giocatori. 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
- describePlayerSessionsRichiesta
-
Un oggetto DescribePlayerSessionsRequest che descrive le sessioni giocatore da recuperare.
Campo obbligatorio: sì
Valore restituito
Se l'esito è positivo, restituisce un oggetto DescribePlayerSessionsOutcome
contenente un set di oggetti di sessione giocatore corrispondente ai parametri della richiesta. Gli oggetti della sessione Player hanno una struttura identica al tipo di GameLift API PlayerSessiondati AWS SDK Amazon.
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 record delle prime 10 sessioni di gioco corrispondenti alla richiesta.
// 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()
Recupera l'ID della sessione di gioco attualmente ospitata dal processo del server, se il processo del server è attivo.
Per i processi inattivi che non sono ancora stati attivati con una sessione di gioco, la chiamata restituisce Success
= True
e GameSessionId
= ""
(una stringa vuota).
Sintassi
AwsStringOutcome GetGameSessionId()
Parametri
Questa operazione non prevede parametri.
Valore restituito
Se l'esito è positivo, l'ID della sessione di gioco verrà restituito come oggetto AwsStringOutcome
. Se l'esito è negativo, verrà restituito un messaggio di errore.
Esempio
var getGameSessionIdOutcome = GameLiftServerAPI.GetGameSessionId();
GetInstanceCertificate()
Recupera la posizione del file di un TLS certificato con codifica pem associato alla flotta e alle relative istanze. AWS Certificate Manager genera questo certificato quando si crea un nuovo parco veicoli con la configurazione del certificato impostata su. GENERATED Utilizza questo certificato per stabilire una connessione sicura con un client di gioco e per crittografare la comunicazione client/server.
Sintassi
GetInstanceCertificateOutcome GetInstanceCertificate();
Parametri
Questa operazione non prevede parametri.
Valore restituito
In caso di successo, restituisce un GetInstanceCertificateOutcome
oggetto contenente la posizione del file di TLS certificato e della catena di certificati della flotta, che sono archiviati nell'istanza. Nell'istanza viene inoltre archiviato un file di certificato radice, estratto dalla catena di certificati. Se l'esito è negativo, verrà restituito un messaggio di errore.
Per ulteriori informazioni sul certificato e sui dati della catena di certificati, consulta GetCertificate Response Elements nel AWS Certificate Manager API riferimento.
Esempio
var getInstanceCertificateOutcome = GameLiftServerAPI.GetInstanceCertificate();
GetSdkVersion()
Restituisce il numero di versione corrente del processo SDK integrato nel server.
Sintassi
AwsStringOutcome GetSdkVersion()
Parametri
Questa operazione non prevede parametri.
Valore restituito
In caso di successo, restituisce la SDK versione corrente come AwsStringOutcome
oggetto. La stringa restituita include solo il numero di versione (ad esempio «3.1.5"). Se l'esito è negativo, verrà restituito un messaggio di errore.
Esempio
var getSdkVersionOutcome = GameLiftServerAPI.GetSdkVersion();
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 dal GameLift servizio Amazon. Amazon GameLift può effettuare una chiamata onProcessTerminate() per i seguenti motivi: (1) per problemi di salute (il processo del server ha segnalato lo stato della porta o non ha risposto ad Amazon GameLift, (2) quando si interrompe l'istanza durante un evento di scale-down o (3) quando un'istanza viene terminata a causa di un'interruzione dell'istanza spot.
Se il processo ha ricevuto una onProcessTerminate()
richiamata, il valore restituito è il tempo di terminazione stimato. Se il processo non ha ricevuto una onProcessTerminate()
richiamata, viene restituito un messaggio di errore. Ulteriori informazioni sull'arresto di un processo del server.
Sintassi
AwsDateTimeOutcome GetTerminationTime()
Parametri
Questa operazione non prevede parametri.
Valore restituito
In caso di successo, restituisce l'ora di terminazione come oggettoAwsDateTimeOutcome
. Il valore è l'ora di terminazione, espressa in segni di spunta trascorsi dalle 00:01 00:00:00. Ad esempio, il valore data/ora 2020-09-13 12:26:40 -000Z è uguale a 637355968000000000 ticks. Se non è disponibile alcun orario di terminazione, restituisce un messaggio di errore.
Esempio
var getTerminationTimeOutcome = GameLiftServerAPI.GetTerminationTime();
Init SDK ()
Inizializza Amazon. GameLift SDK Questo metodo deve essere chiamato all'avvio, prima che si verifichi qualsiasi altra inizializzazione GameLift relativa ad Amazon.
Sintassi
InitSDKOutcome InitSDK()
Parametri
Questa operazione non prevede parametri.
Valore restituito
In caso di successo, restituisce un InitSdkOutcome oggetto che indica che il processo del server è pronto per la chiamata. ProcessReady()
Esempio
var initSDKOutcome = GameLiftServerAPI.InitSDK();
ProcessEnding()
Notifica al GameLift servizio Amazon che il processo del server si sta chiudendo. Questo metodo deve essere richiamato dopo tutte le altre attività di pulizia, tra cui l'arresto di tutte le sessioni di gioco attive. Questo metodo deve uscire con il codice 0; un codice di uscita diverso da zero genera un messaggio di evento che indica che il processo non è terminato correttamente.
Una volta terminato il metodo con un codice 0, puoi terminare il processo con un codice di uscita corretto. È inoltre possibile uscire dal processo con un codice di errore. Se si esce con un codice di errore, l'evento fleet indicherà che il processo è terminato in modo anomalo ()SERVER_PROCESS_TERMINATED_UNHEALTHY
.
Sintassi
GenericOutcome ProcessEnding()
Parametri
Questa operazione non prevede parametri.
Valore restituito
Restituisce un risultato generico composto da successo o fallimento con un messaggio di errore.
Esempio
var processEndingOutcome = GameLiftServerAPI.ProcessEnding(); if (processReadyOutcome.Success) Environment.Exit(0); // otherwise, exit with error code Environment.Exit(errorCode);
ProcessReady()
Notifica al GameLift servizio Amazon che il processo del server è pronto per ospitare sessioni di gioco. Richiama questo metodo dopo aver richiamato Init SDK () e completato con successo le attività di configurazione necessarie prima che il processo del server possa ospitare una sessione di gioco. Questo metodo deve essere chiamato solo una volta per processo.
Sintassi
GenericOutcome ProcessReady(ProcessParameters processParameters)
Parametri
- processParameters
-
Un oggetto ProcessParameters che comunica le informazioni seguenti sul processo del server:
-
Nomi dei metodi di callback, implementati nel codice del server di gioco, che il GameLift servizio Amazon richiama per comunicare con il processo del server.
-
Numero di porta sulla quale è in ascolto il processo del server.
-
Percorso a qualsiasi file specifico della sessione di gioco che desideri che Amazon GameLift acquisisca e archivi.
Campo obbligatorio: sì
-
Valore restituito
Restituisce un risultato generico composto da successo o fallimento con un messaggio di errore.
Esempio
Questo esempio illustra la chiamata ProcessReady() e le implementazioni della funzione delegata.
// 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()
Notifica al GameLift servizio Amazon che un giocatore con l'ID di sessione del giocatore specificato si è disconnesso dal processo del server. In risposta, Amazon GameLift modifica lo slot del giocatore rendendolo disponibile, il che consente di assegnarlo a un nuovo giocatore.
Sintassi
GenericOutcome RemovePlayerSession(String playerSessionId)
Parametri
- playerSessionId
-
ID univoco rilasciato da Amazon GameLift quando viene creata una nuova sessione giocatore. Un ID di sessione del giocatore è specificato in un
PlayerSession
oggetto, che viene restituito in risposta a una chiamata del client alle GameLift APIazioni StartGameSessionPlacement CreateGameSession, DescribeGameSessionPlacement, o DescribePlayerSessions.Tipo: stringa
Campo obbligatorio: sì
Valore restituito
Restituisce un risultato generico composto da successo o fallimento con un messaggio di errore.
Esempio
Aws::GameLift::GenericOutcome disconnectOutcome = Aws::GameLift::Server::RemovePlayerSession(playerSessionId);
StartMatchBackfill()
Invia una richiesta per trovare nuovi giocatori per slot aperti in una sessione di gioco creata con FlexMatch. Vedi anche l' AWS SDKazione StartMatchBackfill(). Con questa operazione, è possibile avviare le richieste di backfill degli abbinamenti da un processo del server di gioco che ospita la sessione di gioco. Scopri di più sulla funzione di FlexMatch riempimento.
Questa operazione è asincrona. Se i nuovi giocatori vengono abbinati con successo, il GameLift servizio Amazon 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 oggetto StartMatchBackfillRequest che comunica le informazioni seguenti:
-
ID del ticket da assegnare alla richiesta di backfill. Queste informazioni sono facoltative; se non viene fornito alcun ID, Amazon GameLift ne genererà uno automaticamente.
-
Matchmaker a cui inviare la richiesta. È richiesta la configurazione ARN completa. Questo valore può essere acquisito dai dati del matchmaker della sessione di gioco.
-
ID della sessione di gioco che è in fase di backfilling.
-
Dati di abbinamento disponibili per i giocatori correnti della sessione di gioco.
Campo obbligatorio: sì
-
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 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()
Annulla una richiesta di backfill degli abbinamenti attiva creata con StartMatchBackfill(). Vedi anche l' AWS SDKazione StopMatchmaking(). Scopri di più sulla funzione di FlexMatch riempimento.
Sintassi
GenericOutcome StopMatchBackfill (StopMatchBackfillRequest stopBackfillRequest);
Parametri
- StopMatchBackfillRequest
-
Un oggetto StopMatchBackfillRequest che identifica il ticket di abbinamento da annullare:
-
ID del ticket assegnato alla richiesta di backfill in fase di annullamento
-
matchmaker a cui è stata inviata la richiesta di backfill
-
sessione di gioco associata alla richiesta di backfill
Campo obbligatorio: sì
-
Valore restituito
Restituisce un risultato generico composto da successo o fallimento con un messaggio di errore.
Esempio
// 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()
Questo metodo è obsoleto con la versione 4.0.1. Invece, il processo del server dovrebbe richiamare ProcessEnding() dopo la fine di una sessione di gioco.
Notifica al GameLift servizio Amazon che il processo del server ha terminato la sessione di gioco corrente. Questa azione viene eseguita quando il processo del server rimane attivo e pronto per ospitare una nuova sessione di gioco. Dovrebbe essere chiamato solo dopo il completamento della procedura di interruzione della sessione di gioco, poiché segnala ad Amazon GameLift che il processo del server è immediatamente disponibile per ospitare una nuova sessione di gioco.
Questa azione non viene eseguita se il processo del server verrà interrotto dopo l'interruzione della sessione di gioco. Invece, chiama ProcessEnding() per segnalare che sia la sessione di gioco che il processo sul server stanno terminando.
Sintassi
GenericOutcome TerminateGameSession()
Parametri
Questa operazione non prevede parametri.
Valore restituito
Restituisce un risultato generico composto da successo o fallimento con un messaggio di errore.
Esempio
Questo esempio illustra un processo del server al termine di una sessione di gioco.
// 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()
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. (Vedi anche l'azione UpdateGameSession() nell'Amazon GameLift Service API Reference).
Sintassi
GenericOutcome UpdatePlayerSessionCreationPolicy(PlayerSessionCreationPolicy playerSessionPolicy)
Parametri
- newPlayerSessionPolitica
-
Valore della stringa che indica se la sessione di gioco accetta nuovi giocatori.
Tipo: enum. PlayerSessionCreationPolicy
. I valori validi includono: -
ACCEPT_ ALL — Accetta tutte le sessioni per i nuovi giocatori.
-
DENY_ ALL — Nega tutte le sessioni dei nuovi giocatori.
Campo obbligatorio: sì
-
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.
var updatePlayerSessionCreationPolicyOutcomex = GameLiftServerAPI.UpdatePlayerSessionCreationPolicy(PlayerSessionCreationPolicy.ACCEPT_ALL);