sapdon 3.0.2 → 3.1.0

package/dist/core/ui/elements/collectionPanel.js

@@ -0,0 +1,53 @@
+import { Control } from "../properties/control.js";
+import { DataBinding } from "../properties/dataBinding.js";
+import { Factory } from "../properties/factory.js";
+import { Layout } from "../properties/layout.js";
+import { UIElement } from "./uiElement.js";
+export class CollectionPanel extends UIElement {
+    constructor(id, template) {
+        super(id, "collection_panel", template);
+        this.control = new Control();
+        this.layout = new Layout();
+        this.dataBinding = new DataBinding();
+        this.factory = new Factory();
+    }
+    setCollectionName(collection_name) {
+        this.addProp("collection_name", collection_name);
+        return this;
+    }
+    setLayout(layout) {
+        if (!(layout instanceof Layout))
+            new Error("参数需要Layout类");
+        this.layout = layout;
+        return this;
+    }
+    serialize() {
+        //序列化
+        // 复制Layout的属性
+        for (const key in this.layout) {
+            if (this.layout.hasOwnProperty(key)) {
+                this.properties.set(key, this.layout[key]);
+            }
+        }
+        // 复制DataBinding的属性
+        for (const key in this.dataBinding) {
+            if (this.dataBinding.hasOwnProperty(key)) {
+                this.properties.set(key, this.dataBinding[key]);
+            }
+        }
+        // 复制Factory的属性
+        for (const key in this.factory) {
+            if (this.factory.hasOwnProperty(key)) {
+                this.properties.set(key, this.factory[key]);
+            }
+        }
+        // 复制Control的属性
+        for (const key in this.control) {
+            if (this.control.hasOwnProperty(key)) {
+                this.properties.set(key, this.control[key]);
+            }
+        }
+        // 调用父类的serialize方法
+        return super.serialize();
+    }
+}

package/dist/core/ui/elements/grid.d.ts

@@ -0,0 +1,8 @@
+export class Grid extends CollectionPanel {
+    gridNum: number;
+    grid: GridProp;
+    setGridProp(grid_prop: any): this;
+    addGridItem(grid_position: any, content: any): this;
+}
+import { CollectionPanel } from "./collectionPanel.js";
+import { GridProp } from "../properties/gridProp.js";

package/dist/core/ui/elements/grid.js

@@ -0,0 +1,33 @@
+import { GridProp } from "../properties/gridProp.js";
+import { CollectionPanel } from "./collectionPanel.js";
+import { Panel } from "./panel.js";
+export class Grid extends CollectionPanel {
+    constructor(id, template) {
+        super(id, template);
+        this.gridNum = 0;
+        this.grid = new GridProp();
+    }
+    setGridProp(grid_prop) {
+        this.grid = grid_prop;
+        return this;
+    }
+    addGridItem(grid_position, content) {
+        const grid_item = new Panel(`grid_item_${this.gridNum}`);
+        grid_item.addProp("grid_position", grid_position);
+        grid_item.addControl(content);
+        this.addControl(grid_item);
+        this.gridNum++;
+        return this;
+    }
+    serialize() {
+        // 复制grid的属性
+        for (const key in this.grid) {
+            if (this.grid.hasOwnProperty(key)) {
+                this.properties.set(key, this.grid[key]);
+            }
+        }
+        //类型修正
+        this.properties.set("type", "grid");
+        return super.serialize();
+    }
+}

package/dist/core/ui/elements/image.d.ts

@@ -0,0 +1,13 @@
+export class Image extends UIElement {
+    constructor(id: any, template: any);
+    sprite: Sprite;
+    layout: Layout;
+    dataBinding: DataBinding;
+    factory: Factory;
+    setSprite(sprite: any): this;
+}
+import { UIElement } from "./uiElement.js";
+import { Sprite } from "../properties/sprite.js";
+import { Layout } from "../properties/layout.js";
+import { DataBinding } from "../properties/dataBinding.js";
+import { Factory } from "../properties/factory.js";

package/dist/core/ui/elements/image.js

