@minecraft/server 1.9.0-beta.1.20.60-preview.20 → 1.9.0-beta.1.20.60-preview.22

package/index.d.ts

@@ -15,7 +15,7 @@
  * ```json
  * {
  *   "module_name": "@minecraft/server",
- *   "version": "1.6.0"
+ *   "version": "1.7.0"
  * }
  * ```
  *
@@ -35,6 +35,16 @@ export enum BlockComponentTypes {
     WaterContainer = 'minecraft:waterContainer',
 }
 
+/**
+ * @beta
+ */
+export enum BlockPistonState {
+    Expanded = 'Expanded',
+    Expanding = 'Expanding',
+    Retracted = 'Retracted',
+    Retracting = 'Retracting',
+}
+
 /**
  * @beta
  * Description of the resulting intersection test on two
@@ -119,11 +129,37 @@ export enum CompoundBlockVolumePositionRelativity {
 
 /**
  * @beta
+ * An enumeration for the various difficulty levels of
+ * Minecraft.
  */
 export enum Difficulty {
+    /**
+     * @beta
+     * @remarks
+     * Peaceful difficulty level.
+     *
+     */
     Peaceful = 0,
+    /**
+     * @beta
+     * @remarks
+     * Easy difficulty level.
+     *
+     */
     Easy = 1,
+    /**
+     * @beta
+     * @remarks
+     * Normal difficulty level.
+     *
+     */
     Normal = 2,
+    /**
+     * @beta
+     * @remarks
+     * Hard difficulty level.
+     *
+     */
     Hard = 3,
 }
 
