@minecraft/server 2.9.0-beta.1.26.30-preview.32 → 2.10.0-beta.1.26.40-preview.20

package/index.d.ts

@@ -16,7 +16,7 @@
  * ```json
  * {
  *   "module_name": "@minecraft/server",
- *   "version": "2.9.0-beta"
+ *   "version": "2.10.0-beta"
  * }
  * ```
  *
@@ -52,6 +52,10 @@ export enum BlockComponentTypes {
      */
     DynamicProperties = 'minecraft:dynamic_properties',
     FluidContainer = 'minecraft:fluid_container',
+    /**
+     * @beta
+     */
+    Instrument = 'minecraft:instrument_sound',
     /**
      * @remarks
      * Represents the inventory of a block in the world. Used with
@@ -197,6 +201,25 @@ export enum ButtonState {
     Released = 'Released',
 }
 
+/**
+ * @beta
+ * Represents the type of shake to apply to the camera.
+ */
+export enum CameraShakeType {
+    /**
+     * @remarks
+     * A positional shake that moves the camera along its axes.
+     *
+     */
+    Positional = 'Positional',
+    /**
+     * @remarks
+     * A rotational shake that rotates the camera around its axes.
+     *
+     */
+    Rotational = 'Rotational',
+}
+
 /**
  * The required permission level to execute the custom command.
  */
@@ -2263,6 +2286,10 @@ export enum InputPermissionCategory {
  * function ItemStack.getComponent.
  */
 export enum ItemComponentTypes {
+    /**
+     * @beta
+     */
+    BlockDynamicProperties = 'minecraft:block_actor_dynamic_properties',
     /**
      * @remarks
      * The minecraft:book component.
@@ -3125,10 +3152,12 @@ export type BlockComponentReturnType<T extends string> = T extends keyof BlockCo
 export type BlockComponentTypeMap = {
     dynamic_properties: BlockDynamicPropertiesComponent;
     fluid_container: BlockFluidContainerComponent;
+    instrument_sound: BlockInstrumentComponent;
     inventory: BlockInventoryComponent;
     map_color: BlockMapColorComponent;
     'minecraft:dynamic_properties': BlockDynamicPropertiesComponent;
     'minecraft:fluid_container': BlockFluidContainerComponent;
+    'minecraft:instrument_sound': BlockInstrumentComponent;
     'minecraft:inventory': BlockInventoryComponent;
     'minecraft:map_color': BlockMapColorComponent;
     'minecraft:movable': BlockMovableComponent;
@@ -3318,6 +3347,7 @@ export type ItemComponentReturnType<T extends string> = T extends keyof ItemComp
     : ItemCustomComponentInstance;
 
 export type ItemComponentTypeMap = {
+    block_actor_dynamic_properties: ItemBlockDynamicPropertiesComponent;
     book: ItemBookComponent;
     compostable: ItemCompostableComponent;
     cooldown: ItemCooldownComponent;
@@ -3326,6 +3356,7 @@ export type ItemComponentTypeMap = {
     enchantable: ItemEnchantableComponent;
     food: ItemFoodComponent;
     inventory: ItemInventoryComponent;
+    'minecraft:block_actor_dynamic_properties': ItemBlockDynamicPropertiesComponent;
     'minecraft:book': ItemBookComponent;
     'minecraft:compostable': ItemCompostableComponent;
     'minecraft:cooldown': ItemCooldownComponent;
@@ -5426,6 +5457,58 @@ export class BlockFluidContainerComponent extends BlockComponent {
     setPotion(itemStack: ItemStack): void;
 }
 
+/**
+ * @beta
+ * Represents the instruments a block can have assigned to it's
+ * up and down faces.
+ */
+// @ts-ignore Class inheritance allowed for native defined classes
+export class BlockInstrumentComponent extends BlockComponent {
+    private constructor();
+    static readonly componentId = 'minecraft:instrument_sound';
+    /**
+     * @remarks
+     * A getter method to get the name of an instrument for a given
+     * valid face Direction.
+     *
+     * @param face
+     * the face Direction to get the instrument name for.
+     * @returns
+     * Returns the name of the instrument for a given valid face
+     * Direction.
+     * @throws This function can throw errors.
+     *
+     * {@link minecraftcommon.InvalidArgumentError}
+     *
+     * {@link LocationInUnloadedChunkError}
+     *
+     * {@link LocationOutOfWorldBoundariesError}
+     */
+    getInstrumentName(face: Direction): string;
+    /**
+     * @remarks
+     * plays the instrument sound for a given valid face Direction
+     * at the components block location using optional
+     * WorldSoundOptions.
+     *
+     * This function can't be called in restricted-execution mode.
+     *
+     * @param face
+     * the face Direction for which instrument sound to play.
+     * @param soundOptions
+     * optional WorldSoundOptions to use when playing the
+     * insturment sound; if omitted the default values are used.
+     * @throws This function can throw errors.
+     *
+     * {@link minecraftcommon.InvalidArgumentError}
+     *
+     * {@link LocationInUnloadedChunkError}
+     *
+     * {@link LocationOutOfWorldBoundariesError}
+     */
+    playInstrumentSound(face: Direction, soundOptions?: WorldSoundOptions): void;
+}
+
 /**
  * Represents the inventory of a block in the world. Used with
  * blocks like chests.
@@ -6601,6 +6684,18 @@ export class Camera {
      *
      */
     readonly isValid: boolean;
+    /**
+     * @beta
+     * @remarks
+     * This function can't be called in restricted-execution mode.
+     *
+     * @throws This function can throw errors.
+     *
+     * {@link minecraftcommon.ArgumentOutOfBoundsError}
+     *
+     * {@link InvalidEntityError}
+     */
+    addShake(shakeCameraOptions: CameraShakeOptions): void;
     /**
      * @remarks
      * Attaches the camera to a non-player entity.
@@ -6706,6 +6801,34 @@ export class Camera {
      * @throws This function can throw errors.
      */
     setFov(fovCameraOptions?: CameraFovOptions): void;
+    /**
+     * @beta
+     * @remarks
+     * This function can't be called in restricted-execution mode.
+     *
+     * @throws This function can throw errors.
+     *
+     * {@link InvalidEntityError}
+     */
+    stopShaking(): void;
+}
+
+/**
+ * @beta
+ * Loot item function that will try to copy the block entity
+ * data from the destroyed block to the dropped item.
+ */
+// @ts-ignore Class inheritance allowed for native defined classes
+export class CarryOverBlockEntityDataFunction extends LootItemFunction {
+    private constructor();
+    /**
+     * @remarks
+     * If true, and if the block entity had dynamic_properties, the
+     * function will copy the dynamic properties from the block
+     * entity to the dropped item.
+     *
+     */
+    readonly dynamicProperties: boolean;
 }
 
 /**
@@ -8472,13 +8595,14 @@ export class Dimension {
     getBlockFromRay(location: Vector3, direction: Vector3, options?: BlockRaycastOptions): BlockRaycastHit | undefined;
     /**
      * @remarks
-     * Gets all the blocks in a volume that satisfy the filter.
+     * Gets all the blocks in a volume that satisfy the block query
+     * options.
      *
      * @param volume
      * Volume of blocks that will be checked.
-     * @param filter
-     * Block filter that will be checked against each block in the
-     * volume.
+     * @param options
+     * Block query options including filter criteria and optional
+     * closest/farthest distance sorting from a location.
      * @param allowUnloadedChunks
      * If set to true will suppress the UnloadedChunksError if some
      * or all of the block volume is outside of the loaded chunks.
@@ -8487,14 +8611,18 @@ export class Dimension {
      * Defaults to: false
      * @returns
      * Returns the ListBlockVolume that contains all the block
-     * locations that satisfied the block filter.
+     * locations that satisfied the block query options.
      * @throws This function can throw errors.
      *
+     * {@link minecraftcommon.ArgumentOutOfBoundsError}
+     *
      * {@link Error}
      *
+     * {@link minecraftcommon.InvalidArgumentError}
+     *
      * {@link UnloadedChunksError}
      */
-    getBlocks(volume: BlockVolumeBase, filter: BlockFilter, allowUnloadedChunks?: boolean): ListBlockVolume;
+    getBlocks(volume: BlockVolumeBase, options: BlockQueryOptions, allowUnloadedChunks?: boolean): ListBlockVolume;
     /**
      * @remarks
      * Returns a set of entities based on a set of conditions
@@ -9635,7 +9763,7 @@ export class Entity {
      */
     readonly location: Vector3;
     /**
-     * @beta
+     * @rc
      * @remarks
      * Boolean which determines if the player nameplate should be
      * depth tested for visibility.
@@ -9645,7 +9773,7 @@ export class Entity {
      */
     nameplateDepthTested: boolean;
     /**
-     * @beta
+     * @rc
      * @remarks
      * Float that determines the render distance of this entity's
      * nameplate.
@@ -13814,6 +13942,54 @@ export class EntityStartSneakingAfterEventSignal {
     unsubscribe(callback: (arg0: EntityStartSneakingAfterEvent) => void): void;
 }
 
+/**
+ * @beta
+ * Contains data related to an entity stopping sneaking.
+ */
+export class EntityStopSneakingAfterEvent {
+    private constructor();
+    /**
+     * @remarks
+     * Entity that has stopped sneaking.
+     *
+     */
+    readonly entity: Entity;
+}
+
+/**
+ * @beta
+ * Manages callbacks that are connected to when an entity stops
+ * sneaking.
+ */
+export class EntityStopSneakingAfterEventSignal {
+    private constructor();
+    /**
+     * @remarks
+     * Adds a callback that will be called when an entity stops
+     * sneaking.
+     *
+     * This function can't be called in restricted-execution mode.
+     *
+     * This function can be called in early-execution mode.
+     *
+     */
+    subscribe(
+        callback: (arg0: EntityStopSneakingAfterEvent) => void,
+        options?: EntitySneakingChangedEventOptions,
+    ): (arg0: EntityStopSneakingAfterEvent) => void;
+    /**
+     * @remarks
+     * Removes a callback from being called when an entity stops
+     * sneaking.
+     *
+     * This function can't be called in restricted-execution mode.
+     *
+     * This function can be called in early-execution mode.
+     *
+     */
+    unsubscribe(callback: (arg0: EntityStopSneakingAfterEvent) => void): void;
+}
+
 /**
  * Defines the entity's ability to carry items. An entity with
  * a higher strength would have higher potential carry capacity
@@ -13901,6 +14077,44 @@ export class EntityTameableComponent extends EntityComponent {
     tame(player: Player): boolean;
 }
 
+/**
+ * @beta
+ * Contains data related to an entity being tamed.
+ */
+export class EntityTamedAfterEvent {
+    private constructor();
+    readonly entity: Entity;
+    readonly tamingEntity: Entity;
+}
+
+/**
+ * @beta
+ * Manages callbacks that are connected to when an entity is
+ * tamed.
+ */
+export class EntityTamedAfterEventSignal {
+    private constructor();
+    /**
+     * @remarks
+     * This function can't be called in restricted-execution mode.
+     *
+     * This function can be called in early-execution mode.
+     *
+     */
+    subscribe(
+        callback: (arg0: EntityTamedAfterEvent) => void,
+        options?: EntityTamedEventFilter,
+    ): (arg0: EntityTamedAfterEvent) => void;
+    /**
+     * @remarks
+     * This function can't be called in restricted-execution mode.
+     *
+     * This function can be called in early-execution mode.
+     *
+     */
+    unsubscribe(callback: (arg0: EntityTamedAfterEvent) => void): void;
+}
+
 /**
  * Contains options for taming a rideable entity based on the
  * entity that mounts it.
@@ -14764,6 +14978,42 @@ export class ISerializable {
     private constructor();
 }
 
+/**
+ * @beta
+ * Represents the dynamic properties of a block. Only available
+ * from block entities. Up to 1KBytes of data can be stored per
+ * block entity in their dynamic properties storage.
+ */
+// @ts-ignore Class inheritance allowed for native defined classes
+export class ItemBlockDynamicPropertiesComponent extends ItemComponent {
+    private constructor();
+    static readonly componentId = 'minecraft:block_actor_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 InvalidItemStackError}
+     */
+    get(key: string): boolean | number | string | Vector3 | undefined;
+    /**
+     * @remarks
+     * Returns the current size, in bytes, of the dynamic
+     * properties storage for this block.
+     *
+     * @throws This function can throw errors.
+     *
+     * {@link InvalidItemStackError}
+     */
+    totalByteCount(): number;
+}
+
 /**
  * When present on an item, this item is a book item. Can
  * access and modify the contents of the book and sign it.
@@ -21832,13 +22082,201 @@ export class SmeltItemFunction extends LootItemFunction {
 
 /**
  * @beta
- * Represents a handle to a sound that has been played.
+ * Contains information about a sound thats declared duration
+ * elapsed.
+ */
+export class SoundCompletedAfterEvent {
+    private constructor();
+    /**
+     * @remarks
+     * Identifier of the sound instance that completed. Matches the
+     * `id` property of the `SoundInstance` returned when the sound
+     * was played.
+     *
+     */
+    readonly soundInstanceId: string;
+}
+
+/**
+ * @beta
+ * Manages callbacks that are invoked when a tracked sound's
+ * declared duration elapses.
+ */
+export class SoundCompletedAfterEventSignal {
+    private constructor();
+    /**
+     * @remarks
+     * Adds a callback that will be invoked when a tracked sound's
+     * declared duration elapses.
+     *
+     * This function can't be called in restricted-execution mode.
+     *
+     * This function can be called in early-execution mode.
+     *
+     */
+    subscribe(callback: (arg0: SoundCompletedAfterEvent) => void): (arg0: SoundCompletedAfterEvent) => void;
+    /**
+     * @remarks
+     * Removes a callback from being invoked when a tracked sound's
+     * declared duration elapses.
+     *
+     * This function can't be called in restricted-execution mode.
+     *
+     * This function can be called in early-execution mode.
+     *
+     */
+    unsubscribe(callback: (arg0: SoundCompletedAfterEvent) => void): void;
+}
+
+/**
+ * @beta
+ * Provides duration and playback information for a sound whose
+ * definition declares a duration.
+ */
+export class SoundDurationInfo {
+    private constructor();
+    /**
+     * @remarks
+     * Gets the total duration of the sound in seconds.
+     *
+     */
+    readonly duration: number;
+    /**
+     * @remarks
+     * Gets whether the sound is still being tracked.
+     *
+     */
+    readonly isActive: boolean;
+    /**
+     * @remarks
+     * Returns the elapsed playback time of the sound, in seconds,
+     * since it started playing.
+     *
+     * This function can't be called in restricted-execution mode.
+     *
+     * @returns
+     * Elapsed playback time in seconds.
+     */
+    getPlaybackPosition(): number;
+}
+
+/**
+ * Represents a handle to a sound that has been played. The
+ * handle is required to control the sound while it is playing
+ * (for example, to call `stop`, `setVolume`, `setPitch`,
+ * `fade`, or `seekTo`). Infinitely-looping sounds (started
+ * with `loop: -1`) stop automatically when the last
+ * `SoundInstance` reference is dropped; retain the handle for
+ * as long as the sound should keep playing.
  */
 export class SoundInstance {
     private constructor();
     /**
+     * @beta
      * @remarks
-     * Stops this sound from playing.
+     * Gets duration and playback information for this sound.
+     *
+     */
+    readonly durationInfo?: SoundDurationInfo;
+    /**
+     * @beta
+     * @remarks
+     * Unique identifier of this sound instance.
+     *
+     */
+    readonly id: string;
+    /**
+     * @beta
+     * @remarks
+     * Gets the player this sound was played for.
+     *
+     */
+    readonly recipient?: Player;
+    /**
+     * @beta
+     * @remarks
+     * Gets the identifier of the sound event this instance was
+     * started with.
+     *
+     */
+    readonly soundEventId: string;
+    /**
+     * @beta
+     * @remarks
+     * Fades this sound instance from its current volume to the
+     * target volume over the specified duration. To fade in from
+     * silence, call `setVolume(0.0)` first; to fade out, pass a
+     * target volume of `0.0`.
+     *
+     * This function can't be called in restricted-execution mode.
+     *
+     * @param duration
+     * Duration of the fade in seconds. Must be non-negative.
+     * Minimum value: 0
+     * @param targetVolume
+     * Volume to fade to. Must be non-negative.
+     * Minimum value: 0
+     */
+    fade(duration: number, targetVolume: number): void;
+    /**
+     * @beta
+     * @remarks
+     * Pauses this sound.
+     *
+     * This function can't be called in restricted-execution mode.
+     *
+     */
+    pause(): void;
+    /**
+     * @beta
+     * @remarks
+     * Resumes this sound after a pause.
+     *
+     * This function can't be called in restricted-execution mode.
+     *
+     */
+    resume(): void;
+    /**
+     * @beta
+     * @remarks
+     * Sets the playback position of this sound instance.
+     *
+     * This function can't be called in restricted-execution mode.
+     *
+     * @param seconds
+     * Position to seek to in seconds. Must be non-negative.
+     * Minimum value: 0
+     */
+    seekTo(seconds: number): void;
+    /**
+     * @beta
+     * @remarks
+     * Sets the pitch of this sound instance.
+     *
+     * This function can't be called in restricted-execution mode.
+     *
+     * @param pitch
+     * Pitch multiplier between 0.01 and 10.0. A value of 1.0 is
+     * normal pitch.
+     * Bounds: [0.009999999776482582, 10]
+     */
+    setPitch(pitch: number): void;
+    /**
+     * @beta
+     * @remarks
+     * Sets the volume of this sound instance.
+     *
+     * This function can't be called in restricted-execution mode.
+     *
+     * @param volume
+     * Volume level between 0.0 and 10.0.
+     * Bounds: [0, 10]
+     */
+    setVolume(volume: number): void;
+    /**
+     * @rc
+     * @remarks
+     * Stops this sound instance from playing.
      *
      * This function can't be called in restricted-execution mode.
      *
@@ -23979,6 +24417,24 @@ export class WorldAfterEvents {
      *
      */
     readonly entityStartSneaking: EntityStartSneakingAfterEventSignal;
+    /**
+     * @beta
+     * @remarks
+     * This event fires when an entity stops sneaking.
+     *
+     * This property can be read in early-execution mode.
+     *
+     */
+    readonly entityStopSneaking: EntityStopSneakingAfterEventSignal;
+    /**
+     * @beta
+     * @remarks
+     * This event fires when an entity is tamed.
+     *
+     * This property can be read in early-execution mode.
+     *
+     */
+    readonly entityTamed: EntityTamedAfterEventSignal;
     /**
      * @rc
      * @remarks
@@ -24292,6 +24748,15 @@ export class WorldAfterEvents {
      *
      */
     readonly projectileHitEntity: ProjectileHitEntityAfterEventSignal;
+    /**
+     * @beta
+     * @remarks
+     * A tracked sound's declared duration elapsed.
+     *
+     * This property can be read in early-execution mode.
+     *
+     */
+    readonly soundCompleted: SoundCompletedAfterEventSignal;
     /**
      * @remarks
      * A target block was hit.
@@ -24833,6 +25298,40 @@ export interface BlockHitInformation {
     faceLocation: Vector3;
 }
 
+/**
+ * @beta
+ * Options for querying blocks in a volume. Extends BlockFilter
+ * with additional sorting and limiting options based on
+ * distance from a location.
+ */
+// @ts-ignore Class inheritance allowed for native defined classes
+export interface BlockQueryOptions extends BlockFilter {
+    /**
+     * @remarks
+     * If specified, returns the closest N blocks to the location.
+     * Must be greater than 0. Cannot be used with farthest.
+     * Requires location to be set.
+     *
+     */
+    closest?: number;
+    /**
+     * @remarks
+     * If specified, returns the farthest N blocks from the
+     * location. Must be greater than 0. Cannot be used with
+     * closest. Requires location to be set.
+     *
+     */
+    farthest?: number;
+    /**
+     * @remarks
+     * Location used as the reference point for closest or farthest
+     * distance calculations. Required when closest or farthest is
+     * specified.
+     *
+     */
+    location?: Vector3;
+}
+
 /**
  * Contains information for block raycast hit results.
  */
@@ -25003,6 +25502,44 @@ export interface CameraSetRotOptions {
     rotation: Vector2;
 }
 
+/**
+ * @beta
+ * Options for applying a camera shake effect to a player's
+ * camera via `Camera.addShake`. Each call to `addShake` queues
+ * a new independent shake event for the specified `type`;
+ * positional and rotational shakes are tracked in separate
+ * queues and run concurrently. The rendered intensity at any
+ * moment is the sum of all active events' intensities for that
+ * type, capped at `4.0`. Events expire naturally when their
+ * `duration` elapses.
+ */
+export interface CameraShakeOptions {
+    /**
+     * @remarks
+     * How long this shake event lasts, in seconds. Must be a
+     * positive value.
+     *
+     */
+    duration: number;
+    /**
+     * @remarks
+     * The intensity of this shake event. Must be a positive value
+     * with a maximum of `4.0`. Multiple active events of the same
+     * `type` are summed, capped at `4.0`.
+     *
+     */
+    intensity: number;
+    /**
+     * @remarks
+     * The type of camera shake to apply. Positional and rotational
+     * shakes maintain separate event queues and are applied
+     * concurrently, so adding a shake of each type does not cause
+     * them to interfere with one another.
+     *
+     */
+    type: CameraShakeType;
+}
+
 /**
  * Used to target an entity with a free camera.
  */
@@ -26074,6 +26611,15 @@ export interface EntitySneakingChangedEventOptions {
     entityFilter?: EntityFilter;
 }
 
+/**
+ * @beta
+ * Contains options for filtering entity tamed events.
+ */
+export interface EntityTamedEventFilter {
+    entityFilter?: EntityFilter;
+    tamingEntityFilter?: EntityFilter;
+}
+
 /**
  * @rc
  * Controls when a waypoint is visible based on the state of
@@ -26618,6 +27164,19 @@ export interface PlayerSoundOptions {
      *
      */
     location?: Vector3;
+    /**
+     * @beta
+     * @remarks
+     * Number of additional times to repeat the sound after the
+     * initial play. `0` (the default) plays the sound once, `-1`
+     * loops it forever, and a positive integer `N` plays the sound
+     * `N + 1` times in total. For example, `loopCount: 1` plays
+     * the sound twice. The loop count is fixed when the sound
+     * starts and cannot be changed afterward. When using `-1`, see
+     * `SoundInstance` for handle lifetime requirements.
+     *
+     */
+    loopCount?: number;
     /**
      * @remarks
      * Optional pitch of the sound.
@@ -27444,6 +28003,19 @@ export interface WaypointTextureSelector {
  * Contains additional options for a playSound occurrence.
  */
 export interface WorldSoundOptions {
+    /**
+     * @beta
+     * @remarks
+     * Number of additional times to repeat the sound after the
+     * initial play. `0` (the default) plays the sound once, `-1`
+     * loops it forever, and a positive integer `N` plays the sound
+     * `N + 1` times in total. For example, `loopCount: 1` plays
+     * the sound twice. The loop count is fixed when the sound
+     * starts and cannot be changed afterward. When using `-1`, see
+     * `SoundInstance` for handle lifetime requirements.
+     *
+     */
+    loopCount?: number;
     /**
      * @remarks
      * Pitch of the sound played.

package/package.json

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