GameLift Servidor Amazon SDK 5.x para C# e Unity: ações

Use a referência SDK 5.x do servidor Amazon GameLift C# para integrar seu jogo multijogador para hospedagem na Amazon. GameLift Para obter orientação sobre o processo de integração, consulteAdicione GameLift a Amazon ao seu servidor de jogos. Se você estiver usando o GameLift plug-in da Amazon para Unity, consulte também GameLift Plugin Amazon para Unity (servidor SDK 5.x).

GameLift Servidor Amazon SDK 5.x para C# e Unity: tipos de dados

GetSdkVersion()

Retorna o número da versão atual do processo SDK incorporado ao servidor.

Sintaxe

AwsStringOutcome GetSdkVersion();

Valor de retorno

Se for bem-sucedido, retornará a SDK versão atual como um AwsStringOutcome objeto. A string retornada inclui o número da versão (exemplo, 5.0.0). Se não for bem-sucedido, retornará uma mensagem de erro.

Exemplo

var getSdkVersionOutcome = GameLiftServerAPI.GetSdkVersion();

Iniciar SDK ()

Inicializa a Amazon GameLift SDK para uma EC2 frota gerenciada. Chame esse método na inicialização, antes que qualquer outra inicialização relacionada à Amazon GameLift ocorra. Esse método lê os parâmetros do servidor do ambiente host para configurar a comunicação entre o servidor e o GameLift serviço da Amazon.

Sintaxe

GenericOutcome InitSDK();

Valor de retorno

Se for bem-sucedido, retornará um InitSdkOutcome objeto para indicar que o processo do servidor está pronto para ser chamadoProcessReady().

Exemplo

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

Iniciar SDK ()

Inicializa a Amazon GameLift SDK para um Anywhere frota. Chame esse método na inicialização, antes que qualquer outra inicialização relacionada à Amazon GameLift ocorra. Esse método requer parâmetros explícitos do servidor para configurar a comunicação entre o servidor e o GameLift serviço da Amazon.

Sintaxe

GenericOutcome InitSDK(ServerParameters serverParameters);

Parâmetros

ServerParameters

Para inicializar um servidor de jogos em uma Amazon GameLift Anywhere frota, construa um ServerParameters objeto com as seguintes informações:

• O URL WebSocket usado para se conectar ao seu servidor de jogo.

• O ID do processo usado para hospedar o servidor de jogos.

• O ID do computador que hospeda os processos do seu servidor de jogos.

• O ID da GameLift frota da Amazon que contém sua Amazon GameLift Anywhere computar.

• O token de autorização gerado pela GameLift operação da Amazon.

Valor de retorno

Se for bem-sucedido, retornará um InitSdkOutcome objeto para indicar que o processo do servidor está pronto para ser chamadoProcessReady().

nota

Se as chamadas para InitSDK() estiverem falhando para compilações de jogos implantadas em frotas do Anywhere, verifique o parâmetro ServerSdkVersion usado ao criar o recurso de compilação. Você deve definir explicitamente esse valor para a SDK versão do servidor em uso. O valor padrão desse parâmetro é 4.x, o que não é compatível. Para resolver esse problema, crie uma nova versão e implante-a em uma nova frota.

Exemplo

//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 a Amazon de GameLift que o processo do servidor está pronto para hospedar sessões de jogo. Chame esse método após invocar Iniciar SDK (). Esse método deve ser chamado somente uma vez por processo.

Sintaxe

GenericOutcome ProcessReady(ProcessParameters processParameters)

Parâmetros

ProcessParameters

Um objeto ProcessParameters contém informações sobre o processo do servidor.

Valor de retorno

Retorna um resultado genérico que consiste em sucesso ou falha com uma mensagem de erro.

Exemplo

Este exemplo ilustra as implementações do método e da função delegada.

// 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 a Amazon de GameLift que o processo do servidor está sendo encerrado. Chame esse método depois de todas as outras tarefas de limpeza (incluindo o encerramento da sessão ativa do jogo) e antes de encerrar o processo. Dependendo do resultado ProcessEnding(), o processo sai com sucesso (0) ou erro (-1) e gera um evento de frota. Se o processo for encerrado com um erro, o evento de frota gerado seráSERVER_PROCESS_TERMINATED_UNHEALTHY.

Sintaxe

GenericOutcome ProcessEnding()

Valor de retorno

Retorna um resultado genérico que consiste em sucesso ou falha com uma mensagem de erro.

Exemplo

Este exemplo chama ProcessEnding() e Destroy() antes de encerrar o processo do servidor com um código de saída bem-sucedido ou de erro.

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 a Amazon de GameLift que o processo do servidor ativou uma sessão de jogo e agora está pronto para receber conexões de jogadores. Essa ação deve ser chamada como parte da função de retorno de chamada onStartGameSession(), após toda inicialização da sessão do jogo.​

