gameguard/build/Options.js

GameGuard is a NodeJS game server that can be used to manage the players connecting to your game, manage rooms and the players in them, and more.

'use strict';
Object.defineProperty(exports, "__esModule", { value: true });
/**
 * Defines the options available for an instance of GameGuard and their default values.
 */
class Options {
    /**
     * @param {Object} options The options passed to GameGuard on initialization.
     */
    constructor(options) {
        /**
         * The interval at which each player is pinged, in milliseconds.
         *
         * @property {number}
         *
         * @default 30000
         */
        this.heartbeatInterval = 30000;
        /**
         * The interval at which each player's latency is calculated, in milliseconds.
         *
         * Note that this is a minimum check interval, checks might be sent more often with messages to converse resources but the checks will happen at least every x milliseconds as specified here.
         *
         * @property {number}
         *
         * @default 5000
         */
        this.latencyCheckInterval = 5000;
        /**
         * The max latency, in milliseconds, a player can have before being kicked.
         *
         * @property {number}
         *
         * @default 300
         */
        this.maxLatency = 300;
        /**
         * The mongodb connection string.
         *
         * @property {string}
         *
         * @default mongodb://localhost:27017
         */
        this.mongodbConnectionString = 'mongodb://localhost:27017';
        Object.assign(this, options);
    }
}
exports.default = Options;