@minecraft/server 1.5.0-rc.1.20.30-preview.20 → 1.5.0-rc.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"
  * }
  * ```
  *
@@ -116,6 +116,62 @@ export enum EntityDamageCause {
     wither = 'wither',
 }
 
+/**
+ * @beta
+ * The equipment slot of the mob. This includes armor, offhand
+ * and mainhand slots.
+ */
+export enum EquipmentSlot {
+    /**
+     * @beta
+     * @remarks
+     * The chest slot. This slot is used to hold items such as
+     * Chestplate or Elytra.
+     *
+     */
+    Chest = 'Chest',
+    /**
+     * @beta
+     * @remarks
+     * The feet slot. This slot is used to hold items such as
+     * Boots.
+     *
+     */
+    Feet = 'Feet',
+    /**
+     * @beta
+     * @remarks
+     * The head slot. This slot is used to hold items such as
+     * Helmets or Carved Pumpkins.
+     *
+     */
+    Head = 'Head',
+    /**
+     * @beta
+     * @remarks
+     * The legs slot. This slot is used to hold items such as
+     * Leggings.
+     *
+     */
+    Legs = 'Legs',
+    /**
+     * @beta
+     * @remarks
+     * The mainhand slot. For players, the mainhand slot refers to
+     * the currently active hotbar slot.
+     *
+     */
+    Mainhand = 'Mainhand',
+    /**
+     * @beta
+     * @remarks
+     * The offhand slot. This slot is used to hold items such as
+     * shields and maps.
+     *
+     */
+    Offhand = 'Offhand',
+}
+
 /**
  * @beta
  * Represents a game mode for the current world experience.
@@ -773,7 +829,6 @@ export class Dimension {
      * @remarks
      * Identifier of the dimension.
      *
-     * @throws This property can throw when used.
      */
     readonly id: string;
     /**
@@ -1058,6 +1113,39 @@ export class Dimension {
      * ```
      */
     spawnItem(itemStack: ItemStack, location: Vector3): Entity;
+    /**
+     * @beta
+     * @remarks
+     * Creates a new particle emitter at a specified location in
+     * the world.
+     *
+     * 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.
+     * @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,
+     *     };
+     *     overworld.spawnParticle("minecraft:colored_flame_particle", newLocation, molang);
+     *   }
+     * ```
+     */
+    spawnParticle(effectName: string, location: Vector3, molangVariables?: MolangVariableMap): void;
 }
 
 /**
@@ -1149,7 +1237,6 @@ export class Entity {
      * property is accessible even if {@link Entity.isValid} is
      * false.
      *
-     * @throws This property can throw when used.
      */
     readonly id: string;
     /**
@@ -1173,17 +1260,17 @@ 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.
      */
     readonly scoreboardIdentity?: ScoreboardIdentity;
     /**
      * @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;
     /**
@@ -1688,6 +1775,30 @@ export class Entity {
      * ```
      */
     teleport(location: Vector3, teleportOptions?: TeleportOptions): void;
