@occultus/block-api 0.18.2

package/LICENSE

@@ -0,0 +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.

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "@occultus/block-api",
+  "version": "0.18.2",
+  "description": "Star Tenon block api",
+  "main": "src/index.ts",
+  "keywords": [
+    "Minecraft",
+    "Occultus SDK",
+    "Script API"
+  ],
+  "contributors": [
+    "FangLimao <mucigames@outlook.com>",
+    "RawDiamondMC <RawDiamondMC@outlook.com>"
+  ],
+  "license": "MIT",
+  "author": "CTN Studios",
+  "peerDependencies": {
+    "@occultus/core": ">=0.18.2 || <0.19.0",
+    "@minecraft/server": "2.3.0-beta.1.21.110-preview.20",
+    "@minecraft/server-ui": "2.1.0-beta.1.21.110-preview.20"
+  },
+  "dependencies": {
+    "@occultus/loot-api": "0.18.0",
+    "@occultus/entity-api": "0.18.1",
+    "@occultus/item-api": "0.18.2"
+  },
+  "type": "module",
+  "devDependencies": {
+    "typedoc": "^0.28.9"
+  }
+}

package/src/api/BlockWithDestroyCondition.ts

@@ -0,0 +1,15 @@
+/**
+ * 设置方块的掉落条件
+ *
+ * @example
+ * new BlockWithDestroyCondition("destroy_condition");
+ *
+ * @example
+ * "destroy_condition": {
+ *   "tag": "minecraft:is_pickaxe",
+ *   "loot_table": "blocks/lab_table"
+ * }
+ */
+export class BlockWithDestroyCondition {
+  constructor(readonly name: string) {}
+}

package/src/api/InteractableBlock.ts

@@ -0,0 +1,9 @@
+/**
+ * 允许玩家与方块交互的组件
+ */
+export class InteractableBlock {
+  /**
+   * @param name 可交互方块的名称，这个名称将会被注册为自定义组件
+   */
+  constructor(readonly name: string) {}
+}

package/src/api/OreBlock.ts

@@ -0,0 +1,12 @@
+import { BlockComponentPlayerBreakEvent } from "@minecraft/server";
+
+/**
+ * 表示自定义矿石方块的类
+ */
+export class OreBlock {
+  /**
+   * @param name 矿石方块的名称，这个名称将会被注册为自定义组件
+   */
+  constructor(readonly name: string) {}
+  onBreak: (arg: BlockComponentPlayerBreakEvent) => void = () => {};
+}

package/src/api/base/BlockRegistries.ts

@@ -0,0 +1,49 @@
+import { Registries } from "@occultus/core";
+import { RegistryBlock } from "../../types/RegistryBlock";
+import { InteractableBlock } from "../InteractableBlock";
+import { BlockInternalUtils } from "../../utils/BlockInternalUtils";
+import { OreBlock } from "../OreBlock";
+import { BlockWithDestroyCondition } from "../BlockWithDestroyCondition";
+import { system } from "@minecraft/server";
+
+export class BlockRegistries extends Registries {
+  constructor() {
+    super();
+  }
+  private registry: Map<string, RegistryBlock> = new Map();
+  id: string = "BlockRegistries";
+  delete(id: string) {
+    return this.registry.delete(id);
+  }
+  get(id: string) {
+    return this.registry.get(id);
+  }
+  has(id: string): boolean {
+    return this.registry.has(id);
+  }
+  getAll() {
+    return Array.from(this.registry.values());
+  }
+  add(value: RegistryBlock | RegistryBlock[]): void {
+    if (Array.isArray(value)) {
+      value.forEach((v) => this.registry.set(v.name, v));
+      return;
+    }
+    this.registry.set(value.name, value);
+  }
+  register(): void {
+    system.beforeEvents.startup.subscribe((init) => {
+      this.registry.forEach((value) => {
+        if (value instanceof InteractableBlock) {
+          BlockInternalUtils.registryInteractableBlockComponent(value, init);
+        }
+        if (value instanceof OreBlock) {
+          BlockInternalUtils.registryOreBlockComponent(value, init);
+        }
+        if (value instanceof BlockWithDestroyCondition) {
+          BlockInternalUtils.registryDestroyCondition(value, init);
+        }
+      });
+    });
+  }
+}

package/src/index.ts

@@ -0,0 +1,7 @@
+export * from "./api/base/BlockRegistries"
+export * from "./api/InteractableBlock"
+export * from "./api/OreBlock"
+export * from "./api/BlockWithDestroyCondition"
+export * from "./types/OreBlockParams"
+export * from "./types/BlockWithDestroyConditionParams"
+export * from "./types/RegistryBlock"

package/src/types/BlockWithDestroyConditionParams.ts

