@kayelaa/canvas API - v0.2.15
    Preparing search index...

    Interface KaylaGame

    Game instance that coordinates scenes, renderers, and the shared ticker.

    interface KaylaGame {
        delay(ms: number): LeaTimeout;
        get started(): boolean;
        start(): void;
        stop(): void;
        addRenderer(renderer: KaylaInternals.KaylaRenderer): void;
        get mainRenderer(): KaylaInternals.KaylaRenderer;
        getRenderers(): KaylaInternals.KaylaRenderer[];
        deleteRenderer(renderer: KaylaInternals.KaylaRenderer): void;
        scenes: Map<string, LeaSceneII>;
        ticker: LeaTickerII;
        get centerX(): number;
        get centerY(): number;
        get left(): number;
        get top(): number;
        get right(): number;
        get bottom(): number;
        width: number;
        height: number;
        addScene(scene: LeaSceneII): void;
        removeScene(scene: LeaSceneII): void;
        now(): number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    scenes: Map<string, LeaSceneII>

    Map of scenes by name.

    ticker: LeaTickerII

    The shared ticker driving updates.

    width: number

    Logical viewport width.

    height: number

    Logical viewport height.

    Accessors

    • get started(): boolean

      Whether the game has been started.

      Returns boolean

    • get centerX(): number

      Center X of the viewport (width / 2).

      Returns number

    • get centerY(): number

      Center Y of the viewport (height / 2).

      Returns number

    • get left(): number

      Returns number

    • get top(): number

      Returns number

    • get right(): number

      Returns number

    • get bottom(): number

      Returns number

    Methods