@@ -0,0 +1,55 @@
+import { Control } from "../properties/control.js";
+import { DataBinding } from "../properties/dataBinding.js";
+import { Factory } from "../properties/factory.js";
+import { Layout } from "../properties/layout.js";
+import { Sprite } from "../properties/sprite.js";
+import { UIElement } from "./uiElement.js";
+export class Image extends UIElement {
+    constructor(id, template) {
+        super(id, "image", template);
+        this.sprite = new Sprite();
+        this.control = new Control();
+        this.layout = new Layout();
+        this.dataBinding = new DataBinding();
+        this.factory = new Factory();
+    }
+    setSprite(sprite) {
+        this.sprite = sprite;
+        return this;
+    }
+    serialize() {
+        //合并属性
+        // 复制Sprite的属性
+        for (const key in this.sprite) {
+            if (this.sprite.hasOwnProperty(key)) {
+                this.properties.set(key, this.sprite[key]);
+            }
+        }
+        // 复制Layout的属性
+        for (const key in this.layout) {
+            if (this.layout.hasOwnProperty(key)) {
+                this.properties.set(key, this.layout[key]);
+            }
+        }
+        // 复制DataBinding的属性
+        for (const key in this.dataBinding) {
+            if (this.dataBinding.hasOwnProperty(key)) {
+                this.properties.set(key, this.dataBinding[key]);
+            }
+        }
+        // 复制Factory的属性
+        for (const key in this.factory) {
+            if (this.factory.hasOwnProperty(key)) {
+                this.properties.set(key, this.factory[key]);
+            }
+        }
+        // 复制Control的属性
+        for (const key in this.control) {
+            if (this.control.hasOwnProperty(key)) {
+                this.properties.set(key, this.control[key]);
+            }
+        }
+        // 调用父类的serialize方法
+        return super.serialize();
+    }
+}

package/dist/core/ui/elements/label.d.ts

@@ -0,0 +1,14 @@
+export class Label extends UIElement {
+    constructor(id: any, template: any);
+    text: Text;
+    layout: Layout;
+    dataBinding: DataBinding;
+    factory: Factory;
+    setLayout(layout: any): this;
+    setText(text: any): this;
+}
+import { UIElement } from "./uiElement.js";
+import { Text } from "../properties/text.js";
+import { Layout } from "../properties/layout.js";
+import { DataBinding } from "../properties/dataBinding.js";
+import { Factory } from "../properties/factory.js";

package/dist/core/ui/elements/label.js

@@ -0,0 +1,61 @@
+import { Control } from "../properties/control.js";
+import { DataBinding } from "../properties/dataBinding.js";
+import { Factory } from "../properties/factory.js";
+import { Layout } from "../properties/layout.js";
+import { Text } from "../properties/text.js";
+import { UIElement } from "./uiElement.js";
+export class Label extends UIElement {
+    constructor(id, template) {
+        super(id, "label", template);
+        this.text = new Text();
+        this.control = new Control();
+        this.layout = new Layout();
+        this.dataBinding = new DataBinding();
+        this.factory = new Factory();
+    }
+    setLayout(layout) {
+        if (!(layout instanceof Layout))
+            new Error("参数需要Layout类");
+        this.layout = layout;
+        return this;
+    }
+    setText(text) {
+        this.text = text;
+        return this;
+    }
+    serialize() {
+        //合并属性
+        // 复制Text的属性
+        for (const key in this.text) {
+            if (this.text.hasOwnProperty(key)) {
+                this.properties.set(key, this.text[key]);
+            }
+        }
+        // 复制Layout的属性
+        for (const key in this.layout) {
+            if (this.layout.hasOwnProperty(key)) {
+                this.properties.set(key, this.layout[key]);
+            }
+        }
+        // 复制DataBinding的属性
+        for (const key in this.dataBinding) {
+            if (this.dataBinding.hasOwnProperty(key)) {
+                this.properties.set(key, this.dataBinding[key]);
+            }
+        }
+        // 复制Factory的属性
+        for (const key in this.factory) {
+            if (this.factory.hasOwnProperty(key)) {
+                this.properties.set(key, this.factory[key]);
+            }
+        }
+        // 复制Control的属性
+        for (const key in this.control) {
+            if (this.control.hasOwnProperty(key)) {
+                this.properties.set(key, this.control[key]);
+            }
+        }
+        // 调用父类的serialize方法
+        return super.serialize();
+    }
+}

