Référence GameLift du serveur Amazon SDK (C++) : types de données - Amazon GameLift

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.

Référence GameLift du serveur Amazon SDK (C++) : types de données

Vous pouvez utiliser cette SDK référence du serveur Amazon GameLift C++ pour vous aider à préparer votre jeu multijoueur en vue de son utilisation avec Amazon GameLift. Pour plus de détails sur le processus d'intégration, consultezAjoutez Amazon GameLift à votre serveur de jeu.

Note

Cette rubrique décrit le code Amazon GameLift C++ API que vous pouvez utiliser lorsque vous créez avec la bibliothèque standard C++ (std). Plus précisément, cette documentation s'applique au code que vous compilez avec l'-DDGAMELIFT_USE_STD=1option.

LogParameters

Un objet identifiant les fichiers générés au cours d'une session de jeu que vous souhaitez qu'Amazon télécharge et stocke GameLift à la fin de la session de jeu. Le serveur de jeu fournit LogParameters à Amazon dans GameLift le cadre d'un ProcessParameters objet 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 souhaitez GameLift qu'Amazon stocke 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 queMyGame\sessionLogs\, le chemin se c:\game\MyGame\sessionLogs trouve sur une instance Windows.

Type : std:vector<std::string>

Obligatoire : non

ProcessParameters

Ce type de données contient l'ensemble de paramètres envoyé à Amazon GameLift dans un fichierProcessReady().

Propriétés

Description
LogParameters Objet avec des chemins de répertoire vers des fichiers générés au cours d'une session de jeu. Amazon GameLift copie et stocke les fichiers pour un accès futur.

Type : Aws::GameLift::Server::LogParameters

Obligatoire : non

OnHealthCheck Fonction de rappel GameLift invoquée par Amazon pour demander un rapport d'état de santé au processus du serveur. Amazon GameLift appelle cette fonction toutes les 60 secondes et attend une réponse pendant 60 secondes. Le processus du serveur revient TRUE s'il est sain, FALSE sinon sain. Si aucune réponse n'est renvoyée, Amazon considère GameLift que le processus du serveur n'est pas sain.

Type : std::function<bool()> onHealthCheck

Obligatoire : non

OnProcessTerminate La fonction de rappel GameLift invoquée par Amazon pour forcer le processus du serveur à s'arrêter. Après avoir appelé cette fonction, Amazon GameLift attend 5 minutes que le processus du serveur s'arrête et répond par un ProcessEnding() appel avant d'arrêter le processus du serveur.

Type : std::function<void()> onProcessTerminate

Obligatoire : oui

OnRefreshConnection Nom de la fonction de rappel GameLift invoquée par Amazon pour actualiser la connexion avec le serveur de jeu.

Type : void OnRefreshConnectionDelegate()

Obligatoire : oui

OnStartGameSession La fonction de rappel GameLift invoquée par Amazon pour activer une nouvelle session de jeu. Amazon GameLift appelle cette fonction en réponse à une demande d'un client CreateGameSession. La fonction de rappel transmet un GameSession objet.

Type : const std::function<void(Aws::GameLift::Model::GameSession)> onStartGameSession

Obligatoire : oui

OnUpdateGameSession Fonction de rappel GameLift invoquée par Amazon pour transmettre un objet de session de jeu mis à jour au processus du serveur. Amazon GameLift appelle cette fonction lorsqu'une demande de mise en 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 : std::function<void(Aws::GameLift::Server::Model::UpdateGameSession)> onUpdateGameSession

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 : Integer

Obligatoire : oui

UpdateGameSession

Ce type de données est mis à jour vers un objet de session de jeu, qui inclut la raison pour laquelle la session de jeu a été mise à jour et l'identifiant du ticket de remplissage associé si le remplissage est utilisé pour remplir les sessions des joueurs pendant la session de jeu.

Propriétés Description
GameSession Un objet GameSession. L'GameSessionobjet contient des propriétés décrivant une session de jeu.

Type : Aws::GameLift::Server::GameSession

Obligatoire : oui

UpdateReason La raison pour laquelle la session de jeu est mise à jour.

Type : Aws::GameLift::Server::UpdateReason

Obligatoire : oui

BackfillTicketId L'identifiant du ticket de remplacement qui tente de mettre à jour la session de jeu.