@@ -0,0 +1,19 @@
+export type BlockWithDestroyConditionParams = {
+  /**
+   * 方块被挖掘后掉落的战利品
+   * @example "block/ore/ruby_ore"
+   */
+  loot_table: string;
+  /**
+   * 挖掘矿石所需的物品标签
+   */
+  tag?: string;
+  /**
+   * 挖掘矿石所需最低工具等级
+   */
+  item_tier?: string;
+  /**
+   * 破坏矿石时给予玩家的经验值
+   */
+  item?: string;
+};

package/src/types/OreBlockParams.ts

@@ -0,0 +1,27 @@
+
+/**
+ * 描述自定义矿石方块组件参数的类型
+ */
+export type OreBlockParams = {
+  /**
+   * 方块被挖掘后掉落的战利品
+   * @example "block/ore/ruby_ore"
+   */
+  loot_table: string;
+  /**
+   * 挖掘矿石所需最低工具等级
+   */
+  item_tier?: string;
+  /**
+   * 挖掘矿石所需的物品标签
+   */
+  tag?: string;
+  /**
+   * 挖掘矿石所需的特定物品
+   */
+  item?: string;
+  /**
+   * 破坏矿石时给予玩家的经验值
+   */
+  exp?: number;
+};

package/src/types/RegistryBlock.ts

@@ -0,0 +1,8 @@
+import { InteractableBlock } from "../api/InteractableBlock";
+import { OreBlock } from "../api/OreBlock";
+import { BlockRegistries } from "../api/base/BlockRegistries";
+
+/**
+ * 需要通过 {@link BlockRegistries} 注册的方块类型
+ */
+export type RegistryBlock = OreBlock | InteractableBlock;

package/src/utils/BlockInternalUtils.ts

@@ -0,0 +1,64 @@
+import { GameMode, Player, system } from "@minecraft/server";
+import { InteractableBlock } from "../api/InteractableBlock";
+import { OreBlock } from "../api/OreBlock";
+import { OreBlockParams } from "../types/OreBlockParams";
+import { loot } from "@occultus/loot-api";
+import { ItemTier } from "@occultus/item-api";
+import { BlockWithDestroyCondition } from "../api/BlockWithDestroyCondition";
+import { BlockWithDestroyConditionParams } from "../types/BlockWithDestroyConditionParams";
+import { getEquipmentItem } from "@occultus/entity-api";
+import { StartupEvent } from "@minecraft/server";
+
+export class BlockInternalUtils {
+  static registryInteractableBlockComponent(
+    block: InteractableBlock,
+    arg: StartupEvent
+  ): void {
+    arg.blockComponentRegistry.registerCustomComponent(block.name, {
+      onPlayerInteract(arg) {},
+    });
+  }
+  static registryOreBlockComponent(block: OreBlock, arg: StartupEvent): void {
+    const that = this;
+    arg.blockComponentRegistry.registerCustomComponent(block.name, {
+      onPlayerBreak(callback, param) {
+        const p = param.params as OreBlockParams;
+        if (!callback.player) return;
+        if (block.onBreak) block.onBreak(callback);
+        if (callback.player.getGameMode() === GameMode.Creative) return;
+        if (that.checkCondition(callback.player, p)) {
+          loot(callback.dimension, callback.block.location, p.loot_table);
+          if (p.exp) callback.player.addExperience(p.exp);
+        }
+      },
+    });
+  }
+  static registryDestroyCondition(
+    block: BlockWithDestroyCondition,
+    arg: StartupEvent
+  ): void {
+    arg.blockComponentRegistry.registerCustomComponent(block.name, {
+      onPlayerBreak(callback, param) {
+        if (!callback.player) return;
+        const p = param.params as BlockWithDestroyConditionParams;
+        if (callback.player.getGameMode() === GameMode.Creative) return;
+        if (BlockInternalUtils.checkCondition(callback.player, p)) {
+          loot(callback.dimension, callback.block.location, p.loot_table);
+          return;
+        }
+      },
+    });
+  }
+  static checkCondition(
+    player: Player,
+    data: OreBlockParams | BlockWithDestroyConditionParams
+  ): boolean {
+    const item = getEquipmentItem(player);
+    if (!item) return false;
+    if (data.item) return item.typeId === data.item;
+    if (data.tag) return item.hasTag(data.tag);
+    if (data.item_tier)
+      return ItemTier.hasTier(ItemTier.stringfyTier(data.item_tier), item);
+    return false;
+  }
+}

package/tsconfig.json

@@ -0,0 +1,21 @@
+{
+  "include": ["src/*"],
+  "exclude": ["./out"],
+  "Modules": {
+    "resolvePackageJsonExports": true
+  },
+  "compilerOptions": {
+    "noEmit": true,
+    "noEmitOnError": true,
+    "target": "es2022",
+    "lib": ["es2020", "dom"],
+    "strict": true,
+    "esModuleInterop": true,
+    "module": "es2022",
+    "moduleResolution": "bundler",
+    "outDir": ".",
+    "removeComments": true,
+    "newLine": "lf",
+    "resolveJsonModule": true
+  }
+}