@occultus/toolkit 0.22.1 → 0.22.3

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.1",
+  "version": "0.22.3",
   "repository": {
     "type": "git",
     "url": "https://codeberg.org/TeamOccultus/StarTenonAPI"

package/src/entity/EntitiesUtils.ts

@@ -9,7 +9,13 @@ import {
   ItemStack
 } from "@minecraft/server";
 import { EffectGroups, EffectData } from "@occultus/common";
-import { addEffect, applyEffectData, clearSlot, giveItem } from "./entityUtils";
+import {
+  addEffect,
+  applyEffectData,
+  clearSlot,
+  giveItem,
+  heal
+} from "./entityUtils";
 
 /**
  * 适用于批量实体的相关工具
@@ -103,4 +109,13 @@ export class EntitiesUtils {
   applyEffectData(data: EffectData | EffectData[]): void {
     return this.query().forEach((entity) => applyEffectData(entity, data));
   }
+  /**
+   * 恢复实体的生命值
+   * @param amount 恢复的生命值，若治愈后生命值超过最大生命值，则重置为最大生命值
+   * @return 治愈后的生命值
+   * @throws 如果实体没有`minecraft:health`组件，则抛出`OccultusSDKError`
+   */
+  heal(amount: number) {
+    this.query().forEach((entity) => heal(entity, amount));
+  }
 }

package/src/entity/entityUtils.ts

@@ -5,7 +5,6 @@ import {
   Entity,
   EntityComponentTypes,
   EntityEffectOptions,
-  EntityEquippableComponent,
   EquipmentSlot,
   ItemStack,
   Player
@@ -173,19 +172,27 @@ export function clearEffect(
  * 状态效果持续时间，以刻为单位 *（20刻 = 1秒）*
  *
  * 其值必须在范围`[0, 20000000]`内
+ * 
+ * 如果值为`"infinite"`，则状态效果将无限期持续
  * @param options 状态效果选项
  * @since Starock 0.6.0 (0.1.0)
  */
 export function addEffect(
   entity: Entity,
   effectType: EffectType | EffectType[] | string | string[] | EffectGroups,
-  duration: number,
+  duration: number | "infinite",
   options?: EntityEffectOptions
 ): void {
   const effects =
     effectGroupMap[effectType as EffectGroups] ||
     (Array.isArray(effectType) ? effectType : [effectType]);
   for (const effect of effects) {
+    if (duration === "infinite") {
+      entity.runCommand(
+        `effect @s ${effect} infinite ${options?.amplifier ?? 0} ${options?.showParticles ?? false}`
+      );
+      return;
+    }
     entity.addEffect(effect, duration, options);
   }
 }
@@ -277,3 +284,22 @@ export function consumeEquipmentAmount(
   if (!item) return false;
   return setEquipmentItem(player, consumeAmount(item, amount));
 }
+
+/**
+ * 恢复实体的生命值
+ * @param entity 将要被治疗的实体
+ * @param amount 恢复的生命值，若治愈后生命值超过最大生命值，则重置为最大生命值
+ * @return 治愈后的生命值
+ * @throws 如果实体没有`minecraft:health`组件，则抛出`OccultusSDKError`
+ */
+export function heal(entity: Entity, amount: number): number {
+  const health = entity.getComponent("minecraft:health");
+  if (!health)
+    throw new OccultusSDKError("The entity does not have health component!");
+  const newHealth = health.currentValue + amount;
+  if (newHealth > health.effectiveMax) {
+    health.resetToMaxValue();
+    return health.effectiveMax;
+  } else health.setCurrentValue(newHealth);
+  return newHealth;
+}

package/src/item/container.ts

@@ -1,4 +1,9 @@
-import { Container, ItemStack } from "@minecraft/server";
+import { Container, EquipmentSlot, ItemStack, Player } from "@minecraft/server";
+import {
+  getContainer,
+  getEquipmentItem,
+  setEquipmentItem
+} from "../entity/entityUtils";
 
 /**
  * 获取容器中指定含指定物品标签的物品的数量
@@ -70,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;
 }
 
 /**