@minecraft/server 2.11.0-rc.1.26.70-preview.21 → 2.11.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/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.
@@ -2214,7 +2213,7 @@ export enum InputPermissionCategory {
  * function ItemStack.getComponent.
  */
 export enum ItemComponentTypes {
-    BlockDynamicProperties = 'minecraft:block_dynamic_properties',
+    BlockDynamicProperties = 'minecraft:block_actor_dynamic_properties',
     /**
      * @remarks
      * The minecraft:book component.
@@ -3254,7 +3253,7 @@ export type ItemComponentReturnType<T extends string> = T extends keyof ItemComp
     : ItemCustomComponentInstance;
 
 export type ItemComponentTypeMap = {
-    block_dynamic_properties: ItemBlockDynamicPropertiesComponent;
+    block_actor_dynamic_properties: ItemBlockDynamicPropertiesComponent;
     book: ItemBookComponent;
     compostable: ItemCompostableComponent;
     cooldown: ItemCooldownComponent;
@@ -3263,7 +3262,7 @@ export type ItemComponentTypeMap = {
     enchantable: ItemEnchantableComponent;
     food: ItemFoodComponent;
     inventory: ItemInventoryComponent;
-    'minecraft:block_dynamic_properties': ItemBlockDynamicPropertiesComponent;
+    'minecraft:block_actor_dynamic_properties': ItemBlockDynamicPropertiesComponent;
     'minecraft:book': ItemBookComponent;
     'minecraft:compostable': ItemCompostableComponent;
     'minecraft:cooldown': ItemCooldownComponent;
@@ -7399,8 +7398,6 @@ export class CustomCommandRegistry {
      * {@link minecraftcommon.EngineError}
      *
      * {@link NamespaceNameError}
-     *
-     * {@link RawMessageError}
      */
     registerCommand(
         customCommand: CustomCommand,
@@ -7421,8 +7418,6 @@ export class CustomCommandRegistry {
      * {@link minecraftcommon.EngineError}
      *
      * {@link NamespaceNameError}
-     *
-     * {@link RawMessageError}
      */
     registerEnum(name: string, values: string[]): void;
 }
@@ -7817,7 +7812,7 @@ export class Dimension {
      * The options to decide if a block is a valid result.
      * @throws This function can throw errors.
      */
-    getBlockAbove(location: Vector3, options?: BlockSearchOptions): Block | undefined;
+    getBlockAbove(location: Vector3, options?: BlockRaycastOptions): Block | undefined;
     /**
      * @remarks
      * Gets the first block found below a given block location
@@ -7830,7 +7825,7 @@ export class Dimension {
      * The options to decide if a block is a valid result.
      * @throws This function can throw errors.
      */
-    getBlockBelow(location: Vector3, options?: BlockSearchOptions): Block | undefined;
+    getBlockBelow(location: Vector3, options?: BlockRaycastOptions): Block | undefined;
     /**
      * @remarks
      * Gets the first block that intersects with a vector emanating
@@ -8386,7 +8381,6 @@ export class Dimension {
      */
     spawnParticle(effectName: string, location: Vector3, molangVariables?: MolangVariableMap): void;
     /**
-     * @rc
      * @remarks
      * Spawns an experience orb at a specified location in the
      * dimension.
@@ -11473,7 +11467,6 @@ export class EntityIsStunnedComponent extends EntityComponent {
 export class EntityIsTamedComponent extends EntityComponent {
     private constructor();
     /**
-     * @rc
      * @remarks
      * Returns the player that has tamed the entity, or 'undefined'
      * if the entity has no player owner.
@@ -11484,7 +11477,6 @@ export class EntityIsTamedComponent extends EntityComponent {
      */
     readonly tamedToPlayer?: Player;
     /**
-     * @rc
      * @remarks
      * Returns the id of the player that has tamed the entity, or
      * 'undefined' if the entity has no player owner.
@@ -14178,7 +14170,7 @@ export class ISerializable {
 // @ts-ignore Class inheritance allowed for native defined classes
 export class ItemBlockDynamicPropertiesComponent extends ItemComponent {
     private constructor();
-    static readonly componentId = 'minecraft:block_dynamic_properties';
+    static readonly componentId = 'minecraft:block_actor_dynamic_properties';
     /**
      * @remarks
      * Returns a DynamicProperty that was stored with the provided
@@ -21065,7 +21057,6 @@ export class SoundInstance {
      */
     readonly soundEventId: string;
     /**
-     * @rc
      * @remarks
      * Fades this sound instance from its current volume multiplier
      * to the target multiplier over the specified duration. Volume
@@ -21085,7 +21076,6 @@ export class SoundInstance {
      */
     fade(duration: number, targetVolume: number): void;
     /**
-     * @rc
      * @remarks
      * Pauses this sound.
      *
@@ -21094,7 +21084,6 @@ export class SoundInstance {
      */
     pause(): void;
     /**
-     * @rc
      * @remarks
      * Resumes this sound after a pause.
      *
@@ -21103,7 +21092,6 @@ export class SoundInstance {
      */
     resume(): void;
     /**
-     * @rc
      * @remarks
      * Sets the playback position of this sound instance.
      *
@@ -21120,7 +21108,6 @@ export class SoundInstance {
      */
     seekTo(seconds: number): void;
     /**
-     * @rc
      * @remarks
      * Sets the pitch of this sound instance.
      *
@@ -21133,7 +21120,6 @@ export class SoundInstance {
      */
     setPitch(pitch: number): void;
     /**
-     * @rc
      * @remarks
      * Sets the volume multiplier of this sound instance relative
      * to the volume of the selected sound variant.
@@ -21219,7 +21205,6 @@ export class StartupEvent {
      */
     readonly itemComponentRegistry: ItemComponentRegistry;
     /**
-     * @rc
      * @remarks
      * @privilege early-execution-readable - This property can be read in early-execution mode.
      *
@@ -21985,7 +21970,6 @@ export class TextPrimitive extends PrimitiveShape {
      */
     depthTest: boolean;
     /**
-     * @rc
      * @remarks
      * This value determines the gap between lines for the
      * TextPrimitive. By default the line gap height is 0.
@@ -22133,7 +22117,6 @@ export class TickingAreaManager {
 }
 
 /**
- * @rc
  * A named point in time on a world clock that can occur once
  * or periodically.
  */
@@ -22640,7 +22623,6 @@ export class World {
      */
     getAllPlayers(): Player[];
     /**
-     * @rc
      * @remarks
      * Retrieves a world clock by its name.
      *
@@ -23576,7 +23558,6 @@ export class WorldAfterEvents {
      */
     readonly weatherChange: WeatherChangeAfterEventSignal;
     /**
-     * @rc
      * @remarks
      * This event fires when a {@link WorldClock} is paused.
      *
@@ -23585,7 +23566,6 @@ export class WorldAfterEvents {
      */
     readonly worldClockOnPaused: WorldClockOnPausedAfterEventSignal;
     /**
-     * @rc
      * @remarks
      * This event fires when a {@link WorldClock} is resumed.
      *
@@ -23594,7 +23574,6 @@ export class WorldAfterEvents {
      */
     readonly worldClockOnResumed: WorldClockOnResumedAfterEventSignal;
     /**
-     * @rc
      * @remarks
      * This event fires when the time of a {@link WorldClock} hits
      * a {@link TimeMarker} on the clock. This can happen during a
@@ -23605,7 +23584,6 @@ export class WorldAfterEvents {
      */
     readonly worldClockOnTimeMarker: WorldClockOnTimeMarkerAfterEventSignal;
     /**
-     * @rc
      * @remarks
      * This event fires when a {@link WorldClock} time is changed.
      * This can happen when the time is directly set through
@@ -23741,7 +23719,6 @@ export class WorldBeforeEvents {
      */
     readonly weatherChange: WeatherChangeBeforeEventSignal;
     /**
-     * @rc
      * @remarks
      * This event fires when a {@link WorldClock} reaches its
      * maximum time and is about to restart.
@@ -23753,7 +23730,6 @@ export class WorldBeforeEvents {
 }
 
 /**
- * @rc
  * A class that represents a particular clock within a world.
  */
 export class WorldClock {
@@ -23880,7 +23856,6 @@ export class WorldClock {
 }
 
 /**
- * @rc
  * Contains information related to a {@link WorldClock} being
  * paused.
  */
@@ -23895,7 +23870,6 @@ export class WorldClockOnPausedAfterEvent {
 }
 
 /**
- * @rc
  * Manages callbacks that are connected to a {@link WorldClock}
  * being paused.
  */
@@ -23929,7 +23903,6 @@ export class WorldClockOnPausedAfterEventSignal {
 }
 
 /**
- * @rc
  * Contains information related to a {@link WorldClock}
  * restarting.
  */
@@ -23960,7 +23933,6 @@ export class WorldClockOnRestartBeforeEvent {
 }
 
 /**
- * @rc
  * Manages callbacks that are connected to a {@link WorldClock}
  * restarting.
  */
@@ -24000,7 +23972,6 @@ export class WorldClockOnRestartBeforeEventSignal {
 }
 
 /**
- * @rc
  * Contains information related to a {@link WorldClock} being
  * resumed.
  */
@@ -24015,7 +23986,6 @@ export class WorldClockOnResumedAfterEvent {
 }
 
 /**
- * @rc
  * Manages callbacks that are connected to a {@link WorldClock}
  * being resumed.
  */
@@ -24049,7 +24019,6 @@ export class WorldClockOnResumedAfterEventSignal {
 }
 
 /**
- * @rc
  * Contains information related to when the time of a
  * {@link WorldClock} hits a {@link TimeMarker}.
  */
@@ -24070,7 +24039,6 @@ export class WorldClockOnTimeMarkerAfterEvent {
 }
 
 /**
- * @rc
  * Manages callbacks that are connected to when the time of a
  * {@link WorldClock} hits a {@link TimeMarker}.
  */
@@ -24104,7 +24072,6 @@ export class WorldClockOnTimeMarkerAfterEventSignal {
 }
 
 /**
- * @rc
  * Contains information related to changes to the time of a
  * {@link WorldClock}.
  */
@@ -24119,7 +24086,6 @@ export class WorldClockOnTimeModifiedAfterEvent {
 }
 
 /**
- * @rc
  * Manages callbacks that are connected to changes to the time
  * of a {@link WorldClock}.
  */
@@ -24153,7 +24119,6 @@ export class WorldClockOnTimeModifiedAfterEventSignal {
 }
 
 /**
- * @rc
  * Provides the functionality for registering custom world
  * clocks. World clocks can only be registered during the
  * system startup event.
@@ -24612,35 +24577,7 @@ export interface BlockRaycastOptions extends BlockFilter {
     includePassableBlocks?: boolean;
     /**
      * @remarks
-     * Maximum raycast distance, in blocks.
-     *
-     * Bounds: [-2147483648, 2147483647]
-     */
-    maxDistance?: number;
-}
-
-/**
- * Options for finding blocks.
- */
-// @ts-ignore Class inheritance allowed for native defined classes
-export interface BlockSearchOptions extends BlockFilter {
-    /**
-     * @remarks
-     * When true, includes liquid blocks.
-     *
-     */
-    includeLiquidBlocks?: boolean;
-    /**
-     * @remarks
-     * When true, includes passable blocks, such as vines and
-     * flowers.
-     *
-     */
-    includePassableBlocks?: boolean;
-    /**
-     * @remarks
-     * Maximum search distance, in blocks. Vertical searches use
-     * whole blocks.
+     * Maximum distance, in blocks, to process the raycast.
      *
      */
     maxDistance?: number;
@@ -25801,9 +25738,8 @@ export interface EntityRaycastOptions extends EntityFilter {
     includePassableBlocks?: boolean;
     /**
      * @remarks
-     * Maximum raycast distance, in blocks.
+     * Maximum distance, in blocks, to process the raycast.
      *
-     * Bounds: [-2147483648, 2147483647]
      */
     maxDistance?: number;
 }
@@ -26369,7 +26305,6 @@ export interface PlayerSoundOptions {
      */
     location?: Vector3;
     /**
-     * @rc
      * @remarks
      * Number of additional times to repeat the sound after the
      * initial play. `0` (the default) plays the sound once, `-1`
@@ -27228,7 +27163,6 @@ export interface TickingAreaOptions {
 }
 
 /**
- * @rc
  * Options for creating time markers for world clocks.
  */
 export interface TimeMarkerOptions {
@@ -27396,7 +27330,6 @@ export interface WaypointTextureSelector {
 }
 
 /**
- * @rc
  * Contains parameters for world clock events that filters out
  * which events are passed to the provided callback.
  */
@@ -27410,7 +27343,6 @@ export interface WorldClockEventOptions {
 }
 
 /**
- * @rc
  * Contains additional options for registering world clocks.
  */
 export interface WorldClockRegistrationOptions {
@@ -27424,7 +27356,6 @@ export interface WorldClockRegistrationOptions {
 }
 
 /**
- * @rc
  * Contains parameters for world clock time marker events that
  * filters out which events are passed to the provided
  * callback.
@@ -27452,7 +27383,6 @@ export interface WorldClockTimeMarkerEventOptions {
 export interface WorldSoundOptions {
     isBroadcast?: boolean;
     /**
-     * @rc
      * @remarks
      * Number of additional times to repeat the sound after the
      * initial play. `0` (the default) plays the sound once, `-1`
@@ -27912,7 +27842,6 @@ export class UnloadedChunksError extends Error {
 }
 
 /**
- * @rc
  * Error thrown by {@link WorldClock.addTimeMarker} when
  * failing to add a time marker to a world clock.
  */
@@ -27922,7 +27851,6 @@ export class WorldClockAddTimeMarkerError extends Error {
 }
 
 /**
- * @rc
  * Thrown when trying to register a world clock outside of the
  * system startup event.
  */
@@ -27932,7 +27860,6 @@ export class WorldClockInvalidRegistryError extends Error {
 }
 
 /**
- * @rc
  * Error thrown when a time marker is invalid. This can occur
  * when trying to access data on a time marker that has been
  * removed.
@@ -27943,7 +27870,6 @@ export class WorldClockInvalidTimeMarkerError extends Error {
 }
 
 /**
- * @rc
  * Error thrown when a world clock is not found in the world
  * clock registry.
  */
@@ -27953,7 +27879,6 @@ export class WorldClockNotFoundError extends Error {
 }
 
 /**
- * @rc
  * Error thrown by {@link WorldClockRegistry.registerClock}
  * when failing to register a world clock.
  */
@@ -27963,7 +27888,6 @@ export class WorldClockRegistrationError extends Error {
 }
 
 /**
- * @rc
  * Thrown after using the /reload command when trying to
  * register a world clock that was not previously registered.
  * New world clocks cannot be added during a reload.
@@ -27974,7 +27898,6 @@ export class WorldClockReloadNewWorldClockError extends Error {
 }
 
 /**
- * @rc
  * Error thrown after using the /reload command when trying to
  * re-register an existing world clock with an invalid time
  * marker.
@@ -27985,7 +27908,6 @@ export class WorldClockReloadTimeMarkerError extends Error {
 }
 
 /**
- * @rc
  * Error thrown by {@link WorldClock.removeTimeMarker} when
  * trying to remove a time marker with the 'minecraft'
  * namespace from a world clock.
@@ -27996,7 +27918,6 @@ export class WorldClockRemoveMinecraftTimeMarkerError extends Error {
 }
 
 /**
- * @rc
  * Error thrown by {@link WorldClock.rewindTo} when the world
  * clock's time is already before the time marker's first
  * occurrence.
@@ -28007,7 +27928,6 @@ export class WorldClockRewindError extends Error {
 }
 
 /**
- * @rc
  * Error thrown when performing actions on a world clock with a
  * time marker that does not exist.
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@minecraft/server",
-  "version": "2.11.0-rc.1.26.70-preview.21",
+  "version": "2.11.0",
   "description": "",
   "contributors": [
     {
@@ -14,7 +14,7 @@
   ],
   "peerDependencies": {
     "@minecraft/common": "^1.2.0",
-    "@minecraft/vanilla-data": ">=1.20.70 || 1.26.70-preview.21"
+    "@minecraft/vanilla-data": ">=1.20.70"
   },
   "license": "MIT"
 }