LSDE Dialog Engine / BlueprintExport

Interface: BlueprintExport

Defined in: types.ts:544

Root container for exported blueprint data.

Remarks

This is the top-level JSON structure exported by the LS-Dialog editor. Pass it to engine.init({ data }) to load and validate the blueprint. The engine indexes all scenes, blocks, and connections internally — the original object is not mutated.

The locales array lists all available languages. Call engine.setLocale(code) to store the active locale — your handlers are responsible for reading the appropriate key from DialogBlock.dialogueText and ChoiceItem.dialogueText.

Use the optional check parameter in init() to cross-validate blueprint references (signatures, dictionaries, characters) against your game's known capabilities.

Example

import blueprint from './blueprint.json';

const engine = new DialogueEngine();
const report = engine.init({
  data: blueprint as BlueprintExport,
  check: {
    signatures: ['set_flag', 'play_sound'],
    characters: ['Alice', 'Bob'],
  },
});

if (report.errors.length > 0) {
  console.error('Invalid blueprint:', report.errors);
}

See

• BlueprintScene for scene structure
• ActionSignature for action type definitions
• Dictionary for dictionary groups
• DiagnosticReport for validation results

Properties

dictionaries?

optional dictionaries?: Dictionary[]

Defined in: types.ts:556

Dictionary groups for conditions and action parameters.

---

exportDate

exportDate: string

Defined in: types.ts:548

ISO 8601 timestamp of when this export was generated.

---

locales

locales: string[]

Defined in: types.ts:554

All language locale codes included in this export.

---

primaryLanguage?

optional primaryLanguage?: string

Defined in: types.ts:552

Primary language locale code (e.g. "fr", "en").

---

projectName?

optional projectName?: string

Defined in: types.ts:550

Name of the LSDE project.

---

scenes

scenes: BlueprintScene[]

Defined in: types.ts:560

All exported scenes.

---

signatures?

optional signatures?: ActionSignature[]

Defined in: types.ts:558

Action signature definitions describing available action types.

---

version

version: string

Defined in: types.ts:546

Schema version of this export format.