@minecraft/server 2.9.0-rc.1.26.40-preview.24 → 2.9.0-rc.1.26.40-preview.29

package/index.d.ts

@@ -781,7 +781,6 @@ export enum EntityComponentTypes {
     Color2 = 'minecraft:color2',
     CursorInventory = 'minecraft:cursor_inventory',
     /**
-     * @rc
      * @remarks
      * Represents this entity's ender inventory properties.
      *
@@ -1439,7 +1438,6 @@ export enum EntityHealCause {
      */
     SelfHeal = 'SelfHeal',
     /**
-     * @rc
      * @remarks
      * Healing caused when Totem of Undying is activated.
      *
@@ -2266,7 +2264,6 @@ export enum LiquidType {
 }
 
 /**
- * @rc
  * Enum representing the different reasons why a locator bar
  * operation may fail.
  */
@@ -2970,7 +2967,6 @@ export enum TintMethod {
 }
 
 /**
- * @rc
  * Enum representing different texture icons that can be
  * displayed for waypoints on the locator bar.
  */
@@ -4457,7 +4453,6 @@ export class BlockComponentBlockBreakEvent extends BlockEvent {
 }
 
 /**
- * @rc
  * Contains information regarding a specific block permutation
  * that was changed from a previous permutation.
  */
@@ -4720,7 +4715,6 @@ export class BlockComponentTickEvent extends BlockEvent {
 }
 
 /**
- * @rc
  * Contains information regarding a specific container block
  * being closed.
  */
@@ -4738,7 +4732,6 @@ export class BlockContainerClosedAfterEvent extends BlockEvent {
 }
 
 /**
- * @rc
  * Manages callbacks that are connected to when a block
  * container is closed.
  */
@@ -4772,7 +4765,6 @@ export class BlockContainerClosedAfterEventSignal {
 }
 
 /**
- * @rc
  * Contains information regarding a specific container block
  * being opened.
  */
@@ -4790,7 +4782,6 @@ export class BlockContainerOpenedAfterEvent extends BlockEvent {
 }
 
 /**
- * @rc
  * Manages callbacks that are connected to when a block
  * container is opened.
  */
@@ -5413,7 +5404,6 @@ export class BlockPrecipitationInteractionsComponent extends BlockComponent {
      */
     accumulatesSnow(): boolean;
     /**
-     * @rc
      * @remarks
      * Returns `true` if this block can have snow within it, like a
      * flower submerged in snow. Returns `false` if this block
@@ -6233,7 +6223,6 @@ export class CatmullRomSpline {
 export class ClientSystemInfo extends SystemInfo {
     private constructor();
     /**
-     * @rc
      * @remarks
      * The locale selected by the client (e.g., en_US, fr_FR,
      * ja_JP). Note that in most cases, server scripts should not
@@ -7299,6 +7288,38 @@ export class Dimension {
      *
      */
     readonly localizationKey: string;
+    /**
+     * @rc
+     * @remarks
+     * Calculates the location of the closest biome of a particular
+     * type from the world seed. Note that
+     * calculateClosestBiomeFromSeed can be an expensive operation,
+     * so avoid using many of these calls within a particular tick.
+     * The result is derived purely from the world generation
+     * algorithm and the world seed, so the returned location may
+     * not reflect the actual current terrain if biomes have been
+     * modified after generation.
+     *
+     * @param pos
+     * Starting location to look for a biome to find.
+     * @param biomeToFind
+     * Identifier of the biome to look for.
+     * @param options
+     * Additional selection criteria for a biome search.
+     * @returns
+     * Returns a location of the biome, or undefined if a biome
+     * could not be found.
+     * @throws This function can throw errors.
+     *
+     * {@link minecraftcommon.EngineError}
+     *
+     * {@link Error}
+     */
+    calculateClosestBiomeFromSeed(
+        pos: Vector3,
+        biomeToFind: BiomeType | string,
+        options?: BiomeSearchOptions,
+    ): Vector3 | undefined;
     /**
      * @remarks
      * Checks if an area contains the specified biomes. If the area
@@ -8082,7 +8103,6 @@ export class Dimension {
 }
 
 /**
- * @rc
  * Provides the functionality for registering custom
  * dimensions. Custom dimensions can only be registered during
  * the system startup event.
@@ -8631,7 +8651,6 @@ export class Entity {
      */
     readonly location: Vector3;
     /**
-     * @rc
      * @remarks
      * Boolean which determines if the player nameplate should be
      * depth tested for visibility.
@@ -8641,7 +8660,6 @@ export class Entity {
      */
     nameplateDepthTested: boolean;
     /**
-     * @rc
      * @remarks
      * Float that determines the render distance of this entity's
      * nameplate.
@@ -10067,7 +10085,6 @@ export class EntityComponent extends Component {
 }
 
 /**
- * @rc
  * Contains information regarding a specific entity container
  * being closed.
  */
@@ -10083,7 +10100,6 @@ export class EntityContainerClosedAfterEvent {
 }
 
 /**
- * @rc
  * Manages callbacks that are connected to when an entity
  * container is closed.
  */
@@ -10117,7 +10133,6 @@ export class EntityContainerClosedAfterEventSignal {
 }
 
 /**
- * @rc
  * Contains information regarding a specific entity container
  * being opened.
  */
@@ -10133,7 +10148,6 @@ export class EntityContainerOpenedAfterEvent {
 }
 
 /**
- * @rc
  * Manages callbacks that are connected to when an entity
  * container is opened.
  */
@@ -10260,7 +10274,6 @@ export class EntityDieAfterEventSignal {
 }
 
 /**
- * @rc
  * Represents this entity's ender inventory properties. This
  * component is always present on players and any items in its
  * container will display for the player when they access an
@@ -12779,7 +12792,6 @@ export class EntityUnderwaterMovementComponent extends EntityAttributeComponent
 }
 
 /**
- * @rc
  * Contains information related to firing of a data driven
  * entity version upgrade.
  */
@@ -12807,7 +12819,6 @@ export class EntityUpgradeAfterEvent {
 }
 
 /**
- * @rc
  * Contains event registration related to firing of a data
  * driven entity version upgrade.
  */
@@ -12869,7 +12880,6 @@ export class EntityWantsJockeyComponent extends EntityComponent {
 }
 
 /**
- * @rc
  * Waypoint that tracks an entity's position. The waypoint
  * automatically updates as the entity moves and becomes
  * invalid when the entity is removed.
@@ -15668,7 +15678,6 @@ export class ListBlockVolume extends BlockVolumeBase {
 }
 
 /**
- * @rc
  * Waypoint that points to a fixed location in the world.
  * Unlike entity waypoints, location waypoints always remain
  * valid and their position can be updated.
@@ -15696,7 +15705,6 @@ export class LocationWaypoint extends Waypoint {
 }
 
 /**
- * @rc
  * Manages the collection of waypoints displayed on a player's
  * locator bar. Allows adding, removing, and querying waypoints
  * with a maximum capacity limit.
@@ -16524,7 +16532,6 @@ export class Player extends Entity {
      */
     readonly level: number;
     /**
-     * @rc
      * @remarks
      * The player's Locator Bar. This property is used for managing
      * waypoints displayed on the HUD.
@@ -17241,6 +17248,83 @@ export class PlayerButtonInputAfterEventSignal {
     unsubscribe(callback: (arg0: PlayerButtonInputAfterEvent) => void): void;
 }
 
+/**
+ * @rc
+ * Contains information regarding an event after a player
+ * cancels breaking a block.
+ */
+// @ts-ignore Class inheritance allowed for native defined classes
+export class PlayerCancelBreakingBlockAfterEvent extends BlockEvent {
+    private constructor();
+    /**
+     * @remarks
+     * The permutation of the block that the player cancelled
+     * breaking.
+     *
+     */
+    readonly blockPermutation: BlockPermutation;
+    /**
+     * @remarks
+     * The progress of breaking the block when the player cancelled
+     * in the exclusive range (0, 1).
+     *
+     */
+    readonly breakProgress: number;
+    /**
+     * @remarks
+     * The face of the block that was being broken.
+     *
+     */
+    readonly face: Direction;
+    /**
+     * @remarks
+     * The item stack that the player was using to break the block,
+     * or undefined if empty hand.
+     *
+     */
+    readonly heldItemStack?: ItemStack;
+    /**
+     * @remarks
+     * Player that cancelled breaking the block for this event.
+     *
+     */
+    readonly player: Player;
+}
+
+/**
+ * @rc
+ * Manages callbacks that are connected to when a player
+ * cancels breaking a block.
+ */
+export class PlayerCancelBreakingBlockAfterEventSignal {
+    private constructor();
+    /**
+     * @remarks
+     * Adds a callback that will be called when a player cancels
+     * breaking a block.
+     *
+     * This function can't be called in restricted-execution mode.
+     *
+     * This function can be called in early-execution mode.
+     *
+     */
+    subscribe(
+        callback: (arg0: PlayerCancelBreakingBlockAfterEvent) => void,
+        options?: PlayerBreakingBlockEventOptions,
+    ): (arg0: PlayerCancelBreakingBlockAfterEvent) => void;
+    /**
+     * @remarks
+     * Removes a callback from being called when a player cancels
+     * breaking a block.
+     *
+     * This function can't be called in restricted-execution mode.
+     *
+     * This function can be called in early-execution mode.
+     *
+     */
+    unsubscribe(callback: (arg0: PlayerCancelBreakingBlockAfterEvent) => void): void;
+}
+
 /**
  * Represents the players cursor inventory. Used when moving
  * items between between containers in the inventory UI. Not
@@ -18346,6 +18430,76 @@ export class PlayerSpawnAfterEventSignal {
     unsubscribe(callback: (arg0: PlayerSpawnAfterEvent) => void): void;
 }
 
+/**
+ * @rc
+ * Contains information regarding an event after a player
+ * starts breaking a block.
+ */
+// @ts-ignore Class inheritance allowed for native defined classes
+export class PlayerStartBreakingBlockAfterEvent extends BlockEvent {
+    private constructor();
+    /**
+     * @remarks
+     * The permutation of the block that the player is starting to
+     * break.
+     *
+     */
+    readonly blockPermutation: BlockPermutation;
+    /**
+     * @remarks
+     * The face of the block being broken.
+     *
+     */
+    readonly face: Direction;
+    /**
+     * @remarks
+     * The item stack that the player is using to break the block,
+     * or undefined if empty hand.
+     *
+     */
+    readonly heldItemStack?: ItemStack;
+    /**
+     * @remarks
+     * Player that started breaking the block for this event.
+     *
+     */
+    readonly player: Player;
+}
+
+/**
+ * @rc
+ * Manages callbacks that are connected to when a player starts
+ * breaking a block.
+ */
+export class PlayerStartBreakingBlockAfterEventSignal {
+    private constructor();
+    /**
+     * @remarks
+     * Adds a callback that will be called when a player starts
+     * breaking a block.
+     *
+     * This function can't be called in restricted-execution mode.
+     *
+     * This function can be called in early-execution mode.
+     *
+     */
+    subscribe(
+        callback: (arg0: PlayerStartBreakingBlockAfterEvent) => void,
+        options?: PlayerBreakingBlockEventOptions,
+    ): (arg0: PlayerStartBreakingBlockAfterEvent) => void;
+    /**
+     * @remarks
+     * Removes a callback from being called when a player starts
+     * breaking a block.
+     *
+     * This function can't be called in restricted-execution mode.
+     *
+     * This function can be called in early-execution mode.
+     *
+     */
+    unsubscribe(callback: (arg0: PlayerStartBreakingBlockAfterEvent) => void): void;
+}
+
 /**
  * Contains information regarding a player starting to swing
  * their arm.
@@ -18411,7 +18565,6 @@ export class PlayerSwingStartAfterEventSignal {
 }
 
 /**
- * @rc
  * Waypoint that tracks a player's position. Extends {@link
  * EntityWaypoint} with additional player-specific visibility
  * rules such as hidden state and spectator mode.
@@ -18645,7 +18798,6 @@ export class PressurePlatePushAfterEventSignal {
 }
 
 /**
- * @rc
  * The base class for a text primitive. Represents an object in
  * the world and its base properties.
  */
@@ -18749,7 +18901,6 @@ export class PrimitiveShape {
 }
 
 /**
- * @rc
  * Primitive Shapes class used to allow adding and removing
  * text primitives to the world.
  */
@@ -20083,7 +20234,6 @@ export class StartupEvent {
      */
     readonly customCommandRegistry: CustomCommandRegistry;
     /**
-     * @rc
      * @remarks
      * This property can be read in early-execution mode.
      *
@@ -20339,7 +20489,6 @@ export class StructureManager {
      */
     get(identifier: string): Structure | undefined;
     /**
-     * @rc
      * @remarks
      * Returns a list of all structures contained in behavior
      * packs. Does not include structures saved to the world or in
@@ -20826,7 +20975,6 @@ export class TargetBlockHitAfterEventSignal {
 }
 
 /**
- * @rc
  * A primitive shape class that represents a text label in the
  * world with a background.
  */
@@ -21134,7 +21282,6 @@ export class TripWireTripAfterEventSignal {
 }
 
 /**
- * @rc
  * Base class for waypoints displayed on the player's locator
  * bar. Waypoints can track locations or entities and are
  * rendered with customizable textures and colors.
@@ -21394,7 +21541,6 @@ export class World {
     readonly gameRules: GameRules;
     readonly isHardcore: boolean;
     /**
-     * @rc
      * @remarks
      * Manager for adding and removing primitive text objects in
      * the world.
@@ -21621,7 +21767,6 @@ export class World {
      */
     getMoonPhase(): MoonPhase;
     /**
-     * @rc
      * @remarks
      * Returns a map of pack setting name and value pairs.
      *
@@ -21884,7 +22029,6 @@ export class World {
 export class WorldAfterEvents {
     private constructor();
     /**
-     * @rc
      * @remarks
      * This event fires when a block container is closed.
      *
@@ -21893,7 +22037,6 @@ export class WorldAfterEvents {
      */
     readonly blockContainerClosed: BlockContainerClosedAfterEventSignal;
     /**
-     * @rc
      * @remarks
      * This event fires when a block container is opened.
      *
@@ -21939,7 +22082,6 @@ export class WorldAfterEvents {
      */
     readonly effectAdd: EffectAddAfterEventSignal;
     /**
-     * @rc
      * @remarks
      * This event fires when an entity container is closed.
      *
@@ -21948,7 +22090,6 @@ export class WorldAfterEvents {
      */
     readonly entityContainerClosed: EntityContainerClosedAfterEventSignal;
     /**
-     * @rc
      * @remarks
      * This event fires when an entity container is opened.
      *
@@ -22046,7 +22187,6 @@ export class WorldAfterEvents {
      */
     readonly entitySpawn: EntitySpawnAfterEventSignal;
     /**
-     * @rc
      * @remarks
      * This property can be read in early-execution mode.
      *
@@ -22166,6 +22306,15 @@ export class WorldAfterEvents {
      *
      */
     readonly playerButtonInput: PlayerButtonInputAfterEventSignal;
+    /**
+     * @rc
+     * @remarks
+     * This event fires when a player cancels breaking a block.
+     *
+     * This property can be read in early-execution mode.
+     *
+     */
+    readonly playerCancelBreakingBlock: PlayerCancelBreakingBlockAfterEventSignal;
     /**
      * @remarks
      * Fires when a player moved to a different dimension.
@@ -22271,6 +22420,15 @@ export class WorldAfterEvents {
      *
      */
     readonly playerSpawn: PlayerSpawnAfterEventSignal;
+    /**
+     * @rc
+     * @remarks
+     * This event fires when a player starts breaking a block.
+     *
+     * This property can be read in early-execution mode.
+     *
+     */
+    readonly playerStartBreakingBlock: PlayerStartBreakingBlockAfterEventSignal;
     /**
      * @remarks
      * This property can be read in early-execution mode.
@@ -22523,6 +22681,20 @@ export interface BiomeFilter {
     includeTags?: string[];
 }
 
+/**
+ * @rc
+ * Contains additional options for searches for the
+ * dimension.findNearestBiome API.
+ */
+export interface BiomeSearchOptions {
+    /**
+     * @remarks
+     * Bounding volume size to look within.
+     *
+     */
+    boundingSize?: Vector3;
+}
+
 /**
  * A BlockBoundingBox is an interface to an object which
  * represents an AABB aligned rectangle.
@@ -22557,7 +22729,6 @@ export interface BlockBoundingBox {
 }
 
 /**
- * @rc
  * Options used to filter block container access events.
  */
 export interface BlockContainerAccessEventOptions {
@@ -22589,9 +22760,6 @@ export interface BlockCustomComponent {
      *
      */
     beforeOnPlayerPlace?: (arg0: BlockComponentPlayerPlaceBeforeEvent, arg1: CustomComponentParameters) => void;
-    /**
-     * @rc
-     */
     onBlockStateChange?: (arg0: BlockComponentBlockStateChangeEvent, arg1: CustomComponentParameters) => void;
     /**
      * @remarks
@@ -22981,7 +23149,6 @@ export interface CameraTargetOptions {
 }
 
 /**
- * @rc
  * Represents the source of a container access.
  */
 export interface ContainerAccessSource {
@@ -22994,7 +23161,6 @@ export interface ContainerAccessSource {
 }
 
 /**
- * @rc
  * Options for use when filtering container access sources.
  */
 export interface ContainerAccessSourceFilter {
@@ -23124,9 +23290,6 @@ export interface CustomCommandResult {
     status: CustomCommandStatus;
 }
 
-/**
- * @rc
- */
 export interface CustomTexture {
     /**
      * @remarks
@@ -23281,7 +23444,6 @@ export interface EntityApplyDamageOptions {
 }
 
 /**
- * @rc
  * Options used to filter entity container access events.
  */
 export interface EntityContainerAccessEventOptions {
@@ -23974,7 +24136,6 @@ export interface EntityRaycastOptions extends EntityFilter {
 }
 
 /**
- * @rc
  * Controls when a waypoint is visible based on the state of
  * the entity it tracks. These rules allow filtering waypoint
  * visibility by entity conditions like sneaking, invisibility,
@@ -24479,6 +24640,33 @@ export interface PlayerAimAssistSettings {
     viewAngle?: Vector2;
 }
 
+/**
+ * @rc
+ * An interface that is passed into {@link
+ * PlayerStartBreakingBlockAfterEventSignal.subscribe} or
+ * {@link PlayerCancelBreakingBlockAfterEventSignal.subscribe}
+ * that filters out which events are passed to the provided
+ * callback.
+ */
+export interface PlayerBreakingBlockEventOptions {
+    /**
+     * @remarks
+     * The {@link BlockFilter} that the callback should be called
+     * for. If undefined, the callback will be called for all
+     * blocks.
+     *
+     */
+    blockFilter?: BlockFilter;
+    /**
+     * @remarks
+     * The {@link EntityFilter} that the callback should be called
+     * for. If undefined, the callback will be called for all
+     * players.
+     *
+     */
+    playerFilter?: EntityFilter;
+}
+
 /**
  * Additional options for how a sound plays for a player.
  */
@@ -24530,7 +24718,6 @@ export interface PlayerSwingEventOptions {
 }
 
 /**
- * @rc
  * Controls when a waypoint is visible based on player-specific
  * states. Extends {@link EntityVisibilityRules} with
  * additional rules for player-only states like hidden mode and
@@ -25259,7 +25446,6 @@ export interface VectorXZ {
 }
 
 /**
- * @rc
  * Defines a texture and the distance range in which it should
  * be displayed. Used within a {@link WaypointTextureSelector}
  * to create distance-based texture switching.
@@ -25294,7 +25480,6 @@ export interface WaypointTextureBounds {
 }
 
 /**
- * @rc
  * Defines how waypoint textures change based on distance.
  * Contains a list of texture bounds that determine which
  * texture is displayed at different distance ranges.
@@ -25448,7 +25633,6 @@ export class CustomComponentNameError extends Error {
 }
 
 /**
- * @rc
  * Thrown when trying to register a custom dimension with a
  * name that has already been registered.
  */
@@ -25458,7 +25642,6 @@ export class CustomDimensionAlreadyRegisteredError extends Error {
 }
 
 /**
- * @rc
  * Thrown when trying to register a custom dimension outside of
  * the system startup event.
  */
@@ -25468,7 +25651,6 @@ export class CustomDimensionInvalidRegistryError extends Error {
 }
 
 /**
- * @rc
  * Thrown when trying to register a custom dimension with a
  * name that contains invalid characters.
  */
@@ -25478,7 +25660,6 @@ export class CustomDimensionNameError extends Error {
 }
 
 /**
- * @rc
  * Thrown after using the /reload command when trying to
  * register a custom dimension that was not previously
  * registered. New custom dimensions cannot be added during a
@@ -25613,7 +25794,6 @@ export class InvalidStructureError extends Error {
 }
 
 /**
- * @rc
  * Error thrown when attempting to perform operations on an
  * invalid waypoint. A waypoint becomes invalid when it is
  * removed or when the entity it tracks is no longer valid.
@@ -25623,9 +25803,6 @@ export class InvalidWaypointError extends Error {
     private constructor();
 }
 
-/**
- * @rc
- */
 // @ts-ignore Class inheritance allowed for native defined classes
 export class InvalidWaypointTextureSelectorError extends Error {
     private constructor();
@@ -25688,7 +25865,6 @@ export class LocationOutOfWorldBoundariesError extends Error {
 }
 
 /**
- * @rc
  * Error thrown when a locator bar operation fails. Contains a
  * reason code indicating the specific cause of the error.
  */
@@ -25726,9 +25902,6 @@ export class PlaceJigsawError extends Error {
     private constructor();
 }
 
-/**
- * @rc
- */
 // @ts-ignore Class inheritance allowed for native defined classes
 export class PrimitiveShapeError extends Error {
     private constructor();

package/package.json

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