sapdon 2.0.2 → 3.0.0

package/dist/core/ui/systems/guidebook.js

@@ -0,0 +1,206 @@
+import { ButtonMapping } from "../buttonMapping.js";
+import { DataBindingObject } from "../dataBindingObject.js";
+import { Button } from "../elements/button.js";
+import { Image } from "../elements/image.js";
+import { Label } from "../elements/label.js";
+import { Panel } from "../elements/panel.js";
+import { StackPanel } from "../elements/stackPanel.js";
+import { UIElement } from "../elements/uiElement.js";
+import { Control } from "../properties/control.js";
+import { Input } from "../properties/input.js";
+import { Layout } from "../properties/layout.js";
+import { Sprite } from "../properties/sprite.js";
+import { Text } from "../properties/text.js";
+import { ServerUISystem } from "./serverForm.js";
+import { UISystem } from "./UISystem.js";
+//表单按钮模板
+const form_button_template = new Button("form_button_template", "common.button");
+form_button_template.addVariable("default_texture|default", "");
+form_button_template.addVariable("hover_texture|default", "");
+form_button_template.addVariable("pressed_texture|default", "");
+form_button_template.addVariable("binding_button_text|default", "");
+form_button_template.dataBinding.addDataBinding(new DataBindingObject().setBindingType("collection_details")
+    .setBindingCollectionName("form_buttons"));
+form_button_template.dataBinding.addDataBinding(new DataBindingObject().setBindingType("collection")
+    .setBindingCollectionName("form_buttons")
+    .setBindingName("#form_button_text"));
+form_button_template.dataBinding.addDataBinding(new DataBindingObject().setBindingType("view")
+    .setSourcePropertyName("($binding_button_text = #form_button_text)")
+    .setTargetPropertyName("#visible"));
+form_button_template.addControls([
+    new Image("default").setSprite(new Sprite().setTexture("$default_texture")),
+    new Image("hover").setSprite(new Sprite().setTexture("$hover_texture")),
+    new Image("pressed").setSprite(new Sprite().setTexture("$pressed_texture"))
+]);
+//f
+const form_button_panel = new Panel("form_button_factory").enableDebug();
+form_button_panel.addProp("type", "collection_panel");
+form_button_panel.factory.setName("buttons").setControlName("$button_control");
+form_button_panel.addProp("collection_name", "form_buttons");
+form_button_panel.dataBinding.addDataBinding(new DataBindingObject().setBindingName("#form_button_length")
+    .setBindingNameOverride("#collection_length"));
+const page_template = new StackPanel("page_template").setOrientation("horizontal")
+    .addVariable("page_left_content | default", "")
+    .addVariable("page_right_content | default", "")
+    .setLayout(new Layout().setSize(["90%", "90%"]))
+    .addStack(["50%", "100%"], new UIElement("page_left", undefined, "$page_left_content").serialize())
+    .addStack(["50%", "100%"], new UIElement("page_right", undefined, "$page_right_content").serialize());
+page_template.dataBinding.addDataBinding(new DataBindingObject().setBindingType("view")
+    .setSourcePropertyName("($binding_text = #form_text)")
+    .setTargetPropertyName("#visible"));
+export class Guidebook {
+    #bindingList = [];
+    constructor(identifier, path) {
+        this.system = new UISystem(identifier, path);
+        //init
+        this.#binding();
+        this.#addTemplate();
+        this.#updateSystem();
+    }
+    addPageBinding(page_name, left_control_name, right_control_name) {
+        this.#bindingList.push({
+            page_name: page_name,
+            left_control_name: left_control_name,
+            right_control_name: right_control_name
+        });
+        //更新系统
+        this.#updateSystem();
+        return this;
+    }
+    addPage(page_name, left_control, right_control) {
+        this.addPageBinding(page_name, left_control.name, right_control.name);
+        //添加元素
+        this.addElement(left_control);
+        this.addElement(right_control);
+        //更新系统
+        this.#updateSystem();
+        return this;
+    }
+    addElement(element) {
+        this.system.addElement(element);
+        return this;
+    }
+    #binding() {
+        ServerUISystem.bindingTitlewithContent(this.system.name, `${this.system.namespace}.guidebook_root_panel`);
+    }
+    #addTemplate() {
+        this.addElement(form_button_template);
+        this.addElement(form_button_panel);
+        this.addElement(page_template);
+        //
+        this.#updateSystem();
+    }
+    #updateSystem() {
+        const guidebook_root_panel = new Panel("guidebook_root_panel");
+        //开启调试框
+        //guidebook_root_panel.enableDebug()
+        //设置布局属性
+        guidebook_root_panel.setLayout(new Layout().setSize([320, 207]));
+        //添加子元素
+        guidebook_root_panel.addControls([
+            //添加背景
+            new UIElement("book_background", undefined, "book.book_background"),
+            //添加书页
+            new StackPanel("book_page_stack_panel").setOrientation("horizontal")
+                .setLayout(new Layout().setSize([320, 207]))
+                .addVariable("page_size", [160, 207])
+                .addStack("$page_size", new Panel("book_left_panel").addControls([
+                {
+                    "page_crease_image@book.page_crease_left_image": {
+                        "size": ["100% - 40px", "100% - 14px"],
+                        "offset": [0, -2]
+                    }
+                },
+                {
+                    "page_edge_image@book.page_edge_left_image": {
+                        "size": ["100% - 7px", "100% - 16px"],
+                        "offset": [7, -1]
+                    }
+                }
+            ]).serialize())
+                .addStack("$page_size", new Panel("book_right_panel").addControls([
+                {
+                    "page_crease_image@book.page_crease_right_image": {
+                        "size": ["100% - 40px", "100% - 14px"],
+                        "offset": [0, -2]
+                    }
+                },
+                {
+                    "page_edge_image@book.page_edge_right_image": {
+                        "size": ["100% - 7px", "100% - 16px"],
+                        "offset": [-7, -1]
+                    }
+                }
+            ]).serialize()),
+            //添加书页内容
+            new Panel("page_content_root")
+                .setControl(new Control().setLayer(5))
+                .setLayout(new Layout().setSize(["90%", "90%"]))
+                .addControls([
+                new Panel("label_text_panel").setLayout(new Layout().setSize([32, 8]).setAnchorFrom("bottom_middle")
+                    .setAnchorTo("bottom_middle")).addControl(new Label("page_content").setText(new Text().setText("#form_text").setColor([0, 0, 0]))),
+                ...this.#bindingList.map(({ page_name, left_control_name, right_control_name }, index) => {
+                    return new UIElement(`page_index_${index}`, undefined, "page_template")
+                        .addVariable("binding_text", page_name)
+                        .addVariable("page_left_content", left_control_name)
+                        .addVariable("page_right_content", right_control_name);
+                })
+                /*
+                new UIElement("page_1",undefined,"page_template")
+                .addVariable("binding_text","page_index1")
+                .addVariable("page_left_content","page_left_content")
+                .addVariable("page_right_content","page_right_content"),
+                new UIElement("page_2",undefined,"page_template")
+                .addVariable("binding_text","page_index2")
+                .addVariable("page_left_content","page_left_content")
+                .addVariable("page_right_content","page_right_content"),
+                new UIElement("page_3",undefined,"page_template")
+                .addVariable("binding_text","page_index3")
+                .addVariable("page_left_content","page_left_content")
+                .addVariable("page_right_content","page_right_content")*/
+            ]),
+            //添加关闭按钮
+            new Button("close_button").setLayout(new Layout().setSize([14, 14])
+                .setAnchorFrom("top_right")
+                .setAnchorTo("top_right"))
+                .setInput(new Input().setButtonMappings([
+                new ButtonMapping().setMappingType("pressed")
+                    .setFromButtonId("button.menu_select")
+                    .setToButtonId("button.menu_exit")
+            ]))
+                .addControls([
+                new UIElement("default", undefined, "book.close_button_default"),
+                new UIElement("hover", undefined, "book.close_button_hover"),
+                new UIElement("pressed", undefined, "book.close_button_pressed"),
+            ]),
+            //添加下一页按钮
+            new Panel("prev_button_panel").enableDebug()
+                .setControl(new Control().setLayer(5))
+                .setLayout(new Layout().setSize([24, 24])
+                .setOffset([7, -9])
+                .setAnchorFrom("bottom_left")
+                .setAnchorTo("bottom_left"))
+                .addControl(new UIElement("prev_button", undefined, "form_button_factory")
+                .addVariable("binding_button_text", "test1")
+                .addVariable("button_control", `${this.system.namespace}.form_button_template`)
+                .addVariable("pressed_button_name", "button.form_button_click")
+                .addVariable("default_texture", "textures/ui/book_pageleft_default")
+                .addVariable("hover_texture", "textures/ui/book_pageleft_hover")
+                .addVariable("pressed_texture", "textures/ui/book_pageleft_pressed")),
+            new Panel("next_button_panel").enableDebug()
+                .setControl(new Control().setLayer(5))
+                .setLayout(new Layout().setSize([24, 24])
+                .setOffset([-7, -9])
+                .setAnchorFrom("bottom_right")
+                .setAnchorTo("bottom_right"))
+                .addControl(new UIElement("next_button", undefined, "form_button_factory")
+                .addVariable("binding_button_text", "test2")
+                .addVariable("button_control", "sapdon_guidebook.form_button_template")
+                .addVariable("pressed_button_name", "button.form_button_click")
+                .addVariable("default_texture", "textures/ui/book_pageright_default")
+                .addVariable("hover_texture", "textures/ui/book_pageright_hover")
+                .addVariable("pressed_texture", "textures/ui/book_pageright_pressed"))
+        ]);
+        this.addElement(guidebook_root_panel);
+    }
+}

