@occultus/toolkit 0.23.3 → 0.23.5

package/LICENSE

@@ -1,9 +1,9 @@
-The MIT License (MIT)
-
-Copyright © 2025 CTN Studios
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-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.
+The MIT License (MIT)
+
+Copyright © 2025 CTN Studios
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+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/README.md

@@ -1,30 +1,30 @@
-# Star Tenon Toolkit
-
-一个轻量的 API 工具包，包括一些常用的工具函数，可用于实体以及 ItemStack。
-
-## 支持版本
-
-本 API 支持任意可以运行 Script API v2.0.0+ 的游戏版本，包括：
-
-- 1.21.90；
-- 1.21.100；
-- 1.21.110；
-- 以及更多……
-
-注意：本包理论上可以在部分更旧的版本上运作，但未经过严格的测试。
-
-## 协议
-
-本项目使用 MIT License 授权：
-
-```text
-The MIT License (MIT)
-
-Copyright © 2025 CTN Studios
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-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.
-```
+# Star Tenon Toolkit
+
+一个轻量的 API 工具包，包括一些常用的工具函数，可用于实体以及 ItemStack。
+
+## 支持版本
+
+本 API 支持任意可以运行 Script API v2.0.0+ 的游戏版本，包括：
+
+- 1.21.90；
+- 1.21.100；
+- 1.21.110；
+- 以及更多……
+
+注意：本包理论上可以在部分更旧的版本上运作，但未经过严格的测试。
+
+## 协议
+
+本项目使用 MIT License 授权：
+
+```text
+The MIT License (MIT)
+
+Copyright © 2025 CTN Studios
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+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.23.3",
+  "version": "0.23.5",
   "repository": {
     "type": "git",
     "url": "https://codeberg.org/TeamOccultus/StarTenonAPI"

package/src/entity/EntitiesUtils.ts

@@ -1,121 +1,121 @@
-import {
-  Dimension,
-  EntityQueryOptions,
-  Entity,
-  EntityApplyDamageByProjectileOptions,
-  EntityApplyDamageOptions,
-  EffectType,
-  EntityEffectOptions,
-  ItemStack
-} from "@minecraft/server";
-import { EffectGroups, EffectData } from "@occultus/common";
-import {
-  addEffect,
-  applyEffectData,
-  clearSlot,
-  giveItem,
-  heal
-} from "./entityUtils";
-
-/**
- * 适用于批量实体的相关工具
- * @since Starock 0.6.0 (0.1.0)
- * @example
- * new EntitiesUtils(world.getDimension("overworld"), {
- *   type: "minecraft:player",
- * }).damage(10);
- */
-
-export class EntitiesUtils {
-  /**
-   * @param dimension 实体所在的维度
-   * @param queryOption 查询实体的选项
-   */
-  constructor(
-    public dimension: Dimension,
-    public queryOption: EntityQueryOptions
-  ) {}
-  /**
-   * 查询给定条件下的实体
-   * @returns
-   */
-  query(): Entity[] {
-    return this.dimension.getEntities(this.queryOption);
-  }
-  /**
-   * 尝试对实体进行操作
-   * @param operate 操作函数，接受一个实体作为参数
-   */
-  tryOperateEntity(operate: (entity: Entity) => void) {
-    this.query().forEach((entity) => {
-      if (entity.isValid) {
-        operate(entity);
-      }
-    });
-  }
-  /**
-   * 对批量实体进行伤害
-   * @param amount 施加的伤害量
-   * @param options 关于伤害来源的额外选项，可能会增加额外的效果或造成受伤实体的额外行为
-   * @since Starock 0.6.0 (0.1.0)
-   */
-  applyDamage(
-    amount: number,
-    options?: EntityApplyDamageByProjectileOptions | EntityApplyDamageOptions
-  ) {
-    this.query().forEach((entity) => entity.applyDamage(amount, options));
-  }
-  /**
-   * 为批量实体添加效果
-   *
-   * @param effectType 效果的类型
-   * @param duration
-   * 效果持续时间，以刻为单位 *（20刻=1秒）*
-   *
-   * 其值必须在范围`[0, 20000000]`内
-   * @param effectOption 可选参数，状态效果的具体配置选项
-   * @since Starock 0.6.0 (0.1.0)
-   */
-  addEffect(
-    effectType: EffectType | EffectType[] | string | string[] | EffectGroups,
-    duration: number,
-    effectOption?: EntityEffectOptions
-  ) {
-    this.query().forEach((entity) =>
-      addEffect(entity, effectType, duration, effectOption)
-    );
-  }
-  /**
-   * 批量给予实体物品
-   * @param entity 要给予物品的实体
-   * @param item 要给予的物品
-   * @since Starock 0.6.0 (0.1.0)
-   */
-  giveItem(item: ItemStack) {
-    this.query().forEach((entity) => giveItem(entity, item));
-  }
-  /**
-   * 批量清空实体的容器
-   * @since Starock 0.6.0 (0.1.0)
-   */
-  clearSlot(): void {
-    this.query().forEach((entity) => clearSlot(entity));
-  }
-  /**
-   * 批量为实体应用 {@link EffectData }
-   * @param data 要应用的 {@link EffectData }
-   * @returns
-   */
-  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));
-  }
-}
+import {
+  Dimension,
+  EntityQueryOptions,
+  Entity,
+  EntityApplyDamageByProjectileOptions,
+  EntityApplyDamageOptions,
+  EffectType,
+  EntityEffectOptions,
+  ItemStack
+} from "@minecraft/server";
+import { EffectGroups, EffectData } from "@occultus/common";
+import {
+  addEffect,
+  applyEffectData,
+  clearSlot,
+  giveItem,
+  heal
+} from "./entityUtils";
+
+/**
+ * 适用于批量实体的相关工具
+ * @since Starock 0.6.0 (0.1.0)
+ * @example
+ * new EntitiesUtils(world.getDimension("overworld"), {
+ *   type: "minecraft:player",
+ * }).damage(10);
+ */
+
+export class EntitiesUtils {
+  /**
+   * @param dimension 实体所在的维度
+   * @param queryOption 查询实体的选项
+   */
+  constructor(
+    public dimension: Dimension,
+    public queryOption: EntityQueryOptions
+  ) {}
+  /**
+   * 查询给定条件下的实体
+   * @returns
+   */
+  query(): Entity[] {
+    return this.dimension.getEntities(this.queryOption);
+  }
+  /**
+   * 尝试对实体进行操作
+   * @param operate 操作函数，接受一个实体作为参数
+   */
+  tryOperateEntity(operate: (entity: Entity) => void) {
+    this.query().forEach((entity) => {
+      if (entity.isValid) {
+        operate(entity);
+      }
+    });
+  }
+  /**
+   * 对批量实体进行伤害
+   * @param amount 施加的伤害量
+   * @param options 关于伤害来源的额外选项，可能会增加额外的效果或造成受伤实体的额外行为
+   * @since Starock 0.6.0 (0.1.0)
+   */
+  applyDamage(
+    amount: number,
+    options?: EntityApplyDamageByProjectileOptions | EntityApplyDamageOptions
+  ) {
+    this.query().forEach((entity) => entity.applyDamage(amount, options));
+  }
+  /**
+   * 为批量实体添加效果
+   *
+   * @param effectType 效果的类型
+   * @param duration
+   * 效果持续时间，以刻为单位 *（20刻=1秒）*
+   *
+   * 其值必须在范围`[0, 20000000]`内
+   * @param effectOption 可选参数，状态效果的具体配置选项
+   * @since Starock 0.6.0 (0.1.0)
+   */
+  addEffect(
+    effectType: EffectType | EffectType[] | string | string[] | EffectGroups,
+    duration: number,
+    effectOption?: EntityEffectOptions
+  ) {
+    this.query().forEach((entity) =>
+      addEffect(entity, effectType, duration, effectOption)
+    );
+  }
+  /**
+   * 批量给予实体物品
+   * @param entity 要给予物品的实体
+   * @param item 要给予的物品
+   * @since Starock 0.6.0 (0.1.0)
+   */
+  giveItem(item: ItemStack) {
+    this.query().forEach((entity) => giveItem(entity, item));
+  }
+  /**
+   * 批量清空实体的容器
+   * @since Starock 0.6.0 (0.1.0)
+   */
+  clearSlot(): void {
+    this.query().forEach((entity) => clearSlot(entity));
+  }
+  /**
+   * 批量为实体应用 {@link EffectData }
+   * @param data 要应用的 {@link EffectData }
+   * @returns
+   */
+  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));
+  }
+}