teeworlds 2.4.3 → 2.4.5

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);
 
 
 	}
@@ -348,7 +326,7 @@ export class Client extends EventEmitter {
 			chunk.msg = messageTypes[packet[0] & 1][chunk.msgid];
 			chunk.raw = packet.slice(1, chunk.bytes)
 			Object.values(messageUUIDs).forEach((a, i) => {
-				if (a.compare(packet.slice(0, 16)) == 0) {
+				if (a.byteLength >= 16 && a.compare(packet.slice(0, 16)) == 0) {
 					chunk.extended_msgid = a;
 					chunk.msg = Object.keys(messageUUIDs)[i];
 				}
@@ -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)
@@ -477,7 +459,7 @@ export class Client extends EventEmitter {
 		chunk.msg = messageTypes[packet[0]&1][chunk.msgid];
 		chunk.raw = packet.slice(1, chunk.bytes)
 		Object.values(messageUUIDs).forEach((a, i) => {
-			if (a.compare(packet.slice(0, 16)) === 0) {
+			if (a.byteLength >= 16 && a.compare(packet.slice(0, 16)) === 0) {
 				chunk.extended_msgid = a;
 				chunk.msg = Object.keys(messageUUIDs)[i];
 			}
@@ -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(() => {
@@ -543,10 +526,10 @@ export class Client extends EventEmitter {
 					return;
 				clearInterval(connectInterval)
 				
-				if (packet.toJSON().data[0] == 0x10) {
-					if (packet.toString().includes("TKEN") || packet.toJSON().data[3] == 0x2) {
+				if (packet[0] == 0x10) {
+					if (packet.toString().includes("TKEN") || packet[3] == 0x2) {
 						clearInterval(connectInterval);
-						this.TKEN = Buffer.from(packet.toJSON().data.slice(packet.toJSON().data.length - 4, packet.toJSON().data.length))
+						this.TKEN = packet.slice(-4)
 						this.SendControlMsg(3);
 						this.State = States.STATE_LOADING; // loading state
 						this.receivedSnaps = 0;
@@ -557,7 +540,7 @@ export class Client extends EventEmitter {
 
 						var client_version = new MsgPacker(0, true, 1);
 						client_version.AddBuffer(Buffer.from("8c00130484613e478787f672b3835bd4", 'hex'));
-						let randomUuid = Buffer.alloc(16);
+						let randomUuid = Buffer.allocUnsafe(16);
 
 						randomBytes(16).copy(randomUuid);
 
@@ -571,13 +554,13 @@ export class Client extends EventEmitter {
 						}
 		
 						this.SendMsgEx([client_version, info])
-					} else if (packet.toJSON().data[3] == 0x4) {
+					} else if (packet[3] == 0x4) {
 						// disconnected
 						this.State = States.STATE_OFFLINE;
-						let reason: string = (unpackString(packet.toJSON().data.slice(4)).result);
+						let reason: string = (unpackString(packet.slice(4)).result);
 						this.emit("disconnect", reason);
 					} 
-					if (packet.toJSON().data[3] !== 0x0) { // keepalive
+					if (packet[3] !== 0x0) { // keepalive
 						this.lastRecvTime = new Date().getTime();
 					}
 				} else {
@@ -611,8 +594,9 @@ export class Client extends EventEmitter {
 
 				})
 				this.sentChunkQueue.forEach((buff, i) => {
-					let chunk = this.MsgToChunk(buff);
-					if (chunk.flags & 1) {
+					let chunkFlags = (buff[0] >> 6) & 3;
+					if (chunkFlags & 1) {
+						let chunk = this.MsgToChunk(buff);
 						if (chunk.seq && chunk.seq >= this.ack)
 							this.sentChunkQueue.splice(i, 1);
 					} 
@@ -672,7 +656,7 @@ export class Client extends EventEmitter {
 						this.PredGameTick = this.AckGameTick + 1;
 
 					// snapChunks.forEach(chunk => {
-						let unpacker = new MsgUnpacker(chunk.raw.toJSON().data);
+						let unpacker = new MsgUnpacker(chunk.raw);
 			
 						let NumParts = 1;
 						let Part = 0;
@@ -682,12 +666,12 @@ export class Client extends EventEmitter {
 						let Crc = 0;
 						let CompleteSize = 0;
 
-						if (chunk.msg == "SNAP") {
+						if (chunk.msgid == NETMSG_Sys.NETMSG_SNAP) {
 							NumParts = unpacker.unpackInt();
 							Part = unpacker.unpackInt();
 						}	
 
-						if (chunk.msg != "SNAP_EMPTY") {
+						if (chunk.msgid != NETMSG_Sys.NETMSG_SNAPEMPTY) {
 							Crc = unpacker.unpackInt();
 							PartSize = unpacker.unpackInt();
 						}
@@ -703,7 +687,7 @@ export class Client extends EventEmitter {
 							}
 
 							// chunk.raw = Buffer.from(unpacker.remaining);
-							this.snaps[Part] = Buffer.from(unpacker.remaining);
+							this.snaps[Part] = unpacker.remaining;
 
 							this.SnapshotParts |= 1 << Part;
 							
@@ -711,9 +695,9 @@ export class Client extends EventEmitter {
 								let mergedSnaps = Buffer.concat(this.snaps);
 								this.SnapshotParts = 0;
 
-								let snapUnpacked = this.SnapUnpacker.unpackSnapshot(mergedSnaps.toJSON().data, DeltaTick, GameTick, Crc);
+								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;
@@ -736,7 +720,7 @@ export class Client extends EventEmitter {
 						if (chunk.msgid == NETMSG_Game.SV_VOTECLEAROPTIONS) {
 							this.VoteList = [];
 						} else if (chunk.msgid == NETMSG_Game.SV_VOTEOPTIONLISTADD) {
-							let unpacker = new MsgUnpacker(chunk.raw.toJSON().data)
+							let unpacker = new MsgUnpacker(chunk.raw)
 							let NumOptions = unpacker.unpackInt()
 							let list: string[] = [];
 							for (let i = 0; i < 15; i++) {
@@ -746,11 +730,11 @@ export class Client extends EventEmitter {
 
 							this.VoteList.push(...list);
 						} else if (chunk.msgid == NETMSG_Game.SV_VOTEOPTIONADD) {
-							let unpacker = new MsgUnpacker(chunk.raw.toJSON().data)
+							let unpacker = new MsgUnpacker(chunk.raw)
 							
 							this.VoteList.push(unpacker.unpackString());
 						} else if (chunk.msgid == NETMSG_Game.SV_VOTEOPTIONREMOVE) {
-							let unpacker = new MsgUnpacker(chunk.raw.toJSON().data)
+							let unpacker = new MsgUnpacker(chunk.raw)
 							
 							let index = this.VoteList.indexOf(unpacker.unpackString());
 
@@ -761,7 +745,7 @@ export class Client extends EventEmitter {
 
 						// events
 						if (chunk.msgid == NETMSG_Game.SV_EMOTICON) {
-							let unpacker = new MsgUnpacker(chunk.raw.toJSON().data);
+							let unpacker = new MsgUnpacker(chunk.raw);
 							let unpacked = {
 								client_id: unpacker.unpackInt(),
 								emoticon: unpacker.unpackInt()
@@ -769,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)
@@ -778,11 +762,11 @@ export class Client extends EventEmitter {
 							
 
 						} else if (chunk.msgid == NETMSG_Game.SV_BROADCAST) {
-							let unpacker = new MsgUnpacker(chunk.raw.toJSON().data);
+							let unpacker = new MsgUnpacker(chunk.raw);
 
 							this.emit("broadcast", unpacker.unpackString());
 						} if (chunk.msgid == NETMSG_Game.SV_CHAT) {
-							let unpacker = new MsgUnpacker(chunk.raw.toJSON().data);
+							let unpacker = new MsgUnpacker(chunk.raw);
 							let unpacked: iMessage = {
 								team: unpacker.unpackInt(),
 								client_id: unpacker.unpackInt(),
@@ -791,27 +775,27 @@ 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)
 						} else if (chunk.msgid == NETMSG_Game.SV_KILLMSG) {
 							let unpacked: iKillMsg = {} as iKillMsg;
-							let unpacker = new MsgUnpacker(chunk.raw.toJSON().data);
+							let unpacker = new MsgUnpacker(chunk.raw);
 							unpacked.killer_id = unpacker.unpackInt();
 							unpacked.victim_id = unpacker.unpackInt();
 							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.toJSON().data);
+							let unpacker = new MsgUnpacker(chunk.raw);
 							let message = unpacker.unpackString();
 							this.emit("motd", message);
 						}
@@ -833,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;
 
@@ -843,30 +828,27 @@ export class Client extends EventEmitter {
 		inputMsg.AddInt(this.PredGameTick);
 		inputMsg.AddInt(40);
 
-		let input_data = [
-
-			input.m_Direction,
-			input.m_TargetX,
-			input.m_TargetY,
-			input.m_Jump,
-			input.m_Fire,
-			input.m_Hook,
-			input.m_PlayerFlags,
-			input.m_WantedWeapon,
-			input.m_NextWeapon,
-			input.m_PrevWeapon
-		]
-		input_data.forEach(a => {
-			inputMsg.AddInt(a);
-		});
+		inputMsg.AddInt(input.m_Direction)
+		inputMsg.AddInt(input.m_TargetX)
+		inputMsg.AddInt(input.m_TargetY)
+		inputMsg.AddInt(input.m_Jump)
+		inputMsg.AddInt(input.m_Fire)
+		inputMsg.AddInt(input.m_Hook)
+		inputMsg.AddInt(input.m_PlayerFlags)
+		inputMsg.AddInt(input.m_WantedWeapon)
+		inputMsg.AddInt(input.m_NextWeapon)
+		inputMsg.AddInt(input.m_PrevWeapon)
+		
 		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);
@@ -878,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) {

package/lib/components/game.ts

@@ -1,5 +1,6 @@
 
 import { MsgPacker } from "../MsgPacker";
+import { PlayerInput, PlayerInfo, Projectile, Laser, Pickup, Flag, GameInfo, GameData, CharacterCore, Character, ClientInfo, SpectatorInfo, Common, Explosion, Spawn, HammerHit, Death, SoundGlobal, SoundWorld, DamageInd } from "../snapshots";
 
 import { Client } from "../client";
 enum NETMSGTYPE { EX, SV_MOTD, SV_BROADCAST, SV_CHAT, SV_KILLMSG, SV_SOUNDGLOBAL, SV_TUNEPARAMS, SV_EXTRAPROJECTILE, SV_READYTOENTER, SV_WEAPONPICKUP, SV_EMOTICON, SV_VOTECLEAROPTIONS, SV_VOTEOPTIONLISTADD, SV_VOTEOPTIONADD, SV_VOTEOPTIONREMOVE, SV_VOTESET, SV_VOTESTATUS, CL_SAY, CL_SETTEAM, CL_SETSPECTATORMODE, CL_STARTINFO, CL_CHANGEINFO, CL_KILL, CL_EMOTICON, CL_VOTE, CL_CALLVOTE, CL_ISDDNETLEGACY, SV_DDRACETIMELEGACY, SV_RECORDLEGACY, UNUSED, SV_TEAMSSTATELEGACY, CL_SHOWOTHERSLEGACY, NUM };
@@ -29,23 +30,26 @@ export class Game {
 		this.send(packer);
 	}
 
-	/* Set the team of an bot. (-1 spectator team, 0 team red/normal team, 1 team blue) */
-	SetTeam(team: number) {
+	
+	/** Set the team of an bot. (-1 spectator team, 0 team red/normal team, 1 team blue) */
+	SetTeam(team: number) { 
 		var packer = new MsgPacker(NETMSGTYPE.CL_SETTEAM, false, 1);
 		packer.AddInt(team);
 		this.send(packer);
 	}
 	
-	/* Spectate an player, taking their id as parameter. pretty useless */
-	SpectatorMode(SpectatorID: number) {
+	
+	/** Spectate an player, taking their id as parameter. pretty useless */
+	SpectatorMode(SpectatorID: number) { 
 		var packer = new MsgPacker(NETMSGTYPE.CL_SETSPECTATORMODE, false, 1);
 		packer.AddInt(SpectatorID);
 		this.send(packer);
 	}
 
 	
-	/* Change the player info */
-	ChangePlayerInfo(playerInfo: ClientInfo) {
+	
+	/** Change the player info */
+	ChangePlayerInfo(playerInfo: ClientInfo) { 
 		var packer = new MsgPacker(NETMSGTYPE.CL_CHANGEINFO, false, 1);
 		packer.AddString(playerInfo.name); 
 		packer.AddString(playerInfo.clan); 
@@ -57,21 +61,24 @@ export class Game {
 		this.send(packer);
 	}
 
-	/* Kill */
-	Kill() {
+	
+	/** Kill */
+	Kill() { 
 		var packer = new MsgPacker(NETMSGTYPE.CL_KILL, false, 1);
 		this.send(packer);
 	}
 
-	/* Send emote */
-	Emote(emote: number) {
+	
+	/** Send emote */
+	Emote(emote: number) { 
 		var packer = new MsgPacker(NETMSGTYPE.CL_EMOTICON, false, 1);
 		packer.AddInt(emote);
 		this.send(packer);
 	}
 
-	/* Vote for an already running vote (f3 / f4) */
-	Vote(vote: boolean) {
+	
+	/** Vote for an already running vote (true = f3 /  false = f4) */
+	Vote(vote: boolean) { 
 		var packer = new MsgPacker(NETMSGTYPE.CL_VOTE, false, 1);
 		packer.AddInt(vote ? 1 : -1);
 		this.send(packer);
@@ -84,27 +91,32 @@ export class Game {
 		packer.AddString(Reason);
 		this.send(packer);
 	}
-	/* Call a vote for an server option (for example ddnet maps) */
-	CallVoteOption(Value: string, Reason: string) {
+	
+	/** Call a vote for an server option (for example ddnet maps) */
+	CallVoteOption(Value: string, Reason: string) { 
 		this.CallVote("option", Value, Reason)
 	}
-	/* Call a vote to kick a player. Requires the player id */
-	CallVoteKick(PlayerID: string|number, Reason: string) {
+	
+	/** Call a vote to kick a player. Requires the player id */
+	CallVoteKick(PlayerID: string|number, Reason: string) { 
 		this.CallVote("kick", PlayerID, Reason)
 	}
-	/* Call a vote to set a player in spectator mode. Requires the player id */
-	CallVoteSpectate(PlayerID: string|number, Reason: string) {
+	
+	/** Call a vote to set a player in spectator mode. Requires the player id */
+	CallVoteSpectate(PlayerID: string|number, Reason: string) { 
 		this.CallVote("spectate", PlayerID, Reason)
 	}
 
 
-	/** probably some verification of using ddnet client.*/
+	
+	/** probably some verification of using ddnet client. */
 	IsDDNetLegacy() { 
 		var packer = new MsgPacker(NETMSGTYPE.CL_ISDDNETLEGACY, false, 1);
 		this.send(packer);
 	}
-	/* returns the ping in ms */
-	Ping(): Promise<number> {
+	
+	/** returns the ping in ms (as a promise) */
+	Ping(): Promise<number> { 
 		return new Promise((resolve, reject) => {
 			var packer = new MsgPacker(22, true, 0);
 			let startTime = new Date().getTime();