teeworlds 2.4.4 → 2.4.5

package/index.js

@@ -20,4 +20,3 @@ Object.defineProperty(exports, "Client", { enumerable: true, get: function () {
 __exportStar(require("./lib/MsgPacker"), exports);
 __exportStar(require("./lib/MsgUnpacker"), exports);
 __exportStar(require("./lib/snapshot"), exports);
-__exportStar(require("./lib/movement"), exports);

package/index.ts

@@ -1,5 +1,4 @@
 export { Client } from "./lib/client";
 export * from "./lib/MsgPacker";
 export * from "./lib/MsgUnpacker";
-export * from "./lib/snapshot";
-export * from "./lib/movement";
+export * from "./lib/snapshot";

package/lib/client.js

@@ -23,11 +23,12 @@ var crypto_1 = require("crypto");
 var dgram_1 = __importDefault(require("dgram"));
 var stream_1 = require("stream");
 var MsgUnpacker_1 = require("./MsgUnpacker");
-var movement_1 = __importDefault(require("./movement"));
+var movement_1 = __importDefault(require("./components/movement"));
 var MsgPacker_1 = require("./MsgPacker");
 var snapshot_1 = require("./snapshot");
 var huffman_1 = __importDefault(require("./huffman"));
 var game_1 = require("./components/game");
+var snapshot_2 = require("./components/snapshot");
 var huff = new huffman_1.default();
 var States;
 (function (States) {
@@ -112,9 +113,6 @@ var NETMSG_Sys;
     NETMSG_Sys[NETMSG_Sys["NETMSG_RCON_CMD_REM"] = 26] = "NETMSG_RCON_CMD_REM";
     NETMSG_Sys[NETMSG_Sys["NUM_NETMSGS"] = 27] = "NUM_NETMSGS";
 })(NETMSG_Sys || (NETMSG_Sys = {}));
-function toHexStream(buff) {
-    return buff.toJSON().data.map(function (a) { return ('0' + (a & 0xff).toString(16)).slice(-2); }).join("");
-}
 var messageTypes = [
     ["none, starts at 1", "SV_MOTD", "SV_BROADCAST", "SV_CHAT", "SV_KILL_MSG", "SV_SOUND_GLOBAL", "SV_TUNE_PARAMS", "SV_EXTRA_PROJECTILE", "SV_READY_TO_ENTER", "SV_WEAPON_PICKUP", "SV_EMOTICON", "SV_VOTE_CLEAR_OPTIONS", "SV_VOTE_OPTION_LIST_ADD", "SV_VOTE_OPTION_ADD", "SV_VOTE_OPTION_REMOVE", "SV_VOTE_SET", "SV_VOTE_STATUS", "CL_SAY", "CL_SET_TEAM", "CL_SET_SPECTATOR_MODE", "CL_START_INFO", "CL_CHANGE_INFO", "CL_KILL", "CL_EMOTICON", "CL_VOTE", "CL_CALL_VOTE", "CL_IS_DDNET", "SV_DDRACE_TIME", "SV_RECORD", "UNUSED", "SV_TEAMS_STATE", "CL_SHOW_OTHERS_LEGACY"],
     ["none, starts at 1", "INFO", "MAP_CHANGE", "MAP_DATA", "CON_READY", "SNAP", "SNAP_EMPTY", "SNAP_SINGLE", "INPUT_TIMING", "RCON_AUTH_STATUS", "RCON_LINE", "READY", "ENTER_GAME", "INPUT", "RCON_CMD", "RCON_AUTH", "REQUEST_MAP_DATA", "PING", "PING_REPLY", "RCON_CMD_ADD", "RCON_CMD_REMOVE"]
@@ -128,17 +126,6 @@ var messageUUIDs = {
     "CLIENT_VERSION": Buffer.from([0x8c, 0x00, 0x13, 0x04, 0x84, 0x61, 0x3e, 0x47, 0x87, 0x87, 0xf6, 0x72, 0xb3, 0x83, 0x5b, 0xd4]),
     "CAPABILITIES": Buffer.from([0xf6, 0x21, 0xa5, 0xa1, 0xf5, 0x85, 0x37, 0x75, 0x8e, 0x73, 0x41, 0xbe, 0xee, 0x79, 0xf2, 0xb2]),
 };
-function arrStartsWith(arr, arrStart, start) {
-    if (start === void 0) { start = 0; }
-    arr.splice(0, start);
-    for (var i = 0; i < arrStart.length; i++) {
-        if (arr[i] == arrStart[i])
-            continue;
-        else
-            return false;
-    }
-    return true;
-}
 var Client = /** @class */ (function (_super) {
     __extends(Client, _super);
     function Client(ip, port, nickname, options) {
@@ -150,7 +137,7 @@ var Client = /** @class */ (function (_super) {
         _this.PredGameTick = 0;
         _this.currentSnapshotGameTick = 0;
         _this.SnapshotParts = 0;
-        _this.SnapUnpacker = new snapshot_1.Snapshot();
+        _this.SnapUnpacker = new snapshot_1.Snapshot(_this);
         // this.eSnapHolder = [];
         _this.requestResend = false;
         _this.VoteList = [];
@@ -172,6 +159,7 @@ var Client = /** @class */ (function (_super) {
         _this.lastSentMessages = [];
         _this.movement = new movement_1.default();
         _this.game = new game_1.Game(_this);
+        _this.SnapshotUnpacker = new snapshot_2.SnapshotWrapper(_this);
         return _this;
     }
     Client.prototype.ResendAfter = function (lastAck) {
@@ -224,7 +212,7 @@ var Client = /** @class */ (function (_super) {
         }
         return unpacked;
     };
-    /* Send a Control Msg to the server. (used for disconnect)*/
+    /**  Send a Control Msg to the server. (used for disconnect)*/
     Client.prototype.SendControlMsg = function (msg, ExtraMsg) {
         var _this = this;
         if (ExtraMsg === void 0) { ExtraMsg = ""; }
@@ -244,7 +232,7 @@ var Client = /** @class */ (function (_super) {
         */
         });
     };
-    /* Send a Msg (or Msg[]) to the server.*/
+    /**  Send a Msg (or Msg[]) to the server.*/
     Client.prototype.SendMsgEx = function (Msgs) {
         var _this = this;
         if (this.State == States.STATE_OFFLINE)
@@ -303,11 +291,11 @@ var Client = /** @class */ (function (_super) {
             return;
         this.socket.send(packet, 0, packet.length, this.port, this.host);
     };
-    /* Queue a chunk (It will get sent in the next packet). */
+    /** Queue a chunk (It will get sent in the next packet). */
     Client.prototype.QueueChunkEx = function (Msg) {
         this.queueChunkEx.push(Msg);
     };
-    /* Send a Raw Buffer (as chunk) to the server. */
+    /**  Send a Raw Buffer (as chunk) to the server. */
     Client.prototype.SendMsgRaw = function (chunks) {
         if (this.State == States.STATE_OFFLINE)
             return;
@@ -344,7 +332,7 @@ var Client = /** @class */ (function (_super) {
         });
         return chunk;
     };
-    /* Connect the client to the server. */
+    /** Connect the client to the server. */
     Client.prototype.connect = function () {
         var _this = this;
         var _a;
@@ -551,7 +539,7 @@ var Client = /** @class */ (function (_super) {
                                     var mergedSnaps = Buffer.concat(_this.snaps);
                                     _this.SnapshotParts = 0;
                                     var snapUnpacked = _this.SnapUnpacker.unpackSnapshot(mergedSnaps, DeltaTick, GameTick, Crc);
-                                    _this.emit("snapshot");
+                                    _this.emit("snapshot", snapUnpacked.items);
                                     _this.AckGameTick = snapUnpacked.recvTick;
                                     if (Math.abs(_this.PredGameTick - _this.AckGameTick) > 10)
                                         _this.PredGameTick = _this.AckGameTick + 1;
@@ -596,8 +584,8 @@ var Client = /** @class */ (function (_super) {
                             };
                             if (unpacked_1.client_id != -1) {
                                 unpacked_1.author = {
-                                    ClientInfo: _this.client_info(unpacked_1.client_id),
-                                    PlayerInfo: _this.player_info(unpacked_1.client_id)
+                                    ClientInfo: _this.SnapshotUnpacker.getObjClientInfo(unpacked_1.client_id),
+                                    PlayerInfo: _this.SnapshotUnpacker.getObjPlayerInfo(unpacked_1.client_id)
                                 };
                             }
                             _this.emit("emote", unpacked_1);
@@ -615,8 +603,8 @@ var Client = /** @class */ (function (_super) {
                             };
                             if (unpacked_2.client_id != -1) {
                                 unpacked_2.author = {
-                                    ClientInfo: _this.client_info(unpacked_2.client_id),
-                                    PlayerInfo: _this.player_info(unpacked_2.client_id)
+                                    ClientInfo: _this.SnapshotUnpacker.getObjClientInfo(unpacked_2.client_id),
+                                    PlayerInfo: _this.SnapshotUnpacker.getObjPlayerInfo(unpacked_2.client_id)
                                 };
                             }
                             _this.emit("message", unpacked_2);
@@ -629,10 +617,10 @@ var Client = /** @class */ (function (_super) {
                             unpacked_3.weapon = unpacker.unpackInt();
                             unpacked_3.special_mode = unpacker.unpackInt();
                             if (unpacked_3.victim_id != -1 && unpacked_3.victim_id < 64) {
-                                unpacked_3.victim = { ClientInfo: _this.client_info(unpacked_3.victim_id), PlayerInfo: _this.player_info(unpacked_3.victim_id) };
+                                unpacked_3.victim = { ClientInfo: _this.SnapshotUnpacker.getObjClientInfo(unpacked_3.victim_id), PlayerInfo: _this.SnapshotUnpacker.getObjPlayerInfo(unpacked_3.victim_id) };
                             }
                             if (unpacked_3.killer_id != -1 && unpacked_3.killer_id < 64)
-                                unpacked_3.killer = { ClientInfo: _this.client_info(unpacked_3.killer_id), PlayerInfo: _this.player_info(unpacked_3.killer_id) };
+                                unpacked_3.killer = { ClientInfo: _this.SnapshotUnpacker.getObjClientInfo(unpacked_3.killer_id), PlayerInfo: _this.SnapshotUnpacker.getObjPlayerInfo(unpacked_3.killer_id) };
                             _this.emit("kill", unpacked_3);
                         }
                         else if (chunk.msgid == NETMSG_Game.SV_MOTD) {
@@ -654,7 +642,7 @@ var Client = /** @class */ (function (_super) {
                 }
             });
     };
-    /* Sending the input. (automatically done unless options.lightweight is on) */
+    /** Sending the input. (automatically done unless options.lightweight is on) */
     Client.prototype.sendInput = function (input) {
         if (input === void 0) { input = this.movement.input; }
         if (this.State != States.STATE_ONLINE)
@@ -676,13 +664,14 @@ var Client = /** @class */ (function (_super) {
         this.SendMsgEx(inputMsg);
     };
     Object.defineProperty(Client.prototype, "input", {
+        /** returns the movement object of the client */
         get: function () {
             return this.movement.input;
         },
         enumerable: false,
         configurable: true
     });
-    /* Disconnect the client. */
+    /** Disconnect the client. */
     Client.prototype.Disconnect = function () {
         var _this = this;
         return new Promise(function (resolve) {
@@ -695,51 +684,17 @@ var Client = /** @class */ (function (_super) {
             });
         });
     };
-    /* Get the client_info from a specific player id. */
-    Client.prototype.client_info = function (id) {
-        var delta = this.SnapUnpacker.deltas.filter(function (_delta) {
-            return _delta.type_id == 11
-                && _delta.id == id;
-        });
-        if (delta.length == 0)
-            return undefined;
-        return delta[0].parsed;
-        // .sort((a, b) => a.id - b.id)
-        // .map(a => a.parsed as ClientInfo);
-    };
-    Object.defineProperty(Client.prototype, "client_infos", {
-        /* Get all client infos. */
-        get: function () {
-            return this.SnapUnpacker.deltas.filter(function (_delta) { return _delta.type_id == 11; })
-                .sort(function (a, b) { return a.id - b.id; })
-                .map(function (a) { return a.parsed; });
-        },
-        enumerable: false,
-        configurable: true
-    });
-    /* Get the player info from a specific player id. */
-    Client.prototype.player_info = function (id) {
-        var delta = this.SnapUnpacker.deltas.filter(function (_delta) {
-            return _delta.type_id == 10
-                && _delta.id == id;
-        });
-        if (delta.length == 0)
-            return undefined;
-        return delta[0].parsed;
-    };
-    Object.defineProperty(Client.prototype, "player_infos", {
-        /* Get all player infos. */
+    Object.defineProperty(Client.prototype, "VoteOptionList", {
+        /** Get all available vote options (for example for map voting) */
         get: function () {
-            return this.SnapUnpacker.deltas.filter(function (_delta) { return _delta.type_id == 10; })
-                .sort(function (a, b) { return a.id - b.id; })
-                .map(function (player) { return player.parsed; });
+            return this.VoteList;
         },
         enumerable: false,
         configurable: true
     });
-    Object.defineProperty(Client.prototype, "VoteOptionList", {
+    Object.defineProperty(Client.prototype, "rawSnapUnpacker", {
         get: function () {
-            return this.VoteList;
+            return this.SnapUnpacker;
         },
         enumerable: false,
         configurable: true

package/lib/client.ts

@@ -5,12 +5,14 @@ import { EventEmitter } from 'stream';
 
 import { unpackString, MsgUnpacker } from "./MsgUnpacker";
 
-import Movement from './movement';
+import Movement from './components/movement';
+import { PlayerInput, PlayerInfo, Projectile, Laser, Pickup, Flag, GameInfo, GameData, CharacterCore, Character, ClientInfo, SpectatorInfo, Common, Explosion, Spawn, HammerHit, Death, SoundGlobal, SoundWorld, DamageInd } from "./snapshots";
 
 import { MsgPacker } from './MsgPacker';
-import { Snapshot } from './snapshot';
+import { Item, Snapshot } from './snapshot';
 import Huffman from "./huffman";
 import { Game } from "./components/game";
+import { SnapshotWrapper } from "./components/snapshot";
 
 const huff = new Huffman();
 
@@ -118,9 +120,7 @@ interface chunk {
 	raw: Buffer,
 	extended_msgid?: Buffer;
 }
-function toHexStream(buff: Buffer): string {
-	return buff.toJSON().data.map(a => ('0' + (a & 0xff).toString(16)).slice(-2)).join("");
-}
+
 interface _packet {
 	twprotocol: { flags: number, ack: number, chunkAmount: number, size: number },
 	chunks: chunk[]
@@ -141,32 +141,6 @@ var messageUUIDs = {
 	"CAPABILITIES": Buffer.from([0xf6, 0x21, 0xa5, 0xa1, 0xf5, 0x85, 0x37, 0x75, 0x8e, 0x73, 0x41, 0xbe, 0xee, 0x79, 0xf2, 0xb2]),
 }
 
-function arrStartsWith(arr: number[], arrStart: number[], start = 0) {
-	arr.splice(0, start)
-	for (let i = 0; i < arrStart.length; i++) {
-		if (arr[i] == arrStart[i])
-			continue;
-		else return false;
-	}
-	return true;
-}
-declare interface PlayerInfo {
-	local: number,
-	client_id: number,
-	team: number,
-	score: number,
-	latency: number,
-}
-
-declare interface ClientInfo {
-	name: string,
-	clan: string,
-	country: number,
-	skin: string,
-	use_custom_color: number,
-	color_body: number,
-	color_feet: number,
-}
 declare interface iMessage {
 	team: number,
 	client_id: number,
@@ -210,6 +184,7 @@ export declare interface Client {
 	on(event: 'kill', listener: (kill: iKillMsg) => void): this;
 	on(event: 'motd', listener: (message: string) => void): this;
 	
+	on(event: 'snapshot', listener: (items: Item[]) => void): this;
 }
 
 export class Client extends EventEmitter {
@@ -226,6 +201,8 @@ export class Client extends EventEmitter {
 	private time: number;
 	private SnapUnpacker: Snapshot;
 
+	public SnapshotUnpacker: SnapshotWrapper;
+
 	private PredGameTick: number;
 	private AckGameTick: number;
 	
@@ -265,7 +242,7 @@ export class Client extends EventEmitter {
 
 		this.SnapshotParts = 0;
 		
-		this.SnapUnpacker = new Snapshot();
+		this.SnapUnpacker = new Snapshot(this);
 		// this.eSnapHolder = [];
 		this.requestResend = false;
 		
@@ -296,6 +273,7 @@ export class Client extends EventEmitter {
 		this.movement = new Movement();
 		
 		this.game = new Game(this);
+		this.SnapshotUnpacker = new SnapshotWrapper(this);
 
 
 	}
@@ -360,8 +338,9 @@ export class Client extends EventEmitter {
 		return unpacked
 	}
 
-	/* Send a Control Msg to the server. (used for disconnect)*/
-	SendControlMsg(msg: number, ExtraMsg: string = "") {
+	
+	/**  Send a Control Msg to the server. (used for disconnect)*/
+	SendControlMsg(msg: number, ExtraMsg: string = "") { 
 		this.lastSendTime = new Date().getTime();
 		return new Promise((resolve, reject) => {
 			if (this.socket) {
@@ -380,8 +359,9 @@ export class Client extends EventEmitter {
 		})
 	}
 
-	/* Send a Msg (or Msg[]) to the server.*/
-	SendMsgEx(Msgs: MsgPacker[] | MsgPacker) {
+	
+	/**  Send a Msg (or Msg[]) to the server.*/
+	SendMsgEx(Msgs: MsgPacker[] | MsgPacker) { 
 		if (this.State == States.STATE_OFFLINE)
 			return; 
 		if (!this.socket)
@@ -439,12 +419,14 @@ export class Client extends EventEmitter {
 			return;
 		this.socket.send(packet, 0, packet.length, this.port, this.host)
 	}
-	/* Queue a chunk (It will get sent in the next packet). */
+	
+	/** Queue a chunk (It will get sent in the next packet). */
 	QueueChunkEx(Msg: MsgPacker) {
 		this.queueChunkEx.push(Msg);
 	}
-	/* Send a Raw Buffer (as chunk) to the server. */
-	SendMsgRaw(chunks: Buffer[]) {
+	
+	/**  Send a Raw Buffer (as chunk) to the server. */
+	SendMsgRaw(chunks: Buffer[]) { 
 		if (this.State == States.STATE_OFFLINE)
 			return;
 		if (!this.socket)
@@ -485,8 +467,9 @@ export class Client extends EventEmitter {
 		return chunk;
 	}
 
-	/* Connect the client to the server. */
-	connect() {
+	
+	/** Connect the client to the server. */
+	connect() { 
 		this.State = States.STATE_CONNECTING;
 
 		let predTimer = setInterval(() => {
@@ -714,7 +697,7 @@ export class Client extends EventEmitter {
 
 								let snapUnpacked = this.SnapUnpacker.unpackSnapshot(mergedSnaps, DeltaTick, GameTick, Crc);
 								
-								this.emit("snapshot");
+								this.emit("snapshot", snapUnpacked.items);
 								this.AckGameTick = snapUnpacked.recvTick;
 								if (Math.abs(this.PredGameTick - this.AckGameTick) > 10)
 									this.PredGameTick = this.AckGameTick + 1;
@@ -770,8 +753,8 @@ export class Client extends EventEmitter {
 
 							if (unpacked.client_id != -1) {
 								unpacked.author = { 
-									ClientInfo: this.client_info(unpacked.client_id), 
-									PlayerInfo: this.player_info(unpacked.client_id) 
+									ClientInfo: this.SnapshotUnpacker.getObjClientInfo(unpacked.client_id), 
+									PlayerInfo: this.SnapshotUnpacker.getObjPlayerInfo(unpacked.client_id) 
 								}
 							}
 							this.emit("emote", unpacked)
@@ -792,8 +775,8 @@ export class Client extends EventEmitter {
 
 							if (unpacked.client_id != -1) {
 								unpacked.author = { 
-									ClientInfo: this.client_info(unpacked.client_id), 
-									PlayerInfo: this.player_info(unpacked.client_id) 
+									ClientInfo: this.SnapshotUnpacker.getObjClientInfo(unpacked.client_id), 
+									PlayerInfo: this.SnapshotUnpacker.getObjPlayerInfo(unpacked.client_id) 
 								}
 							}
 							this.emit("message", unpacked)
@@ -805,11 +788,11 @@ export class Client extends EventEmitter {
 							unpacked.weapon = unpacker.unpackInt();
 							unpacked.special_mode = unpacker.unpackInt();
 							if (unpacked.victim_id != -1 && unpacked.victim_id < 64) {
-								unpacked.victim = { ClientInfo: this.client_info(unpacked.victim_id), PlayerInfo: this.player_info(unpacked.victim_id) }
+								unpacked.victim = { ClientInfo: this.SnapshotUnpacker.getObjClientInfo(unpacked.victim_id), PlayerInfo: this.SnapshotUnpacker.getObjPlayerInfo(unpacked.victim_id) }
 
 							}
 							if (unpacked.killer_id != -1 && unpacked.killer_id < 64)
-								unpacked.killer = { ClientInfo: this.client_info(unpacked.killer_id), PlayerInfo: this.player_info(unpacked.killer_id) }
+								unpacked.killer = { ClientInfo: this.SnapshotUnpacker.getObjClientInfo(unpacked.killer_id), PlayerInfo: this.SnapshotUnpacker.getObjPlayerInfo(unpacked.killer_id) }
 							this.emit("kill", unpacked)
 						} else if (chunk.msgid == NETMSG_Game.SV_MOTD) {
 							let unpacker = new MsgUnpacker(chunk.raw);
@@ -834,8 +817,9 @@ export class Client extends EventEmitter {
 			})
 	}
 
-	/* Sending the input. (automatically done unless options.lightweight is on) */
-	sendInput(input = this.movement.input) {
+	
+	/** Sending the input. (automatically done unless options.lightweight is on) */
+	sendInput(input = this.movement.input) { 
 		if (this.State != States.STATE_ONLINE)
 			return;
 
@@ -857,12 +841,14 @@ export class Client extends EventEmitter {
 		
 		this.SendMsgEx(inputMsg);
 	}
-	get input() {
+	/** returns the movement object of the client */
+	get input() { 
 		return this.movement.input;
 	}
 
-	/* Disconnect the client. */
-	Disconnect() {
+	
+	/** Disconnect the client. */
+	Disconnect() { 
 		return new Promise((resolve) => {
 			this.SendControlMsg(4).then(() => {
 				resolve(true);
@@ -874,46 +860,11 @@ export class Client extends EventEmitter {
 		})
 	}
 
-	/* Get the client_info from a specific player id. */
-	client_info(id: number) {
-		let delta = this.SnapUnpacker.deltas.filter(_delta => 
-			_delta.type_id == 11 
-			&& _delta.id == id
-		);
-
-		if (delta.length == 0)
-			return undefined;
-		return delta[0].parsed as ClientInfo;
-			// .sort((a, b) => a.id - b.id)
-			// .map(a => a.parsed as ClientInfo);
-	}
-
-	/* Get all client infos. */
-	get client_infos(): ClientInfo[] {
-		
-		return this.SnapUnpacker.deltas.filter(_delta => _delta.type_id == 11)
-		.sort((a, b) => a.id - b.id)
-		.map(a => a.parsed as ClientInfo);
-	}
-	/* Get the player info from a specific player id. */
-	player_info(id: number) {
-		let delta = this.SnapUnpacker.deltas.filter(_delta => 
-			_delta.type_id == 10
-			&& _delta.id == id
-		);
-
-		if (delta.length == 0)
-			return undefined;
-		return delta[0].parsed as PlayerInfo;
-	}
-	/* Get all player infos. */
-	get player_infos(): PlayerInfo[] {
-		return this.SnapUnpacker.deltas.filter(_delta => _delta.type_id == 10)
-			.sort((a, b) => a.id - b.id)
-			.map(player => player.parsed as PlayerInfo);
-	}
-
-	get VoteOptionList(): string[] {
+	/** Get all available vote options (for example for map voting) */
+	get VoteOptionList(): string[] { 
 		return this.VoteList;
 	}
+	get rawSnapUnpacker(): Snapshot {
+		return this.SnapUnpacker;
+	}
 }

package/lib/components/game.js

@@ -59,19 +59,19 @@ var Game = /** @class */ (function () {
         packer.AddString(message);
         this.send(packer);
     };
-    /* Set the team of an bot. (-1 spectator team, 0 team red/normal team, 1 team blue) */
+    /** Set the team of an bot. (-1 spectator team, 0 team red/normal team, 1 team blue) */
     Game.prototype.SetTeam = function (team) {
         var packer = new MsgPacker_1.MsgPacker(NETMSGTYPE.CL_SETTEAM, false, 1);
         packer.AddInt(team);
         this.send(packer);
     };
-    /* Spectate an player, taking their id as parameter. pretty useless */
+    /** Spectate an player, taking their id as parameter. pretty useless */
     Game.prototype.SpectatorMode = function (SpectatorID) {
         var packer = new MsgPacker_1.MsgPacker(NETMSGTYPE.CL_SETSPECTATORMODE, false, 1);
         packer.AddInt(SpectatorID);
         this.send(packer);
     };
-    /* Change the player info */
+    /** Change the player info */
     Game.prototype.ChangePlayerInfo = function (playerInfo) {
         var packer = new MsgPacker_1.MsgPacker(NETMSGTYPE.CL_CHANGEINFO, false, 1);
         packer.AddString(playerInfo.name);
@@ -83,18 +83,18 @@ var Game = /** @class */ (function () {
         packer.AddInt(playerInfo.color_feet);
         this.send(packer);
     };
-    /* Kill */
+    /** Kill */
     Game.prototype.Kill = function () {
         var packer = new MsgPacker_1.MsgPacker(NETMSGTYPE.CL_KILL, false, 1);
         this.send(packer);
     };
-    /* Send emote */
+    /** Send emote */
     Game.prototype.Emote = function (emote) {
         var packer = new MsgPacker_1.MsgPacker(NETMSGTYPE.CL_EMOTICON, false, 1);
         packer.AddInt(emote);
         this.send(packer);
     };
-    /* Vote for an already running vote (f3 / f4) */
+    /** Vote for an already running vote (true = f3 /  false = f4) */
     Game.prototype.Vote = function (vote) {
         var packer = new MsgPacker_1.MsgPacker(NETMSGTYPE.CL_VOTE, false, 1);
         packer.AddInt(vote ? 1 : -1);
@@ -107,24 +107,24 @@ var Game = /** @class */ (function () {
         packer.AddString(Reason);
         this.send(packer);
     };
-    /* Call a vote for an server option (for example ddnet maps) */
+    /** Call a vote for an server option (for example ddnet maps) */
     Game.prototype.CallVoteOption = function (Value, Reason) {
         this.CallVote("option", Value, Reason);
     };
-    /* Call a vote to kick a player. Requires the player id */
+    /** Call a vote to kick a player. Requires the player id */
     Game.prototype.CallVoteKick = function (PlayerID, Reason) {
         this.CallVote("kick", PlayerID, Reason);
     };
-    /* Call a vote to set a player in spectator mode. Requires the player id */
+    /** Call a vote to set a player in spectator mode. Requires the player id */
     Game.prototype.CallVoteSpectate = function (PlayerID, Reason) {
         this.CallVote("spectate", PlayerID, Reason);
     };
-    /** probably some verification of using ddnet client.*/
+    /** probably some verification of using ddnet client. */
     Game.prototype.IsDDNetLegacy = function () {
         var packer = new MsgPacker_1.MsgPacker(NETMSGTYPE.CL_ISDDNETLEGACY, false, 1);
         this.send(packer);
     };
-    /* returns the ping in ms */
+    /** returns the ping in ms (as a promise) */
     Game.prototype.Ping = function () {
         var _this = this;
         return new Promise(function (resolve, reject) {