api.graphics

ready

ready(): { tileset: boolean; units: boolean; };

Whether the tileset graphics and the unit tables are in memory.

load

load(): Promise<{ tileset: boolean; units: boolean; }>;

Fetch both; resolves with what is available afterwards.

unitImage

unitImage(unitId: number, options?: { owner?: number; }): PluginImage | null;

A unit type in its editor pose, in a player's colours (owner 0 by default).

spriteImage

spriteImage(kind: SpriteKind, id: number, options?: { owner?: number; flipped?: boolean; }): PluginImage | null;

A THG2 sprite: a sprites.dat image for "pure", a unit for "unit".

tileImage

tileImage(tileId: number): PluginImage | null;

One 32 × 32 megatile of the open map's tileset.

doodadImage

doodadImage(doodadId: number): PluginImage | null;

A doodad drawn from its own tiles.

renderRect

renderRect(rect: Rect, options?: Partial<MapImageOptions>): Promise<Blob | null>;

Part of the map as File ▸ Export ▸ Image draws it — the same render, cropped to a tile rect. Everything it needs is loaded first; null without a map or a canvas.

playerColor

playerColor(owner: number): string;

The colour a player's units are drawn in, #rrggbb.

requestUnit

requestUnit(unitId: number): boolean;

Start fetching the GRPs a unit type needs, and say whether they are already in memory. Graphics load lazily, so the first unitImage for a type is often null — ask for it here, redraw on onImageLoaded, and the list fills in.

requestSprite

requestSprite(kind: SpriteKind, id: number): boolean;

onImageLoaded

onImageLoaded(listener: () => void): Disposable;

A GRP finished loading: anything drawn from one may look different now.

interface PluginImage