sapdon 2.0.0

package/src/core/ui/ButtonMapping.js

@@ -0,0 +1,144 @@
+/**
+ * ButtonMapping 类
+ * 
+ * 该类表示按钮映射配置，用于定义输入事件的映射关系。
+ * 
+ * 属性：
+ * - ignored: boolean - 是否忽略映射（默认值：false）
+ * - from_button_id: string - 触发事件的按钮 ID
+ * - to_button_id: string - 事件触发时执行的按钮 ID
+ * - mapping_type: enum - 映射类型（可能值：global, pressed, double_pressed, focused）
+ * - scope: enum - 映射范围（可能值：view, controller）
+ * - input_mode_condition: enum - 输入模式条件（可能值：not_gaze, not_gamepad, gamepad_and_not_gaze）
+ * - ignore_input_scope: boolean - 是否忽略输入范围
+ * - consume_event: boolean - 是否消耗事件
+ * - handle_select: boolean - 是否处理选择事件
+ * - handle_deselect: boolean - 是否处理取消选择事件
+ * - button_up_right_of_first_refusal: boolean - 是否在首次拒绝后处理按钮释放事件
+ */
+
+export class ButtonMapping {
+    constructor() {
+        this.ignored = false;
+        this.from_button_id = '';
+        this.to_button_id = '';
+        this.mapping_type = null;
+        this.scope = null;
+        this.input_mode_condition = null;
+        this.ignore_input_scope = false;
+        this.consume_event = false;
+        this.handle_select = false;
+        this.handle_deselect = false;
+        this.button_up_right_of_first_refusal = false;
+    }
+
+    /**
+     * 设置是否忽略映射。
+     * @param {boolean} ignored - 是否忽略映射（默认值：false）
+     * @returns {ButtonMapping} 返回当前实例以支持链式调用
+     */
+    setIgnored(ignored = false) {
+        this.ignored = ignored;
+        return this;
+    }
+
+    /**
+     * 设置触发事件的按钮 ID。
+     * @param {string} fromButtonId - 触发事件的按钮 ID
+     * @returns {ButtonMapping} 返回当前实例以支持链式调用
+     */
+    setFromButtonId(fromButtonId) {
+        this.from_button_id = fromButtonId;
+        return this;
+    }
+
+    /**
+     * 设置事件触发时执行的按钮 ID。
+     * @param {string} toButtonId - 事件触发时执行的按钮 ID
+     * @returns {ButtonMapping} 返回当前实例以支持链式调用
+     */
+    setToButtonId(toButtonId) {
+        this.to_button_id = toButtonId;
+        return this;
+    }
+
+    /**
+     * 设置映射类型。
+     * @param {string} mappingType - 映射类型（可能值：global, pressed, double_pressed, focused）
+     * @returns {ButtonMapping} 返回当前实例以支持链式调用
+     */
+    setMappingType(mappingType) {
+        this.mapping_type = mappingType;
+        return this;
+    }
+
+    /**
+     * 设置映射范围。
+     * @param {string} scope - 映射范围（可能值：view, controller）
+     * @returns {ButtonMapping} 返回当前实例以支持链式调用
+     */
+    setScope(scope) {
+        this.scope = scope;
+        return this;
+    }
+
+    /**
+     * 设置输入模式条件。
+     * @param {string} condition - 输入模式条件（可能值：not_gaze, not_gamepad, gamepad_and_not_gaze）
+     * @returns {ButtonMapping} 返回当前实例以支持链式调用
+     */
+    setInputModeCondition(condition) {
+        this.input_mode_condition = condition;
+        return this;
+    }
+
+    /**
+     * 设置是否忽略输入范围。
+     * @param {boolean} ignore - 是否忽略输入范围
+     * @returns {ButtonMapping} 返回当前实例以支持链式调用
+     */
+    setIgnoreInputScope(ignore = false) {
+        this.ignore_input_scope = ignore;
+        return this;
+    }
+
+    /**
+     * 设置是否消耗事件。
+     * @param {boolean} consume - 是否消耗事件
+     * @returns {ButtonMapping} 返回当前实例以支持链式调用
+     */
+    setConsumeEvent(consume = false) {
+        this.consume_event = consume;
+        return this;
+    }
+
+    /**
+     * 设置是否处理选择事件。
+     * @param {boolean} handle - 是否处理选择事件
+     * @returns {ButtonMapping} 返回当前实例以支持链式调用
+     */
+    setHandleSelect(handle = false) {
+        this.handle_select = handle;
+        return this;
+    }
+
+    /**
+     * 设置是否处理取消选择事件。
+     * @param {boolean} handle - 是否处理取消选择事件
+     * @returns {ButtonMapping} 返回当前实例以支持链式调用
+     */
+    setHandleDeselect(handle = false) {
+        this.handle_deselect = handle;
+        return this;
+    }
+
+    /**
+     * 设置是否在首次拒绝后处理按钮释放事件。
+     * @param {boolean} handle - 是否处理按钮释放事件
+     * @returns {ButtonMapping} 返回当前实例以支持链式调用
+     */
+    setButtonUpRightOfFirstRefusal(handle = false) {
+        this.button_up_right_of_first_refusal = handle;
+        return this;
+    }
+}

package/src/core/ui/DataBindingObject.js

@@ -0,0 +1,146 @@
+/**
+ * DataBinding 类
+ * 
+ * 该类表示数据绑定配置，用于将硬编码值或变量绑定到元素属性。
+ * 
+ * 属性：
+ * - ignored: boolean - 是否忽略绑定（默认值：false）
+ * - binding_type: enum - 绑定类型（可能值：global, view, collection, collection_details, none）
+ * - binding_name: string - 数据绑定名称或条件的值
+ * - binding_name_override: string - 应用 binding_name 值的 UI 元素属性名称
+ * - binding_collection_name: string - 要使用的集合名称
+ * - binding_collection_prefix: string - 集合前缀
+ * - binding_condition: enum - 数据绑定的条件（可能值：always, always_when_visible, visible, once, none, visibility_changed）
+ * - source_control_name: string - 要观察其属性值的 UI 元素名称
+ * - source_property_name: string - 存储 source_control_name 引用的 UI 元素的属性值
+ * - target_property_name: string - 应用 source_property_name 值的 UI 元素属性
+ * - resolve_sibling_scope: boolean - 是否允许选择同级元素而非子元素（默认值：false）
+ */
+
+export class DataBindingObject {
+    constructor() {
+        /*
+        this.ignored = false;
+        this.binding_type = null;
+        this.binding_name = '';
+        this.binding_name_override = '';
+        this.binding_collection_name = '';
+        this.binding_collection_prefix = '';
+        this.binding_condition = null;
+        this.source_control_name = '';
+        this.source_property_name = '';
+        this.target_property_name = '';
+        this.resolve_sibling_scope = false;
+        */
+    }
+
+    /**
+     * 设置是否忽略绑定。
+     * @param {boolean} ignored - 是否忽略绑定（默认值：false）
+     * @returns {DataBindingObject} 返回当前实例以支持链式调用
+     */
+    setIgnored(ignored = false) {
+        this.ignored = ignored;
+        return this;
+    }
+
+    /**
+     * 设置绑定类型。
+     * @param {string} type - 绑定类型（可能值：global, view, collection, collection_details, none）
+     * @returns {DataBindingObject} 返回当前实例以支持链式调用
+     */
+    setBindingType(type) {
+        this.binding_type = type;
+        return this;
+    }
+
+    /**
+     * 设置数据绑定名称或条件的值。
+     * @param {string} name - 数据绑定名称或条件的值
+     * @returns {DataBindingObject} 返回当前实例以支持链式调用
+     */
+    setBindingName(name) {
+        this.binding_name = name;
+        return this;
+    }
+
+    /**
+     * 设置应用 binding_name 值的 UI 元素属性名称。
+     * @param {string} nameOverride - 应用 binding_name 值的 UI 元素属性名称
+     * @returns {DataBindingObject} 返回当前实例以支持链式调用
+     */
+    setBindingNameOverride(nameOverride) {
+        this.binding_name_override = nameOverride;
+        return this;
+    }
+
+    /**
+     * 设置要使用的集合名称。
+     * @param {string} collectionName - 集合名称
+     * @returns {DataBindingObject} 返回当前实例以支持链式调用
+     */
+    setBindingCollectionName(collectionName) {
+        this.binding_collection_name = collectionName;
+        return this;
+    }
+
+    /**
+     * 设置集合前缀。
+     * @param {string} prefix - 集合前缀
+     * @returns {DataBindingObject} 返回当前实例以支持链式调用
+     */
+    setBindingCollectionPrefix(prefix) {
+        this.binding_collection_prefix = prefix;
+        return this;
+    }
+
+    /**
+     * 设置数据绑定的条件。
+     * @param {string} condition - 数据绑定的条件（可能值：always, always_when_visible, visible, once, none, visibility_changed）
+     * @returns {DataBindingObject} 返回当前实例以支持链式调用
+     */
+    setBindingCondition(condition) {
+        this.binding_condition = condition;
+        return this;
+    }
+
+    /**
+     * 设置要观察其属性值的 UI 元素名称。
+     * @param {string} controlName - UI 元素名称
+     * @returns {DataBindingObject} 返回当前实例以支持链式调用
+     */
+    setSourceControlName(controlName) {
+        this.source_control_name = controlName;
+        return this;
+    }
+
+    /**
+     * 设置存储 source_control_name 引用的 UI 元素的属性值。
+     * @param {string} propertyName - 属性名称
+     * @returns {DataBindingObject} 返回当前实例以支持链式调用
+     */
+    setSourcePropertyName(propertyName) {
+        this.source_property_name = propertyName;
+        return this;
+    }
+
+    /**
+     * 设置应用 source_property_name 值的 UI 元素属性。
+     * @param {string} propertyName - 属性名称
+     * @returns {DataBindingObject} 返回当前实例以支持链式调用
+     */
+    setTargetPropertyName(propertyName) {
+        this.target_property_name = propertyName;
+        return this;
+    }
+
+    /**
+     * 设置是否允许选择同级元素而非子元素。
+     * @param {boolean} resolve - 是否允许选择同级元素（默认值：false）
+     * @returns {DataBindingObject} 返回当前实例以支持链式调用
+     */
+    setResolveSiblingScope(resolve = false) {
+        this.resolve_sibling_scope = resolve;
+        return this;
+    }
+}

