@occultus/condition-api 0.22.0-alpha.2 → 0.22.0-alpha.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@occultus/condition-api",
-  "version": "0.22.0-alpha.2",
+  "version": "0.22.0-alpha.3",
   "repository": {
     "type": "git",
     "url": "https://codeberg.org/TeamOccultus/StarTenonAPI"
@@ -23,16 +23,16 @@
   "license": "MIT",
   "author": "CTN Studios",
   "peerDependencies": {
-    "@minecraft/server": ">=2.0.0",
-    "@occultus/core": ">=0.18.4 || <0.19.0"
+    "@minecraft/server": "^2.4.0",
+    "@occultus/core": "~0.18.4"
   },
   "dependencies": {
-    "@occultus/toolkit": "0.22.0",
     "@occultus/format-api": "0.21.0",
+    "@occultus/toolkit": "0.22.1",
     "@occultus/text-api": "0.20.0"
   },
   "devDependencies": {
-    "typedoc": "^0.28.9"
+    "typedoc": "^0.28.15"
   },
   "scripts": {
     "test": "tsc"

package/src/api/Conditions.ts

@@ -30,5 +30,4 @@ export abstract class Conditions {
    * @return 用于显示失败原因的文本
    */
   abstract getFailedReason(): TextProvider;
-  
 }

package/src/api/ExpCondition.ts

@@ -30,9 +30,9 @@ export class ExpConditions extends Conditions {
         // 达到 %s 级
         {
           translate: "task.condition.level",
-          with: { text: this.experience.toString() },
-        },
-      ],
+          with: { text: this.experience.toString() }
+        }
+      ]
     };
   }
   getFailedReason(): RawMessage {
@@ -41,9 +41,9 @@ export class ExpConditions extends Conditions {
         // 你需要达到 %s 级
         {
           translate: "task.condition.level.failed",
-          with: { text: this.experience.toString() },
-        },
-      ],
+          with: { text: this.experience.toString() }
+        }
+      ]
     };
   }
 }

package/src/api/ItemConditions.ts

@@ -2,7 +2,7 @@ import { ItemStack, Player, RawMessage } from "@minecraft/server";
 import { Conditions } from "./Conditions";
 import {
   getItemAmountInContainer,
-  removeItemInContainer,
+  removeItemInContainer
 } from "@occultus/toolkit";
 import { TextProvider } from "@occultus/text-api";
 
@@ -24,17 +24,17 @@ export class ItemConditions extends Conditions {
   }
   /**
    * 获取条件对应的 ItemStack
-   * @returns 
+   * @returns
    */
   getItem() {
     return new ItemStack(this.itemType, this.amount);
   }
   /**
    * 检查玩家是否符合该条件的要求
-   * 
+   *
    * **IMPORTANT: 若`consumeAmount`属性被设置为`true`，则当检查通过时将对玩家的背包进行修改**
-   * @param player 
-   * @return 
+   * @param player
+   * @return
    */
   check(player: Player) {
     const container = player.getComponent("minecraft:inventory")?.container;
@@ -49,20 +49,20 @@ export class ItemConditions extends Conditions {
   }
   /**
    * 获得条件对应的 {@link TextProvider}
-   * @returns 
+   * @returns
    */
   getTextProvider(): RawMessage {
     return {
       rawtext: [
         { translate: this.getItem().localizationKey },
         { text: " × " },
-        { text: this.getItem().amount.toString() },
-      ],
+        { text: this.getItem().amount.toString() }
+      ]
     };
   }
   /**
    * 获得条件对应的失败原因
-   * @returns 
+   * @returns
    */
   getFailedReason(): RawMessage {
     return {
@@ -72,8 +72,8 @@ export class ItemConditions extends Conditions {
         { text: " " },
         { translate: this.getItem().localizationKey },
         { text: " × " },
-        { text: this.getItem().amount.toString() },
-      ],
+        { text: this.getItem().amount.toString() }
+      ]
     };
   }
 }

package/src/api/ItemTagConditions.ts

