• English

      • @scml/addon-mod-time-wrapper

      TypeScript type definitions for DoL Time Wrapper addon, for wrapping game time-related functions with time hooks and proxies.

      Installation

      npm
      yarn
      pnpm
      bun
      deno
      npm install -D @scml/addon-mod-time-wrapper

      Quick Start

      Add type reference

      /// <reference types="@scml/addon-mod-time-wrapper" />

      Use global instance

      addonDoLTimeWrapperAddon is mounted on window.

      Import types on demand

      import type { DoLTimeWrapperAddon } from '@scml/addon-mod-time-wrapper/DoLTimeWrapperAddon';
import type { TimeProxyManager, TimeHookType } from '@scml/addon-mod-time-wrapper/TimeProxyManager';
import type { OldTimeFunctionHook } from '@scml/addon-mod-time-wrapper/OldTimeFunctionHook';

      Global Types global

      PropertyTypeDescription
      addonDoLTimeWrapperAddonDoLTimeWrapperAddonAddon instance
      Main entry
      Subpath import
      /// <reference types="@scml/addon-mod-time-wrapper" />

      Subpath Exports

      SubpathDescription
      .Main entry, augments Window/global
      ./DoLTimeWrapperAddonMain Addon class
      ./OldTimeFunctionHookOld time function hook
      ./TimeProxyManagerTime proxy manager
      ./DoLTimeWrapperAddonPluginAddon plugin

      API Reference

      ./DoLTimeWrapperAddon

      DoLTimeWrapperAddon class

      PropertyTypeDescription
      infinityLoopCheckerInfinityLoopCheckerInfinite loop detection
      timeProxyManagerTimeProxyManagerTime proxy manager
      timeHookManagerTimeHookManagerTime hook manager
      isInitbooleanWhether initialized
      addTimeHook(hook)Add time hook
      addFunctionHook(hook)Add function hook
      makeCatchCode()Generate catch code
      init(oldTimeFunctionRef)Initialize, returns injection code

      ./TimeProxyManager

      Time proxy and hook management, including TimeProxyManager, TimeHookType, InfinityLoopChecker, etc.

      ./OldTimeFunctionHook

      Old time function reference type, used for init() parameter.

      Type Definition Source

      INFO
      • Upstream: Bundled with scml-types
      • Build: pnpm run download && pnpm run build