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

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

Cette API est définie dans GameLiftServerAPI.h, LogParameters.h et ProcessParameters.h.

• Actions

• Types de données

DescribePlayerSessionsRequest

Ce type de données est utilisé pour spécifier les sessions de joueur à récupérer. Vous pouvez l'utiliser comme suit :

• Fournissez un PlayerSessionId pour demander une session de joueur spécifique.

• Indiquez un GameSessionId pour demander toutes les sessions des joueurs pendant la session de jeu spécifiée.

• Indiquez un PlayerId pour demander toutes les sessions du 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 blocs séquentiels.

Table des matières

GameSessionId

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'ID de session de jeu est le suivant : arn:aws:gamelift:<region>::gamesession/fleet-<fleet ID>/<ID string>. La valeur de <ID string> peut être une chaîne d'ID personnalisée ou (si spécifiée lors de la création de la session de jeu) une chaîne générée automatiquement.

Type : chaîne

Obligatoire : non

Limite

Nombre maximum de résultats à renvoyer. Utilisez ce paramètre avec NextTokenpour obtenir des résultats sous la forme d'un ensemble de pages séquentielles. Si un ID de session de joueur est spécifié, ce paramètre est ignoré.

Type : entier

Obligatoire : non

NextToken

Jeton indiquant le début de la prochaine page séquentielle de résultats. Utilisez le jeton qui est renvoyé par un appel précédent à cette action. Pour spécifier le début de l'ensemble de résultats, ne spécifiez aucune valeur. Si un ID de session de joueur est spécifié, ce paramètre est ignoré.

Type : chaîne

Obligatoire : non

PlayerId

Identifiant unique pour un joueur. Les ID de joueur sont définis par le développeur. Consultez Générer des identifiants de joueurs.

Type : chaîne

Obligatoire : non

PlayerSessionId

Identifiant unique d'une session de joueur.

Type : chaîne

Obligatoire : non

PlayerSessionStatusFilter

État de session de joueur pour filtrer les résultats. Les états de session de joueur possibles sont les suivants :

• RESERVED - La demande de session de joueur a été reçue, mais le joueur ne s'est pas encore connecté au processus serveur et/ou n'a pas encore été validé.

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

• COMPLETED - La connexion du joueur a été abandonnée.

• TIMEDOUT - Une demande de session de joueur a été reçue, mais le joueur ne s'est pas connecté et/ou n'a pas été validé avant l'expiration du délai (60 secondes).

Type : chaîne

Obligatoire : non

LogParameters

Ce type de données est utilisé pour identifier les fichiers générés pendant une session de jeu que vous souhaitez qu'Amazon GameLift télécharge et stocke une fois la session de jeu terminée. Ces informations sont communiquées au GameLift service Amazon lors d'un ProcessReady() appel.

Table des matières

logPaths

Chemins de répertoire vers les fichiers journaux du serveur de jeu que vous souhaitez qu'Amazon GameLift stocke pour un accès ultérieur. Ces fichiers sont générés au cours de chaque session de jeu. Les chemins et noms des fichiers sont définis dans votre serveur de jeux et stockés dans le répertoire racine de génération de jeu. Les chemins du journal doivent être absolus. Par exemple, si la version de génération de votre jeu stocke les journaux de session de jeu suivant un chemin tel que MyGame\sessionlogs\, le chemin d'accès aux journaux est c:\game\MyGame\sessionLogs (sur une instance Windows) ou /local/game/MyGame/sessionLogs (sur une instance Linux).

Type : std:vector<std::string>

Obligatoire : non

ProcessParameters

Ce type de données contient l'ensemble des paramètres envoyés au GameLift service Amazon lors d'un ProcessReady() appel.

Table des matières

port

Numéro de port sur lequel le processus serveur écoute les nouvelles connexions de joueur. 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 : entier

Obligatoire : oui

logParameters

Objet comportant une liste de chemins de répertoires vers les fichiers journaux de sessions de jeu.

Type : Aws : GameLift : :Serveur : : LogParameters

Obligatoire : non

onStartGameSéance

