@minecraft/server 1.7.0-rc.1.20.60-preview.20 → 1.7.0

package/index.d.ts

@@ -15,7 +15,7 @@
  * ```json
  * {
  *   "module_name": "@minecraft/server",
- *   "version": "1.6.0"
+ *   "version": "1.7.0"
  * }
  * ```
  *
@@ -347,11 +347,16 @@ export enum EntityInitializationCause {
     Born = 'Born',
     /**
      * @remarks
-     * Case when an entity is created by an event, e.g., Wandering
-     * trader spawning llamas.
+     * Case when an entity is created by an event, e.g., a
+     * Wandering trader spawning llamas.
      *
      */
     Event = 'Event',
+    /**
+     * @remarks
+     * Case when an entity is loaded into the world.
+     *
+     */
     Loaded = 'Loaded',
     /**
      * @remarks
@@ -636,11 +641,47 @@ export enum ScriptEventSource {
  * day.
  */
 export enum TimeOfDay {
+    /**
+     * @remarks
+     * Sets the time to the start of the day, which is time of the
+     * day 1,000 (or the equivalent of 7am) in Minecraft.
+     *
+     */
     Day = 1000,
+    /**
+     * @remarks
+     * Sets the time to noon, which is time of the day 6,000 in
+     * Minecraft.
+     *
+     */
     Noon = 6000,
+    /**
+     * @remarks
+     * Sets the time to sunset, which is time of the day 12,000 (or
+     * the equivalent of 6pm) in Minecraft.
+     *
+     */
     Sunset = 12000,
+    /**
+     * @remarks
+     * Sets the time to night, which is time of the day 13,000 (or
+     * the equivalent of 7:00pm) in Minecraft.
+     *
+     */
     Night = 13000,
+    /**
+     * @remarks
+     * Sets the time to midnight, which is time of the day 18,000
+     * (or the equivalent of 12:00am) in Minecraft.
+     *
+     */
     Midnight = 18000,
+    /**
+     * @remarks
+     * Sets the time to sunrise, which is time of the day 23,000
+     * (or the equivalent of 5am) in Minecraft.
+     *
+     */
     Sunrise = 23000,
 }
 
@@ -747,7 +788,6 @@ export class Block {
      */
     readonly z: number;
     /**
-     * @beta
      * @remarks
      * Returns the {@link Block} above this block (positive in the
      * Y direction).
@@ -762,7 +802,6 @@ export class Block {
      */
     above(steps?: number): Block | undefined;
     /**
-     * @beta
      * @remarks
      * Returns the {@link Block} below this block (negative in the
      * Y direction).
@@ -777,7 +816,6 @@ export class Block {
      */
     below(steps?: number): Block | undefined;
     /**
-     * @beta
      * @remarks
      * Returns the {@link @minecraft/server.Location} of the center
      * of this block on the X and Z axis.
@@ -785,7 +823,6 @@ export class Block {
      */
     bottomCenter(): Vector3;
     /**
-     * @beta
      * @remarks
      * Returns the {@link @minecraft/server.Location} of the center
      * of this block on the X, Y, and Z axis.
@@ -793,7 +830,6 @@ export class Block {
      */
     center(): Vector3;
     /**
-     * @beta
      * @remarks
      * Returns the {@link Block} to the east of this block
      * (positive in the X direction).
@@ -839,7 +875,6 @@ export class Block {
      */
     isValid(): boolean;
     /**
-     * @beta
      * @remarks
      * Returns the {@link Block} to the north of this block
      * (negative in the Z direction).
@@ -854,7 +889,16 @@ export class Block {
      */
     north(steps?: number): Block | undefined;
     /**
-     * @beta
+     * @remarks
+     * Returns a block at an offset relative vector to this block.
+     *
+     * @param offset
+     * The offset vector. For example, an offset of 0, 1, 0 will
+     * return the block above the current block.
+     * @returns
+     * Block at the specified offset, or undefined if that block
+     * could not be retrieved (for example, the block and its
+     * relative chunk is not loaded yet.)
      * @throws This function can throw errors.
      *
      * {@link LocationInUnloadedChunkError}
@@ -880,7 +924,6 @@ export class Block {
      */
     setPermutation(permutation: BlockPermutation): void;
     /**
-     * @beta
      * @remarks
      * Returns the {@link Block} to the south of this block
      * (positive in the Z direction).
@@ -895,7 +938,6 @@ export class Block {
      */
     south(steps?: number): Block | undefined;
     /**
-     * @beta
      * @remarks
      * Returns the {@link Block} to the west of this block
      * (negative in the X direction).
@@ -1326,67 +1368,6 @@ export class Container {
     transferItem(fromSlot: number, toContainer: Container): ItemStack | undefined;
 }
 
-/**
- * @beta
- * Contains information related to firing of a data driven
- * entity event - for example, the minecraft:ageable_grow_up
- * event on a chicken.
- */
-export class DataDrivenEntityTriggerAfterEvent {
-    private constructor();
-    /**
-     * @remarks
-     * Entity that the event triggered on.
-     *
-     */
-    readonly entity: Entity;
-    /**
-     * @remarks
-     * Name of the data driven event being triggered.
-     *
-     */
-    readonly eventId: string;
-    /**
-     * @remarks
-     * An updateable list of modifications to component state that
-     * are the effect of this triggered event.
-     *
-     */
-    getModifiers(): DefinitionModifier[];
-}
-
-/**
- * @beta
- * Contains event registration related to firing of a data
- * driven entity event - for example, the
- * minecraft:ageable_grow_up event on a chicken.
- */
-export class DataDrivenEntityTriggerAfterEventSignal {
-    private constructor();
-    /**
-     * @remarks
-     * Adds a callback that will be called after a data driven
-     * entity event is triggered.
-     *
-     * This function can't be called in read-only mode.
-     *
-     */
-    subscribe(
-        callback: (arg: DataDrivenEntityTriggerAfterEvent) => void,
-        options?: EntityDataDrivenTriggerEventOptions,
-    ): (arg: DataDrivenEntityTriggerAfterEvent) => void;
-    /**
-     * @remarks
-     * Removes a callback that will be called after a data driven
-     * entity event is triggered.
-     *
-     * This function can't be called in read-only mode.
-     *
-     * @throws This function can throw errors.
-     */
-    unsubscribe(callback: (arg: DataDrivenEntityTriggerAfterEvent) => void): void;
-}
-
 /**
  * A class that represents a particular dimension (e.g., The
  * End) within a world.
@@ -1394,7 +1375,6 @@ export class DataDrivenEntityTriggerAfterEventSignal {
 export class Dimension {
     private constructor();
     /**
-     * @beta
      * @remarks
      * Height range of the dimension.
      *
@@ -2110,7 +2090,10 @@ export class Entity {
      */
     applyKnockback(directionX: number, directionZ: number, horizontalStrength: number, verticalStrength: number): void;
     /**
-     * @beta
+     * @remarks
+     * Clears all dynamic properties that have been set on this
+     * entity.
+     *
      * @throws This function can throw errors.
      */
     clearDynamicProperties(): void;
@@ -2172,7 +2155,6 @@ export class Entity {
      */
     getComponents(): EntityComponent[];
     /**
-     * @beta
      * @remarks
      * Returns a property value.
      *
@@ -2185,12 +2167,24 @@ export class Entity {
      */
     getDynamicProperty(identifier: string): boolean | number | string | Vector3 | undefined;
     /**
-     * @beta
+     * @remarks
+     * Returns the available set of dynamic property identifiers
+     * that have been used on this entity.
+     *
+     * @returns
+     * A string array of the dynamic properties set on this entity.
      * @throws This function can throw errors.
      */
     getDynamicPropertyIds(): string[];
     /**
-     * @beta
+     * @remarks
+     * Returns the total size, in bytes, of all the dynamic
+     * properties that are currently stored for this entity.  This
+     * can be useful for diagnosing performance warning signs - if,
+     * for example, an entity has many megabytes of associated
+     * dynamic properties, it may be slow to load on various
+     * devices.
+     *
      * @throws This function can throw errors.
      */
     getDynamicPropertyTotalByteCount(): number;
@@ -2371,7 +2365,6 @@ export class Entity {
      */
     kill(): boolean;
     /**
-     * @beta
      * @remarks
      * Matches the entity against the passed in options. Uses the
      * location of the entity for matching if the location is not
@@ -2384,7 +2377,6 @@ export class Entity {
      */
     matches(options: EntityQueryOptions): boolean;
     /**
-     * @beta
      * @remarks
      * Immediately removes the entity from the world. The removed
      * entity will not perform a death animation or drop loot upon
@@ -2481,7 +2473,6 @@ export class Entity {
      */
     runCommandAsync(commandString: string): Promise<CommandResult>;
     /**
-     * @beta
      * @remarks
      * Sets a specified property to a value.
      *
@@ -3778,115 +3769,6 @@ export class EntityWantsJockeyComponent extends EntityComponent {
     static readonly componentId = 'minecraft:wants_jockey';
 }
 
-/**
- * @beta
- * Contains information regarding an explosion that has
- * happened.
- */
-export class ExplosionAfterEvent {
-    private constructor();
-    /**
-     * @remarks
-     * Dimension where the explosion has occurred.
-     *
-     */
-    readonly dimension: Dimension;
-    /**
-     * @remarks
-     * Optional source of the explosion.
-     *
-     */
-    readonly source?: Entity;
-    /**
-     * @remarks
-     * A collection of blocks impacted by this explosion event.
-     *
-     */
-    getImpactedBlocks(): Block[];
-}
-
-/**
- * @beta
- * Manages callbacks that are connected to when an explosion
- * occurs.
- */
-export class ExplosionAfterEventSignal {
-    private constructor();
-    /**
-     * @remarks
-     * Adds a callback that will be called when an explosion
-     * occurs.
-     *
-     * This function can't be called in read-only mode.
-     *
-     */
-    subscribe(callback: (arg: ExplosionAfterEvent) => void): (arg: ExplosionAfterEvent) => void;
-    /**
-     * @remarks
-     * Removes a callback from being called when an explosion
-     * occurs.
-     *
-     * This function can't be called in read-only mode.
-     *
-     * @throws This function can throw errors.
-     */
-    unsubscribe(callback: (arg: ExplosionAfterEvent) => void): void;
-}
-
-/**
- * @beta
- * Contains information regarding an explosion that has
- * happened.
- */
-// @ts-ignore Class inheritance allowed for native defined classes
-export class ExplosionBeforeEvent extends ExplosionAfterEvent {
-    private constructor();
-    /**
-     * @remarks
-     * If set to true, cancels the explosion event.
-     *
-     */
-    cancel: boolean;
-    /**
-     * @remarks
-     * Updates a collection of blocks impacted by this explosion
-     * event.
-     *
-     * @param blocks
-     * New list of blocks that are impacted by this explosion.
-     */
-    setImpactedBlocks(blocks: Block[]): void;
-}
-
-/**
- * @beta
- * Manages callbacks that are connected to before an explosion
- * occurs.
- */
-export class ExplosionBeforeEventSignal {
-    private constructor();
-    /**
-     * @remarks
-     * Adds a callback that will be called when before an explosion
-     * occurs. The callback can optionally change or cancel
-     * explosion behavior.
-     *
-     * This function can't be called in read-only mode.
-     *
-     */
-    subscribe(callback: (arg: ExplosionBeforeEvent) => void): (arg: ExplosionBeforeEvent) => void;
-    /**
-     * @remarks
-     * Removes a callback from being called from before when an
-     * explosion would occur.
-     *
-     * This function can't be called in read-only mode.
-     *
-     * @throws This function can throw errors.
-     */
-    unsubscribe(callback: (arg: ExplosionBeforeEvent) => void): void;
-}
-
 /**
  * As part of the Healable component, represents a specific
  * item that can be fed to an entity to cause health effects.
@@ -4153,7 +4035,7 @@ export class ItemReleaseUseAfterEvent {
      * Returns the item stack that triggered this item event.
      *
      */
-    readonly itemStack?: ItemStack;
+    readonly itemStack: ItemStack;
     /**
      * @remarks
      * Returns the source entity that triggered this item event.
@@ -5490,7 +5372,6 @@ export class PlayerDimensionChangeAfterEventSignal {
 }
 
 /**
- * @beta
  * Contains information regarding an event after a player
  * interacts with a block.
  */
@@ -5531,7 +5412,6 @@ export class PlayerInteractWithBlockAfterEvent {
 }
 
 /**
- * @beta
  * Manages callbacks that are connected to after a player
  * interacts with a block.
  */
@@ -5561,7 +5441,6 @@ export class PlayerInteractWithBlockAfterEventSignal {
 }
 
 /**
- * @beta
  * Contains information regarding an event before a player
  * interacts with a block.
  */
@@ -5608,7 +5487,6 @@ export class PlayerInteractWithBlockBeforeEvent {
 }
 
 /**
- * @beta
  * Manages callbacks that are connected to before a player
  * interacts with a block.
  */
@@ -5638,7 +5516,6 @@ export class PlayerInteractWithBlockBeforeEventSignal {
 }
 
 /**
- * @beta
  * Contains information regarding an event after a player
  * interacts with an entity.
  */
@@ -5666,7 +5543,6 @@ export class PlayerInteractWithEntityAfterEvent {
 }
 
 /**
- * @beta
  * Manages callbacks that are connected to after a player
  * interacts with an entity.
  */
@@ -5696,7 +5572,6 @@ export class PlayerInteractWithEntityAfterEventSignal {
 }
 
 /**
- * @beta
  * Contains information regarding an event before a player
  * interacts with an entity.
  */
@@ -5730,7 +5605,6 @@ export class PlayerInteractWithEntityBeforeEvent {
 }
 
 /**
- * @beta
  * Manages callbacks that are connected to before a player
  * interacts with an entity.
  */
@@ -5820,17 +5694,11 @@ export class PlayerLeaveAfterEventSignal extends IPlayerLeaveAfterEventSignal {
     private constructor();
 }
 
-/**
- * @beta
- */
 export class PlayerLeaveBeforeEvent {
     private constructor();
     readonly player: Player;
 }
 
-/**
- * @beta
- */
 export class PlayerLeaveBeforeEventSignal {
     private constructor();
     /**
@@ -6824,7 +6692,10 @@ export class World {
      */
     readonly scoreboard: Scoreboard;
     /**
-     * @beta
+     * @remarks
+     * Clears the set of dynamic properties declared for this
+     * behavior pack within the world.
+     *
      */
     clearDynamicProperties(): void;
     /**
@@ -6873,7 +6744,6 @@ export class World {
      */
     getDimension(dimensionId: string): Dimension;
     /**
-     * @beta
      * @remarks
      * Returns a property value.
      *
@@ -6940,15 +6810,23 @@ export class World {
      */
     getDynamicProperty(identifier: string): boolean | number | string | Vector3 | undefined;
     /**
-     * @beta
+     * @remarks
+     * Gets a set of dynamic property identifiers that have been
+     * set in this world.
+     *
+     * @returns
+     * A string array of active dynamic property identifiers.
      */
     getDynamicPropertyIds(): string[];
     /**
-     * @beta
+     * @remarks
+     * Gets the total byte count of dynamic properties. This could
+     * potentially be used for your own analytics to ensure you're
+     * not storing gigantic sets of dynamic properties.
+     *
      */
     getDynamicPropertyTotalByteCount(): number;
     /**
-     * @beta
      * @remarks
      * Returns an entity based on the provided id.
      *
@@ -7141,7 +7019,6 @@ export class World {
      */
     setDefaultSpawnLocation(spawnLocation: Vector3): void;
     /**
-     * @beta
      * @remarks
      * Sets a specified property to a value.
      *
@@ -7241,15 +7118,6 @@ export class WorldAfterEvents {
      *
      */
     readonly buttonPush: ButtonPushAfterEventSignal;
-    /**
-     * @beta
-     * @remarks
-     * This event is fired when an entity event has been triggered
-     * that will update the component definition state of an
-     * entity.
-     *
-     */
-    readonly dataDrivenEntityTriggerEvent: DataDrivenEntityTriggerAfterEventSignal;
     /**
      * @remarks
      * This event fires when an entity dies.
@@ -7481,7 +7349,9 @@ export class WorldBeforeEvents {
      */
     readonly playerBreakBlock: PlayerBreakBlockBeforeEventSignal;
     /**
-     * @beta
+     * @remarks
+     * Fires when a player leaves the game.
+     *
      */
     readonly playerLeave: PlayerLeaveBeforeEventSignal;
 }
@@ -7584,6 +7454,11 @@ export interface BlockRaycastOptions {
 }
 
 export interface CameraDefaultOptions {
+    /**
+     * @remarks
+     * Sets a set of easing options for the camera.
+     *
+     */
     easeOptions: CameraEaseOptions;
 }
 
@@ -7670,28 +7545,6 @@ export interface CameraSetRotOptions {
     rotation: Vector2;
 }
 
-/**
- * @beta
- * Contains a set of updates to the component definition state
- * of an entity.
- */
-export interface DefinitionModifier {
-    /**
-     * @remarks
-     * Retrieves the list of component groups that will be added
-     * via this definition modification.
-     *
-     */
-    addedComponentGroups: string[];
-    /**
-     * @remarks
-     * The list of component groups that will be removed via this
-     * definition modification.
-     *
-     */
-    removedComponentGroups: string[];
-}
-
 /**
  * An exact coordinate within the world, including its
  * dimension and location.
@@ -7785,36 +7638,6 @@ export interface EntityDamageSource {
     damagingProjectile?: Entity;
 }
 
-/**
- * @beta
- * Specifies additional filters that are used in registering a
- * data driven trigger event for entities.
- */
-export interface EntityDataDrivenTriggerEventOptions {
-    /**
-     * @remarks
-     * If this value is set, this event will only fire for entities
-     * that match the entities within this collection.
-     *
-     */
-    entities?: Entity[];
-    /**
-     * @remarks
-     * If this value is set, this event will only fire if the
-     * impacted entities' type matches this parameter.
-     *
-     */
-    entityTypes?: string[];
-    /**
-     * @remarks
-     * If this value is set, this event will only fire if the
-     * impacted triggered event matches one of the events listed in
-     * this parameter.
-     *
-     */
-    eventTypes?: string[];
-}
-
 /**
  * Contains additional options for entity effects.
  */
@@ -8457,7 +8280,6 @@ export class LocationOutOfWorldBoundariesError extends Error {
  */
 export const MoonPhaseCount = 8;
 /**
- * @beta
  * @remarks
  * How many times the server ticks per second of real time.
  *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@minecraft/server",
-  "version": "1.7.0-rc.1.20.60-preview.20",
+  "version": "1.7.0",
   "description": "",
   "contributors": [
     {
@@ -13,7 +13,7 @@
     }
   ],
   "dependencies": {
-    "@minecraft/common": "^1.1.0-rc.1.20.60-preview.20"
+    "@minecraft/common": "^1.1.0"
   },
   "license": "MIT"
 }