@minecraft/server 1.2.0-rc.1.20.0-preview.23 → 1.2.0-rc.1.20.0-preview.25

package/index.d.ts

@@ -16,7 +16,7 @@
  * ```json
  * {
  *   "module_name": "@minecraft/server",
- *   "version": "1.3.0-internal.1.20.0-preview.23"
+ *   "version": "1.3.0-internal.1.20.0-preview.25"
  * }
  * ```
  *
@@ -320,10 +320,9 @@ export class Container {
      * out of bounds.
      * @example getItem.ts
      * ```typescript
-     *        // Get a copy of the first item in the player's hotbar
-     *        const inventory = player.getComponent("inventory") as EntityInventoryComponent;
-     *        const itemStack = inventory.container.getItem(0);
-     *
+     * // Get a copy of the first item in the player's hotbar
+     * const inventory = player.getComponent("inventory") as EntityInventoryComponent;
+     * const itemStack = inventory.container.getItem(0);
      * ```
      */
     getItem(slot: number): ItemStack | undefined;
@@ -348,11 +347,10 @@ export class Container {
      * or if the `fromSlot` or `toSlot` indices out of bounds.
      * @example moveItem.ts
      * ```typescript
-     *        // Move an item from the first slot of fromPlayer's inventory to the fifth slot of toPlayer's inventory
-     *        const fromInventory = fromPlayer.getComponent('inventory') as EntityInventoryComponent;
-     *        const toInventory = toPlayer.getComponent('inventory') as EntityInventoryComponent;
-     *        fromInventory.container.moveItem(0, 4, toInventory.container);
-     *
+     * // Move an item from the first slot of fromPlayer's inventory to the fifth slot of toPlayer's inventory
+     * const fromInventory = fromPlayer.getComponent('inventory') as EntityInventoryComponent;
+     * const toInventory = toPlayer.getComponent('inventory') as EntityInventoryComponent;
+     * fromInventory.container.moveItem(0, 4, toInventory.container);
      * ```
      */
     moveItem(fromSlot: number, toSlot: number, toContainer: Container): void;
@@ -390,10 +388,9 @@ export class Container {
      * invalid or if the `slot` or `otherSlot` are out of bounds.
      * @example swapItems.ts
      * ```typescript
-     *        // Swaps an item between slots 0 and 4 in the player's inventory
-     *        const inventory = fromPlayer.getComponent('inventory') as EntityInventoryComponent;
-     *        inventory.container.swapItems(0, 4, inventory);
-     *
+     * // Swaps an item between slots 0 and 4 in the player's inventory
+     * const inventory = fromPlayer.getComponent('inventory') as EntityInventoryComponent;
+     * inventory.container.swapItems(0, 4, inventory);
      * ```
      */
     swapItems(slot: number, otherSlot: number, otherContainer: Container): void;
@@ -415,11 +412,10 @@ export class Container {
      * or if the `fromSlot` or `toSlot` indices out of bounds.
      * @example transferItem.ts
      * ```typescript
-     *        // Transfer an item from the first slot of fromPlayer's inventory to toPlayer's inventory
-     *        const fromInventory = fromPlayer.getComponent('inventory') as EntityInventoryComponent;
-     *        const toInventory = toPlayer.getComponent('inventory') as EntityInventoryComponent;
-     *        fromInventory.container.transferItem(0, toInventory.container);
-     *
+     * // Transfer an item from the first slot of fromPlayer's inventory to toPlayer's inventory
+     * const fromInventory = fromPlayer.getComponent('inventory') as EntityInventoryComponent;
+     * const toInventory = toPlayer.getComponent('inventory') as EntityInventoryComponent;
+     * fromInventory.container.transferItem(0, toInventory.container);
      * ```
      */
     transferItem(fromSlot: number, toContainer: Container): ItemStack;
@@ -464,22 +460,21 @@ export class Dimension {
      * @throws This function can throw errors.
      * @example testThatEntityIsFeatherItem.ts
      * ```typescript
-     *        const query = {
-     *          type: "item",
-     *          location: targetLocation,
-     *        };
-     *        const items = overworld.getEntities(query);
-     *
-     *        for (const item of items) {
-     *          const itemComp = item.getComponent("item") as any;
-     *
-     *          if (itemComp) {
-     *            if (itemComp.itemStack.id.endsWith("feather")) {
-     *              console.log("Success! Found a feather", 1);
-     *            }
-     *          }
-     *        }
-     *
+     * const query = {
+     *   type: "item",
+     *   location: targetLocation,
+     * };
+     * const items = overworld.getEntities(query);
+     *
+     * for (const item of items) {
+     *   const itemComp = item.getComponent("item") as any;
+     *
+     *   if (itemComp) {
+     *     if (itemComp.itemStack.id.endsWith("feather")) {
+     *       console.log("Success! Found a feather", 1);
+     *     }
+     *   }
+     * }
      * ```
      */
     getEntities(options?: EntityQueryOptions): Entity[];
@@ -592,6 +587,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;
@@ -608,6 +606,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;
@@ -665,6 +667,9 @@ export class Entity {
      * 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;
     /**
@@ -673,6 +678,9 @@ export class Entity {
      * 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[];
     /**
@@ -681,6 +689,9 @@ export class Entity {
      * 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;
@@ -689,6 +700,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[];
@@ -697,6 +710,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;
@@ -705,6 +720,8 @@ 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;
@@ -718,15 +735,20 @@ export class Entity {
      * 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
-     * Tests whether an entity has a particular tag.
+     * 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;
@@ -752,6 +774,8 @@ 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;
@@ -762,6 +786,12 @@ export class 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;
@@ -1600,11 +1630,10 @@ export class ItemStack {
      * stack, undefined is returned.
      * @example durability.ts
      * ```typescript
-     *        // Get the maximum durability of a custom sword item
-     *        const itemStack = new ItemStack("custom:sword");
-     *        const durability = itemStack.getComponent("minecraft:durability") as ItemDurabilityComponent;
-     *        const maxDurability = durability.maxDurability;
-     *
+     * // Get the maximum durability of a custom sword item
+     * const itemStack = new ItemStack("custom:sword");
+     * const durability = itemStack.getComponent("minecraft:durability") as ItemDurabilityComponent;
+     * const maxDurability = durability.maxDurability;
      * ```
      */
     getComponent(componentId: string): ItemComponent | undefined;
@@ -1732,33 +1761,29 @@ export class Player extends Entity {
      * is provided to `score`.
      * @example nestedTranslation.ts
      * ```typescript
-     *        // Displays "Apple or Coal"
-     *        let rawMessage = {
-     *          translate: "accessibility.list.or.two",
-     *          with: { rawtext: [{ translate: "item.apple.name" }, { translate: "item.coal.name" }] },
-     *        };
-     *        player.sendMessage(rawMessage);
-     *
+     * // Displays "Apple or Coal"
+     * let rawMessage = {
+     *   translate: "accessibility.list.or.two",
+     *   with: { rawtext: [{ translate: "item.apple.name" }, { translate: "item.coal.name" }] },
+     * };
+     * player.sendMessage(rawMessage);
      * ```
      * @example scoreWildcard.ts
      * ```typescript
-     *        // Displays the player's score for objective "obj". Each player will see their own score.
-     *        const rawMessage = { score: { name: "*", objective: "obj" } };
-     *        world.sendMessage(rawMessage);
-     *
+     * // Displays the player's score for objective "obj". Each player will see their own score.
+     * const rawMessage = { score: { name: "*", objective: "obj" } };
+     * world.sendMessage(rawMessage);
      * ```
      * @example simpleString.ts
      * ```typescript
-     *        // Displays "Hello, world!"
-     *        world.sendMessage("Hello, world!");
-     *
+     * // Displays "Hello, world!"
+     * world.sendMessage("Hello, world!");
      * ```
      * @example translation.ts
      * ```typescript
-     *        // Displays "First or Second"
-     *        const rawMessage = { translate: "accessibility.list.or.two", with: ["First", "Second"] };
-     *        player.sendMessage(rawMessage);
-     *
+     * // Displays "First or Second"
+     * const rawMessage = { translate: "accessibility.list.or.two", with: ["First", "Second"] };
+     * player.sendMessage(rawMessage);
      * ```
      */
     sendMessage(message: (RawMessage | string)[] | RawMessage | string): void;
@@ -1911,33 +1936,29 @@ export class World {
      * is provided to `score`.
      * @example nestedTranslation.ts
      * ```typescript
-     *        // Displays "Apple or Coal"
-     *        let rawMessage = {
-     *          translate: "accessibility.list.or.two",
-     *          with: { rawtext: [{ translate: "item.apple.name" }, { translate: "item.coal.name" }] },
-     *        };
-     *        world.sendMessage(rawMessage);
-     *
+     * // Displays "Apple or Coal"
+     * let rawMessage = {
+     *   translate: "accessibility.list.or.two",
+     *   with: { rawtext: [{ translate: "item.apple.name" }, { translate: "item.coal.name" }] },
+     * };
+     * world.sendMessage(rawMessage);
      * ```
      * @example scoreWildcard.ts
      * ```typescript
-     *        // Displays the player's score for objective "obj". Each player will see their own score.
-     *        const rawMessage = { score: { name: "*", objective: "obj" } };
-     *        world.sendMessage(rawMessage);
-     *
+     * // Displays the player's score for objective "obj". Each player will see their own score.
+     * const rawMessage = { score: { name: "*", objective: "obj" } };
+     * world.sendMessage(rawMessage);
      * ```
      * @example simpleString.ts
      * ```typescript
-     *        // Displays "Hello, world!"
-     *        world.sendMessage("Hello, world!");
-     *
+     * // Displays "Hello, world!"
+     * world.sendMessage("Hello, world!");
      * ```
      * @example translation.ts
      * ```typescript
-     *        // Displays "First or Second"
-     *        const rawMessage = { translate: "accessibility.list.or.two", with: ["First", "Second"] };
-     *        world.sendMessage(rawMessage);
-     *
+     * // Displays "First or Second"
+     * const rawMessage = { translate: "accessibility.list.or.two", with: ["First", "Second"] };
+     * world.sendMessage(rawMessage);
      * ```
      */
     sendMessage(message: (RawMessage | string)[] | RawMessage | string): void;

package/package.json

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