Interface EngineOptions

Options available to the Engine class.

interface EngineOptions {
    container?: string;
    framerate?: null | number;
    fullscreen?: boolean;
    height?: number;
    hooks?: {
        afterStep: (() => Promise<void>);
        beforeStep: (() => Promise<void>);
    };
    resolution?: number;
    width?: number;
}

Properties

container? framerate? fullscreen? height? hooks? resolution? width?

Properties

Optionalcontainer

container?: string

A DOMString to the container of the engine's canvas.

Default

'body'

Optionalframerate

framerate?: null | number

If set, gives a maximum framerate for the engine's fixed update loop.

Default

null

Optionalfullscreen

fullscreen?: boolean

If true, sets the width and height of the engine's canvas to follow the container's size.

Default

true

Optionalheight

height?: number

Height of the engine's canvas.

Default

720

Optionalhooks

hooks?: {
    afterStep: (() => Promise<void>);
    beforeStep: (() => Promise<void>);
}

Hooks are functions that are called at specific points in the engine's runtime.

Type declaration

  • afterStep: (() => Promise<void>)

    Called after the engine's step loop.

    Default

    async () => { }
      • (): Promise<void>

      • Returns Promise<void>

  • beforeStep: (() => Promise<void>)

    Called before the engine's step loop.

    Default

    async () => { }
      • (): Promise<void>

      • Returns Promise<void>

Optionalresolution

resolution?: number

Resolution used by the engine's canvas.

Default

true

Optionalwidth

width?: number

Width of the engine's canvas.

Default

1280

Settings

Member Visibility

On This Page

Properties