@kiswa/kilo
Options
All
  • Public
  • Public/Protected
  • All
Menu

Loads assets for use in a game.

Assets are cached by URI to prevent multiple network calls for the same asset.

Hierarchy

  • Assets

Index

Constructors

Accessors

Methods

Constructors

constructor

Accessors

completed

  • get completed(): boolean

  • Get completed status of all assets.

    Returns boolean

Methods

image

  • image(url: string): HTMLImageElement

  • Loads an image asset.

    Parameters

    • url: string

      Relative path to image file.

    Returns HTMLImageElement

json

  • json(url: string): any

  • Loads a JSON asset and returns parsed object.

    Parameters

    • url: string

      Relative path to JSON asset.

    Returns any

onProgress

  • onProgress(cb: ProgressCallback): void

  • Allows listeners to provide a callback for asset load progress.

    Parameters

    • cb: ProgressCallback

      Function called when a single asset is loaded.

    Returns void

onReady

  • onReady(cb: ReadyCallback): void

  • Allows listeners to provide a callback for asset load completion.

    Parameters

    • cb: ReadyCallback

      Function called when all assets are loaded.

    Returns void

sound

  • sound(url: string): HTMLAudioElement

  • Loads a sound asset.

    Parameters

    • url: string

      Relative path to sound file.

    Returns HTMLAudioElement