@minecraft/debug-utilities 1.0.0-beta.1.26.3-stable → 1.0.0-beta.1.26.30-preview.21

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

@@ -44,6 +44,7 @@ export class DebugArrow extends DebugLine {
      * The number of segments for the base circle of the arrow's
      * head/tip (default: 4).
      *
+     * Bounds: [3, 128]
      */
     headSegments: number;
     constructor(
@@ -143,7 +144,7 @@ export class DebugShape {
      * The color of the shape.
      *
      */
-    color: minecraftserver.RGB;
+    color: minecraftserver.RGBA;
     /**
      * @remarks
      * The dimension the shape is visible within. If the dimension
@@ -166,6 +167,16 @@ export class DebugShape {
      *
      */
     readonly location: minecraftserver.Vector3;
+    /**
+     * @remarks
+     * If defined, this distance will be used to determine how far
+     * away this shape will be rendered for each client. By default
+     * the distance will match the client's render distance
+     * setting.
+     *
+     * Minimum Value: 0
+     */
+    maximumRenderDistance?: number;
     /**
      * @remarks
      * The rotation of the shape (Euler angles - [Pitch, Yaw,
@@ -231,18 +242,72 @@ export class DebugSphere extends DebugShape {
 }
 
 /**
- * A debug shape class that a text label. The text label
- * automatically faces the screen.
+ * A debug shape class that represents a text label in the
+ * world with a background.
  */
 // @ts-ignore Class inheritance allowed for native defined classes
 export class DebugText extends DebugShape {
     /**
      * @remarks
-     * The text of the shape to display.
+     * If set to true, the debug text will render the back-face of
+     * the background. Defaults to true but will always be false if
+     * 'useRotation' is set to false.
+     *
+     */
+    backfaceVisible: boolean;
+    /**
+     * @remarks
+     * The color of the background plate of the text. If set to
+     * undefined, it will use the default color.
+     *
+     */
+    backgroundColorOverride?: minecraftserver.RGBA;
+    /**
+     * @remarks
+     * If set to true, the text will be hidden behind blocks or
+     * entities. By default this is set to false (will always
+     * render).
+     *
+     */
+    depthTest: boolean;
+    /**
+     * @remarks
+     * Get the text of the debug text shape. Returns the RawText of
+     * the debug text if `setText` was called with a RawMessage or
+     * a RawText object, otherwise returns a string.
+     *
+     */
+    readonly text: minecraftserver.RawMessage | string;
+    /**
+     * @remarks
+     * If set to true, the debug text will render the back-face of
+     * the text. Defaults to true but will always be false if
+     * 'useRotation' is set to false.
+     *
+     */
+    textBackfaceVisible: boolean;
+    /**
+     * @remarks
+     * If set to true, the text will not face the camera and
+     * instead will use the rotation from the shape.
+     *
+     */
+    useRotation: boolean;
+    constructor(
+        location: minecraftserver.DimensionLocation | minecraftserver.Vector3,
+        text: minecraftserver.RawMessage | string,
+    );
+    /**
+     * @remarks
+     * Sets the text to display.
+     *
+     * @throws This function can throw errors.
+     *
+     * {@link minecraftcommon.ArgumentOutOfBoundsError}
      *
+     * {@link minecraftserver.RawMessageError}
      */
-    text: string;
-    constructor(location: minecraftserver.DimensionLocation | minecraftserver.Vector3, text: string);
+    setText(text: minecraftserver.RawMessage | string): void;
 }
 
 export interface HandleCounts {

package/package.json

@@ -1,20 +1,20 @@
-{
-  "name": "@minecraft/debug-utilities",
-  "version": "1.0.0-beta.1.26.3-stable",
-  "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"
+{
+  "name": "@minecraft/debug-utilities",
+  "version": "1.0.0-beta.1.26.30-preview.21",
+  "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"
 }