Referência do cliente Realtime Servers API (C#): Ações - Amazon GameLift

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 do cliente Realtime Servers API (C#): Ações

Essa API referência do C# Realtime Client pode ajudá-lo a preparar seu jogo multijogador para uso com servidores em tempo real implantados nas frotas da Amazon. GameLift

Client()

Inicializa um novo cliente para se comunicar com o servidor em tempo real e identifica o tipo de conexão a ser usado.

Sintaxe

public Client(ClientConfiguration configuration)

Parâmetros

clientConfiguration

Detalhes de configuração especificando o tipo de conexão cliente/servidor. Você pode optar por chamar Client() sem esse parâmetro; no entanto, essa abordagem resulta em uma conexão não segura por padrão.

Tipo: ClientConfiguration

Obrigatório: Não

Valor de retorno

Retorna uma instância do cliente Realtime para uso com a comunicação com o servidor Realtime.

Connect()

Solicita uma conexão com um processo de servidor que está hospedando uma sessão do jogo.

Sintaxe

public ConnectionStatus Connect(string endpoint, int remoteTcpPort, int listenPort, ConnectionToken token)

Parâmetros

endpoint

DNSnome ou endereço IP da sessão de jogo à qual se conectar. O endpoint é especificado em um GameSession objeto, que é retornado em resposta a uma chamada do cliente para as GameLift API ações da AWS SDKAmazon StartGameSessionPlacementCreateGameSession, ou DescribeGameSessions.

nota

Se o servidor Realtime estiver sendo executado em uma frota com um TLS certificado, você deverá usar o DNS nome.

Tipo: string

Obrigatório: Sim

remoteTcpPort

Número da porta para a TCP conexão atribuída à sessão do jogo. Essas informações são especificadas em um GameSession objeto, que é retornado em resposta a uma StartGameSessionPlacementCreateGameSessionDescribeGameSessionsolicitação ou.

Tipo: número inteiro

Valores válidos: 1900 a 2000.

Obrigatório: Sim

listenPort

Número da porta que o cliente do jogo está ouvindo para mensagens enviadas usando o UDP canal.

Tipo: número inteiro

Valores válidos: 33400 a 33500.

Obrigatório: Sim

token

Informações opcionais que identificam o cliente do jogo solicitante para o processo do servidor.

Tipo: ConnectionToken

Obrigatório: sim

Valor de retorno

Retorna ConnectionStatusum valor enumerado indicando o status da conexão do cliente.

Disconnect()

Quando conectado a uma sessão de jogo, desconecta o cliente do jogo da sessão do jogo.

Sintaxe

public void Disconnect()

Parâmetros

Essa ação não tem um parâmetro.

Valor de retorno

Esse método não retorna nada.

NewMessage()

Cria um novo objeto de mensagem com um código de operação especificado. Assim que um objeto de mensagem for retornado, conclua o conteúdo da mensagem especificando um destino, atualizando o método de entrega e adicionando uma carga útil de dados conforme necessário. Uma vez concluído, envie a mensagem usando SendMessage().

Sintaxe

public RTMessage NewMessage(int opCode)

Parâmetros

opCode

Código de operação definido pelo desenvolvedor que identifica um evento de jogo ou ação, como uma movimentação do jogador ou uma notificação do servidor.

Tipo: número inteiro

Obrigatório: Sim

Valor de retorno

Retorna um objeto RTMessage que contém o código de operação especificado e o método de entrega padrão. O parâmetro de intenção de entrega é definido como FAST por padrão.

SendMessage()

Envia uma mensagem para um jogador ou grupo usando o método de entrega especificado.

Sintaxe

public void SendMessage(RTMessage message)

Parâmetros

message

Objeto de mensagem que especifica o destinatário o método de entrega e o conteúdo da mensagem.

Tipo: RTMessage

Obrigatório: sim

Valor de retorno

Esse método não retorna nada.

JoinGroup()

Adiciona o jogador à associação de um grupo especificado. Os grupos podem conter qualquer um dos jogadores conectados ao jogo. Uma vez associado, o jogador recebe todas as futuras mensagens enviadas ao grupo e pode enviar mensagens para todo o grupo.

Sintaxe

public void JoinGroup(int targetGroup)

Parâmetros

targetGroup

ID exclusivo que identifica o grupo ao qual adicionar o jogador. IDsOs grupos são definidos pelo desenvolvedor.

Tipo: número inteiro

Obrigatório: Sim

Valor de retorno

Esse método não retorna nada. Como essa solicitação é enviada usando o método de entrega reliable (TCP), uma solicitação com falha aciona o retorno de chamada. OnError()

LeaveGroup()

Remove o jogador da associação de um grupo especificado. Assim que não estiver mais no grupo, o jogador não receberá as mensagens enviadas ao grupo e não poderá enviar mensagens para todo o grupo.

Sintaxe

public void LeaveGroup(int targetGroup)

Parâmetros

targetGroup

ID exclusivo que identifica o grupo do qual remover o jogador. IDsOs grupos são definidos pelo desenvolvedor.

Tipo: número inteiro

Obrigatório: Sim

Valor de retorno

Esse método não retorna nada. Como essa solicitação é enviada usando o método de entrega reliable (TCP), uma solicitação com falha aciona o retorno de chamada. OnError()

RequestGroupMembership()

Solicita que uma lista de jogadores no grupo especificado seja enviada para o cliente do jogo. Qualquer jogador pode solicitar essas informações, independentemente de ele ser um membro do grupo ou não. Em resposta a essa solicitação, a lista de associações é enviada ao cliente por meio de um retorno de chamada OnGroupMembershipUpdated().

Sintaxe

public void RequestGroupMembership(int targetGroup)

Parâmetros

targetGroup

ID exclusivo que identifica o grupo do qual obter informações de associação. IDsOs grupos são definidos pelo desenvolvedor.

Tipo: número inteiro

Obrigatório: Sim

Valor de retorno

Esse método não retorna nada.