@minecraft/server 2.0.0-beta.1.21.70-preview.24 → 2.0.0-beta.1.21.70-preview.26

package/index.d.ts

@@ -2435,12 +2435,21 @@ export enum WeatherType {
 }
 
 /**
- * @beta
+ * @rc
+ */
+export type BlockComponentReturnType<T extends string> = T extends keyof BlockComponentTypeMap
+    ? BlockComponentTypeMap[T]
+    : BlockComponent;
+
+/**
+ * @rc
  */
 export type BlockComponentTypeMap = {
+    destruction_particles: BlockDestructionParticlesComponent;
     fluid_container: BlockFluidContainerComponent;
     inventory: BlockInventoryComponent;
     map_color: BlockMapColorComponent;
+    'minecraft:destruction_particles': BlockDestructionParticlesComponent;
     'minecraft:fluid_container': BlockFluidContainerComponent;
     'minecraft:inventory': BlockInventoryComponent;
     'minecraft:map_color': BlockMapColorComponent;
@@ -2453,7 +2462,7 @@ export type BlockComponentTypeMap = {
 };
 
 /**
- * @beta
+ * @rc
  * Type alias used by the {@link BlockPermutation} matches and
  * resolve functions to narrow block state argument types to
  * those mapped by {@link
@@ -2466,7 +2475,14 @@ export type BlockStateArg<T> = T extends `${minecraftvanilladata.MinecraftBlockT
     : Record<string, boolean | number | string>;
 
 /**
- * @beta
+ * @rc
+ */
+export type EntityComponentReturnType<T extends string> = T extends keyof EntityComponentTypeMap
+    ? EntityComponentTypeMap[T]
+    : EntityComponent;
+
+/**
+ * @rc
  */
 export type EntityComponentTypeMap = {
     addrider: EntityAddRiderComponent;
@@ -2604,7 +2620,14 @@ export type EntityComponentTypeMap = {
 };
 
 /**
- * @beta
+ * @rc
+ */
+export type ItemComponentReturnType<T extends string> = T extends keyof ItemComponentTypeMap
+    ? ItemComponentTypeMap[T]
+    : ItemComponent;
+
+/**
+ * @rc
  */
 export type ItemComponentTypeMap = {
     compostable: ItemCompostableComponent;
@@ -2718,8 +2741,6 @@ export class AimAssistCategorySettings {
      * Constructor that takes a unique Id to associate with the
      * created AimAssistCategory. Must have a namespace.
      *
-     * This function can't be called in read-only mode.
-     *
      */
     constructor(identifier: string);
     /**
@@ -2872,8 +2893,6 @@ export class AimAssistPresetSettings {
      * Constructor that takes a unique Id to associate with the
      * created AimAssistPreset. Must have a namespace.
      *
-     * This function can't be called in read-only mode.
-     *
      */
     constructor(identifier: string);
     /**
@@ -3340,8 +3359,6 @@ export class Block {
      * for a block - for example, an inventory component of a chest
      * block.
      *
-     * This function can't be called in read-only mode.
-     *
      * @param componentId
      * The identifier of the component (e.g.,
      * 'minecraft:inventory'). If no namespace prefix is specified,
@@ -3356,7 +3373,7 @@ export class Block {
      *
      * {@link LocationOutOfWorldBoundariesError}
      */
-    getComponent<T extends keyof BlockComponentTypeMap>(componentId: T): BlockComponentTypeMap[T] | undefined;
+    getComponent<T extends string>(componentId: T): BlockComponentReturnType<T> | undefined;
     /**
      * @remarks
      * Creates a prototype item stack based on this block that can
@@ -3867,6 +3884,35 @@ export class BlockComponentTickEvent extends BlockEvent {
     private constructor();
 }
 
+/**
+ * @beta
+ * Represents the particles that appear when the block is
+ * destroyed.
+ */
+// @ts-ignore Class inheritance allowed for native defined classes
+export class BlockDestructionParticlesComponent extends BlockComponent {
+    private constructor();
+    /**
+     * @remarks
+     * Name of the texture used for the particles.
+     *
+     * @throws This property can throw when used.
+     *
+     * {@link Error}
+     */
+    readonly texture: string;
+    /**
+     * @remarks
+     * Type of tint applied to the particles.
+     *
+     * @throws This property can throw when used.
+     *
+     * {@link Error}
+     */
+    readonly tintMethod: TintMethod;
+    static readonly componentId = 'minecraft:destruction_particles';
+}
+
 /**
  * Contains information regarding an event that impacts a
  * specific block.
@@ -4111,38 +4157,32 @@ export class BlockLocationIterator implements Iterable<Vector3> {
 // @ts-ignore Class inheritance allowed for native defined classes
 export class BlockMapColorComponent extends BlockComponent {
     private constructor();
-    static readonly componentId = 'minecraft:map_color';
     /**
      * @remarks
      * Base map color defined for that block.
      *
-     * This function can't be called in read-only mode.
-     *
-     * @throws This function can throw errors.
+     * @throws This property can throw when used.
      *
      * {@link Error}
      */
-    color(): RGBA;
+    readonly color: RGBA;
     /**
      * @remarks
      * Returns the base color multiplied to the evaluated tint at
      * the given position.
      *
-     * This function can't be called in read-only mode.
-     *
      */
-    tintedColor(): RGBA;
+    readonly tintedColor: RGBA;
     /**
      * @remarks
      * Type of tint applied to the color.
      *
-     * This function can't be called in read-only mode.
-     *
-     * @throws This function can throw errors.
+     * @throws This property can throw when used.
      *
      * {@link Error}
      */
-    tintMethod(): TintMethod;
+    readonly tintMethod: TintMethod;
+    static readonly componentId = 'minecraft:map_color';
 }
 
 /**
@@ -4239,8 +4279,6 @@ export class BlockPermutation {
      * @remarks
      * Gets a state for the permutation.
      *
-     * This function can't be called in read-only mode.
-     *
      * @param stateName
      * Name of the block state who's value is to be returned.
      * @returns
@@ -4316,8 +4354,6 @@ export class BlockPermutation {
      * this permutation. If states is not specified, matches checks
      * against the set of types more broadly.
      *
-     * This function can't be called in read-only mode.
-     *
      * @param blockName
      * An optional set of states to compare against.
      */
@@ -4330,8 +4366,6 @@ export class BlockPermutation {
      * Returns a derived BlockPermutation with a specific property
      * set.
      *
-     * This function can't be called in read-only mode.
-     *
      * @param name
      * Identifier of the block property.
      * @param value
@@ -4348,8 +4382,6 @@ export class BlockPermutation {
      * will return a BlockPermutation object that is usable in
      * other block APIs (e.g., block.setPermutation)
      *
-     * This function can't be called in read-only mode.
-     *
      * @param blockName
      * Identifier of the block to check.
      * @throws This function can throw errors.
@@ -4845,11 +4877,6 @@ export class BlockVolume extends BlockVolumeBase {
      *
      */
     to: Vector3;
-    /**
-     * @remarks
-     * This function can't be called in read-only mode.
-     *
-     */
     constructor(from: Vector3, to: Vector3);
     /**
      * @remarks
@@ -5507,8 +5534,6 @@ export class CompoundBlockVolume {
      * @remarks
      * Create a CompoundBlockVolume object
      *
-     * This function can't be called in read-only mode.
-     *
      * @param origin
      * An optional world space origin on which to center the
      * compound volume.
@@ -7429,9 +7454,6 @@ export class EnchantmentType {
      */
     readonly maxLevel: number;
     /**
-     * @remarks
-     * This function can't be called in read-only mode.
-     *
      * @throws This function can throw errors.
      */
     constructor(enchantmentType: string);
@@ -7892,8 +7914,6 @@ export class Entity {
      * Gets a component (that represents additional capabilities)
      * for an entity.
      *
-     * This function can't be called in read-only mode.
-     *
      * @param componentId
      * The identifier of the component (e.g., 'minecraft:health').
      * If no namespace prefix is specified, 'minecraft:' is
@@ -7906,7 +7926,7 @@ export class Entity {
      *
      * {@link InvalidEntityError}
      */
-    getComponent<T extends keyof EntityComponentTypeMap>(componentId: T): EntityComponentTypeMap[T] | undefined;
+    getComponent<T extends string>(componentId: T): EntityComponentReturnType<T> | undefined;
     /**
      * @remarks
      * Returns all components that are both present on this entity
@@ -10684,10 +10704,9 @@ export class EntityScaleComponent extends EntityComponent {
      * @remarks
      * Current value for the scale property set on entities.
      *
-     * This property can't be edited in read-only mode.
-     *
+     * @throws This property can throw when used.
      */
-    value: number;
+    readonly value: number;
     static readonly componentId = 'minecraft:scale';
 }
 
@@ -12533,8 +12552,6 @@ export class ItemStack {
      * Creates a new instance of a stack of items for use in the
      * world.
      *
-     * This function can't be called in read-only mode.
-     *
      * @param itemType
      * Type of item to create. See the {@link
      * @minecraft/vanilla-data.MinecraftItemTypes} enumeration for
@@ -12588,8 +12605,6 @@ export class ItemStack {
      * Gets a component (that represents additional capabilities)
      * for an item stack.
      *
-     * This function can't be called in read-only mode.
-     *
      * @param componentId
      * The identifier of the component (e.g., 'minecraft:food'). If
      * no namespace prefix is specified, 'minecraft:' is assumed.
@@ -12623,7 +12638,7 @@ export class ItemStack {
      * }
      * ```
      */
-    getComponent<T extends keyof ItemComponentTypeMap>(componentId: T): ItemComponentTypeMap[T] | undefined;
+    getComponent<T extends string>(componentId: T): ItemComponentReturnType<T> | undefined;
     /**
      * @remarks
      * Returns all components that are both present on this item
@@ -13244,129 +13259,6 @@ export class ItemUseBeforeEventSignal {
     unsubscribe(callback: (arg0: ItemUseBeforeEvent) => void): void;
 }
 
-/**
- * Contains information related to an item being used on a
- * block. This event fires when an item used by a player
- * successfully triggers a block interaction.
- */
-export class ItemUseOnAfterEvent {
-    private constructor();
-    /**
-     * @remarks
-     * The block that the item is used on.
-     *
-     */
-    readonly block: Block;
-    /**
-     * @remarks
-     * The face of the block that an item is being used on.
-     *
-     */
-    readonly blockFace: Direction;
-    /**
-     * @remarks
-     * Location relative to the bottom north-west corner of the
-     * block where the item is placed.
-     *
-     */
-    readonly faceLocation: Vector3;
-    /**
-     * @remarks
-     * This value will be true if the event was triggered on
-     * players initial interaction button press and false on events
-     * triggered from holding the interaction button.
-     *
-     */
-    readonly isFirstEvent: boolean;
-    /**
-     * @remarks
-     * The impacted item stack that is being used on a block.
-     *
-     */
-    readonly itemStack: ItemStack;
-    /**
-     * @remarks
-     * Returns the source entity that triggered this item event.
-     *
-     */
-    readonly source: Player;
-}
-
-/**
- * Manages callbacks that are connected to an item being used
- * on a block event.
- */
-export class ItemUseOnAfterEventSignal {
-    private constructor();
-    /**
-     * @remarks
-     * Adds a callback that will be called when an item is used on
-     * a block.
-     *
-     * This function can't be called in read-only mode.
-     *
-     * This function can be called in early-execution mode.
-     *
-     */
-    subscribe(callback: (arg0: ItemUseOnAfterEvent) => void): (arg0: ItemUseOnAfterEvent) => void;
-    /**
-     * @remarks
-     * Removes a callback from being called when an item is used on
-     * a block.
-     *
-     * This function can't be called in read-only mode.
-     *
-     * This function can be called in early-execution mode.
-     *
-     */
-    unsubscribe(callback: (arg0: ItemUseOnAfterEvent) => void): void;
-}
-
-/**
- * Contains information related to an item being used on a
- * block.
- */
-// @ts-ignore Class inheritance allowed for native defined classes
-export class ItemUseOnBeforeEvent extends ItemUseOnAfterEvent {
-    private constructor();
-    /**
-     * @remarks
-     * If set to true, this will cancel the item use behavior.
-     *
-     */
-    cancel: boolean;
-}
-
-/**
- * Manages callbacks that fire before an item being used on a
- * block event.
- */
-export class ItemUseOnBeforeEventSignal {
-    private constructor();
-    /**
-     * @remarks
-     * Adds a callback that will be called before an item is used
-     * on a block.
-     *
-     * This function can't be called in read-only mode.
-     *
-     * This function can be called in early-execution mode.
-     *
-     */
-    subscribe(callback: (arg0: ItemUseOnBeforeEvent) => void): (arg0: ItemUseOnBeforeEvent) => void;
-    /**
-     * @remarks
-     * Removes a callback from being called before an item is used
-     * on a block.
-     *
-     * This function can't be called in read-only mode.
-     *
-     * This function can be called in early-execution mode.
-     *
-     */
-    unsubscribe(callback: (arg0: ItemUseOnBeforeEvent) => void): void;
-}
-
 /**
  * Contains information regarding the use of an item on a
  * block.
@@ -13530,8 +13422,6 @@ export class ListBlockVolume extends BlockVolumeBase {
      * @remarks
      * Creates a new instance of ListBlockVolume.
      *
-     * This function can't be called in read-only mode.
-     *
      * @param locations
      * Initial array of block locations that ListBlockVolume will
      * be constructed with.
@@ -17452,8 +17342,6 @@ export class Trigger {
      * @remarks
      * Creates a new trigger.
      *
-     * This function can't be called in read-only mode.
-     *
      */
     constructor(eventName: string);
 }
@@ -18462,15 +18350,6 @@ export class WorldAfterEvents {
      *
      */
     readonly itemUse: ItemUseAfterEventSignal;
-    /**
-     * @remarks
-     * This event fires when an item is used on a block by a
-     * player.
-     *
-     * This property can be read in early-execution mode.
-     *
-     */
-    readonly itemUseOn: ItemUseOnAfterEventSignal;
     /**
      * @remarks
      * A lever has been pulled.
@@ -18752,15 +18631,6 @@ export class WorldBeforeEvents {
      *
      */
     readonly itemUse: ItemUseBeforeEventSignal;
-    /**
-     * @remarks
-     * This event fires when an item is used on a block by a
-     * player.
-     *
-     * This property can be read in early-execution mode.
-     *
-     */
-    readonly itemUseOn: ItemUseOnBeforeEventSignal;
     /**
      * @remarks
      * This event fires before a block is broken by a player.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@minecraft/server",
-  "version": "2.0.0-beta.1.21.70-preview.24",
+  "version": "2.0.0-beta.1.21.70-preview.26",
   "description": "",
   "contributors": [
     {