pw-js-world 0.0.1

package/dist/Player.d.ts

@@ -0,0 +1,222 @@
+import type { ProtoGen } from "pw-js-api";
+import type { Point } from "./types";
+export interface IPlayer {
+    /**
+     * ID of the player.
+     */
+    playerId: number;
+    /**
+     * ID of the player's account.
+     */
+    accountId: string;
+    /**
+     * Name of the player.
+     */
+    username: string;
+    /**
+     * ID of the player's equipped smiley.
+     */
+    face: number;
+    /**
+     * String, could be an admin or developer.
+     */
+    role: string;
+    /**
+     * If player is bot user's friend.
+     */
+    isFriend: boolean;
+    /**
+     * Position of the user.
+     *
+     * Note: This helper does not simulate physics so positions will always be inaccurate.
+     */
+    position?: Point;
+    /**
+     * If player is the world owner.
+     */
+    isWorldOwner: boolean;
+    /**
+     * Rights
+     */
+    rights: IPlayerRights;
+    /**
+     * current world state.
+     */
+    states: IPlayerWorldState;
+    /**
+     * List of active effects the player has.
+     */
+    effects: PlayerEffect[];
+    /**
+     * If this player is the bot.
+     */
+    isMe: boolean;
+}
+export interface IPlayerRights {
+    /**
+     * If the player has edit rights.
+     */
+    canEdit: boolean;
+    /**
+     * If the player has god rights.
+     */
+    canGod: boolean;
+    /**
+     * If the player has the ability to toggle minimap.
+     */
+    canToggleMinimap: boolean;
+    /**
+     * If the player has the ability to change the world settings.
+     */
+    canChangeWorldSettings: boolean;
+    /**
+     * List of commands (string) the player can use.
+     */
+    availableCommands: string[];
+}
+export interface IPlayerWorldState {
+    /**
+     * Number of gold coins the player has.
+     */
+    coinsGold: number;
+    /**
+     * Number of blue coins the player has.
+     */
+    coinsBlue: number;
+    /**
+     * Number of times the player died.
+     */
+    deaths: number;
+    /**
+     * Coordinates of collected coins?
+     */
+    collectedItems: Point[];
+    /**
+     * If player has gold crown on.
+     */
+    hasGoldCrown: boolean;
+    /**
+     * If player has won the world.
+     */
+    hasSilverCrown: boolean;
+    /**
+     * Zero indexed, map of the player's switch state.
+     */
+    switches: boolean[];
+    /**
+     * If player is in god mode right now.
+     */
+    godmode: boolean;
+    /**
+     * If player is in mod mode right now.
+     */
+    modmode: boolean;
+    /**
+     * ID of the team the player is associated with right now.
+     */
+    teamId: number;
+}
+export interface IPlayerEffect {
+    /**
+     * The ID of the effect.
+     */
+    effectId: number;
+    /**
+     * If applicable, the duration of the effect.
+     */
+    duration?: number;
+    /**
+     * If applicable, the strength of the effect. (For example speed or multi jump effect)
+     */
+    strength?: number;
+}
+export default class Player {
+    /**
+     * ID of the player.
+     */
+    playerId: number;
+    /**
+     * ID of the player's account.
+     */
+    accountId: string;
+    /**
+     * Name of the player.
+     */
+    username: string;
+    /**
+     * ID of the player's equipped smiley.
+     */
+    face: number;
+    /**
+     * String, could be an admin or developer.
+     */
+    role: string;
+    /**
+     * If player is bot user's friend.
+     */
+    isFriend: boolean;
+    /**
+     * Position of the user.
+     *
+     * Note: This helper does not simulate physics so positions will always be inaccurate.
+     */
+    position?: Point;
+    /**
+     * If player is the world owner.
+     */
+    isWorldOwner: boolean;
+    /**
+     * Rights
+     */
+    rights: IPlayerRights;
+    /**
+     * current world state.
+     */
+    states: IPlayerWorldState;
+    /**
+     * List of active effects the player has.
+     */
+    effects: PlayerEffect[];
+    /**
+     * If this player is the bot.
+     */
+    isMe: boolean;
+    constructor(props: ProtoGen.PlayerProperties, states?: IPlayerWorldState | boolean);
+    /**
+     * This is destructive, this is only for on reset packet.
+     */
+    resetState(): void;
+    /**
+     * Destructive.
+     */
+    resetRights(): void;
+}
+export declare class PlayerEffect {
+    /**
+     * The ID of the effect.
+     */
+    effectId: number;
+    /**
+     * If applicable, the duration of the effect.
+     */
+    duration?: number;
+    /**
+     * If applicable, the strength of the effect. (For example speed or multi jump effect)
+     */
+    strength?: number;
+    /**
+     * The time the effect occurred.
+     */
+    triggeredAt: number;
+    constructor(effect: IPlayerEffect, triggeredAt?: number);
+    /**
+     * Note: If this effect is non timed, this will always return false.
+     */
+    get hasExpired(): boolean;
+    /**
+     * Milliseconds showing how long before this expires.
+     *
+     * Note: If this effect is non timed, this will return infinity.
+     */
+    get remaining(): number;
+}

package/dist/Player.js

@@ -0,0 +1,110 @@
+export default class Player {
+    constructor(props, states) {
+        /**
+         * List of active effects the player has.
+         */
+        this.effects = [];
+        /**
+         * If this player is the bot.
+         */
+        this.isMe = false;
+        this.accountId = props.accountId;
+        this.face = props.face;
+        this.isFriend = props.isFriend;
+        this.isWorldOwner = props.isWorldOwner;
+        this.playerId = props.playerId;
+        this.position = props.position ? {
+            x: props.position.x,
+            y: props.position.y
+        } : undefined;
+        if (!props.rights)
+            this.resetRights();
+        else
+            this.rights = {
+                availableCommands: props.rights.availableCommands,
+                canChangeWorldSettings: props.rights.canChangeWorldSettings,
+                canEdit: props.rights.canEdit,
+                canGod: props.rights.canGod,
+                canToggleMinimap: props.rights.canToggleMinimap,
+            };
+        this.role = props.role;
+        this.username = props.username;
+        if (typeof states === "boolean") {
+            this.isMe = states;
+            states = undefined;
+        }
+        if (!states) {
+            // Could be bot via init that don't get states.
+            this.resetState();
+        }
+        else
+            this.states = {
+                coinsBlue: states.coinsBlue,
+                coinsGold: states.coinsGold,
+                collectedItems: states.collectedItems.map(v => ({ x: v.x, y: v.y })),
+                deaths: states.deaths,
+                godmode: states.godmode,
+                hasGoldCrown: states.hasGoldCrown,
+                hasSilverCrown: states.hasSilverCrown,
+                modmode: states.modmode,
+                switches: states.switches,
+                teamId: states.teamId,
+            };
+    }
+    /**
+     * This is destructive, this is only for on reset packet.
+     */
+    resetState() {
+        this.states = {
+            coinsBlue: 0,
+            coinsGold: 0,
+            collectedItems: [],
+            deaths: 0,
+            godmode: false,
+            hasGoldCrown: false,
+            hasSilverCrown: false,
+            modmode: false,
+            switches: new Array(1000).fill(false),
+            teamId: 0,
+        };
+    }
+    /**
+     * Destructive.
+     */
+    resetRights() {
+        this.rights = {
+            availableCommands: [],
+            canChangeWorldSettings: false,
+            canEdit: false,
+            canGod: false,
+            canToggleMinimap: false
+        };
+    }
+}
+export class PlayerEffect {
+    constructor(effect, triggeredAt) {
+        this.effectId = effect.effectId;
+        this.duration = effect.duration;
+        this.strength = effect.strength;
+        this.triggeredAt = triggeredAt !== null && triggeredAt !== void 0 ? triggeredAt : Date.now();
+    }
+    /**
+     * Note: If this effect is non timed, this will always return false.
+     */
+    get hasExpired() {
+        if (this.duration === undefined)
+            return false;
+        return Date.now() > (this.triggeredAt + this.duration);
+    }
+    /**
+     * Milliseconds showing how long before this expires.
+     *
+     * Note: If this effect is non timed, this will return infinity.
+     */
+    get remaining() {
+        if (this.duration === undefined)
+            return Infinity;
+        return Math.max(0, Date.now() - (this.triggeredAt + this.duration));
+    }
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiUGxheWVyLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vbGliL1BsYXllci50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUEySUEsTUFBTSxDQUFDLE9BQU8sT0FBTyxNQUFNO0lBc0R2QixZQUFZLEtBQWdDLEVBQUUsTUFBb0M7UUFWbEY7O1dBRUc7UUFDSCxZQUFPLEdBQWtCLEVBQUUsQ0FBQztRQUU1Qjs7V0FFRztRQUNILFNBQUksR0FBWSxLQUFLLENBQUM7UUFHbEIsSUFBSSxDQUFDLFNBQVMsR0FBRyxLQUFLLENBQUMsU0FBUyxDQUFDO1FBQ2pDLElBQUksQ0FBQyxJQUFJLEdBQUcsS0FBSyxDQUFDLElBQUksQ0FBQztRQUN2QixJQUFJLENBQUMsUUFBUSxHQUFHLEtBQUssQ0FBQyxRQUFRLENBQUM7UUFDL0IsSUFBSSxDQUFDLFlBQVksR0FBRyxLQUFLLENBQUMsWUFBWSxDQUFDO1FBQ3ZDLElBQUksQ0FBQyxRQUFRLEdBQUcsS0FBSyxDQUFDLFFBQVEsQ0FBQztRQUMvQixJQUFJLENBQUMsUUFBUSxHQUFHLEtBQUssQ0FBQyxRQUFRLENBQUMsQ0FBQyxDQUFDO1lBQzdCLENBQUMsRUFBRSxLQUFLLENBQUMsUUFBUSxDQUFDLENBQUM7WUFDbkIsQ0FBQyxFQUFFLEtBQUssQ0FBQyxRQUFRLENBQUMsQ0FBQztTQUN0QixDQUFDLENBQUMsQ0FBQyxTQUFTLENBQUM7UUFFZCxJQUFJLENBQUMsS0FBSyxDQUFDLE1BQU07WUFBRSxJQUFJLENBQUMsV0FBVyxFQUFFLENBQUM7O1lBQ2pDLElBQUksQ0FBQyxNQUFNLEdBQUc7Z0JBQ2YsaUJBQWlCLEVBQUUsS0FBSyxDQUFDLE1BQU0sQ0FBQyxpQkFBaUI7Z0JBQ2pELHNCQUFzQixFQUFFLEtBQUssQ0FBQyxNQUFNLENBQUMsc0JBQXNCO2dCQUMzRCxPQUFPLEVBQUUsS0FBSyxDQUFDLE1BQU0sQ0FBQyxPQUFPO2dCQUM3QixNQUFNLEVBQUUsS0FBSyxDQUFDLE1BQU0sQ0FBQyxNQUFNO2dCQUMzQixnQkFBZ0IsRUFBRSxLQUFLLENBQUMsTUFBTSxDQUFDLGdCQUFnQjthQUNsRCxDQUFDO1FBRUYsSUFBSSxDQUFDLElBQUksR0FBRyxLQUFLLENBQUMsSUFBSSxDQUFDO1FBQ3ZCLElBQUksQ0FBQyxRQUFRLEdBQUcsS0FBSyxDQUFDLFFBQVEsQ0FBQztRQUUvQixJQUFJLE9BQU8sTUFBTSxLQUFLLFNBQVMsRUFBRSxDQUFDO1lBQzlCLElBQUksQ0FBQyxJQUFJLEdBQUcsTUFBTSxDQUFDO1lBQ25CLE1BQU0sR0FBRyxTQUFTLENBQUM7UUFDdkIsQ0FBQztRQUVELElBQUksQ0FBQyxNQUFNLEVBQUUsQ0FBQztZQUNWLCtDQUErQztZQUMvQyxJQUFJLENBQUMsVUFBVSxFQUFFLENBQUE7UUFDckIsQ0FBQzs7WUFBTSxJQUFJLENBQUMsTUFBTSxHQUFHO2dCQUNqQixTQUFTLEVBQUUsTUFBTSxDQUFDLFNBQVM7Z0JBQzNCLFNBQVMsRUFBRSxNQUFNLENBQUMsU0FBUztnQkFDM0IsY0FBYyxFQUFFLE1BQU0sQ0FBQyxjQUFjLENBQUMsR0FBRyxDQUFDLENBQUMsQ0FBQyxFQUFFLENBQUMsQ0FBQyxFQUFFLENBQUMsRUFBRSxDQUFDLENBQUMsQ0FBQyxFQUFFLENBQUMsRUFBRSxDQUFDLENBQUMsQ0FBQyxFQUFFLENBQUMsQ0FBQztnQkFDcEUsTUFBTSxFQUFFLE1BQU0sQ0FBQyxNQUFNO2dCQUNyQixPQUFPLEVBQUUsTUFBTSxDQUFDLE9BQU87Z0JBQ3ZCLFlBQVksRUFBRSxNQUFNLENBQUMsWUFBWTtnQkFDakMsY0FBYyxFQUFFLE1BQU0sQ0FBQyxjQUFjO2dCQUNyQyxPQUFPLEVBQUUsTUFBTSxDQUFDLE9BQU87Z0JBQ3ZCLFFBQVEsRUFBRSxNQUFNLENBQUMsUUFBUTtnQkFDekIsTUFBTSxFQUFFLE1BQU0sQ0FBQyxNQUFNO2FBQ3hCLENBQUM7SUFDTixDQUFDO0lBRUQ7O09BRUc7SUFDSCxVQUFVO1FBQ04sSUFBSSxDQUFDLE1BQU0sR0FBRztZQUNWLFNBQVMsRUFBRSxDQUFDO1lBQ1osU0FBUyxFQUFFLENBQUM7WUFDWixjQUFjLEVBQUUsRUFBRTtZQUNsQixNQUFNLEVBQUUsQ0FBQztZQUNULE9BQU8sRUFBRSxLQUFLO1lBQ2QsWUFBWSxFQUFFLEtBQUs7WUFDbkIsY0FBYyxFQUFFLEtBQUs7WUFDckIsT0FBTyxFQUFFLEtBQUs7WUFDZCxRQUFRLEVBQUUsSUFBSSxLQUFLLENBQUMsSUFBSSxDQUFDLENBQUMsSUFBSSxDQUFDLEtBQUssQ0FBQztZQUNyQyxNQUFNLEVBQUUsQ0FBQztTQUNaLENBQUE7SUFDTCxDQUFDO0lBRUQ7O09BRUc7SUFDSCxXQUFXO1FBQ1AsSUFBSSxDQUFDLE1BQU0sR0FBRztZQUNWLGlCQUFpQixFQUFFLEVBQUU7WUFDckIsc0JBQXNCLEVBQUUsS0FBSztZQUM3QixPQUFPLEVBQUUsS0FBSztZQUNkLE1BQU0sRUFBRSxLQUFLO1lBQ2IsZ0JBQWdCLEVBQUUsS0FBSztTQUMxQixDQUFBO0lBQ0wsQ0FBQztDQUNKO0FBRUQsTUFBTSxPQUFPLFlBQVk7SUFrQnJCLFlBQVksTUFBcUIsRUFBRSxXQUFvQjtRQUNuRCxJQUFJLENBQUMsUUFBUSxHQUFHLE1BQU0sQ0FBQyxRQUFRLENBQUM7UUFDaEMsSUFBSSxDQUFDLFFBQVEsR0FBRyxNQUFNLENBQUMsUUFBUSxDQUFDO1FBQ2hDLElBQUksQ0FBQyxRQUFRLEdBQUcsTUFBTSxDQUFDLFFBQVEsQ0FBQztRQUVoQyxJQUFJLENBQUMsV0FBVyxHQUFHLFdBQVcsYUFBWCxXQUFXLGNBQVgsV0FBVyxHQUFJLElBQUksQ0FBQyxHQUFHLEVBQUUsQ0FBQztJQUNqRCxDQUFDO0lBR0Q7O09BRUc7SUFDSCxJQUFJLFVBQVU7UUFDVixJQUFJLElBQUksQ0FBQyxRQUFRLEtBQUssU0FBUztZQUFFLE9BQU8sS0FBSyxDQUFDO1FBRTlDLE9BQU8sSUFBSSxDQUFDLEdBQUcsRUFBRSxHQUFHLENBQUMsSUFBSSxDQUFDLFdBQVcsR0FBRyxJQUFJLENBQUMsUUFBUSxDQUFDLENBQUM7SUFDM0QsQ0FBQztJQUVEOzs7O09BSUc7SUFDSCxJQUFJLFNBQVM7UUFDVCxJQUFJLElBQUksQ0FBQyxRQUFRLEtBQUssU0FBUztZQUFFLE9BQU8sUUFBUSxDQUFDO1FBRWpELE9BQU8sSUFBSSxDQUFDLEdBQUcsQ0FBQyxDQUFDLEVBQUUsSUFBSSxDQUFDLEdBQUcsRUFBRSxHQUFHLENBQUMsSUFBSSxDQUFDLFdBQVcsR0FBRyxJQUFJLENBQUMsUUFBUSxDQUFDLENBQUMsQ0FBQztJQUN4RSxDQUFDO0NBQ0oifQ==

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export type * from "./types/index.d.ts";
+export { default as PWGameWorldHelper } from "./Helper.js";
+export { ComponentTypeHeader, default as BufferReader } from "./BufferReader.js";
+export { default as Block, BlockArgsHeadings } from "./Block.js";

package/dist/index.js

@@ -0,0 +1,5 @@
+export { default as PWGameWorldHelper } from "./Helper.js";
+export { ComponentTypeHeader, default as BufferReader } from "./BufferReader.js";
+export { default as Block, BlockArgsHeadings } from "./Block.js";
+// import * from "./Helper";
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9saWIvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQ0EsT0FBTyxFQUFFLE9BQU8sSUFBSSxpQkFBaUIsRUFBRSxNQUFNLGFBQWEsQ0FBQztBQUUzRCxPQUFPLEVBQUUsbUJBQW1CLEVBQUUsT0FBTyxJQUFJLFlBQVksRUFBRSxNQUFNLG1CQUFtQixDQUFDO0FBRWpGLE9BQU8sRUFBRSxPQUFPLElBQUksS0FBSyxFQUFFLGlCQUFpQixFQUFFLE1BQU0sWUFBWSxDQUFDO0FBRWpFLDRCQUE0QiJ9

package/dist/types/index.d.ts

@@ -0,0 +1,19 @@
+// I cba so all of the typings will go here
+
+type Point = { x: number, y: number };
+
+export interface SendableBlockPacket {
+    /**
+     * If true, just leave one position
+     */
+    isFillOperation: boolean;
+    blockId: number;
+    layer: number;
+    /**
+     * Note: (I THINK) 250 positions limit.
+     */
+    positions: Point[];
+    extraFields?: Uint8Array;
+}
+
+export type BlockArg = (string | number | bigint | boolean | Buffer);

package/esm.mjs

@@ -0,0 +1,19 @@
+let WorldPlayerHelper = (await import("./dist/Helper.js")).default;
+let Block = (await import("./dist/Block.js")).default;
+let BufferReader = (await import("./dist/BufferReader.js")).default;
+let Player = (await import("./dist/Player.js")).default;
+
+if ("default" in WorldPlayerHelper) WorldPlayerHelper = WorldPlayerHelper.default;
+if ("default" in Block) Block = Block.default;
+if ("default" in BufferReader) BufferReader = BufferReader.default;
+if ("default" in Player) Player = Player.default;
+
+const Constants = (await import("./dist/Constants.js")).default;
+
+export default {
+    WorldPlayerHelper, Block, BufferReader, Player, Constants
+};
+
+export {
+    WorldPlayerHelper, Block, BufferReader, Player, Constants
+};

package/lib/Block.ts

@@ -0,0 +1,217 @@
+import { BlockNames } from "pw-js-api";
+import type { BlockArg, Point, SendableBlockPacket } from "./types";
+import BufferReader, { ComponentTypeHeader } from "./BufferReader";
+import { LayerType } from "./Constants";
+
+export default class Block {
+    bId: number;
+    args: BlockArg[] = [];
+
+    constructor(bId: number | keyof typeof BlockNames, args?: BlockArg[]) {
+        if (typeof bId === "number") this.bId = bId;
+        else {
+            this.bId = BlockNames[bId];
+        }
+
+        if (args) this.args = args;
+    }
+
+    /**
+     * I mean... Just use .args.length !== 0 to see if it has args.
+     * 
+     * But anyway, this will return true if there is at least one args, otherwise false.
+     */
+    hasArgs() : boolean {
+        return this.args.length !== 0;
+    }
+
+    /**
+     * For helper.
+     * 
+     * This is in Block class for organisation.
+     * 
+     * This will deserialise by using the reader to get the block ID then retrieve the args, if applicable.
+     */
+    static deserialize(reader: BufferReader) : Block {
+        return new Block(reader.readUInt32LE()).deserializeArgs(reader);
+    }
+
+    protected deserializeArgs(reader: BufferReader, flag = false) : this {
+        const format: ComponentTypeHeader[] = (BlockArgsHeadings as any)[this.name];
+
+        for (let i = 0; i < (format?.length ?? 0); i++) {
+            if (flag) {
+                reader.expectUInt8(format[i]);
+            }
+
+            this.args[i] = reader.read(format[i], !flag);
+        }
+
+        return this;
+    }
+    
+    /**
+     * For helper.
+     * 
+     * This is in Block class for organisation.
+     */
+    static deserializeArgs(blockId: number, reader: BufferReader, flag = false) : BlockArg[] {
+        const format: ComponentTypeHeader[] = (BlockArgsHeadings as any)[BlockNames[blockId]];
+
+        const args = [];
+
+        for (let i = 0; i < (format?.length ?? 0); i++) {
+            if (flag) {
+                reader.expectUInt8(format[i]);
+            }
+
+            args[i] = reader.read(format[i], !flag);
+        }
+
+        return args;
+    }
+    
+    /**
+     * Serializes the block into a buffer. This is used to convert
+     * the block into a binary format that can be sent over the game
+     * server. As this is static, block id and args are required.
+     *
+     * - Little Endian
+     * - With Id
+     * - Type Byte omitted
+     */
+    public static serializeArgs(bId: number, args: BlockArg[]): Buffer;
+
+    /**
+     * Serializes the block into a buffer. This is used to convert
+     * the block into a binary format that can be sent over the game
+     * server. As this is static, block id and args are required.
+     *
+     * - Big Endian
+     * - No Id
+     * - Type Byte included
+     */
+    public static serializeArgs(bId: number, args: BlockArg[], options: { endian: "big"; writeId: false; readTypeByte: true }): Buffer;
+
+    public static serializeArgs(bId: number, args: BlockArg[], options?: { endian: "little" | "big"; writeId: boolean; readTypeByte: boolean }): Buffer {
+        options ||= {
+            endian: "little",
+            writeId: true,
+            readTypeByte: false,
+        };
+
+        const buffer: Buffer[] = [];
+
+        if (options.writeId) {
+            const idBuffer = Buffer.alloc(4);
+            idBuffer.writeUInt32LE(bId);
+            buffer.push(idBuffer);
+        }
+
+        const blockData:ComponentTypeHeader[] = (BlockArgsHeadings as any)[BlockNames[bId]] ?? [];
+
+        for (let i = 0, len = blockData.length; i < len; i++) {
+            const entry = BufferReader.Dynamic(i, args[i]);
+            buffer.push(entry);
+        }
+
+        return Buffer.concat(buffer);
+    }
+
+    /**
+     * 
+     * @param pos List of points (X and Y)
+     */
+    toPacket(pos: Point[], layer: LayerType) : SendableBlockPacket;
+    toPacket(x: number, y: number, layer: LayerType) : SendableBlockPacket;
+    toPacket(pos: Point[] | number, y: number, layer?: LayerType) : SendableBlockPacket {
+        if (typeof pos === "number") {
+            pos = [{
+                x: pos, y
+            }];
+
+            layer = layer ?? 0;
+        } else layer = y ?? 0;
+
+        return {
+            isFillOperation: false,
+            blockId: this.bId,
+            layer,
+            positions: pos,
+            extraFields: Block.serializeArgs(this.bId, this.args, { endian: "big", writeId: false, readTypeByte: true })
+        } satisfies SendableBlockPacket;
+    }
+
+    /**
+     * This will return the block name in UPPER_CASE form.
+     * 
+     * For eg EFFECTS_INVULNERABILITY.
+     */
+    get name() : keyof typeof BlockNames {
+        return BlockNames[this.bId] as keyof typeof BlockNames;
+    }
+
+    /**
+     * Returns a copy of the block.
+     */
+    clone(obj?: false) : Block;
+    clone(obj: true) : { bId: number, args: BlockArg[], name: string }
+    clone(obj = false) {
+        if (obj === true) return { bId: this.bId, args: this.args, name: this.name };
+
+        return new Block(this.bId, this.args);
+    }
+}
+
+/**
+ * This mapping contains definitions of block data which require additional
+ * arguments to be sent or received with.
+ */
+export const BlockArgsHeadings = {
+    COIN_GOLD_DOOR: [ComponentTypeHeader.Int32],
+    COIN_BLUE_DOOR: [ComponentTypeHeader.Int32],
+    COIN_GOLD_GATE: [ComponentTypeHeader.Int32],
+    COIN_BLUE_GATE: [ComponentTypeHeader.Int32],
+
+    EFFECTS_JUMP_HEIGHT: [ComponentTypeHeader.Int32],
+    EFFECTS_FLY: [ComponentTypeHeader.Boolean],
+    EFFECTS_SPEED: [ComponentTypeHeader.Int32],
+    EFFECTS_INVULNERABILITY: [ComponentTypeHeader.Boolean],
+    EFFECTS_CURSE: [ComponentTypeHeader.Int32],
+    EFFECTS_ZOMBIE: [ComponentTypeHeader.Int32],
+    EFFECTS_GRAVITYFORCE: [ComponentTypeHeader.Int32],
+    EFFECTS_MULTI_JUMP: [ComponentTypeHeader.Int32],
+    // gravity effects no data
+    // effects off
+    // effects zombie
+
+    TOOL_PORTAL_WORLD_SPAWN: [ComponentTypeHeader.Int32],
+
+    SIGN_NORMAL: [ComponentTypeHeader.String],
+    SIGN_RED: [ComponentTypeHeader.String],
+    SIGN_GREEN: [ComponentTypeHeader.String],
+    SIGN_BLUE: [ComponentTypeHeader.String],
+    SIGN_GOLD: [ComponentTypeHeader.String],
+
+    PORTAL: [ComponentTypeHeader.Int32, ComponentTypeHeader.Int32, ComponentTypeHeader.Int32],
+    PORTAL_INVISIBLE: [ComponentTypeHeader.Int32, ComponentTypeHeader.Int32, ComponentTypeHeader.Int32],
+    PORTAL_WORLD: [ComponentTypeHeader.String, ComponentTypeHeader.Int32],
+
+    SWITCH_LOCAL_TOGGLE: [ComponentTypeHeader.Int32],
+    SWITCH_LOCAL_ACTIVATOR: [ComponentTypeHeader.Int32, ComponentTypeHeader.Boolean],
+    SWITCH_LOCAL_RESETTER: [ComponentTypeHeader.Boolean],
+    SWITCH_LOCAL_DOOR: [ComponentTypeHeader.Int32],
+    SWITCH_LOCAL_GATE: [ComponentTypeHeader.Int32],
+    SWITCH_GLOBAL_TOGGLE: [ComponentTypeHeader.Int32],
+    SWITCH_GLOBAL_ACTIVATOR: [ComponentTypeHeader.Int32, ComponentTypeHeader.Boolean],
+    SWITCH_GLOBAL_RESETTER: [ComponentTypeHeader.Boolean],
+    SWITCH_GLOBAL_DOOR: [ComponentTypeHeader.Int32],
+    SWITCH_GLOBAL_GATE: [ComponentTypeHeader.Int32],
+
+    HAZARD_DEATH_DOOR: [ComponentTypeHeader.Int32],
+    HAZARD_DEATH_GATE: [ComponentTypeHeader.Int32],
+
+    NOTE_DRUM: [ComponentTypeHeader.ByteArray],
+    NOTE_PIANO: [ComponentTypeHeader.ByteArray],
+    NOTE_GUITAR: [ComponentTypeHeader.ByteArray],
+} as const;