@minecraft/server 2.11.0-rc.1.26.60-preview.23 → 2.11.0-rc.1.26.60-preview.28

package/README.md

@@ -1,9 +1,9 @@
-# `@minecraft/server`
-
-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:
-
+# `@minecraft/server`
+
+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

@@ -47,14 +47,8 @@ export enum AimAssistTargetMode {
  * function Block.getComponent.
  */
 export enum BlockComponentTypes {
-    /**
-     * @rc
-     */
     DynamicProperties = 'minecraft:dynamic_properties',
     FluidContainer = 'minecraft:fluid_container',
-    /**
-     * @rc
-     */
     Instrument = 'minecraft:instrument_sound',
     /**
      * @remarks
@@ -202,7 +196,6 @@ export enum ButtonState {
 }
 
 /**
- * @rc
  * Represents the type of shake to apply to the camera.
  */
 export enum CameraShakeType {
@@ -221,7 +214,6 @@ export enum CameraShakeType {
 }
 
 /**
- * @rc
  * An enumeration for the clone modes used when cloning blocks.
  */
 export enum CloneMode {
@@ -2222,9 +2214,6 @@ export enum InputPermissionCategory {
  * function ItemStack.getComponent.
  */
 export enum ItemComponentTypes {
-    /**
-     * @rc
-     */
     BlockDynamicProperties = 'minecraft:block_actor_dynamic_properties',
     /**
      * @remarks
@@ -4883,7 +4872,6 @@ export class BlockCustomComponentInstance extends BlockComponent {
 }
 
 /**
- * @rc
  * Represents the dynamic properties of a block in the world.
  * Only available with block entities. Up to 1KB per content
  * pack, per block entity in their dynamic properties storage.
@@ -5123,7 +5111,6 @@ export class BlockFluidContainerComponent extends BlockComponent {
 }
 
 /**
- * @rc
  * Represents the instruments a block can have assigned to it's
  * up and down faces.
  */
@@ -6169,7 +6156,6 @@ export class BlockVolumeBase {
      */
     getCapacity(): number;
     /**
-     * @rc
      * @remarks
      * Returns a list of block positions within the volume that are
      * closest to a given location, sorted by distance (nearest
@@ -6185,7 +6171,6 @@ export class BlockVolumeBase {
      */
     getClosest(count: number, location: Vector3): Vector3[];
     /**
-     * @rc
      * @remarks
      * Returns a list of block positions within the volume that are
      * farthest from a given location, sorted by distance (farthest
@@ -6360,7 +6345,6 @@ export class Camera {
      */
     readonly isValid: boolean;
     /**
-     * @rc
      * @remarks
      * @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
      *
@@ -6460,7 +6444,6 @@ export class Camera {
      */
     setFov(fovCameraOptions?: CameraFovOptions): void;
     /**
-     * @rc
      * @remarks
      * @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
      *
@@ -7589,7 +7572,6 @@ export class Dimension {
         options?: BiomeSearchOptions,
     ): Vector3 | undefined;
     /**
-     * @rc
      * @remarks
      * Clones a region of blocks from one area of the dimension to
      * another.
@@ -7860,7 +7842,6 @@ export class Dimension {
      */
     getBlockFromRay(location: Vector3, direction: Vector3, options?: BlockRaycastOptions): BlockRaycastHit | undefined;
     /**
-     * @rc
      * @remarks
      * Gets all the blocks in a volume that satisfy the filter.
      *
@@ -11487,6 +11468,28 @@ export class EntityIsStunnedComponent extends EntityComponent {
 // @ts-ignore Class inheritance allowed for native defined classes
 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.
+     *
+     * @throws This property can throw when used.
+     *
+     * {@link InvalidEntityError}
+     */
+    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.
+     *
+     * @throws This property can throw when used.
+     *
+     * {@link InvalidEntityError}
+     */
+    readonly tamedToPlayerId?: string;
     static readonly componentId = 'minecraft:is_tamed';
 }
 
@@ -12898,7 +12901,6 @@ export class EntitySpawnAfterEventSignal {
 }
 
 /**
- * @rc
  * Contains data related to an entity beginning to sneak.
  */
 export class EntityStartSneakingAfterEvent {
@@ -12912,7 +12914,6 @@ export class EntityStartSneakingAfterEvent {
 }
 
 /**
- * @rc
  * Manages callbacks that are connected to when an entity
  * begins sneaking.
  */
@@ -12946,7 +12947,6 @@ export class EntityStartSneakingAfterEventSignal {
 }
 
 /**
- * @rc
  * Contains data related to an entity stopping sneaking.
  */
 export class EntityStopSneakingAfterEvent {
@@ -12960,7 +12960,6 @@ export class EntityStopSneakingAfterEvent {
 }
 
 /**
- * @rc
  * Manages callbacks that are connected to when an entity stops
  * sneaking.
  */
@@ -13081,7 +13080,6 @@ export class EntityTameableComponent extends EntityComponent {
 }
 
 /**
- * @rc
  * Contains data related to an entity being tamed.
  */
 export class EntityTamedAfterEvent {
@@ -13091,7 +13089,6 @@ export class EntityTamedAfterEvent {
 }
 
 /**
- * @rc
  * Manages callbacks that are connected to when an entity is
  * tamed.
  */
@@ -13119,7 +13116,6 @@ export class EntityTamedAfterEventSignal {
 }
 
 /**
- * @rc
  * Contains information regarding an event before an entity is
  * tamed.
  */
@@ -13146,7 +13142,6 @@ export class EntityTamedBeforeEvent {
 }
 
 /**
- * @rc
  * Manages callbacks that are connected to before an entity is
  * tamed.
  */
@@ -13697,7 +13692,6 @@ export class FluidContainer {
 }
 
 /**
- * @rc
  * Provides access to the fog definitions stack of a player
  * entity, allowing scripts to push, pop, remove, and query
  * active fog definitions.
@@ -14172,7 +14166,6 @@ export class ISerializable {
 }
 
 /**
- * @rc
  * Represents the dynamic properties of a block. Only available
  * from block entities. Up to 1KBytes of data can be stored per
  * content pack per block entity in their dynamic properties
@@ -17184,7 +17177,6 @@ export class Player extends Entity {
      */
     commandPermissionLevel: CommandPermissionLevel;
     /**
-     * @rc
      * @remarks
      * Contains methods for manipulating the render distance fog
      * settings of a Player.
@@ -19643,7 +19635,6 @@ export class PrimitiveShapesManager {
      */
     addText(text: TextPrimitive, dimension?: Dimension): void;
     /**
-     * @rc
      * @remarks
      * Fetches and queries all primitive shapes stored in the
      * manager and returns the results as an array of shape
@@ -20891,7 +20882,6 @@ export class SmeltItemFunction extends LootItemFunction {
 }
 
 /**
- * @rc
  * Contains information about a sound thats declared duration
  * elapsed.
  */
@@ -20908,7 +20898,6 @@ export class SoundCompletedAfterEvent {
 }
 
 /**
- * @rc
  * Manages callbacks that are invoked when a tracked sound's
  * declared duration elapses.
  */
@@ -20945,7 +20934,6 @@ export class SoundCompletedAfterEventSignal {
 export class SoundDefinition {
     private constructor();
     /**
-     * @rc
      * @remarks
      * Duration metadata declared for this sound. Undefined when
      * the sound definition does not specify a duration.
@@ -20953,7 +20941,6 @@ export class SoundDefinition {
      */
     readonly durationInfo?: SoundDefinitionDurationInfo;
     /**
-     * @rc
      * @remarks
      * Music metadata declared for this sound. Undefined when the
      * sound definition does not specify a music_info block.
@@ -20961,7 +20948,6 @@ export class SoundDefinition {
      */
     readonly musicInfo?: SoundDefinitionMusicInfo;
     /**
-     * @rc
      * @remarks
      * Identifier of the sound event this definition declares, in
      * the form 'namespace:name'.
@@ -20969,7 +20955,6 @@ export class SoundDefinition {
      */
     readonly soundEventId: string;
     /**
-     * @rc
      * @remarks
      * Tag metadata declared for this sound, as a record mapping
      * each tag name to its declared values. A tag declared with a
@@ -20982,7 +20967,6 @@ export class SoundDefinition {
 }
 
 /**
- * @rc
  * Provides read-only access to the sound definitions loaded
  * for the current world.
  */
@@ -21009,7 +20993,6 @@ export class SoundDefinitionRegistry {
 }
 
 /**
- * @rc
  * Provides duration and playback information for a sound whose
  * definition declares a duration.
  */
@@ -21053,34 +21036,112 @@ export class SoundDurationInfo {
 export class SoundInstance {
     private constructor();
     /**
-     * @rc
      * @remarks
      * Gets duration and playback information for this sound.
      *
      */
     readonly durationInfo?: SoundDurationInfo;
     /**
-     * @rc
      * @remarks
      * Unique identifier of this sound instance.
      *
      */
     readonly id: string;
     /**
-     * @rc
      * @remarks
      * Gets the player this sound was played for.
      *
      */
     readonly recipient?: Player;
     /**
-     * @rc
      * @remarks
      * Gets the identifier of the sound event this instance was
      * started with.
      *
      */
     readonly soundEventId: string;
+    /**
+     * @rc
+     * @remarks
+     * Fades this sound instance from its current volume multiplier
+     * to the target multiplier over the specified duration. Volume
+     * multipliers are relative to the selected sound variant's
+     * volume. To fade in from silence, call `setVolume(0.0)`
+     * first; to fade out, pass a target volume of `0.0`.
+     *
+     * @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
+     *
+     * @param duration
+     * Duration of the fade in seconds. Must be non-negative.
+     * Minimum value: 0
+     * @param targetVolume
+     * Volume multiplier to fade to, relative to the selected sound
+     * variant's volume. Must be non-negative.
+     * Minimum value: 0
+     */
+    fade(duration: number, targetVolume: number): void;
+    /**
+     * @rc
+     * @remarks
+     * Pauses this sound.
+     *
+     * @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
+     *
+     */
+    pause(): void;
+    /**
+     * @rc
+     * @remarks
+     * Resumes this sound after a pause.
+     *
+     * @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
+     *
+     */
+    resume(): void;
+    /**
+     * @rc
+     * @remarks
+     * Sets the playback position of this sound instance.
+     *
+     * @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
+     *
+     * @param seconds
+     * Position to seek to in seconds. Must be non-negative.
+     * Bounds: [0, 107374184]
+     * @throws
+     * Throws if `seconds` is negative, or if the sound has a known
+     * duration and `seconds` is greater than that duration.
+     *
+     * {@link minecraftcommon.ArgumentOutOfBoundsError}
+     */
+    seekTo(seconds: number): void;
+    /**
+     * @rc
+     * @remarks
+     * Sets the pitch of this sound instance.
+     *
+     * @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
+     *
+     * @param pitch
+     * Pitch multiplier between 0.01 and 10.0. A value of 1.0 is
+     * normal pitch.
+     * Bounds: [0.009999999776482582, 10]
+     */
+    setPitch(pitch: number): void;
+    /**
+     * @rc
+     * @remarks
+     * Sets the volume multiplier of this sound instance relative
+     * to the volume of the selected sound variant.
+     *
+     * @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
+     *
+     * @param volume
+     * Volume multiplier between 0.0 and 10.0. A value of 1.0 uses
+     * the selected sound variant's volume.
+     * Bounds: [0, 10]
+     */
+    setVolume(volume: number): void;
     /**
      * @remarks
      * Stops this sound instance from playing.
@@ -22478,7 +22539,6 @@ export class World {
      */
     readonly seed: string;
     /**
-     * @rc
      * @remarks
      * Provides read-only access to the sound definitions loaded
      * for this world.
@@ -23112,7 +23172,6 @@ export class WorldAfterEvents {
      */
     readonly entitySpawn: EntitySpawnAfterEventSignal;
     /**
-     * @rc
      * @remarks
      * This event fires when an entity starts sneaking.
      *
@@ -23121,7 +23180,6 @@ export class WorldAfterEvents {
      */
     readonly entityStartSneaking: EntityStartSneakingAfterEventSignal;
     /**
-     * @rc
      * @remarks
      * This event fires when an entity stops sneaking.
      *
@@ -23130,7 +23188,6 @@ export class WorldAfterEvents {
      */
     readonly entityStopSneaking: EntityStopSneakingAfterEventSignal;
     /**
-     * @rc
      * @remarks
      * This event fires when an entity is tamed.
      *
@@ -23420,7 +23477,6 @@ export class WorldAfterEvents {
      */
     readonly projectileHitEntity: ProjectileHitEntityAfterEventSignal;
     /**
-     * @rc
      * @remarks
      * A tracked sound's declared duration elapsed.
      *
@@ -23509,7 +23565,6 @@ export class WorldBeforeEvents {
      */
     readonly entityRemove: EntityRemoveBeforeEventSignal;
     /**
-     * @rc
      * @remarks
      * Fires before an entity is tamed.
      *
@@ -23926,7 +23981,6 @@ export interface BlockHitInformation {
 }
 
 /**
- * @rc
  * Options for querying blocks in a volume. Extends BlockFilter
  * with additional sorting and limiting options based on
  * distance from a location.
@@ -24130,7 +24184,6 @@ export interface CameraSetRotOptions {
 }
 
 /**
- * @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`;
@@ -25175,7 +25228,6 @@ export interface EntityRaycastOptions extends EntityFilter {
 }
 
 /**
- * @rc
  * Options used to filter entity start sneaking and stop
  * sneaking events.
  */
@@ -25184,7 +25236,6 @@ export interface EntitySneakingChangedEventOptions {
 }
 
 /**
- * @rc
  * Contains options for filtering entity tamed events.
  */
 export interface EntityTamedEventOptions {
@@ -25736,6 +25787,19 @@ 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`
+     * loops it forever, and a positive integer `N` plays the sound
+     * `N + 1` times in total. For example, `loopCount: 1` plays
+     * the sound twice. The loop count is fixed when the sound
+     * starts and cannot be changed afterward. When using `-1`, see
+     * `SoundInstance` for handle lifetime requirements.
+     *
+     */
+    loopCount?: number;
     /**
      * @remarks
      * Optional pitch of the sound.
@@ -25808,7 +25872,6 @@ export interface PlayerVisibilityRules extends EntityVisibilityRules {
 }
 
 /**
- * @rc
  * Contains optional filters that control which primitive
  * shapes are returned from a primitive shapes query.
  */
@@ -26166,7 +26229,6 @@ export interface ScriptEventMessageFilterOptions {
 }
 
 /**
- * @rc
  * Duration metadata declared in a sound definition.
  */
 export interface SoundDefinitionDurationInfo {
@@ -26180,7 +26242,6 @@ export interface SoundDefinitionDurationInfo {
 }
 
 /**
- * @rc
  * Criteria used to narrow a set of sound definitions. Each
  * field is optional and applies its constraint only when
  * defined; a definition must satisfy every defined field to
@@ -26259,7 +26320,6 @@ export interface SoundDefinitionFilter {
 }
 
 /**
- * @rc
  * Music metadata declared on a sound definition. Each field is
  * optional and is undefined when the sound definition does not
  * declare a value for it.
@@ -26727,10 +26787,20 @@ export interface WaypointTextureSelector {
  * Contains additional options for a playSound occurrence.
  */
 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`
+     * loops it forever, and a positive integer `N` plays the sound
+     * `N + 1` times in total. For example, `loopCount: 1` plays
+     * the sound twice. The loop count is fixed when the sound
+     * starts and cannot be changed afterward. When using `-1`, see
+     * `SoundInstance` for handle lifetime requirements.
+     *
      */
-    isBroadcast?: boolean;
+    loopCount?: number;
     /**
      * @remarks
      * Pitch of the sound played.
@@ -26921,7 +26991,6 @@ export class EntitySpawnError extends Error {
 }
 
 /**
- * @rc
  * Error thrown by {@link FogSettings} operations when the fog
  * stack limit is exceeded or an invalid fog identifier is
  * provided.

package/package.json

@@ -1,20 +1,20 @@
-{
-  "name": "@minecraft/server",
-  "version": "2.11.0-rc.1.26.60-preview.23",
-  "description": "",
-  "contributors": [
-    {
-      "name": "Jake Shirley",
-      "email": "jake@xbox.com"
-    },
-    {
-      "name": "Mike Ammerlaan",
-      "email": "mikeam@microsoft.com"
-    }
-  ],
-  "peerDependencies": {
-    "@minecraft/common": "^1.2.0",
-    "@minecraft/vanilla-data": ">=1.20.70 || 1.26.60-preview.23"
-  },
-  "license": "MIT"
+{
+  "name": "@minecraft/server",
+  "version": "2.11.0-rc.1.26.60-preview.28",
+  "description": "",
+  "contributors": [
+    {
+      "name": "Jake Shirley",
+      "email": "jake@xbox.com"
+    },
+    {
+      "name": "Mike Ammerlaan",
+      "email": "mikeam@microsoft.com"
+    }
+  ],
+  "peerDependencies": {
+    "@minecraft/common": "^1.2.0",
+    "@minecraft/vanilla-data": ">=1.20.70 || 1.26.60-preview.28"
+  },
+  "license": "MIT"
 }