Function: add()

> add(fn, handlerOptions): void

Defined in: src/translator/TextReplaces.ts:79

Registers a new replacement handler.

Handlers are executed in the order they are added. The first handler added runs first.

The TranslatorManager translation pipeline automatically calls TextReplaces.replace for both phases ("before-translation" and "after-translation"), so no additional setup is required after calling add.

Parameters

fn

ReplaceHandler

The handler function. Receives the key found inside [...] and should return the replacement string, or undefined to leave that token unchanged.

handlerOptions

ReplaceHandlerOptions

Configuration for this handler, including its name, optional description, validation regex, and execution phase.

Returns

void

Example

import { TextReplaces } from 'pixi-vn-ink'

TextReplaces.add(
    (key) => key === "player" ? "Mario" : undefined,
    {
        name: "player-name",
        validation: /^player$/,
    }
)