ase-parser/typings/Aseprite.d.ts

Parser for Aseprite files

declare class Aseprite {
  frames: Array<Aseprite.Frame>;
  layers: Array<Aseprite.Layer>;
  slices: Array<Aseprite.Slice>;
  tags: Array<Aseprite.Tag>;
  palette: Aseprite.Palette;
  tilesets: Array<Aseprite.Tileset>;
  colorProfile: Aseprite.ColorProfile;
  name: string;
  paletteIndex: number;
  colorDepth: number;
  pixelRatio: string;
  numColors: number;
  fileSize: number;
  width: number;
  height: number;
  numFrames: number;
  constructor(buffer: Buffer, name: string): void;
  readByte(offset: number): number;
  readWord(offset: number): number;
  readShort(offset: number): number;
  readDWord(offset: number): number;
  readLong(offset: number): number;
  readFixed(offset: number): number;
  readRawBytes(numBytes: number, b: Buffer, offset: number): Buffer;
  parse(): void;
  toJSON(): object;
}
export = Aseprite;

declare namespace Aseprite {
  export interface Palette {
    paletteSize: number;
    firstColor: number;
    lastColor: number;
    colors: Array<Color>;
    index?: number;
  }
  export interface Tileset {
    id: number;
    tileCount: number;
    tileWidth: number;
    tileHeight: number;
    name: string;
    externalFile?: {
      id: number;
      tilesetId: number;
    };
    rawTilesetData?: Buffer;
  }
  export interface Color {
    red: number;
    green: number;
    blue: number;
    alpha: number;
    name: string;
  }
  export interface Cel {
    layerIndex: number;
    xpos: number;
    ypos: number;
    opacity: number;
    celType: number;
    zIndex: number;
    link?: number;
    w: number;
    h: number;
    tilemapMetadata?: {
      bitsPerTile: number;
      bitmaskForTileId: number;
      bitmaskForXFlip: number;
      bitmaskForYFlip: number;
      bitmaskFor90CWRotation: number;
    };
    rawCelData: Buffer;
  }
  export interface Tag {
    name: string;
    from: number;
    to: number;
    animDirection: string;
    repeat: number;
    color: string;
  }
  export interface Layer {
    flags: Aseprite.LayerFlags;
    type: number;
    layerChildLevel: number;
    blendMode: number;
    opacity: number;
    name: string;
    tilesetIndex?: number;
  }
  export interface Slice {
    flags: number;
    keys: SliceKey[];
    name: string;
  }
  export interface SliceKey {
    frameNumber: number;
    x: number;
    y: number;
    width: number;
    height: number;
    patch?: {
      x: number;
      y: number;
      width: number;
      height: number;
    };
    pivot?: {
      x: number;
      y: number;
    }
  }
  export interface Frame {
    bytesInFrame: number;
    frameDuration: number;
    numChunks: number;
    cels: Array<Cel>;
  }
  export interface ColorProfile {
    type: string;
    flag: number;
    fGamma: number;
    icc?: Buffer;
  }
  export interface LayerFlags {
    visible: boolean;
    editable: boolean;
    lockMovement: boolean;
    background: boolean;
    preferLinkedCels: boolean;
    collapsedGroup: boolean;
    reference: boolean;
  }
}