@minecraft/server 2.0.0-beta.1.21.70-preview.26 → 2.0.0-beta.1.21.80-preview.21

package/index.d.ts

@@ -2619,12 +2619,21 @@ export type EntityComponentTypeMap = {
     wants_jockey: EntityWantsJockeyComponent;
 };
 
+/**
+ * @beta
+ */
+export type EntityIdentifierType<T> = [T] extends [never]
+    ? VanillaEntityIdentifier
+    : T extends string
+    ? VanillaEntityIdentifier | T
+    : never;
+
 /**
  * @rc
  */
 export type ItemComponentReturnType<T extends string> = T extends keyof ItemComponentTypeMap
     ? ItemComponentTypeMap[T]
-    : ItemComponent;
+    : ItemCustomComponentInstance;
 
 /**
  * @rc
@@ -2646,6 +2655,15 @@ export type ItemComponentTypeMap = {
     potion: ItemPotionComponent;
 };
 
+/**
+ * @beta
+ */
+export type VanillaEntityIdentifier =
+    | EntityType
+    | minecraftvanilladata.MinecraftEntityTypes
+    | `${minecraftvanilladata.MinecraftEntityTypes}`
+    | `${minecraftvanilladata.MinecraftEntityTypes}<${string}>`;
+
 /**
  * @beta
  * Handle to an aim-assist category that exists in the
@@ -3313,7 +3331,7 @@ export class Block {
      * @remarks
      * Checks to see whether it is valid to place the specified
      * block type or block permutation, on a specified face on this
-     * block
+     * block.
      *
      * @param blockToPlace
      * Block type or block permutation to check placement for.
@@ -7093,7 +7111,11 @@ export class Dimension {
      * }
      * ```
      */
-    spawnEntity(identifier: EntityType | string, location: Vector3, options?: SpawnEntityOptions): Entity;
+    spawnEntity<T = never>(
+        identifier: EntityIdentifierType<NoInfer<T>>,
+        location: Vector3,
+        options?: SpawnEntityOptions,
+    ): Entity;
     /**
      * @remarks
      * Creates a new item stack as an entity at the specified
@@ -9786,10 +9808,9 @@ export class EntityMarkVariantComponent extends EntityComponent {
      * @remarks
      * Value of the mark variant value for this entity.
      *
-     * This property can't be edited in read-only mode.
-     *
+     * @throws This property can throw when used.
      */
-    value: number;
+    readonly value: number;
     static readonly componentId = 'minecraft:mark_variant';
 }
 
@@ -10394,10 +10415,9 @@ export class EntityPushThroughComponent extends EntityComponent {
      * @remarks
      * Value of the push through distances of this entity.
      *
-     * This property can't be edited in read-only mode.
-     *
+     * @throws This property can throw when used.
      */
-    value: number;
+    readonly value: number;
     static readonly componentId = 'minecraft:push_through';
 }
 
