Class App

Index

Constructors

Methods

createSchedule getWorld registerDebugger registerPlugin registerSystem registerSystemGroup run setComponentHooks setResource setRunner

Constructors

constructor

new App(): App
Returns App

Methods

createSchedule

createSchedule(
    config: {
        defaultSystemGroup?: Constructor<unknown>;
        delay?: number;
        errorHandler?: (error: Error, world: World) => void;
        label: Constructor<unknown>;
        repeat?: boolean;
    },
): App
Parameters
- config: {
      defaultSystemGroup?: Constructor<unknown>;
      delay?: number;
      errorHandler?: (error: Error, world: World) => void;
      label: Constructor<unknown>;
      repeat?: boolean;
  }
Returns App
- Defined in packages/app/src/app.js:104

getWorld

getWorld(): World
Return the world of the app.

Returns World
- Defined in packages/app/src/app.js:97

registerDebugger

registerDebugger(debug: Plugin): App
Parameters
- debug: Plugin
Returns App
- Defined in packages/app/src/app.js:151

registerPlugin

registerPlugin(plugin: Plugin): App
Parameters
- plugin: Plugin
Returns App
- Defined in packages/app/src/app.js:142

registerSystem

registerSystem(config: SystemConfig): App
Parameters
- config: SystemConfig
Returns App
- Defined in packages/app/src/app.js:158

registerSystemGroup

registerSystemGroup(config: SystemGroupConfig): App
Parameters
- config: SystemGroupConfig
Returns App
- Defined in packages/app/src/app.js:167

run

run(): App
Starts up the App. Prevents calls to App.registerSystem, App.registerPlugin and App.setResource. Flushes any resources staged through App.setResource into the world before the runner starts.

Returns App
- Defined in packages/app/src/app.js:127

setComponentHooks

setComponentHooks<T>(
component: new (...args: any[]) => T,
hooks: ComponentHooks,
): App
Type Parameters
- T
Parameters
- component: new (...args: any[]) => T
- hooks: ComponentHooks
Returns App
- Defined in packages/app/src/app.js:178

setResource

setResource<T extends object>(resource: T): App
Type Parameters
- T extends object
Parameters
- resource: T
Returns App
- Defined in packages/app/src/app.js:188

setRunner

setRunner(runner: Runner): App
Parameters
- runner: Runner
Returns App
- Defined in packages/app/src/app.js:113