@minecraft/server 2.12.0-beta.1.26.60-preview.23 → 2.12.0-beta.1.26.60-preview.25

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
@@ -206,7 +200,6 @@ export enum ButtonState {
 }
 
 /**
- * @rc
  * Represents the type of shake to apply to the camera.
  */
 export enum CameraShakeType {
@@ -225,7 +218,6 @@ export enum CameraShakeType {
 }
 
 /**
- * @rc
  * An enumeration for the clone modes used when cloning blocks.
  */
 export enum CloneMode {
@@ -2257,9 +2249,6 @@ export enum InputPermissionCategory {
  * function ItemStack.getComponent.
  */
 export enum ItemComponentTypes {
-    /**
-     * @rc
-     */
     BlockDynamicProperties = 'minecraft:block_actor_dynamic_properties',
     /**
      * @remarks
@@ -4441,6 +4430,15 @@ export class Block {
      * {@link LocationOutOfWorldBoundariesError}
      */
     hasComponent(componentId: string): boolean;
+    /**
+     * @beta
+     * @throws This function can throw errors.
+     *
+     * {@link LocationInUnloadedChunkError}
+     *
+     * {@link LocationOutOfWorldBoundariesError}
+     */
+    hasScheduledNamedTick(eventName: string): boolean;
     /**
      * @remarks
      * Checks to see if the permutation of this block has a
@@ -4581,6 +4579,47 @@ export class Block {
      * {@link LocationOutOfWorldBoundariesError}
      */
     offset(offset: Vector3): Block | undefined;
+    /**
+     * @beta
+     * @remarks
+     * Removes all scheduled named tick events from this block with
+     * the specified event name.
+     *
+     * @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
+     *
+     * @param eventName
+     * Name of the scheduled event to remove.
+     * @throws This function can throw errors.
+     *
+     * {@link LocationInUnloadedChunkError}
+     *
+     * {@link LocationOutOfWorldBoundariesError}
+     */
+    removeScheduledNamedTick(eventName: string): void;
+    /**
+     * @beta
+     * @remarks
+     * Schedules a named tick event for this block. The event will
+     * be delivered to block custom components registered with the
+     * `onNamedTick` callback after the specified delay.
+     *
+     * @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
+     *
+     * @param eventName
+     * Name of the event to schedule. Up to 31 characters.
+     * @param tickDelay
+     * Number of ticks to wait before the event is raised. Must be
+     * at least 1.
+     * Minimum value: 1
+     * @throws This function can throw errors.
+     *
+     * {@link Error}
+     *
+     * {@link LocationInUnloadedChunkError}
+     *
+     * {@link LocationOutOfWorldBoundariesError}
+     */
+    scheduleNamedTick(eventName: string, tickDelay: number): void;
     /**
      * @remarks
      * Sets the block in the dimension to the state of the
@@ -4924,6 +4963,30 @@ export class BlockComponentEntityFallOnEvent extends BlockEvent {
     readonly fallDistance: number;
 }
 
+/**
+ * @beta
+ * Contains information regarding a named tick event for a
+ * specific block.
+ */
+// @ts-ignore Class inheritance allowed for native defined classes
+export class BlockComponentNamedTickEvent extends BlockEvent {
+    private constructor();
+    /**
+     * @remarks
+     * Checks whether this named tick event has the specified name.
+     * Events are namespaced with their content UUID. Two named
+     * tick events with the same name but scheduled from different
+     * packs will not respond the same to this method.
+     *
+     * @param eventName
+     * The name to check against this event.
+     * @returns
+     * Returns true if the event name matches the specified name;
+     * otherwise, false.
+     */
+    isName(eventName: string): boolean;
+}
+
 /**
  * Contains information regarding a specific block that was
  * placed.
@@ -5239,7 +5302,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.
@@ -5479,7 +5541,6 @@ export class BlockFluidContainerComponent extends BlockComponent {
 }
 
 /**
- * @rc
  * Represents the instruments a block can have assigned to it's
  * up and down faces.
  */
@@ -6581,7 +6642,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
@@ -6597,7 +6657,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
@@ -6772,7 +6831,6 @@ export class Camera {
      */
     readonly isValid: boolean;
     /**
-     * @rc
      * @remarks
      * @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
      *
@@ -6889,7 +6947,6 @@ export class Camera {
      */
     setFov(fovCameraOptions?: CameraFovOptions): void;
     /**
-     * @rc
      * @remarks
      * @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
      *
@@ -8208,7 +8265,6 @@ export class Dimension {
         options?: BiomeSearchOptions,
     ): Vector3 | undefined;
     /**
-     * @rc
      * @remarks
      * Clones a region of blocks from one area of the dimension to
      * another.
@@ -8479,7 +8535,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 block query
      * options.
@@ -13665,7 +13720,6 @@ export class EntitySpawnAfterEventSignal {
 }
 
 /**
- * @rc
  * Contains data related to an entity beginning to sneak.
  */
 export class EntityStartSneakingAfterEvent {
@@ -13679,7 +13733,6 @@ export class EntityStartSneakingAfterEvent {
 }
 
 /**
- * @rc
  * Manages callbacks that are connected to when an entity
  * begins sneaking.
  */
@@ -13713,7 +13766,6 @@ export class EntityStartSneakingAfterEventSignal {
 }
 
 /**
- * @rc
  * Contains data related to an entity stopping sneaking.
  */
 export class EntityStopSneakingAfterEvent {
@@ -13727,7 +13779,6 @@ export class EntityStopSneakingAfterEvent {
 }
 
 /**
- * @rc
  * Manages callbacks that are connected to when an entity stops
  * sneaking.
  */
@@ -13848,7 +13899,6 @@ export class EntityTameableComponent extends EntityComponent {
 }
 
 /**
- * @rc
  * Contains data related to an entity being tamed.
  */
 export class EntityTamedAfterEvent {
@@ -13858,7 +13908,6 @@ export class EntityTamedAfterEvent {
 }
 
 /**
- * @rc
  * Manages callbacks that are connected to when an entity is
  * tamed.
  */
@@ -13886,7 +13935,6 @@ export class EntityTamedAfterEventSignal {
 }
 
 /**
- * @rc
  * Contains information regarding an event before an entity is
  * tamed.
  */
@@ -13913,7 +13961,6 @@ export class EntityTamedBeforeEvent {
 }
 
 /**
- * @rc
  * Manages callbacks that are connected to before an entity is
  * tamed.
  */
@@ -14464,7 +14511,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.
@@ -14946,7 +14992,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
@@ -18085,7 +18130,6 @@ export class Player extends Entity {
      */
     commandPermissionLevel: CommandPermissionLevel;
     /**
-     * @rc
      * @remarks
      * Contains methods for manipulating the render distance fog
      * settings of a Player.
@@ -21059,6 +21103,10 @@ export class PrimitiveShape {
      *
      */
     color: RGBA;
+    /**
+     * @beta
+     */
+    defaultVisibleToAll: boolean;
     /**
      * @remarks
      * The dimension the shape is visible within. If the dimension
@@ -21073,6 +21121,10 @@ export class PrimitiveShape {
      *
      */
     readonly hasDuration: boolean;
+    /**
+     * @beta
+     */
+    hiddenFrom: Player[];
     /**
      * @remarks
      * The location of the shape.
@@ -21168,7 +21220,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
@@ -22561,7 +22612,6 @@ export class SmeltItemFunction extends LootItemFunction {
 }
 
 /**
- * @rc
  * Contains information about a sound thats declared duration
  * elapsed.
  */
@@ -22578,7 +22628,6 @@ export class SoundCompletedAfterEvent {
 }
 
 /**
- * @rc
  * Manages callbacks that are invoked when a tracked sound's
  * declared duration elapses.
  */
@@ -22615,7 +22664,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.
@@ -22623,7 +22671,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.
@@ -22631,7 +22678,6 @@ export class SoundDefinition {
      */
     readonly musicInfo?: SoundDefinitionMusicInfo;
     /**
-     * @rc
      * @remarks
      * Identifier of the sound event this definition declares, in
      * the form 'namespace:name'.
@@ -22639,7 +22685,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
@@ -22652,7 +22697,6 @@ export class SoundDefinition {
 }
 
 /**
- * @rc
  * Provides read-only access to the sound definitions loaded
  * for the current world.
  */
@@ -22679,7 +22723,6 @@ export class SoundDefinitionRegistry {
 }
 
 /**
- * @rc
  * Provides duration and playback information for a sound whose
  * definition declares a duration.
  */
@@ -22723,28 +22766,24 @@ 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.
@@ -22752,7 +22791,7 @@ export class SoundInstance {
      */
     readonly soundEventId: string;
     /**
-     * @beta
+     * @rc
      * @remarks
      * Fades this sound instance from its current volume to the
      * target volume over the specified duration. To fade in from
@@ -22770,7 +22809,7 @@ export class SoundInstance {
      */
     fade(duration: number, targetVolume: number): void;
     /**
-     * @beta
+     * @rc
      * @remarks
      * Pauses this sound.
      *
@@ -22779,7 +22818,7 @@ export class SoundInstance {
      */
     pause(): void;
     /**
-     * @beta
+     * @rc
      * @remarks
      * Resumes this sound after a pause.
      *
@@ -22788,7 +22827,7 @@ export class SoundInstance {
      */
     resume(): void;
     /**
-     * @beta
+     * @rc
      * @remarks
      * Sets the playback position of this sound instance.
      *
@@ -22805,7 +22844,7 @@ export class SoundInstance {
      */
     seekTo(seconds: number): void;
     /**
-     * @beta
+     * @rc
      * @remarks
      * Sets the pitch of this sound instance.
      *
@@ -22818,7 +22857,7 @@ export class SoundInstance {
      */
     setPitch(pitch: number): void;
     /**
-     * @beta
+     * @rc
      * @remarks
      * Sets the volume of this sound instance.
      *
@@ -24359,7 +24398,6 @@ export class World {
      */
     readonly seed: string;
     /**
-     * @rc
      * @remarks
      * Provides read-only access to the sound definitions loaded
      * for this world.
@@ -25033,7 +25071,6 @@ export class WorldAfterEvents {
      */
     readonly entitySpawn: EntitySpawnAfterEventSignal;
     /**
-     * @rc
      * @remarks
      * This event fires when an entity starts sneaking.
      *
@@ -25042,7 +25079,6 @@ export class WorldAfterEvents {
      */
     readonly entityStartSneaking: EntityStartSneakingAfterEventSignal;
     /**
-     * @rc
      * @remarks
      * This event fires when an entity stops sneaking.
      *
@@ -25051,7 +25087,6 @@ export class WorldAfterEvents {
      */
     readonly entityStopSneaking: EntityStopSneakingAfterEventSignal;
     /**
-     * @rc
      * @remarks
      * This event fires when an entity is tamed.
      *
@@ -25379,7 +25414,6 @@ export class WorldAfterEvents {
      */
     readonly projectileHitEntity: ProjectileHitEntityAfterEventSignal;
     /**
-     * @rc
      * @remarks
      * A tracked sound's declared duration elapsed.
      *
@@ -25546,7 +25580,6 @@ export class WorldBeforeEvents {
      */
     readonly entityRemove: EntityRemoveBeforeEventSignal;
     /**
-     * @rc
      * @remarks
      * Fires before an entity is tamed.
      *
@@ -26246,6 +26279,10 @@ export interface BlockCustomComponent {
      *
      */
     onEntityFallOn?: (arg0: BlockComponentEntityFallOnEvent, arg1: CustomComponentParameters) => void;
+    /**
+     * @beta
+     */
+    onNamedTick?: (arg0: BlockComponentNamedTickEvent, arg1: CustomComponentParameters) => void;
     /**
      * @remarks
      * This function will be called when the block that this custom
@@ -26419,7 +26456,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.
@@ -26623,7 +26659,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`;
@@ -27685,7 +27720,6 @@ export interface EntityRaycastOptions extends EntityFilter {
 }
 
 /**
- * @rc
  * Options used to filter entity start sneaking and stop
  * sneaking events.
  */
@@ -27694,7 +27728,6 @@ export interface EntitySneakingChangedEventOptions {
 }
 
 /**
- * @rc
  * Contains options for filtering entity tamed events.
  */
 export interface EntityTamedEventOptions {
@@ -28272,7 +28305,7 @@ export interface PlayerSoundOptions {
      */
     location?: Vector3;
     /**
-     * @beta
+     * @rc
      * @remarks
      * Number of additional times to repeat the sound after the
      * initial play. `0` (the default) plays the sound once, `-1`
@@ -28406,7 +28439,6 @@ export interface PoiTagFilter {
 }
 
 /**
- * @rc
  * Contains optional filters that control which primitive
  * shapes are returned from a primitive shapes query.
  */
@@ -28764,7 +28796,6 @@ export interface ScriptEventMessageFilterOptions {
 }
 
 /**
- * @rc
  * Duration metadata declared in a sound definition.
  */
 export interface SoundDefinitionDurationInfo {
@@ -28778,7 +28809,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
@@ -28857,7 +28887,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.
@@ -29407,12 +29436,9 @@ export interface WorldClockTimeMarkerEventOptions {
  * Contains additional options for a playSound occurrence.
  */
 export interface WorldSoundOptions {
-    /**
-     * @rc
-     */
     isBroadcast?: boolean;
     /**
-     * @beta
+     * @rc
      * @remarks
      * Number of additional times to repeat the sound after the
      * initial play. `0` (the default) plays the sound once, `-1`
@@ -29614,7 +29640,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,6 +1,6 @@
 {
   "name": "@minecraft/server",
-  "version": "2.12.0-beta.1.26.60-preview.23",
+  "version": "2.12.0-beta.1.26.60-preview.25",
   "description": "",
   "contributors": [
     {
@@ -14,7 +14,7 @@
   ],
   "peerDependencies": {
     "@minecraft/common": "^1.2.0",
-    "@minecraft/vanilla-data": ">=1.20.70 || 1.26.60-preview.23"
+    "@minecraft/vanilla-data": ">=1.20.70 || 1.26.60-preview.25"
   },
   "license": "MIT"
 }