Class Game

Represents a game engine that manages scenes, assets, and game state.

Constructors

constructor

Properties

animationFrame? audioVolume avgFPS backgroundColor canvas config ctx currentScene debug delta draw frame frameRate frameTimeBuffer frameTimeLast height images input objectClasses paused pixelPerfect postProcess? preload preloadPercent primaryColor sceneClasses scenes settings sounds time timeReal width

Methods

getImage getResolution getSetting getTmxMap getVersion onResize playScene playSound restartScene setAudioVolume setSetting setSettings start timer toggleFullscreen togglePause update

Constructors

constructor

Properties

OptionalanimationFrame

animationFrame?: number

Animation frame ID for the game loop.

audioVolume

audioVolume: number = 1

Game global audio volume.

avgFPS

avgFPS: number = 0

Game average frames per second.

backgroundColor

backgroundColor: Color = DefaultColors.Black

Background color of the game.

canvas

canvas: HTMLCanvasElement

Canvas element for rendering the game.

config

config: GameConfig

The game configuration.

ctx

ctx: CanvasRenderingContext2D

Canvas rendering context.

currentScene

currentScene: null | Scene = null

Current scene being played.

debug

debug: boolean = false

Debug mode flag.

delta

delta: number = ...

Game delta time.

draw

draw: Draw = ...

Draw object for rendering 2D shapes and images.

frame

frame: number = 0

Game frame counter.

frameRate

frameRate: number = 60

Game frame rate.

frameTimeBuffer

frameTimeBuffer: number = 0

Game frame time buffer.

frameTimeLast

frameTimeLast: number = 0

Game frame time last.

height

height: number = window.innerHeight

Game height.

images

images: Record<string, HTMLImageElement> = {}

Image assets record containing image elements.

input

input: Input = ...

Input object for handling user input.

objectClasses

objectClasses: Record<string, Constructable<Entity>> = {}

Object classes record containing entity classes.

paused

paused: boolean = false

Game pause flag.

pixelPerfect

pixelPerfect: boolean = false

Flag indicating whether the game should render pixel-perfect.

OptionalpostProcess

postProcess?: PostProcess

The post-processing effect to apply to the game.

preload

preload: Record<string, string>

The preload record.

preloadPercent

preloadPercent: number = -1

Game preloader percent.

primaryColor

primaryColor: Color = DefaultColors.White

Primary color. Used for text, and other UI elements like preloader.

sceneClasses

sceneClasses: Record<string, Constructable<Scene>> = {}

Scene classes record containing scene classes.

scenes

scenes: Record<string, Scene> = {}

Scene record containing all scenes.

settings

settings: Record<string, any> = {}

Optional settings for the game.

sounds

sounds: Record<string, Howl> = {}

Sound assets record containing Howl objects.

time

time: number = 0

Game time.

timeReal

timeReal: number = 0

Game time in real seconds.

width

width: number = window.innerWidth

Game width.

Methods

getImage

  • getImage(name): HTMLImageElement

  • Retrieves an image by its name from the assets.

    Parameters

    • name: string

      The name of the image to retrieve.

    Returns HTMLImageElement

    The HTMLImageElement corresponding to the specified name.

    Throws

    Error if the image is not found in the assets.

getResolution

getSetting

  • getSetting(key): any

  • Retrieves the value of a setting based on the provided key.

    Parameters

    • key: string

      The key of the setting to retrieve.

    Returns any

    The value of the setting.

getTmxMap

  • getTmxMap(name): any

  • Retrieves a TmxMap object from the session storage based on the provided name. If the object is not found, an empty object is returned.

    Parameters

    • name: string

      The name of the TmxMap object to retrieve.

    Returns any

    The retrieved TmxMap object or an empty object if not found.

getVersion

onResize

playScene

  • playScene(sceneName, restart?): void

  • Plays the specified scene.

    Parameters

    • sceneName: string

      The name of the scene to play.

    • restart: boolean = false

      Whether to restart the scene if it is already playing. Default is false.

    Returns void

    Throws

    Error if the specified scene is not found.

playSound

  • playSound(name): void

  • Plays the sound with the specified name.

    Parameters

    • name: string

      The name of the sound to play.

    Returns void

restartScene

setAudioVolume

setSetting

  • setSetting(key, value): void

  • Sets a setting value for the game.

    Parameters

    • key: string

      The key of the setting.

    • value: any

      The value to set for the setting.

    Returns void

setSettings

start

  • start(sceneName?): Promise<void>

  • Starts the game engine and initializes the scenes.

    Parameters

    • OptionalsceneName: string

      Optional name of the scene to start with.

    Returns Promise<void>

timer

toggleFullscreen

togglePause

  • togglePause(paused?): void

  • Toggles the pause state of the game.

    Parameters

    • paused: boolean = !this.paused

      Optional. Specifies whether the game should be paused or not. Default is true.

    Returns void

update

  • update(frameTime?): void

  • Updates the game state and renders the scene.

    Parameters

    • frameTime: number = 0

      The time elapsed since the last frame in milliseconds.

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods