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.

Création d'un Realtime script

Amazon GameLift ServersRealtimePour l'utiliser dans votre jeu, vous devez fournir un script (sous forme de JavaScript code) pour configurer et éventuellement personnaliser une flotte de Amazon GameLift ServersRealtime. Cette rubrique explique les principales étapes de la création d'un script Realtime. Une fois que le script est prêt, chargez-le dans le service Amazon GameLift Servers et utilisez-le pour créer une flotte (voir Déployez un script pour Amazon GameLift ServersRealtime).

Pour préparer un script à utiliser avec Amazon GameLift ServersRealtime, ajoutez les fonctionnalités suivantes à votre Realtime script.

Gérer le cycle de vie des sessions de jeu (obligatoire)

Au minimum, un script Realtime doit inclure la fonction Init(), qui prépare le serveur Realtime pour commencer une session de jeu. Il est également vivement recommandé de fournir un moyen de mettre fin à des sessions de jeu, afin de garantir que de nouvelles sessions de jeu pourront être encore démarrées sur votre flotte.

La fonction de rappel Init(), lorsqu'elle est appelée, se voit transmettre un objet de session Realtime, qui contient une interface pour le serveur Realtime. Veuillez consulter Amazon GameLift ServersRealtimeinterface pour plus de détails sur cette interface.

Pour mettre fin élégamment à une session de jeu, le script doit également appeler la fonction session.processEnding du serveur Realtime. Cela requiert un mécanisme pour déterminer quand mettre fin à une session. L'exemple de code de script illustre un mécanisme simple qui recherche les connexions de joueur et déclenche l'arrêt de la session de jeu quand aucun joueur ne s'est connecté à la session depuis un temps spécifié.

Amazon GameLift ServersRealtimedotés de la configuration la plus élémentaire (initialisation et terminaison des processus du serveur), agissent essentiellement comme des serveurs relais apatrides. Le serveur Realtime relaie les messages et les données de jeu entre les clients de jeu connectés au jeu, mais ne prend aucune mesure indépendante pour traiter les données ou exécuter la logique. Vous pouvez également ajouter une logique de jeu, déclenchée par des événements de jeu ou d'autres mécanismes, en fonction des besoins de votre jeu.

Ajouter une logique de jeu côté serveur (facultatif)

Si vous le souhaitez, vous pouvez ajouter une logique de jeu à votre script Realtime. Vous pouvez, par exemple, effectuer une partie ou l'ensemble des opérations suivantes. L'exemple de code de script fournit une illustration. Consultez Référence de script pour Amazon GameLift ServersRealtime.

Amazon GameLift ServersRealtimeexemple de script

Cet exemple illustre un script de base nécessaire au déploiement Amazon GameLift Servers Realtime ainsi qu'une logique personnalisée. Il contient la fonction Init() requise et utilise une minuterie pour déclencher l'arrêt de la session de jeu en fonction du temps écoulé sans connexion de joueur. Il inclut également des hooks pour une logique personnalisée, y compris certaines implémentations de rappel.

// Example Realtime Server Script
'use strict';

// Example override configuration
const configuration = {
    pingIntervalTime: 30000,
    maxPlayers: 32
};

// Timing mechanism used to trigger end of game session. Defines how long, in milliseconds, between each tick in the example tick loop
const tickTime = 1000;

// Defines how to long to wait in Seconds before beginning early termination check in the example tick loop
const minimumElapsedTime = 120;

var session;                        // The Realtime server session object
var logger;                         // Log at appropriate level via .info(), .warn(), .error(), .debug()
var startTime;                      // Records the time the process started
var activePlayers = 0;              // Records the number of connected players
var onProcessStartedCalled = false; // Record if onProcessStarted has been called

// Example custom op codes for user-defined messages
// Any positive op code number can be defined here. These should match your client code.
const OP_CODE_CUSTOM_OP1 = 111;
const OP_CODE_CUSTOM_OP1_REPLY = 112;
const OP_CODE_PLAYER_ACCEPTED = 113;
const OP_CODE_DISCONNECT_NOTIFICATION = 114;

// Example groups for user-defined groups
// Any positive group number can be defined here. These should match your client code.
// When referring to user-defined groups, "-1" represents all groups, "0" is reserved.
const RED_TEAM_GROUP = 1;
const BLUE_TEAM_GROUP = 2;

// Called when game server is initialized, passed server's object of current session
function init(rtSession) {
    session = rtSession;
    logger = session.getLogger();
}