Sintaxe

GenericOutcome ActivateGameSession()

Valor de retorno

Retorna um resultado genérico que consiste em sucesso ou falha com uma mensagem de erro.

Exemplo

Este exemplo mostra ActivateGameSession() sendo chamado como parte da função de delegação 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()

Atualiza a capacidade da sessão do jogo atual para aceitar novas sessões de jogador. Atualiza a capacidade da sessão do jogo atual para aceitar novas sessões de jogador.

Sintaxe

GenericOutcome UpdatePlayerSessionCreationPolicy(PlayerSessionCreationPolicy playerSessionPolicy)

Parâmetros

playerSessionPolicy

Valor de string que indica se a sessão do jogo aceita novos jogadores.

Os valores válidos são:

• ACCEPT_ ALL — Aceite todas as sessões de novos jogadores.

• DENY_ ALL — Negar todas as sessões de novos jogadores.

Valor de retorno

Retorna um resultado genérico que consiste em sucesso ou falha com uma mensagem de erro.

Exemplo

Este exemplo define a política de ingresso da sessão do jogo atual para aceitar todos os jogadores.

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

GetGameSessionId()

Recupera o ID da sessão de jogo hospedada pelo processo do servidor ativo.

Para processos inativos que não são ativados com uma sessão de jogo, a chamada retorna um GameLiftError.

Sintaxe

AwsStringOutcome GetGameSessionId()

Valor de retorno

Se bem-sucedido, retornará o ID da sessão de jogo como um objeto AwsStringOutcome. Se não for bem-sucedido, retornará uma mensagem de erro."

Exemplo

AwsStringOutcome getGameSessionIdOutcome = GameLiftServerAPI.GetGameSessionId();

GetTerminationTime()

Retorna a hora em que um processo do servidor está programado para ser desligado, se essa informação estiver disponível. Um processo de servidor executa essa ação após receber um onProcessTerminate() retorno de chamada da Amazon GameLift. A Amazon GameLift liga onProcessTerminate() pelos seguintes motivos:

• Quando o processo do servidor relatou problemas de saúde ou não respondeu à Amazon GameLift.

• Ao encerrar a instância durante um evento de redução.

• Quando uma instância é encerrada devido a uma interrupção na instância spot.

Sintaxe

AwsDateTimeOutcome GetTerminationTime()

Valor de retorno

Se for bem-sucedido, retornará o horário de término como um objeto AwsDateTimeOutcome. O valor é o tempo de rescisão, expresso em tiques decorridos desde então 0001 00:00:00. Por exemplo, o valor da data e hora 2020-09-13 12:26:40 -000Z é igual aos tiques 637355968000000000. Se nenhum horário de rescisão estiver disponível, o retornará uma mensagem de erro.

Exemplo

AwsDateTimeOutcome getTerminationTimeOutcome = GameLiftServerAPI.GetTerminationTime(); 

AcceptPlayerSession()

Notifica a Amazon de GameLift que um jogador com o ID de sessão de jogador especificado se conectou ao processo do servidor e precisa de validação. A Amazon GameLift verifica se o ID da sessão do jogador é válido. Depois que a sessão do jogador é validada, a Amazon GameLift altera o status do slot do jogador de RESERVED paraACTIVE.

Sintaxe

GenericOutcome AcceptPlayerSession(String playerSessionId)

Parâmetros

playerSessionId

ID exclusivo emitido GameLift quando uma nova sessão de jogador é criada.

Valor de retorno

Retorna um resultado genérico que consiste em sucesso ou falha com uma mensagem de erro.

Exemplo

Este exemplo ilustra uma função para lidar com uma solicitação de conexão, incluindo a validação e rejeição de uma sessão de jogador inválida. IDs

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 a Amazon de GameLift que um jogador se desconectou do processo do servidor. Em resposta, a Amazon GameLift altera o slot do jogador para disponível.

Sintaxe

GenericOutcome RemovePlayerSession(String playerSessionId)

Parâmetros

playerSessionId

ID exclusivo emitido pela Amazon GameLift quando uma nova sessão de jogador é criada.

Valor de retorno

Retorna um resultado genérico que consiste em sucesso ou falha com uma mensagem de erro.

Exemplo

GenericOutcome removePlayerSessionOutcome = GameLiftServerAPI.RemovePlayerSession(playerSessionId);

DescribePlayerSessions()

Recupera dados da sessão do jogador, que incluem configurações, metadados da sessão e dados do jogador. Use essa ação para obter informações de uma única sessão de jogador, para todas as sessões de jogador em uma sessão de jogo, ou para todas as sessões de jogador associadas a um único ID de jogador.

Sintaxe

DescribePlayerSessionsOutcome DescribePlayerSessions(DescribePlayerSessionsRequest describePlayerSessionsRequest)