@@ -640,11 +676,16 @@ export enum EntityInitializationCause {
     Born = 'Born',
     /**
      * @remarks
-     * Case when an entity is created by an event, e.g., Wandering
-     * trader spawning llamas.
+     * Case when an entity is created by an event, e.g., a
+     * Wandering trader spawning llamas.
      *
      */
     Event = 'Event',
+    /**
+     * @remarks
+     * Case when an entity is loaded into the world.
+     *
+     */
     Loaded = 'Loaded',
     /**
      * @remarks
@@ -823,7 +864,7 @@ export enum GameMode {
 export enum ItemComponentTypes {
     Cooldown = 'minecraft:cooldown',
     Durability = 'minecraft:durability',
-    Enchants = 'minecraft:enchantments',
+    Enchantable = 'minecraft:enchantable',
     Food = 'minecraft:food',
 }
 
@@ -1021,11 +1062,47 @@ export enum SignSide {
  * day.
  */
 export enum TimeOfDay {
+    /**
+     * @remarks
+     * Sets the time to the start of the day, which is time of the
+     * day 1,000 (or the equivalent of 7am) in Minecraft.
+     *
+     */
     Day = 1000,
+    /**
+     * @remarks
+     * Sets the time to noon, which is time of the day 6,000 in
+     * Minecraft.
+     *
+     */
     Noon = 6000,
+    /**
+     * @remarks
+     * Sets the time to sunset, which is time of the day 12,000 (or
+     * the equivalent of 6pm) in Minecraft.
+     *
+     */
     Sunset = 12000,
+    /**
+     * @remarks
+     * Sets the time to night, which is time of the day 13,000 (or
+     * the equivalent of 7:00pm) in Minecraft.
+     *
+     */
     Night = 13000,
+    /**
+     * @remarks
+     * Sets the time to midnight, which is time of the day 18,000
+     * (or the equivalent of 12:00am) in Minecraft.
+     *
+     */
     Midnight = 18000,
+    /**
+     * @remarks
+     * Sets the time to sunrise, which is time of the day 23,000
+     * (or the equivalent of 5am) in Minecraft.
+     *
+     */
     Sunrise = 23000,
 }
 
@@ -1237,11 +1314,11 @@ export type EntityComponentTypeMap = {
 export type ItemComponentTypeMap = {
     cooldown: ItemCooldownComponent;
     durability: ItemDurabilityComponent;
-    enchantments: ItemEnchantsComponent;
+    enchantable: ItemEnchantableComponent;
     food: ItemFoodComponent;
     'minecraft:cooldown': ItemCooldownComponent;
     'minecraft:durability': ItemDurabilityComponent;
-    'minecraft:enchantments': ItemEnchantsComponent;
+    'minecraft:enchantable': ItemEnchantableComponent;
     'minecraft:food': ItemFoodComponent;
 };
 
@@ -1370,7 +1447,6 @@ export class Block {
      */
     readonly z: number;
     /**
-     * @beta
      * @remarks
      * Returns the {@link Block} above this block (positive in the
      * Y direction).
@@ -1385,7 +1461,6 @@ export class Block {
      */
     above(steps?: number): Block | undefined;
     /**
-     * @beta
      * @remarks
      * Returns the {@link Block} below this block (negative in the
      * Y direction).
@@ -1400,7 +1475,6 @@ export class Block {
      */
     below(steps?: number): Block | undefined;
     /**
-     * @beta
      * @remarks
      * Returns the {@link @minecraft/server.Location} of the center
      * of this block on the X and Z axis.
@@ -1432,7 +1506,6 @@ export class Block {
      */
     canPlace(blockToPlace: BlockPermutation | BlockType | string, faceToPlaceOn?: Direction): boolean;
     /**
-     * @beta
      * @remarks
      * Returns the {@link @minecraft/server.Location} of the center
      * of this block on the X, Y, and Z axis.
@@ -1440,7 +1513,6 @@ export class Block {
      */
     center(): Vector3;
     /**
-     * @beta
      * @remarks
      * Returns the {@link Block} to the east of this block
      * (positive in the X direction).
@@ -1566,7 +1638,6 @@ export class Block {
      */
     isValid(): boolean;
     /**
-     * @beta
      * @remarks
      * Returns the {@link Block} to the north of this block
      * (negative in the Z direction).
@@ -1581,7 +1652,16 @@ export class Block {
      */
     north(steps?: number): Block | undefined;
     /**
-     * @beta
+     * @remarks
+     * Returns a block at an offset relative vector to this block.
+     *
+     * @param offset
+     * The offset vector. For example, an offset of 0, 1, 0 will
+     * return the block above the current block.
+     * @returns
+     * Block at the specified offset, or undefined if that block
+     * could not be retrieved (for example, the block and its
+     * relative chunk is not loaded yet.)
      * @throws This function can throw errors.
      *
      * {@link LocationInUnloadedChunkError}
@@ -1626,7 +1706,6 @@ export class Block {
      */
     setType(blockType: BlockType | string): void;
     /**
-     * @beta
      * @remarks
      * Returns the {@link Block} to the south of this block
      * (positive in the Z direction).
@@ -1662,7 +1741,6 @@ export class Block {
      */
     trySetPermutation(permutation: BlockPermutation): boolean;
     /**
-     * @beta
      * @remarks
      * Returns the {@link Block} to the west of this block
      * (negative in the X direction).
@@ -2066,20 +2144,6 @@ export class BlockPermutation {
 // @ts-ignore Class inheritance allowed for native defined classes
 export class BlockPistonComponent extends BlockComponent {
     private constructor();
-    /**
-     * @remarks
-     * Whether the piston is fully expanded.
-     *
-     * @throws This property can throw when used.
-     */
-    readonly isExpanded: boolean;
-    /**
-     * @remarks
-     * Whether the piston is in the process of expanding.
-     *
-     * @throws This property can throw when used.
-     */
-    readonly isExpanding: boolean;
     /**
      * @remarks
      * Whether the piston is in the process of expanding or
@@ -2089,19 +2153,9 @@ export class BlockPistonComponent extends BlockComponent {
      */
     readonly isMoving: boolean;
     /**
-     * @remarks
-     * Whether the piston is fully retracted.
-     *
-     * @throws This property can throw when used.
-     */
-    readonly isRetracted: boolean;
-    /**
-     * @remarks
-     * Whether the piston is in the process of retracting.
-     *
      * @throws This property can throw when used.
      */
-    readonly isRetracting: boolean;
+    readonly state: BlockPistonState;
     static readonly componentId = 'minecraft:piston';
     /**
      * @remarks
@@ -2110,7 +2164,11 @@ export class BlockPistonComponent extends BlockComponent {
      *
      * @throws This function can throw errors.
      */
-    getAttachedBlocks(): Vector3[];
+    getAttachedBlocks(): Block[];
+    /**
+     * @throws This function can throw errors.
+     */
+    getAttachedBlocksLocations(): Vector3[];
 }
 
 /**
@@ -2290,7 +2348,7 @@ export class BlockSignComponent extends BlockComponent {
      *
      * @throws This function can throw errors.
      */
-    setWaxed(): void;
+    setWaxed(waxed: boolean): void;
 }
 
 /**
@@ -2359,12 +2417,14 @@ export class BlockStateType {
 export class BlockType {
     private constructor();
     /**
+     * @beta
      * @remarks
      * Represents whether this type of block can be waterlogged.
      *
      */
     readonly canBeWaterlogged: boolean;
     /**
+     * @beta
      * @remarks
      * Block type name - for example, `minecraft:acacia_stairs`.
      *
@@ -2790,33 +2850,24 @@ export class ChatSendAfterEvent {
     private constructor();
     /**
      * @remarks
-     * Message that is being broadcast. In a beforeChat event
-     * handler, _message_ can be updated with edits before the
-     * message is displayed to players.
+     * Message that is being broadcast.
      *
      */
-    message: string;
+    readonly message: string;
     /**
      * @remarks
      * Player that sent the chat message.
      *
      */
-    sender: Player;
+    readonly sender: Player;
     /**
      * @remarks
-     * If true, this message is directly targeted to one or more
+     * Optional list of players that will receive this message. If
+     * defined, this message is directly targeted to one or more
      * players (i.e., is not broadcast.)
      *
      */
-    sendToTargets: boolean;
-    /**
-     * @remarks
-     * List of players that will receive this message.
-     *
-     * @returns
-     * List of player objects.
-     */
-    getTargets(): Player[];
+    readonly targets?: Player[];
 }
 
 /**
@@ -2863,8 +2914,7 @@ export class ChatSendAfterEventSignal {
  * @beta
  * An event that fires as players enter chat messages.
  */
