@minecraft/server 1.6.0-beta.1.20.30-preview.20 → 1.6.0-beta.1.20.30-preview.22

package/index.d.ts

@@ -16,7 +16,7 @@
  * ```json
  * {
  *   "module_name": "@minecraft/server",
- *   "version": "1.6.0-internal.1.20.30-preview.20"
+ *   "version": "1.6.0-internal.1.20.30-preview.22"
  * }
  * ```
  *
@@ -296,7 +296,7 @@ export enum EquipmentSlot {
      * Chestplate or Elytra.
      *
      */
-    chest = 'chest',
+    Chest = 'Chest',
     /**
      * @beta
      * @remarks
@@ -304,7 +304,7 @@ export enum EquipmentSlot {
      * Boots.
      *
      */
-    feet = 'feet',
+    Feet = 'Feet',
     /**
      * @beta
      * @remarks
@@ -312,7 +312,7 @@ export enum EquipmentSlot {
      * Helmets or Carved Pumpkins.
      *
      */
-    head = 'head',
+    Head = 'Head',
     /**
      * @beta
      * @remarks
@@ -320,7 +320,7 @@ export enum EquipmentSlot {
      * Leggings.
      *
      */
-    legs = 'legs',
+    Legs = 'Legs',
     /**
      * @beta
      * @remarks
@@ -328,7 +328,7 @@ export enum EquipmentSlot {
      * the currently active hotbar slot.
      *
      */
-    mainhand = 'mainhand',
+    Mainhand = 'Mainhand',
     /**
      * @beta
      * @remarks
@@ -336,7 +336,7 @@ export enum EquipmentSlot {
      * shields and maps.
      *
      */
-    offhand = 'offhand',
+    Offhand = 'Offhand',
 }
 
 /**
@@ -3084,11 +3084,18 @@ export class DefinitionModifier {
 export class Dimension {
     private constructor();
     /**
+     * @beta
      * @remarks
-     * Identifier of the dimension.
+     * Height range of the dimension.
      *
      * @throws This property can throw when used.
      */
+    readonly heightRange: NumberRange;
+    /**
+     * @remarks
+     * Identifier of the dimension.
+     *
+     */
     readonly id: string;
     /**
      * @beta
@@ -3358,8 +3365,13 @@ export class Dimension {
      *
      * @param weatherType
      * Set the type of weather to apply.
+     * @param duration
+     * Sets the duration of the weather (in ticks). If no duration
+     * is provided, the duration will be set to a random duration
+     * between 300 and 900 seconds.
+     * @throws This function can throw errors.
      */
-    setWeather(weatherType: WeatherType): void;
+    setWeather(weatherType: WeatherType, duration?: number): void;
     /**
      * @beta
      * @remarks
@@ -3942,7 +3954,6 @@ export class Entity {
      * property is accessible even if {@link Entity.isValid} is
      * false.
      *
-     * @throws This property can throw when used.
      */
     readonly id: string;
     /**
@@ -3980,6 +3991,14 @@ export class Entity {
      * @throws This property can throw when used.
      */
     readonly isOnGround: boolean;
+    /**
+     * @beta
+     * @remarks
+     * If true, the entity is currently sleeping.
+     *
+     * @throws This property can throw when used.
+     */
+    readonly isSleeping: boolean;
     /**
      * @beta
      * @remarks
@@ -4040,6 +4059,7 @@ export class Entity {
      * @beta
      * @remarks
      * Returns a scoreboard identity that represents this entity.
+     * Will remain valid when the entity is killed.
      *
      * @throws This property can throw when used.
      */