package/src/core/ui/Properties/Control.js

@@ -0,0 +1,308 @@
+/**
+ * Control Class
+ * 
+ * This class represents a UI control element with various properties and methods to manipulate its state.
+ * 
+ * Properties:
+ * - visible: boolean - If the UI element should be visible (default: true)
+ * - enabled: boolean - If true and if the UI element or any of its children have the locked state then they will be in the locked (default: true)
+ * - layer: int - Z-Index/Layer (like zindex in CSS) relative to parent element. Higher layers will render above (default: 0)
+ * - alpha: float - Alpha/transparency of the element. It will only affect the UI element. Its children will be unaffected. (default: 1.0)
+ * - propagate_alpha: boolean - If alpha should not only apply to the parent if possible but also all its children (default: false)
+ * - clips_children: boolean - Cuts off visually and interactively everything beyond the boundaries of the UI element (default: false)
+ * - allow_clipping: boolean - If clips_children works in the UI element. Otherwise, it won't have any effect (default: true)
+ * - clip_offset: Vector [x, y] - Offset from the start of the clipping (default: [0, 0])
+ * - clip_state_change_event: string - Event triggered when the clip state changes
+ * - enable_scissor_test: boolean - Enables scissor test for clipping (default: false)
+ * - property_bag: object - Property bag contains properties/variables that are more related with the data than the actual structure and look of the UI element
+ * - selected: boolean - If the text box is selected by default
+ * - use_child_anchors: boolean - Use the anchor_from and anchor_to of the child of the UI element (default: false)
+ * - controls: array - For adding children to the element
+ * - anims: string[] - Array of the animation names
+ * - disable_anim_fast_forward: boolean - Disables fast-forwarding animations
+ * - animation_reset_name: string - Name of the animation to reset to
+ * - ignored: boolean - If the UI element should be ignored (default: false)
+ * - variables: array or object - A bunch of conditions that change the variables values
+ * - modifications: array - Allows to modify the UI files of resource packs below (vanilla being the most bottom one)
+ * - grid_position: Vector [row, column] - Position that the control will take inside the grid. This also allows to modify specific grid items of a hardcoded grid
+ * - collection_index: int - Index that the control takes in the collection
+ */
+/**
+ * Control 类
+ * 
+ * 该类表示一个具有各种属性和方法的 UI 控件元素，用于操作其状态。
+ * 
+ * 属性：
+ * - visible: boolean - 控制 UI 元素是否可见（默认值：true）
+ * - enabled: boolean - 如果为 true，且 UI 元素或其任何子元素处于锁定状态，则它们将被锁定（默认值：true）
+ * - layer: int - 相对于父元素的 Z-Index/层级（类似于 CSS 中的 zindex）。较高的层级将渲染在上方（默认值：0）
+ * - alpha: float - 元素的透明度。仅影响 UI 元素本身，其子元素不受影响。如果希望透明度同时应用于父元素和子元素，请使用 propagate_alpha（默认值：1.0）
+ * - propagate_alpha: boolean - 透明度是否应同时应用于父元素及其所有子元素（默认值：false）
+ * - clips_children: boolean - 是否在视觉上和交互上裁剪超出 UI 元素边界的内容（默认值：false）
+ * - allow_clipping: boolean - 是否允许在 UI 元素中启用裁剪。否则，clips_children 将无效（默认值：true）
+ * - clip_offset: Vector [x, y] - 裁剪起始点的偏移量（默认值：[0, 0]）
+ * - clip_state_change_event: string - 裁剪状态更改时触发的事件
+ * - enable_scissor_test: boolean - 是否启用裁剪测试（默认值：false）
+ * - property_bag: object - 属性包，包含与数据相关的属性/变量，而不是 UI 元素的实际结构和外观
+ * - selected: boolean - 文本框是否默认被选中
+ * - use_child_anchors: boolean - 是否使用 UI 元素子元素的 anchor_from 和 anchor_to（默认值：false）
+ * - controls: array - 用于向元素添加子元素
+ * - anims: string[] - 动画名称数组
+ * - disable_anim_fast_forward: boolean - 是否禁用动画快进
+ * - animation_reset_name: string - 重置动画的名称
+ * - ignored: boolean - 是否忽略该 UI 元素（默认值：false）
+ * - variables: array 或 object - 一组条件，用于更改变量的值
+ * - modifications: array - 允许修改资源包中的 UI 文件（最底层为原版资源包）
+ * - grid_position: Vector [row, column] - 控件在网格中的位置。此属性还允许修改硬编码网格中的特定网格项
+ * - collection_index: int - 控件在集合中的索引
+ */
+
+export class Control {
+    constructor() {
+        /*
+        this.visible = true;
+        this.enabled = true;
+        this.layer = 0;
+        this.alpha = 1.0;
+        this.propagate_alpha = false;
+        this.clips_children = false;
+        this.allow_clipping = true;
+        this.clip_offset = [0, 0];
+        this.clip_state_change_event = '';
+        this.enable_scissor_test = false;
+        this.property_bag = {};
+        this.selected = false;
+        this.use_child_anchors = false;
+        this.controls = [];
+        this.anims = [];
+        this.disable_anim_fast_forward = false;
+        this.animation_reset_name = '';
+        this.ignored = false;
+        this.variables = {};
+        this.modifications = [];
+        this.grid_position = [0, 0];
+        this.collection_index = 0;
+        */
+    }
+
+    /**
+     * 设置控件的可见性。
+     * @param {boolean} visible - 控件是否可见（默认值：true）
+     * @returns {Control} 返回当前实例以支持链式调用
+     */
+    setVisible(visible = true) {
+        this.visible = visible;
+        return this;
+    }
+
+    /**
+     * 设置控件的启用状态。
+     * @param {boolean} enabled - 控件是否启用（默认值：true）
+     * @returns {Control} 返回当前实例以支持链式调用
+     */
+    setEnabled(enabled = true) {
+        this.enabled = enabled;
+        return this;
+    }
+
+    /**
+     * 设置控件的层级（z-index）。
+     * @param {number} layer - 要设置的层级（默认值：0）
+     * @returns {Control} 返回当前实例以支持链式调用
+     */
+    setLayer(layer = 0) {
+        this.layer = layer;
+        return this;
+    }
+
+    /**
+     * 设置控件的透明度。
+     * @param {number} alpha - 要设置的透明度值（默认值：1.0）
+     * @returns {Control} 返回当前实例以支持链式调用
+     */
+    setAlpha(alpha = 1.0) {
+        this.alpha = alpha;
+        return this;
+    }
+
+    /**
+     * 设置透明度是否应传播到子元素。
+     * @param {boolean} propagate - 透明度是否应传播（默认值：false）
+     * @returns {Control} 返回当前实例以支持链式调用
+     */
+    setPropagateAlpha(propagate = false) {
+        this.propagate_alpha = propagate;
+        return this;
+    }
+
+    /**
+     * 设置控件是否应裁剪其子元素。
+     * @param {boolean} clips - 控件是否应裁剪其子元素（默认值：false）
+     * @returns {Control} 返回当前实例以支持链式调用
+     */
+    setClipsChildren(clips = false) {
+        this.clips_children = clips;
+        return this;
+    }
+
+    /**
+     * 设置控件是否允许裁剪。
+     * @param {boolean} allow - 是否允许裁剪（默认值：true）
+     * @returns {Control} 返回当前实例以支持链式调用
+     */
+    setAllowClipping(allow = true) {
+        this.allow_clipping = allow;
+        return this;
+    }
+
+    /**
+     * 设置控件的裁剪偏移量。
+     * @param {number[]} offset - 裁剪偏移量，格式为 [x, y]（默认值：[0, 0]）
+     * @returns {Control} 返回当前实例以支持链式调用
+     */
+    setClipOffset(offset = [0, 0]) {
+        this.clip_offset = offset;
+        return this;
+    }
+
+    /**
+     * 设置裁剪状态更改事件。
+     * @param {string} event - 裁剪状态更改时触发的事件名称
+     * @returns {Control} 返回当前实例以支持链式调用
+     */
+    setClipStateChangeEvent(event) {
+        this.clip_state_change_event = event;
+        return this;
+    }
+
+    /**
+     * 设置是否启用裁剪测试。
+     * @param {boolean} enable - 是否启用裁剪测试（默认值：false）
+     * @returns {Control} 返回当前实例以支持链式调用
+     */
+    setEnableScissorTest(enable = false) {
+        this.enable_scissor_test = enable;
+        return this;
+    }
+
+    /**
+     * 设置控件的属性包。
+     * @param {object} bag - 要设置的属性包
+     * @returns {Control} 返回当前实例以支持链式调用
+     */
+    setPropertyBag(bag) {
+        this.property_bag = bag;
+        return this;
+    }
+
+    /**
+     * 设置控件是否被选中。
+     * @param {boolean} selected - 控件是否被选中（默认值：false）
+     * @returns {Control} 返回当前实例以支持链式调用
+     */
+    setSelected(selected = false) {
+        this.selected = selected;
+        return this;
+    }
+
+    /**
+     * 设置控件是否使用子元素的锚点。
+     * @param {boolean} use - 是否使用子元素的锚点（默认值：false）
+     * @returns {Control} 返回当前实例以支持链式调用
+     */
+    setUseChildAnchors(use = false) {
+        this.use_child_anchors = use;
+        return this;
+    }
+
+    /**
+     * 向控件添加子控件。
+     * @param {Control} control - 要添加的子控件
+     * @returns {Control} 返回当前实例以支持链式调用
+     */
+    addControl(control) {
+        if (!this.controls) this.controls = [];
+        this.controls.push(control);
+        return this;
+    }
+
+    /**
+     * 设置控件的动画。
+     * @param {string[]} anims - 动画名称数组
+     * @returns {Control} 返回当前实例以支持链式调用
+     */
+    setAnimations(anims) {
+        this.anims = anims;
+        return this;
+    }
+
+    /**
+     * 设置是否禁用动画快进。
+     * @param {boolean} disable - 是否禁用动画快进（默认值：false）
+     * @returns {Control} 返回当前实例以支持链式调用
+     */
+    setDisableAnimFastForward(disable = false) {
+        this.disable_anim_fast_forward = disable;
+        return this;
+    }
+
+    /**
+     * 设置动画重置名称。
+     * @param {string} name - 要重置的动画名称
+     * @returns {Control} 返回当前实例以支持链式调用
+     */
+    setAnimationResetName(name) {
+        this.animation_reset_name = name;
+        return this;
+    }
+
+    /**
+     * 设置是否忽略该控件。
+     * @param {boolean} ignored - 是否忽略该控件（默认值：false）
+     * @returns {Control} 返回当前实例以支持链式调用
+     */
+    setIgnored(ignored = false) {
+        this.ignored = ignored;
+        return this;
+    }
+
+    /**
+     * 设置控件的变量。
+     * @param {object} variables - 要设置的变量
+     * @returns {Control} 返回当前实例以支持链式调用
+     */
+    setVariables(variables) {
+        this.variables = variables;
+        return this;
+    }
+
+    /**
+     * 设置控件的修改项。
+     * @param {array} modifications - 要设置的修改项
+     * @returns {Control} 返回当前实例以支持链式调用
+     */
+    setModifications(modifications) {
+        this.modifications = modifications;
+        return this;
+    }
+
+    /**
+     * 设置控件在网格中的位置。
+     * @param {number[]} position - 网格位置，格式为 [行, 列]
+     * @returns {Control} 返回当前实例以支持链式调用
+     */
+    setGridPosition(position) {
+        this.grid_position = position;
+        return this;
+    }
+
+    /**
+     * 设置控件在集合中的索引。
+     * @param {number} index - 要设置的索引
+     * @returns {Control} 返回当前实例以支持链式调用
+     */
+    setCollectionIndex(index) {
+        this.collection_index = index;
+        return this;
+    }
+}