@@ -11049,7 +11069,7 @@ export class EntityTypes {
      * Retrieves an entity type using a string-based identifier.
      *
      */
-    static get(identifier: string): EntityType | undefined;
+    static get<T = never>(identifier: EntityIdentifierType<NoInfer<T>>): EntityType | undefined;
     /**
      * @remarks
      * Retrieves a set of all entity types within this world.
@@ -11999,6 +12019,15 @@ export class ItemCooldownComponent extends ItemComponent {
     startCooldown(player: Player): void;
 }
 
+/**
+ * @beta
+ * An instance of a custom component on an item.
+ */
+// @ts-ignore Class inheritance allowed for native defined classes
+export class ItemCustomComponentInstance extends ItemComponent {
+    private constructor();
+}
+
 /**
  * When present on an item, this item can take damage in the
  * process of being used. Note that this component only applies
@@ -12608,8 +12637,9 @@ export class ItemStack {
      * @param componentId
      * 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
-     * ItemComponentTypes} enum.
+     * Available component IDs are those in the {@link
+     * ItemComponentTypes} enum and custom component IDs registered
+     * with the {@link ItemComponentRegistry}.
      * @returns
      * Returns the component if it exists on the item stack,
      * otherwise undefined.
@@ -13815,7 +13845,7 @@ export class Player extends Entity {
      */
     addLevels(amount: number): number;
     /**
-     * @beta
+     * @rc
      * @remarks
      * For this player, removes all overrides of any Entity
      * Properties on the target Entity. This change is not applied
@@ -13974,7 +14004,7 @@ export class Player extends Entity {
      */
     queueMusic(trackId: string, musicOptions?: MusicOptions): void;
     /**
-     * @beta
+     * @rc
      * @remarks
      * For this player, removes the override on an Entity Property.
      * This change is not applied until the next tick and will not
@@ -14012,6 +14042,10 @@ export class Player extends Entity {
      * This method can throw if the provided {@link RawMessage} is
      * in an invalid format. For example, if an empty `name` string
      * is provided to `score`.
+     *
+     * {@link InvalidEntityError}
+     *
+     * {@link RawMessageError}
      * @example nestedTranslation.ts
      * ```typescript
      * import { world, DimensionLocation } from "@minecraft/server";
@@ -14111,7 +14145,7 @@ export class Player extends Entity {
      */
     setOp(isOp: boolean): void;
     /**
-     * @beta
+     * @rc
      * @remarks
      * For this player, overrides an Entity Property on the target
      * Entity to the provided value. This property must be client
@@ -16224,6 +16258,8 @@ export class ScreenDisplay {
      * This function can't be called in read-only mode.
      *
      * @throws This function can throw errors.
+     *
+     * {@link InvalidEntityError}
      */
     getHiddenHudElements(): HudElement[];
     /**
@@ -16231,6 +16267,8 @@ export class ScreenDisplay {
      * This function can't be called in read-only mode.
      *
      * @throws This function can throw errors.
+     *
+     * {@link InvalidEntityError}
      */
     hideAllExcept(hudElements?: HudElement[]): void;
     /**
@@ -16238,15 +16276,20 @@ export class ScreenDisplay {
      * This function can't be called in read-only mode.
      *
      * @throws This function can throw errors.
+     *
+     * {@link InvalidEntityError}
      */
     isForcedHidden(hudElement: HudElement): boolean;
     /**
+     * @beta
      * @remarks
      * This function can't be called in read-only mode.
      *
      * @throws This function can throw errors.
+     *
+     * {@link InvalidEntityError}
      */
-    resetHudElements(): void;
+    resetHudElementsVisibility(): void;
     /**
      * @remarks
      * Set the action bar text - a piece of text that displays
@@ -16257,6 +16300,10 @@ export class ScreenDisplay {
      * @param text
      * New value for the action bar text.
      * @throws This function can throw errors.
+     *
+     * {@link InvalidEntityError}
+     *
+     * {@link RawMessageError}
      */
     setActionBar(text: (RawMessage | string)[] | RawMessage | string): void;
     /**
@@ -16272,6 +16319,8 @@ export class ScreenDisplay {
      * @param hudElements
      * Optional list of HUD elements to configure visibility for.
      * @throws This function can throw errors.
+     *
+     * {@link InvalidEntityError}
      */
     setHudVisibility(visible: HudVisibility, hudElements?: HudElement[]): void;
     /**
@@ -16284,6 +16333,12 @@ export class ScreenDisplay {
      * This function can't be called in read-only mode.
      *
      * @throws This function can throw errors.
+     *
+     * {@link minecraftcommon.ArgumentOutOfBoundsError}
+     *
+     * {@link InvalidEntityError}
+     *
+     * {@link RawMessageError}
      * @example setTitle.ts
      * ```typescript
      * import { world, DimensionLocation } from "@minecraft/server";
@@ -16349,6 +16404,10 @@ export class ScreenDisplay {
      * This function can't be called in read-only mode.
      *
      * @throws This function can throw errors.
+     *
+     * {@link InvalidEntityError}
+     *
+     * {@link RawMessageError}
      * @example countdown.ts
      * ```typescript
      * import { world, system, DimensionLocation } from "@minecraft/server";
@@ -21006,6 +21065,11 @@ export class PlaceJigsawError extends Error {
     private constructor();
 }
 
+// @ts-ignore Class inheritance allowed for native defined classes
+export class RawMessageError extends Error {
+    private constructor();
+}
+
 /**
  * Error thrown when the specified area contains one or more
  * unloaded chunks.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@minecraft/server",
-  "version": "2.0.0-beta.1.21.70-preview.26",
+  "version": "2.0.0-beta.1.21.80-preview.21",
   "description": "",
   "contributors": [
     {