@@ -0,0 +1,75 @@
+import { Player, RawMessage } from "@minecraft/server";
+import { Conditions } from "./Conditions";
+import {
+  getTagItemAmountInContainer,
+  removeTagItemInContainer,
+} from "@occultus/toolkit";
+import { TextProvider } from "@occultus/text-api";
+
+/**
+ * 物品标签条件
+ */
+export class ItemTagConditions extends Conditions {
+  /**
+   * @param tag 满足条件所需要的物品标签
+   * @param amount 满足条件所需要的物品数量，默认为 1
+   * @param translateKey 条件对应的翻译键
+   * @param consumeAmount 检查通过时是否消耗物品，默认为 false
+   */
+  constructor(
+    protected tag: string,
+    protected amount: number = 1,
+    protected translateKey: string,
+    protected consumeAmount: boolean = false
+  ) {
+    super(tag);
+  }
+  /**
+   * 检查玩家是否符合该条件的要求
+   *
+   * **IMPORTANT: 若`consumeAmount`属性被设置为`true`，则当检查通过时将对玩家的背包进行修改**
+   * @param player
+   * @return
+   */
+  check(player: Player) {
+    const container = player.getComponent("minecraft:inventory")?.container;
+    if (!container) return false;
+    const amount = getTagItemAmountInContainer(container, this.tag);
+
+    if (amount >= this.amount) {
+      if (!this.consumeAmount) return true;
+      removeTagItemInContainer(container, this.tag, this.amount);
+      return true;
+    }
+    return false;
+  }
+  /**
+   * 获得条件对应的 {@link TextProvider}
+   * @returns
+   */
+  getTextProvider(): RawMessage {
+    return {
+      rawtext: [
+        { translate: "task.condition.itemTag" },
+        { text: " × " },
+        { text: this.translateKey },
+      ],
+    };
+  }
+  /**
+   * 获得条件对应的失败原因
+   * @returns
+   */
+  getFailedReason(): RawMessage {
+    return {
+      rawtext: [
+        // 你缺少这些物品：
+        { translate: "task.condition.itemTag.failed" },
+        { text: " " },
+        { translate: this.translateKey },
+        { text: " × " },
+        { text: this.amount.toString() },
+      ],
+    };
+  }
+}

package/src/api/KillEntityCondition.ts

@@ -4,16 +4,14 @@ import { Localization } from "@occultus/format-api";
 
 /**
  * 击杀实体条件
- * 
+ *
  * **IMPORTANT: 此条件必须调用 {@link Task.pushToServer()} 方法才能生效**
  */
 export class KillEntityConditions extends Conditions {
   /**
    * @param entityType 满足条件所需要的实体类型
    */
-  constructor(
-    public entityType: string
-  ) {
+  constructor(public entityType: string) {
     super(entityType);
   }
   check(player: Player) {
@@ -24,8 +22,8 @@ export class KillEntityConditions extends Conditions {
       rawtext: [
         // 击杀实体：
         { translate: "task.condition.killentity" },
-        { translate: Localization.getEntityKey(this.entityType) },
-      ],
+        { translate: Localization.getEntityKey(this.entityType) }
+      ]
     };
   }
   getFailedReason(): RawMessage {
@@ -34,8 +32,8 @@ export class KillEntityConditions extends Conditions {
         // 你需要击杀实体：
         { translate: "task.condition.killentity.failed" },
         { text: " " },
-        { translate: Localization.getEntityKey(this.entityType) },
-      ],
+        { translate: Localization.getEntityKey(this.entityType) }
+      ]
     };
   }
 }

package/src/api/KillEntityFamilyCondition.ts

@@ -3,7 +3,7 @@ import { Conditions } from "./Conditions";
 
 /**
  * 击杀实体条件
- * 
+ *
  * **IMPORTANT: 此条件必须调用 {@link Task.pushToServer()} 方法才能生效**
  */
 export class KillEntityFamilyConditions extends Conditions {
@@ -24,8 +24,8 @@ export class KillEntityFamilyConditions extends Conditions {
       rawtext: [
         // 击杀此类实体：
         { translate: "task.condition.killEntityFamily" },
-        { translate: this.localizationKey },
-      ],
+        { translate: this.localizationKey }
+      ]
     };
   }
   getFailedReason(): RawMessage {
@@ -34,8 +34,8 @@ export class KillEntityFamilyConditions extends Conditions {
         // 你需要击杀此类实体：
         { translate: "task.condition.killEntityFamily.failed" },
         { text: " " },
-        { translate: this.localizationKey },
-      ],
+        { translate: this.localizationKey }
+      ]
     };
   }
 }

package/src/api/LevelCondition.ts

@@ -29,9 +29,9 @@ export class LevelConditions extends Conditions {
         // 达到 %s 级
         {
           translate: "task.condition.level",
-          with: { text: this.level.toString() },
-        },
-      ],
+          with: { text: this.level.toString() }
+        }
+      ]
     };
   }
   getFailedReason(): RawMessage {
@@ -40,9 +40,9 @@ export class LevelConditions extends Conditions {
         // 你需要达到 %s 级
         {
           translate: "task.condition.level.failed",
-          with: { text: this.level.toString() },
-        },
-      ],
+          with: { text: this.level.toString() }
+        }
+      ]
     };
   }
 }