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 SDK Amazon Server pour Unreal Engine : Actions

Cette référence GameLift du SDK Amazon Server peut vous aider à préparer vos projets de jeux Unreal Engine à utiliser avec Amazon. GameLift Pour plus d'informations sur le processus d'intégration, consultez Ajoutez Amazon GameLift à votre serveur de jeu.

Cette API est définie dans GameLiftServerSDK.h et GameLiftServerSDKModels.h.

Pour configurer le plug-in Unreal Engine et consulter des exemples de code Intégrer Amazon GameLift dans un projet Unreal Engine.

AcceptPlayerSession()

Informe le GameLift service Amazon qu'un joueur avec l'identifiant de session de joueur spécifié s'est connecté au processus du serveur et doit être validé. Amazon GameLift vérifie que l'identifiant de session du joueur est valide, c'est-à-dire que l'identifiant du joueur a réservé un emplacement de joueur dans la session de jeu. Une fois la validation effectuée, GameLift Amazon fait passer le statut de la machine à sous RÉSERVÉ à ACTIVE.

Syntaxe

FGameLiftGenericOutcome AcceptPlayerSession(const FString& playerSessionId)

Paramètres

Valeur renvoyée

Renvoie un résultat générique composé d'un succès ou d'un échec avec un message d'erreur.

ActivateGameSession()

Indique au GameLift service Amazon que le processus du serveur a activé une session de jeu et qu'il est désormais prêt à recevoir les connexions des joueurs. Cette action doit être appelée dans le cadre de la fonction de rappel onStartGameSession(), une fois que l'initialisation de toutes les sessions de jeu est terminée.

Syntaxe

FGameLiftGenericOutcome ActivateGameSession()

Paramètres

Cette action n'a aucun paramètre.

Valeur renvoyée

Renvoie un résultat générique composé d'un succès ou d'un échec avec un message d'erreur.

DescribePlayerSessions()

Récupère les données de session de joueur, y compris les paramètres, les métadonnées de session et les données de joueur. Utilisez cette action pour obtenir des informations pour une seule session de joueur, pour toutes les sessions de joueur d'une session de jeu ou pour toutes les sessions de joueur associées à un seul ID de joueur.

Syntaxe

FGameLiftDescribePlayerSessionsOutcome DescribePlayerSessions(const FGameLiftDescribePlayerSessionsRequest &describePlayerSessionsRequest)

Paramètres

Valeur renvoyée

En cas de réussite, renvoie un objet F DescribePlayerSessionsRequest qui contient un ensemble d'objets de session de joueur correspondant aux paramètres de la demande. Les objets de session du joueur ont une structure identique au type de PlayerSessiondonnées de l'GameLiftAPI Amazon du AWS SDK.

GetGameSessionId()

Extrait l'ID de la session de jeu actuellement hébergée par le processus serveur, si ce dernier est actif.

Syntaxe

FGameLiftStringOutcome GetGameSessionId()

Paramètres

Cette action n'a aucun paramètre.

Valeur renvoyée

En cas de réussite, renvoie l'ID de session de jeu en tant qu'objet FGameLiftStringOutcome. En cas d'échec, renvoie un message d'erreur.

GetInstanceCertificate()

Récupère l'emplacement du fichier d'un certificat TLS codé PEM associé au parc et à ses instances. AWS Certificate Managergénère ce certificat lorsque vous créez une nouvelle flotte avec la configuration du certificat définie sur GENERATED. Utilisez ce certificat pour établir une connexion sécurisée avec un client de jeu et pour chiffrer la communication client/serveur.

Syntaxe

FGameLiftGetInstanceCertificateOutcome GetInstanceCertificate()

Paramètres

Cette action n'a aucun paramètre.

Valeur renvoyée

En cas de succès, renvoie un GetInstanceCertificateOutcome objet contenant l'emplacement du fichier de certificat TLS et de la chaîne de certificats du parc, qui sont stockés sur l'instance. Un fichier de certificat racine, extrait de la chaîne de certificats, est également stocké sur l'instance. En cas d'échec, renvoie un message d'erreur.

Pour plus d'informations sur le certificat et les données de la chaîne de certificats, consultez la section Éléments de GetCertificate réponse dans la référence de l'AWS Certificate ManagerAPI.

GetSdkVersion()

Renvoie le numéro de version actuel du kit SDK intégré dans le processus serveur.

Syntaxe

FGameLiftStringOutcome GetSdkVersion();

Paramètres

Cette action n'a aucun paramètre.

Valeur renvoyée

En cas de réussite, renvoie la version actuelle du kit SDK en tant qu'objet FGameLiftStringOutcome. La chaîne renvoyée inclut uniquement le numéro de version (par exemple « 3.1.5 »). En cas d'échec, renvoie un message d'erreur.

Exemple

Aws::GameLift::AwsStringOutcome SdkVersionOutcome = 
    Aws::GameLift::Server::GetSdkVersion(); 

InitSDK()

Initialise le GameLift SDK Amazon. Cette méthode doit être appelée au lancement, avant toute autre initialisation GameLift liée à Amazon.

Syntaxe

FGameLiftGenericOutcome InitSDK()

Paramètres

Cette action n'a aucun paramètre.

Valeur renvoyée

Renvoie un résultat générique composé d'un succès ou d'un échec avec un message d'erreur.