package/dist/core/ui/elements/panel.d.ts

@@ -0,0 +1,11 @@
+export class Panel extends UIElement {
+    constructor(id: any, template: any);
+    layout: Layout;
+    dataBinding: DataBinding;
+    factory: Factory;
+    setLayout(layout: any): this;
+}
+import { UIElement } from "./uiElement.js";
+import { Layout } from "../properties/layout.js";
+import { DataBinding } from "../properties/dataBinding.js";
+import { Factory } from "../properties/factory.js";

package/dist/core/ui/elements/panel.js

@@ -0,0 +1,49 @@
+import { Control } from "../properties/control.js";
+import { DataBinding } from "../properties/dataBinding.js";
+import { Factory } from "../properties/factory.js";
+import { Layout } from "../properties/layout.js";
+import { UIElement } from "./uiElement.js";
+export class Panel extends UIElement {
+    constructor(id, template) {
+        super(id, "panel", template);
+        this.control = new Control();
+        this.layout = new Layout();
+        this.dataBinding = new DataBinding();
+        this.factory = new Factory();
+    }
+    setLayout(layout) {
+        if (!(layout instanceof Layout))
+            new Error("参数需要Layout类");
+        this.layout = layout;
+        return this;
+    }
+    serialize() {
+        //序列化
+        // 复制Layout的属性
+        for (const key in this.layout) {
+            if (this.layout.hasOwnProperty(key)) {
+                this.properties.set(key, this.layout[key]);
+            }
+        }
+        // 复制DataBinding的属性
+        for (const key in this.dataBinding) {
+            if (this.dataBinding.hasOwnProperty(key)) {
+                this.properties.set(key, this.dataBinding[key]);
+            }
+        }
+        // 复制Factory的属性
+        for (const key in this.factory) {
+            if (this.factory.hasOwnProperty(key)) {
+                this.properties.set(key, this.factory[key]);
+            }
+        }
+        // 复制Control的属性
+        for (const key in this.control) {
+            if (this.control.hasOwnProperty(key)) {
+                this.properties.set(key, this.control[key]);
+            }
+        }
+        // 调用父类的serialize方法
+        return super.serialize();
+    }
+}

package/dist/core/ui/elements/scrollingPanel.d.ts

@@ -0,0 +1,14 @@
+export class ScrollingPanel extends UIElement {
+    constructor(id: any, template: any);
+    input: Input;
+    scrollView: ScrollView;
+    layout: Layout;
+    dataBinding: DataBinding;
+    factory: Factory;
+}
+import { UIElement } from "./uiElement.js";
+import { Input } from "../properties/input.js";
+import { ScrollView } from "../properties/scrollView.js";
+import { Layout } from "../properties/layout.js";
+import { DataBinding } from "../properties/dataBinding.js";
+import { Factory } from "../properties/factory.js";

package/dist/core/ui/elements/scrollingPanel.js

@@ -0,0 +1,59 @@
+import { Control } from "../properties/control.js";
+import { DataBinding } from "../properties/dataBinding.js";
+import { Factory } from "../properties/factory.js";
+import { Input } from "../properties/input.js";
+import { Layout } from "../properties/layout.js";
+import { ScrollView } from "../properties/scrollView.js";
+import { UIElement } from "./uiElement.js";
+export class ScrollingPanel extends UIElement {
+    constructor(id, template) {
+        super(id, "scroll_view", template);
+        this.input = new Input();
+        this.scrollView = new ScrollView();
+        this.control = new Control();
+        this.layout = new Layout();
+        this.dataBinding = new DataBinding();
+        this.factory = new Factory();
+    }
+    serialize() {
+        //合并属性
+        // 复制Input的属性
+        for (const key in this.input) {
+            if (this.input.hasOwnProperty(key)) {
+                this.properties.set(key, this.input[key]);
+            }
+        }
+        // 复制scrollView的属性
+        for (const key in this.scrollView) {
+            if (this.scrollView.hasOwnProperty(key)) {
+                this.properties.set(key, this.scrollView[key]);
+            }
+        }
+        // 复制Layout的属性
+        for (const key in this.layout) {
+            if (this.layout.hasOwnProperty(key)) {
+                this.properties.set(key, this.layout[key]);
+            }
+        }
+        // 复制DataBinding的属性
+        for (const key in this.dataBinding) {
+            if (this.dataBinding.hasOwnProperty(key)) {
+                this.properties.set(key, this.dataBinding[key]);
+            }
+        }
+        // 复制Factory的属性
+        for (const key in this.factory) {
+            if (this.factory.hasOwnProperty(key)) {
+                this.properties.set(key, this.factory[key]);
+            }
+        }
+        // 复制Control的属性
+        for (const key in this.control) {
+            if (this.control.hasOwnProperty(key)) {
+                this.properties.set(key, this.control[key]);
+            }
+        }
+        // 调用父类的serialize方法
+        return super.serialize();
+    }
+}

