Referência do SDK do servidor Amazon GameLift (C++): tipos de dados

Você poderá usar essa referência do SDK de servidor do Amazon GameLift C++ para ajudá-lo a preparar seu jogo multijogador para uso com o Amazon GameLift. Para obter detalhes sobre o processo de integração, consulte Adicione o Amazon GameLift ao servidor de jogos.

Esta API é definida em GameLiftServerAPI.h, LogParameters.h e ProcessParameters.h.

• Ações

• Tipos de dados

DescribePlayerSessionsRequest

Esse tipo de dados é usado para especificar quais sessões de jogador recuperar. Você pode usá-lo da seguinte forma:

• Forneça um PlayerSessionId para solicitar uma sessão de jogador específica.

• Forneça um GameSessionId para solicitar todas as sessões de jogador na sessão do jogo especificada.

• Forneça um PlayerId para solicitar todas as sessões de jogador para o jogador especificado.

Para grandes coleções de sessões de jogador, use os parâmetros de paginação para recuperar resultados em blocos sequenciais.

Índice

GameSessionId

Identificador da sessão de jogo exclusivo. Use esse parâmetro para solicitar todas as sessões de jogador da sessão de jogo especificada. O formato do ID da sessão de jogo é o seguinte: arn:aws:gamelift:<region>::gamesession/fleet-<fleet ID>/<ID string>. O valor de <ID string> é uma string de ID personalizada ou (se houver uma especificada quando a sessão de jogo foi criada) uma string gerada.

Tipo: sequência

Obrigatório: não

Limite

O número máximo de resultados a serem retornados. Use esse parâmetro com NextToken para obter resultados como um conjunto de páginas sequenciais. Se um ID de sessão de jogador for especificado, esse parâmetro será ignorado.

Tipo: inteiro

Obrigatório: não

NextToken

Token indicando o início da próxima página sequencial de resultados. Use o token retornado com uma chamada anterior para essa ação. Para especificar o início do conjunto de resultados, não especifique um valor. Se um ID de sessão de jogador for especificado, esse parâmetro será ignorado.

Tipo: sequência

Obrigatório: não

PlayerId

Identificador exclusivo para um jogador. Os IDs de jogador são definidos pelo desenvolvedor. Consulte Gerar IDs de jogador.

Tipo: sequência

Obrigatório: não

PlayerSessionId

Identificador exclusivo para uma sessão de jogador.

Tipo: sequência

Obrigatório: não

PlayerSessionStatusFilter

Status da sessão de jogador para filtrar resultados. Entre os status da sessão de jogador possíveis estão os seguintes:

• RESERVED – A solicitação de sessão de jogador foi recebida, mas o jogador ainda não se conectou ao processo de servidor e/ou foi validado.

• ACTIVE – O jogador foi validado pelo processo de servidor e está conectado no momento.

• COMPLETED – A conexão do jogador foi interrompida.

• TIMEDOUT – Uma solicitação de sessão de jogador foi recebida, mas o jogador não se conectou e/ou não foi validado dentro do tempo limite (60 segundos).

Tipo: sequência

Obrigatório: não

LogParameters

Este tipo de dados é usado para identificar quais arquivos gerados durante uma sessão de jogo você deseja que o Amazon GameLift faça upload e armazene assim que a sessão de jogo terminar. Essas informações são comunicadas ao serviço do Amazon GameLift em uma chamada ProcessReady().

Índice

logPaths

Caminhos de diretório para arquivos de log do servidor de jogos que você deseja que o Amazon GameLift armazene para acesso futuro. Esses arquivos são gerados durante cada sessão do jogo. Os nomes e caminhos de arquivos são definidos no seu servidor de jogos e armazenados no diretório raiz da compilação do jogo. Os caminhos de log devem ser caminhos absolutos. Por exemplo, se a compilação do jogo armazenasse logs de sessão de jogo em um caminho como MyGame\sessionlogs\, o caminho de log seria c:\game\MyGame\sessionLogs (em uma instância do Windows) ou /local/game/MyGame/sessionLogs (em uma instância do Linux).

Tipo: std:vector<std::string>

Obrigatório: não

ProcessParameters

Este tipo de dados contém o conjunto de parâmetros enviado para o serviço do Amazon GameLift em uma chamada ProcessReady().

Índice

port

Número da porta em que o processo de servidor escuta para novas conexões de jogador. O valor deve estar dentro do intervalo de portas configurado para qualquer frota que implanta essa compilação do servidor de jogo. Esse número de porta está incluído nos objetos das sessões de jogo e jogador, que as sessões de jogo usam ao se conectar a um processo de servidor.

Tipo: inteiro

Obrigatório: Sim

