@minecraft/server 1.18.0-rc.1.21.80-preview.21 → 1.18.0

package/README.md

@@ -2,8 +2,6 @@
 
 Contains many types related to manipulating a Minecraft world, including entities, blocks, dimensions, and more.
 
-## **NOTE: This version of this module is still in pre-release.  It may change or it may be removed in future releases.**
-
 See full documentation for this module here:
 
-https://learn.microsoft.com/en-us/minecraft/creator/legacyscriptapi/minecraft/server-1xx/minecraft-server
+https://learn.microsoft.com/en-us/minecraft/creator/scriptapi/minecraft/server/minecraft-server

package/index.d.ts

@@ -7,7 +7,6 @@
    Copyright (c) Microsoft Corporation.
    ***************************************************************************** */
 /**
- * @preview
  * @packageDocumentation
  * Contains many types related to manipulating a Minecraft
  * world, including entities, blocks, dimensions, and more.
@@ -114,7 +113,6 @@ export enum BlockVolumeIntersection {
 }
 
 /**
- * @rc
  * The state of a button on a keyboard, controller, or touch
  * interface.
  */
@@ -1503,7 +1501,6 @@ export enum HudVisibility {
 }
 
 /**
- * @rc
  * All the different input buttons that are supported. Use with
  * {@link InputInfo.getButtonState} via {@link
  * Player.inputInfo} or {@link PlayerButtonInputAfterEvent} via
@@ -1703,7 +1700,6 @@ export enum ItemLockMode {
 }
 
 /**
- * @rc
  * Represents the type of liquid that can be placed on a block
  * or flow dynamically in the world.
  */
@@ -1816,7 +1812,6 @@ export enum MoonPhase {
 }
 
 /**
- * @rc
  * An enumeration describing the reason for the namespace name
  * error being thrown
  */
@@ -2245,16 +2240,10 @@ export enum WeatherType {
     Thunder = 'Thunder',
 }
 
-/**
- * @rc
- */
 export type BlockComponentReturnType<T extends string> = T extends keyof BlockComponentTypeMap
     ? BlockComponentTypeMap[T]
     : BlockComponent;
 
