@minecraft/server 1.9.0-beta.1.20.60-preview.20 → 1.9.0-beta.1.20.60-preview.21

package/index.d.ts

@@ -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,
 }
 
@@ -1582,6 +1649,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}
@@ -2790,33 +2867,24 @@ 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;
+    readonly message: string;
     /**
      * @remarks
      * Player that sent the chat message.
      *
      */
-    sender: Player;
+    readonly sender: Player;
     /**
      * @remarks
-     * If true, this message is directly targeted to one or more
+     * Optional list of players that will receive this message. If
+     * defined, 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[];
+    readonly targets?: Player[];
 }
 
 /**
@@ -2863,8 +2931,7 @@ export class ChatSendAfterEventSignal {
  * @beta
  * An event that fires as players enter chat messages.
  */
-// @ts-ignore Class inheritance allowed for native defined classes
-export class ChatSendBeforeEvent extends ChatSendAfterEvent {
+export class ChatSendBeforeEvent {
     private constructor();
     /**
      * @remarks
@@ -2875,13 +2942,24 @@ export class ChatSendBeforeEvent extends ChatSendAfterEvent {
     cancel: boolean;
     /**
      * @remarks
-     * Sets an updated list of players that will receive this
-     * message.
+     * Message that is being broadcast.
+     *
+     */
+    readonly message: string;
+    /**
+     * @remarks
+     * Player that sent the chat message.
      *
-     * @param players
-     * Updated array of players that should receive this message.
      */
-    setTargets(players: Player[]): void;
+    readonly sender: Player;
+    /**
+     * @remarks
+     * Optional list of players that will receive this message. If
+     * defined, this message is directly targeted to one or more
+     * players (i.e., is not broadcast.)
+     *
+     */
+    readonly targets?: Player[];
 }
 
 /**
@@ -3991,8 +4069,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;
     /**
@@ -4291,18 +4374,14 @@ export class EffectAddAfterEvent {
      * @remarks
      * Additional properties and details of the effect.
      *
-     * This property can't be edited in read-only mode.
-     *
      */
-    effect: Effect;
+    readonly effect: Effect;
     /**
      * @remarks
      * Entity that the effect is being added to.
      *
-     * This property can't be edited in read-only mode.
-     *
      */
-    entity: Entity;
+    readonly entity: Entity;
 }
 
 /**
@@ -4349,6 +4428,11 @@ export class EffectAddBeforeEvent {
      *
      */
     cancel: boolean;
+    /**
+     * @remarks
+     * Effect duration.
+     *
+     */
     duration: number;
     /**
      * @remarks
@@ -4952,6 +5036,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;
@@ -5071,11 +5159,25 @@ 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;
@@ -5969,8 +6071,6 @@ export class EntityEquippableComponent extends EntityComponent {
      * @remarks
      * Gets the equipped item for the given EquipmentSlot.
      *
-     * This function can't be called in read-only mode.
-     *
      * @param equipmentSlot
      * The equipment slot. e.g. "head", "chest", "offhand"
      * @returns
@@ -5985,8 +6085,6 @@ export class EntityEquippableComponent extends EntityComponent {
      * Gets the ContainerSlot corresponding to the given
      * EquipmentSlot.
      *
-     * This function can't be called in read-only mode.
-     *
      * @param equipmentSlot
      * The equipment slot. e.g. "head", "chest", "offhand".
      * @returns
@@ -7603,7 +7701,7 @@ export class EntityTypes {
      * Retrieves an iterator of all entity types within this world.
      *
      */
-    static getAll(): EntityTypeIterator;
+    static getAll(): EntityType[];
 }
 
 /**
@@ -8213,23 +8311,16 @@ export class ItemDurabilityComponent extends ItemComponent {
      *
      * This function can't be called in read-only mode.
      *
-     * @param unbreaking
-     * Unbreaking factor to consider in factoring the damage
-     * chance. Incoming unbreaking parameter must be greater than
-     * 0.
      * @throws This function can throw errors.
      */