ProcessEnding()

Informe le GameLift service Amazon que le processus du serveur est en train de s'arrêter. Cette méthode doit être appelée après toutes les autres tâches de nettoyage, y compris l'arrêt de toutes les sessions de jeu actives. Cette méthode doit quitter avec un code de sortie 0 ; un code de sortie différent de 0 génère un message d'événement indiquant que le processus ne s'est pas fermé correctement.

Syntaxe

FGameLiftGenericOutcome ProcessEnding()

Paramètres

Cette action n'a aucun paramètre.

Valeur renvoyée

Renvoie un résultat générique composé d'un succès ou d'un échec avec un message d'erreur.

ProcessReady()

Indique au GameLift service Amazon que le processus du serveur est prêt à héberger des sessions de jeu. Appelez cette méthode après avoir invoqué InitSDK() et terminé avec succès les tâches de configuration requises pour que le processus serveur puisse héberger une session de jeu. Cette méthode ne doit être appelée qu'une seule fois par processus.

Syntaxe

FGameLiftGenericOutcome ProcessReady(FProcessParameters &processParameters)

Paramètres

Valeur renvoyée

Renvoie un résultat générique composé d'un succès ou d'un échec avec un message d'erreur.

Exemple

Consultez l'exemple de code dans Utilisation du plug-in Unreal Engine.

RemovePlayerSession()

Informe le GameLift service Amazon qu'un joueur avec l'identifiant de session de joueur spécifié s'est déconnecté du processus serveur. En réponse, Amazon GameLift change le créneau de joueur en disponible, ce qui permet de l'attribuer à un nouveau joueur.

Syntaxe

FGameLiftGenericOutcome RemovePlayerSession(const FString& playerSessionId)

Paramètres

Valeur renvoyée

Renvoie un résultat générique composé d'un succès ou d'un échec avec un message d'erreur.

StartMatchBackfill()

Envoie une demande de recherche de nouveaux joueurs pour des emplacements ouverts dans une session de jeu créée avec FlexMatch. Voir également l'action du AWS SDK StartMatchBackfill(). Avec cette action, les requêtes de renvoi de correspondance peuvent être initiées par processus de serveur de jeu qui héberge la session de jeu. En savoir plus sur la fonction de FlexMatch remblayage.

Cette action est asynchrone. Si de nouveaux joueurs sont jumelés avec succès, le GameLift service Amazon fournit des données de matchmaking mises à jour à l'aide de la fonction de rappel. OnUpdateGameSession()

Un processus de serveur ne peut comporter qu'une seule requête de renvoi de correspondance à la fois. Pour envoyer une nouvelle requête, appelez d'abord StopMatchBackfill() pour annuler la requête d'origine.

Syntaxe

FGameLiftStringOutcome StartMatchBackfill (FStartMatchBackfillRequest &startBackfillRequest);

Paramètres

Valeur renvoyée

En cas de réussite, renvoie le ticket de renvoi de correspondance sous la forme d'un objet FGameLiftStringOutcome. En cas d'échec, renvoie un message d'erreur. L'état du ticket peut être suivi à l'aide de l'action du AWS SDK DescribeMatchmaking().

StopMatchBackfill()

Annule une requête de renvoi de correspondance active qui a été créée avec StartMatchBackfill(). Voir également l'action du AWS SDK StopMatchmaking(). En savoir plus sur la fonction de FlexMatch remblayage.

Syntaxe

FGameLiftGenericOutcome StopMatchBackfill (FStopMatchBackfillRequest &stopBackfillRequest);

Paramètres

Valeur renvoyée

Renvoie un résultat générique composé d'un succès ou d'un échec avec un message d'erreur.

TerminateGameSession()

Cette méthode est obsolète depuis la version 4.0.1. Au lieu de cela, le processus du serveur doit appeler ProcessEnding() après la fin d'une session de jeu.

Informe le GameLift service Amazon que le processus du serveur a mis fin à la session de jeu en cours. Cette action est appelée lorsque le processus du serveur reste actif et prêt à héberger une nouvelle session de jeu. Il ne doit être appelé qu'une fois la procédure de fin de session de jeu terminée, car il indique à Amazon GameLift que le processus du serveur est immédiatement disponible pour héberger une nouvelle session de jeu.

Cette action n'est pas appelée si le processus du serveur doit être arrêté après la fin de la session de jeu. Appelez plutôt ProcessEnding() pour signaler que la session de jeu et le processus du serveur se terminent.

Syntaxe

FGameLiftGenericOutcome TerminateGameSession()

Paramètres

Cette action n'a aucun paramètre.

Valeur renvoyée

Renvoie un résultat générique composé d'un succès ou d'un échec avec un message d'erreur.

UpdatePlayerSessionCreationPolicy()

Met à jour la capacité de la session de jeu à accepter de nouvelles sessions de joueur. Une session de jeu peut être définie pour accepter ou refuser toutes les nouvelles sessions joueur. (Voir également l'UpdateGameSession()action dans la référence de l'API Amazon GameLift Service).

Syntaxe

FGameLiftGenericOutcome UpdatePlayerSessionCreationPolicy(EPlayerSessionCreationPolicy policy)

Paramètres

Valeur renvoyée

Renvoie un résultat générique composé d'un succès ou d'un échec avec un message d'erreur.