@minecraft/server 1.5.0-rc.1.20.30-preview.21 → 1.5.0-rc.1.20.30-preview.24

package/README.md

@@ -6,4 +6,4 @@ Contains many types related to manipulating a Minecraft world, including entitie
 
 See full documentation for this module here:
 
-https://learn.microsoft.com/en-us/minecraft/creator/scriptapi/@minecraft/server/@minecraft/server
+https://learn.microsoft.com/en-us/minecraft/creator/scriptapi/minecraft/server/minecraft-server

package/index.d.ts

@@ -16,7 +16,7 @@
  * ```json
  * {
  *   "module_name": "@minecraft/server",
- *   "version": "1.6.0-internal.1.20.30-preview.21"
+ *   "version": "1.6.0-internal.1.20.30-preview.24"
  * }
  * ```
  *
@@ -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.
@@ -1204,13 +1260,13 @@ 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.
      *
@@ -1982,6 +2038,44 @@ export class EntityDieAfterEventSignal {
     unsubscribe(callback: (arg: EntityDieAfterEvent) => void): void;
 }
 
+/**
+ * @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 EntityEquippableComponent extends EntityComponent {
+    private constructor();
+    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;
+    /**
+     * @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;
+}
+
 /**
  * @beta
  * When added, this component signifies that this entity
@@ -4332,12 +4426,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;
 }
 
 /**
@@ -4371,7 +4469,7 @@ export class ScoreboardIdentity {
      *
      * @throws This function can throw errors.
      */
-    getEntity(): Entity;
+    getEntity(): Entity | undefined;
     isValid(): boolean;
 }
 
@@ -5920,6 +6018,13 @@ export interface RawMessage {
      *
      */
     translate?: string;
+    /**
+     * @remarks
+     * Arguments for the translation token. Can be either an array
+     * of strings or RawMessage containing an array of raw text
+     * objects.
+     *
+     */
     with?: string[] | RawMessage;
 }
 

package/package.json

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