Parâmetros

DescribePlayerSessionsRequest

Um objeto DescribePlayerSessionsRequest que descreve quais sessões de jogador recuperar.

Valor de retorno

Se bem-sucedido, retorna um objeto DescribePlayerSessionsOutcome que contém um conjunto de objetos de sessão do jogador que atendem aos parâmetros de solicitação.

Exemplo

Este exemplo ilustra uma solicitação para todas as sessões de jogador conectadas ativamente a uma sessão de jogo especificada. Ao omitir NextTokene definir o valor limite como 10, a Amazon GameLift retornará os primeiros registros de sessão de 10 jogadores que correspondam à solicitação.

// 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()

Envia uma solicitação para encontrar novos jogadores para vagas abertas em uma sessão de jogo criada com FlexMatch. Para obter mais informações, consulte o recurso FlexMatch de preenchimento.

Esta ação é assíncrona. Se novos jogadores forem combinados, a Amazon GameLift fornece dados atualizados do matchmaker usando a função de retorno de chamada. OnUpdateGameSession()

Um processo de servidor pode ter apenas uma solicitação de alocação de correspondência ativa por vez. Para enviar uma nova solicitação, primeiro chame StopMatchBackfill() para cancelar a solicitação original.

Sintaxe

StartMatchBackfillOutcome StartMatchBackfill (StartMatchBackfillRequest startBackfillRequest);

Parâmetros

StartMatchBackfillRequest

Um objeto StartMatchBackfillRequest contém informações sobre a solicitação de alocação.

Valor de retorno

Retorna um objeto StartMatchBackfillOutcome com o ID do tíquete de alocação de correspondência ou um falha com uma mensagem de erro.

Exemplo

// 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()

Cancela uma solicitação de alocação de correspondência ativa. Para obter mais informações, consulte o recurso FlexMatch de preenchimento.

Sintaxe

GenericOutcome StopMatchBackfill (StopMatchBackfillRequest stopBackfillRequest);

Parâmetros

StopMatchBackfillRequest

Um objeto StopMatchBackfillRequest que fornece detalhes sobre o tíquete de marcação de jogos que você está interrompendo.

Valor de retorno

Retorna um resultado genérico que consiste em sucesso ou falha com uma mensagem de erro.

Exemplo

// 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 o caminho para o TLS certificado usado para criptografar a conexão de rede entre o servidor do jogo e o cliente do jogo. Você pode usar o caminho do certificado ao registrar seu dispositivo computacional em um Amazon GameLift Anywhere frota. Para obter mais informações, consulte, RegisterCompute.

Sintaxe

GetComputeCertificateOutcome GetComputeCertificate();

Valor de retorno

Retorna um GetComputeCertificateResponse objeto que contém o seguinte:

• CertificatePath: o caminho para o TLS certificado em seu recurso computacional. Ao usar uma frota GameLift gerenciada pela Amazon, esse caminho contém:

  • certificate.pem: o certificado do usuário final. A cadeia completa de certificados é a combinação de certificateChain.pem anexados a esse certificado.

  • certificateChain.pem: a cadeia de certificados que contém o certificado raiz e os certificados intermediários.

  • rootCertificate.pem: o certificado raiz.

  • privateKey.pem: a chave privada para o certificado do usuário final.

• ComputeName: o nome do seu recurso computacional.

Exemplo

GetComputeCertificateOutcome getComputeCertificateOutcome = GameLiftServerAPI.GetComputeCertificate();

GetFleetRoleCredentials()

Recupera as credenciais da IAM função que autorizam a GameLift Amazon a interagir com outras. Serviços da AWS Para obter mais informações, consulte Comunique-se com outros AWS recursos de suas frotas.

Sintaxe

GetFleetRoleCredentialsOutcome GetFleetRoleCredentials(GetFleetRoleCredentialsRequest request);

Parâmetros

GetFleetRoleCredentialsRequest

Credenciais de função que ampliam o acesso limitado aos seus AWS recursos no servidor do jogo.

Valor de retorno

Informa um objeto GetFleetRoleCredentialsOutcome.

Exemplo

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

Destroy()

Libera o servidor de GameLift jogos da Amazon SDK da memória. Como melhor prática, chame esse método antes ProcessEnding() e depois de encerrar o processo. Se você estiver usando uma frota Anywhere e não estiver encerrando os processos do servidor após cada sessão de jogo, ligue Destroy() e reinicialize antes de notificar InitSDK() a Amazon de GameLift que o processo está pronto para hospedar uma sessão de jogo. ProcessReady()

Sintaxe

GenericOutcome Destroy()

Valor de retorno

Retorna um resultado genérico que consiste em sucesso ou falha com uma mensagem de erro.

Exemplo

// 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); 
  }