package/dist/core/ui/systems/serverForm.d.ts

@@ -0,0 +1,12 @@
+export const ServerFormSystem: any;
+export const form_button_panel: Panel;
+export class ServerUISystem {
+    static "__#4@#binding_map": Map<any, any>;
+    static "__#4@#binding_title_list": any[];
+    static addBindingTitle(title_name: any): void;
+    static getBindingTitleList(): any[];
+    static getBindingContentList(): any[];
+    static bindingTitlewithContent(title_name: any, content: any): void;
+    static "__#4@#updateServerFormSystem"(): void;
+}
+import { Panel } from "../elements/panel.js";

package/dist/core/ui/systems/serverForm.js

@@ -0,0 +1,116 @@
+import { Modifications, UIElement } from "../elements/uiElement.js";
+import { DataBindingObject } from "../dataBindingObject.js";
+import { UISystem } from "./UISystem.js";
+import { Panel } from "../elements/panel.js";
+import { Button } from "../elements/button.js";
+import { Image } from "../elements/image.js";
+import { Sprite } from "../properties/sprite.js";
+export const ServerFormSystem = new UISystem("server_form:server_form", "ui/");
+//表单按钮模板
+const form_button_template = new Button("sapdon_form_button_template", "common.button");
+form_button_template.addVariable("pressed_button_name", "button.form_button_click");
+form_button_template.addVariable("default_texture|default", "textures/gui/newgui/buttons/borderless/light");
+form_button_template.addVariable("hover_texture|default", "textures/gui/newgui/buttons/borderless/lighthover");
+form_button_template.addVariable("pressed_texture|default", "textures/gui/newgui/buttons/borderless/lightpressed");
+form_button_template.addVariable("binding_button_text|default", "");
+form_button_template.dataBinding.addDataBinding(new DataBindingObject().setBindingType("collection_details")
+    .setBindingCollectionName("form_buttons"));
+form_button_template.dataBinding.addDataBinding(new DataBindingObject().setBindingType("collection")
+    .setBindingCollectionName("form_buttons")
+    .setBindingName("#form_button_text"));
+form_button_template.dataBinding.addDataBinding(new DataBindingObject().setBindingType("view")
+    .setSourcePropertyName("($binding_button_text = #form_button_text)")
+    .setTargetPropertyName("#visible"));
+form_button_template.addControls([
+    new Image("default").setSprite(new Sprite().setTexture("$default_texture")),
+    new Image("hover").setSprite(new Sprite().setTexture("$hover_texture")),
+    new Image("pressed").setSprite(new Sprite().setTexture("$pressed_texture"))
+]);
+//f
+export const form_button_panel = new Panel("sapdon_form_button_factory");
+form_button_panel.addProp("type", "collection_panel");
+form_button_panel.factory.setName("buttons").setControlName("sapdon_form_button_template");
+form_button_panel.addProp("collection_name", "form_buttons");
+form_button_panel.dataBinding.addDataBinding(new DataBindingObject().setBindingName("#form_button_length")
+    .setBindingNameOverride("#collection_length"));
+ServerFormSystem.addElement(form_button_template);
+ServerFormSystem.addElement(form_button_panel);
+export class ServerUISystem {
+    static #binding_map = new Map();
+    static #binding_title_list = [];
+    static addBindingTitle(title_name) {
+        this.#binding_title_list.push(title_name);
+    }
+    static getBindingTitleList() {
+        //console.log("arrr:",Array.from(this.#binding_map.keys()))
+        return this.#binding_title_list.concat(Array.from(this.#binding_map.keys()));
+    }
+    static getBindingContentList() {
+        return Array.from(this.#binding_map.values());
+    }
+    static bindingTitlewithContent(title_name, content) {
+        //添加绑定
+        this.#binding_map.set(title_name, content);
+        this.#updateServerFormSystem();
+    }
+    static #updateServerFormSystem() {
+        //文本化处理
+        //console.log("ttttt:",this.getBindingTitleList())
+        const user_custom_ui_text = this.getBindingTitleList().map((title_name) => {
+            console.log("title_name", title_name);
+            return `'${title_name}'`;
+        }).join('-');
+        const long_form = new UIElement("long_form")
+            .addModification({
+            array_name: "bindings",
+            operation: Modifications.OPERATION.INSERT_BACK,
+            value: [
+                new DataBindingObject().setBindingName("#title_text"),
+                new DataBindingObject().setBindingType("view")
+                    .setSourcePropertyName(`((#title_text - ${user_custom_ui_text}) = #title_text)`)
+                    .setTargetPropertyName("#visible")
+            ]
+        });
+        const custom_server_form_factory = new Panel("custom_server_form_factory");
+        custom_server_form_factory.factory.setName("server_form_factory") //工程名被绑定至表单，不可改动
+            .setControlIds({ "long_form": "@server_form.custom_root_panel" });
+        //加入自定义表单内容
+        const main_screen_content = new UIElement("main_screen_content")
+            .addModification({
+            array_name: "controls",
+            operation: Modifications.OPERATION.INSERT_BACK,
+            value: [
+                custom_server_form_factory.serialize()
+            ]
+        });
+        //自定义ui模板
+        const custom_ui_template = new Panel("custom_ui_template");
+        custom_ui_template.dataBinding.addDataBinding(new DataBindingObject().setBindingName("#title_text")).addDataBinding(new DataBindingObject().setBindingType("view")
+            .setSourcePropertyName("(#title_text = $binding_text)")
+            .setTargetPropertyName("#visible"));
+        custom_ui_template.control.addControl(new UIElement("main", undefined, "$main_content").serialize());
+        //类似于 root ，决定什么时候加载自定义界面 ，不可改动
+        const custom_form_root = new Panel("custom_form_root");
+        //custom_form_root.addVariable("title_needs_to_contain",user_custom_ui_text)
+        custom_form_root.dataBinding.addDataBinding(new DataBindingObject().setBindingType("view")
+            .setSourceControlName("custom_root_panel")
+            .setSourcePropertyName(`(not ((#title_text - ${user_custom_ui_text}) = #title_text))`)
+            .setTargetPropertyName("#visible"));
+        //用户自定义ui内容绑定
+        this.#binding_map.forEach((content, key) => {
+            //加入 root
+            custom_form_root.control.addControl(new UIElement("custom_ui_" + key, undefined, "custom_ui_template")
+                .addVariable("main_content", content)
+                .addVariable("binding_text", key).serialize());
+        });
+        //类似于 sreen，必要，不可改动
+        const custom_root_panel = new Panel("custom_root_panel");
+        custom_root_panel.dataBinding.addDataBinding(new DataBindingObject().setBindingName("#title_text"));
+        custom_root_panel.control.addControl(custom_form_root.serialize());
+        ServerFormSystem
+            .addElement(custom_ui_template)
+            .addElement(long_form)
+            .addElement(custom_root_panel)
+            .addElement(main_screen_content);
+    }
+}

