@scml/addon-twee-replacer-linker

TypeScript type definitions for Twee replacer linker addon, for connecting TweeReplacer clients and coordinating replace callbacks across mods.

Installation

npm

yarn

pnpm

bun

deno

npm install -D @scml/addon-twee-replacer-linker

Quick Start

Add type reference

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

Use global instance

addonTweeReplacerLinker is mounted on window.

Import types on demand

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

Global Types global

Property	Type	Description
`addonTweeReplacerLinker`	`TweeReplacerLinker`	Addon instance, coordinates TweeReplacer clients

Main entry

Subpath import

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

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

Subpath Exports

Subpath	Description
`.`	Main entry, augments Window/global
`./TweeReplacerLinker`	Main class
`./TweeReplacerLinkerInterface`	Interfaces and types

API Reference

./TweeReplacerLinker

TweeReplacerLinker class

Property/Method	Type	Description
`canRegister`	`boolean`	Whether registrable
`userCallback`	`TweeReplacerLinkerCallbackData[]`	User callback list
`registerClient()`	`(client) => Promise<boolean>`	Register client
`addUserMod()`	`(clientName, userModName, callback) => Promise<boolean>`	Add user mod callback
`registerMod()`	`(addonName, mod, modZip) => Promise<void>`	Register mod
`afterPatchModToGame()`	`() => Promise<void>`	After-patch hook
`init()`	`() => void`	Initialize

./TweeReplacerLinkerInterface

TweeReplacerLinkerInterface interface

Method	Description
`registerClient(client)`	Register client
`addUserMod(clientName, userModName, callback)`	Add user mod callback

TweeReplacerLinkerClientInterface interface

Method	Description
`enableLinkerMode()`	Enable linker mode

TweeReplacerLinkerClientCallbackType type

(sc: SC2DataInfo) => Promise<any> - User mod callback type

Type Definition Source

Source Code

INFO

Upstream: https://github.com/Lyoko-Jeremie/TweeReplacerLinkerAddon
Default branch: master
Build: pnpm run download && pnpm run build

#@scml/addon-twee-replacer-linker

#Installation

#Quick Start

#Add type reference

#Use global instance

#Import types on demand

#Global Types global

#Subpath Exports

#API Reference

#./TweeReplacerLinker

#TweeReplacerLinker class

#./TweeReplacerLinkerInterface

#TweeReplacerLinkerInterface interface

#TweeReplacerLinkerClientInterface interface

#TweeReplacerLinkerClientCallbackType type

#Type Definition Source