Type : std::string

Obligatoire : non

GameSession

Ce type de données fournit les détails d'une session de jeu.

Propriétés Description
GameSessionId

Identifiant unique pour la session de jeu. Une session de jeu ARN a le format suivant :arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom ID string or idempotency token>.

Type : std::string

Obligatoire : non

Nom

Une étiquette descriptive de la session de jeu.

Type : std::string

Obligatoire : non

FleetId

Identifiant unique de la flotte sur laquelle s'exécute la session de jeu.

Type : std::string

Obligatoire : non

MaximumPlayerSessionCount

Le nombre maximum de connexions de joueurs à la session de jeu.

Type : int

Obligatoire : non

Port

Le numéro de port de la session de jeu. Pour se connecter à un serveur de GameLift jeu Amazon, une application a besoin à la fois de l'adresse IP et du numéro de port.

Type : in

Obligatoire : non

IpAddress

Adresse IP de la session de jeu. Pour se connecter à un serveur de GameLift jeu Amazon, une application a besoin à la fois de l'adresse IP et du numéro de port.

Type : std::string

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 : std::string

Obligatoire : non

MatchmakerData

Informations sur le processus de matchmaking utilisé pour créer la session de jeu, en JSON syntaxe, formatées sous forme de chaîne. En plus de la configuration de matchmaking utilisée, il contient des données sur tous les joueurs affectés au match, y compris les attributs des joueurs et les affectations des équipes.

Type : std::string

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 : std :: vector < GameProperty >

Obligatoire : non

DnsName

DNSIdentifiant attribué à l'instance qui exécute la session de jeu. Les valeurs ont le format suivant :

  • TLSflottes compatibles :. <unique identifier>.<region identifier>.amazongamelift.com

  • Flottes non TLS activées :. ec2-<unique identifier>.compute.amazonaws.com

Lorsque vous vous connectez à une session de jeu exécutée sur un parc TLS compatible, vous devez utiliser le DNS nom, et non l'adresse IP.

Type : std::string

Obligatoire : non

ServerParameters

Informations utilisées par un serveur de jeu pour établir une connexion avec le GameLift service Amazon. N'incluez ces paramètres lors de l'appel InitSDK() que si la version du serveur de jeu doit être déployée sur une Anywhere flotte ou une flotte de conteneurs sans l' GameLift agent Amazon. Pour tous les autres scénarios de déploiement, appelez InitSDK() sans paramètres.

Propriétés Description
webSocketUrl

L'GameLiftServerSdkEndpointAmazon GameLift revient lorsque vous RegisterComputerecherchez une ressource GameLift Anywhere informatique Amazon.

Type : std::string

Obligatoire : oui

processId

Un identifiant unique enregistré auprès du processus serveur hébergeant votre jeu.

Type : std::string

Obligatoire : oui

hostId Le HostID est celui ComputeName utilisé lorsque vous avez enregistré votre ordinateur. Pour plus d'informations, voir, RegisterCompute.

Type : std::string

Obligatoire : oui

fleetId Identifiant unique de la flotte dans laquelle le calcul est enregistré. Pour plus d'informations, voir, RegisterCompute.

Type : std::string

Obligatoire : oui

authToken Le jeton d'authentification généré par Amazon GameLift qui authentifie votre serveur auprès d'Amazon GameLift. Pour plus d'informations, voir, GetComputeAuthToken.

Type : std::string

Obligatoire : oui

StartMatchBackfillRequest

Informations utilisées pour créer une demande de remplissage par matchmaking. Le serveur de jeu communique ces informations à Amazon GameLift lors d'un StartMatchBackfill() appel.

Propriétés Description
GameSessionArn

Un identifiant de session de jeu unique. L'APIopération GetGameSessionId renvoie l'identifiant au ARN format.

Type : std::string

Obligatoire : oui

MatchmakingConfigurationArn

Un identifiant unique, sous la forme d'unARN, que le système de jumelage doit utiliser pour cette demande. Le système de matchmaking ARN de la session de jeu d'origine se trouve dans l'objet de session de jeu dans la propriété de données du système de matchmaking. 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 : std::string

Obligatoire : oui

Joueurs

Un ensemble de données représentant tous les joueurs participant à la session de jeu. Le matchmaker utilise ces informations pour rechercher de nouveaux joueurs qui constituent de bonnes correspondances pour les joueurs actuels.

