@minecraft/server 1.2.0-rc.1.20.0-preview.22 → 1.2.0-rc.1.20.0-preview.24

package/index.d.ts

@@ -16,7 +16,7 @@
  * ```json
  * {
  *   "module_name": "@minecraft/server",
- *   "version": "1.3.0-internal.1.20.0-preview.22"
+ *   "version": "1.4.0-internal.1.20.0-preview.24"
  * }
  * ```
  *
@@ -184,6 +184,13 @@ export class BlockInventoryComponent {
      * @throws This property can throw when used.
      */
     readonly container: Container;
+    /**
+     * @remarks
+     * Identifier of this component. Should always be
+     * minecraft:inventory.
+     *
+     */
+    static readonly componentId = 'minecraft:inventory';
 }
 
 /**
@@ -233,6 +240,20 @@ export class CommandResult {
     readonly successCount: number;
 }
 
+/**
+ * @beta
+ * Base class for downstream Component implementations.
+ */
+export class Component {
+    protected constructor();
+    /**
+     * @remarks
+     * Identifier of the component.
+     *
+     */
+    readonly typeId: string;
+}
+
 /**
  * @beta
  * Represents a container that can hold sets of items. Used
@@ -420,8 +441,7 @@ export class Dimension {
     /**
      * @beta
      * @remarks
-     * Returns a block instance at the given location. This method
-     * was introduced as of version 1.17.10.21.
+     * Returns a block instance at the given location.
      *
      * @param location
      * The location at which to return a block.
@@ -572,6 +592,9 @@ export class Entity {
      *
      * @param tag
      * Content of the tag to add.
+     * @returns
+     * Returns true if the tag was added successfully. This can
+     * fail if the tag already exists on the entity.
      * @throws This function can throw errors.
      */
     addTag(tag: string): boolean;
