teeworlds 2.4.4 → 2.4.5

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();

package/lib/components/snapshot.js

@@ -0,0 +1,200 @@
+"use strict";
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SnapshotWrapper = void 0;
+var stream_1 = require("stream");
+var items;
+(function (items) {
+    items[items["OBJ_EX"] = 0] = "OBJ_EX";
+    items[items["OBJ_PLAYER_INPUT"] = 1] = "OBJ_PLAYER_INPUT";
+    items[items["OBJ_PROJECTILE"] = 2] = "OBJ_PROJECTILE";
+    items[items["OBJ_LASER"] = 3] = "OBJ_LASER";
+    items[items["OBJ_PICKUP"] = 4] = "OBJ_PICKUP";
+    items[items["OBJ_FLAG"] = 5] = "OBJ_FLAG";
+    items[items["OBJ_GAME_INFO"] = 6] = "OBJ_GAME_INFO";
+    items[items["OBJ_GAME_DATA"] = 7] = "OBJ_GAME_DATA";
+    items[items["OBJ_CHARACTER_CORE"] = 8] = "OBJ_CHARACTER_CORE";
+    items[items["OBJ_CHARACTER"] = 9] = "OBJ_CHARACTER";
+    items[items["OBJ_PLAYER_INFO"] = 10] = "OBJ_PLAYER_INFO";
+    items[items["OBJ_CLIENT_INFO"] = 11] = "OBJ_CLIENT_INFO";
+    items[items["OBJ_SPECTATOR_INFO"] = 12] = "OBJ_SPECTATOR_INFO";
+    items[items["EVENT_COMMON"] = 13] = "EVENT_COMMON";
+    items[items["EVENT_EXPLOSION"] = 14] = "EVENT_EXPLOSION";
+    items[items["EVENT_SPAWN"] = 15] = "EVENT_SPAWN";
+    items[items["EVENT_HAMMERHIT"] = 16] = "EVENT_HAMMERHIT";
+    items[items["EVENT_DEATH"] = 17] = "EVENT_DEATH";
+    items[items["EVENT_SOUND_GLOBAL"] = 18] = "EVENT_SOUND_GLOBAL";
+    items[items["EVENT_SOUND_WORLD"] = 19] = "EVENT_SOUND_WORLD";
+    items[items["EVENT_DAMAGE_INDICATOR"] = 20] = "EVENT_DAMAGE_INDICATOR";
+})(items || (items = {}));
+var SnapshotWrapper = /** @class */ (function (_super) {
+    __extends(SnapshotWrapper, _super);
+    function SnapshotWrapper(_client) {
+        var _this = 
+        // this.SendMsgEx = callback;
+        _super.call(this) || this;
+        _this._client = _client;
+        return _this;
+    }
+    SnapshotWrapper.prototype.getParsed = function (type_id, id) {
+        var _a;
+        return (_a = this._client.rawSnapUnpacker.deltas.find(function (delta) { return delta.type_id == type_id && delta.id == id; })) === null || _a === void 0 ? void 0 : _a.parsed;
+    };
+    SnapshotWrapper.prototype.getAll = function (type_id) {
+        var _all = [];
+        this._client.rawSnapUnpacker.deltas.forEach(function (delta) {
+            if (delta.type_id == type_id)
+                _all.push(delta.parsed);
+        });
+        return _all;
+        // return this._client.rawSnapUnpacker.deltas.filter(delta => delta.type_id == type_id && delta.id == id).map(a => a.parsed);
+    };
+    SnapshotWrapper.prototype.getObjPlayerInput = function (player_id) {
+        return this.getParsed(items.OBJ_PLAYER_INPUT, player_id);
+    };
+    Object.defineProperty(SnapshotWrapper.prototype, "AllObjPlayerInput", {
+        get: function () {
+            return this.getAll(items.OBJ_PLAYER_INPUT);
+        },
+        enumerable: false,
+        configurable: true
+    });
+    SnapshotWrapper.prototype.getObjProjectile = function (id) {
+        return this.getParsed(items.OBJ_PROJECTILE, id);
+    };
+    Object.defineProperty(SnapshotWrapper.prototype, "AllProjectiles", {
+        get: function () {
+            return this.getAll(items.OBJ_PROJECTILE);
+        },
+        enumerable: false,
+        configurable: true
+    });
+    SnapshotWrapper.prototype.getObjLaser = function (id) {
+        return this.getParsed(items.OBJ_LASER, id);
+    };
+    Object.defineProperty(SnapshotWrapper.prototype, "AllObjLaser", {
+        get: function () {
+            return this.getAll(items.OBJ_LASER);
+        },
+        enumerable: false,
+        configurable: true
+    });
+    SnapshotWrapper.prototype.getObjPickup = function (id) {
+        return this.getParsed(items.OBJ_PICKUP, id);
+    };
+    Object.defineProperty(SnapshotWrapper.prototype, "AllObjPickup", {
+        get: function () {
+            return this.getAll(items.OBJ_PICKUP);
+        },
+        enumerable: false,
+        configurable: true
+    });
+    SnapshotWrapper.prototype.getObjFlag = function (id) {
+        return this.getParsed(items.OBJ_FLAG, id);
+    };
+    Object.defineProperty(SnapshotWrapper.prototype, "AllObjFlag", {
+        get: function () {
+            return this.getAll(items.OBJ_FLAG);
+        },
+        enumerable: false,
+        configurable: true
+    });
+    SnapshotWrapper.prototype.getObjGameInfo = function (id) {
+        return this.getParsed(items.OBJ_GAME_INFO, id);
+    };
+    Object.defineProperty(SnapshotWrapper.prototype, "AllObjGameInfo", {
+        get: function () {
+            return this.getAll(items.OBJ_GAME_INFO);
+        },
+        enumerable: false,
+        configurable: true
+    });
+    SnapshotWrapper.prototype.getObjGameData = function (id) {
+        return this.getParsed(items.OBJ_GAME_DATA, id);
+    };
+    Object.defineProperty(SnapshotWrapper.prototype, "AllObjGameData", {
+        get: function () {
+            return this.getAll(items.OBJ_GAME_DATA);
+        },
+        enumerable: false,
+        configurable: true
+    });
+    /** NOTICE: x & y positions always differ from the positions in the ingame debug menu. If you want the debug menu positions, you can calculate them like this: Math.round((myChar.character_core.x / 32) * 100)/100 */
+    SnapshotWrapper.prototype.getObjCharacterCore = function (player_id) {
+        return this.getParsed(items.OBJ_CHARACTER_CORE, player_id);
+    };
+    Object.defineProperty(SnapshotWrapper.prototype, "AllObjCharacterCore", {
+        /** NOTICE: x & y positions always differ from the positions in the ingame debug menu. If you want the debug menu positions, you can calculate them like this: Math.round((myChar.character_core.x / 32) * 100)/100 */
+        get: function () {
+            return this.getAll(items.OBJ_CHARACTER_CORE);
+        },
+        enumerable: false,
+        configurable: true
+    });
+    /** NOTICE: x & y positions always differ from the positions in the ingame debug menu. If you want the debug menu positions, you can calculate them like this: Math.round((myChar.character_core.x / 32) * 100)/100 */
+    SnapshotWrapper.prototype.getObjCharacter = function (player_id) {
+        return this.getParsed(items.OBJ_CHARACTER, player_id);
+    };
+    Object.defineProperty(SnapshotWrapper.prototype, "AllObjCharacter", {
+        /** NOTICE: x & y positions always differ from the positions in the ingame debug menu. If you want the debug menu positions, you can calculate them like this: Math.round((myChar.character_core.x / 32) * 100)/100 */
+        get: function () {
+            return this.getAll(items.OBJ_CHARACTER);
+        },
+        enumerable: false,
+        configurable: true
+    });
+    SnapshotWrapper.prototype.getObjPlayerInfo = function (player_id) {
+        return this.getParsed(items.OBJ_PLAYER_INFO, player_id);
+    };
+    Object.defineProperty(SnapshotWrapper.prototype, "AllObjPlayerInfo", {
+        get: function () {
+            return this.getAll(items.OBJ_PLAYER_INFO);
+        },
+        enumerable: false,
+        configurable: true
+    });
+    SnapshotWrapper.prototype.getObjClientInfo = function (player_id) {
+        return this.getParsed(items.OBJ_CLIENT_INFO, player_id);
+    };
+    Object.defineProperty(SnapshotWrapper.prototype, "AllObjClientInfo", {
+        get: function () {
+            return this.getAll(items.OBJ_CLIENT_INFO);
+        },
+        enumerable: false,
+        configurable: true
+    });
+    SnapshotWrapper.prototype.getObjSpectatorInfo = function (player_id) {
+        return this.getParsed(items.OBJ_SPECTATOR_INFO, player_id);
+    };
+    Object.defineProperty(SnapshotWrapper.prototype, "AllObjSpectatorInfo", {
+        get: function () {
+            return this.getAll(items.OBJ_SPECTATOR_INFO);
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(SnapshotWrapper.prototype, "OwnID", {
+        get: function () {
+            var _a;
+            return (_a = this.AllObjPlayerInfo.find(function (parsed) { return parsed.local; })) === null || _a === void 0 ? void 0 : _a.client_id;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    return SnapshotWrapper;
+}(stream_1.EventEmitter));
+exports.SnapshotWrapper = SnapshotWrapper;

package/lib/components/snapshot.ts

@@ -0,0 +1,174 @@
+
+import { Client } from "../client";
+import { EventEmitter } from "stream";
+import { PlayerInput, PlayerInfo, Projectile, Laser, Pickup, Flag, GameInfo, GameData, CharacterCore, Character, ClientInfo, SpectatorInfo, Common, Explosion, Spawn, HammerHit, Death, SoundGlobal, SoundWorld, DamageInd } from "../snapshots";
+
+enum items {
+	OBJ_EX,
+	OBJ_PLAYER_INPUT,
+	OBJ_PROJECTILE,
+	OBJ_LASER,
+	OBJ_PICKUP,
+	OBJ_FLAG,
+	OBJ_GAME_INFO,
+	OBJ_GAME_DATA,
+	OBJ_CHARACTER_CORE,
+	OBJ_CHARACTER,
+	OBJ_PLAYER_INFO,
+	OBJ_CLIENT_INFO,
+	OBJ_SPECTATOR_INFO,
+	EVENT_COMMON,
+	EVENT_EXPLOSION,
+	EVENT_SPAWN,
+	EVENT_HAMMERHIT,
+	EVENT_DEATH,
+	EVENT_SOUND_GLOBAL,
+	EVENT_SOUND_WORLD,
+	EVENT_DAMAGE_INDICATOR
+}
+export declare interface SnapshotWrapper {
+	
+
+	// on(event: 'connected', listener: () => void): this;
+	// on(event: 'disconnect', listener: (reason: string) => void): this;
+
+	// on(event: 'emote', listener: (message: iEmoticon) => void): this;
+	// on(event: 'message', listener: (message: iMessage) => void): this;
+	// on(event: 'broadcast', listener: (message: string) => void): this;
+	// on(event: 'kill', listener: (kill: iKillMsg) => void): this;
+	// on(event: 'motd', listener: (message: string) => void): this;
+	
+	on(event: 'common', listener: (common: Common) => void): this;
+	on(event: 'explosion', listener: (explosion: Explosion) => void): this;
+	on(event: 'spawn', listener: (spawn: Spawn) => void): this;
+	on(event: 'hammerhit', listener: (hammerhit: HammerHit) => void): this;
+	on(event: 'death', listener: (death: Death) => void): this;
+	on(event: 'sound_global', listener: (sound_global: SoundGlobal) => void): this;
+	on(event: 'sound_world', listener: (sound_world: SoundWorld) => void): this;
+	on(event: 'damage_indicator', listener: (damage_indicator: DamageInd) => void): this;
+
+}
+
+export class SnapshotWrapper extends EventEmitter {
+	private _client: Client;
+	constructor(_client: Client) {
+		// this.SendMsgEx = callback;
+		super();
+		this._client = _client;
+	}
+	
+	private getParsed<T>(type_id: number, id: number) {
+		return this._client.rawSnapUnpacker.deltas.find(delta => delta.type_id == type_id && delta.id == id)?.parsed as unknown as T;
+	}
+
+	private getAll<T>(type_id: number): T[] {
+		let _all: T[] = [];
+
+		this._client.rawSnapUnpacker.deltas.forEach(delta => {
+			if (delta.type_id == type_id)
+				_all.push(delta.parsed as T);
+		})
+
+
+		return _all;
+		// return this._client.rawSnapUnpacker.deltas.filter(delta => delta.type_id == type_id && delta.id == id).map(a => a.parsed);
+	}
+
+	getObjPlayerInput(player_id: number): PlayerInput | undefined {
+		return this.getParsed(items.OBJ_PLAYER_INPUT, player_id);
+	}
+
+	get AllObjPlayerInput(): PlayerInput[] {
+		return this.getAll(items.OBJ_PLAYER_INPUT);
+	}
+
+	getObjProjectile(id: number): Projectile | undefined {
+		return this.getParsed(items.OBJ_PROJECTILE, id);
+	}
+	get AllProjectiles(): Projectile[] {
+		return this.getAll(items.OBJ_PROJECTILE);
+	}
+
+	getObjLaser(id: number): Laser | undefined {
+		return this.getParsed(items.OBJ_LASER, id);
+	}
+	get AllObjLaser(): Laser[] {
+		return this.getAll(items.OBJ_LASER);
+	}
+	
+	getObjPickup(id: number): Pickup | undefined {
+		return this.getParsed(items.OBJ_PICKUP, id);
+	}
+	get AllObjPickup(): Pickup[] {
+		return this.getAll(items.OBJ_PICKUP);
+	}
+	
+	getObjFlag(id: number): Flag | undefined {
+		return this.getParsed(items.OBJ_FLAG, id);
+	}
+	get AllObjFlag(): Flag[] {
+		return this.getAll(items.OBJ_FLAG);
+	}
+	
+	getObjGameInfo(id: number): GameInfo | undefined {
+		return this.getParsed(items.OBJ_GAME_INFO, id);
+	}
+	get AllObjGameInfo(): GameInfo[] {
+		return this.getAll(items.OBJ_GAME_INFO);
+	}
+
+	getObjGameData(id: number): GameData | undefined {
+		return this.getParsed(items.OBJ_GAME_DATA, id);
+	}
+	get AllObjGameData(): GameData[] {
+		return this.getAll(items.OBJ_GAME_DATA);
+	}
+	
+	/** NOTICE: x & y positions always differ from the positions in the ingame debug menu. If you want the debug menu positions, you can calculate them like this: Math.round((myChar.character_core.x / 32) * 100)/100 */
+	getObjCharacterCore(player_id: number): CharacterCore | undefined { 
+		return this.getParsed(items.OBJ_CHARACTER_CORE, player_id);
+	}
+	/** NOTICE: x & y positions always differ from the positions in the ingame debug menu. If you want the debug menu positions, you can calculate them like this: Math.round((myChar.character_core.x / 32) * 100)/100 */
+	get AllObjCharacterCore(): CharacterCore[] { 
+		return this.getAll(items.OBJ_CHARACTER_CORE);
+	}
+
+	/** NOTICE: x & y positions always differ from the positions in the ingame debug menu. If you want the debug menu positions, you can calculate them like this: Math.round((myChar.character_core.x / 32) * 100)/100 */
+	getObjCharacter(player_id: number): Character | undefined { 
+		return this.getParsed(items.OBJ_CHARACTER, player_id);
+	}
+	/** NOTICE: x & y positions always differ from the positions in the ingame debug menu. If you want the debug menu positions, you can calculate them like this: Math.round((myChar.character_core.x / 32) * 100)/100 */
+	get AllObjCharacter(): Character[] { 
+		
+		return this.getAll(items.OBJ_CHARACTER);
+	}
+	
+	getObjPlayerInfo(player_id: number): PlayerInfo | undefined {
+		return this.getParsed(items.OBJ_PLAYER_INFO, player_id);
+	}
+	get AllObjPlayerInfo(): PlayerInfo[] {
+		return this.getAll(items.OBJ_PLAYER_INFO);
+	}
+	
+	getObjClientInfo(player_id: number): ClientInfo | undefined {
+		return this.getParsed(items.OBJ_CLIENT_INFO, player_id);
+	}
+	get AllObjClientInfo(): ClientInfo[] {
+		return this.getAll(items.OBJ_CLIENT_INFO);
+	}
+	
+	getObjSpectatorInfo(player_id: number): SpectatorInfo | undefined {
+		return this.getParsed(items.OBJ_SPECTATOR_INFO, player_id);
+	}
+	get AllObjSpectatorInfo(): SpectatorInfo[] {
+		return this.getAll(items.OBJ_SPECTATOR_INFO);
+	}
+
+
+	get OwnID(): number | undefined {
+		return this.AllObjPlayerInfo.find(parsed => parsed.local)?.client_id;
+	}
+
+
+
+}