Type : std::vector<Player>

Obligatoire : oui

TicketId

Un identifiant unique pour un ticket de demande de matchmaking ou de remplacement de match. Si vous ne fournissez aucune valeur, Amazon en GameLift 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 : std::string

Obligatoire : non

Joueur

Ce type de données représente un joueur dans le matchmaking. Lors du lancement d'une demande de matchmaking, un joueur dispose d'un identifiant de joueur, d'attributs et éventuellement de données de latence. Amazon GameLift ajoute les informations de l'équipe une fois le match terminé.

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 : Dictionary<string,int>

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 : std::map<std::string,AttributeValue>

Obligatoire : non

PlayerId

Identifiant unique pour un joueur.

Type : std::string

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 : std::string

Obligatoire : non

DescribePlayerSessionsRequest

Objet qui indique les sessions de joueur à récupérer. Le processus du serveur fournit ces informations lors d'un DescribePlayerSessions() appel à Amazon GameLift.

Propriétés Description
GameSessionId

Un identifiant de session de jeu unique. Utilisez ce paramètre pour demander toutes les sessions de joueur pour la session de jeu spécifiée.

Le format de l'identifiant de session de jeu estarn:aws:gamelift:<region>::gamesession/fleet-<fleet ID>/<ID string>. GameSessionIDIl s'agit d'une chaîne d'identification personnalisée ou d'un

Type : std::string

Obligatoire : non

PlayerSessionId

Identifiant unique d'une session de joueur. Utilisez ce paramètre pour demander une session de joueur spécifique.

Type : std::string

Obligatoire : non

PlayerId

L'identifiant unique d'un joueur. Utilisez ce paramètre pour demander toutes les sessions de joueur pour un joueur spécifique. veuillez consulter Générer des identifiants de joueurs.

Type : std::string

Obligatoire : non

PlayerSessionStatusFilter

État de la session du joueur sur lequel filtrer les résultats. Les statuts possibles des sessions de joueur sont les suivants :

  • RESERVED— La demande de session du joueur a été reçue, mais le joueur ne s'est pas connecté au processus du serveur ni n'a été validé.

  • ACTIVE— Le joueur a été validé par le processus du serveur et est connecté.

  • COMPLETED— La connexion du joueur a été interrompue.

  • TIMEDOUT— Une demande de session de joueur a été reçue, mais le joueur ne s'est pas connecté ou n'a pas été validé dans le délai imparti (60 secondes).

Type : std::string

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 : std::string

Obligatoire : non

Limite

Nombre maximal de résultats à renvoyer. Si vous fournissez un identifiant de session de joueur, ce paramètre est ignoré.

Type : int

Obligatoire : non

StopMatchBackfillRequest

Informations utilisées pour annuler une demande de remblayage par matchmaking. Le serveur de jeu communique ces informations au GameLift service Amazon lors d'un StopMatchBackfill() appel.

Propriétés Description
GameSessionArn

Identifiant de session de jeu unique de la demande annulée.

Type : char[]

Obligatoire : non

MatchmakingConfigurationArn

Un identifiant unique du matchmaker auquel cette demande a été envoyée.

Type : char[]

Obligatoire : non

TicketId

Identifiant unique du ticket de demande de remblayage à annuler.

Type : char[]

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 doit utiliser exactement l'une des propriétés disponibles : SN,SL, ouSDM.

Propriétés Description
AttrType

Spécifie le type de valeur d'attribut. Les types de valeurs d'attributs possibles sont les suivants :

  • NONE

  • STRING

  • DOUBLE

  • STRING_LIST

  • STRING_DOUBLE_MAP

Obligatoire : non

S

Représente une valeur d'attribut de chaîne.

Type : std::string

Obligatoire : non

N

Représente une valeur d'attribut numérique.

Type : double

Obligatoire : non

SL

Représente un tableau de valeurs d'attributs de chaîne.

Type : std::vector<std::string>

Obligatoire : non

SDM

Représente un dictionnaire de chaînes de caractères, de clés et de valeurs doubles.

Type : std::map<std::string, double>

Obligatoire : non

GetFleetRoleCredentialsRequest

