sapdon 2.0.2 → 3.0.0

package/dist/core/ui/properties/sound.js

@@ -0,0 +1,66 @@
+/**
+ * Sound 类
+ *
+ * 该类表示一个声音控件，用于管理声音播放及其相关属性。
+ *
+ * 属性：
+ * - sound_name: string - 声音名称（定义在 RP/sounds/sound_definitions.json 文件中）
+ * - sound_volume: float - 声音音量（默认值：1.0）
+ * - sound_pitch: float - 声音音调（默认值：1.0）
+ * - sounds: Array of sound objects - 触发事件时播放的声音数组
+ */
+export class Sound {
+    constructor() {
+        /*
+        this.sound_name = '';
+        this.sound_volume = 1.0;
+        this.sound_pitch = 1.0;
+        this.sounds = [];
+        */
+    }
+    /**
+     * 设置声音名称。
+     * @param {string} name - 声音名称（定义在 RP/sounds/sound_definitions.json 文件中）
+     * @returns {Sound} 返回当前实例以支持链式调用
+     */
+    setSoundName(name) {
+        this.sound_name = name;
+        return this;
+    }
+    /**
+     * 设置声音音量。
+     * @param {number} volume - 音量（范围：0.0 到 1.0，默认值：1.0）
+     * @returns {Sound} 返回当前实例以支持链式调用
+     */
+    setSoundVolume(volume = 1.0) {
+        this.sound_volume = volume;
+        return this;
+    }
+    /**
+     * 设置声音音调。
+     * @param {number} pitch - 音调（默认值：1.0）
+     * @returns {Sound} 返回当前实例以支持链式调用
+     */
+    setSoundPitch(pitch = 1.0) {
+        this.sound_pitch = pitch;
+        return this;
+    }
+    /**
+     * 设置触发事件时播放的声音数组。
+     * @param {object[]} sounds - 声音对象数组
+     * @returns {Sound} 返回当前实例以支持链式调用
+     */
+    setSounds(sounds) {
+        this.sounds = sounds;
+        return this;
+    }
+    /**
+     * 添加一个声音对象到声音数组。
+     * @param {object} sound - 声音对象
+     * @returns {Sound} 返回当前实例以支持链式调用
+     */
+    addSound(sound) {
+        this.sounds.push(sound);
+        return this;
+    }
+}

package/dist/core/ui/properties/sprite.d.ts

@@ -0,0 +1,161 @@
+/**
+ * Sprite 类
+ *
+ * 该类表示一个 Sprite 控件，用于管理图像纹理及其相关属性。
+ *
+ * 属性：
+ * - texture: string - 图像路径（从包根目录开始，例如："textures/ui/White"）
+ * - allow_debug_missing_texture: boolean - 是否在纹理未找到时显示缺失纹理（默认值：true）
+ * - uv: Vector [u, v] - 纹理映射的起始位置
+ * - uv_size: Vector [width, height] - 纹理映射的大小
+ * - texture_file_system: string - 纹理来源（默认值：InUserPackage）
+ * - nineslice_size: int or Vector [x0, y0, x1, y1] - 9-slice 分割大小
+ * - tiled: boolean or enum - 是否平铺纹理（可能值：true/false, x, y）
+ * - tiled_scale: Vector [sX, sY] - 平铺纹理的缩放比例（默认值：false）
+ * - clip_direction: enum - 裁剪方向的起始点（可能值：left, right, up, down, center）
+ * - clip_ratio: float - 裁剪比例（范围：0.0 到 1.0）
+ * - clip_pixelperfect: boolean - 是否尽可能保持像素精确裁剪
+ * - keep_ratio: boolean - 是否在调整大小时保持比例（默认值：true）
+ * - bilinear: boolean - 是否在调整大小时使用双线性函数（默认值：false）
+ * - fill: boolean - 是否拉伸图像以适应大小（默认值：false）
+ * - $fit_to_width: boolean - 是否适应宽度
+ * - zip_folder: string - 压缩文件夹路径
+ * - grayscale: boolean - 是否以黑白渲染图像（默认值：false）
+ * - force_texture_reload: boolean - 是否在纹理路径更改时强制重新加载图像
+ * - base_size: Vector [width, height] - 基础大小
+ */
+export class Sprite {
+    /**
+     * 设置图像纹理路径。
+     * @param {string} texture - 图像路径（例如："textures/ui/White"）
+     * @returns {Sprite} 返回当前实例以支持链式调用
+     */
+    setTexture(texture: string): Sprite;
+    texture: string;
+    /**
+     * 设置是否在纹理未找到时显示缺失纹理。
+     * @param {boolean} allow - 是否显示缺失纹理（默认值：true）
+     * @returns {Sprite} 返回当前实例以支持链式调用
+     */
+    setAllowDebugMissingTexture(allow?: boolean): Sprite;
+    allow_debug_missing_texture: boolean;
+    /**
+     * 设置纹理映射的起始位置。
+     * @param {number[]} uv - 起始位置，格式为 [u, v]
+     * @returns {Sprite} 返回当前实例以支持链式调用
+     */
+    setUV(uv: number[]): Sprite;
+    uv: number[];
+    /**
+     * 设置纹理映射的大小。
+     * @param {number[]} uvSize - 大小，格式为 [width, height]
+     * @returns {Sprite} 返回当前实例以支持链式调用
+     */
+    setUVSize(uvSize: number[]): Sprite;
+    uv_size: number[];
+    /**
+     * 设置纹理来源。
+     * @param {string} source - 纹理来源（可能值：InUserPackage, InAppPackage, RawPath, RawPersistent, InSettingsDir, InExternalDir, InServerPackage, InDataDir, InUserDir, InWorldDir, StoreCache, Usage is Unknown）
+     * @returns {Sprite} 返回当前实例以支持链式调用
+     */
+    setTextureFileSystem(source?: string): Sprite;
+    texture_file_system: string;
+    /**
+     * 设置 9-slice 分割大小。
+     * @param {number|number[]} size - 9-slice 分割大小（可以是单个数字或 [x0, y0, x1, y1] 数组）
+     * @returns {Sprite} 返回当前实例以支持链式调用
+     */
+    setNineSliceSize(size: number | number[]): Sprite;
+    nineslice_size: number | number[];
+    /**
+     * 设置是否平铺纹理。
+     * @param {boolean|string} tiled - 是否平铺纹理（可能值：true/false, x, y）
+     * @returns {Sprite} 返回当前实例以支持链式调用
+     */
+    setTiled(tiled: boolean | string): Sprite;
+    tiled: string | boolean;
+    /**
+     * 设置平铺纹理的缩放比例。
+     * @param {number[]} scale - 缩放比例，格式为 [sX, sY]（默认值：[1, 1]）
+     * @returns {Sprite} 返回当前实例以支持链式调用
+     */
+    setTiledScale(scale?: number[]): Sprite;
+    tiled_scale: number[];
+    /**
+     * 设置裁剪方向的起始点。
+     * @param {string} direction - 裁剪方向（可能值：left, right, up, down, center）
+     * @returns {Sprite} 返回当前实例以支持链式调用
+     */
+    setClipDirection(direction: string): Sprite;
+    clip_direction: string;
+    /**
+     * 设置裁剪比例。
+     * @param {number} ratio - 裁剪比例（范围：0.0 到 1.0）
+     * @returns {Sprite} 返回当前实例以支持链式调用
+     */
+    setClipRatio(ratio: number): Sprite;
+    clip_ratio: number;
+    /**
+     * 设置是否尽可能保持像素精确裁剪。
+     * @param {boolean} pixelPerfect - 是否保持像素精确裁剪
+     * @returns {Sprite} 返回当前实例以支持链式调用
+     */
+    setClipPixelPerfect(pixelPerfect?: boolean): Sprite;
+    clip_pixelperfect: boolean;
+    /**
+     * 设置是否在调整大小时保持比例。
+     * @param {boolean} keep - 是否保持比例（默认值：true）
+     * @returns {Sprite} 返回当前实例以支持链式调用
+     */
+    setKeepRatio(keep?: boolean): Sprite;
+    keep_ratio: boolean;
+    /**
+     * 设置是否在调整大小时使用双线性函数。
+     * @param {boolean} bilinear - 是否使用双线性函数（默认值：false）
+     * @returns {Sprite} 返回当前实例以支持链式调用
+     */
+    setBilinear(bilinear?: boolean): Sprite;
+    bilinear: boolean;
+    /**
+     * 设置是否拉伸图像以适应大小。
+     * @param {boolean} fill - 是否拉伸图像（默认值：false）
+     * @returns {Sprite} 返回当前实例以支持链式调用
+     */
+    setFill(fill?: boolean): Sprite;
+    fill: boolean;
+    /**
+     * 设置是否适应宽度。
+     * @param {boolean} fit - 是否适应宽度
+     * @returns {Sprite} 返回当前实例以支持链式调用
+     */
+    setFitToWidth(fit?: boolean): Sprite;
+    $fit_to_width: boolean;
+    /**
+     * 设置压缩文件夹路径。
+     * @param {string} folder - 压缩文件夹路径
+     * @returns {Sprite} 返回当前实例以支持链式调用
+     */
+    setZipFolder(folder: string): Sprite;
+    zip_folder: string;
+    /**
+     * 设置是否以黑白渲染图像。
+     * @param {boolean} grayscale - 是否以黑白渲染图像（默认值：false）
+     * @returns {Sprite} 返回当前实例以支持链式调用
+     */
+    setGrayscale(grayscale?: boolean): Sprite;
+    grayscale: boolean;
+    /**
+     * 设置是否在纹理路径更改时强制重新加载图像。
+     * @param {boolean} force - 是否强制重新加载图像
+     * @returns {Sprite} 返回当前实例以支持链式调用
+     */
+    setForceTextureReload(force?: boolean): Sprite;
+    force_texture_reload: boolean;
+    /**
+     * 设置基础大小。
+     * @param {number[]} size - 基础大小，格式为 [width, height]
+     * @returns {Sprite} 返回当前实例以支持链式调用
+     */
+    setBaseSize(size: number[]): Sprite;
+    base_size: number[];
+}