Nom de la fonction de rappel invoquée par le GameLift service Amazon pour activer une nouvelle session de jeu. Amazon GameLift appelle cette fonction en réponse à la demande du client CreateGameSession. La fonction de rappel transmet un GameSessionobjet (défini dans la référence de l'API Amazon GameLift Service).

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

Obligatoire : oui

onProcessTerminate

Nom de la fonction de rappel invoquée par le GameLift service Amazon pour forcer l'arrêt du processus serveur. Après avoir appelé cette fonction, Amazon GameLift attend cinq minutes que le processus du serveur s'arrête et répond par un ProcessEnding() appel. Si aucune réponse n'est reçue, le processus serveur est arrêté.

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

Obligatoire : non

onHealthCheck

Nom de la fonction de rappel invoquée par le GameLift service Amazon pour demander un rapport d'état de santé au processus serveur. Amazon GameLift appelle cette fonction toutes les 60 secondes. Après avoir appelé cette fonction, Amazon GameLift attend une réponse pendant 60 secondes et, si aucune réponse n'est reçue, enregistre le processus du serveur comme étant défectueux.

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

Obligatoire : non

onUpdateGameSéance

Nom de la fonction de rappel invoquée par le GameLift service Amazon pour transmettre un objet de session de jeu mis à jour au processus du serveur. Amazon GameLift fait appel à cette fonction lorsqu'une demande de remplissage de correspondance a été traitée afin de fournir des données de matchmaking mises à jour. Il transmet un GameSessionobjet, une mise à jour de statut (updateReason) et l'identifiant du ticket de remplissage du match.

Type: std::function<void(Aws::GameLift::Server::Model::UpdateGameSession)> onUpdateGameSession

Obligatoire : non

StartMatchBackfillRequest

Ce type de données est utilisé pour envoyer une requête de renvoi de correspondance. Les informations sont communiquées au GameLift service Amazon lors d'un StartMatchBackfill() appel.

Table des matières

GameSessionArn

Identifiant de session de jeu unique. L'action d'API GetGameSessionId() renvoie l'identifiant au format ARN.

Type : String

Obligatoire : oui

MatchmakingConfigurationArn

Identifiant unique, sous la forme d'un ARN, pour le matchmaker à utiliser pour cette requête. Pour trouver le matchmaker qui a été utilisé pour créer la session de jeu d'origine, recherchez dans l'objet de session de jeu, dans la propriété de données de matchmaker. En savoir plus sur les données de matchmaking dans Word avec les données de matchmaking.

Type : String

Obligatoire : oui

Joueurs

Ensemble de données représentant tous les joueurs qui sont actuellement dans la session de jeu. Le matchmaker utilise ces informations pour rechercher de nouveaux joueurs qui constituent de bonnes correspondances pour les joueurs actuels. Consultez le guide de référence des GameLift API Amazon pour obtenir une description du format d'objet Player. Pour trouver des attributs de joueur, des identifiants et des affectations d'équipe, recherchez dans l'objet de session de jeu, dans la propriété des données de matchmaker. Si une latence est utilisée par le matchmaker, collectez la latence mise à jour pour la région actuelle et incluez-la dans les données de chaque joueur.

Type : standard : vecteurhttps://docs.aws.amazon.com/gamelift/latest/apireference/API_Player.html <player>

Obligatoire : oui

TicketId

Identifiant unique pour une correspondance ou un ticket de requête de renvoi de correspondance. Si aucune valeur n'est fournie ici, Amazon en GameLift générera une sous la forme d'un UUID. Utilisez cet identifiant pour suivre l'état du ticket de renvoi de correspondance ou annuler la requête si nécessaire.

Type : chaîne

Obligatoire : non

StopMatchBackfillRequest

Ce type de données est utilisé pour annuler une demande de renvoi de correspondance. Les informations sont communiquées au GameLift service Amazon lors d'un StopMatchBackfill() appel.

Table des matières

GameSessionArn

Identifiant de session de jeu unique associé à la requête en cours d'annulation.

Type : String

Obligatoire : oui

MatchmakingConfigurationArn

Identifiant unique du matchmaker auquel cette requête a été envoyée.

Type : String

Obligatoire : oui

TicketId

Identifiant unique d'un ticket de requête de correspondance à annuler.

Type : String

Obligatoire : oui