sapdon 3.2.2 → 3.3.3

package/doc/BlockAPI.md

@@ -1,145 +0,0 @@
-# 方块工厂类 (BlockAPI) API 文档
-
-## 类描述
-
-`BlockAPI` 是一个工厂函数集合，用于创建和管理多种类型的游戏方块，并自动注册到游戏系统中。支持基础方块、旋转方块、几何方块、矿物方块和作物方块的创建。
-
----
-
-## BlockAPI 工厂函数
-
-### `createBasicBlock(identifier, category, textures_arr, options = {})`
-
-创建基础方块。
-
-#### 参数
-
-- `identifier` (string): 方块的唯一标识符，格式为"命名空间:名称" (例："my_mod:stone_block")。
-- `category` (string): 在创造模式物品栏的分类，可选值： "construction", "nature", "equipment", "items", and "none"。
-- `textures_arr` (string[]): 6面纹理数组，顺序为 [上, 下, 东, 西, 南, 北]
-- `options` (Object): 可选参数，默认为空。
-    - `group` (string): 分组名称，默认 "construction"。
-    - `hide_in_command` (boolean): 是否在命令中隐藏，默认 `false`。
-
-#### 返回值
-
-- `BasicBlock`: 基础方块实例
-
----
-
-### `createBlock(identifier, category, variantDatas, options = {})`
-
-创建含变体状态的标准方块。
-
-#### 参数
-
-- `identifier` (string): 方块的唯一标识符。
-- `category` (string): 在创造模式物品栏的分类，可选值： "construction", "nature", "equipment", "items", and "none"
-- `variantDatas` (Array): 变体数据数组，每个元素包含：
-    - `stateTag` (number): 状态标签 0-15 最大15
-    - `textures` (string[]): 对应状态的6面，纹理顺序为 [上, 下, 东, 西, 南, 北]
-- `options` (Object): 可选参数，默认为空。
-    - `options.group` (string): 分组，默认为 "construction"。
-    - `options.hide_in_command` (boolean): 是否在命令中隐藏，默认为 false。
-    - `ambient_occlusion` (boolean): 环境光遮蔽，默认 `false`
-    - `face_dimming` (boolean): 面亮度衰减，默认 `false`
-    - `render_method` (string): 渲染模式，可选 "opaque"/"blend"/"alpha_test"
-
-#### 返回值
-
-- `Block`: 标准方块实例
-
----
-
-### `createRotatableBlock(identifier, category, textures_arr, options = {})`
-
-创建支持多方向旋转的方块。
-
-#### 参数
-
-- `identifier` (string): 矿物方块的唯一标识符。
-- `category` (string): 在创造模式物品栏的分类，可选值："construction", "nature", "equipment", "items", and "none"
-- `textures_arr` (string[]): 6面纹理数组，顺序为 [上, 下, 东, 西, 南, 北]。
-- `options` (Object): 可选参数，默认为空。
-    - `options.group` (string): 分组，默认为 "construction"。
-    - `options.hide_in_command` (boolean): 是否在命令中隐藏，默认为 false。
-    - `options.rotationType` (string): 旋转类型，默认为 "cardinal"。
-    - `options.yRotationOffset` (number): 初始旋转偏移量，默认为 180。
-
-#### 返回值
-
-- `RotatableBlock`: 旋转方块实例
-
----
-
-### `createGeometryBlock(identifier, category, geometry, material_instances, options = {})`
-
-创建自定义几何模型方块。
-
-#### 参数
-
-- `identifier` (string): 方块的唯一标识符。
-- `category` (string): 在创造模式物品栏的分类，可选值："construction", "nature", "equipment","items" and "none"。
-- `geometry` (string): 几何模型标识符 (例："geometry.custom_model")。
-- `material_instances` (Object): 材质实例配置。
-    - 撰写文档者不晓得具体内容应该填啥
-- `options` (Object): 可选参数，默认为空。
-    - `options.group` (string): 分组，默认为 "construction"。
-    - `options.hide_in_command` (boolean): 是否在命令中隐藏，默认为 false。
-
-#### 返回值
-
-- `GeometryBlock`: 自定义几何模型方块实例
-
----
-
-### `createOreBlock(identifier, category, textures_arr, options = {})`
-
-创建矿物生成方块。
-
-#### 参数
-
-- `identifier` (string): 矿物方块的唯一标识符。
-- `category` (string): 在创造模式物品栏的分类，可选值："construction", "nature", "equipment", "items" and "none"。
-- `textures_arr` (string[]): 6面纹理数组，顺序为 [上, 下, 东, 西, 南, 北]。
-- `options` (Object): 可选参数，默认为空。
-    - `options.group` (string): 分组，默认为 "construction"。
-    - `options.hide_in_command` (boolean): 是否在命令中隐藏，默认为 false。
-
-#### 返回值
-
-- `OreBlock`: 矿物方块实例
-
----
-
-### `createCropBlock(identifier, category, variantDatas, options = {})`
-
-创建农作物方块。
-
-#### 参数
-
-- `identifier` (string): 作物方块的唯一标识符。
-- `category` (string): 在创造模式物品栏的分类，可选值："construction", "nature", "equipment", "items" and "none"。
-- `variantDatas` (Array): 变体数据数组，每个元素包含：
-  - `stateTag` (number): 状态标签 0-15 最大15
-  - `textures` (string[]): 对应状态的6面纹理
-- `options` (Object): 可选参数，默认为空。
-    - `options.group` (string): 分组，默认为 "construction"。
-    - `options.hide_in_command` (boolean): 是否在命令中隐藏，默认为 false。
-    - `options.ambient_occlusion` (boolean): 是否应用环境光遮蔽，默认为 false。
-    - `options.face_dimming` (boolean): 是否根据面的方向进行亮度调整，默认为 false。
-    - `options.render_method` (string): 渲染方法，默认为 "alpha_test"。
-
-#### 返回值
-
-- `CropBlock`: 作物方块实例
-
----
-
-## 版本兼容性
-
-| 功能 | 最低版本 | 依赖组件 |
-|------|---------|---------|
-| 几何方块 | 1.16.20 | minecraft:geometry |
-| 矿脉生成 | 1.18.30 | ore_feature |
-| 动态碰撞箱 | 1.17.10 | permutation |

