Type alias Options

Options: {
    audioSeed?: number;
    audioVolume?: number;
    captureCanvasScale?: number;
    isCapturing?: boolean;
    isCapturingGameCanvasOnly?: boolean;
    isDrawingParticleFront?: boolean;
    isDrawingScoreFront?: boolean;
    isPlayingBgm?: boolean;
    isReplayEnabled?: boolean;
    isShowingScore?: boolean;
    isSoundEnabled?: boolean;
    isUsingSmallText?: boolean;
    seed?: number;
    theme?: ThemeName;
    viewSize?: {
        x: number;
        y: number;
    };
}

Game setting options.

Type declaration

  • Optional audioSeed?: number

    Random number seed for BGM and sound effects generation.

  • Optional audioVolume?: number

    Audio volume, default: 1.

  • Optional captureCanvasScale?: number

    Additional setting for isCapturingGameCanvasOnly, set the scale of the output file, default: 1.

  • Optional isCapturing?: boolean

    Capture a screen by pressing 'c' key.

  • Optional isCapturingGameCanvasOnly?: boolean

    Additional setting for isCapturing, will omit the margins on two sides when enabled.

  • Optional isDrawingParticleFront?: boolean

    Display particles on the front of of the screen.

  • Optional isDrawingScoreFront?: boolean

    Display added score points on the front of the screen.

  • Optional isPlayingBgm?: boolean

    Play BGM.

  • Optional isReplayEnabled?: boolean

    Enable replay of the previous game on the title screen.

  • Optional isShowingScore?: boolean

    Show a score and a hi-score, default: true.

  • Optional isSoundEnabled?: boolean

    Enable BGM and sound effects, default: true.

  • Optional isUsingSmallText?: boolean

    Use a small text for a score and a description, default: true.

  • Optional seed?: number

    Deprecated

    Use audioSeed.

  • Optional theme?: ThemeName

    Appearance theme of the game.

  • Optional viewSize?: {
        x: number;
        y: number;
    }

    Screen size of the game, default: {x: 100, y: 100}.

    • x: number
    • y: number

Settings

Member Visibility

Theme

Generated using TypeDoc