Ce type de données donne au serveur de jeu un accès limité à vos autres AWS ressources. Pour plus d'informations, veuillez consulter Configurer un rôle de service IAM pour Amazon GameLift.

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 : std::string

Obligatoire : non

RoleSessionName Nom de session de rôle que vous pouvez utiliser pour identifier une AWS Security Token Service AssumeRolesession de manière unique. Ce nom est exposé dans les journaux d'audit tels que ceux contenus dans CloudTrail.

Type : std::string

Obligatoire : non

AwsLongOutcome

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 : long

Obligatoire : non

ResultWithOwnership

Le résultat de l'action, converti en valeur rvalue, afin que le code appelant puisse s'approprier l'objet.

Type : long&&

Obligatoire : non

Réussite

Que l'action ait été couronnée de succès ou non.

Type : bool

Obligatoire : oui

Erreur

L'erreur qui s'est produite en cas d'échec de l'action.

Type : GameLiftError

Obligatoire : non

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 : std::string

Obligatoire : non

ResultWithOwnership

Le résultat de l'action, converti en valeur rvalue, afin que le code appelant puisse s'approprier l'objet.

Type : long&&

Obligatoire : non

Réussite

Que l'action ait été couronnée de succès ou non.

Type : bool

Obligatoire : oui

Erreur

L'erreur qui s'est produite 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

ResultWithOwnership

Le résultat de l'action, converti en valeur rvalue, afin que le code appelant puisse s'approprier l'objet.

Type : Aws::GameLift::Server::Model::DescribePlayerSessionsResult&&

Obligatoire : non

Réussite

Que l'action ait été couronnée de succès ou non.

Type : bool

Obligatoire : oui

Erreur

L'erreur qui s'est produite en cas d'échec de l'action.

Type : GameLiftError

Obligatoire : non

DescribePlayerSessionsResult

Collection d'objets contenant les propriétés de chaque session de joueur correspondant à la demande.

Propriétés Description
NextToken

Un jeton qui indique le début de la prochaine page séquentielle de résultats. Utilisez le jeton renvoyé lors d'un appel précédent à cette opération. Pour commencer au début du jeu de résultats, ne spécifiez aucune valeur. Si un ID de session de joueur est spécifié, ce paramètre est ignoré.

Type : std::string

Obligatoire : oui

PlayerSessions

Type : IList<PlayerSession>

Obligatoire :

ResultWithOwnership

Le résultat de l'action, converti en valeur rvalue, afin que le code appelant puisse s'approprier l'objet.

Type : std::string&&

Obligatoire : non

Réussite

Que l'action ait été couronnée de succès ou non.

Type : bool

Obligatoire : oui

Erreur

L'erreur qui s'est produite 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 : bool

Obligatoire : oui

Erreur

L'erreur qui s'est produite en cas d'échec de l'action.

Type : GameLiftError

Obligatoire : non

GenericOutcomeCallable

Ce type de données est un résultat générique asynchrone. Il comprend les propriétés suivantes :

Propriétés Description
Réussite

Que l'action ait été couronnée de succès ou non.

Type : bool

Obligatoire : oui

Erreur

L'erreur qui s'est produite en cas d'échec de l'action.

Type : GameLiftError

Obligatoire : non

PlayerSession

Ce type de données représente une session de joueur qu'Amazon GameLift transmet au serveur de jeu. Pour plus d'informations, consultez PlayerSession.

Propriétés Description
CreationTime

Type : long

Obligatoire : non

FleetId

Type : std::string

Obligatoire : non

GameSessionId

Type : std::string

Obligatoire : non

IpAddress

Type : std::string

Obligatoire : non

PlayerData

Type : std::string

Obligatoire : non

PlayerId

Type : std::string

Obligatoire : non

PlayerSessionId

Type : std::string

Obligatoire : non

Port

Type : int

Obligatoire : non

Statut

État de session de joueur pour filtrer les résultats. Lorsqu'un PlayerSessionId ou PlayerId est fourni, cela n' PlayerSessionStatusFilter a aucun effet sur la réponse.

Type : Une PlayerSessionStatus énumération. Les valeurs possibles sont notamment les suivantes :

  • ACTIVE

  • COMPLETED

  • NOT_SET

  • RESERVED

  • TIMEDOUT

Obligatoire : non

TerminationTime

Type : long

Obligatoire : non

DnsName

Type : std::string

