Class: KataEngine — Kata docs
Kata docs

kata-framework

Class: KataEngine

Defined in: packages/kata-core/src/runtime/index.ts:14

Extends

  • EventEmitter

Constructors

Constructor

new KataEngine(initialCtx?, options?): KataEngine;

Defined in: packages/kata-core/src/runtime/index.ts:28

Parameters

initialCtx?

Record<string, any> = {}

options?

KataEngineOptions = {}

Returns

KataEngine

Overrides

EventEmitter.constructor

Methods

back()

back(): void;

Defined in: packages/kata-core/src/runtime/index.ts:361

Returns

void

getPlugin()

getPlugin<T>(name): T | undefined;

Defined in: packages/kata-core/src/runtime/index.ts:89

Type Parameters

T

T extends KataPlugin = KataPlugin

Parameters

name

string

Returns

T | undefined

getPlugins()

getPlugins(): string[];

Defined in: packages/kata-core/src/runtime/index.ts:81

Returns

string[]

getSnapshot()

getSnapshot(): GameStateSnapshot;

Defined in: packages/kata-core/src/runtime/index.ts:390

Returns

GameStateSnapshot

loadSnapshot()

loadSnapshot(raw): void;

Defined in: packages/kata-core/src/runtime/index.ts:416

Parameters

raw

unknown

Returns

void

makeChoice()

makeChoice(choiceId): void;

Defined in: packages/kata-core/src/runtime/index.ts:193

Parameters

choiceId

string

Returns

void

next()

next(): void;

Defined in: packages/kata-core/src/runtime/index.ts:235

Returns

void

registerLocale()

registerLocale(
   sceneId, 
   locale, 
   overrides): void;

Defined in: packages/kata-core/src/runtime/index.ts:67

Parameters

sceneId

string

locale

string

overrides

LocaleOverride[]

Returns

void

registerMigration()

registerMigration(fromVersion, migrator): void;

Defined in: packages/kata-core/src/runtime/index.ts:453

Parameters

fromVersion

number

migrator

Migrator

Returns

void

registerScene()

registerScene(scene): void;

Defined in: packages/kata-core/src/runtime/index.ts:93

Parameters

scene

KSONScene

Returns

void

removePlugin()

removePlugin(name): void;

Defined in: packages/kata-core/src/runtime/index.ts:85

Parameters

name

string

Returns

void

setAssetRegistry()

setAssetRegistry(registry): void;

Defined in: packages/kata-core/src/runtime/index.ts:97

Parameters

registry

AssetRegistry

Returns

void

setLocale()

setLocale(locale): void;

Defined in: packages/kata-core/src/runtime/index.ts:55

Parameters

locale

string

Returns

void

setLocaleFallback()

setLocaleFallback(fallback): void;

Defined in: packages/kata-core/src/runtime/index.ts:63

Parameters

fallback

string

Returns

void

start()

start(sceneId): void;

Defined in: packages/kata-core/src/runtime/index.ts:157

Parameters

sceneId

string

Returns

void

use()

use(plugin): void;

Defined in: packages/kata-core/src/runtime/index.ts:72

Parameters

plugin

KataPlugin

Returns

void