package/dist/core/ui/elements/stackPanel.d.ts

@@ -0,0 +1,14 @@
+export class StackPanel extends Panel {
+    type: string;
+    orientation: string;
+    stackNum: number;
+    addStack(size: any, content: any, debug?: boolean): this;
+    /**
+     * Possible values:
+        vertical
+        horizontal
+     * @param {*} orientation
+     */
+    setOrientation(orientation: any): this;
+}
+import { Panel } from "./panel.js";

package/dist/core/ui/elements/stackPanel.js

@@ -0,0 +1,37 @@
+import { Layout } from "../properties/layout.js";
+import { Panel } from "./panel.js";
+export class StackPanel extends Panel {
+    constructor(id, template) {
+        super(id, template);
+        this.type = "stack_panel";
+        this.orientation = "vertical";
+        this.stackNum = 0;
+        //init
+        this.setLayout(new Layout().setSize(["100%", "100%"]));
+    }
+    addStack(size, content, debug = false) {
+        const stack = new Panel(`stack${this.stackNum}`)
+            .setLayout(new Layout().setSize(size))
+            .addControl(content);
+        if (debug)
+            stack.enableDebug();
+        this.addControl(stack);
+        this.stackNum++;
+        return this;
+    }
+    /**
+     * Possible values:
+        vertical
+        horizontal
+     * @param {*} orientation
+     */
+    setOrientation(orientation) {
+        this.orientation = orientation;
+        return this;
+    }
+    serialize() {
+        this.properties.set("type", "stack_panel");
+        this.properties.set("orientation", this.orientation);
+        return super.serialize();
+    }
+}

package/dist/core/ui/elements/uiElement.d.ts

@@ -0,0 +1,53 @@
+export class UIElement {
+    constructor(name: any, type: any, template: any);
+    type: any;
+    id: any;
+    name: any;
+    control: Control;
+    properties: Map<any, any>;
+    variables: Map<any, any>;
+    modifications: any[];
+    enableDebug(): this;
+    setControl(control: any): this;
+    addControl(control: any): this;
+    addControls(controls: any): this;
+    addVariable(name: any, value: any): this;
+    addProp(name: any, value: any): this;
+    addModification(modification: any): this;
+    serialize(): {
+        [x: number]: any;
+    };
+}
+/**
+ * Modifications ​
+    To modify JSON UI in a non-intrusive way, you can use the modifications property to modify previously existing JSON UI elements from other packs (usually vanilla JSON UI files). Doing this makes sure only necessary parts are modified unless otherwise intended, to improve compatibility with other packs that modify the JSON UI.
+
+    Modification	Description
+    insert_back	insert at end of array
+    insert_front	insert at start of array
+    insert_after	insert after target in array
+    insert_before	insert before target in array
+    move_back	move target to end of array
+    move_front	move target to start of array
+    move_after	move target after second target
+    move_before	move target before second target
+    swap	swap first target with second target
+    replace	replace first target with second target
+    remove	remove target
+ */
+export class Modifications {
+    static OPERATION: Readonly<{
+        INSERT_BACK: "insert_back";
+        INSERT_FRONT: "insert_front";
+        INSERT_AFTER: "insert_after";
+        INSERT_BEFORE: "insert_before";
+        MOVE_BACK: "move_back";
+        MOVE_FRONT: "move_front";
+        MOVE_AFTER: "move_after";
+        MOVE_BEFORE: "move_before";
+        SWAP: "swap";
+        REPLACE: "replace";
+        REMOVE: "remove";
+    }>;
+}
+import { Control } from "../properties/control.js";

