@minecraft/server 1.7.0-beta.1.20.40-preview.22 → 1.7.0-beta.1.20.40-preview.24

package/index.d.ts

@@ -16,11 +16,12 @@
  * ```json
  * {
  *   "module_name": "@minecraft/server",
- *   "version": "1.7.0-internal.1.20.40-preview.22"
+ *   "version": "1.7.0-internal.1.20.40-preview.24"
  * }
  * ```
  *
  */
+import * as minecraftcommon from '@minecraft/common';
 /**
  * @beta
  * Description of the resulting intersection test on two
@@ -121,42 +122,42 @@ export enum Direction {
     /**
      * @beta
      * @remarks
-     * Returns the block beneath (y - 1) of this item.
+     * Returns the {@link Block} beneath (y - 1) of this item.
      *
      */
     Down = 'Down',
     /**
      * @beta
      * @remarks
-     * Returns the block to the east (x + 1) of this item.
+     * Returns the {@link Block} to the east (x + 1) of this item.
      *
      */
     East = 'East',
     /**
      * @beta
      * @remarks
-     * Returns the block to the east (z + 1) of this item.
+     * Returns the {@link Block} to the east (z + 1) of this item.
      *
      */
     North = 'North',
     /**
      * @beta
      * @remarks
-     * Returns the block to the south (z - 1) of this item.
+     * Returns the {@link Block} to the south (z - 1) of this item.
      *
      */
     South = 'South',
     /**
      * @beta
      * @remarks
-     * Returns the block above (y + 1) of this item.
+     * Returns the {@link Block} above (y + 1) of this item.
      *
      */
     Up = 'Up',
     /**
      * @beta
      * @remarks
-     * Returns the block to the west (x - 1) of this item.
+     * Returns the {@link Block} to the west (x - 1) of this item.
      *
      */
     West = 'West',
