Référence du client Realtime Servers API (C#) : Actions

Cette API référence du client C# Realtime peut vous aider à préparer votre jeu multijoueur pour une utilisation avec les serveurs en temps réel déployés sur les flottes Amazon. GameLift

• Actions synchrones

• Rappels asynchrones

• Types de données

Client()

Initialise un nouveau client pour communiquer avec le serveur Realtime et identifie le type de connexion à utiliser.

Syntaxe

public Client(ClientConfiguration configuration)

Paramètres

clientConfiguration

Détails de configuration spécifiant le type de connexion client/serveur. Vous pouvez choisir d'appeler Client() sans ce paramètre ; cependant, cette approche se traduit par une connexion non sécurisée par défaut.

Type : ClientConfiguration

Obligatoire : non

Valeur renvoyée

Renvoie une instance du client Realtime à utiliser avec la communication avec le serveur Realtime.

Connect()

Demande une connexion à un processus serveur qui héberge une session de jeu.

Syntaxe

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

Paramètres

point de terminaison

DNSnom ou adresse IP de la session de jeu à laquelle se connecter. Le point de terminaison est spécifié dans un GameSession objet, qui est renvoyé en réponse à un appel du client aux GameLift API actions AWS SDKAmazon StartGameSessionPlacementCreateGameSession, ou DescribeGameSessions.

Note

Si le serveur Realtime fonctionne sur un parc doté d'un TLS certificat, vous devez utiliser le DNS nom.

Type : String

Obligatoire : oui

remoteTcpPort

Numéro de port pour la TCP connexion attribuée à la session de jeu. Ces informations sont spécifiées dans un GameSession objet, qui est renvoyé en réponse à une StartGameSessionPlacementCreateGameSessionDescribeGameSessiondemande ou.

Type : entier

Valeurs valides : 1900 à 2000.

Obligatoire : oui

listenPort

Numéro de port sur lequel le client du jeu écoute les messages envoyés via le UDP canal.

Type : entier

Valeurs valides : 33400 à 33500.

Obligatoire : oui

jeton

Informations facultatives qui identifient la demande client de jeu au processus serveur.

Type : ConnectionToken

Obligatoire : oui

Valeur renvoyée

Renvoie une valeur ConnectionStatusenum indiquant l'état de connexion du client.

Disconnect()

Lorsque vous êtes connecté à une session de jeu, déconnecte le client de jeu à partir de la session de jeu.

Syntaxe

public void Disconnect()

Paramètres

Cette action n'a aucun paramètre.

Valeur renvoyée

Cette méthode ne renvoie rien.

NewMessage()

Crée un nouvel objet de message avec un code d'opération spécifié. Une fois qu'un message est renvoyé, complétez le contenu du message en spécifiant une cible, en mettant à jour le mode de remise, et en ajoutant une charge utile de données en fonction de vos besoins. Une fois terminé, envoyez le message à l'aide de SendMessage().

Syntaxe

public RTMessage NewMessage(int opCode)

Paramètres

opCode

Code d'opération défini par le développeur qui identifie un événement ou une action de jeu, par exemple un mouvement de joueur ou une notification.

Type : entier

Obligatoire : oui

Valeur renvoyée

Renvoie un objet RTMessage contenant l'opération spécifiée par défaut et la méthode de livraison de code. Le paramètre d'intention d'acheminement est défini sur FAST par défaut.

SendMessage()

Envoie un message à un joueur ou un groupe à l'aide de la méthode de livraison spécifiée.

Syntaxe

public void SendMessage(RTMessage message)

Paramètres

message

Message d'objet qui spécifie le destinataire cible, la méthode de livraison et le contenu du message.

Type : RTMessage

Obligatoire : oui

Valeur renvoyée

Cette méthode ne renvoie rien.

JoinGroup()

Ajoute le joueur à un groupe spécifié. Les groupes peuvent contenir n'importe quel joueur connecté au jeu. Une fois qu'il a rejoint le serveur, le joueur reçoit tous les futurs messages envoyés au groupe et peut envoyer des messages à l'ensemble du groupe.

Syntaxe

public void JoinGroup(int targetGroup)

Paramètres

targetGroup

ID unique qui identifie le groupe auquel ajouter le joueur. IDsLes groupes sont définis par le développeur.

Type : entier

Obligatoire : oui

Valeur renvoyée

Cette méthode ne renvoie rien. Comme cette demande est envoyée à l'aide de la méthode de livraison reliable (TCP), une demande échouée déclenche le rappelOnError().

LeaveGroup()

Retire le joueur d'un groupe spécifié. Une fois qu'il n'est plus dans le groupe, le joueur ne reçoit pas les messages envoyés au groupe et ne peut envoyer de messages à l'ensemble du groupe.

Syntaxe

public void LeaveGroup(int targetGroup)

Paramètres

targetGroup

ID unique qui identifie le groupe duquel retirer le joueur. IDsLes groupes sont définis par le développeur.

Type : entier

Obligatoire : oui

Valeur renvoyée

Cette méthode ne renvoie rien. Comme cette demande est envoyée à l'aide de la méthode de livraison reliable (TCP), une demande échouée déclenche le rappelOnError().

RequestGroupMembership()

Demande qu'une liste de joueurs dans le groupe spécifié soit envoyée au client de jeu. Tout joueur peut demander ces informations, qu'il s'agisse ou non d'un membre du groupe. En réponse à cette demande, la liste d'adhésion est envoyée au client via un rappel OnGroupMembershipUpdated().

Syntaxe

public void RequestGroupMembership(int targetGroup)

Paramètres

targetGroup

ID unique qui identifie le groupe pour lequel obtenir des informations sur l'adhésion. IDsLes groupes sont définis par le développeur.

Type : entier

Obligatoire : oui

Valeur renvoyée

Cette méthode ne renvoie rien.