retrolib/dist-lib/retrolib.d.ts

Render low-res scenes to the canvas in a retro 8-bit era style. Aseprite exported animation wrapper, scene management, sound and image management, particle support.

export * as postprocessing from './modules/postprocessing';
export * as images from './modules/images';
export * as font from './modules/font';
export * as scenes from './modules/scenes';
export * as dialogscenes from './modules/dialogscene';
export * as sfx from './modules/sfx';
export * as music from './modules/music';
export * as input from './modules/input';
export * as gamepad from './modules/input-gamepad';
export * as keyboard from './modules/input-keyboard';
export * as menus from './modules/menus';
export * as menu from './modules/menu';
export * as aseprite from './modules/aseprite';
export * as terminal from './modules/terminal';
export * as random from './modules/random';
export * as map from './modules/map';
export { AnimationFrameFunction, InputHandlerFunction, OnDeactivateFunction, OnActivateFunction } from './modules/scenes';
export { MenuOption } from './modules/menu';
import { Timeline } from './modules/timeline';
import Rect from './modules/rect';
import Scene from './modules/scene';
import DialogScene from './modules/dialogscene';
import Menu from './modules/menu';
import FontData from './modules/FontData';
import Glyph from './modules/Glyph';
import { Aseprite } from './modules/aseprite';
import ImageDefinition from './modules/ImageDefinition';
import { OnSelectionFunction } from './modules/menu';
import MusicDefinition from './modules/MusicDefinition';
import SfxDefinition from './modules/SfxDefinition';
/**
 * X and Y coordinates.
 */
export type Coordinates = {
    x: number;
    y: number;
};
/**
 * Canvas element to draw on.
 */
declare let gameCanvas: HTMLCanvasElement;
/**
 * Canvas width (resolution x).
 */
declare let canvasWidth: number;
/**
 * Canvas height (resolution y).
 */
declare let canvasHeight: number;
export declare function appendCanvas(canvasId: string, width: number, height: number, autoResize: boolean): HTMLCanvasElement;
/**
 * Set the canvas element's background value.
 * @param color CSS background for canvas element.
 */
declare function setCanvasBackground(color: string): void;
/**
 * Initialize the retrolib engine.
 * @param canvasId Id attribute of existing canvas, or id attribute to give to created canvas element.
 * @param width X resolution.
 * @param height Y resolution.
 * @param buildCanvas Whether or not to create a canvas element.
 * @param autoResize Whether or not to autoresize the canvas to the window.
 */
declare function initialize(canvasId: string, width: number, height: number, buildCanvas: boolean, autoResize: boolean): void;
export { initialize, setCanvasBackground, gameCanvas, canvasWidth, canvasHeight, Scene, Menu, Rect, FontData, Glyph, ImageDefinition, OnSelectionFunction, MusicDefinition, SfxDefinition, Aseprite, DialogScene, Timeline };