@@ -349,42 +350,244 @@ export enum EasingType {
 
 /**
  * @beta
+ * Describes the source of damage from an Entity.
  */
 export enum EntityDamageCause {
+    /**
+     * @beta
+     * @remarks
+     * Damage caused by a falling anvil.
+     *
+     */
     anvil = 'anvil',
+    /**
+     * @beta
+     * @remarks
+     * Damage caused from a non-Entity explosion. For example, an
+     * exploding bed.
+     *
+     */
     blockExplosion = 'blockExplosion',
     campfire = 'campfire',
+    /**
+     * @beta
+     * @remarks
+     * Unused.
+     *
+     */
     charging = 'charging',
+    /**
+     * @beta
+     * @remarks
+     * Damage caused by physically touching an Entity or Block. For
+     * example, touching a Sweet Berry bush or Pufferfish.
+     *
+     */
     contact = 'contact',
+    /**
+     * @beta
+     * @remarks
+     * Damage caused by an Entity being out of air and inside a
+     * liquid block.
+     *
+     */
     drowning = 'drowning',
+    /**
+     * @beta
+     * @remarks
+     * Damage caused by an Entity attack.
+     *
+     */
     entityAttack = 'entityAttack',
+    /**
+     * @beta
+     * @remarks
+     * Damage caused by an Entity explosion. For example, a Creeper
+     * or Wither.
+     *
+     */
     entityExplosion = 'entityExplosion',
+    /**
+     * @beta
+     * @remarks
+     * Damage caused by falling onto the ground.
+     *
+     */
     fall = 'fall',
+    /**
+     * @beta
+     * @remarks
+     * Damage caused by falling blocks. Note: Anvils and
+     * Stalactites have their own damage causes.
+     *
+     */
     fallingBlock = 'fallingBlock',
+    /**
+     * @beta
+     * @remarks
+     * Damage caused by catching on fire.
+     *
+     */
     fire = 'fire',
+    /**
+     * @beta
+     * @remarks
+     * Damage caused by burning over time.
+     *
+     */
     fireTick = 'fireTick',
+    /**
+     * @beta
+     * @remarks
+     * Damage caused by fireworks.
+     *
+     */
     fireworks = 'fireworks',
+    /**
+     * @beta
+     * @remarks
+     * Damage caused by flying into a wall at high speed while
+     * gliding with Elytra.
+     *
+     */
     flyIntoWall = 'flyIntoWall',
+    /**
+     * @beta
+     * @remarks
+     * Damage caused by staying inside a Powder Snow block.
+     *
+     */
     freezing = 'freezing',
+    /**
+     * @beta
+     * @remarks
+     * Damage caused by touching a Lava block.
+     *
+     */
     lava = 'lava',
+    /**
+     * @beta
+     * @remarks
+     * Damage caused by being struck by lightning.
+     *
+     */
     lightning = 'lightning',
+    /**
+     * @beta
+     * @remarks
+     * Damage caused by magical attacks. For example, Evoker Fang
+     * or Conduit Block.
+     *
+     */
     magic = 'magic',
+    /**
+     * @beta
+     * @remarks
+     * Damage caused by touching a Magma block.
+     *
+     */
     magma = 'magma',
+    /**
+     * @beta
+     * @remarks
+     * Damage caused by no source. For example, from a command or
+     * script.
+     *
+     */
     none = 'none',
+    /**
+     * @beta
+     * @remarks
+     * Damage caused by an indirect source. For example, setting a
+     * mob's health to 0 in a behavior pack.
+     *
+     */
     override = 'override',
+    /**
+     * @beta
+     * @remarks
+     * Damage caused by a Piston.
+     *
+     */
     piston = 'piston',
+    /**
+     * @beta
+     * @remarks
+     * Damage caused by a projectile.
+     *
+     */
     projectile = 'projectile',
     ramAttack = 'ramAttack',
     sonicBoom = 'sonicBoom',
     soulCampfire = 'soulCampfire',
+    /**
+     * @beta
+     * @remarks
+     * Damage caused by a falling Stalactite block.
+     *
+     */
     stalactite = 'stalactite',
+    /**
+     * @beta
+     * @remarks
+     * Damage caused by touching a Stalagmite block.
+     *
+     */
     stalagmite = 'stalagmite',
+    /**
+     * @beta
+     * @remarks
+     * Damage caused over time by having an empty hunger bar.
+     *
+     */
     starve = 'starve',
+    /**
+     * @beta
+     * @remarks
+     * Damage caused by an Entity being out of air and inside a
+     * non-liquid block.
+     *
+     */
     suffocation = 'suffocation',
+    /**
+     * @beta
+     * @remarks
+     * Damage caused by an Entity killing itself. For example, from
+     * the /kill command.
+     *
+     */
     suicide = 'suicide',
+    /**
+     * @beta
+     * @remarks
+     * Damage caused by an Entity being in an inhabitable climate.
+     * For example, a Snow Golem in a biome with a temperature
+     * greater than 1.
+     *
+     */
     temperature = 'temperature',
+    /**
+     * @beta
+     * @remarks
+     * Damage caused by the Thorns armor enchantment and by the
+     * Guardian thorns effect.
+     *
+     */
     thorns = 'thorns',
+    /**
+     * @beta
+     * @remarks
+     * Damage caused over time by falling into the void.
+     *
+     */
     'void' = 'void',
+    /**
+     * @beta
+     * @remarks
+     * Damage caused by the Wither effect. For example, from
+     * touching a Wither Rose.
+     *
+     */
     wither = 'wither',
 }
 
@@ -628,17 +831,72 @@ export enum ItemLockMode {
 /**
  * @beta
  * Enum containing the different phases of the moon based on
- * the current day.
- * Obtain the current MoonPhase using world.getMoonPhase
+ * the current day.,Obtain the current MoonPhase using
+ * world.getMoonPhase.
+ *
+ * The fullness of the moon controls various mob behaviors such
+ * as the number of slimes that spawn in Swamp biomes, the
+ * chance skeletons and zombies have to spawn with armor, as
+ * well as the chance for spiders to spawn with certain status
+ * effects.
  */
 export enum MoonPhase {
+    /**
+     * @beta
+     * @remarks
+     * The brightest moon phase. During this phase, cats have a 50%
+     * chance of spawning as black cats.
+     *
+     */
     FullMoon = 0,
+    /**
+     * @beta
+     * @remarks
+     * The phase following the Full Moon.
+     *
+     */
     WaningGibbous = 1,
+    /**
+     * @beta
+     * @remarks
+     * The phase following the Waxing Crescent.
+     *
+     */
     FirstQuarter = 2,
+    /**
+     * @beta
+     * @remarks
+     * The phase following the Last Quarter.
+     *
+     */
     WaningCrescent = 3,
+    /**
+     * @beta
+     * @remarks
+     * The darkest moon phase.
+     *
+     */
     NewMoon = 4,
+    /**
+     * @beta
+     * @remarks
+     * The phase following the New Moon.
+     *
+     */
     WaxingCrescent = 5,
+    /**
+     * @beta
+     * @remarks
+     * The phase following the Waning Gibbous.
+     *
+     */
     LastQuarter = 6,
+    /**
+     * @beta
+     * @remarks
+     * The phase following the First Quarter.
+     *
+     */
     WaxingGibbous = 7,
 }
 
@@ -952,6 +1210,12 @@ export class Block {
     readonly z: number;
     /**
      * @beta
+     * @remarks
+     * Returns the {@link Block} above this block (positive in the
+     * Y direction).
+     *
+     * @param steps
+     * Number of steps above to step before returning.
      * @throws This function can throw errors.
      *
      * {@link LocationInUnloadedChunkError}
@@ -961,6 +1225,12 @@ export class Block {
     above(steps?: number): Block | undefined;
     /**
      * @beta
+     * @remarks
+     * Returns the {@link Block} below this block (negative in the
+     * Y direction).
+     *
+     * @param steps
+     * Number of steps below to step before returning.
      * @throws This function can throw errors.
      *
      * {@link LocationInUnloadedChunkError}
@@ -970,6 +1240,10 @@ 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.
+     *
      */
     bottomCenter(): Vector3;
     /**
@@ -998,10 +1272,20 @@ 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.
+     *
      */
     center(): Vector3;
     /**
      * @beta
+     * @remarks
+     * Returns the {@link Block} to the east of this block
+     * (positive in the X direction).
+     *
+     * @param steps
+     * Number of steps to the east to step before returning.
      * @throws This function can throw errors.
      *
      * {@link LocationInUnloadedChunkError}
@@ -1012,16 +1296,13 @@ export class Block {
     /**
      * @beta
      * @remarks
-     * Gets additional configuration properties (a component) for
-     * specific capabilities of particular blocks - for example, an
-     * inventory component of a chest block.
+     * Gets a component (that represents additional capabilities)
+     * for a block - for example, an inventory component of a chest
+     * block.
      *
-     * @param componentName
-     * Identifier of the component. If a namespace is not
-     * specified, minecraft: is assumed.
      * @returns
-     * Returns the component object if it is present on the
-     * particular block.
+     * Returns the component if it exists on the block, otherwise
+     * undefined.
      * @throws This function can throw errors.
      *
      * {@link LocationInUnloadedChunkError}
@@ -1041,13 +1322,16 @@ export class Block {
      * @param withData
      * Whether additional data facets of the item stack are
      * included.
+     * @returns
+     * An itemStack with the specified amount of items and data.
+     * Returns undefined if block type is incompatible.
      * @throws This function can throw errors.
      *
      * {@link LocationInUnloadedChunkError}
      *
      * {@link LocationOutOfWorldBoundariesError}
      */
-    getItemStack(amount?: number, withData?: boolean): ItemStack;
+    getItemStack(amount?: number, withData?: boolean): ItemStack | undefined;
     /**
      * @beta
      * @remarks
@@ -1119,6 +1403,12 @@ export class Block {
     isValid(): boolean;
     /**
      * @beta
+     * @remarks
+     * Returns the {@link Block} to the north of this block
+     * (negative in the Z direction).
+     *
+     * @param steps
+     * Number of steps to the north to step before returning.
      * @throws This function can throw errors.
      *
      * {@link LocationInUnloadedChunkError}
@@ -1173,6 +1463,12 @@ 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).
+     *
+     * @param steps
+     * Number of steps to the south to step before returning.
      * @throws This function can throw errors.
      *
      * {@link LocationInUnloadedChunkError}
@@ -1203,6 +1499,12 @@ export class Block {
     trySetPermutation(permutation: BlockPermutation): boolean;
     /**
      * @beta
+     * @remarks
+     * Returns the {@link Block} to the west of this block
+     * (negative in the X direction).
+     *
+     * @param steps
+     * Number of steps to the west to step before returning.
      * @throws This function can throw errors.
      *
      * {@link LocationInUnloadedChunkError}
@@ -1854,8 +2156,8 @@ export class BlockStates {
      * Retrieves a specific block state instance.
      *
      * @returns
-     * Returns the block state instance if it is found. If the
-     * block state instance is not found returns undefined.
+     * Returns the {@link Block} state instance if it is found. If
+     * the block state instance is not found returns undefined.
      */
     static get(stateName: string): BlockStateType | undefined;
     /**
@@ -2786,7 +3088,7 @@ export class Container {
      * The stack of items to add.
      * @throws This function can throw errors.
      */
-    addItem(itemStack: ItemStack): ItemStack;
+    addItem(itemStack: ItemStack): ItemStack | undefined;
     /**
      * @remarks
      * Clears all inventory items in the container.
@@ -2922,6 +3224,9 @@ export class Container {
      * @param toContainer
      * Target container to transfer to. Note this can be the same
      * container as the source.
+     * @returns
+     * An itemStack with the items that couldn't be transferred.
+     * Returns undefined if all items were transferred.
      * @throws
      * Throws if either this container or `toContainer` are invalid
      * or if the `fromSlot` or `toSlot` indices out of bounds.
@@ -2933,7 +3238,7 @@ export class Container {
      * fromInventory.container.transferItem(0, toInventory.container);
      * ```
      */
-    transferItem(fromSlot: number, toContainer: Container): ItemStack;
+    transferItem(fromSlot: number, toContainer: Container): ItemStack | undefined;
 }
 
 /**
@@ -3904,8 +4209,6 @@ export class EffectAddAfterEvent {
     effect: Effect;
     /**
      * @remarks
-     * Additional variant number for the effect.
-     *
      * This property can't be edited in read-only mode.
      *
      */
@@ -4616,10 +4919,10 @@ export class Entity {
      * for an entity.
      *
      * @param componentId
-     * The identifier of the component (e.g., 'minecraft:rideable')
-     * to retrieve. If no namespace prefix is specified,
-     * 'minecraft:' is assumed. If the component is not present on
-     * the entity, undefined is returned.
+     * The identifier of the component (e.g., 'minecraft:health').
+     * If no namespace prefix is specified, 'minecraft:' is
+     * assumed. Available component IDs can be found as part of the
+     * {@link @minecraft/server.EntityComponentTypes} enum.
      * @returns
      * Returns the component if it exists on the entity, otherwise
      * undefined.
@@ -4850,6 +5153,11 @@ export class Entity {
      * ```
      */
     kill(): boolean;
+    /**
+     * @beta
+     * @throws This function can throw errors.
+     */
+    matches(options: EntityQueryOptions): boolean;
     /**
      * @beta
      * @remarks
@@ -4925,6 +5233,10 @@ export class Entity {
      * returned.
      * @throws
      * Throws if the entity is invalid.
+     *
+     * {@link minecraftcommon.EngineError}
+     *
+     * {@link Error}
      */
     resetProperty(identifier: string): boolean | number | string;
     /**
@@ -7472,12 +7784,16 @@ export class IButtonPushAfterEventSignal {
     private constructor();
     /**
      * @remarks
+     * Subscribes to the event.
+     *
      * This function can't be called in read-only mode.
      *
      */
     subscribe(callback: (arg: ButtonPushAfterEvent) => void): (arg: ButtonPushAfterEvent) => void;
     /**
      * @remarks
+     * Unsubscribes from the event.
+     *
      * This function can't be called in read-only mode.
      *
      * @throws This function can throw errors.
@@ -7494,12 +7810,16 @@ export class ILeverActionAfterEventSignal {
     private constructor();
     /**
      * @remarks
+     * Subscribes to the event.
+     *
      * This function can't be called in read-only mode.
      *
      */
     subscribe(callback: (arg: LeverActionAfterEvent) => void): (arg: LeverActionAfterEvent) => void;
     /**
      * @remarks
+     * Unsubscribes from the event.
+     *
      * This function can't be called in read-only mode.
      *
      * @throws This function can throw errors.
@@ -7516,12 +7836,16 @@ export class IPlayerJoinAfterEventSignal {
     private constructor();
     /**
      * @remarks
+     * Subscribes to the event.
+     *
      * This function can't be called in read-only mode.
      *
      */
     subscribe(callback: (arg: PlayerJoinAfterEvent) => void): (arg: PlayerJoinAfterEvent) => void;
     /**
      * @remarks
+     * Unsubscribes from the event.
+     *
      * This function can't be called in read-only mode.
      *
      * @throws This function can throw errors.
@@ -7538,12 +7862,16 @@ export class IPlayerLeaveAfterEventSignal {
     private constructor();
     /**
      * @remarks
+     * Subscribes to the event.
+     *
      * This function can't be called in read-only mode.
      *
      */
     subscribe(callback: (arg: PlayerLeaveAfterEvent) => void): (arg: PlayerLeaveAfterEvent) => void;
     /**
      * @remarks
+     * Unsubscribes from the event.
+     *
      * This function can't be called in read-only mode.
      *
      * @throws This function can throw errors.
@@ -7560,12 +7888,16 @@ export class IPlayerSpawnAfterEventSignal {
     private constructor();
     /**
      * @remarks
+     * Subscribes to the event.
+     *
      * This function can't be called in read-only mode.
      *
      */
     subscribe(callback: (arg: PlayerSpawnAfterEvent) => void): (arg: PlayerSpawnAfterEvent) => void;
     /**
      * @remarks
+     * Unsubscribes from the event.
+     *
      * This function can't be called in read-only mode.
      *
      * @throws This function can throw errors.
@@ -8095,15 +8427,18 @@ export class ItemStack {
      * for an item stack.
      *
      * @param componentId
-     * 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 or doesn't exist, undefined is returned.
+     * The identifier of the component (e.g., 'minecraft:food'). If
+     * no namespace prefix is specified, 'minecraft:' is assumed.
+     * Available component IDs can be found as part of the {@link
+     * @minecraft/server.ItemComponentTypes} enum.
+     * @returns
+     * Returns the component if it exists on the item stack,
+     * otherwise undefined.
      * @example durability.ts
      * ```typescript
      * // Get the maximum durability of a custom sword item
-     * const itemStack = new ItemStack("custom:sword");
-     * const durability = itemStack.getComponent("minecraft:durability") as ItemDurabilityComponent;
+     * const itemStack = new ItemStack('custom:sword');
+     * const durability = itemStack.getComponent(ItemComponentTypes.Durability);
      * const maxDurability = durability.maxDurability;
      * ```
      */
@@ -8549,8 +8884,9 @@ export class ItemTypes {
 
 /**
  * @beta
- * Contains information related to an item being used. This
- * event fires when an item is successfully used by a player.
+ * Contains information related to an item being used on a
+ * block. This event fires when an item used by a player
+ * successfully triggers an entity interaction.
  */
 export class ItemUseAfterEvent {
     private constructor();
@@ -8636,8 +8972,8 @@ export class ItemUseBeforeEventSignal {
 /**
  * @beta
  * Contains information related to an item being used on a
- * block. This event fires when an item is successfully used on
- * a block by a player.
+ * block. This event fires when an item used by a player
+ * successfully triggers a block interaction.
  */
 export class ItemUseOnAfterEvent {
     private constructor();
@@ -9698,40 +10034,6 @@ export class PlayerDimensionChangeAfterEventSignal {
     unsubscribe(callback: (arg: PlayerDimensionChangeAfterEvent) => void): void;
 }
 
-/**
- * @beta
- */
-export class PlayerDimensionChangeBeforeEvent {
-    private constructor();
-    readonly fromDimension: Dimension;
-    readonly fromLocation: Vector3;
-    readonly player: Player;
-    readonly toDimension: Dimension;
-    readonly toLocation: Vector3;
-}
-
-/**
- * @beta
- */
-export class PlayerDimensionChangeBeforeEventSignal {
-    private constructor();
-    /**
-     * @remarks
-     * This function can't be called in read-only mode.
-     *
-     */
-    subscribe(
-        callback: (arg: PlayerDimensionChangeBeforeEvent) => void,
-    ): (arg: PlayerDimensionChangeBeforeEvent) => void;
-    /**
-     * @remarks
-     * This function can't be called in read-only mode.
-     *
-     * @throws This function can throw errors.
-     */
-    unsubscribe(callback: (arg: PlayerDimensionChangeBeforeEvent) => void): void;
-}
-
 /**
  * @beta
  * Contains information regarding an event after a player
@@ -10061,6 +10363,34 @@ export class PlayerLeaveAfterEventSignal extends IPlayerLeaveAfterEventSignal {
     private constructor();
 }
 
+/**
+ * @beta
+ */
+export class PlayerLeaveBeforeEvent {
+    private constructor();
+    readonly player: Player;
+}
+
+/**
+ * @beta
+ */
+export class PlayerLeaveBeforeEventSignal {
+    private constructor();
+    /**
+     * @remarks
+     * This function can't be called in read-only mode.
+     *
+     */
+    subscribe(callback: (arg: PlayerLeaveBeforeEvent) => void): (arg: PlayerLeaveBeforeEvent) => void;
+    /**
+     * @remarks
+     * This function can't be called in read-only mode.
+     *
+     * @throws This function can throw errors.
+     */
+    unsubscribe(callback: (arg: PlayerLeaveBeforeEvent) => void): void;
+}
+
 /**
  * @beta
  * Contains information regarding an event where a player
@@ -12379,19 +12709,16 @@ export class WorldBeforeEvents {
     readonly playerBreakBlock: PlayerBreakBlockBeforeEventSignal;
     /**
      * @beta
-     * @remarks
-     * Fires before a player is about to change dimensions.
-     *
      */
-    readonly playerDimensionChange: PlayerDimensionChangeBeforeEventSignal;
+    readonly playerInteractWithBlock: PlayerInteractWithBlockBeforeEventSignal;
     /**
      * @beta
      */
-    readonly playerInteractWithBlock: PlayerInteractWithBlockBeforeEventSignal;
+    readonly playerInteractWithEntity: PlayerInteractWithEntityBeforeEventSignal;
     /**
      * @beta
      */
-    readonly playerInteractWithEntity: PlayerInteractWithEntityBeforeEventSignal;
+    readonly playerLeave: PlayerLeaveBeforeEventSignal;
     /**
      * @beta
      * @remarks

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@minecraft/server",
-  "version": "1.7.0-beta.1.20.40-preview.22",
+  "version": "1.7.0-beta.1.20.40-preview.24",
   "description": "",
   "contributors": [
     {
@@ -12,5 +12,8 @@
       "email": "mikeam@microsoft.com"
     }
   ],
+  "dependencies": {
+    "@minecraft/common": "^1.0.0-rc.1.20.40-preview.24"
+  },
   "license": "MIT"
 }