# split_sprite_sheet

Cut a sprite sheet into its cells as separate image files, in reading order.

A deterministic file operation: no model runs and no Creative Units are spent. Frames keep  
their full cell so an animation cycle stays registered; use \`inset\` to drop thin gutters or  
divider lines. With \`trim\_transparent\`, each frame is cropped to its subject instead, and  
\`cut\_off\_frames\` lists those whose subject reaches its cell's edge. The frames are saved to  
the workspace library and, when the call runs in a session, placed on its board (each frame  
reports \`placed\_on\_board\`) — reference them by \`file\_id\` afterwards. All frames are written or none: a failure part-way  
deletes the frames already written, so the call can simply be retried.

## Parameters

| Parameter             | Type               | Default | Description                                                                                                                                                                                                                       |
| --------------------- | ------------------ | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| file\_idrequired      | string (uuid)      | —       | The sheet to cut: a workspace file id — an attachment's id or a forge output's file\_id.                                                                                                                                          |
| columnsrequired       | integer1–16        | —       | Cells across. Pass the grid the sheet was generated with.                                                                                                                                                                         |
| rows                  | integer1–16        | 1       | Cells down.                                                                                                                                                                                                                       |
| inset                 | integer0–256       | 0       | Pixels trimmed off every side of each cell, to drop gutters or divider lines the generator drew.                                                                                                                                  |
| trim\_transparent     | boolean            | false   | Crop each frame to its subject's bounds, ignoring faint haze, so a subject the generator drew off center comes out centered. Leave off for animation frames: a cycle stays registered only while every frame keeps its full cell. |
| overlap\_x            | integer0–2048      | 0       | Pixels neighboring cells share horizontally. Leave 0 for sprite sheets; set it to cut a large image into overlapping chunks for per-chunk editing.                                                                                |
| overlap\_y            | integer0–2048      | 0       | Pixels neighboring cells share vertically.                                                                                                                                                                                        |
| offset\_x             | integer\-4096–4096 | 0       | Shifts the whole grid right (positive) or left (negative).                                                                                                                                                                        |
| offset\_y             | integer\-4096–4096 | 0       | Shifts the whole grid down (positive) or up.                                                                                                                                                                                      |
| pad\_edges            | boolean            | true    | Fill the part of a cell an offset pushes past the image with transparency, keeping every frame the same size. False crops those frames to the image.                                                                              |
| name\_prefix          | string0–120 chars  | —       | File name stem for the frames. Defaults to the sheet's name.                                                                                                                                                                      |
| workspace\_idrequired | string (uuid)      | —       | The user's workspace id.                                                                                                                                                                                                          |
| session\_id           | string (uuid)      | —       | Session whose board receives the frames. Omit to only save them to the library.                                                                                                                                                   |