package/doc/api.md

@@ -1,128 +0,0 @@
-# 物品类 (Item) 和 ItemAPI 工厂函数 API 文档
-
-## 类描述
-`Item` 类用于创建一个物品对象，该对象可以包含多种组件，并且可以转换为 JSON 格式，用于在特定的游戏中定义物品。`ItemAPI` 是一个工厂函数集合，用于简化物品的创建过程，支持创建普通物品、食物、可附着物品以及胸甲护甲等。
-
-## Item 类
-
-### 构造函数
-### `constructor(identifier, category, texture, options = {})`
-创建一个新的物品实例。
-
-#### 参数
-- `identifier` (string): 物品的唯一标识符。由命名空间与名字组成，例如"hello_sapdon:my_item"
-- `category` (string): 物品所属的菜单栏分类，可选值包括："construction", "nature", "equipment", "items", 和 "none"。
-- `texture` (string): 物品的纹理。
-- `options` (Object): 可选参数配置对象。默认为空对象。
-  - `group` (string): 分组名称。
-  - `hide_in_command` (boolean): 是否在命令中隐藏物品。默认为 `false`。
-  - `max_stack_size` (number): 物品的最大堆叠数量。默认为 `64`。
-
-#### 抛出异常
-- 当 `identifier`, `category`, 或 `texture` 参数缺失或不是字符串时，抛出 `Error`。
-
-### 方法
-
-### `addComponent(componentMap)`
-向物品添加新的组件。
-
-##### 参数
-- `componentMap` (Map): 组件的 Map 对象。
-
-##### 抛出异常
-- 当 `componentMap` 参数缺失或不是 Map 实例时，抛出 `Error`。
-
-### `removeComponent(key)`
-从物品中移除一个组件。
-
-##### 参数
-- `key` (string): 组件的名称。
-
-##### 抛出异常
-- 当 `key` 参数缺失或不是字符串时，抛出 `Error`。
-
-### `@Serializer` 装饰器
-将物品转换为 Addon JSON 对象，以便在游戏中定义物品。
-
-##### 返回值
-- `Object`: JSON 格式的物品对象。
-
-##### 内部实现
-根据物品的属性和组件，创建一个 `AddonItem` 实例，并返回其 JSON 表示。这个 JSON 对象可以被游戏引擎解析，用于定义游戏中的物品。
-
----
-
-## ItemAPI 工厂函数
-
-`ItemAPI` 是一个用于创建和管理游戏物品的工厂函数集合，提供了多种方法来创建不同类型的物品。
-
-### `createItem(identifier, category, texture, options = {})`
-创建一个普通物品。
-
-#### 参数
-- `identifier` (string): 物品的唯一标识符。
-- `category` (string): 物品在创造菜单中的分类，可选值包括："construction", "nature", "equipment", "items"。
-- `texture` (string): 物品的纹理。
-- `options` (Object): 额外选项配置对象。默认为空对象。
-  - `group` (string): 物品的分组。
-  - `hide_in_command` (boolean): 是否在命令中隐藏物品。默认为 `false`。
-
-#### 抛出异常
-- 当 `identifier`, `category`, 或 `texture` 参数缺失或为空时，抛出 `Error`。
-
-#### 返回值
-- `Item`: 创建的普通物品对象。
-
-### `createFood(identifier, category, texture, options = {})`
-创建一个食物物品。
-
-#### 参数
-- `identifier` (string): 食物的唯一标识符。
-- `category` (string): 食物在创造菜单中的分类。
-- `texture` (string): 食物的纹理。
-- `options` (Object): 额外选项配置对象。默认为空对象。
-  - `group` (string): 食物的分组。
-  - `hide_in_command` (boolean): 是否在命令中隐藏食物。默认为 `false`。
-  - `animation` (string): 食用时的动画。默认为 `"eat"`。
-  - `canAlwaysEat` (boolean): 是否总是可以食用。默认为 `false`。
-  - `nutrition` (number): 食物的营养价值。默认为 `0`。
-  - `saturationModifier` (number): 饱和度修正值。默认为 `1`。
-
-#### 抛出异常
-- 当 `identifier`, `category`, 或 `texture` 参数缺失或为空时，抛出 `Error`。
-
-#### 返回值
-- `Food`: 创建的食物物品对象。
-
-### `createAttachable(identifier, texture, material, options = {})`
-创建一个可附着物品。
-
-#### 参数
-- `identifier` (string): 可附着物品的唯一标识符。
-- `texture` (string): 可附着物品的纹理。
-- `material` (string): 可附着物品的材质。
-- `options` (Object): 额外选项配置对象。默认为空对象。
-
-#### 抛出异常
-- 当 `identifier`, `texture`, 或 `material` 参数缺失或为空时，抛出 `Error`。
-
-#### 返回值
-- `Attachable`: 创建的可附着物品对象。
-
-### `createChestplateArmor(identifier, item_texture, texture_path, options = {})`
-创建一个胸甲护甲物品。
-
-#### 参数
-- `identifier` (string): 胸甲的唯一标识符。
-- `item_texture` (string): 胸甲的纹理。
-- `texture_path` (string): 胸甲的纹理路径。
-- `options` (Object): 额外选项配置对象。默认为空对象。
-
-#### 返回值
-- `Chestplate`: 创建的胸甲护甲物品对象。
-
----
-
-## 内部实现
-- `ItemAPI` 使用 `GRegistry` 来注册物品和可附着物品的行为和资源路径。
-- 每个方法在创建物品后，会调用 `registerItem` 函数将物品注册到全局注册表中，以便游戏引擎能够识别和加载这些物品。

