Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.
SDK 5.x du serveur C# pour Amazon GameLift Servers -- Types de données
Utilisez la référence du SDK 5.x du serveur Amazon GameLift Servers C# pour intégrer votre jeu multijoueur à des fins d'hébergement. Amazon GameLift Servers Pour obtenir des conseils sur le processus d'intégration, consultezAjouter Amazon GameLift Servers à votre serveur de jeu. Si vous utilisez le Amazon GameLift Servers plugin pour Unity, consultez égalementAmazon GameLift Serversplugin pour Unity (SDK serveur 5.x).
SDK 5.x du serveur C# pour -- Actions Amazon GameLift Servers
Types de données
LogParameters
Utilisez ce type de données pour identifier les fichiers générés pendant une session de jeu vers lesquels vous souhaitez que le serveur de jeu les télécharge Amazon GameLift Servers après la fin de la session de jeu. Le serveur de jeu communique LogParameters to
Amazon GameLift Servers lors d'un ProcessReady() appel.
Propriétés |
Description |
LogPaths |
La liste des chemins de répertoire vers les fichiers journaux du serveur de jeu que vous Amazon GameLift Servers souhaitez stocker pour un accès futur. Le processus du serveur génère ces fichiers lors de chaque session de jeu. Vous définissez les chemins et les noms des fichiers sur votre serveur de jeu et vous les stockez dans le répertoire racine du jeu. Les chemins du journal doivent être absolus. Par exemple, si votre build de jeu stocke les journaux de session de jeu dans un chemin tel que Type : Obligatoire : non |
ProcessParameters
Ce type de données contient l'ensemble des paramètres envoyés Amazon GameLift Servers lors d'un ProcessReady() appel.
Propriétés |
Description |
LogParameters | L'objet contenant une liste de chemins de répertoire vers les fichiers journaux des sessions de jeu. Type : Obligatoire : oui |
OnHealthCheck | Nom de la fonction de rappel Amazon GameLift Servers invoquée pour demander un rapport d'état de santé au processus du serveur. Amazon GameLift Serversappelle cette fonction toutes les 60 secondes. Après avoir appelé cette fonction, Amazon GameLift Servers elle attend 60 secondes pour recevoir une réponse. Si aucune réponse n'est reçue, le processus Amazon GameLift Servers du serveur est considéré comme défaillant. Type : Obligatoire : oui |
OnProcessTerminate | Nom de la fonction de rappel Amazon GameLift Servers invoquée pour forcer l'arrêt du processus du serveur. Après l'appel de cette fonction, Amazon GameLift Servers patiente cinq minutes afin que le processus serveur s'arrête et réponde avec un appel ProcessEnding() avant d'arrêter le processus serveur. Type : Obligatoire : oui |
OnStartGameSession | Nom de la fonction de rappel Amazon GameLift Servers invoquée pour activer une nouvelle session de jeu. Amazon GameLift Serversappelle cette fonction en réponse à la demande du client CreateGameSession. La fonction de rappel prend un GameSession objet. Type : Obligatoire : oui |
OnUpdateGameSession | Nom de la fonction de rappel Amazon GameLift Servers invoquée pour transmettre un objet de session de jeu mis à jour au processus du serveur. Amazon GameLift Serversappelle cette fonction lorsqu'une demande de remplissage de correspondance a été traitée pour fournir des données de matchmaking mises à jour. Il transmet un GameSession objet, une mise à jour de statut (updateReason ) et l'identifiant du ticket de remplacement des matchs.Type : vide OnUpdateGameSessionDelegate (UpdateGameSession) Obligatoire : non |
Port | Numéro de port sur lequel le processus serveur écoute les connexions des nouveaux joueurs. La valeur doit être comprise dans la plage de ports configurée pour toutes les flottes déployant cette version de génération du serveur de jeux. Ce numéro de port est inclus dans les objets de session de jeu et de session de joueur, que les sessions de jeu utilisent pour se connecter à un processus serveur. Type : Obligatoire : oui |
UpdateGameSession
Les informations mises à jour pour un objet de session de jeu incluent la raison pour laquelle la session de jeu a été mise à jour. Si la mise à jour est liée à une action de remplissage par correspondance, ce type de données inclut l'ID du ticket de remplissage.
Propriétés | Description |
---|---|
GameSession | Un objet GameSession. L'GameSession objet contient des propriétés décrivant une session de jeu. Type : Obligatoire : oui |
UpdateReason | La raison pour laquelle la session de jeu est mise à jour. Type : Obligatoire : oui |
BackfillTicketId | L'identifiant du ticket de remplacement qui tente de mettre à jour la session de jeu. Type : Obligatoire : oui |
GameSession
Détails d'une session de jeu.
Propriétés | Description |
---|---|
GameSessionId |
Identifiant unique pour la session de jeu. L'ARN d'une session de jeu a le format suivant : Type : Obligatoire : non |
Nom |
Une étiquette descriptive de la session de jeu. Type : Obligatoire : non |
FleetId |
Identifiant unique de la flotte sur laquelle s'exécute la session de jeu. Type : Obligatoire : non |
MaximumPlayerSessionCount |
Le nombre maximum de connexions de joueurs à la session de jeu. Type : Obligatoire : non |
Port |
Le numéro de port de la session de jeu. Pour se connecter à un serveur de Amazon GameLift Servers jeu, une application a besoin à la fois de l'adresse IP et du numéro de port. Type : Obligatoire : non |
IpAddress |
Adresse IP de la session de jeu. Pour se connecter à un serveur de Amazon GameLift Servers jeu, une application a besoin à la fois de l'adresse IP et du numéro de port. Type : Obligatoire : non |
GameSessionData |
Ensemble de propriétés de session de jeu personnalisées, mises en forme en tant que valeur de chaîne unique. Type : Obligatoire : non |
MatchmakerData |
Les informations sur le processus de matchmaking utilisé pour créer la session de jeu, en syntaxe JSON, formatées sous forme de chaîne. En plus de la configuration de matchmaking utilisée, elle contient des données sur tous les joueurs affectés au match, y compris les attributs des joueurs et les affectations des équipes. Type : Obligatoire : non |
GameProperties |
Ensemble de propriétés personnalisées pour une session de jeu, formatées sous forme de paires clé:valeur. Ces propriétés sont transmises avec une demande de démarrage d'une nouvelle session de jeu. Type : Obligatoire : non |
DnsName |
Identifiant DNS attribué à l'instance qui exécute la session de jeu. Les valeurs ont le format suivant :
Lorsque vous vous connectez à une session de jeu exécutée sur une flotte compatible TLS, vous devez utiliser le nom DNS et non l'adresse IP. Type : Obligatoire : non |
ServerParameters
Informations utilisées pour maintenir la connexion entre un serveur Amazon GameLift Servers Anywhere et le Amazon GameLift Servers service. Ces informations sont utilisées lors du lancement de nouveaux processus serveur avecInitSDK(). Pour les serveurs hébergés sur EC2 des instances Amazon GameLift Servers gérées, utilisez un objet vide.
Propriétés | Description |
---|---|
WebSocketUrl |
Ils Type : Obligatoire : oui |
ProcessId |
Un identifiant unique enregistré auprès du processus serveur hébergeant votre jeu. Type : Obligatoire : oui |
HostId |
Un identifiant unique pour l'hôte chargé des processus hébergeant votre jeu sur le serveur. Le HostID est celui ComputeName utilisé lors de l'enregistrement de votre ordinateur. Pour plus d'informations, voir RegisterCompute Type : Obligatoire : oui |
FleetId | ID de flotte du parc dans lequel le calcul est enregistré. Pour plus d'informations, voir, RegisterCompute. Type : Obligatoire : oui |
AuthToken | Le jeton d'authentification généré par Amazon GameLift Servers celui-ci authentifie votre serveur auprès deAmazon GameLift Servers. Pour plus d'informations, voir, GetComputeAuthToken. Type : Obligatoire : oui |
StartMatchBackfillRequest
Informations utilisées pour créer une demande de remplissage par matchmaking. Le serveur de jeu communique ces informations Amazon GameLift Servers lors d'un StartMatchBackfill() appel.
Propriétés | Description |
---|---|
GameSessionArn |
L'identifiant unique de session de jeu. L'opération API Type : Obligatoire : oui |
MatchmakingConfigurationArn |
L'identifiant unique, sous la forme d'un ARN, que le système de jumelage doit utiliser pour cette demande. L'ARN de matchmaking pour la session de jeu d'origine se trouve dans l'objet de session de jeu dans la propriété de données du matchmaker. Pour en savoir plus sur les données du système de jumelage, consultez la section Travailler avec les données du système de jumelage. Type : Obligatoire : oui |
Joueurs |
Ensemble de données représentant tous les joueurs qui participent actuellement à la session de jeu. Le matchmaker utilise ces informations pour rechercher de nouveaux joueurs qui constituent de bonnes correspondances pour les joueurs actuels. Type : Obligatoire : oui |
TicketId |
L'identifiant unique d'un ticket de demande de matchmaking ou de remplacement de match. Si vous ne fournissez aucune valeur, il en Amazon GameLift Servers génère une. Utilisez cet identifiant pour suivre l'état du ticket de renvoi de correspondance ou annuler la requête si nécessaire. Type : Obligatoire : non |
Joueur
Représente un joueur dans le matchmaking. Lorsqu'une demande de matchmaking démarre, un joueur dispose d'un identifiant de joueur, d'attributs et éventuellement de données de latence. Amazon GameLift Serversajoute des informations sur l'équipe après la fin d'un match.
Propriétés | Description |
---|---|
LatencyInMS |
Ensemble de valeurs exprimées en millisecondes, qui indiquent le niveau de latence ressenti par un joueur lorsqu'il est connecté à un lieu. Si cette propriété est utilisée, le joueur n'est jumelé qu'aux emplacements répertoriés. Si un matchmaker dispose d'une règle qui évalue la latence, les joueurs doivent indiquer la latence pour être mis en relation. Type : Obligatoire : non |
PlayerAttributes |
Une collection de paires clé:valeur contenant des informations sur les joueurs à utiliser dans le matchmaking. Les clés d'attribut du joueur doivent correspondre à PlayerAttributes celles utilisées dans un ensemble de règles de matchmaking. Pour plus d'informations sur les attributs des joueurs, consultez AttributeValue. Type : Obligatoire : non |
PlayerId |
Identifiant unique pour un joueur. Type : Obligatoire : non |
Equipe |
Le nom de l'équipe à laquelle le joueur est affecté lors d'un match. Vous définissez le nom de l'équipe dans le jeu de règles de matchmaking. Type : Obligatoire : non |
DescribePlayerSessionsRequest
Ce type de données est utilisé pour spécifier les sessions de joueur à récupérer. Il peut être utilisé de plusieurs manières : (1) fournir une session PlayerSessionId pour demander une session de joueur spécifique ; (2) fournir une GameSessionId pour demander toutes les sessions de joueur dans la session de jeu spécifiée ; ou (3) fournir une PlayerId pour demander toutes les sessions de joueur pour le joueur spécifié. Pour les volumes importants de sessions de joueur, utilisez les paramètres de pagination pour récupérer les résultats en tant que pages séquentielles.
Propriétés | Description |
---|---|
GameSessionId |
L'identifiant unique de session de jeu. Utilisez ce paramètre pour demander toutes les sessions de joueur pour la session de jeu spécifiée. Le format de l'ID de session de jeu est le suivant : Type : Obligatoire : non |
PlayerSessionId |
Identifiant unique d'une session de joueur. Type : Obligatoire : non |
PlayerId |
L'identifiant unique d'un joueur. Consultez Générer un joueur IDs. Type : Obligatoire : non |
PlayerSessionStatusFilter |
État de la session du joueur sur lequel filtrer les résultats. Les états de session de joueur possibles sont les suivants :
Type : Obligatoire : non |
NextToken |
Le jeton indiquant le début de la page de résultats suivante. Pour spécifier le début du jeu de résultats, ne fournissez aucune valeur. Si vous fournissez un identifiant de session de joueur, ce paramètre est ignoré. Type : Obligatoire : non |
Limite |
Nombre maximal de résultats à renvoyer. Si vous fournissez un identifiant de session de joueur, ce paramètre est ignoré. Type : Obligatoire : non |
StopMatchBackfillRequest
Informations utilisées pour annuler une demande de remplissage par matchmaking. Le serveur de jeu communique ces informations au Amazon GameLift Servers service lors d'un StopMatchBackfill() appel.
Propriétés | Description |
---|---|
GameSessionArn |
Identifiant de session de jeu unique de la demande annulée. Type : Obligatoire : oui |
MatchmakingConfigurationArn |
L'identifiant unique du matchmaker auquel cette demande a été envoyée. Type : Obligatoire : oui |
TicketId |
L'identifiant unique du ticket de demande de remblayage à annuler. Type : Obligatoire : oui |
GetFleetRoleCredentialsRequest
Ce type de données donne au serveur de jeu un accès limité à vos autres AWS ressources. Pour plus d'informations, voir,Configurer un rôle de service IAM pour Amazon GameLift Servers.
Propriétés | Description |
---|---|
RoleArn | Le nom de ressource Amazon (ARN) du rôle de service qui étend un accès limité à vos AWS ressources. Type : Obligatoire : oui |
RoleSessionName | Le nom de la session qui décrit l'utilisation des informations d'identification du rôle. Type : Obligatoire : non |
AttributeValue
Utilisez ces valeurs dans les paires Joueur clé-valeur d'attribut. Cet objet vous permet de spécifier une valeur d'attribut à l'aide de n'importe quel type de données valide : chaîne, nombre, tableau de chaînes ou mappage de données. Chaque AttributeValue
objet ne peut utiliser qu'une seule des propriétés disponibles.
Propriétés | Description |
---|---|
Type ATR |
Spécifie le type de valeur d'attribut. Type : valeur Obligatoire : non |
S |
Représente une valeur d'attribut de chaîne. Type : Obligatoire : oui |
N |
Représente une valeur d'attribut numérique. Type : Obligatoire : oui |
SL |
Représente un tableau de valeurs d'attributs de chaîne. Type : Obligatoire : oui |
SDM |
Représente un dictionnaire de clés de chaîne et de valeurs doubles. Type : Obligatoire : oui |
AwsStringOutcome
Ce type de données résulte d'une action et produit un objet doté des propriétés suivantes :
Propriétés | Description |
---|---|
Résultat |
Le résultat de l'action. Type : Obligatoire : non |
Réussite |
Que l'action ait été couronnée de succès ou non. Type : Obligatoire : oui |
Erreur |
Erreur survenue en cas d'échec de l'action. Type : GameLiftError Obligatoire : non |
GenericOutcome
Ce type de données résulte d'une action et produit un objet doté des propriétés suivantes :
Propriétés | Description |
---|---|
Réussite |
Que l'action ait été couronnée de succès ou non. Type : Obligatoire : oui |
Erreur |
Erreur survenue en cas d'échec de l'action. Type : GameLiftError Obligatoire : non |
DescribePlayerSessionsOutcome
Ce type de données résulte d'une action et produit un objet doté des propriétés suivantes :
Propriétés | Description |
---|---|
Résultat |
Le résultat de l'action. Type : DescribePlayerSessionsResult Obligatoire : non |
Réussite |
Que l'action ait été couronnée de succès ou non. Type : Obligatoire : oui |
Erreur |
Erreur survenue en cas d'échec de l'action. Type : GameLiftError Obligatoire : non |
DescribePlayerSessionsResult
Propriétés | Description |
---|---|
NextToken |
Le jeton indiquant le début de la page de résultats suivante. Pour spécifier le début du jeu de résultats, ne fournissez aucune valeur. Si vous fournissez un identifiant de session de joueur, ce paramètre est ignoré. Type : Obligatoire : oui |
PlayerSessions |
Collection d'objets contenant les propriétés de chaque session de joueur correspondant à la demande. Type : Obligatoire : |
Réussite |
Que l'action ait été couronnée de succès ou non. Type : Obligatoire : oui |
Erreur |
Erreur survenue en cas d'échec de l'action. Type : GameLiftError Obligatoire : non |
PlayerSession
Propriétés | Description |
---|---|
CreationTime |
Type : Obligatoire : oui |
FleetId |
Type : Obligatoire : oui |
GameSessionId |
Type : Obligatoire : oui |
IpAddress |
Type : Obligatoire : oui |
PlayerData |
Type : Obligatoire : oui |
PlayerId |
Type : Obligatoire : oui |
PlayerSessionId |
Type : Obligatoire : oui |
Port |
Type : Obligatoire : oui |
Statut |
Type : Une Obligatoire : oui |
TerminationTime |
Type : Obligatoire : oui |
DnsName |
Type : Obligatoire : oui |
StartMatchBackfillOutcome
Ce type de données résulte d'une action et produit un objet doté des propriétés suivantes :
Propriétés | Description |
---|---|
Résultat |
Le résultat de l'action. Type : StartMatchBackfillResult Obligatoire : non |
Réussite |
Que l'action ait été couronnée de succès ou non. Type : Obligatoire : oui |
Erreur |
Erreur survenue en cas d'échec de l'action. Type : GameLiftError Obligatoire : non |
StartMatchBackfillResult
Propriétés | Description |
---|---|
TicketId |
Type : Obligatoire : oui |
GetComputeCertificateOutcome
Ce type de données résulte d'une action et produit un objet doté des propriétés suivantes :
Propriétés | Description |
---|---|
Résultat |
Le résultat de l'action. Type : GetComputeCertificateResult Obligatoire : non |
Réussite |
Que l'action ait été couronnée de succès ou non. Type : Obligatoire : oui |
Erreur |
Erreur survenue en cas d'échec de l'action. Type : GameLiftError Obligatoire : non |
GetComputeCertificateResult
Le chemin d'accès au certificat TLS sur votre ordinateur et le nom d'hôte du calcul.
Propriétés | Description |
---|---|
CertificatePath |
Type : Obligatoire : oui |
ComputeName |
Type : Obligatoire : oui |
GetFleetRoleCredentialsOutcome
Ce type de données résulte d'une action et produit un objet doté des propriétés suivantes :
Propriétés | Description |
---|---|
Résultat |
Le résultat de l'action. Type : GetFleetRoleCredentialsResult Obligatoire : non |
Réussite |
Que l'action ait été couronnée de succès ou non. Type : Obligatoire : oui |
Erreur |
Erreur survenue en cas d'échec de l'action. Type : GameLiftError Obligatoire : non |
GetFleetRoleCredentialsResult
Propriétés | Description |
---|---|
AccessKeyId |
ID de clé d'accès permettant d'authentifier et de fournir un accès à vos AWS ressources. Type : Obligatoire : non |
AssumedRoleId |
ID de l'utilisateur auquel appartient le rôle de service. Type : Obligatoire : non |
AssumedRoleUserArn |
Le nom de ressource Amazon (ARN) de l'utilisateur auquel appartient le rôle de service. Type : Obligatoire : non |
Expiration |
Durée avant l'expiration de vos informations d'identification de session. Type : Obligatoire : non |
SecretAccessKey |
ID de clé d'accès secrète pour l'authentification. Type : Obligatoire : non |
SessionToken |
Un jeton pour identifier la session active en cours qui interagit avec vos AWS ressources. Type : Obligatoire : non |
Réussite |
Que l'action ait été couronnée de succès ou non. Type : Obligatoire : oui |
Erreur |
Erreur survenue en cas d'échec de l'action. Type : GameLiftError Obligatoire : non |
AwsDateTimeOutcome
Ce type de données résulte d'une action et produit un objet doté des propriétés suivantes :
Propriétés | Description |
---|---|
Résultat |
Le résultat de l'action. Type : Obligatoire : non |
Réussite |
Que l'action ait été couronnée de succès ou non. Type : Obligatoire : oui |
Erreur |
Erreur survenue en cas d'échec de l'action. Type : GameLiftError Obligatoire : non |
GameLiftError
Propriétés | Description |
---|---|
ErrorType |
Type d'erreur. Type : Une Obligatoire : non |
ErrorName |
Nom de l'erreur. Type : Obligatoire : non |
ErrorMessage |
Message d’erreur. Type : Obligatoire : non |
Enums
Les énumérations définies pour le SDK du serveur pour Amazon GameLift Servers (C#) sont définies comme suit :
- AttrType
-
NONE
CORDE
DOUBLE
LISTE_CHAÎNES
STRING_DOUBLE_MAP
- GameLiftErrorType
-
Valeur de chaîne indiquant le type d'erreur. Les valeurs valides sont les suivantes :
-
SERVICE_CALL_FAILED — Un appel à un AWS service a échoué.
-
LOCAL_CONNECTION_FAILED — La connexion locale a échoué. Amazon GameLift Servers
-
NETWORK_NOT_INITIALIZED — Le réseau n'a pas été initialisé.
-
GAMESESSION_ID_NOT_SET — L'ID de session de jeu n'a pas été défini.
-
MAUVAISE DEMANDE D'EXCEPTION
-
EXCEPTION DE SERVICE INTERNE
-
ALREADY_INITIALIZED — Le Amazon GameLift Servers serveur ou le client a déjà été initialisé avec Initialize ().
-
FLEET_MISMATCH — La flotte cible ne correspond pas à la flotte d'une GameSession ou d'une PlayerSession.
-
GAMELIFT_CLIENT_NOT_INITIALIZED — Le client n'a pas été initialisé. Amazon GameLift Servers
-
GAMELIFT_SERVER_NOT_INITIALIZED — Le serveur n'a pas été initialisé. Amazon GameLift Servers
-
GAME_SESSION_ENDED_FAILED : le SDK du serveur n'a pas Amazon GameLift Servers pu contacter le service pour signaler la fin de la session de jeu.
-
GAME_SESSION_NOT_READY — La Amazon GameLift Servers session de jeu sur le serveur n'a pas été activée.
-
GAME_SESSION_READY_FAILED : le SDK du serveur n'a pas Amazon GameLift Servers pu contacter le service pour signaler que la session de jeu est prête.
-
INITIALIZATION_MISMATCH — Une méthode client a été appelée après Server : :Initialize (), ou vice versa.
-
NOT_INITIALIZED — Le Amazon GameLift Servers serveur ou le client n'a pas été initialisé avec Initialize ().
-
NO_TARGET_ALIASID_SET — Aucun AliasID cible n'a été défini.
-
NO_TARGET_FLEET_SET — Aucune flotte cible n'a été définie.
-
PROCESS_ENDING_FAILED : le SDK du serveur n'a pas Amazon GameLift Servers pu contacter le service pour signaler la fin du processus.
-
PROCESS_NOT_ACTIVE — Le processus du serveur n'est pas encore actif, n'est pas lié à un et ne peut ni GameSession accepter ni traiter. PlayerSessions
-
PROCESS_NOT_READY — Le processus du serveur n'est pas encore prêt à être activé.
-
PROCESS_READY_FAILED : le SDK du serveur n'a pas Amazon GameLift Servers pu contacter le service pour signaler que le processus est prêt.
-
SDK_VERSION_DETECTION_FAILED — La détection de la version du SDK a échoué.
-
STX_CALL_FAILED — Un appel au composant principal du XStx serveur a échoué.
-
STX_INITIALIZATION_FAILED — Le composant principal du XStx serveur n'a pas pu être initialisé.
-
UNEXPECTED_PLAYER_SESSION — Le serveur a détecté une session de joueur non enregistrée.
-
ÉCHEC DE CONNEXION WEBSOCKET
-
WEBSOCKET_CONNECT_FAILURE_FORBIDDEN
-
WEBSOCKET_CONNECT_FAILURE_INVALID_URL
-
WEBSOCKET_CONNECT_FAILURE_TIMEOUT
-
WEBSOCKET_RETRIABLE_SEND_MESSAGE_FAILURE — Impossible de récupérer un message au service. GameLift WebSocket
-
WEBSOCKET_SEND_MESSAGE_FAILURE — Impossible d'envoyer un message au service. GameLift WebSocket
-
MATCH_BACKFILL_REQUEST_VALIDATION — La validation de la demande a échoué.
-
PLAYER_SESSION_REQUEST_VALIDATION — La validation de la demande a échoué.
-
- PlayerSessionCreationPolicy
-
Valeur de chaîne indiquant si la session de jeu accepte ou non de nouveaux joueurs. Les valeurs valides sont les suivantes :
-
ACCEPT_ALL — Accepte toutes les sessions de nouveaux joueurs.
-
DENY_ALL — Refuse toutes les sessions de nouveaux joueurs.
-
NOT_SET — La session de jeu n'est pas configurée pour accepter ou refuser les sessions de nouveaux joueurs.
-
- PlayerSessionStatus
-
ACTIF
TERMINÉ
NOT_SET
RÉSERVÉ
DÉLAI EXPIRÉ