Interface PluginConstructor

constructor

• new PluginConstructor(): Plugin

  Plugin constructor

  Returns Plugin

Readonlyicon

instance

Optional Readonlylogo

Readonlymenu

Readonlyname

Readonlyprototype

Optional Readonlythumb

component

• component<ComponentType>(
      component: ComponentType,
      framework: FrameworkPluginConstructor,
      props?: Record<string, unknown>,
  ): PluginComponent<ComponentType>

  Create framework component.

  Type Parameters

  • ComponentType

  Parameters

  • component: ComponentType

    JSX Component.

  • framework: FrameworkPluginConstructor
  • Optionalprops: Record<string, unknown>

    JSX Component props.

  Returns PluginComponent<ComponentType>

  Duplicis plugin component.

patch

• patch<
      Name extends keyof TargetList,
      Base extends AppConstructor | GameConstructor,
      Mixin extends AppConstructor | GameConstructor,
  >(
      name: Name,
      base: Base,
      apply: TargetApply<Base, Mixin>,
  ): Target<Mixin>

  Apply mixin patch.

  Type Parameters

  • Name extends keyof TargetList
  • Base extends AppConstructor | GameConstructor
  • Mixin extends AppConstructor | GameConstructor

  Parameters

  • name: Name

    Target name.

  • base: Base

    Base class.

  • apply: TargetApply<Base, Mixin>

    Mixin function.

  Returns Target<Mixin>

  Modified target.

translations

• translations<T extends BasePluginTranslation>(
      data: Record<Locales, T>,
  ): PluginI18n<T>

  Generate plugin translations.

  Type Parameters

  • T extends BasePluginTranslation

  Parameters

  • data: Record<Locales, T>

    Translation data.

  Returns PluginI18n<T>

  Plugin translator.