package/doc/sapdon-ts.md

@@ -1,64 +0,0 @@
-# sapdon with typescript
-在使用脚手架创建项目时，默认使用的语言将会是 `ts`
-
-但这并不意味着你需要手动去调整 tsconfig 和打包工具，我们提供了一套默认能用的ts设置
-
-## 和 js 版本相比有什么区别？
-ts版本拥有更好的类型提示，更严格的类型检查，也可以直接使用node_modules里的库（只能是js/ts）
-
-## 听起来太酷了我们开始吧！
-比如我们需要注册一个物品，可能你会想去找它在哪，但在ts版本中，你只需要 `@sapdon/core` 就可以了
-
-```ts
-import { ItemAPI } from '@sapdon/core'
-```
-
-如果你需要更高级的功能，比如你需要一个ts打包器，或者添加命令行的功能，你可以使用 `@sapdon/cli`
-
-## 从js迁移到ts
-js 的 `main.mjs` 包含了一些预定义的代码：
-```js
-import { registry } from '@sapdon/core'
-
-// 进行注册后需进行一次提交, 通知开发服务器更新文件
-registry.setup()
-```
-如果需要从js迁移到ts，删除 `startDevServer` 那行即可（不删也没事）
-
-
-## OC (Object - Component)
-sapdon通过 `@sapdon/oc` 为sapi提供了一些高级功能, 比如:
-- 实体组件系统
-- 组件间通信
-
-传统的书写方式是通过事件和tick回调来实现功能, 而OC提供了更适合游戏的组件化开发方式
-
-```ts
-import { world, system } from '@minecraft/server'
-import { oc, CustomComponent } from '@sapdon/oc'
-
-world.afterEvents.worldInitialize.subscribe(oc.start)
-
-class MyComponent extends CustomComponent {
-    onTick() {
-        world.sendMessage('tick')
-    }
-}
-```
-
-是的, 我们得到了一个MyComponent, 它每刻都会给玩家发送 'tick'
-但是如果你进入游戏, 会发现它毫无作用, 没错! 因为我们还没有把它到绑定在实体身上!
-
-```ts
-const manager = oc.addEntity(id)
-manager.attachComponent(new MyComponent())
-```
-
-这样就可以了, 我们已经把MyComponent绑定到了entityId为id的实体身上
-
-你也可以动态增删改查组件! 这很方便!
-
-如果你想看它到底是怎么回事,可以从 `examples/oc-core` 开始了解
-
-## [Object - Component](./oc/index.md)
-关于 `@sapdon/oc` 的一切