package/dist/core/ui/systems/system.d.ts

@@ -0,0 +1,16 @@
+export class UISystem {
+    constructor(identifier: any, path: any);
+    identifier: any;
+    namespace: any;
+    name: any;
+    path: any;
+    elements: Map<any, any>;
+    animations: Map<any, any>;
+    addElement(element: any): this;
+    getElement(element_name: any): any;
+    addAnimation(name: any, value: any): void;
+    getAnimation(animation_name: any): any;
+    toJson(): {
+        namespace: any;
+    };
+}

package/dist/core/ui/systems/system.js

@@ -0,0 +1,37 @@
+import { UISystemRegistry } from "../registry/uiSystemRegistry.js";
+// UI 文件核心类
+export class UISystem {
+    constructor(identifier, path) {
+        this.identifier = identifier;
+        this.namespace = identifier.split(':')[0];
+        this.name = identifier.split(':')[1];
+        this.path = path;
+        this.elements = new Map();
+        this.animations = new Map();
+        UISystemRegistry.registerUISystem(this);
+    }
+    addElement(element) {
+        this.elements.set(element.id, element);
+        return this;
+    }
+    getElement(element_name) {
+        return this.elements.get(element_name);
+    }
+    addAnimation(name, value) {
+        this.animations.set(name, value);
+    }
+    getAnimation(animation_name) {
+        return this.animations.get(animation_name);
+    }
+    toJson() {
+        const ui = { namespace: this.namespace };
+        //序列化
+        this.elements.forEach((value, key) => {
+            //console.log("elements key:",key)
+            console.log("elements value:", value);
+            ui[key] = value.serialize()[value.id];
+        });
+        console.log("ui:", ui);
+        return ui;
+    }
+}

package/doc/BlockAPI.md

@@ -0,0 +1,145 @@
+# 方块工厂类 (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

@@ -10,7 +10,7 @@
 创建一个新的物品实例。
 
 #### 参数
-- `identifier` (string): 物品的唯一标识符。
+- `identifier` (string): 物品的唯一标识符。由命名空间与名字组成，例如"hello_sapdon:my_item"
 - `category` (string): 物品所属的菜单栏分类，可选值包括："construction", "nature", "equipment", "items", 和 "none"。
 - `texture` (string): 物品的纹理。
 - `options` (Object): 可选参数配置对象。默认为空对象。