Interface JetLagGameConfig

JetLagGameConfig stores game-specific configuration values. The programmer makes one of these to tell JetLag how to run their game.

interface JetLagGameConfig {
    accelerometerMode?: AccelerometerMode;
    aspectRatio: {
        height: number;
        width: number;
    };
    hitBoxes: boolean;
    resources?: {
        imageNames?: string[];
        musicNames?: string[];
        prefix: string;
        soundNames?: string[];
        videoNames?: string[];
    };
    storageKey?: string;
}

Properties

accelerometerMode? aspectRatio hitBoxes resources? storageKey?

Properties

Optional Readonly accelerometerMode

accelerometerMode?: AccelerometerMode

Accelerometer mode (customize for each device target and orientation)

Readonly aspectRatio

aspectRatio: {
    height: number;
    width: number;
}

The width and height of the game, in meters. Common values are 16/9 (landscape) and 9/16 (portrait)

Type declaration

  • height: number
  • width: number

Readonly hitBoxes

hitBoxes: boolean

Should JetLag print an outline around each actor in the game?

Optional Readonly resources

resources?: {
    imageNames?: string[];
    musicNames?: string[];
    prefix: string;
    soundNames?: string[];
    videoNames?: string[];
}

Configuration of any assets used by the game

Type declaration

  • Optional Readonly imageNames?: string[]

    The list of image files that can be used by the game

  • Optional Readonly musicNames?: string[]

    The list of audio files that can be used as (looping) background music

  • Readonly prefix: string

    The prefix for all resources

  • Optional Readonly soundNames?: string[]

    The list of audio files that can be used as sound effects by the game

  • Optional Readonly videoNames?: string[]

    The list of video files that can be used for cut scenes

Optional Readonly storageKey

storageKey?: string

Key for accessing persistent storage

Settings

Member Visibility

Theme

On This Page