api.palette

active

active(): PaletteChoice;

setActive

setActive(choice: Partial<PaletteChoice>): void;

playerColor

playerColor(owner: number): string;

The colour a player's units are shown in, #rrggbb (the same as graphics.playerColor).

placementOptions

placementOptions(): PlacementOptions;

The Units palette's placement checks and snapping — what placeUnit, canPlaceUnit and query.placement apply, and whether an edit removes stranded units.

setPlacementOptions

setPlacementOptions(patch: Partial<PlacementOptions>): void;

doodadPlacement

doodadPlacement(): DoodadPlacementOptions;

The Doodads palette's rules: place anywhere, snap to grid.

setDoodadPlacement

setDoodadPlacement(patch: Partial<DoodadPlacementOptions>): void;

locationSnap

locationSnap(): number;

The Locations layer's snap step in pixels, 0 for off.

setLocationSnap

setLocationSnap(step: 0 | 8 | 16 | 32 | 64): void;

unitGroups

unitGroups(): UnitGroup[];

Every unit type, grouped the way the Units palette lists them.

unitName

unitName(unitId: number): string;

unitSize

unitSize(unitId: number): UnitSize;

spriteGroups

spriteGroups(): SpriteGroup[];

What the Sprites palette lists, by group; empty until the unit tables are loaded.

spriteName

spriteName(kind: SpriteKind, id: number): string;

"Terran Marine" for a unit sprite, the unit or GRP the pure sprite draws otherwise.

doodadCategories

doodadCategories(): { name: string; doodads: DoodadInfo[]; }[];

The open map's doodads by palette category; empty without the tileset graphics.

doodadInfo

doodadInfo(doodadId: number): DoodadInfo | null;

type RaceKey = "terran" | "zerg" | "protoss" | "neutral";

interface UnitGroup

interface SpriteGroup

interface PlacementOptions

interface DoodadPlacementOptions

interface PaletteChoice

interface UnitSize

interface DoodadInfo