@occultus/toolkit 0.22.0 → 0.22.2

package/README.md

@@ -28,4 +28,3 @@ The above copyright notice and this permission notice shall be included in all c
 
 THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 ```
-

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@occultus/toolkit",
-  "version": "0.22.0",
+  "version": "0.22.2",
   "repository": {
     "type": "git",
     "url": "https://codeberg.org/TeamOccultus/StarTenonAPI"
@@ -24,13 +24,13 @@
   "author": "CTN Studios",
   "dependencies": {},
   "peerDependencies": {
-    "@minecraft/server": ">=2.0.0",
-    "@minecraft/server-ui": ">=2.0.0",
-    "@occultus/core": ">=0.18.4 || <0.19.0",
+    "@minecraft/server": "^2.4.0",
+    "@minecraft/server-ui": "^2.0.0",
+    "@occultus/core": "~0.18.4",
     "@occultus/common": "0.20.0"
   },
   "devDependencies": {
-    "typedoc": "^0.28.9"
+    "typedoc": "^0.28.15"
   },
   "scripts": {
     "test": "tsc"

package/src/entity/EntitiesUtils.ts

@@ -6,7 +6,7 @@ import {
   EntityApplyDamageOptions,
   EffectType,
   EntityEffectOptions,
-  ItemStack,
+  ItemStack
 } from "@minecraft/server";
 import { EffectGroups, EffectData } from "@occultus/common";
 import { addEffect, applyEffectData, clearSlot, giveItem } from "./entityUtils";
@@ -101,8 +101,6 @@ export class EntitiesUtils {
    * @returns
    */
   applyEffectData(data: EffectData | EffectData[]): void {
-    return this.query().forEach((entity) =>
-      applyEffectData(entity, data)
-    );
+    return this.query().forEach((entity) => applyEffectData(entity, data));
   }
 }

package/src/entity/entityUtils.ts

@@ -3,11 +3,11 @@ import {
   Effect,
   EffectType,
   Entity,
+  EntityComponentTypes,
   EntityEffectOptions,
-  EntityEquippableComponent,
   EquipmentSlot,
   ItemStack,
-  Player,
+  Player
 } from "@minecraft/server";
 import { EffectData, effectGroupMap, EffectGroups } from "@occultus/common";
 import { OccultusSDKError } from "@occultus/core";
@@ -32,9 +32,10 @@ export function tryOperateEntity(
 }
 
 /**
- * 获取给定实体的指定槽位物品
+ * 获取给定**玩家**的指定装备槽物品 {@see EquipmentSlot}
+ *
+ * 注意：该方法仅适用于玩家实体
  *
- * **IMPORTANT: 受原版接口限制， 当前只能获取玩家的装备**
  * @param entity 要获取槽位的实体
  * @param slot 要获取的槽位，默认为 {@link EquipmentSlot.Mainhand}
  * @return 槽位中的物品
@@ -44,16 +45,16 @@ export function getEquipmentItem(
   entity: Entity,
   slot = EquipmentSlot.Mainhand
 ): ItemStack | undefined {
-  const equipment = entity?.getComponent(
-    "minecraft:equippable"
-  ) as EntityEquippableComponent;
-  return equipment?.getEquipment(slot);
+  return entity
+    ?.getComponent(EntityComponentTypes.Equippable)
+    ?.getEquipment(slot);
 }
 
 /**
- * 设置给定实体的指定槽位物品
+ * 设置给定**玩家**的指定装备槽物品 {@see EquipmentSlot}
+ *
+ * 注意：该方法仅适用于玩家实体
  *
- * **IMPORTANT: 受原版接口限制， 当前只能获取玩家的装备**
  * @param entity 要设置槽位的实体
  * @param item 要设置的物品，如果为undefined则清空该槽位
  * @param slot 要设置的槽位，默认为 {@link EquipmentSlot.Mainhand}
@@ -64,11 +65,11 @@ export function setEquipmentItem(
   item?: ItemStack,
   slot: EquipmentSlot = EquipmentSlot.Mainhand
 ): boolean {
-  const equipment = entity?.getComponent(
-    "minecraft:equippable"
-  ) as EntityEquippableComponent;
-  if (!equipment) return false;
-  return equipment?.setEquipment(slot, item);
+  return (
+    entity
+      ?.getComponent(EntityComponentTypes.Equippable)
+      ?.setEquipment(slot, item) ?? false
+  );
 }
 
 /**
@@ -79,7 +80,7 @@ export function setEquipmentItem(
  * @since Starock 0.6.0 (0.1.0)
  */
 export function getContainer(entity: Entity): Container | undefined {
-  return entity.getComponent("minecraft:inventory")?.container;
+  return entity.getComponent(EntityComponentTypes.Inventory)?.container;
 }
 
 /**
@@ -140,7 +141,7 @@ export function applyEffectData(
   return data.flatMap((effectData) => {
     return entity.addEffect(effectData.effectType, effectData.duration, {
       amplifier: effectData.amplifier,
-      showParticles: effectData.showParticles,
+      showParticles: effectData.showParticles
     });
   });
 }

package/src/index.ts

@@ -1,7 +1,7 @@
 /**
  * @module toolkit
  */
-export * from "./entity/EntitiesUtils"
-export * from "./entity/entityUtils"
-export * from "./item/item"
-export * from "./item/container"
+export * from "./entity/EntitiesUtils";
+export * from "./entity/entityUtils";
+export * from "./item/item";
+export * from "./item/container";

package/src/item/container.ts

@@ -1,4 +1,57 @@
-import { Container, ItemStack } from "@minecraft/server";
+import { Container, EquipmentSlot, ItemStack, Player } from "@minecraft/server";
+import {
+  getContainer,
+  getEquipmentItem,
+  setEquipmentItem
+} from "../entity/entityUtils";
+
+/**
+ * 获取容器中指定含指定物品标签的物品的数量
+ * @param container 容器对象
+ * @param tag 要获取的物品标签
+ * @returns 容器中指定物品的数量
+ * @author RawDiamondMC, FangLiulii
+ */
+
+export function getTagItemAmountInContainer(
+  container: Container,
+  tag: string
+): number {
+  let amount = 0;
+  for (let slot = 0; slot < container.size; slot++) {
+    const itemStack: undefined | ItemStack = container.getItem(slot);
+    if (itemStack?.hasTag(tag)) {
+      amount += itemStack.amount;
+    }
+  }
+  return amount;
+}
+
+/**
+ * 从容器中移除指定数量的含有特定标签的物品
+ * @param container 容器对象
+ * @param tag 物品标签
+ * @param amount 要移除物品的数量
+ * @author RawDiamondMC, FangLiulii
+ */
+export function removeTagItemInContainer(
+  container: Container,
+  tag: string,
+  amount: number
+): void {
+  for (let slot = 0; slot < container.size; slot++) {
+    const itemStack: undefined | ItemStack = container.getItem(slot);
+    if (itemStack?.hasTag(tag)) {
+      if (itemStack.amount > amount) {
+        itemStack.amount -= amount;
+        container.setItem(slot, itemStack);
+        return;
+      }
+      container.setItem(slot);
+      amount -= itemStack.amount;
+    }
+  }
+}
 
 /**
  * 获取容器中指定物品的数量
@@ -22,30 +75,109 @@ export function getItemAmountInContainer(
   return amount;
 }
 
+/**
+ * 获取玩家身上的所有物品（包含装备栏与副手）
+ * @param player 玩家对象
+ * @param typeId 要获取的物品 ID
+ * @returns 容器中指定物品的数量
+ * @author RawDiamondMC
+ */
+
+export function getItemAmountOfPlayer(player: Player, typeId: string): number {
+  const container = player.getComponent("minecraft:inventory")?.container;
+  if (!container) return 0;
+  let amount = getItemAmountInContainer(container, typeId);
+  // 不包含主手，防止重复计算
+  const slots = [
+    EquipmentSlot.Head,
+    EquipmentSlot.Chest,
+    EquipmentSlot.Legs,
+    EquipmentSlot.Feet,
+    EquipmentSlot.Offhand
+  ];
+  for (const slot of slots) {
+    const itemStack = getEquipmentItem(player, slot);
+    if (itemStack?.typeId === typeId) {
+      amount += itemStack.amount;
+    }
+  }
+  return amount;
+}
+
 /**
  * 从容器中移除指定数量的物品
  * @param container 容器对象
  * @param typeId 物品 ID
  * @param amount 要移除物品的数量
+ * @returns 未能够移除完的物品数量
  * @author RawDiamondMC
  */
 export function removeItemInContainer(
   container: Container,
   typeId: string,
   amount: number
-): void {
+): number {
   for (let slot = 0; slot < container.size; slot++) {
+    // 物品已经移除完毕
+    if (amount <= 0) return 0;
     const itemStack: undefined | ItemStack = container.getItem(slot);
     if (itemStack?.typeId === typeId) {
+      // 这个槽位的物品数量足够移除
       if (itemStack.amount > amount) {
         itemStack.amount -= amount;
         container.setItem(slot, itemStack);
-        return;
+        // 直接返回，因为肯定移除完毕了
+        return 0;
       }
       container.setItem(slot);
       amount -= itemStack.amount;
     }
   }
+  return amount;
+}
+
+/**
+ * 从玩家身上移除一定量的物品
+ * @param player 玩家对象
+ * @param typeId 物品 ID
+ * @param amount 要移除物品的数量
+ * @returns 未能够移除完的物品数量
+ * @author RawDiamondMC
+ */
+export function removeItemOfPlayer(
+  player: Player,
+  typeId: string,
+  amount: number
+): number {
+  // 玩家肯定得有inventory组件
+  let remaining = removeItemInContainer(getContainer(player)!, typeId, amount);
+  // 已经移除完毕
+  if (remaining <= 0) return 0;
+  // 不包含主手，防止重复计算
+  const slots = [
+    EquipmentSlot.Head,
+    EquipmentSlot.Chest,
+    EquipmentSlot.Legs,
+    EquipmentSlot.Feet,
+    EquipmentSlot.Offhand
+  ];
+  for (const slot of slots) {
+    // 物品已经移除完毕
+    if (remaining <= 0) return 0;
+    const itemStack = getEquipmentItem(player, slot);
+    if (itemStack?.typeId === typeId) {
+      // 这个槽位的物品数量足够移除
+      if (itemStack.amount > remaining) {
+        itemStack.amount -= remaining;
+        setEquipmentItem(player, itemStack, slot);
+        // 直接返回，因为肯定移除完毕了
+        return 0;
+      }
+      setEquipmentItem(player, itemStack, slot);
+      remaining -= itemStack.amount;
+    }
+  }
+  return remaining;
 }
 
 /**

package/src/item/item.ts

@@ -5,7 +5,7 @@ import {
   ItemComponentTypes,
   ItemDurabilityComponent,
   Player,
-  GameMode,
+  GameMode
 } from "@minecraft/server";
 import { OccultusSDKError } from "@occultus/core";
 
@@ -48,6 +48,10 @@ export function consumeDurability(
 
 /**
  * 消耗物品的数量
+ *
+ * 注意！这个函数不会直接修改传入的物品堆，而是返回一个新的物品堆。在原版，直接修改物品堆的数量不会正确同步，需要重新设定。
+ * F**K U Mojang
+ *
  * @param item 要消耗物品的数量
  * @param value 要消耗的数量
  * @returns 消耗后的物品堆