@nxg-org/mineflayer-physics-util 1.3.6 → 1.3.8

package/{lib → dist}/index.d.ts

@@ -13,4 +13,5 @@ export { EPhysicsCtx, PhysicsSettings } from "./physics/settings";
 export { BaseSimulator } from "./simulators";
 export { EntityPhysics } from "./physics/engines";
 export { EntityState } from "./physics/states";
+export { ControlStateHandler } from "./physics/player";
 export type { SimulationGoal, Controller, OnGoalReachFunction } from "./simulators";

package/{lib → dist}/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.EntityState = exports.EntityPhysics = exports.BaseSimulator = exports.PhysicsSettings = exports.EPhysicsCtx = exports.initSetup = void 0;
+exports.ControlStateHandler = exports.EntityState = exports.EntityPhysics = exports.BaseSimulator = exports.PhysicsSettings = exports.EPhysicsCtx = exports.initSetup = void 0;
 const settings_1 = require("./physics/settings");
 const wrapper_1 = require("./wrapper");
 function loader(bot) {
@@ -24,3 +24,5 @@ var engines_1 = require("./physics/engines");
 Object.defineProperty(exports, "EntityPhysics", { enumerable: true, get: function () { return engines_1.EntityPhysics; } });
 var states_1 = require("./physics/states");
 Object.defineProperty(exports, "EntityState", { enumerable: true, get: function () { return states_1.EntityState; } });
+var player_1 = require("./physics/player");
+Object.defineProperty(exports, "ControlStateHandler", { enumerable: true, get: function () { return player_1.ControlStateHandler; } });

package/{lib → dist}/simulators/baseSimulator.d.ts

@@ -4,7 +4,7 @@ import { EntityState } from "../physics/states";
 import { IPhysics } from "../physics/engines";
 import { Entity } from "prismarine-entity";
 import { Vec3 } from "vec3";
-export declare type SimulationGoal = (state: EntityState, ticks?: number) => boolean;
+export declare type SimulationGoal = (state: EntityState, ticks: number) => boolean | ((state: EntityState) => boolean);
 export declare type OnGoalReachFunction = (state: EntityState) => void;
 export declare type Controller = (state: EntityState, ticks: number) => void;
 export declare abstract class BaseSimulator {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@nxg-org/mineflayer-physics-util",
-    "version": "1.3.6",
+    "version": "1.3.8",
     "description": "Provides functionality for more accurate entity and projectile tracking.",
     "keywords": [
         "mineflayer",
@@ -13,12 +13,12 @@
     },
     "license": "GPL-3.0",
     "author": "generel_schwerz",
-    "main": "lib/index.js",
-    "types": "lib/index.d.ts",
+    "main": "dist/index.js",
+    "types": "dist/index.d.ts",
     "scripts": {
         "build": "npx tsc",
         "prepublish": "npm run build",
-        "test": "node --trace-warnings lib/tests/fakeWorld.js"
+        "test": "ts-node -T tests/fakeWorld.ts"
     },
     "dependencies": {
         "@nxg-org/mineflayer-util-plugin": "^1.3.17",

package/tests/fakeWorld.ts

@@ -0,0 +1,95 @@
+import type { Entity } from "prismarine-entity";
+import type { Effect } from "mineflayer";
+import { EntityPhysics } from "../src/physics/engines";
+import { EntityState } from "../src/physics/states";
+import { EPhysicsCtx, PhysicsSettings } from "../src/physics/settings";
+import { applyMdToNewEntity } from "../src/util/physicsUtils";
+import { ControlStateHandler } from "../src/physics/player";
+import { Vec3 } from "vec3";
+import md from "minecraft-data";
+import block from "prismarine-block";
+import expect from "expect";
+
+import { initSetup } from "../src/index";
+
+const mcData = md("1.17.1");
+const Block = (block as any)("1.17.1");
+
+const fakeWorld = {
+    getBlock: (pos: { x: number; y: number; z: number }) => {
+        const type = pos.y < 60 ? mcData.blocksByName.stone.id : mcData.blocksByName.air.id;
+        const b = new Block(type, 0, 0);
+        b.position = pos;
+        return b;
+    },
+};
+
+function createFakePlayer(pos: Vec3) {
+    return {
+        entity: {
+            position: pos,
+            velocity: new Vec3(0, 0, 0),
+            onGround: false,
+            isInWater: false,
+            isInLava: false,
+            isInWeb: false,
+            isCollidedHorizontally: false,
+            isCollidedVertically: false,
+            yaw: 0,
+            effects: {} as Effect[],
+        } as unknown as Entity,
+        jumpTicks: 0,
+        jumpQueued: false,
+        version: "1.17.1",
+        inventory: {
+            slots: [],
+        },
+    };
+}
+
+
+//init (imports mcData to necessary modules).
+initSetup(mcData);
+
+//create fake bot
+const playerType = mcData.entitiesByName["player"]; // specify type we will be simulating.
+const fakePlayer = createFakePlayer(new Vec3(0, 80, 0)); // call function supplied by prismarine-physics
+fakePlayer.entity = applyMdToNewEntity(EPhysicsCtx, playerType, fakePlayer.entity); // ensure compatibility.
+
+// create physics context.
+const physics = new EntityPhysics(mcData); // creates entity physics w/ environments specific to this entity.
+
+// create entity-specific physics context.
+const playerState = EntityState.CREATE_FROM_ENTITY(physics, fakePlayer.entity); // creates a simulation-compatible state.
+const playerCtx = EPhysicsCtx.FROM_ENTITY_STATE(physics, playerState, playerType); // create wrapper context (supplies AABB, pose info, etc).
+
+// set control state.
+playerState.controlState = ControlStateHandler.DEFAULT(); // specific to players and mobs, specify control scheme to apply.
+playerState.controlState.forward = true;
+
+// simulate until on ground.
+while (!playerCtx.state.onGround) {
+    physics.simulate(playerCtx, fakeWorld).applyToBot(fakePlayer as any); // (applyToBot since fakePlayer is supposed to be a bot)
+    // console.log(fakePlayer.entity.position, fakePlayer.entity.velocity);
+}
+
+if (playerState.controlState.forward) {
+    expect(fakePlayer.entity.position).toEqual(new Vec3(0, 60, -3.4508449226731694)); // it works.
+} else {
+    expect(fakePlayer.entity.position).toEqual(new Vec3(0, 60, 0)); // it works.
+}
+
+playerCtx.state.controlState.set("jump", true);
+for (let i = 0; i < 12; i++) {
+    physics.simulate(playerCtx, fakeWorld).applyToBot(fakePlayer as any); // (applyToBot since fakePlayer is supposed to be a bot)
+    // console.log(fakePlayer.entity.position, fakePlayer.entity.velocity);
+}
+
+if (playerState.controlState.forward) {
+    expect(fakePlayer.entity.position).toEqual(new Vec3(0, 60, -5.788782872583908)); // it works.
+} else {
+    expect(fakePlayer.entity.position).toEqual(new Vec3(0, 60, 0)); // it works.
+}
+
+
+console.log(fakePlayer.entity.position); //manual run.

package/tests/util/testUtils.ts

@@ -0,0 +1,68 @@
+import { Effect } from "mineflayer";
+import { Entity } from "prismarine-entity";
+import { Vec3 } from "vec3";
+import md from "minecraft-data";
+import block from "prismarine-block";
+import entity from "prismarine-entity"
+
+export default function load(version: string) {
+
+    const mcData = md(version);
+    const Block = (block as any)(version);
+    const Entity = (entity as any)(version)
+
+
+    const fakeWorld = {
+        getBlock: (pos: { x: number; y: number; z: number }) => {
+            const type = pos.y < 60 ? mcData.blocksByName.stone.id : mcData.blocksByName.air.id;
+            const b = new Block(type, 0, 0);
+            b.position = pos;
+            return b;
+        },
+    };
+
+    const createFakeEntity = (name: string, pos: Vec3) => {
+        if (!mcData.entitiesByName[name!]) throw "invalid name"
+        const tmp = mcData.entitiesByName[name!]
+        return {
+            name: name,
+            type: tmp.type,
+            height: tmp.height,
+            width: tmp.width,
+            position: pos,
+            velocity: new Vec3(0, 0, 0),
+            onGround: false,
+            isInWater: false,
+            isInLava: false,
+            isInWeb: false,
+            isCollidedHorizontally: false,
+            isCollidedVertically: false,
+            yaw: 0,
+            effects: {} as Effect[],
+            metadata: [],
+            equipment: new Array(6)
+        } as unknown as Entity
+    }
+
+    const modifyEntity = (name: string, entity: Entity) => {
+        if (!mcData.entitiesByName[name!]) throw "invalid name"
+        const tmp = mcData.entitiesByName[name!]
+        entity.height = tmp.height ?? 0
+        entity.width = tmp.width ?? 0
+    }
+
+    const createFakePlayer = (pos: Vec3) => {
+        return {
+            entity: createFakeEntity("player", pos),
+            jumpTicks: 0,
+            jumpQueued: false,
+            version: "1.17.1",
+            inventory: {
+                slots: [],
+            },
+            world: fakeWorld
+        };
+    }
+
+    return { mcData, Block, Entity, fakeWorld, createFakePlayer, createFakeEntity, modifyEntity };
+}

package/lib/tests/fakeWorld.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/tests/fakeWorld.js

@@ -1,77 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const engines_1 = require("../physics/engines");
-const states_1 = require("../physics/states");
-const settings_1 = require("../physics/settings");
-const physicsUtils_1 = require("../util/physicsUtils");
-const player_1 = require("../physics/player");
-const vec3_1 = require("vec3");
-const minecraft_data_1 = __importDefault(require("minecraft-data"));
-const prismarine_block_1 = __importDefault(require("prismarine-block"));
-const index_1 = require("../index");
-const mcData = (0, minecraft_data_1.default)("1.17.1");
-const Block = prismarine_block_1.default("1.17.1");
-const fakeWorld = {
-    getBlock: (pos) => {
-        const type = pos.y < 60 ? mcData.blocksByName.stone.id : mcData.blocksByName.air.id;
-        const b = new Block(type, 0, 0);
-        b.position = pos;
-        return b;
-    },
-};
-function createFakePlayer(pos) {
-    return {
-        entity: {
-            position: pos,
-            velocity: new vec3_1.Vec3(0, 0, 0),
-            onGround: false,
-            isInWater: false,
-            isInLava: false,
-            isInWeb: false,
-            isCollidedHorizontally: false,
-            isCollidedVertically: false,
-            yaw: 0,
-            effects: {},
-        },
-        jumpTicks: 0,
-        jumpQueued: false,
-        version: "1.17.1",
-        inventory: {
-            slots: [],
-        },
-    };
-}
-//init (imports mcData to necessary modules).
-(0, index_1.initSetup)(mcData);
-//create fake bot
-const playerType = mcData.entitiesByName["player"]; // specify type we will be simulating.
-const fakePlayer = createFakePlayer(new vec3_1.Vec3(0, 80, 0)); // call function supplied by prismarine-physics
-fakePlayer.entity = (0, physicsUtils_1.applyMdToNewEntity)(settings_1.EPhysicsCtx, playerType, fakePlayer.entity); // ensure compatibility.
-// create physics context.
-const physics = new engines_1.EntityPhysics(mcData); // creates entity physics w/ environments specific to this entity.
-// create entity-specific physics context.
-const playerState = states_1.EntityState.CREATE_FROM_ENTITY(physics, fakePlayer.entity); // creates a simulation-compatible state.
-const playerCtx = settings_1.EPhysicsCtx.FROM_ENTITY_STATE(physics, playerState, playerType); // create wrapper context (supplies AABB, pose info, etc).
-// set control state.
-playerState.controlState = player_1.ControlStateHandler.DEFAULT(); // specific to players and mobs, specify control scheme to apply.
-playerState.controlState.forward = true;
-// simulate until on ground.
-while (!playerCtx.state.onGround) {
-    physics.simulate(playerCtx, fakeWorld).applyToBot(fakePlayer); // (applyToBot since fakePlayer is supposed to be a bot)
-    console.log(fakePlayer.entity.position, fakePlayer.entity.velocity);
-}
-playerCtx.state.controlState.set("jump", true);
-for (let i = 0; i < 12; i++) {
-    physics.simulate(playerCtx, fakeWorld).applyToBot(fakePlayer); // (applyToBot since fakePlayer is supposed to be a bot)
-    console.log(fakePlayer.entity.position, fakePlayer.entity.velocity);
-}
-if (playerState.controlState.forward) {
-    // expect(fakePlayer.entity.position).toEqual(new Vec3(0, 60, -3.4508449226731694)); // it works.
-}
-else {
-    // expect(fakePlayer.entity.position).toEqual(new Vec3(0, 60, 0)); // it works.
-}
-console.log(fakePlayer.entity.position); //manual run.

package/lib/tests/util/testUtils.d.ts

@@ -1,33 +0,0 @@
-import { Entity } from "prismarine-entity";
-import { Vec3 } from "vec3";
-import md from "minecraft-data";
-export default function load(version: string): {
-    mcData: md.IndexedData;
-    Block: any;
-    Entity: any;
-    fakeWorld: {
-        getBlock: (pos: {
-            x: number;
-            y: number;
-            z: number;
-        }) => any;
-    };
-    createFakePlayer: (pos: Vec3) => {
-        entity: Entity;
-        jumpTicks: number;
-        jumpQueued: boolean;
-        version: string;
-        inventory: {
-            slots: never[];
-        };
-        world: {
-            getBlock: (pos: {
-                x: number;
-                y: number;
-                z: number;
-            }) => any;
-        };
-    };
-    createFakeEntity: (name: string, pos: Vec3) => Entity;
-    modifyEntity: (name: string, entity: Entity) => void;
-};

package/lib/tests/util/testUtils.js

@@ -1,67 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const vec3_1 = require("vec3");
-const minecraft_data_1 = __importDefault(require("minecraft-data"));
-const prismarine_block_1 = __importDefault(require("prismarine-block"));
-const prismarine_entity_1 = __importDefault(require("prismarine-entity"));
-function load(version) {
-    const mcData = (0, minecraft_data_1.default)(version);
-    const Block = prismarine_block_1.default(version);
-    const Entity = prismarine_entity_1.default(version);
-    const fakeWorld = {
-        getBlock: (pos) => {
-            const type = pos.y < 60 ? mcData.blocksByName.stone.id : mcData.blocksByName.air.id;
-            const b = new Block(type, 0, 0);
-            b.position = pos;
-            return b;
-        },
-    };
-    const createFakeEntity = (name, pos) => {
-        if (!mcData.entitiesByName[name])
-            throw "invalid name";
-        const tmp = mcData.entitiesByName[name];
-        return {
-            name: name,
-            type: tmp.type,
-            height: tmp.height,
-            width: tmp.width,
-            position: pos,
-            velocity: new vec3_1.Vec3(0, 0, 0),
-            onGround: false,
-            isInWater: false,
-            isInLava: false,
-            isInWeb: false,
-            isCollidedHorizontally: false,
-            isCollidedVertically: false,
-            yaw: 0,
-            effects: {},
-            metadata: [],
-            equipment: new Array(6)
-        };
-    };
-    const modifyEntity = (name, entity) => {
-        var _a, _b;
-        if (!mcData.entitiesByName[name])
-            throw "invalid name";
-        const tmp = mcData.entitiesByName[name];
-        entity.height = (_a = tmp.height) !== null && _a !== void 0 ? _a : 0;
-        entity.width = (_b = tmp.width) !== null && _b !== void 0 ? _b : 0;
-    };
-    const createFakePlayer = (pos) => {
-        return {
-            entity: createFakeEntity("player", pos),
-            jumpTicks: 0,
-            jumpQueued: false,
-            version: "1.17.1",
-            inventory: {
-                slots: [],
-            },
-            world: fakeWorld
-        };
-    };
-    return { mcData, Block, Entity, fakeWorld, createFakePlayer, createFakeEntity, modifyEntity };
-}
-exports.default = load;