+    /**
+     * @beta
+     * @remarks
+     * Triggers an entity type event. For every entity, a number of
+     * events are defined in an entities' definition for key entity
+     * behaviors; for example, creepers have a
+     * minecraft:start_exploding type event.
+     *
+     * This function can't be called in read-only mode.
+     *
+     * @param eventName
+     * Name of the entity type event to trigger. If a namespace is
+     * not specified, minecraft: is assumed.
+     * @throws
+     * If the event is not defined in the definition of the entity,
+     * an error will be thrown.
+     * @example triggerEvent.ts
+     * ```typescript
+     *   const creeper = overworld.spawnEntity("minecraft:creeper", targetLocation);
+     *
+     *   creeper.triggerEvent("minecraft:start_exploding_forced");
+     * ```
+     */
+    triggerEvent(eventName: string): void;
     /**
      * @beta
      * @remarks
@@ -1928,6 +2039,29 @@ export class EntityDieAfterEventSignal {
     unsubscribe(callback: (arg: EntityDieAfterEvent) => void): void;
 }
 
+/**
+ * @beta
+ */
+// @ts-ignore Class inheritance allowed for native defined classes
+export class EntityEquippableComponent extends EntityComponent {
+    private constructor();
+    static readonly componentId = 'minecraft:equippable';
+    /**
+     * @remarks
+     * This function can't be called in read-only mode.
+     *
+     * @throws This function can throw errors.
+     */
+    getEquipment(equipmentSlot: EquipmentSlot): ItemStack | undefined;
+    /**
+     * @remarks
+     * This function can't be called in read-only mode.
+     *
+     * @throws This function can throw errors.
+     */
+    setEquipment(equipmentSlot: EquipmentSlot, itemStack?: ItemStack): boolean;
+}
+
 /**
  * @beta
  * When added, this component signifies that this entity
@@ -3034,7 +3168,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
@@ -3058,7 +3192,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[];
@@ -3081,16 +3215,26 @@ 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;
     /**
      * @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
@@ -3649,6 +3793,64 @@ export class MinecraftDimensionTypes {
     static readonly theEnd = 'minecraft:the_end';
 }
 
+/**
+ * @beta
+ * Contains a set of additional variable values for further
+ * defining how rendering and animations function.
+ */
+export class MolangVariableMap {
+    /**
+     * @remarks
+     * Adds the following variables to Molang:
+     * - `<variable_name>.r` - Red color value [0-1]
+     * - `<variable_name>.g` - Green color value [0-1]
+     * - `<variable_name>.b` - Blue color value [0-1]
+     *
+     * @throws This function can throw errors.
+     */
+    setColorRGB(variableName: string, color: RGB): void;
+    /**
+     * @remarks
+     * Adds the following variables to Molang:
+     * - `<variable_name>.r` - Red color value [0-1]
+     * - `<variable_name>.g` - Green color value [0-1]
+     * - `<variable_name>.b` - Blue color value [0-1]
+     * - `<variable_name>.a` - Alpha (transparency) color value
+     * [0-1]
+     *
+     * @throws This function can throw errors.
+     */
+    setColorRGBA(variableName: string, color: RGBA): void;
+    setFloat(variableName: string, number: number): void;
+    /**
+     * @remarks
+     * Adds the following variables to Molang:
+     * - `<variable_name>.speed` - Speed number provided
+     * - `<variable_name>.direction_x` - X value from the {@link
+     * Vector3} provided
+     * - `<variable_name>.direction_y` - Y value from the {@link
+     * Vector3} provided
+     * - `<variable_name>.direction_z` - Z value from the {@link
+     * Vector3} provided
+     *
+     * @throws This function can throw errors.
+     */
+    setSpeedAndDirection(variableName: string, speed: number, direction: Vector3): void;
+    /**
+     * @remarks
+     * Adds the following variables to Molang:
+     * - `<variable_name>.x` - X value from the {@link Vector3}
+     * provided
+     * - `<variable_name>.y` - Y value from the {@link Vector3}
+     * provided
+     * - `<variable_name>.z` - Z value from the {@link Vector3}
+     * provided
+     *
+     * @throws This function can throw errors.
+     */
+    setVector3(variableName: string, vector: Vector3): void;
+}
+
 /**
  * Represents a player within the world.
  */
@@ -3992,6 +4194,158 @@ export class PressurePlatePushAfterEventSignal {
     unsubscribe(callback: (arg: PressurePlatePushAfterEvent) => void): void;
 }
 