Obligatoire : non

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

ResultWithOwnership

Le résultat de l'action, converti en valeur rvalue, afin que le code appelant puisse s'approprier l'objet.

Type : StartMatchBackfillResult&&

Obligatoire : non

Réussite

Que l'action ait été couronnée de succès ou non.

Type : bool

Obligatoire : oui

Erreur

L'erreur qui s'est produite en cas d'échec de l'action.

Type : GameLiftError

Obligatoire : non

StartMatchBackfillResult

Ce type de données résulte d'une action et produit un objet doté des propriétés suivantes :

Propriétés Description
TicketId

Un identifiant unique pour un ticket de matchmaking. Si aucun numéro de ticket n'est spécifié ici, Amazon en GameLift générera un sous la forme d'unUUID. Utilisez cet identifiant pour suivre l'état du ticket de remplacement des matchs et récupérer les résultats des matchs.

Type : std::string

Obligatoire : non

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

ResultWithOwnership

Le résultat de l'action, converti en valeur rvalue, afin que le code appelant puisse s'approprier l'objet.

Type : Aws::GameLift::Server::Model::GetComputeCertificateResult&&

Obligatoire : non

Réussite

Que l'action ait été couronnée de succès ou non.

Type : bool

Obligatoire : oui

Erreur

L'erreur qui s'est produite en cas d'échec de l'action.

Type : GameLiftError

Obligatoire : non

GetComputeCertificateResult

Le chemin d'accès au TLS certificat sur votre ordinateur et le nom d'hôte du calcul.

Propriétés Description
CertificatePath

Le chemin d'accès au TLS certificat sur votre ressource de calcul. Lorsque vous utilisez une flotte GameLift gérée par Amazon, ce chemin contient :

  • certificate.pem: le certificat de l'utilisateur final. La chaîne de certificats complète est la combinaison des certificateChain.pem éléments ajoutés à ce certificat.

  • certificateChain.pem: chaîne de certificats qui contient le certificat racine et les certificats intermédiaires.

  • rootCertificate.pem: le certificat racine.

  • privateKey.pem: clé privée pour le certificat d'utilisateur final.

Type : std::string

Obligatoire : non

ComputeName

Le nom de votre ressource de calcul.

Type : std::string

Obligatoire : non

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

ResultWithOwnership

Le résultat de l'action, converti en valeur rvalue, afin que le code appelant puisse s'approprier l'objet.

Type : Aws::GameLift::Server::Model::GetFleetRoleCredentialsResult

Obligatoire : non

Réussite

Que l'action ait été couronnée de succès ou non.

Type : bool

Obligatoire : oui

Erreur

L'erreur qui s'est produite 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 : string

Obligatoire : non

AssumedRoleId

ID de l'utilisateur auquel appartient le rôle de service.

Type : string

Obligatoire : non

AssumedRoleUserArn

Le nom de ressource Amazon (ARN) de l'utilisateur auquel appartient le rôle de service.

Type : string

Obligatoire : non

Expiration

Durée avant l'expiration de vos informations d'identification de session.

Type : DateTime

Obligatoire : non

SecretAccessKey

ID de clé d'accès secrète pour l'authentification.

Type : string

Obligatoire : non

SessionToken

Un jeton permettant d'identifier la session active en cours qui interagit avec vos AWS ressources.

Type : string

Obligatoire : non

Réussite

Que l'action ait été couronnée de succès ou non.

Type : bool

Obligatoire : oui

Erreur

L'erreur qui s'est produite en cas d'échec de l'action.

Type : GameLiftError

Obligatoire : non

JE nitSDKOutcome

Note

InitSDKOutcomen'est renvoyé que lorsque vous le construisez SDK avec le std drapeau. Si vous construisez avec le nostd drapeau, il GenericOutcome est renvoyé à la place.

Propriétés Description
Réussite

Que l'action ait été couronnée de succès ou non.

Type : bool

Obligatoire : oui

Erreur

L'erreur qui s'est produite en cas d'échec de l'action.

Type : GameLiftError

Obligatoire : non

GameLiftError

Propriétés Description
ErrorType

Type d'erreur.

Type : Une GameLiftErrorType énumération.

Obligatoire : non

ErrorName

Nom de l'erreur.

Type : std::string

Obligatoire : non

