As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.
GameLift Servidor Amazon SDK para Unreal Engine: ações
Use o GameLift servidor Amazon SDK para referência do Unreal 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.
nota
Essa referência é para uma versão anterior do GameLift servidor AmazonSDK. Para obter a versão mais recente, consulte GameLift Servidor Amazon SDK 5.x para Unreal Engine: ações.
Isso API é definido em GameLiftServerSDK.h
GameLiftServerSDKModels.h
e.
Para configurar o plug-in do Unreal Engine e ver exemplos de código Integre a Amazon GameLift em um projeto Unreal Engine.
GameLift Servidor Amazon SDK para Unreal Engine: tipos de dados
Tópicos
AcceptPlayerSession()
Notifica o GameLift serviço da Amazon de 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, ou seja, se o ID do jogador reservou um espaço para o jogador na sessão do jogo. Depois de validado, a Amazon GameLift altera o status do slot do jogador de RESERVED paraACTIVE.
Sintaxe
FGameLiftGenericOutcome AcceptPlayerSession(const FString& playerSessionId)
Parâmetros
- playerSessionId
-
ID exclusiva emitida pelo GameLift serviço da Amazon em resposta a uma chamada para a GameLift API ação da AWS SDK Amazon CreatePlayerSession. O cliente do jogo faz referência a esse ID ao se conectar ao processo do servidor.
Tipo: FString
Obrigatório: Sim
Valor de retorno
Retorna um resultado genérico que consiste em sucesso ou falha com uma mensagem de erro.
ActivateGameSession()
Notifica o GameLift serviço da Amazon de 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()
, depois que toda a inicialização da sessão tiver sido concluída.
Sintaxe
FGameLiftGenericOutcome ActivateGameSession()
Parâmetros
Essa ação não tem um parâmetro.
Valor de retorno
Retorna um resultado genérico que consiste em sucesso ou falha com uma mensagem de erro.
DescribePlayerSessions()
Recupera dados da sessão do jogador, inclusive 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
FGameLiftDescribePlayerSessionsOutcome DescribePlayerSessions(const FGameLiftDescribePlayerSessionsRequest &describePlayerSessionsRequest)
Parâmetros
- describePlayerSessionsSolicitação
-
Um objeto FDescribePlayerSessionsRequest que descreve quais sessões de jogador recuperar.
Obrigatório: Sim
Valor de retorno
Se bem-sucedido, retorna um objeto FDescribePlayerSessionsRequest que contém um conjunto de objetos de sessão do jogador que atendem aos parâmetros de solicitação. Os objetos de sessão do jogador têm uma estrutura idêntica ao tipo de GameLift API PlayerSessiondados AWS SDK da Amazon.
GetGameSessionId()
Recupera o ID da sessão do jogo hospedada no momento pelo processo do servidor, caso o processo do servidor esteja ativo.
Sintaxe
FGameLiftStringOutcome GetGameSessionId()
Parâmetros
Essa ação não tem um parâmetro.
Valor de retorno
Se bem-sucedido, retornará o ID da sessão de jogo como um objeto FGameLiftStringOutcome
. Se não for bem-sucedido, retornará uma mensagem de erro.
GetInstanceCertificate()
Recupera a localização do arquivo de um TLS certificado codificado por pem que está associado à frota e suas instâncias. AWS Certificate Manager gera esse certificado quando você cria uma nova frota com a configuração do certificado definida comoGENERATED. Use esse certificado para estabelecer uma conexão segura com um cliente de jogo e para criptografar a comunicação entre cliente e servidor.
Sintaxe
FGameLiftGetInstanceCertificateOutcome GetInstanceCertificate()
Parâmetros
Essa ação não tem um parâmetro.
Valor de retorno
Se for bem-sucedido, retornará um GetInstanceCertificateOutcome
objeto contendo a localização do arquivo de TLS certificado e da cadeia de certificados da frota, que estão armazenados na instância. Um arquivo de certificado raiz, extraído da cadeia de certificados, também é armazenado na instância. Se não for bem-sucedido, retornará uma mensagem de erro.
Para obter mais informações sobre o certificado e os dados da cadeia de certificados, consulte Elementos de GetCertificate resposta na AWS Certificate Manager API referência.
GetSdkVersion()
Retorna o número da versão atual do processo SDK incorporado ao servidor.
Sintaxe
FGameLiftStringOutcome GetSdkVersion();
Parâmetros
Essa ação não tem um parâmetro.
Valor de retorno
Se for bem-sucedido, retornará a SDK versão atual como um FGameLiftStringOutcome
objeto. A string retornada inclui apenas o número da versão (exemplo, "3.1.5"). Se não for bem-sucedido, retornará uma mensagem de erro.
Exemplo
Aws::GameLift::AwsStringOutcome SdkVersionOutcome = Aws::GameLift::Server::GetSdkVersion();
Iniciar SDK ()
Inicializa a Amazon GameLift SDK. Esse método deve ser chamado no lançamento, antes que qualquer outra inicialização GameLift relacionada à Amazon ocorra.
Sintaxe
FGameLiftGenericOutcome InitSDK()
Parâmetros
Essa ação não tem um parâmetro.
Valor de retorno
Retorna um resultado genérico que consiste em sucesso ou falha com uma mensagem de erro.
ProcessEnding()
Notifica o GameLift serviço da Amazon de que o processo do servidor está sendo encerrado. Esse método deverá ser chamado depois de todas as outras tarefas de limpeza, inclusive desligar todas as sessões de jogos ativas. Este método deve sair com um código de saída zero; um código de saída diferente de zero resulta em uma mensagem de evento indicando que o processo não foi encerrado corretamente.
Sintaxe
FGameLiftGenericOutcome ProcessEnding()
Parâmetros
Essa ação não tem um parâmetro.
Valor de retorno
Retorna um resultado genérico que consiste em sucesso ou falha com uma mensagem de erro.
ProcessReady()
Notifica o GameLift serviço da Amazon de que o processo do servidor está pronto para hospedar sessões de jogo. Chame esse método depois de invocar Iniciar SDK () e concluir todas as tarefas de configuração necessárias antes que o processo do servidor possa hospedar uma sessão do jogo. Esse método deve ser chamado somente uma vez por processo.
Sintaxe
FGameLiftGenericOutcome ProcessReady(FProcessParameters &processParameters)
Parâmetros
- FProcessParameters
-
Um objeto FProcessParameters que fornece as seguintes informações sobre o processo do servidor:
-
Nomes dos métodos de retorno de chamada, implementados no código do servidor do jogo, que o GameLift serviço da Amazon invoca para se comunicar com o processo do servidor.
-
Número da porta em que o processo de servidor está escutando.
-
Caminho para qualquer arquivo específico da sessão de jogo que você deseja que a Amazon capture e GameLift armazene.
Obrigatório: Sim
-
Valor de retorno
Retorna um resultado genérico que consiste em sucesso ou falha com uma mensagem de erro.
Exemplo
Consulte o código de exemplo em Usar o plug-in do Unreal Engine.
RemovePlayerSession()
Notifica o GameLift serviço da Amazon de que um jogador com o ID de sessão de jogador especificado se desconectou do processo do servidor. Em resposta, a Amazon GameLift altera a vaga do jogador para disponível, o que permite que ela seja atribuída a um novo jogador.
Sintaxe
FGameLiftGenericOutcome RemovePlayerSession(const FString& playerSessionId)
Parâmetros
- playerSessionId
-
ID exclusiva emitida pelo GameLift serviço da Amazon em resposta a uma chamada para a GameLift API ação da AWS SDK Amazon CreatePlayerSession. O cliente do jogo faz referência a esse ID ao se conectar ao processo do servidor.
Tipo: FString
Obrigatório: Sim
Valor de retorno
Retorna um resultado genérico que consiste em sucesso ou falha com uma mensagem de erro.
StartMatchBackfill()
Envia uma solicitação para encontrar novos jogadores para vagas abertas em uma sessão de jogo criada com FlexMatch. Veja também a AWS SDK ação StartMatchBackfill(). Com essa ação, as solicitações de alocação de correspondência podem ser iniciadas por um processo do servidor de jogos que esteja hospedando a sessão do jogo. Saiba mais sobre o recurso FlexMatch de preenchimento.
Esta ação é assíncrona. Se novos jogadores forem combinados com sucesso, o GameLift serviço Amazon 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
FGameLiftStringOutcome StartMatchBackfill (FStartMatchBackfillRequest &startBackfillRequest);
Parâmetros
- FStartMatchBackfillRequest
-
Um objeto FStartMatchBackfillRequest que fornece as seguintes informações:
-
ID do tíquete a ser atribuído à solicitação de alocação. Essas informações são opcionais; se nenhum ID for fornecido, a Amazon GameLift gerará automaticamente um.
-
O marcador de jogos para o qual a solicitação é enviada. A configuração completa ARN é necessária. Esse valor pode ser obtido dos dados do marcador da sessão do jogo.
-
ID da sessão de jogo que está sendo alocada.
-
Dados disponíveis de marcação para os jogadores atuais da sessão do jogo.
Obrigatório: Sim
-
Valor de retorno
Se bem-sucedido, retorna o tíquete de alocação de correspondência como um objeto FGameLiftStringOutcome
. Se não for bem-sucedido, retornará uma mensagem de erro. O status do tíquete pode ser rastreado usando a AWS SDK ação DescribeMatchmaking().
StopMatchBackfill()
Cancela uma solicitação de alocação de correspondência ativa criada com StartMatchBackfill(). Veja também a AWS SDK ação StopMatchmaking(). Saiba mais sobre o recurso FlexMatch de preenchimento.
Sintaxe
FGameLiftGenericOutcome StopMatchBackfill (FStopMatchBackfillRequest &stopBackfillRequest);
Parâmetros
- StopMatchBackfillRequest
-
Um objeto FStopMatchBackfillRequest que identifica o tíquete de marcação de jogos para cancelar:
-
ID do tíquete atribuído à solicitação de alocação sendo cancelada
-
o marcador de jogo que recebeu a solicitação de alocação
-
a sessão do jogo associada à solicitação de alocação
Obrigatório: Sim
-
Valor de retorno
Retorna um resultado genérico que consiste em sucesso ou falha com uma mensagem de erro.
TerminateGameSession()
Esse método foi descontinuado com a versão 4.0.1. Em vez disso, o processo do servidor deve ser chamado ProcessEnding() após o término de uma sessão de jogo.
Notifica o GameLift serviço da Amazon de que o processo do servidor encerrou a sessão atual do jogo. Essa ação é chamada quando o processo do servidor permanece ativo e pronto para hospedar uma nova sessão de jogo. Ele deve ser chamado somente após a conclusão do procedimento de encerramento da sessão de jogo, pois indica à Amazon GameLift que o processo do servidor está imediatamente disponível para hospedar uma nova sessão de jogo.
Essa ação não será chamada se o processo do servidor for encerrado após o término da sessão do jogo. Em vez disso, chame ProcessEnding() para sinalizar que tanto a sessão do jogo quanto o processo do servidor estão terminando.
Sintaxe
FGameLiftGenericOutcome TerminateGameSession()
Parâmetros
Essa ação não tem um parâmetro.
Valor de retorno
Retorna um resultado genérico que consiste em sucesso ou falha com uma mensagem de erro.
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. (Veja também a UpdateGameSession()
ação na Amazon GameLift Service API Reference).
Sintaxe
FGameLiftGenericOutcome UpdatePlayerSessionCreationPolicy(EPlayerSessionCreationPolicy policy)
Parâmetros
- Política
-
Valor indicando se a sessão do jogo aceita novos jogadores.
Tipo: enumeração
EPlayerSessionCreationPolicy
. 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.
Obrigatório: Sim
-
Valor de retorno
Retorna um resultado genérico que consiste em sucesso ou falha com uma mensagem de erro.