pw-js-world 0.0.1

package/dist/Constants.d.ts

@@ -0,0 +1,4 @@
+export declare enum LayerType {
+    Background = 0,
+    Foreground = 1
+}

package/dist/Constants.js

@@ -0,0 +1,6 @@
+export var LayerType;
+(function (LayerType) {
+    LayerType[LayerType["Background"] = 0] = "Background";
+    LayerType[LayerType["Foreground"] = 1] = "Foreground";
+})(LayerType || (LayerType = {}));
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiQ29uc3RhbnRzLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vbGliL0NvbnN0YW50cy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxNQUFNLENBQU4sSUFBWSxTQUdYO0FBSEQsV0FBWSxTQUFTO0lBQ2pCLHFEQUFVLENBQUE7SUFDVixxREFBVSxDQUFBO0FBQ2QsQ0FBQyxFQUhXLFNBQVMsS0FBVCxTQUFTLFFBR3BCIn0=

package/dist/Helper.d.ts

@@ -0,0 +1,200 @@
+import { BlockNames, Hook } from "pw-js-api";
+import type { WorldMeta } from "../node_modules/pw-js-api/dist/gen/world_pb";
+import Block from "./Block";
+import Player, { IPlayerEffect, IPlayerRights } from "./Player";
+import { LayerType } from "./Constants";
+import type { BlockArg, Point, SendableBlockPacket } from "./types";
+/**
+ * To use this helper, you must first create an instance of this,
+ *
+ * then: <PWGameClient>.addCallback("raw", helper.onRawPacketRecv)
+ */
+export default class PWGameWorldHelper {
+    /**
+     * Arrays of blocks (by layer, x, y)
+     */
+    blocks: [Block[][], Block[][]];
+    players: Map<number, Player>;
+    globalSwitches: boolean[];
+    private _meta?;
+    private _width;
+    private _height;
+    private _init;
+    private _selfPlayerId;
+    /**
+     * The current world's width.
+     *
+     * If you didn't put the hook before init, this may throw error.
+     */
+    get width(): number;
+    /**
+     * The current world's height.
+     *
+     * If you didn't put the hook before init, this may throw error.
+     */
+    get height(): number;
+    /**
+     * The current world's metadata.
+     *
+     * If you didn't put the hook before init, this may throw error.
+     */
+    get meta(): WorldMeta | null;
+    /**
+     * If this helper is ready. When it's false, the helper will not return anything for any of the packets.
+     */
+    get initialised(): boolean;
+    /**
+     * The bot's player object.
+     *
+     * If you didn't put the hook before init, this may throw error.
+     */
+    get botPlayer(): Player;
+    /**
+     * The bot's player id in the world.
+     *
+     * If you didn't put the hook before init, this may throw error.
+     */
+    get botPlayerId(): number;
+    /**
+     * This must go in .use() of the main PW-JS-API Game Client class.
+     *
+     * <PWGameClient>.use(<PWGameWorldHelper>.receiveHook)
+     *
+     * DO NOT PUT () AFTER RECEIVEHOOK
+     */
+    receiveHook: Hook<{
+        worldBlockPlacedPacket: {
+            player: Player;
+            oldBlocks: Block[];
+            newBlocks: Block[];
+        };
+        playerJoinedPacket: {
+            player: Player;
+        };
+        playerLeftPacket: {
+            player: Player;
+        };
+        playerInitPacket: {
+            player: Player;
+        };
+        playerFacePacket: {
+            player: Player;
+            oldFace: number;
+        };
+        playerModModePacket: {
+            player: Player;
+            oldState: boolean;
+        };
+        playerGodModePacket: {
+            player: Player;
+            oldState: boolean;
+        };
+        playerAddEffectPacket: {
+            player: Player;
+            effect: IPlayerEffect;
+        };
+        playerRemoveEffectPacket: {
+            player: Player;
+            effect: IPlayerEffect;
+        };
+        playerResetEffectsPacket: {
+            player: Player;
+            effects: IPlayerEffect[];
+        };
+        playerMovedPacket: {
+            player: Player;
+        };
+        playerResetPacket: {
+            player: Player;
+        };
+        playerRespawnPacket: {
+            player: Player;
+        };
+        playerUpdateRightsPacket: {
+            player: Player;
+            rights: IPlayerRights;
+        };
+        playerTeamUpdatePacket: {
+            player: Player;
+            oldTeam: number;
+        };
+        playerCountersUpdatePacket: {
+            player: Player;
+            oldState: {
+                coinsBlue: number;
+                coinsGold: number;
+                deaths: number;
+            };
+        };
+        playerTeleportedPacket: {
+            player: Player;
+        };
+        globalSwitchChangedPacket: {
+            player: Player;
+        };
+        globalSwitchResetPacket: {
+            player: Player;
+        };
+        playerLocalSwitchChangedPacket: {
+            player: Player;
+        };
+        playerLocalSwitchResetPacket: {
+            player: Player;
+        };
+        playerChatPacket: {
+            player: Player;
+        };
+        playerDirectMessagePacket: {
+            player: Player;
+        };
+        playerTouchBlockPacket: {
+            player: Player;
+        };
+    }>;
+    /**
+     * Internal function.
+     */
+    private initialise;
+    /**
+     * Internal function.
+     */
+    private deserialize;
+    private convertSwitchState;
+    /**
+     * Internal function, this triggers when the world gets cleared.
+     *
+     * Clears the blocks map and promptly fill it with empty except the border which becomes basci gray.
+     */
+    private clear;
+    /**
+     * Gets the block at the position.
+     */
+    getBlockAt(x: number, y: number, l: number): Block;
+    /**
+     * Player ID.
+     *
+     * The main bot player is excluded from the criteria.
+     */
+    getPlayer(id: number, isAccount?: false): Player | undefined;
+    /**
+     * Username is case insensitive.
+     *
+     * The main bot player is excluded from the criteria.
+     */
+    getPlayer(username: string, isAccount?: false): Player | undefined;
+    /**
+     * The ID of the account (must have second parameter set to true)
+     *
+     * The main bot player is excluded from the criteria.
+     */
+    getPlayer(accountId: string, isAccount: true): Player | undefined;
+    /**
+     * Returns the list of current players in the world.
+     */
+    getPlayers(): Player[];
+    /**
+     * For now this is slightly limited, but this will ONLY create a sendable packet which you must then send it yourself.
+     */
+    createBlockPacket(blockId: number | BlockNames | keyof typeof BlockNames, layer: LayerType, pos: Point | Point[], ...args: BlockArg[]): SendableBlockPacket;
+    createBlockPacket(block: Block, layer: LayerType, pos: Point | Point[]): SendableBlockPacket;
+}