// On Process Started is called when the process has begun and we need to perform any
// bootstrapping.  This is where the developer should insert any code to prepare
// the process to be able to host a game session, for example load some settings or set state
//
// Return true if the process has been appropriately prepared and it is okay to invoke the
// GameLift ProcessReady() call.
function onProcessStarted(args) {
    onProcessStartedCalled = true;
    logger.info("Starting process with args: " + args);
    logger.info("Ready to host games...");

    return true;
}

// Called when a new game session is started on the process
function onStartGameSession(gameSession) {
    // Complete any game session set-up

    // Set up an example tick loop to perform server initiated actions
    startTime = getTimeInS();
    tickLoop();
}

// Handle process termination if the process is being terminated by Amazon GameLift Servers
// You do not need to call ProcessEnding here
function onProcessTerminate() {
    // Perform any clean up
}

// Return true if the process is healthy
function onHealthCheck() {
    return true;
}

// On Player Connect is called when a player has passed initial validation
// Return true if player should connect, false to reject
function onPlayerConnect(connectMsg) {
    // Perform any validation needed for connectMsg.payload, connectMsg.peerId
    return true;
}

// Called when a Player is accepted into the game
function onPlayerAccepted(player) {
    // This player was accepted -- let's send them a message
    const msg = session.newTextGameMessage(OP_CODE_PLAYER_ACCEPTED, player.peerId,
                                             "Peer " + player.peerId + " accepted");
    session.sendReliableMessage(msg, player.peerId);
    activePlayers++;
}

// On Player Disconnect is called when a player has left or been forcibly terminated
// Is only called for players that actually connected to the server and not those rejected by validation
// This is called before the player is removed from the player list
function onPlayerDisconnect(peerId) {
    // send a message to each remaining player letting them know about the disconnect
    const outMessage = session.newTextGameMessage(OP_CODE_DISCONNECT_NOTIFICATION,
                                                session.getServerId(),
                                                "Peer " + peerId + " disconnected");
    session.getPlayers().forEach((player, playerId) => {
        if (playerId != peerId) {
            session.sendReliableMessage(outMessage, playerId);
        }
    });
    activePlayers--;
}

// Handle a message to the server
function onMessage(gameMessage) {
    switch (gameMessage.opCode) {
      case OP_CODE_CUSTOM_OP1: {
        // do operation 1 with gameMessage.payload for example sendToGroup
        const outMessage = session.newTextGameMessage(OP_CODE_CUSTOM_OP1_REPLY, session.getServerId(), gameMessage.payload);
        session.sendGroupMessage(outMessage, RED_TEAM_GROUP);
        break;
      }
    }
}

// Return true if the send should be allowed
function onSendToPlayer(gameMessage) {
    // This example rejects any payloads containing "Reject"
    return (!gameMessage.getPayloadAsText().includes("Reject"));
}

// Return true if the send to group should be allowed
// Use gameMessage.getPayloadAsText() to get the message contents
function onSendToGroup(gameMessage) {
    return true;
}

// Return true if the player is allowed to join the group
function onPlayerJoinGroup(groupId, peerId) {
    return true;
}

// Return true if the player is allowed to leave the group
function onPlayerLeaveGroup(groupId, peerId) {
    return true;
}

// A simple tick loop example
// Checks to see if a minimum amount of time has passed before seeing if the game has ended
async function tickLoop() {
    const elapsedTime = getTimeInS() - startTime;
    logger.info("Tick... " + elapsedTime + " activePlayers: " + activePlayers);

    // In Tick loop - see if all players have left early after a minimum period of time has passed
    // Call processEnding() to terminate the process and quit
    if ( (activePlayers == 0) && (elapsedTime > minimumElapsedTime)) {
        logger.info("All players disconnected. Ending game");
        const outcome = await session.processEnding();
        logger.info("Completed process ending with: " + outcome);
        process.exit(0);
    }
    else {
        setTimeout(tickLoop, tickTime);
    }
}

// Calculates the current time in seconds
function getTimeInS() {
    return Math.round(new Date().getTime()/1000);
}

exports.ssExports = {
    configuration: configuration,
    init: init,
    onProcessStarted: onProcessStarted,
    onMessage: onMessage,
    onPlayerConnect: onPlayerConnect,
    onPlayerAccepted: onPlayerAccepted,
    onPlayerDisconnect: onPlayerDisconnect,
    onSendToPlayer: onSendToPlayer,
    onSendToGroup: onSendToGroup,
    onPlayerJoinGroup: onPlayerJoinGroup,
    onPlayerLeaveGroup: onPlayerLeaveGroup,
    onStartGameSession: onStartGameSession,
    onProcessTerminate: onProcessTerminate,
    onHealthCheck: onHealthCheck
};