@occultus/toolkit 0.22.4 → 0.23.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@occultus/toolkit",
-  "version": "0.22.4",
+  "version": "0.23.2",
   "repository": {
     "type": "git",
     "url": "https://codeberg.org/TeamOccultus/StarTenonAPI"
@@ -30,7 +30,7 @@
     "@occultus/common": "0.20.0"
   },
   "devDependencies": {
-    "typedoc": "^0.28.15"
+    "typedoc": "^0.28.16"
   },
   "scripts": {
     "test": "tsc"

package/src/entity/entityUtils.ts

@@ -173,7 +173,7 @@ export function clearEffect(
  * 状态效果持续时间，以刻为单位 *（20刻 = 1秒）*
  *
  * 其值必须在范围`[0, 20000000]`内
- * 
+ *
  * 如果值为`"infinite"`，则状态效果将无限期持续
  * @param options 状态效果选项
  * @since Starock 0.6.0 (0.1.0)
@@ -304,3 +304,63 @@ export function heal(entity: Entity, amount: number): number {
   } else health.setCurrentValue(newHealth);
   return newHealth;
 }
+
+/**
+ * 获取实体当前生命值
+ * @param entity 要获取生命值的实体
+ * @returns 
+ */
+export function getCurrentHealth(entity: Entity): number {
+  const health = entity.getComponent("minecraft:health");
+  if (!health)
+    throw new OccultusSDKError("The entity does not have health component!");
+  return health.currentValue;
+}
+
+/**
+ * 设置实体当前生命值
+ * @param entity 要设置生命值的实体
+ * @param value 要设置的生命值，若超出实体最大生命值，则重置为最大生命值
+ * @returns 
+ */
+export function setCurrentHealth(entity: Entity, value: number): number {
+  const health = entity.getComponent("minecraft:health");
+  if (!health)
+    throw new OccultusSDKError("The entity does not have health component!");
+  if(value > health.effectiveMax) {
+    health.resetToMaxValue();
+    return health.effectiveMax;
+  }
+  health.setCurrentValue(value);
+  return value;
+}
+
+/**
+ * 消耗实体生命值，这一行为不会被视为攻击
+ * @param entity 
+ * @param amount 
+ * @returns 
+ */
+export function consumeHealth(entity: Entity, amount: number): number {
+  const newHealth = getCurrentHealth(entity) - amount;
+  if(newHealth <= 0) {
+    entity.kill();
+    return 0;
+  }
+  return setCurrentHealth(entity, getCurrentHealth(entity) - amount);
+}
+
+/**
+ * 以指定倍率消耗实体的生命值，这一行为不会被视为攻击
+ * @param entity 
+ * @param amplifier 消耗生命的倍率，例如`0.8`将会被视为消耗实体当前 80% 的生命值
+ * @returns 
+ */
+export function consumeHealthAmplifier(entity: Entity, amplifier: number): number {
+  const newHealth = getCurrentHealth(entity) - (getCurrentHealth(entity) * amplifier);
+  if(newHealth <= 0) {
+    entity.kill();
+    return 0;
+  }
+  return setCurrentHealth(entity, newHealth);
+}

package/src/identifier/namespace.ts

@@ -1,4 +1,3 @@
-
 /**
  * 确保命名空间存在，若不存在则自动加上`minecraft:`命名空间
  * @param identifier 要检查的标识符
@@ -21,4 +20,4 @@ export function ensureNoNamespace(identifier: string): string {
     return identifier.split(":")[1];
   }
   return identifier;
-}
+}

package/src/index.ts

@@ -5,4 +5,5 @@ export * from "./entity/EntitiesUtils";
 export * from "./entity/entityUtils";
 export * from "./item/item";
 export * from "./item/container";
-export * from "./identifier/namespace";
+export * from "./identifier/namespace";
+export * from "./item/cooldown";

package/src/item/cooldown.ts

@@ -0,0 +1,26 @@
+import { ItemStack, Player } from "@minecraft/server";
+
+/**
+ * 返回物品是否处于冷却状态
+ * @param item 要检查的物品
+ * @param player 持有物品的玩家
+ * @return 是否处于冷却状态
+ */
+export function isInCooldown(item: ItemStack, player: Player): boolean {
+  const cooldown = item.getComponent("minecraft:cooldown");
+  if (!cooldown) return false;
+  return cooldown.getCooldownTicksRemaining(player) !== 0;
+}
+
+/**
+ * 让物品开始冷却
+ * @param item 要执行冷却操作的物品
+ * @param player 持有物品的玩家
+ * @return 是否成功执行冷却操作，若物品不支持冷却则返回`false`
+ */
+export function startCooldown(item: ItemStack, player: Player): boolean {
+  const cooldown = item.getComponent("minecraft:cooldown");
+  if (!cooldown) return false;
+  cooldown.startCooldown(player);
+  return true;
+}