@minecraft/server 2.13.0-beta.1.26.70-preview.21 → 2.13.0-beta.1.26.70-preview.22

package/index.d.ts

@@ -1,7 +1,7 @@
 // Type definitions for Minecraft Bedrock Edition script APIs
-// Project: https://docs.microsoft.com/minecraft/creator/
+// Project: https://learn.microsoft.com/minecraft/creator/
 // Definitions by: Jake Shirley <https://github.com/JakeShirley>
-//                 Mike Ammerlaan <https://github.com/mammerla>
+//                 Raphael Landaverde <https://github.com/rlandav>
 
 /* *****************************************************************************
    Copyright (c) Microsoft Corporation.
@@ -61,6 +61,14 @@ export enum BlockComponentTypes {
      *
      */
     Inventory = 'minecraft:inventory',
+    /**
+     * @beta
+     * @remarks
+     * Represents an item frame block and provides access to the
+     * item displayed in the frame.
+     *
+     */
+    ItemFrame = 'minecraft:item_frame',
     /**
      * @remarks
      * Represents the color of a block when displayed on a map.
@@ -2309,6 +2317,62 @@ export enum ItemComponentTypes {
     Potion = 'minecraft:potion',
 }
 
+/**
+ * @beta
+ * Specifies the rotation of the item displayed in an item
+ * frame.
+ */
+export enum ItemFrameRotation {
+    /**
+     * @remarks
+     * The displayed item is rotated 135 degrees clockwise.
+     *
+     */
+    Clockwise135 = 'Clockwise135',
+    /**
+     * @remarks
+     * The displayed item is rotated 180 degrees clockwise.
+     *
+     */
+    Clockwise180 = 'Clockwise180',
+    /**
+     * @remarks
+     * The displayed item is rotated 225 degrees clockwise.
+     *
+     */
+    Clockwise225 = 'Clockwise225',
+    /**
+     * @remarks
+     * The displayed item is rotated 270 degrees clockwise.
+     *
+     */
+    Clockwise270 = 'Clockwise270',
+    /**
+     * @remarks
+     * The displayed item is rotated 315 degrees clockwise.
+     *
+     */
+    Clockwise315 = 'Clockwise315',
+    /**
+     * @remarks
+     * The displayed item is rotated 45 degrees clockwise.
+     *
+     */
+    Clockwise45 = 'Clockwise45',
+    /**
+     * @remarks
+     * The displayed item is rotated 90 degrees clockwise.
+     *
+     */
+    Clockwise90 = 'Clockwise90',
+    /**
+     * @remarks
+     * The displayed item has no additional rotation.
+     *
+     */
+    None = 'None',
+}
+
 /**
  * Describes how an an item can be moved within a container.
  */
