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á.
Referência GameLift do servidor Amazon SDK (Unreal): tipos de dados
Você pode usar essa SDK referência de servidor Amazon GameLift Unreal para ajudá-lo a preparar seu jogo multijogador para uso com a Amazon GameLift. Para obter detalhes sobre o processo de integração, consulte Adicione GameLift a Amazon ao seu servidor de jogos e para obter informações sobre como usar o plug-in de SDK servidor Unreal, consulteIntegre a Amazon GameLift em um projeto Unreal Engine.
Tipos de dados
- FProcessParameters
- UpdateGameSession
- GameSession
- FServerParameters
- FStartMatchBackfillRequest
- FPlayer
- FGameLiftDescribePlayerSessionsRequest
- FStopMatchBackfillRequest
- FAttributeValue
- FGameLiftGetFleetRoleCredentialsRequest
- FGameLiftLongOutcome
- FGameLiftStringOutcome
- FGameLiftDescribePlayerSessionsOutcome
- FGameLiftDescribePlayerSessionsResult
- FGenericOutcome
- FGameLiftPlayerSession
- FGameLiftGetComputeCertificateOutcome
- FGameLiftGetComputeCertificateResult
- FGameLiftGetFleetRoleCredentialsOutcome
- FGetFleetRoleCredentialsResult
- FGameLiftError
- Enumerações
nota
Este tópico descreve o Amazon GameLift C++ API que você pode usar ao criar para o Unreal Engine. Especificamente, essa documentação se aplica ao código que você compila com a opção -DBUILD_FOR_UNREAL=1
.
FProcessParameters
Esse tipo de dados contém o conjunto de parâmetros enviados para a Amazon GameLift em umProcessReady().
Properties |
Descrição |
LogParameters | Um objeto com caminhos de diretório para arquivos que são gerados durante uma sessão de jogo. A Amazon GameLift copia e armazena os arquivos para acesso futuro. Digite: Obrigatório: não |
OnHealthCheck | A função de retorno de chamada que a Amazon GameLift invoca para solicitar um relatório de status de saúde do processo do servidor. A Amazon GameLift chama essa função a cada 60 segundos e espera 60 segundos por uma resposta. O processo do servidor retorna TRUE se estiver íntegro, FALSE se não estiver íntegro. Se nenhuma resposta for retornada, a Amazon GameLift registra o processo do servidor como não íntegro. Essa propriedade é uma função delegada definida como Digite: Obrigatório: não |
OnProcessTerminate | A função de retorno de chamada que a Amazon GameLift invoca para forçar o encerramento do processo do servidor. Depois de chamar essa função, a Amazon GameLift espera 5 minutos até que o processo do servidor seja encerrado e responda com uma ProcessEnding() chamada antes de encerrar o processo do servidor. Digite: Obrigatório: Sim |
OnStartGameSession | A função de retorno de chamada que a Amazon GameLift invoca para ativar uma nova sessão de jogo. A Amazon GameLift chama essa função em resposta a uma solicitação do cliente CreateGameSession. A função de retorno de chamada passa um GameSession objeto. Essa propriedade é uma função delegada definida como Digite: Obrigatório: Sim |
OnUpdateGameSession | A função de retorno de chamada que a Amazon GameLift invoca para passar um objeto de sessão de jogo atualizado para o processo do servidor. A Amazon GameLift chama essa função quando uma solicitação de preenchimento de correspondência é processada para fornecer dados atualizados do matchmaker. Ele passa um GameSession objeto, uma atualização de status (updateReason ) e o ID do tíquete de preenchimento correspondente. Essa propriedade é uma função delegada definida como Digite: Obrigatório: não |
Porta | O 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. Digite: Obrigatório: Sim |
UpdateGameSession
Esse tipo de dados é atualizado para um objeto de sessão de jogo, o que inclui o motivo pelo qual a sessão de jogo foi atualizada e o ID do tíquete de alocação relacionada, se a alocação for usada para preencher as sessões dos jogadores na sessão do jogo.
Propriedades | Descrição |
---|---|
GameSession | Um objeto GameSession. O objeto GameSession contém propriedades que descrevem uma sessão de jogo. Digite: Obrigatório: não |
UpdateReason | O motivo pelo qual a sessão do jogo está sendo atualizada. Digite:
Obrigatório: não |
BackfillTicketId | O ID do tíquete de alocação que está tentando atualizar a sessão do jogo. Digite: Obrigatório: não |
GameSession
Esse tipo de dados fornece detalhes de uma sessão de jogo.
Propriedades | Descrição |
---|---|
GameSessionId |
Um identificador exclusivo da sessão de jogo. Uma sessão de jogo ARN tem o seguinte formato: Digite: Obrigatório: não |
Nome |
Um rótulo descritivo da sessão do jogo. Digite: Obrigatório: não |
FleetId |
Um identificador exclusivo da frota em que a sessão de jogo está sendo executada. Digite: Obrigatório: não |
MaximumPlayerSessionCount |
O número máximo de conexões do jogador com a sessão do jogo. Digite: Obrigatório: não |
Porta |
O número da porta da sessão de jogo. Para se conectar a um servidor de GameLift jogos da Amazon, um aplicativo precisa do endereço IP e do número da porta. Digite: Obrigatório: não |
IpAddress |
O endereço IP da sessão de jogo. Para se conectar a um servidor de GameLift jogos da Amazon, um aplicativo precisa do endereço IP e do número da porta. Digite: Obrigatório: não |
GameSessionData |
Um conjunto de propriedades de sessão de jogo personalizadas, formatadas como um único valor de string. Digite: Obrigatório: não |
MatchmakerData |
Informações sobre o processo de matchmaking usado para criar a sessão do jogo, em JSON sintaxe, formatado como uma string. Além da configuração de marcação de jogos usada, ele contém dados sobre todos os jogadores atribuídos à partida, incluindo atributos do jogador e atribuições da equipe. Digite: Obrigatório: não |
GameProperties |
Um conjunto de propriedades personalizadas para uma sessão de jogo, formatado como pares de chave:valor. Essas propriedades são passadas com uma solicitação de início de uma nova sessão de jogo. Digite: Obrigatório: não |
DnsName |
O DNS identificador atribuído à instância que está executando a sessão do jogo. Os valores têm o formato a seguir:
Ao se conectar a uma sessão de jogo que está sendo executada em uma frota TLS habilitada, você deve usar o DNS nome, não o endereço IP. Digite: Obrigatório: não |
FServerParameters
Informações usadas para manter a conexão entre um GameLift Anywhere servidor da Amazon e o GameLift serviço da Amazon. Essas informações são usadas ao iniciar novos processos de servidor com InitSDK(). Para servidores hospedados em EC2 instâncias GameLift gerenciadas da Amazon, use um objeto vazio.
Propriedades | Descrição |
---|---|
webSocketUrl |
A Digite: Obrigatório: Sim |
processId |
Um identificador exclusivo registrado no processo do servidor que hospeda seu jogo. Digite: Obrigatório: Sim |
hostId | O HostID é o ComputeName usado quando você registrou seu computador. Para obter mais informações, consulte, RegisterCompute.Digite: Obrigatório: Sim |
fleetId | O identificador exclusivo da frota na qual o computador está registrado. Para obter mais informações, consulte, RegisterCompute. Digite: Obrigatório: Sim |
authToken | O token de autenticação gerado pela Amazon GameLift que autentica seu servidor na Amazon GameLift. Para obter mais informações, consulte, GetComputeAuthToken. Digite: Obrigatório: Sim |
FStartMatchBackfillRequest
Informações usadas para criar uma solicitação de alocação de marcação de jogos. O servidor do jogo comunica essas informações à Amazon GameLift em uma StartMatchBackfill() chamada.
Propriedades | Descrição |
---|---|
GameSessionArn |
Um identificador da sessão de jogo exclusivo. A API operação Digite: Obrigatório: Sim |
MatchmakingConfigurationArn |
Um identificador único, na forma de umARN, para o matchmaker usar para esta solicitação. O matchmaker da sessão ARN de jogo original está no objeto da sessão de jogo na propriedade de dados do matchmaker. Saiba mais sobre os dados do marcador de jogos em Trabalhar com dados do marcador de jogos. Digite: Obrigatório: Sim |
Jogadores |
Um conjunto de dados que representa todos os jogadores que estão na sessão do jogo. O marcador de jogos usa essas informações para pesquisar novos jogadores que sejam correspondências ideais para os jogadores atuais. Digite: Obrigatório: Sim |
TicketId |
Um identificador exclusivo de um tíquete de solicitação de marcação de jogo ou de alocação de correspondência. Se você não fornecer um valor, a Amazon GameLift gera um. Use esse identificador para acompanhar o status do tíquete de alocação de correspondência ou cancelar a solicitação, se necessário. Digite: Obrigatório: não |
FPlayer
Esse tipo de dados representa um jogador em marcação de jogos. Ao iniciar uma solicitação de marcação de jogos, um jogador tem um ID de jogador, atributos, e possivelmente dados de latência. A Amazon GameLift adiciona informações da equipe após a realização de uma partida.
Propriedades | Descrição |
---|---|
LatencyInMS |
Um conjunto de valores expressos em milissegundos que indicam a quantidade de latência que um jogador experimenta quando conectado a um local. Se essa propriedade for usada, o player só será correspondido aos locais listados. Se um marcador de jogos tiver uma regra que avalie a latência do jogador, os jogadores deverão reportar a latência a ser correspondida. Digite: Obrigatório: não |
PlayerAttributes |
Uma coleção de pares de chave:valor contendo informações de jogadores para uso em marcação de jogos. As chaves de atributos do jogador devem corresponder às PlayerAttributes usadas em um conjunto de regras de matchmaking. Para obter mais informações sobre os atributos do jogador, consulte AttributeValue. Digite: Obrigatório: não |
PlayerId |
Um identificador exclusivo para um jogador. Digite: Obrigatório: não |
Team |
O nome da equipe à qual o jogador está designado em uma partida. Você define o nome da equipe no conjunto de regras de marcação de jogos. Digite: Obrigatório: não |
FGameLiftDescribePlayerSessionsRequest
Um objeto que especifica quais sessões de jogador devem ser recuperadas. O processo do servidor fornece essas informações com uma DescribePlayerSessions() chamada para a Amazon GameLift.
Propriedades | Descrição |
---|---|
GameSessionId |
Um 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 do jogo é Digite: Obrigatório: não |
PlayerSessionId |
Um identificador exclusivo para uma sessão de jogador. Use esse parâmetro para solicitar uma única sessão de jogador específica. Digite: Obrigatório: não |
PlayerId |
Um identificador exclusivo para um jogador. Use este parâmetro para solicitar todas as sessões de jogador para um jogador específico. Consulte Gerar IDs de jogador. Digite: Obrigatório: não |
PlayerSessionStatusFilter |
O status da sessão de jogador para filtrar resultados. Entre os status da sessão de jogador possíveis incluem:
Digite: Obrigatório: não |
NextToken |
O token que indica o início da próxima página de resultados. Para especificar o início do conjunto de resultados, não forneça um valor. Se fornecer um ID de sessão do jogador, esse parâmetro será ignorado. Digite: Obrigatório: não |
Limite |
O número máximo de resultados a serem retornados. Se fornecer um ID de sessão do jogador, esse parâmetro será ignorado. Digite: Obrigatório: não |
FStopMatchBackfillRequest
Informações usadas para cancelar uma solicitação de alocação de marcação de jogos. O servidor do jogo comunica essas informações ao GameLift serviço da Amazon em uma StopMatchBackfill() chamada.
Propriedades | Descrição |
---|---|
GameSessionArn |
Um identificador exclusivo da sessão de jogo da solicitação que está sendo cancelada. Digite: Obrigatório: Sim |
MatchmakingConfigurationArn |
Um identificador exclusivo do marcador de jogos para o qual essa solicitação foi enviada. Digite: Obrigatório: Sim |
TicketId |
Um identificador exclusivo do tíquete de solicitação de alocação a ser cancelado. Digite: Obrigatório: Sim |
FAttributeValue
Use esses valores em pares de chave-valor de atributo FPlayer. Esse objeto permite especificar um valor de atributo usando qualquer um dos tipos de dados válidos: string, número, matriz de string ou mapa de dados. Cada objeto AttributeValue
pode usar somente uma das propriedades disponíveis.
Propriedades | Descrição |
---|---|
attrType |
Especifica o tipo de valor do atributo. Tipo: Um Obrigatório: não |
S |
Representa um valor de atributo de string. Digite: Obrigatório: não |
N |
Representa um valor de atributo numérico. Digite: Obrigatório: não |
SL |
Representa uma matriz de valores de atributos de string. Digite: Obrigatório: não |
SDM |
Representa um dicionário de chaves de string e valores duplos. Digite: Obrigatório: não |
FGameLiftGetFleetRoleCredentialsRequest
Esse tipo de dados fornece credenciais de função que ampliam o acesso limitado aos seus recursos AWS no servidor do jogo. Para obter mais informações, consulte, Configurar uma função de serviço do IAM para a Amazon GameLift.
Propriedades | Descrição |
---|---|
RoleArn | O Amazon Resource Name (ARN) da função de serviço que estende o acesso limitado aos seus AWS recursos. Digite: Obrigatório: não |
RoleSessionName | O nome da sessão que descreve o uso das credenciais da função. Digite: Obrigatório: não |
FGameLiftLongOutcome
Esse tipo de dados resulta de uma ação e produz um objeto com as seguintes propriedades:
Propriedades | Descrição |
---|---|
Resultado |
O resultado da ação. Digite: Obrigatório: não |
ResultWithOwnership |
O resultado da ação, convertido como um rvalue, para que o código de chamada possa se apropriar do objeto. Digite: Obrigatório: não |
Bem-sucedida |
Se a ação foi bem-sucedida ou não. Digite: Obrigatório: Sim |
Erro |
O erro que ocorreu se a ação não foi bem-sucedida. Digite: FGameLiftError Obrigatório: não |
FGameLiftStringOutcome
Esse tipo de dados resulta de uma ação e produz um objeto com as seguintes propriedades:
Propriedades | Descrição |
---|---|
Resultado |
O resultado da ação. Digite: Obrigatório: não |
ResultWithOwnership |
O resultado da ação, convertido como um rvalue, para que o código de chamada possa se apropriar do objeto. Digite: Obrigatório: não |
Bem-sucedida |
Se a ação foi bem-sucedida ou não. Digite: Obrigatório: Sim |
Erro |
O erro que ocorreu se a ação não foi bem-sucedida. Digite: FGameLiftError Obrigatório: não |
FGameLiftDescribePlayerSessionsOutcome
Esse tipo de dados resulta de uma ação e produz um objeto com as seguintes propriedades:
Propriedades | Descrição |
---|---|
Resultado |
O resultado da ação. Digite: FGameLiftDescribePlayerSessionsResult Obrigatório: não |
ResultWithOwnership |
O resultado da ação, convertido como um rvalue, para que o código de chamada possa se apropriar do objeto. Digite: Obrigatório: não |
Bem-sucedida |
Se a ação foi bem-sucedida ou não. Digite: Obrigatório: Sim |
Erro |
O erro que ocorreu se a ação não foi bem-sucedida. Digite: FGameLiftError Obrigatório: não |
FGameLiftDescribePlayerSessionsResult
Propriedades | Descrição |
---|---|
PlayerSessions |
Digite: Obrigatório: Sim |
NextToken |
O token indicando o início da próxima página de resultados. Para especificar o início do conjunto de resultados, não forneça um valor. Se fornecer um ID de sessão do jogador, esse parâmetro será ignorado. Digite: Obrigatório: não |
Bem-sucedida |
Se a ação foi bem-sucedida ou não. Digite: Obrigatório: Sim |
Erro |
O erro que ocorreu se a ação não foi bem-sucedida. Digite: FGameLiftError Obrigatório: não |
FGenericOutcome
Esse tipo de dados resulta de uma ação e produz um objeto com as seguintes propriedades:
Propriedades | Descrição |
---|---|
Bem-sucedida |
Se a ação foi bem-sucedida ou não. Digite: Obrigatório: Sim |
Erro |
O erro que ocorreu se a ação não foi bem-sucedida. Digite: FGameLiftError Obrigatório: não |
FGameLiftPlayerSession
Propriedades | Descrição |
---|---|
CreationTime |
Digite: Obrigatório: Sim |
FleetId |
Digite: Obrigatório: Sim |
GameSessionId |
Digite: Obrigatório: Sim |
IpAddress |
Digite: Obrigatório: Sim |
PlayerData |
Digite: Obrigatório: Sim |
PlayerId |
Digite: Obrigatório: Sim |
PlayerSessionId |
Digite: Obrigatório: Sim |
Porta |
Digite: Obrigatório: Sim |
Status |
Tipo: Um Obrigatório: Sim |
TerminationTime |
Digite: Obrigatório: Sim |
DnsName |
Digite: Obrigatório: Sim |
FGameLiftGetComputeCertificateOutcome
Esse tipo de dados resulta de uma ação e produz um objeto com as seguintes propriedades:
Propriedades | Descrição |
---|---|
Resultado |
O resultado da ação. Digite: FGameLiftGetComputeCertificateResult Obrigatório: não |
ResultWithOwnership |
O resultado da ação, convertido como um rvalue, para que o código de chamada possa se apropriar do objeto. Digite: Obrigatório: não |
Bem-sucedida |
Se a ação foi bem-sucedida ou não. Digite: Obrigatório: Sim |
Erro |
O erro que ocorreu se a ação não foi bem-sucedida. Digite: FGameLiftError Obrigatório: não |
FGameLiftGetComputeCertificateResult
O caminho para o TLS certificado em seu computador e o nome do host do computador.
Propriedades | Descrição |
---|---|
CertificatePath |
Digite: Obrigatório: Sim |
ComputeName |
Digite: Obrigatório: Sim |
FGameLiftGetFleetRoleCredentialsOutcome
Esse tipo de dados resulta de uma ação e produz um objeto com as seguintes propriedades:
Propriedades | Descrição |
---|---|
Resultado |
O resultado da ação. Digite: FGetFleetRoleCredentialsResult Obrigatório: não |
ResultWithOwnership |
O resultado da ação, convertido como um rvalue, para que o código de chamada possa se apropriar do objeto. Digite: Obrigatório: não |
Bem-sucedida |
Se a ação foi bem-sucedida ou não. Digite: Obrigatório: Sim |
Erro |
O erro que ocorreu se a ação não foi bem-sucedida. Digite: FGameLiftError Obrigatório: não |
FGetFleetRoleCredentialsResult
Propriedades | Descrição |
---|---|
AccessKeyId |
O ID da chave de acesso para autenticar e fornecer acesso aos seus recursos AWS . Digite: Obrigatório: não |
AssumedRoleId |
O ID do usuário ao qual o perfil de serviço pertence. Digite: Obrigatório: não |
AssumedRoleUserArn |
O Amazon Resource Name (ARN) do usuário ao qual a função de serviço pertence. Digite: Obrigatório: não |
Expiração |
A quantidade de tempo até que suas credenciais de sessão expirem. Digite: Obrigatório: não |
SecretAccessKey |
O ID da chave de acesso secreta para autenticação. Digite: Obrigatório: não |
SessionToken |
Um token para identificar a sessão ativa atual interagindo com seus AWS recursos. Digite: Obrigatório: não |
Bem-sucedida |
Se a ação foi bem-sucedida ou não. Digite: Obrigatório: Sim |
Erro |
O erro que ocorreu se a ação não foi bem-sucedida. Digite: GameLiftError Obrigatório: não |
FGameLiftError
Propriedades | Descrição |
---|---|
ErrorType |
O tipo de erro. Tipo: Um Obrigatório: não |
ErrorName |
O nome do erro. Digite: Obrigatório: não |
ErrorMessage |
A mensagem de erro. Digite: Obrigatório: não |
Enumerações
Os enums definidos para o GameLift servidor Amazon SDK (Unreal) são definidos da seguinte forma:
- FAttributeType
-
NONE
STRING
DOUBLE
STRING_LIST
STRING_DOUBLE_MAP
- GameLiftErrorType
-
Valor da string indicando o tipo de erro. Os valores válidos são:
-
SERVICE_ CALL _ FAILED — Uma chamada para um AWS serviço falhou.
-
LOCAL_ CONNECTION _ FAILED — A conexão local com a Amazon GameLift falhou.
-
NETWORK_ NOT _ INITIALIZED — A rede não foi inicializada.
-
GAMESESSION_ID_ NOT _ SET — O ID da sessão do jogo não foi definido.
-
BAD_REQUEST_EXCEPTION
-
INTERNAL_SERVICE_EXCEPTION
-
ALREADY_ INITIALIZED — O GameLift servidor ou cliente da Amazon já foi inicializado com Initialize ().
-
FLEET_ MISMATCH — A frota alvo não corresponde à frota de um gameSession ouplayerSession.
-
GAMELIFT_ CLIENT _ NOT _ INITIALIZED — O GameLift cliente Amazon não foi inicializado.
-
GAMELIFT_ SERVER _ NOT _ INITIALIZED — O GameLift servidor Amazon não foi inicializado.
-
GAME_ _ SESSION ENDED _ FAILED — O Amazon GameLift Server não SDK conseguiu entrar em contato com o serviço para informar que a sessão do jogo foi encerrada.
-
GAME_ SESSION _ NOT _ READY — A sessão de jogo GameLift do Amazon Server não foi ativada.
-
GAME_ SESSION _ READY _ FAILED — O Amazon GameLift Server não SDK conseguiu entrar em contato com o serviço para informar que a sessão do jogo está pronta.
-
INITIALIZATION_ MISMATCH — Um método cliente foi chamado depois de Server: :Initialize () ou vice-versa.
-
NOT_ INITIALIZED — O GameLift servidor ou cliente da Amazon não foi inicializado com Initialize ().
-
NO_ TARGET _ ALIASID _ SET — Uma meta não aliasId foi definida.
-
NO_ TARGET _ FLEET _ SET — Uma frota alvo não foi definida.
-
PROCESS_ ENDING _ FAILED — O Amazon GameLift Server não SDK conseguiu entrar em contato com o serviço para informar que o processo está sendo encerrado.
-
PROCESS_ NOT _ ACTIVE — O processo do servidor ainda não está ativo, não está vinculado a um GameSession e não pode aceitar ou processar PlayerSessions.
-
PROCESS_ NOT _ READY — O processo do servidor ainda não está pronto para ser ativado.
-
PROCESS_ READY _ FAILED — O Amazon GameLift Server não SDK pôde entrar em contato com o serviço para informar que o processo está pronto.
-
SDK_ VERSION _ DETECTION _ FAILED — falha SDK na detecção da versão.
-
STX_ CALL _ FAILED — Uma chamada para o componente de back-end do XStx servidor falhou.
-
STX_ INITIALIZATION _ FAILED — O componente de back-end do XStx servidor falhou ao inicializar.
-
UNEXPECTED_ PLAYER _ SESSION — Uma sessão de jogador não registrada foi encontrada pelo servidor.
-
WEBSOCKET_CONNECT_FAILURE
-
WEBSOCKET_CONNECT_FAILURE_FORBIDDEN
-
WEBSOCKET_CONNECT_FAILURE_INVALID_URL
-
WEBSOCKET_CONNECT_FAILURE_TIMEOUT
-
WEBSOCKET_ RETRIABLE _ SEND _ MESSAGE _ FAILURE — Falha recuperável ao enviar uma mensagem ao GameLift Serviço WebSocket.
-
WEBSOCKET_ SEND _ MESSAGE _ FAILURE — Falha no envio de uma mensagem para o GameLift Serviço WebSocket.
-
MATCH_ BACKFILL _ REQUEST _ VALIDATION — Falha na validação da solicitação.
-
PLAYER_ SESSION _ REQUEST _ VALIDATION — Falha na validação da solicitação.
-
- EPlayerSessionCreationPolicy
-
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.
-
NOT_ SET — A sessão do jogo não está configurada para aceitar ou negar sessões de novos jogadores.
-
- EPlayerSessionStatus
-
ACTIVE
COMPLETED
NOT_SET
RESERVED
TIMEDOUT