-/**
- * @rc
- */
 export type BlockComponentTypeMap = {
     fluidContainer: BlockFluidContainerComponent;
     inventory: BlockInventoryComponent;
@@ -2269,7 +2258,6 @@ export type BlockComponentTypeMap = {
 };
 
 /**
- * @rc
  * Type alias used by the {@link BlockPermutation} matches and
  * resolve functions to narrow block state argument types to
  * those mapped by {@link
@@ -2281,16 +2269,10 @@ export type BlockStateArg<T> = T extends `${minecraftvanilladata.MinecraftBlockT
         : never
     : Record<string, boolean | number | string>;
 
-/**
- * @rc
- */
 export type EntityComponentReturnType<T extends string> = T extends keyof EntityComponentTypeMap
     ? EntityComponentTypeMap[T]
     : EntityComponent;
 
-/**
- * @rc
- */
 export type EntityComponentTypeMap = {
     addrider: EntityAddRiderComponent;
     ageable: EntityAgeableComponent;
@@ -2424,16 +2406,10 @@ export type EntityComponentTypeMap = {
     wants_jockey: EntityWantsJockeyComponent;
 };
 
-/**
- * @rc
- */
 export type ItemComponentReturnType<T extends string> = T extends keyof ItemComponentTypeMap
     ? ItemComponentTypeMap[T]
     : ItemComponent;
 
-/**
- * @rc
- */
 export type ItemComponentTypeMap = {
     compostable: ItemCompostableComponent;
     cooldown: ItemCooldownComponent;
@@ -2595,7 +2571,6 @@ export class Block {
      */
     bottomCenter(): Vector3;
     /**
-     * @rc
      * @remarks
      * Returns whether this block is removed when touched by
      * liquid.
@@ -2614,7 +2589,6 @@ export class Block {
      */
     canBeDestroyedByLiquidSpread(liquidType: LiquidType): boolean;
     /**
-     * @rc
      * @remarks
      * Returns whether this block can have a liquid placed over it,
      * i.e. be waterlogged.
@@ -2756,7 +2730,6 @@ export class Block {
      */
     hasTag(tag: string): boolean;
     /**
-     * @rc
      * @remarks
      * Returns whether this block stops liquid from flowing.
      *
@@ -2786,7 +2759,6 @@ export class Block {
      */
     isValid(): boolean;
     /**
-     * @rc
      * @remarks
      * Returns whether liquid can flow into the block from the
      * provided direction, or flow out from the provided direction
@@ -2808,7 +2780,6 @@ export class Block {
      */
     liquidCanFlowFromDirection(liquidType: LiquidType, flowDirection: Direction): boolean;
     /**
-     * @rc
      * @remarks
      * Returns whether this block is removed and spawns its item
      * when touched by liquid.
@@ -3428,7 +3399,6 @@ export class BlockPermutation {
      */
     readonly 'type': BlockType;
     /**
-     * @rc
      * @remarks
      * Returns whether this block is removed when touched by
      * liquid.
@@ -3443,7 +3413,6 @@ export class BlockPermutation {
      */
     canBeDestroyedByLiquidSpread(liquidType: LiquidType): boolean;
     /**
-     * @rc
      * @remarks
      * Returns whether this block can have a liquid placed over it,
      * i.e. be waterlogged.
@@ -3522,7 +3491,6 @@ export class BlockPermutation {
      */
     hasTag(tag: string): boolean;
     /**
-     * @rc
      * @remarks
      * Returns whether this block stops liquid from flowing.
      *
@@ -3536,7 +3504,6 @@ export class BlockPermutation {
      */
     isLiquidBlocking(liquidType: LiquidType): boolean;
     /**
-     * @rc
      * @remarks
      * Returns whether this block is removed and spawns its item
      * when touched by liquid.
@@ -10047,7 +10014,6 @@ export class InputInfo {
      */
     readonly touchOnlyAffectsHotbar: boolean;
     /**
-     * @rc
      * @throws This function can throw errors.
      *
      * {@link minecraftcommon.EngineError}
@@ -10056,7 +10022,6 @@ export class InputInfo {
      */
     getButtonState(button: InputButton): ButtonState;
     /**
-     * @rc
      * @throws This function can throw errors.
      *
      * {@link InvalidEntityError}
@@ -11074,9 +11039,8 @@ 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 are those in the {@link
-     * ItemComponentTypes} enum and custom component IDs registered
-     * with the {@link ItemComponentRegistry}.
+     * Available component IDs can be found as part of the {@link
+     * ItemComponentTypes} enum.
      * @returns
      * Returns the component if it exists on the item stack,
      * otherwise undefined.
@@ -12429,22 +12393,6 @@ export class Player extends Entity {
      * @throws This function can throw errors.
      */
     addLevels(amount: number): number;
-    /**
-     * @rc
-     * @remarks
-     * For this player, removes all overrides of any Entity
-     * Properties on the target Entity. This change is not applied
-     * until the next tick and will not apply to other players.
-     *
-     * This function can't be called in read-only mode.
-     *
-     * @param targetEntity
-     * The Entity whose Entity Property overrides are being
-     * cleared.
-     * @throws
-     * Throws if the entity is invalid.
-     */
-    clearPropertyOverridesForEntity(targetEntity: Entity): void;
     /**
      * @remarks
      * Retrieves the active gamemode for this player, if specified.
@@ -12548,26 +12496,6 @@ export class Player extends Entity {
      *
      */
     queueMusic(trackId: string, musicOptions?: MusicOptions): void;
-    /**
-     * @rc
-     * @remarks
-     * For this player, removes the override on an Entity Property.
-     * This change is not applied until the next tick and will not
-     * apply to other players.
-     *
-     * This function can't be called in read-only mode.
-     *
-     * @param targetEntity
-     * The Entity whose Entity Property override is being removed.
-     * @param identifier
-     * The Entity Property identifier.
-     * @throws
-     * Throws if the entity is invalid.
-     * Throws if an invalid identifier is provided.
-     * Throws if the provided value type does not match the
-     * property type.
-     */
-    removePropertyOverrideForEntity(targetEntity: Entity, identifier: string): void;
     /**
      * @remarks
      * Resets the level of the player.
@@ -12587,10 +12515,6 @@ 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";
@@ -12678,34 +12602,6 @@ export class Player extends Entity {
      * @throws This function can throw errors.
      */
     setGameMode(gameMode?: GameMode): void;
-    /**
-     * @rc
-     * @remarks
-     * For this player, overrides an Entity Property on the target
-     * Entity to the provided value. This property must be client
-     * synced. This change is not applied until the next tick and
-     * will not apply to other players.
-     *
-     * This function can't be called in read-only mode.
-     *
-     * @param targetEntity
-     * The Entity whose Entity Property is being overriden.
-     * @param identifier
-     * The Entity Property identifier.
-     * @param value
-     * The override value. The provided type must be compatible
-     * with the type specified in the entity's definition.
-     * @throws
-     * Throws if the entity is invalid.
-     * Throws if an invalid identifier is provided.
-     * Throws if the provided value type does not match the
-     * property type.
-     * Throws if the provided value is outside the expected range
-     * (int, float properties).
-     * Throws if the provided string value does not match the set
-     * of accepted enum values (enum properties)
-     */
-    setPropertyOverrideForEntity(targetEntity: Entity, identifier: string, value: boolean | number | string): void;
     /**
      * @remarks
      * Sets the current starting spawn point for this particular
@@ -12721,7 +12617,6 @@ export class Player extends Entity {
      */
     setSpawnPoint(spawnPoint?: DimensionLocation): void;
     /**
-     * @rc
      * @remarks
      * Creates a new particle emitter at a specified location in
      * the world. Only visible to the target player.
@@ -12926,7 +12821,6 @@ export class PlayerBreakBlockBeforeEventSignal {
 }
 
 /**
- * @rc
  * Event data for when a player presses a button.
  */
 export class PlayerButtonInputAfterEvent {
@@ -12952,7 +12846,6 @@ export class PlayerButtonInputAfterEvent {
 }
 
 /**
- * @rc
  * Manages callbacks that are connected to player inputs.
  */
 export class PlayerButtonInputAfterEventSignal {
@@ -14527,8 +14420,6 @@ export class ScreenDisplay {
      * This function can't be called in read-only mode.
      *
      * @throws This function can throw errors.
-     *
-     * {@link InvalidEntityError}
      */
     getHiddenHudElements(): HudElement[];
     /**
@@ -14536,8 +14427,6 @@ 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;
     /**
@@ -14545,8 +14434,6 @@ 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;
     /**
@@ -14559,14 +14446,10 @@ export class ScreenDisplay {
      */
     isValid(): boolean;
     /**
-     * @deprecated This function is deprecated and will be removed in 2.0.0.
-     *
      * @remarks
      * This function can't be called in read-only mode.
      *
      * @throws This function can throw errors.
-     *
-     * {@link InvalidEntityError}
      */
     resetHudElements(): void;
     /**
@@ -14579,10 +14462,6 @@ 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;
     /**
@@ -14598,8 +14477,6 @@ 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;
     /**
@@ -14612,12 +14489,6 @@ 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";
@@ -14683,10 +14554,6 @@ 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";
@@ -15290,7 +15157,6 @@ export class System {
      */
     runTimeout(callback: () => void, tickDelay?: number): number;
     /**
-     * @rc
      * @remarks
      * Causes an event to fire within script with the specified
      * message ID and payload.
@@ -16404,7 +16270,6 @@ export class WorldAfterEvents {
      */
     readonly playerBreakBlock: PlayerBreakBlockAfterEventSignal;
     /**
-     * @rc
      * @remarks
      * This event fires when an {@link InputButton} state is
      * changed.
@@ -17924,7 +17789,6 @@ export interface GreaterThanOrEqualsComparison {
 }
 
 /**
- * @rc
  * An interface that is passed into {@link
  * @minecraft/Server.PlayerButtonInputAfterEventSignal.subscribe}
  * that filters out which events are passed to the provided
@@ -18845,7 +18709,6 @@ export class LocationOutOfWorldBoundariesError extends Error {
 }
 
 /**
- * @rc
  * Thrown when a name requires a namespace and an error occurs
  * when validating that namespace
  */
@@ -18860,11 +18723,6 @@ export class NamespaceNameError extends Error {
     reason: NamespaceNameErrorReason;
 }
 
-// @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": "1.18.0-rc.1.21.80-preview.21",
+  "version": "1.18.0",
   "description": "",
   "contributors": [
     {