package/src/core/ui/Properties/DataBinding.js

@@ -0,0 +1,14 @@
+export class DataBinding{
+    constructor(){
+    }
+    setBinding(binding){
+        if(!this.bindings) this.bindings = [];
+        this.binding = binding;
+        return this;
+    }
+    addDataBinding(dataBindingObject){
+        if(!this.bindings) this.bindings = [];
+        this.bindings.push(dataBindingObject);
+        return this;
+    }
+}

package/src/core/ui/Properties/Factory.js

@@ -0,0 +1,63 @@
+/**
+ * Factory 类
+ * 
+ * 该类表示一个工厂控件，用于管理子控件的名称和 ID。
+ * 
+ * 属性：
+ * - control_name: string - 工厂的子控件名
+ * - control_ids: object - 工厂的子控件 ID 对象组
+ */
+
+export class Factory {
+    constructor() {
+        
+        /*
+        this.control_name = '';
+        this.control_ids = {};
+        */
+    }
+    /**
+     * 设置工厂的名。
+     * @param {string} name - 名（格式：name）
+     * @returns {Factory} 返回当前实例以支持链式调用
+     */
+    setName(name) {
+        if(!this.factory) this.factory = {};
+        this.factory.name = name;
+        return this;
+    }
+
+    /**
+     * 设置工厂的子控件名。
+     * @param {string} name - 子控件名（格式：namespace.controls_name）
+     * @returns {Factory} 返回当前实例以支持链式调用
+     */
+    setControlName(name) {
+        if(!this.factory) this.factory = {};
+        this.factory.control_name = name;
+        return this;
+    }
+
+    /**
+     * 设置工厂的子控件 ID 对象组。
+     * @param {object} ids - 子控件 ID 对象组
+     * @returns {Factory} 返回当前实例以支持链式调用
+     */
+    setControlIds(ids) {
+        if(!this.factory) this.factory = {};
+        this.factory.control_ids = ids;
+        return this;
+    }
+
+    /**
+     * 添加一个子控件 ID。
+     * @param {string} key - 子控件的键名
+     * @param {string} value - 子控件的 ID 值
+     * @returns {Factory} 返回当前实例以支持链式调用
+     */
+    addControlId(key, value) {
+        if(!this.factory) this.factory = {};
+        this.factory.control_ids[key] = value;
+        return this;
+    }
+}