package/dist/core/ui/properties/sprite.js

@@ -0,0 +1,222 @@
+/**
+ * Sprite 类
+ *
+ * 该类表示一个 Sprite 控件，用于管理图像纹理及其相关属性。
+ *
+ * 属性：
+ * - texture: string - 图像路径（从包根目录开始，例如："textures/ui/White"）
+ * - allow_debug_missing_texture: boolean - 是否在纹理未找到时显示缺失纹理（默认值：true）
+ * - uv: Vector [u, v] - 纹理映射的起始位置
+ * - uv_size: Vector [width, height] - 纹理映射的大小
+ * - texture_file_system: string - 纹理来源（默认值：InUserPackage）
+ * - nineslice_size: int or Vector [x0, y0, x1, y1] - 9-slice 分割大小
+ * - tiled: boolean or enum - 是否平铺纹理（可能值：true/false, x, y）
+ * - tiled_scale: Vector [sX, sY] - 平铺纹理的缩放比例（默认值：false）
+ * - clip_direction: enum - 裁剪方向的起始点（可能值：left, right, up, down, center）
+ * - clip_ratio: float - 裁剪比例（范围：0.0 到 1.0）
+ * - clip_pixelperfect: boolean - 是否尽可能保持像素精确裁剪
+ * - keep_ratio: boolean - 是否在调整大小时保持比例（默认值：true）
+ * - bilinear: boolean - 是否在调整大小时使用双线性函数（默认值：false）
+ * - fill: boolean - 是否拉伸图像以适应大小（默认值：false）
+ * - $fit_to_width: boolean - 是否适应宽度
+ * - zip_folder: string - 压缩文件夹路径
+ * - grayscale: boolean - 是否以黑白渲染图像（默认值：false）
+ * - force_texture_reload: boolean - 是否在纹理路径更改时强制重新加载图像
+ * - base_size: Vector [width, height] - 基础大小
+ */
+export class Sprite {
+    constructor() {
+        /*
+        this.texture = '';
+        this.allow_debug_missing_texture = true;
+        this.uv = null;
+        this.uv_size = null;
+        this.texture_file_system = 'InUserPackage';
+        this.nineslice_size = null;
+        this.tiled = false;
+        this.tiled_scale = [1, 1];
+        this.clip_direction = null;
+        this.clip_ratio = null;
+        this.clip_pixelperfect = false;
+        this.keep_ratio = true;
+        this.bilinear = false;
+        this.fill = false;
+        this.$fit_to_width = false;
+        this.zip_folder = '';
+        this.grayscale = false;
+        this.force_texture_reload = false;
+        this.base_size = null;
+        */
+    }
+    /**
+     * 设置图像纹理路径。
+     * @param {string} texture - 图像路径（例如："textures/ui/White"）
+     * @returns {Sprite} 返回当前实例以支持链式调用
+     */
+    setTexture(texture) {
+        this.texture = texture;
+        return this;
+    }
+    /**
+     * 设置是否在纹理未找到时显示缺失纹理。
+     * @param {boolean} allow - 是否显示缺失纹理（默认值：true）
+     * @returns {Sprite} 返回当前实例以支持链式调用
+     */
+    setAllowDebugMissingTexture(allow = true) {
+        this.allow_debug_missing_texture = allow;
+        return this;
+    }
+    /**
+     * 设置纹理映射的起始位置。
+     * @param {number[]} uv - 起始位置，格式为 [u, v]
+     * @returns {Sprite} 返回当前实例以支持链式调用
+     */
+    setUV(uv) {
+        this.uv = uv;
+        return this;
+    }
+    /**
+     * 设置纹理映射的大小。
+     * @param {number[]} uvSize - 大小，格式为 [width, height]
+     * @returns {Sprite} 返回当前实例以支持链式调用
+     */
+    setUVSize(uvSize) {
+        this.uv_size = uvSize;
+        return this;
+    }
+    /**
+     * 设置纹理来源。
+     * @param {string} source - 纹理来源（可能值：InUserPackage, InAppPackage, RawPath, RawPersistent, InSettingsDir, InExternalDir, InServerPackage, InDataDir, InUserDir, InWorldDir, StoreCache, Usage is Unknown）
+     * @returns {Sprite} 返回当前实例以支持链式调用
+     */
+    setTextureFileSystem(source = 'InUserPackage') {
+        this.texture_file_system = source;
+        return this;
+    }
+    /**
+     * 设置 9-slice 分割大小。
+     * @param {number|number[]} size - 9-slice 分割大小（可以是单个数字或 [x0, y0, x1, y1] 数组）
+     * @returns {Sprite} 返回当前实例以支持链式调用
+     */
+    setNineSliceSize(size) {
+        this.nineslice_size = size;
+        return this;
+    }
+    /**
+     * 设置是否平铺纹理。
+     * @param {boolean|string} tiled - 是否平铺纹理（可能值：true/false, x, y）
+     * @returns {Sprite} 返回当前实例以支持链式调用
+     */
+    setTiled(tiled) {
+        this.tiled = tiled;
+        return this;
+    }
+    /**
+     * 设置平铺纹理的缩放比例。
+     * @param {number[]} scale - 缩放比例，格式为 [sX, sY]（默认值：[1, 1]）
+     * @returns {Sprite} 返回当前实例以支持链式调用
+     */
+    setTiledScale(scale = [1, 1]) {
+        this.tiled_scale = scale;
+        return this;
+    }
+    /**
+     * 设置裁剪方向的起始点。
+     * @param {string} direction - 裁剪方向（可能值：left, right, up, down, center）
+     * @returns {Sprite} 返回当前实例以支持链式调用
+     */
+    setClipDirection(direction) {
+        this.clip_direction = direction;
+        return this;
+    }
+    /**
+     * 设置裁剪比例。
+     * @param {number} ratio - 裁剪比例（范围：0.0 到 1.0）
+     * @returns {Sprite} 返回当前实例以支持链式调用
+     */
+    setClipRatio(ratio) {
+        this.clip_ratio = ratio;
+        return this;
+    }
+    /**
+     * 设置是否尽可能保持像素精确裁剪。
+     * @param {boolean} pixelPerfect - 是否保持像素精确裁剪
+     * @returns {Sprite} 返回当前实例以支持链式调用
+     */
+    setClipPixelPerfect(pixelPerfect = false) {
+        this.clip_pixelperfect = pixelPerfect;
+        return this;
+    }
+    /**
+     * 设置是否在调整大小时保持比例。
+     * @param {boolean} keep - 是否保持比例（默认值：true）
+     * @returns {Sprite} 返回当前实例以支持链式调用
+     */
+    setKeepRatio(keep = true) {
+        this.keep_ratio = keep;
+        return this;
+    }
+    /**
+     * 设置是否在调整大小时使用双线性函数。
+     * @param {boolean} bilinear - 是否使用双线性函数（默认值：false）
+     * @returns {Sprite} 返回当前实例以支持链式调用
+     */
+    setBilinear(bilinear = false) {
+        this.bilinear = bilinear;
+        return this;
+    }
+    /**
+     * 设置是否拉伸图像以适应大小。
+     * @param {boolean} fill - 是否拉伸图像（默认值：false）
+     * @returns {Sprite} 返回当前实例以支持链式调用
+     */
+    setFill(fill = false) {
+        this.fill = fill;
+        return this;
+    }
+    /**
+     * 设置是否适应宽度。
+     * @param {boolean} fit - 是否适应宽度
+     * @returns {Sprite} 返回当前实例以支持链式调用
+     */
+    setFitToWidth(fit = false) {
+        this.$fit_to_width = fit;
+        return this;
+    }
+    /**
+     * 设置压缩文件夹路径。
+     * @param {string} folder - 压缩文件夹路径
+     * @returns {Sprite} 返回当前实例以支持链式调用
+     */
+    setZipFolder(folder) {
+        this.zip_folder = folder;
+        return this;
+    }
+    /**
+     * 设置是否以黑白渲染图像。
+     * @param {boolean} grayscale - 是否以黑白渲染图像（默认值：false）
+     * @returns {Sprite} 返回当前实例以支持链式调用
+     */
+    setGrayscale(grayscale = false) {
+        this.grayscale = grayscale;
+        return this;
+    }
+    /**
+     * 设置是否在纹理路径更改时强制重新加载图像。
+     * @param {boolean} force - 是否强制重新加载图像
+     * @returns {Sprite} 返回当前实例以支持链式调用
+     */
+    setForceTextureReload(force = false) {
+        this.force_texture_reload = force;
+        return this;
+    }
+    /**
+     * 设置基础大小。
+     * @param {number[]} size - 基础大小，格式为 [width, height]
+     * @returns {Sprite} 返回当前实例以支持链式调用
+     */
+    setBaseSize(size) {
+        this.base_size = size;
+        return this;
+    }
+}

