Référence de l'API client (C#) de Realtime Servers : types de données

Cette référence d'API client C# Realtime peut vous aider à préparer votre jeu multijoueur en vue de son utilisation avec les serveurs en temps réel déployés sur les flottes Amazon. GameLift Pour plus d'informations sur le processus d'intégration, consultez Préparez votre serveur en temps réel.

• Actions synchrones

• Rappels asynchrones

• Les types de données

ClientConfiguration

Informations sur la façon dont le client du jeu se connecte à un serveur en temps réel.

Table des matières

ConnectionType

Type de connexion client/serveur à utiliser, sécurisée ou non sécurisée. Si vous ne spécifiez pas de type de connexion, la valeur par défaut est non sécurisée.

Note

Lors de la connexion à un serveur en temps réel sur une flotte sécurisée avec un certificat TLS, vous devez utiliser la valeur RT_OVER_WSS_DTLS_TLS12.

Type : valeur ConnectionType enum .

Obligatoire : non

ConnectionToken

Informations concernant le client du jeu et/ou le joueur qui demande une connexion à un serveur en temps réel.

Table des matières

playerSessionId

Identifiant unique émis par Amazon GameLift lors de la création d'une nouvelle session de joueur. Un identifiant de session de joueur est spécifié dans un PlayerSession objet, qui est renvoyé en réponse à un appel du client aux actions de l'GameLiftAPI StartGameSessionPlacementCreateGameSession, DescribeGameSessionPlacement, ou DescribePlayerSessions.

Type : String

Obligatoire : oui

payload

Informations définies par le développeur à communiquer au serveur en temps réel lors de la connexion. Cela inclut toutes les données arbitraires qui peuvent être utilisées pour un mécanisme de connexion personnalisé. Par exemple, une charge utile peut fournir des informations d'authentification à traiter par le script du serveur en temps réel avant d'autoriser un client à se connecter.

Type : tableau d'octets

Obligatoire : non

RTMessage

Contenu et informations de livraison pour un message. Un message doit spécifier soit un joueur ou un groupe cible.

Table des matières

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. Un code Op d'un message fournit le contexte pour les données utiles qui sont fournies. Le code d'opération des messages créés à l'aide de NewMessage () est déjà défini, mais il peut être modifié à tout moment.

Type : entier

Obligatoire : oui

targetPlayer

ID unique qui identifie le destinataire voulu du message envoyé. La cible peut être le serveur lui-même (en utilisant l'ID de serveur) ou un autre joueur (à l'aide d'un ID de joueur).

Type : entier

Obligatoire : non

targetGroup

ID unique qui identifie le groupe destinataire voulu du message envoyé. Les ID de groupe sont définis par le développeur.

Type : entier

Obligatoire : non

deliveryIntent

Indique s'il convient d'envoyer le message à l'aide de la connexion TCP fiable ou à l'aide du canal UDP rapide. Messages créés à l'aide de NewMessage().

Type : DeliveryIntent enum

Valeurs valides : RAPIDE | FIABLE

Obligatoire : oui

payload

Contenu du message. Ces informations sont structurées de telle manière à être traitées par le client de jeu en fonction du code d'opération connexe. Elles peuvent contenir des données d'état du jeu ou d'autres informations qui doivent être communiquées entre les clients de jeu ou entre un client de jeu et le serveur en temps réel.

Type : tableau d'octets

Obligatoire : non

DataReceivedEventArgs

Les données fournies avec un rappel OnDataReceived().

Table des matières

sender

ID unique qui identifie l'entité (ID de joueur ou ID de serveur) ayant transmis le message.

Type : entier

Obligatoire : oui

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. Un code Op d'un message fournit le contexte pour les données utiles qui sont fournies.

Type : entier

Obligatoire : oui

data

Contenu du message. Ces informations sont structurées de telle manière à être traitées par le client de jeu en fonction du code d'opération connexe. Elles peuvent contenir des données d'état du jeu ou d'autres informations qui doivent être communiquées entre les clients de jeu ou entre un client de jeu et le serveur en temps réel.

Type : tableau d'octets

Obligatoire : non

GroupMembershipEventArgs

Les données fournies avec un rappel OnGroupMembershipUpdated().

Table des matières

sender

ID unique qui identifie le joueur qui a demandé une mise à jour d'adhésion au groupe.

Type : entier

Obligatoire : oui

opCode

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

Type : entier

Obligatoire : oui

groupId

ID unique qui identifie le groupe destinataire voulu du message envoyé. Les ID de groupe sont définis par le développeur.

Type : entier

Obligatoire : oui

playerId

Liste des ID de joueurs qui sont actuellement membres du groupe spécifié.

Type : tableau integer

Obligatoire : oui

Enums

Les énumérations définies pour le SDK du client en temps réel sont définies comme suit :

ConnectionStatus

• CONNECTÉ — Le client du jeu est connecté au serveur en temps réel via une connexion TCP uniquement. Tous les messages sont envoyés via TCP ; indépendamment de l'intention de livraison.

• CONNECTED_SEND_FAST — Le client du jeu est connecté au serveur Realtime via une connexion TCP et UDP. Cependant, la capacité de recevoir des messages via UDP n'est pas encore vérifiée. Par conséquent, tous les messages envoyés au client de jeu utilisent TCP.

• CONNECTED_SEND_AND_RECEIVE_FAST — Le client du jeu est connecté au serveur Realtime via une connexion TCP et UDP. Le client de jeu peut envoyer et recevoir des messages à l'aide de TCP ou UDP.

• CONNECTING Le client du jeu a envoyé une demande de connexion et le serveur Realtime est en train de la traiter.

• DISCONNECTED_CLIENT_CALL — Le client du jeu a été déconnecté du serveur en temps réel en réponse à une demande du client du jeu. Disconnect()

• DÉCONNECTÉ — Le client du jeu a été déconnecté du serveur en temps réel pour une raison autre qu'un appel de déconnexion du client.

ConnectionType

• RT_OVER_WSS_DTLS_TLS12 — Type de connexion sécurisée.

  À utiliser avec les serveurs en temps réel qui s'exécutent sur un GameLift parc avec un certificat TLS généré. Lorsque vous utilisez une connexion sécurisée, le trafic TCP est chiffré à l'aide de TLS 1.2 et le trafic UDP est chiffré à l'aide de DTLS 1.2.

• RT_OVER_WS_UDP_UNSECURED — Type de connexion non sécurisé.

• RT_OVER_WEBSOCKET — Type de connexion non sécurisé. Cette valeur n'est plus préférée.

DeliveryIntent

• RAPIDE — Livré via un canal UDP.

• FIABLE — Fourni via une connexion TCP.