• Documentation
• API
• FAQ
• Quick Reference
• Tutorial

Feedback

• press ENTER to search or ESC to cancel

Table of content

Overview
API Changes

Globals namespaces

• app
• app.command
• app.fs
• app.os
• app.pixelColor
• app.theme
• json

Constants

• Align
• AniDir
• BlendMode
• BrushPattern
• BrushType
• ColorMode
• FilterChannels
• Ink
• MouseButton
• MouseCursor
• RangeType
• SelectionMode
• SpriteSheetDataFormat
• SpriteSheetType
• WebSocketMessageType

Classes/objects

• Brush
• Cel
• Color
• ColorSpace
• Dialog
• Editor
• Events
• Frame
• GraphicsContext
• Image
• ImageSpec
• KeyEvent
• Layer
• MouseEvent
• Palette
• Plugin
• Point
• Properties
• Range
• Rectangle
• Selection
• Site
• Size
• Slice
• Sprite
• Tag
• Tile
• Tileset
• Timer
• Tool
• TouchEvent
• Version
• WebSocket
• Window

---

Edit page

ExportSpriteSheet

app.command.ExportSpriteSheet {
  ui=true,
  recent=true,
  askOverwrite=true,
  type=SpriteSheetType.HORIZONTAL,
  columns=0,
  rows=0,
  width=0,
  height=0,
  bestFit=false,
  textureFilename="",
  dataFilename="",
  dataFormat=SpriteSheetDataFormat.JSON_HASH,
  filenameFormat="{title} ({layer}) {frame}.{extension}",
  borderPadding=0,
  shapePadding=0,
  innerPadding=0,
  trimSprite=false,
  trim=false,
  trimByGrid=false,
  extrude=false,
  ignoreEmpty=false,
  mergeDuplicates=false,
  openGenerated=false,
  layer="",
  tag="",
  splitLayers=false,
  splitTags=false,
  splitGrid=false,
  listLayers=true,
  listTags=true,
  listSlices=true,
  fromTilesets=false,
}

This is similar to using the -sheet argument from the CLI.

• ui: Shows the dialog to export the sprite sheet.
• recent: Only available since v1.3.7, it adds the output file (textureFilename) to the list of recent files. By default, if it's not specified, it depends on the ui parameter: if the Export Sprite Sheet dialog is displayed, the selected output filename will be added to the recent list.
• askOverwrite
• type (SpriteSheetType)
• columns
• rows
• width
• height
• bestFit=false
• textureFilename
• dataFilename
• dataFormat (SpriteSheetDataFormat)
• filenameFormat
• borderPadding
• shapePadding
• innerPadding
• trimSprite
• trim
• trimByGrid
• extrude
• ignoreEmpty
• mergeDuplicates
• openGenerated
• layer
• tag
• splitLayers
• splitTags
• splitGrid: Only available since v1.3-beta21
• listLayers
• listTags
• listSlices
• fromTilesets: Only available since v1.3-beta21, export tileset, like ExportTileset