-// @ts-ignore Class inheritance allowed for native defined classes
-export class ChatSendBeforeEvent extends ChatSendAfterEvent {
+export class ChatSendBeforeEvent {
     private constructor();
     /**
      * @remarks
@@ -2875,13 +2925,24 @@ export class ChatSendBeforeEvent extends ChatSendAfterEvent {
     cancel: boolean;
     /**
      * @remarks
-     * Sets an updated list of players that will receive this
-     * message.
+     * Message that is being broadcast.
+     *
+     */
+    readonly message: string;
+    /**
+     * @remarks
+     * Player that sent the chat message.
+     *
+     */
+    readonly sender: Player;
+    /**
+     * @remarks
+     * Optional list of players that will receive this message. If
+     * defined, this message is directly targeted to one or more
+     * players (i.e., is not broadcast.)
      *
-     * @param players
-     * Updated array of players that should receive this message.
      */
-    setTargets(players: Player[]): void;
+    readonly targets?: Player[];
 }
 
 /**
@@ -3757,7 +3818,6 @@ export class DataDrivenEntityTriggerBeforeEventSignal {
 export class Dimension {
     private constructor();
     /**
-     * @beta
      * @remarks
      * Height range of the dimension.
      *
@@ -3991,8 +4051,13 @@ export class Dimension {
     /**
      * @beta
      * @remarks
+     * Returns the current weather.
+     *
      * This function can't be called in read-only mode.
      *
+     * @returns
+     * Returns a WeatherType that explains the broad category of
+     * weather that is currently going on.
      */
     getWeather(): WeatherType;
     /**
@@ -4291,18 +4356,14 @@ export class EffectAddAfterEvent {
      * @remarks
      * Additional properties and details of the effect.
      *
-     * This property can't be edited in read-only mode.
-     *
      */
-    effect: Effect;
+    readonly effect: Effect;
     /**
      * @remarks
      * Entity that the effect is being added to.
      *
-     * This property can't be edited in read-only mode.
-     *
      */
-    entity: Entity;
+    readonly entity: Entity;
 }
 
 /**
@@ -4349,6 +4410,11 @@ export class EffectAddBeforeEvent {
      *
      */
     cancel: boolean;
+    /**
+     * @remarks
+     * Effect duration.
+     *
+     */
     duration: number;
     /**
      * @remarks
@@ -4438,150 +4504,6 @@ export class EffectTypes {
     static getAll(): EffectType[];
 }
 
-/**
- * @beta
- * This class represents a specific leveled enchantment that is
- * applied to an item.
- */
-export class Enchantment {
-    /**
-     * @remarks
-     * The level of this enchantment instance.
-     *
-     * This property can't be edited in read-only mode.
-     *
-     */
-    level: number;
-    /**
-     * @remarks
-     * The enchantment type of this instance.
-     *
-     */
-    readonly 'type': EnchantmentType;
-    /**
-     * @remarks
-     * Creates a new particular type of enchantment configuration.
-     *
-     * @param enchantmentType
-     * Type of the enchantment.
-     * @param level
-     * Level of the enchantment.
-     * @throws This function can throw errors.
-     */
-    constructor(enchantmentType: EnchantmentType | string, level?: number);
-}
-
-/**
- * @beta
- * This class represents a collection of enchantments that can
- * be applied to an item.
- */
-export class EnchantmentList implements Iterable<Enchantment> {
-    /**
-     * @remarks
-     * The item slot/type that this collection is applied to.
-     *
-     */
-    readonly slot: number;
-    /**
-     * @remarks
-     * Creates a new EnchantmentList.
-     *
-     */
-    constructor(enchantmentSlot: number);
-    /**
-     * @remarks
-     * This function can't be called in read-only mode.
-     *
-     */
-    [Symbol.iterator](): Iterator<Enchantment>;
-    /**
-     * @remarks
-     * Attempts to add the enchantment to this collection. Returns
-     * true if successful.
-     *
-     * This function can't be called in read-only mode.
-     *
-     */
-    addEnchantment(enchantment: Enchantment): boolean;
-    /**
-     * @remarks
-     * Returns whether or not the provided EnchantmentInstance can
-     * be added to this collection.
-     *
-     * This function can't be called in read-only mode.
-     *
-     */
-    canAddEnchantment(enchantment: Enchantment): boolean;
-    /**
-     * @remarks
-     * Returns an enchantment associated with a type.
-     *
-     * This function can't be called in read-only mode.
-     *
-     * @throws This function can throw errors.
-     */
-    getEnchantment(enchantmentType: EnchantmentType | string): Enchantment | undefined;
-    /**
-     * @remarks
-     * If this collection has an EnchantmentInstance with type,
-     * returns the level of the enchantment. Returns 0 if not
-     * present.
-     *
-     * @throws This function can throw errors.
-     */
-    hasEnchantment(enchantmentType: EnchantmentType | string): number;
-    /**
-     * @remarks
-     * This function can't be called in read-only mode.
-     *
-     */
-    next(): IteratorResult<Enchantment>;
-    /**
-     * @remarks
-     * Removes an EnchantmentInstance with type from this
-     * collection if present.
-     *
-     * This function can't be called in read-only mode.
-     *
-     * @throws This function can throw errors.
-     */
-    removeEnchantment(enchantmentType: EnchantmentType | string): void;
-}
-
-/**
- * @beta
- * This enum represents the item slot or type that an
- * enchantment can be applied to.
- */
-export class EnchantmentSlot {
-    private constructor();
-    static readonly all = -1;
-    static readonly armorFeet = 4;
-    static readonly armorHead = 1;
-    static readonly armorLegs = 8;
-    static readonly armorTorso = 2;
-    static readonly axe = 512;
-    static readonly bow = 32;
-    static readonly carrotStick = 8192;
-    static readonly cosmeticHead = 262144;
-    static readonly crossbow = 65536;
-    static readonly elytra = 16384;
-    static readonly fishingRod = 4096;
-    static readonly flintsteel = 256;
-    static readonly gArmor = 15;
-    static readonly gDigging = 3648;
-    static readonly gTool = 131520;
-    static readonly hoe = 64;
-    static readonly none = 0;
-    static readonly pickaxe = 1024;
-    static readonly shears = 128;
-    static readonly shield = 131072;
-    static readonly shovel = 2048;
-    static readonly spear = 32768;
-    static readonly sword = 16;
-}
-
 /**
  * @beta
  * Contains information on a type of enchantment.
@@ -4951,7 +4873,10 @@ export class Entity {
      */
     applyKnockback(directionX: number, directionZ: number, horizontalStrength: number, verticalStrength: number): void;
     /**
-     * @beta
+     * @remarks
+     * Clears all dynamic properties that have been set on this
+     * entity.
+     *
      * @throws This function can throw errors.
      */
     clearDynamicProperties(): void;