@@ -4055,11 +4075,10 @@ export class Entity {
     readonly target: Entity;
     /**
      * @remarks
-     * Unique identifier of the type of the entity - for example,
+     * Identifier of the type of the entity - for example,
      * 'minecraft:skeleton'. This property is accessible even if
      * {@link Entity.isValid} is false.
      *
-     * @throws This property can throw when used.
      */
     readonly typeId: string;
     /**
@@ -4417,13 +4436,19 @@ export class Entity {
      * @throws This function can throw errors.
      */
     getHeadLocation(): Vector3;
+    /**
+     * @beta
+     * @throws This function can throw errors.
+     */
+    getProperty(identifier: string): boolean | number | string | undefined;
     /**
      * @beta
      * @remarks
      * Returns the current rotation component of this entity.
      *
      * @returns
-     * Returns the current rotation component of this entity.
+     * Returns a Vec2 containing the rotation of this entity (in
+     * degrees).
      * @throws This function can throw errors.
      */
     getRotation(): Vector2;
@@ -4602,6 +4627,14 @@ export class Entity {
      * @throws This function can throw errors.
      */
     removeTag(tag: string): boolean;
+    /**
+     * @beta
+     * @remarks
+     * This function can't be called in read-only mode.
+     *
+     * @throws This function can throw errors.
+     */
+    resetProperty(identifier: string): boolean | number | string;
     /**
      * @beta
      * @remarks
@@ -4694,6 +4727,14 @@ export class Entity {
      * ```
      */
     setOnFire(seconds: number, useEffects?: boolean): boolean;
+    /**
+     * @beta
+     * @remarks
+     * This function can't be called in read-only mode.
+     *
+     * @throws This function can throw errors.
+     */
+    setProperty(identifier: string, value: boolean | number | string): void;
     /**
      * @beta
      * @remarks
@@ -4702,9 +4743,9 @@ export class Entity {
      * This function can't be called in read-only mode.
      *
      * @param rotation
-     * The x and y rotation of the entity. For most mobs, the x
-     * rotation controls the head tilt and the y rotation controls
-     * the body rotation.
+     * The x and y rotation of the entity (in degrees). For most
+     * mobs, the x rotation controls the head tilt and the y
+     * rotation controls the body rotation.
      * @throws This function can throw errors.
      */
     setRotation(rotation: Vector2): void;
@@ -5201,52 +5242,30 @@ export class EntityDieAfterEventSignal {
 
 /**
  * @beta
- * Provides access to a mob's equipment slots. This component
- * exists for all mob entities.
  */
 // @ts-ignore Class inheritance allowed for native defined classes
-export class EntityEquipmentInventoryComponent extends EntityComponent {
+export class EntityEquippableComponent extends EntityComponent {
     private constructor();
-    static readonly componentId = 'minecraft:equipment_inventory';
+    static readonly componentId = 'minecraft:equippable';
     /**
      * @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
-     * Returns the item equipped to the given EquipmentSlot. If
-     * empty, returns undefined.
      * @throws This function can throw errors.
      */
     getEquipment(equipmentSlot: EquipmentSlot): ItemStack | undefined;
     /**
+     * @beta
      * @remarks
-     * 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
-     * Returns the ContainerSlot corresponding to the given
-     * EquipmentSlot.
      * @throws This function can throw errors.
      */
     getEquipmentSlot(equipmentSlot: EquipmentSlot): ContainerSlot;
     /**
      * @remarks
-     * Replaces the item in the given EquipmentSlot.
-     *
      * This function can't be called in read-only mode.
      *
-     * @param equipmentSlot
-     * The equipment slot. e.g. "head", "chest", "offhand".
-     * @param itemStack
-     * The item to equip. If undefined, clears the slot.
      * @throws This function can throw errors.
      */
     setEquipment(equipmentSlot: EquipmentSlot, itemStack?: ItemStack): boolean;
@@ -6341,14 +6360,21 @@ export class EntityPushThroughComponent extends EntityComponent {
  * from the world (for example, the entity is unloaded because
  * it is not close to players.)
  */
-export class EntityRemovedAfterEvent {
+export class EntityRemoveAfterEvent {
     private constructor();
     /**
      * @remarks
-     * Reference to an entity that was removed.
+     * Id of the entity that was removed.
+     *
+     */
+    readonly removedEntityId: string;
+    /**
+     * @remarks
+     * Identifier of the type of the entity removed - for example,
+     * 'minecraft:skeleton'.
      *
      */
-    readonly removedEntity: string;
+    readonly typeId: string;
 }
 
 /**
@@ -6357,7 +6383,7 @@ export class EntityRemovedAfterEvent {
  * is removed from  the game (for example, unloaded, or a few
  * seconds after they are dead.)
  */
-export class EntityRemovedAfterEventSignal {
+export class EntityRemoveAfterEventSignal {
     private constructor();
     /**
      * @remarks
@@ -6375,9 +6401,9 @@ export class EntityRemovedAfterEventSignal {
      * operations.
      */
     subscribe(
-        callback: (arg: EntityRemovedAfterEvent) => void,
+        callback: (arg: EntityRemoveAfterEvent) => void,
         options?: EntityEventOptions,
-    ): (arg: EntityRemovedAfterEvent) => void;
+    ): (arg: EntityRemoveAfterEvent) => void;
     /**
      * @remarks
      * Unsubscribes your function from subsequent calls when an
@@ -6387,7 +6413,57 @@ export class EntityRemovedAfterEventSignal {
      *
      * @throws This function can throw errors.
      */
-    unsubscribe(callback: (arg: EntityRemovedAfterEvent) => void): void;
+    unsubscribe(callback: (arg: EntityRemoveAfterEvent) => void): void;
+}
+
+/**
+ * @beta
+ * Data for an event that happens when an entity is being
+ * removed from the world (for example, the entity is unloaded
+ * because it is not close to players.)
+ */
+export class EntityRemoveBeforeEvent {
+    private constructor();
+    /**
+     * @remarks
+     * Reference to an entity that is being removed.
+     *
+     */
+    readonly removedEntity: Entity;
+}
+
+/**
+ * @beta
+ * Allows registration for an event that fires when an entity
+ * is being removed from  the game (for example, unloaded, or a
+ * few seconds after they are dead.)
+ */
+export class EntityRemoveBeforeEventSignal {
+    private constructor();
+    /**
+     * @remarks
+     * Will call your function every time an entity is being
+     * removed from the game.
+     *
+     * This function can't be called in read-only mode.
+     *
+     * @param callback
+     * Function to call.
+     * @returns
+     * Returns a closure that can be used in subsequent unsubscribe
+     * operations.
+     */
+    subscribe(callback: (arg: EntityRemoveBeforeEvent) => void): (arg: EntityRemoveBeforeEvent) => void;
+    /**
+     * @remarks
+     * Unsubscribes your function from subsequent calls when an
+     * entity is being removed.
+     *
+     * This function can't be called in read-only mode.
+     *
+     * @throws This function can throw errors.
+     */
+    unsubscribe(callback: (arg: EntityRemoveBeforeEvent) => void): void;
 }
 
 /**
@@ -7603,6 +7679,26 @@ export class ItemStack {
      * Returns a copy of this item stack.
      */
     clone(): ItemStack;
+    /**
+     * @beta
+     * @remarks
+     * Get the list of block types this item can break in Adventure
+     * mode.
+     *
+     * This function can't be called in read-only mode.
+     *
+     */
+    getCanDestroy(): string[];
+    /**
+     * @beta
+     * @remarks
+     * Get the list of block types this item can be placed on in
+     * Adventure mode.
+     *
+     * This function can't be called in read-only mode.
+     *
+     */
+    getCanPlaceOn(): string[];
     /**
      * @remarks
      * Gets a component (that represents additional capabilities)
@@ -7612,7 +7708,7 @@ export class ItemStack {
      * The identifier of the component (e.g., 'minecraft:food') to
      * retrieve. If no namespace prefix is specified, 'minecraft:'
      * is assumed. If the component is not present on the item
-     * stack, undefined is returned.
+     * stack or doesn't exist, undefined is returned.
      * @example durability.ts
      * ```typescript
      * // Get the maximum durability of a custom sword item
@@ -7636,7 +7732,7 @@ export class ItemStack {
      * ItemStack.
      *
      * @returns
-     * An array of lore strings. If the item does not have lore,
+     * An array of lore lines. If the item does not have lore,
      * returns an empty array.
      */
     getLore(): string[];
@@ -7679,6 +7775,11 @@ export class ItemStack {
      * item stacks. The amount of each item stack is not taken into
      * consideration.
      *
+     * @param itemStack
+     * ItemStack to check stacking compatability with.
+     * @returns
+     * True if the Item Stack is stackable with the itemStack
+     * passed in.
      */
     isStackableWith(itemStack: ItemStack): boolean;
     /**
@@ -7690,6 +7791,8 @@ export class ItemStack {
      *
      * This function can't be called in read-only mode.
      *
+     * @param blockIdentifiers
+     * String list of block types that the item can destroy.
      * @throws
      * Throws if any of the provided block identifiers are invalid.
      * @example example.ts
@@ -7710,6 +7813,8 @@ export class ItemStack {
      *
      * This function can't be called in read-only mode.
      *
+     * @param blockIdentifiers
+     * String list of block types that the item can be placed on.
      * @throws
      * Throws if any of the provided block identifiers are invalid.
      * @example example.ts
@@ -7724,10 +7829,15 @@ export class ItemStack {
      * @beta
      * @remarks
      * Sets the lore value - a secondary display string - for an
-     * ItemStack.
+     * ItemStack. The lore list is cleared if set to an empty
+     * string or undefined.
      *
      * This function can't be called in read-only mode.
      *
+     * @param loreList
+     * List of lore lines. Each element in the list represents a
+     * new line. The maximum lore line count is 20. The maximum
+     * lore line length is 50 characters.
      * @throws This function can throw errors.
      * @example diamondAwesomeSword.ts
      * ```typescript
@@ -8639,6 +8749,14 @@ export class Player extends Entity {
      * @throws This property can throw when used.
      */
     readonly camera: Camera;
+    /**
+     * @beta
+     * @remarks
+     * If true, the player is currently emoting.
+     *
+     * @throws This property can throw when used.
+     */
+    readonly isEmoting: boolean;
     /**
      * @beta
      * @remarks
@@ -9420,12 +9538,16 @@ export class Scoreboard {
      *
      * This function can't be called in read-only mode.
      *
+     * @returns
+     * Returns the previous `ScoreboardObjective` set at the
+     * display slot, if no objective was previously set it returns
+     * `undefined`.
      * @throws This function can throw errors.
      */
     setObjectiveAtDisplaySlot(
         displaySlotId: DisplaySlotId,
         objectiveDisplaySetting: ScoreboardObjectiveDisplayOptions,
-    ): ScoreboardObjective;
+    ): ScoreboardObjective | undefined;
 }
 
 /**
@@ -9459,7 +9581,7 @@ export class ScoreboardIdentity {
      *
      * @throws This function can throw errors.
      */
-    getEntity(): Entity;
+    getEntity(): Entity | undefined;
     isValid(): boolean;
 }
 
@@ -9684,7 +9806,7 @@ export class ScriptEventCommandMessageAfterEvent {
      * that initiated the NPC dialogue.
      *
      */
-    readonly initiator: Entity;
+    readonly initiator?: Entity;
     /**
      * @remarks
      * Optional additional data passed in with the script event
@@ -9698,14 +9820,14 @@ export class ScriptEventCommandMessageAfterEvent {
      * (e.g., a commandblock.)
      *
      */
-    readonly sourceBlock: Block;
+    readonly sourceBlock?: Block;
     /**
      * @remarks
      * Source entity if this command was triggered by an entity
      * (e.g., a NPC).
      *
      */
-    readonly sourceEntity: Entity;
+    readonly sourceEntity?: Entity;
     /**
      * @remarks
      * Returns the type of source that fired this command.
@@ -10926,13 +11048,8 @@ export class WorldAfterEvents {
     readonly entityHurt: EntityHurtAfterEventSignal;
     /**
      * @beta
-     * @remarks
-     * This event fires when an entity is removed from the game
-     * (e.g., is unloaded when it goes out of range; or a few
-     * seconds after the death of an entity.)
-     *
      */
-    readonly entityRemoved: EntityRemovedAfterEventSignal;
+    readonly entityRemove: EntityRemoveAfterEventSignal;
     /**
      * @beta
      * @remarks
@@ -11155,6 +11272,10 @@ export class WorldBeforeEvents {
      *
      */
     readonly dataDrivenEntityTriggerEvent: DataDrivenEntityTriggerBeforeEventSignal;
+    /**
+     * @beta
+     */
+    readonly entityRemove: EntityRemoveBeforeEventSignal;
     /**
      * @beta
      * @remarks

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@minecraft/server",
-  "version": "1.6.0-beta.1.20.30-preview.20",
+  "version": "1.6.0-beta.1.20.30-preview.22",
   "description": "",
   "contributors": [
     {