Function extrudeTilesetToJimp

  • extrudeTilesetToJimp(
        tileWidth: number,
        tileHeight: number,
        inputPath: string,
        options?: ExtrusionOptions,
    ): Promise<JimpInstance>

  • Accepts an image path and returns a Jimp image object containing the extruded image. This is exposed for advanced image processing purposes. For more common uses, see extrudeTilesetToImage or extrudeTilesetToBuffer. It returns a Promise that resolves when it is finished extruding the image.

    Parameters

    • tileWidth: number

      tile width in pixels.

    • tileHeight: number

      tile height in pixels.

    • inputPath: string

      the path to the tileset you want to extrude.

    • Optionaloptions: ExtrusionOptions = {}

      optional settings.

      • Optionalcolor?: string | number
      • Optionalextrusion?: number
      • Optionalmargin?: number
      • Optionalspacing?: number

    Returns Promise<JimpInstance>

    • A promise that resolves to a Jimp image object, or rejects with an error.

Settings

Member Visibility