@minecraft/server 1.0.0-beta.preview.1.19.50.20 → 1.0.0-beta.release.1.19.40

package/index.d.ts

@@ -15,7 +15,7 @@
  * ```json
  * {
  *   "module_name": "@minecraft/server",
- *   "version": "1.0.0-internal.preview.1.19.50.20"
+ *   "version": "0.1.0"
  * }
  * ```
  *
@@ -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.
@@ -1909,6 +1913,26 @@ export class BlockProperties {
     static readonly woodType = 'wood_type';
     protected constructor();
 }
+/**
+ * Contains additional options for configuring a block raycast
+ * query.
+ */
+export class BlockRaycastOptions {
+    /**
+     * If true, liquid blocks will be considered as blocks that
+     * 'stop' the raycast.
+     */
+    includeLiquidBlocks: boolean;
+    /**
+     * If true, passable blocks like vines and flowers will be
+     * considered as blocks that 'stop' the raycast.
+     */
+    includePassableBlocks: boolean;
+    /**
+     * Maximum distance, in blocks, to process the raycast.
+     */
+    maxDistance: number;
+}
 /**
  * Represents a block that can play a record.
  */
@@ -1947,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();
 }
@@ -2523,12 +2565,13 @@ export class Dimension {
      * @throws This function can throw errors.
      */
     getPlayers(getPlayers?: EntityQueryOptions): PlayerIterator;
+    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.
@@ -2891,7 +2934,7 @@ export class Entity {
      * Current location of the entity.
      * @throws This property can throw when used.
      */
-    readonly location: IVec3;
+    readonly location: Location;
     /**
      * Given name of the entity.
      */
@@ -3077,12 +3120,12 @@ export class Entity {
      * @throws This function can throw errors.
      */
     removeTag(tag: string): boolean;
+    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.
@@ -3434,6 +3477,28 @@ export class EntityCreateEventSignal {
     unsubscribe(callback: (arg: EntityCreateEvent) => void): void;
     protected constructor();
 }
+/**
+ * Specifies additional filters that are used in registering a
+ * data driven trigger event for entities.
+ */
+export class EntityDataDrivenTriggerEventOptions {
+    /**
+     * If this value is set, this event will only fire for entities
+     * that match the entities within this collection.
+     */
+    entities: Entity[];
+    /**
+     * If this value is set, this event will only fire if the
+     * impacted entities' type matches this parameter.
+     */
+    entityTypes: string[];
+    /**
+     * If this value is set, this event will only fire if the
+     * impacted triggered event matches one of the events listed in
+     * this parameter.
+     */
+    eventTypes: string[];
+}
 /**
  * As part of the Ageable component, represents a set of items
  * that can be fed to an entity and the rate at which that
@@ -3453,6 +3518,22 @@ export class EntityDefinitionFeedItem {
     readonly item: string;
     protected constructor();
 }
+/**
+ * Contains optional parameters for registering an entity
+ * event.
+ */
+export class EntityEventOptions {
+    /**
+     * If this value is set, this event will only fire for entities
+     * that match the entities within this collection.
+     */
+    entities: Entity[];
+    /**
+     * If this value is set, this event will only fire if the
+     * impacted entities' type matches this parameter.
+     */
+    entityTypes: string[];
+}
 /**
  * When added, this component signifies that this entity
  * doesn't take damage from fire.
@@ -5734,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.
@@ -6078,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
@@ -6152,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
@@ -6177,6 +6270,9 @@ export class ItemEnchantsComponent {
      * item stack.
      */
     enchantments: EnchantmentList;
+    /**
+     * Identifier of this component.
+     */
     static readonly componentId = 'minecraft:enchantments';
     /**
      * @remarks
@@ -6217,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();
 }
@@ -6295,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
@@ -6754,7 +6859,6 @@ export class Location {
 export class MessageReceiveEvent {
     readonly id: string;
     readonly message: string;
-    readonly player: Player;
     readonly sourceType: MessageSourceType;
     protected constructor();
 }
@@ -12845,7 +12949,7 @@ export class Player extends Entity {
      * Current location of the player.
      * @throws This property can throw when used.
      */
-    readonly location: IVec3;
+    readonly location: Location;
     /**
      * Name of the player.
      * @throws This property can throw when used.
@@ -13041,12 +13145,12 @@ export class Player extends Entity {
      * @throws This function can throw errors.
      */
     removeTag(tag: string): boolean;
+    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.
@@ -13514,6 +13618,21 @@ export class ScoreboardObjective {
     getScores(): ScoreboardScoreInfo[];
     protected constructor();
 }
+/**
+ * Contains additional options for how a scoreboard should be
+ * displayed within its display slot.
+ */
+export class ScoreboardObjectiveDisplayOptions {
+    /**
+     * Objective to be displayed.
+     */
+    readonly objective: ScoreboardObjective;
+    /**
+     * The sort order to display the objective items within.
+     */
+    readonly sortOrder: ObjectiveSortOrder;
+    constructor(objective: ScoreboardObjective, sortOrder?: ObjectiveSortOrder);
+}
 /**
  * Contains a pair of a scoreboard participant and its
  * respective score.
@@ -13626,16 +13745,24 @@ export class StringBlockProperty extends IBlockProperty {
  * A class that provides system-level events and functions.
  */
 export class System {
-    readonly currentTick: number;
     /**
      * Contains a set of events that are applicable for the
      * lifecycle of items in the Minecraft system.
      */
     readonly events: SystemEvents;
-    clearRun(runId: number): void;
-    clearRunSchedule(runScheduleId: number): void;
-    run(callback: () => void, tickDelay?: number): number;
-    runSchedule(callback: () => void, tickInterval?: number): number;
+    /**
+     * @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();
 }
 /**
@@ -13752,7 +13879,7 @@ export class Vector {
      * @param a
      * @param b
      */
-    static add(a: IVec3, b: IVec3): Vector;
+    static add(a: Vector, b: Vector): Vector;
     /**
      * @remarks
      * Creates a new instance of an abstract vector.
@@ -13770,21 +13897,21 @@ export class Vector {
      * @param a
      * @param b
      */
-    static cross(a: IVec3, b: IVec3): Vector;
+    static cross(a: Vector, b: Vector): Vector;
     /**
      * @remarks
      * Returns the distance between two vectors.
      * @param a
      * @param b
      */
-    static distance(a: IVec3, b: IVec3): number;
+    static distance(a: Vector, b: Vector): number;
     /**
      * @remarks
      * Returns the component-wise division of these vectors.
      * @param a
      * @param b
      */
-    static divide(a: IVec3, b: number | IVec3): Vector;
+    static divide(a: Vector, b: number | Vector): Vector;
     /**
      * @remarks
      * Compares this vector and another vector to one another.
@@ -13812,7 +13939,7 @@ export class Vector {
      * @param b
      * @param t
      */
-    static lerp(a: IVec3, b: IVec3, t: number): Vector;
+    static lerp(a: Vector, b: Vector, t: number): Vector;
     /**
      * @remarks
      * Returns a vector that is made from the largest components of
@@ -13820,7 +13947,7 @@ export class Vector {
      * @param a
      * @param b
      */
-    static max(a: IVec3, b: IVec3): Vector;
+    static max(a: Vector, b: Vector): Vector;
     /**
      * @remarks
      * Returns a vector that is made from the smallest components
@@ -13828,14 +13955,14 @@ export class Vector {
      * @param a
      * @param b
      */
-    static min(a: IVec3, b: IVec3): Vector;
+    static min(a: Vector, b: Vector): Vector;
     /**
      * @remarks
      * Returns the component-wise product of these vectors.
      * @param a
      * @param b
      */
-    static multiply(a: IVec3, b: number | IVec3): Vector;
+    static multiply(a: Vector, b: number | Vector): Vector;
     /**
      * @remarks
      * Returns this vector as a normalized vector.
@@ -13849,14 +13976,14 @@ export class Vector {
      * @param b
      * @param s
      */
-    static slerp(a: IVec3, b: IVec3, s: number): Vector;
+    static slerp(a: Vector, b: Vector, s: number): Vector;
     /**
      * @remarks
      * Returns the subtraction of these vectors.
      * @param a
      * @param b
      */
-    static subtract(a: IVec3, b: IVec3): Vector;
+    static subtract(a: Vector, b: Vector): Vector;
 }
 /**
  * Contains information related to changes in weather in the
@@ -13912,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
@@ -13940,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
@@ -13987,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
@@ -14064,64 +14204,6 @@ export class XYRotation {
     y: number;
     protected constructor();
 }
-/**
- * Contains additional options for configuring a block raycast
- * query.
- */
-export interface BlockRaycastOptions {
-    /**
-     * If true, liquid blocks will be considered as blocks that
-     * 'stop' the raycast.
-     */
-    includeLiquidBlocks?: boolean;
-    /**
-     * If true, passable blocks like vines and flowers will be
-     * considered as blocks that 'stop' the raycast.
-     */
-    includePassableBlocks?: boolean;
-    /**
-     * Maximum distance, in blocks, to process the raycast.
-     */
-    maxDistance?: number;
-}
-/**
- * Specifies additional filters that are used in registering a
- * data driven trigger event for entities.
- */
-export interface EntityDataDrivenTriggerEventOptions {
-    /**
-     * If this value is set, this event will only fire for entities
-     * that match the entities within this collection.
-     */
-    entities?: Entity[];
-    /**
-     * If this value is set, this event will only fire if the
-     * impacted entities' type matches this parameter.
-     */
-    entityTypes?: string[];
-    /**
-     * If this value is set, this event will only fire if the
-     * impacted triggered event matches one of the events listed in
-     * this parameter.
-     */
-    eventTypes?: string[];
-}
-/**
- * Contains optional parameters for registering an entity
- * event.
- */
-export interface EntityEventOptions {
-    /**
-     * If this value is set, this event will only fire for entities
-     * that match the entities within this collection.
-     */
-    entities?: Entity[];
-    /**
-     * If this value is set, this event will only fire if the
-     * impacted entities' type matches this parameter.
-     */
-    entityTypes?: string[];
-}
 /**
  * Contains options for selecting entities within an area.
  */
@@ -14302,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;
 }
 /**
@@ -14333,20 +14447,6 @@ export interface MusicOptions {
      */
     volume?: number;
 }
-/**
- * Contains additional options for how a scoreboard should be
- * displayed within its display slot.
- */
-export interface ScoreboardObjectiveDisplayOptions {
-    /**
-     * Objective to be displayed.
-     */
-    objective: ScoreboardObjective;
-    /**
-     * The sort order to display the objective items within.
-     */
-    sortOrder?: ObjectiveSortOrder;
-}
 /**
  * Additional configuration options for the {@link
  * Player.playSound}/{@link World.playSound} method.

package/package.json

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