+/**
+ * @beta
+ * Contains information related to a projectile hitting a
+ * block.
+ */
+export class ProjectileHitBlockAfterEvent {
+    private constructor();
+    /**
+     * @remarks
+     * Dimension where this projectile hit took place.
+     *
+     */
+    readonly dimension: Dimension;
+    /**
+     * @remarks
+     * Direction vector of the projectile as it hit a block.
+     *
+     */
+    readonly hitVector: Vector3;
+    /**
+     * @remarks
+     * Location where the projectile hit occurred.
+     *
+     */
+    readonly location: Vector3;
+    /**
+     * @remarks
+     * Entity for the projectile that hit a block.
+     *
+     */
+    readonly projectile: Entity;
+    /**
+     * @remarks
+     * Optional source entity that fired the projectile.
+     *
+     */
+    readonly source?: Entity;
+    /**
+     * @remarks
+     * Contains additional information about the block that was hit
+     * by the projectile.
+     *
+     * This function can't be called in read-only mode.
+     *
+     */
+    getBlockHit(): BlockHitInformation;
+}
+
+/**
+ * @beta
+ * Manages callbacks that are connected to when a projectile
+ * hits a block.
+ */
+export class ProjectileHitBlockAfterEventSignal {
+    private constructor();
+    /**
+     * @remarks
+     * Adds a callback that will be called when a projectile hits a
+     * block.
+     *
+     * This function can't be called in read-only mode.
+     *
+     */
+    subscribe(callback: (arg: ProjectileHitBlockAfterEvent) => void): (arg: ProjectileHitBlockAfterEvent) => void;
+    /**
+     * @remarks
+     * Removes a callback from being called when a projectile hits
+     * a block.
+     *
+     * This function can't be called in read-only mode.
+     *
+     * @throws This function can throw errors.
+     */
+    unsubscribe(callback: (arg: ProjectileHitBlockAfterEvent) => void): void;
+}
+
+/**
+ * @beta
+ * Contains information related to a projectile hitting an
+ * entity.
+ */
+export class ProjectileHitEntityAfterEvent {
+    private constructor();
+    /**
+     * @remarks
+     * Dimension where this projectile hit took place.
+     *
+     */
+    readonly dimension: Dimension;
+    /**
+     * @remarks
+     * Direction vector of the projectile as it hit an entity.
+     *
+     */
+    readonly hitVector: Vector3;
+    /**
+     * @remarks
+     * Location where the projectile hit occurred.
+     *
+     */
+    readonly location: Vector3;
+    /**
+     * @remarks
+     * Entity for the projectile that hit an entity.
+     *
+     */
+    readonly projectile: Entity;
+    /**
+     * @remarks
+     * Optional source entity that fired the projectile.
+     *
+     */
+    readonly source?: Entity;
+    /**
+     * @remarks
+     * Contains additional information about an entity that was
+     * hit.
+     *
+     * This function can't be called in read-only mode.
+     *
+     */
+    getEntityHit(): EntityHitInformation;
+}
+
+/**
+ * @beta
+ * Manages callbacks that are connected to when a projectile
+ * hits an entity.
+ */
+export class ProjectileHitEntityAfterEventSignal {
+    private constructor();
+    /**
+     * @remarks
+     * Adds a callback that will be called when a projectile hits
+     * an entity.
+     *
+     * This function can't be called in read-only mode.
+     *
+     */
+    subscribe(callback: (arg: ProjectileHitEntityAfterEvent) => void): (arg: ProjectileHitEntityAfterEvent) => void;
+    /**
+     * @remarks
+     * Removes a callback from being called when a projectile hits
+     * an entity.
+     *
+     * This function can't be called in read-only mode.
+     *
+     * @throws This function can throw errors.
+     */
+    unsubscribe(callback: (arg: ProjectileHitEntityAfterEvent) => void): void;
+}
+
 /**
  * @beta
  * Contains objectives and participants for the scoreboard.
@@ -4058,12 +4412,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;
 }
 
 /**
@@ -4097,7 +4455,7 @@ export class ScoreboardIdentity {
      *
      * @throws This function can throw errors.
      */
-    getEntity(): Entity;
+    getEntity(): Entity | undefined;
     isValid(): boolean;
 }
 
@@ -4322,7 +4680,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
@@ -4336,14 +4694,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.
@@ -5044,6 +5402,20 @@ export class WorldAfterEvents {
      *
      */
     readonly pressurePlatePush: PressurePlatePushAfterEventSignal;
+    /**
+     * @beta
+     * @remarks
+     * This event fires when a projectile hits a block.
+     *
+     */
+    readonly projectileHitBlock: ProjectileHitBlockAfterEventSignal;
+    /**
+     * @beta
+     * @remarks
+     * This event fires when a projectile hits an entity.
+     *
+     */
+    readonly projectileHitEntity: ProjectileHitEntityAfterEventSignal;
     /**
      * @beta
      * @remarks
@@ -5086,6 +5458,32 @@ export class WorldBeforeEvents {
     readonly itemUseOn: ItemUseOnBeforeEventSignal;
 }
 
+/**
+ * @beta
+ * Contains more information for events where a block is hit.
+ */
+export interface BlockHitInformation {
+    /**
+     * @remarks
+     * Block that was hit.
+     *
+     */
+    block: Block;
+    /**
+     * @remarks
+     * Face of the block that was hit.
+     *
+     */
+    face: Direction;
+    /**
+     * @remarks
+     * Location relative to the bottom north-west corner of the
+     * block.
+     *
+     */
+    faceLocation: Vector3;
+}
+
 /**
  * @beta
  * Contains information for block raycast hit results.
@@ -5278,6 +5676,20 @@ export interface EntityEventOptions {
     entityTypes?: string[];
 }
 
+/**
+ * @beta
+ * Contains additional information about an entity that was
+ * hit.
+ */
+export interface EntityHitInformation {
+    /**
+     * @remarks
+     * Entity that was hit.
+     *
+     */
+    entity: Entity;
+}
+
 /**
  * @beta
  * Contains options for selecting entities within an area.
@@ -5615,6 +6027,69 @@ export interface RawMessageScore {
     objective?: string;
 }
 
+/**
+ * @beta
+ * Represents a fully customizable color within Minecraft.
+ */
+export interface RGB {
+    /**
+     * @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;
+}
+
+/**
+ * @beta
+ * Represents a fully customizable color within Minecraft.
+ */
+export interface RGBA {
+    /**
+     * @remarks
+     * Determines a color's alpha (opacity) component. Valid values
+     * are between 0 (transparent) and 1.0 (opaque).
+     *
+     */
+    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;
+}
+
 /**
  * @beta
  * Contains additional options for how a scoreboard should be

package/package.json

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