@starktma/minecraft-utils 1.2.0 → 1.2.1

package/README.md

@@ -0,0 +1,77 @@
+# Database Management in Minecraft: TypeScript Edition
+
+PropertyDatabase is a TypeScript-based database management system designed for use within Minecraft. The system consists of two main classes: `DatabaseManager` and `SimpleDatabase`, which handle JSON database operations in the Minecraft world.
+
+## Features
+
+- **Entity & World Targeting**: Ability to target either an entity or the Minecraft world for storing data.
+- **JSON Database Operations**: Supports basic CRUD (Create, Read, Update, Delete) operations for JSON databases.
+- **Custom Object Management**: Facilitates storing and managing custom objects with unique IDs.
+
+## Installation
+
+1. Ensure you have the Minecraft server set up with the appropriate scripting API support.
+2. Install the PropertyDatabase module `@starktma/minecraft-utils` using your preferred method (e.g., npm, yarn).
+3. Place the PropertyDatabase module in your server's script directory or in the assets/javascript directory if you're using Anvil.
+
+## Usage
+
+### DatabaseManager Class
+
+Handles JSON databases in Minecraft's world properties. Can target an entity or the world itself.
+
+#### Methods:
+
+- `hasJSONDatabase(databaseName: string)`: Checks if a database exists.
+- `addJSONDatabase(databaseName: string, database: object)`: Adds a new database.
+- `removeJSONDatabase(databaseName: string)`: Removes a database.
+- `getJSONDatabase(databaseName: string)`: Retrieves a database.
+
+### SimpleDatabase Class
+
+A base class for managing databases of custom objects.
+
+#### Methods:
+
+- `addObject(object: SimpleObject)`: Adds a new object to the database.
+- `updateObject(object: SimpleObject)`: Updates an existing object.
+- `hasObject(id: string)`: Checks if an object exists.
+- `getObject(id: string)`: Retrieves an object by ID.
+- `removeObject(id: string)`: Removes an object.
+- `getAllObjects()`: Retrieves all objects.
+- `eraseAllObjects()`: Clears the database.
+- `forEach(callback: Function)`: Iterates over objects.
+
+### SimpleObject Interface
+
+A basic interface for objects managed by `SimpleDatabase`. Must include an `id` property.
+
+## NOTE
+
+The `DatabaseManager` class is designed to handle JSON databases in Minecraft's world properties and cannot be used directly. Its main job is to convert your database to string formats that can be stored on dynamic properties and back.
+
+The `DatabaseManager` class is responsible for deconstructing and reconstructing the database from JSON strings to work around the dynamic property size limits in Minecraft [`32767`].
+
+The `SimpleDatabase` class uses the `DatabaseManager` to manage custom objects. It provides methods to add, update, retrieve, and remove objects, as well as to iterate over all objects in the database.
+
+The `SimpleDatabase` is intended to be inherited by custom object classes. It requires an `id` property to uniquely identify each object and can be extended with additional properties as needed.
+
+The `SimpleObject` interface defines the structure of objects that can be managed by `SimpleDatabase`. It includes an `id` property, which is essential for identifying objects within the database, and can be extended with additional properties to structure your own database objects.
+
+## Examples
+
+### Creating a Custom Database
+
+```typescript
+class MyDatabase extends SimpleDatabase {
+	constructor() {
+		super("my_database");
+	}
+
+	addObject(object: MyObject) {
+		super.addObject(object);
+	}
+
+	// Additional custom methods...
+}
+```

