@minecraft/server 1.0.0-beta.11940b24 → 1.0.0-beta.release.1.19.40

package/index.d.ts

@@ -648,6 +648,10 @@ export class Block {
      * @throws This property can throw when used.
      */
     readonly 'type': BlockType;
+    /**
+     * Identifier of the type of block for this block.
+     * @throws This property can throw when used.
+     */
     readonly typeId: string;
     /**
      * X coordinate of the block.
@@ -1967,10 +1971,28 @@ export class BlockRecordPlayerComponent extends BlockComponent {
     setRecord(recordItemType: ItemType): void;
     protected constructor();
 }
+/**
+ * Represents a block that can display text on it.
+ */
 export class BlockSignComponent extends BlockComponent {
+    /**
+     * Location of the sign.
+     */
     readonly location: BlockLocation;
+    /**
+     * Text of the sign
+     * @throws This property can throw when used.
+     */
     readonly text: string;
+    /**
+     * Identifier of this component. Should always be
+     * minecraft:sign.
+     */
     readonly typeId: string;
+    /**
+     * Identifier of this component. Should always be
+     * minecraft:sign.
+     */
     static readonly componentId = 'minecraft:sign';
     protected constructor();
 }
@@ -2543,31 +2565,13 @@ export class Dimension {
      * @throws This function can throw errors.
      */
     getPlayers(getPlayers?: EntityQueryOptions): PlayerIterator;
-    /**
-     * @remarks
-     * Runs a particular command from the context of the broader
-     * dimension.
-     * @param commandString
-     * Command to run. Note that command strings should not start
-     * with slash.
-     * @returns
-     * For commands that return data, returns a JSON structure with
-     * command response values.
-     * @throws This function can throw errors.
-     * @example commands.js
-     * ```typescript
-     *        world.getDimension("overworld").runCommand("say You got a new high score!");
-     *        world.getDimension("overworld").runCommand("scoreboard players set @p score 10");
-     *
-     * ```
-     */
     runCommand(commandString: string): any;
     /**
      * @remarks
      * Runs a particular command asynchronously from the context of
-     * the broader dimension. Where possible - and especially for
-     * long-running operations - you should use runCommandAsync
-     * over runCommand.
+     * the broader dimension.  Note that there is a maximum queue
+     * of 128 asynchronous commands that can be run in a given
+     * tick.
      * @param commandString
      * Command to run. Note that command strings should not start
      * with slash.
@@ -3116,30 +3120,12 @@ export class Entity {
      * @throws This function can throw errors.
      */
     removeTag(tag: string): boolean;
-    /**
-     * @remarks
-     * Runs a particular command from the context of this entity.
-     * @param commandString
-     * Command to run. Note that command strings should not start
-     * with slash.
-     * @returns
-     * For commands that return data, returns a JSON structure with
-     * command response values.
-     * @throws This function can throw errors.
-     * @example commands.js
-     * ```typescript
-     *        entity.runCommand("say You got a new high score!");
-     *        entity.runCommand("scoreboard players set @p score 10");
-     *
-     * ```
-     */
     runCommand(commandString: string): any;
     /**
      * @remarks
      * Runs a particular command asynchronously from the context of
-     * this entity. Where possible, running a command
-     * asynchronously is recommended, especially for long running
-     * operations.
+     * this entity. Note that there is a maximum queue of 128
+     * asynchronous commands that can be run in a given tick.
      * @param commandString
      * Command to run. Note that command strings should not start
      * with slash.
@@ -5829,6 +5815,10 @@ export class Events {
      * This event fires when a lever activates or is deactivated.
      */
     readonly leverActivate: LeverActionEventSignal;
+    /**
+     * This event is an internal implementation detail, and is
+     * otherwise not currently functional.
+     */
     readonly messageReceive: ServerMessageSignal;
     /**
      * This event fires when a piston expands or retracts.
@@ -6173,6 +6163,10 @@ export class ItemCooldownComponent {
      * @throws This property can throw when used.
      */
     readonly cooldownTicks: number;
+    /**
+     * Identifier of this component. Should always be
+     * 'minecraft:cooldown'.
+     */
     static readonly componentId = 'minecraft:cooldown';
     /**
      * @remarks
@@ -6247,6 +6241,10 @@ export class ItemDurabilityComponent {
      * @throws This property can throw when used.
      */
     readonly maxDurability: number;
+    /**
+     * Identifier of this component. Should always be
+     * 'minecraft:durability'.
+     */
     static readonly componentId = 'minecraft:durability';
     /**
      * @remarks
@@ -6272,6 +6270,9 @@ export class ItemEnchantsComponent {
      * item stack.
      */
     enchantments: EnchantmentList;
+    /**
+     * Identifier of this component.
+     */
     static readonly componentId = 'minecraft:enchantments';
     /**
      * @remarks
@@ -6312,6 +6313,10 @@ export class ItemFoodComponent {
      * @throws This property can throw when used.
      */
     readonly usingConvertsTo: string;
+    /**
+     * Identifier of this component. Should always be
+     * 'minecraft:food'.
+     */
     static readonly componentId = 'minecraft:food';
     protected constructor();
 }
@@ -6390,6 +6395,11 @@ export class ItemStack {
      * Given name of this stack of items.
      */
     nameTag?: string;
+    /**
+     * Identifier of the type of items for the stack. If a
+     * namespace is not specified, 'minecraft:' is assumed.
+     * Examples include 'wheat' or 'apple'.
+     */
     readonly typeId: string;
     /**
      * @remarks
@@ -13135,30 +13145,12 @@ export class Player extends Entity {
      * @throws This function can throw errors.
      */
     removeTag(tag: string): boolean;
-    /**
-     * @remarks
-     * Runs a particular command from the context of this player.
-     * @param commandString
-     * Command to run. Note that command strings should not start
-     * with slash.
-     * @returns
-     * For commands that return data, returns a JSON structure with
-     * command response values.
-     * @throws This function can throw errors.
-     * @example commands.js
-     * ```typescript
-     *        player.runCommand("say You got a new high score!");
-     *        player.runCommand("scoreboard players set @s score 10");
-     *
-     * ```
-     */
     runCommand(commandString: string): any;
     /**
      * @remarks
      * Runs a particular command asynchronously from the context of
-     * this entity. Where possible, running a command
-     * asynchronously is recommended, especially for long running
-     * operations.
+     * this entity.  Note that there is a maximum queue of 128
+     * asynchronous commands that can be run in a given tick.
      * @param commandString
      * Command to run. Note that command strings should not start
      * with slash.
@@ -13758,6 +13750,18 @@ export class System {
      * lifecycle of items in the Minecraft system.
      */
     readonly events: SystemEvents;
+    /**
+     * @remarks
+     * Runs a specified function at a future time. This is
+     * frequently used to implement delayed behaviors and game
+     * loops.
+     * @param callback
+     * Function callback to run when the tickDelay time criteria is
+     * met.
+     * @returns
+     * An opaque identifier that can be used with the `clearRun`
+     * function to cancel the execution of this run.
+     */
     run(callback: (arg: TickEvent) => void): void;
     protected constructor();
 }
@@ -14035,6 +14039,10 @@ export class World {
      */
     readonly scoreboard: Scoreboard;
     broadcastClientMessage(id: string, value: string): void;
+    /**
+     * @remarks
+     * Returns the absolute time since the start of the world.
+     */
     getAbsoluteTime(): number;
     /**
      * @param dimensionId
@@ -14063,6 +14071,10 @@ export class World {
      * @throws This function can throw errors.
      */
     getPlayers(options?: EntityQueryOptions): PlayerIterator;
+    /**
+     * @remarks
+     * Sets the current game time of the day.
+     */
     getTime(): number;
     /**
      * @remarks
@@ -14110,6 +14122,11 @@ export class World {
      * @throws This function can throw errors.
      */
     setDynamicProperty(identifier: string, value: boolean | number | string): void;
+    /**
+     * @remarks
+     * Returns the current game time of the day.
+     * @param timeOfDay
+     */
     setTime(timeOfDay: number): void;
     /**
      * @remarks
@@ -14367,17 +14384,49 @@ export interface ExplosionOptions {
      */
     source?: Entity;
 }
+/**
+ * An interface that describes the signature of a message that
+ * is passed into a say/tell API request.
+ */
 // tslint:disable-next-line:interface-name
 export interface IRawMessage {
+    /**
+     * A list of text objects used to build a message.
+     */
     rawtext?: IRawMessage | string[];
+    /**
+     * Contains plain text to display directly. Only valid when
+     * used as a sub member in a parent _rawtext_ or _with_ member.
+     */
     text?: string;
+    /**
+     * Contains a resource pack translation identifier that can be
+     * used to translate text in the player's selected language.
+     */
     translate?: string;
+    /**
+     * A list of text object arguments that can be used to fill
+     * values in the _translate_ text. Ignored when _translate_ is
+     * not present.
+     */
     with?: IRawMessage | string[];
 }
+/**
+ * Contains a description of a vector.
+ */
 // tslint:disable-next-line:interface-name
 export interface IVec3 {
+    /**
+     * X component of this vector.
+     */
     x: number;
+    /**
+     * Y component of this vector.
+     */
     y: number;
+    /**
+     * Z component of this vector.
+     */
     z: number;
 }
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@minecraft/server",
-  "version": "1.0.0-beta.11940b24",
+  "version": "1.0.0-beta.release.1.19.40",
   "description": "",
   "contributors": [
     {