package/src/templates/js_sapdon/build.config

@@ -1,23 +0,0 @@
-{
-    "formatVersion": 2,
-    "buildOptions": {
-        "useHMR": true,                      // 热更新
-        "buildMode": "development",          // 开发模式 'development' | 'production', production模式下会压缩代码
-        "buildEntry": "main.mjs",            // Addon构建入口文件
-        "useJs": true,                       // 是否使用js文件
-        "scriptEntry": "scripts/index.js",   // ScriptApi脚本入口文件
-        "scriptOutput": "scripts/index.js",  // ScriptApi脚本输出文件 (在 buildDir 目录下)
-        "buildDir": "dev/",                  // 构建输出目录    
-        "dependencies": [
-            {
-                "module_name": "@minecraft/server",
-                "version": "1.17.0"
-            }
-        ],
-        "resource": {
-            "path": "res/",                   // 资源文件目录
-            "resourceHints": true             // 是否生成资源提示文件
-        }
-    },
-    "versionType": "release"                  // mc游戏版本, 会影响开发文件路径
-}

package/src/templates/js_sapdon/main.mjs

@@ -1,4 +0,0 @@
-import { registry } from '@sapdon/core'
-
-// 提交所有注册
-registry.submit()

package/src/templates/js_sapdon/mod.info

@@ -1,7 +0,0 @@
-{
-    "name":"mod名字",
-    "authors":["作者1","作者2"],
-    "version":"0.0.1",
-    "min_engine_version":"1.19.50",
-    "description":"mod介绍",
-}

package/src/templates/js_sapdon/package.json

@@ -1,20 +0,0 @@
-{
-    "name": "sapdon",
-    "version": "1.0.0",
-    "main": "main.mjs",
-    "scripts": {
-        "build": "sapdon build ./",
-        "postinstall": "sapdon lib"
-    },
-    "keywords": [
-        "bedrock",
-        "addon"
-    ],
-    "author": "",
-    "license": "ISC",
-    "type": "module",
-    "devDependencies": {
-        "@minecraft/server": "^1.17.0",
-        "@minecraft/server-ui": "^1.3.0"
-    }
-}

