@minecraft/server 1.8.0-beta.1.20.50-preview.24 → 1.8.0-beta.1.20.50-stable

package/index.d.ts

@@ -15,7 +15,7 @@
  * ```json
  * {
  *   "module_name": "@minecraft/server",
- *   "version": "1.6.0"
+ *   "version": "1.7.0"
  * }
  * ```
  *
@@ -119,11 +119,37 @@ export enum CompoundBlockVolumePositionRelativity {
 
 /**
  * @beta
+ * An enumeration for the various difficulty levels of
+ * Minecraft.
  */
 export enum Difficulty {
+    /**
+     * @beta
+     * @remarks
+     * Peaceful difficulty level.
+     *
+     */
     Peaceful = 0,
+    /**
+     * @beta
+     * @remarks
+     * Easy difficulty level.
+     *
+     */
     Easy = 1,
+    /**
+     * @beta
+     * @remarks
+     * Normal difficulty level.
+     *
+     */
     Normal = 2,
+    /**
+     * @beta
+     * @remarks
+     * Hard difficulty level.
+     *
+     */
     Hard = 3,
 }
 
@@ -640,11 +666,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
@@ -1021,11 +1052,47 @@ export enum SignSide {
  * 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,
 }
 
@@ -1370,7 +1437,6 @@ export class Block {
      */
     readonly z: number;
     /**
-     * @beta
      * @remarks
      * Returns the {@link Block} above this block (positive in the
      * Y direction).
@@ -1385,7 +1451,6 @@ export class Block {
      */
     above(steps?: number): Block | undefined;
     /**
-     * @beta
      * @remarks
      * Returns the {@link Block} below this block (negative in the
      * Y direction).
@@ -1400,7 +1465,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.
@@ -1432,7 +1496,6 @@ export class Block {
      */
     canPlace(blockToPlace: BlockPermutation | BlockType | string, faceToPlaceOn?: Direction): boolean;
     /**
-     * @beta
      * @remarks
      * Returns the {@link @minecraft/server.Location} of the center
      * of this block on the X, Y, and Z axis.
@@ -1440,7 +1503,6 @@ export class Block {
      */
     center(): Vector3;
     /**
-     * @beta
      * @remarks
      * Returns the {@link Block} to the east of this block
      * (positive in the X direction).
@@ -1566,7 +1628,6 @@ export class Block {
      */
     isValid(): boolean;
     /**
-     * @beta
      * @remarks
      * Returns the {@link Block} to the north of this block
      * (negative in the Z direction).
@@ -1581,7 +1642,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}
@@ -1626,7 +1696,6 @@ export class Block {
      */
     setType(blockType: BlockType | string): void;
     /**
-     * @beta
      * @remarks
      * Returns the {@link Block} to the south of this block
      * (positive in the Z direction).
@@ -1662,7 +1731,6 @@ export class Block {
      */
     trySetPermutation(permutation: BlockPermutation): boolean;
     /**
-     * @beta
      * @remarks
      * Returns the {@link Block} to the west of this block
      * (negative in the X direction).
@@ -2790,9 +2858,7 @@ export class ChatSendAfterEvent {
     private constructor();
     /**
      * @remarks
-     * Message that is being broadcast. In a beforeChat event
-     * handler, _message_ can be updated with edits before the
-     * message is displayed to players.
+     * Message that is being broadcast.
      *
      */
     message: string;
@@ -2802,20 +2868,7 @@ export class ChatSendAfterEvent {
      *
      */
     sender: Player;
-    /**
-     * @remarks
-     * If true, this message is directly targeted to one or more
-     * players (i.e., is not broadcast.)
-     *
-     */
     sendToTargets: boolean;
-    /**
-     * @remarks
-     * List of players that will receive this message.
-     *
-     * @returns
-     * List of player objects.
-     */
     getTargets(): Player[];
 }
 
@@ -2873,14 +2926,6 @@ export class ChatSendBeforeEvent extends ChatSendAfterEvent {
      *
      */
     cancel: boolean;
-    /**
-     * @remarks
-     * Sets an updated list of players that will receive this
-     * message.
-     *
-     * @param players
-     * Updated array of players that should receive this message.
-     */
     setTargets(players: Player[]): void;
 }
 
@@ -3757,7 +3802,6 @@ export class DataDrivenEntityTriggerBeforeEventSignal {
 export class Dimension {
     private constructor();
     /**
-     * @beta
      * @remarks
      * Height range of the dimension.
      *
@@ -3991,8 +4035,13 @@ export class Dimension {
     /**
      * @beta
      * @remarks
+     * Returns the current weather.
+     *
      * This function can't be called in read-only mode.
      *
+     * @returns
+     * Returns a WeatherType that explains the broad category of
+     * weather that is currently going on.
      */
     getWeather(): WeatherType;
     /**
@@ -4349,6 +4398,11 @@ export class EffectAddBeforeEvent {
      *
      */
     cancel: boolean;
+    /**
+     * @remarks
+     * Effect duration.
+     *
+     */
     duration: number;
     /**
      * @remarks
@@ -4951,7 +5005,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;
@@ -5057,7 +5114,6 @@ export class Entity {
      */
     getComponents(): EntityComponent[];
     /**
-     * @beta
      * @remarks
      * Returns a property value.
      *
@@ -5070,12 +5126,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;
@@ -5256,7 +5324,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
@@ -5284,7 +5351,6 @@ export class Entity {
      */
     playAnimation(animationName: string, options?: PlayAnimationOptions): void;
     /**
-     * @beta
      * @remarks
      * Immediately removes the entity from the world. The removed
      * entity will not perform a death animation or drop loot upon
@@ -5381,7 +5447,6 @@ export class Entity {
      */
     runCommandAsync(commandString: string): Promise<CommandResult>;
     /**
-     * @beta
      * @remarks
      * Sets a specified property to a value.
      *
@@ -10052,7 +10117,6 @@ export class PlayerDimensionChangeAfterEventSignal {
 }
 
 /**
- * @beta
  * Contains information regarding an event after a player
  * interacts with a block.
  */
@@ -10093,7 +10157,6 @@ export class PlayerInteractWithBlockAfterEvent {
 }
 
 /**
- * @beta
  * Manages callbacks that are connected to after a player
  * interacts with a block.
  */
@@ -10123,7 +10186,6 @@ export class PlayerInteractWithBlockAfterEventSignal {
 }
 
 /**
- * @beta
  * Contains information regarding an event before a player
  * interacts with a block.
  */
@@ -10170,7 +10232,6 @@ export class PlayerInteractWithBlockBeforeEvent {
 }
 
 /**
- * @beta
  * Manages callbacks that are connected to before a player
  * interacts with a block.
  */
@@ -10200,7 +10261,6 @@ export class PlayerInteractWithBlockBeforeEventSignal {
 }
 
 /**
- * @beta
  * Contains information regarding an event after a player
  * interacts with an entity.
  */
@@ -10228,7 +10288,6 @@ export class PlayerInteractWithEntityAfterEvent {
 }
 
 /**
- * @beta
  * Manages callbacks that are connected to after a player
  * interacts with an entity.
  */
@@ -10258,7 +10317,6 @@ export class PlayerInteractWithEntityAfterEventSignal {
 }
 
 /**
- * @beta
  * Contains information regarding an event before a player
  * interacts with an entity.
  */
@@ -10292,7 +10350,6 @@ export class PlayerInteractWithEntityBeforeEvent {
 }
 
 /**
- * @beta
  * Manages callbacks that are connected to before a player
  * interacts with an entity.
  */
@@ -10408,17 +10465,11 @@ export class PlayerLeaveAfterEventSignal extends IPlayerLeaveAfterEventSignal {
     private constructor();
 }
 
-/**
- * @beta
- */
 export class PlayerLeaveBeforeEvent {
     private constructor();
     readonly player: Player;
 }
 
-/**
- * @beta
- */
 export class PlayerLeaveBeforeEventSignal {
     private constructor();
     /**
@@ -11898,7 +11949,10 @@ export class World {
      */
     broadcastClientMessage(id: string, value: string): void;
     /**
-     * @beta
+     * @remarks
+     * Clears the set of dynamic properties declared for this
+     * behavior pack within the world.
+     *
      */
     clearDynamicProperties(): void;
     /**
@@ -11947,7 +12001,6 @@ export class World {
      */
     getDimension(dimensionId: string): Dimension;
     /**
-     * @beta
      * @remarks
      * Returns a property value.
      *
@@ -12014,15 +12067,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.
      *
@@ -12215,7 +12276,6 @@ export class World {
      */
     setDefaultSpawnLocation(spawnLocation: Vector3): void;
     /**
-     * @beta
      * @remarks
      * Sets a specified property to a value.
      *
@@ -12334,11 +12394,6 @@ export class WorldAfterEvents {
     readonly chatSend: ChatSendAfterEventSignal;
     /**
      * @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;
     /**
@@ -12509,10 +12564,16 @@ export class WorldAfterEvents {
     readonly playerDimensionChange: PlayerDimensionChangeAfterEventSignal;
     /**
      * @beta
+     * @remarks
+     * An event for when a player interacts with a block.
+     *
      */
     readonly playerInteractWithBlock: PlayerInteractWithBlockAfterEventSignal;
     /**
      * @beta
+     * @remarks
+     * This event fires when a player interacts with an entity.
+     *
      */
     readonly playerInteractWithEntity: PlayerInteractWithEntityAfterEventSignal;
     /**
@@ -12687,14 +12748,22 @@ export class WorldBeforeEvents {
     readonly playerBreakBlock: PlayerBreakBlockBeforeEventSignal;
     /**
      * @beta
+     * @remarks
+     * Fires before a player interacts with a block.
+     *
      */
     readonly playerInteractWithBlock: PlayerInteractWithBlockBeforeEventSignal;
     /**
      * @beta
+     * @remarks
+     * Fires before a player interacts with an entity.
+     *
      */
     readonly playerInteractWithEntity: PlayerInteractWithEntityBeforeEventSignal;
     /**
-     * @beta
+     * @remarks
+     * Fires when a player leaves the game.
+     *
      */
     readonly playerLeave: PlayerLeaveBeforeEventSignal;
     /**
@@ -12942,6 +13011,11 @@ export interface BoundingBox {
 }
 
 export interface CameraDefaultOptions {
+    /**
+     * @remarks
+     * Sets a set of easing options for the camera.
+     *
+     */
     easeOptions: CameraEaseOptions;
 }
 
@@ -13952,7 +14026,6 @@ export const MoonPhaseCount = 8;
  */
 export const TicksPerDay = 24000;
 /**
- * @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.8.0-beta.1.20.50-preview.24",
+  "version": "1.8.0-beta.1.20.50-stable",
   "description": "",
   "contributors": [
     {
@@ -13,7 +13,7 @@
     }
   ],
   "dependencies": {
-    "@minecraft/common": "^1.1.0-rc.1.20.50-preview.24"
+    "@minecraft/common": "^1.1.0"
   },
   "license": "MIT"
 }