package/dist/database/database.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"database.d.ts","sourceRoot":"","sources":["../../src/database/database.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAgB,MAAM,mBAAmB,CAAC;AACzD,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AA0I5C;;;;;;;;;;;;;;;;;;GAkBG;AACH,qBAAa,cAAc,CAAC,CAAC,SAAS,YAAY;IACjD,OAAO,CAAC,MAAM,CAAkB;IAChC,OAAO,CAAC,OAAO,CAAM;IAErB,SAAS,CAAC,YAAY,EAAE,MAAM,CAAC;IAE/B;;;;OAIG;IACH,SAAS,aAAa,YAAY,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,SAAS;IAYtE;;;;OAIG;IACH,OAAO,CAAC,YAAY;IAIpB;;;;OAIG;IACH,OAAO,CAAC,SAAS;IAIjB;;;OAGG;IACH,SAAS,CAAC,MAAM,EAAE,CAAC,GAAG,IAAI;IAK1B;;;;OAIG;IACH,YAAY,CAAC,MAAM,EAAE,CAAC,GAAG,IAAI;IAO7B;;;;OAIG;IACH,SAAS,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO;IAI9B;;;;OAIG;IACH,SAAS,CAAC,EAAE,EAAE,MAAM,GAAG,CAAC,GAAG,SAAS;IAIpC;;;OAGG;IACH,YAAY,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI;IAK9B;;;OAGG;IACH,aAAa,IAAI,CAAC,EAAE;IAIpB;;OAEG;IACH,eAAe,IAAI,IAAI;IAKvB;;;OAGG;IACH,OAAO,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,YAAY,EAAE,KAAK,EAAE,MAAM,KAAK,IAAI,GAAG,IAAI;CAGtE"}
+{"version":3,"file":"database.d.ts","sourceRoot":"","sources":["../../src/database/database.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAgB,MAAM,mBAAmB,CAAC;AACzD,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AA0I5C;;;;;;;;;;;;;;;;;;GAkBG;AACH,qBAAa,cAAc,CAAC,CAAC,SAAS,YAAY;IACjD,OAAO,CAAC,MAAM,CAAkB;IAChC,OAAO,CAAC,OAAO,CAAM;IAErB,SAAS,CAAC,YAAY,EAAE,MAAM,CAAC;IAE/B;;;;OAIG;IACH,SAAS,aAAa,YAAY,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS;IAYvE;;;;OAIG;IACH,OAAO,CAAC,YAAY;IAIpB;;;;OAIG;IACH,OAAO,CAAC,SAAS;IAIjB;;;OAGG;IACH,SAAS,CAAC,MAAM,EAAE,CAAC,GAAG,IAAI;IAK1B;;;;OAIG;IACH,YAAY,CAAC,MAAM,EAAE,CAAC,GAAG,IAAI;IAO7B;;;;OAIG;IACH,SAAS,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO;IAI9B;;;;OAIG;IACH,SAAS,CAAC,EAAE,EAAE,MAAM,GAAG,CAAC,GAAG,SAAS;IAIpC;;;OAGG;IACH,YAAY,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI;IAK9B;;;OAGG;IACH,aAAa,IAAI,CAAC,EAAE;IAIpB;;OAEG;IACH,eAAe,IAAI,IAAI;IAKvB;;;OAGG;IACH,OAAO,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,YAAY,EAAE,KAAK,EAAE,MAAM,KAAK,IAAI,GAAG,IAAI;CAGtE"}

package/dist/minecraft/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/minecraft/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACN,MAAM,EACN,MAAM,EACN,KAAK,EACL,OAAO,EAEP,iBAAiB,EACjB,OAAO,EAOP,MAAM,mBAAmB,CAAC;AAG3B,wBAAgB,kBAAkB,CAAC,WAAW,EAAE,KAAK,GAAG,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM,WA4BnG;AAED,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,EAAE,GAAG,OAAO,EAAE,GAAG,QAO3E;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAGnD;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,QAAQ,EAAE,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,QAAQ,GAAE,MAAU,GAAG,OAAO,CAUjG;AAED,wBAAgB,wBAAwB,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,iBAAiB,CAO3F;AAED,wBAAgB,4BAA4B,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,OAAO,CAapF;AAED,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,QAwC1D;AAED,wBAAgB,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,QAAQ,GAAE,OAAe,GAAG,MAAM,CAuD3F"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/minecraft/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACN,MAAM,EACN,MAAM,EACN,KAAK,EACL,OAAO,EAEP,iBAAiB,EACjB,OAAO,EAOP,MAAM,mBAAmB,CAAC;AAG3B,wBAAgB,kBAAkB,CAAC,WAAW,EAAE,KAAK,GAAG,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM,WA4BnG;AAED,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,EAAE,GAAG,OAAO,EAAE,GAAG,QAO3E;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAKnD;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,QAAQ,EAAE,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,QAAQ,GAAE,MAAU,GAAG,OAAO,CAUjG;AAED,wBAAgB,wBAAwB,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,iBAAiB,CAQ1F;AAED,wBAAgB,4BAA4B,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,OAAO,CAapF;AAED,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,QAwC1D;AAED,wBAAgB,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,QAAQ,GAAE,OAAe,GAAG,MAAM,CAuD3F"}