@@ -5057,7 +4982,6 @@ export class Entity {
      */
     getComponents(): EntityComponent[];
     /**
-     * @beta
      * @remarks
      * Returns a property value.
      *
@@ -5070,12 +4994,24 @@ export class Entity {
      */
     getDynamicProperty(identifier: string): boolean | number | string | Vector3 | undefined;
     /**
-     * @beta
+     * @remarks
+     * Returns the available set of dynamic property identifiers
+     * that have been used on this entity.
+     *
+     * @returns
+     * A string array of the dynamic properties set on this entity.
      * @throws This function can throw errors.
      */
     getDynamicPropertyIds(): string[];
     /**
-     * @beta
+     * @remarks
+     * Returns the total size, in bytes, of all the dynamic
+     * properties that are currently stored for this entity.  This
+     * can be useful for diagnosing performance warning signs - if,
+     * for example, an entity has many megabytes of associated
+     * dynamic properties, it may be slow to load on various
+     * devices.
+     *
      * @throws This function can throw errors.
      */
     getDynamicPropertyTotalByteCount(): number;
@@ -5256,7 +5192,6 @@ export class Entity {
      */
     kill(): boolean;
     /**
-     * @beta
      * @remarks
      * Matches the entity against the passed in options. Uses the
      * location of the entity for matching if the location is not
@@ -5284,7 +5219,6 @@ export class Entity {
      */
     playAnimation(animationName: string, options?: PlayAnimationOptions): void;
     /**
-     * @beta
      * @remarks
      * Immediately removes the entity from the world. The removed
      * entity will not perform a death animation or drop loot upon
@@ -5381,7 +5315,6 @@ export class Entity {
      */
     runCommandAsync(commandString: string): Promise<CommandResult>;
     /**
-     * @beta
      * @remarks
      * Sets a specified property to a value.
      *
@@ -5969,8 +5902,6 @@ export class EntityEquippableComponent extends EntityComponent {
      * @remarks
      * Gets the equipped item for the given EquipmentSlot.
      *
-     * This function can't be called in read-only mode.
-     *
      * @param equipmentSlot
      * The equipment slot. e.g. "head", "chest", "offhand"
      * @returns
@@ -5985,8 +5916,6 @@ export class EntityEquippableComponent extends EntityComponent {
      * Gets the ContainerSlot corresponding to the given
      * EquipmentSlot.
      *
-     * This function can't be called in read-only mode.
-     *
      * @param equipmentSlot
      * The equipment slot. e.g. "head", "chest", "offhand".
      * @returns
@@ -7603,7 +7532,7 @@ export class EntityTypes {
      * Retrieves an iterator of all entity types within this world.
      *
      */
-    static getAll(): EntityTypeIterator;
+    static getAll(): EntityType[];
 }
 
 /**
@@ -7646,7 +7575,6 @@ export class EntityWantsJockeyComponent extends EntityComponent {
 }
 
 /**
- * @beta
  * Contains information regarding an explosion that has
  * happened.
  */
@@ -7673,7 +7601,6 @@ export class ExplosionAfterEvent {
 }
 
 /**
- * @beta
  * Manages callbacks that are connected to when an explosion
  * occurs.
  */
@@ -7701,7 +7628,6 @@ export class ExplosionAfterEventSignal {
 }
 
 /**
- * @beta
  * Contains information regarding an explosion that has
  * happened.
  */
@@ -7726,7 +7652,6 @@ export class ExplosionBeforeEvent extends ExplosionAfterEvent {
 }
 
 /**
- * @beta
  * Manages callbacks that are connected to before an explosion
  * occurs.
  */
@@ -8213,53 +8138,97 @@ export class ItemDurabilityComponent extends ItemComponent {
      *
      * This function can't be called in read-only mode.
      *
-     * @param unbreaking
-     * Unbreaking factor to consider in factoring the damage
-     * chance. Incoming unbreaking parameter must be greater than
-     * 0.
      * @throws This function can throw errors.
      */
-    getDamageChance(unbreaking?: number): number;
+    getDamageChance(unbreakingEnchantmentLevel?: number): number;
     /**
      * @remarks
-     * A range of numbers that describes the chance of the item
-     * losing durability.
-     *
      * This function can't be called in read-only mode.
      *
      * @throws This function can throw errors.
      */
-    getDamageRange(): minecraftcommon.NumberRange;
+    getDamageChanceRange(): minecraftcommon.NumberRange;
 }
 
 /**
  * @beta
- * When present on an item, this item has applied enchantment
- * effects. Note that this component only applies to
- * data-driven items.
  */
 // @ts-ignore Class inheritance allowed for native defined classes
-export class ItemEnchantsComponent extends ItemComponent {
+export class ItemEnchantableComponent extends ItemComponent {
     private constructor();
+    static readonly componentId = 'minecraft:enchantable';
     /**
      * @remarks
-     * Returns a collection of the enchantments applied to this
-     * item stack.
+     * This function can't be called in read-only mode.
      *
-     * This property can't be edited in read-only mode.
+     * @throws This function can throw errors.
+     *
+     * {@link EnchantmentLevelOutOfBoundsError}
+     *
+     * {@link EnchantmentTypeNotCompatibleError}
      *
+     * {@link EnchantmentTypeUnknownIdError}
+     *
+     * {@link Error}
      */
-    enchantments: EnchantmentList;
-    static readonly componentId = 'minecraft:enchantments';
+    addEnchantment(enchantment: Enchantment): void;
     /**
      * @remarks
-     * Removes all enchantments applied to this item stack.
+     * This function can't be called in read-only mode.
+     *
+     * @throws This function can throw errors.
+     *
+     * {@link EnchantmentLevelOutOfBoundsError}
+     *
+     * {@link EnchantmentTypeNotCompatibleError}
+     *
+     * {@link EnchantmentTypeUnknownIdError}
+     *
+     * {@link Error}
+     */
+    addEnchantments(enchantments: Enchantment[]): void;
+    /**
+     * @throws This function can throw errors.
+     *
+     * {@link EnchantmentLevelOutOfBoundsError}
+     *
+     * {@link EnchantmentTypeUnknownIdError}
+     */
+    canAddEnchantment(enchantment: Enchantment): boolean;
+    /**
+     * @throws This function can throw errors.
+     *
+     * {@link EnchantmentTypeUnknownIdError}
+     */
+    getEnchantment(enchantmentType: EnchantmentType | string): Enchantment | undefined;
+    /**
+     * @throws This function can throw errors.
+     */
+    getEnchantments(): Enchantment[];
+    /**
+     * @throws This function can throw errors.
      *
+     * {@link EnchantmentTypeUnknownIdError}
+     */
+    hasEnchantment(enchantmentType: EnchantmentType | string): boolean;
+    /**
+     * @remarks
      * This function can't be called in read-only mode.
      *
      * @throws This function can throw errors.
      */
     removeAllEnchantments(): void;
+    /**
+     * @remarks
+     * This function can't be called in read-only mode.
+     *
+     * @throws This function can throw errors.
+     *
+     * {@link EnchantmentTypeUnknownIdError}
+     *
+     * {@link Error}
+     */
+    removeEnchantment(enchantmentType: EnchantmentType | string): void;
 }
 
 /**
@@ -9293,29 +9262,6 @@ export class MolangVariableMap {
     setVector3(variableName: string, vector: Vector3): void;
 }
 
-/**
- * @beta
- * Contains data resulting from a navigation operation,
- * including whether the navigation is possible and the path of
- * navigation.
- */
-export class NavigationResult {
-    private constructor();
-    /**
-     * @remarks
-     * Whether the navigation result contains a full path,
-     * including to the requested destination.
-     *
-     */
-    readonly isFullPath: boolean;
-    /**
-     * @remarks
-     * A set of block locations that comprise the navigation route.
-     *
-     */
-    getPath(): Vector3[];
-}
-
 /**
  * @beta
  * Contains information related to changes to a piston
@@ -9414,107 +9360,6 @@ export class PistonActivateAfterEventSignal {
     unsubscribe(callback: (arg: PistonActivateAfterEvent) => void): void;
 }
 
-/**
- * @beta
- * Contains information related to changes before a piston
- * expands or retracts.
- */
-// @ts-ignore Class inheritance allowed for native defined classes
-export class PistonActivateBeforeEvent extends BlockEvent {
-    private constructor();
-    /**
-     * @remarks
-     * If this is set to true within an event handler, the piston
-     * activation is canceled.
-     *
-     */
-    cancel: boolean;
-    /**
-     * @remarks
-     * True if the piston is the process of expanding.
-     *
-     */
-    readonly isExpanding: boolean;
-    /**
-     * @remarks
-     * Contains additional properties and details of the piston.
-     *
-     */
-    readonly piston: BlockPistonComponent;
-}
-
-/**
- * @beta
- * Manages callbacks that are connected to an event that fires
- * before a piston is activated.
- */
-export class PistonActivateBeforeEventSignal {
-    private constructor();
-    /**
-     * @remarks
-     * Adds a callback that will be called before a piston expands
-     * or retracts.
-     *
-     * This function can't be called in read-only mode.
-     *
-     * @example pistonBeforeEvent.ts
-     * ```typescript
-     *   // set up a couple of piston blocks
-     *   let piston = overworld.getBlock(targetLocation);
-     *   let button = overworld.getBlock({ x: targetLocation.x, y: targetLocation.y + 1, z: targetLocation.z });
-     *
-     *   if (piston === undefined || button === undefined) {
-     *     log("Could not find block at location.");
-     *     return -1;
-     *   }
-     *
-     *   piston.setPermutation(mc.BlockPermutation.resolve('piston').withState('facing_direction', 3));
-     *   button.setPermutation(mc.BlockPermutation.resolve('acacia_button').withState('facing_direction', 1));
-     *
-     *   const uncanceledPistonLoc = {
-     *     x: Math.floor(targetLocation.x) + 2,
-     *     y: Math.floor(targetLocation.y),
-     *     z: Math.floor(targetLocation.z) + 2,
-     *   };
-     *
-     *   // this is our control.
-     *   let uncanceledPiston = overworld.getBlock(uncanceledPistonLoc);
-     *   let uncanceledButton = overworld.getBlock({
-     *     x: uncanceledPistonLoc.x,
-     *     y: uncanceledPistonLoc.y + 1,
-     *     z: uncanceledPistonLoc.z,
-     *   });
-     *
-     *   if (uncanceledPiston === undefined || uncanceledButton === undefined) {
-     *     log("Could not find block at location.");
-     *     return -1;
-     *   }
-     *
-     *   uncanceledPiston.setPermutation(mc.BlockPermutation.resolve('piston').withState('facing_direction', 3));
-     *   uncanceledButton.setPermutation(mc.BlockPermutation.resolve('acacia_button').withState('facing_direction', 1));
-     *
-     *   mc.world.beforeEvents.pistonActivate.subscribe((pistonEvent: mc.PistonActivateBeforeEvent) => {
-     *     let eventLoc = pistonEvent.piston.block.location;
-     *     if (eventLoc.x === targetLocation.x && eventLoc.y === targetLocation.y && eventLoc.z === targetLocation.z) {
-     *       log("Cancelling piston event");
-     *       pistonEvent.cancel = true;
-     *     }
-     *   });
-     * ```
-     */
-    subscribe(callback: (arg: PistonActivateBeforeEvent) => void): (arg: PistonActivateBeforeEvent) => void;
-    /**
-     * @remarks
-     * Removes a callback from being called before a piston expands
-     * or retracts.
-     *
-     * This function can't be called in read-only mode.
-     *
-     * @throws This function can throw errors.
-     */
-    unsubscribe(callback: (arg: PistonActivateBeforeEvent) => void): void;
-}
-
 /**
  * Represents a player within the world.
  */
@@ -9634,6 +9479,14 @@ export class Player extends Entity {
      * @throws This function can throw errors.
      */
     addLevels(amount: number): number;
+    /**
+     * @beta
+     * @remarks
+     * This function can't be called in read-only mode.
+     *
+     * @throws This function can throw errors.
+     */
+    eatItem(itemStack: ItemStack): void;
     /**
      * @beta
      * @remarks
@@ -9835,8 +9688,18 @@ export class Player extends Entity {
     /**
      * @beta
      * @remarks
+     * Creates a new particle emitter at a specified location in
+     * the world. Only visible to the target player.
+     *
      * This function can't be called in read-only mode.
      *
+     * @param effectName
+     * Identifier of the particle to create.
+     * @param location
+     * The location at which to create the particle emitter.
+     * @param molangVariables
+     * A set of optional, customizable variables that can be
+     * adjusted for this particle.
      * @throws This function can throw errors.
      *
      * {@link Error}
@@ -9844,6 +9707,26 @@ export class Player extends Entity {
      * {@link LocationInUnloadedChunkError}
      *
      * {@link LocationOutOfWorldBoundariesError}
+     * @example spawnParticle.ts
+     * ```typescript
+     * for (let i = 0; i < 100; i++) {
+     *   const molang = new mc.MolangVariableMap();
+     *
+     *   molang.setColorRGB("variable.color", {
+     *     red: Math.random(),
+     *     green: Math.random(),
+     *     blue: Math.random(),
+     *     alpha: 1,
+     *   });
+     *
+     *   let newLocation = {
+     *     x: targetLocation.x + Math.floor(Math.random() * 8) - 4,
+     *     y: targetLocation.y + Math.floor(Math.random() * 8) - 4,
+     *     z: targetLocation.z + Math.floor(Math.random() * 8) - 4,
+     *   };
+     *   player.spawnParticle("minecraft:colored_flame_particle", newLocation, molang);
+     * }
+     * ```
      */
     spawnParticle(effectName: string, location: Vector3, molangVariables?: MolangVariableMap): void;
     /**
@@ -10066,7 +9949,6 @@ export class PlayerDimensionChangeAfterEventSignal {
 }
 
 /**
- * @beta
  * Contains information regarding an event after a player
  * interacts with a block.
  */
@@ -10107,7 +9989,6 @@ export class PlayerInteractWithBlockAfterEvent {
 }
 
 /**
- * @beta
  * Manages callbacks that are connected to after a player
  * interacts with a block.
  */
@@ -10137,7 +10018,6 @@ export class PlayerInteractWithBlockAfterEventSignal {
 }
 
 /**
- * @beta
  * Contains information regarding an event before a player
  * interacts with a block.
  */
@@ -10184,7 +10064,6 @@ export class PlayerInteractWithBlockBeforeEvent {
 }
 
 /**
- * @beta
  * Manages callbacks that are connected to before a player
  * interacts with a block.
  */
@@ -10214,7 +10093,6 @@ export class PlayerInteractWithBlockBeforeEventSignal {
 }
 
 /**
- * @beta
  * Contains information regarding an event after a player
  * interacts with an entity.
  */
@@ -10242,7 +10120,6 @@ export class PlayerInteractWithEntityAfterEvent {
 }
 
 /**
- * @beta
  * Manages callbacks that are connected to after a player
  * interacts with an entity.
  */
@@ -10272,7 +10149,6 @@ export class PlayerInteractWithEntityAfterEventSignal {
 }
 
 /**
- * @beta
  * Contains information regarding an event before a player
  * interacts with an entity.
  */
@@ -10306,7 +10182,6 @@ export class PlayerInteractWithEntityBeforeEvent {
 }
 
 /**
- * @beta
  * Manages callbacks that are connected to before a player
  * interacts with an entity.
  */
@@ -10422,17 +10297,11 @@ export class PlayerLeaveAfterEventSignal extends IPlayerLeaveAfterEventSignal {
     private constructor();
 }
 
-/**
- * @beta
- */
 export class PlayerLeaveBeforeEvent {
     private constructor();
     readonly player: Player;
 }
 
-/**
- * @beta
- */
 export class PlayerLeaveBeforeEventSignal {
     private constructor();
     /**
@@ -10863,7 +10732,7 @@ export class Scoreboard {
      *
      * @throws This function can throw errors.
      */
-    addObjective(objectiveId: string, displayName: string): ScoreboardObjective;
+    addObjective(objectiveId: string, displayName?: string): ScoreboardObjective;
     /**
      * @remarks
      * Clears the objective that occupies a display slot.
@@ -11907,7 +11776,10 @@ export class World {
      */
     broadcastClientMessage(id: string, value: string): void;
     /**
-     * @beta
+     * @remarks
+     * Clears the set of dynamic properties declared for this
+     * behavior pack within the world.
+     *
      */
     clearDynamicProperties(): void;
     /**
@@ -11956,7 +11828,6 @@ export class World {
      */
     getDimension(dimensionId: string): Dimension;
     /**
-     * @beta
      * @remarks
      * Returns a property value.
      *
@@ -12023,15 +11894,23 @@ export class World {
      */
     getDynamicProperty(identifier: string): boolean | number | string | Vector3 | undefined;
     /**
-     * @beta
+     * @remarks
+     * Gets a set of dynamic property identifiers that have been
+     * set in this world.
+     *
+     * @returns
+     * A string array of active dynamic property identifiers.
      */
     getDynamicPropertyIds(): string[];
     /**
-     * @beta
+     * @remarks
+     * Gets the total byte count of dynamic properties. This could
+     * potentially be used for your own analytics to ensure you're
+     * not storing gigantic sets of dynamic properties.
+     *
      */
     getDynamicPropertyTotalByteCount(): number;
     /**
-     * @beta
      * @remarks
      * Returns an entity based on the provided id.
      *
@@ -12224,7 +12103,6 @@ export class World {
      */
     setDefaultSpawnLocation(spawnLocation: Vector3): void;
     /**
-     * @beta
      * @remarks
      * Sets a specified property to a value.
      *
@@ -12349,7 +12227,7 @@ export class WorldAfterEvents {
      * entity.
      *
      */
-    readonly dataDrivenEntityTriggerEvent: DataDrivenEntityTriggerAfterEventSignal;
+    readonly dataDrivenEntityTrigger: DataDrivenEntityTriggerAfterEventSignal;
     /**
      * @beta
      * @remarks
@@ -12518,10 +12396,16 @@ export class WorldAfterEvents {
     readonly playerDimensionChange: PlayerDimensionChangeAfterEventSignal;
     /**
      * @beta
+     * @remarks
+     * An event for when a player interacts with a block.
+     *
      */
     readonly playerInteractWithBlock: PlayerInteractWithBlockAfterEventSignal;
     /**
      * @beta
+     * @remarks
+     * This event fires when a player interacts with an entity.
+     *
      */
     readonly playerInteractWithEntity: PlayerInteractWithEntityAfterEventSignal;
     /**
@@ -12681,13 +12565,6 @@ export class WorldBeforeEvents {
      *
      */
     readonly itemUseOn: ItemUseOnBeforeEventSignal;
-    /**
-     * @beta
-     * @remarks
-     * This event fires when a piston expands or retracts.
-     *
-     */
-    readonly pistonActivate: PistonActivateBeforeEventSignal;
     /**
      * @remarks
      * This event fires before a block is broken by a player.
@@ -12696,14 +12573,22 @@ export class WorldBeforeEvents {
     readonly playerBreakBlock: PlayerBreakBlockBeforeEventSignal;
     /**
      * @beta
+     * @remarks
+     * Fires before a player interacts with a block.
+     *
      */
     readonly playerInteractWithBlock: PlayerInteractWithBlockBeforeEventSignal;
     /**
      * @beta
+     * @remarks
+     * Fires before a player interacts with an entity.
+     *
      */
     readonly playerInteractWithEntity: PlayerInteractWithEntityBeforeEventSignal;
     /**
-     * @beta
+     * @remarks
+     * Fires when a player leaves the game.
+     *
      */
     readonly playerLeave: PlayerLeaveBeforeEventSignal;
     /**
@@ -12951,6 +12836,11 @@ export interface BoundingBox {
 }
 
 export interface CameraDefaultOptions {
+    /**
+     * @remarks
+     * Sets a set of easing options for the camera.
+     *
+     */
     easeOptions: CameraEaseOptions;
 }
 
@@ -13132,6 +13022,26 @@ export interface DimensionLocation {
     z: number;
 }
 
+/**
+ * @beta
+ * This class represents a specific leveled enchantment that is
+ * applied to an item.
+ */
+export interface Enchantment {
+    /**
+     * @remarks
+     * The level of this enchantment instance.
+     *
+     */
+    level: number;
+    /**
+     * @remarks
+     * The enchantment type of this instance.
+     *
+     */
+    type: EnchantmentType | string;
+}
+
 /**
  * Additional options for when damage has been applied via a
  * projectile.
@@ -13593,6 +13503,7 @@ export interface PlayAnimationOptions {
      *
      */
     nextState?: string;
+    players?: string[];
     /**
      * @remarks
      * Specifies a Molang expression for when this animation should
@@ -13734,7 +13645,8 @@ export interface RGB {
 /**
  * Represents a fully customizable color within Minecraft.
  */
-export interface RGBA {
+// @ts-ignore Class inheritance allowed for native defined classes
+export interface RGBA extends RGB {
     /**
      * @remarks
      * Determines a color's alpha (opacity) component. Valid values
@@ -13742,27 +13654,6 @@ export interface RGBA {
      *
      */
     alpha: number;
-    /**
-     * @remarks
-     * Determines a color's blue component. Valid values are
-     * between 0 and 1.0.
-     *
-     */
-    blue: number;
-    /**
-     * @remarks
-     * Determines a color's green component. Valid values are
-     * between 0 and 1.0.
-     *
-     */
-    green: number;
-    /**
-     * @remarks
-     * Determines a color's red component. Valid values are between
-     * 0 and 1.0.
-     *
-     */
-    red: number;
 }
 
 /**
@@ -13941,6 +13832,30 @@ export class CommandError extends Error {
     private constructor();
 }
 
+/**
+ * @beta
+ */
+// @ts-ignore Class inheritance allowed for native defined classes
+export class EnchantmentLevelOutOfBoundsError extends Error {
+    private constructor();
+}
+
+/**
+ * @beta
+ */
+// @ts-ignore Class inheritance allowed for native defined classes
+export class EnchantmentTypeNotCompatibleError extends Error {
+    private constructor();
+}
+
+/**
+ * @beta
+ */
+// @ts-ignore Class inheritance allowed for native defined classes
+export class EnchantmentTypeUnknownIdError extends Error {
+    private constructor();
+}
+
 // @ts-ignore Class inheritance allowed for native defined classes
 export class LocationInUnloadedChunkError extends Error {
     private constructor();
@@ -13962,7 +13877,6 @@ export const MoonPhaseCount = 8;
  */
 export const TicksPerDay = 24000;
 /**
- * @beta
  * @remarks
  * How many times the server ticks per second of real time.
  *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@minecraft/server",
-  "version": "1.9.0-beta.1.20.60-preview.20",
+  "version": "1.9.0-beta.1.20.60-preview.22",
   "description": "",
   "contributors": [
     {
@@ -13,7 +13,7 @@
     }
   ],
   "dependencies": {
-    "@minecraft/common": "^1.1.0-rc.1.20.60-preview.20"
+    "@minecraft/common": "^1.1.0"
   },
   "license": "MIT"
 }