@minecraft/server 1.1.0-rc.1.20.0-preview.21 → 1.1.0

package/README.md

@@ -2,8 +2,6 @@
 
 Contains many types related to manipulating a Minecraft world, including entities, blocks, dimensions, and more.
 
-## **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/server/@minecraft/server

package/index.d.ts

@@ -7,7 +7,6 @@
    Copyright (c) Microsoft Corporation.
    ***************************************************************************** */
 /**
- * @beta
  * @packageDocumentation
  * Contains many types related to manipulating a Minecraft
  * world, including entities, blocks, dimensions, and more.
@@ -16,18 +15,16 @@
  * ```json
  * {
  *   "module_name": "@minecraft/server",
- *   "version": "1.3.0-internal.1.20.0-preview.21"
+ *   "version": "1.1.0"
  * }
  * ```
  *
  */
 /**
- * @beta
  * Represents a game mode for the current world experience.
  */
 export enum GameMode {
     /**
-     * @beta
      * @remarks
      * World is in a more locked-down experience, where blocks may
      * not be manipulated.
@@ -35,7 +32,6 @@ export enum GameMode {
      */
     adventure = 'adventure',
     /**
-     * @beta
      * @remarks
      * World is in a full creative mode. In creative mode, the
      * player has all the resources available in the item selection
@@ -49,7 +45,6 @@ export enum GameMode {
     creative = 'creative',
     spectator = 'spectator',
     /**
-     * @beta
      * @remarks
      * World is in a survival mode, where players can take damage
      * and entities may not be peaceful. Survival mode is where the
@@ -60,8 +55,8 @@ export enum GameMode {
      */
     survival = 'survival',
 }
+
 /**
- * @beta
  * Represents a block in a dimension. A block represents a
  * unique X, Y, and Z within a dimension and get/sets the state
  * of the block at that location. This type was significantly
@@ -122,8 +117,8 @@ export class Block {
      */
     setPermutation(permutation: BlockPermutation): void;
 }
+
 /**
- * @beta
  * Contains the combination of type {@link BlockType} and
  * properties (also sometimes called block state) which
  * describe a block (but does not belong to a specific {@link
@@ -137,22 +132,29 @@ export class BlockPermutation {
      * this permutation. If states is not specified, matches checks
      * against the set of types more broadly.
      *
+     * This function can't be called in read-only mode.
+     *
      * @param blockName
      * An optional set of states to compare against.
      */
-    matches(blockName: string, states?: Record<string, boolean | number | string>): boolean;
+    matches(blockName: string, properties?: Record<string, boolean | number | string>): boolean;
     /**
      * @remarks
      * Given a type identifier and an optional set of properties,
      * will return a BlockPermutation object that is usable in
      * other block APIs (e.g., block.setPermutation)
      *
+     * This function can't be called in read-only mode.
+     *
      * @param blockName
      * Identifier of the block to check.
+     * @param properties
+     * Optional additional set of properties to check against.
      * @throws This function can throw errors.
      */
-    static resolve(blockName: string, states?: Record<string, boolean | number | string>): BlockPermutation;
+    static resolve(blockName: string, properties?: Record<string, boolean | number | string>): BlockPermutation;
 }
+
 /**
  * Contains return data on the result of a command execution.
  */
@@ -167,6 +169,7 @@ export class CommandResult {
      */
     readonly successCount: number;
 }