package/src/templates/js_sapdon/res/animations/animation_item.animation.json

@@ -1,34 +0,0 @@
-{
-	"format_version": "1.8.0",
-	"animations": {
-		"animation.animation_item.default": {
-			"loop": true,
-			"bones": {
-				"body": {
-					"position": [0, 8, 0]
-				},
-				"rightitem": {
-					"rotation": [-80, 0, 0],
-					"position": [0, -3, 2]
-				}
-			}
-		},
-		"animation.animation_item.rotating": {
-			"loop": true,
-			"animation_length": 10,
-			"bones": {
-				"body": {
-					"rotation": {
-						"0.0": [0, 0, 0],
-						"10.0": [0, 360, 0]
-					},
-					"position": [0, 8, 0]
-				},
-				"rightitem": {
-					"rotation": [-80, 0, 0],
-					"position": [0, -3, 2]
-				}
-			}
-		}
-	}
-}

package/src/templates/js_sapdon/res/animations/large_item.animation.json

@@ -1,27 +0,0 @@
-{
-    "format_version": "1.10.0",
-    "animations": {
-        "animation.large_item.hold": {
-            "loop": true,
-            "bones": {
-                "rightitem": {
-                    "position": [
-                        "c.is_first_person ? -6 : 1",
-                        "c.is_first_person ? 0 : -1",
-                        "c.is_first_person ? -1 : -6"
-                    ],
-                    "rotation": [
-                        "c.is_first_person ? 45 : 15",
-                        "c.is_first_person ? -15 : 0",
-                        "c.is_first_person ? 30 : -165"
-                    ],
-                    "scale": [
-                        "c.is_first_person ? 1 : 0.5",
-                        "c.is_first_person ? 1 : 0.5",
-                        "c.is_first_person ? 1 : 0.5"
-                    ]
-                }
-            }
-        }
-    }
-}

package/src/templates/js_sapdon/res/models/blocks/crop.geo.json

@@ -1,48 +0,0 @@
-{
-    "format_version": "1.21.20",
-    "minecraft:geometry": [
-        {
-            "description": {
-                "identifier": "geometry.crop",
-                "texture_width": 16,
-                "texture_height": 16
-            },
-            "bones": [
-                {
-                    "name": "crop",
-                    "pivot": [0, 0, 0],
-                    "cubes": [
-                        {
-                            "origin": [-8, -1, -4],
-                            "size": [16, 16, 0],
-                            "uv": {
-                                "south": { "uv": [0, 0], "uv_size": [16, 16] }
-                            }
-                        },
-                        {
-                            "origin": [-8, -1, 4],
-                            "size": [16, 16, 0],
-                            "uv": {
-                                "north": { "uv": [0, 0], "uv_size": [16, 16] }
-                            }
-                        },
-                        {
-                            "origin": [4, -1, -8],
-                            "size": [0, 16, 16],
-                            "uv": {
-                                "east": { "uv": [16, 0], "uv_size": [-16, 16] }
-                            }
-                        },
-                        {
-                            "origin": [-4, -1, -8],
-                            "size": [0, 16, 16],
-                            "uv": {
-                                "west": { "uv": [16, 0], "uv_size": [-16, 16] }
-                            }
-                        }
-                    ]
-                }
-            ]
-        }
-    ]
-}

package/src/templates/js_sapdon/res/models/entity/animation/animation_item.geo.json

@@ -1,26 +0,0 @@
-{
-	"format_version": "1.12.0",
-	"minecraft:geometry": [
-		{
-			"description": {
-				"identifier": "geometry.animation_item",
-				"texture_width": 32,
-				"texture_height": 32,
-				"visible_bounds_width": 5,
-				"visible_bounds_height": 3.5,
-				"visible_bounds_offset": [0, 1.25, 0]
-			},
-			"bones": [
-				{
-					"name": "body",
-					"pivot": [0, 0, 0]
-				},
-				{
-					"name": "rightitem",
-					"parent": "body",
-					"pivot": [-0.3, 8, 0]
-				}
-			]
-		}
-	]
-}

package/src/templates/js_sapdon/res/models/entity/animation/large_item.geo.json