package/dist/player-event/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/player-event/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAGN,MAAM,EAEN,yBAAyB,EACzB,wBAAwB,EAGxB,SAAS,EACT,MAAM,mBAAmB,CAAC;AAG3B,KAAK,aAAa,CAAC,CAAC,GAAG,YAAY,IAAI,CAAC,MAAM,EAAE,CAAC,KAAK,IAAI,CAAC;AAE3D,aAAK,kBAAkB;IACtB,IAAI,SAAS;IACb,SAAS,cAAc;IACvB,QAAQ,aAAa;IACrB,OAAO,YAAY;IACnB,UAAU,eAAe;IACzB,SAAS,cAAc;IACvB,QAAQ,aAAa;CACrB;AAED,aAAK,WAAW;IACf,eAAe,mCAAmC;CAClD;AAED,KAAK,eAAe,GAAG,kBAAkB,GAAG,MAAM,CAAC;AAEnD,cAAM,UAAU,CAAC,CAAC,GAAG,YAAY;IAChC,OAAO,CAAC,SAAS,CAAkD;;IASnE,OAAO,CAAC,GAAG;IAIX,OAAO,CAAC,IAAI,EAAE,eAAe,EAAE,MAAM,EAAE,CAAC;IAOxC,EAAE,CAAC,IAAI,EAAE,eAAe,EAAE,QAAQ,EAAE,aAAa,CAAC,CAAC,CAAC;IAQpD,GAAG,CAAC,IAAI,EAAE,eAAe,EAAE,QAAQ,EAAE,aAAa,CAAC,CAAC,CAAC;CASrD;AAED,cAAM,YAAY;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,SAAK;IACd,QAAQ,SAAK;IACb,SAAS,SAAK;gBAEF,MAAM,EAAE,MAAM;IAK1B,IAAI,mBAAmB,IACoD,yBAAyB,CACnG;IAED,IAAI,kBAAkB,IACoD,wBAAwB,CACjG;IAED,eAAe,IAAI,SAAS,GAAG,SAAS;IAIxC,KAAK;IAOL,IAAI;CAmBJ;AAED,cAAM,aAAa,CAAC,CAAC,SAAS,YAAY,GAAG,YAAY;IACxD,OAAO,CAAC,OAAO,CAAwB;IACvC,OAAO,CAAC,MAAM,CAAoC;IAElD,SAAS;IA2BT,SAAS,CAAC,mBAAmB,CAAC,MAAM,EAAE,MAAM,GAAG,CAAC;IAIhD,SAAS,CAAC,EAAE,EAAE,MAAM;IAIpB,YAAY,CAAC,EAAE,EAAE,MAAM;IAIvB,SAAS,CAAC,MAAM,EAAE,MAAM;IAKxB,cAAc,CAAC,OAAO,EAAE,MAAM;;;IAM9B,SAAS,CAAC,OAAO,EAAE,MAAM;IAIzB,IAAI;CAWJ;AAED,OAAO,EAAE,kBAAkB,EAAE,WAAW,EAAE,YAAY,EAAE,aAAa,EAAE,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/player-event/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAGN,MAAM,EAEN,yBAAyB,EACzB,wBAAwB,EAGxB,SAAS,EACT,MAAM,mBAAmB,CAAC;AAE3B,KAAK,aAAa,CAAC,CAAC,GAAG,YAAY,IAAI,CAAC,MAAM,EAAE,CAAC,KAAK,IAAI,CAAC;AAC3D,KAAK,eAAe,GAAG,kBAAkB,GAAG,MAAM,CAAC;AAEnD,aAAK,kBAAkB;IACtB,IAAI,SAAS;IACb,SAAS,cAAc;IACvB,QAAQ,aAAa;IACrB,OAAO,YAAY;IACnB,UAAU,eAAe;IACzB,SAAS,cAAc;IACvB,QAAQ,aAAa;CACrB;AAED,cAAM,UAAU,CAAC,CAAC,GAAG,YAAY;IAChC,OAAO,CAAC,SAAS,CAAkD;;IASnE,OAAO,CAAC,GAAG;IAIX,OAAO,CAAC,IAAI,EAAE,eAAe,EAAE,MAAM,EAAE,CAAC;IAOxC,EAAE,CAAC,IAAI,EAAE,eAAe,EAAE,QAAQ,EAAE,aAAa,CAAC,CAAC,CAAC;IAQpD,GAAG,CAAC,IAAI,EAAE,eAAe,EAAE,QAAQ,EAAE,aAAa,CAAC,CAAC,CAAC;CASrD;AAED,cAAM,YAAY;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,SAAK;IACd,QAAQ,SAAK;IACb,SAAS,SAAK;gBAEF,MAAM,EAAE,MAAM;IAK1B,IAAI,mBAAmB,IACoD,yBAAyB,CACnG;IAED,IAAI,kBAAkB,IACoD,wBAAwB,CACjG;IAED,eAAe,IAAI,SAAS,GAAG,SAAS;IAIxC,KAAK;IAML,IAAI;CAmBJ;AAED,cAAM,aAAa,CAAC,CAAC,SAAS,YAAY,GAAG,YAAY;IACxD,OAAO,CAAC,OAAO,CAAwB;IACvC,OAAO,CAAC,MAAM,CAAoC;IAElD,SAAS;IAwBT,SAAS,CAAC,mBAAmB,CAAC,MAAM,EAAE,MAAM,GAAG,CAAC;IAIhD,SAAS,CAAC,EAAE,EAAE,MAAM;IAIpB,YAAY,CAAC,EAAE,EAAE,MAAM;IAIvB,SAAS,CAAC,MAAM,EAAE,MAAM;IAKxB,cAAc,CAAC,OAAO,EAAE,MAAM;;;IAM9B,SAAS,CAAC,OAAO,EAAE,MAAM;IAIzB,IAAI;CAWJ;AAED,OAAO,EAAE,kBAAkB,EAAE,YAAY,EAAE,aAAa,EAAE,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@starktma/minecraft-utils",
-	"version": "1.2.0",
+	"version": "1.2.1",
 	"description": "",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",

