@minecraft/debug-utilities 1.0.0-beta.1.21.95-stable → 1.0.0-beta.1.26.0-preview.24

package/README.md

@@ -1,9 +1,9 @@
-# `@minecraft/debug-utilities`
-
-Contains debug utility functions.
-
-## **NOTE: This version of this module is still in pre-release.  It may change or it may be removed in future releases.**
-
-See full documentation for this module here:
-
+# `@minecraft/debug-utilities`
+
+Contains debug utility functions.
+
+## **NOTE: This version of this module is still in pre-release.  It may change or it may be removed in future releases.**
+
+See full documentation for this module here:
+
 https://learn.microsoft.com/en-us/minecraft/creator/scriptapi/minecraft/debug-utilities/minecraft-debug-utilities

package/index.d.ts

@@ -46,7 +46,10 @@ export class DebugArrow extends DebugLine {
      *
      */
     headSegments: number;
-    constructor(location: minecraftserver.Vector3, endLocation: minecraftserver.Vector3);
+    constructor(
+        location: minecraftserver.DimensionLocation | minecraftserver.Vector3,
+        endLocation: minecraftserver.Vector3,
+    );
 }
 
 /**
@@ -61,7 +64,7 @@ export class DebugBox extends DebugShape {
      *
      */
     bound: minecraftserver.Vector3;
-    constructor(location: minecraftserver.Vector3);
+    constructor(location: minecraftserver.DimensionLocation | minecraftserver.Vector3);
 }
 
 /**
@@ -69,7 +72,7 @@ export class DebugBox extends DebugShape {
  */
 // @ts-ignore Class inheritance allowed for native defined classes
 export class DebugCircle extends DebugShape {
-    constructor(location: minecraftserver.Vector3);
+    constructor(location: minecraftserver.DimensionLocation | minecraftserver.Vector3);
 }
 
 /**
@@ -87,7 +90,7 @@ export class DebugDrawer {
      * DebugLine, DebugCircle, DebugSphere, DebugArrow or
      * DebugText.
      */
-    addShape(shape: DebugShape): void;
+    addShape(shape: DebugShape, dimension?: minecraftserver.Dimension): void;
     /**
      * @remarks
      * Removes all debug shapes from the world.
@@ -115,7 +118,10 @@ export class DebugLine extends DebugShape {
      *
      */
     endLocation: minecraftserver.Vector3;
-    constructor(location: minecraftserver.Vector3, endLocation: minecraftserver.Vector3);
+    constructor(
+        location: minecraftserver.DimensionLocation | minecraftserver.Vector3,
+        endLocation: minecraftserver.Vector3,
+    );
 }
 
 /**
@@ -130,6 +136,13 @@ export class DebugShape {
      *
      */
     color: minecraftserver.RGB;
+    /**
+     * @remarks
+     * The dimension the shape is visible within. If the dimension
+     * is undefined, it will display in all dimensions.
+     *
+     */
+    readonly dimension: minecraftserver.Dimension;
     /**
      * @remarks
      * Returns true if the shape has a limited time span before
@@ -139,12 +152,12 @@ export class DebugShape {
     readonly hasDuration: boolean;
     /**
      * @remarks
-     * The location of the shape. For most shapes this is the
-     * centre of the shape, except DebugLine and DebugArrow where
-     * this represents the start point of the line.
+     * The location of the shape. For most shapes the location is
+     * the centre of the shape, except DebugLine and DebugArrow
+     * where this represents the start point of the line.
      *
      */
-    location: minecraftserver.Vector3;
+    readonly location: minecraftserver.Vector3;
     /**
      * @remarks
      * The rotation of the shape (Euler angles - [Pitch, Yaw,
@@ -162,16 +175,16 @@ export class DebugShape {
     /**
      * @remarks
      * The time left (in seconds) until this shape is automatically
-     * removed. Returns 0 if the shape does not have a limited
-     * life-span.
+     * removed. Returns undefined if the shape does not have a
+     * limited life-span.
      *
      */
     timeLeft?: number;
     /**
      * @remarks
      * The total initial time-span (in seconds) until this shape is
-     * automatically removed. Returns 0 if the shape does not have
-     * a limited life-span.
+     * automatically removed. Returns undefined if the shape does
+     * not have a limited life-span.
      *
      */
     readonly totalTimeLeft?: number;
@@ -182,6 +195,16 @@ export class DebugShape {
      *
      */
     remove(): void;
+    /**
+     * @remarks
+     * Set the location and dimension of the shape. If the
+     * dimension is undefined, it will display in all dimensions.
+     * For most shapes the location is the centre of the shape,
+     * except DebugLine and DebugArrow where this represents the
+     * start point of the line.
+     *
+     */
+    setLocation(location: minecraftserver.DimensionLocation | minecraftserver.Vector3): void;
 }
 
 /**
@@ -189,7 +212,7 @@ export class DebugShape {
  */
 // @ts-ignore Class inheritance allowed for native defined classes
 export class DebugSphere extends DebugShape {
-    constructor(location: minecraftserver.Vector3);
+    constructor(location: minecraftserver.DimensionLocation | minecraftserver.Vector3);
 }
 
 /**
@@ -204,7 +227,7 @@ export class DebugText extends DebugShape {
      *
      */
     text: string;
-    constructor(location: minecraftserver.Vector3, text: string);
+    constructor(location: minecraftserver.DimensionLocation | minecraftserver.Vector3, text: string);
 }
 
 export interface HandleCounts {
@@ -229,6 +252,7 @@ export interface RuntimeStats {
     functionLineCount: number;
     functionSize: number;
     memoryAllocatedCount: number;
+    memoryAllocatedLimit: number;
     memoryAllocatedSize: number;
     memoryUsedCount: number;
     memoryUsedSize: number;

package/package.json

@@ -1,20 +1,20 @@
-{
-  "name": "@minecraft/debug-utilities",
-  "version": "1.0.0-beta.1.21.95-stable",
-  "description": "",
-  "contributors": [
-    {
-      "name": "Jake Shirley",
-      "email": "jake@xbox.com"
-    },
-    {
-      "name": "Mike Ammerlaan",
-      "email": "mikeam@microsoft.com"
-    }
-  ],
-  "dependencies": {
-    "@minecraft/common": "^1.0.0",
-    "@minecraft/server": "^1.17.0 || ^2.0.0"
-  },
-  "license": "MIT"
+{
+  "name": "@minecraft/debug-utilities",
+  "version": "1.0.0-beta.1.26.0-preview.24",
+  "description": "",
+  "contributors": [
+    {
+      "name": "Jake Shirley",
+      "email": "jake@xbox.com"
+    },
+    {
+      "name": "Mike Ammerlaan",
+      "email": "mikeam@microsoft.com"
+    }
+  ],
+  "peerDependencies": {
+    "@minecraft/common": "^1.0.0",
+    "@minecraft/server": "^1.17.0 || ^2.0.0"
+  },
+  "license": "MIT"
 }