• 简体中文

      • @scml/addon-twee-replacer-linker

      Twee replacer linker addon 的 TypeScript 类型定义，用于连接 TweeReplacer 客户端，协调跨 mod 的替换回调。

      安装

      npm
      yarn
      pnpm
      bun
      deno
      npm install -D @scml/addon-twee-replacer-linker

      快速开始

      添加类型引用

      /// <reference types="@scml/addon-twee-replacer-linker" />

      使用全局实例

      addonTweeReplacerLinker 已挂载到 window 上。

      按需导入类型

      import type { TweeReplacerLinker } from '@scml/addon-twee-replacer-linker/TweeReplacerLinker';
import type { TweeReplacerLinkerInterface, TweeReplacerLinkerClientInterface } from '@scml/addon-twee-replacer-linker/TweeReplacerLinkerInterface';

      全局类型 global

      属性类型说明
      addonTweeReplacerLinkerTweeReplacerLinkerAddon 实例，协调 TweeReplacer 客户端
      主入口
      子路径导入
      /// <reference types="@scml/addon-twee-replacer-linker" />

      子路径导出

      子路径描述
      .主入口，增强 Window/全局
      ./TweeReplacerLinker主类
      ./TweeReplacerLinkerInterface接口与类型

      API 参考

      ./TweeReplacerLinker

      TweeReplacerLinker 类

      属性/方法类型说明
      canRegisterboolean是否可注册
      userCallbackTweeReplacerLinkerCallbackData[]用户回调列表
      registerClient()(client) => Promise<boolean>注册客户端
      addUserMod()(clientName, userModName, callback) => Promise<boolean>添加用户 mod 回调
      registerMod()(addonName, mod, modZip) => Promise<void>注册 mod
      afterPatchModToGame()() => Promise<void>patch 后钩子
      init()() => void初始化

      ./TweeReplacerLinkerInterface

      TweeReplacerLinkerInterface 接口

      方法说明
      registerClient(client)注册客户端
      addUserMod(clientName, userModName, callback)添加用户 mod 回调

      TweeReplacerLinkerClientInterface 接口

      方法说明
      enableLinkerMode()启用 linker 模式

      TweeReplacerLinkerClientCallbackType 类型

      (sc: SC2DataInfo) => Promise<any> - 用户 mod 回调类型

      类型定义来源

      源码
      INFO