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

package/index.d.ts

@@ -47,6 +47,10 @@ export enum AimAssistTargetMode {
  * function Block.getComponent.
  */
 export enum BlockComponentTypes {
+    /**
+     * @beta
+     */
+    DynamicProperties = 'minecraft:dynamic_properties',
     FluidContainer = 'minecraft:fluid_container',
     /**
      * @remarks
@@ -1503,7 +1507,7 @@ export enum EntityHealCause {
      */
     SelfHeal = 'SelfHeal',
     /**
-     * @beta
+     * @rc
      * @remarks
      * Healing caused when Totem of Undying is activated.
      *
@@ -3110,9 +3114,11 @@ export type BlockComponentReturnType<T extends string> = T extends keyof BlockCo
     : BlockCustomComponentInstance;
 
 export type BlockComponentTypeMap = {
+    dynamic_properties: BlockDynamicPropertiesComponent;
     fluid_container: BlockFluidContainerComponent;
     inventory: BlockInventoryComponent;
     map_color: BlockMapColorComponent;
+    'minecraft:dynamic_properties': BlockDynamicPropertiesComponent;
     'minecraft:fluid_container': BlockFluidContainerComponent;
     'minecraft:inventory': BlockInventoryComponent;
     'minecraft:map_color': BlockMapColorComponent;
@@ -3907,14 +3913,12 @@ export class BiomeType {
      */
     readonly id: string;
     /**
-     * @rc
      * @remarks
      * Returns a list of the biome's tags.
      *
      */
     getTags(): string[];
     /**
-     * @rc
      * @remarks
      * Checks if the biome has all of the provided tags.
      *
@@ -3925,7 +3929,6 @@ export class BiomeType {
 }
 
 /**
- * @rc
  * Supports a catalog of available biome types registered
  * within Minecraft.
  */
@@ -4792,7 +4795,7 @@ export class BlockComponentBlockBreakEvent extends BlockEvent {
 }
 
 /**
- * @beta
+ * @rc
  * Contains information regarding a specific block permutation
  * that was changed from a previous permutation.
  */
@@ -5174,6 +5177,108 @@ export class BlockCustomComponentInstance extends BlockComponent {
     readonly customComponentParameters: CustomComponentParameters;
 }
 
+/**
+ * @beta
+ * Represents the dynamic properties of a block in the world.
+ * Only available with block entities. Up to 1KBytes of data
+ * can be stored per block entity in their dynamic properties
+ * storage.
+ * @example rememberPlayerInteraction.ts
+ * ```typescript
+ * import { system } from '@minecraft/server-wrapper';
+ *
+ * system.beforeEvents.startup.subscribe(initEvent => {
+ *   initEvent.blockComponentRegistry.registerCustomComponent('scripting_demo_pack:block_entity_onPlayerInteract', {
+ *     onPlayerInteract: e => {
+ *       if (e.player === undefined) {
+ *         return;
+ *       }
+ *
+ *       const dynamicProperties = e.block.getComponent('minecraft:dynamic_properties');
+ *       if (!dynamicProperties) {
+ *         return;
+ *       }
+ *
+ *       const lastInteractorValue = dynamicProperties.get('last_interactor');
+ *       const lastVisitor = typeof lastInteractorValue === 'string' ? lastInteractorValue : 'unknown';
+ *       const lastTick = Number(dynamicProperties.get('last_interact_tick') ?? system.currentTick);
+ *       const ticksAgo = Math.max(0, system.currentTick - lastTick);
+ *
+ *       if (lastVisitor === e.player.name) {
+ *         e.player.sendMessage("do you remember that player? I 'member, it was here " + String(ticksAgo) + ' ticks ago!');
+ *       } else {
+ *         e.player.sendMessage("oh, I don't remember that player");
+ *       }
+ *
+ *       dynamicProperties.set('last_interactor', e.player.name);
+ *       dynamicProperties.set('last_interact_tick', system.currentTick);
+ *     },
+ *   });
+ * });
+ * ```
+ */
+// @ts-ignore Class inheritance allowed for native defined classes
+export class BlockDynamicPropertiesComponent extends BlockComponent {
+    private constructor();
+    static readonly componentId = 'minecraft:dynamic_properties';
+    /**
+     * @remarks
+     * Returns a DynamicProperty that was stored with the provided
+     * key. Keys are unique to each content pack and cannot be used
+     * to retrieve dynamic properties set from other content packs.
+     * Returns undefined if the key was not found.
+     *
+     * @throws This function can throw errors.
+     *
+     * {@link Error}
+     *
+     * {@link InvalidBlockComponentError}
+     *
+     * {@link LocationInUnloadedChunkError}
+     *
+     * {@link LocationOutOfWorldBoundariesError}
+     */
+    get(key: string): boolean | number | string | Vector3 | undefined;
+    /**
+     * @remarks
+     * Sets a dynamic property with the provided key and value.
+     * Keys are unique to each content pack and cannot be used to
+     * set dynamic properties for other content packs. Values can
+     * be either a Number, a String or a Vector3. Setting a
+     * property with an undefined value will remove it from the
+     * storage.
+     *
+     * This function can't be called in restricted-execution mode.
+     *
+     * @throws This function can throw errors.
+     *
+     * {@link Error}
+     *
+     * {@link InvalidBlockComponentError}
+     *
+     * {@link LocationInUnloadedChunkError}
+     *
+     * {@link LocationOutOfWorldBoundariesError}
+     */
+    set(key: string, value?: boolean | number | string | Vector3): void;
+    /**
+     * @remarks
+     * Returns the current size, in bytes, of the dynamic
+     * properties storage for this block entity.
+     *
+     * @throws This function can throw errors.
+     *
+     * {@link Error}
+     *
+     * {@link InvalidBlockComponentError}
+     *
+     * {@link LocationInUnloadedChunkError}
+     *
+     * {@link LocationOutOfWorldBoundariesError}
+     */
+    totalByteCount(): number;
+}
+
 /**
  * Contains information regarding an event that impacts a
  * specific block.
@@ -5767,7 +5872,7 @@ export class BlockPrecipitationInteractionsComponent extends BlockComponent {
      */
     accumulatesSnow(): boolean;
     /**
-     * @beta
+     * @rc
      * @remarks
      * Returns `true` if this block can have snow within it, like a
      * flower submerged in snow. Returns `false` if this block
@@ -9646,7 +9751,6 @@ export class Entity {
      */
     addEffect(effectType: EffectType | string, duration: number, options?: EntityEffectOptions): Effect | undefined;
     /**
-     * @rc
      * @remarks
      * Adds an item to the entity's inventory.
      *
@@ -13517,6 +13621,54 @@ export class EntitySpawnAfterEventSignal {
     unsubscribe(callback: (arg0: EntitySpawnAfterEvent) => void): void;
 }
 
+/**
+ * @beta
+ * Contains data related to an entity beginning to sneak.
+ */
+export class EntityStartSneakingAfterEvent {
+    private constructor();
+    /**
+     * @remarks
+     * Entity that has started sneaking.
+     *
+     */
+    readonly entity: Entity;
+}
+
+/**
+ * @beta
+ * Manages callbacks that are connected to when an entity
+ * begins sneaking.
+ */
+export class EntityStartSneakingAfterEventSignal {
+    private constructor();
+    /**
+     * @remarks
+     * Adds a callback that will be called when an entity begins
+     * sneaking.
+     *
+     * This function can't be called in restricted-execution mode.
+     *
+     * This function can be called in early-execution mode.
+     *
+     */
+    subscribe(
+        callback: (arg0: EntityStartSneakingAfterEvent) => void,
+        options?: EntitySneakingChangedEventOptions,
+    ): (arg0: EntityStartSneakingAfterEvent) => void;
+    /**
+     * @remarks
+     * Removes a callback from being called when an entity begins
+     * sneaking.
+     *
+     * This function can't be called in restricted-execution mode.
+     *
+     * This function can be called in early-execution mode.
+     *
+     */
+    unsubscribe(callback: (arg0: EntityStartSneakingAfterEvent) => void): void;
+}
+
 /**
  * Defines the entity's ability to carry items. An entity with
  * a higher strength would have higher potential carry capacity
@@ -13736,7 +13888,7 @@ export class EntityUnderwaterMovementComponent extends EntityAttributeComponent
 }
 
 /**
- * @beta
+ * @rc
  * Contains information related to firing of a data driven
  * entity version upgrade.
  */
@@ -16819,6 +16971,10 @@ export class LootingEnchantFunction extends LootItemFunction {
 // @ts-ignore Class inheritance allowed for native defined classes
 export class LootItem extends LootPoolEntry {
     private constructor();
+    /**
+     * @beta
+     */
+    readonly conditions: LootItemCondition[];
     readonly functions: LootItemFunction[];
     /**
      * @remarks
@@ -17632,17 +17788,6 @@ export class Player extends Entity {
      * @throws This property can throw when used.
      */
     readonly onScreenDisplay: ScreenDisplay;
-    /**
-     * @beta
-     * @remarks
-     * The party information for this player, or undefined if the
-     * player is not in a party.
-     *
-     * @throws This property can throw when used.
-     *
-     * {@link InvalidEntityError}
-     */
-    readonly partyInfo?: PartyInfo;
     /**
      * @throws This property can throw when used.
      *
@@ -19604,6 +19749,76 @@ export class PlayerSpawnAfterEventSignal {
     unsubscribe(callback: (arg0: PlayerSpawnAfterEvent) => void): void;
 }
 
+/**
+ * @beta
+ * 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;
+}
+
+/**
+ * @beta
+ * 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.
@@ -19977,7 +20192,7 @@ export class PressurePlatePushAfterEventSignal {
 }
 
 /**
- * @beta
+ * @rc
  * The base class for a text primitive. Represents an object in
  * the world and its base properties.
  */
@@ -20081,7 +20296,7 @@ export class PrimitiveShape {
 }
 
 /**
- * @beta
+ * @rc
  * Primitive Shapes class used to allow adding and removing
  * text primitives to the world.
  */
@@ -22211,7 +22426,7 @@ export class TargetBlockHitAfterEventSignal {
 }
 
 /**
- * @beta
+ * @rc
  * A primitive shape class that represents a text label in the
  * world with a background.
  */
@@ -22853,7 +23068,7 @@ export class World {
     readonly gameRules: GameRules;
     readonly isHardcore: boolean;
     /**
-     * @beta
+     * @rc
      * @remarks
      * Manager for adding and removing primitive text objects in
      * the world.
@@ -23094,7 +23309,7 @@ export class World {
      */
     getMoonPhase(): MoonPhase;
     /**
-     * @beta
+     * @rc
      * @remarks
      * Returns a map of pack setting name and value pairs.
      *
@@ -23528,6 +23743,15 @@ export class WorldAfterEvents {
      *
      */
     readonly entitySpawn: EntitySpawnAfterEventSignal;
+    /**
+     * @beta
+     * @remarks
+     * This event fires when an entity starts sneaking.
+     *
+     * This property can be read in early-execution mode.
+     *
+     */
+    readonly entityStartSneaking: EntityStartSneakingAfterEventSignal;
     /**
      * @beta
      * @remarks
@@ -23773,6 +23997,15 @@ export class WorldAfterEvents {
      *
      */
     readonly playerSpawn: PlayerSpawnAfterEventSignal;
+    /**
+     * @beta
+     * @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.
@@ -24162,7 +24395,7 @@ export interface BlockCustomComponent {
      */
     beforeOnPlayerPlace?: (arg0: BlockComponentPlayerPlaceBeforeEvent, arg1: CustomComponentParameters) => void;
     /**
-     * @beta
+     * @rc
      */
     onBlockStateChange?: (arg0: BlockComponentBlockStateChangeEvent, arg1: CustomComponentParameters) => void;
     /**
@@ -25596,6 +25829,15 @@ export interface EntityRaycastOptions extends EntityFilter {
     maxDistance?: number;
 }
 
+/**
+ * @beta
+ * Options used to filter entity start sneaking and stop
+ * sneaking events.
+ */
+export interface EntitySneakingChangedEventOptions {
+    entityFilter?: EntityFilter;
+}
+
 /**
  * @beta
  * Controls when a waypoint is visible based on the state of
@@ -26033,27 +26275,6 @@ export interface NotEqualsComparison {
     notEquals: boolean | number | string;
 }
 
-/**
- * @beta
- * Contains information about a player's party membership. This
- * object is a snapshot of the player's party state at the time
- * it was retrieved and is not kept up to date.
- */
-export interface PartyInfo {
-    /**
-     * @remarks
-     * Whether this player is the leader of their party.
-     *
-     */
-    isLeader: boolean;
-    /**
-     * @remarks
-     * The unique identifier of the party this player belongs to.
-     *
-     */
-    partyId: string;
-}
-
 /**
  * Contains additional options for how an animation is played.
  */
@@ -26123,6 +26344,32 @@ export interface PlayerAimAssistSettings {
     viewAngle?: Vector2;
 }
 
+/**
+ * @beta
+ * An interface that is passed into {@link
+ * PlayerStartBreakingBlockAfterEventSignal.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.
  */
@@ -27182,7 +27429,6 @@ export class InvalidContainerSlotError extends Error {
 }
 
 /**
- * @rc
  * This error can occur when accessing components on an entity
  * that doesn't have them.
  */
@@ -27372,7 +27618,7 @@ export class PlaceJigsawError extends Error {
 }
 
 /**
- * @beta
+ * @rc
  */
 // @ts-ignore Class inheritance allowed for native defined classes
 export class PrimitiveShapeError extends Error {

package/package.json

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