package/dist/core/ui/elements/uiElement.js

@@ -0,0 +1,129 @@
+/**
+ * Elements ​
+    A JSON UI element is the basic form of data within JSON UI. Elements must have a unique name for each namespace so as to not have a conflict with other elements of the same name yet may have different functions.
+
+    Here the element type is label so it will render a text of Hello World when called:
+
+    vanilla/ui/example_file.json
+
+    {
+        "test_element": {
+            "type": "label",
+            "text": "Hello World"
+        }
+    }
+    Types ​
+    The following are some of the element types, which are possible values for the type property:
+
+    label - for creating text objects
+    image - for rendering images from a filepath provided
+    button - for creating interactive and clickable elements
+    panel - an empty container where you can store all other elements that may overlap to each other
+    stack_panel - an empty container where you can store all other elements in a stack that doesn't overlap to each other
+    grid - uses another element as a template, and then renders it repeatedly in multiple rows and columns
+    factory - renders an element based off of another element, is capable of calling hardcoded values and variables
+    custom - is paired with another property renderer which renders hardcoded JSON UI elements
+    screen - elements that are called by the game directly, usually root panel elements
+ */
+import { Control } from "../properties/control.js";
+// 基础元素类
+export class UIElement {
+    constructor(name, type, template) {
+        this.type = type;
+        this.id = template ? `${name}@${template}` : name;
+        this.name = name;
+        this.control = new Control();
+        this.properties = new Map().set("type", type);
+        this.variables = new Map();
+        this.modifications = [];
+    }
+    enableDebug() {
+        this.control.addControl({
+            "debug_board": {
+                "type": "image",
+                "texture": "textures/ui/focus_border_white",
+                "nineslice_size": 1,
+                "size": ["100%", "100%"]
+            }
+        });
+        return this;
+    }
+    setControl(control) {
+        this.control = control;
+        return this;
+    }
+    addControl(control) {
+        //console.log("control:  ", control)
+        if (control instanceof UIElement) {
+            this.control.addControl(control.serialize());
+        }
+        else {
+            this.control.addControl(control);
+        }
+        return this;
+    }
+    addControls(controls) {
+        for (let i in controls) {
+            this.addControl(controls[i]);
+        }
+        return this;
+    }
+    addVariable(name, value) {
+        this.variables.set(`$${name}`, value);
+        return this;
+    }
+    addProp(name, value) {
+        this.properties.set(name, value);
+        return this;
+    }
+    addModification(modification) {
+        this.modifications.push({
+            array_name: modification.array_name,
+            operation: modification.operation,
+            value: modification.value
+        });
+        this.addProp("modifications", this.modifications);
+        return this;
+    }
+    serialize() {
+        const json = Object.fromEntries(this.properties);
+        Object.assign(json, Object.fromEntries(this.variables));
+        return {
+            [this.id]: json
+        };
+    }
+}
+//Modifications ​方法
+/**
+ * Modifications ​
+    To modify JSON UI in a non-intrusive way, you can use the modifications property to modify previously existing JSON UI elements from other packs (usually vanilla JSON UI files). Doing this makes sure only necessary parts are modified unless otherwise intended, to improve compatibility with other packs that modify the JSON UI.
+
+    Modification	Description
+    insert_back	insert at end of array
+    insert_front	insert at start of array
+    insert_after	insert after target in array
+    insert_before	insert before target in array
+    move_back	move target to end of array
+    move_front	move target to start of array
+    move_after	move target after second target
+    move_before	move target before second target
+    swap	swap first target with second target
+    replace	replace first target with second target
+    remove	remove target
+ */
+// Modifications操作类型常量类
+export class Modifications {
+    static OPERATION = Object.freeze({
+        INSERT_BACK: "insert_back",
+        INSERT_FRONT: "insert_front",
+        INSERT_AFTER: "insert_after",
+        INSERT_BEFORE: "insert_before",
+        MOVE_BACK: "move_back",
+        MOVE_FRONT: "move_front",
+        MOVE_AFTER: "move_after",
+        MOVE_BEFORE: "move_before",
+        SWAP: "swap",
+        REPLACE: "replace",
+        REMOVE: "remove"
+    });
+}