package/dist/core/ui/properties/text.d.ts

@@ -0,0 +1,135 @@
+/**
+ * Text 类
+ *
+ * 该类表示一个文本控件，用于管理文本内容及其样式属性。
+ *
+ * 属性：
+ * - text: string - 文本内容（默认值：空字符串）
+ * - color: Vector [r, g, b] - 文本颜色（RGB 值，范围 0.0 到 1.0，默认值：[1.0, 1.0, 1.0]）
+ * - locked_color: Vector [r, g, b] - 父级禁用时的文本颜色
+ * - shadow: boolean - 是否显示文本阴影（默认值：false）
+ * - hide_hyphen: boolean - 是否隐藏断词连字符（默认值：false）
+ * - notify_on_ellipses: string[] - 文本出现省略号时需通知的控件名称数组
+ * - enable_profanity_filter: boolean - 是否启用脏话过滤（默认值：false）
+ * - locked_alpha: float - 父级禁用时的透明度
+ * - font_size: enum - 字体大小（可能值：small, normal, large, extra_large，默认值：normal）
+ * - font_scale_factor: float - 字体缩放比例（默认值：1.0）
+ * - localize: boolean - 是否启用本地化翻译（默认值：false）
+ * - line_padding: number - 行间距
+ * - font_type: enum - 字体类型（可能值：default, rune, unicode, smooth, MinecraftTen 或自定义字体，默认值：default）
+ * - backup_font_type: enum - 备用字体类型（默认值：default）
+ * - text_alignment: enum - 文本对齐方式（未定义时根据 anchor_from 和 anchor_to 自动调整）
+ */
+export class Text {
+    /**
+     * 设置文本内容。
+     * @param {string} text - 文本内容
+     * @returns {Text} 返回当前实例以支持链式调用
+     */
+    setText(text?: string): Text;
+    text: string;
+    /**
+     * 设置文本颜色。
+     * @param {number[]} color - RGB 颜色值（格式：[r, g, b]，默认值：[1.0, 1.0, 1.0]）
+     * @returns {Text} 返回当前实例以支持链式调用
+     */
+    setColor(color?: number[]): Text;
+    color: number[];
+    /**
+     * 设置父级禁用时的文本颜色。
+     * @param {number[]} lockedColor - RGB 颜色值（格式：[r, g, b]）
+     * @returns {Text} 返回当前实例以支持链式调用
+     */
+    setLockedColor(lockedColor: number[]): Text;
+    locked_color: number[];
+    /**
+     * 设置是否显示文本阴影。
+     * @param {boolean} shadow - 是否显示阴影（默认值：false）
+     * @returns {Text} 返回当前实例以支持链式调用
+     */
+    setShadow(shadow?: boolean): Text;
+    shadow: boolean;
+    /**
+     * 设置是否隐藏断词连字符。
+     * @param {boolean} hide - 是否隐藏连字符（默认值：false）
+     * @returns {Text} 返回当前实例以支持链式调用
+     */
+    setHideHyphen(hide?: boolean): Text;
+    hide_hyphen: boolean;
+    /**
+     * 设置文本出现省略号时需通知的控件名称数组。
+     * @param {string[]} controls - 控件名称数组
+     * @returns {Text} 返回当前实例以支持链式调用
+     */
+    setNotifyOnEllipses(controls: string[]): Text;
+    notify_on_ellipses: string[];
+    /**
+     * 添加一个需通知省略号事件的控件名称。
+     * @param {string} controlName - 控件名称
+     * @returns {Text} 返回当前实例以支持链式调用
+     */
+    addNotifyOnEllipses(controlName: string): Text;
+    /**
+     * 设置是否启用脏话过滤。
+     * @param {boolean} enable - 是否启用过滤（默认值：false）
+     * @returns {Text} 返回当前实例以支持链式调用
+     */
+    setEnableProfanityFilter(enable?: boolean): Text;
+    enable_profanity_filter: boolean;
+    /**
+     * 设置父级禁用时的透明度。
+     * @param {number} alpha - 透明度（范围：0.0 到 1.0）
+     * @returns {Text} 返回当前实例以支持链式调用
+     */
+    setLockedAlpha(alpha: number): Text;
+    locked_alpha: number;
+    /**
+     * 设置字体大小。
+     * @param {string} size - 字体大小（可能值：small, normal, large, extra_large，默认值：normal）
+     * @returns {Text} 返回当前实例以支持链式调用
+     */
+    setFontSize(size?: string): Text;
+    font_size: string;
+    /**
+     * 设置字体缩放比例。
+     * @param {number} factor - 缩放比例（默认值：1.0）
+     * @returns {Text} 返回当前实例以支持链式调用
+     */
+    setFontScaleFactor(factor?: number): Text;
+    font_scale_factor: number;
+    /**
+     * 设置是否启用本地化翻译。
+     * @param {boolean} localize - 是否启用本地化（默认值：false）
+     * @returns {Text} 返回当前实例以支持链式调用
+     */
+    setLocalize(localize?: boolean): Text;
+    localize: boolean;
+    /**
+     * 设置行间距。
+     * @param {number} padding - 行间距
+     * @returns {Text} 返回当前实例以支持链式调用
+     */
+    setLinePadding(padding: number): Text;
+    line_padding: number;
+    /**
+     * 设置字体类型。
+     * @param {string} font - 字体类型（可能值：default, rune, unicode 等，默认值：default）
+     * @returns {Text} 返回当前实例以支持链式调用
+     */
+    setFontType(font?: string): Text;
+    font_type: string;
+    /**
+     * 设置备用字体类型。
+     * @param {string} backupFont - 备用字体类型（默认值：default）
+     * @returns {Text} 返回当前实例以支持链式调用
+     */
+    setBackupFontType(backupFont?: string): Text;
+    backup_font_type: string;
+    /**
+     * 设置文本对齐方式。
+     * @param {string} alignment - 对齐方式（例如：left, right, center）
+     * @returns {Text} 返回当前实例以支持链式调用
+     */
+    setTextAlignment(alignment: string): Text;
+    text_alignment: string;
+}