+
 /**
  * A class that represents a particular dimension (e.g., The
  * End) within a world.
@@ -181,11 +184,12 @@ export class Dimension {
      */
     readonly id: string;
     /**
-     * @beta
      * @remarks
      * Returns a block instance at the given location. This method
      * was introduced as of version 1.17.10.21.
      *
+     * This function can't be called in read-only mode.
+     *
      * @param location
      * The location at which to return a block.
      * @returns
@@ -194,11 +198,12 @@ export class Dimension {
      */
     getBlock(location: Vector3): Block;
     /**
-     * @beta
      * @remarks
      * Returns a set of entities based on a set of conditions
      * defined via the EntityQueryOptions set of filter criteria.
      *
+     * This function can't be called in read-only mode.
+     *
      * @param options
      * Additional options that can be used to filter the set of
      * entities returned.
@@ -227,10 +232,11 @@ export class Dimension {
      */
     getEntities(options?: EntityQueryOptions): Entity[];
     /**
-     * @beta
      * @remarks
      * Returns a set of entities at a particular location.
      *
+     * This function can't be called in read-only mode.
+     *
      * @param location
      * The location at which to return entities.
      * @returns
@@ -238,11 +244,12 @@ export class Dimension {
      */
     getEntitiesAtBlockLocation(location: Vector3): Entity[];
     /**
-     * @beta
      * @remarks
      * Returns a set of players based on a set of conditions
      * defined via the EntityQueryOptions set of filter criteria.
      *
+     * This function can't be called in read-only mode.
+     *
      * @param options
      * Additional options that can be used to filter the set of
      * players returned.
@@ -258,6 +265,8 @@ export class Dimension {
      * of 128 asynchronous commands that can be run in a given
      * tick.
      *
+     * This function can't be called in read-only mode.
+     *
      * @param commandString
      * Command to run. Note that command strings should not start
      * with slash.
@@ -268,6 +277,7 @@ export class Dimension {
      */
     runCommandAsync(commandString: string): Promise<CommandResult>;
 }
+
 /**
  * Represents the state of an entity (a mob, the player, or
  * other moving objects like minecarts) in the world.
@@ -275,7 +285,6 @@ export class Dimension {
 export class Entity {
     protected constructor();
     /**
-     * @beta
      * @remarks
      * Dimension that the entity is currently within.
      *
@@ -293,7 +302,6 @@ export class Entity {
      */
     readonly id: string;
     /**
-     * @beta
      * @remarks
      * Current location of the entity.
      *
@@ -301,7 +309,6 @@ export class Entity {
      */
     readonly location: Vector3;
     /**
-     * @beta
      * @remarks
      * Given name of the entity.
      *
@@ -318,27 +325,30 @@ export class Entity {
      */
     readonly typeId: string;
     /**
-     * @beta
      * @remarks
      * Returns the current location of the head component of this
      * entity.
      *
+     * This function can't be called in read-only mode.
+     *
      * @throws This function can throw errors.
      */
     getHeadLocation(): Vector3;
     /**
-     * @beta
      * @remarks
      * Returns the current velocity vector of the entity.
      *
+     * This function can't be called in read-only mode.
+     *
      * @throws This function can throw errors.
      */
     getVelocity(): Vector3;
     /**
-     * @beta
      * @remarks
      * Returns the current view direction of the entity.
      *
+     * This function can't be called in read-only mode.
+     *
      * @throws This function can throw errors.
      */
     getViewDirection(): Vector3;
