Class: JsonUnifier

Defined in: src/core/JsonUnifier.ts:38

Constructors

Constructor

> new JsonUnifier(): JsonUnifier

Returns

JsonUnifier

Accessors

animateOperation

Get Signature

> get static animateOperation(): (operation) => void

Defined in: src/core/JsonUnifier.ts:303

Registered handler for keyframe animation operations.

Returns

(operation) => void

---

canvasElementOperation

Get Signature

> get static canvasElementOperation(): (operation) => Promise<void>

Defined in: src/core/JsonUnifier.ts:232

Registered handler for generic canvas-element edit/remove operations.

Returns

(operation) => Promise<void>

---

effectOperation

Get Signature

> get static effectOperation(): (operation) => Promise<void>

Defined in: src/core/JsonUnifier.ts:290

Registered handler for canvas visual effects (e.g. shake).

Returns

(operation) => Promise<void>

---

getConditionalStep

Get Signature

> get static getConditionalStep(): (originalStep, props?) => PixiVNJsonLabelStep

Defined in: src/core/JsonUnifier.ts:342

Registered handler that resolves a label step's conditionalStep field.

Returns

(originalStep, props?) => PixiVNJsonLabelStep

---

getLogichValue

Get Signature

> get static getLogichValue(): <T>(value, props?) => T | undefined

Defined in: src/core/JsonUnifier.ts:326

Registered handler that evaluates a JSON logic expression to a plain value.

Returns

<T>(value, props?) => T | undefined

---

imageContainerOperation

Get Signature

> get static imageContainerOperation(): (operation) => Promise<void>

Defined in: src/core/JsonUnifier.ts:198

Returns

(operation) => Promise<void>

---

imageOperation

Get Signature

> get static imageOperation(): (operation) => Promise<void>

Defined in: src/core/JsonUnifier.ts:162

Registered handler for ImageSprite show/edit/remove operations.

Returns

(operation) => Promise<void>

---

loadAssets

Get Signature

> get static loadAssets(): (origin) => void | Promise<void>

Defined in: src/core/JsonUnifier.ts:134

Registered handler for loading/lazy-loading assets.

Returns

(origin) => void | Promise<void>

---

narrationOperation

Get Signature

> get static narrationOperation(): (operation) => void

Defined in: src/core/JsonUnifier.ts:277

Registered handler for narration operations (input requests, dialogue resets).

Returns

(operation) => void

---

setInitialStorageValue

Get Signature

> get static setInitialStorageValue(): (value, props?) => void

Defined in: src/core/JsonUnifier.ts:264

Registered handler for setting a default (initial) storage value at import time.

Returns

(value, props?) => void

---

setStorageValue

Get Signature

> get static setStorageValue(): (value, props?) => void

Defined in: src/core/JsonUnifier.ts:248

Registered handler for setting a storage value during label execution.

Returns

(value, props?) => void

---

soundOperation

Get Signature

> get static soundOperation(): (operation) => void

Defined in: src/core/JsonUnifier.ts:147

Registered handler for sound play/stop/pause/resume/edit operations.

Returns

(operation) => void

---

textOperation

Get Signature

> get static textOperation(): (operation) => Promise<void>

Defined in: src/core/JsonUnifier.ts:213

Registered handler for Text show/edit/remove operations.

Returns

(operation) => Promise<void>

---

videoOperation

Get Signature

> get static videoOperation(): (operation) => Promise<void>

Defined in: src/core/JsonUnifier.ts:181

Registered handler for VideoSprite show/edit/remove/pause/resume operations.

Returns

(operation) => Promise<void>

Methods

init()

> static init(options): void

Defined in: src/core/JsonUnifier.ts:46

Registers the operation handlers that pixi-vn-json will delegate to at runtime. Call this once at application startup (e.g. via init) before importing any labels.

All parameters are optional except setInitialStorageValue, which is required because it must be available for initial-operation processing during label import.

Parameters

options

animateOperation?

(operation) => void

canvasElementOperation?

(operation) => Promise<void>

effectOperation?

(operation) => Promise<void>

getConditionalStep?

(originalStep, props?) => PixiVNJsonLabelStep

getLogichValue?

<T>(value, props?) => T | undefined

imageContainerOperation?

(operation) => Promise<void>

imageOperation?

(operation) => Promise<void>

loadAssets?

(origin) => void | Promise<void>

narrationOperation?

(operation) => void

setInitialStorageValue

(value, props?) => void

setStorageValue?

(value, props?) => void

soundOperation?

(operation) => void

textOperation?

(operation) => Promise<void>

videoOperation?

(operation) => Promise<void>

Returns

void