package/src/database/database.ts

@@ -167,7 +167,7 @@ export class SimpleDatabase<T extends SimpleObject> {
 	 * @param databaseName The name of the database.
 	 * @param target The target entity to store the database in. If undefined, the database is stored in the world.
 	 */
-	protected constructor(databaseName: string, target: Entity | undefined) {
+	protected constructor(databaseName: string, target?: Entity | undefined) {
 		this.mainDB = new DatabaseManager(target);
 		this.databaseName = databaseName;
 

package/src/minecraft/index.ts

@@ -13,7 +13,7 @@ import {
 	EquipmentSlot,
 	ItemStack,
 } from "@minecraft/server";
-import { calculateDistance, toRadians, toUnsigned } from "../math";
+import { calculateDistance, toRadians, toSigned, toUnsigned } from "../math";
 
 export function getBlocksInASphere(centerBlock: Block | Entity, radius: number, innerRadius?: number) {
 	if (centerBlock) {
@@ -62,7 +62,9 @@ export function displayActionbar(player: Player | undefined, ...message: any) {
  */
 export function snapYawToGrid(angle: number): number {
 	const gridSize = 90;
-	return Math.round(toUnsigned(angle) / gridSize) * gridSize;
+	// Round to nearest grid step, then normalize into [0, 360)
+	const snapped = Math.round(toUnsigned(angle) / gridSize) * gridSize;
+	return ((snapped % 360) + 360) % 360;
 }
 
 /**
@@ -83,12 +85,13 @@ export function snapLocationToGrid(location: Vector3, yaw: Vector2, gridSize: nu
 	};
 }
 
-export function getStructureRotationEnum(angle: number, saveYaw?: number): StructureRotation {
-	const EPS = 1e-4;
-	const diff = snapYawToGrid(angle) - snapYawToGrid(saveYaw ?? 0);
-	if (Math.abs(diff - 90) < EPS) return StructureRotation.Rotate90;
-	if (Math.abs(diff - 180) < EPS) return StructureRotation.Rotate180;
-	if (Math.abs(diff - 270) < EPS) return StructureRotation.Rotate270;
+export function getStructureRotationEnum(angle: number, offset?: number): StructureRotation {
+	const diff = snapYawToGrid(toUnsigned(angle - (offset ?? 0)));
+	console.log(diff);
+
+	if (Math.abs(diff - 90) < Number.EPSILON) return StructureRotation.Rotate90;
+	if (Math.abs(diff - 180) < Number.EPSILON) return StructureRotation.Rotate180;
+	if (Math.abs(diff - 270) < Number.EPSILON) return StructureRotation.Rotate270;
 	return StructureRotation.None;
 }
 

package/src/player-event/index.ts

@@ -9,9 +9,9 @@ import {
 	InputButton,
 	ItemStack,
 } from "@minecraft/server";
-import { NAMESPACE } from "./constants";
 
 type EventCallback<T = CustomPlayer> = (player: T) => void;
+type PlayerEventType = CustomPlayerEvents | string;
 
 enum CustomPlayerEvents {
 	Tick = "tick",
@@ -23,12 +23,6 @@ enum CustomPlayerEvents {
 	SneakEnd = "sneakEnd",
 }
 
-enum PropertyIDs {
-	OriginalNameTag = `${NAMESPACE}:original_name_tag`,
-}
-
-type PlayerEventType = CustomPlayerEvents | string;
-
 class EventGroup<T = CustomPlayer> {
 	private callbacks = new Map<PlayerEventType, EventCallback<T>[]>();
 
@@ -93,7 +87,6 @@ class CustomPlayer {
 	}
 
 	reset() {
-		this.player.nameTag = (this.player.getDynamicProperty(PropertyIDs.OriginalNameTag) as string | undefined) ?? this.player.nameTag;
 		this.stateTick = 0;
 		this.JumpTick = 0;
 		this.player.camera.clear();
@@ -101,8 +94,8 @@ class CustomPlayer {
 
 	tick() {
 		this.stateTick++;
-
-		if (this.player.inputInfo.getButtonState(InputButton.Jump) === ButtonState.Pressed && !this.player.isOnGround) {
+		
+		if (this.player.inputInfo.getButtonState(InputButton.Jump) === ButtonState.Pressed) {
 			this.JumpTick++;
 		} else if (this.JumpTick > 0) {
 			this.JumpTick = -1;
@@ -142,9 +135,6 @@ class PlayerManager<T extends CustomPlayer = CustomPlayer> {
 
 		world.afterEvents.worldLoad.subscribe(() => {
 			world.getAllPlayers().forEach((player) => this.addPlayer(player));
-		});
-
-		world.afterEvents.worldLoad.subscribe(() => {
 			system.runInterval(() => {
 				this.tick();
 			});
@@ -191,4 +181,4 @@ class PlayerManager<T extends CustomPlayer = CustomPlayer> {
 	}
 }
 
-export { CustomPlayerEvents, PropertyIDs, CustomPlayer, PlayerManager };
+export { CustomPlayerEvents, CustomPlayer, PlayerManager };

package/dist/player-event/constants.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../src/player-event/constants.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,SAAS,iBAAiB,CAAC"}

package/src/player-event/constants.ts

@@ -1 +0,0 @@
-export const NAMESPACE = 'player-event';