ErrorMessage

Message d’erreur.

Type : std::string

Obligatoire : non

Enums

Les énumérations définies pour le GameLift serveur Amazon SDK (C++) sont définies comme suit :

GameLiftErrorType

Valeur de chaîne indiquant le type d'erreur. Les valeurs valides sont les suivantes :

  • BAD_REQUEST_EXCEPTION

  • GAMESESSION_ID_ NOT _ SET — L'identifiant de session de jeu n'a pas été défini.

  • INTERNAL_SERVICE_EXCEPTION

  • LOCAL_ CONNECTION _ FAILED — La connexion locale à Amazon GameLift a échoué.

  • NETWORK_ NOT _ INITIALIZED — Le réseau n'a pas été initialisé.

  • SERVICE_ CALL _ FAILED — Un appel à un AWS service a échoué.

  • WEBSOCKET_CONNECT_FAILURE

  • WEBSOCKET_CONNECT_FAILURE_FORBIDDEN

  • WEBSOCKET_CONNECT_FAILURE_INVALID_URL

  • WEBSOCKET_CONNECT_FAILURE_TIMEOUT

  • ALREADY_ INITIALIZED — Le GameLift serveur ou le client Amazon a déjà été initialisé avec Initialize ().

  • FLEET_ MISMATCH — La flotte cible ne correspond pas à la flotte d'un gameSession ouplayerSession.

  • GAMELIFT_ CLIENT _ NOT _ INITIALIZED — Le GameLift client Amazon n'a pas été initialisé.

  • GAMELIFT_ SERVER _ NOT _ INITIALIZED — Le GameLift serveur Amazon n'a pas été initialisé.

  • GAME_ SESSION _ ENDED _ FAILED — Le GameLift serveur Amazon n'SDKa pas pu contacter le service pour signaler la fin de la session de jeu.

  • GAME_ SESSION _ NOT _ READY — La session de jeu Amazon GameLift Server n'a pas été activée.

  • GAME_ SESSION _ READY _ FAILED — Le GameLift serveur Amazon n'SDKa pas pu contacter le service pour signaler que la session de jeu était prête.

  • INITIALIZATION_ MISMATCH — Une méthode client a été appelée après Server : :Initialize (), ou vice versa.

  • NOT_ INITIALIZED — Le GameLift serveur ou le client Amazon n'a pas été initialisé avec Initialize ().

  • NO_ TARGET _ ALIASID _ SET — Aucune cible n' aliasId a été définie.

  • NO_ TARGET _ FLEET _ SET — Aucune flotte cible n'a été définie.

  • PROCESS_ ENDING _ FAILED — Le GameLift serveur Amazon n'SDKa pas 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 GameSession et ne peut ni accepter ni traiter PlayerSessions.

  • PROCESS_ NOT _ READY — Le processus serveur n'est pas encore prêt à être activé.

  • PROCESS_ READY _ FAILED — Le GameLift serveur Amazon n'SDKa pas pu contacter le service pour signaler que le processus était prêt.

  • SDK_ _ VERSION DETECTION _ FAILED — échec de SDK la détection de version.

  • STX_ CALL _ FAILED — Un appel au composant XStx principal du serveur a échoué.

  • STX_ INITIALIZATION _ FAILED — Le composant principal XStx du serveur n'a pas pu être initialisé.

  • UNEXPECTED_ PLAYER _ SESSION — Une session de joueur non enregistrée a été détectée par le serveur.

  • WEBSOCKET_CONNECT_FAILURE

  • WEBSOCKET_CONNECT_FAILURE_FORBIDDEN

  • WEBSOCKET_CONNECT_FAILURE_INVALID_URL

  • WEBSOCKET_CONNECT_FAILURE_TIMEOUT

  • WEBSOCKET_ RETRIABLE _ _ SEND MESSAGE _ FAILURE — Échec récupérable lors de l'envoi d'un message au GameLift Service WebSocket.

  • WEBSOCKET_ SEND _ MESSAGE _ FAILURE — Impossible d'envoyer un message au GameLift Service 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 pour nouveaux joueurs.

  • DENY_ ALL — Refusez toutes les sessions pour les nouveaux joueurs.

  • NOT_ SET — La session de jeu n'est pas configurée pour accepter ou refuser les sessions de nouveaux joueurs.