Class EngineFactory

The EngineFactory is used to create and initialize an IEligiusEngine instance.

It prepares a resolved configuration and creates the engine based on the class defined in the configuration.

Example

Loading a configuration and creating an IEligiusEngine instance

import { IEngineConfiguration, EngineFactory, WebpackResourceImporter } from 'eligius';
import * as engineConfig from './my-eligius-config.json';

const factory = new EngineFactory(new WebpackResourceImporter(), window);

const engine = factory.createEngine((engineConfig as unknown) as IEngineConfiguration);

engine.init().then(()=> {console.log('Eligius engine ready for business');});

Hierarchy

  • EngineFactory

Implements

Constructors

constructor

Properties

_actionsLookup _eventRemovers _eventbus _importer _resizeTimeout

Methods

_createTimelineProviders _handleSpacePress _importSystemEntry _importSystemEntryWithEventbusDependency _initializeDevtools _requestActionHandler _requestFunctionHandler _requestInstanceHandler _resizeHandler createEngine destroy

Constructors

constructor

Properties

Private _actionsLookup

_actionsLookup: Record<string, IAction> = {}

Private _eventRemovers

_eventRemovers: TEventbusRemover[] = []

Private _eventbus

_eventbus: IEventbus

Private _importer

_importer: ISimpleResourceImporter

Private _resizeTimeout

_resizeTimeout: any = -1

Methods

Private _createTimelineProviders

Private _handleSpacePress

  • _handleSpacePress(keyboardEvent, _hotkeysEvent): boolean | void

  • Parameters

    • keyboardEvent: KeyboardEvent
    • _hotkeysEvent: HotkeysEvent

    Returns boolean | void

Private _importSystemEntry

  • _importSystemEntry(systemName): any

  • Parameters

    • systemName: string

    Returns any

Private _importSystemEntryWithEventbusDependency

  • _importSystemEntryWithEventbusDependency(systemName): any

  • Parameters

    • systemName: string

    Returns any

Private _initializeDevtools

Private _requestActionHandler

Private _requestFunctionHandler

Private _requestInstanceHandler

Private _resizeHandler

createEngine

destroy

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc