pw-js-world 0.2.1-dev.ee2fd11 → 0.3.0

package/cm/Player.d.ts

@@ -0,0 +1,255 @@
+import type { ProtoGen } from "pw-js-api";
+import type { Point } from "./types/index.js";
+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;
+    /**
+     * Instance of counters associated with the player.
+     */
+    counters: PlayerCounters;
+}
+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;
+}
+/**
+ * Index based
+ */
+declare enum CounterKeys {
+    WHITE = 0,
+    GRAY = 1,
+    BLACK = 2,
+    RED = 3,
+    ORANGE = 4,
+    YELLOW = 5,
+    GREEN = 6,
+    CYAN = 7,
+    BLUE = 8,
+    MAGENTA = 9
+}
+export declare class PlayerCounters {
+    readonly scores: number[];
+    constructor(scores?: number[]);
+    /**
+     * Returns the current score of the player's counter for that colour.
+     *
+     * Can be ID (counter id) or colour (use as predefined).
+     *
+     * If the colour given is unknown, it will error. Capitalisation is irrelevant.
+     */
+    get(id: number): number | undefined;
+    get(id: keyof typeof CounterKeys): number | undefined;
+}
+export {};

package/cm/Player.js

@@ -0,0 +1,154 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PlayerCounters = exports.PlayerEffect = void 0;
+const Misc_js_1 = require("./util/Misc.js");
+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: (0, Misc_js_1.map)(states.collectedItems, 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,
+                counters: states.counters
+            };
+    }
+    /**
+     * 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,
+            counters: new PlayerCounters()
+        };
+    }
+    /**
+     * Destructive.
+     */
+    resetRights() {
+        this.rights = {
+            availableCommands: [],
+            canChangeWorldSettings: false,
+            canEdit: false,
+            canGod: false,
+            canToggleMinimap: false
+        };
+    }
+}
+exports.default = Player;
+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));
+    }
+}
+exports.PlayerEffect = PlayerEffect;
+/**
+ * Index based
+ */
+var CounterKeys;
+(function (CounterKeys) {
+    CounterKeys[CounterKeys["WHITE"] = 0] = "WHITE";
+    CounterKeys[CounterKeys["GRAY"] = 1] = "GRAY";
+    CounterKeys[CounterKeys["BLACK"] = 2] = "BLACK";
+    CounterKeys[CounterKeys["RED"] = 3] = "RED";
+    CounterKeys[CounterKeys["ORANGE"] = 4] = "ORANGE";
+    CounterKeys[CounterKeys["YELLOW"] = 5] = "YELLOW";
+    CounterKeys[CounterKeys["GREEN"] = 6] = "GREEN";
+    CounterKeys[CounterKeys["CYAN"] = 7] = "CYAN";
+    CounterKeys[CounterKeys["BLUE"] = 8] = "BLUE";
+    CounterKeys[CounterKeys["MAGENTA"] = 9] = "MAGENTA";
+})(CounterKeys || (CounterKeys = {}));
+class PlayerCounters {
+    constructor(scores = []) {
+        var _a;
+        this.scores = [];
+        for (let i = 0; i < 10; i++) {
+            this.scores[i] = (_a = scores[i]) !== null && _a !== void 0 ? _a : 0;
+        }
+    }
+    get(id) {
+        if (typeof id === "number")
+            return this.scores[id];
+        const index = CounterKeys[id.toUpperCase()];
+        if (index !== undefined) {
+            return this.scores[index];
+        }
+        else
+            throw Error("Unknown colour");
+    }
+}
+exports.PlayerCounters = PlayerCounters;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiUGxheWVyLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vbGliL1BsYXllci50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUFFQSw0Q0FBcUM7QUE4SXJDLE1BQXFCLE1BQU07SUFzRHZCLFlBQVksS0FBZ0MsRUFBRSxNQUFvQztRQVZsRjs7V0FFRztRQUNILFlBQU8sR0FBa0IsRUFBRSxDQUFDO1FBRTVCOztXQUVHO1FBQ0gsU0FBSSxHQUFZLEtBQUssQ0FBQztRQUdsQixJQUFJLENBQUMsU0FBUyxHQUFHLEtBQUssQ0FBQyxTQUFTLENBQUM7UUFDakMsSUFBSSxDQUFDLElBQUksR0FBRyxLQUFLLENBQUMsSUFBSSxDQUFDO1FBQ3ZCLElBQUksQ0FBQyxRQUFRLEdBQUcsS0FBSyxDQUFDLFFBQVEsQ0FBQztRQUMvQixJQUFJLENBQUMsWUFBWSxHQUFHLEtBQUssQ0FBQyxZQUFZLENBQUM7UUFDdkMsSUFBSSxDQUFDLFFBQVEsR0FBRyxLQUFLLENBQUMsUUFBUSxDQUFDO1FBQy9CLElBQUksQ0FBQyxRQUFRLEdBQUcsS0FBSyxDQUFDLFFBQVEsQ0FBQyxDQUFDLENBQUM7WUFDN0IsQ0FBQyxFQUFFLEtBQUssQ0FBQyxRQUFRLENBQUMsQ0FBQztZQUNuQixDQUFDLEVBQUUsS0FBSyxDQUFDLFFBQVEsQ0FBQyxDQUFDO1NBQ3RCLENBQUMsQ0FBQyxDQUFDLFNBQVMsQ0FBQztRQUVkLElBQUksQ0FBQyxLQUFLLENBQUMsTUFBTTtZQUFFLElBQUksQ0FBQyxXQUFXLEVBQUUsQ0FBQzs7WUFDakMsSUFBSSxDQUFDLE1BQU0sR0FBRztnQkFDZixpQkFBaUIsRUFBRSxLQUFLLENBQUMsTUFBTSxDQUFDLGlCQUFpQjtnQkFDakQsc0JBQXNCLEVBQUUsS0FBSyxDQUFDLE1BQU0sQ0FBQyxzQkFBc0I7Z0JBQzNELE9BQU8sRUFBRSxLQUFLLENBQUMsTUFBTSxDQUFDLE9BQU87Z0JBQzdCLE1BQU0sRUFBRSxLQUFLLENBQUMsTUFBTSxDQUFDLE1BQU07Z0JBQzNCLGdCQUFnQixFQUFFLEtBQUssQ0FBQyxNQUFNLENBQUMsZ0JBQWdCO2FBQ2xELENBQUM7UUFFRixJQUFJLENBQUMsSUFBSSxHQUFHLEtBQUssQ0FBQyxJQUFJLENBQUM7UUFDdkIsSUFBSSxDQUFDLFFBQVEsR0FBRyxLQUFLLENBQUMsUUFBUSxDQUFDO1FBRS9CLElBQUksT0FBTyxNQUFNLEtBQUssU0FBUyxFQUFFLENBQUM7WUFDOUIsSUFBSSxDQUFDLElBQUksR0FBRyxNQUFNLENBQUM7WUFDbkIsTUFBTSxHQUFHLFNBQVMsQ0FBQztRQUN2QixDQUFDO1FBRUQsSUFBSSxDQUFDLE1BQU0sRUFBRSxDQUFDO1lBQ1YsK0NBQStDO1lBQy9DLElBQUksQ0FBQyxVQUFVLEVBQUUsQ0FBQTtRQUNyQixDQUFDOztZQUFNLElBQUksQ0FBQyxNQUFNLEdBQUc7Z0JBQ2pCLFNBQVMsRUFBRSxNQUFNLENBQUMsU0FBUztnQkFDM0IsU0FBUyxFQUFFLE1BQU0sQ0FBQyxTQUFTO2dCQUMzQixjQUFjLEVBQUUsSUFBQSxhQUFHLEVBQUMsTUFBTSxDQUFDLGNBQWMsRUFBRSxDQUFDLENBQUMsRUFBRSxDQUFDLENBQUMsRUFBRSxDQUFDLEVBQUUsQ0FBQyxDQUFDLENBQUMsRUFBRSxDQUFDLEVBQUUsQ0FBQyxDQUFDLENBQUMsRUFBRSxDQUFDLENBQUM7Z0JBQ3JFLE1BQU0sRUFBRSxNQUFNLENBQUMsTUFBTTtnQkFDckIsT0FBTyxFQUFFLE1BQU0sQ0FBQyxPQUFPO2dCQUN2QixZQUFZLEVBQUUsTUFBTSxDQUFDLFlBQVk7Z0JBQ2pDLGNBQWMsRUFBRSxNQUFNLENBQUMsY0FBYztnQkFDckMsT0FBTyxFQUFFLE1BQU0sQ0FBQyxPQUFPO2dCQUN2QixRQUFRLEVBQUUsTUFBTSxDQUFDLFFBQVE7Z0JBQ3pCLE1BQU0sRUFBRSxNQUFNLENBQUMsTUFBTTtnQkFDckIsUUFBUSxFQUFFLE1BQU0sQ0FBQyxRQUFRO2FBQzVCLENBQUM7SUFDTixDQUFDO0lBRUQ7O09BRUc7SUFDSCxVQUFVO1FBQ04sSUFBSSxDQUFDLE1BQU0sR0FBRztZQUNWLFNBQVMsRUFBRSxDQUFDO1lBQ1osU0FBUyxFQUFFLENBQUM7WUFDWixjQUFjLEVBQUUsRUFBRTtZQUNsQixNQUFNLEVBQUUsQ0FBQztZQUNULE9BQU8sRUFBRSxLQUFLO1lBQ2QsWUFBWSxFQUFFLEtBQUs7WUFDbkIsY0FBYyxFQUFFLEtBQUs7WUFDckIsT0FBTyxFQUFFLEtBQUs7WUFDZCxRQUFRLEVBQUUsSUFBSSxLQUFLLENBQUMsSUFBSSxDQUFDLENBQUMsSUFBSSxDQUFDLEtBQUssQ0FBQztZQUNyQyxNQUFNLEVBQUUsQ0FBQztZQUNULFFBQVEsRUFBRSxJQUFJLGNBQWMsRUFBRTtTQUNqQyxDQUFBO0lBQ0wsQ0FBQztJQUVEOztPQUVHO0lBQ0gsV0FBVztRQUNQLElBQUksQ0FBQyxNQUFNLEdBQUc7WUFDVixpQkFBaUIsRUFBRSxFQUFFO1lBQ3JCLHNCQUFzQixFQUFFLEtBQUs7WUFDN0IsT0FBTyxFQUFFLEtBQUs7WUFDZCxNQUFNLEVBQUUsS0FBSztZQUNiLGdCQUFnQixFQUFFLEtBQUs7U0FDMUIsQ0FBQTtJQUNMLENBQUM7Q0FDSjtBQW5JRCx5QkFtSUM7QUFFRCxNQUFhLFlBQVk7SUFrQnJCLFlBQVksTUFBcUIsRUFBRSxXQUFvQjtRQUNuRCxJQUFJLENBQUMsUUFBUSxHQUFHLE1BQU0sQ0FBQyxRQUFRLENBQUM7UUFDaEMsSUFBSSxDQUFDLFFBQVEsR0FBRyxNQUFNLENBQUMsUUFBUSxDQUFDO1FBQ2hDLElBQUksQ0FBQyxRQUFRLEdBQUcsTUFBTSxDQUFDLFFBQVEsQ0FBQztRQUVoQyxJQUFJLENBQUMsV0FBVyxHQUFHLFdBQVcsYUFBWCxXQUFXLGNBQVgsV0FBVyxHQUFJLElBQUksQ0FBQyxHQUFHLEVBQUUsQ0FBQztJQUNqRCxDQUFDO0lBR0Q7O09BRUc7SUFDSCxJQUFJLFVBQVU7UUFDVixJQUFJLElBQUksQ0FBQyxRQUFRLEtBQUssU0FBUztZQUFFLE9BQU8sS0FBSyxDQUFDO1FBRTlDLE9BQU8sSUFBSSxDQUFDLEdBQUcsRUFBRSxHQUFHLENBQUMsSUFBSSxDQUFDLFdBQVcsR0FBRyxJQUFJLENBQUMsUUFBUSxDQUFDLENBQUM7SUFDM0QsQ0FBQztJQUVEOzs7O09BSUc7SUFDSCxJQUFJLFNBQVM7UUFDVCxJQUFJLElBQUksQ0FBQyxRQUFRLEtBQUssU0FBUztZQUFFLE9BQU8sUUFBUSxDQUFDO1FBRWpELE9BQU8sSUFBSSxDQUFDLEdBQUcsQ0FBQyxDQUFDLEVBQUUsSUFBSSxDQUFDLEdBQUcsRUFBRSxHQUFHLENBQUMsSUFBSSxDQUFDLFdBQVcsR0FBRyxJQUFJLENBQUMsUUFBUSxDQUFDLENBQUMsQ0FBQztJQUN4RSxDQUFDO0NBQ0o7QUE5Q0Qsb0NBOENDO0FBRUQ7O0dBRUc7QUFDSCxJQUFLLFdBRUo7QUFGRCxXQUFLLFdBQVc7SUFDWiwrQ0FBSyxDQUFBO0lBQUUsNkNBQUksQ0FBQTtJQUFFLCtDQUFLLENBQUE7SUFBRSwyQ0FBRyxDQUFBO0lBQUUsaURBQU0sQ0FBQTtJQUFFLGlEQUFNLENBQUE7SUFBRSwrQ0FBSyxDQUFBO0lBQUUsNkNBQUksQ0FBQTtJQUFFLDZDQUFJLENBQUE7SUFBRSxtREFBTyxDQUFBO0FBQ3ZFLENBQUMsRUFGSSxXQUFXLEtBQVgsV0FBVyxRQUVmO0FBRUQsTUFBYSxjQUFjO0lBR3ZCLFlBQVksU0FBbUIsRUFBRTs7UUFGeEIsV0FBTSxHQUFhLEVBQUUsQ0FBQztRQUczQixLQUFLLElBQUksQ0FBQyxHQUFHLENBQUMsRUFBRSxDQUFDLEdBQUcsRUFBRSxFQUFFLENBQUMsRUFBRSxFQUFFLENBQUM7WUFDMUIsSUFBSSxDQUFDLE1BQU0sQ0FBQyxDQUFDLENBQUMsR0FBRyxNQUFBLE1BQU0sQ0FBQyxDQUFDLENBQUMsbUNBQUksQ0FBQyxDQUFDO1FBQ3BDLENBQUM7SUFDTCxDQUFDO0lBWUQsR0FBRyxDQUFDLEVBQXFDO1FBQ3JDLElBQUksT0FBTyxFQUFFLEtBQUssUUFBUTtZQUFFLE9BQU8sSUFBSSxDQUFDLE1BQU0sQ0FBQyxFQUFFLENBQUMsQ0FBQztRQUVuRCxNQUFNLEtBQUssR0FBRyxXQUFXLENBQUMsRUFBRSxDQUFDLFdBQVcsRUFBOEIsQ0FBQyxDQUFDO1FBRXhFLElBQUksS0FBSyxLQUFLLFNBQVMsRUFBRSxDQUFDO1lBQ3RCLE9BQU8sSUFBSSxDQUFDLE1BQU0sQ0FBQyxLQUFLLENBQUMsQ0FBQztRQUM5QixDQUFDOztZQUFNLE1BQU0sS0FBSyxDQUFDLGdCQUFnQixDQUFDLENBQUM7SUFDekMsQ0FBQztDQUNKO0FBNUJELHdDQTRCQyJ9

package/cm/Structure.d.ts

@@ -0,0 +1,103 @@
+import Block from "./Block";
+import type { BlockArg } from "./types";
+/**
+ * This is external to the main Helper, it will allow developers to use the structure without needing to use helper if they so wish.
+ *
+ * All of the functions are static!
+ */
+export default class StructureHelper {
+    /**
+     * NOTE: If you're reading a file, you must get it then pass it to read.
+     *
+     * This is for reading the structure itself, if you have just the blocks (and width/height), you must use deserialiseStructBlocks;
+     *
+     * @param data Buffer representing the JSON structure itself.
+     */
+    static read(data: Buffer | Uint8Array | IStructure): DeserialisedStructure;
+    /**
+     * If width or height are not provided, the structure may be trimmed (empty blocks).
+     *
+     * This is ideal if you want the trimmed structure in that case.
+     */
+    static deserialiseStructBlocks(struct: IStructureBlocks, width?: number, height?: number): {
+        blocks: [Block[][], Block[][]];
+        width: number;
+        height: number;
+    };
+}
+/**
+ * Represents the structure in its deserialised form, allows for modification
+ */
+export declare class DeserialisedStructure {
+    blocks: [Block[][], Block[][]];
+    width: number;
+    height: number;
+    constructor(blocks: [Block[][], Block[][]], struct: Omit<IStructure, "version" | "blocks">);
+    /**
+     * This will return a new object that meets IStructureBlocks interface.
+     */
+    getSerialisedBlocks(): IStructureBlocks;
+    /**
+     * This will return the structure form, giving you the freedom to choose your own way of saving.
+     */
+    toStruct(): IStructure;
+    /**
+     * Buffer form of the structure.
+     */
+    toBuffer(): Buffer<ArrayBuffer>;
+    /**
+     * The JSON stringified of the structure.
+     */
+    toJSONString(space?: number): string;
+    /**
+     * (This is for browser client or Bun)
+     *
+     * Blob form of the structure.
+     */
+    toBlob(): Blob;
+    /**
+     * Uint8Array form of the structure.
+     */
+    toBytes(): Uint8Array<ArrayBuffer>;
+    /**
+     * This will return a list of packets containing all of the blocks.
+     */
+    toPackets(x: number, y: number): import("./types").SendableBlockPacket[];
+}
+export interface IStructure {
+    /**
+     * Version of the structure object, not the world.
+     */
+    version: number;
+    /**
+     * The maximum width of the structure.
+     */
+    width: number;
+    /**
+     * The maximum height of the structure.
+     */
+    height: number;
+    /**
+     * Object containing the mappings and the blocks.
+     */
+    blocks: IStructureBlocks;
+}
+interface IStructureBlocks {
+    /**
+     * Index starts at 0, this is the mapping of blocks (in block name ids in UPPER_CASE)
+     */
+    mapping: string[];
+    /**
+     * Index starts at 0, this is the mapping of args (2nd elements and beyond in each block pos in blocks)
+     */
+    args: BlockArg[];
+    /**
+     * If array, it's index corresponds to the mapping, the element will be array of locations and args indexed by layers (while impossible, it's for possible compatibility with mirrored blocks, foreground block in background layer etc)
+     *
+     * If argMapping exists in a block, it'll be an index that corresponds to the block's arguments in args array.
+     *
+     * If string, it's the encoded version of the object, use atob then JSON parse.
+     */
+    blocks: [[x: number, y: number, ...argMapping: number[]][], [x: number, y: number, ...argMapping: number[]][]][];
+}
+export {};