@minecraft/server 2.1.0-rc.1.21.110-preview.22 → 2.1.0

package/README.md

@@ -1,9 +1,7 @@
-# `@minecraft/server`
-
-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:
-
+# `@minecraft/server`
+
+Contains many types related to manipulating a Minecraft world, including entities, blocks, dimensions, and more.
+
+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.
    ***************************************************************************** */
 /**
- * @preview
  * @packageDocumentation
  * Contains many types related to manipulating a Minecraft
  * world, including entities, blocks, dimensions, and more.
@@ -123,7 +122,6 @@ export enum ButtonState {
 }
 
 /**
- * @rc
  * The required permission level to execute the custom command.
  */
 export enum CommandPermissionLevel {
@@ -160,7 +158,6 @@ export enum CommandPermissionLevel {
 }
 
 /**
- * @rc
  * Reason why custom command registration failed.
  */
 export enum CustomCommandErrorReason {
@@ -207,7 +204,6 @@ export enum CustomCommandErrorReason {
 }
 
 /**
- * @rc
  * The types of paramaters accepted by a custom command.
  */
 export enum CustomCommandParamType {
@@ -281,7 +277,6 @@ export enum CustomCommandParamType {
 }
 
 /**
- * @rc
  * Who executed the command.
  */
 export enum CustomCommandSource {
@@ -306,9 +301,6 @@ export enum CustomCommandSource {
     Server = 'Server',
 }
 
-/**
- * @rc
- */
 export enum CustomCommandStatus {
     Success = 0,
     Failure = 1,
@@ -929,7 +921,6 @@ export enum EntityComponentTypes {
      */
     OnFire = 'minecraft:onfire',
     /**
-     * @rc
      * @remarks
      * Use this component to read the exhaustion of a player. This
      * is only available on players.
@@ -937,7 +928,6 @@ export enum EntityComponentTypes {
      */
     Exhaustion = 'minecraft:player.exhaustion',
     /**
-     * @rc
      * @remarks
      * Use this component to read the hunger of a player. This is
      * only available on players.
@@ -945,7 +935,6 @@ export enum EntityComponentTypes {
      */
     Hunger = 'minecraft:player.hunger',
     /**
-     * @rc
      * @remarks
      * Use this component to read the saturation of a player. This
      * is only available on players.
@@ -2256,7 +2245,6 @@ export enum PlatformType {
 }
 
 /**
- * @rc
  * Specifies the player inventory type.
  */
 export enum PlayerInventoryType {
@@ -2275,7 +2263,6 @@ export enum PlayerInventoryType {
 }
 
 /**
- * @rc
  * The player permission level.
  */
 export enum PlayerPermissionLevel {
@@ -2872,7 +2859,6 @@ export class Block {
      */
     readonly isWaterlogged: boolean;
     /**
-     * @rc
      * @remarks
      * Key for the localization of this block's name used in .lang
      * files.
@@ -4982,7 +4968,6 @@ export class Container {
      */
     clearAll(): void;
     /**
-     * @rc
      * @remarks
      * Attempts to find an item inside the container
      *
@@ -4994,7 +4979,6 @@ export class Container {
      */
     contains(itemStack: ItemStack): boolean;
     /**
-     * @rc
      * @remarks
      * Find the index of the first instance of an item inside the
      * container
@@ -5007,7 +4991,6 @@ export class Container {
      */
     find(itemStack: ItemStack): number | undefined;
     /**
-     * @rc
      * @remarks
      * Find the index of the last instance of an item inside the
      * container
@@ -5020,7 +5003,6 @@ export class Container {
      */
     findLast(itemStack: ItemStack): number | undefined;
     /**
-     * @rc
      * @remarks
      * Finds the index of the first empty slot inside the container
      *
@@ -5030,7 +5012,6 @@ export class Container {
      */
     firstEmptySlot(): number | undefined;
     /**
-     * @rc
      * @remarks
      * Finds the index of the first item inside the container
      *
@@ -5597,7 +5578,6 @@ export class ContainerSlot {
 }
 
 /**
- * @rc
  * Details about the origins of the command.
  */
 export class CustomCommandOrigin {
@@ -5632,7 +5612,6 @@ export class CustomCommandOrigin {
 }
 
 /**
- * @rc
  * Provides the functionality for registering custom commands.
  */
 export class CustomCommandRegistry {
@@ -5775,7 +5754,6 @@ export class Dimension {
      */
     readonly id: string;
     /**
-     * @rc
      * @remarks
      * Key for the localization of a dimension's name used by
      * language files.
@@ -6877,7 +6855,6 @@ export class Entity {
      */
     readonly isValid: boolean;
     /**
-     * @rc
      * @remarks
      * Key for the localization of this entity's name used in .lang
      * files.
@@ -7083,7 +7060,8 @@ export class Entity {
     /**
      * @remarks
      * Applies impulse vector to the current velocity of the
-     * entity.
+     * entity. Note that this method throws an error if called on
+     * Players and will have no impact.
      *
      * This function can't be called in read-only mode.
      *
@@ -7094,6 +7072,8 @@ export class Entity {
      * {@link minecraftcommon.ArgumentOutOfBoundsError}
      *
      * {@link InvalidEntityError}
+     *
+     * {@link minecraftcommon.UnsupportedFunctionalityError}
      * @example applyImpulse.ts
      * ```typescript
      * import { DimensionLocation } from "@minecraft/server";
@@ -7159,13 +7139,17 @@ export class Entity {
     clearDynamicProperties(): void;
     /**
      * @remarks
-     * Sets the current velocity of the Entity to zero.
+     * Sets the current velocity of the Entity to zero. Note that
+     * this method throws an error if called on Players and will
+     * have no impact.
      *
      * This function can't be called in read-only mode.
      *
      * @throws This function can throw errors.
      *
      * {@link InvalidEntityError}
+     *
+     * {@link minecraftcommon.UnsupportedFunctionalityError}
      * @example applyImpulse.ts
      * ```typescript
      * import { DimensionLocation } from "@minecraft/server";
@@ -8347,7 +8331,6 @@ export class EntityDieAfterEventSignal {
 export class EntityEquippableComponent extends EntityComponent {
     private constructor();
     /**
-     * @rc
      * @remarks
      * Returns the total Armor level of the owner.
      *
@@ -8357,7 +8340,6 @@ export class EntityEquippableComponent extends EntityComponent {
      */
     readonly totalArmor: number;
     /**
-     * @rc
      * @remarks
      * Returns the total Toughness level of the owner.
      *
@@ -8408,7 +8390,6 @@ export class EntityEquippableComponent extends EntityComponent {
 }
 
 /**
- * @rc
  * Defines the interactions with this entity for Exhaustion.
  * Wraps the `minecraft.player.exhaustion` attribute.
  */
@@ -8706,7 +8687,6 @@ export class EntityHitEntityAfterEventSignal {
 }
 
 /**
- * @rc
  * Defines the interactions with this entity for hunger. Wraps
  * the `minecraft.player.hunger` attribute.
  */
@@ -10038,7 +10018,6 @@ export class EntityRidingComponent extends EntityComponent {
 }
 
 /**
- * @rc
  * Defines the interactions with this entity for Saturation.
  * Wraps the `minecraft.player.saturation` attribute.
  */
@@ -11802,7 +11781,6 @@ export class ItemStack {
      */
     keepOnDeath: boolean;
     /**
-     * @rc
      * @remarks
      * Key for the localization of this items's name used in .lang
      * files.
@@ -12952,7 +12930,6 @@ export class Player extends Entity {
      */
     readonly clientSystemInfo: ClientSystemInfo;
     /**
-     * @rc
      * @remarks
      * This property can't be edited in read-only mode.
      *
@@ -13035,7 +13012,6 @@ export class Player extends Entity {
      */
     readonly onScreenDisplay: ScreenDisplay;
     /**
-     * @rc
      * @throws This property can throw when used.
      *
      * {@link InvalidEntityError}
@@ -13885,7 +13861,6 @@ export class PlayerGameModeChangeBeforeEventSignal {
 }
 
 /**
- * @rc
  * Contains information regarding an event after changing the
  * selected hotbar slot for a player.
  */
@@ -13918,7 +13893,6 @@ export class PlayerHotbarSelectedSlotChangeAfterEvent {
 }
 
 /**
- * @rc
  * Manages callbacks that are connected after a player selected
  * hotbar slot is changed.
  */
@@ -14400,7 +14374,6 @@ export class PlayerInteractWithEntityBeforeEventSignal {
 }
 
 /**
- * @rc
  * Contains information regarding an event after a player's
  * inventory item changes.
  */
@@ -14439,7 +14412,6 @@ export class PlayerInventoryItemChangeAfterEvent {
 }
 
 /**
- * @rc
  * Manages callbacks that are connected after a player's
  * inventory item is changed.
  */
@@ -15748,7 +15720,6 @@ export class StartupEvent {
      */
     readonly blockComponentRegistry: BlockComponentRegistry;
     /**
-     * @rc
      * @remarks
      * This property can be read in early-execution mode.
      *
@@ -16316,6 +16287,8 @@ export class System {
      * Causes an event to fire within script with the specified
      * message ID and payload.
      *
+     * This function can't be called in read-only mode.
+     *
      * @param id
      * Identifier of the message to send. This is custom and
      * dependent on the kinds of behavior packs and content you may
@@ -17455,7 +17428,6 @@ export class WorldAfterEvents {
      */
     readonly playerGameModeChange: PlayerGameModeChangeAfterEventSignal;
     /**
-     * @rc
      * @remarks
      * This event fires when a player's selected slot changes.
      *
@@ -17496,7 +17468,6 @@ export class WorldAfterEvents {
      */
     readonly playerInteractWithEntity: PlayerInteractWithEntityAfterEventSignal;
     /**
-     * @rc
      * @remarks
      * This event fires when an item gets added or removed to the
      * player's inventory.
@@ -18094,7 +18065,6 @@ export interface CameraTargetOptions {
 }
 
 /**
- * @rc
  * Define the custom command, including name, permissions, and
  * parameters.
  */
@@ -18139,7 +18109,6 @@ export interface CustomCommand {
 }
 
 /**
- * @rc
  * Definition for each parameter expected by the custom
  * command.
  */
@@ -18159,7 +18128,6 @@ export interface CustomCommandParameter {
 }
 
 /**
- * @rc
  * Interface returned from custom command callback function.
  */
 export interface CustomCommandResult {
@@ -18961,7 +18929,6 @@ export interface GreaterThanOrEqualsComparison {
 }
 
 /**
- * @rc
  * Contains additional filtering options for hotbar events.
  */
 export interface HotbarEventOptions {
@@ -18998,7 +18965,6 @@ export interface InputEventOptions {
 }
 
 /**
- * @rc
  * Contains additional filtering options for inventory item
  * events.
  */
@@ -19888,7 +19854,6 @@ export class ContainerRulesError extends Error {
 }
 
 /**
- * @rc
  * Error object thrown when CustomCommandRegistry errors occur.
  */
 // @ts-ignore Class inheritance allowed for native defined classes
@@ -19941,7 +19906,6 @@ export class EntitySpawnError extends Error {
 }
 
 /**
- * @rc
  * The container is invalid. This can occur if the container is
  * missing or deleted.
  */

package/package.json

@@ -1,20 +1,22 @@
-{
-  "name": "@minecraft/server",
-  "version": "2.1.0-rc.1.21.110-preview.22",
-  "description": "",
-  "contributors": [
-    {
-      "name": "Jake Shirley",
-      "email": "jake@xbox.com"
-    },
-    {
-      "name": "Mike Ammerlaan",
-      "email": "mikeam@microsoft.com"
-    }
-  ],
-  "peerDependencies": {
-    "@minecraft/common": "^1.2.0",
-    "@minecraft/vanilla-data": ">=1.20.70 || 1.21.110-preview.22"
-  },
-  "license": "MIT"
+{
+  "name": "@minecraft/server",
+  "version": "2.1.0",
+  "description": "",
+  "contributors": [
+    {
+      "name": "Jake Shirley",
+      "email": "jake@xbox.com"
+    },
+    {
+      "name": "Mike Ammerlaan",
+      "email": "mikeam@microsoft.com"
+    }
+  ],
+  "dependencies": {
+    "@minecraft/common": "^1.2.0"
+  },
+  "peerDependencies": {
+    "@minecraft/vanilla-data": ">=1.20.70"
+  },
+  "license": "MIT"
 }