SDK du serveur Go pour Amazon GameLift Servers -- Types de données - Amazon GameLift Servers
LogParametersProcessParametersUpdateGameSessionGameSessionServerParametersStartMatchBackfillRequestJoueurDescribePlayerSessionsRequestStopMatchBackfillRequestGetFleetRoleCredentialsRequest

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 du serveur Go pour Amazon GameLift Servers -- Types de données

Utilisez la référence du SDK du serveur pour intégrer votre jeu multijoueur à des fins d'Amazon GameLift Servershébergement. Pour obtenir des conseils sur le processus d'intégration, consultezAjouter Amazon GameLift Servers à votre serveur de jeu.

GameLiftServerAPI.godéfinit les actions du SDK du serveur Go.

SDK du serveur Go pour Amazon GameLift Servers -- Actions

LogParameters

Objet identifiant les fichiers générés au cours d'une session de jeu que vous Amazon GameLift Servers souhaitez télécharger et stocker à la fin de la session de jeu. Le serveur de jeu fournit LogParameters to dans Amazon GameLift Servers le cadre d'un ProcessParameters objet lors d'un ProcessReady() appel.

Propriétés

 Description
LogPaths

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 queMyGame\sessionLogs\, alors le chemin se c:\game\MyGame\sessionLogs trouve sur une instance Windows.

Type : []string

Obligatoire : non

ProcessParameters

Objet décrivant la communication entre un processus serveur etAmazon GameLift Servers. Le processus du serveur fournit ces informations à l'Amazon GameLift Serversaide d'un appel àProcessReady().

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 Serverscopie et stocke les fichiers pour un accès futur.

Type : LogParameters

Obligatoire : non
OnHealthCheck La fonction de rappel qui Amazon GameLift Servers appelle le processus du serveur pour demander un rapport d'état de santé. Amazon GameLift Serversappelle 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 GameLift Servers enregistre le processus du serveur comme non sain.

Type : OnHealthCheck func() bool

Obligatoire : non
OnProcessTerminate La fonction de rappel qui Amazon GameLift Servers invoque pour forcer l'arrêt du processus du serveur. Après avoir appelé cette fonction, Amazon GameLift Servers attendez 5 minutes que le processus serveur s'arrête et répondez par un ProcessEnding() appel avant d'arrêter le processus serveur.

Type : OnProcessTerminate func()

Obligatoire : oui
OnStartGameSession La fonction de rappel qui Amazon GameLift Servers appelle 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 correspondances 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 : OnStartGameSession func (model.GameSession )

Obligatoire : oui
OnUpdateGameSession La fonction de rappel qui demande de Amazon GameLift Servers transmettre les informations de session de jeu mises à jour au processus du serveur. Amazon GameLift Serversappelle cette fonction après avoir traité une demande de remplissage de correspondance pour fournir des données de matchmaking mises à jour.

Type : OnUpdateGameSession func (model.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 : int

Obligatoire : oui

UpdateGameSession

Les mises à jour apportées à un objet de session de jeu, y compris 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 : GameSession GameSession()

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

Type : UpdateReason UpdateReason()

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

Type : String

Obligatoire : non

GameSession

Les détails d'une session de jeu.

Propriétés Description
GameSessionId

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

Type : String

Obligatoire : non
Nom

Une étiquette descriptive de la session de jeu.

Type : String

Obligatoire : non
FleetId

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

Type : String

Obligatoire : non
MaximumPlayerSessionCount

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

Type : Integer

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

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

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, 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 : 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 : map[string] string

Obligatoire : non
DnsName

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

  • Flottes compatibles TLS :. <unique identifier>.<region identifier>.amazongamelift.com

  • Non-TLS-enabled flottes :ec2-<unique identifier>.compute.amazonaws.com.

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

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

Les GameLiftServerSdkEndpoint Amazon GameLift Servers retours lorsque vous RegisterComputerecherchez une ressource de calcul Amazon GameLift Servers Anywhere.

Type : string

Obligatoire : oui
ProcessID

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

Type : string

Obligatoire : oui
HostID

Identifiant unique de la ressource de calcul hébergeant le nouveau processus du serveur.

Le HostID est celui ComputeName utilisé lorsque vous avez enregistré votre ordinateur. Pour de plus amples informations, veuillez consulter RegisterCompute.

Type : string

Obligatoire : oui
FleetID Identifiant unique de la flotte dans laquelle le calcul est enregistré. Pour de plus amples informations, veuillez consulter RegisterCompute.

Type : string

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 de plus amples informations, veuillez consulter GetComputeAuthToken.

Type : 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 Servers lors d'un StartMatchBackfill() appel.

Propriétés Description
GameSessionArn

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

Type : String

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 du système de matchmaking correspondant à la session de jeu d'origine se trouve dans l'objet de session de jeu dans la propriété des données du système de matchmaking. Pour plus d'informations sur les données du système de jumelage, consultez la section Utilisation des données du système de jumelage.

Type : String

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 : []model.Player

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

Obligatoire : non

Joueur

L'objet qui 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 : map[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 : map[string] AttributeValue

Obligatoire : non
PlayerId

Identifiant unique pour un joueur.

Type : 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 : String

Obligatoire : non

DescribePlayerSessionsRequest

Objet qui indique les sessions de joueur à récupérer. Le processus du serveur fournit ces informations en DescribePlayerSessions() appelantAmazon GameLift Servers.

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'une chaîne générée.

Type : String

Obligatoire : non
PlayerSessionID

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

Type : 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. Consultez Générer un joueur IDs.

Type : String

Obligatoire : non
PlayerSessionStatusFilter

État de la session du joueur sur lequel filtrer les résultats. Les statuts de session de joueur possibles incluent :

  • RÉSERVÉ — 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é.

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

  • TERMINÉ — 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ée dans le délai imparti (60 secondes).

Type : 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 : String

Obligatoire : non
Limit

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

Obligatoire : non
MatchmakingConfigurationArn

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

Type : string

Obligatoire : non
TicketId

L'identifiant unique du ticket de demande de remblayage à annuler.

Type : string

Obligatoire : non

GetFleetRoleCredentialsRequest

Les informations d'identification du rôle qui étendent l'accès limité à vos AWS ressources au serveur de jeu. Pour plus d'informations, voir,Configurer un rôle de service IAM pour Amazon GameLift Servers.

Propriétés Description
RoleArn L'ARN du rôle de service qui étend un accès limité à vos AWS ressources.

Type : string

Obligatoire : oui
RoleSessionName Le nom de la session qui décrit l'utilisation des informations d'identification du rôle.

Type : string

Obligatoire : oui