factorio-clusterio/packages/lib/PlayerStats.js

"use strict";

/**
 * Stastics collected about a player.
 * @alias module:lib/PlayerStats
 */
class PlayerStats {
	/**
	 * Count of the number of times this player has been seen joining this server.
	 * @type {number}
	 */
	joinCount = 0;

	/**
	 * Time in ms this player has been seen online on this instance.
	 * @type {number}
	 */
	onlineTimeMs = 0;

	/**
	 * Timestamp the player was last seen joining.
	 * @type {Date=}
	 */
	lastJoinAt;

	/**
	 * Timestamp the player was last seen leaving.
	 * @type {Date=}
	 */
	lastLeaveAt;

	/**
	 * Reason the player was last seen leaving with.
	 * @type {string=}
	 */
	lastLeaveReason;

	static jsonSchema = {
		type: "object",
		properties: {
			"join_count": { type: "integer" },
			"online_time_ms": { type: "number" },
			"last_join_at": { type: "number" },
			"last_leave_at": { type: "number" },
			"last_leave_reason": { type: "string" },
		},
	};

	constructor(json = {}) {
		if (json["join_count"]) {
			this.joinCount = json["join_count"];
		}
		if (json["online_time_ms"]) {
			this.onlineTimeMs = json["online_time_ms"];
		}
		if (json["last_join_at"]) {
			this.lastJoinAt = new Date(json["last_join_at"]);
		}
		if (json["last_leave_at"]) {
			this.lastLeaveAt = new Date(json["last_leave_at"]);
			this.lastLeaveReason = json["last_leave_reason"] || "quit";
		}
	}

	toJSON() {
		let json = {};
		if (this.joinCount) {
			json["join_count"] = this.joinCount;
		}
		if (this.onlineTimeMs) {
			json["online_time_ms"] = this.onlineTimeMs;
		}
		if (this.lastJoinAt) {
			json["last_join_at"] = this.lastJoinAt.getTime();
		}
		if (this.lastLeaveAt) {
			json["last_leave_at"] = this.lastLeaveAt.getTime();
			json["last_leave_reason"] = this.lastLeaveReason;
		}
		return json;
	}
}

module.exports = PlayerStats;