@@ -588,6 +611,10 @@ export class Entity {
      * Additional options about the source of damage, which may add
      * additional effects or spur additional behaviors on this
      * entity.
+     * @returns
+     * Whether the entity takes any damage. This can return false
+     * if the entity is invulnerable or if the damage applied is
+     * less than or equal to 0.
      * @throws This function can throw errors.
      */
     applyDamage(amount: number, options?: EntityApplyDamageByProjectileOptions | EntityApplyDamageOptions): boolean;
@@ -634,12 +661,42 @@ export class Entity {
      * @throws This function can throw errors.
      */
     clearVelocity(): void;
+    /**
+     * @beta
+     * @remarks
+     * Gets a component (that represents additional capabilities)
+     * for an entity.
+     *
+     * @param componentId
+     * The identifier of the component (e.g., 'minecraft:rideable')
+     * to retrieve. If no namespace prefix is specified,
+     * 'minecraft:' is assumed. If the component is not present on
+     * the entity, undefined is returned.
+     * @returns
+     * Returns the component if it exists on the entity, otherwise
+     * undefined.
+     */
+    getComponent(componentId: string): EntityComponent | undefined;
+    /**
+     * @beta
+     * @remarks
+     * Returns all components that are both present on this entity
+     * and supported by the API.
+     *
+     * @returns
+     * Returns all components that are both present on this entity
+     * and supported by the API.
+     */
+    getComponents(): EntityComponent[];
     /**
      * @beta
      * @remarks
      * Returns the current location of the head component of this
      * entity.
      *
+     * @returns
+     * Returns the current location of the head component of this
+     * entity.
      * @throws This function can throw errors.
      */
     getHeadLocation(): Vector3;
@@ -648,6 +705,8 @@ export class Entity {
      * @remarks
      * Returns all tags associated with an entity.
      *
+     * @returns
+     * Returns the current rotation component of this entity.
      * @throws This function can throw errors.
      */
     getTags(): string[];
@@ -656,6 +715,8 @@ export class Entity {
      * @remarks
      * Returns the current velocity vector of the entity.
      *
+     * @returns
+     * Returns the current velocity vector of the entity.
      * @throws This function can throw errors.
      */
     getVelocity(): Vector3;
@@ -664,16 +725,35 @@ export class Entity {
      * @remarks
      * Returns the current view direction of the entity.
      *
+     * @returns
+     * Returns the current view direction of the entity.
      * @throws This function can throw errors.
      */
     getViewDirection(): Vector3;
     /**
      * @beta
      * @remarks
-     * Tests whether an entity has a particular tag.
+     * Returns true if the specified component is present on this
+     * entity.
+     *
+     * @param componentId
+     * The identifier of the component (e.g., 'minecraft:rideable')
+     * to retrieve. If no namespace prefix is specified,
+     * 'minecraft:' is assumed.
+     * @returns
+     * Returns true if the specified component is present on this
+     * entity.
+     */
+    hasComponent(componentId: string): boolean;
+    /**
+     * @beta
+     * @remarks
+     * Returns whether an entity has a particular tag.
      *
      * @param tag
      * Identifier of the tag to test for.
+     * @returns
+     * Returns whether an entity has a particular tag.
      * @throws This function can throw errors.
      */
     hasTag(tag: string): boolean;
@@ -699,14 +779,24 @@ export class Entity {
      *
      * @param tag
      * Content of the tag to remove.
+     * @returns
+     * Returns whether the tag existed on the entity.
      * @throws This function can throw errors.
      */
     removeTag(tag: string): boolean;
     /**
      * @beta
      * @remarks
+     * Runs a synchronous command on the entity.
+     *
      * This function can't be called in read-only mode.
      *
+     * @param commandString
+     * The command string. Note: This should not include a leading
+     * forward slash.
+     * @returns
+     * A command result containing whether the command was
+     * successful.
      * @throws This function can throw errors.
      */
     runCommand(commandString: string): CommandResult;
@@ -727,11 +817,195 @@ export class Entity {
     runCommandAsync(commandString: string): Promise<CommandResult>;
 }
 
+/**
+ * @beta
+ * Base class for a family of entity movement events.
+ */
+export class EntityBaseMovementComponent extends EntityComponent {
+    protected constructor();
+    readonly maxTurn: number;
+}
+
+/**
+ * @beta
+ * When added, this component signifies that the entity can
+ * climb up ladders.
+ */
+export class EntityCanClimbComponent extends EntityComponent {
+    protected constructor();
+    /**
+     * @remarks
+     * Identifier of this component. Should always be
+     * minecraft:can_climb.
+     *
+     */
+    static readonly componentId = 'minecraft:can_climb';
+}
+
+/**
+ * @beta
+ * When added, this component signifies that the entity can
+ * fly, and the pathfinder won't be restricted to paths where a
+ * solid block is required underneath it.
+ */
+export class EntityCanFlyComponent extends EntityComponent {
+    protected constructor();
+    /**
+     * @remarks
+     * Identifier of this component. Should always be
+     * minecraft:can_fly.
+     *
+     */
+    static readonly componentId = 'minecraft:can_fly';
+}
+
+/**
+ * @beta
+ * When added, this component signifies that the entity can
+ * power jump like the horse does within Minecraft.
+ */
+export class EntityCanPowerJumpComponent extends EntityComponent {
+    protected constructor();
+    /**
+     * @remarks
+     * Identifier of this component. Should always be
+     * minecraft:can_power_jump.
+     *
+     */
+    static readonly componentId = 'minecraft:can_power_jump';
+}
+
+/**
+ * @beta
+ * Defines the entity's color. Only works on certain entities
+ * that have predefined color values (sheep, llama, shulker).
+ */
+export class EntityColorComponent extends EntityComponent {
+    protected constructor();
+    /**
+     * @remarks
+     * This property can't be edited in read-only mode.
+     *
+     */
+    value: number;
+    /**
+     * @remarks
+     * Identifier of this component. Should always be
+     * minecraft:color.
+     *
+     */
+    static readonly componentId = 'minecraft:color';
+}
+
+/**
+ * @beta
+ * Base class for downstream entity components.
+ */
+export class EntityComponent extends Component {
+    protected constructor();
+}
+
+/**
+ * @beta
+ * When added, this component signifies that this entity
+ * doesn't take damage from fire.
+ */
+export class EntityFireImmuneComponent extends EntityComponent {
+    protected constructor();
+    /**
+     * @remarks
+     * Identifier of this component. Should always be
+     * minecraft:fire_immune.
+     *
+     */
+    static readonly componentId = 'minecraft:fire_immune';
+}
+
+/**
+ * @beta
+ * When added, this component signifies that this entity can
+ * float in liquid blocks.
+ */
+export class EntityFloatsInLiquidComponent extends EntityComponent {
+    protected constructor();
+    /**
+     * @remarks
+     * Identifier of this component. Should always be
+     * minecraft:floats_in_liquid.
+     *
+     */
+    static readonly componentId = 'minecraft:floats_in_liquid';
+}
+
+/**
+ * @beta
+ * Represents the flying speed of an entity.
+ */
+export class EntityFlyingSpeedComponent extends EntityComponent {
+    protected constructor();
+    /**
+     * @remarks
+     * This property can't be edited in read-only mode.
+     *
+     */
+    value: number;
+    /**
+     * @remarks
+     * Identifier of this component. Should always be
+     * minecraft:flying_speed.
+     *
+     */
+    static readonly componentId = 'minecraft:flying_speed';
+}
+
+/**
+ * @beta
+ * Defines how much friction affects this entity.
+ */
+export class EntityFrictionModifierComponent extends EntityComponent {
+    protected constructor();
+    /**
+     * @remarks
+     * This property can't be edited in read-only mode.
+     *
+     */
+    value: number;
+    /**
+     * @remarks
+     * Identifier of this component. Should always be
+     * minecraft:friction_modifier.
+     *
+     */
+    static readonly componentId = 'minecraft:friction_modifier';
+}
+
+/**
+ * @beta
+ * Sets the offset from the ground that the entity is actually
+ * at.
+ */
+export class EntityGroundOffsetComponent extends EntityComponent {
+    protected constructor();
+    /**
+     * @remarks
+     * This property can't be edited in read-only mode.
+     *
+     */
+    value: number;
+    /**
+     * @remarks
+     * Identifier of this component. Should always be
+     * minecraft:ground_offset.
+     *
+     */
+    static readonly componentId = 'minecraft:ground_offset';
+}
+
 /**
  * @beta
  * Defines this entity's inventory properties.
  */
-export class EntityInventoryComponent {
+export class EntityInventoryComponent extends EntityComponent {
     protected constructor();
     /**
      * @remarks
@@ -785,6 +1059,221 @@ export class EntityInventoryComponent {
      * @throws This property can throw when used.
      */
     readonly restrictToOwner: boolean;
+    /**
+     * @remarks
+     * Identifier of this component. Should always be
+     * minecraft:inventory.
+     *
+     */
+    static readonly componentId = 'minecraft:inventory';
+}
+
+/**
+ * @beta
+ * When added, this component signifies that this entity is a
+ * baby.
+ */
+export class EntityIsBabyComponent extends EntityComponent {
+    protected constructor();
+    /**
+     * @remarks
+     * Identifier of this component. Should always be
+     * minecraft:is_baby.
+     *
+     */
+    static readonly componentId = 'minecraft:is_baby';
+}
+
+/**
+ * @beta
+ * When added, this component signifies that this entity is
+ * charged.
+ */
+export class EntityIsChargedComponent extends EntityComponent {
+    protected constructor();
+    /**
+     * @remarks
+     * Identifier of this component. Should always be
+     * minecraft:is_charged.
+     *
+     */
+    static readonly componentId = 'minecraft:is_charged';
+}
+
+/**
+ * @beta
+ * When added, this component signifies that this entity is
+ * currently carrying a chest.
+ */
+export class EntityIsChestedComponent extends EntityComponent {
+    protected constructor();
+    /**
+     * @remarks
+     * Identifier of this component. Should always be
+     * minecraft:is_chested.
+     *
+     */
+    static readonly componentId = 'minecraft:is_chested';
+}
+
+/**
+ * @beta
+ * When added, this component signifies that dyes can be used
+ * on this entity to change its color.
+ */
+export class EntityIsDyeableComponent extends EntityComponent {
+    protected constructor();
+    /**
+     * @remarks
+     * Identifier of this component. Should always be
+     * minecraft:is_dyeable.
+     *
+     */
+    static readonly componentId = 'minecraft:is_dyeable';
+}
+
+/**
+ * @beta
+ * When added, this component signifies that this entity can
+ * hide from hostile mobs while invisible.
+ */
+export class EntityIsHiddenWhenInvisibleComponent extends EntityComponent {
+    protected constructor();
+    /**
+     * @remarks
+     * Identifier of this component. Should always be
+     * minecraft:is_hidden_when_invisible.
+     *
+     */
+    static readonly componentId = 'minecraft:is_hidden_when_invisible';
+}
+
+/**
+ * @beta
+ * When added, this component signifies that this entity this
+ * currently on fire.
+ */
+export class EntityIsIgnitedComponent extends EntityComponent {
+    protected constructor();
+    /**
+     * @remarks
+     * Identifier of this component. Should always be
+     * minecraft:is_ignited.
+     *
+     */
+    static readonly componentId = 'minecraft:is_ignited';
+}
+
+/**
+ * @beta
+ * When added, this component signifies that this entity is an
+ * illager captain.
+ */
+export class EntityIsIllagerCaptainComponent extends EntityComponent {
+    protected constructor();
+    /**
+     * @remarks
+     * Identifier of this component. Should always be
+     * minecraft:is_illager_captain.
+     *
+     */
+    static readonly componentId = 'minecraft:is_illager_captain';
+}
+
+/**
+ * @beta
+ * When added, this component signifies that this entity is
+ * currently saddled.
+ */
+export class EntityIsSaddledComponent extends EntityComponent {
+    protected constructor();
+    /**
+     * @remarks
+     * Identifier of this component. Should always be
+     * minecraft:is_saddled.
+     *
+     */
+    static readonly componentId = 'minecraft:is_saddled';
+}
+
+/**
+ * @beta
+ * When added, this component signifies that this entity is
+ * currently shaking.
+ */
+export class EntityIsShakingComponent extends EntityComponent {
+    protected constructor();
+    /**
+     * @remarks
+     * Identifier of this component. Should always be
+     * minecraft:is_shaking.
+     *
+     */
+    static readonly componentId = 'minecraft:is_shaking';
+}
+
+/**
+ * @beta
+ * When added, this component signifies that this entity is
+ * currently sheared.
+ */
+export class EntityIsShearedComponent extends EntityComponent {
+    protected constructor();
+    /**
+     * @remarks
+     * Identifier of this component. Should always be
+     * minecraft:is_sheared.
+     *
+     */
+    static readonly componentId = 'minecraft:is_sheared';
+}
+
+/**
+ * @beta
+ * When added, this component signifies that this entity can be
+ * stacked.
+ */
+export class EntityIsStackableComponent extends EntityComponent {
+    protected constructor();
+    /**
+     * @remarks
+     * Identifier of this component. Should always be
+     * minecraft:is_stackable.
+     *
+     */
+    static readonly componentId = 'minecraft:is_stackable';
+}
+
+/**
+ * @beta
+ * When added, this component signifies that this entity is
+ * currently stunned.
+ */
+export class EntityIsStunnedComponent extends EntityComponent {
+    protected constructor();
+    /**
+     * @remarks
+     * Identifier of this component. Should always be
+     * minecraft:is_stunned.
+     *
+     */
+    static readonly componentId = 'minecraft:is_stunned';
+}
+
+/**
+ * @beta
+ * When added, this component signifies that this entity is
+ * currently tamed.
+ */
+export class EntityIsTamedComponent extends EntityComponent {
+    protected constructor();
+    /**
+     * @remarks
+     * Identifier of this component. Should always be
+     * minecraft:is_tamed.
+     *
+     */
+    static readonly componentId = 'minecraft:is_tamed';
 }
 
 /**
@@ -794,7 +1283,7 @@ export class EntityInventoryComponent {
  * retrieve the actual item stack contents via the itemStack
  * property.
  */
-export class EntityItemComponent {
+export class EntityItemComponent extends EntityComponent {
     protected constructor();
     /**
      * @remarks
@@ -803,13 +1292,247 @@ export class EntityItemComponent {
      * @throws This property can throw when used.
      */
     readonly itemStack: ItemStack;
+    /**
+     * @remarks
+     * Identifier of this component.
+     *
+     */
+    static readonly componentId = 'minecraft:item';
+}
+
+/**
+ * @beta
+ * Additional variant value. Can be used to further
+ * differentiate variants.
+ */
+export class EntityMarkVariantComponent extends EntityComponent {
+    protected constructor();
+    /**
+     * @remarks
+     * This property can't be edited in read-only mode.
+     *
+     */
+    value: number;
+    /**
+     * @remarks
+     * Identifier of this component. Should always be
+     * minecraft:mark_variant.
+     *
+     */
+    static readonly componentId = 'minecraft:mark_variant';
+}
+
+/**
+ * @beta
+ * When added, this movement control allows the mob to swim in
+ * water and walk on land.
+ */
+export class EntityMovementAmphibiousComponent extends EntityBaseMovementComponent {
+    protected constructor();
+    /**
+     * @remarks
+     * Identifier of this component. Should always be
+     * minecraft:movement.amphibious.
+     *
+     */
+    static readonly componentId = 'minecraft:movement.amphibious';
+}
+
+/**
+ * @beta
+ * This component accents the movement of an entity.
+ */
+export class EntityMovementBasicComponent extends EntityBaseMovementComponent {
+    protected constructor();
+    /**
+     * @remarks
+     * Identifier of this component. Should always be
+     * minecraft:movement.basic.
+     *
+     */
+    static readonly componentId = 'minecraft:movement.basic';
+}
+
+/**
+ * @beta
+ * When added, this move control causes the mob to fly.
+ */
+export class EntityMovementFlyComponent extends EntityBaseMovementComponent {
+    protected constructor();
+    /**
+     * @remarks
+     * Identifier of this component. Should always be
+     * minecraft:movement.fly.
+     *
+     */
+    static readonly componentId = 'minecraft:movement.fly';
+}
+
+/**
+ * @beta
+ * When added, this move control allows a mob to fly, swim,
+ * climb, etc.
+ */
+export class EntityMovementGenericComponent extends EntityBaseMovementComponent {
+    protected constructor();
+    /**
+     * @remarks
+     * Identifier of this component. Should always be
+     * minecraft:movement.generic.
+     *
+     */
+    static readonly componentId = 'minecraft:movement.generic';
+}
+
+/**
+ * @beta
+ * When added, this move control causes the mob to hover.
+ */
+export class EntityMovementHoverComponent extends EntityBaseMovementComponent {
+    protected constructor();
+    /**
+     * @remarks
+     * Identifier of this component. Should always be
+     * minecraft:movement.hover.
+     *
+     */
+    static readonly componentId = 'minecraft:movement.hover';
+}
+
+/**
+ * @beta
+ * Move control that causes the mob to jump as it moves with a
+ * specified delay between jumps.
+ */
+export class EntityMovementJumpComponent extends EntityBaseMovementComponent {
+    protected constructor();
+    /**
+     * @remarks
+     * Identifier of this component. Should always be
+     * minecraft:movement.jump.
+     *
+     */
+    static readonly componentId = 'minecraft:movement.jump';
+}
+
+/**
+ * @beta
+ * When added, this move control causes the mob to hop as it
+ * moves.
+ */
+export class EntityMovementSkipComponent extends EntityBaseMovementComponent {
+    protected constructor();
+    /**
+     * @remarks
+     * Identifier of this component. Should always be
+     * minecraft:movement.skip.
+     *
+     */
+    static readonly componentId = 'minecraft:movement.skip';
+}
+
+/**
+ * @beta
+ * Sets the distance through which the entity can push through.
+ */
+export class EntityPushThroughComponent extends EntityComponent {
+    protected constructor();
+    /**
+     * @remarks
+     * This property can't be edited in read-only mode.
+     *
+     */
+    value: number;
+    /**
+     * @remarks
+     * Identifier of this component. Should always be
+     * minecraft:push_through.
+     *
+     */
+    static readonly componentId = 'minecraft:push_through';
+}
+
+/**
+ * @beta
+ * Sets the entity's visual size.
+ */
+export class EntityScaleComponent extends EntityComponent {
+    protected constructor();
+    /**
+     * @remarks
+     * This property can't be edited in read-only mode.
+     *
+     */
+    value: number;
+    /**
+     * @remarks
+     * Identifier of this component. Should always be
+     * minecraft:scale.
+     *
+     */
+    static readonly componentId = 'minecraft:scale';
+}
+
+/**
+ * @beta
+ * Skin Id value. Can be used to differentiate skins, such as
+ * base skins for villagers.
+ */
+export class EntitySkinIdComponent extends EntityComponent {
+    protected constructor();
+    /**
+     * @remarks
+     * This property can't be edited in read-only mode.
+     *
+     */
+    value: number;
+    /**
+     * @remarks
+     * Identifier of this component. Should always be
+     * minecraft:skin_id.
+     *
+     */
+    static readonly componentId = 'minecraft:skin_id';
+}
+
+/**
+ * @beta
+ * Used to differentiate the component group of a variant of an
+ * entity from others. (e.g. ocelot, villager).
+ */
+export class EntityVariantComponent extends EntityComponent {
+    protected constructor();
+    readonly value: number;
+    /**
+     * @remarks
+     * Identifier of this component. Should always be
+     * minecraft:variant.
+     *
+     */
+    static readonly componentId = 'minecraft:variant';
+}
+
+/**
+ * @beta
+ * When added, this component signifies that this entity wants
+ * to become a jockey.
+ */
+export class EntityWantsJockeyComponent extends EntityComponent {
+    protected constructor();
+    /**
+     * @remarks
+     * Identifier of this component. Should always be
+     * minecraft:wants_jockey.
+     *
+     */
+    static readonly componentId = 'minecraft:wants_jockey';
 }
 
 /**
  * @beta
  * Base class for item components.
  */
-export class ItemComponent {
+export class ItemComponent extends Component {
     protected constructor();
 }
 
@@ -1266,17 +1989,40 @@ export class World {
 
 /**
  * @beta
+ * Additional options for when damage has been applied via a
+ * projectile.
  */
 export interface EntityApplyDamageByProjectileOptions {
+    /**
+     * @remarks
+     * Optional entity that fired the projectile.
+     *
+     */
     damagingEntity?: Entity;
+    /**
+     * @remarks
+     * Projectile that caused damage.
+     *
+     */
     damagingProjectile: Entity;
 }
 
 /**
  * @beta
+ * Additional descriptions and metadata for a damage event.
  */
 export interface EntityApplyDamageOptions {
+    /**
+     * @remarks
+     * Underlying cause of the damage.
+     *
+     */
     cause: EntityDamageCause;
+    /**
+     * @remarks
+     * Optional entity that caused the damage.
+     *
+     */
     damagingEntity?: Entity;
 }
 
@@ -1506,10 +2252,27 @@ export interface MusicOptions {
 
 /**
  * @beta
+ * Additional options for how a sound plays for a player.
  */
 export interface PlayerSoundOptions {
+    /**
+     * @remarks
+     * Location of the sound; if not specified, the sound is played
+     * near a player.
+     *
+     */
     location?: Vector3;
+    /**
+     * @remarks
+     * Optional pitch of the sound.
+     *
+     */
     pitch?: number;
+    /**
+     * @remarks
+     * Optional volume of the sound.
+     *
+     */
     volume?: number;
 }
 
@@ -1526,9 +2289,21 @@ export interface RawMessage {
 
 /**
  * @beta
+ * Provides a description of a score token to use within a raw
+ * message.
  */
 export interface RawMessageScore {
+    /**
+     * @remarks
+     * Name of the score value to match.
+     *
+     */
     name?: string;
+    /**
+     * @remarks
+     * Name of the score value to match.
+     *
+     */
     objective?: string;
 }
 
@@ -1559,9 +2334,21 @@ export interface Vector3 {
 
 /**
  * @beta
+ * Contains additional options for a world-level playSound
+ * occurrence.
  */
 export interface WorldSoundOptions {
+    /**
+     * @remarks
+     * Pitch of the sound played at the world level.
+     *
+     */
     pitch?: number;
+    /**
+     * @remarks
+     * Relative volume and space by which this sound is heard.
+     *
+     */
     volume?: number;
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@minecraft/server",
-  "version": "1.2.0-rc.1.20.0-preview.22",
+  "version": "1.2.0-rc.1.20.0-preview.24",
   "description": "",
   "contributors": [
     {