• 简体中文

      • @scml/addon-modded-hair

      Modded hair addon 的 TypeScript 类型定义，用于添加并合并 modded 发型数据。

      安装

      npm
      yarn
      pnpm
      bun
      deno
      npm install -D @scml/addon-modded-hair

      快速开始

      添加类型引用

      /// <reference types="@scml/addon-modded-hair" />

      使用全局实例

      addonModdedHairAddon 已挂载到 window 上。

      按需导入类型

      import type { ModdedHairAddon, mergeHairObject } from '@scml/addon-modded-hair/ModdedHairAddon';
import type { ModdedClothesHairParams } from '@scml/addon-modded-hair/ModdedHairAddonParams';

      全局类型 global

      属性类型说明
      addonModdedHairAddonModdedHairAddonAddon 实例，管理发型数据
      主入口
      子路径导入
      /// <reference types="@scml/addon-modded-hair" />

      子路径导出

      子路径描述
      .主入口，增强 Window/全局
      ./ModdedHairAddon主类与工具函数
      ./ModdedHairAddonParams配置参数与类型守卫

      API 参考

      ./ModdedHairAddon

      ModdedHairAddon 类

      属性类型说明
      hairDataMap<string, HairObject>按 key 存储的发型数据
      registerMod()(addonName, mod, modZip) => Promise<void>注册 mod
      exportDataZip()(zip: JSZip) => Promise<JSZip>导出数据
      init()() => void初始化

      mergeHairObject() / appendHairObject() 方法

      • mergeHairObject(b, o, modName, logger)：合并两个 HairObject，相同 key 报错
      • appendHairObject(b, o, logger)：将 o 追加到 b

      ./ModdedHairAddonParams

      ModdedClothesHairParams 接口

      属性类型说明
      hairstring[]发型文件路径列表

      checkParams() / checkHairItem() 类型守卫

      类型定义来源

      源码
      INFO