@minecraft/server 2.9.0-beta.1.26.30-preview.28 → 2.9.0-beta.1.26.30-preview.32

package/index.d.ts

@@ -1149,6 +1149,15 @@ export enum EntityComponentTypes {
      *
      */
     Exhaustion = 'minecraft:player.exhaustion',
+    /**
+     * @beta
+     * @remarks
+     * Use this component to access and manipulate the fog
+     * definitions stack of a player. This is only available on
+     * players.
+     *
+     */
+    Fog = 'minecraft:player.fog',
     /**
      * @remarks
      * Use this component to read the hunger of a player. This is
@@ -2350,7 +2359,7 @@ export enum LiquidType {
 }
 
 /**
- * @beta
+ * @rc
  * Enum representing the different reasons why a locator bar
  * operation may fail.
  */
@@ -3053,7 +3062,7 @@ export enum WatchdogTerminateReason {
 }
 
 /**
- * @beta
+ * @rc
  * Enum representing different texture icons that can be
  * displayed for waypoints on the locator bar.
  */
@@ -3242,6 +3251,7 @@ export type EntityComponentTypeMap = {
     'minecraft:npc': EntityNpcComponent;
     'minecraft:onfire': EntityOnFireComponent;
     'minecraft:player.exhaustion': EntityExhaustionComponent;
+    'minecraft:player.fog': EntityFogComponent;
     'minecraft:player.hunger': EntityHungerComponent;
     'minecraft:player.saturation': EntitySaturationComponent;
     'minecraft:projectile': EntityProjectileComponent;
@@ -3276,6 +3286,7 @@ export type EntityComponentTypeMap = {
     npc: EntityNpcComponent;
     onfire: EntityOnFireComponent;
     'player.exhaustion': EntityExhaustionComponent;
+    'player.fog': EntityFogComponent;
     'player.hunger': EntityHungerComponent;
     'player.saturation': EntitySaturationComponent;
     projectile: EntityProjectileComponent;
@@ -9075,7 +9086,7 @@ export class Dimension {
 }
 
 /**
- * @beta
+ * @rc
  * Provides the functionality for registering custom
  * dimensions. Custom dimensions can only be registered during
  * the system startup event.
@@ -11433,6 +11444,140 @@ export class EntityFlyingSpeedComponent extends EntityComponent {
     static readonly componentId = 'minecraft:flying_speed';
 }
 
+/**
+ * @beta
+ * Provides access to the fog definitions stack of a player
+ * entity, allowing scripts to push, pop, remove, and query
+ * active fog definitions.
+ */
+// @ts-ignore Class inheritance allowed for native defined classes
+export class EntityFogComponent extends EntityComponent {
+    private constructor();
+    static readonly componentId = 'minecraft:player.fog';
+    /**
+     * @remarks
+     * Sets the player's fog stack to the given list of fog
+     * identifiers, replacing any existing entries.
+     *
+     * This function can't be called in restricted-execution mode.
+     *
+     * @param fogIds
+     * A stack of fog definition identifiers to set on the player's
+     * fog stack (e.g. ['minecraft:fog_bamboo_jungle']). Maximum of
+     * 16 entries.
+     * @param tag
+     * An optional tag to associate with the new entries, used to
+     * target them with pop or remove.
+     * @throws
+     * Throws if the entity is invalid, if more than 16 fog
+     * identifiers are provided, or if any fog identifier is
+     * invalid.
+     *
+     * {@link EntityFogComponentError}
+     *
+     * {@link InvalidEntityError}
+     */
+    applyStack(fogIds: string[], tag?: string): void;
+    /**
+     * @remarks
+     * Returns the list of fog identifiers currently on the
+     * player's fog stack, ordered from bottom to top.
+     *
+     * This function can't be called in restricted-execution mode.
+     *
+     * @returns
+     * An array of fog definition identifiers currently on the
+     * stack.
+     * @throws
+     * Throws if the entity is invalid.
+     *
+     * {@link InvalidEntityError}
+     */
+    getStack(): string[];
+    /**
+     * @remarks
+     * Returns the list of tags currently present on the player's
+     * fog stack.
+     *
+     * This function can't be called in restricted-execution mode.
+     *
+     * @returns
+     * An array of tag strings associated with fog settings on the
+     * stack.
+     * @throws
+     * Throws if the entity is invalid.
+     *
+     * {@link InvalidEntityError}
+     */
+    getTags(): string[];
+    /**
+     * @remarks
+     * Removes the most recently pushed fog definition from the
+     * player's fog stack.
+     *
+     * This function can't be called in restricted-execution mode.
+     *
+     * @param tag
+     * An optional tag identifying which entry to pop. If provided,
+     * searches the stack from top to bottom and removes the most
+     * recently pushed entry with this tag. If omitted, removes the
+     * most recently pushed entry regardless of tag.
+     * @returns
+     * Returns the identifier of the popped fog definition, or
+     * undefined if the stack was unchanged.
+     * @throws
+     * Throws if the entity is invalid.
+     *
+     * {@link InvalidEntityError}
+     */
+    pop(tag?: string): string | undefined;
+    /**
+     * @remarks
+     * Pushes a new fog definition onto the player's fog stack.
+     *
+     * This function can't be called in restricted-execution mode.
+     *
+     * @param fogId
+     * The identifier of the fog definition to push onto the stack
+     * (e.g. 'minecraft:fog_bamboo_jungle').
+     * @param tag
+     * An optional tag used to label this fog definition on the
+     * stack, allowing it to be targeted by pop or remove. If
+     * omitted, the entry is stored with the tag 'untagged'.
+     * @returns
+     * Returns the zero-based index at which the fog definition was
+     * inserted into the stack.
+     * @throws
+     * Throws if the entity is invalid, the fog identifier is
+     * invalid, or if the stack limit of 16 has been exceeded.
+     *
+     * {@link EntityFogComponentError}
+     *
+     * {@link InvalidEntityError}
+     */
+    push(fogId: string, tag?: string): number;
+    /**
+     * @remarks
+     * Removes all fog definitions with the given tag from the
+     * player's fog stack. If no tag is provided, clears all fog
+     * definitions.
+     *
+     * This function can't be called in restricted-execution mode.
+     *
+     * @param tag
+     * An optional tag identifying which the entries to remove. If
+     * omitted, clears all fog definitions regardless of tag.
+     * @returns
+     * Returns true if at least one entry was removed, or false if
+     * the stack was unchanged.
+     * @throws
+     * Throws if the entity is invalid.
+     *
+     * {@link InvalidEntityError}
+     */
+    remove(tag?: string): boolean;
+}
+
 /**
  * Defines how much friction affects this entity.
  */
@@ -13916,7 +14061,7 @@ export class EntityUpgradeAfterEvent {
 }
 
 /**
- * @beta
+ * @rc
  * Contains event registration related to firing of a data
  * driven entity version upgrade.
  */
@@ -13978,7 +14123,7 @@ export class EntityWantsJockeyComponent extends EntityComponent {
 }
 
 /**
- * @beta
+ * @rc
  * Waypoint that tracks an entity's position. The waypoint
  * automatically updates as the entity moves and becomes
  * invalid when the entity is removed.
@@ -14615,6 +14760,10 @@ export class IsBabyCondition extends LootItemCondition {
     private constructor();
 }
 
+export class ISerializable {
+    private constructor();
+}
+
 /**
  * When present on an item, this item is a book item. Can
  * access and modify the contents of the book and sign it.
@@ -16780,7 +16929,7 @@ export class ListBlockVolume extends BlockVolumeBase {
 }
 
 /**
- * @beta
+ * @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.
@@ -16808,7 +16957,7 @@ export class LocationWaypoint extends Waypoint {
 }
 
 /**
- * @beta
+ * @rc
  * Manages the collection of waypoints displayed on a player's
  * locator bar. Allows adding, removing, and querying waypoints
  * with a maximum capacity limit.
@@ -17766,7 +17915,7 @@ export class Player extends Entity {
      */
     readonly level: number;
     /**
-     * @beta
+     * @rc
      * @remarks
      * The player's Locator Bar. This property is used for managing
      * waypoints displayed on the HUD.
@@ -18562,6 +18711,83 @@ export class PlayerButtonInputAfterEventSignal {
     unsubscribe(callback: (arg0: PlayerButtonInputAfterEvent) => void): void;
 }
 
+/**
+ * @beta
+ * 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;
+}
+
+/**
+ * @beta
+ * 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
@@ -19958,7 +20184,7 @@ export class PlayerUseNameTagAfterEventSignal {
 }
 
 /**
- * @beta
+ * @rc
  * Waypoint that tracks a player's position. Extends {@link
  * EntityWaypoint} with additional player-specific visibility
  * rules such as hidden state and spectator mode.
@@ -21671,7 +21897,7 @@ export class StartupEvent {
      */
     readonly customCommandRegistry: CustomCommandRegistry;
     /**
-     * @beta
+     * @rc
      * @remarks
      * This property can be read in early-execution mode.
      *
@@ -21690,7 +21916,8 @@ export class StartupEvent {
  * Structures can be placed in a world using the /structure
  * command or the {@link StructureManager} APIs.
  */
-export class Structure {
+// @ts-ignore Class inheritance allowed for native defined classes
+export class Structure extends ISerializable {
     private constructor();
     /**
      * @remarks
@@ -22799,7 +23026,7 @@ export class WatchdogTerminateBeforeEventSignal {
 }
 
 /**
- * @beta
+ * @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.
@@ -23753,7 +23980,7 @@ export class WorldAfterEvents {
      */
     readonly entityStartSneaking: EntityStartSneakingAfterEventSignal;
     /**
-     * @beta
+     * @rc
      * @remarks
      * This property can be read in early-execution mode.
      *
@@ -23892,6 +24119,15 @@ export class WorldAfterEvents {
      *
      */
     readonly playerButtonInput: PlayerButtonInputAfterEventSignal;
+    /**
+     * @beta
+     * @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.
@@ -24973,7 +25209,7 @@ export interface CustomCommandResult {
 }
 
 /**
- * @beta
+ * @rc
  */
 export interface CustomTexture {
     /**
@@ -25839,7 +26075,7 @@ export interface EntitySneakingChangedEventOptions {
 }
 
 /**
- * @beta
+ * @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,
@@ -26347,8 +26583,9 @@ export interface PlayerAimAssistSettings {
 /**
  * @beta
  * An interface that is passed into {@link
- * PlayerStartBreakingBlockAfterEventSignal.subscribe} that
- * filters out which events are passed to the provided
+ * PlayerStartBreakingBlockAfterEventSignal.subscribe} or
+ * {@link PlayerCancelBreakingBlockAfterEventSignal.subscribe}
+ * that filters out which events are passed to the provided
  * callback.
  */
 export interface PlayerBreakingBlockEventOptions {
@@ -26421,7 +26658,7 @@ export interface PlayerSwingEventOptions {
 }
 
 /**
- * @beta
+ * @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
@@ -27150,7 +27387,7 @@ export interface VectorXZ {
 }
 
 /**
- * @beta
+ * @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.
@@ -27185,7 +27422,7 @@ export interface WaypointTextureBounds {
 }
 
 /**
- * @beta
+ * @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.
@@ -27339,7 +27576,7 @@ export class CustomComponentNameError extends Error {
 }
 
 /**
- * @beta
+ * @rc
  * Thrown when trying to register a custom dimension with a
  * name that has already been registered.
  */
@@ -27349,7 +27586,7 @@ export class CustomDimensionAlreadyRegisteredError extends Error {
 }
 
 /**
- * @beta
+ * @rc
  * Thrown when trying to register a custom dimension outside of
  * the system startup event.
  */
@@ -27359,7 +27596,7 @@ export class CustomDimensionInvalidRegistryError extends Error {
 }
 
 /**
- * @beta
+ * @rc
  * Thrown when trying to register a custom dimension with a
  * name that contains invalid characters.
  */
@@ -27369,7 +27606,7 @@ export class CustomDimensionNameError extends Error {
 }
 
 /**
- * @beta
+ * @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
@@ -27395,6 +27632,17 @@ export class EnchantmentTypeUnknownIdError extends Error {
     private constructor();
 }
 
+/**
+ * @beta
+ * Error thrown by {@link EntityFogComponent} operations when
+ * the fog stack limit is exceeded or an invalid fog identifier
+ * is provided.
+ */
+// @ts-ignore Class inheritance allowed for native defined classes
+export class EntityFogComponentError extends Error {
+    private constructor();
+}
+
 // @ts-ignore Class inheritance allowed for native defined classes
 export class EntitySpawnError extends Error {
     private constructor();
@@ -27504,7 +27752,7 @@ export class InvalidStructureError extends Error {
 }
 
 /**
- * @beta
+ * @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.
@@ -27515,7 +27763,7 @@ export class InvalidWaypointError extends Error {
 }
 
 /**
- * @beta
+ * @rc
  */
 // @ts-ignore Class inheritance allowed for native defined classes
 export class InvalidWaypointTextureSelectorError extends Error {
@@ -27579,7 +27827,7 @@ export class LocationOutOfWorldBoundariesError extends Error {
 }
 
 /**
- * @beta
+ * @rc
  * Error thrown when a locator bar operation fails. Contains a
  * reason code indicating the specific cause of the error.
  */

package/package.json

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