@minecraft/server 2.5.0-rc.1.26.10-preview.20 → 2.5.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.
    ***************************************************************************** */
 /**
- * @preview
  * @packageDocumentation
  * Contains many types related to manipulating a Minecraft
  * world, including entities, blocks, dimensions, and more.
@@ -38,14 +37,12 @@ export enum BlockComponentTypes {
      */
     Inventory = 'minecraft:inventory',
     /**
-     * @rc
      * @remarks
      * Represents the color of a block when displayed on a map.
      *
      */
     MapColor = 'minecraft:map_color',
     /**
-     * @rc
      * @remarks
      * Represents a block that can move (such as a piston).
      *
@@ -59,7 +56,6 @@ export enum BlockComponentTypes {
      */
     Piston = 'minecraft:piston',
     /**
-     * @rc
      * @remarks
      * Represents a how a block interacts with precipitation (such
      * as rain or snow).
@@ -73,7 +69,6 @@ export enum BlockComponentTypes {
      */
     RecordPlayer = 'minecraft:record_player',
     /**
-     * @rc
      * @remarks
      * Represents a block that can output a redstone signal.
      *
@@ -1419,7 +1414,6 @@ export enum EntityInitializationCause {
 }
 
 /**
- * @rc
  * Enumerator describing the source of an Entity swing. Sent as
  * part of {@link PlayerSwingStartAfterEvent}
  */
@@ -1901,7 +1895,6 @@ export enum GraphicsMode {
 }
 
 /**
- * @rc
  * Specifies options related to the item currently being held
  * by an entity.
  */