logParameters

Objeto com uma lista de caminhos de diretório para arquivos de log da sessão de jogo.

Tipo: Aws::GameLift::Server::LogParameters

Obrigatório: não

onStartGameSession

Nome da função de retorno de chamada que o serviço do Amazon GameLift invoca para ativar uma nova sessão de jogo. O Amazon GameLift chama essa função em resposta à solicitação do cliente CreateGameSession. A função de retorno de chamada passa um objeto GameSession (definido na Referência de API do serviço do Amazon GameLift).

Digite: const std::function<void(Aws::GameLift::Model::GameSession)> onStartGameSession

Obrigatório: Sim

onProcessTerminate

Nome da função de retorno de chamada que o serviço do Amazon GameLift invoca para forçar o desligamento do processo de servidor. Depois de chamar essa função, o Amazon GameLift aguardará cinco minutos para o processo de servidor encerrar e responder com uma chamada ProcessEnding(). Se nenhuma resposta for recebida, ele desativará o processo do servidor.

Digite: std::function<void()> onProcessTerminate

Obrigatório: não

onHealthCheck

Nome da função de retorno que o serviço do Amazon GameLift invoca para solicitar um relatório de status de integridade do processo de servidor. O Amazon GameLift chama essa função a cada 60 segundos. Depois de chamar essa função, o Amazon GameLift aguardará 60 segundos por uma resposta e, se nenhuma for recebida, registra o processo do servidor como não íntegro.

Digite: std::function<bool()> onHealthCheck

Obrigatório: não

onUpdateGameSession

Nome da função de retorno de chamada que o serviço do Amazon GameLift invoca para passar um objeto de sessão de jogo atualizado para o processo do servidor. O Amazon GameLift chama essa função quando uma solicitação de alocação de correspondência é processada para fornecer dados atualizados do marcador de jogos. Ele passa um objeto GameSession, uma atualização de status (updateReason) e o ID do tíquete de alocação de correspondência.

Digite: std::function<void(Aws::GameLift::Server::Model::UpdateGameSession)> onUpdateGameSession

Obrigatório: não

StartMatchBackfillRequest

Esse tipo de dados é usado para enviar uma solicitação de alocação de marcação de jogos. As informações são fornecidas ao serviço do Amazon GameLift em uma chamada StartMatchBackfill().

Índice

GameSessionArn

Identificador da sessão de jogo exclusivo. A ação de API GetGameSessionId() retorna o identificador no formato de ARN.

Tipo: sequência

Obrigatório: Sim

MatchmakingConfigurationArn

O identificador exclusivo, no formato de ARN, para o marcador de jogos a ser usado para essa solicitação. Para encontrar o marcador de jogos usado para criar a sessão de jogo original, procure no objeto de sessão do jogo, na propriedade de dados do marcador de jogos. Saiba mais sobre os dados do marcador de jogos no Trabalhar com dados do marcador de jogos.

Tipo: sequência

Obrigatório: Sim

Jogadores

Um conjunto de dados que representa todos os jogadores que estão na sessão do jogo no momento. O marcador de jogos usa essas informações para pesquisar novos jogadores que sejam correspondências ideais para os jogadores atuais. Consulte o Guia de Referência de API do Amazon GameLift para obter uma descrição do formato do objeto Player. Para encontrar atributos, IDs e atribuições de equipe dos jogadores, procure no objeto de sessão do jogo, na propriedade de dados do marcador de jogos. Se o marcador de jogos usa latência, obtenha a latência atualizada para a região atual e a inclua nos dados de cada jogador.

Tipo: std:vector<player>

Obrigatório: Sim

TicketId

O identificador exclusivo de um tíquete de solicitação de marcação de jogo ou de alocação de correspondência. Se nenhum valor for fornecido aqui, o Amazon GameLift gerará um no formato de UUID. Use esse identificador para acompanhar o status do tíquete de alocação de correspondência ou cancelar a solicitação, se necessário.

Tipo: sequência

Obrigatório: não

StopMatchBackfillRequest

Esse tipo de dados é usado para cancelar uma solicitação de alocação de marcação de jogo. As informações são fornecidas ao serviço do Amazon GameLift em uma chamada StopMatchBackfill().

Índice

GameSessionArn

O identificador de sessão de jogo exclusivo associado à solicitação que está sendo cancelada.

Tipo: sequência

Obrigatório: Sim

MatchmakingConfigurationArn

O identificador exclusivo do marcador de jogos para o qual essa solicitação foi enviada.

Tipo: sequência

Obrigatório: Sim

TicketId

O identificador exclusivo do tíquete de solicitação de alocação a ser cancelado.

Tipo: sequência

Obrigatório: Sim