-    getDamageChance(unbreaking?: number): number;
+    getDamageChance(unbreakingEnchantmentLevel?: number): number;
     /**
      * @remarks
-     * A range of numbers that describes the chance of the item
-     * losing durability.
-     *
      * This function can't be called in read-only mode.
      *
      * @throws This function can throw errors.
      */
-    getDamageRange(): minecraftcommon.NumberRange;
+    getDamageChanceRange(): minecraftcommon.NumberRange;
 }
 
 /**
@@ -9835,8 +9926,18 @@ export class Player extends Entity {
     /**
      * @beta
      * @remarks
+     * Creates a new particle emitter at a specified location in
+     * the world. Only visible to the target player.
+     *
      * This function can't be called in read-only mode.
      *
+     * @param effectName
+     * Identifier of the particle to create.
+     * @param location
+     * The location at which to create the particle emitter.
+     * @param molangVariables
+     * A set of optional, customizable variables that can be
+     * adjusted for this particle.
      * @throws This function can throw errors.
      *
      * {@link Error}
@@ -9844,6 +9945,26 @@ export class Player extends Entity {
      * {@link LocationInUnloadedChunkError}
      *
      * {@link LocationOutOfWorldBoundariesError}
+     * @example spawnParticle.ts
+     * ```typescript
+     * for (let i = 0; i < 100; i++) {
+     *   const molang = new mc.MolangVariableMap();
+     *
+     *   molang.setColorRGB("variable.color", {
+     *     red: Math.random(),
+     *     green: Math.random(),
+     *     blue: Math.random(),
+     *     alpha: 1,
+     *   });
+     *
+     *   let newLocation = {
+     *     x: targetLocation.x + Math.floor(Math.random() * 8) - 4,
+     *     y: targetLocation.y + Math.floor(Math.random() * 8) - 4,
+     *     z: targetLocation.z + Math.floor(Math.random() * 8) - 4,
+     *   };
+     *   player.spawnParticle("minecraft:colored_flame_particle", newLocation, molang);
+     * }
+     * ```
      */
     spawnParticle(effectName: string, location: Vector3, molangVariables?: MolangVariableMap): void;
     /**
@@ -11908,6 +12029,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;
     /**
@@ -12024,10 +12149,21 @@ 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;
     /**
@@ -12349,7 +12485,7 @@ export class WorldAfterEvents {
      * entity.
      *
      */
-    readonly dataDrivenEntityTriggerEvent: DataDrivenEntityTriggerAfterEventSignal;
+    readonly dataDrivenEntityTrigger: DataDrivenEntityTriggerAfterEventSignal;
     /**
      * @beta
      * @remarks
@@ -12518,10 +12654,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;
     /**
@@ -12696,14 +12838,23 @@ 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;
     /**
@@ -12951,6 +13102,11 @@ export interface BoundingBox {
 }
 
 export interface CameraDefaultOptions {
+    /**
+     * @remarks
+     * Sets a set of easing options for the camera.
+     *
+     */
     easeOptions: CameraEaseOptions;
 }
 
@@ -13734,7 +13890,8 @@ export interface RGB {
 /**
  * Represents a fully customizable color within Minecraft.
  */
-export interface RGBA {
+// @ts-ignore Class inheritance allowed for native defined classes
+export interface RGBA extends RGB {
     /**
      * @remarks
      * Determines a color's alpha (opacity) component. Valid values
@@ -13742,27 +13899,6 @@ export interface RGBA {
      *
      */
     alpha: number;
-    /**
-     * @remarks
-     * Determines a color's blue component. Valid values are
-     * between 0 and 1.0.
-     *
-     */
-    blue: number;
-    /**
-     * @remarks
-     * Determines a color's green component. Valid values are
-     * between 0 and 1.0.
-     *
-     */
-    green: number;
-    /**
-     * @remarks
-     * Determines a color's red component. Valid values are between
-     * 0 and 1.0.
-     *
-     */
-    red: number;
 }
 
 /**

package/package.json

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