• English

      • @scml/addon-mod-beauty-selector

      TypeScript type definitions for Beauty Selector addon, for image selector UI and mod image management.

      Installation

      npm
      yarn
      pnpm
      bun
      deno
      npm install -D @scml/addon-mod-beauty-selector

      Quick Start

      Add type reference

      /// <reference types="@scml/addon-mod-beauty-selector" />

      Use global instance

      addonBeautySelectorAddon is mounted on window.

      Import types on demand

      import type { BeautySelectorAddon } from '@scml/addon-mod-beauty-selector/BeautySelectorAddon';
import type { BeautySelectorAddonInterface } from '@scml/addon-mod-beauty-selector/BeautySelectorAddonInterface';

      Global Types global

      PropertyTypeDescription
      addonBeautySelectorAddonBeautySelectorAddonAddon instance
      Main entry
      Subpath import
      /// <reference types="@scml/addon-mod-beauty-selector" />

      Subpath Exports

      SubpathDescription
      .Main entry, augments Window/global
      ./BeautySelectorAddonMain class
      ./BeautySelectorAddonInterfaceInterfaces
      ./BeautySelectorAddonTypeType definitions
      ./extnameExtension utilities
      ./ModImageStoreMod image store
      ./utils/getRelativePathRelative path utilities
      ./utils/traverseZipFolderTraverse zip folder
      ./GUI_StringTable/*GUI string tables

      API Reference

      ./BeautySelectorAddon

      Main Beauty Selector Addon class implementing BeautySelectorAddonInterface and AddonPluginHookPointEx, providing image selector and mod image management. See BeautySelectorAddonInterface and type definitions for detailed API.

      Type Definition Source

      Source Code
      INFO