@minecraft/server 2.10.0-beta.1.26.40-preview.31 → 2.11.0-beta.1.26.50-preview.20

package/index.d.ts

@@ -16,7 +16,7 @@
  * ```json
  * {
  *   "module_name": "@minecraft/server",
- *   "version": "2.10.0-beta"
+ *   "version": "2.11.0-beta"
  * }
  * ```
  *
@@ -53,7 +53,7 @@ export enum BlockComponentTypes {
     DynamicProperties = 'minecraft:dynamic_properties',
     FluidContainer = 'minecraft:fluid_container',
     /**
-     * @beta
+     * @rc
      */
     Instrument = 'minecraft:instrument_sound',
     /**
@@ -202,7 +202,7 @@ export enum ButtonState {
 }
 
 /**
- * @beta
+ * @rc
  * Represents the type of shake to apply to the camera.
  */
 export enum CameraShakeType {
@@ -284,55 +284,6 @@ export enum CommandPermissionLevel {
     Owner = 4,
 }
 
-/**
- * @beta
- * The Action enum determines how the CompoundBlockVolume
- * considers the associated CompoundBlockVolumeItem when
- * performing inside/outside calculations.
- */
-export enum CompoundBlockVolumeAction {
-    /**
-     * @remarks
-     * The associated BlockVolume is considered a positive space,
-     * and any intersection tests are considered hits
-     *
-     */
-    Add = 0,
-    /**
-     * @remarks
-     * The associated BlockVolume is considered a negative or void
-     * space, and any intersection tests are considered misses.
-     * Using the Subtract action, it is possible to `punch holes`
-     * in block volumes so that any intersection tests may pass
-     * through such spaces
-     *
-     */
-    Subtract = 1,
-}
-
-/**
- * @beta
- * An enum describing the relativity of the
- * CompoundBlockVolumeItem, relative to the parent
- * CompoundVolume.
- */
-export enum CompoundBlockVolumePositionRelativity {
-    /**
-     * @remarks
-     * The locations within the associated BlockVolume are relative
-     * to the CompoundBlockVolume to which they were added
-     *
-     */
-    Relative = 0,
-    /**
-     * @remarks
-     * The locations within the associated BlockVolume are in
-     * absolute world space
-     *
-     */
-    Absolute = 1,
-}
-
 /**
  * Reasons that the {@link
  * @minecraft/server.ContainerRulesError} was thrown.
@@ -5500,7 +5451,7 @@ export class BlockFluidContainerComponent extends BlockComponent {
 }
 
 /**
- * @beta
+ * @rc
  * Represents the instruments a block can have assigned to it's
  * up and down faces.
  */
@@ -6567,7 +6518,7 @@ export class BlockVolumeBase {
      */
     getCapacity(): number;
     /**
-     * @beta
+     * @rc
      * @remarks
      * Returns a list of block positions within the volume that are
      * closest to a given location, sorted by distance (nearest
@@ -6583,7 +6534,7 @@ export class BlockVolumeBase {
      */
     getClosest(count: number, location: Vector3): Vector3[];
     /**
-     * @beta
+     * @rc
      * @remarks
      * Returns a list of block positions within the volume that are
      * farthest from a given location, sorted by distance (farthest
@@ -6758,7 +6709,7 @@ export class Camera {
      */
     readonly isValid: boolean;
     /**
-     * @beta
+     * @rc
      * @remarks
      * This function can't be called in restricted-execution mode.
      *
@@ -6875,7 +6826,7 @@ export class Camera {
      */
     setFov(fovCameraOptions?: CameraFovOptions): void;
     /**
-     * @beta
+     * @rc
      * @remarks
      * This function can't be called in restricted-execution mode.
      *
@@ -7147,258 +7098,6 @@ export class Component {
     readonly typeId: string;
 }
 
-/**
- * @beta
- * The Compound Block Volume is a collection of individual
- * block volume definitions which, as a collection, define a
- * larger volume of (sometimes non-contiguous) irregular
- * shapes.
- * This class is loosely based on the concept of CSG
- * (Computational Solid Geometry) and allows a user to create
- * complex volumes by building a stack of volumes and voids to
- * make a larger single volume.
- * For example - normally a creator would create a hollow cube
- * by creating 6 "wall" surfaces for each face.
- * With a Compound Block Volume, a creator can define a hollow
- * cube by creating a single outer solid cube, and then
- * defining a further single 'void' cube inside the larger one.
- * Similarly, the Compound Block Volume can represent irregular
- * shaped volumes (e.g. a tree consists of a trunk and lots of
- * leaf cubes which are not necessarily contiguously placed).
- * Each of the volumes added to the CompoundBlockVolume are (by
- * default) relative to the origin set (either at construction
- * or via one of the set functions).
- * However, it is also possible to push volumes to the compound
- * collection which are absolute in nature and are not affected
- * by origin changes.
- */
-export class CompoundBlockVolume {
-    /**
-     * @remarks
-     * Return the 'capacity' of the bounding rectangle which
-     * represents the collection of volumes in the stack
-     *
-     */
-    readonly capacity: number;
-    readonly items: CompoundBlockVolumeItem[];
-    readonly itemsAbsolute: CompoundBlockVolumeItem[];
-    /**
-     * @remarks
-     * Return the number of volumes (positive and negative) in the
-     * volume stack
-     *
-     */
-    readonly volumeCount: number;
-    /**
-     * @remarks
-     * Create a CompoundBlockVolume object
-     *
-     * @param origin
-     * An optional world space origin on which to center the
-     * compound volume.
-     * If not specified, the origin is set to (0,0,0)
-     */
-    constructor(origin?: Vector3);
-    /**
-     * @remarks
-     * Clear the contents of the volume stack
-     *
-     * This function can't be called in restricted-execution mode.
-     *
-     */
-    clear(): void;
-    /**
-     * @remarks
-     * Fetch a Block Location Iterator for the Compound Block
-     * Volume.  This iterator will allow a creator to iterate
-     * across all of the selected volumes within the larger
-     * bounding area.
-     * Areas of a volume which have been overridden by a
-     * subtractive volume will not be included in the iterator
-     * step.
-     * (i.e. if you push a cube to the stack, and then push a
-     * subtractive volume to the same location, then the iterator
-     * will step over the initial volume because it is considered
-     * negative space)
-     * Note that the Block Locations returned by this iterator are
-     * in absolute world space (irrespective of whether the
-     * compound volume items pushed are absolute or relative)
-     *
-     * This function can't be called in restricted-execution mode.
-     *
-     */
-    getBlockLocationIterator(): BlockLocationIterator;
-    /**
-     * @remarks
-     * Get the largest bounding box that represents a container for
-     * all of the volumes on the stack
-     * Note that the bounding box returned is represented in
-     * absolute world space  (irrespective of whether the compound
-     * volume items pushed are absolute or relative)
-     *
-     * This function can't be called in restricted-execution mode.
-     *
-     */
-    getBoundingBox(): BlockBoundingBox;
-    /**
-     * @remarks
-     * Get the max block location of the outermost bounding
-     * rectangle which represents the volumes on the stack.
-     * Note that the max location returned is in absolute world
-     * space (irrespective of whether the compound volume items
-     * pushed are absolute or relative)
-     *
-     * This function can't be called in restricted-execution mode.
-     *
-     */
-    getMax(): Vector3;
-    /**
-     * @remarks
-     * Get the min block location of the outermost bounding
-     * rectangle which represents the volumes on the stack.
-     * Note that the min location returned is in absolute world
-     * space (irrespective of whether the compound volume items
-     * pushed are absolute or relative)
-     *
-     * This function can't be called in restricted-execution mode.
-     *
-     */
-    getMin(): Vector3;
-    /**
-     * @remarks
-     * Fetch the origin in world space of the compound volume
-     *
-     * This function can't be called in restricted-execution mode.
-     *
-     */
-    getOrigin(): Vector3;
-    /**
-     * @remarks
-     * Return a boolean which signals if there are any volume items
-     * pushed to the volume
-     *
-     * This function can't be called in restricted-execution mode.
-     *
-     */
-    isEmpty(): boolean;
-    /**
-     * @remarks
-     * Return a boolean representing whether or not a given
-     * absolute world space block location is inside a positive
-     * block volume.
-     * E.g. if the stack contains a large cube followed by a
-     * slightly smaller negative cube, and the test location is
-     * within the negative cube - the function will return false
-     * because it's not 'inside' a volume (it IS inside the
-     * bounding rectangle, but it is not inside a positively
-     * defined location)
-     *
-     * This function can't be called in restricted-execution mode.
-     *
-     */
-    isInside(worldLocation: Vector3): boolean;
-    /**
-     * @remarks
-     * Inspect the last entry pushed to the volume stack without
-     * affecting the stack contents.
-     *
-     * This function can't be called in restricted-execution mode.
-     *
-     * @param forceRelativity
-     * Determine whether the function returns a
-     * CompoundBlockVolumeItem which is forced into either relative
-     * or absolute coordinate system.
-     * `true` = force returned item to be relative to volume origin
-     * `false` = force returned item to be absolute world space
-     * location
-     *
-     * If no flag is specified, the item returned retains whatever
-     * relativity it had when it was pushed
-     * @returns
-     * Returns undefined if the stack is empty
-     */
-    peekLastVolume(forceRelativity?: CompoundBlockVolumePositionRelativity): CompoundBlockVolumeItem | undefined;
-    /**
-     * @remarks
-     * Remove the last entry from the volume stack.  This will
-     * reduce the stack size by one
-     *
-     * This function can't be called in restricted-execution mode.
-     *
-     */
-    popVolume(): boolean;
-    /**
-     * @remarks
-     * Push a volume item to the stack.  The volume item contains
-     * an 'action' parameter which determines whether this volume
-     * is a positive or negative space.
-     * The item also contains a `locationRelativity` which
-     * determines whether it is relative or absolute to the
-     * compound volume origin
-     *
-     * This function can't be called in restricted-execution mode.
-     *
-     * @param item
-     * Item to push to the end of the stack
-     */
-    pushVolume(item: CompoundBlockVolumeItem): void;
-    /**
-     * @remarks
-     * If the volume stack is empty, this function will push the
-     * specified item to the stack.
-     * If the volume stack is NOT empty, this function will replace
-     * the last item on the stack with the new item.
-     *
-     * This function can't be called in restricted-execution mode.
-     *
-     * @param item
-     * Item to add or replace
-     */
-    replaceOrAddLastVolume(item: CompoundBlockVolumeItem): boolean;
-    /**
-     * @remarks
-     * Set the origin of the compound volume to an absolute world
-     * space location
-     *
-     * This function can't be called in restricted-execution mode.
-     *
-     * @param preserveExistingVolumes
-     * This optional boolean flag determines whether the relative
-     * `CompoundBlockVolumeItem`'s are frozen in place, or are
-     * affected by the new origin.
-     * Imagine a scenario where you have a series of relative
-     * locations around an origin which make up a sphere; all of
-     * these locations are in the range of -2 to 2.
-     * Push each of these locations to the compound volume as
-     * relative items.
-     * Now, move the origin and all of the locations representing
-     * the sphere move accordingly.
-     * However, let's say you want to add a 2nd sphere next to the
-     * 1st.
-     * In this case, set the new origin a few locations over, but
-     * 'preserveExistingVolumes' = true.
-     * This will set a new origin, but the existing sphere
-     * locations will remain relative to the original origin.
-     * Now, you can push the relative sphere locations again (this
-     * time they will be relative to the new origin) - resulting in
-     * 2 spheres next to each other.
-     */
-    setOrigin(position: Vector3, preserveExistingVolumes?: boolean): void;
-    /**
-     * @remarks
-     * Similar to {@link CompoundBlockVolume.setOrigin} - this
-     * function will translate the origin by a given delta to a new
-     * position
-     *
-     * This function can't be called in restricted-execution mode.
-     *
-     * @param preserveExistingVolumes
-     * See the description for the arguments to {@link
-     * CompoundBlockVolume.setOrigin}
-     */
-    translateOrigin(delta: Vector3, preserveExistingVolumes?: boolean): void;
-}
-
 /**
  * Represents a container that can hold sets of items. Used
  * with entities such as Players, Chest Minecarts, Llamas, and
@@ -8708,6 +8407,7 @@ export class Dimension {
      */
     getBlockFromRay(location: Vector3, direction: Vector3, options?: BlockRaycastOptions): BlockRaycastHit | undefined;
     /**
+     * @rc
      * @remarks
      * Gets all the blocks in a volume that satisfy the block query
      * options.
@@ -9599,8 +9299,6 @@ export class EffectTypes {
      * @remarks
      * Effect type for the given identifier.
      *
-     * This function can't be called in restricted-execution mode.
-     *
      * @param identifier
      * The identifier for the effect.
      * @returns
@@ -9612,8 +9310,6 @@ export class EffectTypes {
      * @remarks
      * Gets all effects.
      *
-     * This function can't be called in restricted-execution mode.
-     *
      * @returns
      * A list of all effects.
      */
@@ -14050,7 +13746,7 @@ export class EntityTameableComponent extends EntityComponent {
 }
 
 /**
- * @beta
+ * @rc
  * Contains data related to an entity being tamed.
  */
 export class EntityTamedAfterEvent {
@@ -14060,7 +13756,7 @@ export class EntityTamedAfterEvent {
 }
 
 /**
- * @beta
+ * @rc
  * Manages callbacks that are connected to when an entity is
  * tamed.
  */
@@ -14075,7 +13771,7 @@ export class EntityTamedAfterEventSignal {
      */
     subscribe(
         callback: (arg0: EntityTamedAfterEvent) => void,
-        options?: EntityTamedEventFilter,
+        options?: EntityTamedEventOptions,
     ): (arg0: EntityTamedAfterEvent) => void;
     /**
      * @remarks
@@ -14088,7 +13784,7 @@ export class EntityTamedAfterEventSignal {
 }
 
 /**
- * @beta
+ * @rc
  * Contains information regarding an event before an entity is
  * tamed.
  */
@@ -14115,7 +13811,7 @@ export class EntityTamedBeforeEvent {
 }
 
 /**
- * @beta
+ * @rc
  * Manages callbacks that are connected to before an entity is
  * tamed.
  */
@@ -14134,7 +13830,7 @@ export class EntityTamedBeforeEventSignal {
      */
     subscribe(
         callback: (arg0: EntityTamedBeforeEvent) => void,
-        options?: EntityTamedEventFilter,
+        options?: EntityTamedEventOptions,
     ): (arg0: EntityTamedBeforeEvent) => void;
     /**
      * @remarks
@@ -22291,7 +21987,7 @@ export class SmeltItemFunction extends LootItemFunction {
 }
 
 /**
- * @beta
+ * @rc
  * Contains information about a sound thats declared duration
  * elapsed.
  */
@@ -22308,7 +22004,7 @@ export class SoundCompletedAfterEvent {
 }
 
 /**
- * @beta
+ * @rc
  * Manages callbacks that are invoked when a tracked sound's
  * declared duration elapses.
  */
@@ -22406,7 +22102,7 @@ export class SoundDefinitionRegistry {
 }
 
 /**
- * @beta
+ * @rc
  * Provides duration and playback information for a sound whose
  * definition declares a duration.
  */
@@ -22450,28 +22146,28 @@ export class SoundDurationInfo {
 export class SoundInstance {
     private constructor();
     /**
-     * @beta
+     * @rc
      * @remarks
      * Gets duration and playback information for this sound.
      *
      */
     readonly durationInfo?: SoundDurationInfo;
     /**
-     * @beta
+     * @rc
      * @remarks
      * Unique identifier of this sound instance.
      *
      */
     readonly id: string;
     /**
-     * @beta
+     * @rc
      * @remarks
      * Gets the player this sound was played for.
      *
      */
     readonly recipient?: Player;
     /**
-     * @beta
+     * @rc
      * @remarks
      * Gets the identifier of the sound event this instance was
      * started with.
@@ -23400,6 +23096,14 @@ export class TextPrimitive extends PrimitiveShape {
      *
      */
     depthTest: boolean;
+    /**
+     * @beta
+     * @remarks
+     * This value determines the gap between lines for the
+     * TextPrimitive. By default the line gap height is 0.
+     *
+     */
+    lineGapHeight: number;
     /**
      * @remarks
      * Get the text of the debug text shape. Returns the RawText of
@@ -24708,7 +24412,7 @@ export class WorldAfterEvents {
      */
     readonly entityStopSneaking: EntityStopSneakingAfterEventSignal;
     /**
-     * @beta
+     * @rc
      * @remarks
      * This event fires when an entity is tamed.
      *
@@ -25029,7 +24733,7 @@ export class WorldAfterEvents {
      */
     readonly projectileHitEntity: ProjectileHitEntityAfterEventSignal;
     /**
-     * @beta
+     * @rc
      * @remarks
      * A tracked sound's declared duration elapsed.
      *
@@ -25155,7 +24859,7 @@ export class WorldBeforeEvents {
      */
     readonly entityRemove: EntityRemoveBeforeEventSignal;
     /**
-     * @beta
+     * @rc
      * @remarks
      * Fires before an entity is tamed.
      *
@@ -25584,7 +25288,7 @@ export interface BlockHitInformation {
 }
 
 /**
- * @beta
+ * @rc
  * Options for querying blocks in a volume. Extends BlockFilter
  * with additional sorting and limiting options based on
  * distance from a location.
@@ -25788,7 +25492,7 @@ export interface CameraSetRotOptions {
 }
 
 /**
- * @beta
+ * @rc
  * Options for applying a camera shake effect to a player's
  * camera via `Camera.addShake`. Each call to `addShake` queues
  * a new independent shake event for the specified `type`;
@@ -25843,40 +25547,6 @@ export interface CameraTargetOptions {
     targetEntity: Entity;
 }
 
-/**
- * @beta
- * This interface defines an entry into the {@link
- * CompoundBlockVolume} which represents a volume of positive
- * or negative space.
- *
- */
-export interface CompoundBlockVolumeItem {
-    /**
-     * @remarks
-     * The 'action' defines how the block volume is represented in
-     * the compound block volume stack.
-     * 'Add' creates a block volume which is positively selected
-     * 'Subtract' creates a block volume which represents a hole or
-     * negative space in the overall compound block volume.
-     *
-     */
-    action?: CompoundBlockVolumeAction;
-    /**
-     * @remarks
-     * The relativity enumeration determines whether the
-     * BlockVolume specified is positioned relative to the parent
-     * compound block volume origin, or in absolute world space.
-     *
-     */
-    locationRelativity?: CompoundBlockVolumePositionRelativity;
-    /**
-     * @remarks
-     * The volume of space
-     *
-     */
-    volume: BlockVolume;
-}
-
 /**
  * Represents the source of a container access.
  */
@@ -26891,10 +26561,10 @@ export interface EntitySneakingChangedEventOptions {
 }
 
 /**
- * @beta
+ * @rc
  * Contains options for filtering entity tamed events.
  */
-export interface EntityTamedEventFilter {
+export interface EntityTamedEventOptions {
     entityFilter?: EntityFilter;
     tamingEntityFilter?: EntityFilter;
 }

package/package.json

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