@@ -348,6 +358,8 @@ export class Entity {
      * this entity. Note that there is a maximum queue of 128
      * asynchronous commands that can be run in a given tick.
      *
+     * This function can't be called in read-only mode.
+     *
      * @param commandString
      * Command to run. Note that command strings should not start
      * with slash.
@@ -358,6 +370,7 @@ export class Entity {
      */
     runCommandAsync(commandString: string): Promise<CommandResult>;
 }
+
 /**
  * A collection of default Minecraft dimension types.
  */
@@ -397,6 +410,7 @@ export class MinecraftDimensionTypes {
      */
     static readonly theEnd = 'minecraft:the_end';
 }
+
 /**
  * Represents a player within the world.
  */
@@ -410,10 +424,11 @@ export class Player extends Entity {
      */
     readonly name: string;
     /**
-     * @beta
      * @remarks
      * Sends a message to the player.
      *
+     * This function can't be called in read-only mode.
+     *
      * @param message
      * The message to be displayed.
      * @throws
@@ -453,24 +468,25 @@ export class Player extends Entity {
      */
     sendMessage(message: (RawMessage | string)[] | RawMessage | string): void;
 }
+
 /**
  * A class that provides system-level events and functions.
  */
 export class System {
     protected constructor();
     /**
-     * @beta
      * @remarks
      * Represents the current world tick of the server.
      *
      */
     readonly currentTick: number;
     /**
-     * @beta
      * @remarks
      * Cancels the execution of a function run that was previously
      * scheduled via the `run` function.
      *
+     * This function can't be called in read-only mode.
+     *
      */
     clearRun(runId: number): void;
     /**
@@ -479,6 +495,8 @@ export class System {
      * frequently used to implement delayed behaviors and game
      * loops.
      *
+     * This function can't be called in read-only mode.
+     *
      * @param callback
      * Function callback to run when the tickDelay time criteria is
      * met.
@@ -488,10 +506,11 @@ export class System {
      */
     run(callback: () => void): number;
     /**
-     * @beta
      * @remarks
      * Runs a set of code on an interval.
      *
+     * This function can't be called in read-only mode.
+     *
      * @param callback
      * Functional code that will run when this interval occurs.
      * @param tickInterval
@@ -503,10 +522,11 @@ export class System {
      */
     runInterval(callback: () => void, tickInterval?: number): number;
     /**
-     * @beta
      * @remarks
      * Runs a set of code at a future time specified by tickDelay.
      *
+     * This function can't be called in read-only mode.
+     *
      * @param callback
      * Functional code that will run when this timeout occurs.
      * @param tickDelay
@@ -518,6 +538,7 @@ export class System {
      */
     runTimeout(callback: () => void, tickDelay?: number): number;
 }
+
 /**
  * A class that wraps the state of a world - a set of
  * dimensions and the environment of Minecraft.
@@ -528,6 +549,8 @@ export class World {
      * @remarks
      * Returns an array of all active players within the world.
      *
+     * This function can't be called in read-only mode.
+     *
      * @throws This function can throw errors.
      */
     getAllPlayers(): Player[];
@@ -535,6 +558,8 @@ export class World {
      * @remarks
      * Returns a dimension object.
      *
+     * This function can't be called in read-only mode.
+     *
      * @returns
      * The requested dimension
      * @throws
@@ -542,11 +567,12 @@ export class World {
      */
     getDimension(dimensionId: string): Dimension;
     /**
-     * @beta
      * @remarks
      * Returns a set of players based on a set of conditions
      * defined via the EntityQueryOptions set of filter criteria.
      *
+     * This function can't be called in read-only mode.
+     *
      * @param options
      * Additional options that can be used to filter the set of
      * players returned.
@@ -556,10 +582,11 @@ export class World {
      */
     getPlayers(options?: EntityQueryOptions): Player[];
     /**
-     * @beta
      * @remarks
      * Sends a message to all players.
      *
+     * This function can't be called in read-only mode.
+     *
      * @param message
      * The message to be displayed.
      * @throws
@@ -599,8 +626,8 @@ export class World {
      */
     sendMessage(message: (RawMessage | string)[] | RawMessage | string): void;
 }
+
 /**
- * @beta
  * Contains options for selecting entities within an area.
  */
 export interface EntityQueryOptions {
@@ -761,8 +788,8 @@ export interface EntityQueryOptions {
      */
     type?: string;
 }
+
 /**
- * @beta
  * Contains additional options for filtering players based on
  * their score for an objective.
  */
@@ -795,9 +822,7 @@ export interface EntityQueryScoreOptions {
      */
     objective?: string;
 }
-/**
- * @beta
- */
+
 export interface RawMessage {
     rawtext?: RawMessage[];
     score?: RawMessageScore;
@@ -805,15 +830,13 @@ export interface RawMessage {
     translate?: string;
     with?: string[] | RawMessage;
 }
-/**
- * @beta
- */
+
 export interface RawMessageScore {
     name?: string;
     objective?: string;
 }
+
 /**
- * @beta
  * Contains a description of a vector.
  */
 export interface Vector3 {
@@ -836,6 +859,7 @@ export interface Vector3 {
      */
     z: number;
 }
+
 /**
  * @remarks
  * A class that provides system-level events and functions.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@minecraft/server",
-  "version": "1.1.0-rc.1.20.0-preview.21",
+  "version": "1.1.0",
   "description": "",
   "contributors": [
     {