@@ -3219,12 +3283,14 @@ export type BlockComponentTypeMap = {
     fluid_container: BlockFluidContainerComponent;
     instrument_sound: BlockInstrumentComponent;
     inventory: BlockInventoryComponent;
+    item_frame: BlockItemFrameComponent;
     map_color: BlockMapColorComponent;
     'minecraft:dynamic_properties': BlockDynamicPropertiesComponent;
     'minecraft:entity_storage': BlockEntityStorageComponent;
     'minecraft:fluid_container': BlockFluidContainerComponent;
     'minecraft:instrument_sound': BlockInstrumentComponent;
     'minecraft:inventory': BlockInventoryComponent;
+    'minecraft:item_frame': BlockItemFrameComponent;
     'minecraft:map_color': BlockMapColorComponent;
     'minecraft:movable': BlockMovableComponent;
     'minecraft:piston': BlockPistonComponent;
@@ -5927,6 +5993,79 @@ export class BlockInventoryComponent extends BlockComponent {
     static readonly componentId = 'minecraft:inventory';
 }
 
+/**
+ * @beta
+ * Represents the frame holding an item of a block in the
+ * world. You can replace the item, remove it, drop it into the
+ * world, or get and set its rotation.
+ */
+// @ts-ignore Class inheritance allowed for native defined classes
+export class BlockItemFrameComponent extends BlockComponent {
+    private constructor();
+    static readonly componentId = 'minecraft:item_frame';
+    /**
+     * @remarks
+     * Removes the framed item and drops it into the world.
+     *
+     * @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
+     *
+     * @throws This function can throw errors.
+     *
+     * {@link InvalidBlockComponentError}
+     */
+    dropFramedItem(): void;
+    /**
+     * @remarks
+     * Gets the item stack currently displayed in the frame.
+     *
+     * @returns
+     * The framed item stack, or undefined if the frame is empty.
+     * @throws This function can throw errors.
+     *
+     * {@link InvalidBlockComponentError}
+     */
+    getFramedItem(): ItemStack | undefined;
+    /**
+     * @remarks
+     * Gets the current rotation of the item frame.
+     *
+     * @returns
+     * The current {@link ItemFrameRotation} of the item frame.
+     * @throws This function can throw errors.
+     *
+     * {@link InvalidBlockComponentError}
+     */
+    getRotation(): ItemFrameRotation;
+    /**
+     * @remarks
+     * Sets or replaces the item displayed in the frame. Pass
+     * undefined to remove the item without dropping it.
+     *
+     * @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
+     *
+     * @param itemStack
+     * The item stack to display in the frame, or undefined to
+     * clear it without dropping it.
+     * @throws This function can throw errors.
+     *
+     * {@link InvalidBlockComponentError}
+     */
+    setFramedItem(itemStack?: ItemStack): void;
+    /**
+     * @remarks
+     * Sets the rotation of the item frame.
+     *
+     * @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
+     *
+     * @param rotation
+     * The {@link ItemFrameRotation} to apply to the item frame.
+     * @throws This function can throw errors.
+     *
+     * {@link InvalidBlockComponentError}
+     */
+    setRotation(rotation: ItemFrameRotation): void;
+}
+
 /**
  * A BlockLocationIterator returns the next block location of
  * the block volume across which it is iterating.
@@ -9559,7 +9698,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.
@@ -12749,7 +12887,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.
@@ -12760,7 +12897,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.
@@ -23616,7 +23752,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
@@ -23636,7 +23771,6 @@ export class SoundInstance {
      */
     fade(duration: number, targetVolume: number): void;
     /**
-     * @rc
      * @remarks
      * Pauses this sound.
      *
@@ -23645,7 +23779,6 @@ export class SoundInstance {
      */
     pause(): void;
     /**
-     * @rc
      * @remarks
      * Resumes this sound after a pause.
      *
@@ -23654,7 +23787,6 @@ export class SoundInstance {
      */
     resume(): void;
     /**
-     * @rc
      * @remarks
      * Sets the playback position of this sound instance.
      *
@@ -23671,7 +23803,6 @@ export class SoundInstance {
      */
     seekTo(seconds: number): void;
     /**
-     * @rc
      * @remarks
      * Sets the pitch of this sound instance.
      *
@@ -23684,7 +23815,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.
@@ -23770,7 +23900,6 @@ export class StartupEvent {
      */
     readonly itemComponentRegistry: ItemComponentRegistry;
     /**
-     * @rc
      * @remarks
      * @privilege early-execution-readable - This property can be read in early-execution mode.
      *
@@ -24549,7 +24678,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.
@@ -24697,7 +24825,6 @@ export class TickingAreaManager {
 }
 
 /**
- * @rc
  * A named point in time on a world clock that can occur once
  * or periodically.
  */
@@ -25292,7 +25419,6 @@ export class World {
      */
     getAllPlayers(): Player[];
     /**
-     * @rc
      * @remarks
      * Retrieves a world clock by its name.
      *
@@ -26298,7 +26424,6 @@ export class WorldAfterEvents {
      */
     readonly weatherChange: WeatherChangeAfterEventSignal;
     /**
-     * @rc
      * @remarks
      * This event fires when a {@link WorldClock} is paused.
      *
@@ -26307,7 +26432,6 @@ export class WorldAfterEvents {
      */
     readonly worldClockOnPaused: WorldClockOnPausedAfterEventSignal;
     /**
-     * @rc
      * @remarks
      * This event fires when a {@link WorldClock} is resumed.
      *
@@ -26316,7 +26440,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
@@ -26327,7 +26450,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
@@ -26516,7 +26638,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.
@@ -26528,7 +26649,6 @@ export class WorldBeforeEvents {
 }
 
 /**
- * @rc
  * A class that represents a particular clock within a world.
  */
 export class WorldClock {
@@ -26655,7 +26775,6 @@ export class WorldClock {
 }
 
 /**
- * @rc
  * Contains information related to a {@link WorldClock} being
  * paused.
  */
@@ -26670,7 +26789,6 @@ export class WorldClockOnPausedAfterEvent {
 }
 
 /**
- * @rc
  * Manages callbacks that are connected to a {@link WorldClock}
  * being paused.
  */
@@ -26704,7 +26822,6 @@ export class WorldClockOnPausedAfterEventSignal {
 }
 
 /**
- * @rc
  * Contains information related to a {@link WorldClock}
  * restarting.
  */
@@ -26735,7 +26852,6 @@ export class WorldClockOnRestartBeforeEvent {
 }
 
 /**
- * @rc
  * Manages callbacks that are connected to a {@link WorldClock}
  * restarting.
  */
@@ -26775,7 +26891,6 @@ export class WorldClockOnRestartBeforeEventSignal {
 }
 
 /**
- * @rc
  * Contains information related to a {@link WorldClock} being
  * resumed.
  */
@@ -26790,7 +26905,6 @@ export class WorldClockOnResumedAfterEvent {
 }
 
 /**
- * @rc
  * Manages callbacks that are connected to a {@link WorldClock}
  * being resumed.
  */
@@ -26824,7 +26938,6 @@ export class WorldClockOnResumedAfterEventSignal {
 }
 
 /**
- * @rc
  * Contains information related to when the time of a
  * {@link WorldClock} hits a {@link TimeMarker}.
  */
@@ -26845,7 +26958,6 @@ export class WorldClockOnTimeMarkerAfterEvent {
 }
 
 /**
- * @rc
  * Manages callbacks that are connected to when the time of a
  * {@link WorldClock} hits a {@link TimeMarker}.
  */
@@ -26879,7 +26991,6 @@ export class WorldClockOnTimeMarkerAfterEventSignal {
 }
 
 /**
- * @rc
  * Contains information related to changes to the time of a
  * {@link WorldClock}.
  */
@@ -26894,7 +27005,6 @@ export class WorldClockOnTimeModifiedAfterEvent {
 }
 
 /**
- * @rc
  * Manages callbacks that are connected to changes to the time
  * of a {@link WorldClock}.
  */
@@ -26928,7 +27038,6 @@ export class WorldClockOnTimeModifiedAfterEventSignal {
 }
 
 /**
- * @rc
  * Provides the functionality for registering custom world
  * clocks. World clocks can only be registered during the
  * system startup event.
@@ -29243,7 +29352,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`
@@ -30160,7 +30268,6 @@ export interface TickingAreaOptions {
 }
 
 /**
- * @rc
  * Options for creating time markers for world clocks.
  */
 export interface TimeMarkerOptions {
@@ -30328,7 +30435,6 @@ export interface WaypointTextureSelector {
 }
 
 /**
- * @rc
  * Contains parameters for world clock events that filters out
  * which events are passed to the provided callback.
  */
@@ -30342,7 +30448,6 @@ export interface WorldClockEventOptions {
 }
 
 /**
- * @rc
  * Contains additional options for registering world clocks.
  */
 export interface WorldClockRegistrationOptions {
@@ -30356,7 +30461,6 @@ export interface WorldClockRegistrationOptions {
 }
 
 /**
- * @rc
  * Contains parameters for world clock time marker events that
  * filters out which events are passed to the provided
  * callback.
@@ -30384,7 +30488,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`
@@ -30861,7 +30964,6 @@ export class UnloadedChunksError extends Error {
 }
 
 /**
- * @rc
  * Error thrown by {@link WorldClock.addTimeMarker} when
  * failing to add a time marker to a world clock.
  */
@@ -30871,7 +30973,6 @@ export class WorldClockAddTimeMarkerError extends Error {
 }
 
 /**
- * @rc
  * Thrown when trying to register a world clock outside of the
  * system startup event.
  */
@@ -30881,7 +30982,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.
@@ -30892,7 +30992,6 @@ export class WorldClockInvalidTimeMarkerError extends Error {
 }
 
 /**
- * @rc
  * Error thrown when a world clock is not found in the world
  * clock registry.
  */
@@ -30902,7 +31001,6 @@ export class WorldClockNotFoundError extends Error {
 }
 
 /**
- * @rc
  * Error thrown by {@link WorldClockRegistry.registerClock}
  * when failing to register a world clock.
  */
@@ -30912,7 +31010,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.
@@ -30923,7 +31020,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.
@@ -30934,7 +31030,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.
@@ -30945,7 +31040,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.
@@ -30956,7 +31050,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.13.0-beta.1.26.70-preview.21",
+  "version": "2.13.0-beta.1.26.70-preview.22",
   "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 || 1.26.70-preview.22"
   },
   "license": "MIT"
 }