@@ -3308,7 +3301,6 @@ export class Block {
      * Number of instances of this block to place in the item
      * stack.
      * Defaults to: 1
-     * Bounds: [1, 255]
      * @param withData
      * Whether additional data facets of the item stack are
      * included.
@@ -4223,7 +4215,6 @@ export class BlockPermutation {
      * Number of instances of this block to place in the prototype
      * item stack.
      * Defaults to: 1
-     * Bounds: [1, 255]
      */
     getItemStack(amount?: number): ItemStack | undefined;
     /**
@@ -5468,7 +5459,6 @@ export class Container {
      *
      * @param slot
      * Zero-based index of the slot to retrieve items from.
-     * Minimum value: 0
      * @throws
      * Throws if the container is invalid or if the `slot` index is
      * out of bounds.
@@ -5502,7 +5492,6 @@ export class Container {
      * @param slot
      * The index of the slot to return. This index must be within
      * the bounds of the container.
-     * Minimum value: 0
      * @throws
      * Throws if the container is invalid or if the `slot` index is
      * out of bounds.
@@ -5518,11 +5507,9 @@ export class Container {
      * @param fromSlot
      * Zero-based index of the slot to transfer an item from, on
      * this container.
-     * Minimum value: 0
      * @param toSlot
      * Zero-based index of the slot to transfer an item to, on
      * `toContainer`.
-     * Minimum value: 0
      * @param toContainer
      * Target container to transfer to. Note this can be the same
      * container as the source.
@@ -5571,7 +5558,6 @@ export class Container {
      *
      * @param slot
      * Zero-based index of the slot to set an item at.
-     * Minimum value: 0
      * @param itemStack
      * Stack of items to place within the specified slot. Setting
      * `itemStack` to undefined will clear the slot.
@@ -5592,10 +5578,8 @@ export class Container {
      *
      * @param slot
      * Zero-based index of the slot to swap from this container.
-     * Minimum value: 0
      * @param otherSlot
      * Zero-based index of the slot to swap with.
-     * Minimum value: 0
      * @param otherContainer
      * Target container to swap with. Note this can be the same
      * container as this source.
@@ -5618,7 +5602,6 @@ export class Container {
      * @param fromSlot
      * Zero-based index of the slot to transfer an item from, on
      * this container.
-     * Minimum value: 0
      * @param toContainer
      * Target container to transfer to. Note this can be the same
      * container as the source.
@@ -5678,7 +5661,6 @@ export class ContainerSlot {
      *
      * This property can't be edited in restricted-execution mode.
      *
-     * Bounds: [1, 255]
      * @throws
      * Throws if the value is outside the range of 1-255.
      */
@@ -6292,7 +6274,6 @@ export class Dimension {
      * The location of the explosion.
      * @param radius
      * Radius, in blocks, of the explosion to create.
-     * Bounds: [0, 1000]
      * @param explosionOptions
      * Additional configurable options for the explosion.
      * @throws This function can throw errors.
@@ -6813,7 +6794,6 @@ export class Dimension {
      * Sets the duration of the weather (in ticks). If no duration
      * is provided, the duration will be set to a random duration
      * between 300 and 900 seconds.
-     * Bounds: [1, 1000000]
      * @throws This function can throw errors.
      */
     setWeather(weatherType: WeatherType, duration?: number): void;
@@ -7536,7 +7516,6 @@ export class Entity {
      * 20 ticks per second. Use {@link TicksPerSecond} constant to
      * convert between ticks and seconds. The value must be within
      * the range [0, 20000000].
-     * Bounds: [1, 20000000]
      * @param options
      * Additional options for the effect.
      * @returns
@@ -9432,6 +9411,37 @@ export class EntityHurtAfterEvent {
     readonly hurtEntity: Entity;
 }
 
+/**
+ * Manages callbacks that are connected to when an entity is
+ * hurt.
+ */
+export class EntityHurtAfterEventSignal {
+    private constructor();
+    /**
+     * @remarks
+     * Adds a callback that will be called when an entity is hurt.
+     *
+     * This function can't be called in restricted-execution mode.
+     *
+     * This function can be called in early-execution mode.
+     *
+     */
+    subscribe(
+        callback: (arg0: EntityHurtAfterEvent) => void,
+        options?: EntityEventOptions,
+    ): (arg0: EntityHurtAfterEvent) => void;
+    /**
+     * @remarks
+     * Removes a callback from being called when an entity is hurt.
+     *
+     * This function can't be called in restricted-execution mode.
+     *
+     * This function can be called in early-execution mode.
+     *
+     */
+    unsubscribe(callback: (arg0: EntityHurtAfterEvent) => void): void;
+}
+
 /**
  * Defines this entity's inventory properties.
  */
@@ -12331,7 +12341,6 @@ export class ItemDurabilityComponent extends ItemComponent {
      * chance. Incoming unbreaking parameter must be within the
      * range [0, 3].
      * Defaults to: 0
-     * Bounds: [0, 3]
      * @throws This function can throw errors.
      */
     getDamageChance(unbreakingEnchantmentLevel?: number): number;
@@ -12770,7 +12779,6 @@ export class ItemStack {
      *
      * This property can't be edited in restricted-execution mode.
      *
-     * Bounds: [1, 255]
      * @throws
      * Throws if the value is outside the range of 1-255.
      */
@@ -12868,7 +12876,6 @@ export class ItemStack {
      * size. Note that certain items can only have one item in the
      * stack.
      * Defaults to: 1
-     * Bounds: [1, 255]
      * @throws
      * Throws if `itemType` is invalid, or if `amount` is outside
      * the range of 1-255.
@@ -14532,7 +14539,6 @@ export class Player extends Entity {
      * @param amount
      * Amount of experience to add. Note that this can be negative.
      * Min/max bounds at -2^24 ~ 2^24
-     * Bounds: [-16777216, 16777216]
      * @returns
      * Returns the current experience of the Player.
      * @throws This function can throw errors.
@@ -14547,7 +14553,6 @@ export class Player extends Entity {
      *
      * @param amount
      * Amount to add to the player. Min/max bounds at -2^24 ~ 2^24
-     * Bounds: [-16777216, 16777216]
      * @returns
      * Returns the current level of the Player.
      * @throws This function can throw errors.
@@ -14935,7 +14940,6 @@ export class Player extends Entity {
      * cooldown for.
      * @param tickDuration
      * Duration in ticks of the item cooldown.
-     * Bounds: [0, 32767]
      * @throws This function can throw errors.
      */
     startItemCooldown(cooldownCategory: string, tickDuration: number): void;
@@ -16250,7 +16254,6 @@ export class PlayerSpawnAfterEventSignal {
 }
 
 /**
- * @rc
  * Contains information regarding a player starting to swing
  * their arm.
  */
@@ -16279,7 +16282,6 @@ export class PlayerSwingStartAfterEvent {
 }
 
 /**
- * @rc
  * Manages callbacks that are connected to when a player starts
  * to swing their arm (e.g. attacking, using an item,
  * interacting).
@@ -18093,7 +18095,6 @@ export class StructureManager {
      * templates.
      * @param maxDepth
      * The maximum recursion depth for the jigsaw structure.
-     * Bounds: [1, 20]
      * @param dimension
      * The dimension to place the jigsaw structure in.
      * @param location
@@ -19354,6 +19355,14 @@ export class WorldAfterEvents {
      *
      */
     readonly entityHitEntity: EntityHitEntityAfterEventSignal;
+    /**
+     * @remarks
+     * This event fires when an entity is hurt (takes damage).
+     *
+     * This property can be read in early-execution mode.
+     *
+     */
+    readonly entityHurt: EntityHurtAfterEventSignal;
     /**
      * @remarks
      * Fires when an entity is loaded.
@@ -19599,7 +19608,6 @@ export class WorldAfterEvents {
      */
     readonly playerSpawn: PlayerSpawnAfterEventSignal;
     /**
-     * @rc
      * @remarks
      * This property can be read in early-execution mode.
      *
@@ -21142,7 +21150,6 @@ export interface HotbarEventOptions {
      * The slot indexes to consider. Values should be between 0 and
      * 8, inclusive. If not specified, all slots are considered.
      *
-     * Bounds: [0, 8]
      */
     allowedSlots?: number[];
 }
@@ -21180,7 +21187,6 @@ export interface InventoryItemEventOptions {
      * The slot indexes to consider. Values should be positive
      * numbers. If not specified, all slots are considered.
      *
-     * Bounds: [0, 1000]
      */
     allowedSlots?: number[];
     /**
@@ -21472,7 +21478,6 @@ export interface PlayerSoundOptions {
 }
 
 /**
- * @rc
  * An interface that is passed into {@link
  * @minecraft/Server.PlayerSwingStartAfterEvent.subscribe} that
  * filters out which events are passed to the provided

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@minecraft/server",
-  "version": "2.5.0-rc.1.26.10-preview.20",
+  "version": "2.5.0",
   "description": "",
   "contributors": [
     {
@@ -14,7 +14,7 @@
   ],
   "peerDependencies": {
     "@minecraft/common": "^1.2.0",
-    "@minecraft/vanilla-data": ">=1.20.70 || 1.26.10-preview.20"
+    "@minecraft/vanilla-data": ">=1.20.70"
   },
   "license": "MIT"
 }