@minecraft/server 2.8.0-rc.1.26.40-preview.23 → 2.8.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.
@@ -781,7 +780,6 @@ export enum EntityComponentTypes {
     Color2 = 'minecraft:color2',
     CursorInventory = 'minecraft:cursor_inventory',
     /**
-     * @rc
      * @remarks
      * Represents this entity's ender inventory properties.
      *
@@ -1439,7 +1437,6 @@ export enum EntityHealCause {
      */
     SelfHeal = 'SelfHeal',
     /**
-     * @rc
      * @remarks
      * Healing caused when Totem of Undying is activated.
      *
@@ -2266,7 +2263,6 @@ export enum LiquidType {
 }
 
 /**
- * @rc
  * Enum representing the different reasons why a locator bar
  * operation may fail.
  */
@@ -2938,7 +2934,6 @@ export enum TintMethod {
 }
 
 /**
- * @rc
  * Enum representing different texture icons that can be
  * displayed for waypoints on the locator bar.
  */
@@ -4411,7 +4406,6 @@ export class BlockComponentBlockBreakEvent extends BlockEvent {
 }
 
 /**
- * @rc
  * Contains information regarding a specific block permutation
  * that was changed from a previous permutation.
  */
@@ -4674,7 +4668,6 @@ export class BlockComponentTickEvent extends BlockEvent {
 }
 
 /**
- * @rc
  * Contains information regarding a specific container block
  * being closed.
  */
@@ -4692,7 +4685,6 @@ export class BlockContainerClosedAfterEvent extends BlockEvent {
 }
 
 /**
- * @rc
  * Manages callbacks that are connected to when a block
  * container is closed.
  */
@@ -4726,7 +4718,6 @@ export class BlockContainerClosedAfterEventSignal {
 }
 
 /**
- * @rc
  * Contains information regarding a specific container block
  * being opened.
  */
@@ -4744,7 +4735,6 @@ export class BlockContainerOpenedAfterEvent extends BlockEvent {
 }
 
 /**
- * @rc
  * Manages callbacks that are connected to when a block
  * container is opened.
  */
@@ -5367,7 +5357,6 @@ export class BlockPrecipitationInteractionsComponent extends BlockComponent {
      */
     accumulatesSnow(): boolean;
     /**
-     * @rc
      * @remarks
      * Returns `true` if this block can have snow within it, like a
      * flower submerged in snow. Returns `false` if this block
@@ -6187,7 +6176,6 @@ export class CatmullRomSpline {
 export class ClientSystemInfo extends SystemInfo {
     private constructor();
     /**
-     * @rc
      * @remarks
      * The locale selected by the client (e.g., en_US, fr_FR,
      * ja_JP). Note that in most cases, server scripts should not
@@ -7510,12 +7498,8 @@ export class Dimension {
      * locations that satisfied the block filter.
      * @throws This function can throw errors.
      *
-     * {@link minecraftcommon.ArgumentOutOfBoundsError}
-     *
      * {@link Error}
      *
-     * {@link minecraftcommon.InvalidArgumentError}
-     *
      * {@link UnloadedChunksError}
      */
     getBlocks(volume: BlockVolumeBase, filter: BlockFilter, allowUnloadedChunks?: boolean): ListBlockVolume;
@@ -7772,11 +7756,9 @@ export class Dimension {
      * An error will be thrown if pitch is less than 0.01.
      * An error will be thrown if volume is less than 0.0.
      *
-     * {@link minecraftcommon.EngineError}
-     *
      * {@link minecraftcommon.PropertyOutOfBoundsError}
      */
-    playSound(soundId: string, location: Vector3, soundOptions?: WorldSoundOptions): SoundInstance;
+    playSound(soundId: string, location: Vector3, soundOptions?: WorldSoundOptions): void;
     /**
      * @remarks
      * Runs a command synchronously using the context of the
@@ -8036,7 +8018,6 @@ export class Dimension {
 }
 
 /**
- * @rc
  * Provides the functionality for registering custom
  * dimensions. Custom dimensions can only be registered during
  * the system startup event.
@@ -8584,26 +8565,6 @@ export class Entity {
      * {@link InvalidEntityError}
      */
     readonly location: Vector3;
-    /**
-     * @rc
-     * @remarks
-     * Boolean which determines if the player nameplate should be
-     * depth tested for visibility.
-     *
-     * This property can't be edited in restricted-execution mode.
-     *
-     */
-    nameplateDepthTested: boolean;
-    /**
-     * @rc
-     * @remarks
-     * Float that determines the render distance of this entity's
-     * nameplate.
-     *
-     * This property can't be edited in restricted-execution mode.
-     *
-     */
-    nameplateRenderDistance: number;
     /**
      * @remarks
      * Given name of the entity.
@@ -10021,7 +9982,6 @@ export class EntityComponent extends Component {
 }
 
 /**
- * @rc
  * Contains information regarding a specific entity container
  * being closed.
  */
@@ -10037,7 +9997,6 @@ export class EntityContainerClosedAfterEvent {
 }
 
 /**
- * @rc
  * Manages callbacks that are connected to when an entity
  * container is closed.
  */
@@ -10071,7 +10030,6 @@ export class EntityContainerClosedAfterEventSignal {
 }
 
 /**
- * @rc
  * Contains information regarding a specific entity container
  * being opened.
  */
@@ -10087,7 +10045,6 @@ export class EntityContainerOpenedAfterEvent {
 }
 
 /**
- * @rc
  * Manages callbacks that are connected to when an entity
  * container is opened.
  */
@@ -10214,7 +10171,6 @@ export class EntityDieAfterEventSignal {
 }
 
 /**
- * @rc
  * Represents this entity's ender inventory properties. This
  * component is always present on players and any items in its
  * container will display for the player when they access an
@@ -12733,7 +12689,6 @@ export class EntityUnderwaterMovementComponent extends EntityAttributeComponent
 }
 
 /**
- * @rc
  * Contains information related to firing of a data driven
  * entity version upgrade.
  */
@@ -12761,7 +12716,6 @@ export class EntityUpgradeAfterEvent {
 }
 
 /**
- * @rc
  * Contains event registration related to firing of a data
  * driven entity version upgrade.
  */
@@ -12823,7 +12777,6 @@ export class EntityWantsJockeyComponent extends EntityComponent {
 }
 
 /**
- * @rc
  * Waypoint that tracks an entity's position. The waypoint
  * automatically updates as the entity moves and becomes
  * invalid when the entity is removed.
@@ -15622,7 +15575,6 @@ export class ListBlockVolume extends BlockVolumeBase {
 }
 
 /**
- * @rc
  * Waypoint that points to a fixed location in the world.
  * Unlike entity waypoints, location waypoints always remain
  * valid and their position can be updated.
@@ -15650,7 +15602,6 @@ export class LocationWaypoint extends Waypoint {
 }
 
 /**
- * @rc
  * Manages the collection of waypoints displayed on a player's
  * locator bar. Allows adding, removing, and querying waypoints
  * with a maximum capacity limit.
@@ -16478,7 +16429,6 @@ export class Player extends Entity {
      */
     readonly level: number;
     /**
-     * @rc
      * @remarks
      * The player's Locator Bar. This property is used for managing
      * waypoints displayed on the HUD.
@@ -16643,10 +16593,6 @@ export class Player extends Entity {
      * @param soundOptions
      * Additional optional options for the sound.
      * @throws This function can throw errors.
-     *
-     * {@link minecraftcommon.EngineError}
-     *
-     * {@link Error}
      * @example playMusicAndSound.ts
      * ```typescript
      * import { world, MusicOptions, WorldSoundOptions, PlayerSoundOptions, DimensionLocation } from '@minecraft/server';
@@ -16676,7 +16622,7 @@ export class Player extends Entity {
      * }
      * ```
      */
-    playSound(soundId: string, soundOptions?: PlayerSoundOptions): SoundInstance;
+    playSound(soundId: string, soundOptions?: PlayerSoundOptions): void;
     /**
      * @remarks
      * Queues an additional music track that only this particular
@@ -18365,7 +18311,6 @@ export class PlayerSwingStartAfterEventSignal {
 }
 
 /**
- * @rc
  * Waypoint that tracks a player's position. Extends {@link
  * EntityWaypoint} with additional player-specific visibility
  * rules such as hidden state and spectator mode.
@@ -18599,7 +18544,6 @@ export class PressurePlatePushAfterEventSignal {
 }
 
 /**
- * @rc
  * The base class for a text primitive. Represents an object in
  * the world and its base properties.
  */
@@ -18703,7 +18647,6 @@ export class PrimitiveShape {
 }
 
 /**
- * @rc
  * Primitive Shapes class used to allow adding and removing
  * text primitives to the world.
  */
@@ -19964,19 +19907,6 @@ export class SmeltItemFunction extends LootItemFunction {
     private constructor();
 }
 
-/**
- * Represents a handle to a sound that has been played. The
- * handle is required to control the sound while it is playing
- * (for example, to call `stop`, `setVolume`, `setPitch`,
- * `fade`, or `seekTo`). Infinitely-looping sounds (started
- * with `loop: -1`) stop automatically when the last
- * `SoundInstance` reference is dropped; retain the handle for
- * as long as the sound should keep playing.
- */
-export class SoundInstance {
-    private constructor();
-}
-
 /**
  * Loot item function that applies one or several predefined
  * enchants to the dropped item.
@@ -20028,7 +19958,6 @@ export class StartupEvent {
      */
     readonly customCommandRegistry: CustomCommandRegistry;
     /**
-     * @rc
      * @remarks
      * This property can be read in early-execution mode.
      *
@@ -20284,7 +20213,6 @@ export class StructureManager {
      */
     get(identifier: string): Structure | undefined;
     /**
-     * @rc
      * @remarks
      * Returns a list of all structures contained in behavior
      * packs. Does not include structures saved to the world or in
@@ -20771,7 +20699,6 @@ export class TargetBlockHitAfterEventSignal {
 }
 
 /**
- * @rc
  * A primitive shape class that represents a text label in the
  * world with a background.
  */
@@ -21079,7 +21006,6 @@ export class TripWireTripAfterEventSignal {
 }
 
 /**
- * @rc
  * Base class for waypoints displayed on the player's locator
  * bar. Waypoints can track locations or entities and are
  * rendered with customizable textures and colors.
@@ -21339,7 +21265,6 @@ export class World {
     readonly gameRules: GameRules;
     readonly isHardcore: boolean;
     /**
-     * @rc
      * @remarks
      * Manager for adding and removing primitive text objects in
      * the world.
@@ -21566,7 +21491,6 @@ export class World {
      */
     getMoonPhase(): MoonPhase;
     /**
-     * @rc
      * @remarks
      * Returns a map of pack setting name and value pairs.
      *
@@ -21829,7 +21753,6 @@ export class World {
 export class WorldAfterEvents {
     private constructor();
     /**
-     * @rc
      * @remarks
      * This event fires when a block container is closed.
      *
@@ -21838,7 +21761,6 @@ export class WorldAfterEvents {
      */
     readonly blockContainerClosed: BlockContainerClosedAfterEventSignal;
     /**
-     * @rc
      * @remarks
      * This event fires when a block container is opened.
      *
@@ -21884,7 +21806,6 @@ export class WorldAfterEvents {
      */
     readonly effectAdd: EffectAddAfterEventSignal;
     /**
-     * @rc
      * @remarks
      * This event fires when an entity container is closed.
      *
@@ -21893,7 +21814,6 @@ export class WorldAfterEvents {
      */
     readonly entityContainerClosed: EntityContainerClosedAfterEventSignal;
     /**
-     * @rc
      * @remarks
      * This event fires when an entity container is opened.
      *
@@ -21991,7 +21911,6 @@ export class WorldAfterEvents {
      */
     readonly entitySpawn: EntitySpawnAfterEventSignal;
     /**
-     * @rc
      * @remarks
      * This property can be read in early-execution mode.
      *
@@ -22502,7 +22421,6 @@ export interface BlockBoundingBox {
 }
 
 /**
- * @rc
  * Options used to filter block container access events.
  */
 export interface BlockContainerAccessEventOptions {
@@ -22534,9 +22452,6 @@ export interface BlockCustomComponent {
      *
      */
     beforeOnPlayerPlace?: (arg0: BlockComponentPlayerPlaceBeforeEvent, arg1: CustomComponentParameters) => void;
-    /**
-     * @rc
-     */
     onBlockStateChange?: (arg0: BlockComponentBlockStateChangeEvent, arg1: CustomComponentParameters) => void;
     /**
      * @remarks
@@ -22926,7 +22841,6 @@ export interface CameraTargetOptions {
 }
 
 /**
- * @rc
  * Represents the source of a container access.
  */
 export interface ContainerAccessSource {
@@ -22939,7 +22853,6 @@ export interface ContainerAccessSource {
 }
 
 /**
- * @rc
  * Options for use when filtering container access sources.
  */
 export interface ContainerAccessSourceFilter {
@@ -23069,9 +22982,6 @@ export interface CustomCommandResult {
     status: CustomCommandStatus;
 }
 
-/**
- * @rc
- */
 export interface CustomTexture {
     /**
      * @remarks
@@ -23226,7 +23136,6 @@ export interface EntityApplyDamageOptions {
 }
 
 /**
- * @rc
  * Options used to filter entity container access events.
  */
 export interface EntityContainerAccessEventOptions {
@@ -23919,7 +23828,6 @@ export interface EntityRaycastOptions extends EntityFilter {
 }
 
 /**
- * @rc
  * Controls when a waypoint is visible based on the state of
  * the entity it tracks. These rules allow filtering waypoint
  * visibility by entity conditions like sneaking, invisibility,
@@ -24475,7 +24383,6 @@ export interface PlayerSwingEventOptions {
 }
 
 /**
- * @rc
  * Controls when a waypoint is visible based on player-specific
  * states. Extends {@link EntityVisibilityRules} with
  * additional rules for player-only states like hidden mode and
@@ -25204,7 +25111,6 @@ export interface VectorXZ {
 }
 
 /**
- * @rc
  * Defines a texture and the distance range in which it should
  * be displayed. Used within a {@link WaypointTextureSelector}
  * to create distance-based texture switching.
@@ -25239,7 +25145,6 @@ export interface WaypointTextureBounds {
 }
 
 /**
- * @rc
  * Defines how waypoint textures change based on distance.
  * Contains a list of texture bounds that determine which
  * texture is displayed at different distance ranges.
@@ -25393,7 +25298,6 @@ export class CustomComponentNameError extends Error {
 }
 
 /**
- * @rc
  * Thrown when trying to register a custom dimension with a
  * name that has already been registered.
  */
@@ -25403,7 +25307,6 @@ export class CustomDimensionAlreadyRegisteredError extends Error {
 }
 
 /**
- * @rc
  * Thrown when trying to register a custom dimension outside of
  * the system startup event.
  */
@@ -25413,7 +25316,6 @@ export class CustomDimensionInvalidRegistryError extends Error {
 }
 
 /**
- * @rc
  * Thrown when trying to register a custom dimension with a
  * name that contains invalid characters.
  */
@@ -25423,7 +25325,6 @@ export class CustomDimensionNameError extends Error {
 }
 
 /**
- * @rc
  * Thrown after using the /reload command when trying to
  * register a custom dimension that was not previously
  * registered. New custom dimensions cannot be added during a
@@ -25558,7 +25459,6 @@ export class InvalidStructureError extends Error {
 }
 
 /**
- * @rc
  * Error thrown when attempting to perform operations on an
  * invalid waypoint. A waypoint becomes invalid when it is
  * removed or when the entity it tracks is no longer valid.
@@ -25568,9 +25468,6 @@ export class InvalidWaypointError extends Error {
     private constructor();
 }
 
-/**
- * @rc
- */
 // @ts-ignore Class inheritance allowed for native defined classes
 export class InvalidWaypointTextureSelectorError extends Error {
     private constructor();
@@ -25633,7 +25530,6 @@ export class LocationOutOfWorldBoundariesError extends Error {
 }
 
 /**
- * @rc
  * Error thrown when a locator bar operation fails. Contains a
  * reason code indicating the specific cause of the error.
  */
@@ -25671,9 +25567,6 @@ export class PlaceJigsawError extends Error {
     private constructor();
 }
 
-/**
- * @rc
- */
 // @ts-ignore Class inheritance allowed for native defined classes
 export class PrimitiveShapeError extends Error {
     private constructor();

package/package.json

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