@@ -1,28 +0,0 @@
-{
-    "format_version": "1.16.0",
-    "minecraft:geometry": [
-        {
-            "description": {
-                "identifier": "geometry.large_item",
-                "texture_width": 16,
-                "texture_height": 16,
-                "visible_bounds_width": 2,
-                "visible_bounds_height": 1.5,
-                "visible_bounds_offset": [0, 0.25, 0]
-            },
-            "bones": [
-                {
-                    "name": "rightitem",
-                    "pivot": [0, 0, 0],
-                    "texture_meshes": [
-                        {
-                            "texture": "default",
-                            "position": [0, 0, 0],
-                            "local_pivot": [8, 0, 8]
-                        }
-                    ]
-                }
-            ]
-        }
-    ]
-}

package/src/templates/js_sapdon/scripts/custom_components/cropComponent.js

@@ -1,50 +0,0 @@
-import { EquipmentSlot, GameMode, world } from "@minecraft/server";
-
-/**
- * @param {number} min The minimum integer
- * @param {number} max The maximum integer
- * @returns {number} A random integer between the `min` and `max` parameters (inclusive)
- */
-const randomInt = (min, max) => Math.floor(Math.random() * (max - min + 1)) + min;
-
-const maxGrowth = 3;
-
-/** @type {import("@minecraft/server").BlockCustomComponent} */
-export const CustomCropGrowthBlockComponent = {
-    onRandomTick({ block }) {
-        const growthChance = 1 / 3;
-        if (Math.random() > growthChance) return;
-
-        const growth = block.permutation.getState("sapdon:block_variant_tag");
-        block.setPermutation(block.permutation.withState("sapdon:block_variant_tag", growth + 1));
-    },
-    onPlayerInteract({ block, dimension, player }) {
-        if (!player) return;
-
-        const equippable = player.getComponent("minecraft:equippable");
-        if (!equippable) return;
-
-        const mainhand = equippable.getEquipmentSlot(EquipmentSlot.Mainhand);
-        if (!mainhand.hasItem() || mainhand.typeId !== "minecraft:bone_meal") return;
-
-        if (player.getGameMode() === GameMode.creative) {
-            // Grow crop fully
-            block.setPermutation(block.permutation.withState("sapdon:block_variant_tag", maxGrowth));
-        } else {
-            let growth = block.permutation.getState("sapdon:block_variant_tag");
-
-            // Add random amount of growth
-            growth += randomInt(1, maxGrowth - growth);
-            block.setPermutation(block.permutation.withState("sapdon:block_variant_tag", growth));
-
-            // Decrement stack
-            if (mainhand.amount > 1) mainhand.amount--;
-            else mainhand.setItem(undefined);
-        }
-
-        // Play effects
-        const effectLocation = block.center();
-        dimension.playSound("item.bone_meal.use", effectLocation);
-        dimension.spawnParticle("minecraft:crop_growth_emitter", effectLocation);
-    },
-};

package/src/templates/js_sapdon/scripts/custom_components/items/gui_book.js

@@ -1,37 +0,0 @@
-import { world } from "@minecraft/server";
-import { ActionFormData} from "@minecraft/server-ui";
-
-const item_ui_list ={
-    "thaumcraft:thaumonomicon":"guidebook"
-};
-
-var page_index = 0;
-/** @type {import("@minecraft/server").ItemCustomComponent} */
-export const GuiBookItemComponent = {
-    onUse({itemStack,source}){
-        if(source.typeId != "minecraft:player") return
-        showGuidebook(source,item_ui_list[itemStack.typeId])
-    }
-}
-
-function showGuidebook(target,ui){
-    const form = new ActionFormData()
-    .title(ui)
-    .body("page_index"+ page_index)
-    .button("test1")
-    .button("test2")
-    
-    form.show(target).then((response) => {
-        if (response.selection === 0) {
-            page_index--;
-            world.sendMessage("上一页")
-            showGuidebook(target,ui)
-
-        }
-        else if (response.selection === 1) {
-            page_index++;
-            world.sendMessage("下一页")
-            showGuidebook(target,ui)
-        }
-    });
-}